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

README.md : More README formatting.

Browse Source
This commit is contained in:
kevin 2024-12-03 13:12:16 -05:00
parent 7f6a56552c
commit 51307c8a90
1 changed files with 21 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
README.md
View File

@ -35,52 +35,50 @@ sets of parameters. The primary parameter file is `src/cwtest/cfg/main.cfg`.
---- ----
# MIDI - MIDI Device Manager # MIDI - MIDI devices and files.
-------------------------------------------------------------------------------------------------------------------------------------------
midiDeviceReport [cwMidiDeviceTest.cpp testReport()](https://gitea.currawongproject.org/cml/libcw/src/branch/master/cwMidiDeviceTest.cpp)
---------------- --------------------------------------------------------------------------------------------------------------------------
Notes: List The current set of MIDI hardware devices
-------------------------------------------------------------------------------------------------------------------------------------------
-------------------------------------------------------------------------------------------------------------------------------------------
midiDevice [cwMidiDeviceTest.cpp test()](https://gitea.currawongproject.org/cml/libcw/src/branch/master/cwMidiDeviceTest.cpp)
---------------- --------------------------------------------------------------------------------------------------------------------------
Notes: Interactive testing of the MIDI input file device
start/pause/unpause/stop functions. This function also validates the
latency of the device by comparing the time between MIDI events as
generated by the device to the actual time between the events in the
MIDI file.
-------------------------------------------------------------------------------------------------------------------------------------------
CLI Label | Source File | Function ----
Label | Source File | Function
------------------|----------------------|--------------
midiDeviceReport | cwMidiDeviceTest.cpp | testReport()
List The current set of MIDI hardware devices
----
Label | Source File | Function
------------------|----------------------|-------------- ------------------|----------------------|--------------
midiDevice | cwMidiDeviceTest.cpp | test() midiDevice | cwMidiDeviceTest.cpp | test()
Interactive testing of the MIDI input file device
start/pause/unpause/stop functions. This function also validates the
latency of the device by comparing the time between MIDI events as
generated by the device to the actual time between the events in the
MIDI file.
CLI Label | Source File | Function ----
Label | Source File | Function
------------------|----------------------|-------------- ------------------|----------------------|--------------
midifile | cwMidiFile.cpp | test() midifile | cwMidiFile.cpp | test()
MIDI file utility parameters: MIDI file utility parameters:
Convert a MIDI file to a CSV file. - Convert a MIDI file to a CSV file.
``` ```
csv: { midiFn:<filename> csvFn:<filename> } csv: { midiFn:<filename> csvFn:<filename> }
``` ```
Print the first <msgCnt> MIDI messages from a file. - Print the first <msgCnt> MIDI messages from a file.
``` ```
rpt_beg_end: { midi_fname:<filenae>, msgCnt:<int>, note_on_only_fl:<true|false> } rpt_beg_end: { midi_fname:<filenae>, msgCnt:<int>, note_on_only_fl:<true|false> }
``` ```
Print the entire contents of the MIDI file. - Print the entire contents of the MIDI file.
``` ```
rpt : { midiFn:<filename> } rpt : { midiFn:<filename> }
``` ```
Convert all the MIDI files in the folder: `<path>/<folder>/take/'record_%i'` to CSV files - Convert all the MIDI files in the folder: `<path>/<folder>/take/'record_%i'` to CSV files
``` ```
batch_convert: { io_dir:<path>, session_dir:<folder>, take_begin:<int>, take_end:<int> print_warnings_flag:<true|false> } batch_convert: { io_dir:<path>, session_dir:<folder>, take_begin:<int>, take_end:<int> print_warnings_flag:<true|false> }
``` ```