three-wolves / mozzi Goto Github PK

README for Mozzi, a sound synthesis library for Arduino.
Version 0.01.1c
Tim Barrass 2010-12


Currently your Arduino can only beep like a microwave oven. Mozzi brings
your Arduino to life by allowing it to produce much more complex and interesting
growls, sweeps and chorusing atmospherics. These sounds can be quickly and easily
constructed from familiar synthesis units like oscillators, delays, filters and
envelopes.

You can use Mozzi to generate algorithmic music for an installation or
performance, or make interactive sonifications of sensors, on a small, modular
and super cheap Arduino, without the need for additional shields, message
passing or external synths.

Mozzi is designed to be easy to use, open source and extendable.

If you enjoy using Mozzi for a project, or have extended it, we would be
pleased to hear about it and provide support wherever possible. Contribute
suggestions, improvements and bug fixes to the Mozzi wiki on Github, or
Fork it to contribute directly to future developments.

Mozzi is a development of research into Mobile Sonification in the
SweatSonics Project. (http://stephenbarrass.wordpress.com/tag/sweatsonics/)


FEATURES

-    16384 Hz, 8-bit audio output. (Actually, nearly 9 bit resolution,
      -244 to 243).
-    Variable control rate from 64 Hz upwards.
-    Useful basic audio toolkit: oscillators, samples, lines, envelopes,
     scheduling, filtering.
-    Fast ADC and other cpu-efficient code utilities to help keep audio
     running smoothly.
-    Example sketches for easy modification.
-    Readymade wavetables and a script to convert your own soundfiles for Mozzi.


INSTALLATION

Download Mozzi and unzip it. It will probably have a name like
"sensorium-Mozzi-2bee818". Rename the unzipped folder "Mozzi".
Then, following the instructions from the Arduino libraries page:
Open your Arduino sketchbook folder. If there is already a folder there called
libraries, place the library folder in there. If not, create a folder called
libraries in the sketchbook folder, and drop the Mozzi folder in there. Then
re-start the Arduino programming environment, and you should see Mozzi in the
Sketch > Import Library menu.


QUICK START

To hear Mozzi, connect a 3.5mm audio jack with the centre wire to the PWM
output on Digital pin 9 on Arduino, and the black ground to the Ground on the
Arduino. Use this as a line out which you can plug into your computer and listen
to with a sound program like Audacity. Try some examples. They are in your
File > Examples > Mozzi menu.


USING MOZZI

Here's a template for an empty Mozzi sketch:

	#include <MozziGuts.h>         // at the top of your sketch
	#define CONTROL_RATE 64 // or some other power of 2

	void setup() {
		startMozzi(CONTROL_RATE);
	}

	void loop() {
		audioHook();
	}

	int updateAudio(){
		// your audio code which returns an int between -244 and 243
		// actually, a char is fine
	}

	void updateControl(){
		// your control code
	}


DOCUMENTATION

There's documentation in the doc folder in the Mozzi download
and online. (http://sensorium.github.com/Mozzi/doc/html/index.html)

There are hints and tips and more help on the Mozzi wiki.
(https://github.com/sensorium/Mozzi/wiki/Hints-and-Tips)

Start or look up a topic on the Mozzi users forum.
(https://groups.google.com/forum/#!forum/mozzi-users)

Also, feel free to submit any issues on the GitHub Mozzi site.
(https://github.com/sensorium/Mozzi/issues)

Share code snippets:
(https://github.com/sensorium/Mozzi/wiki/Code-Snippets-to-Share)

Check for code and usage changes in CHANGES.txt.


CAVEATS

This code has been tested on Arduino Dumemilanove ATmega328. Feedback
about performance on other Arduinos welcome.

Mozzi doesn't play nice with Arduino time functions millis(), micros(), delay(),
delayMicroseconds(). Instead, you can use Mozzi's EventDelay() for scheduling.


CONTRIBUTIONS / INCLUDED DEPENDENCIES

Mozzi makes use of the following code:

TimerOne library - http://code.google.com/p/arduino-timerone/ (GPL3)
TimerTwo library - https://bitbucket.org/johnmccombs (author unknown: is it you?)

Mozzi has also drawn on and been influenced by:

ead~.c puredata external (creb library) Copyright (c) 2000-2003 by Tom Schouten (GPL2)

AF_precision_synthesis.pde by Adrian Freed, 2009.
(http://adrianfreed.com/content/arduino-sketch-high-frequency-precision-sine-wave-tone-sound-synthesis)

Resonant filter posted to musicdsp.org by Paul Kellett
http://www.musicdsp.org/archive.php?classid=3#259,
and fixed point version of the filter on "dave's blog of art and programming"
http://www.pawfal.org/dave/blog/2011/09/