accumulatoralgorithm.h

Go to the documentation of this file.

/*
 * Copyright (C) 2006-2021  Music Technology Group - Universitat Pompeu Fabra
 *
 * This file is part of Essentia
 *
 * Essentia is free software: you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License as published by the Free
 * Software Foundation (FSF), either version 3 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the Affero GNU General Public License
 * version 3 along with this program.  If not, see http://www.gnu.org/licenses/
 */
 
#ifndef ESSENTIA_ACCUMULATORALGORITHM_H
#define ESSENTIA_ACCUMULATORALGORITHM_H
 
#include "streamingalgorithm.h"
 
namespace essentia {
namespace streaming {
 
class AccumulatorAlgorithm : public Algorithm {
 public:
  AccumulatorAlgorithm();
 
  AlgorithmStatus process();
 
  void reset();
 
  virtual void consume() = 0;
  virtual void finalProduce() = 0;
 
  void declareInputStream(SinkBase& sink, const std::string& name, const std::string& desc,
                          int preferredAcquireSize = 4096);
 
  void declareOutputResult(SourceBase& source, const std::string& name, const std::string& desc);
 
 protected:
  int _preferredSize;
  SinkBase* _inputStream;
 
  // shadow those methods to prevent people from using them
  void declareInput();
  void declareOutput();
};
 
 
} // namespace streaming
} // namespace essentia
 
 
#endif // ESSENTIA_ACCUMULATORALGORITHM_H