From b07ddb4e54b3cbcad2ec3036dd0c3839c03a84f5 Mon Sep 17 00:00:00 2001 From: Giso Grimm Date: Thu, 23 May 2024 18:05:31 +0200 Subject: [PATCH] add documentation --- manual/apmodlevel2hsv.tex | 36 +---------------------- manual/apmodlevel2osc.tex | 7 ++--- manual/modmididispatch.tex | 2 ++ manual/oscdoc_tascar_ap_bandpass.tex | 1 + manual/oscdoc_tascar_ap_level2hsv.tex | 1 + manual/oscdoc_tascar_ap_level2osc.tex | 16 ++++++++++ manual/oscdoc_tascarmod_granularsynth.tex | 1 + manual/oscdoc_tascarmod_mididispatch.tex | 32 ++++++++++++++++++++ 8 files changed, 57 insertions(+), 39 deletions(-) create mode 100644 manual/oscdoc_tascar_ap_level2osc.tex create mode 100644 manual/oscdoc_tascarmod_mididispatch.tex diff --git a/manual/apmodlevel2hsv.tex b/manual/apmodlevel2hsv.tex index c0c0b003..12a7dd70 100644 --- a/manual/apmodlevel2hsv.tex +++ b/manual/apmodlevel2hsv.tex @@ -1,40 +1,6 @@ Convert sound pressure level to value component of a lamp. -\definecolor{shadecolor}{RGB}{255,230,204}\begin{snugshade} -{\footnotesize -\label{attrtab:level2hsv} -Attributes of element {\bf level2hsv}\nopagebreak - -\begin{tabularx}{\textwidth}{lXl} -\hline -name & description (type, unit) & def.\\ -\hline -\hline -\indattr{active} & start activated (bool) & true\\ -\hline -\indattr{frange} & Frequency range in bandpass mode (float array, Hz) & 62.5 4000\\ -\hline -\indattr{hue} & Hue component (0-360) (float, degree) & 0\\ -\hline -\indattr{lrange} & Level range (float array, dB) & 40 90\\ -\hline -\indattr{mode} & Level mode [dbspl|rms|max] (string) & dbspl\\ -\hline -\indattr{path} & Target path (string) & /hsv\\ -\hline -\indattr{saturation} & Saturation component (0-1) (float) & 1\\ -\hline -\indattr{skip} & Skip frames (uint32) & 0\\ -\hline -\indattr{tau} & Leq duration, or 0 to use block size (float, s) & 0\\ -\hline -\indattr{url} & Target URL (string) & {\tiny osc.udp://localhost:9999/}\\ -\hline -\indattr{weight} & Level meter weight (f-weight) & Z\\ -\hline -\end{tabularx} -} -\end{snugshade} +\input{tablevel2hsv.tex} OSC control: diff --git a/manual/apmodlevel2osc.tex b/manual/apmodlevel2osc.tex index 5a95ef10..d6e86dc7 100644 --- a/manual/apmodlevel2osc.tex +++ b/manual/apmodlevel2osc.tex @@ -2,7 +2,6 @@ \input{tablevel2osc.tex} -If $N$ is the number of channels, the OSC message will contain $N+1$ -floating point values. The first float contains the object time in -seconds, the other floats contain the RMS level within the current -audio block in dB SPL. +The number of channels, denoted by $N$, and the number of frequency weights, represented by $W$, determine the number of floating-point values contained in the OSC message. The first of these values represents the object time in seconds, while the remaining values indicate the RMS level within the current audio block in dB SPL. + +\input{oscdoc_tascar_ap_level2osc.tex} diff --git a/manual/modmididispatch.tex b/manual/modmididispatch.tex index 17fd707c..28456617 100644 --- a/manual/modmididispatch.tex +++ b/manual/modmididispatch.tex @@ -80,3 +80,5 @@ \end{tabularx} } \end{snugshade} + +\input{oscdoc_tascarmod_mididispatch.tex} diff --git a/manual/oscdoc_tascar_ap_bandpass.tex b/manual/oscdoc_tascar_ap_bandpass.tex index 1bc25a3b..31591337 100644 --- a/manual/oscdoc_tascar_ap_bandpass.tex +++ b/manual/oscdoc_tascar_ap_bandpass.tex @@ -8,6 +8,7 @@ \hline path & fmt. & range & r. & description\\ \hline +\attr{/.../bypass} & i & bool & yes & \\ \attr{/.../fmax} & f & ]0,20000] & yes & Upper cutoff frequency in Hz\\ \attr{/.../fmax} & ff & & no & Fade the upper cutoff frequency, first parameter is new frequency in Hz, second parameter is fade duration in s\\ \attr{/.../fmin} & f & ]0,20000] & yes & Lower cutoff frequency in Hz\\ diff --git a/manual/oscdoc_tascar_ap_level2hsv.tex b/manual/oscdoc_tascar_ap_level2hsv.tex index f004d1e5..e8366c44 100644 --- a/manual/oscdoc_tascar_ap_level2hsv.tex +++ b/manual/oscdoc_tascar_ap_level2hsv.tex @@ -9,6 +9,7 @@ path & fmt. & range & r. & description\\ \hline \attr{/.../active} & i & bool & yes & \\ +\attr{/.../decay} & f & [0,1[ & yes & decay coeficient\\ \attr{/.../hue} & f & & yes & Hue component (0-360 degree)\\ \attr{/.../lrange} & ff & & no & Level range in dB\\ \attr{/.../saturation} & f & & yes & Saturation component (0-1)\\ diff --git a/manual/oscdoc_tascar_ap_level2osc.tex b/manual/oscdoc_tascar_ap_level2osc.tex new file mode 100644 index 00000000..a0ccad4a --- /dev/null +++ b/manual/oscdoc_tascar_ap_level2osc.tex @@ -0,0 +1,16 @@ +\definecolor{shadecolor}{RGB}{236,236,255}\begin{snugshade} +{\footnotesize +\label{osctab:tascaraplevel2osc} +OSC variables: +\nopagebreak + +\begin{tabularx}{\textwidth}{llllX} +\hline +path & fmt. & range & r. & description\\ +\hline +\attr{/.../firstpar} & f & & yes & \\ +\hline +\end{tabularx} +} +\end{snugshade} +\definecolor{shadecolor}{RGB}{255,230,204} diff --git a/manual/oscdoc_tascarmod_granularsynth.tex b/manual/oscdoc_tascarmod_granularsynth.tex index fb591451..0711761d 100644 --- a/manual/oscdoc_tascarmod_granularsynth.tex +++ b/manual/oscdoc_tascarmod_granularsynth.tex @@ -11,6 +11,7 @@ \attr{/.../active} & i & bool & yes & \\ \attr{/.../bypass} & i & bool & yes & \\ \attr{/.../gain} & f & [-40,10] & yes & \\ +\attr{/.../oscactive} & i & bool & yes & \\ \attr{/.../ponset} & f & & yes & \\ \attr{/.../psustain} & f & & yes & \\ \attr{/.../reset} & & & no & \\ diff --git a/manual/oscdoc_tascarmod_mididispatch.tex b/manual/oscdoc_tascarmod_mididispatch.tex new file mode 100644 index 00000000..7d3111a2 --- /dev/null +++ b/manual/oscdoc_tascarmod_mididispatch.tex @@ -0,0 +1,32 @@ +\definecolor{shadecolor}{RGB}{236,236,255}\begin{snugshade} +{\footnotesize +\label{osctab:tascarmodmididispatch} +OSC variables: +\nopagebreak + +\begin{tabularx}{\textwidth}{llllX} +\hline +path & fmt. & range & r. & description\\ +\hline +\attr{/.../add/cc/float} & iisff & & no & \\ +\attr{/.../add/cc/float} & iisffs & & no & \\ +\attr{/.../add/cc/trigger} & iisii & & no & \\ +\attr{/.../add/cc/trigger} & iisiis & & no & \\ +\attr{/.../add/note/float} & iisff & & no & \\ +\attr{/.../add/note/float} & iisffs & & no & \\ +\attr{/.../add/note/trigger} & iisii & & no & \\ +\attr{/.../add/note/trigger} & iisiis & & no & \\ +\attr{/.../clear/launchpadaction} & & & no & \\ +\attr{/.../del/cc/all} & & & no & \\ +\attr{/.../del/cc} & ii & & no & \\ +\attr{/.../del/launchpadaction} & i & & no & \\ +\attr{/.../del/note/all} & & & no & \\ +\attr{/.../del/note} & ii & & no & \\ +\attr{/.../select/launchpadaction} & s & & no & \\ +\attr{/.../send/cc} & iii & & no & \\ +\attr{/.../send/note} & iii & & no & \\ +\hline +\end{tabularx} +} +\end{snugshade} +\definecolor{shadecolor}{RGB}{255,230,204}