Skip to content

Commit

Permalink
doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
@sensorium
sensorium committed Jul 2, 2013
1 parent f5fd885 commit 83c0c98
Show file tree
Hide file tree
Showing 879 changed files with 64,771 additions and 7,650 deletions.
1 change: 1 addition & 0 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ tags
user_guide.md
notes.txt
FAQ.md
*.dox
*~
*.o
*.lo
Expand Down
36 changes: 18 additions & 18 deletions ADSR.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -180,52 +180,52 @@ inline


/** Set the attack level of the ADSR.
@param value the attack level.
@param attack the attack level.
*/
inline
void setAttackLevel(byte value)
void setAttackLevel(byte attack)
{
attack.level=value;
attack.level=attack;
}



/** Set the decay level of the ADSR.
@param value the decay level.
@param decay the decay level.
*/
inline
void setDecayLevel(byte value)
void setDecayLevel(byte decay)
{
decay.level=value;
decay.level=decay;
}


/** Set the sustain level of the ADSR.
@param value the sustain level. Usually the same as the decay level,
@param sustain the sustain level. Usually the same as the decay level,
for a steady sustained note.
*/
inline
void setSustainLevel(byte value)
void setSustainLevel(byte sustain)
{
sustain.level=value;
sustain.level=sustain;
}

/** Set the release level of the ADSR. Normally you'd make this 0,
but you have the option of some other value.
@param value the release level (normally 0).
@param release the release level (normally 0).
*/
inline
void setReleaseLevel(byte value)
void setReleaseLevel(byte release)
{
release.level=value;
release.level=release;
}



/** Set the attack and decay levels of the ADSR. This assumes a conventional
ADSR where the sustain continues at the same level as the decay, till the release ramps to 0.
@param attack the new attack level.
@param value the new sustain level.
@param decay the new sustain level.
*/
inline
void setADLevels(byte attack, byte decay)
Expand All @@ -244,7 +244,7 @@ inline

/** Set the attack time of the ADSR in milliseconds.
The actual time taken will be resolved within the resolution of CONTROL_RATE.
@param value the unsigned int attack time in milliseconds.
@param msec the unsigned int attack time in milliseconds.
*/
inline
void setAttackTime(unsigned int msec)
Expand All @@ -255,7 +255,7 @@ inline

/** Set the decay time of the ADSR in milliseconds.
The actual time taken will be resolved within the resolution of CONTROL_RATE.
@param value the unsigned int decay time in milliseconds.
@param msec the unsigned int decay time in milliseconds.
*/
inline
void setDecayTime(unsigned int msec)
Expand All @@ -267,7 +267,7 @@ inline
/** Set the sustain time of the ADSR in milliseconds.
The actual time taken will be resolved within the resolution of CONTROL_RATE.
The sustain phase will finish if the ADSR recieves a noteOff().
@param value the unsigned int sustain time in milliseconds.
@param msec the unsigned int sustain time in milliseconds.
*/
inline
void setSustainTime(unsigned int msec)
Expand All @@ -279,7 +279,7 @@ inline

/** Set the release time of the ADSR in milliseconds.
The actual time taken will be resolved within the resolution of CONTROL_RATE.
@param value the unsigned int release time in milliseconds.
@param msec the unsigned int release time in milliseconds.
*/
inline
void setReleaseTime(unsigned int msec)
Expand All @@ -293,7 +293,7 @@ inline
The actual times will be resolved within the resolution of CONTROL_RATE.
@param attack_ms the new attack time in milliseconds.
@param decay_ms the new decay time in milliseconds.
@param decay_ms the new sustain time in milliseconds.
@param sustain_ms the new sustain time in milliseconds.
@param release_ms the new release time in milliseconds.
*/
inline
Expand Down
2 changes: 1 addition & 1 deletion AudioDelay.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@


/**
@brief Audio delay line for comb filter, flange, chorus and short echo effects.
Audio delay line for comb filter, flange, chorus and short echo effects.
@tparam NUM_BUFFER_SAMPLES is the length of the delay buffer in samples. This should
be a power of two. The largest delay you'll fit in an atmega328 will be 512
cells, which at 16384 Hz sample rate is 31 milliseconds. More of a flanger or a
Expand Down
2 changes: 1 addition & 1 deletion AudioDelayFeedback.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ enum interpolation_types {LINEAR,ALLPASS};


/**
@brief Audio delay line with feedback for comb filter, flange, chorus and short echo effects.
Audio delay line with feedback for comb filter, flange, chorus and short echo effects.
@tparam NUM_BUFFER_SAMPLES is the length of the delay buffer in samples, and should be a
power of two. The maximum delay length which will fit in an atmega328 is half
that of a plain AudioDelay object, in this case 256 cells, or about 15
Expand Down
2 changes: 1 addition & 1 deletion AutoRange.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@


/**
Keeps a running calculation of the range of the input values it receives.
Keeps a running calculation of the range of the input values it receives.
*/
template <class T>
class
Expand Down
3 changes: 2 additions & 1 deletion ControlDelay.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@

#include "AudioDelay.h"

/** Control-rate delay line for delaying control signals.
/**
@brief Control-rate delay line for delaying control signals.
For example, this could be used to produce echo-like effects using multiple
instances of the same voice, when AudioDelay would be too short for an actual
audio echo. This is in fact just a wrapper of the AudioDelay code.
Expand Down
4 changes: 2 additions & 2 deletions Doxyfile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -635,7 +635,7 @@ WARN_IF_DOC_ERROR = YES
# wrong or incomplete parameter documentation, but not about the absence of
# documentation.

WARN_NO_PARAMDOC = NO
WARN_NO_PARAMDOC = YES

# The WARN_FORMAT tag determines the format of the warning messages that
# doxygen can produce. The string should contain the $file, $line, and $text
Expand Down Expand Up @@ -793,7 +793,7 @@ INPUT_FILTER =
# info on how filters are used. If FILTER_PATTERNS is empty or if
# non of the patterns match the file name, INPUT_FILTER is applied.

FILTER_PATTERNS =
FILTER_PATTERNS = "*.py = /usr/local/bin/doxypypy.py"

# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
# INPUT_FILTER) will be used to filter the input files when producing source
Expand Down
62 changes: 11 additions & 51 deletions MozziGuts.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,58 +33,17 @@
#include "TimerOne.h"
#include "FrequencyTimer2.h"

/**
@mainpage Welcome
The latest version of Mozzi and this documentation are at the <a href="http://sensorium.github.com/Mozzi/">Mozzi home page.</a>
Here's a brief description of each section of this documentation:
@section Modules
Fixed point number types, macros and functions for fast fractional maths.
Mozzi core definitions and functions, which are used in every Mozzi sketch.
Utility functions which are generally useful, including midi note to frequency conversion, efficient asynchronous analog input and random functions.
@section Classes
The Classes used to generate control and audio signals.
@section Soundtables
Includes ready-to-use wave tables and a few example samples which are in
the Mozzi/tables and Mozzi/samples folders.
You can convert your own sounds from a program like Audacity to tables for Mozzi
with a script called char2mozzi.py, in Mozzi/python. Read the char2mozzi.py file for instructions.
*/


/** @defgroup soundtables Look-up-tables and python scripts to generate tables or convert sounds.
Includes ready-to-use wave tables
and a few example samples which are in the Mozzi/tables and Mozzi/samples
folders. You can convert your own sounds from a program like Audacity to tables
for Mozzi with a script called char2mozzi.py, in Mozzi/python. Read the
char2mozzi.py file for instructions. Also check out the other scripts in the python
folder for templates to use if you want to do your own thing.
*/


/** @defgroup core Mozzi core definitions and functions
The bones of every Mozzi sketch.
*/


/** @ingroup core
Control rate setting.
Mozzi's CONTROL_RATE sets how many times per second updateControl() is called.
It can be any power of 2 greater than 64, and the largest value where it starts to
become impractical is around 1024. 64, 128, 256 and sometimes 512 are all usable values.
Try to keep it as low as you can, for efficiency, though higher rates can sometimes give smoother results,
avoiding the need to interpolate sensitive variables at audio rate in updateAudio().
CONTROL_RATE has a default of 64 Hz, but it can be changed at the top of your sketch,
after the \#includes, for example:
\#define CONTROL_RATE 256
It can be any power of 2 greater than 64, and the largest value where it starts
to become impractical is around 1024. 64, 128, 256 and sometimes 512 are all
usable values. Try to keep it as low as you can, for efficiency, though higher
rates can sometimes give smoother results, avoiding the need to interpolate
sensitive variables at audio rate in updateAudio(). CONTROL_RATE has a default
of 64 Hz, but it can be changed at the top of your sketch, after the \#includes,
for example: \#define CONTROL_RATE 256
*/
#define CONTROL_RATE 64

Expand Down Expand Up @@ -322,9 +281,10 @@ int getAudioInput();


/** @ingroup core
A replacement for Arduino micros() which is disabled by Mozzi which takes over Timer 0 for control interrupts.
mozziMicros has a resolution of 61 microseconds.
May be a useful hack for replacing micros() in time-related sensor libraries.
A replacement for Arduino micros() which is disabled by Mozzi which takes over
Timer 0 for control interrupts. mozziMicros is updated each time an audio sample
is output, so the resolution is 1/AUDIO_RATE (61 microseconds when AUDIO_RATE is
16384 Hz).
@return the approximate number of microseconds since the program began.
@todo incorporate mozziMicros() in a more accurate EventDelay()?
*/
Expand Down
20 changes: 11 additions & 9 deletions doc/html/_02_control_2_control__echo__theremin_2_control__echo__theremin_8ino-example.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,18 @@
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="custom_stylesheet.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="mozzi_smooth_courier_rotated_small_flying_light.png"/></td>
<td id="projectlogo"><img alt="Logo" src="mozzi-circle.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Mozzi
&#160;<span id="projectnumber">alpha 0.01.2c</span>
&#160;<span id="projectnumber">0.01.2c alpha</span>
</div>
<div id="projectbrief">sound synthesis library for Arduino</div>
</td>
Expand All @@ -49,6 +50,7 @@
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
Expand Down Expand Up @@ -88,7 +90,7 @@
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Pages</a></div>
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
Expand Down Expand Up @@ -127,11 +129,11 @@
<div class="line"><span class="comment"> This example code is in the public domain.</span></div>
<div class="line"><span class="comment"> */</span></div>
<div class="line"></div>
<div class="line"><span class="preprocessor">#include &lt;MozziGuts.h&gt;</span></div>
<div class="line"><span class="preprocessor">#include &lt;Oscil.h&gt;</span> <span class="comment">// oscillator template</span></div>
<div class="line"><span class="preprocessor">#include &lt;tables/sin2048_int8.h&gt;</span> <span class="comment">// sine table for oscillator</span></div>
<div class="line"><span class="preprocessor">#include &lt;RecentAverage.h&gt;</span></div>
<div class="line"><span class="preprocessor">#include &lt;ControlDelay.h&gt;</span></div>
<div class="line"><span class="preprocessor">#include &lt;<a class="code" href="_mozzi_guts_8h.html">MozziGuts.h</a>&gt;</span></div>
<div class="line"><span class="preprocessor">#include &lt;<a class="code" href="_oscil_8h.html">Oscil.h</a>&gt;</span> <span class="comment">// oscillator template</span></div>
<div class="line"><span class="preprocessor">#include &lt;<a class="code" href="sin2048__int8_8h.html">tables/sin2048_int8.h</a>&gt;</span> <span class="comment">// sine table for oscillator</span></div>
<div class="line"><span class="preprocessor">#include &lt;<a class="code" href="_recent_average_8h.html">RecentAverage.h</a>&gt;</span></div>
<div class="line"><span class="preprocessor">#include &lt;<a class="code" href="_control_delay_8h.html">ControlDelay.h</a>&gt;</span></div>
<div class="line"></div>
<div class="line"><span class="preprocessor">#define INPUT_PIN 0 // analog control input</span></div>
<div class="line"><span class="preprocessor"></span></div>
Expand Down Expand Up @@ -184,7 +186,7 @@
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Mon Jul 1 2013 00:19:19 for Mozzi by
<li class="footer">Generated on Tue Jul 2 2013 22:37:19 for Mozzi by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.4 </li>
</ul>
Expand Down
Loading

0 comments on commit 83c0c98

Please sign in to comment.