cmProc4.h : Updated comments and formatting.

This commit is contained in:
kevin 2013-11-03 11:52:03 -08:00
parent b67964871f
commit 3e5af0773e

View File

@ -359,11 +359,12 @@ cmScMatcher* cmScMatcherAlloc(
cmScMatcher* p, // Existing cmScMatcher to reallocate or NULL to allocate a new cmScMatcher. cmScMatcher* p, // Existing cmScMatcher to reallocate or NULL to allocate a new cmScMatcher.
double srate, // System sample rate. double srate, // System sample rate.
cmScH_t scH, // Score handle. See cmScore.h. cmScH_t scH, // Score handle. See cmScore.h.
unsigned scWndN, // Length of the scores active search area. ** See Note. unsigned scWndN, // Length of the scores active search area. ** See Notes.
unsigned midiWndN, // Length of the MIDI active note buffer. ** See Note. unsigned midiWndN, // Length of the MIDI active note buffer. ** See Notes.
cmScMatcherCb_t cbFunc, // A cmScMatcherCb_t function to be called to notify the recipient of changes in the score matcher status. cmScMatcherCb_t cbFunc, // A cmScMatcherCb_t function to be called to notify the recipient of changes in the score matcher status.
void* cbArg ); // User argument to 'cbFunc'. void* cbArg ); // User argument to 'cbFunc'.
// Notes:
// The cmScMatcher maintains an internal cmScMatch object which is used to attempt to find the // The cmScMatcher maintains an internal cmScMatch object which is used to attempt to find the
// best match between the current MIDI active note buffer and the current score search area. // best match between the current MIDI active note buffer and the current score search area.
// 'scWndN' is used to set the cmScMatch 'locN' argument. // 'scWndN' is used to set the cmScMatch 'locN' argument.
@ -396,7 +397,7 @@ cmRC_t cmScMatcherStep( cmScMatcher* p );
// This function calls cmScMatcherScan() and cmScMatcherStep() internally. // This function calls cmScMatcherScan() and cmScMatcherStep() internally.
// If 'status' is not kNonMidiMdId then the function returns without changing the // If 'status' is not kNonMidiMdId then the function returns without changing the
// state of the object. // state of the object. In other words the matcher only recognizes MIDI note-on messages.
// If the MIDI note passed by the call results in a successful match then // If the MIDI note passed by the call results in a successful match then
// p->eli will be updated to the location in p->mp->loc[] of the latest // p->eli will be updated to the location in p->mp->loc[] of the latest
// match, the MIDI note in p->midiBuf[] associated with this match // match, the MIDI note in p->midiBuf[] associated with this match