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              : #ifndef MUSE_MIDI_IMIDIOUTPORT_H
      23              : #define MUSE_MIDI_IMIDIOUTPORT_H
      24              : 
      25              : #include "modularity/imoduleinterface.h"
      26              : 
      27              : #include "types/ret.h"
      28              : #include "async/notification.h"
      29              : #include "miditypes.h"
      30              : 
      31              : namespace muse::midi {
      32              : class IMidiOutPort : MODULE_GLOBAL_INTERFACE
      33              : {
      34            0 :     INTERFACE_ID(IMidiOutPort)
      35              : 
      36              : public:
      37            0 :     virtual ~IMidiOutPort() = default;
      38              : 
      39              :     virtual MidiDeviceList availableDevices() const = 0;
      40              :     virtual async::Notification availableDevicesChanged() const = 0;
      41              : 
      42              :     virtual Ret connect(const MidiDeviceID& deviceID) = 0;
      43              :     virtual void disconnect() = 0;
      44              :     virtual bool isConnected() const = 0;
      45              :     virtual MidiDeviceID deviceID() const = 0;
      46              :     virtual async::Notification deviceChanged() const = 0;
      47              : 
      48              :     // Whether the output port supports it, rather than whether the receiver supports it
      49              :     // (If the receiver does not support MIDI 2.0, then it's the output port's resposibility to convert to MIDI 1.0)
      50              :     virtual bool supportsMIDI20Output() const = 0;
      51              : 
      52              :     virtual Ret sendEvent(const Event& e) = 0;
      53              : };
      54              : }
      55              : 
      56              : #endif // MUSE_MIDI_IMIDIPORT_H