Documentation.

grame-cncm · Mar 26, 2024 · dc47143 · dc47143
1 parent 18f9a28
commit dc47143
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 5 deletions.
diff --git a/architecture/faust/audio/jack-dsp.h b/architecture/faust/audio/jack-dsp.h
@@ -480,7 +480,7 @@ class jackaudio_midi : public jackaudio, public jack_midi {
                 fOutChannel[i] = (float*)jack_port_get_buffer(fOutputPorts[i], nframes);
             }
 
-            // By convention timestamp of -1 means 'no timestamp conversion' : events already have a timestamp espressed in frames
+            // By convention timestamp of -1 means 'no timestamp conversion', events already have a timestamp expressed in frames
             fDSP->compute(-1, nframes, reinterpret_cast<FAUSTFLOAT**>(fInChannel), reinterpret_cast<FAUSTFLOAT**>(fOutChannel));
         }
 

diff --git a/architecture/faust/dsp/dsp.h b/architecture/faust/dsp/dsp.h
@@ -166,9 +166,11 @@ class FAUST_API dsp {
         virtual void compute(int count, FAUSTFLOAT** inputs, FAUSTFLOAT** outputs) = 0;
 
         /**
-         * DSP instance computation: alternative method to be used by subclasses.
+         * Alternative DSP instance computation method for use by subclasses, incorporating an additional `date_usec` parameter,
+         * which specifies the timestamp of the first sample in the audio buffers.
          *
-         * @param date_usec - the timestamp in microsec given by audio driver.
+         * @param date_usec - the timestamp in microsec given by audio driver. By convention timestamp of -1 means 'no timestamp conversion',
+         * events already have a timestamp expressed in frames.
          * @param count - the number of frames to compute
          * @param inputs - the input audio buffers as an array of non-interleaved FAUSTFLOAT samples (either float, double or quad)
          * @param outputs - the output audio buffers as an array of non-interleaved FAUSTFLOAT samples (either float, double or quad)

diff --git a/architecture/faust/gui/ControlSequenceUI.h b/architecture/faust/gui/ControlSequenceUI.h
@@ -44,7 +44,7 @@ struct TSMessage {
 };
 
 /*
- Allows to process a sequence of time-stamped messages.
+ Allows to process a sequence of timestamped messages.
  */
 class ControlSequenceUI : public MapUI {
 

diff --git a/architecture/faust/midi/midi.h b/architecture/faust/midi/midi.h
@@ -84,7 +84,7 @@ class midi {
         midi() {}
         virtual ~midi() {}
 
-        // Additional time-stamped API for MIDI input
+        // Additional timestamped API for MIDI input
         virtual MapUI* keyOn(double, int channel, int pitch, int velocity)
         {
             return keyOn(channel, pitch, velocity);