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 "global/types/ret.h"
      26              : #include "global/async/promise.h"
      27              : #include "global/async/channel.h"
      28              : 
      29              : #include "audio/common/audiotypes.h"
      30              : #include "audio/common/timeposition.h"
      31              : 
      32              : namespace muse::audio::engine {
      33              : class IEnginePlayer
      34              : {
      35              : public:
      36            0 :     virtual ~IEnginePlayer() = default;
      37              : 
      38              :     virtual async::Promise<Ret> prepareToPlay() = 0;
      39              : 
      40              :     virtual void play(const secs_t delay = 0) = 0;
      41              :     virtual void seek(const TimePosition& position, const bool flushSound = true) = 0;
      42              :     virtual void stop() = 0;
      43              :     virtual void pause() = 0;
      44              :     virtual void resume(const secs_t delay = 0) = 0;
      45              : 
      46              :     virtual PlaybackStatus playbackStatus() const = 0;
      47              :     virtual async::Channel<PlaybackStatus> playbackStatusChanged() const = 0;
      48              :     virtual bool isActive() const = 0;
      49              :     virtual async::Channel<bool> isActiveChanged() const = 0;
      50              : 
      51              :     virtual secs_t duration() const = 0;
      52              :     virtual void setDuration(const secs_t duration) = 0;
      53              :     virtual Ret setLoop(const secs_t from, const secs_t to) = 0;
      54              :     virtual void resetLoop() = 0;
      55              : 
      56              :     virtual secs_t playbackPosition() const = 0;
      57              :     virtual async::Channel<secs_t> playbackPositionChanged() const = 0;
      58              : };
      59              : using IEnginePlayerPtr = std::shared_ptr<IEnginePlayer>;
      60              : }