089b7ad4c6
I will keep working on the Docbook version, but as I'm still not completely comfortable with that as final choice, I'm playing around with this as well. The String.cpp file contained doxygen documentation for almost all methods, I copied those to a new file (string.dox) and grouped them accordingly. (Done because Axel is absolutely against in-header or in-source docs) Integrated the BMidiConsumer and BMidiLocalConsumer class into the same file (like I did now to the producers), since I think it's better to keep a 1:1 relation with the headers. Removed the mididefs.dox file and replaced it with the midi2/Midi2Defs.dox file which actually documents the Midi2Defs.h file, rather than contain a custom page that was somewhat hard to find. Please see http://www.myhouserules.nl/haiku_book/index.html for a generated book from the current source. I actually quite like the output so far, though I'm aware of the fact that I needed to perform some tricks to let Doxygen get to this point. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@19651 a95241bf-73f2-0310-859d-f6bbb57e9c96
280 lines
2.6 KiB
Plaintext
280 lines
2.6 KiB
Plaintext
/*!
|
|
\file Midi2Defs.h
|
|
\ingroup midi2
|
|
*/
|
|
|
|
/*!
|
|
\name Channel Message Masks
|
|
\brief Some definitions to define the raw MIDI events.
|
|
|
|
The default implementation of BMidiLocalConsumer::Data() uses these constants
|
|
to determine which event has been passed on. If you override that method, you
|
|
may use the constants yourself.
|
|
*/
|
|
|
|
//! @{
|
|
|
|
/*!
|
|
\var B_NOTE_OFF
|
|
*/
|
|
|
|
/*!
|
|
\var B_NOTE_ON
|
|
*/
|
|
|
|
/*!
|
|
\var B_KEY_PRESSURE
|
|
*/
|
|
|
|
/*!
|
|
\var B_CONTROL_CHANGE
|
|
*/
|
|
|
|
/*!
|
|
\var B_PROGRAM_CHANGE
|
|
*/
|
|
|
|
/*!
|
|
\var B_CHANNEL_PRESSURE
|
|
*/
|
|
|
|
/*!
|
|
\var B_PITCH_BEND
|
|
*/
|
|
|
|
//! @}
|
|
|
|
|
|
/*!
|
|
\name System Messages
|
|
\brief Some definitions to define the raw MIDI system messages.
|
|
|
|
The default implementation of BMidiLocalConsumer::Data() uses these constants
|
|
to determine which event system message has been passed on. See
|
|
BMidiLocalProducer::SpraySystemCommon() and BMidiLocalProducer::SpraySystemRealTime()
|
|
for more details on how and when to use these messages.
|
|
*/
|
|
|
|
//! @{
|
|
|
|
/*!
|
|
\var B_SYS_EX_START
|
|
*/
|
|
|
|
/*!
|
|
\var B_MIDI_TIME_CODE
|
|
*/
|
|
|
|
/*!
|
|
\var B_SONG_POSITION
|
|
*/
|
|
|
|
/*!
|
|
\var B_SONG_SELECT
|
|
*/
|
|
|
|
/*!
|
|
\var B_CABLE_MESSAGE
|
|
*/
|
|
|
|
/*!
|
|
\var B_TUNE_REQUEST
|
|
*/
|
|
|
|
/*!
|
|
\var B_SYS_EX_END
|
|
*/
|
|
|
|
/*!
|
|
\var B_TIMING_CLOCK
|
|
*/
|
|
|
|
/*!
|
|
\var B_START
|
|
*/
|
|
|
|
/*!
|
|
\var B_CONTINUE
|
|
*/
|
|
|
|
/*!
|
|
\var B_STOP
|
|
*/
|
|
|
|
/*!
|
|
\var B_ACTIVE_SENSING
|
|
*/
|
|
|
|
/*!
|
|
\var B_SYSTEM_RESET
|
|
*/
|
|
|
|
//! @}
|
|
|
|
/*!
|
|
\name Controller Numbers
|
|
\brief Constants that represent specific controller messages.
|
|
|
|
These constants can be used in BMidiLocalProducer::SprayControlChange()
|
|
and BMidiLocalConsumer::ControlChange(). These constants represent the
|
|
MIDI specification.
|
|
*/
|
|
|
|
//! @{
|
|
|
|
|
|
*/
|
|
|
|
/*!
|
|
\var B_MODULATION
|
|
*/
|
|
|
|
/*!
|
|
\var B_BREATH_CONTROLLER
|
|
*/
|
|
|
|
/*!
|
|
\var B_FOOT_CONTROLLER
|
|
*/
|
|
|
|
/*!
|
|
\var B_PORTAMENTO_TIME
|
|
*/
|
|
|
|
/*!
|
|
\var B_DATA_ENTRY
|
|
*/
|
|
|
|
/*!
|
|
\var B_MAIN_VOLUME
|
|
*/
|
|
|
|
/*!
|
|
\var B_MIDI_BALANCE
|
|
*/
|
|
|
|
/*!
|
|
\var B_PAN
|
|
*/
|
|
|
|
/*!
|
|
\var B_EXPRESSION_CTRL
|
|
*/
|
|
|
|
/*!
|
|
\var B_GENERAL_CTRL_1
|
|
*/
|
|
|
|
/*!
|
|
\var B_GENERAL_CTRL_2
|
|
*/
|
|
|
|
/*!
|
|
\var B_GENERAL_CTRL_3
|
|
*/
|
|
|
|
/*!
|
|
\var B_GENERAL_CTRL_4
|
|
*/
|
|
|
|
/*!
|
|
\var B_SUSTAIN_PEDAL
|
|
*/
|
|
|
|
/*!
|
|
\var B_PORTAMENTO
|
|
*/
|
|
|
|
/*!
|
|
\var B_SOSTENUTO
|
|
*/
|
|
|
|
/*!
|
|
\var B_SOFT_PEDAL
|
|
*/
|
|
|
|
/*!
|
|
\var B_HOLD_2
|
|
*/
|
|
|
|
/*!
|
|
\var B_GENERAL_CTRL_5
|
|
*/
|
|
|
|
/*!
|
|
\var B_GENERAL_CTRL_6
|
|
*/
|
|
|
|
/*!
|
|
\var B_TEMPO_CHANGE
|
|
*/
|
|
|
|
/*!
|
|
\var B_GENERAL_CTRL_7
|
|
*/
|
|
|
|
/*!
|
|
\var B_GENERAL_CTRL_8
|
|
*/
|
|
|
|
/*!
|
|
\var B_EFFECTS_DEPTH
|
|
*/
|
|
|
|
/*!
|
|
\var B_TREMOLO_DEPTH
|
|
*/
|
|
|
|
/*!
|
|
\var B_CHORUS_DEPTH
|
|
*/
|
|
|
|
/*!
|
|
\var B_CELESTE_DEPTH
|
|
*/
|
|
|
|
/*!
|
|
\var B_PHASER_DEPTH
|
|
*/
|
|
|
|
/*!
|
|
\var B_DATA_INCREMENT
|
|
*/
|
|
|
|
/*!
|
|
\var B_DATA_DECREMENT
|
|
*/
|
|
|
|
/*!
|
|
\var B_RESET_ALL_CONTROLLERS
|
|
*/
|
|
|
|
/*!
|
|
\var B_LOCAL_CONTROL
|
|
*/
|
|
|
|
/*!
|
|
\var B_ALL_NOTES_OFF
|
|
*/
|
|
|
|
/*!
|
|
\var B_OMNI_MODE_OFF
|
|
*/
|
|
|
|
/*!
|
|
\var B_OMNI_MODE_ON
|
|
*/
|
|
|
|
/*!
|
|
\var B_MONO_MODE_ON
|
|
*/
|
|
|
|
/*!
|
|
\var B_POLY_MODE_ON
|
|
*/
|
|
|
|
|
|
//! @}
|
|
|
|
|