
Lua Bindings Class Reference
This documentation is far from complete may be inaccurate and subject to change.
Overview
The top-level entry point are ARDOUR:Session and ArdourUI:Editor. Most other Classes are used indirectly starting with a Session function. e.g. Session:get_routes().
A few classes are dedicated to certain script types, e.g. Lua DSP processors have exclusive access to ARDOUR.DSP and ARDOUR:ChanMapping. Action Hooks Scripts to LuaSignal:Set etc.
Detailed documentation (parameter names, method description) is not yet available. Please stay tuned.
Short introduction to Ardour classes
Ardour's structure is object oriented. The main object is the Session. A Session contains Audio Tracks, Midi Tracks and Busses. Audio and Midi tracks are derived from a more general "Track" Object, which in turn is derived from a "Route" (aka Bus). (We say "An Audio Track is-a Track is-a Route"). Tracks contain specifics. For Example a track has-a diskstream (for file i/o).
Operations are performed on objects. One gets a reference to an object and then calls a method.
e.g obj = Session:route_by_name("Audio") obj:set_name("Guitar")
.
Lua automatically follows C++ class inheritance. e.g one can directly call all SessionObject and Route methods on Track object. However lua does not automatically promote objects. A Route object which just happens to be a Track needs to be explicitly cast to a Track. Methods for casts are provided with each class. Note that the cast may fail and return a nil reference.
Likewise multiple inheritance is a non-trivial issue in Lua. To avoid performance penalties involved with lookups, explicit casts are required in this case. One example is ARDOUR:SessionObject which is-a StatefulDestructible which inherits from both Stateful and Destructible.
Object lifetimes are managed by the Session. Most Objects cannot be directly created, but one asks the Session to create or destroy them. This is mainly due to realtime constrains: you cannot simply remove a track that is currently processing audio. There are various factory methods for object creation or removal.
Pass by Reference
Since Lua functions are closures, C++ methods that pass arguments by reference cannot be used as-is. All parameters passed to a C++ method which uses references are returned as Lua Table. If the C++ method also returns a value it is prefixed. Two parameters are returned: the value and a Lua Table holding the parameters.
void set_ref (int& var, long& val)
{
printf ("%d %ld\n", var, val);
var = 5;
val = 7;
}
local var = 0; ref = set_ref (var, 2); -- output from C++ printf()
0 2-- var is still 0 here print (ref[1], ref[2])
5 7
int set_ref2 (int &var, std::string unused)
{
var = 5;
return 3;
}
rv, ref = set_ref2 (0, "hello");
print (rv, ref[1], ref[2])
3 5 hello
Pointer Classes
Libardour makes extensive use of reference counted boost::shared_ptr
to manage lifetimes.
The Lua bindings provide a complete abstraction of this. There are no pointers in Lua.
For example a ARDOUR:Route is a pointer in C++, but Lua functions operate on it like it was a class instance.
shared_ptr
are reference counted. Once assigned to a Lua variable, the C++ object will be kept and remains valid.
It is good practice to assign references to Lua local
variables or reset the variable to nil
to drop the ref.
All pointer classes have a isnil ()
method. This is for two cases:
Construction may fail. e.g. ARDOUR.LuaAPI.newplugin()
may not be able to find the given plugin and hence cannot create an object.
The second case if for boost::weak_ptr
. As opposed to boost::shared_ptr
weak-pointers are not reference counted.
The object may vanish at any time.
If Lua code calls a method on a nil object, the interpreter will raise an exception and the script will not continue.
This is not unlike a = nil a:test()
which results in en error "attempt to index a nil value".
From the Lua side of things there is no distinction between weak and shared pointers. They behave identically. Below they're indicated in orange and have an arrow to indicate the pointer type. Pointer Classes cannot be created in Lua scripts. It always requires a call to C++ to create the Object and obtain a reference to it.
Class Documentation
ℕ ARDOUR
Methods | ||
---|---|---|
RCConfiguration | config () | |
std::string | user_cache_directory (std::string) | |
Returns the path to the directory used to store user specific caches (e.g. plugin indices, blacklist/whitelist) it defaults to XDG_CACHE_HOME | ||
std::string | user_config_directory (int) | |
user_config_directory() exists IF version was negative. Returns the path to the directory used to store user specific configuration files for the given version of the program. If version is negative, the build-time string PROGRAM_VERSION will be used to determine the version number. |
↠ ARDOUR:Amp
C‡: boost::shared_ptr< ARDOUR::Amp >, boost::weak_ptr< ARDOUR::Amp >
is-a: ARDOUR:Processor
Gain Stage (Fader, Trim).
Methods | ||
---|---|---|
float | apply_gain (AudioBuffer&, long, long, float, float, long) | |
GainControl | gain_control () | |
bool | isnil () |
Inherited from ARDOUR:Processor
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
long | capture_offset () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
long | input_latency () | |
ChanCount | input_streams () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
long | signal_latency () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
↠ ARDOUR:AsyncMIDIPort
C‡: boost::shared_ptr< ARDOUR::AsyncMIDIPort >, boost::weak_ptr< ARDOUR::AsyncMIDIPort >
is-a: ARDOUR:MidiPort
Methods | ||
---|---|---|
bool | isnil () | |
int | write (unsigned char*, unsigned long, unsigned int) |
Inherited from ARDOUR:MidiPort
Methods | ||
---|---|---|
MidiBuffer | get_midi_buffer (unsigned int) | |
bool | input_active () | |
void | set_input_active (bool) | |
Cast | ||
AsyncMIDIPort | to_asyncmidiport () |
Inherited from ARDOUR:Port
Methods | ||
---|---|---|
int | connect (std::string) | |
bool | connected () | |
Returns true if this port is connected to anything | ||
bool | connected_to (std::string) | |
Returns true if this port is connected to o, otherwise false. | ||
int | disconnect (std::string) | |
int | disconnect_all () | |
PortFlags | flags () | |
Returns flags | ||
LuaTable(...) | get_connected_latency_range (LatencyRange&, bool) | |
std::string | name () | |
Returns Port short name | ||
bool | physically_connected () | |
std::string | pretty_name (bool) | |
Returns Port human readable name | ||
LatencyRange | private_latency_range (bool) | |
LatencyRange | public_latency_range (bool) | |
bool | receives_input () | |
Returns true if this Port receives input, otherwise false | ||
bool | sends_output () | |
Returns true if this Port sends output, otherwise false | ||
Cast | ||
AsyncMIDIPort | to_asyncmidiport () | |
AudioPort | to_audioport () | |
MidiPort | to_midiport () |
↠ ARDOUR:AudioBackend
C‡: boost::shared_ptr< ARDOUR::AudioBackend >, boost::weak_ptr< ARDOUR::AudioBackend >
AudioBackend is an high-level abstraction for interacting with the operating system's audio and midi I/O.
Methods | ||
---|---|---|
unsigned int | buffer_size () | |
std::string | device_name () | |
std::string | driver_name () | |
override this if this implementation returns true from requires_driver_selection() | ||
float | dsp_load () | |
return the fraction of the time represented by the current buffer size that is being used for each buffer process cycle, as a value from 0.0 to 1.0 E.g. if the buffer size represents 5msec and current processing takes 1msec, the returned value should be 0.2. Implementations can feel free to smooth the values returned over time (e.g. high pass filtering, or its equivalent). | ||
DeviceStatusVector | enumerate_devices () | |
Returns a collection of DeviceStatuses identifying devices discovered by this backend since the start of the process. Any of the names in each DeviceStatus may be used to identify a device in other calls to the backend, though any of them may become invalid at any time. | ||
StringVector | enumerate_drivers () | |
If the return value of requires_driver_selection() is true, then this function can return the list of known driver names. If the return value of requires_driver_selection() is false, then this function should not be called. If it is called its return value is an empty vector of strings. | ||
DeviceStatusVector | enumerate_input_devices () | |
Returns a collection of DeviceStatuses identifying input devices discovered by this backend since the start of the process. Any of the names in each DeviceStatus may be used to identify a device in other calls to the backend, though any of them may become invalid at any time. | ||
DeviceStatusVector | enumerate_output_devices () | |
Returns a collection of DeviceStatuses identifying output devices discovered by this backend since the start of the process. Any of the names in each DeviceStatus may be used to identify a device in other calls to the backend, though any of them may become invalid at any time. | ||
AudioBackendInfo | info () | |
Return the AudioBackendInfo object from which this backend was constructed. | ||
unsigned int | input_channels () | |
std::string | input_device_name () | |
bool | isnil () | |
unsigned int | output_channels () | |
std::string | output_device_name () | |
unsigned int | period_size () | |
float | sample_rate () | |
int | set_buffer_size (unsigned int) | |
Set the buffer size to be used. The device is assumed to use a double buffering scheme, so that one buffer's worth of data can be processed by hardware while software works on the other buffer. All known suitable audio APIs support this model (though ALSA allows for alternate numbers of buffers, and CoreAudio doesn't directly expose the concept). | ||
int | set_device_name (std::string) | |
Set the name of the device to be used | ||
int | set_driver (std::string) | |
Returns zero if the backend can successfully use drivername as the driver, non-zero otherwise. Should not be used unless the backend returns true from requires_driver_selection() | ||
int | set_input_device_name (std::string) | |
Set the name of the input device to be used if using separate input/output devices. use_separate_input_and_output_devices() | ||
int | set_output_device_name (std::string) | |
Set the name of the output device to be used if using separate input/output devices. use_separate_input_and_output_devices() | ||
int | set_peridod_size (unsigned int) | |
Set the period size to be used. must be called before starting the backend. | ||
int | set_sample_rate (float) | |
Set the sample rate to be used | ||
bool | use_separate_input_and_output_devices () | |
An optional alternate interface for backends to provide a facility to select separate input and output devices. If a backend returns true then enumerate_input_devices() and enumerate_output_devices() will be used instead of enumerate_devices() to enumerate devices. Similarly set_input/output_device_name() should be used to set devices instead of set_device_name(). |
∁ ARDOUR:AudioBackendInfo
C‡: ARDOUR::AudioBackendInfo
Data Members | ||
---|---|---|
char* | name |
∁ ARDOUR:AudioBuffer
C‡: ARDOUR::AudioBuffer
Buffer containing audio data.
Methods | ||
---|---|---|
void | apply_gain (float, long) | |
Apply a fixed gain factor to the audio buffer
| ||
bool | check_silence (unsigned int, unsigned int&) | |
Check buffer for silence
Returns true if all samples are zero | ||
FloatArray | data (long) | |
void | read_from (FloatArray, long, long, long) | |
void | silence (long, long) | |
silence buffer
|
∁ ARDOUR:AudioEngine
C‡: ARDOUR::AudioEngine
is-a: ARDOUR:PortManager
Methods | ||
---|---|---|
BackendVector | available_backends () | |
std::string | current_backend_name () | |
bool | freewheeling () | |
float | get_dsp_load () | |
std::string | get_last_backend_error () | |
long | processed_samples () | |
bool | running () | |
AudioBackend | set_backend (std::string, std::string, std::string) | |
int | set_buffer_size (unsigned int) | |
int | set_device_name (std::string) | |
int | set_sample_rate (float) | |
bool | setup_required () | |
int | start (bool) | |
int | stop (bool) |
Inherited from ARDOUR:PortManager
Methods | ||
---|---|---|
int | connect (std::string, std::string) | |
bool | connected (std::string) | |
int | disconnect (std::string, std::string) | |
int | disconnect_port (Port) | |
LuaTable(int, ...) | get_backend_ports (std::string, DataType, PortFlags, StringVector&) | |
LuaTable(int, ...) | get_connections (std::string, StringVector&) | |
void | get_physical_inputs (DataType, StringVector&, MidiPortFlags, MidiPortFlags) | |
void | get_physical_outputs (DataType, StringVector&, MidiPortFlags, MidiPortFlags) | |
Port | get_port_by_name (std::string) | |
Returns Corresponding Port or 0. | ||
LuaTable(int, ...) | get_ports (DataType, PortList&) | |
std::string | get_pretty_name_by_name (std::string) | |
ChanCount | n_physical_inputs () | |
ChanCount | n_physical_outputs () | |
bool | physically_connected (std::string) | |
PortEngine | port_engine () | |
bool | port_is_physical (std::string) | |
void | reset_input_meters () |
↠ ARDOUR:AudioPlaylist
C‡: boost::shared_ptr< ARDOUR::AudioPlaylist >, boost::weak_ptr< ARDOUR::AudioPlaylist >
is-a: ARDOUR:Playlist
A named object associated with a Session. Objects derived from this class are expected to be destroyed before the session calls drop_references().
Methods | ||
---|---|---|
bool | isnil () | |
timecnt_t | read (FloatArray, FloatArray, FloatArray, timepos_t, timecnt_t, unsigned int) |
Inherited from ARDOUR:Playlist
Methods | ||
---|---|---|
void | add_region (Region, timepos_t, float, bool) | |
Region | combine (RegionList, Track) | |
unsigned int | count_regions_at (timepos_t) | |
Playlist | cut (TimelineRangeList&, bool) | |
DataType | data_type () | |
void | duplicate (Region, timepos_t&, timecnt_t, float) | |
void | duplicate_range (TimelineRange&, float) | |
void | duplicate_until (Region, timepos_t&, timecnt_t, timepos_t) | |
bool | empty () | |
Region | find_next_region (timepos_t, RegionPoint, int) | |
timepos_t | find_next_region_boundary (timepos_t, int) | |
long | find_next_transient (timepos_t, int) | |
ID | get_orig_track_id () | |
bool | hidden () | |
void | lower_region (Region) | |
void | lower_region_to_bottom (Region) | |
unsigned int | n_regions () | |
void | raise_region (Region) | |
void | raise_region_to_top (Region) | |
Region | region_by_id (ID) | |
RegionListPtr | region_list () | |
RegionListPtr | regions_at (timepos_t) | |
RegionListPtr | regions_touched (timepos_t, timepos_t) | |
RegionListPtr | regions_with_end_within (Range) | |
RegionListPtr | regions_with_start_within (Range) | |
void | remove_region (Region) | |
bool | set_name (std::string) | |
bool | shared () | |
void | split_region (Region, timepos_t) | |
Region | top_region_at (timepos_t) | |
Region | top_unmuted_region_at (timepos_t) | |
void | uncombine (Region) | |
bool | used () | |
Cast | ||
AudioPlaylist | to_audioplaylist () | |
MidiPlaylist | to_midiplaylist () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
↠ ARDOUR:AudioPort
C‡: boost::shared_ptr< ARDOUR::AudioPort >, boost::weak_ptr< ARDOUR::AudioPort >
is-a: ARDOUR:Port
Methods | ||
---|---|---|
bool | isnil () |
Inherited from ARDOUR:Port
Methods | ||
---|---|---|
int | connect (std::string) | |
bool | connected () | |
Returns true if this port is connected to anything | ||
bool | connected_to (std::string) | |
Returns true if this port is connected to o, otherwise false. | ||
int | disconnect (std::string) | |
int | disconnect_all () | |
PortFlags | flags () | |
Returns flags | ||
LuaTable(...) | get_connected_latency_range (LatencyRange&, bool) | |
std::string | name () | |
Returns Port short name | ||
bool | physically_connected () | |
std::string | pretty_name (bool) | |
Returns Port human readable name | ||
LatencyRange | private_latency_range (bool) | |
LatencyRange | public_latency_range (bool) | |
bool | receives_input () | |
Returns true if this Port receives input, otherwise false | ||
bool | sends_output () | |
Returns true if this Port sends output, otherwise false | ||
Cast | ||
AsyncMIDIPort | to_asyncmidiport () | |
AudioPort | to_audioport () | |
MidiPort | to_midiport () |
∁ ARDOUR:AudioPortMeters
C‡: std::map<std::string, ARDOUR::PortManager::DPM >
Constructor | ||
---|---|---|
ℂ | ARDOUR.AudioPortMeters () | |
Methods | ||
LuaTable | add (std::string, ARDOUR::PortManager::DPM ) | |
... | at (--lua--) | |
void | clear () | |
unsigned long | count (std::string) | |
bool | empty () | |
LuaIter | iter () | |
unsigned long | size () | |
LuaTable | table () |
↠ ARDOUR:AudioRegion
C‡: boost::shared_ptr< ARDOUR::AudioRegion >, boost::weak_ptr< ARDOUR::AudioRegion >
is-a: ARDOUR:Region
A named object associated with a Session. Objects derived from this class are expected to be destroyed before the session calls drop_references().
Methods | ||
---|---|---|
AudioSource | audio_source (unsigned int) | |
AutomationList | envelope () | |
bool | envelope_active () | |
bool | fade_in_active () | |
bool | fade_out_active () | |
bool | isnil () | |
double | maximum_amplitude (Progress) | |
Returns the maximum (linear) amplitude of the region, or a -ve number if the Progress object reports that the process was cancelled. | ||
unsigned int | n_channels () | |
double | rms (Progress) | |
Returns the maximum (rms) signal power of the region, or a -1 if the Progress object reports that the process was cancelled. | ||
float | scale_amplitude () | |
LuaTable(int, ...) | separate_by_channel (RegionVector&) | |
void | set_envelope_active (bool) | |
void | set_fade_in_active (bool) | |
void | set_fade_in_length (long) | |
void | set_fade_in_shape (FadeShape) | |
void | set_fade_out_active (bool) | |
void | set_fade_out_length (long) | |
void | set_fade_out_shape (FadeShape) | |
void | set_scale_amplitude (float) | |
Cast | ||
Readable | to_readable () |
Inherited from ARDOUR:Region
Methods | ||
---|---|---|
bool | at_natural_position () | |
bool | automatic () | |
bool | can_move () | |
bool | captured () | |
void | captured_xruns (XrunPositions&, bool) | |
void | clear_sync_position () | |
Control | control (Parameter, bool) | |
bool | covers (timepos_t) | |
void | cut_end (timepos_t) | |
void | cut_front (timepos_t) | |
DataType | data_type () | |
bool | external () | |
bool | has_transients () | |
bool | hidden () | |
bool | import () | |
bool | is_compound () | |
unsigned int | layer () | |
timecnt_t | length () | |
bool | locked () | |
void | lower () | |
void | lower_to_bottom () | |
StringVector | master_source_names () | |
SourceList | master_sources () | |
void | move_start (timecnt_t) | |
void | move_to_natural_position () | |
bool | muted () | |
void | nudge_position (timecnt_t) | |
bool | opaque () | |
Playlist | playlist () | |
timepos_t | position () | |
How the region parameters play together: POSITION: first sample of the region along the timeline START: first sample of the region within its source(s) LENGTH: number of samples the region represents | ||
bool | position_locked () | |
void | raise () | |
void | raise_to_top () | |
void | set_hidden (bool) | |
void | set_initial_position (timepos_t) | |
void | set_length (timecnt_t) | |
void | set_locked (bool) | |
void | set_muted (bool) | |
bool | set_name (std::string) | |
Note: changing the name of a Region does not constitute an edit | ||
void | set_opaque (bool) | |
void | set_position (timepos_t) | |
void | set_position_locked (bool) | |
void | set_start (timepos_t) | |
void | set_sync_position (timepos_t) | |
void | set_video_locked (bool) | |
float | shift () | |
Source | source (unsigned int) | |
timepos_t | start () | |
float | stretch () | |
bool | sync_marked () | |
LuaTable(timecnt_t, ...) | sync_offset (int&) | |
timepos_t | sync_position () | |
Returns Sync position in session time | ||
Int64List | transients () | |
void | trim_end (timepos_t) | |
void | trim_front (timepos_t) | |
void | trim_to (timepos_t, timecnt_t) | |
bool | video_locked () | |
bool | whole_file () | |
Cast | ||
AudioRegion | to_audioregion () | |
MidiRegion | to_midiregion () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
↠ ARDOUR:AudioRom
C‡: boost::shared_ptr< ARDOUR::AudioRom >, boost::weak_ptr< ARDOUR::AudioRom >
is-a: ARDOUR:Readable
Methods | ||
---|---|---|
bool | isnil () | |
AudioRom | new_rom (FloatArray, unsigned long) |
Inherited from ARDOUR:Readable
Methods | ||
---|---|---|
ReadableList | load (Session&, std::string) | |
unsigned int | n_channels () | |
long | read (FloatArray, long, long, int) | |
long | readable_length () |
↠ ARDOUR:AudioSource
C‡: boost::shared_ptr< ARDOUR::AudioSource >, boost::weak_ptr< ARDOUR::AudioSource >
is-a: ARDOUR:Source
A named object associated with a Session. Objects derived from this class are expected to be destroyed before the session calls drop_references().
Methods | ||
---|---|---|
std::string | captured_for () | |
bool | empty () | |
bool | isnil () | |
bool | isnil () | |
timepos_t | length () | |
unsigned int | n_channels () | |
unsigned int | n_channels () | |
long | read (FloatArray, long, long, int) | |
long | readable_length () | |
long | readable_length () | |
float | sample_rate () | |
Cast | ||
Readable | to_readable () |
Inherited from ARDOUR:Source
Methods | ||
---|---|---|
std::string | ancestor_name () | |
bool | can_be_analysed () | |
XrunPositions | captured_xruns () | |
bool | has_been_analysed () | |
timepos_t | natural_position () | |
timepos_t | timeline_position () | |
long | timestamp () | |
int | use_count () | |
bool | used () | |
bool | writable () | |
Cast | ||
AudioSource | to_audiosource () | |
FileSource | to_filesource () | |
MidiSource | to_midisource () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
↠ ARDOUR:AudioTrack
C‡: boost::shared_ptr< ARDOUR::AudioTrack >, boost::weak_ptr< ARDOUR::AudioTrack >
is-a: ARDOUR:Track
A track is an route (bus) with a recordable diskstream and related objects relevant to recording, playback and editing.
Specifically a track has a playlist object that describes material to be played from disk, and modifies that object during recording and editing.
Methods | ||
---|---|---|
bool | isnil () |
Inherited from ARDOUR:Track
Constructor | ||
---|---|---|
ℵ | ARDOUR.Track () | |
Methods | ||
Region | bounce (InterThreadInfo&, std::string) | |
bounce track from session start to session end to new region
Returns a new audio region (or nil in case of error) | ||
Region | bounce_range (long, long, InterThreadInfo&, Processor, bool, std::string) | |
Bounce the given range to a new audio region.
Returns a new audio region (or nil in case of error) | ||
bool | bounceable (Processor, bool) | |
Test if the track can be bounced with the given settings. If sends/inserts/returns are present in the signal path or the given track has no audio outputs bouncing is not possible.
Returns true if the track can be bounced, or false otherwise. | ||
bool | can_record () | |
int | find_and_use_playlist (DataType, ID) | |
Playlist | playlist () | |
bool | set_name (std::string) | |
int | use_copy_playlist () | |
int | use_new_playlist (DataType) | |
int | use_playlist (DataType, Playlist, bool) | |
Cast | ||
AudioTrack | to_audio_track () | |
MidiTrack | to_midi_track () |
Inherited from ARDOUR:Route
Methods | ||
---|---|---|
bool | active () | |
int | add_aux_send (Route, Processor) | |
Add an aux send to a route.
| ||
int | add_foldback_send (Route, bool) | |
int | add_processor_by_index (Processor, int, ProcessorStreams, bool) | |
Add a processor to a route such that it ends up with a given index into the visible processors.
Returns 0 on success, non-0 on failure. | ||
bool | add_sidechain (Processor) | |
Amp | amp () | |
std::string | comment () | |
bool | customize_plugin_insert (Processor, unsigned int, ChanCount, ChanCount) | |
enable custom plugin-insert configuration
Returns true if successful | ||
DataType | data_type () | |
IO | input () | |
Delivery | main_outs () | |
the signal processorat at end of the processing chain which produces output | ||
MonitorControl | monitoring_control () | |
MonitorState | monitoring_state () | |
bool | muted () | |
ChanCount | n_inputs () | |
ChanCount | n_outputs () | |
Processor | nth_plugin (unsigned int) | |
Processor | nth_processor (unsigned int) | |
Processor | nth_send (unsigned int) | |
IO | output () | |
PannerShell | panner_shell () | |
PeakMeter | peak_meter () | |
************************************************************* Pure interface begins here************************************************************* | ||
long | playback_latency (bool) | |
int | remove_processor (Processor, ProcessorStreams, bool) | |
remove plugin/processor
Returns 0 on success | ||
int | remove_processors (ProcessorList, ProcessorStreams) | |
bool | remove_sidechain (Processor) | |
int | reorder_processors (ProcessorList, ProcessorStreams) | |
int | replace_processor (Processor, Processor, ProcessorStreams) | |
replace plugin/processor with another
Returns 0 on success | ||
bool | reset_plugin_insert (Processor) | |
reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused)
Returns true if successful | ||
void | set_active (bool, void*) | |
void | set_comment (std::string, void*) | |
void | set_meter_point (MeterPoint) | |
bool | set_strict_io (bool) | |
long | signal_latency () | |
bool | soloed () | |
bool | strict_io () | |
Processor | the_instrument () | |
Return the first processor that accepts has at least one MIDI input and at least one audio output. In the vast majority of cases, this will be "the instrument". This does not preclude other MIDI->audio processors later in the processing chain, but that would be a special case not covered by this utility function. | ||
Amp | trim () | |
Cast | ||
Track | to_track () |
Inherited from ARDOUR:Stripable
Methods | ||
---|---|---|
AutomationControl | comp_enable_controllable () | |
AutomationControl | comp_makeup_controllable () | |
AutomationControl | comp_mode_controllable () | |
std::string | comp_mode_name (unsigned int) | |
ReadOnlyControl | comp_redux_controllable () | |
AutomationControl | comp_speed_controllable () | |
std::string | comp_speed_name (unsigned int) | |
AutomationControl | comp_threshold_controllable () | |
unsigned int | eq_band_cnt () | |
std::string | eq_band_name (unsigned int) | |
AutomationControl | eq_enable_controllable () | |
AutomationControl | eq_freq_controllable (unsigned int) | |
AutomationControl | eq_gain_controllable (unsigned int) | |
AutomationControl | eq_q_controllable (unsigned int) | |
AutomationControl | eq_shape_controllable (unsigned int) | |
AutomationControl | filter_enable_controllable (bool) | |
AutomationControl | filter_freq_controllable (bool) | |
AutomationControl | filter_slope_controllable (bool) | |
GainControl | gain_control () | |
bool | is_auditioner () | |
bool | is_hidden () | |
bool | is_master () | |
bool | is_monitor () | |
bool | is_private_route () | |
bool | is_selected () | |
AutomationControl | master_send_enable_controllable () | |
MonitorProcessor | monitor_control () | |
MuteControl | mute_control () | |
AutomationControl | pan_azimuth_control () | |
AutomationControl | pan_elevation_control () | |
AutomationControl | pan_frontback_control () | |
AutomationControl | pan_lfe_control () | |
AutomationControl | pan_width_control () | |
PhaseControl | phase_control () | |
PresentationInfo | presentation_info_ptr () | |
AutomationControl | rec_enable_control () | |
AutomationControl | rec_safe_control () | |
AutomationControl | send_enable_controllable (unsigned int) | |
AutomationControl | send_level_controllable (unsigned int) | |
std::string | send_name (unsigned int) | |
AutomationControl | send_pan_azimuth_controllable (unsigned int) | |
AutomationControl | send_pan_azimuth_enable_controllable (unsigned int) | |
void | set_presentation_order (unsigned int) | |
bool | slaved () | |
bool | slaved_to (VCA) | |
SoloControl | solo_control () | |
SoloIsolateControl | solo_isolate_control () | |
SoloSafeControl | solo_safe_control () | |
GainControl | trim_control () | |
Cast | ||
Automatable | to_automatable () | |
Route | to_route () | |
Slavable | to_slavable () | |
VCA | to_vca () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
∁ ARDOUR:AudioTrackList
C‡: std::list<boost::shared_ptr<ARDOUR::AudioTrack> >
Constructor | ||
---|---|---|
ℂ | ARDOUR.AudioTrackList () | |
Methods | ||
LuaTable | add (LuaTable {AudioTrack}) | |
AudioTrack | back () | |
bool | empty () | |
AudioTrack | front () | |
LuaIter | iter () | |
void | push_back (AudioTrack) | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () | |
void | unique () |
↠ ARDOUR:Automatable
C‡: boost::shared_ptr< ARDOUR::Automatable >, boost::weak_ptr< ARDOUR::Automatable >
is-a: Evoral:ControlSet
Methods | ||
---|---|---|
ParameterList | all_automatable_params () | |
API for Lua binding | ||
AutomationControl | automation_control (Parameter, bool) | |
bool | isnil () | |
Cast | ||
Slavable | to_slavable () |
↠ ARDOUR:AutomatableSequence
C‡: boost::shared_ptr< ARDOUR::AutomatableSequence<Temporal::Beats> >, boost::weak_ptr< ARDOUR::AutomatableSequence<Temporal::Beats> >
is-a: ARDOUR:Automatable
Methods | ||
---|---|---|
bool | isnil () | |
Cast | ||
Sequence | to_sequence () |
Inherited from ARDOUR:Automatable
Methods | ||
---|---|---|
ParameterList | all_automatable_params () | |
API for Lua binding | ||
AutomationControl | automation_control (Parameter, bool) | |
Cast | ||
Slavable | to_slavable () |
↠ ARDOUR:AutomationControl
C‡: boost::shared_ptr< ARDOUR::AutomationControl >, boost::weak_ptr< ARDOUR::AutomationControl >
is-a: PBD:Controllable
A PBD::Controllable with associated automation data (AutomationList)
Methods | ||
---|---|---|
AutomationList | alist () | |
AutoState | automation_state () | |
ParameterDescriptor | desc () | |
double | get_value () | |
Get `internal' value Returns raw value as used for the plugin/processor control port | ||
bool | isnil () | |
double | lower () | |
double | normal () | |
void | set_automation_state (AutoState) | |
void | set_value (double, GroupControlDisposition) | |
Set `internal' value All derived classes must implement this. Basic derived classes will ignore group_override but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.
| ||
void | start_touch (timepos_t) | |
void | stop_touch (timepos_t) | |
bool | toggled () | |
double | upper () | |
bool | writable () | |
Cast | ||
Control | to_ctrl () | |
SlavableAutomationControl | to_slavable () |
Inherited from PBD:Controllable
Methods | ||
---|---|---|
void | dump_registry () | |
std::string | name () | |
ControllableSet | registered_controllables () | |
Cast | ||
AutomationControl | to_automationcontrol () | |
MPGainControl | to_mpgain () | |
MPToggleControl | to_mptoggle () |
Inherited from PBD:StatefulPtr
Methods | ||
---|---|---|
void | clear_changes () | |
Forget about any changes to this object's properties | ||
ID | id () | |
OwnedPropertyList | properties () |
↠ ARDOUR:AutomationList
C‡: boost::shared_ptr< ARDOUR::AutomationList >, boost::weak_ptr< ARDOUR::AutomationList >
is-a: Evoral:ControlList
AutomationList is a stateful wrapper around Evoral::ControlList. It includes session-specifics (such as automation state), control logic (e.g. touch, signals) and acts as proxy to the underlying ControlList which holds the actual data.
Methods | ||
---|---|---|
XMLNode | get_state () | |
bool | isnil () | |
Command | memento_command (XMLNode, XMLNode) | |
bool | touch_enabled () | |
bool | touching () | |
bool | writing () | |
Cast | ||
ControlList | list () | |
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
Inherited from Evoral:ControlList
Methods | ||
---|---|---|
void | add (timepos_t, double, bool, bool) | |
void | clear (timepos_t, timepos_t) | |
void | clear_list () | |
bool | editor_add (timepos_t, double, bool) | |
double | eval (timepos_t) | |
EventList | events () | |
Returns the list of events | ||
bool | in_write_pass () | |
Returns true if transport is running and this list is in write mode | ||
InterpolationStyle | interpolation () | |
query interpolation style of the automation data Returns Interpolation Style | ||
LuaTable(double, ...) | rt_safe_eval (timepos_t, bool&) | |
bool | set_interpolation (InterpolationStyle) | |
Sets the interpolation style of the automation data. This will fail when asking for Logarithmic scale and min,max crosses 0 or Exponential scale with min != 0.
Returns true if style change was successful | ||
unsigned long | size () | |
void | thin (double) | |
Thin the number of events in this list. The thinning factor corresponds to the area of a triangle computed between three points in the list (time-difference * value-difference). If the area is large, it indicates significant non-linearity between the points. Time is measured in samples, value is usually normalized to 0..1. During automation recording we thin the recorded points using this value. If a point is sufficiently co-linear with its neighbours (as defined by the area of the triangle formed by three of them), we will not include it in the list. The larger the value, the more points are excluded, so this effectively measures the amount of thinning to be done.
| ||
void | truncate_end (timepos_t) | |
void | truncate_start (timecnt_t) | |
Cast | ||
AutomationList | to_automationlist () |
∁ ARDOUR:AutomationTypeSet
C‡: std::set<ARDOUR::AutomationType >
Constructor | ||
---|---|---|
ℂ | ARDOUR.AutomationTypeSet () | |
Methods | ||
void | clear () | |
bool | empty () | |
LuaIter | iter () | |
unsigned long | size () | |
LuaTable | table () |
∁ ARDOUR:BackendVector
C‡: std::vector<ARDOUR::AudioBackendInfo const* >
Constructor | ||
---|---|---|
ℂ | ARDOUR.BackendVector () | |
Methods | ||
AudioBackendInfo | at (unsigned long) | |
bool | empty () | |
LuaIter | iter () | |
unsigned long | size () | |
LuaTable | table () |
∁ ARDOUR:BufferSet
C‡: ARDOUR::BufferSet
A set of buffers of various types.
These are mainly accessed from Session and passed around as scratch buffers (eg as parameters to run() methods) to do in-place signal processing.
There are two types of counts associated with a BufferSet - available, and the 'use count'. Available is the actual number of allocated buffers (and so is the maximum acceptable value for the use counts).
The use counts are how things determine the form of their input and inform others the form of their output (eg what they did to the BufferSet). Setting the use counts is realtime safe.
Methods | ||
---|---|---|
ChanCount | available () | |
ChanCount | count () | |
AudioBuffer | get_audio (unsigned long) | |
MidiBuffer | get_midi (unsigned long) |
↠ ARDOUR:Bundle
C‡: boost::shared_ptr< ARDOUR::Bundle >, boost::weak_ptr< ARDOUR::Bundle >
A set of `channels', each of which is associated with 0 or more ports. Each channel has a name which can be anything useful, and a data type. Intended for grouping things like, for example, a buss' outputs. `Channel' is a rather overloaded term but I can't think of a better one right now.
Methods | ||
---|---|---|
std::string | channel_name (unsigned int) | |
Returns Channel name. | ||
bool | isnil () | |
unsigned int | n_total () | |
std::string | name () | |
Returns Bundle name | ||
ChanCount | nchannels () | |
Returns Number of channels that this Bundle has | ||
bool | ports_are_inputs () | |
bool | ports_are_outputs () | |
Cast | ||
UserBundle | to_userbundle () |
∁ ARDOUR:BundleListPtr
C‡: boost::shared_ptr<std::vector<boost::shared_ptr<ARDOUR::Bundle> > >
Constructor | ||
---|---|---|
ℂ | ARDOUR.BundleListPtr () | |
Methods | ||
LuaTable | add (LuaTable {Bundle}) | |
Bundle | at (unsigned long) | |
bool | empty () | |
LuaIter | iter () | |
void | push_back (Bundle) | |
unsigned long | size () | |
LuaTable | table () |
∁ ARDOUR:ChanCount
C‡: ARDOUR::ChanCount
A count of channels, possibly with many types.
Operators are defined so this may safely be used as if it were a simple (single-typed) integer count of channels.
Constructor | ||
---|---|---|
ℂ | ARDOUR.ChanCount (DataType, unsigned int) | |
Convenience constructor for making single-typed streams (mono, stereo, midi, etc)
| ||
Methods | ||
unsigned int | get (DataType) | |
query channel count for given type
Returns channel count for given type | ||
unsigned int | n_audio () | |
query number of audio channels Returns number of audio channels | ||
unsigned int | n_midi () | |
query number of midi channels Returns number of midi channels | ||
unsigned int | n_total () | |
query total channel count of all data types Returns total channel count (audio + midi) | ||
void | reset () | |
zero count of all data types | ||
void | set (DataType, unsigned int) | |
set channel count for given type
| ||
void | set_audio (unsigned int) | |
set number of audio channels
| ||
void | set_midi (unsigned int) | |
set number of audio channels
|
∁ ARDOUR:ChanMapping
C‡: ARDOUR::ChanMapping
A mapping from one set of channels to another. The general form is 1 source (from), many sinks (to). numeric IDs are used to identify sources and sinks.
for plugins this is used to map "plugin-pin" to "audio-buffer"
Constructor | ||
---|---|---|
ℂ | ARDOUR.ChanMapping () | |
Methods | ||
ChanCount | count () | |
unsigned int | get (DataType, unsigned int) | |
get buffer mapping for given data type and pin
Returns mapped buffer number (or ChanMapping::Invalid) | ||
bool | is_monotonic () | |
Test if this mapping is monotonic (useful to see if inplace processing is feasible) Returns true if the map is a strict monotonic set | ||
unsigned int | n_total () | |
void | set (DataType, unsigned int, unsigned int) | |
set buffer mapping for given data type
|
∁ ARDOUR:ControlList
C‡: std::list<boost::shared_ptr<ARDOUR::AutomationControl> >
Constructor | ||
---|---|---|
ℂ | ARDOUR.ControlList () | |
Methods | ||
LuaTable | add (LuaTable {AutomationControl}) | |
AutomationControl | back () | |
bool | empty () | |
AutomationControl | front () | |
LuaIter | iter () | |
void | push_back (AutomationControl) | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () | |
void | unique () |
∁ ARDOUR:ControlListPtr
C‡: boost::shared_ptr<std::list<boost::shared_ptr<ARDOUR::AutomationControl> > >
Constructor | ||
---|---|---|
ℂ | ARDOUR.ControlListPtr () | |
Methods | ||
LuaTable | add (LuaTable {AutomationControl}) | |
bool | empty () | |
LuaIter | iter () | |
void | push_back (AutomationControl) | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () | |
void | unique () |
∁ ARDOUR:ControllableSet
C‡: std::set<boost::shared_ptr<PBD::Controllable> > >
Constructor | ||
---|---|---|
ℂ | ARDOUR.ControllableSet () | |
Methods | ||
void | clear () | |
bool | empty () | |
LuaIter | iter () | |
unsigned long | size () | |
LuaTable | table () |
ℕ ARDOUR.DSP
Methods | ||
---|---|---|
float | accurate_coefficient_to_dB (float) | |
void | apply_gain_to_buffer (FloatArray, unsigned int, float) | |
float | compute_peak (FloatArray, unsigned int, float) | |
void | copy_vector (FloatArray, FloatArray, unsigned int) | |
float | dB_to_coefficient (float) | |
float | fast_coefficient_to_dB (float) | |
void | find_peaks (FloatArray, unsigned int, FloatArray, FloatArray) | |
float | log_meter (float) | |
non-linear power-scale meter deflection
Returns deflected value | ||
float | log_meter_coeff (float) | |
non-linear power-scale meter deflection
Returns deflected value | ||
void | memset (FloatArray, float, unsigned int) | |
lua wrapper to memset() | ||
void | mix_buffers_no_gain (FloatArray, FloatArray, unsigned int) | |
void | mix_buffers_with_gain (FloatArray, FloatArray, unsigned int, float) | |
void | mmult (FloatArray, FloatArray, unsigned int) | |
matrix multiply multiply every sample of `data' with the corresponding sample at `mult'.
| ||
LuaTable(...) | peaks (FloatArray, float&, float&, unsigned int) | |
void | process_map (BufferSet, ChanCount, ChanMapping, ChanMapping, unsigned int, long) |
∁ ARDOUR:DSP:Biquad
C‡: ARDOUR::DSP::Biquad
Biquad Filter
Constructor | ||
---|---|---|
ℂ | ARDOUR.DSP.Biquad (double) | |
Instantiate Biquad Filter
| ||
Methods | ||
void | compute (Type, double, double, double) | |
setup filter, compute coefficients
| ||
void | configure (Biquad) | |
float | dB_at_freq (float) | |
filter transfer function (filter response for spectrum visualization)
Returns gain at given frequency in dB (clamped to -120..+120) | ||
void | reset () | |
reset filter state | ||
void | run (FloatArray, unsigned int) | |
process audio data
| ||
void | set_coefficients (double, double, double, double, double) |
∁ ARDOUR:DSP:Convolution
C‡: ARDOUR::DSP::Convolution
Constructor | ||
---|---|---|
ℂ | ARDOUR.DSP.Convolution (Session&, unsigned int, unsigned int) | |
Methods | ||
bool | add_impdata (unsigned int, unsigned int, Readable, float, unsigned int, long, long, unsigned int) | |
void | clear_impdata () | |
unsigned int | latency () | |
unsigned int | n_inputs () | |
unsigned int | n_outputs () | |
bool | ready () | |
void | restart () | |
void | run (BufferSet&, ChanMapping, ChanMapping, unsigned int, long) | |
void | run_mono_buffered (FloatArray, unsigned int) | |
void | run_mono_no_latency (FloatArray, unsigned int) |
∁ ARDOUR:DSP:Convolver
C‡: ARDOUR::DSP::Convolver
is-a: ARDOUR:DSP:Convolution
Constructor | ||
---|---|---|
ℂ | ARDOUR.DSP.Convolver (Session&, std::string, IRChannelConfig, IRSettings) | |
Methods | ||
void | run_stereo_buffered (FloatArray, FloatArray, unsigned int) | |
void | run_stereo_no_latency (FloatArray, FloatArray, unsigned int) |
Inherited from ARDOUR:DSP:Convolution
Constructor | ||
---|---|---|
ℂ | ARDOUR.DSP.Convolution (Session&, unsigned int, unsigned int) | |
Methods | ||
bool | add_impdata (unsigned int, unsigned int, Readable, float, unsigned int, long, long, unsigned int) | |
void | clear_impdata () | |
unsigned int | latency () | |
unsigned int | n_inputs () | |
unsigned int | n_outputs () | |
bool | ready () | |
void | restart () | |
void | run (BufferSet&, ChanMapping, ChanMapping, unsigned int, long) | |
void | run_mono_buffered (FloatArray, unsigned int) | |
void | run_mono_no_latency (FloatArray, unsigned int) |
∁ ARDOUR:DSP:DspShm
C‡: ARDOUR::DSP::DspShm
C/C++ Shared Memory
A convenience class representing a C array of float[] or int32_t[] data values. This is useful for lua scripts to perform DSP operations directly using C/C++ with CPU Hardware acceleration.
Access to this memory area is always 4 byte aligned. The data is interpreted either as float or as int.
This memory area can also be shared between different instances or the same lua plugin (DSP, GUI).
Since memory allocation is not realtime safe it should be allocated during dsp_init() or dsp_configure(). The memory is free()ed automatically when the lua instance is destroyed.
Constructor | ||
---|---|---|
ℂ | ARDOUR.DSP.DspShm (unsigned long) | |
Methods | ||
void | allocate (unsigned long) | |
[re] allocate memory in host's memory space
| ||
int | atomic_get_int (unsigned long) | |
atomically read integer at offset This involves a memory barrier. This call is intended for buffers which are shared with another instance.
Returns value at offset | ||
void | atomic_set_int (unsigned long, int) | |
atomically set integer at offset This involves a memory barrier. This call is intended for buffers which are shared with another instance.
| ||
void | clear () | |
clear memory (set to zero) | ||
FloatArray | to_float (unsigned long) | |
access memory as float array
Returns float[] | ||
IntArray | to_int (unsigned long) | |
access memory as integer array
Returns int_32_t[] |
∁ ARDOUR:DSP:FFTSpectrum
C‡: ARDOUR::DSP::FFTSpectrum
Constructor | ||
---|---|---|
ℂ | ARDOUR.DSP.FFTSpectrum (unsigned int, double) | |
Methods | ||
void | execute () | |
process current data in buffer | ||
float | freq_at_bin (unsigned int) | |
float | power_at_bin (unsigned int, float) | |
query
Returns signal power at given bin (in dBFS) | ||
void | set_data_hann (FloatArray, unsigned int, unsigned int) |
∁ ARDOUR:DSP:Generator
C‡: ARDOUR::DSP::Generator
Constructor | ||
---|---|---|
ℂ | ARDOUR.DSP.Generator () | |
Methods | ||
void | run (FloatArray, unsigned int) | |
void | set_type (Type) |
∁ ARDOUR:DSP:IRSettings
C‡: ARDOUR::DSP::Convolver::IRSettings
Constructor | ||
---|---|---|
ℂ | ARDOUR.DSP.IRSettings () | |
Methods | ||
unsigned int | get_channel_delay (unsigned int) | |
float | get_channel_gain (unsigned int) | |
void | set_channel_delay (unsigned int, unsigned int) | |
void | set_channel_gain (unsigned int, float) | |
Data Members | ||
float | gain | |
unsigned int | pre_delay |
∁ ARDOUR:DSP:LTCReader
C‡: ARDOUR::LTCReader
Constructor | ||
---|---|---|
ℂ | ARDOUR.DSP.LTCReader (int, LTC_TV_STANDARD) | |
Methods | ||
LuaTable(long, ...) | read (unsigned int&, unsigned int&, unsigned int&, unsigned int&, long&) | |
void | write (FloatArray, long, long) |
∁ ARDOUR:DSP:LowPass
C‡: ARDOUR::DSP::LowPass
1st order Low Pass filter
Constructor | ||
---|---|---|
ℂ | ARDOUR.DSP.LowPass (double, float) | |
instantiate a LPF
| ||
Methods | ||
void | ctrl (FloatArray, float, unsigned int) | |
filter control data This is useful for parameter smoothing.
| ||
void | proc (FloatArray, unsigned int) | |
process audio data
| ||
void | reset () | |
reset filter state | ||
void | set_cutoff (float) | |
update filter cut-off frequency
|
∁ ARDOUR:DataType
C‡: ARDOUR::DataType
A type of Data Ardour is capable of processing.
The majority of this class is dedicated to conversion to and from various other type representations, simple comparison between then, etc. This code is deliberately 'ugly' so other code doesn't have to be.
Constructor | ||
---|---|---|
ℂ | ARDOUR.DataType (std::string) | |
Methods | ||
DataType | audio () | |
convenience constructor for DataType::AUDIO with managed lifetime Returns DataType::AUDIO | ||
DataType | midi () | |
convenience constructor for DataType::MIDI with managed lifetime Returns DataType::MIDI | ||
DataType | null () | |
convenience constructor for DataType::NIL with managed lifetime Returns DataType::NIL | ||
char* | to_string () | |
Inverse of the from-string constructor |
↠ ARDOUR:DelayLine
C‡: boost::shared_ptr< ARDOUR::DelayLine >, boost::weak_ptr< ARDOUR::DelayLine >
is-a: ARDOUR:Processor
Meters peaks on the input and stores them for access.
Methods | ||
---|---|---|
long | delay () | |
bool | isnil () |
Inherited from ARDOUR:Processor
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
long | capture_offset () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
long | input_latency () | |
ChanCount | input_streams () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
long | signal_latency () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
↠ ARDOUR:Delivery
C‡: boost::shared_ptr< ARDOUR::Delivery >, boost::weak_ptr< ARDOUR::Delivery >
is-a: ARDOUR:IOProcessor
A mixer strip element (Processor) with 1 or 2 IO elements.
Methods | ||
---|---|---|
bool | isnil () | |
PannerShell | panner_shell () |
Inherited from ARDOUR:IOProcessor
Methods | ||
---|---|---|
IO | input () | |
ChanCount | natural_input_streams () | |
ChanCount | natural_output_streams () | |
IO | output () |
Inherited from ARDOUR:Processor
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
long | capture_offset () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
long | input_latency () | |
ChanCount | input_streams () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
long | signal_latency () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
∁ ARDOUR:DeviceStatus
C‡: ARDOUR::AudioBackend::DeviceStatus
used to list device names along with whether or not they are currently available.
Data Members | ||
---|---|---|
bool | available | |
std::string | name |
∁ ARDOUR:DeviceStatusVector
C‡: std::vector<ARDOUR::AudioBackend::DeviceStatus >
Constructor | ||
---|---|---|
ℂ | ARDOUR.DeviceStatusVector () | |
ℂ | ARDOUR.DeviceStatusVector () | |
Methods | ||
LuaTable | add (LuaTable {DeviceStatus}) | |
DeviceStatus | at (unsigned long) | |
void | clear () | |
bool | empty () | |
LuaIter | iter () | |
void | push_back (DeviceStatus) | |
unsigned long | size () | |
LuaTable | table () | |
... | to_array (--lua--) |
↠ ARDOUR:DiskIOProcessor
C‡: boost::shared_ptr< ARDOUR::DiskIOProcessor >, boost::weak_ptr< ARDOUR::DiskIOProcessor >
is-a: ARDOUR:Processor
A mixer strip element - plugin, send, meter, etc
Methods | ||
---|---|---|
bool | isnil () |
Inherited from ARDOUR:Processor
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
long | capture_offset () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
long | input_latency () | |
ChanCount | input_streams () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
long | signal_latency () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
↠ ARDOUR:DiskReader
C‡: boost::shared_ptr< ARDOUR::DiskReader >, boost::weak_ptr< ARDOUR::DiskReader >
is-a: ARDOUR:DiskIOProcessor
A mixer strip element - plugin, send, meter, etc
Methods | ||
---|---|---|
bool | isnil () |
Inherited from ARDOUR:Processor
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
long | capture_offset () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
long | input_latency () | |
ChanCount | input_streams () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
long | signal_latency () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
↠ ARDOUR:DiskWriter
C‡: boost::shared_ptr< ARDOUR::DiskWriter >, boost::weak_ptr< ARDOUR::DiskWriter >
is-a: ARDOUR:DiskIOProcessor
A mixer strip element - plugin, send, meter, etc
Methods | ||
---|---|---|
bool | isnil () |
Inherited from ARDOUR:Processor
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
long | capture_offset () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
long | input_latency () | |
ChanCount | input_streams () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
long | signal_latency () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
∁ ARDOUR:EventList
C‡: std::list<Evoral::ControlEvent* >
Constructor | ||
---|---|---|
ℂ | ARDOUR.EventList () | |
Methods | ||
ControlEvent | back () | |
bool | empty () | |
ControlEvent | front () | |
LuaIter | iter () | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () |
↠ ARDOUR:FileSource
C‡: boost::shared_ptr< ARDOUR::FileSource >, boost::weak_ptr< ARDOUR::FileSource >
is-a: ARDOUR:Source
A source associated with a file on disk somewhere
Methods | ||
---|---|---|
unsigned short | channel () | |
float | gain () | |
bool | isnil () | |
std::string | origin () | |
std::string | path () | |
std::string | take_id () | |
bool | within_session () |
Inherited from ARDOUR:Source
Methods | ||
---|---|---|
std::string | ancestor_name () | |
bool | can_be_analysed () | |
XrunPositions | captured_xruns () | |
bool | empty () | |
bool | has_been_analysed () | |
timepos_t | length () | |
timepos_t | natural_position () | |
timepos_t | timeline_position () | |
long | timestamp () | |
int | use_count () | |
bool | used () | |
bool | writable () | |
Cast | ||
AudioSource | to_audiosource () | |
FileSource | to_filesource () | |
MidiSource | to_midisource () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
∁ ARDOUR:FluidSynth
C‡: ARDOUR::FluidSynth
Constructor | ||
---|---|---|
ℂ | ARDOUR.FluidSynth (float, int) | |
instantiate a Synth
| ||
Methods | ||
bool | load_sf2 (std::string) | |
bool | midi_event (unsigned char*, unsigned long) | |
void | panic () | |
unsigned int | program_count () | |
std::string | program_name (unsigned int) | |
bool | select_program (unsigned int, unsigned char) | |
bool | synth (FloatArray, FloatArray, unsigned int) |
↠ ARDOUR:GainControl
C‡: boost::shared_ptr< ARDOUR::GainControl >, boost::weak_ptr< ARDOUR::GainControl >
is-a: ARDOUR:SlavableAutomationControl
A PBD::Controllable with associated automation data (AutomationList)
Methods | ||
---|---|---|
bool | isnil () |
Inherited from ARDOUR:SlavableAutomationControl
Methods | ||
---|---|---|
void | add_master (AutomationControl) | |
void | clear_masters () | |
int | get_boolean_masters () | |
double | get_masters_value () | |
void | remove_master (AutomationControl) | |
bool | slaved () | |
bool | slaved_to (AutomationControl) |
Inherited from ARDOUR:AutomationControl
Methods | ||
---|---|---|
AutomationList | alist () | |
AutoState | automation_state () | |
ParameterDescriptor | desc () | |
double | get_value () | |
Get `internal' value Returns raw value as used for the plugin/processor control port | ||
double | lower () | |
double | normal () | |
void | set_automation_state (AutoState) | |
void | set_value (double, GroupControlDisposition) | |
Set `internal' value All derived classes must implement this. Basic derived classes will ignore group_override but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.
| ||
void | start_touch (timepos_t) | |
void | stop_touch (timepos_t) | |
bool | toggled () | |
double | upper () | |
bool | writable () | |
Cast | ||
Control | to_ctrl () | |
SlavableAutomationControl | to_slavable () |
Inherited from PBD:Controllable
Methods | ||
---|---|---|
void | dump_registry () | |
std::string | name () | |
ControllableSet | registered_controllables () | |
Cast | ||
AutomationControl | to_automationcontrol () | |
MPGainControl | to_mpgain () | |
MPToggleControl | to_mptoggle () |
Inherited from PBD:StatefulPtr
Methods | ||
---|---|---|
void | clear_changes () | |
Forget about any changes to this object's properties | ||
ID | id () | |
OwnedPropertyList | properties () |
↠ ARDOUR:IO
C‡: boost::shared_ptr< ARDOUR::IO >, boost::weak_ptr< ARDOUR::IO >
is-a: ARDOUR:SessionObjectPtr
A collection of ports (all input or all output) with connections.
An IO can contain ports of varying types, making routes/inserts/etc with varied combinations of types (eg MIDI and audio) possible.
Methods | ||
---|---|---|
bool | active () | |
int | add_port (std::string, void*, DataType) | |
Add a port.
| ||
AudioPort | audio (unsigned int) | |
int | connect (Port, std::string, void*) | |
int | disconnect (Port, std::string, void*) | |
int | disconnect_all (void*) | |
bool | has_port (Port) | |
bool | isnil () | |
long | latency () | |
MidiPort | midi (unsigned int) | |
ChanCount | n_ports () | |
Port | nth (unsigned int) | |
bool | physically_connected () | |
Port | port_by_name (unsigned int) | |
long | public_latency () | |
int | remove_port (Port, void*) |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
↠ ARDOUR:IOProcessor
C‡: boost::shared_ptr< ARDOUR::IOProcessor >, boost::weak_ptr< ARDOUR::IOProcessor >
is-a: ARDOUR:Processor
A mixer strip element (Processor) with 1 or 2 IO elements.
Methods | ||
---|---|---|
IO | input () | |
bool | isnil () | |
ChanCount | natural_input_streams () | |
ChanCount | natural_output_streams () | |
IO | output () |
Inherited from ARDOUR:Processor
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
long | capture_offset () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
long | input_latency () | |
ChanCount | input_streams () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
long | signal_latency () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
∁ ARDOUR:InterThreadInfo
C‡: ARDOUR::InterThreadInfo
Constructor | ||
---|---|---|
ℂ | ARDOUR.InterThreadInfo () | |
Data Members | ||
bool | done | |
float | progress |
↠ ARDOUR:InternalReturn
C‡: boost::shared_ptr< ARDOUR::InternalReturn >, boost::weak_ptr< ARDOUR::InternalReturn >
is-a: ARDOUR:Return
A mixer strip element - plugin, send, meter, etc
Methods | ||
---|---|---|
bool | isnil () |
Inherited from ARDOUR:IOProcessor
Methods | ||
---|---|---|
IO | input () | |
ChanCount | natural_input_streams () | |
ChanCount | natural_output_streams () | |
IO | output () |
Inherited from ARDOUR:Processor
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
long | capture_offset () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
long | input_latency () | |
ChanCount | input_streams () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
long | signal_latency () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
↠ ARDOUR:InternalSend
C‡: boost::shared_ptr< ARDOUR::InternalSend >, boost::weak_ptr< ARDOUR::InternalSend >
is-a: ARDOUR:Send
A mixer strip element (Processor) with 1 or 2 IO elements.
Methods | ||
---|---|---|
bool | allow_feedback () | |
std::string | display_name () | |
bool | feeds (Route) | |
bool | isnil () | |
void | set_allow_feedback (bool) | |
bool | set_name (std::string) | |
Route | source_route () | |
Route | target_route () |
Inherited from ARDOUR:Send
Methods | ||
---|---|---|
GainControl | gain_control () | |
long | get_delay_in () | |
long | get_delay_out () | |
bool | is_foldback () | |
void | set_remove_on_disconnect (bool) | |
Cast | ||
InternalSend | to_internalsend () |
Inherited from ARDOUR:Delivery
Methods | ||
---|---|---|
PannerShell | panner_shell () |
Inherited from ARDOUR:IOProcessor
Methods | ||
---|---|---|
IO | input () | |
ChanCount | natural_input_streams () | |
ChanCount | natural_output_streams () | |
IO | output () |
Inherited from ARDOUR:Processor
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
long | capture_offset () | |
void | deactivate () | |
bool | display_to_user () | |
long | input_latency () | |
ChanCount | input_streams () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
long | signal_latency () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
∁ ARDOUR:LatencyRange
C‡: ARDOUR::LatencyRange
Constructor | ||
---|---|---|
ℂ | ARDOUR.LatencyRange () | |
Data Members | ||
unsigned int | max | |
unsigned int | min |
↠ ARDOUR:Latent
C‡: boost::shared_ptr< ARDOUR::Latent >, boost::weak_ptr< ARDOUR::Latent >
Methods | ||
---|---|---|
long | effective_latency () | |
bool | isnil () | |
void | set_user_latency (long) | |
void | unset_user_latency () | |
long | user_latency () |
∁ ARDOUR:Location
C‡: ARDOUR::Location
is-a: PBD:StatefulDestructible
Location on Timeline - abstract representation for Markers, Loop/Punch Ranges, CD-Markers etc.
Methods | ||
---|---|---|
timepos_t | _end () | |
Flags | flags () | |
bool | is_auto_loop () | |
bool | is_auto_punch () | |
bool | is_cd_marker () | |
bool | is_cue_marker () | |
bool | is_hidden () | |
bool | is_mark () | |
bool | is_range_marker () | |
bool | is_session_range () | |
timecnt_t | length () | |
void | lock () | |
bool | locked () | |
bool | matches (Flags) | |
int | move_to (timepos_t) | |
std::string | name () | |
int | set (timepos_t, timepos_t) | |
int | set_end (timepos_t, bool) | |
int | set_length (timepos_t, timepos_t) | |
void | set_name (std::string) | |
Set location name | ||
int | set_start (timepos_t, bool) | |
timepos_t | start () | |
void | unlock () |
Inherited from PBD:Stateful
Methods | ||
---|---|---|
void | clear_changes () | |
Forget about any changes to this object's properties | ||
ID | id () | |
OwnedPropertyList | properties () |
∁ ARDOUR:LocationList
C‡: std::list<ARDOUR::Location* >
Constructor | ||
---|---|---|
ℂ | ARDOUR.LocationList () | |
Methods | ||
Location | back () | |
bool | empty () | |
Location | front () | |
LuaIter | iter () | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () |
∁ ARDOUR:Locations
C‡: ARDOUR::Locations
is-a: PBD:StatefulDestructible
A collection of session locations including unique dedicated locations (loop, punch, etc)
Methods | ||
---|---|---|
Location | add_range (timepos_t, timepos_t) | |
Location | auto_loop_location () | |
Location | auto_punch_location () | |
LuaTable(...) | find_all_between (timepos_t, timepos_t, LocationList&, Flags) | |
timepos_t | first_mark_after (timepos_t, bool) | |
Location | first_mark_at (timepos_t, timecnt_t) | |
timepos_t | first_mark_before (timepos_t, bool) | |
LocationList | list () | |
Location | mark_at (timepos_t, timecnt_t) | |
LuaTable(...) | marks_either_side (timepos_t, timepos_t&, timepos_t&) | |
Location | range_starts_at (timepos_t, timecnt_t, bool) | |
void | remove (Location) | |
Location | session_range_location () |
Inherited from PBD:Stateful
Methods | ||
---|---|---|
void | clear_changes () | |
Forget about any changes to this object's properties | ||
ID | id () | |
OwnedPropertyList | properties () |
ℕ ARDOUR.LuaAPI
Methods | ||
---|---|---|
std::string | ascii_dtostr (double) | |
... | build_filename (--lua--) | |
Creates a filename from a series of elements using the correct separator for filenames. No attempt is made to force the resulting filename to be an absolute path. If the first element is a relative path, the result will be a relative path. | ||
... | color_to_rgba (--lua--) | |
A convenience function to expand RGBA parameters from an integer convert a Canvas::Color (uint32_t 0xRRGGBBAA) into double RGBA values which can be passed as parameters to Cairo::Context::set_source_rgba Example: local r, g, b, a = ARDOUR.LuaAPI.color_to_rgba (0x88aa44ff) cairo_ctx:set_source_rgba (ARDOUR.LuaAPI.color_to_rgba (0x11336699) Returns 4 parameters: red, green, blue, alpha (in range 0..1) | ||
... | desc_scale_points (--lua--) | |
std::string | dump_untagged_plugins () | |
Write a list of untagged plugins to a file, so we can bulk-tag them Returns path to XML file or empty string on error | ||
StringVector | env () | |
Return system environment variables (POSIX environ) | ||
std::string | file_get_contents (std::string) | |
bool | file_test (std::string, FileTest) | |
LuaTable(float, ...) | get_plugin_insert_param (PluginInsert, unsigned int, bool&) | |
get a plugin control parameter value
Returns value | ||
LuaTable(float, ...) | get_processor_param (Processor, unsigned int, bool&) | |
get a plugin control parameter value
Returns value | ||
... | hsla_to_rgba (--lua--) | |
A convenience function for colorspace HSL to RGB conversion. All ranges are 0..1 Example: local r, g, b, a = ARDOUR.LuaAPI.hsla_to_rgba (hue, saturation, luminosity, alpha) Returns 4 parameters: red, green, blue, alpha (in range 0..1) | ||
PluginInfoList | list_plugins () | |
List all installed plugins | ||
long | monotonic_time () | |
Processor | new_luaproc (Session, std::string) | |
Processor | new_luaproc_with_time_domain (Session, std::string, TimeDomain) | |
create a new Lua Processor (Plugin)
Returns Processor object (may be nil) | ||
NotePtr | new_noteptr (unsigned char, Beats, Beats, unsigned char, unsigned char) | |
Processor | new_plugin (Session, std::string, PluginType, std::string) | |
PluginInfo | new_plugin_info (std::string, PluginType) | |
search a Plugin
Returns PluginInfo or nil if not found | ||
Processor | new_plugin_with_time_domain (Session, std::string, PluginType, TimeDomain, std::string) | |
create a new Plugin Instance
Returns Processor or nil | ||
Processor | new_send (Session, Route, Processor) | |
add a new [external] Send to the given Route
| ||
Processor | nil_proc () | |
NotePtrList | note_list (MidiModel) | |
std::string | path_get_basename (std::string) | |
... | plugin_automation (--lua--) | |
A convenience function to get a Automation Lists and ParameterDescriptor for a given plugin control. This is equivalent to the following lua code function (processor, param_id) local plugininsert = processor:to_insert () local plugin = plugininsert:plugin(0) local _, t = plugin:get_parameter_descriptor(param_id, ARDOUR.ParameterDescriptor ()) local ctrl = Evoral.Parameter (ARDOUR.AutomationType.PluginAutomation, 0, param_id) local ac = pi:automation_control (ctrl, false) local acl = ac:alist() return ac:alist(), ac:to_ctrl():list(), t[2] end Example usage: get the third input parameter of first plugin on the given route (Ardour starts counting at zero). local al, cl, pd = ARDOUR.LuaAPI.plugin_automation (route:nth_plugin (0), 3) Returns 3 parameters: AutomationList, ControlList, ParameterDescriptor | ||
bool | reset_processor_to_default (Processor) | |
reset a processor to its default values (only works for plugins ) This is a wrapper which looks up the Processor by plugin-insert.
Returns true on success, false when the processor is not a plugin | ||
... | sample_to_timecode (--lua--) | |
Generic conversion from audio sample count to timecode. (TimecodeType, sample-rate, sample-pos) | ||
void | segfault () | |
Crash Test Dummy | ||
bool | set_plugin_insert_param (PluginInsert, unsigned int, float) | |
set a plugin control-input parameter value This is a wrapper around set_processor_param which looks up the Processor by plugin-insert.
Returns true on success, false on error or out-of-bounds value | ||
bool | set_processor_param (Processor, unsigned int, float) | |
set a plugin control-input parameter value
Returns true on success, false on error or out-of-bounds value | ||
... | timecode_to_sample (--lua--) | |
Generic conversion from timecode to audio sample count. (TimecodeType, sample-rate, hh, mm, ss, ff) | ||
void | usleep (unsigned long) | |
bool | wait_for_process_callback (unsigned long, long) | |
Delay execution until next prcess cycle starts.
Returns true on success, false if timeout was reached or engine was not running |
∁ ARDOUR:LuaAPI:Rubberband
C‡: ARDOUR::LuaAPI::Rubberband
Constructor | ||
---|---|---|
ℂ | ARDOUR.LuaAPI.Rubberband (AudioRegion, bool) | |
Methods | ||
unsigned int | n_channels () | |
AudioRegion | process (Lua-Function) | |
Readable | readable () | |
long | readable_length () | |
bool | set_mapping (Lua-Function) | |
bool | set_strech_and_pitch (double, double) |
∁ ARDOUR:LuaAPI:Vamp
C‡: ARDOUR::LuaAPI::Vamp
Constructor | ||
---|---|---|
ℂ | ARDOUR.LuaAPI.Vamp (std::string, float) | |
Methods | ||
int | analyze (Readable, unsigned int, Lua-Function) | |
high-level abstraction to process a single channel of the given AudioReadable. If the plugin is not yet initialized, initialize() is called. if fn is not nil, it is called with the immediate Vamp::Plugin::Features on every process call.
Returns 0 on success | ||
bool | initialize () | |
initialize the plugin for use with analyze(). This is equivalent to plugin():initialise (1, ssiz, bsiz) and prepares a plugin for analyze. (by preferred step and block sizes are used. if the plugin does not specify them or they're larger than 8K, both are set to 1024) Manual initialization is only required to set plugin-parameters which depend on prior initialization of the plugin. vamp:reset () vamp:initialize () vamp:plugin():setParameter (0, 1.5, nil) vamp:analyze (r, 0) | ||
StringVector | list_plugins () | |
Plugin | plugin () | |
FeatureSet | process (FloatArrayVector, RealTime) | |
process given array of audio-samples. This is a lua-binding for vamp:plugin():process ()
Returns features extracted from that data (if the plugin is causal) | ||
void | reset () | |
call plugin():reset() and clear initialization flag |
∁ ARDOUR:LuaOSC:Address
C‡: ARDOUR::LuaOSC::Address
OSC transmitter
A Class to send OSC messages.
Constructor | ||
---|---|---|
ℂ | ARDOUR.LuaOSC.Address (std::string) | |
Construct a new OSC transmitter object
| ||
Methods | ||
... | send (--lua--) | |
Transmit an OSC message Path (string) and type (string) must always be given. The number of following args must match the type. Supported types are: 'i': integer (lua number) 'f': float (lua number) 'd': double (lua number) 'h': 64bit integer (lua number) 's': string (lua string) 'c': character (lua string) 'T': boolean (lua bool) -- this is not implicily True, a lua true/false must be given 'F': boolean (lua bool) -- this is not implicily False, a lua true/false must be given
Returns boolean true if successful, false on error. |
↠ ARDOUR:LuaProc
C‡: boost::shared_ptr< ARDOUR::LuaProc >, boost::weak_ptr< ARDOUR::LuaProc >
is-a: ARDOUR:Plugin
A plugin is an external module (usually 3rd party provided) loaded into Ardour for the purpose of digital signal processing.
This class provides an abstraction for methords provided by all supported plugin standards such as presets, name, parameters etc.
Plugins are not used directly in Ardour but always wrapped by a PluginInsert.
Methods | ||
---|---|---|
bool | isnil () | |
DspShm | shmem () | |
LuaTableRef | table () |
Inherited from ARDOUR:Plugin
Methods | ||
---|---|---|
IOPortDescription | describe_io_port (DataType, bool, unsigned int) | |
std::string | get_docs () | |
PluginInfo | get_info () | |
LuaTable(int, ...) | get_parameter_descriptor (unsigned int, ParameterDescriptor&) | |
std::string | get_parameter_docs (unsigned int) | |
char* | label () | |
PresetRecord | last_preset () | |
Returns Last preset to be requested; the settings may have been changed since; find out with parameter_changed_since_last_preset. | ||
bool | load_preset (PresetRecord) | |
Set parameters using a preset | ||
char* | maker () | |
char* | name () | |
LuaTable(unsigned int, ...) | nth_parameter (unsigned int, bool&) | |
unsigned int | parameter_count () | |
bool | parameter_is_audio (unsigned int) | |
bool | parameter_is_control (unsigned int) | |
bool | parameter_is_input (unsigned int) | |
bool | parameter_is_output (unsigned int) | |
std::string | parameter_label (unsigned int) | |
PresetRecord | preset_by_label (std::string) | |
PresetRecord | preset_by_uri (std::string) | |
void | remove_preset (std::string) | |
PresetRecord | save_preset (std::string) | |
Create a new plugin-preset from the current state
Returns PresetRecord with empty URI on failure | ||
std::string | unique_id () | |
Cast | ||
LuaProc | to_luaproc () |
Inherited from PBD:StatefulPtr
Methods | ||
---|---|---|
void | clear_changes () | |
Forget about any changes to this object's properties | ||
ID | id () | |
OwnedPropertyList | properties () |
∁ ARDOUR:LuaTableRef
C‡: ARDOUR::LuaTableRef
Methods | ||
---|---|---|
... | get (--lua--) | |
... | set (--lua--) |
∁ ARDOUR:MIDIPortMeters
C‡: std::map<std::string, ARDOUR::PortManager::MPM >
Constructor | ||
---|---|---|
ℂ | ARDOUR.MIDIPortMeters () | |
Methods | ||
LuaTable | add (std::string, ARDOUR::PortManager::MPM ) | |
... | at (--lua--) | |
void | clear () | |
unsigned long | count (std::string) | |
bool | empty () | |
LuaIter | iter () | |
unsigned long | size () | |
LuaTable | table () |
↠ ARDOUR:MPGainControl
C‡: boost::shared_ptr< ARDOUR::MPControl<float> >, boost::weak_ptr< ARDOUR::MPControl<float> >
is-a: PBD:Controllable
Methods | ||
---|---|---|
std::string | get_user_string () | |
double | get_value () | |
bool | isnil () | |
double | lower () | |
double | normal () | |
void | set_value (double, GroupControlDisposition) | |
double | upper () |
Inherited from PBD:Controllable
Methods | ||
---|---|---|
void | dump_registry () | |
std::string | name () | |
ControllableSet | registered_controllables () | |
Cast | ||
AutomationControl | to_automationcontrol () | |
MPGainControl | to_mpgain () | |
MPToggleControl | to_mptoggle () |
Inherited from PBD:StatefulPtr
Methods | ||
---|---|---|
void | clear_changes () | |
Forget about any changes to this object's properties | ||
ID | id () | |
OwnedPropertyList | properties () |
↠ ARDOUR:MPToggleControl
C‡: boost::shared_ptr< ARDOUR::MPControl<bool> >, boost::weak_ptr< ARDOUR::MPControl<bool> >
is-a: PBD:Controllable
Methods | ||
---|---|---|
std::string | get_user_string () | |
double | get_value () | |
bool | isnil () | |
double | lower () | |
double | normal () | |
void | set_value (double, GroupControlDisposition) | |
Set `internal' value All derived classes must implement this. Basic derived classes will ignore group_override but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.
| ||
double | upper () |
Inherited from PBD:Controllable
Methods | ||
---|---|---|
void | dump_registry () | |
std::string | name () | |
ControllableSet | registered_controllables () | |
Cast | ||
AutomationControl | to_automationcontrol () | |
MPGainControl | to_mpgain () | |
MPToggleControl | to_mptoggle () |
Inherited from PBD:StatefulPtr
Methods | ||
---|---|---|
void | clear_changes () | |
Forget about any changes to this object's properties | ||
ID | id () | |
OwnedPropertyList | properties () |
∁ ARDOUR:MidiBuffer
C‡: ARDOUR::MidiBuffer
Buffer containing 8-bit unsigned char (MIDI) data.
Methods | ||
---|---|---|
void | copy (MidiBuffer) | |
bool | empty () | |
bool | push_back (long, EventType, unsigned long, unsigned char*) | |
bool | push_event (Event) | |
void | resize (unsigned long) | |
Reallocate the buffer used internally to handle at least size_t units of data. The buffer is not silent after this operation. the capacity argument passed to the constructor must have been non-zero. | ||
void | silence (long, long) | |
Clear (eg zero, or empty) buffer | ||
unsigned long | size () | |
... | table (--lua--) |
↠ ARDOUR:MidiModel
C‡: boost::shared_ptr< ARDOUR::MidiModel >, boost::weak_ptr< ARDOUR::MidiModel >
is-a: ARDOUR:AutomatableSequence
This is a higher level (than MidiBuffer) model of MIDI data, with separate representations for notes (instead of just unassociated note on/off events) and controller data. Controller data is represented as part of the Automatable base (i.e. in a map of AutomationList, keyed by Parameter). Because of this MIDI controllers and automatable controllers/widgets/etc are easily interchangeable.
Methods | ||
---|---|---|
void | apply_command (Session, Command) | |
void | apply_diff_command_as_commit (Session, Command) | |
bool | isnil () | |
NoteDiffCommand | new_note_diff_command (std::string) | |
Start a new NoteDiff command. This has no side-effects on the model or Session, the returned command can be held on to for as long as the caller wishes, or discarded without formality, until apply_diff_command_* is called and ownership is taken. |
Inherited from ARDOUR:AutomatableSequence
Cast | ||
---|---|---|
Sequence | to_sequence () |
Inherited from ARDOUR:Automatable
Methods | ||
---|---|---|
ParameterList | all_automatable_params () | |
API for Lua binding | ||
AutomationControl | automation_control (Parameter, bool) | |
Cast | ||
Slavable | to_slavable () |
∅ ARDOUR:MidiModel:DiffCommand
C‡: ARDOUR::MidiModel::DiffCommand
is-a: PBD:Command
Base class for Undo/Redo commands and changesets
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
Inherited from PBD:Command
Methods | ||
---|---|---|
std::string | name () | |
void | set_name (std::string) |
Inherited from PBD:Stateful
Methods | ||
---|---|---|
void | clear_changes () | |
Forget about any changes to this object's properties | ||
ID | id () | |
OwnedPropertyList | properties () |
∁ ARDOUR:MidiModel:NoteDiffCommand
C‡: ARDOUR::MidiModel::NoteDiffCommand
is-a: ARDOUR:MidiModel:DiffCommand
Base class for Undo/Redo commands and changesets
Methods | ||
---|---|---|
void | add (NotePtr) | |
void | remove (NotePtr) |
Inherited from PBD:Command
Methods | ||
---|---|---|
std::string | name () | |
void | set_name (std::string) |
Inherited from PBD:Stateful
Methods | ||
---|---|---|
void | clear_changes () | |
Forget about any changes to this object's properties | ||
ID | id () | |
OwnedPropertyList | properties () |
↠ ARDOUR:MidiPlaylist
C‡: boost::shared_ptr< ARDOUR::MidiPlaylist >, boost::weak_ptr< ARDOUR::MidiPlaylist >
is-a: ARDOUR:Playlist
A named object associated with a Session. Objects derived from this class are expected to be destroyed before the session calls drop_references().
Methods | ||
---|---|---|
bool | isnil () | |
void | set_note_mode (NoteMode) |
Inherited from ARDOUR:Playlist
Methods | ||
---|---|---|
void | add_region (Region, timepos_t, float, bool) | |
Region | combine (RegionList, Track) | |
unsigned int | count_regions_at (timepos_t) | |
Playlist | cut (TimelineRangeList&, bool) | |
DataType | data_type () | |
void | duplicate (Region, timepos_t&, timecnt_t, float) | |
void | duplicate_range (TimelineRange&, float) | |
void | duplicate_until (Region, timepos_t&, timecnt_t, timepos_t) | |
bool | empty () | |
Region | find_next_region (timepos_t, RegionPoint, int) | |
timepos_t | find_next_region_boundary (timepos_t, int) | |
long | find_next_transient (timepos_t, int) | |
ID | get_orig_track_id () | |
bool | hidden () | |
void | lower_region (Region) | |
void | lower_region_to_bottom (Region) | |
unsigned int | n_regions () | |
void | raise_region (Region) | |
void | raise_region_to_top (Region) | |
Region | region_by_id (ID) | |
RegionListPtr | region_list () | |
RegionListPtr | regions_at (timepos_t) | |
RegionListPtr | regions_touched (timepos_t, timepos_t) | |
RegionListPtr | regions_with_end_within (Range) | |
RegionListPtr | regions_with_start_within (Range) | |
void | remove_region (Region) | |
bool | set_name (std::string) | |
bool | shared () | |
void | split_region (Region, timepos_t) | |
Region | top_region_at (timepos_t) | |
Region | top_unmuted_region_at (timepos_t) | |
void | uncombine (Region) | |
bool | used () | |
Cast | ||
AudioPlaylist | to_audioplaylist () | |
MidiPlaylist | to_midiplaylist () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
↠ ARDOUR:MidiPort
C‡: boost::shared_ptr< ARDOUR::MidiPort >, boost::weak_ptr< ARDOUR::MidiPort >
is-a: ARDOUR:Port
Methods | ||
---|---|---|
MidiBuffer | get_midi_buffer (unsigned int) | |
bool | input_active () | |
bool | isnil () | |
void | set_input_active (bool) | |
Cast | ||
AsyncMIDIPort | to_asyncmidiport () |
Inherited from ARDOUR:Port
Methods | ||
---|---|---|
int | connect (std::string) | |
bool | connected () | |
Returns true if this port is connected to anything | ||
bool | connected_to (std::string) | |
Returns true if this port is connected to o, otherwise false. | ||
int | disconnect (std::string) | |
int | disconnect_all () | |
PortFlags | flags () | |
Returns flags | ||
LuaTable(...) | get_connected_latency_range (LatencyRange&, bool) | |
std::string | name () | |
Returns Port short name | ||
bool | physically_connected () | |
std::string | pretty_name (bool) | |
Returns Port human readable name | ||
LatencyRange | private_latency_range (bool) | |
LatencyRange | public_latency_range (bool) | |
bool | receives_input () | |
Returns true if this Port receives input, otherwise false | ||
bool | sends_output () | |
Returns true if this Port sends output, otherwise false | ||
Cast | ||
AsyncMIDIPort | to_asyncmidiport () | |
AudioPort | to_audioport () | |
MidiPort | to_midiport () |
↠ ARDOUR:MidiRegion
C‡: boost::shared_ptr< ARDOUR::MidiRegion >, boost::weak_ptr< ARDOUR::MidiRegion >
is-a: ARDOUR:Region
A named object associated with a Session. Objects derived from this class are expected to be destroyed before the session calls drop_references().
Methods | ||
---|---|---|
bool | do_export (std::string) | |
Export the MIDI data of the MidiRegion to a new MIDI file (SMF). | ||
bool | isnil () | |
MidiSource | midi_source (unsigned int) | |
MidiModel | model () |
Inherited from ARDOUR:Region
Methods | ||
---|---|---|
bool | at_natural_position () | |
bool | automatic () | |
bool | can_move () | |
bool | captured () | |
void | captured_xruns (XrunPositions&, bool) | |
void | clear_sync_position () | |
Control | control (Parameter, bool) | |
bool | covers (timepos_t) | |
void | cut_end (timepos_t) | |
void | cut_front (timepos_t) | |
DataType | data_type () | |
bool | external () | |
bool | has_transients () | |
bool | hidden () | |
bool | import () | |
bool | is_compound () | |
unsigned int | layer () | |
timecnt_t | length () | |
bool | locked () | |
void | lower () | |
void | lower_to_bottom () | |
StringVector | master_source_names () | |
SourceList | master_sources () | |
void | move_start (timecnt_t) | |
void | move_to_natural_position () | |
bool | muted () | |
void | nudge_position (timecnt_t) | |
bool | opaque () | |
Playlist | playlist () | |
timepos_t | position () | |
How the region parameters play together: POSITION: first sample of the region along the timeline START: first sample of the region within its source(s) LENGTH: number of samples the region represents | ||
bool | position_locked () | |
void | raise () | |
void | raise_to_top () | |
void | set_hidden (bool) | |
void | set_initial_position (timepos_t) | |
void | set_length (timecnt_t) | |
void | set_locked (bool) | |
void | set_muted (bool) | |
bool | set_name (std::string) | |
Note: changing the name of a Region does not constitute an edit | ||
void | set_opaque (bool) | |
void | set_position (timepos_t) | |
void | set_position_locked (bool) | |
void | set_start (timepos_t) | |
void | set_sync_position (timepos_t) | |
void | set_video_locked (bool) | |
float | shift () | |
Source | source (unsigned int) | |
timepos_t | start () | |
float | stretch () | |
bool | sync_marked () | |
LuaTable(timecnt_t, ...) | sync_offset (int&) | |
timepos_t | sync_position () | |
Returns Sync position in session time | ||
Int64List | transients () | |
void | trim_end (timepos_t) | |
void | trim_front (timepos_t) | |
void | trim_to (timepos_t, timecnt_t) | |
bool | video_locked () | |
bool | whole_file () | |
Cast | ||
AudioRegion | to_audioregion () | |
MidiRegion | to_midiregion () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
↠ ARDOUR:MidiSource
C‡: boost::shared_ptr< ARDOUR::MidiSource >, boost::weak_ptr< ARDOUR::MidiSource >
is-a: ARDOUR:Source
Source for MIDI data
Methods | ||
---|---|---|
bool | empty () | |
bool | isnil () | |
timepos_t | length () | |
MidiModel | model () |
Inherited from ARDOUR:Source
Methods | ||
---|---|---|
std::string | ancestor_name () | |
bool | can_be_analysed () | |
XrunPositions | captured_xruns () | |
bool | has_been_analysed () | |
timepos_t | natural_position () | |
timepos_t | timeline_position () | |
long | timestamp () | |
int | use_count () | |
bool | used () | |
bool | writable () | |
Cast | ||
AudioSource | to_audiosource () | |
FileSource | to_filesource () | |
MidiSource | to_midisource () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
↠ ARDOUR:MidiTrack
C‡: boost::shared_ptr< ARDOUR::MidiTrack >, boost::weak_ptr< ARDOUR::MidiTrack >
is-a: ARDOUR:Track
A track is an route (bus) with a recordable diskstream and related objects relevant to recording, playback and editing.
Specifically a track has a playlist object that describes material to be played from disk, and modifies that object during recording and editing.
Methods | ||
---|---|---|
unsigned short | get_capture_channel_mask () | |
ChannelMode | get_capture_channel_mode () | |
ChannelMode | get_playback_channel_mask () | |
ChannelMode | get_playback_channel_mode () | |
bool | input_active () | |
bool | isnil () | |
void | set_capture_channel_mask (unsigned short) | |
void | set_capture_channel_mode (ChannelMode, unsigned short) | |
void | set_input_active (bool) | |
void | set_playback_channel_mask (unsigned short) | |
void | set_playback_channel_mode (ChannelMode, unsigned short) | |
bool | write_immediate_event (EventType, unsigned long, unsigned char*) |
Inherited from ARDOUR:Track
Constructor | ||
---|---|---|
ℵ | ARDOUR.Track () | |
Methods | ||
Region | bounce (InterThreadInfo&, std::string) | |
bounce track from session start to session end to new region
Returns a new audio region (or nil in case of error) | ||
Region | bounce_range (long, long, InterThreadInfo&, Processor, bool, std::string) | |
Bounce the given range to a new audio region.
Returns a new audio region (or nil in case of error) | ||
bool | bounceable (Processor, bool) | |
Test if the track can be bounced with the given settings. If sends/inserts/returns are present in the signal path or the given track has no audio outputs bouncing is not possible.
Returns true if the track can be bounced, or false otherwise. | ||
bool | can_record () | |
int | find_and_use_playlist (DataType, ID) | |
Playlist | playlist () | |
bool | set_name (std::string) | |
int | use_copy_playlist () | |
int | use_new_playlist (DataType) | |
int | use_playlist (DataType, Playlist, bool) | |
Cast | ||
AudioTrack | to_audio_track () | |
MidiTrack | to_midi_track () |
Inherited from ARDOUR:Route
Methods | ||
---|---|---|
bool | active () | |
int | add_aux_send (Route, Processor) | |
Add an aux send to a route.
| ||
int | add_foldback_send (Route, bool) | |
int | add_processor_by_index (Processor, int, ProcessorStreams, bool) | |
Add a processor to a route such that it ends up with a given index into the visible processors.
Returns 0 on success, non-0 on failure. | ||
bool | add_sidechain (Processor) | |
Amp | amp () | |
std::string | comment () | |
bool | customize_plugin_insert (Processor, unsigned int, ChanCount, ChanCount) | |
enable custom plugin-insert configuration
Returns true if successful | ||
DataType | data_type () | |
IO | input () | |
Delivery | main_outs () | |
the signal processorat at end of the processing chain which produces output | ||
MonitorControl | monitoring_control () | |
MonitorState | monitoring_state () | |
bool | muted () | |
ChanCount | n_inputs () | |
ChanCount | n_outputs () | |
Processor | nth_plugin (unsigned int) | |
Processor | nth_processor (unsigned int) | |
Processor | nth_send (unsigned int) | |
IO | output () | |
PannerShell | panner_shell () | |
PeakMeter | peak_meter () | |
************************************************************* Pure interface begins here************************************************************* | ||
long | playback_latency (bool) | |
int | remove_processor (Processor, ProcessorStreams, bool) | |
remove plugin/processor
Returns 0 on success | ||
int | remove_processors (ProcessorList, ProcessorStreams) | |
bool | remove_sidechain (Processor) | |
int | reorder_processors (ProcessorList, ProcessorStreams) | |
int | replace_processor (Processor, Processor, ProcessorStreams) | |
replace plugin/processor with another
Returns 0 on success | ||
bool | reset_plugin_insert (Processor) | |
reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused)
Returns true if successful | ||
void | set_active (bool, void*) | |
void | set_comment (std::string, void*) | |
void | set_meter_point (MeterPoint) | |
bool | set_strict_io (bool) | |
long | signal_latency () | |
bool | soloed () | |
bool | strict_io () | |
Processor | the_instrument () | |
Return the first processor that accepts has at least one MIDI input and at least one audio output. In the vast majority of cases, this will be "the instrument". This does not preclude other MIDI->audio processors later in the processing chain, but that would be a special case not covered by this utility function. | ||
Amp | trim () | |
Cast | ||
Track | to_track () |
Inherited from ARDOUR:Stripable
Methods | ||
---|---|---|
AutomationControl | comp_enable_controllable () | |
AutomationControl | comp_makeup_controllable () | |
AutomationControl | comp_mode_controllable () | |
std::string | comp_mode_name (unsigned int) | |
ReadOnlyControl | comp_redux_controllable () | |
AutomationControl | comp_speed_controllable () | |
std::string | comp_speed_name (unsigned int) | |
AutomationControl | comp_threshold_controllable () | |
unsigned int | eq_band_cnt () | |
std::string | eq_band_name (unsigned int) | |
AutomationControl | eq_enable_controllable () | |
AutomationControl | eq_freq_controllable (unsigned int) | |
AutomationControl | eq_gain_controllable (unsigned int) | |
AutomationControl | eq_q_controllable (unsigned int) | |
AutomationControl | eq_shape_controllable (unsigned int) | |
AutomationControl | filter_enable_controllable (bool) | |
AutomationControl | filter_freq_controllable (bool) | |
AutomationControl | filter_slope_controllable (bool) | |
GainControl | gain_control () | |
bool | is_auditioner () | |
bool | is_hidden () | |
bool | is_master () | |
bool | is_monitor () | |
bool | is_private_route () | |
bool | is_selected () | |
AutomationControl | master_send_enable_controllable () | |
MonitorProcessor | monitor_control () | |
MuteControl | mute_control () | |
AutomationControl | pan_azimuth_control () | |
AutomationControl | pan_elevation_control () | |
AutomationControl | pan_frontback_control () | |
AutomationControl | pan_lfe_control () | |
AutomationControl | pan_width_control () | |
PhaseControl | phase_control () | |
PresentationInfo | presentation_info_ptr () | |
AutomationControl | rec_enable_control () | |
AutomationControl | rec_safe_control () | |
AutomationControl | send_enable_controllable (unsigned int) | |
AutomationControl | send_level_controllable (unsigned int) | |
std::string | send_name (unsigned int) | |
AutomationControl | send_pan_azimuth_controllable (unsigned int) | |
AutomationControl | send_pan_azimuth_enable_controllable (unsigned int) | |
void | set_presentation_order (unsigned int) | |
bool | slaved () | |
bool | slaved_to (VCA) | |
SoloControl | solo_control () | |
SoloIsolateControl | solo_isolate_control () | |
SoloSafeControl | solo_safe_control () | |
GainControl | trim_control () | |
Cast | ||
Automatable | to_automatable () | |
Route | to_route () | |
Slavable | to_slavable () | |
VCA | to_vca () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
∁ ARDOUR:MidiTrackList
C‡: std::list<boost::shared_ptr<ARDOUR::MidiTrack> >
Constructor | ||
---|---|---|
ℂ | ARDOUR.MidiTrackList () | |
Methods | ||
LuaTable | add (LuaTable {MidiTrack}) | |
MidiTrack | back () | |
bool | empty () | |
MidiTrack | front () | |
LuaIter | iter () | |
void | push_back (MidiTrack) | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () | |
void | unique () |
↠ ARDOUR:MixerScene
C‡: boost::shared_ptr< ARDOUR::MixerScene >, boost::weak_ptr< ARDOUR::MixerScene >
Base class for objects with saveable and undoable state
Methods | ||
---|---|---|
bool | apply () | |
bool | apply_to (ControllableSet, AutomationTypeSet) | |
void | clear () | |
bool | empty () | |
bool | isnil () | |
std::string | name () | |
bool | set_name (std::string) | |
void | snapshot () |
↠ ARDOUR:MonitorControl
C‡: boost::shared_ptr< ARDOUR::MonitorControl >, boost::weak_ptr< ARDOUR::MonitorControl >
is-a: ARDOUR:SlavableAutomationControl
A PBD::Controllable with associated automation data (AutomationList)
Methods | ||
---|---|---|
bool | isnil () | |
MonitorChoice | monitoring_choice () |
Inherited from ARDOUR:SlavableAutomationControl
Methods | ||
---|---|---|
void | add_master (AutomationControl) | |
void | clear_masters () | |
int | get_boolean_masters () | |
double | get_masters_value () | |
void | remove_master (AutomationControl) | |
bool | slaved () | |
bool | slaved_to (AutomationControl) |
Inherited from ARDOUR:AutomationControl
Methods | ||
---|---|---|
AutomationList | alist () | |
AutoState | automation_state () | |
ParameterDescriptor | desc () | |
double | get_value () | |
Get `internal' value Returns raw value as used for the plugin/processor control port | ||
double | lower () | |
double | normal () | |
void | set_automation_state (AutoState) | |
void | set_value (double, GroupControlDisposition) | |
Set `internal' value All derived classes must implement this. Basic derived classes will ignore group_override but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.
| ||
void | start_touch (timepos_t) | |
void | stop_touch (timepos_t) | |
bool | toggled () | |
double | upper () | |
bool | writable () | |
Cast | ||
Control | to_ctrl () | |
SlavableAutomationControl | to_slavable () |
Inherited from PBD:Controllable
Methods | ||
---|---|---|
void | dump_registry () | |
std::string | name () | |
ControllableSet | registered_controllables () | |
Cast | ||
AutomationControl | to_automationcontrol () | |
MPGainControl | to_mpgain () | |
MPToggleControl | to_mptoggle () |
Inherited from PBD:StatefulPtr
Methods | ||
---|---|---|
void | clear_changes () | |
Forget about any changes to this object's properties | ||
ID | id () | |
OwnedPropertyList | properties () |
↠ ARDOUR:MonitorProcessor
C‡: boost::shared_ptr< ARDOUR::MonitorProcessor >, boost::weak_ptr< ARDOUR::MonitorProcessor >
is-a: ARDOUR:Processor
A mixer strip element - plugin, send, meter, etc
Methods | ||
---|---|---|
Controllable | channel_cut_control (unsigned int) | |
Controllable | channel_dim_control (unsigned int) | |
Controllable | channel_polarity_control (unsigned int) | |
Controllable | channel_solo_control (unsigned int) | |
bool | cut (unsigned int) | |
bool | cut_all () | |
Controllable | cut_control () | |
bool | dim_all () | |
Controllable | dim_control () | |
float | dim_level () | |
Controllable | dim_level_control () | |
bool | dimmed (unsigned int) | |
bool | inverted (unsigned int) | |
bool | isnil () | |
bool | monitor_active () | |
bool | mono () | |
Controllable | mono_control () | |
void | set_cut (unsigned int, bool) | |
void | set_cut_all (bool) | |
void | set_dim (unsigned int, bool) | |
void | set_dim_all (bool) | |
void | set_mono (bool) | |
void | set_polarity (unsigned int, bool) | |
void | set_solo (unsigned int, bool) | |
Controllable | solo_boost_control () | |
float | solo_boost_level () | |
bool | soloed (unsigned int) |
Inherited from ARDOUR:Processor
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
long | capture_offset () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
long | input_latency () | |
ChanCount | input_streams () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
long | signal_latency () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
↠ ARDOUR:MuteControl
C‡: boost::shared_ptr< ARDOUR::MuteControl >, boost::weak_ptr< ARDOUR::MuteControl >
is-a: ARDOUR:SlavableAutomationControl
A PBD::Controllable with associated automation data (AutomationList)
Methods | ||
---|---|---|
bool | isnil () | |
MutePoint | mute_points () | |
bool | muted () | |
bool | muted_by_self () | |
void | set_mute_points (MutePoint) |
Inherited from ARDOUR:SlavableAutomationControl
Methods | ||
---|---|---|
void | add_master (AutomationControl) | |
void | clear_masters () | |
int | get_boolean_masters () | |
double | get_masters_value () | |
void | remove_master (AutomationControl) | |
bool | slaved () | |
bool | slaved_to (AutomationControl) |
Inherited from ARDOUR:AutomationControl
Methods | ||
---|---|---|
AutomationList | alist () | |
AutoState | automation_state () | |
ParameterDescriptor | desc () | |
double | get_value () | |
Get `internal' value Returns raw value as used for the plugin/processor control port | ||
double | lower () | |
double | normal () | |
void | set_automation_state (AutoState) | |
void | set_value (double, GroupControlDisposition) | |
Set `internal' value All derived classes must implement this. Basic derived classes will ignore group_override but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.
| ||
void | start_touch (timepos_t) | |
void | stop_touch (timepos_t) | |
bool | toggled () | |
double | upper () | |
bool | writable () | |
Cast | ||
Control | to_ctrl () | |
SlavableAutomationControl | to_slavable () |
Inherited from PBD:Controllable
Methods | ||
---|---|---|
void | dump_registry () | |
std::string | name () | |
ControllableSet | registered_controllables () | |
Cast | ||
AutomationControl | to_automationcontrol () | |
MPGainControl | to_mpgain () | |
MPToggleControl | to_mptoggle () |
Inherited from PBD:StatefulPtr
Methods | ||
---|---|---|
void | clear_changes () | |
Forget about any changes to this object's properties | ||
ID | id () | |
OwnedPropertyList | properties () |
∁ ARDOUR:NotePtrList
C‡: std::list<boost::shared_ptr<Evoral::Note<Temporal::Beats> > > >
Constructor | ||
---|---|---|
ℂ | ARDOUR.NotePtrList () | |
Methods | ||
LuaTable | add (LuaTable {Beats}) | |
NotePtr | back () | |
bool | empty () | |
NotePtr | front () | |
LuaIter | iter () | |
void | push_back (NotePtr) | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () | |
void | unique () |
∅ ARDOUR:OwnedPropertyList
C‡: PBD::OwnedPropertyList
is-a: ARDOUR:PropertyList
Persistent Property List
A variant of PropertyList that does not delete its property list in its destructor. Objects with their own Properties store them in an OwnedPropertyList to avoid having them deleted at the wrong time.
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
∁ ARDOUR:PDC
C‡: ARDOUR::Latent
Methods | ||
---|---|---|
void | force_zero_latency (bool) | |
bool | zero_latency () |
↠ ARDOUR:PannerShell
C‡: boost::shared_ptr< ARDOUR::PannerShell >, boost::weak_ptr< ARDOUR::PannerShell >
is-a: ARDOUR:SessionObjectPtr
Class to manage panning by instantiating and controlling an appropriate Panner object for a given in/out configuration.
Methods | ||
---|---|---|
bool | bypassed () | |
bool | isnil () | |
void | set_bypassed (bool) |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
∁ ARDOUR:ParameterDescriptor
C‡: ARDOUR::ParameterDescriptor
is-a: Evoral:ParameterDescriptor
Descriptor of a parameter or control.
Essentially a union of LADSPA, VST and LV2 info.
Constructor | ||
---|---|---|
ℂ | ARDOUR.ParameterDescriptor () | |
Methods | ||
std::string | midi_note_name (unsigned char, bool) | |
Data Members | ||
unsigned int | display_priority | |
higher is more important http://lv2plug.in/ns/ext/port-props#displayPriority | ||
bool | enumeration | |
bool | inline_ctrl | |
bool | integer_step | |
std::string | label | |
float | largestep | |
std::string | print_fmt | |
format string for pretty printing | ||
float | smallstep | |
bool | sr_dependent | |
float | step |
Inherited from Evoral:ParameterDescriptor
Constructor | ||
---|---|---|
ℂ | Evoral.ParameterDescriptor () | |
Data Members | ||
bool | logarithmic | |
True for log-scale parameters | ||
float | lower | |
Minimum value (in Hz, for frequencies) | ||
float | normal | |
Default value | ||
unsigned int | rangesteps | |
number of steps, [min,max] (inclusive). <= 1 means continuous. == 2 only min, max. For integer controls this is usually (1 + max - min) | ||
bool | toggled | |
True iff parameter is boolean | ||
float | upper | |
Maximum value (in Hz, for frequencies) |
∁ ARDOUR:ParameterList
C‡: std::vector<Evoral::Parameter >
Constructor | ||
---|---|---|
ℂ | ARDOUR.ParameterList () | |
Methods | ||
Parameter | at (unsigned long) | |
bool | empty () | |
LuaIter | iter () | |
unsigned long | size () | |
LuaTable | table () |
↠ ARDOUR:PeakMeter
C‡: boost::shared_ptr< ARDOUR::PeakMeter >, boost::weak_ptr< ARDOUR::PeakMeter >
is-a: ARDOUR:Processor
Meters peaks on the input and stores them for access.
Methods | ||
---|---|---|
bool | isnil () | |
float | meter_level (unsigned int, MeterType) | |
MeterType | meter_type () | |
void | reset_max () | |
void | set_meter_type (MeterType) |
Inherited from ARDOUR:Processor
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
long | capture_offset () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
long | input_latency () | |
ChanCount | input_streams () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
long | signal_latency () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
↠ ARDOUR:PhaseControl
C‡: boost::shared_ptr< ARDOUR::PhaseControl >, boost::weak_ptr< ARDOUR::PhaseControl >
is-a: ARDOUR:AutomationControl
A PBD::Controllable with associated automation data (AutomationList)
Methods | ||
---|---|---|
bool | inverted (unsigned int) | |
bool | isnil () | |
void | set_phase_invert (unsigned int, bool) | |
|
Inherited from ARDOUR:AutomationControl
Methods | ||
---|---|---|
AutomationList | alist () | |
AutoState | automation_state () | |
ParameterDescriptor | desc () | |
double | get_value () | |
Get `internal' value Returns raw value as used for the plugin/processor control port | ||
double | lower () | |
double | normal () | |
void | set_automation_state (AutoState) | |
void | set_value (double, GroupControlDisposition) | |
Set `internal' value All derived classes must implement this. Basic derived classes will ignore group_override but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.
| ||
void | start_touch (timepos_t) | |
void | stop_touch (timepos_t) | |
bool | toggled () | |
double | upper () | |
bool | writable () | |
Cast | ||
Control | to_ctrl () | |
SlavableAutomationControl | to_slavable () |
Inherited from PBD:Controllable
Methods | ||
---|---|---|
void | dump_registry () | |
std::string | name () | |
ControllableSet | registered_controllables () | |
Cast | ||
AutomationControl | to_automationcontrol () | |
MPGainControl | to_mpgain () | |
MPToggleControl | to_mptoggle () |
Inherited from PBD:StatefulPtr
Methods | ||
---|---|---|
void | clear_changes () | |
Forget about any changes to this object's properties | ||
ID | id () | |
OwnedPropertyList | properties () |
↠ ARDOUR:Playlist
C‡: boost::shared_ptr< ARDOUR::Playlist >, boost::weak_ptr< ARDOUR::Playlist >
is-a: ARDOUR:SessionObjectPtr
A named object associated with a Session. Objects derived from this class are expected to be destroyed before the session calls drop_references().
Methods | ||
---|---|---|
void | add_region (Region, timepos_t, float, bool) | |
Region | combine (RegionList, Track) | |
unsigned int | count_regions_at (timepos_t) | |
Playlist | cut (TimelineRangeList&, bool) | |
DataType | data_type () | |
void | duplicate (Region, timepos_t&, timecnt_t, float) | |
void | duplicate_range (TimelineRange&, float) | |
void | duplicate_until (Region, timepos_t&, timecnt_t, timepos_t) | |
bool | empty () | |
Region | find_next_region (timepos_t, RegionPoint, int) | |
timepos_t | find_next_region_boundary (timepos_t, int) | |
long | find_next_transient (timepos_t, int) | |
ID | get_orig_track_id () | |
bool | hidden () | |
bool | isnil () | |
void | lower_region (Region) | |
void | lower_region_to_bottom (Region) | |
unsigned int | n_regions () | |
void | raise_region (Region) | |
void | raise_region_to_top (Region) | |
Region | region_by_id (ID) | |
RegionListPtr | region_list () | |
RegionListPtr | regions_at (timepos_t) | |
RegionListPtr | regions_touched (timepos_t, timepos_t) | |
RegionListPtr | regions_with_end_within (Range) | |
RegionListPtr | regions_with_start_within (Range) | |
void | remove_region (Region) | |
bool | set_name (std::string) | |
bool | shared () | |
void | split_region (Region, timepos_t) | |
Region | top_region_at (timepos_t) | |
Region | top_unmuted_region_at (timepos_t) | |
void | uncombine (Region) | |
bool | used () | |
Cast | ||
AudioPlaylist | to_audioplaylist () | |
MidiPlaylist | to_midiplaylist () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
∁ ARDOUR:PlaylistList
C‡: std::vector<boost::shared_ptr<ARDOUR::Playlist> >
Constructor | ||
---|---|---|
ℂ | ARDOUR.PlaylistList () | |
ℂ | ARDOUR.PlaylistList () | |
Methods | ||
LuaTable | add (LuaTable {Playlist}) | |
Playlist | at (unsigned long) | |
void | clear () | |
bool | empty () | |
LuaIter | iter () | |
void | push_back (Playlist) | |
unsigned long | size () | |
LuaTable | table () | |
... | to_array (--lua--) |
↠ ARDOUR:Plugin
C‡: boost::shared_ptr< ARDOUR::Plugin >, boost::weak_ptr< ARDOUR::Plugin >
is-a: PBD:StatefulDestructiblePtr
A plugin is an external module (usually 3rd party provided) loaded into Ardour for the purpose of digital signal processing.
This class provides an abstraction for methords provided by all supported plugin standards such as presets, name, parameters etc.
Plugins are not used directly in Ardour but always wrapped by a PluginInsert.
Methods | ||
---|---|---|
IOPortDescription | describe_io_port (DataType, bool, unsigned int) | |
std::string | get_docs () | |
PluginInfo | get_info () | |
LuaTable(int, ...) | get_parameter_descriptor (unsigned int, ParameterDescriptor&) | |
std::string | get_parameter_docs (unsigned int) | |
bool | isnil () | |
char* | label () | |
PresetRecord | last_preset () | |
Returns Last preset to be requested; the settings may have been changed since; find out with parameter_changed_since_last_preset. | ||
bool | load_preset (PresetRecord) | |
Set parameters using a preset | ||
char* | maker () | |
char* | name () | |
LuaTable(unsigned int, ...) | nth_parameter (unsigned int, bool&) | |
unsigned int | parameter_count () | |
bool | parameter_is_audio (unsigned int) | |
bool | parameter_is_control (unsigned int) | |
bool | parameter_is_input (unsigned int) | |
bool | parameter_is_output (unsigned int) | |
std::string | parameter_label (unsigned int) | |
PresetRecord | preset_by_label (std::string) | |
PresetRecord | preset_by_uri (std::string) | |
void | remove_preset (std::string) | |
PresetRecord | save_preset (std::string) | |
Create a new plugin-preset from the current state
Returns PresetRecord with empty URI on failure | ||
std::string | unique_id () | |
Cast | ||
LuaProc | to_luaproc () |
Inherited from PBD:StatefulPtr
Methods | ||
---|---|---|
void | clear_changes () | |
Forget about any changes to this object's properties | ||
ID | id () | |
OwnedPropertyList | properties () |
∁ ARDOUR:Plugin:IOPortDescription
C‡: ARDOUR::Plugin::IOPortDescription
Data Members | ||
---|---|---|
unsigned int | group_channel | |
std::string | group_name | |
bool | is_sidechain | |
std::string | name |
↠ ARDOUR:PluginControl
C‡: boost::shared_ptr< ARDOUR::PluginInsert::PluginControl >, boost::weak_ptr< ARDOUR::PluginInsert::PluginControl >
is-a: ARDOUR:AutomationControl
A control that manipulates a plugin parameter (control port).
Methods | ||
---|---|---|
bool | isnil () |
Inherited from ARDOUR:AutomationControl
Methods | ||
---|---|---|
AutomationList | alist () | |
AutoState | automation_state () | |
ParameterDescriptor | desc () | |
double | get_value () | |
Get `internal' value Returns raw value as used for the plugin/processor control port | ||
double | lower () | |
double | normal () | |
void | set_automation_state (AutoState) | |
void | set_value (double, GroupControlDisposition) | |
Set `internal' value All derived classes must implement this. Basic derived classes will ignore group_override but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.
| ||
void | start_touch (timepos_t) | |
void | stop_touch (timepos_t) | |
bool | toggled () | |
double | upper () | |
bool | writable () | |
Cast | ||
Control | to_ctrl () | |
SlavableAutomationControl | to_slavable () |
Inherited from PBD:Controllable
Methods | ||
---|---|---|
void | dump_registry () | |
std::string | name () | |
ControllableSet | registered_controllables () | |
Cast | ||
AutomationControl | to_automationcontrol () | |
MPGainControl | to_mpgain () | |
MPToggleControl | to_mptoggle () |
Inherited from PBD:StatefulPtr
Methods | ||
---|---|---|
void | clear_changes () | |
Forget about any changes to this object's properties | ||
ID | id () | |
OwnedPropertyList | properties () |
↠ ARDOUR:PluginInfo
C‡: boost::shared_ptr< ARDOUR::PluginInfo >, boost::weak_ptr< ARDOUR::PluginInfo >
Constructor | ||
---|---|---|
ℵ | ARDOUR.PluginInfo () | |
Methods | ||
PresetVector | get_presets (bool) | |
bool | is_instrument () | |
bool | isnil () | |
Data Members | ||
std::string | category | |
std::string | creator | |
ARDOUR:ChanCount | n_inputs | |
ARDOUR:ChanCount | n_outputs | |
std::string | name | |
std::string | path | |
ARDOUR.PluginType | _type | |
std::string | unique_id |
∁ ARDOUR:PluginInfoList
C‡: std::list<boost::shared_ptr<ARDOUR::PluginInfo> >
Constructor | ||
---|---|---|
ℂ | ARDOUR.PluginInfoList () | |
Methods | ||
LuaTable | add (LuaTable {PluginInfo}) | |
PluginInfo | back () | |
bool | empty () | |
PluginInfo | front () | |
LuaIter | iter () | |
void | push_back (PluginInfo) | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () | |
void | unique () |
↠ ARDOUR:PluginInsert
C‡: boost::shared_ptr< ARDOUR::PluginInsert >, boost::weak_ptr< ARDOUR::PluginInsert >
is-a: ARDOUR:Processor
Plugin inserts: send data through a plugin
Methods | ||
---|---|---|
void | activate () | |
void | clear_stats () | |
void | deactivate () | |
void | enable (bool) | |
bool | enabled () | |
unsigned int | get_count () | |
LuaTable(bool, ...) | get_stats (long&, long&, double&, double&) | |
bool | has_sidechain () | |
ChanMapping | input_map (unsigned int) | |
bool | is_channelstrip () | |
bool | is_instrument () | |
bool | isnil () | |
ChanCount | natural_input_streams () | |
ChanCount | natural_output_streams () | |
ChanMapping | output_map (unsigned int) | |
Plugin | plugin (unsigned int) | |
bool | reset_parameters_to_default () | |
void | set_input_map (unsigned int, ChanMapping) | |
void | set_output_map (unsigned int, ChanMapping) | |
void | set_thru_map (ChanMapping) | |
IO | sidechain_input () | |
long | signal_latency () | |
bool | strict_io_configured () | |
ChanMapping | thru_map () | |
PluginType | _type () | |
bool | write_immediate_event (EventType, unsigned long, unsigned char*) |
Inherited from ARDOUR:Processor
Methods | ||
---|---|---|
bool | active () | |
long | capture_offset () | |
std::string | display_name () | |
bool | display_to_user () | |
long | input_latency () | |
ChanCount | input_streams () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
ℕ ARDOUR.PluginType
Methods | ||
---|---|---|
std::string | name (PluginType, bool) |
↠ ARDOUR:PolarityProcessor
C‡: boost::shared_ptr< ARDOUR::PolarityProcessor >, boost::weak_ptr< ARDOUR::PolarityProcessor >
is-a: ARDOUR:Processor
A mixer strip element - plugin, send, meter, etc
Methods | ||
---|---|---|
bool | isnil () |
Inherited from ARDOUR:Processor
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
long | capture_offset () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
long | input_latency () | |
ChanCount | input_streams () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
long | signal_latency () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
↠ ARDOUR:Port
C‡: boost::shared_ptr< ARDOUR::Port >, boost::weak_ptr< ARDOUR::Port >
Methods | ||
---|---|---|
int | connect (std::string) | |
bool | connected () | |
Returns true if this port is connected to anything | ||
bool | connected_to (std::string) | |
Returns true if this port is connected to o, otherwise false. | ||
int | disconnect (std::string) | |
int | disconnect_all () | |
PortFlags | flags () | |
Returns flags | ||
LuaTable(...) | get_connected_latency_range (LatencyRange&, bool) | |
bool | isnil () | |
std::string | name () | |
Returns Port short name | ||
bool | physically_connected () | |
std::string | pretty_name (bool) | |
Returns Port human readable name | ||
LatencyRange | private_latency_range (bool) | |
LatencyRange | public_latency_range (bool) | |
bool | receives_input () | |
Returns true if this Port receives input, otherwise false | ||
bool | sends_output () | |
Returns true if this Port sends output, otherwise false | ||
Cast | ||
AsyncMIDIPort | to_asyncmidiport () | |
AudioPort | to_audioport () | |
MidiPort | to_midiport () |
∅ ARDOUR:PortEngine
C‡: ARDOUR::PortEngine
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
∁ ARDOUR:PortList
C‡: std::list<boost::shared_ptr<ARDOUR::Port> >
Constructor | ||
---|---|---|
ℂ | ARDOUR.PortList () | |
Methods | ||
Port | back () | |
bool | empty () | |
Port | front () | |
LuaIter | iter () | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () |
∁ ARDOUR:PortManager
C‡: ARDOUR::PortManager
Methods | ||
---|---|---|
int | connect (std::string, std::string) | |
bool | connected (std::string) | |
int | disconnect (std::string, std::string) | |
int | disconnect_port (Port) | |
LuaTable(int, ...) | get_backend_ports (std::string, DataType, PortFlags, StringVector&) | |
LuaTable(int, ...) | get_connections (std::string, StringVector&) | |
void | get_physical_inputs (DataType, StringVector&, MidiPortFlags, MidiPortFlags) | |
void | get_physical_outputs (DataType, StringVector&, MidiPortFlags, MidiPortFlags) | |
Port | get_port_by_name (std::string) | |
Returns Corresponding Port or 0. | ||
LuaTable(int, ...) | get_ports (DataType, PortList&) | |
std::string | get_pretty_name_by_name (std::string) | |
ChanCount | n_physical_inputs () | |
ChanCount | n_physical_outputs () | |
bool | physically_connected (std::string) | |
PortEngine | port_engine () | |
bool | port_is_physical (std::string) | |
void | reset_input_meters () |
↠ ARDOUR:PortSet
C‡: boost::shared_ptr< ARDOUR::PortSet >, boost::weak_ptr< ARDOUR::PortSet >
An ordered list of Ports, possibly of various types.
This allows access to all the ports as a list, ignoring type, or accessing the nth port of a given type. Note that port(n) and nth_audio_port(n) may NOT return the same port.
Each port is held twice; once in a per-type vector of vectors (_ports) and once in a vector of all port (_all_ports). This is to speed up the fairly common case of iterating over all ports.
Methods | ||
---|---|---|
void | add (Port) | |
void | clear () | |
Remove all ports from the PortSet. Ports are not deregistered with the engine, it's the caller's responsibility to not leak here! | ||
bool | contains (Port) | |
bool | empty () | |
bool | isnil () | |
unsigned long | num_ports (DataType) | |
Port | port (DataType, unsigned long) | |
nth port of type t, or nth port if t = NIL
| ||
bool | remove (Port) |
∁ ARDOUR:PresentationInfo
C‡: ARDOUR::PresentationInfo
is-a: PBD:Stateful
Base class for objects with saveable and undoable state
Methods | ||
---|---|---|
unsigned int | color () | |
Flag | flags () | |
unsigned int | order () | |
void | set_color (unsigned int) | |
bool | special (bool) |
Inherited from PBD:Stateful
Methods | ||
---|---|---|
void | clear_changes () | |
Forget about any changes to this object's properties | ||
ID | id () | |
OwnedPropertyList | properties () |
∁ ARDOUR:PresetRecord
C‡: ARDOUR::Plugin::PresetRecord
Constructor | ||
---|---|---|
ℂ | ARDOUR.PresetRecord () | |
Data Members | ||
std::string | label | |
std::string | uri | |
bool | user | |
bool | valid |
∁ ARDOUR:PresetVector
C‡: std::vector<ARDOUR::Plugin::PresetRecord >
Constructor | ||
---|---|---|
ℂ | ARDOUR.PresetVector () | |
ℂ | ARDOUR.PresetVector () | |
Methods | ||
LuaTable | add (LuaTable {PresetRecord}) | |
PresetRecord | at (unsigned long) | |
void | clear () | |
bool | empty () | |
LuaIter | iter () | |
void | push_back (PresetRecord) | |
unsigned long | size () | |
LuaTable | table () | |
... | to_array (--lua--) |
↠ ARDOUR:Processor
C‡: boost::shared_ptr< ARDOUR::Processor >, boost::weak_ptr< ARDOUR::Processor >
is-a: ARDOUR:SessionObjectPtr
A mixer strip element - plugin, send, meter, etc
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
long | capture_offset () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
long | input_latency () | |
ChanCount | input_streams () | |
bool | isnil () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
long | signal_latency () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
∁ ARDOUR:ProcessorList
C‡: std::list<boost::shared_ptr<ARDOUR::Processor> >
Constructor | ||
---|---|---|
ℂ | ARDOUR.ProcessorList () | |
Methods | ||
LuaTable | add (LuaTable {Processor}) | |
Processor | back () | |
bool | empty () | |
Processor | front () | |
LuaIter | iter () | |
void | push_back (Processor) | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () | |
void | unique () |
∁ ARDOUR:ProcessorVector
C‡: std::vector<boost::shared_ptr<ARDOUR::Processor> >
Constructor | ||
---|---|---|
ℂ | ARDOUR.ProcessorVector () | |
ℂ | ARDOUR.ProcessorVector () | |
Methods | ||
LuaTable | add (LuaTable {Processor}) | |
Processor | at (unsigned long) | |
void | clear () | |
bool | empty () | |
LuaIter | iter () | |
void | push_back (Processor) | |
unsigned long | size () | |
LuaTable | table () | |
... | to_array (--lua--) |
∅ ARDOUR:Progress
C‡: ARDOUR::Progress
A class to handle reporting of progress of something
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
∅ ARDOUR:Properties:BoolProperty
C‡: PBD::PropertyDescriptor<bool>
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
∅ ARDOUR:Properties:FloatProperty
C‡: PBD::PropertyDescriptor<float>
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
∅ ARDOUR:Properties:SamplePosProperty
C‡: PBD::PropertyDescriptor<long>
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
∅ ARDOUR:Properties:StringProperty
C‡: PBD::PropertyDescriptor<std::string >
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
∅ ARDOUR:Properties:TimeCntProperty
C‡: PBD::PropertyDescriptor<Temporal::timecnt_t>
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
∅ ARDOUR:Properties:TimePosProperty
C‡: PBD::PropertyDescriptor<Temporal::timepos_t>
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
∁ ARDOUR:PropertyChange
C‡: PBD::PropertyChange
A list of IDs of Properties that have changed in some situation or other
Methods | ||
---|---|---|
bool | containsBool (BoolProperty) | |
bool | containsFloat (FloatProperty) | |
bool | containsSamplePos (SamplePosProperty) | |
bool | containsString (StringProperty) | |
bool | containsTimeCnt (TimeCntProperty) | |
bool | containsTimePos (TimePosProperty) |
∅ ARDOUR:PropertyList
C‡: PBD::PropertyList
A list of properties, mapped using their ID
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
∁ ARDOUR:RCConfiguration
C‡: ARDOUR::RCConfiguration
is-a: PBD:Configuration
Base class for objects with saveable and undoable state
Methods | ||
---|---|---|
AFLPosition | get_afl_position () | |
bool | get_all_safe () | |
bool | get_allow_special_bus_removal () | |
bool | get_ask_replace_instrument () | |
bool | get_ask_setup_instrument () | |
float | get_audio_capture_buffer_seconds () | |
float | get_audio_playback_buffer_seconds () | |
std::string | get_auditioner_output_left () | |
std::string | get_auditioner_output_right () | |
bool | get_auto_analyse_audio () | |
bool | get_auto_connect_standard_busses () | |
bool | get_auto_input_does_talkback () | |
bool | get_auto_return_after_rewind_ffwd () | |
AutoReturnTarget | get_auto_return_target_list () | |
bool | get_automation_follows_regions () | |
float | get_automation_interval_msecs () | |
double | get_automation_thinning_factor () | |
BufferingPreset | get_buffering_preset () | |
std::string | get_click_emphasis_sound () | |
float | get_click_gain () | |
bool | get_click_record_only () | |
std::string | get_click_sound () | |
bool | get_clicking () | |
std::string | get_clip_library_dir () | |
bool | get_conceal_lv1_if_lv2_exists () | |
bool | get_conceal_vst2_if_vst3_exists () | |
bool | get_copy_demo_sessions () | |
int | get_cpu_dma_latency () | |
bool | get_create_xrun_marker () | |
TimeDomain | get_default_automation_time_domain () | |
FadeShape | get_default_fade_shape () | |
std::string | get_default_session_parent_dir () | |
std::string | get_default_trigger_input_port () | |
DenormalModel | get_denormal_model () | |
bool | get_denormal_protection () | |
bool | get_disable_disarm_during_roll () | |
bool | get_discover_plugins_on_start () | |
unsigned int | get_disk_choice_space_threshold () | |
std::string | get_donate_url () | |
EditMode | get_edit_mode () | |
bool | get_exclusive_solo () | |
float | get_export_preroll () | |
float | get_export_silence_threshold () | |
unsigned int | get_feedback_interval_ms () | |
bool | get_first_midi_bank_is_zero () | |
bool | get_group_override_inverts () | |
bool | get_hide_dummy_backend () | |
bool | get_hiding_groups_deactivates_groups () | |
int | get_history_depth () | |
int | get_initial_program_change () | |
AutoConnectOption | get_input_auto_connect () | |
int | get_inter_scene_gap_samples () | |
bool | get_interview_editing () | |
bool | get_latched_record_enable () | |
LayerModel | get_layer_model () | |
unsigned int | get_limit_n_automatables () | |
bool | get_link_send_and_route_panner () | |
ListenPosition | get_listen_position () | |
bool | get_locate_while_waiting_for_sync () | |
LoopFadeChoice | get_loop_fade_choice () | |
bool | get_loop_is_mode () | |
std::string | get_ltc_output_port () | |
float | get_ltc_output_volume () | |
bool | get_ltc_send_continuously () | |
float | get_max_gain () | |
unsigned int | get_max_recent_sessions () | |
unsigned int | get_max_recent_templates () | |
float | get_max_transport_speed () | |
float | get_meter_falloff () | |
MeterType | get_meter_type_bus () | |
MeterType | get_meter_type_master () | |
MeterType | get_meter_type_track () | |
std::string | get_midi_audition_synth_uri () | |
bool | get_midi_clock_sets_tempo () | |
bool | get_midi_feedback () | |
bool | get_midi_input_follows_selection () | |
float | get_midi_track_buffer_seconds () | |
unsigned int | get_minimum_disk_read_bytes () | |
unsigned int | get_minimum_disk_write_bytes () | |
bool | get_mmc_control () | |
int | get_mmc_receive_device_id () | |
int | get_mmc_send_device_id () | |
std::string | get_monitor_bus_preferred_bundle () | |
MonitorModel | get_monitoring_model () | |
int | get_mtc_qf_speed_tolerance () | |
bool | get_mute_affects_control_outs () | |
bool | get_mute_affects_main_outs () | |
bool | get_mute_affects_post_fader () | |
bool | get_mute_affects_pre_fader () | |
bool | get_new_plugins_active () | |
unsigned int | get_osc_port () | |
AutoConnectOption | get_output_auto_connect () | |
unsigned int | get_periodic_safety_backup_interval () | |
bool | get_periodic_safety_backups () | |
PFLPosition | get_pfl_position () | |
std::string | get_pingback_url () | |
unsigned int | get_plugin_cache_version () | |
std::string | get_plugin_path_lxvst () | |
std::string | get_plugin_path_vst () | |
std::string | get_plugin_path_vst3 () | |
unsigned int | get_plugin_scan_timeout () | |
bool | get_plugins_stop_with_transport () | |
unsigned int | get_port_resampler_quality () | |
float | get_preroll_seconds () | |
int | get_processor_usage () | |
bool | get_quieten_at_speed () | |
long | get_range_location_minimum () | |
RangeSelectionAfterSplit | get_range_selection_after_split () | |
bool | get_recording_resets_xrun_count () | |
std::string | get_reference_manual_url () | |
bool | get_region_boundaries_from_onscreen_tracks () | |
bool | get_region_boundaries_from_selected_tracks () | |
RegionEquivalence | get_region_equivalence () | |
RegionSelectionAfterSplit | get_region_selection_after_split () | |
bool | get_replicate_missing_region_channels () | |
bool | get_reset_default_speed_on_stop () | |
std::string | get_resource_index_url () | |
bool | get_rewind_ffwd_like_tape_decks () | |
RippleMode | get_ripple_mode () | |
bool | get_run_all_transport_masters_always () | |
std::string | get_sample_lib_path () | |
bool | get_save_history () | |
int | get_saved_history_depth () | |
bool | get_send_ltc () | |
bool | get_send_midi_clock () | |
bool | get_send_mmc () | |
bool | get_send_mtc () | |
bool | get_setup_sidechain () | |
bool | get_show_solo_mutes () | |
bool | get_show_video_server_dialog () | |
bool | get_show_vst3_micro_edit_inline () | |
float | get_shuttle_max_speed () | |
float | get_shuttle_speed_factor () | |
float | get_shuttle_speed_threshold () | |
ShuttleUnits | get_shuttle_units () | |
bool | get_skip_playback () | |
bool | get_solo_control_is_listen_control () | |
float | get_solo_mute_gain () | |
bool | get_solo_mute_override () | |
bool | get_stop_at_session_end () | |
bool | get_stop_recording_on_xrun () | |
bool | get_strict_io () | |
bool | get_timecode_sync_frame_rate () | |
bool | get_trace_midi_input () | |
bool | get_trace_midi_output () | |
TracksAutoNamingRule | get_tracks_auto_naming () | |
float | get_transient_sensitivity () | |
bool | get_transport_masters_just_roll_when_sync_lost () | |
bool | get_try_autostart_engine () | |
std::string | get_tutorial_manual_url () | |
std::string | get_updates_url () | |
bool | get_use_audio_units () | |
bool | get_use_click_emphasis () | |
bool | get_use_lxvst () | |
bool | get_use_macvst () | |
bool | get_use_master_volume () | |
bool | get_use_monitor_bus () | |
bool | get_use_osc () | |
bool | get_use_plugin_own_gui () | |
bool | get_use_tranzport () | |
bool | get_use_vst3 () | |
bool | get_use_windows_vst () | |
bool | get_verbose_plugin_scan () | |
bool | get_verify_remove_last_capture () | |
bool | get_video_advanced_setup () | |
std::string | get_video_server_docroot () | |
std::string | get_video_server_url () | |
bool | get_work_around_jack_no_copy_optimization () | |
std::string | get_xjadeo_binary () | |
bool | set_afl_position (AFLPosition) | |
bool | set_all_safe (bool) | |
bool | set_allow_special_bus_removal (bool) | |
bool | set_ask_replace_instrument (bool) | |
bool | set_ask_setup_instrument (bool) | |
bool | set_audio_capture_buffer_seconds (float) | |
bool | set_audio_playback_buffer_seconds (float) | |
bool | set_auditioner_output_left (std::string) | |
bool | set_auditioner_output_right (std::string) | |
bool | set_auto_analyse_audio (bool) | |
bool | set_auto_connect_standard_busses (bool) | |
bool | set_auto_input_does_talkback (bool) | |
bool | set_auto_return_after_rewind_ffwd (bool) | |
bool | set_auto_return_target_list (AutoReturnTarget) | |
bool | set_automation_follows_regions (bool) | |
bool | set_automation_interval_msecs (float) | |
bool | set_automation_thinning_factor (double) | |
bool | set_buffering_preset (BufferingPreset) | |
bool | set_click_emphasis_sound (std::string) | |
bool | set_click_gain (float) | |
bool | set_click_record_only (bool) | |
bool | set_click_sound (std::string) | |
bool | set_clicking (bool) | |
bool | set_clip_library_dir (std::string) | |
bool | set_conceal_lv1_if_lv2_exists (bool) | |
bool | set_conceal_vst2_if_vst3_exists (bool) | |
bool | set_copy_demo_sessions (bool) | |
bool | set_cpu_dma_latency (int) | |
bool | set_create_xrun_marker (bool) | |
bool | set_default_automation_time_domain (TimeDomain) | |
bool | set_default_fade_shape (FadeShape) | |
bool | set_default_session_parent_dir (std::string) | |
bool | set_default_trigger_input_port (std::string) | |
bool | set_denormal_model (DenormalModel) | |
bool | set_denormal_protection (bool) | |
bool | set_disable_disarm_during_roll (bool) | |
bool | set_discover_plugins_on_start (bool) | |
bool | set_disk_choice_space_threshold (unsigned int) | |
bool | set_donate_url (std::string) | |
bool | set_edit_mode (EditMode) | |
bool | set_exclusive_solo (bool) | |
bool | set_export_preroll (float) | |
bool | set_export_silence_threshold (float) | |
bool | set_feedback_interval_ms (unsigned int) | |
bool | set_first_midi_bank_is_zero (bool) | |
bool | set_group_override_inverts (bool) | |
bool | set_hide_dummy_backend (bool) | |
bool | set_hiding_groups_deactivates_groups (bool) | |
bool | set_history_depth (int) | |
bool | set_initial_program_change (int) | |
bool | set_input_auto_connect (AutoConnectOption) | |
bool | set_inter_scene_gap_samples (int) | |
bool | set_interview_editing (bool) | |
bool | set_latched_record_enable (bool) | |
bool | set_layer_model (LayerModel) | |
bool | set_limit_n_automatables (unsigned int) | |
bool | set_link_send_and_route_panner (bool) | |
bool | set_listen_position (ListenPosition) | |
bool | set_locate_while_waiting_for_sync (bool) | |
bool | set_loop_fade_choice (LoopFadeChoice) | |
bool | set_loop_is_mode (bool) | |
bool | set_ltc_output_port (std::string) | |
bool | set_ltc_output_volume (float) | |
bool | set_ltc_send_continuously (bool) | |
bool | set_max_gain (float) | |
bool | set_max_recent_sessions (unsigned int) | |
bool | set_max_recent_templates (unsigned int) | |
bool | set_max_transport_speed (float) | |
bool | set_meter_falloff (float) | |
bool | set_meter_type_bus (MeterType) | |
bool | set_meter_type_master (MeterType) | |
bool | set_meter_type_track (MeterType) | |
bool | set_midi_audition_synth_uri (std::string) | |
bool | set_midi_clock_sets_tempo (bool) | |
bool | set_midi_feedback (bool) | |
bool | set_midi_input_follows_selection (bool) | |
bool | set_midi_track_buffer_seconds (float) | |
bool | set_minimum_disk_read_bytes (unsigned int) | |
bool | set_minimum_disk_write_bytes (unsigned int) | |
bool | set_mmc_control (bool) | |
bool | set_mmc_receive_device_id (int) | |
bool | set_mmc_send_device_id (int) | |
bool | set_monitor_bus_preferred_bundle (std::string) | |
bool | set_monitoring_model (MonitorModel) | |
bool | set_mtc_qf_speed_tolerance (int) | |
bool | set_mute_affects_control_outs (bool) | |
bool | set_mute_affects_main_outs (bool) | |
bool | set_mute_affects_post_fader (bool) | |
bool | set_mute_affects_pre_fader (bool) | |
bool | set_new_plugins_active (bool) | |
bool | set_osc_port (unsigned int) | |
bool | set_output_auto_connect (AutoConnectOption) | |
bool | set_periodic_safety_backup_interval (unsigned int) | |
bool | set_periodic_safety_backups (bool) | |
bool | set_pfl_position (PFLPosition) | |
bool | set_pingback_url (std::string) | |
bool | set_plugin_cache_version (unsigned int) | |
bool | set_plugin_path_lxvst (std::string) | |
bool | set_plugin_path_vst (std::string) | |
bool | set_plugin_path_vst3 (std::string) | |
bool | set_plugin_scan_timeout (unsigned int) | |
bool | set_plugins_stop_with_transport (bool) | |
bool | set_port_resampler_quality (unsigned int) | |
bool | set_preroll_seconds (float) | |
bool | set_processor_usage (int) | |
bool | set_quieten_at_speed (bool) | |
bool | set_range_location_minimum (long) | |
bool | set_range_selection_after_split (RangeSelectionAfterSplit) | |
bool | set_recording_resets_xrun_count (bool) | |
bool | set_reference_manual_url (std::string) | |
bool | set_region_boundaries_from_onscreen_tracks (bool) | |
bool | set_region_boundaries_from_selected_tracks (bool) | |
bool | set_region_equivalence (RegionEquivalence) | |
bool | set_region_selection_after_split (RegionSelectionAfterSplit) | |
bool | set_replicate_missing_region_channels (bool) | |
bool | set_reset_default_speed_on_stop (bool) | |
bool | set_resource_index_url (std::string) | |
bool | set_rewind_ffwd_like_tape_decks (bool) | |
bool | set_ripple_mode (RippleMode) | |
bool | set_run_all_transport_masters_always (bool) | |
bool | set_sample_lib_path (std::string) | |
bool | set_save_history (bool) | |
bool | set_saved_history_depth (int) | |
bool | set_send_ltc (bool) | |
bool | set_send_midi_clock (bool) | |
bool | set_send_mmc (bool) | |
bool | set_send_mtc (bool) | |
bool | set_setup_sidechain (bool) | |
bool | set_show_solo_mutes (bool) | |
bool | set_show_video_server_dialog (bool) | |
bool | set_show_vst3_micro_edit_inline (bool) | |
bool | set_shuttle_max_speed (float) | |
bool | set_shuttle_speed_factor (float) | |
bool | set_shuttle_speed_threshold (float) | |
bool | set_shuttle_units (ShuttleUnits) | |
bool | set_skip_playback (bool) | |
bool | set_solo_control_is_listen_control (bool) | |
bool | set_solo_mute_gain (float) | |
bool | set_solo_mute_override (bool) | |
bool | set_stop_at_session_end (bool) | |
bool | set_stop_recording_on_xrun (bool) | |
bool | set_strict_io (bool) | |
bool | set_timecode_sync_frame_rate (bool) | |
bool | set_trace_midi_input (bool) | |
bool | set_trace_midi_output (bool) | |
bool | set_tracks_auto_naming (TracksAutoNamingRule) | |
bool | set_transient_sensitivity (float) | |
bool | set_transport_masters_just_roll_when_sync_lost (bool) | |
bool | set_try_autostart_engine (bool) | |
bool | set_tutorial_manual_url (std::string) | |
bool | set_updates_url (std::string) | |
bool | set_use_audio_units (bool) | |
bool | set_use_click_emphasis (bool) | |
bool | set_use_lxvst (bool) | |
bool | set_use_macvst (bool) | |
bool | set_use_master_volume (bool) | |
bool | set_use_monitor_bus (bool) | |
bool | set_use_osc (bool) | |
bool | set_use_plugin_own_gui (bool) | |
bool | set_use_tranzport (bool) | |
bool | set_use_vst3 (bool) | |
bool | set_use_windows_vst (bool) | |
bool | set_verbose_plugin_scan (bool) | |
bool | set_verify_remove_last_capture (bool) | |
bool | set_video_advanced_setup (bool) | |
bool | set_video_server_docroot (std::string) | |
bool | set_video_server_url (std::string) | |
bool | set_work_around_jack_no_copy_optimization (bool) | |
bool | set_xjadeo_binary (std::string) | |
Properties | ||
ARDOUR.AFLPosition | afl_position | |
bool | all_safe | |
bool | allow_special_bus_removal | |
bool | ask_replace_instrument | |
bool | ask_setup_instrument | |
float | audio_capture_buffer_seconds | |
float | audio_playback_buffer_seconds | |
std::string | auditioner_output_left | |
std::string | auditioner_output_right | |
bool | auto_analyse_audio | |
bool | auto_connect_standard_busses | |
bool | auto_input_does_talkback | |
bool | auto_return_after_rewind_ffwd | |
ARDOUR.AutoReturnTarget | auto_return_target_list | |
bool | automation_follows_regions | |
float | automation_interval_msecs | |
double | automation_thinning_factor | |
ARDOUR.BufferingPreset | buffering_preset | |
std::string | click_emphasis_sound | |
float | click_gain | |
bool | click_record_only | |
std::string | click_sound | |
bool | clicking | |
std::string | clip_library_dir | |
bool | conceal_lv1_if_lv2_exists | |
bool | conceal_vst2_if_vst3_exists | |
bool | copy_demo_sessions | |
int | cpu_dma_latency | |
bool | create_xrun_marker | |
Temporal.TimeDomain | default_automation_time_domain | |
ARDOUR.FadeShape | default_fade_shape | |
std::string | default_session_parent_dir | |
std::string | default_trigger_input_port | |
ARDOUR.DenormalModel | denormal_model | |
bool | denormal_protection | |
bool | disable_disarm_during_roll | |
bool | discover_plugins_on_start | |
unsigned int | disk_choice_space_threshold | |
std::string | donate_url | |
ARDOUR.EditMode | edit_mode | |
bool | exclusive_solo | |
float | export_preroll | |
float | export_silence_threshold | |
unsigned int | feedback_interval_ms | |
bool | first_midi_bank_is_zero | |
bool | group_override_inverts | |
bool | hide_dummy_backend | |
bool | hiding_groups_deactivates_groups | |
int | history_depth | |
int | initial_program_change | |
ARDOUR.AutoConnectOption | input_auto_connect | |
int | inter_scene_gap_samples | |
bool | interview_editing | |
bool | latched_record_enable | |
ARDOUR.LayerModel | layer_model | |
unsigned int | limit_n_automatables | |
bool | link_send_and_route_panner | |
ARDOUR.ListenPosition | listen_position | |
bool | locate_while_waiting_for_sync | |
ARDOUR.LoopFadeChoice | loop_fade_choice | |
bool | loop_is_mode | |
std::string | ltc_output_port | |
float | ltc_output_volume | |
bool | ltc_send_continuously | |
float | max_gain | |
unsigned int | max_recent_sessions | |
unsigned int | max_recent_templates | |
float | max_transport_speed | |
float | meter_falloff | |
ARDOUR.MeterType | meter_type_bus | |
ARDOUR.MeterType | meter_type_master | |
ARDOUR.MeterType | meter_type_track | |
std::string | midi_audition_synth_uri | |
bool | midi_clock_sets_tempo | |
bool | midi_feedback | |
bool | midi_input_follows_selection | |
float | midi_track_buffer_seconds | |
unsigned int | minimum_disk_read_bytes | |
unsigned int | minimum_disk_write_bytes | |
bool | mmc_control | |
int | mmc_receive_device_id | |
int | mmc_send_device_id | |
std::string | monitor_bus_preferred_bundle | |
ARDOUR.MonitorModel | monitoring_model | |
int | mtc_qf_speed_tolerance | |
bool | mute_affects_control_outs | |
bool | mute_affects_main_outs | |
bool | mute_affects_post_fader | |
bool | mute_affects_pre_fader | |
bool | new_plugins_active | |
unsigned int | osc_port | |
ARDOUR.AutoConnectOption | output_auto_connect | |
unsigned int | periodic_safety_backup_interval | |
bool | periodic_safety_backups | |
ARDOUR.PFLPosition | pfl_position | |
std::string | pingback_url | |
unsigned int | plugin_cache_version | |
std::string | plugin_path_lxvst | |
std::string | plugin_path_vst | |
std::string | plugin_path_vst3 | |
unsigned int | plugin_scan_timeout | |
bool | plugins_stop_with_transport | |
unsigned int | port_resampler_quality | |
float | preroll_seconds | |
int | processor_usage | |
bool | quieten_at_speed | |
long | range_location_minimum | |
ARDOUR.RangeSelectionAfterSplit | range_selection_after_split | |
bool | recording_resets_xrun_count | |
std::string | reference_manual_url | |
bool | region_boundaries_from_onscreen_tracks | |
bool | region_boundaries_from_selected_tracks | |
ARDOUR.RegionEquivalence | region_equivalence | |
ARDOUR.RegionSelectionAfterSplit | region_selection_after_split | |
bool | replicate_missing_region_channels | |
bool | reset_default_speed_on_stop | |
std::string | resource_index_url | |
bool | rewind_ffwd_like_tape_decks | |
ARDOUR.RippleMode | ripple_mode | |
bool | run_all_transport_masters_always | |
std::string | sample_lib_path | |
bool | save_history | |
int | saved_history_depth | |
bool | send_ltc | |
bool | send_midi_clock | |
bool | send_mmc | |
bool | send_mtc | |
bool | setup_sidechain | |
bool | show_solo_mutes | |
bool | show_video_server_dialog | |
bool | show_vst3_micro_edit_inline | |
float | shuttle_max_speed | |
float | shuttle_speed_factor | |
float | shuttle_speed_threshold | |
ARDOUR.ShuttleUnits | shuttle_units | |
bool | skip_playback | |
bool | solo_control_is_listen_control | |
float | solo_mute_gain | |
bool | solo_mute_override | |
bool | stop_at_session_end | |
bool | stop_recording_on_xrun | |
bool | strict_io | |
bool | timecode_sync_frame_rate | |
bool | trace_midi_input | |
bool | trace_midi_output | |
ARDOUR.TracksAutoNamingRule | tracks_auto_naming | |
float | transient_sensitivity | |
bool | transport_masters_just_roll_when_sync_lost | |
bool | try_autostart_engine | |
std::string | tutorial_manual_url | |
std::string | updates_url | |
bool | use_audio_units | |
bool | use_click_emphasis | |
bool | use_lxvst | |
bool | use_macvst | |
bool | use_master_volume | |
bool | use_monitor_bus | |
bool | use_osc | |
bool | use_plugin_own_gui | |
bool | use_tranzport | |
bool | use_vst3 | |
bool | use_windows_vst | |
bool | verbose_plugin_scan | |
bool | verify_remove_last_capture | |
bool | video_advanced_setup | |
std::string | video_server_docroot | |
std::string | video_server_url | |
bool | work_around_jack_no_copy_optimization | |
std::string | xjadeo_binary |
Inherited from PBD:Stateful
Methods | ||
---|---|---|
void | clear_changes () | |
Forget about any changes to this object's properties | ||
ID | id () | |
OwnedPropertyList | properties () |
∁ ARDOUR:RawMidiParser
C‡: ARDOUR::RawMidiParser
Constructor | ||
---|---|---|
ℂ | ARDOUR.RawMidiParser () | |
Methods | ||
unsigned long | buffer_size () | |
unsigned char* | midi_buffer () | |
bool | process_byte (unsigned char) | |
void | reset () |
↠ ARDOUR:ReadOnlyControl
C‡: boost::shared_ptr< ARDOUR::ReadOnlyControl >, boost::weak_ptr< ARDOUR::ReadOnlyControl >
is-a: PBD:StatefulDestructiblePtr
Methods | ||
---|---|---|
ParameterDescriptor | desc () | |
std::string | describe_parameter () | |
double | get_parameter () | |
bool | isnil () |
Inherited from PBD:StatefulPtr
Methods | ||
---|---|---|
void | clear_changes () | |
Forget about any changes to this object's properties | ||
ID | id () | |
OwnedPropertyList | properties () |
↠ ARDOUR:Readable
C‡: boost::shared_ptr< ARDOUR::AudioReadable >, boost::weak_ptr< ARDOUR::AudioReadable >
Methods | ||
---|---|---|
bool | isnil () | |
ReadableList | load (Session&, std::string) | |
unsigned int | n_channels () | |
long | read (FloatArray, long, long, int) | |
long | readable_length () |
∁ ARDOUR:ReadableList
C‡: std::vector<boost::shared_ptr<ARDOUR::AudioReadable> >
Constructor | ||
---|---|---|
ℂ | ARDOUR.ReadableList () | |
ℂ | ARDOUR.ReadableList () | |
Methods | ||
LuaTable | add (LuaTable {Readable}) | |
Readable | at (unsigned long) | |
void | clear () | |
bool | empty () | |
LuaIter | iter () | |
void | push_back (Readable) | |
unsigned long | size () | |
LuaTable | table () | |
... | to_array (--lua--) |
↠ ARDOUR:Region
C‡: boost::shared_ptr< ARDOUR::Region >, boost::weak_ptr< ARDOUR::Region >
is-a: ARDOUR:SessionObjectPtr
A named object associated with a Session. Objects derived from this class are expected to be destroyed before the session calls drop_references().
Methods | ||
---|---|---|
bool | at_natural_position () | |
bool | automatic () | |
bool | can_move () | |
bool | captured () | |
void | captured_xruns (XrunPositions&, bool) | |
void | clear_sync_position () | |
Control | control (Parameter, bool) | |
bool | covers (timepos_t) | |
void | cut_end (timepos_t) | |
void | cut_front (timepos_t) | |
DataType | data_type () | |
bool | external () | |
bool | has_transients () | |
bool | hidden () | |
bool | import () | |
bool | is_compound () | |
bool | isnil () | |
unsigned int | layer () | |
timecnt_t | length () | |
bool | locked () | |
void | lower () | |
void | lower_to_bottom () | |
StringVector | master_source_names () | |
SourceList | master_sources () | |
void | move_start (timecnt_t) | |
void | move_to_natural_position () | |
bool | muted () | |
void | nudge_position (timecnt_t) | |
bool | opaque () | |
Playlist | playlist () | |
timepos_t | position () | |
How the region parameters play together: POSITION: first sample of the region along the timeline START: first sample of the region within its source(s) LENGTH: number of samples the region represents | ||
bool | position_locked () | |
void | raise () | |
void | raise_to_top () | |
void | set_hidden (bool) | |
void | set_initial_position (timepos_t) | |
void | set_length (timecnt_t) | |
void | set_locked (bool) | |
void | set_muted (bool) | |
bool | set_name (std::string) | |
Note: changing the name of a Region does not constitute an edit | ||
void | set_opaque (bool) | |
void | set_position (timepos_t) | |
void | set_position_locked (bool) | |
void | set_start (timepos_t) | |
void | set_sync_position (timepos_t) | |
void | set_video_locked (bool) | |
float | shift () | |
Source | source (unsigned int) | |
timepos_t | start () | |
float | stretch () | |
bool | sync_marked () | |
LuaTable(timecnt_t, ...) | sync_offset (int&) | |
timepos_t | sync_position () | |
Returns Sync position in session time | ||
Int64List | transients () | |
void | trim_end (timepos_t) | |
void | trim_front (timepos_t) | |
void | trim_to (timepos_t, timecnt_t) | |
bool | video_locked () | |
bool | whole_file () | |
Cast | ||
AudioRegion | to_audioregion () | |
MidiRegion | to_midiregion () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
∁ ARDOUR:RegionFactory
C‡: ARDOUR::RegionFactory
Methods | ||
---|---|---|
Region | clone_region (Region, bool, bool) | |
Region | region_by_id (ID) | |
RegionMap | regions () |
∁ ARDOUR:RegionList
C‡: std::list<boost::shared_ptr<ARDOUR::Region> >
Constructor | ||
---|---|---|
ℂ | ARDOUR.RegionList () | |
Methods | ||
Region | back () | |
bool | empty () | |
Region | front () | |
LuaIter | iter () | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () |
∁ ARDOUR:RegionListPtr
C‡: boost::shared_ptr<std::list<boost::shared_ptr<ARDOUR::Region> > >
Constructor | ||
---|---|---|
ℂ | ARDOUR.RegionListPtr () | |
Methods | ||
LuaTable | add (LuaTable {Region}) | |
bool | empty () | |
LuaIter | iter () | |
void | push_back (Region) | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () | |
void | unique () |
∁ ARDOUR:RegionMap
C‡: std::map<PBD::ID, boost::shared_ptr<ARDOUR::Region> > >
Constructor | ||
---|---|---|
ℂ | ARDOUR.RegionMap () | |
Methods | ||
LuaTable | add (LuaTable {Region}) | |
... | at (--lua--) | |
void | clear () | |
unsigned long | count (ID) | |
bool | empty () | |
LuaIter | iter () | |
unsigned long | size () | |
LuaTable | table () |
∁ ARDOUR:RegionVector
C‡: std::vector<boost::shared_ptr<ARDOUR::Region> >
Constructor | ||
---|---|---|
ℂ | ARDOUR.RegionVector () | |
ℂ | ARDOUR.RegionVector () | |
Methods | ||
LuaTable | add (LuaTable {Region}) | |
Region | at (unsigned long) | |
void | clear () | |
bool | empty () | |
LuaIter | iter () | |
void | push_back (Region) | |
unsigned long | size () | |
LuaTable | table () | |
... | to_array (--lua--) |
↠ ARDOUR:Return
C‡: boost::shared_ptr< ARDOUR::Return >, boost::weak_ptr< ARDOUR::Return >
is-a: ARDOUR:IOProcessor
A mixer strip element (Processor) with 1 or 2 IO elements.
Methods | ||
---|---|---|
bool | isnil () |
Inherited from ARDOUR:IOProcessor
Methods | ||
---|---|---|
IO | input () | |
ChanCount | natural_input_streams () | |
ChanCount | natural_output_streams () | |
IO | output () |
Inherited from ARDOUR:Processor
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
long | capture_offset () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
long | input_latency () | |
ChanCount | input_streams () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
long | signal_latency () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
↠ ARDOUR:Route
C‡: boost::shared_ptr< ARDOUR::Route >, boost::weak_ptr< ARDOUR::Route >
is-a: ARDOUR:Stripable
A named object associated with a Session. Objects derived from this class are expected to be destroyed before the session calls drop_references().
Methods | ||
---|---|---|
bool | active () | |
int | add_aux_send (Route, Processor) | |
Add an aux send to a route.
| ||
int | add_foldback_send (Route, bool) | |
int | add_processor_by_index (Processor, int, ProcessorStreams, bool) | |
Add a processor to a route such that it ends up with a given index into the visible processors.
Returns 0 on success, non-0 on failure. | ||
bool | add_sidechain (Processor) | |
Amp | amp () | |
std::string | comment () | |
bool | customize_plugin_insert (Processor, unsigned int, ChanCount, ChanCount) | |
enable custom plugin-insert configuration
Returns true if successful | ||
DataType | data_type () | |
IO | input () | |
bool | isnil () | |
Delivery | main_outs () | |
the signal processorat at end of the processing chain which produces output | ||
MonitorControl | monitoring_control () | |
MonitorState | monitoring_state () | |
bool | muted () | |
ChanCount | n_inputs () | |
ChanCount | n_outputs () | |
Processor | nth_plugin (unsigned int) | |
Processor | nth_processor (unsigned int) | |
Processor | nth_send (unsigned int) | |
IO | output () | |
PannerShell | panner_shell () | |
PeakMeter | peak_meter () | |
************************************************************* Pure interface begins here************************************************************* | ||
long | playback_latency (bool) | |
int | remove_processor (Processor, ProcessorStreams, bool) | |
remove plugin/processor
Returns 0 on success | ||
int | remove_processors (ProcessorList, ProcessorStreams) | |
bool | remove_sidechain (Processor) | |
int | reorder_processors (ProcessorList, ProcessorStreams) | |
int | replace_processor (Processor, Processor, ProcessorStreams) | |
replace plugin/processor with another
Returns 0 on success | ||
bool | reset_plugin_insert (Processor) | |
reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused)
Returns true if successful | ||
void | set_active (bool, void*) | |
void | set_comment (std::string, void*) | |
void | set_meter_point (MeterPoint) | |
bool | set_name (std::string) | |
bool | set_strict_io (bool) | |
long | signal_latency () | |
bool | soloed () | |
bool | strict_io () | |
Processor | the_instrument () | |
Return the first processor that accepts has at least one MIDI input and at least one audio output. In the vast majority of cases, this will be "the instrument". This does not preclude other MIDI->audio processors later in the processing chain, but that would be a special case not covered by this utility function. | ||
Amp | trim () | |
Cast | ||
Track | to_track () |
Inherited from ARDOUR:Stripable
Methods | ||
---|---|---|
AutomationControl | comp_enable_controllable () | |
AutomationControl | comp_makeup_controllable () | |
AutomationControl | comp_mode_controllable () | |
std::string | comp_mode_name (unsigned int) | |
ReadOnlyControl | comp_redux_controllable () | |
AutomationControl | comp_speed_controllable () | |
std::string | comp_speed_name (unsigned int) | |
AutomationControl | comp_threshold_controllable () | |
unsigned int | eq_band_cnt () | |
std::string | eq_band_name (unsigned int) | |
AutomationControl | eq_enable_controllable () | |
AutomationControl | eq_freq_controllable (unsigned int) | |
AutomationControl | eq_gain_controllable (unsigned int) | |
AutomationControl | eq_q_controllable (unsigned int) | |
AutomationControl | eq_shape_controllable (unsigned int) | |
AutomationControl | filter_enable_controllable (bool) | |
AutomationControl | filter_freq_controllable (bool) | |
AutomationControl | filter_slope_controllable (bool) | |
GainControl | gain_control () | |
bool | is_auditioner () | |
bool | is_hidden () | |
bool | is_master () | |
bool | is_monitor () | |
bool | is_private_route () | |
bool | is_selected () | |
AutomationControl | master_send_enable_controllable () | |
MonitorProcessor | monitor_control () | |
MuteControl | mute_control () | |
AutomationControl | pan_azimuth_control () | |
AutomationControl | pan_elevation_control () | |
AutomationControl | pan_frontback_control () | |
AutomationControl | pan_lfe_control () | |
AutomationControl | pan_width_control () | |
PhaseControl | phase_control () | |
PresentationInfo | presentation_info_ptr () | |
AutomationControl | rec_enable_control () | |
AutomationControl | rec_safe_control () | |
AutomationControl | send_enable_controllable (unsigned int) | |
AutomationControl | send_level_controllable (unsigned int) | |
std::string | send_name (unsigned int) | |
AutomationControl | send_pan_azimuth_controllable (unsigned int) | |
AutomationControl | send_pan_azimuth_enable_controllable (unsigned int) | |
void | set_presentation_order (unsigned int) | |
bool | slaved () | |
bool | slaved_to (VCA) | |
SoloControl | solo_control () | |
SoloIsolateControl | solo_isolate_control () | |
SoloSafeControl | solo_safe_control () | |
GainControl | trim_control () | |
Cast | ||
Automatable | to_automatable () | |
Route | to_route () | |
Slavable | to_slavable () | |
VCA | to_vca () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
∁ ARDOUR:Route:ProcessorStreams
C‡: ARDOUR::Route::ProcessorStreams
A record of the stream configuration at some point in the processor list. Used to return where and why an processor list configuration request failed.
Constructor | ||
---|---|---|
ℂ | ARDOUR.Route.ProcessorStreams () |
∁ ARDOUR:RouteGroup
C‡: ARDOUR::RouteGroup
is-a: ARDOUR:SessionObject
A group identifier for routes.
RouteGroups permit to define properties which are shared among all Routes that use the given identifier.
A route can at most be in one group.
Methods | ||
---|---|---|
int | add (Route) | |
Add a route to a group. Adding a route which is already in the group is allowed; nothing will happen.
| ||
void | clear () | |
void | destroy_subgroup () | |
bool | empty () | |
int | group_master_number () | |
bool | has_subgroup () | |
bool | is_active () | |
bool | is_color () | |
bool | is_gain () | |
bool | is_hidden () | |
bool | is_monitoring () | |
bool | is_mute () | |
bool | is_recenable () | |
bool | is_relative () | |
bool | is_route_active () | |
bool | is_select () | |
bool | is_solo () | |
void | make_subgroup (bool, Placement) | |
int | remove (Route) | |
unsigned int | rgba () | |
RouteListPtr | route_list () | |
void | set_active (bool, void*) | |
void | set_color (bool) | |
void | set_gain (bool) | |
void | set_hidden (bool, void*) | |
void | set_monitoring (bool) | |
void | set_mute (bool) | |
void | set_recenable (bool) | |
void | set_relative (bool, void*) | |
void | set_rgba (unsigned int) | |
set route-group color and notify UI about change | ||
void | set_route_active (bool) | |
void | set_select (bool) | |
void | set_solo (bool) | |
unsigned long | size () |
Inherited from ARDOUR:SessionObject
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () |
∁ ARDOUR:RouteGroupList
C‡: std::list<ARDOUR::RouteGroup* >
Constructor | ||
---|---|---|
ℂ | ARDOUR.RouteGroupList () | |
Methods | ||
RouteGroup | back () | |
bool | empty () | |
RouteGroup | front () | |
LuaIter | iter () | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () |
∁ ARDOUR:RouteList
C‡: std::list<boost::shared_ptr<ARDOUR::Route> >
Constructor | ||
---|---|---|
ℂ | ARDOUR.RouteList () | |
Methods | ||
Route | back () | |
bool | empty () | |
Route | front () | |
LuaIter | iter () | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () |
∁ ARDOUR:RouteListPtr
C‡: boost::shared_ptr<std::list<boost::shared_ptr<ARDOUR::Route> > >
Constructor | ||
---|---|---|
ℂ | ARDOUR.RouteListPtr () | |
Methods | ||
LuaTable | add (LuaTable {Route}) | |
bool | empty () | |
LuaIter | iter () | |
void | push_back (Route) | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () | |
void | unique () |
↠ ARDOUR:Send
C‡: boost::shared_ptr< ARDOUR::Send >, boost::weak_ptr< ARDOUR::Send >
is-a: ARDOUR:Delivery
A mixer strip element (Processor) with 1 or 2 IO elements.
Methods | ||
---|---|---|
GainControl | gain_control () | |
long | get_delay_in () | |
long | get_delay_out () | |
bool | is_foldback () | |
bool | isnil () | |
void | set_remove_on_disconnect (bool) | |
Cast | ||
InternalSend | to_internalsend () |
Inherited from ARDOUR:Delivery
Methods | ||
---|---|---|
PannerShell | panner_shell () |
Inherited from ARDOUR:IOProcessor
Methods | ||
---|---|---|
IO | input () | |
ChanCount | natural_input_streams () | |
ChanCount | natural_output_streams () | |
IO | output () |
Inherited from ARDOUR:Processor
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
long | capture_offset () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
long | input_latency () | |
ChanCount | input_streams () | |
long | output_latency () | |
ChanCount | output_streams () | |
long | playback_offset () | |
long | signal_latency () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
DelayLine | to_delayline () | |
DiskIOProcessor | to_diskioprocessor () | |
DiskReader | to_diskreader () | |
DiskWriter | to_diskwriter () | |
PluginInsert | to_insert () | |
InternalSend | to_internalsend () | |
IOProcessor | to_ioprocessor () | |
Latent | to_latent () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
PolarityProcessor | to_polarityprocessor () | |
Send | to_send () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
∁ ARDOUR:Session
C‡: ARDOUR::Session
Ardour Session
Methods | ||
---|---|---|
bool | abort_empty_reversible_command () | |
Abort reversible command IFF no undo changes have been collected. Returns true if undo operation was aborted. | ||
void | abort_reversible_command () | |
abort an open undo command This must only be called after begin_reversible_command () | ||
bool | actively_recording () | |
double | actual_speed () | |
void | add_command (Command) | |
void | add_internal_send (Route, Processor, Route) | |
void | add_internal_sends (Route, Placement, RouteListPtr) | |
int | add_master_bus (ChanCount) | |
StatefulDiffCommand | add_stateful_diff_command (StatefulDestructiblePtr) | |
create an StatefulDiffCommand from the given object and add it to the stack. This function must only be called after begin_reversible_command. Failing to do so may lead to a crash.
Returns the allocated StatefulDiffCommand (already added via add_command) | ||
bool | apply_nth_mixer_scene (unsigned long) | |
bool | apply_nth_mixer_scene_to (unsigned long, RouteList) | |
void | begin_reversible_command (std::string) | |
begin collecting undo information This call must always be followed by either begin_reversible_command() or commit_reversible_command()
| ||
BundleListPtr | bundles () | |
void | cancel_all_solo () | |
SessionConfiguration | cfg () | |
void | clear_all_solo_state (RouteListPtr) | |
bool | collected_undo_commands () | |
Test if any undo commands were added since the call to begin_reversible_command () This is useful to determine if an undoable action was performed before adding additional information (e.g. selection changes) to the undo transaction. Returns true if undo operation is valid but empty | ||
void | commit_reversible_command (Command) | |
finalize an undo command and commit pending transactions This must only be called after begin_reversible_command ()
| ||
Controllable | controllable_by_id (ID) | |
long | current_end_sample () | |
long | current_start_sample () | |
void | cut_copy_section (timepos_t, timepos_t, timepos_t, bool) | |
void | disable_record (bool, bool) | |
AudioEngine | engine () | |
double | engine_speed () | |
bool | export_track_state (RouteListPtr, std::string) | |
unsigned int | get_block_size () | |
bool | get_play_loop () | |
Route | get_remote_nth_route (unsigned int) | |
Stripable | get_remote_nth_stripable (unsigned int, Flag) | |
RouteList | get_routelist (bool, Flag) | |
RouteListPtr | get_routes () | |
BufferSet | get_scratch_buffers (ChanCount, bool) | |
BufferSet | get_silent_buffers (ChanCount) | |
StripableList | get_stripables () | |
RouteListPtr | get_tracks () | |
unsigned int | get_xrun_count () | |
void | goto_end () | |
void | goto_start (bool) | |
long | io_latency () | |
long | last_transport_start () | |
bool | listening () | |
Locations | locations () | |
Route | master_out () | |
void | maybe_enable_record (bool) | |
Route | monitor_out () | |
std::string | name () | |
RouteList | new_audio_route (int, int, RouteGroup, unsigned int, std::string, Flag, unsigned int) | |
AudioTrackList | new_audio_track (int, int, RouteGroup, unsigned int, std::string, unsigned int, TrackMode, bool, bool) | |
RouteList | new_midi_route (RouteGroup, unsigned int, std::string, bool, PluginInfo, PresetRecord, Flag, unsigned int) | |
MidiTrackList | new_midi_track (ChanCount, ChanCount, bool, PluginInfo, PresetRecord, RouteGroup, unsigned int, std::string, unsigned int, TrackMode, bool, bool) | |
RouteList | new_route_from_template (unsigned int, unsigned int, std::string, std::string, PlaylistDisposition) | |
RouteGroup | new_route_group (std::string) | |
long | nominal_sample_rate () | |
"native" sample rate of session, regardless of current audioengine rate, pullup/down etc | ||
MixerScene | nth_mixer_scene (unsigned long, bool) | |
bool | nth_mixer_scene_valid (unsigned long) | |
std::string | path () | |
SessionPlaylists | playlists () | |
bool | plot_process_graph (std::string) | |
Processor | processor_by_id (ID) | |
RecordState | record_status () | |
void | remove_route_group (RouteGroup) | |
int | rename (std::string) | |
void | request_bounded_roll (long, long) | |
void | request_locate (long, bool, LocateTransportDisposition, TransportRequestSource) | |
void | request_play_loop (bool, bool) | |
void | request_roll (TransportRequestSource) | |
void | request_stop (bool, bool, TransportRequestSource) | |
void | request_transport_speed (double, TransportRequestSource) | |
void | reset_xrun_count () | |
Route | route_by_id (ID) | |