Skip to content

Commit

Permalink
add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
gisogrimm committed May 23, 2024
1 parent cf83346 commit b07ddb4
Show file tree
Hide file tree
Showing 8 changed files with 57 additions and 39 deletions.
36 changes: 1 addition & 35 deletions manual/apmodlevel2hsv.tex
Original file line number Diff line number Diff line change
@@ -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:

Expand Down
7 changes: 3 additions & 4 deletions manual/apmodlevel2osc.tex
Original file line number Diff line number Diff line change
Expand Up @@ -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}
2 changes: 2 additions & 0 deletions manual/modmididispatch.tex
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,5 @@
\end{tabularx}
}
\end{snugshade}

\input{oscdoc_tascarmod_mididispatch.tex}
1 change: 1 addition & 0 deletions manual/oscdoc_tascar_ap_bandpass.tex
Original file line number Diff line number Diff line change
Expand Up @@ -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\\
Expand Down
1 change: 1 addition & 0 deletions manual/oscdoc_tascar_ap_level2hsv.tex
Original file line number Diff line number Diff line change
Expand Up @@ -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)\\
Expand Down
16 changes: 16 additions & 0 deletions manual/oscdoc_tascar_ap_level2osc.tex
Original file line number Diff line number Diff line change
@@ -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}
1 change: 1 addition & 0 deletions manual/oscdoc_tascarmod_granularsynth.tex
Original file line number Diff line number Diff line change
Expand Up @@ -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 & \\
Expand Down
32 changes: 32 additions & 0 deletions manual/oscdoc_tascarmod_mididispatch.tex
Original file line number Diff line number Diff line change
@@ -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}

0 comments on commit b07ddb4

Please sign in to comment.