MIDI.h File Reference

MIDI Library for the Arduino. More...

#include "midi_Defs.h"
#include "midi_Platform.h"
#include "midi_Settings.h"
#include "midi_Message.h"
#include "serialMIDI.h"
#include "MIDI.hpp"

Go to the source code of this file.

Classes
class	MidiInterface< Transport, _Settings, _Platform >
	The main class for MIDI handling. It is templated over the type of serial port to provide abstraction from 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. More...

Macros
#define	MIDI_LIBRARY_VERSION   0x050000
#define	MIDI_LIBRARY_VERSION_MAJOR   5
#define	MIDI_LIBRARY_VERSION_MINOR   0
#define	MIDI_LIBRARY_VERSION_PATCH   0

Functions
unsigned	encodeSysEx (const byte *inData, byte *outSysEx, unsigned inLength, bool inFlipHeaderBits=false)
	Encode System Exclusive messages. SysEx messages are encoded to guarantee transmission of data bytes higher than 127 without breaking the MIDI protocol. Use this static method to convert the data you want to send. More...
unsigned	decodeSysEx (const byte *inSysEx, byte *outData, unsigned inLength, bool inFlipHeaderBits=false)
	Decode System Exclusive messages. SysEx messages are encoded to guarantee transmission of data bytes higher than 127 without breaking the MIDI protocol. Use this static method to reassemble your received message. More...

Detailed Description

MIDI Library for the Arduino.

Project Arduino MIDI Library

Author

Francois Best, lathoub

Date

24/02/11 @license MIT - Copyright (c) 2015 Francois Best

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Definition in file MIDI.h.

Macro Definition Documentation

MIDI_LIBRARY_VERSION

#define MIDI_LIBRARY_VERSION   0x050000

Definition at line 42 of file MIDI.h.

MIDI_LIBRARY_VERSION_MAJOR

#define MIDI_LIBRARY_VERSION_MAJOR   5

Definition at line 43 of file MIDI.h.

MIDI_LIBRARY_VERSION_MINOR

#define MIDI_LIBRARY_VERSION_MINOR   0

Definition at line 44 of file MIDI.h.

MIDI_LIBRARY_VERSION_PATCH

#define MIDI_LIBRARY_VERSION_PATCH   0

Definition at line 45 of file MIDI.h.

Function Documentation

decodeSysEx()

unsigned decodeSysEx	(	const byte *	inSysEx,
		byte *	outData,
		unsigned	inLength,
		bool	inFlipHeaderBits
	)

Decode System Exclusive messages. SysEx messages are encoded to guarantee transmission of data bytes higher than 127 without breaking the MIDI protocol. Use this static method to reassemble your received message.

Parameters

inSysEx	The SysEx data received from MIDI in.
outData	The output buffer where to store the decrypted message.
inLength	The length of the input buffer.
inFlipHeaderBits	True for Korg and other who store MSB in reverse order

Returns

The length of the output buffer.

See also

encodeSysEx

getSysExArrayLength Code inspired from Ruin & Wesen's SysEx encoder/decoder - http://ruinwesen.com

Definition at line 87 of file MIDI.cpp.

{
    unsigned count  = 0;
    byte msbStorage = 0;
    byte byteIndex  = 0;
 
    for (unsigned i = 0; i < inLength; ++i)
    {
        if ((i % 8) == 0)
        {
            msbStorage = inSysEx[i];
            byteIndex  = 6;
        }
        else
        {
            const byte body     = inSysEx[i];
            const byte shift    = inFlipHeaderBits ? 6 - byteIndex : byteIndex;
            const byte msb      = byte(((msbStorage >> shift) & 1) << 7);
            byteIndex--;
            outData[count++] = msb | body;
        }
    }
    return count;
}

encodeSysEx()

unsigned encodeSysEx	(	const byte *	inData,
		byte *	outSysEx,
		unsigned	inLength,
		bool	inFlipHeaderBits
	)

Encode System Exclusive messages. SysEx messages are encoded to guarantee transmission of data bytes higher than 127 without breaking the MIDI protocol. Use this static method to convert the data you want to send.

Parameters

inData	The data to encode.
outSysEx	The output buffer where to store the encoded message.
inLength	The length of the input buffer.
inFlipHeaderBits	True for Korg and other who store MSB in reverse order

Returns

The length of the encoded output buffer.

See also

decodeSysEx Code inspired from Ruin & Wesen's SysEx encoder/decoder - http://ruinwesen.com

Definition at line 46 of file MIDI.cpp.

{
    unsigned outLength  = 0;     // Num bytes in output array.
    byte count          = 0;     // Num 7bytes in a block.
    outSysEx[0]         = 0;
 
    for (unsigned i = 0; i < inLength; ++i)
    {
        const byte data = inData[i];
        const byte msb  = data >> 7;
        const byte body = data & 0x7f;
 
        outSysEx[0] |= (msb << (inFlipHeaderBits ? count : (6 - count)));
        outSysEx[1 + count] = body;
 
        if (count++ == 6)
        {
            outSysEx   += 8;
            outLength  += 8;
            outSysEx[0] = 0;
            count       = 0;
        }
    }
    return outLength + count + (count != 0 ? 1 : 0);
}