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) 2025 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 "global/async/channel.h"
      28              : 
      29              : #include "audio/common/audiotypes.h"
      30              : 
      31              : namespace muse::audio::engine {
      32              : class IAudioSource
      33              : {
      34              : public:
      35            0 :     virtual ~IAudioSource() = default;
      36              : 
      37              :     virtual void setMode(const ProcessMode mode) = 0;
      38              :     virtual ProcessMode mode() const = 0;
      39              : 
      40              :     //! set current output spec. Called by destination.
      41              :     virtual void setOutputSpec(const OutputSpec& spec) = 0;
      42              : 
      43              :     //! return substream count for this source: 1 for mono, 2 for stereo, 6 for surround
      44              :     virtual unsigned int audioChannelsCount() const = 0;
      45              : 
      46              :     virtual async::Channel<unsigned int> audioChannelsCountChanged() const = 0;
      47              : 
      48              :     //! move buffer forward for sampleCount samples
      49              :     virtual samples_t process(float* buffer, samples_t samplesPerChannel) = 0;
      50              : };
      51              : 
      52              : using IAudioSourcePtr = std::shared_ptr<IAudioSource>;
      53              : }