From 6164e2c5fee5d3a1622c27e36d9402976054e99d Mon Sep 17 00:00:00 2001 From: Francois Best Date: Fri, 18 Apr 2014 14:56:15 +0200 Subject: [PATCH 01/17] Fix issue #13 on GitHub. --- src/MIDI.hpp | 28 +++++++++++++--------------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/src/MIDI.hpp b/src/MIDI.hpp index 7a154c2..789f524 100644 --- a/src/MIDI.hpp +++ b/src/MIDI.hpp @@ -483,24 +483,22 @@ inline bool MidiInterface::read(Channel inChannel) if (inChannel >= MIDI_CHANNEL_OFF) return false; // MIDI Input disabled. - if (parse()) + if (!parse()) + return false; + + handleNullVelocityNoteOnAsNoteOff(); + const bool channelMatch = inputFilter(inChannel); + + if (MIDI_USE_CALLBACKS && channelMatch) { - handleNullVelocityNoteOnAsNoteOff(); - if (inputFilter(inChannel)) - { - -#if (MIDI_BUILD_OUTPUT && MIDI_BUILD_THRU) - thruFilter(inChannel); -#endif - -#if MIDI_USE_CALLBACKS - launchCallback(); -#endif - return true; - } + launchCallback(); } - return false; +#if MIDI_BUILD_THRU + thruFilter(inChannel); +#endif + + return channelMatch; } // ----------------------------------------------------------------------------- From c2a87ea0c9ea2506ac6e6d3d8a0cef9600db478b Mon Sep 17 00:00:00 2001 From: Francois Best Date: Fri, 18 Apr 2014 14:56:41 +0200 Subject: [PATCH 02/17] Doc. --- src/midi_Defs.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/midi_Defs.h b/src/midi_Defs.h index 324f361..6da132d 100644 --- a/src/midi_Defs.h +++ b/src/midi_Defs.h @@ -203,6 +203,8 @@ struct Message /*! \brief Create an instance of the library attached to a serial port. You can use HardwareSerial or SoftwareSerial for the serial port. + Example: MIDI_CREATE_INSTANCE(HardwareSerial, Serial2, midi2); + Then call midi2.begin(), midi2.read() etc.. */ #define MIDI_CREATE_INSTANCE(Type, SerialPort, Name) \ midi::MidiInterface Name((Type&)SerialPort); From 410e51c91a344137cfc7d023152afc292b74df99 Mon Sep 17 00:00:00 2001 From: Francois Best Date: Sun, 20 Apr 2014 17:23:10 +0200 Subject: [PATCH 03/17] Template settings. --- src/MIDI.h | 2 +- src/MIDI.hpp | 390 +++++++++++++++++++++++--------------------- src/midi_Defs.h | 11 +- src/midi_Settings.h | 20 +++ 4 files changed, 228 insertions(+), 195 deletions(-) diff --git a/src/MIDI.h b/src/MIDI.h index 5575e32..6f21ec6 100644 --- a/src/MIDI.h +++ b/src/MIDI.h @@ -40,7 +40,7 @@ the hardware interface, meaning you can use HardwareSerial, SoftwareSerial or ak47's Uart classes. The only requirement is that the class implements the begin, read, write and available methods. */ -template +template class MidiInterface { public: diff --git a/src/MIDI.hpp b/src/MIDI.hpp index 7a154c2..b6df785 100644 --- a/src/MIDI.hpp +++ b/src/MIDI.hpp @@ -26,8 +26,8 @@ BEGIN_MIDI_NAMESPACE /// \brief Constructor for MidiInterface. -template -MidiInterface::MidiInterface(SerialPort& inSerial) +template +inline MidiInterface::MidiInterface(SerialPort& inSerial) : mSerial(inSerial) { #if MIDI_BUILD_INPUT && MIDI_USE_CALLBACKS @@ -56,8 +56,8 @@ MidiInterface::MidiInterface(SerialPort& inSerial) This is not really useful for the Arduino, as it is never called... */ -template -MidiInterface::~MidiInterface() +template +inline MidiInterface::~MidiInterface() { } @@ -69,21 +69,22 @@ MidiInterface::~MidiInterface() - Input channel set to 1 if no value is specified - Full thru mirroring */ -template -void MidiInterface::begin(Channel inChannel) +template +void MidiInterface::begin(Channel inChannel) { // Initialise the Serial port -#if defined(ARDUINO) - mSerial.begin(MIDI_BAUDRATE); -#elif defined(FSE_AVR) - mSerial. template open(); +#if defined(FSE_AVR) + mSerial. template open(); +#else + mSerial.begin(Settings::BaudRate); #endif -#if MIDI_BUILD_OUTPUT && MIDI_USE_RUNNING_STATUS - - mRunningStatus_TX = InvalidType; - -#endif // MIDI_BUILD_OUTPUT && MIDI_USE_RUNNING_STATUS +#if MIDI_BUILD_OUTPUT + if (Settings::UseRunningStatus) + { + mRunningStatus_TX = InvalidType; + } +#endif // MIDI_BUILD_OUTPUT #if MIDI_BUILD_INPUT @@ -133,22 +134,21 @@ void MidiInterface::begin(Channel inChannel) This is an internal method, use it only if you need to send raw data from your code, at your own risks. */ -template -void MidiInterface::send(MidiType inType, - DataByte inData1, - DataByte inData2, - Channel inChannel) +template +void MidiInterface::send(MidiType inType, + DataByte inData1, + DataByte inData2, + Channel inChannel) { // Then test if channel is valid if (inChannel >= MIDI_CHANNEL_OFF || inChannel == MIDI_CHANNEL_OMNI || inType < NoteOff) { - -#if MIDI_USE_RUNNING_STATUS - mRunningStatus_TX = InvalidType; -#endif - + if (Settings::UseRunningStatus) + { + mRunningStatus_TX = InvalidType; + } return; // Don't send anything } @@ -160,18 +160,20 @@ void MidiInterface::send(MidiType inType, const StatusByte status = getStatus(inType, inChannel); -#if MIDI_USE_RUNNING_STATUS - // Check Running Status - if (mRunningStatus_TX != status) + if (Settings::UseRunningStatus) { - // New message, memorise and send header - mRunningStatus_TX = status; - mSerial.write(mRunningStatus_TX); + if (mRunningStatus_TX != status) + { + // New message, memorise and send header + mRunningStatus_TX = status; + mSerial.write(mRunningStatus_TX); + } + } + else + { + // Don't care about running status, send the status byte. + mSerial.write(status); } -#else - // Don't care about running status, send the status byte. - mSerial.write(status); -#endif // Then send data mSerial.write(inData1); @@ -195,10 +197,10 @@ void MidiInterface::send(MidiType inType, Take a look at the values, names and frequencies of notes here: http://www.phys.unsw.edu.au/jw/notes.html */ -template -void MidiInterface::sendNoteOn(DataByte inNoteNumber, - DataByte inVelocity, - Channel inChannel) +template +void MidiInterface::sendNoteOn(DataByte inNoteNumber, + DataByte inVelocity, + Channel inChannel) { send(NoteOn, inNoteNumber, inVelocity, inChannel); } @@ -214,10 +216,10 @@ void MidiInterface::sendNoteOn(DataByte inNoteNumber, Take a look at the values, names and frequencies of notes here: http://www.phys.unsw.edu.au/jw/notes.html */ -template -void MidiInterface::sendNoteOff(DataByte inNoteNumber, - DataByte inVelocity, - Channel inChannel) +template +void MidiInterface::sendNoteOff(DataByte inNoteNumber, + DataByte inVelocity, + Channel inChannel) { send(NoteOff, inNoteNumber, inVelocity, inChannel); } @@ -226,9 +228,9 @@ void MidiInterface::sendNoteOff(DataByte inNoteNumber, \param inProgramNumber The Program to select (0 to 127). \param inChannel The channel on which the message will be sent (1 to 16). */ -template -void MidiInterface::sendProgramChange(DataByte inProgramNumber, - Channel inChannel) +template +void MidiInterface::sendProgramChange(DataByte inProgramNumber, + Channel inChannel) { send(ProgramChange, inProgramNumber, 0, inChannel); } @@ -239,10 +241,10 @@ void MidiInterface::sendProgramChange(DataByte inProgramNumber, \param inChannel The channel on which the message will be sent (1 to 16). @see MidiControlChangeNumber */ -template -void MidiInterface::sendControlChange(DataByte inControlNumber, - DataByte inControlValue, - Channel inChannel) +template +void MidiInterface::sendControlChange(DataByte inControlNumber, + DataByte inControlValue, + Channel inChannel) { send(ControlChange, inControlNumber, inControlValue, inChannel); } @@ -252,10 +254,10 @@ void MidiInterface::sendControlChange(DataByte inControlNumber, \param inPressure The amount of AfterTouch to apply (0 to 127). \param inChannel The channel on which the message will be sent (1 to 16). */ -template -void MidiInterface::sendPolyPressure(DataByte inNoteNumber, - DataByte inPressure, - Channel inChannel) +template +void MidiInterface::sendPolyPressure(DataByte inNoteNumber, + DataByte inPressure, + Channel inChannel) { send(AfterTouchPoly, inNoteNumber, inPressure, inChannel); } @@ -264,9 +266,9 @@ void MidiInterface::sendPolyPressure(DataByte inNoteNumber, \param inPressure The amount of AfterTouch to apply to all notes. \param inChannel The channel on which the message will be sent (1 to 16). */ -template -void MidiInterface::sendAfterTouch(DataByte inPressure, - Channel inChannel) +template +void MidiInterface::sendAfterTouch(DataByte inPressure, + Channel inChannel) { send(AfterTouchChannel, inPressure, 0, inChannel); } @@ -277,9 +279,9 @@ void MidiInterface::sendAfterTouch(DataByte inPressure, center value is 0. \param inChannel The channel on which the message will be sent (1 to 16). */ -template -void MidiInterface::sendPitchBend(int inPitchValue, - Channel inChannel) +template +void MidiInterface::sendPitchBend(int inPitchValue, + Channel inChannel) { const unsigned bend = inPitchValue - MIDI_PITCHBEND_MIN; send(PitchBend, (bend & 0x7f), (bend >> 7) & 0x7f, inChannel); @@ -292,11 +294,11 @@ void MidiInterface::sendPitchBend(int inPitchValue, and +1.0f (max upwards bend), center value is 0.0f. \param inChannel The channel on which the message will be sent (1 to 16). */ -template -void MidiInterface::sendPitchBend(double inPitchValue, - Channel inChannel) +template +void MidiInterface::sendPitchBend(double inPitchValue, + Channel inChannel) { - const int value = inPitchValue * MIDI_PITCHBEND_MAX; + const int value = inPitchValue * MIDI_PITCHBEND_MAX * Settings::Toto; sendPitchBend(value, inChannel); } @@ -309,29 +311,32 @@ void MidiInterface::sendPitchBend(double inPitchValue, default value for ArrayContainsBoundaries is set to 'false' for compatibility with previous versions of the library. */ -template -void MidiInterface::sendSysEx(unsigned inLength, - const byte* inArray, - bool inArrayContainsBoundaries) +template +void MidiInterface::sendSysEx(unsigned inLength, + const byte* inArray, + bool inArrayContainsBoundaries) { - if (inArrayContainsBoundaries == false) + const bool writeBeginEndBytes = !inArrayContainsBoundaries; + + if (writeBeginEndBytes) { mSerial.write(0xf0); + } - for (unsigned i = 0; i < inLength; ++i) - mSerial.write(inArray[i]); + for (unsigned i = 0; i < inLength; ++i) + { + mSerial.write(inArray[i]); + } + if (writeBeginEndBytes) + { mSerial.write(0xf7); } - else - { - for (unsigned i = 0; i < inLength; ++i) - mSerial.write(inArray[i]); - } -#if MIDI_USE_RUNNING_STATUS - mRunningStatus_TX = InvalidType; -#endif + if (Settings::UseRunningStatus) + { + mRunningStatus_TX = InvalidType; + } } /*! \brief Send a Tune Request message. @@ -339,8 +344,8 @@ void MidiInterface::sendSysEx(unsigned inLength, When a MIDI unit receives this message, it should tune its oscillators (if equipped with any). */ -template -void MidiInterface::sendTuneRequest() +template +void MidiInterface::sendTuneRequest() { sendRealTime(TuneRequest); } @@ -351,9 +356,9 @@ void MidiInterface::sendTuneRequest() \param inValuesNibble MTC data See MIDI Specification for more information. */ -template -void MidiInterface::sendTimeCodeQuarterFrame(DataByte inTypeNibble, - DataByte inValuesNibble) +template +void MidiInterface::sendTimeCodeQuarterFrame(DataByte inTypeNibble, + DataByte inValuesNibble) { const byte data = (((inTypeNibble & 0x07) << 4) | (inValuesNibble & 0x0f)); sendTimeCodeQuarterFrame(data); @@ -365,42 +370,45 @@ void MidiInterface::sendTimeCodeQuarterFrame(DataByte inTypeNibble, \param inData if you want to encode directly the nibbles in your program, you can send the byte here. */ -template -void MidiInterface::sendTimeCodeQuarterFrame(DataByte inData) +template +void MidiInterface::sendTimeCodeQuarterFrame(DataByte inData) { mSerial.write((byte)TimeCodeQuarterFrame); mSerial.write(inData); -#if MIDI_USE_RUNNING_STATUS - mRunningStatus_TX = InvalidType; -#endif + if (Settings::UseRunningStatus) + { + mRunningStatus_TX = InvalidType; + } } /*! \brief Send a Song Position Pointer message. \param inBeats The number of beats since the start of the song. */ -template -void MidiInterface::sendSongPosition(unsigned inBeats) +template +void MidiInterface::sendSongPosition(unsigned inBeats) { mSerial.write((byte)SongPosition); mSerial.write(inBeats & 0x7f); mSerial.write((inBeats >> 7) & 0x7f); -#if MIDI_USE_RUNNING_STATUS - mRunningStatus_TX = InvalidType; -#endif + if (Settings::UseRunningStatus) + { + mRunningStatus_TX = InvalidType; + } } /*! \brief Send a Song Select message */ -template -void MidiInterface::sendSongSelect(DataByte inSongNumber) +template +void MidiInterface::sendSongSelect(DataByte inSongNumber) { mSerial.write((byte)SongSelect); mSerial.write(inSongNumber & 0x7f); -#if MIDI_USE_RUNNING_STATUS - mRunningStatus_TX = InvalidType; -#endif + if (Settings::UseRunningStatus) + { + mRunningStatus_TX = InvalidType; + } } /*! \brief Send a Real Time (one byte) message. @@ -410,8 +418,8 @@ void MidiInterface::sendSongSelect(DataByte inSongNumber) You can also send a Tune Request with this method. @see MidiType */ -template -void MidiInterface::sendRealTime(MidiType inType) +template +void MidiInterface::sendRealTime(MidiType inType) { switch (inType) { @@ -432,18 +440,19 @@ void MidiInterface::sendRealTime(MidiType inType) // Do not cancel Running Status for real-time messages as they can be // interleaved within any message. Though, TuneRequest can be sent here, // and as it is a System Common message, it must reset Running Status. -#if MIDI_USE_RUNNING_STATUS - if (inType == TuneRequest) mRunningStatus_TX = InvalidType; -#endif + if (Settings::UseRunningStatus && inType == TuneRequest) + { + mRunningStatus_TX = InvalidType; + } } /*! @} */ // End of doc group MIDI Output // ----------------------------------------------------------------------------- -template -StatusByte MidiInterface::getStatus(MidiType inType, - Channel inChannel) const +template +StatusByte MidiInterface::getStatus(MidiType inType, + Channel inChannel) const { return ((byte)inType | ((inChannel - 1) & 0x0f)); } @@ -469,16 +478,16 @@ StatusByte MidiInterface::getStatus(MidiType inType, it is sent back on the MIDI output. @see see setInputChannel() */ -template -inline bool MidiInterface::read() +template +inline bool MidiInterface::read() { return read(mInputChannel); } /*! \brief Read messages on a specified channel. */ -template -inline bool MidiInterface::read(Channel inChannel) +template +inline bool MidiInterface::read(Channel inChannel) { if (inChannel >= MIDI_CHANNEL_OFF) return false; // MIDI Input disabled. @@ -506,8 +515,8 @@ inline bool MidiInterface::read(Channel inChannel) // ----------------------------------------------------------------------------- // Private method: MIDI parser -template -bool MidiInterface::parse() +template +bool MidiInterface::parse() { if (mSerial.available() == 0) // No data available. @@ -770,24 +779,26 @@ bool MidiInterface::parse() // Then update the index of the pending message. mPendingMessageIndex++; -#if USE_1BYTE_PARSING - // Message is not complete. - return false; -#else - // Call the parser recursively - // to parse the rest of the message. - return parse(); -#endif + if (Settings::Use1ByteParsing) + { + // Message is not complete. + return false; + } + else + { + // Call the parser recursively to parse the rest of the message. + return parse(); + } } } } // Private method, see midi_Settings.h for documentation -template -inline void MidiInterface::handleNullVelocityNoteOnAsNoteOff() +template +inline void MidiInterface::handleNullVelocityNoteOnAsNoteOff() { - #if MIDI_HANDLE_NULL_VELOCITY_NOTE_ON_AS_NOTE_OFF - if (getType() == NoteOn && getData2() == 0) + if (Settings::HandleNullVelocityNoteOnAsNoteOff && + getType() == NoteOn && getData2() == 0) { mMessage.type = NoteOff; } @@ -795,8 +806,8 @@ inline void MidiInterface::handleNullVelocityNoteOnAsNoteOff() } // Private method: check if the received message is on the listened channel -template -inline bool MidiInterface::inputFilter(Channel inChannel) +template +inline bool MidiInterface::inputFilter(Channel inChannel) { // This method handles recognition of channel // (to know if the message is destinated to the Arduino) @@ -827,8 +838,8 @@ inline bool MidiInterface::inputFilter(Channel inChannel) } // Private method: reset input attributes -template -inline void MidiInterface::resetInput() +template +inline void MidiInterface::resetInput() { mPendingMessageIndex = 0; mPendingMessageExpectedLenght = 0; @@ -841,8 +852,8 @@ inline void MidiInterface::resetInput() Returns an enumerated type. @see MidiType */ -template -MidiType MidiInterface::getType() const +template +MidiType MidiInterface::getType() const { return mMessage.type; } @@ -852,22 +863,22 @@ MidiType MidiInterface::getType() const \return Channel range is 1 to 16. For non-channel messages, this will return 0. */ -template -Channel MidiInterface::getChannel() const +template +Channel MidiInterface::getChannel() const { return mMessage.channel; } /*! \brief Get the first data byte of the last received message. */ -template -DataByte MidiInterface::getData1() const +template +DataByte MidiInterface::getData1() const { return mMessage.data1; } /*! \brief Get the second data byte of the last received message. */ -template -DataByte MidiInterface::getData2() const +template +DataByte MidiInterface::getData2() const { return mMessage.data2; } @@ -876,8 +887,8 @@ DataByte MidiInterface::getData2() const @see getSysExArrayLength to get the array's length in bytes. */ -template -const byte* MidiInterface::getSysExArray() const +template +const byte* MidiInterface::getSysExArray() const { return mMessage.sysexArray; } @@ -887,24 +898,25 @@ const byte* MidiInterface::getSysExArray() const It is coded using data1 as LSB and data2 as MSB. \return The array's length, in bytes. */ -template -unsigned MidiInterface::getSysExArrayLength() const +template +unsigned MidiInterface::getSysExArrayLength() const { - const unsigned size = ((unsigned)(mMessage.data2) << 8) | mMessage.data1; - return (size > MIDI_SYSEX_ARRAY_SIZE) ? MIDI_SYSEX_ARRAY_SIZE : size; + static const unsigned maxSize = Settings::SysExArraySize; + const unsigned size = (unsigned(mMessage.data2) << 8) | mMessage.data1; + return (size > maxSize) ? maxSize : size; } /*! \brief Check if a valid message is stored in the structure. */ -template -bool MidiInterface::check() const +template +bool MidiInterface::check() const { return mMessage.valid; } // ----------------------------------------------------------------------------- -template -Channel MidiInterface::getInputChannel() const +template +Channel MidiInterface::getInputChannel() const { return mInputChannel; } @@ -913,8 +925,8 @@ Channel MidiInterface::getInputChannel() const \param inChannel the channel value. Valid values are 1 to 16, MIDI_CHANNEL_OMNI if you want to listen to all channels, and MIDI_CHANNEL_OFF to disable input. */ -template -void MidiInterface::setInputChannel(Channel inChannel) +template +void MidiInterface::setInputChannel(Channel inChannel) { mInputChannel = inChannel; } @@ -926,8 +938,8 @@ void MidiInterface::setInputChannel(Channel inChannel) This is a utility static method, used internally, made public so you can handle MidiTypes more easily. */ -template -MidiType MidiInterface::getTypeFromStatusByte(byte inStatus) +template +MidiType MidiInterface::getTypeFromStatusByte(byte inStatus) { if ((inStatus < 0x80) || (inStatus == 0xf4) || @@ -949,14 +961,14 @@ MidiType MidiInterface::getTypeFromStatusByte(byte inStatus) /*! \brief Returns channel in the range 1-16 */ -template -inline Channel MidiInterface::getChannelFromStatusByte(byte inStatus) +template +inline Channel MidiInterface::getChannelFromStatusByte(byte inStatus) { return (inStatus & 0x0f) + 1; } -template -bool MidiInterface::isChannelMessage(MidiType inType) +template +bool MidiInterface::isChannelMessage(MidiType inType) { return (inType == NoteOff || inType == NoteOn || @@ -975,24 +987,24 @@ bool MidiInterface::isChannelMessage(MidiType inType) @{ */ -template void MidiInterface::setHandleNoteOff(void (*fptr)(byte channel, byte note, byte velocity)) { mNoteOffCallback = fptr; } -template void MidiInterface::setHandleNoteOn(void (*fptr)(byte channel, byte note, byte velocity)) { mNoteOnCallback = fptr; } -template void MidiInterface::setHandleAfterTouchPoly(void (*fptr)(byte channel, byte note, byte pressure)) { mAfterTouchPolyCallback = fptr; } -template void MidiInterface::setHandleControlChange(void (*fptr)(byte channel, byte number, byte value)) { mControlChangeCallback = fptr; } -template void MidiInterface::setHandleProgramChange(void (*fptr)(byte channel, byte number)) { mProgramChangeCallback = fptr; } -template void MidiInterface::setHandleAfterTouchChannel(void (*fptr)(byte channel, byte pressure)) { mAfterTouchChannelCallback = fptr; } -template void MidiInterface::setHandlePitchBend(void (*fptr)(byte channel, int bend)) { mPitchBendCallback = fptr; } -template void MidiInterface::setHandleSystemExclusive(void (*fptr)(byte* array, byte size)) { mSystemExclusiveCallback = fptr; } -template void MidiInterface::setHandleTimeCodeQuarterFrame(void (*fptr)(byte data)) { mTimeCodeQuarterFrameCallback = fptr; } -template void MidiInterface::setHandleSongPosition(void (*fptr)(unsigned beats)) { mSongPositionCallback = fptr; } -template void MidiInterface::setHandleSongSelect(void (*fptr)(byte songnumber)) { mSongSelectCallback = fptr; } -template void MidiInterface::setHandleTuneRequest(void (*fptr)(void)) { mTuneRequestCallback = fptr; } -template void MidiInterface::setHandleClock(void (*fptr)(void)) { mClockCallback = fptr; } -template void MidiInterface::setHandleStart(void (*fptr)(void)) { mStartCallback = fptr; } -template void MidiInterface::setHandleContinue(void (*fptr)(void)) { mContinueCallback = fptr; } -template void MidiInterface::setHandleStop(void (*fptr)(void)) { mStopCallback = fptr; } -template void MidiInterface::setHandleActiveSensing(void (*fptr)(void)) { mActiveSensingCallback = fptr; } -template void MidiInterface::setHandleSystemReset(void (*fptr)(void)) { mSystemResetCallback = fptr; } +template void MidiInterface::setHandleNoteOff(void (*fptr)(byte channel, byte note, byte velocity)) { mNoteOffCallback = fptr; } +template void MidiInterface::setHandleNoteOn(void (*fptr)(byte channel, byte note, byte velocity)) { mNoteOnCallback = fptr; } +template void MidiInterface::setHandleAfterTouchPoly(void (*fptr)(byte channel, byte note, byte pressure)) { mAfterTouchPolyCallback = fptr; } +template void MidiInterface::setHandleControlChange(void (*fptr)(byte channel, byte number, byte value)) { mControlChangeCallback = fptr; } +template void MidiInterface::setHandleProgramChange(void (*fptr)(byte channel, byte number)) { mProgramChangeCallback = fptr; } +template void MidiInterface::setHandleAfterTouchChannel(void (*fptr)(byte channel, byte pressure)) { mAfterTouchChannelCallback = fptr; } +template void MidiInterface::setHandlePitchBend(void (*fptr)(byte channel, int bend)) { mPitchBendCallback = fptr; } +template void MidiInterface::setHandleSystemExclusive(void (*fptr)(byte* array, byte size)) { mSystemExclusiveCallback = fptr; } +template void MidiInterface::setHandleTimeCodeQuarterFrame(void (*fptr)(byte data)) { mTimeCodeQuarterFrameCallback = fptr; } +template void MidiInterface::setHandleSongPosition(void (*fptr)(unsigned beats)) { mSongPositionCallback = fptr; } +template void MidiInterface::setHandleSongSelect(void (*fptr)(byte songnumber)) { mSongSelectCallback = fptr; } +template void MidiInterface::setHandleTuneRequest(void (*fptr)(void)) { mTuneRequestCallback = fptr; } +template void MidiInterface::setHandleClock(void (*fptr)(void)) { mClockCallback = fptr; } +template void MidiInterface::setHandleStart(void (*fptr)(void)) { mStartCallback = fptr; } +template void MidiInterface::setHandleContinue(void (*fptr)(void)) { mContinueCallback = fptr; } +template void MidiInterface::setHandleStop(void (*fptr)(void)) { mStopCallback = fptr; } +template void MidiInterface::setHandleActiveSensing(void (*fptr)(void)) { mActiveSensingCallback = fptr; } +template void MidiInterface::setHandleSystemReset(void (*fptr)(void)) { mSystemResetCallback = fptr; } /*! \brief Detach an external function from the given type. @@ -1000,8 +1012,8 @@ template void MidiInterface::setHandleSystemReset( \param inType The type of message to unbind. When a message of this type is received, no function will be called. */ -template -void MidiInterface::disconnectCallbackFromType(MidiType inType) +template +void MidiInterface::disconnectCallbackFromType(MidiType inType) { switch (inType) { @@ -1031,8 +1043,8 @@ void MidiInterface::disconnectCallbackFromType(MidiType inType) /*! @} */ // End of doc group MIDI Callbacks // Private - launch callback function based on received type. -template -void MidiInterface::launchCallback() +template +void MidiInterface::launchCallback() { // The order is mixed to allow frequent messages to trigger their callback faster. switch (mMessage.type) @@ -1092,8 +1104,8 @@ void MidiInterface::launchCallback() @see MidiFilterMode */ -template -void MidiInterface::setThruFilterMode(MidiFilterMode inThruFilterMode) +template +void MidiInterface::setThruFilterMode(MidiFilterMode inThruFilterMode) { mThruFilterMode = inThruFilterMode; if (mThruFilterMode != Off) @@ -1102,27 +1114,27 @@ void MidiInterface::setThruFilterMode(MidiFilterMode inThruFilterMod mThruActivated = false; } -template -MidiFilterMode MidiInterface::getFilterMode() const +template +MidiFilterMode MidiInterface::getFilterMode() const { return mThruFilterMode; } -template -bool MidiInterface::getThruState() const +template +bool MidiInterface::getThruState() const { return mThruActivated; } -template -void MidiInterface::turnThruOn(MidiFilterMode inThruFilterMode) +template +void MidiInterface::turnThruOn(MidiFilterMode inThruFilterMode) { mThruActivated = true; mThruFilterMode = inThruFilterMode; } -template -void MidiInterface::turnThruOff() +template +void MidiInterface::turnThruOff() { mThruActivated = false; mThruFilterMode = Off; @@ -1136,8 +1148,8 @@ void MidiInterface::turnThruOff() // to output unless filter is set to Off. // - Channel messages are passed to the output whether their channel // is matching the input channel and the filter setting -template -void MidiInterface::thruFilter(Channel inChannel) +template +void MidiInterface::thruFilter(Channel inChannel) { // If the feature is disabled, don't do anything. if (!mThruActivated || (mThruFilterMode == Off)) diff --git a/src/midi_Defs.h b/src/midi_Defs.h index 324f361..dc2b29a 100644 --- a/src/midi_Defs.h +++ b/src/midi_Defs.h @@ -207,11 +207,12 @@ struct Message #define MIDI_CREATE_INSTANCE(Type, SerialPort, Name) \ midi::MidiInterface Name((Type&)SerialPort); -/*! \brief Shortcut for MIDI Interface class with template argument. - The class name for a MIDI object using the hardware UART would be - midi::MidiInterface, when the macro is MIDI_CLASS(HardwareSerial). +/*! \brief Create an instance of the library attached to a serial port with + custom settings. + @see DefaultSettings + @see MIDI_CREATE_INSTANCE */ -#define MIDI_CLASS(Type) \ - midi::MidiInterface +#define MIDI_CREATE_CUSTOM_INSTANCE(Type, SerialPort, Name, Settings) \ + midi::MidiInterface Name((Type&)SerialPort); END_MIDI_NAMESPACE diff --git a/src/midi_Settings.h b/src/midi_Settings.h index cd2d021..f2ea338 100644 --- a/src/midi_Settings.h +++ b/src/midi_Settings.h @@ -99,4 +99,24 @@ BEGIN_MIDI_NAMESPACE +/*! \brief Default Settings Traits struct + To change the default settings, don't edit them there, create a subclass and + override the values in that subclass, then use the MIDI_CREATE_CUSTOM_INSTANCE + macro to create your instance. The settings you don't override will keep their + default value. Eg: + struct MySettings : public midi::DefaultSettings + { + static const bool UseRunningStatus = false; // Messes with my old equipment! + }; + MIDI_CREATE_CUSTOM_INSTANCE(HardwareSerial, Serial2, midi, MySettings); + */ +struct DefaultSettings +{ + static const bool UseRunningStatus = true; + static const bool HandleNullVelocityNoteOnAsNoteOff = true; + static const bool Use1ByteParsing = true; + static const unsigned BaudRate = 31250; + static const unsigned SysExArraySize = 128; +}; + END_MIDI_NAMESPACE From f88012b38fb3179339ee2fc5a3a35b59145ed891 Mon Sep 17 00:00:00 2001 From: Francois Best Date: Sun, 20 Apr 2014 17:24:35 +0200 Subject: [PATCH 04/17] Removed auto-instanciation --- src/MIDI.cpp | 21 --------------- src/MIDI.h | 63 ++++++++++++++------------------------------- src/MIDI.hpp | 43 +++++++++++++++---------------- src/midi_Defs.h | 8 +++--- src/midi_Settings.h | 30 --------------------- 5 files changed, 45 insertions(+), 120 deletions(-) diff --git a/src/MIDI.cpp b/src/MIDI.cpp index b8f1c0c..fa356ce 100644 --- a/src/MIDI.cpp +++ b/src/MIDI.cpp @@ -25,27 +25,6 @@ // ----------------------------------------------------------------------------- -#if !(MIDI_BUILD_INPUT) && !(MIDI_BUILD_OUTPUT) -# error To use MIDI, you need to enable at least input or output. -#endif - -#if MIDI_BUILD_THRU && !(MIDI_BUILD_OUTPUT) -# error For thru to work, you need to enable output. -#endif -#if MIDI_BUILD_THRU && !(MIDI_BUILD_INPUT) -# error For thru to work, you need to enable input. -#endif - -// ----------------------------------------------------------------------------- - -#if MIDI_AUTO_INSTANCIATE && defined(ARDUINO) - MIDI_CREATE_INSTANCE(MIDI_DEFAULT_SERIAL_CLASS, - MIDI_DEFAULT_SERIAL_PORT, - MIDI); -#endif - -// ----------------------------------------------------------------------------- - BEGIN_MIDI_NAMESPACE /*! \brief Encode System Exclusive messages. diff --git a/src/MIDI.h b/src/MIDI.h index 6f21ec6..dc6baed 100644 --- a/src/MIDI.h +++ b/src/MIDI.h @@ -26,10 +26,6 @@ #include "midi_Settings.h" #include "midi_Defs.h" -#ifdef FSE_AVR -#include -#endif - // ----------------------------------------------------------------------------- BEGIN_MIDI_NAMESPACE @@ -44,8 +40,8 @@ template class MidiInterface { public: - MidiInterface(SerialPort& inSerial); - ~MidiInterface(); + inline MidiInterface(SerialPort& inSerial); + inline ~MidiInterface(); public: void begin(Channel inChannel = 1); @@ -53,8 +49,6 @@ public: // ------------------------------------------------------------------------- // MIDI Output -#if MIDI_BUILD_OUTPUT - public: inline void sendNoteOn(DataByte inNoteNumber, DataByte inVelocity, @@ -100,17 +94,9 @@ public: DataByte inData2, Channel inChannel); -private: - inline StatusByte getStatus(MidiType inType, - Channel inChannel) const; - -#endif // MIDI_BUILD_OUTPUT - // ------------------------------------------------------------------------- // MIDI Input -#if MIDI_BUILD_INPUT - public: inline bool read(); inline bool read(Channel inChannel); @@ -133,25 +119,10 @@ public: static inline Channel getChannelFromStatusByte(byte inStatus); static inline bool isChannelMessage(MidiType inType); -private: - bool parse(); - inline void handleNullVelocityNoteOnAsNoteOff(); - inline bool inputFilter(Channel inChannel); - inline void resetInput(); - -private: - StatusByte mRunningStatus_RX; - Channel mInputChannel; - byte mPendingMessage[3]; - unsigned mPendingMessageExpectedLenght; - unsigned mPendingMessageIndex; - Message mMessage; // ------------------------------------------------------------------------- // Input Callbacks -#if MIDI_USE_CALLBACKS - public: inline void setHandleNoteOff(void (*fptr)(byte channel, byte note, byte velocity)); inline void setHandleNoteOn(void (*fptr)(byte channel, byte note, byte velocity)); @@ -196,14 +167,9 @@ private: void (*mActiveSensingCallback)(void); void (*mSystemResetCallback)(void); -#endif // MIDI_USE_CALLBACKS -#endif // MIDI_BUILD_INPUT - // ------------------------------------------------------------------------- // MIDI Soft Thru -#if MIDI_BUILD_THRU - public: inline MidiFilterMode getFilterMode() const; inline bool getThruState() const; @@ -216,11 +182,28 @@ public: private: void thruFilter(byte inChannel); +private: + bool parse(); + inline void handleNullVelocityNoteOnAsNoteOff(); + inline bool inputFilter(Channel inChannel); + inline void resetInput(); + private: bool mThruActivated : 1; MidiFilterMode mThruFilterMode : 7; -#endif // MIDI_BUILD_THRU +private: + StatusByte mRunningStatus_RX; + Channel mInputChannel; + byte mPendingMessage[3]; + unsigned mPendingMessageExpectedLenght; + unsigned mPendingMessageIndex; + Message mMessage; + +private: + inline StatusByte getStatus(MidiType inType, + Channel inChannel) const; + #if MIDI_USE_RUNNING_STATUS @@ -241,10 +224,4 @@ END_MIDI_NAMESPACE // ----------------------------------------------------------------------------- -#if MIDI_AUTO_INSTANCIATE && defined(ARDUINO) - extern MIDI_NAMESPACE::MidiInterface MIDI; -#endif - -// ----------------------------------------------------------------------------- - #include "MIDI.hpp" diff --git a/src/MIDI.hpp b/src/MIDI.hpp index b6df785..2ffd715 100644 --- a/src/MIDI.hpp +++ b/src/MIDI.hpp @@ -143,7 +143,7 @@ void MidiInterface::send(MidiType inType, // Then test if channel is valid if (inChannel >= MIDI_CHANNEL_OFF || inChannel == MIDI_CHANNEL_OMNI || - inType < NoteOff) + inType < 0x80) { if (Settings::UseRunningStatus) { @@ -178,12 +178,14 @@ void MidiInterface::send(MidiType inType, // Then send data mSerial.write(inData1); if (inType != ProgramChange && inType != AfterTouchChannel) + { mSerial.write(inData2); - - return; + } } else if (inType >= TuneRequest && inType <= SystemReset) + { sendRealTime(inType); // System Real-time and 1 byte. + } } // ----------------------------------------------------------------------------- @@ -212,7 +214,7 @@ void MidiInterface::sendNoteOn(DataByte inNoteNumber, Note: you can send NoteOn with zero velocity to make a NoteOff, this is based on the Running Status principle, to avoid sending status messages and thus - sending only NoteOn data. This method will always send a real NoteOff message. + sending only NoteOn data. sendNoteOff will always send a real NoteOff message. Take a look at the values, names and frequencies of notes here: http://www.phys.unsw.edu.au/jw/notes.html */ @@ -492,24 +494,22 @@ inline bool MidiInterface::read(Channel inChannel) if (inChannel >= MIDI_CHANNEL_OFF) return false; // MIDI Input disabled. - if (parse()) + if (!parse()) + return false; + + handleNullVelocityNoteOnAsNoteOff(); + const bool channelMatch = inputFilter(inChannel); + + if (MIDI_USE_CALLBACKS && channelMatch) { - handleNullVelocityNoteOnAsNoteOff(); - if (inputFilter(inChannel)) - { - -#if (MIDI_BUILD_OUTPUT && MIDI_BUILD_THRU) - thruFilter(inChannel); -#endif - -#if MIDI_USE_CALLBACKS - launchCallback(); -#endif - return true; - } + launchCallback(); } - return false; +#if MIDI_BUILD_THRU + thruFilter(inChannel); +#endif + + return channelMatch; } // ----------------------------------------------------------------------------- @@ -802,7 +802,6 @@ inline void MidiInterface::handleNullVelocityNoteOnAsNoteO { mMessage.type = NoteOff; } - #endif } // Private method: check if the received message is on the listened channel @@ -953,10 +952,10 @@ MidiType MidiInterface::getTypeFromStatusByte(byte inStatu if (inStatus < 0xf0) { // Channel message, remove channel nibble. - return (MidiType)(inStatus & 0xf0); + return MidiType(inStatus & 0xf0); } - return (MidiType)inStatus; + return MidiType(inStatus); } /*! \brief Returns channel in the range 1-16 diff --git a/src/midi_Defs.h b/src/midi_Defs.h index dc2b29a..84315be 100644 --- a/src/midi_Defs.h +++ b/src/midi_Defs.h @@ -24,6 +24,7 @@ #pragma once #include "midi_Namespace.h" +#include "midi_Settings.h" #include BEGIN_MIDI_NAMESPACE @@ -39,8 +40,7 @@ BEGIN_MIDI_NAMESPACE // ----------------------------------------------------------------------------- // Type definitions -typedef uint8_t byte; - +typedef uint8_t byte; typedef byte StatusByte; typedef byte DataByte; typedef byte Channel; @@ -163,7 +163,6 @@ enum MidiControlChangeNumber */ struct Message { - /*! The MIDI channel on which the message was recieved. \n Value goes from 1 to 16. */ @@ -196,13 +195,14 @@ struct Message validity means the message respects the MIDI norm. */ bool valid; - }; // ----------------------------------------------------------------------------- /*! \brief Create an instance of the library attached to a serial port. You can use HardwareSerial or SoftwareSerial for the serial port. + Example: MIDI_CREATE_INSTANCE(HardwareSerial, Serial2, midi2); + Then call midi2.begin(), midi2.read() etc.. */ #define MIDI_CREATE_INSTANCE(Type, SerialPort, Name) \ midi::MidiInterface Name((Type&)SerialPort); diff --git a/src/midi_Settings.h b/src/midi_Settings.h index f2ea338..85270e8 100644 --- a/src/midi_Settings.h +++ b/src/midi_Settings.h @@ -44,36 +44,6 @@ #define MIDI_USE_CALLBACKS 1 -// ----------------------------------------------------------------------------- - -// Create a MIDI object automatically on the port defined with MIDI_SERIAL_PORT. -#ifndef MIDI_AUTO_INSTANCIATE -# ifdef ARDUINO -# define MIDI_AUTO_INSTANCIATE 1 -# else -# define MIDI_AUTO_INSTANCIATE 0 ///< @see MIDI_CREATE_INSTANCE -# endif -#endif - -// ----------------------------------------------------------------------------- -// Default serial port configuration (if MIDI_AUTO_INSTANCIATE is set) - -// Set the default port to use for MIDI. -#if MIDI_AUTO_INSTANCIATE -# ifdef ARDUINO -# include "Arduino.h" -# ifdef USBCON -# define MIDI_DEFAULT_SERIAL_PORT Serial1 // For Leonardo -# else -# define MIDI_DEFAULT_SERIAL_PORT Serial // For other Arduinos -# endif -# define MIDI_DEFAULT_SERIAL_CLASS HardwareSerial -# include "HardwareSerial.h" -# else -# error Auto-instanciation disabled. Use MIDI_CREATE_INSTANCE macro. -# endif -#endif - // ----------------------------------------------------------------------------- // Misc. options From 5454bd46bc33366de4b49509d8fe7027fd7ec697 Mon Sep 17 00:00:00 2001 From: Francois Best Date: Wed, 21 May 2014 08:29:47 +0200 Subject: [PATCH 05/17] No longer needs a power of two. --- res/Examples/MIDI_SimpleSynth/noteList.h | 2 -- 1 file changed, 2 deletions(-) diff --git a/res/Examples/MIDI_SimpleSynth/noteList.h b/res/Examples/MIDI_SimpleSynth/noteList.h index 559edc8..6d5885c 100644 --- a/res/Examples/MIDI_SimpleSynth/noteList.h +++ b/res/Examples/MIDI_SimpleSynth/noteList.h @@ -145,8 +145,6 @@ inline typename MidiNoteList::Cell& MidiNoteList::Cell::operator= (c template inline MidiNoteList::MidiNoteList() { - // Check that size is a power of two - //AVR_STATIC_ASSERT(Size != 0 && !(Size & (Size - 1))); } template From bcd3f8f33a492885b8e4803a246b16d69146d2fb Mon Sep 17 00:00:00 2001 From: Francois Best Date: Wed, 21 May 2014 08:30:15 +0200 Subject: [PATCH 06/17] Low, High and Last playing modes. --- .../MIDI_SimpleSynth/MIDI_SimpleSynth.ino | 9 ++- res/Examples/MIDI_SimpleSynth/noteList.h | 65 +++++++++++++++++-- 2 files changed, 66 insertions(+), 8 deletions(-) diff --git a/res/Examples/MIDI_SimpleSynth/MIDI_SimpleSynth.ino b/res/Examples/MIDI_SimpleSynth/MIDI_SimpleSynth.ino index c44c441..205611a 100644 --- a/res/Examples/MIDI_SimpleSynth/MIDI_SimpleSynth.ino +++ b/res/Examples/MIDI_SimpleSynth/MIDI_SimpleSynth.ino @@ -41,8 +41,13 @@ void handleNotesChanged() } else { + // Possible playing modes: + // Mono Low: use midiNotes.getLow + // Mono High: use midiNotes.getHigh + // Mono Last: use midiNotes.getLast + byte currentNote = 0; - if (midiNotes.getTail(currentNote)) + if (midiNotes.getLast(currentNote)) { tone(sAudioOutPin, sNotePitches[currentNote]); pulseGate(); // Retrigger envelopes. Remove for legato effect. @@ -67,7 +72,7 @@ void handleNoteOff(byte inChannel, byte inNote, byte inVelocity) // ----------------------------------------------------------------------------- void setup() -{ +{ pinMode(sGatePin, OUTPUT); pinMode(sAudioOutPin, OUTPUT); MIDI.setHandleNoteOn(handleNoteOn); diff --git a/res/Examples/MIDI_SimpleSynth/noteList.h b/res/Examples/MIDI_SimpleSynth/noteList.h index 6d5885c..c5b5190 100644 --- a/res/Examples/MIDI_SimpleSynth/noteList.h +++ b/res/Examples/MIDI_SimpleSynth/noteList.h @@ -65,7 +65,9 @@ public: public: inline bool get(byte inIndex, byte& outPitch) const; - inline bool getTail(byte& outPitch) const; + inline bool getLast(byte& outPitch) const; + inline bool getHigh(byte& outPitch) const; + inline bool getLow(byte& outPitch) const; public: inline bool empty() const; @@ -257,14 +259,65 @@ inline bool MidiNoteList::get(byte inIndex, byte& outPitch) const } template -inline bool MidiNoteList::getTail(byte& outPitch) const +inline bool MidiNoteList::getLast(byte& outPitch) const { - if (mTail) + if (!mTail) { - outPitch = mTail->note.pitch; - return true; + return false; } - return false; + + outPitch = mTail->note.pitch; + return true; +} + +template +inline bool MidiNoteList::getHigh(byte& outPitch) const +{ + if (!mTail) + { + return false; + } + + outPitch = 0; + const Cell* it = mTail; + for (byte i = 0; i < mSize; ++i) + { + if (it->note.pitch > outPitch) + { + outPitch = it->note.pitch; + } + + if (it->prev) + { + it = it->prev; + } + } + return true; +} + +template +inline bool MidiNoteList::getLow(byte& outPitch) const +{ + if (!mTail) + { + return false; + } + + outPitch = 0xff; + const Cell* it = mTail; + for (byte i = 0; i < mSize; ++i) + { + if (it->note.pitch < outPitch) + { + outPitch = it->note.pitch; + } + + if (it->prev) + { + it = it->prev; + } + } + return true; } // ----------------------------------------------------------------------------- From 532b0d38431ce0d25661870fb8fbb3838e6effa6 Mon Sep 17 00:00:00 2001 From: Francois Best Date: Wed, 21 May 2014 08:44:26 +0200 Subject: [PATCH 07/17] Doc. --- res/Examples/MIDI_SimpleSynth/noteList.h | 25 +++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/res/Examples/MIDI_SimpleSynth/noteList.h b/res/Examples/MIDI_SimpleSynth/noteList.h index c5b5190..5037a05 100644 --- a/res/Examples/MIDI_SimpleSynth/noteList.h +++ b/res/Examples/MIDI_SimpleSynth/noteList.h @@ -1,7 +1,8 @@ /*! - * \file synth-core_NoteList.h + * \file noteList.h * \author Francois Best * \date 24/05/2013 + * \brief Linked list of notes, for Low, Last & High playing modes. * \license GPL v3.0 - Copyright Forty Seven Effects 2013 * * This program is free software: you can redistribute it and/or modify @@ -156,6 +157,10 @@ inline MidiNoteList::~MidiNoteList() // ----------------------------------------------------------------------------- +/*! \brief Add a note, sorting it by time. + Call this when receiving a NoteOn event. This will add the new note as the tail + of the list. + */ template inline void MidiNoteList::add(const MidiNote& inNote) { @@ -186,6 +191,9 @@ inline void MidiNoteList::add(const MidiNote& inNote) print(); } +/*! \brief Remove a note + Call this when receiving a NoteOff event. + */ template inline void MidiNoteList::remove(byte inPitch) { @@ -235,6 +243,9 @@ inline void MidiNoteList::remove(byte inPitch) // ----------------------------------------------------------------------------- +/*! \brief Get a note at an arbitrary position + This can be interesting for duo/multi/polyphony operations. + */ template inline bool MidiNoteList::get(byte inIndex, byte& outPitch) const { @@ -258,6 +269,9 @@ inline bool MidiNoteList::get(byte inIndex, byte& outPitch) const return false; } +/*! \brief Get the last active note played + This implements the Mono Last playing mode. + */ template inline bool MidiNoteList::getLast(byte& outPitch) const { @@ -270,6 +284,9 @@ inline bool MidiNoteList::getLast(byte& outPitch) const return true; } +/*! \brief Get the highest pitched active note + This implements the Mono High playing mode. + */ template inline bool MidiNoteList::getHigh(byte& outPitch) const { @@ -295,6 +312,9 @@ inline bool MidiNoteList::getHigh(byte& outPitch) const return true; } +/*! \brief Get the lowest pitched active note + This implements the Mono Low playing mode. + */ template inline bool MidiNoteList::getLow(byte& outPitch) const { @@ -328,6 +348,8 @@ inline bool MidiNoteList::empty() const return mSize == 0; } +/*! \brief Get the number of active notes. + */ template inline byte MidiNoteList::size() const { @@ -335,6 +357,7 @@ inline byte MidiNoteList::size() const } // ----------------------------------------------------------------------------- +// Private implementations, for internal use only. template inline typename MidiNoteList::Cell* MidiNoteList::getFirstEmptyCell() From 7980d5f881e6f9b8e400c62691a1a17cd3ad781b Mon Sep 17 00:00:00 2001 From: Francois Best Date: Wed, 21 May 2014 08:55:12 +0200 Subject: [PATCH 08/17] Fixed gate logic. --- .../MIDI_SimpleSynth/MIDI_SimpleSynth.ino | 51 +++++++++---------- 1 file changed, 25 insertions(+), 26 deletions(-) diff --git a/res/Examples/MIDI_SimpleSynth/MIDI_SimpleSynth.ino b/res/Examples/MIDI_SimpleSynth/MIDI_SimpleSynth.ino index 205611a..18b3387 100644 --- a/res/Examples/MIDI_SimpleSynth/MIDI_SimpleSynth.ino +++ b/res/Examples/MIDI_SimpleSynth/MIDI_SimpleSynth.ino @@ -18,12 +18,12 @@ MidiNoteList midiNotes; // ----------------------------------------------------------------------------- -void handleGateChanged(bool inGateActive) +inline void handleGateChanged(bool inGateActive) { digitalWrite(sGatePin, inGateActive ? HIGH : LOW); } -void pulseGate() +inline void pulseGate() { handleGateChanged(false); delay(1); @@ -32,41 +32,40 @@ void pulseGate() // ----------------------------------------------------------------------------- -void handleNotesChanged() +void handleNoteOn(byte inChannel, byte inNote, byte inVelocity) { - if (midiNotes.empty()) - { - handleGateChanged(false); - noTone(sAudioOutPin); - } - else - { - // Possible playing modes: - // Mono Low: use midiNotes.getLow - // Mono High: use midiNotes.getHigh - // Mono Last: use midiNotes.getLast + const bool firstNote = midiNotes.empty(); + midiNotes.add(MidiNote(inNote, inVelocity)); + + // Possible playing modes: + // Mono Low: use midiNotes.getLow + // Mono High: use midiNotes.getHigh + // Mono Last: use midiNotes.getLast - byte currentNote = 0; - if (midiNotes.getLast(currentNote)) + byte currentNote = 0; + if (midiNotes.getLast(currentNote)) + { + tone(sAudioOutPin, sNotePitches[currentNote]); + + if (firstNote) + { + handleGateChanged(true); + } + else { - tone(sAudioOutPin, sNotePitches[currentNote]); pulseGate(); // Retrigger envelopes. Remove for legato effect. } } } -// ----------------------------------------------------------------------------- - -void handleNoteOn(byte inChannel, byte inNote, byte inVelocity) -{ - midiNotes.add(MidiNote(inNote, inVelocity)); - handleNotesChanged(); -} - void handleNoteOff(byte inChannel, byte inNote, byte inVelocity) { midiNotes.remove(inNote); - handleNotesChanged(); + if (midiNotes.empty()) + { + handleGateChanged(false); + noTone(sAudioOutPin); + } } // ----------------------------------------------------------------------------- From 97e2c554dec951c8ccd6383cd31b81e0b73366fe Mon Sep 17 00:00:00 2001 From: Francois Best Date: Wed, 21 May 2014 08:57:22 +0200 Subject: [PATCH 09/17] Revert "Fixed gate logic." This reverts commit 7980d5f881e6f9b8e400c62691a1a17cd3ad781b. --- .../MIDI_SimpleSynth/MIDI_SimpleSynth.ino | 61 ++++++++++--------- 1 file changed, 31 insertions(+), 30 deletions(-) diff --git a/res/Examples/MIDI_SimpleSynth/MIDI_SimpleSynth.ino b/res/Examples/MIDI_SimpleSynth/MIDI_SimpleSynth.ino index 18b3387..205611a 100644 --- a/res/Examples/MIDI_SimpleSynth/MIDI_SimpleSynth.ino +++ b/res/Examples/MIDI_SimpleSynth/MIDI_SimpleSynth.ino @@ -18,12 +18,12 @@ MidiNoteList midiNotes; // ----------------------------------------------------------------------------- -inline void handleGateChanged(bool inGateActive) +void handleGateChanged(bool inGateActive) { digitalWrite(sGatePin, inGateActive ? HIGH : LOW); } -inline void pulseGate() +void pulseGate() { handleGateChanged(false); delay(1); @@ -32,40 +32,41 @@ inline void pulseGate() // ----------------------------------------------------------------------------- -void handleNoteOn(byte inChannel, byte inNote, byte inVelocity) +void handleNotesChanged() { - const bool firstNote = midiNotes.empty(); - midiNotes.add(MidiNote(inNote, inVelocity)); - - // Possible playing modes: - // Mono Low: use midiNotes.getLow - // Mono High: use midiNotes.getHigh - // Mono Last: use midiNotes.getLast - - byte currentNote = 0; - if (midiNotes.getLast(currentNote)) - { - tone(sAudioOutPin, sNotePitches[currentNote]); - - if (firstNote) - { - handleGateChanged(true); - } - else - { - pulseGate(); // Retrigger envelopes. Remove for legato effect. - } - } -} - -void handleNoteOff(byte inChannel, byte inNote, byte inVelocity) -{ - midiNotes.remove(inNote); if (midiNotes.empty()) { handleGateChanged(false); noTone(sAudioOutPin); } + else + { + // Possible playing modes: + // Mono Low: use midiNotes.getLow + // Mono High: use midiNotes.getHigh + // Mono Last: use midiNotes.getLast + + byte currentNote = 0; + if (midiNotes.getLast(currentNote)) + { + tone(sAudioOutPin, sNotePitches[currentNote]); + pulseGate(); // Retrigger envelopes. Remove for legato effect. + } + } +} + +// ----------------------------------------------------------------------------- + +void handleNoteOn(byte inChannel, byte inNote, byte inVelocity) +{ + midiNotes.add(MidiNote(inNote, inVelocity)); + handleNotesChanged(); +} + +void handleNoteOff(byte inChannel, byte inNote, byte inVelocity) +{ + midiNotes.remove(inNote); + handleNotesChanged(); } // ----------------------------------------------------------------------------- From 9157f847ca9a750b48d384fae4b3fa944db825f1 Mon Sep 17 00:00:00 2001 From: Francois Best Date: Wed, 21 May 2014 09:01:29 +0200 Subject: [PATCH 10/17] Fix the fix. --- .../MIDI_SimpleSynth/MIDI_SimpleSynth.ino | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/res/Examples/MIDI_SimpleSynth/MIDI_SimpleSynth.ino b/res/Examples/MIDI_SimpleSynth/MIDI_SimpleSynth.ino index 205611a..0b6f560 100644 --- a/res/Examples/MIDI_SimpleSynth/MIDI_SimpleSynth.ino +++ b/res/Examples/MIDI_SimpleSynth/MIDI_SimpleSynth.ino @@ -18,12 +18,12 @@ MidiNoteList midiNotes; // ----------------------------------------------------------------------------- -void handleGateChanged(bool inGateActive) +inline void handleGateChanged(bool inGateActive) { digitalWrite(sGatePin, inGateActive ? HIGH : LOW); } -void pulseGate() +inline void pulseGate() { handleGateChanged(false); delay(1); @@ -32,7 +32,7 @@ void pulseGate() // ----------------------------------------------------------------------------- -void handleNotesChanged() +void handleNotesChanged(bool isFirstNote = false) { if (midiNotes.empty()) { @@ -50,7 +50,15 @@ void handleNotesChanged() if (midiNotes.getLast(currentNote)) { tone(sAudioOutPin, sNotePitches[currentNote]); - pulseGate(); // Retrigger envelopes. Remove for legato effect. + + if (isFirstNote) + { + handleGateChanged(true); + } + else + { + pulseGate(); // Retrigger envelopes. Remove for legato effect. + } } } } @@ -59,8 +67,9 @@ void handleNotesChanged() void handleNoteOn(byte inChannel, byte inNote, byte inVelocity) { + const bool firstNote = midiNotes.empty(); midiNotes.add(MidiNote(inNote, inVelocity)); - handleNotesChanged(); + handleNotesChanged(firstNote); } void handleNoteOff(byte inChannel, byte inNote, byte inVelocity) From db002130c9b0c7604307cda2f06049d30c0553da Mon Sep 17 00:00:00 2001 From: Francois Best Date: Wed, 21 May 2014 09:56:06 +0200 Subject: [PATCH 11/17] Improve performance by iterating from the tail when removing notes. --- res/Examples/MIDI_SimpleSynth/noteList.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/res/Examples/MIDI_SimpleSynth/noteList.h b/res/Examples/MIDI_SimpleSynth/noteList.h index 5037a05..18ef829 100644 --- a/res/Examples/MIDI_SimpleSynth/noteList.h +++ b/res/Examples/MIDI_SimpleSynth/noteList.h @@ -108,7 +108,7 @@ inline MidiNote::MidiNote(const MidiNote& inOther) inline MidiNote& MidiNote::operator= (const MidiNote& inOther) { - pitch = inOther.pitch; + pitch = inOther.pitch; velocity = inOther.velocity; return *this; } @@ -197,9 +197,9 @@ inline void MidiNoteList::add(const MidiNote& inNote) template inline void MidiNoteList::remove(byte inPitch) { - if (mHead != 0) + if (mTail != 0) { - for (Cell* it = mHead; it != 0; it = it->next) + for (Cell* it = mTail; it != 0; it = it->prev) { if (it->note.pitch == inPitch) { From 219340ea96ce947b78918d35af093f77e20ba4d6 Mon Sep 17 00:00:00 2001 From: Francois Best Date: Wed, 11 Jun 2014 09:09:08 +0200 Subject: [PATCH 12/17] Fix SysEx size callback bug, using template settings instead of preprocessor macros. --- res/Examples/MIDI_Basic_IO/MIDI_Basic_IO.ino | 4 +- .../MIDI_Callbacks/MIDI_Callbacks.ino | 28 ++++--- res/Examples/MIDI_Input/MIDI_Input.ino | 14 ++-- .../MIDI_SimpleSynth/MIDI_SimpleSynth.ino | 4 +- res/validator/validate.py | 51 +++++++----- src/MIDI.h | 20 +++-- src/MIDI.hpp | 77 +++++------------- src/midi_Defs.h | 63 +++++---------- src/midi_Message.h | 81 +++++++++++++++++++ src/midi_Settings.h | 73 ++++++++--------- 10 files changed, 225 insertions(+), 190 deletions(-) create mode 100644 src/midi_Message.h diff --git a/res/Examples/MIDI_Basic_IO/MIDI_Basic_IO.ino b/res/Examples/MIDI_Basic_IO/MIDI_Basic_IO.ino index c40a666..f6efee2 100644 --- a/res/Examples/MIDI_Basic_IO/MIDI_Basic_IO.ino +++ b/res/Examples/MIDI_Basic_IO/MIDI_Basic_IO.ino @@ -1,9 +1,11 @@ #include // Simple tutorial on how to receive and send MIDI messages. -// Here, when receiving any message on channel 4, the Arduino +// Here, when receiving any message on channel 4, the Arduino // will blink a led and play back a note for 1 second. +MIDI_CREATE_DEFAULT_INSTANCE(); + #define LED 13 // LED pin on Arduino Uno void setup() diff --git a/res/Examples/MIDI_Callbacks/MIDI_Callbacks.ino b/res/Examples/MIDI_Callbacks/MIDI_Callbacks.ino index b8043e7..642223b 100644 --- a/res/Examples/MIDI_Callbacks/MIDI_Callbacks.ino +++ b/res/Examples/MIDI_Callbacks/MIDI_Callbacks.ino @@ -1,33 +1,39 @@ #include +MIDI_CREATE_DEFAULT_INSTANCE(); + +// ----------------------------------------------------------------------------- + // This function will be automatically called when a NoteOn is received. // It must be a void-returning function with the correct parameters, // see documentation here: // http://arduinomidilib.fortyseveneffects.com/a00022.html -void HandleNoteOn(byte channel, byte pitch, byte velocity) +void handleNoteOn(byte channel, byte pitch, byte velocity) { - // Do whatever you want when you receive a Note On. - - if (velocity == 0) - { - // This acts like a NoteOff. You can ask the library to call the NoteOff - // callback when receiving null-velocity NoteOn messages. - // See MIDI_HANDLE_NULL_VELOCITY_NOTE_ON_AS_NOTE_OFF in midi_Settings.h - } + // Do whatever you want when a note is pressed. // Try to keep your callbacks short (no delays ect) // otherwise it would slow down the loop() and have a bad impact // on real-time performance. } +void handleNoteOff(byte channel, byte pitch, byte velocity) +{ + // Do something when the note is released. + // Note that NoteOn messages with 0 velocity are interpreted as NoteOffs. +} + // ----------------------------------------------------------------------------- void setup() { - // Connect the HandleNoteOn function to the library, + // Connect the handleNoteOn function to the library, // so it is called upon reception of a NoteOn. - MIDI.setHandleNoteOn(HandleNoteOn); // Put only the name of the function + MIDI.setHandleNoteOn(handleNoteOn); // Put only the name of the function + + // Do the same for NoteOffs + MIDI.setHandleNoteOff(handleNoteOff); // Initiate MIDI communications, listen to all channels MIDI.begin(MIDI_CHANNEL_OMNI); diff --git a/res/Examples/MIDI_Input/MIDI_Input.ino b/res/Examples/MIDI_Input/MIDI_Input.ino index e1bf0a9..4bdcb02 100644 --- a/res/Examples/MIDI_Input/MIDI_Input.ino +++ b/res/Examples/MIDI_Input/MIDI_Input.ino @@ -1,5 +1,9 @@ #include +MIDI_CREATE_DEFAULT_INSTANCE(); + +// ----------------------------------------------------------------------------- + // This example shows the old way of checking for input messages. // It's simpler to use the callbacks now, check out the dedicated example. @@ -8,7 +12,7 @@ // ----------------------------------------------------------------------------- void BlinkLed(byte num) // Basic blink function -{ +{ for (byte i=0;i MidiMessage; + private: StatusByte mRunningStatus_RX; + StatusByte mRunningStatus_TX; Channel mInputChannel; byte mPendingMessage[3]; unsigned mPendingMessageExpectedLenght; unsigned mPendingMessageIndex; - Message mMessage; + MidiMessage mMessage; private: inline StatusByte getStatus(MidiType inType, Channel inChannel) const; - - -#if MIDI_USE_RUNNING_STATUS -private: - StatusByte mRunningStatus_TX; -#endif - private: SerialPort& mSerial; }; diff --git a/src/MIDI.hpp b/src/MIDI.hpp index 2ffd715..b73abcc 100644 --- a/src/MIDI.hpp +++ b/src/MIDI.hpp @@ -79,18 +79,10 @@ void MidiInterface::begin(Channel inChannel) mSerial.begin(Settings::BaudRate); #endif -#if MIDI_BUILD_OUTPUT - if (Settings::UseRunningStatus) - { - mRunningStatus_TX = InvalidType; - } -#endif // MIDI_BUILD_OUTPUT - - -#if MIDI_BUILD_INPUT - mInputChannel = inChannel; + mRunningStatus_TX = InvalidType; mRunningStatus_RX = InvalidType; + mPendingMessageIndex = 0; mPendingMessageExpectedLenght = 0; @@ -100,25 +92,14 @@ void MidiInterface::begin(Channel inChannel) mMessage.data1 = 0; mMessage.data2 = 0; -#endif // MIDI_BUILD_INPUT - - -#if (MIDI_BUILD_INPUT && MIDI_BUILD_OUTPUT && MIDI_BUILD_THRU) // Thru - mThruFilterMode = Full; mThruActivated = true; - -#endif // Thru - } - // ----------------------------------------------------------------------------- // Output // ----------------------------------------------------------------------------- -#if MIDI_BUILD_OUTPUT - /*! \addtogroup output @{ */ @@ -459,15 +440,10 @@ StatusByte MidiInterface::getStatus(MidiType inType, return ((byte)inType | ((inChannel - 1) & 0x0f)); } -#endif // MIDI_BUILD_OUTPUT - - // ----------------------------------------------------------------------------- // Input // ----------------------------------------------------------------------------- -#if MIDI_BUILD_INPUT - /*! \addtogroup input @{ */ @@ -505,9 +481,7 @@ inline bool MidiInterface::read(Channel inChannel) launchCallback(); } -#if MIDI_BUILD_THRU thruFilter(inChannel); -#endif return channelMatch; } @@ -604,8 +578,8 @@ bool MidiInterface::parse() case SystemExclusive: // The message can be any lenght - // between 3 and MIDI_SYSEX_ARRAY_SIZE bytes - mPendingMessageExpectedLenght = MIDI_SYSEX_ARRAY_SIZE; + // between 3 and MidiMessage::sSysExMaxSize bytes + mPendingMessageExpectedLenght = MidiMessage::sSysExMaxSize; mRunningStatus_RX = InvalidType; mMessage.sysexArray[0] = SystemExclusive; break; @@ -693,8 +667,8 @@ bool MidiInterface::parse() mMessage.type = SystemExclusive; // Get length - mMessage.data1 = mPendingMessageIndex & 0xff; - mMessage.data2 = mPendingMessageIndex >> 8; + mMessage.data1 = mPendingMessageIndex & 0xff; // LSB + mMessage.data2 = mPendingMessageIndex >> 8; // MSB mMessage.channel = 0; mMessage.valid = true; @@ -725,7 +699,7 @@ bool MidiInterface::parse() { // "FML" case: fall down here with an overflown SysEx.. // This means we received the last possible data byte that can fit - // the buffer. If this happens, try increasing MIDI_SYSEX_ARRAY_SIZE. + // the buffer. If this happens, try increasing MidiMessage::sSysExMaxSize. if (mPendingMessage[0] == SystemExclusive) { resetInput(); @@ -852,7 +826,7 @@ inline void MidiInterface::resetInput() Returns an enumerated type. @see MidiType */ template -MidiType MidiInterface::getType() const +inline MidiType MidiInterface::getType() const { return mMessage.type; } @@ -863,21 +837,21 @@ MidiType MidiInterface::getType() const For non-channel messages, this will return 0. */ template -Channel MidiInterface::getChannel() const +inline Channel MidiInterface::getChannel() const { return mMessage.channel; } /*! \brief Get the first data byte of the last received message. */ template -DataByte MidiInterface::getData1() const +inline DataByte MidiInterface::getData1() const { return mMessage.data1; } /*! \brief Get the second data byte of the last received message. */ template -DataByte MidiInterface::getData2() const +inline DataByte MidiInterface::getData2() const { return mMessage.data2; } @@ -887,7 +861,7 @@ DataByte MidiInterface::getData2() const @see getSysExArrayLength to get the array's length in bytes. */ template -const byte* MidiInterface::getSysExArray() const +inline const byte* MidiInterface::getSysExArray() const { return mMessage.sysexArray; } @@ -898,16 +872,14 @@ const byte* MidiInterface::getSysExArray() const \return The array's length, in bytes. */ template -unsigned MidiInterface::getSysExArrayLength() const +inline unsigned MidiInterface::getSysExArrayLength() const { - static const unsigned maxSize = Settings::SysExArraySize; - const unsigned size = (unsigned(mMessage.data2) << 8) | mMessage.data1; - return (size > maxSize) ? maxSize : size; + return mMessage.getSysExSize(); } /*! \brief Check if a valid message is stored in the structure. */ template -bool MidiInterface::check() const +inline bool MidiInterface::check() const { return mMessage.valid; } @@ -915,7 +887,7 @@ bool MidiInterface::check() const // ----------------------------------------------------------------------------- template -Channel MidiInterface::getInputChannel() const +inline Channel MidiInterface::getInputChannel() const { return mInputChannel; } @@ -925,7 +897,7 @@ Channel MidiInterface::getInputChannel() const if you want to listen to all channels, and MIDI_CHANNEL_OFF to disable input. */ template -void MidiInterface::setInputChannel(Channel inChannel) +inline void MidiInterface::setInputChannel(Channel inChannel) { mInputChannel = inChannel; } @@ -980,8 +952,6 @@ bool MidiInterface::isChannelMessage(MidiType inType) // ----------------------------------------------------------------------------- -#if MIDI_USE_CALLBACKS - /*! \addtogroup callbacks @{ */ @@ -993,7 +963,7 @@ template void MidiInterface void MidiInterface::setHandleProgramChange(void (*fptr)(byte channel, byte number)) { mProgramChangeCallback = fptr; } template void MidiInterface::setHandleAfterTouchChannel(void (*fptr)(byte channel, byte pressure)) { mAfterTouchChannelCallback = fptr; } template void MidiInterface::setHandlePitchBend(void (*fptr)(byte channel, int bend)) { mPitchBendCallback = fptr; } -template void MidiInterface::setHandleSystemExclusive(void (*fptr)(byte* array, byte size)) { mSystemExclusiveCallback = fptr; } +template void MidiInterface::setHandleSystemExclusive(void (*fptr)(byte* array, unsigned size)) { mSystemExclusiveCallback = fptr; } template void MidiInterface::setHandleTimeCodeQuarterFrame(void (*fptr)(byte data)) { mTimeCodeQuarterFrameCallback = fptr; } template void MidiInterface::setHandleSongPosition(void (*fptr)(unsigned beats)) { mSongPositionCallback = fptr; } template void MidiInterface::setHandleSongSelect(void (*fptr)(byte songnumber)) { mSongSelectCallback = fptr; } @@ -1066,7 +1036,7 @@ void MidiInterface::launchCallback() case AfterTouchChannel: if (mAfterTouchChannelCallback != 0) mAfterTouchChannelCallback(mMessage.channel, mMessage.data1); break; case ProgramChange: if (mProgramChangeCallback != 0) mProgramChangeCallback(mMessage.channel, mMessage.data1); break; - case SystemExclusive: if (mSystemExclusiveCallback != 0) mSystemExclusiveCallback(mMessage.sysexArray, mMessage.data1); break; + case SystemExclusive: if (mSystemExclusiveCallback != 0) mSystemExclusiveCallback(mMessage.sysexArray, mMessage.getSysExSize()); break; // Occasional messages case TimeCodeQuarterFrame: if (mTimeCodeQuarterFrameCallback != 0) mTimeCodeQuarterFrameCallback(mMessage.data1); break; @@ -1081,19 +1051,12 @@ void MidiInterface::launchCallback() } } -#endif // MIDI_USE_CALLBACKS - /*! @} */ // End of doc group MIDI Input -#endif // MIDI_BUILD_INPUT - - // ----------------------------------------------------------------------------- // Thru // ----------------------------------------------------------------------------- -#if (MIDI_BUILD_INPUT && MIDI_BUILD_OUTPUT && MIDI_BUILD_THRU) - /*! \addtogroup thru @{ */ @@ -1238,8 +1201,6 @@ void MidiInterface::thruFilter(Channel inChannel) } } -#endif // MIDI_BUILD_THRU - // ----------------------------------------------------------------------------- END_MIDI_NAMESPACE diff --git a/src/midi_Defs.h b/src/midi_Defs.h index 84315be..d9eba5a 100644 --- a/src/midi_Defs.h +++ b/src/midi_Defs.h @@ -24,8 +24,13 @@ #pragma once #include "midi_Namespace.h" -#include "midi_Settings.h" + +#if ARDUINO +#include +#else #include +typedef uint8_t byte; +#endif BEGIN_MIDI_NAMESPACE @@ -40,7 +45,6 @@ BEGIN_MIDI_NAMESPACE // ----------------------------------------------------------------------------- // Type definitions -typedef uint8_t byte; typedef byte StatusByte; typedef byte DataByte; typedef byte Channel; @@ -155,48 +159,6 @@ enum MidiControlChangeNumber PolyModeOn = 127 }; - -// ----------------------------------------------------------------------------- - -/*! The midimsg structure contains decoded data of a MIDI message - read from the serial port with read() - */ -struct Message -{ - /*! The MIDI channel on which the message was recieved. - \n Value goes from 1 to 16. - */ - Channel channel; - - /*! The type of the message - (see the MidiType enum for types reference) - */ - MidiType type; - - /*! The first data byte. - \n Value goes from 0 to 127. - */ - DataByte data1; - - /*! The second data byte. - If the message is only 2 bytes long, this one is null. - \n Value goes from 0 to 127. - */ - DataByte data2; - - /*! System Exclusive dedicated byte array. - \n Array length is stocked on 16 bits, - in data1 (LSB) and data2 (MSB) - */ - DataByte sysexArray[MIDI_SYSEX_ARRAY_SIZE]; - - /*! This boolean indicates if the message is valid or not. - There is no channel consideration here, - validity means the message respects the MIDI norm. - */ - bool valid; -}; - // ----------------------------------------------------------------------------- /*! \brief Create an instance of the library attached to a serial port. @@ -207,6 +169,19 @@ struct Message #define MIDI_CREATE_INSTANCE(Type, SerialPort, Name) \ midi::MidiInterface Name((Type&)SerialPort); +#if defined(ARDUINO_SAM_DUE) || defined(USBCON) + // Leonardo, Due and other USB boards use Serial1 by default. + #define MIDI_CREATE_DEFAULT_INSTANCE() \ + MIDI_CREATE_INSTANCE(HardwareSerial, Serial1, MIDI); +#else + /*! \brief Create an instance of the library with default name, serial port + and settings, for compatibility with sketches written with pre-v4.2 MIDI Lib, + or if you don't bother using custom names, serial port or settings. + */ + #define MIDI_CREATE_DEFAULT_INSTANCE() \ + MIDI_CREATE_INSTANCE(HardwareSerial, Serial, MIDI); +#endif + /*! \brief Create an instance of the library attached to a serial port with custom settings. @see DefaultSettings diff --git a/src/midi_Message.h b/src/midi_Message.h new file mode 100644 index 0000000..d0820d8 --- /dev/null +++ b/src/midi_Message.h @@ -0,0 +1,81 @@ +/*! + * @file midi_Message.h + * Project Arduino MIDI Library + * @brief MIDI Library for the Arduino - Message struct definition + * @version 4.1 + * @author Francois Best + * @date 11/06/14 + * @license GPL v3.0 - Copyright Forty Seven Effects 2014 + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#pragma once + +#include "midi_Namespace.h" +#include "midi_Defs.h" + +BEGIN_MIDI_NAMESPACE + +/*! The Message structure contains decoded data of a MIDI message + read from the serial port with read() + */ +template +struct Message +{ + /*! The maximum size for the System Exclusive array. + */ + static const unsigned sSysExMaxSize = SysExMaxSize; + + /*! The MIDI channel on which the message was recieved. + \n Value goes from 1 to 16. + */ + Channel channel; + + /*! The type of the message + (see the MidiType enum for types reference) + */ + MidiType type; + + /*! The first data byte. + \n Value goes from 0 to 127. + */ + DataByte data1; + + /*! The second data byte. + If the message is only 2 bytes long, this one is null. + \n Value goes from 0 to 127. + */ + DataByte data2; + + /*! System Exclusive dedicated byte array. + \n Array length is stocked on 16 bits, + in data1 (LSB) and data2 (MSB) + */ + DataByte sysexArray[sSysExMaxSize]; + + /*! This boolean indicates if the message is valid or not. + There is no channel consideration here, + validity means the message respects the MIDI norm. + */ + bool valid; + + inline unsigned getSysExSize() const + { + const unsigned size = unsigned(data2) << 8 | data1; + return size > sSysExMaxSize ? sSysExMaxSize : size; + } +}; + +END_MIDI_NAMESPACE diff --git a/src/midi_Settings.h b/src/midi_Settings.h index 85270e8..971c1e0 100644 --- a/src/midi_Settings.h +++ b/src/midi_Settings.h @@ -23,47 +23,16 @@ #pragma once -#include "midi_Namespace.h" - -// ----------------------------------------------------------------------------- - -// Here are a few settings you can change to customize -// the library for your own project. You can for example -// choose to compile only parts of it so you gain flash -// space and optimise the speed of your sketch. - -// ----------------------------------------------------------------------------- +#include "midi_Defs.h" // Compilation flags. Set them to 1 to build the associated feature // (MIDI in, out, thru), or to 0 to disable the feature and save space. // Note that thru can work only if input and output are enabled. -#define MIDI_BUILD_INPUT 1 -#define MIDI_BUILD_OUTPUT 1 -#define MIDI_BUILD_THRU 1 - -#define MIDI_USE_CALLBACKS 1 - -// ----------------------------------------------------------------------------- -// Misc. options - -// Running status enables short messages when sending multiple values -// of the same type and channel. -// Set to 0 if you have troubles controlling your hardware. -#define MIDI_USE_RUNNING_STATUS 1 - -// NoteOn with 0 velocity should be handled as NoteOf. -// Set to 1 to get NoteOff events when receiving null-velocity NoteOn messages. -// Set to 0 to get NoteOn events when receiving null-velocity NoteOn messages. -#define MIDI_HANDLE_NULL_VELOCITY_NOTE_ON_AS_NOTE_OFF 1 - -// Setting this to 1 will make MIDI.read parse only one byte of data for each -// call when data is available. This can speed up your application if receiving -// a lot of traffic, but might induce MIDI Thru and treatment latency. -#define MIDI_USE_1BYTE_PARSING 1 - -#define MIDI_BAUDRATE 31250 -#define MIDI_SYSEX_ARRAY_SIZE 255 // Maximum size is 65535 bytes. +#define MIDI_BUILD_INPUT 1 +#define MIDI_BUILD_OUTPUT 1 +#define MIDI_BUILD_THRU 1 +#define MIDI_USE_CALLBACKS 1 // ----------------------------------------------------------------------------- @@ -82,11 +51,33 @@ BEGIN_MIDI_NAMESPACE */ struct DefaultSettings { - static const bool UseRunningStatus = true; - static const bool HandleNullVelocityNoteOnAsNoteOff = true; - static const bool Use1ByteParsing = true; - static const unsigned BaudRate = 31250; - static const unsigned SysExArraySize = 128; + /*! Running status enables short messages when sending multiple values + of the same type and channel.\n + Set to 0 if you have troubles controlling your hardware. + */ + static const bool UseRunningStatus = true; + + /* NoteOn with 0 velocity should be handled as NoteOf.\n + Set to 1 to get NoteOff events when receiving null-velocity NoteOn messages.\n + Set to 0 to get NoteOn events when receiving null-velocity NoteOn messages. + */ + static const bool HandleNullVelocityNoteOnAsNoteOff = true; + + // Setting this to 1 will make MIDI.read parse only one byte of data for each + // call when data is available. This can speed up your application if receiving + // a lot of traffic, but might induce MIDI Thru and treatment latency. + static const bool Use1ByteParsing = true; + + /*! Override the default MIDI baudrate to transmit over USB serial, to + a decoding program such as Hairless MIDI (set baudrate to 115200)\n + http://projectgus.github.io/hairless-midiserial/ + */ + static const long BaudRate = 31250; + + /*! Maximum size of SysEx receivable. Decrease to save RAM if you don't expect + to receive SysEx, or adjust accordingly. + */ + static const unsigned SysExMaxSize = 128; }; END_MIDI_NAMESPACE From b1b978d63cd342d632ab9cfaebc22c7a9de3e4b8 Mon Sep 17 00:00:00 2001 From: Francois Best Date: Wed, 11 Jun 2014 09:13:34 +0200 Subject: [PATCH 13/17] 4.2 --- src/MIDI.cpp | 2 +- src/MIDI.h | 2 +- src/MIDI.hpp | 2 +- src/midi_Defs.h | 2 +- src/midi_Message.h | 2 +- src/midi_Namespace.h | 2 +- src/midi_Settings.h | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/src/MIDI.cpp b/src/MIDI.cpp index fa356ce..0ed34b9 100644 --- a/src/MIDI.cpp +++ b/src/MIDI.cpp @@ -2,7 +2,7 @@ * @file MIDI.cpp * Project Arduino MIDI Library * @brief MIDI Library for the Arduino - * @version 4.1 + * @version 4.2 * @author Francois Best * @date 24/02/11 * @license GPL v3.0 - Copyright Forty Seven Effects 2014 diff --git a/src/MIDI.h b/src/MIDI.h index dc195d9..5ed1473 100644 --- a/src/MIDI.h +++ b/src/MIDI.h @@ -2,7 +2,7 @@ * @file MIDI.h * Project Arduino MIDI Library * @brief MIDI Library for the Arduino - * @version 4.1 + * @version 4.2 * @author Francois Best * @date 24/02/11 * @license GPL v3.0 - Copyright Forty Seven Effects 2014 diff --git a/src/MIDI.hpp b/src/MIDI.hpp index b73abcc..e6413f6 100644 --- a/src/MIDI.hpp +++ b/src/MIDI.hpp @@ -2,7 +2,7 @@ * @file midi_Inline.hpp * Project Arduino MIDI Library * @brief MIDI Library for the Arduino - Inline implementations - * @version 4.1 + * @version 4.2 * @author Francois Best * @date 24/02/11 * @license GPL v3.0 - Copyright Forty Seven Effects 2014 diff --git a/src/midi_Defs.h b/src/midi_Defs.h index d9eba5a..3404797 100644 --- a/src/midi_Defs.h +++ b/src/midi_Defs.h @@ -2,7 +2,7 @@ * @file midi_Defs.h * Project Arduino MIDI Library * @brief MIDI Library for the Arduino - Definitions - * @version 4.1 + * @version 4.2 * @author Francois Best * @date 24/02/11 * @license GPL v3.0 - Copyright Forty Seven Effects 2014 diff --git a/src/midi_Message.h b/src/midi_Message.h index d0820d8..31ee3d1 100644 --- a/src/midi_Message.h +++ b/src/midi_Message.h @@ -2,7 +2,7 @@ * @file midi_Message.h * Project Arduino MIDI Library * @brief MIDI Library for the Arduino - Message struct definition - * @version 4.1 + * @version 4.2 * @author Francois Best * @date 11/06/14 * @license GPL v3.0 - Copyright Forty Seven Effects 2014 diff --git a/src/midi_Namespace.h b/src/midi_Namespace.h index c99629e..4b93929 100644 --- a/src/midi_Namespace.h +++ b/src/midi_Namespace.h @@ -2,7 +2,7 @@ * @file midi_Namespace.h * Project Arduino MIDI Library * @brief MIDI Library for the Arduino - Namespace declaration - * @version 4.1 + * @version 4.2 * @author Francois Best * @date 24/02/11 * @license GPL v3.0 - Copyright Forty Seven Effects 2014 diff --git a/src/midi_Settings.h b/src/midi_Settings.h index 971c1e0..43f6880 100644 --- a/src/midi_Settings.h +++ b/src/midi_Settings.h @@ -2,7 +2,7 @@ * @file midi_Settings.h * Project Arduino MIDI Library * @brief MIDI Library for the Arduino - Settings - * @version 4.1 + * @version 4.2 * @author Francois Best * @date 24/02/11 * @license GPL v3.0 - Copyright Forty Seven Effects 2014 From 3dc0f30e16692b2726da71ec33e07393913175f7 Mon Sep 17 00:00:00 2001 From: Francois Best Date: Wed, 11 Jun 2014 09:14:03 +0200 Subject: [PATCH 14/17] Removed compile flags and last preprocessor settings. --- src/MIDI.hpp | 24 ++++++++++++------------ src/midi_Settings.h | 11 ----------- 2 files changed, 12 insertions(+), 23 deletions(-) diff --git a/src/MIDI.hpp b/src/MIDI.hpp index e6413f6..0d4e347 100644 --- a/src/MIDI.hpp +++ b/src/MIDI.hpp @@ -30,7 +30,6 @@ template inline MidiInterface::MidiInterface(SerialPort& inSerial) : mSerial(inSerial) { -#if MIDI_BUILD_INPUT && MIDI_USE_CALLBACKS mNoteOffCallback = 0; mNoteOnCallback = 0; mAfterTouchPolyCallback = 0; @@ -49,7 +48,6 @@ inline MidiInterface::MidiInterface(SerialPort& inSerial) mStopCallback = 0; mActiveSensingCallback = 0; mSystemResetCallback = 0; -#endif } /*! \brief Destructor for MidiInterface. @@ -476,7 +474,7 @@ inline bool MidiInterface::read(Channel inChannel) handleNullVelocityNoteOnAsNoteOff(); const bool channelMatch = inputFilter(inChannel); - if (MIDI_USE_CALLBACKS && channelMatch) + if (channelMatch) { launchCallback(); } @@ -616,15 +614,17 @@ bool MidiInterface::parse() mPendingMessageIndex++; } - #if USE_1BYTE_PARSING - // Message is not complete. - return false; - #else - // Call the parser recursively - // to parse the rest of the message. - return parse(); - #endif - + if (Settings::Use1ByteParsing) + { + // Message is not complete. + return false; + } + else + { + // Call the parser recursively + // to parse the rest of the message. + return parse(); + } } else { diff --git a/src/midi_Settings.h b/src/midi_Settings.h index 43f6880..fccb99d 100644 --- a/src/midi_Settings.h +++ b/src/midi_Settings.h @@ -25,17 +25,6 @@ #include "midi_Defs.h" -// Compilation flags. Set them to 1 to build the associated feature -// (MIDI in, out, thru), or to 0 to disable the feature and save space. -// Note that thru can work only if input and output are enabled. - -#define MIDI_BUILD_INPUT 1 -#define MIDI_BUILD_OUTPUT 1 -#define MIDI_BUILD_THRU 1 -#define MIDI_USE_CALLBACKS 1 - -// ----------------------------------------------------------------------------- - BEGIN_MIDI_NAMESPACE /*! \brief Default Settings Traits struct From e31d0a19102d423d8ebd53777cfbd10d240b8c8f Mon Sep 17 00:00:00 2001 From: Francois Best Date: Wed, 11 Jun 2014 09:33:32 +0200 Subject: [PATCH 15/17] Doc. --- doc/Doxyfile | 2652 ++++++++++++++++++++++++----------------- res/packaging.command | 8 +- src/MIDI.h | 1 - src/MIDI.hpp | 4 +- src/midi_Defs.h | 2 - src/midi_Settings.h | 6 +- 6 files changed, 1601 insertions(+), 1072 deletions(-) diff --git a/doc/Doxyfile b/doc/Doxyfile index 73391c8..e078caf 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -1,104 +1,122 @@ -# Doxyfile 1.8.2 +# Doxyfile 1.8.7 # This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project +# doxygen (www.doxygen.org) for a project. # -# All text after a hash (#) is considered a comment and will be ignored +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. # The format is: -# TAG = value [value, ...] -# For lists items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (" ") +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all -# text before the first occurrence of this tag. Doxygen uses libiconv (or the -# iconv built into libc) for the transcoding. See -# http://www.gnu.org/software/libiconv for the list of possible encodings. +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. DOXYFILE_ENCODING = UTF-8 -# The PROJECT_NAME tag is a single word (or sequence of words) that should -# identify the project. Note that if you do not use Doxywizard you need -# to put quotes around the project name if it contains spaces. +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. PROJECT_NAME = "Arduino MIDI Library" -# The PROJECT_NUMBER tag can be used to enter a project or revision number. -# This could be handy for archiving the generated documentation or -# if some version control system is used. +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. -PROJECT_NUMBER = "Version 4.0" +PROJECT_NUMBER = "Version 4.2" -# Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer -# a quick idea about the purpose of the project. Keep the description short. +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. -PROJECT_BRIEF = +PROJECT_BRIEF = -# With the PROJECT_LOGO tag one can specify an logo or icon that is -# included in the documentation. The maximum height of the logo should not -# exceed 55 pixels and the maximum width should not exceed 200 pixels. -# Doxygen will copy the logo to the output directory. +# With the PROJECT_LOGO tag one can specify an logo or icon that is included in +# the documentation. The maximum height of the logo should not exceed 55 pixels +# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo +# to the output directory. -PROJECT_LOGO = +PROJECT_LOGO = -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) -# base path where the generated documentation will be put. -# If a relative path is entered, it will be relative to the location -# where doxygen was started. If left blank the current directory will be used. +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. OUTPUT_DIRECTORY = . -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create -# 4096 sub-directories (in 2 levels) under the output directory of each output -# format and will distribute the generated files over these directories. -# Enabling this option can be useful when feeding doxygen a huge amount of -# source files, where putting all generated files in the same directory would -# otherwise cause performance problems for the file system. +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. CREATE_SUBDIRS = NO -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# The default language is English, other supported languages are: -# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, -# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, -# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English -# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, -# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, -# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. OUTPUT_LANGUAGE = English -# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will -# include brief member descriptions after the members that are listed in -# the file and class documentation (similar to JavaDoc). -# Set to NO to disable this. +# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. BRIEF_MEMBER_DESC = YES -# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend -# the brief description of a member or function before the detailed description. -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. +# The default value is: YES. REPEAT_BRIEF = YES -# This tag implements a quasi-intelligent brief description abbreviator -# that is used to form the text in various listings. Each string -# in this list, if found as the leading text of the brief description, will be -# stripped from the text and the result after processing the whole list, is -# used as the annotated text. Otherwise, the brief description is used as-is. -# If left blank, the following values are used ("$name" is automatically -# replaced with the name of the entity): "The $name class" "The $name widget" -# "The $name file" "is" "provides" "specifies" "contains" -# "represents" "a" "an" "the" +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. ABBREVIATE_BRIEF = "The $name class" \ "The $name widget" \ @@ -112,257 +130,280 @@ ABBREVIATE_BRIEF = "The $name class" \ an \ the -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# Doxygen will generate a detailed section even if there is only a brief +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief # description. +# The default value is: NO. ALWAYS_DETAILED_SEC = NO -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. +# The default value is: NO. INLINE_INHERITED_MEMB = NO -# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full -# path before files name in the file list and in the header files. If set -# to NO the shortest path that makes the file name unique will be used. +# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. FULL_PATH_NAMES = YES -# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag -# can be used to strip a user-defined part of the path. Stripping is -# only done if one of the specified strings matches the left-hand part of -# the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the -# path to strip. Note that you specify absolute paths here, but also -# relative paths, which will be relative from the directory where doxygen is -# started. +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. STRIP_FROM_PATH = /Users/dimitri/doxygen/mail/1.5.7/doxywizard/ -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of -# the path mentioned in the documentation of a class, which tells -# the reader which header file to include in order to use a class. -# If left blank only the name of the header file containing the class -# definition is used. Otherwise one should specify the include paths that -# are normally passed to the compiler using the -I flag. +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. -STRIP_FROM_INC_PATH = +STRIP_FROM_INC_PATH = -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter -# (but less readable) file names. This can be useful if your file system -# doesn't support long names like on DOS, Mac, or CD-ROM. +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. SHORT_NAMES = YES -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen -# will interpret the first line (until the first dot) of a JavaDoc-style -# comment as the brief description. If set to NO, the JavaDoc -# comments will behave just like regular Qt-style comments -# (thus requiring an explicit @brief command for a brief description.) +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. JAVADOC_AUTOBRIEF = NO -# If the QT_AUTOBRIEF tag is set to YES then Doxygen will -# interpret the first line (until the first dot) of a Qt-style -# comment as the brief description. If set to NO, the comments -# will behave just like regular Qt-style comments (thus requiring -# an explicit \brief command for a brief description.) +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. QT_AUTOBRIEF = NO -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen -# treat a multi-line C++ special comment block (i.e. a block of //! or /// -# comments) as a brief description. This used to be the default behaviour. -# The new default is to treat a multi-line C++ comment block as a detailed -# description. Set this tag to YES if you prefer the old behaviour instead. +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. MULTILINE_CPP_IS_BRIEF = NO -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented -# member inherits the documentation from any documented member that it -# re-implements. +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. INHERIT_DOCS = YES -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce -# a new page for each member. If set to NO, the documentation of a member will -# be part of the file/class/namespace that contains it. +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a +# new page for each member. If set to NO, the documentation of a member will be +# part of the file/class/namespace that contains it. +# The default value is: NO. SEPARATE_MEMBER_PAGES = NO -# The TAB_SIZE tag can be used to set the number of spaces in a tab. -# Doxygen uses this value to replace tabs by spaces in code fragments. +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. TAB_SIZE = 4 -# This tag can be used to specify a number of aliases that acts -# as commands in the documentation. An alias has the form "name=value". -# For example adding "sideeffect=\par Side Effects:\n" will allow you to -# put the command \sideeffect (or @sideeffect) in the documentation, which -# will result in a user-defined paragraph with heading "Side Effects:". -# You can put \n's in the value part of an alias to insert newlines. +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. -ALIASES = +ALIASES = -# This tag can be used to specify a number of word-keyword mappings (TCL only). -# A mapping has the form "name=value". For example adding -# "class=itcl::class" will allow you to use the command class in the -# itcl::class meaning. +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. -TCL_SUBST = +TCL_SUBST = -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C -# sources only. Doxygen will then generate output that is more tailored for C. -# For instance, some of the names that are used will be different. The list -# of all members will be omitted, etc. +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. OPTIMIZE_OUTPUT_FOR_C = NO -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java -# sources only. Doxygen will then generate output that is more tailored for -# Java. For instance, namespaces will be presented as packages, qualified -# scopes will look different, etc. +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. OPTIMIZE_OUTPUT_JAVA = NO -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources only. Doxygen will then generate output that is more tailored for -# Fortran. +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. OPTIMIZE_FOR_FORTRAN = NO -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for -# VHDL. +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. OPTIMIZE_OUTPUT_VHDL = NO -# Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given -# extension. Doxygen has a built-in mapping, but you can override or extend it -# using this tag. The format is ext=language, where ext is a file extension, -# and language is one of the parsers supported by doxygen: IDL, Java, -# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, -# C++. For instance to make doxygen treat .inc files as Fortran files (default -# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note -# that for custom extensions you also need to set FILE_PATTERNS otherwise the -# files are not read by doxygen. +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. -EXTENSION_MAPPING = +EXTENSION_MAPPING = -# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all -# comments according to the Markdown format, which allows for more readable -# documentation. See http://daringfireball.net/projects/markdown/ for details. -# The output of markdown processing is further processed by doxygen, so you -# can mix doxygen, HTML, and XML commands with Markdown formatting. -# Disable only in case of backward compatibilities issues. +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. MARKDOWN_SUPPORT = YES -# When enabled doxygen tries to link words that correspond to documented classes, -# or namespaces to their corresponding documentation. Such a link can be -# prevented in individual cases by by putting a % sign in front of the word or -# globally by setting AUTOLINK_SUPPORT to NO. +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by by putting a % sign in front of the word +# or globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. AUTOLINK_SUPPORT = YES -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should -# set this tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. -# func(std::string) {}). This also makes the inheritance and collaboration +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. +# The default value is: NO. BUILTIN_STL_SUPPORT = NO -# If you use Microsoft's C++/CLI language, you should set this option to YES to +# If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. +# The default value is: NO. CPP_CLI_SUPPORT = NO -# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. -# Doxygen will parse them like normal C++ but will assume all classes use public -# instead of private inheritance when no explicit protection keyword is present. +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate -# getter and setter methods for a property. Setting this option to YES (the -# default) will make doxygen replace the get and set methods by a property in -# the documentation. This will only work if the methods are indeed getting or -# setting a simple type. If this is not the case, or you want to show the -# methods anyway, you should set this option to NO. +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. IDL_PROPERTY_SUPPORT = YES -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. +# The default value is: NO. DISTRIBUTE_GROUP_DOC = NO -# Set the SUBGROUPING tag to YES (the default) to allow class member groups of -# the same type (for instance a group of public functions) to be put as a -# subgroup of that type (e.g. under the Public Functions section). Set it to -# NO to prevent subgrouping. Alternatively, this can be done per class using -# the \nosubgrouping command. +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. SUBGROUPING = YES -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and -# unions are shown inside the group in which they are included (e.g. using -# @ingroup) instead of on a separate page (for HTML and Man pages) or -# section (for LaTeX and RTF). +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. INLINE_GROUPED_CLASSES = NO -# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and -# unions with only public data fields will be shown inline in the documentation -# of the scope in which they are defined (i.e. file, namespace, or group -# documentation), provided this scope is documented. If set to NO (the default), -# structs, classes, and unions are shown on a separate page (for HTML and Man -# pages) or section (for LaTeX and RTF). +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. INLINE_SIMPLE_STRUCTS = NO -# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum -# is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically -# be useful for C code in case the coding convention dictates that all compound +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. TYPEDEF_HIDES_STRUCT = NO -# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to -# determine which symbols to keep in memory and which to flush to disk. -# When the cache is full, less often used symbols will be written to disk. -# For small to medium size projects (<1000 input files) the default value is -# probably good enough. For larger projects a too small cache size can cause -# doxygen to be busy swapping symbols to and from disk most of the time -# causing a significant performance penalty. -# If the system has enough physical memory increasing the cache will improve the -# performance by keeping more symbols in memory. Note that the value works on -# a logarithmic scale so increasing the size by one will roughly double the -# memory usage. The cache size is given by this formula: -# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, -# corresponding to a cache size of 2^16 = 65536 symbols. - -SYMBOL_CACHE_SIZE = 0 - -# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be -# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given -# their name and scope. Since this can be an expensive process and often the -# same symbol appear multiple times in the code, doxygen keeps a cache of -# pre-resolved symbols. If the cache is too small doxygen will become slower. -# If the cache is too large, memory is wasted. The cache size is given by this -# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, -# corresponding to a cache size of 2^16 = 65536 symbols. +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. LOOKUP_CACHE_SIZE = 0 @@ -370,329 +411,379 @@ LOOKUP_CACHE_SIZE = 0 # Build related configuration options #--------------------------------------------------------------------------- -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in -# documentation are documented, even if no documentation was available. -# Private class members and static file members will be hidden unless -# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. EXTRACT_ALL = YES -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class -# will be included in the documentation. +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will +# be included in the documentation. +# The default value is: NO. EXTRACT_PRIVATE = NO -# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal # scope will be included in the documentation. +# The default value is: NO. EXTRACT_PACKAGE = NO -# If the EXTRACT_STATIC tag is set to YES all static members of a file -# will be included in the documentation. +# If the EXTRACT_STATIC tag is set to YES all static members of a file will be +# included in the documentation. +# The default value is: NO. EXTRACT_STATIC = YES -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) -# defined locally in source files will be included in the documentation. -# If set to NO only classes defined in header files are included. +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. EXTRACT_LOCAL_CLASSES = YES -# This flag is only useful for Objective-C code. When set to YES local -# methods, which are defined in the implementation section but not in -# the interface are included in the documentation. -# If set to NO (the default) only methods in the interface are included. +# This flag is only useful for Objective-C code. When set to YES local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO only methods in the interface are +# included. +# The default value is: NO. EXTRACT_LOCAL_METHODS = NO -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base -# name of the file that contains the anonymous namespace. By default -# anonymous namespaces are hidden. +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. EXTRACT_ANON_NSPACES = NO -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all -# undocumented members of documented classes, files or namespaces. -# If set to NO (the default) these members will be included in the -# various overviews, but no documentation section is generated. -# This option has no effect if EXTRACT_ALL is enabled. +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. HIDE_UNDOC_MEMBERS = NO -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. -# If set to NO (the default) these classes will be included in the various -# overviews. This option has no effect if EXTRACT_ALL is enabled. +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO these classes will be included in the various overviews. This option has +# no effect if EXTRACT_ALL is enabled. +# The default value is: NO. HIDE_UNDOC_CLASSES = NO -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all -# friend (class|struct|union) declarations. -# If set to NO (the default) these declarations will be included in the -# documentation. +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO these declarations will be +# included in the documentation. +# The default value is: NO. HIDE_FRIEND_COMPOUNDS = NO -# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any -# documentation blocks found inside the body of a function. -# If set to NO (the default) these blocks will be appended to the -# function's detailed documentation block. +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. HIDE_IN_BODY_DOCS = NO -# The INTERNAL_DOCS tag determines if documentation -# that is typed after a \internal command is included. If the tag is set -# to NO (the default) then the documentation will be excluded. -# Set it to YES to include the internal documentation. +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. INTERNAL_DOCS = NO -# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate -# file names in lower-case letters. If set to YES upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. +# The default value is: system dependent. CASE_SENSE_NAMES = NO -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen -# will show members with their full class and namespace scopes in the -# documentation. If set to YES the scope will be hidden. +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES the +# scope will be hidden. +# The default value is: NO. HIDE_SCOPE_NAMES = NO -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen -# will put a list of the files that are included by a file in the documentation -# of that file. +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. SHOW_INCLUDE_FILES = YES -# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen -# will list include files with double quotes in the documentation -# rather than with sharp brackets. +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. FORCE_LOCAL_INCLUDES = NO -# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] -# is inserted in the documentation for inline members. +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. INLINE_INFO = YES -# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen -# will sort the (detailed) documentation of file and class members -# alphabetically by member name. If set to NO the members will appear in -# declaration order. +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. +# The default value is: YES. SORT_MEMBER_DOCS = YES -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the -# brief documentation of file, namespace and class members alphabetically -# by member name. If set to NO (the default) the members will appear in -# declaration order. +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. SORT_BRIEF_DOCS = NO -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen -# will sort the (brief and detailed) documentation of class members so that -# constructors and destructors are listed first. If set to NO (the default) -# the constructors will appear in the respective orders defined by -# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. -# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO -# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. SORT_MEMBERS_CTORS_1ST = NO -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the -# hierarchy of group names into alphabetical order. If set to NO (the default) -# the group names will appear in their defined order. +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. SORT_GROUP_NAMES = NO -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be -# sorted by fully-qualified names, including namespaces. If set to -# NO (the default), the class list will be sorted only by class name, -# not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the -# alphabetical list. +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. SORT_BY_SCOPE_NAME = NO -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to -# do proper type resolution of all parameters of a function it will reject a -# match between the prototype and the implementation of a member function even -# if there is only one candidate or it is obvious which candidate to choose -# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen -# will still accept a match between prototype and implementation in such cases. +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. STRICT_PROTO_MATCHING = NO -# The GENERATE_TODOLIST tag can be used to enable (YES) or -# disable (NO) the todo list. This list is created by putting \todo -# commands in the documentation. +# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the +# todo list. This list is created by putting \todo commands in the +# documentation. +# The default value is: YES. GENERATE_TODOLIST = YES -# The GENERATE_TESTLIST tag can be used to enable (YES) or -# disable (NO) the test list. This list is created by putting \test -# commands in the documentation. +# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the +# test list. This list is created by putting \test commands in the +# documentation. +# The default value is: YES. GENERATE_TESTLIST = YES -# The GENERATE_BUGLIST tag can be used to enable (YES) or -# disable (NO) the bug list. This list is created by putting \bug -# commands in the documentation. +# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. GENERATE_BUGLIST = YES -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or -# disable (NO) the deprecated list. This list is created by putting -# \deprecated commands in the documentation. +# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. GENERATE_DEPRECATEDLIST= YES -# The ENABLED_SECTIONS tag can be used to enable conditional -# documentation sections, marked by \if sectionname ... \endif. +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. -ENABLED_SECTIONS = +ENABLED_SECTIONS = -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines -# the initial value of a variable or macro consists of for it to appear in -# the documentation. If the initializer consists of more lines than specified -# here it will be hidden. Use a value of 0 to hide initializers completely. -# The appearance of the initializer of individual variables and macros in the -# documentation can be controlled using \showinitializer or \hideinitializer -# command in the documentation regardless of this setting. +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. MAX_INITIALIZER_LINES = 30 -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated -# at the bottom of the documentation of classes and structs. If set to YES the -# list will mention the files that were used to generate the documentation. +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES the list +# will mention the files that were used to generate the documentation. +# The default value is: YES. SHOW_USED_FILES = YES -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. -# This will remove the Files entry from the Quick Index and from the -# Folder Tree View (if specified). The default is YES. +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. SHOW_FILES = YES -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the -# Namespaces page. This will remove the Namespaces entry from the Quick Index -# and from the Folder Tree View (if specified). The default is YES. +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. SHOW_NAMESPACES = YES -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command , where is the value of -# the FILE_VERSION_FILTER tag, and is the name of an input file -# provided by doxygen. Whatever the program writes to standard output -# is used as the file version. See the manual for examples. +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. -FILE_VERSION_FILTER = +FILE_VERSION_FILTER = -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed -# by doxygen. The layout file controls the global structure of the generated -# output files in an output format independent way. To create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. -# You can optionally specify a file name after the option, if omitted -# DoxygenLayout.xml will be used as the name of the layout file. +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. -LAYOUT_FILE = +LAYOUT_FILE = -# The CITE_BIB_FILES tag can be used to specify one or more bib files -# containing the references data. This must be a list of .bib files. The -# .bib extension is automatically appended if omitted. Using this command -# requires the bibtex tool to be installed. See also -# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style -# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this -# feature you need bibtex and perl available in the search path. +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. Do not use file names with spaces, bibtex cannot handle them. See +# also \cite for info how to create references. -CITE_BIB_FILES = +CITE_BIB_FILES = #--------------------------------------------------------------------------- -# configuration options related to warning and progress messages +# Configuration options related to warning and progress messages #--------------------------------------------------------------------------- -# The QUIET tag can be used to turn on/off the messages that are generated -# by doxygen. Possible values are YES and NO. If left blank NO is used. +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. QUIET = NO -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated by doxygen. Possible values are YES and NO. If left blank -# NO is used. +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. WARNINGS = YES -# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings -# for undocumented members. If EXTRACT_ALL is set to YES then this flag will -# automatically be disabled. +# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. WARN_IF_UNDOCUMENTED = YES -# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some -# parameters in a documented function, or documenting parameters that -# don't exist or using markup commands wrongly. +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. WARN_IF_DOC_ERROR = YES -# The WARN_NO_PARAMDOC option can be enabled to get warnings for -# functions that are documented, but have no documentation for their parameters -# or return value. If set to NO (the default) doxygen will only warn about -# wrong or incomplete parameter documentation, but not about the absence of -# documentation. +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO doxygen will only warn about wrong or incomplete parameter +# documentation, but not about the absence of documentation. +# The default value is: NO. WARN_NO_PARAMDOC = NO -# The WARN_FORMAT tag determines the format of the warning messages that -# doxygen can produce. The string should contain the $file, $line, and $text -# tags, which will be replaced by the file and line number from which the -# warning originated and the warning text. Optionally the format may contain -# $version, which will be replaced by the version of the file (if it could -# be obtained via FILE_VERSION_FILTER) +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" -# The WARN_LOGFILE tag can be used to specify a file to which warning -# and error messages should be written. If left blank the output is written -# to stderr. +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). -WARN_LOGFILE = +WARN_LOGFILE = #--------------------------------------------------------------------------- -# configuration options related to the input files +# Configuration options related to the input files #--------------------------------------------------------------------------- -# The INPUT tag can be used to specify the files and/or directories that contain -# documented source files. You may enter file names like "myfile.cpp" or -# directories like "/usr/src/myproject". Separate the files or directories -# with spaces. +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. +# Note: If this tag is empty the current directory is searched. INPUT = ../src \ ./midi_DoxygenMainPage.h -# This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is -# also the default input encoding. Doxygen uses libiconv (or the iconv built -# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for -# the list of possible encodings. +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. INPUT_ENCODING = UTF-8 -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: -# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh -# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py -# *.f90 *.f *.for *.vhd *.vhdl +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank the +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. FILE_PATTERNS = *.c \ *.cc \ @@ -727,900 +818,1264 @@ FILE_PATTERNS = *.c \ *.vhdl \ *.ino -# The RECURSIVE tag can be used to turn specify whether or not subdirectories -# should be searched for input files as well. Possible values are YES and NO. -# If left blank NO is used. +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. RECURSIVE = YES -# The EXCLUDE tag can be used to specify files and/or directories that should be -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. -# Note that relative paths are relative to the directory from which doxygen is +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is # run. -EXCLUDE = +EXCLUDE = -# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or -# directories that are symbolic links (a Unix file system feature) are excluded +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded # from the input. +# The default value is: NO. EXCLUDE_SYMLINKS = NO -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. Note that the wildcards are matched -# against the file with absolute path, so to exclude all test directories -# for example use the pattern */test/* +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* -EXCLUDE_PATTERNS = +EXCLUDE_PATTERNS = -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* -EXCLUDE_SYMBOLS = +EXCLUDE_SYMBOLS = -# The EXAMPLE_PATH tag can be used to specify one or more files or -# directories that contain example code fragments that are included (see -# the \include command). +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). EXAMPLE_PATH = ../res/Examples -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank all files are included. +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. EXAMPLE_PATTERNS = * -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude -# commands irrespective of the value of the RECURSIVE tag. -# Possible values are YES and NO. If left blank NO is used. +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. EXAMPLE_RECURSIVE = YES -# The IMAGE_PATH tag can be used to specify one or more files or -# directories that contain image that are included in the documentation (see -# the \image command). +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). -IMAGE_PATH = +IMAGE_PATH = -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command , where -# is the value of the INPUT_FILTER tag, and is the name of an -# input file. Doxygen will then use the output that the filter program writes -# to standard output. If FILTER_PATTERNS is specified, this tag will be -# ignored. +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. -INPUT_FILTER = +INPUT_FILTER = -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: -# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further -# info on how filters are used. If FILTER_PATTERNS is empty or if -# non of the patterns match the file name, INPUT_FILTER is applied. +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. -FILTER_PATTERNS = +FILTER_PATTERNS = -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will be used to filter the input files when producing source -# files to browse (i.e. when SOURCE_BROWSER is set to YES). +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER ) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. FILTER_SOURCE_FILES = NO -# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) -# and it is also possible to disable source filtering for a specific pattern -# using *.ext= (so without naming a filter). This option only has effect when -# FILTER_SOURCE_FILES is enabled. +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. -FILTER_SOURCE_PATTERNS = +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = #--------------------------------------------------------------------------- -# configuration options related to source browsing +# Configuration options related to source browsing #--------------------------------------------------------------------------- -# If the SOURCE_BROWSER tag is set to YES then a list of source files will -# be generated. Documented entities will be cross-referenced with these sources. -# Note: To get rid of all source code in the generated output, make sure also -# VERBATIM_HEADERS is set to NO. +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. SOURCE_BROWSER = YES -# Setting the INLINE_SOURCES tag to YES will include the body -# of functions and classes directly in the documentation. +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. INLINE_SOURCES = YES -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct -# doxygen to hide any special comment blocks from generated source code -# fragments. Normal C, C++ and Fortran comments will always remain visible. +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. STRIP_CODE_COMMENTS = YES -# If the REFERENCED_BY_RELATION tag is set to YES -# then for each documented function all documented -# functions referencing it will be listed. +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. REFERENCED_BY_RELATION = NO -# If the REFERENCES_RELATION tag is set to YES -# then for each documented function all documented entities -# called/used by that function will be listed. +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. REFERENCES_RELATION = NO -# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) -# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from -# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will -# link to the source code. Otherwise they will link to the documentation. +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES, then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. REFERENCES_LINK_SOURCE = YES -# If the USE_HTAGS tag is set to YES then the references to source code -# will point to the HTML generated by the htags(1) tool instead of doxygen -# built-in source browser. The htags tool is part of GNU's global source -# tagging system (see http://www.gnu.org/software/global/global.html). You -# will need version 4.8.6 or higher. +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. USE_HTAGS = NO -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen -# will generate a verbatim copy of the header file for each class for -# which an include is specified. Set to NO to disable this. +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. VERBATIM_HEADERS = YES +# If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# compiled with the --with-libclang option. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + #--------------------------------------------------------------------------- -# configuration options related to the alphabetical class index +# Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index -# of all compounds will be generated. Enable this if the project -# contains a lot of classes, structs, unions or interfaces. +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. ALPHABETICAL_INDEX = NO -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns -# in which this list will be split (can be a number in the range [1..20]) +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. COLS_IN_ALPHA_INDEX = 5 -# In case all classes in a project start with a common prefix, all -# classes will be put under the same header in the alphabetical index. -# The IGNORE_PREFIX tag can be used to specify one or more prefixes that -# should be ignored while generating the index headers. +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. -IGNORE_PREFIX = +IGNORE_PREFIX = #--------------------------------------------------------------------------- -# configuration options related to the HTML output +# Configuration options related to the HTML output #--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will -# generate HTML output. +# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output +# The default value is: YES. GENERATE_HTML = YES -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `html' will be used as the default path. +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_OUTPUT = html -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for -# each generated HTML page (for example: .htm,.php,.asp). If it is left blank -# doxygen will generate files with .html extension. +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_FILE_EXTENSION = .html -# The HTML_HEADER tag can be used to specify a personal HTML header for -# each generated HTML page. If it is left blank doxygen will generate a -# standard header. Note that when using a custom header you are responsible -# for the proper inclusion of any scripts and style sheets that doxygen -# needs, which is dependent on the configuration options used. -# It is advised to generate a default header using "doxygen -w html -# header.html footer.html stylesheet.css YourConfigFile" and then modify -# that header. Note that the header is subject to change so you typically -# have to redo this when upgrading to a newer version of doxygen or when -# changing the value of configuration settings such as GENERATE_TREEVIEW! +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. -HTML_HEADER = +HTML_HEADER = -# The HTML_FOOTER tag can be used to specify a personal HTML footer for -# each generated HTML page. If it is left blank doxygen will generate a -# standard footer. +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. -HTML_FOOTER = +HTML_FOOTER = -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading -# style sheet that is used by each HTML page. It can be used to -# fine-tune the look of the HTML output. If left blank doxygen will -# generate a default style sheet. Note that it is recommended to use -# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this -# tag will in the future become obsolete. +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. -HTML_STYLESHEET = +HTML_STYLESHEET = -# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional -# user-defined cascading style sheet that is included after the standard -# style sheets created by doxygen. Using this option one can overrule -# certain style aspects. This is preferred over using HTML_STYLESHEET -# since it does not replace the standard style sheet and is therefor more -# robust against future updates. Doxygen will copy the style sheet file to -# the output directory. +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- +# defined cascading style sheet that is included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefor more robust against future updates. +# Doxygen will copy the style sheet file to the output directory. For an example +# see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = +HTML_EXTRA_STYLESHEET = -# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or -# other source files which should be copied to the HTML output directory. Note -# that these files will be copied to the base HTML output directory. Use the -# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these -# files. In the HTML_STYLESHEET file, use the file name only. Also note that -# the files will be copied as-is; there are no commands or markers available. +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_FILES = +HTML_EXTRA_FILES = -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. -# Doxygen will adjust the colors in the style sheet and background images -# according to this color. Hue is specified as an angle on a colorwheel, -# see http://en.wikipedia.org/wiki/Hue for more information. -# For instance the value 0 represents red, 60 is yellow, 120 is green, -# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. -# The allowed range is 0 to 359. +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the stylesheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_HUE = 220 -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of -# the colors in the HTML output. For a value of 0 the output will use -# grayscales only. A value of 255 will produce the most vivid colors. +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_SAT = 100 -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to -# the luminance component of the colors in the HTML output. Values below -# 100 gradually make the output lighter, whereas values above 100 make -# the output darker. The value divided by 100 is the actual gamma applied, -# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, -# and 100 does not change the gamma. +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_GAMMA = 80 -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting -# this to NO can help when comparing the output of multiple runs. +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_TIMESTAMP = YES -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the # page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_SECTIONS = NO -# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of -# entries shown in the various tree structured indices initially; the user -# can expand and collapse entries dynamically later on. Doxygen will expand -# the tree to such a level that at most the specified number of entries are -# visible (unless a fully collapsed tree already exceeds this amount). -# So setting the number of entries 1 will produce a full collapsed tree by -# default. 0 is a special value representing an infinite number of entries -# and will result in a full expanded tree by default. +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_INDEX_NUM_ENTRIES = 100 -# If the GENERATE_DOCSET tag is set to YES, additional index files -# will be generated that can be used as input for Apple's Xcode 3 -# integrated development environment, introduced with OSX 10.5 (Leopard). -# To create a documentation set, doxygen will generate a Makefile in the -# HTML output directory. Running make will produce the docset in that -# directory and running "make install" will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find -# it at startup. -# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html # for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_DOCSET = NO -# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the -# feed. A documentation feed provides an umbrella under which multiple -# documentation sets from a single provider (such as a company or product suite) -# can be grouped. +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_FEEDNAME = "Doxygen generated docs" -# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that -# should uniquely identify the documentation set bundle. This should be a -# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen -# will append .docset to the name. +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_BUNDLE_ID = org.doxygen.Project -# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely -# identify the documentation publisher. This should be a reverse domain-name -# style string, e.g. com.mycompany.MyDocSet.documentation. +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_ID = org.doxygen.Publisher -# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_NAME = Publisher -# If the GENERATE_HTMLHELP tag is set to YES, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) -# of the generated HTML documentation. +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_HTMLHELP = NO -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can -# be used to specify the file name of the resulting .chm file. You -# can add a path in front of the file if the result should not be +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be # written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. -CHM_FILE = +CHM_FILE = -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can -# be used to specify the location (absolute path including file name) of -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run -# the HTML help compiler on the generated index.hhp. +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler ( hhc.exe). If non-empty +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. -HHC_LOCATION = +HHC_LOCATION = -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag -# controls if a separate .chi index file is generated (YES) or that -# it should be included in the master .chm file (NO). +# The GENERATE_CHI flag controls if a separate .chi index file is generated ( +# YES) or that it should be included in the master .chm file ( NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. GENERATE_CHI = NO -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING -# is used to encode HtmlHelp index (hhk), content (hhc) and project file -# content. +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. -CHM_INDEX_ENCODING = +CHM_INDEX_ENCODING = -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag -# controls whether a binary table of contents is generated (YES) or a -# normal table of contents (NO) in the .chm file. +# The BINARY_TOC flag controls whether a binary table of contents is generated ( +# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. BINARY_TOC = NO -# The TOC_EXPAND flag can be set to YES to add extra items for group members -# to the contents of the HTML help documentation and to the tree view. +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. TOC_EXPAND = NO -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated -# that can be used as input for Qt's qhelpgenerator to generate a -# Qt Compressed Help (.qch) of the generated HTML documentation. +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_QHP = NO -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can -# be used to specify the file name of the resulting .qch file. -# The path specified is relative to the HTML output folder. +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. -QCH_FILE = +QCH_FILE = -# The QHP_NAMESPACE tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#namespace +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. QHP_NAMESPACE = org.doxygen.Project -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#virtual-folders +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. QHP_VIRTUAL_FOLDER = doc -# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to -# add. For more information please see -# http://doc.trolltech.com/qthelpproject.html#custom-filters +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. -QHP_CUST_FILTER_NAME = +QHP_CUST_FILTER_NAME = -# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see -# -# Qt Help Project / Custom Filters. +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. -QHP_CUST_FILTER_ATTRS = +QHP_CUST_FILTER_ATTRS = -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's -# filter section matches. -# -# Qt Help Project / Filter Attributes. +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. -QHP_SECT_FILTER_ATTRS = +QHP_SECT_FILTER_ATTRS = -# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can -# be used to specify the location of Qt's qhelpgenerator. -# If non-empty doxygen will try to run qhelpgenerator on the generated -# .qhp file. +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. -QHG_LOCATION = +QHG_LOCATION = -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files -# will be generated, which together with the HTML files, form an Eclipse help -# plugin. To install this plugin and make it available under the help contents -# menu in Eclipse, the contents of the directory containing the HTML and XML -# files needs to be copied into the plugins directory of eclipse. The name of -# the directory within the plugins directory should be the same as -# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before -# the help appears. +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_ECLIPSEHELP = NO -# A unique identifier for the eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have -# this name. +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. ECLIPSE_DOC_ID = org.doxygen.Project -# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) -# at top of each HTML page. The value NO (the default) enables the index and -# the value YES disables it. Since the tabs have the same information as the -# navigation tree you can set this option to NO if you already set -# GENERATE_TREEVIEW to YES. +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. DISABLE_INDEX = NO -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. -# If the tag value is set to YES, a side panel will be generated -# containing a tree-like index structure (just like the one that -# is generated for HTML Help). For this to work a browser that supports -# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). -# Windows users are probably better off using the HTML help feature. -# Since the tree basically has the same information as the tab index you -# could consider to set DISABLE_INDEX to NO when enabling this option. +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = YES -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values -# (range [0,1..20]) that doxygen will group on one line in the generated HTML -# documentation. Note that a value of 0 will completely suppress the enum -# values from appearing in the overview section. +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. ENUM_VALUES_PER_LINE = 4 -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be -# used to set the initial width (in pixels) of the frame in which the tree -# is shown. +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. TREEVIEW_WIDTH = 250 -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open -# links to external symbols imported via tag files in a separate window. +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. EXT_LINKS_IN_WINDOW = NO -# Use this tag to change the font size of Latex formulas included -# as images in the HTML documentation. The default is 10. Note that -# when you change the font size after a successful doxygen run you need -# to manually remove any form_*.png images from the HTML output directory -# to force them to be regenerated. +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_FONTSIZE = 10 -# Use the FORMULA_TRANPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are -# not supported properly for IE 6.0, but are supported on all modern browsers. -# Note that when changing this option you need to delete any form_*.png files -# in the HTML output before the changes have effect. +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_TRANSPARENT = YES -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax -# (see http://www.mathjax.org) which uses client side Javascript for the -# rendering instead of using prerendered bitmaps. Use this if you do not -# have LaTeX installed or if you want to formulas look prettier in the HTML -# output. When enabled you may also need to install MathJax separately and -# configure the path to it using the MATHJAX_RELPATH option. +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using prerendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. USE_MATHJAX = NO -# When MathJax is enabled you need to specify the location relative to the -# HTML output directory using the MATHJAX_RELPATH option. The destination -# directory should contain the MathJax.js script. For instance, if the mathjax -# directory is located at the same level as the HTML output directory, then -# MATHJAX_RELPATH should be ../mathjax. The default value points to -# the MathJax Content Delivery Network so you can quickly see the result without -# installing MathJax. However, it is strongly recommended to install a local -# copy of MathJax from http://www.mathjax.org before deployment. +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = http://www.mathjax.org/mathjax -# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension -# names that should be enabled during MathJax rendering. +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. -MATHJAX_EXTENSIONS = +MATHJAX_EXTENSIONS = -# When the SEARCHENGINE tag is enabled doxygen will generate a search box -# for the HTML output. The underlying search engine uses javascript -# and DHTML and should work on any modern browser. Note that when using -# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets -# (GENERATE_DOCSET) there is already a search function so this one should -# typically be disabled. For large projects the javascript based search engine -# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /