Re: [Audacity-nyquist] Audacity Nyquist source code research for writing new documentation

[Gale A. <ga...@au...>]

| From edgar <edg...@we...> 
| Wed, 18 Nov 2009 15:53:29 +0100
| Subject: [Audacity-nyquist] Audacity Nyquist source code research for writing new documentation
> Because it's (once again) a month ago, here is a summary of what
> happened last:
> 
>  > Dave Storer asked:
> 
>  > I there a way to carry over any information from one call to the next
>  > except by saving the state information in an external file?
> 
>  > Leland wrote:
> 
>  > There's a global variable called *SCRATCH* that can be used for
>  > this purpose. It is not restored between between tracks. A couple
>  > of new comment statements were added when I did the upgrade.
> 
>  > ;codetype lisp | sal
> 
>  > Tells Audacity the syntax to expect and how to pass it on to libnyquist.
>  > The default is lisp.  Only one type is allowed.
> 
>  > ;debugflags trace | notrace | compiler | nocompiler
> 
>  > Trace and notrace simply set Nyquist's "*tracenable*" global. This is
>  > similar to clicking the Debug button in the Nyquist prompt, but it
>  > allows the plug-in to control it instead.
> 
>  > Compiler and nocompiler controls whether the generated Lisp code from
>  > the SAL compiler will be sent to stdout or to the output window in the
>  > Nyquist Workbench.
> 
> -----
> 
> Edgar - What I have so far...
> 
> Looking at the source code of Audacity 1.3.10-alpha, 2009 Nov 18:
> 
> According to "audacity/src/effects/Nyquist.cpp" the following control
> lines are currently recognized in Audacity Nyquist plugins:
> 
> ;version    - the Audacity Plugin version (1, 2, or 3)
> 
> // Version 1 only supported the slider widget
> // Version 2 added support for string widgets
> // Version 3 added support for choice widgets
> 
> ;name       - the user-defined name of the plugin
> ;action     - the text in the message box when the effect is applied
> ;info       - some info text displayed in the plugin window
> 
> ;control    - a slider widget
> ;string     - a string input widget
> ;choice     - a multiple-choice list-box widget
> 
> ;categories - I have no idea what this is for ???

Edgar,

They are LV2 categories which we introduced as part of GSoC 2008: 
http://wiki.audacityteam.org/index.php?title=LV2_Support#2008-06-04:_Category_support_working

We tried the categories out in the 1.3.6 Beta version of Audacity. It
was unpopular with the majority of users because of the extra
navigation involved to reach the effects. 

It will not be re-introduced until it is provided with a way by which the 
user can turn the grouping on and off in the interface. 

It is turned on by compiling Audacity and uncommenting 

//#define EFFECT_CATEGORIES

in Experimental.h. 
.


Gale