libcm is a C development framework with an emphasis on audio signal processing applications.
選択できるのは25トピックまでです。 トピックは、先頭が英数字で、英数字とダッシュ('-')を使用した35文字以内のものにしてください。

cmScore.h 10KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273
  1. #ifndef cmScore_h
  2. #define cmScore_h
  3. #ifdef __cplusplus
  4. extern "C" {
  5. #endif
  6. enum
  7. {
  8. kOkScRC = cmOkRC,
  9. kCsvFailScRC,
  10. kSyntaxErrScRC,
  11. kInvalidIdxScRC,
  12. kTimeLineFailScRC,
  13. kInvalidDynRefCntScRC,
  14. kMidiFileFailScRC
  15. };
  16. enum
  17. {
  18. kInvalidEvtScId = 0,
  19. kTimeSigEvtScId,
  20. kKeySigEvtScId,
  21. kTempoEvtScId,
  22. kTrackEvtScId,
  23. kTextEvtScId,
  24. kNameEvtScId,
  25. kEOTrackEvtScId,
  26. kCopyEvtScId,
  27. kBlankEvtScId,
  28. kBarEvtScId,
  29. kPgmEvtScId,
  30. kCtlEvtScId,
  31. kNonEvtScId
  32. };
  33. // Flags used by cmScoreEvt_t.flags
  34. enum
  35. {
  36. kEvenScFl = 0x001, // This note is marked for evenness measurement
  37. kDynScFl = 0x002, // This note is marked for dynamics measurement
  38. kTempoScFl = 0x004, // This note is marked for tempo measurement
  39. kSkipScFl = 0x008, // This isn't a real event (e.g. tied note) skip over it
  40. kGraceScFl = 0x010, // This is a grace note
  41. kInvalidScFl = 0x020 // This note has a calculated time
  42. };
  43. // Id's used by cmScoreSet_t.varId and as indexes into
  44. // cmScoreSection_t.vars[].
  45. enum
  46. {
  47. kEvenVarScId,
  48. kDynVarScId,
  49. kTempoVarScId,
  50. kScVarCnt
  51. };
  52. struct cmScoreLoc_str;
  53. struct cmScoreSet_str;
  54. // The score can be divided into arbitrary non-overlapping sections.
  55. typedef struct
  56. {
  57. const cmChar_t* label; // section label
  58. unsigned index; // index of this record in the internal section array
  59. struct cmScoreLoc_str* locPtr; // location where this section starts
  60. unsigned begEvtIndex; // score element index where this section starts
  61. unsigned setCnt; // Count of elements in setArray[]
  62. struct cmScoreSet_str** setArray; // Ptrs to sets which are applied to this section.
  63. double vars[ kScVarCnt ]; // Set to DBL_MAX by default.
  64. } cmScoreSection_t;
  65. typedef struct
  66. {
  67. unsigned type; // Event type
  68. double secs; // Time location in seconds
  69. double durSecs; // Duration in seconds
  70. unsigned index; // Index of this event in the event array.
  71. unsigned locIdx; // Index of the location containing this event
  72. cmMidiByte_t pitch; // MIDI pitch of this note
  73. unsigned flags; // Attribute flags for this event
  74. unsigned dynVal; // Dynamcis value pppp to ffff (1 to 11) for this note.
  75. double frac; // Note's time value for tempo and non-grace evenness notes.
  76. unsigned barNumb; // Bar id of the measure containing this event.
  77. unsigned barNoteIdx; // Index of this note in this bar
  78. unsigned csvRowNumb; // File row number (not index) from which this record originated
  79. unsigned perfSmpIdx; // Time this event was performed or cmInvalidIdx if the event was not performed.
  80. unsigned perfVel; // Velocity of the performed note or 0 if the note was not performed.
  81. unsigned perfDynLvl; // Index into dynamic level ref. array assoc'd with perfVel
  82. unsigned line; // Line number of this event in the score file.
  83. } cmScoreEvt_t;
  84. typedef struct cmScoreSet_str
  85. {
  86. unsigned varId; // See kXXXVarScId flags above
  87. cmScoreEvt_t** eleArray; // Events that make up this set in time order
  88. unsigned eleCnt; //
  89. cmScoreSection_t** sectArray; // Sections this set will be applied to
  90. unsigned sectCnt; //
  91. unsigned* symArray; // symArray[sectCnt] - symbol name of all variables represented by this set (e.g '1a-e', '1b-e', '2-t', etc)
  92. unsigned* costSymArray; // costSymArray[sectCnt] - same as symbols in symArray[] with 'c' prepended to front
  93. bool doneFl;
  94. double value;
  95. struct cmScoreSet_str* llink; // cmScoreLoc_t setList link
  96. } cmScoreSet_t;
  97. typedef enum
  98. {
  99. kInvalidScMId,
  100. kRecdBegScMId,
  101. kRecdEndScMId,
  102. kFadeScMId,
  103. kPlayBegScMId,
  104. kPlayEndScMId
  105. } cmMarkScMId_t;
  106. // score markers
  107. typedef struct cmScoreMarker_str
  108. {
  109. cmMarkScMId_t markTypeId; // marker type
  110. unsigned labelSymId; // marker label
  111. struct cmScoreLoc_str* scoreLocPtr; // score location of the marker
  112. unsigned csvRowIdx; // score CSV file line assoc'd w/ this marker
  113. struct cmScoreMarker_str* link; // cmScoreLoc_t.markList links
  114. } cmScoreMarker_t;
  115. // All events which are simultaneous are collected into a single
  116. // cmScoreLoc_t record.
  117. typedef struct cmScoreLoc_str
  118. {
  119. unsigned index; // index of this location record
  120. double secs; // Time of this location
  121. unsigned evtCnt; // Count of events in evtArray[].
  122. cmScoreEvt_t** evtArray; // Events which occur at this time.
  123. unsigned barNumb; // Bar number this event is contained by.
  124. cmScoreSet_t* setList; // Set's which end on this time location (linked through cmScoreSet_t.llink)
  125. cmScoreSection_t* begSectPtr; // NULL if this location does not start a section
  126. cmScoreMarker_t* markList; // List of markers assigned to this location
  127. } cmScoreLoc_t;
  128. typedef void (*cmScCb_t)( void* arg, const void* data, unsigned byteCnt );
  129. typedef cmRC_t cmScRC_t;
  130. typedef cmHandle_t cmScH_t;
  131. extern cmScH_t cmScNullHandle;
  132. const cmChar_t* cmScEvtTypeIdToLabel( unsigned id );
  133. const cmChar_t* cmScDynIdToLabel( unsigned id );
  134. // Initialize a score object from a CSV File generated from a score spreadsheet.
  135. // The dynRefArray[dynRefCnt] and cbFunc(cbArg) are optional if these
  136. // features are not used.
  137. // If provided the dynRefArray[] is copied into an internal array.
  138. // The physical array passed here therefore does not need to remain valid.
  139. // Set 'srate' to zero if the score will not be used to perform measurement calculations.
  140. // The symbol table is only necessary if valid symbols are to be assigned to the cmScoreSet_t.symArray[].
  141. cmScRC_t cmScoreInitialize( cmCtx_t* ctx, cmScH_t* hp, const cmChar_t* fn, double srate, const unsigned* dynRefArray, unsigned dynRefCnt, cmScCb_t cbFunc, void* cbArg, cmSymTblH_t stH );
  142. cmScRC_t cmScoreFinalize( cmScH_t* hp );
  143. // Filename of last successfuly loaded score file.
  144. const cmChar_t* cmScoreFileName( cmScH_t h );
  145. // Sample rate as set in cmScoreInitialize()
  146. double cmScoreSampleRate( cmScH_t h );
  147. // Validate the score handle
  148. bool cmScoreIsValid( cmScH_t h );
  149. // Access the score data.
  150. unsigned cmScoreEvtCount( cmScH_t h );
  151. cmScoreEvt_t* cmScoreEvt( cmScH_t h, unsigned idx );
  152. // Given a bar number return the associated 'bar' event record.
  153. cmScoreEvt_t* cmScoreBarEvt( cmScH_t h, unsigned barNumb );
  154. // Access section records
  155. unsigned cmScoreSectionCount( cmScH_t h );
  156. cmScoreSection_t* cmScoreSection( cmScH_t h, unsigned idx );
  157. // Access the score location data
  158. unsigned cmScoreLocCount( cmScH_t h );
  159. cmScoreLoc_t* cmScoreLoc( cmScH_t h, unsigned idx );
  160. void cmScorePrintLoc( cmScH_t h );
  161. // Return the location associated with a given score event.
  162. cmScoreLoc_t* cmScoreEvtLoc( cmScH_t h, const cmScoreEvt_t* evt );
  163. // Return the count of sets.
  164. unsigned cmScoreSetCount( cmScH_t h );
  165. unsigned cmScoreMarkerLabelCount( cmScH_t h );
  166. unsigned cmScoreMarkerLabelSymbolId( cmScH_t h, unsigned idx );
  167. const cmScoreMarker_t* cmScoreMarker( cmScH_t h, cmMarkScMId_t markMId, unsigned labelSymId );
  168. // Make callbacks for all events in the score. The callbacks
  169. // contain cmScMsg_t records serialized as a byte stream.
  170. // Use cmScoreDecode() to convert the byte string to a
  171. // cmScMsg_t record.
  172. cmScRC_t cmScoreSeqNotify( cmScH_t h );
  173. void cmScoreClearPerfInfo( cmScH_t h );
  174. // Assign 'smpIdx' and 'vel' to the event matching 'pitch' at 'locIdx'
  175. // but do not trigger any variable calculations. Return true if as a
  176. // result of this call all events assigned to 'locIdx' have been received
  177. // otherwise return false.
  178. bool cmScoreSetPerfEvent( cmScH_t h, unsigned locIdx, unsigned smpIdx, unsigned pitch, unsigned vel );
  179. // Assign 'smpIdx' and 'vel' to the event matching 'pitch' at 'locIdx'
  180. // but and trigger any variable calculations which may happen on, or before, 'locIdx'.
  181. void cmScoreExecPerfEvent( cmScH_t h, unsigned locIdx, unsigned smpIdx, unsigned pitch, unsigned vel );
  182. // Assign 'value' to the section at, or before, 'locIdx'.
  183. void cmScoreSetPerfValue( cmScH_t h, unsigned locIdx, unsigned varId, double value );
  184. // Set the performed dynamic level of a score event.
  185. void cmScoreSetPerfDynLevel( cmScH_t h, unsigned evtIdx, unsigned dynLvl );
  186. typedef enum
  187. {
  188. kInvalidMsgScId,
  189. kBeginMsgScId,
  190. kEventMsgScId,
  191. kSectionMsgScId,
  192. kEndMsgScId,
  193. kVarMsgScId,
  194. kDynMsgScId
  195. } cmScMsgTypeId_t;
  196. typedef struct
  197. {
  198. unsigned varId; // see kXXXVarScId from cmScoreSet_t.varId
  199. double value; // value of a variable
  200. } cmScMeas_t;
  201. typedef struct
  202. {
  203. unsigned evtIdx;
  204. unsigned dynLvl;
  205. } cmScDyn_t;
  206. typedef struct
  207. {
  208. cmScMsgTypeId_t typeId;
  209. union
  210. {
  211. cmScoreEvt_t evt; // only used when typeId == kEventMsgScId
  212. cmScMeas_t meas; // only used when typeId == kVarMsgScId
  213. cmScoreSection_t sect; // only used when typeId == kSectionMsgScId
  214. cmScDyn_t dyn; // only used when typeId == kDynLvlMsgScId
  215. } u;
  216. } cmScMsg_t;
  217. // Decode a serialized cmScMsg_t from a byte stream as passed to the
  218. // cmScCb_t function.
  219. cmScRC_t cmScoreDecode( const void* msg, unsigned msgByteCnt, cmScMsg_t* );
  220. void cmScorePrint( cmScH_t h, cmRpt_t* rpt );
  221. // Generate a new score file from a MIDI file.
  222. cmScRC_t cmScoreFileFromMidi( cmCtx_t* ctx, const cmChar_t* midiFn, const cmChar_t* scoreFn );
  223. void cmScoreTest( cmCtx_t* ctx, const cmChar_t* fn );
  224. #ifdef __cplusplus
  225. }
  226. #endif
  227. #endif