diff --git a/doc/SKINI.txt b/doc/SKINI.txt index d42c731..89e7497 100644 --- a/doc/SKINI.txt +++ b/doc/SKINI.txt @@ -85,7 +85,7 @@ upon/from which to build and depart. the channel number is scanned as a long int. Channels could be socket numbers, machine IDs, serial numbers, or even unique tags for each event in a synthesis. Other fields might be used, as specified in the - SKINI.tbl file. This is described in more detail later. + SKINItbl.h file. This is described in more detail later. Fields in a SKINI line are delimited by spaces, commas, or tabs. The SKINI parser only operates on a line at a time, @@ -109,9 +109,9 @@ upon/from which to build and depart. All fields other than type, time, and channel are optional, and the types and useage of the additional fields is defined in the file - SKINI.tbl. + SKINItbl.h. - The other important file used by SKINI is SKINI.msg, which is a + The other important file used by SKINI is SKINImsg.h, which is a set of #defines to make C code more readable, and to allow reasonably quick re-mapping of control numbers, etc.. All of these defined symbols are assigned integer values. For JAVA, the #defines could @@ -127,13 +127,13 @@ upon/from which to build and depart. receiving SKINI messages a line at a time, usually in real time, but not restricted to real time. - SKINI.msg should be included by anything wanting to use the + SKINImsg.h should be included by anything wanting to use the Skini.cpp object. This is not mandatory, but use of the __SK_blah_ symbols which are defined in the .msg file will help to ensure clarity and consistency when messages are added and changed. - SKINI.tbl is used only by the SKINI parser object (Skini.cpp). - In the file SKINI.tbl, an array of structures is declared and + SKINItbl.h is used only by the SKINI parser object (Skini.cpp). + In the file SKINItbl.h, an array of structures is declared and assigned values which instruct the parser as to what the message types are, and what the fields mean for those message types. This table is compiled and linked into applications using SKINI, but @@ -195,7 +195,7 @@ upon/from which to build and depart. A -1 channel can be used as don't care, omni, or other functions depending on your needs and taste. - g) All remaining fields are specified in the SKINI.tbl file. + g) All remaining fields are specified in the SKINItbl.h file. In general, there are maximum two more fields, which are either SK_INT (long), SK_DBL (double float), or SK_STR (string). The latter is the mechanism by which more arguments can be specified @@ -237,9 +237,9 @@ upon/from which to build and depart. NoteOff 0.000000 2 71 82 NoteOff 0.000000 2 79 82 -7) The SKINI.tbl File, How Messages are Parsed: +7) The SKINItbl.h File, How Messages are Parsed: - The SKINI.tbl file contains an array of structures which + The SKINItbl.h file contains an array of structures which are accessed by the parser object Skini.cpp. The struct is: struct SKINISpec { char messageString[32]; @@ -276,7 +276,7 @@ upon/from which to build and depart. something else stored in the SK_STR field, or as a new type of multi-line message. - Here's a couple of lines from the SKINI.tbl file + Here's a couple of lines from the SKINItbl.h file {"NoteOff" , __SK_NoteOff_, SK_DBL, SK_DBL}, {"NoteOn" , __SK_NoteOn_, SK_DBL, SK_DBL}, @@ -290,7 +290,7 @@ upon/from which to build and depart. The first three are basic MIDI messages. The first two would cause the parser, after recognizing a match of the string "NoteOff" or "NoteOn", to set the message type to 128 or 144 (__SK_NoteOff_ and __SK_NoteOn_ - are #defined in the file SKINI.msg to be the MIDI byte value, without + are #defined in the file SKINImsg.h to be the MIDI byte value, without channel, of the actual MIDI messages for NoteOn and NoteOff). The parser would then set the time or delta time (this is always done and is therefore not described in the SKINI Message Struct). The next two diff --git a/doc/hierarchy.txt b/doc/hierarchy.txt index 6935041..1328704 100644 --- a/doc/hierarchy.txt +++ b/doc/hierarchy.txt @@ -173,7 +173,7 @@ effects.cpp Effects demonstration program ragamatic.cpp Nirvana just waiting to happen Skini.cpp SKINI file/message parser object -SKINI.msg #defines for often used and universal MIDI/SKINI symbols -SKINI.tbl Table of SKINI messages +SKINImsg.h #defines for often used and universal MIDI/SKINI symbols +SKINItbl.h Table of SKINI messages diff --git a/include/Skini.h b/include/Skini.h index 9f83b1f..d5619bd 100644 --- a/include/Skini.h +++ b/include/Skini.h @@ -41,7 +41,7 @@ class Skini : public Stk //! A message structure to store and pass parsed SKINI messages. struct Message { - long type; /*!< The message type, as defined in SKINI.msg. */ + long type; /*!< The message type, as defined in SKINImsg.h. */ long channel; /*!< The message channel (not limited to 16!). */ StkFloat time; /*!< The message time stamp in seconds (delta or absolute). */ std::vector floatValues; /*!< The message values read as floats (values are type-specific). */ diff --git a/projects/demo/Md2Skini.cpp b/projects/demo/Md2Skini.cpp index be0e569..dc32e4b 100644 --- a/projects/demo/Md2Skini.cpp +++ b/projects/demo/Md2Skini.cpp @@ -11,7 +11,7 @@ /***************************************************/ #include "RtMidi.h" -#include "SKINI.msg" +#include "SKINImsg.h" #include #include #include diff --git a/projects/demo/demo.cpp b/projects/demo/demo.cpp index e2f6e2a..c877b4a 100644 --- a/projects/demo/demo.cpp +++ b/projects/demo/demo.cpp @@ -3,7 +3,7 @@ // An example STK program that allows voice playback and control of // most of the STK instruments. -#include "SKINI.msg" +#include "SKINImsg.h" #include "WvOut.h" #include "Instrmnt.h" #include "JCRev.h" diff --git a/projects/effects/effects.cpp b/projects/effects/effects.cpp index f57e60c..6bbd9b9 100644 --- a/projects/effects/effects.cpp +++ b/projects/effects/effects.cpp @@ -1,7 +1,7 @@ /************** Effects Program *********************/ #include "Skini.h" -#include "SKINI.msg" +#include "SKINImsg.h" #include "Envelope.h" #include "PRCRev.h" #include "JCRev.h" diff --git a/projects/eguitar/eguitar.cpp b/projects/eguitar/eguitar.cpp index 4ae6e30..269f2d3 100644 --- a/projects/eguitar/eguitar.cpp +++ b/projects/eguitar/eguitar.cpp @@ -29,7 +29,7 @@ // Gary P. Scavone, McGill University 2012. #include "Guitar.h" -#include "SKINI.msg" +#include "SKINImsg.h" #include "WvOut.h" #include "JCRev.h" #include "Skini.h" diff --git a/projects/examples/controlbee.cpp b/projects/examples/controlbee.cpp index ff5b8f7..42e4d41 100644 --- a/projects/examples/controlbee.cpp +++ b/projects/examples/controlbee.cpp @@ -3,7 +3,7 @@ #include "BeeThree.h" #include "RtAudio.h" #include "Messager.h" -#include "SKINI.msg" +#include "SKINImsg.h" #include #include using std::min; diff --git a/projects/examples/threebees.cpp b/projects/examples/threebees.cpp index bd450f2..004cae2 100644 --- a/projects/examples/threebees.cpp +++ b/projects/examples/threebees.cpp @@ -4,7 +4,7 @@ #include "RtAudio.h" #include "Messager.h" #include "Voicer.h" -#include "SKINI.msg" +#include "SKINImsg.h" #include using std::min; diff --git a/projects/ragamatic/ragamat.cpp b/projects/ragamatic/ragamat.cpp index 463092f..b706e2e 100644 --- a/projects/ragamatic/ragamat.cpp +++ b/projects/ragamatic/ragamat.cpp @@ -1,6 +1,6 @@ /************** Test Main Program Individual Voice *********************/ -#include "SKINI.msg" +#include "SKINImsg.h" #include "Instrmnt.h" #include "JCRev.h" #include "Drone.h"