ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

EventInfo Struct Reference

Provides comprehensive information on the next event in the MIDI stream. More...

#include <midiparser.h>

List of all members.

Public Member Functions

byte channel () const
 Separates the MIDI channel from the event.
byte command () const
 Separates the command code from the event.

Public Attributes

bytestart
 Position in the MIDI stream where the event starts.
uint32 delta
 The number of ticks after the previous event that this event should occur.
byte event
 Upper 4 bits are the command code, lower 4 bits are the MIDI channel.
union {
   struct {
      byte   param1
 The first parameter in a simple MIDI message.
      byte   param2
 The second parameter in a simple MIDI message.
   }   basic
   struct {
      byte   type
 For META events, this indicates the META type.
      byte *   data
 For META and SysEx events, this points to the start of the data.
   }   ext
}; 
uint32 length
 For META and SysEx blocks, this indicates the length of the data.

Detailed Description

Provides comprehensive information on the next event in the MIDI stream.

An EventInfo struct is instantiated by format-specific implementations of MidiParser::parseNextEvent() each time another event is needed.

Definition at line 87 of file midiparser.h.


Member Function Documentation

byte EventInfo::channel (  )  const [inline]

Separates the MIDI channel from the event.

Definition at line 108 of file midiparser.h.

byte EventInfo::command (  )  const [inline]

Separates the command code from the event.

Definition at line 109 of file midiparser.h.


Member Data Documentation

union { ... }
struct { ... } EventInfo::basic

For META and SysEx events, this points to the start of the data.

Definition at line 100 of file midiparser.h.

The number of ticks after the previous event that this event should occur.

Definition at line 90 of file midiparser.h.

Upper 4 bits are the command code, lower 4 bits are the MIDI channel.

For META, event == 0xFF. For SysEx, event == 0xF0.

Definition at line 91 of file midiparser.h.

struct { ... } EventInfo::ext

For META and SysEx blocks, this indicates the length of the data.

For Note On events, a non-zero value indicates that no Note Off event will occur, and the MidiParser will have to generate one itself. For all other events, this value should always be zero.

Definition at line 103 of file midiparser.h.

The first parameter in a simple MIDI message.

Definition at line 95 of file midiparser.h.

The second parameter in a simple MIDI message.

Definition at line 96 of file midiparser.h.

Position in the MIDI stream where the event starts.

For delta-based MIDI streams (e.g. SMF and XMIDI), this points to the delta.

Definition at line 88 of file midiparser.h.

For META events, this indicates the META type.

Definition at line 99 of file midiparser.h.


The documentation for this struct was generated from the following file:


Generated on Sat Jan 12 2019 05:03:20 for ResidualVM by doxygen 1.7.1
curved edge   curved edge