prymula/com: DPF-Prymula-audioplugins/dpf/distrho/src/jackbridge/rtmidi/RtMidi.h annotate

annotate DPF-Prymula-audioplugins/dpf/distrho/src/jackbridge/rtmidi/RtMidi.h @ 3:84e66ea83026

DPF-Prymula-audioplugins-0.231015-2

author	prymula <prymula76@outlook.com>
date	Mon, 16 Oct 2023 21:53:34 +0200
parents
children

rev	line source
3 84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1 /**********************************************************************/
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	2 /*! \class RtMidi
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	3 \brief An abstract base class for realtime MIDI input/output.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	4
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	5 This class implements some common functionality for the realtime
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	6 MIDI input/output subclasses RtMidiIn and RtMidiOut.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	7
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	8 RtMidi GitHub site: https://github.com/thestk/rtmidi
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	9 RtMidi WWW site: http://www.music.mcgill.ca/~gary/rtmidi/
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	10
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	11 RtMidi: realtime MIDI i/o C++ classes
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	12 Copyright (c) 2003-2021 Gary P. Scavone
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	13
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	14 Permission is hereby granted, free of charge, to any person
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	15 obtaining a copy of this software and associated documentation files
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	16 (the "Software"), to deal in the Software without restriction,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	17 including without limitation the rights to use, copy, modify, merge,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	18 publish, distribute, sublicense, and/or sell copies of the Software,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	19 and to permit persons to whom the Software is furnished to do so,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	20 subject to the following conditions:
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	21
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	22 The above copyright notice and this permission notice shall be
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	23 included in all copies or substantial portions of the Software.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	24
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	25 Any person wishing to distribute modifications to the Software is
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	26 asked to send the modifications to the original developer so that
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	27 they can be incorporated into the canonical version. This is,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	28 however, not a binding provision of this license.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	29
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	30 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	31 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	32 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	33 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	34 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	35 CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	36 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	37 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	38 /**********************************************************************/
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	39
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	40 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	41 \file RtMidi.h
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	42 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	43
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	44 #ifndef RTMIDI_H
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	45 #define RTMIDI_H
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	46
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	47 #if defined _WIN32 \|\| defined __CYGWIN__
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	48 #if defined(RTMIDI_EXPORT)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	49 #define RTMIDI_DLL_PUBLIC __declspec(dllexport)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	50 #else
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	51 #define RTMIDI_DLL_PUBLIC
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	52 #endif
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	53 #else
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	54 #if __GNUC__ >= 4
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	55 #define RTMIDI_DLL_PUBLIC __attribute__( (visibility( "default" )) )
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	56 #else
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	57 #define RTMIDI_DLL_PUBLIC
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	58 #endif
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	59 #endif
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	60
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	61 #define RTMIDI_VERSION "5.0.0"
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	62
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	63 #include <exception>
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	64 #include <iostream>
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	65 #include <string>
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	66 #include <vector>
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	67
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	68
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	69 /************************************************************************/
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	70 /*! \class RtMidiError
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	71 \brief Exception handling class for RtMidi.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	72
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	73 The RtMidiError class is quite simple but it does allow errors to be
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	74 "caught" by RtMidiError::Type. See the RtMidi documentation to know
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	75 which methods can throw an RtMidiError.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	76 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	77 /************************************************************************/
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	78
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	79 class RTMIDI_DLL_PUBLIC RtMidiError : public std::exception
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	80 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	81 public:
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	82 //! Defined RtMidiError types.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	83 enum Type {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	84 WARNING, /!< A non-critical error. /
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	85 DEBUG_WARNING, /!< A non-critical error which might be useful for debugging. /
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	86 UNSPECIFIED, /!< The default, unspecified error type. /
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	87 NO_DEVICES_FOUND, /!< No devices found on system. /
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	88 INVALID_DEVICE, /!< An invalid device ID was specified. /
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	89 MEMORY_ERROR, /!< An error occured during memory allocation. /
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	90 INVALID_PARAMETER, /!< An invalid parameter was specified to a function. /
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	91 INVALID_USE, /!< The function was called incorrectly. /
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	92 DRIVER_ERROR, /!< A system driver error occured. /
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	93 SYSTEM_ERROR, /!< A system error occured. /
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	94 THREAD_ERROR /!< A thread error occured. /
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	95 };
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	96
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	97 //! The constructor.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	98 RtMidiError( const std::string& message, Type type = RtMidiError::UNSPECIFIED ) throw()
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	99 : message_(message), type_(type) {}
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	100
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	101 //! The destructor.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	102 virtual ~RtMidiError( void ) throw() {}
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	103
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	104 //! Prints thrown error message to stderr.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	105 virtual void printMessage( void ) const throw() { std::cerr << '\n' << message_ << "\n\n"; }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	106
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	107 //! Returns the thrown error message type.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	108 virtual const Type& getType( void ) const throw() { return type_; }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	109
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	110 //! Returns the thrown error message string.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	111 virtual const std::string& getMessage( void ) const throw() { return message_; }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	112
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	113 //! Returns the thrown error message as a c-style string.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	114 virtual const char* what( void ) const throw() { return message_.c_str(); }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	115
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	116 protected:
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	117 std::string message_;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	118 Type type_;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	119 };
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	120
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	121 //! RtMidi error callback function prototype.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	122 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	123 \param type Type of error.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	124 \param errorText Error description.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	125
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	126 Note that class behaviour is undefined after a critical error (not
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	127 a warning) is reported.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	128 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	129 typedef void (RtMidiErrorCallback)( RtMidiError::Type type, const std::string &errorText, void userData );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	130
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	131 class MidiApi;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	132
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	133 class RTMIDI_DLL_PUBLIC RtMidi
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	134 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	135 public:
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	136
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	137 RtMidi(RtMidi&& other) noexcept;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	138 //! MIDI API specifier arguments.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	139 enum Api {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	140 UNSPECIFIED, /!< Search for a working compiled API. /
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	141 MACOSX_CORE, /!< Macintosh OS-X CoreMIDI API. /
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	142 LINUX_ALSA, /!< The Advanced Linux Sound Architecture API. /
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	143 UNIX_JACK, /!< The JACK Low-Latency MIDI Server API. /
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	144 WINDOWS_MM, /!< The Microsoft Multimedia MIDI API. /
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	145 RTMIDI_DUMMY, /!< A compilable but non-functional API. /
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	146 WEB_MIDI_API, /!< W3C Web MIDI API. /
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	147 NUM_APIS /!< Number of values in this enum. /
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	148 };
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	149
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	150 //! A static function to determine the current RtMidi version.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	151 static std::string getVersion( void ) throw();
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	152
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	153 //! A static function to determine the available compiled MIDI APIs.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	154 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	155 The values returned in the std::vector can be compared against
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	156 the enumerated list values. Note that there can be more than one
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	157 API compiled for certain operating systems.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	158 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	159 static void getCompiledApi( std::vector<RtMidi::Api> &apis ) throw();
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	160
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	161 //! Return the name of a specified compiled MIDI API.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	162 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	163 This obtains a short lower-case name used for identification purposes.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	164 This value is guaranteed to remain identical across library versions.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	165 If the API is unknown, this function will return the empty string.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	166 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	167 static std::string getApiName( RtMidi::Api api );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	168
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	169 //! Return the display name of a specified compiled MIDI API.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	170 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	171 This obtains a long name used for display purposes.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	172 If the API is unknown, this function will return the empty string.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	173 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	174 static std::string getApiDisplayName( RtMidi::Api api );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	175
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	176 //! Return the compiled MIDI API having the given name.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	177 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	178 A case insensitive comparison will check the specified name
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	179 against the list of compiled APIs, and return the one which
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	180 matches. On failure, the function returns UNSPECIFIED.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	181 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	182 static RtMidi::Api getCompiledApiByName( const std::string &name );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	183
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	184 //! Pure virtual openPort() function.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	185 virtual void openPort( unsigned int portNumber = 0, const std::string &portName = std::string( "RtMidi" ) ) = 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	186
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	187 //! Pure virtual openVirtualPort() function.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	188 virtual void openVirtualPort( const std::string &portName = std::string( "RtMidi" ) ) = 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	189
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	190 //! Pure virtual getPortCount() function.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	191 virtual unsigned int getPortCount() = 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	192
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	193 //! Pure virtual getPortName() function.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	194 virtual std::string getPortName( unsigned int portNumber = 0 ) = 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	195
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	196 //! Pure virtual closePort() function.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	197 virtual void closePort( void ) = 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	198
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	199 void setClientName( const std::string &clientName );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	200 void setPortName( const std::string &portName );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	201
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	202 //! Returns true if a port is open and false if not.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	203 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	204 Note that this only applies to connections made with the openPort()
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	205 function, not to virtual ports.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	206 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	207 virtual bool isPortOpen( void ) const = 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	208
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	209 //! Set an error callback function to be invoked when an error has occured.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	210 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	211 The callback function will be called whenever an error has occured. It is best
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	212 to set the error callback function before opening a port.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	213 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	214 virtual void setErrorCallback( RtMidiErrorCallback errorCallback = NULL, void *userData = 0 ) = 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	215
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	216 protected:
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	217 RtMidi();
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	218 virtual ~RtMidi();
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	219 MidiApi *rtapi_;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	220
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	221 /* Make the class non-copyable */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	222 RtMidi(RtMidi& other) = delete;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	223 RtMidi& operator=(RtMidi& other) = delete;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	224 };
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	225
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	226 /**********************************************************************/
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	227 /*! \class RtMidiIn
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	228 \brief A realtime MIDI input class.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	229
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	230 This class provides a common, platform-independent API for
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	231 realtime MIDI input. It allows access to a single MIDI input
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	232 port. Incoming MIDI messages are either saved to a queue for
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	233 retrieval using the getMessage() function or immediately passed to
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	234 a user-specified callback function. Create multiple instances of
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	235 this class to connect to more than one MIDI device at the same
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	236 time. With the OS-X, Linux ALSA, and JACK MIDI APIs, it is also
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	237 possible to open a virtual input port to which other MIDI software
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	238 clients can connect.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	239 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	240 /**********************************************************************/
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	241
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	242 // **************************************************************** //
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	243 //
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	244 // RtMidiIn and RtMidiOut class declarations.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	245 //
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	246 // RtMidiIn / RtMidiOut are "controllers" used to select an available
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	247 // MIDI input or output interface. They present common APIs for the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	248 // user to call but all functionality is implemented by the classes
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	249 // MidiInApi, MidiOutApi and their subclasses. RtMidiIn and RtMidiOut
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	250 // each create an instance of a MidiInApi or MidiOutApi subclass based
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	251 // on the user's API choice. If no choice is made, they attempt to
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	252 // make a "logical" API selection.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	253 //
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	254 // **************************************************************** //
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	255
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	256 class RTMIDI_DLL_PUBLIC RtMidiIn : public RtMidi
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	257 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	258 public:
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	259 //! User callback function type definition.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	260 typedef void (RtMidiCallback)( double timeStamp, std::vector<unsigned char> message, void *userData );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	261
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	262 //! Default constructor that allows an optional api, client name and queue size.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	263 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	264 An exception will be thrown if a MIDI system initialization
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	265 error occurs. The queue size defines the maximum number of
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	266 messages that can be held in the MIDI queue (when not using a
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	267 callback function). If the queue size limit is reached,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	268 incoming messages will be ignored.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	269
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	270 If no API argument is specified and multiple API support has been
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	271 compiled, the default order of use is ALSA, JACK (Linux) and CORE,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	272 JACK (OS-X).
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	273
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	274 \param api An optional API id can be specified.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	275 \param clientName An optional client name can be specified. This
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	276 will be used to group the ports that are created
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	277 by the application.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	278 \param queueSizeLimit An optional size of the MIDI input queue can be specified.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	279 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	280 RtMidiIn( RtMidi::Api api=UNSPECIFIED,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	281 const std::string& clientName = "RtMidi Input Client",
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	282 unsigned int queueSizeLimit = 100 );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	283
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	284 RtMidiIn(RtMidiIn&& other) noexcept : RtMidi(std::move(other)) { }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	285
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	286 //! If a MIDI connection is still open, it will be closed by the destructor.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	287 ~RtMidiIn ( void ) throw();
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	288
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	289 //! Returns the MIDI API specifier for the current instance of RtMidiIn.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	290 RtMidi::Api getCurrentApi( void ) throw();
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	291
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	292 //! Open a MIDI input connection given by enumeration number.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	293 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	294 \param portNumber An optional port number greater than 0 can be specified.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	295 Otherwise, the default or first port found is opened.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	296 \param portName An optional name for the application port that is used to connect to portId can be specified.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	297 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	298 void openPort( unsigned int portNumber = 0, const std::string &portName = std::string( "RtMidi Input" ) );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	299
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	300 //! Create a virtual input port, with optional name, to allow software connections (OS X, JACK and ALSA only).
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	301 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	302 This function creates a virtual MIDI input port to which other
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	303 software applications can connect. This type of functionality
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	304 is currently only supported by the Macintosh OS-X, any JACK,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	305 and Linux ALSA APIs (the function returns an error for the other APIs).
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	306
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	307 \param portName An optional name for the application port that is
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	308 used to connect to portId can be specified.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	309 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	310 void openVirtualPort( const std::string &portName = std::string( "RtMidi Input" ) );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	311
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	312 //! Set a callback function to be invoked for incoming MIDI messages.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	313 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	314 The callback function will be called whenever an incoming MIDI
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	315 message is received. While not absolutely necessary, it is best
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	316 to set the callback function before opening a MIDI port to avoid
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	317 leaving some messages in the queue.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	318
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	319 \param callback A callback function must be given.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	320 \param userData Optionally, a pointer to additional data can be
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	321 passed to the callback function whenever it is called.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	322 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	323 void setCallback( RtMidiCallback callback, void *userData = 0 );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	324
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	325 //! Cancel use of the current callback function (if one exists).
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	326 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	327 Subsequent incoming MIDI messages will be written to the queue
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	328 and can be retrieved with the \e getMessage function.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	329 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	330 void cancelCallback();
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	331
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	332 //! Close an open MIDI connection (if one exists).
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	333 void closePort( void );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	334
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	335 //! Returns true if a port is open and false if not.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	336 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	337 Note that this only applies to connections made with the openPort()
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	338 function, not to virtual ports.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	339 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	340 virtual bool isPortOpen() const;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	341
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	342 //! Return the number of available MIDI input ports.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	343 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	344 \return This function returns the number of MIDI ports of the selected API.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	345 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	346 unsigned int getPortCount();
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	347
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	348 //! Return a string identifier for the specified MIDI input port number.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	349 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	350 \return The name of the port with the given Id is returned.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	351 \retval An empty string is returned if an invalid port specifier
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	352 is provided. User code should assume a UTF-8 encoding.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	353 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	354 std::string getPortName( unsigned int portNumber = 0 );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	355
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	356 //! Specify whether certain MIDI message types should be queued or ignored during input.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	357 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	358 By default, MIDI timing and active sensing messages are ignored
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	359 during message input because of their relative high data rates.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	360 MIDI sysex messages are ignored by default as well. Variable
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	361 values of "true" imply that the respective message type will be
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	362 ignored.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	363 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	364 void ignoreTypes( bool midiSysex = true, bool midiTime = true, bool midiSense = true );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	365
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	366 //! Fill the user-provided vector with the data bytes for the next available MIDI message in the input queue and return the event delta-time in seconds.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	367 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	368 This function returns immediately whether a new message is
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	369 available or not. A valid message is indicated by a non-zero
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	370 vector size. An exception is thrown if an error occurs during
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	371 message retrieval or an input connection was not previously
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	372 established.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	373 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	374 double getMessage( std::vector<unsigned char> *message );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	375
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	376 //! Set an error callback function to be invoked when an error has occured.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	377 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	378 The callback function will be called whenever an error has occured. It is best
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	379 to set the error callback function before opening a port.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	380 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	381 virtual void setErrorCallback( RtMidiErrorCallback errorCallback = NULL, void *userData = 0 );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	382
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	383 //! Set maximum expected incoming message size.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	384 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	385 For APIs that require manual buffer management, it can be useful to set the buffer
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	386 size and buffer count when expecting to receive large SysEx messages. Note that
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	387 currently this function has no effect when called after openPort(). The default
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	388 buffer size is 1024 with a count of 4 buffers, which should be sufficient for most
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	389 cases; as mentioned, this does not affect all API backends, since most either support
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	390 dynamically scalable buffers or take care of buffer handling themselves. It is
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	391 principally intended for users of the Windows MM backend who must support receiving
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	392 especially large messages.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	393 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	394 virtual void setBufferSize( unsigned int size, unsigned int count );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	395
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	396 protected:
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	397 void openMidiApi( RtMidi::Api api, const std::string &clientName, unsigned int queueSizeLimit );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	398 };
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	399
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	400 /**********************************************************************/
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	401 /*! \class RtMidiOut
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	402 \brief A realtime MIDI output class.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	403
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	404 This class provides a common, platform-independent API for MIDI
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	405 output. It allows one to probe available MIDI output ports, to
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	406 connect to one such port, and to send MIDI bytes immediately over
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	407 the connection. Create multiple instances of this class to
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	408 connect to more than one MIDI device at the same time. With the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	409 OS-X, Linux ALSA and JACK MIDI APIs, it is also possible to open a
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	410 virtual port to which other MIDI software clients can connect.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	411 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	412 /**********************************************************************/
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	413
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	414 class RTMIDI_DLL_PUBLIC RtMidiOut : public RtMidi
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	415 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	416 public:
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	417 //! Default constructor that allows an optional client name.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	418 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	419 An exception will be thrown if a MIDI system initialization error occurs.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	420
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	421 If no API argument is specified and multiple API support has been
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	422 compiled, the default order of use is ALSA, JACK (Linux) and CORE,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	423 JACK (OS-X).
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	424 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	425 RtMidiOut( RtMidi::Api api=UNSPECIFIED,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	426 const std::string& clientName = "RtMidi Output Client" );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	427
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	428 RtMidiOut(RtMidiOut&& other) noexcept : RtMidi(std::move(other)) { }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	429
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	430 //! The destructor closes any open MIDI connections.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	431 ~RtMidiOut( void ) throw();
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	432
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	433 //! Returns the MIDI API specifier for the current instance of RtMidiOut.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	434 RtMidi::Api getCurrentApi( void ) throw();
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	435
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	436 //! Open a MIDI output connection.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	437 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	438 An optional port number greater than 0 can be specified.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	439 Otherwise, the default or first port found is opened. An
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	440 exception is thrown if an error occurs while attempting to make
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	441 the port connection.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	442 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	443 void openPort( unsigned int portNumber = 0, const std::string &portName = std::string( "RtMidi Output" ) );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	444
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	445 //! Close an open MIDI connection (if one exists).
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	446 void closePort( void );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	447
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	448 //! Returns true if a port is open and false if not.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	449 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	450 Note that this only applies to connections made with the openPort()
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	451 function, not to virtual ports.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	452 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	453 virtual bool isPortOpen() const;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	454
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	455 //! Create a virtual output port, with optional name, to allow software connections (OS X, JACK and ALSA only).
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	456 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	457 This function creates a virtual MIDI output port to which other
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	458 software applications can connect. This type of functionality
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	459 is currently only supported by the Macintosh OS-X, Linux ALSA
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	460 and JACK APIs (the function does nothing with the other APIs).
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	461 An exception is thrown if an error occurs while attempting to
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	462 create the virtual port.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	463 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	464 void openVirtualPort( const std::string &portName = std::string( "RtMidi Output" ) );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	465
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	466 //! Return the number of available MIDI output ports.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	467 unsigned int getPortCount( void );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	468
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	469 //! Return a string identifier for the specified MIDI port type and number.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	470 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	471 \return The name of the port with the given Id is returned.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	472 \retval An empty string is returned if an invalid port specifier
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	473 is provided. User code should assume a UTF-8 encoding.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	474 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	475 std::string getPortName( unsigned int portNumber = 0 );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	476
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	477 //! Immediately send a single message out an open MIDI output port.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	478 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	479 An exception is thrown if an error occurs during output or an
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	480 output connection was not previously established.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	481 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	482 void sendMessage( const std::vector<unsigned char> *message );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	483
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	484 //! Immediately send a single message out an open MIDI output port.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	485 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	486 An exception is thrown if an error occurs during output or an
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	487 output connection was not previously established.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	488
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	489 \param message A pointer to the MIDI message as raw bytes
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	490 \param size Length of the MIDI message in bytes
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	491 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	492 void sendMessage( const unsigned char *message, size_t size );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	493
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	494 //! Set an error callback function to be invoked when an error has occured.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	495 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	496 The callback function will be called whenever an error has occured. It is best
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	497 to set the error callback function before opening a port.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	498 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	499 virtual void setErrorCallback( RtMidiErrorCallback errorCallback = NULL, void *userData = 0 );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	500
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	501 protected:
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	502 void openMidiApi( RtMidi::Api api, const std::string &clientName );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	503 };
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	504
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	505
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	506 // **************************************************************** //
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	507 //
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	508 // MidiInApi / MidiOutApi class declarations.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	509 //
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	510 // Subclasses of MidiInApi and MidiOutApi contain all API- and
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	511 // OS-specific code necessary to fully implement the RtMidi API.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	512 //
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	513 // Note that MidiInApi and MidiOutApi are abstract base classes and
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	514 // cannot be explicitly instantiated. RtMidiIn and RtMidiOut will
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	515 // create instances of a MidiInApi or MidiOutApi subclass.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	516 //
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	517 // **************************************************************** //
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	518
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	519 class RTMIDI_DLL_PUBLIC MidiApi
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	520 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	521 public:
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	522
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	523 MidiApi();
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	524 virtual ~MidiApi();
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	525 virtual RtMidi::Api getCurrentApi( void ) = 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	526 virtual void openPort( unsigned int portNumber, const std::string &portName ) = 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	527 virtual void openVirtualPort( const std::string &portName ) = 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	528 virtual void closePort( void ) = 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	529 virtual void setClientName( const std::string &clientName ) = 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	530 virtual void setPortName( const std::string &portName ) = 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	531
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	532 virtual unsigned int getPortCount( void ) = 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	533 virtual std::string getPortName( unsigned int portNumber ) = 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	534
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	535 inline bool isPortOpen() const { return connected_; }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	536 void setErrorCallback( RtMidiErrorCallback errorCallback, void *userData );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	537
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	538 //! A basic error reporting function for RtMidi classes.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	539 void error( RtMidiError::Type type, std::string errorString );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	540
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	541 protected:
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	542 virtual void initialize( const std::string& clientName ) = 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	543
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	544 void *apiData_;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	545 bool connected_;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	546 std::string errorString_;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	547 RtMidiErrorCallback errorCallback_;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	548 bool firstErrorOccurred_;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	549 void *errorCallbackUserData_;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	550
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	551 };
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	552
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	553 class RTMIDI_DLL_PUBLIC MidiInApi : public MidiApi
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	554 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	555 public:
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	556
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	557 MidiInApi( unsigned int queueSizeLimit );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	558 virtual ~MidiInApi( void );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	559 void setCallback( RtMidiIn::RtMidiCallback callback, void *userData );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	560 void cancelCallback( void );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	561 virtual void ignoreTypes( bool midiSysex, bool midiTime, bool midiSense );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	562 double getMessage( std::vector<unsigned char> *message );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	563 virtual void setBufferSize( unsigned int size, unsigned int count );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	564
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	565 // A MIDI structure used internally by the class to store incoming
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	566 // messages. Each message represents one and only one MIDI message.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	567 struct MidiMessage {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	568 std::vector<unsigned char> bytes;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	569
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	570 //! Time in seconds elapsed since the previous message
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	571 double timeStamp;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	572
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	573 // Default constructor.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	574 MidiMessage()
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	575 : bytes(0), timeStamp(0.0) {}
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	576 };
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	577
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	578 struct MidiQueue {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	579 unsigned int front;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	580 unsigned int back;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	581 unsigned int ringSize;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	582 MidiMessage *ring;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	583
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	584 // Default constructor.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	585 MidiQueue()
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	586 : front(0), back(0), ringSize(0), ring(0) {}
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	587 bool push( const MidiMessage& );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	588 bool pop( std::vector<unsigned char>, double );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	589 unsigned int size( unsigned int back=0, unsigned int front=0 );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	590 };
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	591
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	592 // The RtMidiInData structure is used to pass private class data to
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	593 // the MIDI input handling function or thread.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	594 struct RtMidiInData {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	595 MidiQueue queue;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	596 MidiMessage message;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	597 unsigned char ignoreFlags;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	598 bool doInput;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	599 bool firstMessage;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	600 void *apiData;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	601 bool usingCallback;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	602 RtMidiIn::RtMidiCallback userCallback;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	603 void *userData;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	604 bool continueSysex;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	605 unsigned int bufferSize;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	606 unsigned int bufferCount;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	607
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	608 // Default constructor.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	609 RtMidiInData()
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	610 : ignoreFlags(7), doInput(false), firstMessage(true), apiData(0), usingCallback(false),
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	611 userCallback(0), userData(0), continueSysex(false), bufferSize(1024), bufferCount(4) {}
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	612 };
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	613
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	614 protected:
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	615 RtMidiInData inputData_;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	616 };
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	617
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	618 class RTMIDI_DLL_PUBLIC MidiOutApi : public MidiApi
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	619 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	620 public:
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	621
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	622 MidiOutApi( void );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	623 virtual ~MidiOutApi( void );
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	624 virtual void sendMessage( const unsigned char *message, size_t size ) = 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	625 };
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	626
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	627 // **************************************************************** //
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	628 //
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	629 // Inline RtMidiIn and RtMidiOut definitions.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	630 //
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	631 // **************************************************************** //
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	632
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	633 inline RtMidi::Api RtMidiIn :: getCurrentApi( void ) throw() { return rtapi_->getCurrentApi(); }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	634 inline void RtMidiIn :: openPort( unsigned int portNumber, const std::string &portName ) { rtapi_->openPort( portNumber, portName ); }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	635 inline void RtMidiIn :: openVirtualPort( const std::string &portName ) { rtapi_->openVirtualPort( portName ); }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	636 inline void RtMidiIn :: closePort( void ) { rtapi_->closePort(); }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	637 inline bool RtMidiIn :: isPortOpen() const { return rtapi_->isPortOpen(); }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	638 inline void RtMidiIn :: setCallback( RtMidiCallback callback, void userData ) { static_cast<MidiInApi >(rtapi_)->setCallback( callback, userData ); }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	639 inline void RtMidiIn :: cancelCallback( void ) { static_cast<MidiInApi *>(rtapi_)->cancelCallback(); }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	640 inline unsigned int RtMidiIn :: getPortCount( void ) { return rtapi_->getPortCount(); }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	641 inline std::string RtMidiIn :: getPortName( unsigned int portNumber ) { return rtapi_->getPortName( portNumber ); }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	642 inline void RtMidiIn :: ignoreTypes( bool midiSysex, bool midiTime, bool midiSense ) { static_cast<MidiInApi *>(rtapi_)->ignoreTypes( midiSysex, midiTime, midiSense ); }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	643 inline double RtMidiIn :: getMessage( std::vector<unsigned char> message ) { return static_cast<MidiInApi >(rtapi_)->getMessage( message ); }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	644 inline void RtMidiIn :: setErrorCallback( RtMidiErrorCallback errorCallback, void *userData ) { rtapi_->setErrorCallback(errorCallback, userData); }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	645 inline void RtMidiIn :: setBufferSize( unsigned int size, unsigned int count ) { static_cast<MidiInApi *>(rtapi_)->setBufferSize(size, count); }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	646
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	647 inline RtMidi::Api RtMidiOut :: getCurrentApi( void ) throw() { return rtapi_->getCurrentApi(); }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	648 inline void RtMidiOut :: openPort( unsigned int portNumber, const std::string &portName ) { rtapi_->openPort( portNumber, portName ); }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	649 inline void RtMidiOut :: openVirtualPort( const std::string &portName ) { rtapi_->openVirtualPort( portName ); }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	650 inline void RtMidiOut :: closePort( void ) { rtapi_->closePort(); }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	651 inline bool RtMidiOut :: isPortOpen() const { return rtapi_->isPortOpen(); }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	652 inline unsigned int RtMidiOut :: getPortCount( void ) { return rtapi_->getPortCount(); }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	653 inline std::string RtMidiOut :: getPortName( unsigned int portNumber ) { return rtapi_->getPortName( portNumber ); }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	654 inline void RtMidiOut :: sendMessage( const std::vector<unsigned char> message ) { static_cast<MidiOutApi >(rtapi_)->sendMessage( &message->at(0), message->size() ); }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	655 inline void RtMidiOut :: sendMessage( const unsigned char message, size_t size ) { static_cast<MidiOutApi >(rtapi_)->sendMessage( message, size ); }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	656 inline void RtMidiOut :: setErrorCallback( RtMidiErrorCallback errorCallback, void *userData ) { rtapi_->setErrorCallback(errorCallback, userData); }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	657
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	658 #endif

Mercurial > hg > pub > prymula > com

annotate DPF-Prymula-audioplugins/dpf/distrho/src/jackbridge/rtmidi/RtMidi.h @ 3:84e66ea83026