Architecture

== Components ==
Currently the project consists of these source modules:
* '''buzztard''' - the applications and their shared libraries
* '''bml''' - the buzz machine loader (wrapper), also provides a sanitized API to the buzz-machines
* '''bsl''' - the buzz song loader
* '''gst-buzztard''' - experimental code, that might go into [[http://gstreamer.freedesktop.org gstreamer]]<br><small>([http://www.buzztard.org/files/apidocs/gst-buzztard/index.html API docs])</small> and plugins like gstbml, simsynth, ...

This reflects the goal, to have a stand-alone application and sub-modules for buzz migration.
The '''buzztard''' applications will not require the '''bml''', '''gstbml''' and '''bsl''' components.

=== Buzztard modules ===
The buzztard module has several components as well:
* '''libbuzztard-core''' - all the gobjects to model a song, to construct the gstreamer network, to handle configuration data and to use song im/export<br><small>([http://www.buzztard.org/files/apidocs/bt-core/index.html API docs])</small>
* '''libbuzztard-ic''' - interaction controller support<br><small>([http://www.buzztard.org/files/apidocs/bt-ic/index.html API docs])</small>
* '''buzztard-cmd''' - a commandline tool for playing, showing song info, etc.<br><small>([http://www.buzztard.org/files/apidocs/bt-cmd/index.html API docs])</small>
* '''buzztard-edit''' - the graphical editor application<br><small>([http://www.buzztard.org/files/apidocs/bt-edit/index.html API docs])</small>

In the future we might have more apps based on the framework. On our list currently are
* '''[[buzztard-live]]''' - a live playback application
* '''[[buzztard-session]]''' - a live sequencing / composing application
* '''[[buzztard-bin]]''' - a gstreamer bin element + a typefinder, so that buzztard songs can be played in playbin based applications

We might also add more libs. Once we have more GUI apps, we should move alls gtk-widgets to a separate lib (libbt-ui).