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) 2024 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              : #pragma once
      23              : 
      24              : #include "async/channel.h"
      25              : #include "io/iodevice.h"
      26              : #include "io/path.h"
      27              : #include "types/ret.h"
      28              : 
      29              : #include "engraving/types/types.h"
      30              : 
      31              : namespace mu::engraving {
      32              : class MscReader;
      33              : }
      34              : 
      35              : namespace mu::notation {
      36              : class INotationSoloMuteState
      37              : {
      38              : public:
      39              :     struct SoloMuteState {
      40              :         bool mute = false;
      41              :         bool solo = false;
      42              : 
      43            0 :         bool operator ==(const SoloMuteState& other) const
      44              :         {
      45            0 :             return mute == other.mute
      46            0 :                    && solo == other.solo;
      47              :         }
      48              :     };
      49              : 
      50            0 :     virtual ~INotationSoloMuteState() = default;
      51              : 
      52              :     virtual muse::Ret read(const engraving::MscReader& reader, const muse::io::path_t& pathPrefix = "") = 0;
      53              :     virtual muse::Ret write(muse::io::IODevice* out) = 0;
      54              : 
      55              :     virtual bool trackSoloMuteStateExists(const engraving::InstrumentTrackId& trackId) const = 0;
      56              :     virtual const SoloMuteState& trackSoloMuteState(const engraving::InstrumentTrackId& trackId) const = 0;
      57              :     virtual void setTrackSoloMuteState(const engraving::InstrumentTrackId& trackId, const SoloMuteState& state) = 0;
      58              :     virtual void removeTrackSoloMuteState(const engraving::InstrumentTrackId& trackId) = 0;
      59              :     virtual muse::async::Channel<engraving::InstrumentTrackId, SoloMuteState> trackSoloMuteStateChanged() const = 0;
      60              : };
      61              : 
      62              : using INotationSoloMuteStatePtr = std::shared_ptr<INotationSoloMuteState>;
      63              : }