libcm is a C development framework with an emphasis on audio signal processing applications.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

cmMidiFile.h 6.9KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185
  1. #ifndef cmMidiFile_h
  2. #define cmMidiFile_h
  3. #ifdef __cplusplus
  4. extern "C" {
  5. #endif
  6. //( { file_desc:"MIDI file reader and writer." kw:[midi file]}
  7. // MIDI file timing:
  8. // Messages in the MIDI file are time tagged with a delta offset in 'ticks'
  9. // from the previous message in the same track.
  10. //
  11. // A 'tick' can be converted to microsends as follows:
  12. //
  13. // microsecond per tick = micros per quarter note / ticks per quarter note
  14. //
  15. // MpT = MpQN / TpQN
  16. //
  17. // TpQN is given as a constant in the MIDI file header.
  18. // MpQN is given as the value of the MIDI file tempo message.
  19. //
  20. // See cmMidiFileSeekUSecs() for an example of converting ticks to milliseconds.
  21. //
  22. // As part of the file reading process, the status byte of note-on messages
  23. // with velocity=0 are is changed to a note-off message. See _cmMidiFileReadChannelMsg().
  24. //)
  25. //(
  26. typedef cmHandle_t cmMidiFileH_t;
  27. typedef unsigned cmMfRC_t;
  28. typedef struct
  29. {
  30. cmMidiByte_t hr;
  31. cmMidiByte_t min;
  32. cmMidiByte_t sec;
  33. cmMidiByte_t frm;
  34. cmMidiByte_t sfr;
  35. } cmMidiSmpte_t;
  36. typedef struct
  37. {
  38. cmMidiByte_t num;
  39. cmMidiByte_t den;
  40. cmMidiByte_t metro;
  41. cmMidiByte_t th2s;
  42. } cmMidiTimeSig_t;
  43. typedef struct
  44. {
  45. cmMidiByte_t key;
  46. cmMidiByte_t scale;
  47. } cmMidiKeySig_t;
  48. typedef struct
  49. {
  50. cmMidiByte_t ch;
  51. cmMidiByte_t d0;
  52. cmMidiByte_t d1;
  53. unsigned durMicros; // note duration in microseconds (corrected for tempo changes)
  54. } cmMidiChMsg_t;
  55. typedef struct cmMidiTrackMsg_str
  56. {
  57. unsigned uid; // uid's are unique among all msg's in the file
  58. unsigned dtick; // delta ticks between events on this track
  59. unsigned atick; // global (all tracks interleaved) accumulated ticks
  60. unsigned amicro; // global (all tracks interleaved) accumulated microseconds adjusted for tempo changes
  61. cmMidiByte_t status; // ch msg's have the channel value removed (it is stored in u.chMsgPtr->ch)
  62. cmMidiByte_t metaId; //
  63. unsigned short trkIdx; //
  64. unsigned byteCnt; // length of data pointed to by u.voidPtr (or any other pointer in the union)
  65. struct cmMidiTrackMsg_str* link; // link to next record in this track
  66. union
  67. {
  68. cmMidiByte_t bVal;
  69. unsigned iVal;
  70. unsigned short sVal;
  71. const char* text;
  72. const void* voidPtr;
  73. const cmMidiSmpte_t* smptePtr;
  74. const cmMidiTimeSig_t* timeSigPtr;
  75. const cmMidiKeySig_t* keySigPtr;
  76. const cmMidiChMsg_t* chMsgPtr;
  77. const cmMidiByte_t* sysExPtr;
  78. } u;
  79. } cmMidiTrackMsg_t;
  80. enum
  81. {
  82. kOkMfRC = cmOkRC, // 0
  83. kFileFailMfRC, // 1
  84. kNotAMidiFileMfRC, // 2
  85. kMemAllocFailMfRC, // 3
  86. kFileCorruptMfRC, // 4
  87. kMissingEoxMfRC, // 5
  88. kUnknownMetaIdMfRC, // 6
  89. kInvalidHandleMfRC, // 7
  90. kMissingNoteOffMfRC, // 8
  91. kInvalidStatusMfRC, // 9
  92. kSustainPedalMfRC, // 10
  93. kLargeDeltaTickMfRC // 11 (a large delta tick value was filtered)
  94. };
  95. extern cmMidiFileH_t cmMidiFileNullHandle;
  96. cmMfRC_t cmMidiFileOpen( cmCtx_t* ctx, cmMidiFileH_t* hPtr, const char* fn );
  97. cmMfRC_t cmMidiFileClose( cmMidiFileH_t* hp );
  98. cmMfRC_t cmMidiFileWrite( cmMidiFileH_t h, const char* fn );
  99. bool cmMidiFileIsValid( cmMidiFileH_t h );
  100. // Returns track count or kInvalidCnt if 'h' is invalid.
  101. unsigned cmMidiFileTrackCount( cmMidiFileH_t h );
  102. // Return midi file format id (0,1,2) or kInvalidId if 'h' is invalid.
  103. unsigned cmMidiFileType( cmMidiFileH_t h );
  104. // Returns ticks per quarter note or kInvalidMidiByte if 'h' is invalid or 0 if file uses SMPTE ticks per frame time base.
  105. unsigned cmMidiFileTicksPerQN( cmMidiFileH_t h );
  106. // The file name used in an earlier call to midiFileOpen() or NULL if this
  107. // midi file did not originate from an actual file.
  108. const char* cmMidiFileName( cmMidiFileH_t h );
  109. // Returns SMPTE ticks per frame or kInvalidMidiByte if 'h' is invalid or 0 if file uses ticks per quarter note time base.
  110. cmMidiByte_t cmMidiFileTicksPerSmpteFrame( cmMidiFileH_t h );
  111. // Returns SMPTE format or kInvalidMidiByte if 'h' is invalid or 0 if file uses ticks per quarter note time base.
  112. cmMidiByte_t cmMidiFileSmpteFormatId( cmMidiFileH_t h );
  113. // Returns count of records in track 'trackIdx' or kInvalidCnt if 'h' is invalid.
  114. unsigned cmMidiFileTrackMsgCount( cmMidiFileH_t h, unsigned trackIdx );
  115. // Returns base of record chain from track 'trackIdx' or NULL if 'h' is invalid.
  116. const cmMidiTrackMsg_t* cmMidiFileTrackMsg( cmMidiFileH_t h, unsigned trackIdx );
  117. // Returns the total count of records in the midi file and the number in the array returned by cmMidiFileMsgArray().
  118. // Return kInvalidCnt if 'h' is invalid.
  119. unsigned cmMidiFileMsgCount( cmMidiFileH_t h );
  120. // Returns a pointer to the base of an array of pointers to each record in the file sorted in ascending time order.
  121. // Returns NULL if 'h' is invalid.
  122. const cmMidiTrackMsg_t** cmMidiFileMsgArray( cmMidiFileH_t h );
  123. // Return a pointer to the first msg at or after 'usecsOffs' or kInvalidIdx if no
  124. // msg exists after 'usecsOffs'. Note that 'usecOffs' is an offset from the beginning
  125. // of the file.
  126. // On return *'msgUsecsPtr' is set to the actual time of the msg.
  127. // (which will be equal to or greater than 'usecsOffs').
  128. unsigned cmMidiFileSeekUsecs( cmMidiFileH_t h, unsigned usecsOffs, unsigned* msgUsecsPtr, unsigned* newMicrosPerTickPtr );
  129. double cmMidiFileDurSecs( cmMidiFileH_t h );
  130. // Calculate Note Duration
  131. void cmMidiFileCalcNoteDurations( cmMidiFileH_t h );
  132. // Set the delay prior to the first non-zero msg.
  133. void cmMidiFileSetDelay( cmMidiFileH_t h, unsigned ticks );
  134. // This function packs a track msg into a single consecutive
  135. // block of memory buf[ bufByteCnt ]. Call cmMidiFilePackTracMsgBufByteCount()
  136. // to get the required buffer length for any given cmMidiTrackMsg_t instance.
  137. cmMidiTrackMsg_t* cmMidiFilePackTrackMsg( const cmMidiTrackMsg_t* m, void* buf, unsigned bufByteCnt );
  138. unsigned cmMidiFilePackTrackMsgBufByteCount( const cmMidiTrackMsg_t* m );
  139. void cmMidiFilePrintMsgs( cmMidiFileH_t h, cmRpt_t* rpt );
  140. void cmMidiFilePrintTrack( cmMidiFileH_t h, unsigned trkIdx, cmRpt_t* rpt );
  141. bool cmMidiFileIsNull( cmMidiFileH_t h );
  142. void cmMidiFileTest( const char* fn, cmCtx_t* ctx );
  143. // Generate a piano-roll plot description file which can be displayed with cmXScore.m
  144. cmMfRC_t cmMidiFileGenPlotFile( cmCtx_t* ctx, const cmChar_t* midiFn, const cmChar_t* outFn );
  145. //)
  146. #ifdef __cplusplus
  147. }
  148. #endif
  149. #endif