Skip to main content

Developers

-> -> New release June 30th. See news

Architecture

Getting started

After reading the docs in this section…

To make use of an existing Ayyi service from within your application is very simple. Link to either the C or C++ client libs and its dependencies, and you will imediately have access to all the Song and Mixer functionality. Start with the example application, and add from there.

Writing your own Service is slightly more involved, but not difficult. Look at the server example to see how this can be done. The minimum is just to set up a standard dbus service. You can also export a shm segment and provide a header file and client dll to support this.

You may find the documentation incomplete, and speaking to an Ayyi developer will save you time and frustration. Send an email, post to LAD, or arrange to speak on irc…

Distributed development

The starting premise for the Ayyi project is that for GPL’d audio production software to exceed the capabilities of existing closed solutions, the modularity of its architecture needs to be improved. See the distributed development page for some ramblings on this subject.

Ayyi splits functionality along the natural and familiar MVC lines. In constrast to other similarly-architected systems in the domain, many of which are more oriented toward synthesis, Ayyi takes the centre piece as the Song (or Sequence, or Composition) model. The other significant model used is the Mixer. Both the user interfaces, and the audio/midi renderers are considered to be Views. This in fact is how many applications are divided internally (eg, c/w ARDOUR::Session, ARDOUR::engine, ARDOUR::UI), but here they are further separated into distinct processes.

This split gives Ayyi the essential qualities of being completely language and toolkit agnostic.

The example software on this site concentrates on the most basic level of separation - that between the “engine” and the gui (eg the audio renderer is still integrated with the Model).

Distributed objects

The most essential characteristic of Ayyi is that of an interface between the participating elements of the production system.

The IPC used is a combination of messaging and shared memory (shm):

With current implementations, all clients must be on the same machine, though the messaging systems are network capable, and it would be relatively simple to request the shared data currently in shm via a message instead.

The use of SHM is unpopular with some developers. The primary reason being that network clients cannot access it. And having to store application object properties in a language-agnostic (POD) manner is a non-trivial burden, even if equally it is not that difficult. For a c/c++ server developer, library code abstracts the memory allocation and destruction of public data in the shared memory segment, and the application references it as it would any other data.

It could be argued that having the interface defined in two separate places (half in SHM and half in the messaging system), is bad practice. But the performance benefits to direct access to properties in shared memory without making asynchronous calls, can’t be denied, and there is nothing in the architecture to prevent this access being duplicated in the message interface to satisfy network clients. In fact there is nothing to prevent a participating server from doing everything using RPC, and not using SHM at all.

Unlike DCOM/.Net or Cocoa, there is no library support for degeneration to in-process servers, though nothing prevents this from being done.

Engines

A server process - a service that exports data - can be referred to as an “engine”.

The job of the Song engine, is to make its state available to connected audio and graphical renderers, to make updates in response to requests from connected controllers, and to broadcast changes. The same applies to the Mixer and other engines.

There is currently only one publically available engine. The Ayyid1 package uses a slightly modified version of libardour that adds the ability for external processes to read and write some aspects of its model.

More about the ayyi-d1 engine

Guis

The gui functions by reading the Song Model from shared memory, and presenting it the user. In response to user actions, the gui makes asynchronous function calls, via the messaging service, to the server. The gui also registers to receive signals for Song objects that it is interested. On receipt of a signal, the gui rereads the shm model and updates the display the accordingly.

Most of the existing code uses Gtk, but could just as well be written with QT, Opengl, or any other toolkit.

There are two example gui apps currently available:

Document model

Api’s

Future

Now that the project works as a proof-of-concept, the next steps are: