192 lines
5.4 KiB
Plaintext
192 lines
5.4 KiB
Plaintext
Ardour Source-Tree layout (April 2020)
|
|
|
|
===== Front Ends =====
|
|
|
|
gtk2_ardour/
|
|
The main Ardour GUI -- This is where most of the complexity is :)
|
|
It is cleanly separated from the backend and processing engine.
|
|
|
|
headless/
|
|
hardour -- headless Ardour, mostly demo-code how to use Ardour without a GUI.
|
|
|
|
session_utils/
|
|
command-line tools using libardour (e.g. export)
|
|
|
|
luasession/
|
|
arlua -- commandline interface to libardour
|
|
|
|
vst
|
|
wine application top-level (WindowsVST on Linux)
|
|
|
|
===== LIBRARIES =====
|
|
A collection of libraries and utility functions. While most are shared
|
|
libraries, they're pretty much exclusive to Ardour.
|
|
|
|
libs/
|
|
|
|
**** Independent libs ****
|
|
|
|
- appleutility
|
|
Utility Classes, abstraction for CoreAudio and AudioUnits (OSX, macOS)
|
|
|
|
- ardouralsautil
|
|
Utility Class for device-listing (used by the jack and ALSA backends).
|
|
Device-reservation comandline tool (linked against libdbus), which is
|
|
also available from https://github.com/x42/alsa_request_device
|
|
|
|
- clearlooks-newer
|
|
GTK theme engine (used by gtk2_ardour)
|
|
|
|
- fluidsynth
|
|
Stripped down (library only) and slightly customized version of fluidsynth
|
|
use tools/update_fluidsynth.sh to update from upstream
|
|
|
|
- hidapi
|
|
Unmodified https://github.com/signal11/hidapi for interaction with some
|
|
control surfaces (Push2, NI Maschine)
|
|
|
|
- libltc
|
|
Unmodified https://github.com/x42/libltc/ for Linear Timecode en/decoding
|
|
|
|
- lua
|
|
Lua Script interpreter and C++ class abstraction
|
|
- libs/lua/lua-5.3.5 is unmodified upstream Lua-5.3.5
|
|
- libs/lua/LuaBridge is a highly customized version of
|
|
https://github.com/vinniefalco/LuaBridge (C++ bindings)
|
|
|
|
- midi++2
|
|
(uses libpdb, libevoral)
|
|
Standard MIDI Files I/O
|
|
|
|
- ptformat
|
|
Unmodified https://github.com/zamaudio/ptformat for loading ProTools sessions
|
|
|
|
- temporal
|
|
various utility code for dealing with different kinds of time,
|
|
including Timecode (FPS) and musical time conversions
|
|
|
|
- qm-dsp
|
|
Stripped down version of https://github.com/c4dm/qm-dsp
|
|
The Queen Mary DSP library is used by VAMP Plugins
|
|
|
|
- vamp-plugins
|
|
VAMP plugins for audio analysis and offline processing (uses qm-dsp)
|
|
|
|
- vamp-pyin
|
|
VAMP plugins for pitch and note-tracking (uses qm-dsp), offline analyis
|
|
|
|
- vfork
|
|
A exec-wrapper which redirects file-descriptors to be used with vfork(2)
|
|
|
|
- plugins
|
|
LV2 Plugins included with Ardour. These are currently mostly
|
|
independent (a-fluidsynth uses libfluidsynth).
|
|
Most of them are custom version of existing plugins (zamaudio, x42),
|
|
that have been customized to be bundled with Ardour on all platforms
|
|
tha ardour runs on.
|
|
|
|
- zita-convolver
|
|
convolution kernel, so far only avialable to Lua scripts.
|
|
|
|
- zita-resampler
|
|
Efficient resampler with variable rate, useful for adaptive resampling.
|
|
Mainly used for vari-speed playback.
|
|
|
|
**** PBD dependent libs ****
|
|
|
|
- pbd
|
|
Paul B. Davis' utility classes. This is the basis for all Ardour specifics.
|
|
It provides basic concepts and OS abstractions.
|
|
|
|
- evoral
|
|
(uses libpbd)
|
|
Control events, control lists, automation evaluation,
|
|
parameter descriptions, incl MIDI event abstraction
|
|
|
|
- backends
|
|
(uses libpdb, ardouralsautil | appleutility, implements libardour interface)
|
|
Interaction with Operating System's Audio/MIDI API:
|
|
ALSA, CoreAudio, JACK, PortAudio/ASIO, Pulseaudio
|
|
|
|
- surfaces
|
|
(uses libpbd, libevoral, libtimecode, libardour ;; libgtkmm2ext, libcanvas)
|
|
Control Surfaces, dynamically loaded by libardour on runtime,
|
|
to remote-control ardour (midi bindings, network etc).
|
|
|
|
- panners
|
|
(uses libpdb, implements libardour interface)
|
|
Pan plugins (stereo-balance, VBAP, etc) are dynamically loaded at runtime.
|
|
|
|
- audiographer
|
|
(uses libpdb)
|
|
Mini Ardour inside Ardour to export audio-files from sessions.
|
|
|
|
- fst
|
|
(uses libpbd, implements external methods for libardour and gtk2ardour)
|
|
VST scanner tool and abstraction for Windows-VSTs to be used with
|
|
wine or MS windows.
|
|
|
|
- ardour
|
|
(uses pretty much all the libs above)
|
|
This is it. libardour runs Ardour sessions
|
|
All realtime processing happens here, plugins are managed etc.
|
|
|
|
**** UI related libs ****
|
|
|
|
- gtkmm2ext
|
|
(uses libpbd)
|
|
Utility Library to extend GDK, GTK, and basic abstraction for UIs
|
|
and event-loops. This library is not limited to the GUI, but also
|
|
used for other graphical interfaces (e.g. Push2, NI Maschine control
|
|
surfaces).
|
|
|
|
- canvas
|
|
(uses libpbd, libgtkmm2ext)
|
|
Cairo Canvas, provides a slate for scalable drawing and basic layout/packing
|
|
This is used by gtk2ardour's main editor.
|
|
|
|
- widgets
|
|
(uses libpbd, libgtkmm2ext ;; libcanvas utils/colors)
|
|
Ardour GUI widgets (buttons, fader, knobs, etc)
|
|
|
|
- waveview
|
|
(uses libpbd, libgtkmm2ext, canvas, libardour)
|
|
Threaded waveform rendering and waveform image cache
|
|
|
|
|
|
===== RESOURCE FILES =====
|
|
These are bundled as-is.
|
|
|
|
share/export/
|
|
Export Presets
|
|
|
|
share/mcp/
|
|
Mackie control surface device files
|
|
|
|
share/midi_maps/
|
|
Generic MIDI control surface presets
|
|
|
|
share/osc/
|
|
Configuration presets for the OSC control surface
|
|
|
|
share/patchfiles/
|
|
MIDNAM files, MIDI synth descriptions (note-names, CC, PGM names)
|
|
|
|
share/scripts/
|
|
Lua scripts (files with a leading underscore are not bundled)
|
|
see also share/scripts/README
|
|
|
|
share/templates/
|
|
Session templates (currently none)
|
|
|
|
|
|
===== MISC =====
|
|
doc/
|
|
Misc developer oriented documentation files and Doxygen
|
|
|
|
patches/
|
|
Some .diff files for the build-stack.
|
|
|
|
tools/
|
|
Various developer tools, most notably packaging scripts
|