Skip to content

Commit

Permalink
Adding Riccardo Russo's fds library
Browse files Browse the repository at this point in the history
  • Loading branch information
rmichon committed Jan 13, 2021
1 parent 3afbfb8 commit f9e0548
Show file tree
Hide file tree
Showing 53 changed files with 3,787 additions and 1,049 deletions.
1 change: 1 addition & 0 deletions all.lib
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import("delays.lib");
import("demos.lib");
import("dx7.lib");
import("envelopes.lib");
import("fds.lib");
import("filters.lib");
import("hoa.lib");
import("interpolators.lib");
Expand Down
3 changes: 2 additions & 1 deletion doc/docs/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ Sampo Savolainen, Nicolas Scaringella,
Anne Sedes, Priyanka Shekar,
Stephen Sinclair, Travis Skare,
Julius Smith, Mike Solomon,
Michael Wilson, Bart Brouns, Dirk Roosenburg.
Michael Wilson, Bart Brouns, Dirk Roosenburg,
Riccardo Russo.
</ul>

as well as our colleagues at [GRAME](http://grame.fr):
Expand Down
1 change: 1 addition & 0 deletions doc/docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ de = library("delays.lib");
dm = library("demos.lib");
dx = library("dx7.lib");
en = library("envelopes.lib");
fd = library("fds.lib");
fi = library("filters.lib");
ho = library("hoa.lib");
it = library("interpolators.lib");
Expand Down
1 change: 1 addition & 0 deletions doc/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ This will give you access to all the Faust libraries through a series of environ
* `dm`: `demos.lib`
* `dx`: `dx7.lib`
* `en`: `envelopes.lib`
* `fd`: `fds.lib`
* `fi`: `filters.lib`
* `ho`: `hoa.lib`
* `it`: `interpolators.lib`
Expand Down
1 change: 1 addition & 0 deletions doc/docs/organization.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Only the libraries that are considered to be "standard" are documented:
* `demos.lib`
* `dx7.lib`
* `envelopes.lib`
* `fds.lib`
* `filters.lib`
* `hoa.lib`
* `interpolators.lib`
Expand Down
1 change: 1 addition & 0 deletions doc/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ nav:
- ' demos ': libs/demos.md
- ' dx7 ': libs/dx7.md
- ' envelopes ': libs/envelopes.md
- ' fds ': libs/fds.md
- ' filters ': libs/filters.md
- ' hoa ': libs/hoa.md
- ' interpolators ': libs/interpolators.md
Expand Down
6 changes: 5 additions & 1 deletion docs/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,10 @@
<a href="/libs/envelopes/" class="dropdown-item"> envelopes </a>
</li>

<li>
<a href="/libs/fds/" class="dropdown-item"> fds </a>
</li>

<li>
<a href="/libs/filters/" class="dropdown-item"> filters </a>
</li>
Expand Down Expand Up @@ -233,7 +237,7 @@ <h4 class="modal-title" id="searchModalLabel">Search</h4>
</p>
<form>
<div class="form-group">
<input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
<input type="search" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
</div>
</form>
<div id="mkdocs-search-results"></div>
Expand Down
11 changes: 8 additions & 3 deletions docs/about/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,10 @@
<a href="../libs/envelopes/" class="dropdown-item"> envelopes </a>
</li>

<li>
<a href="../libs/fds/" class="dropdown-item"> fds </a>
</li>

<li>
<a href="../libs/filters/" class="dropdown-item"> filters </a>
</li>
Expand Down Expand Up @@ -215,7 +219,7 @@
<div class="col-md-9 main-container" role="main">

<h1 id="the-faust-project">The Faust Project</h1>
<p>The Faust Project has started in 2004. It is actively developped by the <a href="https://www.grame.fr/recherche">Grame Research Lab</a>.</p>
<p>The Faust Project has started in 2002. It is actively developed by the <a href="https://www.grame.fr/recherche">Grame Research Lab</a>.</p>
<p>Many persons are contributing to the Faust project, by providing code for the
compiler, architecture files, libraries, examples, documentation, scripts, bug
reports, ideas, etc. We would like in particular to thank:</p>
Expand All @@ -238,7 +242,8 @@ <h1 id="the-faust-project">The Faust Project</h1>
Anne&nbsp;Sedes, Priyanka&nbsp;Shekar,
Stephen&nbsp;Sinclair, Travis&nbsp;Skare,
Julius&nbsp;Smith, Mike&nbsp;Solomon,
Michael&nbsp;Wilson, Bart Brouns, Dirk Roosenburg.
Michael&nbsp;Wilson, Bart Brouns, Dirk Roosenburg,
Riccardo Russo.
</ul>

<p>as well as our colleagues at <a href="http://grame.fr">GRAME</a>:</p>
Expand Down Expand Up @@ -285,7 +290,7 @@ <h4 class="modal-title" id="searchModalLabel">Search</h4>
</p>
<form>
<div class="form-group">
<input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
<input type="search" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
</div>
</form>
<div id="mkdocs-search-results"></div>
Expand Down
12 changes: 7 additions & 5 deletions docs/contributing/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,10 @@
<a href="../libs/envelopes/" class="dropdown-item"> envelopes </a>
</li>

<li>
<a href="../libs/fds/" class="dropdown-item"> fds </a>
</li>

<li>
<a href="../libs/filters/" class="dropdown-item"> filters </a>
</li>
Expand Down Expand Up @@ -243,6 +247,7 @@
<div class="col-md-9 main-container" role="main">

<h1 id="contributing">Contributing</h1>
<p>In general, libraries are organised in a <em>stacked manner</em>: the base ones define functions or constants without any dependancies, and additional ones are gradually built on top of simpler ones, layer by layer. <strong>Dependency loops must be avoided as much as possible</strong>. The <em>resources</em> folder contains tools to build and visualise the libraries dependencies graphs.</p>
<p>If you wish to add a function to any of these libraries or if you plan to add a new library, make sure that you follow the following conventions:</p>
<h2 id="new-functions">New Functions</h2>
<ul>
Expand All @@ -262,7 +267,6 @@ <h2 id="new-functions">New Functions</h2>
// * argument1: argument 1 description
//-------------------------------------------------
</code></pre>

<ul>
<li>Every time a new function is added, the documentation should be updated simply by running <code>make doclib</code>. <!-- TODO --></li>
<li>The environment system (e.g. <code>os.osc</code>) should be used when calling a function declared in another library (see the section on <em>Using the Faust Libraries</em>).</li>
Expand Down Expand Up @@ -304,7 +308,6 @@ <h2 id="new-libraries">New Libraries</h2>
// Description
//==============================================
</code></pre>

<ul>
<li>If you have any question, send an e-mail to rmichon_at_ccrma_dot_stanford_dot_edu.</li>
</ul>
Expand All @@ -326,6 +329,7 @@ <h3 id="library-import">Library Import</h3>
dm = library(&quot;demos.lib&quot;);
dx = library(&quot;dx7.lib&quot;);
en = library(&quot;envelopes.lib&quot;);
fd = library(&quot;fds.lib&quot;);
fi = library(&quot;filters.lib&quot;);
ho = library(&quot;hoa.lib&quot;);
it = library(&quot;interpolators.lib&quot;);
Expand All @@ -348,13 +352,11 @@ <h3 id="library-import">Library Import</h3>
vl = library(&quot;version.lib&quot;);
wd = library(&quot;wavedigitalfilters.lib&quot;);
</code></pre>

<p>For example, if we wanted to use the <code>smooth</code> function which is now declared in <code>signals.lib</code>, we would do the following:</p>
<pre><code>import(&quot;stdfaust.lib&quot;);

process = si.smooth(0.999);
</code></pre>

<p>This standard is only used within the libraries: nothing prevents coders to still import <code>signals.lib</code> directly and call <code>smooth</code> without <code>ro.</code>, etc. It means symbols and function names defined within a library have to be unique to not collide with symbols of any other libraries. </p>
<h3 id="demo-functions">"Demo" Functions</h3>
<p>"Demo" functions are placed in <code>demos.lib</code> and have a built-in user interface (UI). Their name ends with the <code>_demo</code> suffix. Each of these function have a <code>.dsp</code> file associated to them in the <code>/examples</code> folder.</p>
Expand Down Expand Up @@ -390,7 +392,7 @@ <h4 class="modal-title" id="searchModalLabel">Search</h4>
</p>
<form>
<div class="form-group">
<input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
<input type="search" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
</div>
</form>
<div id="mkdocs-search-results"></div>
Expand Down
6 changes: 5 additions & 1 deletion docs/copyright/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,10 @@
<a href="../libs/envelopes/" class="dropdown-item"> envelopes </a>
</li>

<li>
<a href="../libs/fds/" class="dropdown-item"> fds </a>
</li>

<li>
<a href="../libs/filters/" class="dropdown-item"> filters </a>
</li>
Expand Down Expand Up @@ -266,7 +270,7 @@ <h4 class="modal-title" id="searchModalLabel">Search</h4>
</p>
<form>
<div class="form-group">
<input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
<input type="search" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
</div>
</form>
<div id="mkdocs-search-results"></div>
Expand Down
16 changes: 8 additions & 8 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,10 @@
<a href="libs/envelopes/" class="dropdown-item"> envelopes </a>
</li>

<li>
<a href="libs/fds/" class="dropdown-item"> fds </a>
</li>

<li>
<a href="libs/filters/" class="dropdown-item"> filters </a>
</li>
Expand Down Expand Up @@ -232,7 +236,6 @@ <h2 id="using-the-faust-libraries">Using the Faust Libraries</h2>
<p>The easiest and most standard way to use the Faust libraries is to import <code>stdfaust.lib</code> in your Faust code:</p>
<pre><code>import(&quot;stdfaust.lib&quot;);
</code></pre>

<p>This will give you access to all the Faust libraries through a series of environments:</p>
<ul>
<li><code>sf</code>: <code>all.lib</code></li>
Expand All @@ -243,6 +246,7 @@ <h2 id="using-the-faust-libraries">Using the Faust Libraries</h2>
<li><code>dm</code>: <code>demos.lib</code></li>
<li><code>dx</code>: <code>dx7.lib</code></li>
<li><code>en</code>: <code>envelopes.lib</code></li>
<li><code>fd</code>: <code>fds.lib</code></li>
<li><code>fi</code>: <code>filters.lib</code></li>
<li><code>ho</code>: <code>hoa.lib</code></li>
<li><code>it</code>: <code>interpolators.lib</code></li>
Expand All @@ -269,23 +273,19 @@ <h2 id="using-the-faust-libraries">Using the Faust Libraries</h2>
<pre><code>import(&quot;stdfaust.lib&quot;);
process = os.osc(440);
</code></pre>

<p>In this case, we're calling the <code>osc</code> function from <code>oscillators.lib</code>.</p>
<p>You can also access all the functions of all the libraries directly using the <code>sf</code> environment:</p>
<pre><code>import(&quot;stdfaust.lib&quot;);
process = sf.osc(440);
</code></pre>

<p>Alternatively, environments can be created by hand:</p>
<pre><code>os = library(&quot;oscillators.lib&quot;);
process = os.osc(440);
</code></pre>

<p>Finally, libraries can be simply imported in the Faust code (not recommended):</p>
<pre><code>import(&quot;oscillators.lib&quot;);
process = osc(440);
</code></pre>

<h2 id="organization-of-this-documentation">Organization of This Documentation</h2>
<p>The <code>Overview</code> tab in the upper menu provides additional information about the general organization of the libraries, licensing/copyright, and guidelines on how to contribute to the Faust libraries. </p>
<p>The <code>Libraries</code> tab contain the actual documentation of the Faust libraries.</p></div>
Expand Down Expand Up @@ -318,7 +318,7 @@ <h4 class="modal-title" id="searchModalLabel">Search</h4>
</p>
<form>
<div class="form-group">
<input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
<input type="search" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
</div>
</form>
<div id="mkdocs-search-results"></div>
Expand Down Expand Up @@ -372,6 +372,6 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
</html>

<!--
MkDocs version : 1.1
Build Date UTC : 2020-11-27 07:25:52
MkDocs version : 1.1.2
Build Date UTC : 2021-01-13 14:57:21.700588+00:00
-->
Loading

0 comments on commit f9e0548

Please sign in to comment.