Line data    Source code

       1              : /*
       2              :  * SPDX-License-Identifier: GPL-3.0-only
       3              :  * MuseScore-CLA-applies
       4              :  *
       5              :  * MuseScore Studio
       6              :  * Music Composition & Notation
       7              :  *
       8              :  * Copyright (C) 2021 MuseScore Limited and others
       9              :  *
      10              :  * This program is free software: you can redistribute it and/or modify
      11              :  * it under the terms of the GNU General Public License version 3 as
      12              :  * published by the Free Software Foundation.
      13              :  *
      14              :  * This program is distributed in the hope that it will be useful,
      15              :  * but WITHOUT ANY WARRANTY; without even the implied warranty of
      16              :  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      17              :  * GNU General Public License for more details.
      18              :  *
      19              :  * You should have received a copy of the GNU General Public License
      20              :  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
      21              :  */
      22              : 
      23              : #pragma once
      24              : 
      25              : #include <memory>
      26              : 
      27              : #include "audio/common/audiotypes.h"
      28              : 
      29              : namespace muse::audio {
      30              : class IFxProcessor
      31              : {
      32              : public:
      33            0 :     virtual ~IFxProcessor() = default;
      34              : 
      35              :     virtual AudioFxType type() const = 0;
      36              :     virtual std::string name() const = 0;
      37              : 
      38              :     virtual const AudioFxParams& params() const = 0;
      39              :     virtual async::Channel<audio::AudioFxParams> paramsChanged() const = 0;
      40              : 
      41              :     virtual void setOutputSpec(const OutputSpec& spec) = 0;
      42              : 
      43              :     virtual bool active() const = 0;
      44              :     virtual void setActive(bool active) = 0;
      45              : 
      46              :     virtual void setMode(const ProcessMode mode) = 0;
      47              : 
      48              :     virtual bool shouldProcessDuringSilence() const = 0;
      49              : 
      50              :     virtual void process(float* buffer, samples_t sampleCount, samples_t playbackPositionSamples = 0) = 0;
      51              : };
      52              : 
      53              : using IFxProcessorPtr = std::shared_ptr<IFxProcessor>;
      54              : }