Line data    Source code

       1              : /*
       2              :  * SPDX-License-Identifier: GPL-3.0-only
       3              :  * MuseScore-Studio-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 "types/retval.h"
      26              : #include "midi/miditypes.h"
      27              : #include "audio/common/audiotypes.h"
      28              : #include "async/channel.h"
      29              : #include "mpe/events.h"
      30              : #include "engraving/types/types.h"
      31              : 
      32              : #include "types/loopboundaries.h"
      33              : #include "types/tempo.h"
      34              : 
      35              : namespace mu::engraving {
      36              : class EngravingItem;
      37              : class StaffText;
      38              : }
      39              : 
      40              : namespace mu::notation {
      41              : class INotationPlayback
      42              : {
      43              : public:
      44            0 :     virtual ~INotationPlayback() = default;
      45              : 
      46              :     virtual void init() = 0;
      47              :     virtual void reload() = 0;
      48              : 
      49              :     virtual void setSendEventsOnScoreChange(const engraving::InstrumentTrackId& trackId, bool send) = 0;
      50              :     virtual void sendEventsForChangedTracks() = 0;
      51              : 
      52              :     virtual muse::async::Channel<engraving::InstrumentTrackIdSet> tracksDataChanged() const = 0;
      53              : 
      54              :     virtual const engraving::InstrumentTrackId& metronomeTrackId() const = 0;
      55              :     virtual engraving::InstrumentTrackId chordSymbolsTrackId(const muse::ID& partId) const = 0;
      56              :     virtual bool isChordSymbolsTrack(const engraving::InstrumentTrackId& trackId) const = 0;
      57              : 
      58              :     virtual const muse::mpe::PlaybackData& trackPlaybackData(const engraving::InstrumentTrackId& trackId) const = 0;
      59              : 
      60              :     virtual void triggerEventsForItems(const std::vector<const engraving::EngravingItem*>& items, muse::mpe::duration_t duration,
      61              :                                        bool flushSound) = 0;
      62              :     virtual void triggerMetronome(muse::midi::tick_t tick) = 0;
      63              :     virtual void triggerCountIn(muse::midi::tick_t tick, muse::secs_t& countInDuration) = 0;
      64              :     virtual void triggerControllers(const muse::mpe::ControllerChangeEventList& list, engraving::staff_idx_t staffIdx, int tick) = 0;
      65              : 
      66              :     virtual engraving::InstrumentTrackIdSet existingTrackIdSet() const = 0;
      67              :     virtual muse::async::Channel<engraving::InstrumentTrackId> trackAdded() const = 0;
      68              :     virtual muse::async::Channel<engraving::InstrumentTrackId> trackRemoved() const = 0;
      69              : 
      70              :     virtual muse::audio::secs_t totalPlayTime() const = 0;
      71              :     virtual muse::async::Channel<muse::audio::secs_t> totalPlayTimeChanged() const = 0;
      72              : 
      73              :     virtual muse::audio::secs_t playedTickToSec(muse::midi::tick_t tick) const = 0;
      74              :     virtual muse::midi::tick_t secToPlayedTick(muse::audio::secs_t sec) const = 0;
      75              :     virtual muse::midi::tick_t secToTick(muse::audio::secs_t sec) const = 0;
      76              : 
      77              :     virtual muse::RetVal<muse::midi::tick_t> playPositionTickByRawTick(muse::midi::tick_t tick) const = 0;
      78              :     virtual muse::RetVal<muse::midi::tick_t> playPositionTickByElement(const engraving::EngravingItem* element) const = 0;
      79              : 
      80              :     enum BoundaryTick {
      81              :         FirstScoreTick = 0,
      82              :         SelectedNoteTick,
      83              :         LastScoreTick
      84              :     };
      85              : 
      86              :     virtual void addLoopBoundary(LoopBoundaryType boundaryType, muse::midi::tick_t tick) = 0;
      87              :     virtual void setLoopBoundariesEnabled(bool enabled) = 0;
      88              :     virtual bool isLoopEnabled() const = 0;
      89              :     virtual muse::async::Channel<bool> loopEnabledChanged() const = 0;
      90              :     virtual const LoopBoundaries& loopBoundaries() const = 0;
      91              :     virtual muse::async::Notification loopBoundariesChanged() const = 0;
      92              : 
      93              :     virtual const Tempo& multipliedTempo(muse::midi::tick_t tick) const = 0;
      94              :     virtual engraving::MeasureBeat beat(muse::midi::tick_t tick) const = 0;
      95              :     virtual muse::midi::tick_t beatToRawTick(int measureIndex, int beatIndex) const = 0;
      96              : 
      97              :     virtual double tempoMultiplier() const = 0;
      98              :     virtual void setTempoMultiplier(double multiplier) = 0;
      99              : 
     100              :     virtual void addSoundFlags(const std::vector<mu::engraving::StaffText*>& staffTextList) = 0;
     101              :     virtual void removeSoundFlags(const engraving::InstrumentTrackIdSet& trackIdSet) = 0;
     102              :     virtual bool hasSoundFlags(const engraving::InstrumentTrackIdSet& trackIdSet) = 0;
     103              : };
     104              : 
     105              : using INotationPlaybackPtr = std::shared_ptr<INotationPlayback>;
     106              : }