Read Me

* Figus Dev Pack

* Introduction

FDP is an audio (visual?) Army Knife.

* Prerequisites

** Audio

| Module                | URL                                                                 | Description                                                                                                    |
|-----------------------+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------|
| Numpy / Pylab / Scipy | http://scipy.org                                                    | Scientific Tools for Python                                                                                    |
| pyo                   | http://code.google.com/p/pyo/                                       | Python digital signal processing module                                                                        |
| (Py)SndObj            | http://sndobj.sourceforge.net/                                      | Object-oriented audio processing library                                                                       |
| Audiolab              | http://www.ar.media.kyoto-u.ac.jp/members/david/softwares/audiolab/ | A python package to make noise with numpy arrays                                                               |
| pyOSC                 | https://trac.v2.nl/wiki/pyOSC                                       | A Simple OpenSoundControl implementation, in Pure Python                                                       |
| simpleOSC             | http://www.ixi-software.net/content/body_backyard_osc.html          | Provides the simplest API to pyOSC library                                                                     |
| Music21               | http://mit.edu/music21/                                             | A toolkit for computer-aided musicology                                                                        |
| athenaCL              | http://www.flexatone.net/athena.html                                | A modular poly-paradigm algorithmic music composition in a cross-platform interactive command-line environment |
| CSoundAC              | http://www.csounds.com/                                             | Python extension module for writing music by programming in Python                                             |

** Visual

| Module  | URL                | Description                                                                            |
|---------+--------------------+----------------------------------------------------------------------------------------|
| Pyglet  | http://pyglet.org  | A cross-platform windowing and multimedia library for Python                           |
| Cocos2d | http://cocos2d.org | A framework for building 2D games, demos, and other graphical/interactive applications |

** Maybe on a near future

| Module       | URL                                    | Description                                                   |
|--------------+----------------------------------------+---------------------------------------------------------------|
| pyFluidSynth | http://code.google.com/p/pyfluidsynth/ | Python bindings for FluidSynth                                |
| mingus       | http://code.google.com/p/mingus/       | Music package for Python                                      |
| improviser   | http://improviser.onderstekop.nl/      | Real-time music generation program written in Python          |
| pcsets       | http://code.google.com/p/pcsets/       | Pitch Class Sets for Python                                   |
| aristoxenus  | http://github.com/kroger/aristoxenus   | A library in python to parse music data in the humdrum format |
| pyata        | http://code.google.com/p/pyata/        | A Library that allows you to use Pure Data inside Python      |
| toPD         | http://automata.cc/topd                | A simple Python interface to Pure Data                        |

* Installing

FDP has a install script that make installation easy on Debian GNU/Linux based
operating systems.

To install FDP and all it's dependencies:

#+begin_src sh
$ svn co https://fdpack.svn.sourceforge.net/svnroot/fdpack fdpack
$ cd fdpack/
$ scripts/install.sh
#+end_src

It will take some time.

* Using

Start the Python interpreter:

#+begin_src sh
$ ipython
#+end_src

Import the fdp module and hack free:

#+begin_src sh
from fdp import *
play_file('samples/chant.wav')
#+end_src

If you want to know more about a function, use the help:

#+begin_src sh
play_file? <PRESS ENTER!>
#+end_src

You can execute the example commands listed on the help of each function:

#+begin_src sh
run_example(play_file)
run_example(plot_file)
#+end_src

* Hacking

Directory structure

| Dir       | Description                                                              |
|-----------+--------------------------------------------------------------------------|
| examples/ | Commented examples of various FDP features                               |
| apps/     | Applications created using FDP                                           |
| docs/     | Documentation                                                            |
| deps/     | Created by scripts/instala.sh. Contains source codes of FDP dependencies |
| scripts/  | Useful scripts                                                           |

* More Information

Please, take a look at http://www.estudiolivre.org/tiki-index.php?page=fdp