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.

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629
  1. #ifndef cmProc4_h
  2. #define cmProc4_h
  3. #ifdef __cplusplus
  4. extern "C" {
  5. #endif
  6. typedef struct
  7. {
  8. unsigned smpIdx; // time tag sample index for val
  9. cmMidiByte_t val; //
  10. bool validFl; //
  11. } cmScFolBufEle_t;
  12. typedef struct
  13. {
  14. unsigned pitch;
  15. unsigned scEvtIdx;
  16. } cmScFolEvt_t;
  17. typedef struct
  18. {
  19. unsigned evtCnt; //
  20. cmScFolEvt_t* evtV; // pitchV[pitchCnt]
  21. unsigned scIdx; // index of the score loc (into cmScoreEvt[]) at this location
  22. int barNumb; // bar number of this location
  23. } cmScFolLoc_t;
  24. typedef struct
  25. {
  26. cmObj obj;
  27. cmReal_t srate; //
  28. cmScH_t scH; // score handle
  29. unsigned bufN; // event buffer count
  30. cmScFolBufEle_t* bufV; // event buffer bufV[bufN] - bufV[bufN-1] newest event, bufV[boi] oldest event
  31. int locN; // count of score locations
  32. cmScFolLoc_t* loc; // score loc[locN]
  33. unsigned sbi; // oldest score window index
  34. unsigned sei; // newest score window index
  35. unsigned msln; // minimum score look ahead count
  36. unsigned mswn; // maximum score window length
  37. unsigned forwardCnt; // count of score loc's to look ahead for a match to the current pitch when the optimal edit-dist alignment does not produce a match for the current pitch
  38. unsigned maxDist; // max. dist allowed to still consider matching
  39. unsigned minVel; // notes < minVel are ignored
  40. bool printFl; // true if pitch tracker reporting should be included
  41. bool noBackFl; // prevent the tracker from going backwards in time
  42. unsigned* edWndMtx;
  43. unsigned missCnt; // current consecutive unmatched notes
  44. unsigned matchCnt; // current consecutive matched notes
  45. unsigned eventIdx; // events since reset
  46. unsigned skipCnt; // notes skipped due to velocity
  47. unsigned ret_idx; // last tracked location
  48. } cmScFol;
  49. cmScFol* cmScFolAlloc( cmCtx* ctx, cmScFol* p, cmReal_t srate, cmScH_t scH, unsigned bufN, unsigned minWndLookAhead, unsigned maxWndCnt, unsigned minVel );
  50. cmRC_t cmScFolFree( cmScFol** pp );
  51. cmRC_t cmScFolInit( cmScFol* p, cmReal_t srate, cmScH_t scH, unsigned bufN, unsigned minWndLookAhead, unsigned maxWndCnt, unsigned minVel );
  52. cmRC_t cmScFolFinal( cmScFol* p );
  53. // Jump to a score location and reset the internal state of the follower.
  54. cmRC_t cmScFolReset( cmScFol* p, unsigned scoreIndex );
  55. // Give the follower a MIDI performance event. Only MIDI note-on events are acted upon;
  56. // all others are ignored.
  57. unsigned cmScFolExec( cmScFol* p, unsigned smpIdx, unsigned status, cmMidiByte_t d0, cmMidiByte_t d1 );
  58. //=======================================================================================================================
  59. typedef struct
  60. {
  61. unsigned pitch;
  62. unsigned scEvtIdx;
  63. bool matchFl;
  64. } cmScTrkEvt_t;
  65. typedef struct
  66. {
  67. unsigned evtCnt; //
  68. cmScTrkEvt_t* evtV; // evtV[evtCnt]
  69. unsigned scIdx; // index of the score event (into cmScoreEvt[]) at this location
  70. int barNumb; // bar number of this location
  71. } cmScTrkLoc_t;
  72. typedef struct
  73. {
  74. cmObj obj;
  75. cmScFol* sfp;
  76. double srate;
  77. cmScH_t scH;
  78. unsigned locN;
  79. cmScTrkLoc_t* loc;
  80. unsigned minVel;
  81. unsigned maxWndCnt;
  82. unsigned minWndLookAhead;
  83. bool printFl;
  84. int curLocIdx;
  85. unsigned evtIndex;
  86. } cmScTrk;
  87. cmScTrk* cmScTrkAlloc( cmCtx* ctx, cmScTrk* p, cmReal_t srate, cmScH_t scH, unsigned bufN, unsigned minWndLookAhead, unsigned maxWndCnt, unsigned minVel );
  88. cmRC_t cmScTrkFree( cmScTrk** pp );
  89. cmRC_t cmScTrkInit( cmScTrk* p, cmReal_t srate, cmScH_t scH, unsigned bufN, unsigned minWndLookAhead, unsigned maxWndCnt, unsigned minVel );
  90. cmRC_t cmScTrkFinal( cmScTrk* p );
  91. // Jump to a score location and reset the internal state of the follower.
  92. cmRC_t cmScTrkReset( cmScTrk* p, unsigned scoreIndex );
  93. // Give the follower a MIDI performance event. Only MIDI note-on events are acted upon;
  94. // all others are ignored.
  95. unsigned cmScTrkExec( cmScTrk* p, unsigned smpIdx, unsigned status, cmMidiByte_t d0, cmMidiByte_t d1 );
  96. //=======================================================================================================================
  97. //
  98. // Simplified string alignment function based on Levenshtein edit distance.
  99. //
  100. enum { kEdMinIdx, kEdSubIdx, kEdDelIdx, kEdInsIdx, kEdCnt };
  101. typedef struct
  102. {
  103. unsigned v[kEdCnt];
  104. bool matchFl;
  105. bool transFl;
  106. } ed_val;
  107. typedef struct ed_path_str
  108. {
  109. unsigned code;
  110. unsigned ri;
  111. unsigned ci;
  112. bool matchFl;
  113. bool transFl;
  114. struct ed_path_str* next;
  115. } ed_path;
  116. /*
  117. Backtracking:
  118. m[rn,cn] is organized to indicate the mutation operations
  119. on s0[0:rn-1] or s1[0:cn-1] during backtracking.
  120. Backtracking begins at cell m[rn-1,cn-1] and proceeds
  121. up and left toward m[0,0]. The action to perform during
  122. backtracking is determined by examinging which values
  123. int m[].v[1:3] match m[].v[0].
  124. Match Next Cell
  125. Index Operation Location
  126. ----- ------------------------ ------------------------
  127. 1 Substitute char s0[ri-1] move diagonally; up-left
  128. 2 Delete char s0[ri-1] move up.
  129. 3 Delete char s1[ci-1] move left.
  130. (same as inserting blank
  131. into after s[ri-1]
  132. Note that more than one value in m[].v[1:3] may match
  133. m[].v[0]. In this case the candidate solution branches
  134. at this point in the candidate selection processes.
  135. */
  136. typedef struct
  137. {
  138. const char* s0; // forms rows of m[] - mutate to match s1 - rn=strlen(s0)
  139. const char* s1; // forms columns of m[] - target string - cn=strlen(s1)
  140. unsigned rn; // length of s0 + 1
  141. unsigned cn; // length of s1 + 1
  142. ed_val* m; // m[rn,cn]
  143. unsigned pn; // rn+cn
  144. ed_path* p_mem; // pmem[ 2*pn ];
  145. ed_path* p_avl; // available path record linked list
  146. ed_path* p_cur; // current path linked list
  147. ed_path* p_opt; // p_opt[pn] current best alignment
  148. double s_opt; // score of the current best alignment
  149. } ed_r;
  150. // print the DP matrix ed_r.m[rn,cn].
  151. void ed_print_mtx( ed_r* r );
  152. // Initialize ed_r.
  153. void ed_init( ed_r* r, const char* s0, const char* s1 );
  154. // Fill in the DP matrix.
  155. void ed_calc_mtx( ed_r* r );
  156. // Traverse the possible alignments in the DP matrix and determine the optimal alignment.
  157. void ed_align( ed_r* r );
  158. // Print the optimal alignment p_opt[]
  159. void ed_print_opt( ed_r* r );
  160. // Free resource allocated by ed_init().
  161. void ed_free(ed_r* r);
  162. // Main test function.
  163. void ed_main();
  164. //=======================================================================================================================
  165. enum
  166. {
  167. kSmMinIdx, //
  168. kSmSubIdx, // 'substitute' - may or may not match
  169. kSmDelIdx, // 'delete' - delete a MIDI note
  170. kSmInsIdx, // 'insert' - insert a space in the score
  171. kSmCnt
  172. };
  173. enum
  174. {
  175. kSmMatchFl = 0x01,
  176. kSmTransFl = 0x02,
  177. kSmTruePosFl = 0x04,
  178. kSmFalsePosFl = 0x08,
  179. kSmBarFl = 0x10,
  180. kSmNoteFl = 0x20
  181. };
  182. // Dynamic Programming (DP) matrix element
  183. typedef struct
  184. {
  185. unsigned v[kSmCnt]; // cost for each operation
  186. unsigned flags; // cmSmMatchFl | cmSmTransFl
  187. unsigned scEvtIdx;
  188. } cmScMatchVal_t;
  189. // List record used to track a path through the DP matrix p->m[,]
  190. typedef struct cmScMatchPath_str
  191. {
  192. unsigned code; // kSmXXXIdx
  193. unsigned ri; // matrix row index
  194. unsigned ci; // matrix col index
  195. unsigned flags; // cmSmMatchFl | cmSmTransFl
  196. unsigned locIdx; // p->loc index or cmInvalidIdx
  197. unsigned scEvtIdx; // scScore event index
  198. struct cmScMatchPath_str* next; //
  199. } cmScMatchPath_t;
  200. typedef struct cmScMatchEvt_str
  201. {
  202. unsigned pitch; //
  203. unsigned scEvtIdx; // scScore event index
  204. } cmScMatchEvt_t;
  205. // Score location record.
  206. typedef struct
  207. {
  208. unsigned evtCnt; //
  209. cmScMatchEvt_t* evtV; // evtV[evtCnt]
  210. unsigned scLocIdx; // scH score location index
  211. int barNumb; // bar number of this location
  212. } cmScMatchLoc_t;
  213. typedef struct
  214. {
  215. unsigned mni; // unique identifier for this MIDI note - used to recognize when the cmScMatcher backtracks.
  216. unsigned smpIdx; // time stamp of this event
  217. unsigned pitch; // MIDI note pitch
  218. unsigned vel; // " " velocity
  219. unsigned locIdx; // location assoc'd with this MIDI evt (cmInvalidIdx if not a matching or non-matching 'substitute')
  220. unsigned scEvtIdx; // cmScore event index assoc'd with this event
  221. } cmScMatchMidi_t;
  222. typedef struct
  223. {
  224. cmObj obj; //
  225. cmScH_t scH; // cmScore handle
  226. unsigned locN; //
  227. cmScMatchLoc_t* loc; // loc[locN]
  228. unsigned mrn; // max m[] row count (midi)
  229. unsigned rn; // cur m[] row count
  230. unsigned mcn; // max m[] column count (score)
  231. unsigned cn; // cur m[] column count
  232. unsigned mmn; // max length of midiBuf[] (mrn-1)
  233. unsigned msn; // max length of score window (mcn-1)
  234. cmScMatchVal_t* m; // m[mrn,mcn] DP matrix
  235. unsigned pn; // mrn+mcn
  236. cmScMatchPath_t* p_mem; // pmem[ 2*pn ] - path memory
  237. cmScMatchPath_t* p_avl; // available path record linked list
  238. cmScMatchPath_t* p_cur; // current path linked list
  239. cmScMatchPath_t* p_opt; // p_opt[pn] - current best alignment as a linked list
  240. double opt_cost; // last p_opt cost set by cmScMatchExec()
  241. } cmScMatch;
  242. /*
  243. 1) This matcher cannot handle multiple instances of the same pitch occuring
  244. at the same 'location'.
  245. 2) Because each note of a chord is spread out over multiple locations, and
  246. there is no way to indicate that a note in the chord is already 'in-use'.
  247. If a MIDI note which is part of the chord is repeated, in error, it will
  248. apear to be correct (a positive match will be assigned to
  249. the second (and possible successive notes)).
  250. */
  251. cmScMatch* cmScMatchAlloc( cmCtx* c, cmScMatch* p, cmScH_t scH, unsigned maxScWndN, unsigned maxMidiWndN );
  252. cmRC_t cmScMatchFree( cmScMatch** pp );
  253. cmRC_t cmScMatchInit( cmScMatch* p, cmScH_t scH, unsigned maxScWndN, unsigned maxMidiWndN );
  254. cmRC_t cmScMatchFinal( cmScMatch* p );
  255. // Locate the position in p->loc[locIdx:locIdx+locN-1] which bests
  256. // matches midiV[midiN].
  257. // The result of this function is to update p_opt[]
  258. // The optimal path p_opt[] will only be updated if the edit_cost associated 'midiV[midiN]'.
  259. // with the best match is less than 'min_cost'.
  260. // Set 'min_cost' to DBL_MAX to force p_opt[] to be updated.
  261. // Returns cmEofRC if locIdx + locN > p->locN - note that this is not
  262. // necessarily an error.
  263. cmRC_t cmScMatchExec( cmScMatch* p, unsigned locIdx, unsigned locN, const cmScMatchMidi_t* midiV, unsigned midiN, double min_cost );
  264. //=======================================================================================================================
  265. typedef struct
  266. {
  267. unsigned locIdx;
  268. unsigned scEvtIdx;
  269. unsigned mni;
  270. unsigned smpIdx;
  271. unsigned pitch;
  272. unsigned vel;
  273. unsigned flags;
  274. } cmScMatcherResult_t;
  275. struct cmScMatcher_str;
  276. typedef void (*cmScMatcherCb_t)( struct cmScMatcher_str* p, void* arg, cmScMatcherResult_t* rp );
  277. typedef struct cmScMatcher_str
  278. {
  279. cmObj obj;
  280. cmScMatcherCb_t cbFunc;
  281. void* cbArg;
  282. cmScMatch* mp;
  283. unsigned mn;
  284. cmScMatchMidi_t* midiBuf; // midiBuf[mn]
  285. cmScMatcherResult_t* res; // res[rn]
  286. unsigned rn; // length of res[] (set to 2*score event count)
  287. unsigned ri; // next avail res[] recd.
  288. double s_opt; //
  289. unsigned missCnt; // current count of consecutive trailing non-matches
  290. unsigned ili; // index into loc[] to start scan following reset
  291. unsigned eli; // index into loc[] of the last positive match.
  292. unsigned mni; // current count of MIDI events since the last call to cmScMatcherReset()
  293. unsigned mbi; // index of oldest MIDI event in midiBuf[]; stays at 0 when the buffer is full.
  294. unsigned begSyncLocIdx; // start of score window, in mp->loc[], of best match in previous scan
  295. unsigned initHopCnt; // max window hops during the initial (when the MIDI buffer fills for first time) sync scan
  296. unsigned stepCnt; // count of forward/backward score loc's to examine for a match during cmScMatcherStep().
  297. unsigned maxMissCnt; // max. number of consecutive non-matches during step prior to executing a scan.
  298. unsigned scanCnt; // current count of times a resync-scan was executed during cmScMatcherStep()
  299. bool printFl;
  300. } cmScMatcher;
  301. cmScMatcher* cmScMatcherAlloc(
  302. cmCtx* c, // Program context.
  303. cmScMatcher* p, // Existing cmScMatcher to reallocate or NULL to allocate a new cmScMatcher.
  304. double srate, // System sample rate.
  305. cmScH_t scH, // Score handle. See cmScore.h.
  306. unsigned scWndN, // Length of the scores active search area. ** See Note.
  307. unsigned midiWndN, // Length of the MIDI active note buffer. ** See Note.
  308. cmScMatcherCb_t cbFunc, // A cmScMatcherCb_t function to be called to notify the recipient of changes in the score matcher status.
  309. void* cbArg ); // User argument to 'cbFunc'.
  310. // The cmScMatcher maintains an internal cmScMatch object which is used to attempt to find the
  311. // best match between the current MIDI active note buffer and the current score search area.
  312. // 'scWndN' is used to set the cmScMatch 'locN' argument.
  313. // 'midiWndN' sets the length of the MIDI FIFO which is used to match to the score with
  314. // each recceived MIDI note.
  315. // 'midiWndN' must be <= 'scWndN'.
  316. cmRC_t cmScMatcherFree( cmScMatcher** pp );
  317. cmRC_t cmScMatcherInit( cmScMatcher* p, double srate, cmScH_t scH, unsigned scWndN, unsigned midiWndN, cmScMatcherCb_t cbFunc, void* cbArg );
  318. cmRC_t cmScMatcherFinal( cmScMatcher* p );
  319. // 'scLocIdx' is a score index as used by cmScoreLoc(scH) not into p->mp->loc[].
  320. cmRC_t cmScMatcherReset( cmScMatcher* p, unsigned scLocIdx );
  321. // Slide a score window 'hopCnt' times, beginning at 'bli' (an
  322. // index int p->mp->loc[]) looking for the best match to p->midiBuf[].
  323. // The score window contain scWndN (p->mp->mcn-1) score locations.
  324. // Returns the index into p->mp->loc[] of the start of the best
  325. // match score window. The score associated
  326. // with this match is stored in s_opt.
  327. unsigned cmScMatcherScan( cmScMatcher* p, unsigned bli, unsigned hopCnt );
  328. // Step forward/back by p->stepCnt from p->eli.
  329. // p->eli must therefore be valid prior to calling this function.
  330. // If more than p->maxMissCnt consecutive MIDI events are
  331. // missed then automatically run cmScAlignScan().
  332. // Return cmEofRC if the end of the score is encountered.
  333. // Return cmSubSysFailRC if an internal scan resync. failed.
  334. cmRC_t cmScMatcherStep( cmScMatcher* p );
  335. // This function calls cmScMatcherScan() and cmScMatcherStep() internally.
  336. // If 'status' is not kNonMidiMdId then the function returns without changing the
  337. // state of the object.
  338. // If the MIDI note passed by the call results in a successful match then
  339. // p->eli will be updated to the location in p->mp->loc[] of the latest
  340. // match, the MIDI note in p->midiBuf[] associated with this match
  341. // will be assigned a valid locIdx and scLocIdx values, and *scLocIdxPtr
  342. // will be set with the matched scLocIdx of the match.
  343. // If this call does not result in a successful match *scLocIdxPtr is set
  344. // to cmInvalidIdx.
  345. // Return:
  346. // cmOkRC - Continue processing MIDI events.
  347. // cmEofRC - The end of the score was encountered.
  348. // cmInvalidArgRC - scan failed or the object was in an invalid state to attempt a match.
  349. // cmSubSysFailRC - a scan resync failed in cmScMatcherStep().
  350. cmRC_t cmScMatcherExec( cmScMatcher* p, unsigned smpIdx, unsigned status, cmMidiByte_t d0, cmMidiByte_t d1, unsigned* scLocIdxPtr );
  351. void cmScMatcherPrint( cmScMatcher* p );
  352. //=======================================================================================================================
  353. typedef struct
  354. {
  355. cmScoreSet_t* sp; // ptr to this set in the score
  356. unsigned bsei; // begin score event index
  357. unsigned esei; // end score event index
  358. unsigned bsli; // beg score loc index
  359. unsigned esli; // end score loc index
  360. unsigned bli; //
  361. unsigned eli; //
  362. double value; // DBL_MAX if the value has not yet been set
  363. double tempo; //
  364. double match_cost; // cost of the match to the performance divided by sp->eleCnt
  365. } cmScMeasSet_t;
  366. typedef struct
  367. {
  368. cmObj obj;
  369. double srate; //
  370. cmScMatch* mp; //
  371. unsigned mii; // next avail recd in midiBuf[]
  372. unsigned mn; // length of of midiBuf[] (init. to 2*cmScoreEvtCount())
  373. cmScMatchMidi_t* midiBuf; // midiBuf[mn]
  374. unsigned sn; // length of set[] (init. to cmScoreSetCount())
  375. cmScMeasSet_t* set; // set[sn]
  376. unsigned dn; // length of dynRef[]
  377. unsigned* dynRef; // dynRef[dn]
  378. unsigned nsi; // next set index to fill (this is the set[] we are waiting to complete)
  379. unsigned nsli; // next score location index we are expecting to receive
  380. unsigned vsi; // set[vsi:nsi-1] indicates sets with new values following a call to cmScMeasExec()
  381. unsigned vsli; // vsli:nsli-1 indicates cmScore loc's to check for section triggers following a call to cmScMeasExec()
  382. } cmScMeas;
  383. //
  384. // Notes:
  385. //
  386. // 1) midiBuf[] stores all MIDI notes for the duration of the performance
  387. // it is initialized to 2*score_event_count.
  388. //
  389. // 2) dynRef][ is the gives the MIDI velocity range for each dynamics
  390. // category: pppp-fff
  391. //
  392. // 3) See a cmDspKr.c _cmScFolMatcherCb() for an example of how
  393. // cmScMeas.vsi and cmScMeas.vsli are used to act on the results of
  394. // a call to cmMeasExec().
  395. cmScMeas* cmScMeasAlloc( cmCtx* c, cmScMeas* p, cmScH_t scH, double srate, const unsigned* dynRefArray, unsigned dynRefCnt );
  396. cmRC_t cmScMeasFree( cmScMeas** pp );
  397. cmRC_t cmScMeasInit( cmScMeas* p, cmScH_t scH, double srate, const unsigned* dynRefArray, unsigned dynRefCnt );
  398. cmRC_t cmScMeasFinal( cmScMeas* p );
  399. // Empty MIDI buffer and set the next set nsi and nsli to zero.
  400. cmRC_t cmScMeasReset( cmScMeas* p );
  401. // This function is called for each input MIDI note which is assigned a
  402. // score location by cmScMatcher.
  403. // 'mni' is the MIDI event index which uniquely identifies this MIDI event.
  404. // 'locIdx' is the location index into cmScMatcher.mp->loc[] associated with
  405. // this event.
  406. cmRC_t cmScMeasExec( cmScMeas* p, unsigned mni, unsigned locIdx, unsigned scEvtIdx, unsigned flags, unsigned smpIdx, unsigned pitch, unsigned vel );
  407. //=======================================================================================================================
  408. unsigned cmScAlignScanToTimeLineEvent( cmScMatcher* p, cmTlH_t tlH, cmTlObj_t* top, unsigned endSmpIdx );
  409. // Given a score, a time-line, and a marker on the time line scan the
  410. // entire score looking for the best match between the first 'midiN'
  411. // notes in each marker region and the score.
  412. void cmScAlignScanMarkers( cmRpt_t* rpt, cmTlH_t tlH, cmScH_t scH );
  413. //=======================================================================================================================
  414. /*
  415. Syntax: <loc> <mod> <var> <type> <params>
  416. <loc> - score location
  417. <mod> - name of the modulator
  418. <var> - variable name
  419. <type> - type of operation
  420. <params>
  421. <min> - set a variable min value
  422. <max> - set a variable max value
  423. <rate> - limit how often a variable is transmitted while it is ramping
  424. <val> - type dependent value - see 'Types' below.
  425. <end> - ending value for a ramping variable
  426. <dur> - determines the length of time to get to the ending value
  427. The value of parameters may be literal numeric values or may refer to
  428. variables by their name.
  429. Types:
  430. set = set <var> to <val> which may be a literal or another variable.
  431. line = ramp from its current value to <val> over <dur> seconds
  432. sline = set <var> to <val> and ramp to <end> over <dur> seconds
  433. */
  434. enum
  435. {
  436. kInvalidModTId,
  437. kSetModTId, // set variable to parray[0] at scLocIdx
  438. kLineModTId, // linear ramp variable to parray[0] over parray[1] seconds
  439. kSetLineModTId, // set variable to parray[0] and ramp to parray[1] over parray[2] seconds
  440. };
  441. enum
  442. {
  443. kActiveModFl = 0x01, // this variable is on the 'active' list
  444. kCalcModFl = 0x02 // when this variable is used as a parameter it's value must be calculated rather than used directly.
  445. };
  446. struct cmScModEntry_str;
  447. typedef enum
  448. {
  449. kInvalidModPId,
  450. kLiteralModPId, // this is a literal value
  451. kSymbolModPId //
  452. } cmScModPId_t;
  453. typedef struct cmScModParam_str
  454. {
  455. cmScModPId_t pid; // parameter type: literal or symbol
  456. unsigned symId; // symbol of external and internal variables
  457. double val; // value of literals
  458. } cmScModParam_t;
  459. typedef struct cmScModVar_str
  460. {
  461. unsigned flags; // see kXXXModFl flags above.
  462. unsigned varSymId; // variable name
  463. unsigned outVarId; // output var id
  464. double value; // current value of this variable
  465. double v0; // reserved internal variable
  466. unsigned phase; // cycle phase since activation
  467. double min;
  468. double max;
  469. double rate; // output rate in milliseconds (use
  470. struct cmScModEntry_str* entry; // last entry assoc'd with this value
  471. struct cmScModVar_str* vlink; // p->vlist link
  472. struct cmScModVar_str* alink; // p->alist link
  473. } cmScModVar_t;
  474. // Each entry gives a time tagged location and some parameters
  475. // for an algorthm which is used to set/modulate a value.
  476. typedef struct cmScModEntry_str
  477. {
  478. unsigned scLocIdx; // entry start time
  479. unsigned typeId; // variable type
  480. cmScModParam_t beg; // parameter values
  481. cmScModParam_t end; //
  482. cmScModParam_t dur; //
  483. cmScModParam_t min; // min value for this variable
  484. cmScModParam_t max; // max value for this variable
  485. cmScModParam_t rate; // update rate in milliseconds (DBL_MAX to disable)
  486. cmScModVar_t* varPtr; // target variable
  487. } cmScModEntry_t;
  488. typedef void (*cmScModCb_t)( void* cbArg, unsigned varSymId, double value );
  489. typedef struct
  490. {
  491. cmObj obj;
  492. cmChar_t* fn; // modulator score file
  493. unsigned modSymId; // modulator name
  494. cmSymTblH_t stH; // symbol table used by this modulator
  495. cmScModCb_t cbFunc; // active value callback function
  496. void* cbArg; // first arg to cbFunc()
  497. unsigned samplesPerCycle; // interval in samples between calls to cmScModulatorExec()
  498. double srate; // system sample rate
  499. cmScModEntry_t* earray; // earray[en] - entry array sorted on ascending cmScModEntry_t.scLocIdx
  500. unsigned en; // count
  501. cmScModVar_t* vlist; // variable list
  502. cmScModVar_t* alist; // active variable list
  503. cmScModVar_t* elist; // last element on the active list
  504. unsigned nei; // next entry index
  505. unsigned outVarCnt; // count of unique vars that are targets of entry recds
  506. } cmScModulator;
  507. cmScModulator* cmScModulatorAlloc( cmCtx* c, cmScModulator* p, cmCtx_t* ctx, cmSymTblH_t stH, double srate, unsigned samplesPerCycle, const cmChar_t* fn, const cmChar_t* modLabel, cmScModCb_t cbFunc, void* cbArg );
  508. cmRC_t cmScModulatorFree( cmScModulator** pp );
  509. cmRC_t cmScModulatorInit( cmScModulator* p, cmCtx_t* ctx, cmSymTblH_t stH, double srate, unsigned samplesPerCycle, const cmChar_t* fn, const cmChar_t* modLabel, cmScModCb_t cbFunc, void* cbArg );
  510. cmRC_t cmScModulatorFinal( cmScModulator* p );
  511. // Return count of variables.
  512. unsigned cmScModulatorOutVarCount( cmScModulator* p );
  513. // Return a pointer to the variable at vlist[idx].
  514. cmScModVar_t* cmScModulatorOutVar( cmScModulator* p, unsigned idx );
  515. cmRC_t cmScModulatorSetValue( cmScModulator* p, unsigned varSymId, double value, double min, double max );
  516. cmRC_t cmScModulatorReset( cmScModulator* p, cmCtx_t* ctx, unsigned scLocIdx );
  517. cmRC_t cmScModulatorExec( cmScModulator* p, unsigned scLocIdx );
  518. cmRC_t cmScModulatorDump( cmScModulator* p );
  519. #ifdef __cplusplus
  520. }
  521. #endif
  522. #endif