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