cml/libcw
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

cwMidiDecls.h,cwMidiFile.h,cwThread.h : Fixed or improved comments. No functional changes.

Browse Source
This commit is contained in:
kevin 2024-02-10 11:35:34 -05:00
parent 57f3d06f37
commit 4aa91755ed
3 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
cwMidiDecls.h
View File

@ -16,7 +16,7 @@ namespace cw
typedef struct packet_str typedef struct packet_str
{ {
void* cbDataPtr; // Application supplied reference value from mdParserCreate() void* cbDataPtr; // Application supplied reference value
unsigned devIdx; // The device the msg originated from unsigned devIdx; // The device the msg originated from
unsigned portIdx; // The port index on the source device unsigned portIdx; // The port index on the source device
msg_t* msgArray; // Pointer to an array of 'msgCnt' mdMsg records or NULL if sysExMsg is non-NULL msg_t* msgArray; // Pointer to an array of 'msgCnt' mdMsg records or NULL if sysExMsg is non-NULL

4
cwMidiFile.h
View File

@ -152,7 +152,7 @@ namespace cw
const trackMsg_t* trackMsg( handle_t h, unsigned trackIdx ); const trackMsg_t* trackMsg( handle_t h, unsigned trackIdx );
// Returns the total count of records in the midi file and the // Returns the total count of records in the midi file and the
// number in the array returned by cmMidiFileMsgArray(). // number in the array returned by msgArray().
// Return kInvalidCnt if 'h' is invalid. // Return kInvalidCnt if 'h' is invalid.
unsigned msgCount( handle_t h ); unsigned msgCount( handle_t h );
@ -221,7 +221,7 @@ namespace cw
rc_t genCsvFile( const char* midiFn, const char* csvFn, bool printWarningsFl=true ); rc_t genCsvFile( const char* midiFn, const char* csvFn, bool printWarningsFl=true );
// Generate a text file reportusing cmMIdiFilePrintMsgs() // Generate a text file report using printMsgs()
rc_t report( const char* midiFn, log::handle_t logH ); rc_t report( const char* midiFn, log::handle_t logH );
rc_t report_begin_end( const char* midiFn, unsigned msg_cnt=10, bool pitch_only_fl=true, log::handle_t logH=log::handle_t() ); rc_t report_begin_end( const char* midiFn, unsigned msg_cnt=10, bool pitch_only_fl=true, log::handle_t logH=log::handle_t() );

2
cwThread.h
View File

@ -15,10 +15,12 @@ namespace cw
typedef handle<struct thread_str> handle_t; typedef handle<struct thread_str> handle_t;
// Return false to indicate that the thread should terminate.
typedef bool (*cbFunc_t)( void* arg ); typedef bool (*cbFunc_t)( void* arg );
typedef unsigned long long thread_id_t; typedef unsigned long long thread_id_t;
// The thread is in the 'paused' state after it is created.
// stateMicros = total time out duration for switching to the exit state or for switching in/out of pause state. // stateMicros = total time out duration for switching to the exit state or for switching in/out of pause state.
// pauseMicros = duration of thread sleep interval when in paused state. // pauseMicros = duration of thread sleep interval when in paused state.
rc_t create( handle_t& hRef, cbFunc_t func, void* funcArg, int stateTimeOutMicros=100000, int pauseMicros=10000 ); rc_t create( handle_t& hRef, cbFunc_t func, void* funcArg, int stateTimeOutMicros=100000, int pauseMicros=10000 );