
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 () |
↠ ARDOUR:Amp
C‡: boost::shared_ptr< ARDOUR::Amp >, boost::weak_ptr< ARDOUR::Amp >
is-a: ARDOUR:Processor
Applies a declick operation to all audio inputs, passing the same number of audio outputs, and passing through any other types unchanged.
Methods | ||
---|---|---|
GainControl | gain_control () | |
bool | isnil () |
Inherited from ARDOUR:Processor
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
ChanCount | input_streams () | |
ChanCount | output_streams () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
PluginInsert | to_insert () | |
IOProcessor | to_ioprocessor () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
↠ 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 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) | |
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 () | |
float | get_dsp_load () | |
std::string | get_last_backend_error () | |
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) |
↠ 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 () | |
long | read (FloatArray, FloatArray, FloatArray, long, long, unsigned int) |
Inherited from ARDOUR:Playlist
Methods | ||
---|---|---|
void | add_region (Region, long, float, bool, int, double, bool) | |
Note: this calls set_layer (..., DBL_MAX) so it will reset the layering index of region | ||
Region | combine (RegionList) | |
unsigned int | count_regions_at (long) | |
Playlist | cut (AudioRangeList&, bool) | |
DataType | data_type () | |
void | duplicate (Region, long, long, float) | |
| ||
void | duplicate_range (AudioRange&, float) | |
void | duplicate_until (Region, long, long, long) | |
| ||
Region | find_next_region (long, RegionPoint, int) | |
long | find_next_region_boundary (long, int) | |
long | find_next_transient (long, int) | |
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 (long) | |
RegionListPtr | regions_touched (long, long) | |
Returns regions which have some part within this range. | ||
RegionListPtr | regions_with_end_within (Range) | |
RegionListPtr | regions_with_start_within (Range) | |
void | remove_region (Region) | |
void | split (long) | |
void | split_region (Region, MusicFrame) | |
Region | top_region_at (long) | |
Region | top_unmuted_region_at (long) | |
void | uncombine (Region) | |
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 () | |
std::string | name () | |
Returns Port short name | ||
std::string | pretty_name (bool) | |
Returns Port human readable name | ||
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 | ||
AudioPort | to_audioport () | |
MidiPort | to_midiport () |
∁ ARDOUR:AudioRange
C‡: ARDOUR::AudioRange
Constructor | ||
---|---|---|
ℂ | ARDOUR.AudioRange (long, long, unsigned int) | |
Methods | ||
bool | equal (AudioRange) | |
long | length () | |
Data Members | ||
long | end | |
unsigned int | id | |
long | start |
∁ ARDOUR:AudioRangeList
C‡: std::list<ARDOUR::AudioRange >
Constructor | ||
---|---|---|
ℂ | ARDOUR.AudioRangeList () | |
Methods | ||
AudioRange | back () | |
bool | empty () | |
AudioRange | front () | |
LuaIter | iter () | |
void | reverse () | |
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) | |
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. | ||
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_scale_amplitude (float) |
Inherited from ARDOUR:Region
Methods | ||
---|---|---|
bool | at_natural_position () | |
bool | automatic () | |
bool | can_move () | |
bool | captured () | |
void | clear_sync_position () | |
Control | control (Parameter, bool) | |
bool | covers (long) | |
void | cut_end (long, int) | |
void | cut_front (long, int) | |
DataType | data_type () | |
bool | external () | |
bool | has_transients () | |
bool | hidden () | |
bool | import () | |
bool | is_compound () | |
unsigned int | layer () | |
long | length () | |
bool | locked () | |
void | lower () | |
void | lower_to_bottom () | |
StringVector | master_source_names () | |
SourceList | master_sources () | |
void | move_start (long, int) | |
void | move_to_natural_position () | |
bool | muted () | |
unsigned int | n_channels () | |
void | nudge_position (long) | |
bool | opaque () | |
long | position () | |
How the region parameters play together: POSITION: first frame of the region along the timeline START: first frame of the region within its source(s) LENGTH: number of frames the region represents | ||
bool | position_locked () | |
double | quarter_note () | |
void | raise () | |
void | raise_to_top () | |
void | set_hidden (bool) | |
void | set_initial_position (long) | |
A gui may need to create a region, then place it in an initial position determined by the user. When this takes place within one gui operation, we have to reset _last_position to prevent an implied move. | ||
void | set_length (long, int) | |
void | set_locked (bool) | |
void | set_muted (bool) | |
void | set_opaque (bool) | |
void | set_position (long, int) | |
void | set_position_locked (bool) | |
void | set_start (long) | |
void | set_sync_position (long) | |
Set the region's sync point.
| ||
void | set_video_locked (bool) | |
float | shift () | |
Source | source (unsigned int) | |
long | start () | |
float | stretch () | |
bool | sync_marked () | |
LuaTable(long, ...) | sync_offset (int&) | |
long | sync_position () | |
Returns Sync position in session time | ||
Int64List | transients () | |
void | trim_end (long, int) | |
void | trim_front (long, int) | |
void | trim_to (long, long, int) | |
bool | video_locked () | |
bool | whole_file () | |
Cast | ||
AudioRegion | to_audioregion () | |
MidiRegion | to_midiregion () | |
Readable | to_readable () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
↠ 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 () | |
long | length (long) | |
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 () | |
bool | destructive () | |
bool | has_been_analysed () | |
long | natural_position () | |
long | 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 tracking, playback and editing.
Specifically a track has regions and playlist objects.
Methods | ||
---|---|---|
bool | isnil () |
Inherited from ARDOUR:Track
Methods | ||
---|---|---|
Region | bounce (InterThreadInfo&) | |
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) | |
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 () | |
Playlist | playlist () | |
bool | set_name (std::string) | |
Cast | ||
AudioTrack | to_audio_track () | |
MidiTrack | to_midi_track () |
Inherited from ARDOUR:Route
Methods | ||
---|---|---|
bool | active () | |
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 | ||
IO | input () | |
Delivery | main_outs () | |
the signal processor at at end of the processing chain which produces output | ||
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************************************************************* | ||
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) | |
bool | set_strict_io (bool) | |
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 | ||
Automatable | to_automatable () | |
Slavable | to_slavable () | |
Track | to_track () |
Inherited from ARDOUR:Stripable
Methods | ||
---|---|---|
AutomationControl | comp_enable_control () | |
AutomationControl | comp_makeup_control () | |
AutomationControl | comp_mode_control () | |
std::string | comp_mode_name (unsigned int) | |
ReadOnlyControl | comp_redux_control () | |
AutomationControl | comp_speed_control () | |
std::string | comp_speed_name (unsigned int) | |
AutomationControl | comp_threshold_control () | |
unsigned int | eq_band_cnt () | |
std::string | eq_band_name (unsigned int) | |
AutomationControl | eq_enable_control () | |
AutomationControl | eq_freq_control (unsigned int) | |
AutomationControl | eq_gain_control (unsigned int) | |
AutomationControl | eq_q_control (unsigned int) | |
AutomationControl | eq_shape_control (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_selected () | |
AutomationControl | master_send_enable_control () | |
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_control (unsigned int) | |
AutomationControl | send_level_control (unsigned int) | |
std::string | send_name (unsigned int) | |
void | set_presentation_order (unsigned int) | |
SoloControl | solo_control () | |
SoloIsolateControl | solo_isolate_control () | |
SoloSafeControl | solo_safe_control () | |
GainControl | trim_control () | |
Cast | ||
Route | to_route () | |
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 | ||
---|---|---|
AutomationControl | automation_control (Parameter, bool) | |
bool | isnil () | |
Cast | ||
Slavable | to_slavable () |
↠ ARDOUR:AutomatableSequence
C‡: boost::shared_ptr< ARDOUR::AutomatableSequence<Evoral::Beats> >, boost::weak_ptr< ARDOUR::AutomatableSequence<Evoral::Beats> >
is-a: ARDOUR:Automatable
Methods | ||
---|---|---|
bool | isnil () | |
Cast | ||
Sequence | to_sequence () |
Inherited from ARDOUR:Automatable
Methods | ||
---|---|---|
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 () | |
double | get_value () | |
Get the current effective `user' value based on automation state | ||
bool | isnil () | |
void | set_automation_state (AutoState) | |
void | set_value (double, GroupControlDisposition) | |
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||
void | start_touch (double) | |
void | stop_touch (double) | |
bool | writable () | |
Cast | ||
Control | to_ctrl () | |
SlavableAutomationControl | to_slavable () |
Inherited from PBD:Controllable
Methods | ||
---|---|---|
std::string | name () |
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 (double, double, bool, bool) | |
add automation events
| ||
void | clear (double, double) | |
remove all automation events between the given time range
| ||
void | clear_list () | |
double | eval (double) | |
query value at given time (takes a read-lock, not safe while writing automation)
Returns parameter value | ||
EventList | events () | |
bool | in_write_pass () | |
InterpolationStyle | interpolation () | |
query interpolation style of the automation data Returns Interpolation Style | ||
LuaTable(double, ...) | rt_safe_eval (double, bool&) | |
realtime safe version of eval, may fail if read-lock cannot be taken
Returns parameter value | ||
bool | set_interpolation (InterpolationStyle) | |
set 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 | ||
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 (double) | |
truncate the event list after the given time
| ||
void | truncate_start (double) | |
truncate the event list to the given time
|
∁ 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:BeatsFramesConverter
C‡: ARDOUR::BeatsFramesConverter
Converter between quarter-note beats and frames. Takes distances in quarter-note beats or frames from some origin (supplied to the constructor in frames), and converts them to the opposite unit, taking tempo changes into account.
Constructor | ||
---|---|---|
ℂ | ARDOUR.BeatsFramesConverter (TempoMap, long) | |
Methods | ||
Beats | from (long) | |
Convert B time to A time (A from B) | ||
long | to (Beats) | |
Convert A time to B time (A to B) |
∁ ARDOUR:BufferSet
C‡: ARDOUR::BufferSet
A set of buffers of various types.
These are mainly accessed from Session and passed around as scratch buffers (e.g. 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 (e.g. what they did to the BufferSet). Setting the use counts is realtime safe.
Methods | ||
---|---|---|
ChanCount | count () | |
AudioBuffer | get_audio (unsigned long) | |
MidiBuffer | get_midi (unsigned long) |
∁ 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
|
∁ 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.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, ChanMapping, ChanMapping, unsigned int, long, DataType) |
∁ 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 (double, double, double, double, double) | |
setup filter, set coefficients directly | ||
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
|
∁ 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: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: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 () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
ChanCount | input_streams () | |
ChanCount | output_streams () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
PluginInsert | to_insert () | |
IOProcessor | to_ioprocessor () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
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) | |
bool | empty () | |
LuaIter | iter () | |
void | push_back (DeviceStatus) | |
unsigned long | size () | |
LuaTable | table () |
∁ ARDOUR:DoubleBeatsFramesConverter
C‡: ARDOUR::DoubleBeatsFramesConverter
Converter between quarter-note beats and frames. Takes distances in quarter-note beats or frames from some origin (supplied to the constructor in frames), and converts them to the opposite unit, taking tempo changes into account.
Constructor | ||
---|---|---|
ℂ | ARDOUR.DoubleBeatsFramesConverter (TempoMap, long) | |
Methods | ||
double | from (long) | |
Convert B time to A time (A from B) | ||
long | to (double) | |
Convert A time to B time (A to B) |
∁ 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 () | |
bool | destructive () | |
bool | empty () | |
bool | has_been_analysed () | |
long | length (long) | |
long | natural_position () | |
long | 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 () | |
double | get_value () | |
Get the current effective `user' value based on automation state | ||
void | set_automation_state (AutoState) | |
void | set_value (double, GroupControlDisposition) | |
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||
void | start_touch (double) | |
void | stop_touch (double) | |
bool | writable () | |
Cast | ||
Control | to_ctrl () | |
SlavableAutomationControl | to_slavable () |
Inherited from PBD:Controllable
Methods | ||
---|---|---|
std::string | name () |
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 (e.g. 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 () | |
MidiPort | midi (unsigned int) | |
ChanCount | n_ports () | |
Port | nth (unsigned int) | |
bool | physically_connected () | |
Port | port_by_name (unsigned int) | |
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 () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
ChanCount | input_streams () | |
ChanCount | output_streams () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
PluginInsert | to_insert () | |
IOProcessor | to_ioprocessor () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
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:Location
C‡: ARDOUR::Location
is-a: PBD:StatefulDestructible
Location on Timeline - abstract representation for Markers, Loop/Punch Ranges, CD-Markers etc.
Methods | ||
---|---|---|
long | end () | |
Flags | flags () | |
bool | is_auto_loop () | |
bool | is_auto_punch () | |
bool | is_cd_marker () | |
bool | is_hidden () | |
bool | is_mark () | |
bool | is_range_marker () | |
bool | is_session_range () | |
long | length () | |
void | lock () | |
bool | locked () | |
bool | matches (Flags) | |
int | move_to (long, unsigned int) | |
std::string | name () | |
int | set_end (long, bool, bool, unsigned int) | |
Set end position.
| ||
int | set_length (long, long, bool, unsigned int) | |
int | set_start (long, bool, bool, unsigned int) | |
Set start position.
| ||
long | 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 | auto_loop_location () | |
Location | auto_punch_location () | |
LuaTable(...) | find_all_between (long, long, LocationList&, Flags) | |
long | first_mark_after (long, bool) | |
Location | first_mark_at (long, long) | |
long | first_mark_before (long, bool) | |
LocationList | list () | |
LuaTable(...) | marks_either_side (long, long&, long&) | |
Look for the `marks' (either locations which are marks, or start/end points of range markers) either side of a frame. Note that if frame is exactly on a `mark', that mark will not be considered for returning as before/after.
| ||
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 | ||
---|---|---|
... | 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) | ||
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) | ||
long | monotonic_time () | |
Processor | new_luaproc (Session, std::string) | |
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) | |
create a new Plugin Instance
Returns Processor or nil | ||
PluginInfo | new_plugin_info (std::string, PluginType) | |
search a Plugin
Returns PluginInfo or nil if not found | ||
Processor | nil_proc () | |
NotePtrList | note_list (MidiModel) | |
... | plugin_automation (--lua--) | |
A convenience function to get a Automation Lists and ParamaterDescriptor 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, ParamaterDescriptor | ||
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) | ||
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) |
∁ 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 Readable. If the plugin is not yet initialized, initialize() is called. if 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 intialization 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 () | |
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) | |
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:Meter
C‡: ARDOUR::Meter
Meter, or time signature (beats per bar, and which note type is a beat).
Constructor | ||
---|---|---|
ℂ | ARDOUR.Meter (double, double) | |
Methods | ||
double | divisions_per_bar () | |
double | frames_per_bar (Tempo, long) | |
double | frames_per_grid (Tempo, long) | |
double | note_divisor () |
∁ ARDOUR:MeterSection
C‡: ARDOUR::MeterSection
is-a: ARDOUR:MetricSection
A section of timeline with a certain Meter.
Methods | ||
---|---|---|
void | set_beat (double) | |
void | set_pulse (double) | |
Cast | ||
Meter | to_meter () |
Inherited from ARDOUR:MetricSection
Methods | ||
---|---|---|
double | pulse () |
∁ ARDOUR:MetricSection
C‡: ARDOUR::MetricSection
A section of timeline with a certain Tempo or Meter.
Methods | ||
---|---|---|
double | pulse () | |
void | set_pulse (double) |
∁ ARDOUR:MidiBuffer
C‡: ARDOUR::MidiBuffer
Buffer containing 8-bit unsigned char (MIDI) data.
Methods | ||
---|---|---|
void | copy (MidiBuffer) | |
bool | empty () | |
bool | push_back (long, 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 (e.g. 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) | |
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_command is called and ownership is taken. |
Inherited from ARDOUR:AutomatableSequence
Cast | ||
---|---|---|
Sequence | to_sequence () |
Inherited from ARDOUR:Automatable
Methods | ||
---|---|---|
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, long, float, bool, int, double, bool) | |
Note: this calls set_layer (..., DBL_MAX) so it will reset the layering index of region | ||
Region | combine (RegionList) | |
unsigned int | count_regions_at (long) | |
Playlist | cut (AudioRangeList&, bool) | |
DataType | data_type () | |
void | duplicate (Region, long, long, float) | |
| ||
void | duplicate_range (AudioRange&, float) | |
void | duplicate_until (Region, long, long, long) | |
| ||
Region | find_next_region (long, RegionPoint, int) | |
long | find_next_region_boundary (long, int) | |
long | find_next_transient (long, int) | |
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 (long) | |
RegionListPtr | regions_touched (long, long) | |
Returns regions which have some part within this range. | ||
RegionListPtr | regions_with_end_within (Range) | |
RegionListPtr | regions_with_start_within (Range) | |
void | remove_region (Region) | |
void | split (long) | |
void | split_region (Region, MusicFrame) | |
Region | top_region_at (long) | |
Region | top_unmuted_region_at (long) | |
void | uncombine (Region) | |
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) |
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 () | |
std::string | name () | |
Returns Port short name | ||
std::string | pretty_name (bool) | |
Returns Port human readable name | ||
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 | ||
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 () | |
double | length_beats () | |
MidiSource | midi_source (unsigned int) | |
MidiModel | model () | |
double | start_beats () |
Inherited from ARDOUR:Region
Methods | ||
---|---|---|
bool | at_natural_position () | |
bool | automatic () | |
bool | can_move () | |
bool | captured () | |
void | clear_sync_position () | |
Control | control (Parameter, bool) | |
bool | covers (long) | |
void | cut_end (long, int) | |
void | cut_front (long, int) | |
DataType | data_type () | |
bool | external () | |
bool | has_transients () | |
bool | hidden () | |
bool | import () | |
bool | is_compound () | |
unsigned int | layer () | |
long | length () | |
bool | locked () | |
void | lower () | |
void | lower_to_bottom () | |
StringVector | master_source_names () | |
SourceList | master_sources () | |
void | move_start (long, int) | |
void | move_to_natural_position () | |
bool | muted () | |
unsigned int | n_channels () | |
void | nudge_position (long) | |
bool | opaque () | |
long | position () | |
How the region parameters play together: POSITION: first frame of the region along the timeline START: first frame of the region within its source(s) LENGTH: number of frames the region represents | ||
bool | position_locked () | |
double | quarter_note () | |
void | raise () | |
void | raise_to_top () | |
void | set_hidden (bool) | |
void | set_initial_position (long) | |
A gui may need to create a region, then place it in an initial position determined by the user. When this takes place within one gui operation, we have to reset _last_position to prevent an implied move. | ||
void | set_length (long, int) | |
void | set_locked (bool) | |
void | set_muted (bool) | |
void | set_opaque (bool) | |
void | set_position (long, int) | |
void | set_position_locked (bool) | |
void | set_start (long) | |
void | set_sync_position (long) | |
Set the region's sync point.
| ||
void | set_video_locked (bool) | |
float | shift () | |
Source | source (unsigned int) | |
long | start () | |
float | stretch () | |
bool | sync_marked () | |
LuaTable(long, ...) | sync_offset (int&) | |
long | sync_position () | |
Returns Sync position in session time | ||
Int64List | transients () | |
void | trim_end (long, int) | |
void | trim_front (long, int) | |
void | trim_to (long, long, int) | |
bool | video_locked () | |
bool | whole_file () | |
Cast | ||
AudioRegion | to_audioregion () | |
MidiRegion | to_midiregion () | |
Readable | to_readable () |
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 () | |
long | length (long) | |
MidiModel | model () |
Inherited from ARDOUR:Source
Methods | ||
---|---|---|
std::string | ancestor_name () | |
bool | can_be_analysed () | |
bool | destructive () | |
bool | has_been_analysed () | |
long | natural_position () | |
long | 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 tracking, playback and editing.
Specifically a track has regions and playlist objects.
Methods | ||
---|---|---|
bool | isnil () |
Inherited from ARDOUR:Track
Methods | ||
---|---|---|
Region | bounce (InterThreadInfo&) | |
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) | |
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 () | |
Playlist | playlist () | |
bool | set_name (std::string) | |
Cast | ||
AudioTrack | to_audio_track () | |
MidiTrack | to_midi_track () |
Inherited from ARDOUR:Route
Methods | ||
---|---|---|
bool | active () | |
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 | ||
IO | input () | |
Delivery | main_outs () | |
the signal processorat at end of the processing chain which produces output | ||
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************************************************************* | ||
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) | |
bool | set_strict_io (bool) | |
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 | ||
Automatable | to_automatable () | |
Slavable | to_slavable () | |
Track | to_track () |
Inherited from ARDOUR:Stripable
Methods | ||
---|---|---|
AutomationControl | comp_enable_control () | |
AutomationControl | comp_makeup_control () | |
AutomationControl | comp_mode_control () | |
std::string | comp_mode_name (unsigned int) | |
ReadOnlyControl | comp_redux_control () | |
AutomationControl | comp_speed_control () | |
std::string | comp_speed_name (unsigned int) | |
AutomationControl | comp_threshold_control () | |
unsigned int | eq_band_cnt () | |
std::string | eq_band_name (unsigned int) | |
AutomationControl | eq_enable_control () | |
AutomationControl | eq_freq_control (unsigned int) | |
AutomationControl | eq_gain_control (unsigned int) | |
AutomationControl | eq_q_control (unsigned int) | |
AutomationControl | eq_shape_control (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_selected () | |
AutomationControl | master_send_enable_control () | |
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_control (unsigned int) | |
AutomationControl | send_level_control (unsigned int) | |
std::string | send_name (unsigned int) | |
void | set_presentation_order (unsigned int) | |
SoloControl | solo_control () | |
SoloIsolateControl | solo_isolate_control () | |
SoloSafeControl | solo_safe_control () | |
GainControl | trim_control () | |
Cast | ||
Route | to_route () | |
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: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 () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
ChanCount | input_streams () | |
ChanCount | output_streams () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
PluginInsert | to_insert () | |
IOProcessor | to_ioprocessor () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
∁ ARDOUR:MusicFrame
C‡: ARDOUR::MusicFrame
Constructor | ||
---|---|---|
ℂ | ARDOUR.MusicFrame (long, int) | |
Methods | ||
void | set (long, int) | |
Data Members | ||
int | division | |
long | frame |
↠ 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 () | |
bool | muted () | |
bool | muted_by_self () |
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 () | |
double | get_value () | |
Get the current effective `user' value based on automation state | ||
void | set_automation_state (AutoState) | |
void | set_value (double, GroupControlDisposition) | |
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||
void | start_touch (double) | |
void | stop_touch (double) | |
bool | writable () | |
Cast | ||
Control | to_ctrl () | |
SlavableAutomationControl | to_slavable () |
Inherited from PBD:Controllable
Methods | ||
---|---|---|
std::string | name () |
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<Evoral::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: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 | ||
std::string | label |
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 | ||
bool | toggled | |
True iff parameter is boolean | ||
float | upper | |
Maximum value (in Hz, for frequencies) |
↠ 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) | |
void | reset_max () | |
void | set_type (MeterType) |
Inherited from ARDOUR:Processor
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
ChanCount | input_streams () | |
ChanCount | output_streams () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
PluginInsert | to_insert () | |
IOProcessor | to_ioprocessor () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
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 () | |
double | get_value () | |
Get the current effective `user' value based on automation state | ||
void | set_automation_state (AutoState) | |
void | set_value (double, GroupControlDisposition) | |
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||
void | start_touch (double) | |
void | stop_touch (double) | |
bool | writable () | |
Cast | ||
Control | to_ctrl () | |
SlavableAutomationControl | to_slavable () |
Inherited from PBD:Controllable
Methods | ||
---|---|---|
std::string | name () |
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, long, float, bool, int, double, bool) | |
Note: this calls set_layer (..., DBL_MAX) so it will reset the layering index of region | ||
Region | combine (RegionList) | |
unsigned int | count_regions_at (long) | |
Playlist | cut (AudioRangeList&, bool) | |
DataType | data_type () | |
void | duplicate (Region, long, long, float) | |
| ||
void | duplicate_range (AudioRange&, float) | |
void | duplicate_until (Region, long, long, long) | |
| ||
Region | find_next_region (long, RegionPoint, int) | |
long | find_next_region_boundary (long, int) | |
long | find_next_transient (long, int) | |
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 (long) | |
RegionListPtr | regions_touched (long, long) | |
Returns regions which have some part within this range. | ||
RegionListPtr | regions_with_end_within (Range) | |
RegionListPtr | regions_with_start_within (Range) | |
void | remove_region (Region) | |
void | split (long) | |
void | split_region (Region, MusicFrame) | |
Region | top_region_at (long) | |
Region | top_unmuted_region_at (long) | |
void | uncombine (Region) | |
Cast | ||
AudioPlaylist | to_audioplaylist () | |
MidiPlaylist | to_midiplaylist () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
↠ 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 () | |
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) | |
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 () | |
double | get_value () | |
Get the current effective `user' value based on automation state | ||
void | set_automation_state (AutoState) | |
void | set_value (double, GroupControlDisposition) | |
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||
void | start_touch (double) | |
void | stop_touch (double) | |
bool | writable () | |
Cast | ||
Control | to_ctrl () | |
SlavableAutomationControl | to_slavable () |
Inherited from PBD:Controllable
Methods | ||
---|---|---|
std::string | name () |
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: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 | deactivate () | |
ChanMapping | input_map (unsigned int) | |
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) | |
bool | strict_io_configured () |
Inherited from ARDOUR:Processor
Methods | ||
---|---|---|
bool | active () | |
std::string | display_name () | |
bool | display_to_user () | |
ChanCount | input_streams () | |
ChanCount | output_streams () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
PluginInsert | to_insert () | |
IOProcessor | to_ioprocessor () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
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 () | |
bool | isnil () | |
std::string | name () | |
Returns Port short name | ||
std::string | pretty_name (bool) | |
Returns Port human readable name | ||
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 | ||
AudioPort | to_audioport () | |
MidiPort | to_midiport () |
∅ ARDOUR:PortEngine
C‡: ARDOUR::PortEngine
PortEngine is an abstract base class that defines the functionality required by Ardour.
A Port is basically an endpoint for a datastream (which can either be continuous, like audio, or event-based, like MIDI). Ports have buffers associated with them into which data can be written (if they are output ports) and from which data can be read (if they input ports). Ports can be connected together so that data written to an output port can be read from an input port. These connections can be 1:1, 1:N OR N:1.
Ports may be associated with software only, or with hardware. Hardware related ports are often referred to as physical, and correspond to some relevant physical entity on a hardware device, such as an audio jack or a MIDI connector. Physical ports may be potentially asked to monitor their inputs, though some implementations may not support this.
Most physical ports will also be considered "terminal", which means that data delivered there or read from there will go to or comes from a system outside of the PortEngine implementation's control (e.g. the analog domain for audio, or external MIDI devices for MIDI). Non-physical ports can also be considered "terminal". For example, the output port of a software synthesizer is a terminal port, because the data contained in its buffer does not and cannot be considered to come from any other port - it is synthesized by its owner.
Ports also have latency associated with them. Each port has a playback latency and a capture latency:
capture latency: how long since the data read from the buffer of a port arrived at at a terminal port. The data will have come from the "outside world" if the terminal port is also physical, or will have been synthesized by the entity that owns the terminal port.
playback latency: how long until the data written to the buffer of port will reach a terminal port.
For more detailed questions about the PortEngine API, consult the JACK API documentation, on which this entire object is based.
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) |
↠ 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) | |
bool | empty () | |
LuaIter | iter () | |
void | push_back (PresetRecord) | |
unsigned long | size () | |
LuaTable | table () |
↠ 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 () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
ChanCount | input_streams () | |
bool | isnil () | |
ChanCount | output_streams () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
PluginInsert | to_insert () | |
IOProcessor | to_ioprocessor () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
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) | |
bool | empty () | |
LuaIter | iter () | |
void | push_back (Processor) | |
unsigned long | size () | |
LuaTable | table () |
∅ 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:FrameposProperty
C‡: PBD::PropertyDescriptor<long>
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 | containsFramePos (FrameposProperty) |
∅ 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 () | |
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 () | |
bool | get_copy_demo_sessions () | |
bool | get_create_xrun_marker () | |
FadeShape | get_default_fade_shape () | |
std::string | get_default_session_parent_dir () | |
DenormalModel | get_denormal_model () | |
bool | get_denormal_protection () | |
bool | get_disable_disarm_during_roll () | |
bool | get_discover_audio_units () | |
bool | get_discover_vst_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 () | |
std::string | get_freesound_download_dir () | |
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_frames () | |
bool | get_latched_record_enable () | |
LayerModel | get_layer_model () | |
bool | get_link_send_and_route_panner () | |
std::string | get_linux_pingback_url () | |
ListenPosition | get_listen_position () | |
bool | get_locate_while_waiting_for_sync () | |
bool | get_loop_is_mode () | |
std::string | get_ltc_output_port () | |
float | get_ltc_output_volume () | |
bool | get_ltc_send_continuously () | |
std::string | get_ltc_source_port () | |
float | get_max_gain () | |
unsigned int | get_max_recent_sessions () | |
unsigned int | get_max_recent_templates () | |
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_feedback () | |
bool | get_midi_input_follows_selection () | |
float | get_midi_readahead () | |
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 () | |
std::string | get_osx_pingback_url () | |
AutoConnectOption | get_output_auto_connect () | |
unsigned int | get_periodic_safety_backup_interval () | |
bool | get_periodic_safety_backups () | |
PFLPosition | get_pfl_position () | |
std::string | get_plugin_path_lxvst () | |
std::string | get_plugin_path_vst () | |
bool | get_plugins_stop_with_transport () | |
long | get_postroll () | |
long | get_preroll () | |
float | get_preroll_seconds () | |
int | get_processor_usage () | |
bool | get_quieten_at_speed () | |
long | get_range_location_minimum () | |
std::string | get_reference_manual_url () | |
bool | get_region_boundaries_from_onscreen_tracks () | |
bool | get_region_boundaries_from_selected_tracks () | |
RegionSelectionAfterSplit | get_region_selection_after_split () | |
bool | get_replicate_missing_region_channels () | |
float | get_rf_speed () | |
bool | get_save_history () | |
int | get_saved_history_depth () | |
bool | get_seamless_loop () | |
bool | get_send_ltc () | |
bool | get_send_midi_clock () | |
bool | get_send_mmc () | |
bool | get_send_mtc () | |
bool | get_show_solo_mutes () | |
bool | get_show_video_export_info () | |
bool | get_show_video_server_dialog () | |
ShuttleBehaviour | get_shuttle_behaviour () | |
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 () | |
SyncSource | get_sync_source () | |
bool | get_tape_machine_mode () | |
bool | get_timecode_source_2997 () | |
bool | get_timecode_source_is_synced () | |
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_try_autostart_engine () | |
std::string | get_tutorial_manual_url () | |
std::string | get_updates_url () | |
bool | get_use_click_emphasis () | |
bool | get_use_lxvst () | |
bool | get_use_macvst () | |
bool | get_use_monitor_bus () | |
bool | get_use_osc () | |
bool | get_use_overlap_equivalency () | |
bool | get_use_plugin_own_gui () | |
bool | get_use_tranzport () | |
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 () | |
int | get_vst_scan_timeout () | |
std::string | get_windows_pingback_url () | |
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_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_copy_demo_sessions (bool) | |
bool | set_create_xrun_marker (bool) | |
bool | set_default_fade_shape (FadeShape) | |
bool | set_default_session_parent_dir (std::string) | |
bool | set_denormal_model (DenormalModel) | |
bool | set_denormal_protection (bool) | |
bool | set_disable_disarm_during_roll (bool) | |
bool | set_discover_audio_units (bool) | |
bool | set_discover_vst_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_freesound_download_dir (std::string) | |
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_frames (int) | |
bool | set_latched_record_enable (bool) | |
bool | set_layer_model (LayerModel) | |
bool | set_link_send_and_route_panner (bool) | |
bool | set_linux_pingback_url (std::string) | |
bool | set_listen_position (ListenPosition) | |
bool | set_locate_while_waiting_for_sync (bool) | |
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_ltc_source_port (std::string) | |
bool | set_max_gain (float) | |
bool | set_max_recent_sessions (unsigned int) | |
bool | set_max_recent_templates (unsigned int) | |
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_feedback (bool) | |
bool | set_midi_input_follows_selection (bool) | |
bool | set_midi_readahead (float) | |
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_osx_pingback_url (std::string) | |
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_plugin_path_lxvst (std::string) | |
bool | set_plugin_path_vst (std::string) | |
bool | set_plugins_stop_with_transport (bool) | |
bool | set_postroll (long) | |
bool | set_preroll (long) | |
bool | set_preroll_seconds (float) | |
bool | set_processor_usage (int) | |
bool | set_quieten_at_speed (bool) | |
bool | set_range_location_minimum (long) | |
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_selection_after_split (RegionSelectionAfterSplit) | |
bool | set_replicate_missing_region_channels (bool) | |
bool | set_rf_speed (float) | |
bool | set_save_history (bool) | |
bool | set_saved_history_depth (int) | |
bool | set_seamless_loop (bool) | |
bool | set_send_ltc (bool) | |
bool | set_send_midi_clock (bool) | |
bool | set_send_mmc (bool) | |
bool | set_send_mtc (bool) | |
bool | set_show_solo_mutes (bool) | |
bool | set_show_video_export_info (bool) | |
bool | set_show_video_server_dialog (bool) | |
bool | set_shuttle_behaviour (ShuttleBehaviour) | |
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_sync_source (SyncSource) | |
bool | set_tape_machine_mode (bool) | |
bool | set_timecode_source_2997 (bool) | |
bool | set_timecode_source_is_synced (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_try_autostart_engine (bool) | |
bool | set_tutorial_manual_url (std::string) | |
bool | set_updates_url (std::string) | |
bool | set_use_click_emphasis (bool) | |
bool | set_use_lxvst (bool) | |
bool | set_use_macvst (bool) | |
bool | set_use_monitor_bus (bool) | |
bool | set_use_osc (bool) | |
bool | set_use_overlap_equivalency (bool) | |
bool | set_use_plugin_own_gui (bool) | |
bool | set_use_tranzport (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_vst_scan_timeout (int) | |
bool | set_windows_pingback_url (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 | |
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 | |
bool | copy_demo_sessions | |
bool | create_xrun_marker | |
ARDOUR.FadeShape | default_fade_shape | |
std::string | default_session_parent_dir | |
ARDOUR.DenormalModel | denormal_model | |
bool | denormal_protection | |
bool | disable_disarm_during_roll | |
bool | discover_audio_units | |
bool | discover_vst_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 | |
std::string | freesound_download_dir | |
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_frames | |
bool | latched_record_enable | |
ARDOUR.LayerModel | layer_model | |
bool | link_send_and_route_panner | |
std::string | linux_pingback_url | |
ARDOUR.ListenPosition | listen_position | |
bool | locate_while_waiting_for_sync | |
bool | loop_is_mode | |
std::string | ltc_output_port | |
float | ltc_output_volume | |
bool | ltc_send_continuously | |
std::string | ltc_source_port | |
float | max_gain | |
unsigned int | max_recent_sessions | |
unsigned int | max_recent_templates | |
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_feedback | |
bool | midi_input_follows_selection | |
float | midi_readahead | |
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 | |
std::string | osx_pingback_url | |
ARDOUR.AutoConnectOption | output_auto_connect | |
unsigned int | periodic_safety_backup_interval | |
bool | periodic_safety_backups | |
ARDOUR.PFLPosition | pfl_position | |
std::string | plugin_path_lxvst | |
std::string | plugin_path_vst | |
bool | plugins_stop_with_transport | |
long | postroll | |
long | preroll | |
float | preroll_seconds | |
int | processor_usage | |
bool | quieten_at_speed | |
long | range_location_minimum | |
std::string | reference_manual_url | |
bool | region_boundaries_from_onscreen_tracks | |
bool | region_boundaries_from_selected_tracks | |
ARDOUR.RegionSelectionAfterSplit | region_selection_after_split | |
bool | replicate_missing_region_channels | |
float | rf_speed | |
bool | save_history | |
int | saved_history_depth | |
bool | seamless_loop | |
bool | send_ltc | |
bool | send_midi_clock | |
bool | send_mmc | |
bool | send_mtc | |
bool | show_solo_mutes | |
bool | show_video_export_info | |
bool | show_video_server_dialog | |
ARDOUR.ShuttleBehaviour | shuttle_behaviour | |
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 | |
ARDOUR.SyncSource | sync_source | |
bool | tape_machine_mode | |
bool | timecode_source_2997 | |
bool | timecode_source_is_synced | |
bool | timecode_sync_frame_rate | |
bool | trace_midi_input | |
bool | trace_midi_output | |
ARDOUR.TracksAutoNamingRule | tracks_auto_naming | |
float | transient_sensitivity | |
bool | try_autostart_engine | |
std::string | tutorial_manual_url | |
std::string | updates_url | |
bool | use_click_emphasis | |
bool | use_lxvst | |
bool | use_macvst | |
bool | use_monitor_bus | |
bool | use_osc | |
bool | use_overlap_equivalency | |
bool | use_plugin_own_gui | |
bool | use_tranzport | |
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 | |
int | vst_scan_timeout | |
std::string | windows_pingback_url |
Inherited from PBD:Stateful
Methods | ||
---|---|---|
void | clear_changes () | |
Forget about any changes to this object's properties | ||
ID | id () | |
OwnedPropertyList | properties () |
↠ 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::Readable >, boost::weak_ptr< ARDOUR::Readable >
Methods | ||
---|---|---|
bool | isnil () | |
unsigned int | n_channels () | |
long | read (FloatArray, long, long, int) | |
long | readable_length () |
↠ 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 | clear_sync_position () | |
Control | control (Parameter, bool) | |
bool | covers (long) | |
void | cut_end (long, int) | |
void | cut_front (long, int) | |
DataType | data_type () | |
bool | external () | |
bool | has_transients () | |
bool | hidden () | |
bool | import () | |
bool | is_compound () | |
bool | isnil () | |
unsigned int | layer () | |
long | length () | |
bool | locked () | |
void | lower () | |
void | lower_to_bottom () | |
StringVector | master_source_names () | |
SourceList | master_sources () | |
void | move_start (long, int) | |
void | move_to_natural_position () | |
bool | muted () | |
unsigned int | n_channels () | |
void | nudge_position (long) | |
bool | opaque () | |
long | position () | |
How the region parameters play together: POSITION: first frame of the region along the timeline START: first frame of the region within its source(s) LENGTH: number of frames the region represents | ||
bool | position_locked () | |
double | quarter_note () | |
void | raise () | |
void | raise_to_top () | |
void | set_hidden (bool) | |
void | set_initial_position (long) | |
A gui may need to create a region, then place it in an initial position determined by the user. When this takes place within one gui operation, we have to reset _last_position to prevent an implied move. | ||
void | set_length (long, int) | |
void | set_locked (bool) | |
void | set_muted (bool) | |
void | set_opaque (bool) | |
void | set_position (long, int) | |
void | set_position_locked (bool) | |
void | set_start (long) | |
void | set_sync_position (long) | |
Set the region's sync point.
| ||
void | set_video_locked (bool) | |
float | shift () | |
Source | source (unsigned int) | |
long | start () | |
float | stretch () | |
bool | sync_marked () | |
LuaTable(long, ...) | sync_offset (int&) | |
long | sync_position () | |
Returns Sync position in session time | ||
Int64List | transients () | |
void | trim_end (long, int) | |
void | trim_front (long, int) | |
void | trim_to (long, long, int) | |
bool | video_locked () | |
bool | whole_file () | |
Cast | ||
AudioRegion | to_audioregion () | |
MidiRegion | to_midiregion () | |
Readable | to_readable () |
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) | |
bool | empty () | |
LuaIter | iter () | |
void | push_back (Region) | |
unsigned long | size () | |
LuaTable | table () |
↠ 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_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 | ||
IO | input () | |
bool | isnil () | |
Delivery | main_outs () | |
the signal processorat at end of the processing chain which produces output | ||
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************************************************************* | ||
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) | |
bool | set_name (std::string) | |
bool | set_strict_io (bool) | |
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 | ||
Automatable | to_automatable () | |
Slavable | to_slavable () | |
Track | to_track () |
Inherited from ARDOUR:Stripable
Methods | ||
---|---|---|
AutomationControl | comp_enable_control () | |
AutomationControl | comp_makeup_control () | |
AutomationControl | comp_mode_control () | |
std::string | comp_mode_name (unsigned int) | |
ReadOnlyControl | comp_redux_control () | |
AutomationControl | comp_speed_control () | |
std::string | comp_speed_name (unsigned int) | |
AutomationControl | comp_threshold_control () | |
unsigned int | eq_band_cnt () | |
std::string | eq_band_name (unsigned int) | |
AutomationControl | eq_enable_control () | |
AutomationControl | eq_freq_control (unsigned int) | |
AutomationControl | eq_gain_control (unsigned int) | |
AutomationControl | eq_q_control (unsigned int) | |
AutomationControl | eq_shape_control (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_selected () | |
AutomationControl | master_send_enable_control () | |
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_control (unsigned int) | |
AutomationControl | send_level_control (unsigned int) | |
std::string | send_name (unsigned int) | |
void | set_presentation_order (unsigned int) | |
SoloControl | solo_control () | |
SoloIsolateControl | solo_isolate_control () | |
SoloSafeControl | solo_safe_control () | |
GainControl | trim_control () | |
Cast | ||
Route | to_route () | |
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:Session
C‡: ARDOUR::Session
Ardour Session
Methods | ||
---|---|---|
void | abort_reversible_command () | |
abort an open undo command This must only be called after begin_reversible_command () | ||
bool | actively_recording () | |
void | add_command (Command) | |
void | add_internal_sends (Route, Placement, RouteListPtr) | |
int | add_master_bus (ChanCount) | |
void | add_monitor_section () | |
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) | ||
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()
| ||
void | cancel_all_solo () | |
SessionConfiguration | cfg () | |
void | clear_all_solo_state (RouteListPtr) | |
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_frame () | |
long | current_start_frame () | |
void | disable_record (bool, bool) | |
bool | end_is_free () | |
AudioEngine | engine () | |
bool | export_track_state (RouteListPtr, std::string) | |
long | frame_rate () | |
"actual" sample rate of session, set by current audioengine rate, pullup/down etc. | ||
unsigned int | get_block_size () | |
bool | get_play_loop () | |
Route | get_remote_nth_route (unsigned int) | |
Stripable | get_remote_nth_stripable (unsigned int, Flag) | |
RouteListPtr | get_routes () | |
BufferSet | get_scratch_buffers (ChanCount, bool) | |
BufferSet | get_silent_buffers (ChanCount) | |
StripableList | get_stripables () | |
RouteListPtr | get_tracks () | |
void | goto_end () | |
void | goto_start (bool) | |
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) | |
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) | |
RouteList | new_route_from_template (unsigned int, unsigned int, std::string, std::string, PlaylistDisposition) | |
RouteGroup | new_route_group (std::string) | |
long | nominal_frame_rate () | |
"native" sample rate of session, regardless of current audioengine rate, pullup/down etc | ||
std::string | path () | |
Processor | processor_by_id (ID) | |
RecordState | record_status () | |
void | remove_monitor_section () | |
void | remove_route_group (RouteGroup) | |
void | request_locate (long, bool) | |
void | request_play_loop (bool, bool) | |
void | request_stop (bool, bool) | |
void | request_transport_speed (double, bool) | |
Route | route_by_id (ID) | |
Route | route_by_name (std::string) | |
Route | route_by_selected_count (unsigned int) | |
RouteGroupList | route_groups () | |
... | sample_to_timecode_lua (--lua--) | |
double | samples_per_timecode_frame () | |
int | save_state (std::string, bool, bool, bool) | |
save session
Returns zero on success | ||
void | scripts_changed () | |
void | set_control (AutomationControl, double, GroupControlDisposition) | |
void | set_controls (ControlListPtr, double, GroupControlDisposition) | |
void | set_dirty () | |
void | set_end_is_free (bool) | |
void | set_exclusive_input_active (RouteListPtr, bool, bool) | |
std::string | snap_name () | |
bool | solo_isolated () | |
bool | soloing () | |
Source | source_by_id (ID) | |
TempoMap | tempo_map () | |
bool | timecode_drop_frames () | |
long | timecode_frames_per_hour () | |
double | timecode_frames_per_second () | |
... | timecode_to_sample_lua (--lua--) | |
Track | track_by_diskstream_id (ID) | |
long | transport_frame () | |
bool | transport_rolling () | |
double | transport_speed () | |
StringList | unknown_processors () | |
VCAManager | vca_manager () | |
long | worst_input_latency () | |
long | worst_output_latency () | |
long | worst_playback_latency () | |
long | worst_track_latency () |
∁ ARDOUR:SessionConfiguration
C‡: ARDOUR::SessionConfiguration
is-a: PBD:Configuration
Base class for objects with saveable and undoable state
Methods | ||
---|---|---|
std::string | get_audio_search_path () | |
bool | get_auto_input () | |
bool | get_auto_play () | |
bool | get_auto_return () | |
bool | get_count_in () | |
unsigned int | get_destructive_xfade_msecs () | |
bool | get_external_sync () | |
bool | get_glue_new_markers_to_bars_and_beats () | |
bool | get_glue_new_regions_to_bars_and_beats () | |
InsertMergePolicy | get_insert_merge_policy () | |
bool | get_jack_time_master () | |
bool | get_layered_record_mode () | |
unsigned int | get_meterbridge_label_height () | |
bool | get_midi_copy_is_fork () | |
std::string | get_midi_search_path () | |
long | get_minitimeline_span () | |
SampleFormat | get_native_file_data_format () | |
HeaderFormat | get_native_file_header_format () | |
bool | get_punch_in () | |
bool | get_punch_out () | |
std::string | get_raid_path () | |
bool | get_realtime_export () | |
MonitorChoice | get_session_monitoring () | |
bool | get_show_busses_on_meterbridge () | |
bool | get_show_group_tabs () | |
bool | get_show_master_on_meterbridge () | |
bool | get_show_midi_on_meterbridge () | |
bool | get_show_monitor_on_meterbridge () | |
bool | get_show_mute_on_meterbridge () | |
bool | get_show_name_on_meterbridge () | |
bool | get_show_rec_on_meterbridge () | |
bool | get_show_region_fades () | |
bool | get_show_solo_on_meterbridge () | |
bool | get_show_summary () | |
std::string | get_slave_timecode_offset () | |
unsigned int | get_subframes_per_frame () | |
std::string | get_take_name () | |
TimecodeFormat | get_timecode_format () | |
std::string | get_timecode_generator_offset () | |
long | get_timecode_offset () | |
bool | get_timecode_offset_negative () | |
bool | get_track_name_number () | |
bool | get_track_name_take () | |
bool | get_use_monitor_fades () | |
bool | get_use_region_fades () | |
bool | get_use_transport_fades () | |
bool | get_use_video_file_fps () | |
bool | get_use_video_sync () | |
float | get_video_pullup () | |
bool | get_videotimeline_pullup () | |
double | get_wave_amplitude_zoom () | |
unsigned short | get_wave_zoom_factor () | |
bool | set_audio_search_path (std::string) | |
bool | set_auto_input (bool) | |
bool | set_auto_play (bool) | |
bool | set_auto_return (bool) | |
bool | set_count_in (bool) | |
bool | set_destructive_xfade_msecs (unsigned int) | |
bool | set_external_sync (bool) | |
bool | set_glue_new_markers_to_bars_and_beats (bool) | |
bool | set_glue_new_regions_to_bars_and_beats (bool) | |
bool | set_insert_merge_policy (InsertMergePolicy) | |
bool | set_jack_time_master (bool) | |
bool | set_layered_record_mode (bool) | |
bool | set_meterbridge_label_height (unsigned int) | |
bool | set_midi_copy_is_fork (bool) | |
bool | set_midi_search_path (std::string) | |
bool | set_minitimeline_span (long) | |
bool | set_native_file_data_format (SampleFormat) | |
bool | set_native_file_header_format (HeaderFormat) | |
bool | set_punch_in (bool) | |
bool | set_punch_out (bool) | |
bool | set_raid_path (std::string) | |
bool | set_realtime_export (bool) | |
bool | set_session_monitoring (MonitorChoice) | |
bool | set_show_busses_on_meterbridge (bool) | |
bool | set_show_group_tabs (bool) | |
bool | set_show_master_on_meterbridge (bool) | |
bool | set_show_midi_on_meterbridge (bool) | |
bool | set_show_monitor_on_meterbridge (bool) | |
bool | set_show_mute_on_meterbridge (bool) | |
bool | set_show_name_on_meterbridge (bool) | |
bool | set_show_rec_on_meterbridge (bool) | |
bool | set_show_region_fades (bool) | |
bool | set_show_solo_on_meterbridge (bool) | |
bool | set_show_summary (bool) | |
bool | set_slave_timecode_offset (std::string) | |
bool | set_subframes_per_frame (unsigned int) | |
bool | set_take_name (std::string) | |
bool | set_timecode_format (TimecodeFormat) | |
bool | set_timecode_generator_offset (std::string) | |
bool | set_timecode_offset (long) | |
bool | set_timecode_offset_negative (bool) | |
bool | set_track_name_number (bool) | |
bool | set_track_name_take (bool) | |
bool | set_use_monitor_fades (bool) | |
bool | set_use_region_fades (bool) | |
bool | set_use_transport_fades (bool) | |
bool | set_use_video_file_fps (bool) | |
bool | set_use_video_sync (bool) | |
bool | set_video_pullup (float) | |
bool | set_videotimeline_pullup (bool) | |
bool | set_wave_amplitude_zoom (double) | |
bool | set_wave_zoom_factor (unsigned short) | |
Properties | ||
std::string | audio_search_path | |
bool | auto_input | |
bool | auto_play | |
bool | auto_return | |
bool | count_in | |
unsigned int | destructive_xfade_msecs | |
bool | external_sync | |
bool | glue_new_markers_to_bars_and_beats | |
bool | glue_new_regions_to_bars_and_beats | |
ARDOUR.InsertMergePolicy | insert_merge_policy | |
bool | jack_time_master | |
bool | layered_record_mode | |
unsigned int | meterbridge_label_height | |
bool | midi_copy_is_fork | |
std::string | midi_search_path | |
long | minitimeline_span | |
ARDOUR.SampleFormat | native_file_data_format | |
ARDOUR.HeaderFormat | native_file_header_format | |
bool | punch_in | |
bool | punch_out | |
std::string | raid_path | |
bool | realtime_export | |
ARDOUR.MonitorChoice | session_monitoring | |
bool | show_busses_on_meterbridge | |
bool | show_group_tabs | |
bool | show_master_on_meterbridge | |
bool | show_midi_on_meterbridge | |
bool | show_monitor_on_meterbridge | |
bool | show_mute_on_meterbridge | |
bool | show_name_on_meterbridge | |
bool | show_rec_on_meterbridge | |
bool | show_region_fades | |
bool | show_solo_on_meterbridge | |
bool | show_summary | |
std::string | slave_timecode_offset | |
unsigned int | subframes_per_frame | |
std::string | take_name | |
Timecode.TimecodeFormat | timecode_format | |
std::string | timecode_generator_offset | |
long | timecode_offset | |
bool | timecode_offset_negative | |
bool | track_name_number | |
bool | track_name_take | |
bool | use_monitor_fades | |
bool | use_region_fades | |
bool | use_transport_fades | |
bool | use_video_file_fps | |
bool | use_video_sync | |
float | video_pullup | |
bool | videotimeline_pullup | |
double | wave_amplitude_zoom | |
unsigned short | wave_zoom_factor |
Inherited from PBD:Stateful
Methods | ||
---|---|---|
void | clear_changes () | |
Forget about any changes to this object's properties | ||
ID | id () | |
OwnedPropertyList | properties () |
∁ ARDOUR:SessionObject
C‡: ARDOUR::SessionObject
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 | name () | |
Cast | ||
Stateful | to_stateful () |
↠ ARDOUR:SessionObjectPtr
C‡: boost::shared_ptr< ARDOUR::SessionObject >, boost::weak_ptr< ARDOUR::SessionObject >
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 () | |
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
↠ ARDOUR:SideChain
C‡: boost::shared_ptr< ARDOUR::SideChain >, boost::weak_ptr< ARDOUR::SideChain >
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 () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
ChanCount | input_streams () | |
ChanCount | output_streams () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
PluginInsert | to_insert () | |
IOProcessor | to_ioprocessor () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
↠ ARDOUR:Slavable
C‡: boost::shared_ptr< ARDOUR::Slavable >, boost::weak_ptr< ARDOUR::Slavable >
Methods | ||
---|---|---|
void | assign (VCA) | |
bool | isnil () | |
void | unassign (VCA) |
↠ ARDOUR:SlavableAutomationControl
C‡: boost::shared_ptr< ARDOUR::SlavableAutomationControl >, boost::weak_ptr< ARDOUR::SlavableAutomationControl >
is-a: ARDOUR:AutomationControl
A PBD::Controllable with associated automation data (AutomationList)
Methods | ||
---|---|---|
void | add_master (AutomationControl) | |
void | clear_masters () | |
int | get_boolean_masters () | |
double | get_masters_value () | |
bool | isnil () | |
void | remove_master (AutomationControl) | |
bool | slaved () | |
bool | slaved_to (AutomationControl) |
Inherited from ARDOUR:AutomationControl
Methods | ||
---|---|---|
AutomationList | alist () | |
AutoState | automation_state () | |
double | get_value () | |
Get the current effective `user' value based on automation state | ||
void | set_automation_state (AutoState) | |
void | set_value (double, GroupControlDisposition) | |
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||
void | start_touch (double) | |
void | stop_touch (double) | |
bool | writable () | |
Cast | ||
Control | to_ctrl () | |
SlavableAutomationControl | to_slavable () |
Inherited from PBD:Controllable
Methods | ||
---|---|---|
std::string | name () |
Inherited from PBD:StatefulPtr
Methods | ||
---|---|---|
void | clear_changes () | |
Forget about any changes to this object's properties | ||
ID | id () | |
OwnedPropertyList | properties () |
↠ ARDOUR:SoloControl
C‡: boost::shared_ptr< ARDOUR::SoloControl >, boost::weak_ptr< ARDOUR::SoloControl >
is-a: ARDOUR:SlavableAutomationControl
A PBD::Controllable with associated automation data (AutomationList)
Methods | ||
---|---|---|
bool | can_solo () | |
bool | isnil () | |
bool | self_soloed () | |
bool | soloed () |
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 () | |
double | get_value () | |
Get the current effective `user' value based on automation state | ||
void | set_automation_state (AutoState) | |
void | set_value (double, GroupControlDisposition) | |
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||
void | start_touch (double) | |
void | stop_touch (double) | |
bool | writable () | |
Cast | ||
Control | to_ctrl () | |
SlavableAutomationControl | to_slavable () |
Inherited from PBD:Controllable
Methods | ||
---|---|---|
std::string | name () |
Inherited from PBD:StatefulPtr
Methods | ||
---|---|---|
void | clear_changes () | |
Forget about any changes to this object's properties | ||
ID | id () | |
OwnedPropertyList | properties () |
↠ ARDOUR:SoloIsolateControl
C‡: boost::shared_ptr< ARDOUR::SoloIsolateControl >, boost::weak_ptr< ARDOUR::SoloIsolateControl >
is-a: ARDOUR:SlavableAutomationControl
A PBD::Controllable with associated automation data (AutomationList)
Methods | ||
---|---|---|
bool | isnil () | |
bool | self_solo_isolated () | |
bool | solo_isolated () |
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 () | |
double | get_value () | |
Get the current effective `user' value based on automation state | ||
void | set_automation_state (AutoState) | |
void | set_value (double, GroupControlDisposition) | |
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||
void | start_touch (double) | |
void | stop_touch (double) | |
bool | writable () | |
Cast | ||
Control | to_ctrl () | |
SlavableAutomationControl | to_slavable () |
Inherited from PBD:Controllable
Methods | ||
---|---|---|
std::string | name () |
Inherited from PBD:StatefulPtr
Methods | ||
---|---|---|
void | clear_changes () | |
Forget about any changes to this object's properties | ||
ID | id () | |
OwnedPropertyList | properties () |
↠ ARDOUR:SoloSafeControl
C‡: boost::shared_ptr< ARDOUR::SoloSafeControl >, boost::weak_ptr< ARDOUR::SoloSafeControl >
is-a: ARDOUR:SlavableAutomationControl
A PBD::Controllable with associated automation data (AutomationList)
Methods | ||
---|---|---|
bool | isnil () | |
bool | solo_safe () |
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 () | |
double | get_value () | |
Get the current effective `user' value based on automation state | ||
void | set_automation_state (AutoState) | |
void | set_value (double, GroupControlDisposition) | |
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||
void | start_touch (double) | |
void | stop_touch (double) | |
bool | writable () | |
Cast | ||
Control | to_ctrl () | |
SlavableAutomationControl | to_slavable () |
Inherited from PBD:Controllable
Methods | ||
---|---|---|
std::string | name () |
Inherited from PBD:StatefulPtr
Methods | ||
---|---|---|
void | clear_changes () | |
Forget about any changes to this object's properties | ||
ID | id () | |
OwnedPropertyList | properties () |
↠ ARDOUR:Source
C‡: boost::shared_ptr< ARDOUR::Source >, boost::weak_ptr< ARDOUR::Source >
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 | ||
---|---|---|
std::string | ancestor_name () | |
bool | can_be_analysed () | |
bool | destructive () | |
bool | empty () | |
bool | has_been_analysed () | |
bool | isnil () | |
long | length (long) | |
long | natural_position () | |
long | 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:SourceList
C‡: std::vector<boost::shared_ptr<ARDOUR::Source> >
Constructor | ||
---|---|---|
ℂ | ARDOUR.SourceList () | |
ℂ | ARDOUR.SourceList () | |
Methods | ||
LuaTable | add (LuaTable {Source}) | |
Source | at (unsigned long) | |
bool | empty () | |
LuaIter | iter () | |
void | push_back (Source) | |
unsigned long | size () | |
LuaTable | table () |
↠ ARDOUR:Stripable
C‡: boost::shared_ptr< ARDOUR::Stripable >, boost::weak_ptr< ARDOUR::Stripable >
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 | ||
---|---|---|
AutomationControl | comp_enable_control () | |
AutomationControl | comp_makeup_control () | |
AutomationControl | comp_mode_control () | |
std::string | comp_mode_name (unsigned int) | |
ReadOnlyControl | comp_redux_control () | |
AutomationControl | comp_speed_control () | |
std::string | comp_speed_name (unsigned int) | |
AutomationControl | comp_threshold_control () | |
unsigned int | eq_band_cnt () | |
std::string | eq_band_name (unsigned int) | |
AutomationControl | eq_enable_control () | |
AutomationControl | eq_freq_control (unsigned int) | |
AutomationControl | eq_gain_control (unsigned int) | |
AutomationControl | eq_q_control (unsigned int) | |
AutomationControl | eq_shape_control (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_selected () | |
bool | isnil () | |
AutomationControl | master_send_enable_control () | |
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_control (unsigned int) | |
AutomationControl | send_level_control (unsigned int) | |
std::string | send_name (unsigned int) | |
void | set_presentation_order (unsigned int) | |
SoloControl | solo_control () | |
SoloIsolateControl | solo_isolate_control () | |
SoloSafeControl | solo_safe_control () | |
GainControl | trim_control () | |
Cast | ||
Route | to_route () | |
VCA | to_vca () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
∁ ARDOUR:StripableList
C‡: std::list<boost::shared_ptr<ARDOUR::Stripable> >
Constructor | ||
---|---|---|
ℂ | ARDOUR.StripableList () | |
Methods | ||
Stripable | back () | |
bool | empty () | |
Stripable | front () | |
LuaIter | iter () | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () |
∁ ARDOUR:Tempo
C‡: ARDOUR::Tempo
Tempo, the speed at which musical time progresses (BPM).
Constructor | ||
---|---|---|
ℂ | ARDOUR.Tempo (double, double, double) | |
Methods | ||
double | frames_per_note_type (long) | |
audio samples per note type. if you want an instantaneous value for this, use TempoMap::frames_per_quarter_note_at() instead.
| ||
double | frames_per_quarter_note (long) | |
audio samples per quarter note. if you want an instantaneous value for this, use TempoMap::frames_per_quarter_note_at() instead.
| ||
double | note_type () | |
double | note_types_per_minute () | |
double | quarter_notes_per_minute () |
∁ ARDOUR:TempoMap
C‡: ARDOUR::TempoMap
Tempo Map - mapping of timecode to musical time. convert audio-samples, sample-rate to Bar/Beat/Tick, Meter/Tempo
Methods | ||
---|---|---|
MeterSection | add_meter (Meter, BBT_TIME, long, PositionLockStyle) | |
TempoSection | add_tempo (Tempo, double, long, PositionLockStyle) | |
BBT_TIME | bbt_at_frame (long) | |
Returns the BBT time corresponding to the supplied frame position.
Returns the BBT time at the frame position . | ||
double | exact_beat_at_frame (long, int) | |
double | exact_qn_at_frame (long, int) | |
long | framepos_plus_qn (long, Beats) | |
Add some (fractional) Beats to a session frame position, and return the result in frames. pos can be -ve, if required. | ||
Beats | framewalk_to_qn (long, long) | |
Count the number of beats that are equivalent to distance when going forward, starting at pos. | ||
MeterSection | meter_section_at_beat (double) | |
MeterSection | meter_section_at_frame (long) | |
TempoSection | tempo_section_at_frame (long) | |
TempoSection | tempo_section_at_frame (long) |
∁ ARDOUR:TempoSection
C‡: ARDOUR::TempoSection
is-a: ARDOUR:MetricSection
A section of timeline with a certain Tempo.
Methods | ||
---|---|---|
double | c () |
Inherited from ARDOUR:MetricSection
Methods | ||
---|---|---|
double | pulse () | |
void | set_pulse (double) |
↠ ARDOUR:Track
C‡: boost::shared_ptr< ARDOUR::Track >, boost::weak_ptr< ARDOUR::Track >
is-a: ARDOUR:Route
A track is an route (bus) with a recordable diskstream and related objects relevant to tracking, playback and editing.
Specifically a track has regions and playlist objects.
Methods | ||
---|---|---|
Region | bounce (InterThreadInfo&) | |
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) | |
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 () | |
bool | isnil () | |
Playlist | playlist () | |
bool | set_name (std::string) | |
Cast | ||
AudioTrack | to_audio_track () | |
MidiTrack | to_midi_track () |
Inherited from ARDOUR:Route
Methods | ||
---|---|---|
bool | active () | |
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 | ||
IO | input () | |
Delivery | main_outs () | |
the signal processorat at end of the processing chain which produces output | ||
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************************************************************* | ||
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) | |
bool | set_strict_io (bool) | |
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 | ||
Automatable | to_automatable () | |
Slavable | to_slavable () | |
Track | to_track () |
Inherited from ARDOUR:Stripable
Methods | ||
---|---|---|
AutomationControl | comp_enable_control () | |
AutomationControl | comp_makeup_control () | |
AutomationControl | comp_mode_control () | |
std::string | comp_mode_name (unsigned int) | |
ReadOnlyControl | comp_redux_control () | |
AutomationControl | comp_speed_control () | |
std::string | comp_speed_name (unsigned int) | |
AutomationControl | comp_threshold_control () | |
unsigned int | eq_band_cnt () | |
std::string | eq_band_name (unsigned int) | |
AutomationControl | eq_enable_control () | |
AutomationControl | eq_freq_control (unsigned int) | |
AutomationControl | eq_gain_control (unsigned int) | |
AutomationControl | eq_q_control (unsigned int) | |
AutomationControl | eq_shape_control (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_selected () | |
AutomationControl | master_send_enable_control () | |
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_control (unsigned int) | |
AutomationControl | send_level_control (unsigned int) | |
std::string | send_name (unsigned int) | |
void | set_presentation_order (unsigned int) | |
SoloControl | solo_control () | |
SoloIsolateControl | solo_isolate_control () | |
SoloSafeControl | solo_safe_control () | |
GainControl | trim_control () | |
Cast | ||
Route | to_route () | |
VCA | to_vca () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
↠ ARDOUR:UnknownProcessor
C‡: boost::shared_ptr< ARDOUR::UnknownProcessor >, boost::weak_ptr< ARDOUR::UnknownProcessor >
is-a: ARDOUR:Processor
A stub Processor that can be used in place of a `real' one that cannot be created for some reason; usually because it requires a plugin which is not present. UnknownProcessors are special-cased in a few places, notably in route configuration and signal processing, so that on encountering them configuration or processing stops.
When a Processor is missing from a Route, the following processors cannot be configured, as the missing Processor's output port configuration is unknown.
The main utility of the UnknownProcessor is that it allows state to be preserved, so that, for example, loading and re-saving a session on a machine without a particular plugin will not corrupt the session.
Methods | ||
---|---|---|
bool | isnil () |
Inherited from ARDOUR:Processor
Methods | ||
---|---|---|
void | activate () | |
bool | active () | |
void | deactivate () | |
std::string | display_name () | |
bool | display_to_user () | |
ChanCount | input_streams () | |
ChanCount | output_streams () | |
Cast | ||
Amp | to_amp () | |
Automatable | to_automatable () | |
PluginInsert | to_insert () | |
IOProcessor | to_ioprocessor () | |
PeakMeter | to_meter () | |
MonitorProcessor | to_monitorprocessor () | |
PeakMeter | to_peakmeter () | |
PluginInsert | to_plugininsert () | |
SideChain | to_sidechain () | |
UnknownProcessor | to_unknownprocessor () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
↠ ARDOUR:VCA
C‡: boost::shared_ptr< ARDOUR::VCA >, boost::weak_ptr< ARDOUR::VCA >
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 | ||
---|---|---|
std::string | full_name () | |
GainControl | gain_control () | |
bool | isnil () | |
MuteControl | mute_control () | |
int | number () | |
SoloControl | solo_control () |
Inherited from ARDOUR:Stripable
Methods | ||
---|---|---|
AutomationControl | comp_enable_control () | |
AutomationControl | comp_makeup_control () | |
AutomationControl | comp_mode_control () | |
std::string | comp_mode_name (unsigned int) | |
ReadOnlyControl | comp_redux_control () | |
AutomationControl | comp_speed_control () | |
std::string | comp_speed_name (unsigned int) | |
AutomationControl | comp_threshold_control () | |
unsigned int | eq_band_cnt () | |
std::string | eq_band_name (unsigned int) | |
AutomationControl | eq_enable_control () | |
AutomationControl | eq_freq_control (unsigned int) | |
AutomationControl | eq_gain_control (unsigned int) | |
AutomationControl | eq_q_control (unsigned int) | |
AutomationControl | eq_shape_control (unsigned int) | |
AutomationControl | filter_enable_controllable (bool) | |
AutomationControl | filter_freq_controllable (bool) | |
AutomationControl | filter_slope_controllable (bool) | |
bool | is_auditioner () | |
bool | is_hidden () | |
bool | is_master () | |
bool | is_monitor () | |
bool | is_selected () | |
AutomationControl | master_send_enable_control () | |
MonitorProcessor | monitor_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_control (unsigned int) | |
AutomationControl | send_level_control (unsigned int) | |
std::string | send_name (unsigned int) | |
void | set_presentation_order (unsigned int) | |
SoloIsolateControl | solo_isolate_control () | |
SoloSafeControl | solo_safe_control () | |
GainControl | trim_control () | |
Cast | ||
Route | to_route () | |
VCA | to_vca () |
Inherited from ARDOUR:SessionObjectPtr
Methods | ||
---|---|---|
std::string | name () | |
Cast | ||
Stateful | to_stateful () | |
StatefulDestructible | to_statefuldestructible () |
∁ ARDOUR:VCAList
C‡: std::list<boost::shared_ptr<ARDOUR::VCA> >
Constructor | ||
---|---|---|
ℂ | ARDOUR.VCAList () | |
Methods | ||
VCA | back () | |
bool | empty () | |
VCA | front () | |
LuaIter | iter () | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () |
∁ ARDOUR:VCAManager
C‡: ARDOUR::VCAManager
is-a: PBD:StatefulDestructible
Base class for objects with saveable and undoable state with destruction notification
Methods | ||
---|---|---|
int | create_vca (unsigned int, std::string) | |
unsigned long | n_vcas () | |
void | remove_vca (VCA) | |
VCA | vca_by_name (std::string) | |
VCA | vca_by_number (int) | |
VCAList | vcas () |
Inherited from PBD:Stateful
Methods | ||
---|---|---|
void | clear_changes () | |
Forget about any changes to this object's properties | ||
ID | id () | |
OwnedPropertyList | properties () |
∁ ARDOUR:WeakAudioSourceList
C‡: std::list<boost::weak_ptr<ARDOUR::AudioSource> >
Constructor | ||
---|---|---|
ℂ | ARDOUR.WeakAudioSourceList () | |
Methods | ||
AudioSource | back () | |
bool | empty () | |
AudioSource | front () | |
LuaIter | iter () | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () |
∁ ARDOUR:WeakRouteList
C‡: std::list<boost::weak_ptr<ARDOUR::Route> >
Constructor | ||
---|---|---|
ℂ | ARDOUR.WeakRouteList () | |
Methods | ||
Route | back () | |
bool | empty () | |
Route | front () | |
LuaIter | iter () | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () |
∁ ARDOUR:WeakSourceList
C‡: std::list<boost::weak_ptr<ARDOUR::Source> >
Constructor | ||
---|---|---|
ℂ | ARDOUR.WeakSourceList () | |
Methods | ||
Source | back () | |
bool | empty () | |
Source | front () | |
LuaIter | iter () | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () |
ℕ ArdourUI
Methods | ||
---|---|---|
std::string | http_get (std::string) | |
ProcessorVector | processor_selection () | |
unsigned int | translate_order (InsertAt) |
∁ ArdourUI:ArdourMarker
C‡: ArdourMarker
Location Marker
Editor ruler representation of a location marker or range on the timeline.
Methods | ||
---|---|---|
std::string | name () | |
long | position () | |
Type | type () |
∁ ArdourUI:ArdourMarkerList
C‡: std::list<ArdourMarker* >
Constructor | ||
---|---|---|
ℂ | ArdourUI.ArdourMarkerList () | |
Methods | ||
LuaTable | add (ArdourMarker* ) | |
ArdourMarker | back () | |
bool | empty () | |
ArdourMarker | front () | |
LuaIter | iter () | |
void | push_back (ArdourMarker) | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () | |
void | unique () |
∅ ArdourUI:AxisView
C‡: AxisView
AxisView defines the abstract base class for horizontal and vertical presentations of Stripables.
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
∁ ArdourUI:Editor
C‡: PublicEditor
This class contains just the public interface of the Editor class, in order to decouple it from the private implementation, so that callers of PublicEditor need not be recompiled if private methods or member variables change.
Methods | ||
---|---|---|
void | access_action (std::string, std::string) | |
void | add_location_from_playhead_cursor () | |
TrackViewList | axis_views_from_routes (RouteListPtr) | |
void | center_screen (long) | |
void | clear_playlist (Playlist) | |
void | clear_playlists (TimeAxisView) | |
void | consider_auditioning (Region) | |
Possibly start the audition of a region. If
| ||
void | copy_playlists (TimeAxisView) | |
MouseMode | current_mouse_mode () | |
Returns The current mouse mode (gain, object, range, timefx etc.) (defined in editing_syms.h) | ||
long | current_page_samples () | |
void | deselect_all () | |
LuaTable(...) | do_embed (StringVector, ImportDisposition, ImportMode, long&, PluginInfo) | |
LuaTable(...) | do_import (StringVector, ImportDisposition, ImportMode, SrcQuality, MidiTrackNameSource, MidiTempoMapDisposition, long&, PluginInfo) | |
Import existing media | ||
bool | dragging_playhead () | |
Returns true if the playhead is currently being dragged, otherwise false | ||
MouseMode | effective_mouse_mode () | |
void | export_audio () | |
Open main export dialog | ||
void | export_range () | |
Open export dialog with current range pre-selected | ||
void | export_selection () | |
Open export dialog with current selection pre-selected | ||
LuaTable(Location, ...) | find_location_from_marker (ArdourMarker, bool&) | |
ArdourMarker | find_marker_from_location_id (ID, bool) | |
void | fit_selection () | |
bool | follow_playhead () | |
Returns true if the editor is following the playhead | ||
long | get_current_zoom () | |
Selection | get_cut_buffer () | |
unsigned int | get_grid_beat_divisions (long) | |
LuaTable(Beats, ...) | get_grid_type_as_beats (bool&, long) | |
LuaTable(long, ...) | get_nudge_distance (long, long&) | |
long | get_paste_offset (long, unsigned int, long) | |
LuaTable(...) | get_pointer_position (double&, double&) | |
Selection | get_selection () | |
LuaTable(bool, ...) | get_selection_extents (long&, long&) | |
bool | get_smart_mode () | |
StripableTimeAxisView | get_stripable_time_axis_by_id (ID) | |
TrackViewList | get_track_views () | |
int | get_videotl_bar_height () | |
double | get_y_origin () | |
ZoomFocus | get_zoom_focus () | |
void | goto_nth_marker (int) | |
void | hide_track_in_display (TimeAxisView, bool) | |
long | leftmost_sample () | |
void | maximise_editing_space () | |
void | maybe_locate_with_edit_preroll (long) | |
void | mouse_add_new_marker (long, bool) | |
void | new_playlists (TimeAxisView) | |
void | new_region_from_selection () | |
void | override_visible_track_count () | |
long | pixel_to_sample (double) | |
void | play_selection () | |
void | play_with_preroll () | |
void | redo (unsigned int) | |
Redo some transactions.
| ||
RegionView | regionview_from_region (Region) | |
void | remove_last_capture () | |
void | remove_location_at_playhead_cursor () | |
void | remove_tracks () | |
void | reset_x_origin (long) | |
void | reset_y_origin (double) | |
void | reset_zoom (long) | |
void | restore_editing_space () | |
RouteTimeAxisView | rtav_from_route (Route) | |
double | sample_to_pixel (long) | |
bool | scroll_down_one_track (bool) | |
void | scroll_tracks_down_line () | |
void | scroll_tracks_up_line () | |
bool | scroll_up_one_track (bool) | |
void | select_all_tracks () | |
void | separate_region_from_selection () | |
void | set_follow_playhead (bool, bool) | |
Set whether the editor should follow the playhead.
| ||
void | set_loop_range (long, long, std::string) | |
void | set_mouse_mode (MouseMode, bool) | |
Set the mouse mode (gain, object, range, timefx etc.)
| ||
void | set_punch_range (long, long, std::string) | |
void | set_selection (SelectionList, Operation) | |
void | set_show_measures (bool) | |
void | set_snap_mode (SnapMode) | |
Set the snap mode.
| ||
void | set_snap_threshold (double) | |
Set the snap threshold.
| ||
void | set_stationary_playhead (bool) | |
void | set_toggleaction (std::string, std::string, bool) | |
void | set_video_timeline_height (int) | |
void | set_visible_track_count (int) | |
void | set_zoom_focus (ZoomFocus) | |
bool | show_measures () | |
void | show_track_in_display (TimeAxisView, bool) | |
SnapMode | snap_mode () | |
SnapType | snap_type () | |
bool | stationary_playhead () | |
void | stem_export () | |
Open stem export dialog | ||
void | temporal_zoom_step (bool) | |
void | toggle_meter_updating () | |
void | toggle_ruler_video (bool) | |
void | toggle_xjadeo_proc (int) | |
void | undo (unsigned int) | |
Undo some transactions.
| ||
double | visible_canvas_height () |
∅ ArdourUI:MarkerSelection
C‡: MarkerSelection
is-a: ArdourUI:ArdourMarkerList
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
Inherited from ArdourUI:ArdourMarkerList
Constructor | ||
---|---|---|
ℂ | ArdourUI.ArdourMarkerList () | |
Methods | ||
LuaTable | add (ArdourMarker* ) | |
ArdourMarker | back () | |
bool | empty () | |
ArdourMarker | front () | |
LuaIter | iter () | |
void | push_back (ArdourMarker) | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () | |
void | unique () |
∁ ArdourUI:RegionSelection
C‡: RegionSelection
Class to represent list of selected regions.
Methods | ||
---|---|---|
long | end_frame () | |
unsigned long | n_midi_regions () | |
RegionList | regionlist () | |
long | start () |
∅ ArdourUI:RegionView
C‡: RegionView
is-a: ArdourUI:TimeAxisViewItem
Base class for items that may appear upon a TimeAxisView.
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
∁ ArdourUI:RouteTimeAxisView
C‡: RouteTimeAxisView
is-a: ArdourUI:RouteUI
Base class for objects with auto-disconnection. trackable must be inherited when objects shall automatically invalidate slots referring to them on destruction. A slot built from a member function of a trackable derived type installs a callback that is invoked when the trackable object is destroyed or overwritten.
add_destroy_notify_callback() and remove_destroy_notify_callback() can be used to manually install and remove callbacks when notification of the object dying is needed.
notify_callbacks() invokes and removes all previously installed callbacks and can therefore be used to disconnect from all signals.
Note that there is no virtual destructor. Don't use trackable* as pointer type for managing your data or the destructors of your derived types won't be called when deleting your objects.
signal
Cast | ||
---|---|---|
StripableTimeAxisView | to_stripabletimeaxisview () | |
TimeAxisView | to_timeaxisview () |
∅ ArdourUI:RouteUI
C‡: RouteUI
is-a: ArdourUI:Selectable
Base class for objects with auto-disconnection. trackable must be inherited when objects shall automatically invalidate slots referring to them on destruction. A slot built from a member function of a trackable derived type installs a callback that is invoked when the trackable object is destroyed or overwritten.
add_destroy_notify_callback() and remove_destroy_notify_callback() can be used to manually install and remove callbacks when notification of the object dying is needed.
notify_callbacks() invokes and removes all previously installed callbacks and can therefore be used to disconnect from all signals.
Note that there is no virtual destructor. Don't use trackable* as pointer type for managing your data or the destructors of your derived types won't be called when deleting your objects.
signal
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
∅ ArdourUI:Selectable
C‡: Selectable
Base class for objects with auto-disconnection. trackable must be inherited when objects shall automatically invalidate slots referring to them on destruction. A slot built from a member function of a trackable derived type installs a callback that is invoked when the trackable object is destroyed or overwritten.
add_destroy_notify_callback() and remove_destroy_notify_callback() can be used to manually install and remove callbacks when notification of the object dying is needed.
notify_callbacks() invokes and removes all previously installed callbacks and can therefore be used to disconnect from all signals.
Note that there is no virtual destructor. Don't use trackable* as pointer type for managing your data or the destructors of your derived types won't be called when deleting your objects.
signal
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
∁ ArdourUI:Selection
C‡: Selection
The Selection class holds lists of selected items (tracks, regions, etc. etc.).
Methods | ||
---|---|---|
void | clear () | |
Clear everything from the Selection | ||
void | clear_all () | |
bool | empty (bool) | |
check if all selections are empty
Returns true if nothing is selected. | ||
Data Members | ||
ArdourUI:MarkerSelection | markers | |
ArdourUI:RegionSelection | regions | |
ArdourUI:TimeSelection | time | |
ArdourUI:TrackSelection | tracks |
∁ ArdourUI:SelectionList
C‡: std::list<Selectable* >
Constructor | ||
---|---|---|
ℂ | ArdourUI.SelectionList () | |
Methods | ||
Selectable | back () | |
bool | empty () | |
Selectable | front () | |
LuaIter | iter () | |
void | push_back (Selectable) | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () | |
void | unique () |
∅ ArdourUI:StripableTimeAxisView
C‡: StripableTimeAxisView
is-a: ArdourUI:TimeAxisView
Abstract base class for time-axis views (horizontal editor 'strips')
This class provides the basic LHS controls and display methods. This should be extended to create functional time-axis based views.
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
∅ ArdourUI:TimeAxisView
C‡: TimeAxisView
is-a: ArdourUI:AxisView
Abstract base class for time-axis views (horizontal editor 'strips')
This class provides the basic LHS controls and display methods. This should be extended to create functional time-axis based views.
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
∅ ArdourUI:TimeAxisViewItem
C‡: TimeAxisViewItem
is-a: ArdourUI:Selectable
Base class for items that may appear upon a TimeAxisView.
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
∁ ArdourUI:TimeSelection
C‡: TimeSelection
is-a: ARDOUR:AudioRangeList
Methods | ||
---|---|---|
long | end_frame () | |
long | length () | |
long | start () |
Inherited from ARDOUR:AudioRangeList
Constructor | ||
---|---|---|
ℂ | ARDOUR.AudioRangeList () | |
Methods | ||
AudioRange | back () | |
bool | empty () | |
AudioRange | front () | |
LuaIter | iter () | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () |
∅ ArdourUI:TrackSelection
C‡: TrackSelection
is-a: ArdourUI:TrackViewList
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
Inherited from ArdourUI:TrackViewList
Methods | ||
---|---|---|
bool | contains (TimeAxisView) | |
RouteList | routelist () |
Inherited from ArdourUI:TrackViewStdList
Constructor | ||
---|---|---|
ℂ | ArdourUI.TrackViewStdList () | |
Methods | ||
TimeAxisView | back () | |
bool | empty () | |
TimeAxisView | front () | |
LuaIter | iter () | |
void | push_back (TimeAxisView) | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () | |
void | unique () |
∁ ArdourUI:TrackViewList
C‡: TrackViewList
is-a: ArdourUI:TrackViewStdList
Methods | ||
---|---|---|
bool | contains (TimeAxisView) | |
RouteList | routelist () |
Inherited from ArdourUI:TrackViewStdList
Constructor | ||
---|---|---|
ℂ | ArdourUI.TrackViewStdList () | |
Methods | ||
TimeAxisView | back () | |
bool | empty () | |
TimeAxisView | front () | |
LuaIter | iter () | |
void | push_back (TimeAxisView) | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () | |
void | unique () |
∁ ArdourUI:TrackViewStdList
C‡: std::list<TimeAxisView* >
Constructor | ||
---|---|---|
ℂ | ArdourUI.TrackViewStdList () | |
Methods | ||
TimeAxisView | back () | |
bool | empty () | |
TimeAxisView | front () | |
LuaIter | iter () | |
void | push_back (TimeAxisView) | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () | |
void | unique () |
⋯ C:ByteArray
C‡: unsigned char*
Methods | ||
---|---|---|
LuaMetaTable | array () | |
LuaTable | get_table () | |
unsigned char* | offset (unsigned int) | |
void | set_table (LuaTable {unsigned char}) |
∁ C:DoubleVector
C‡: std::vector<double >
Constructor | ||
---|---|---|
ℂ | C.DoubleVector () | |
ℂ | C.DoubleVector () | |
Methods | ||
LuaTable | add (LuaTable {double}) | |
double | at (unsigned long) | |
bool | empty () | |
LuaIter | iter () | |
void | push_back (double) | |
unsigned long | size () | |
LuaTable | table () |
⋯ C:FloatArray
C‡: float*
Methods | ||
---|---|---|
LuaMetaTable | array () | |
LuaTable | get_table () | |
FloatArray | offset (unsigned int) | |
void | set_table (LuaTable {float}) |
∁ C:FloatArrayVector
C‡: std::vector<float* >
Constructor | ||
---|---|---|
ℂ | C.FloatArrayVector () | |
ℂ | C.FloatArrayVector () | |
Methods | ||
LuaTable | add (LuaTable {FloatArray}) | |
FloatArray | at (unsigned long) | |
bool | empty () | |
LuaIter | iter () | |
void | push_back (FloatArray) | |
unsigned long | size () | |
LuaTable | table () |
∁ C:FloatVector
C‡: std::vector<float >
Constructor | ||
---|---|---|
ℂ | C.FloatVector () | |
ℂ | C.FloatVector () | |
Methods | ||
LuaTable | add (LuaTable {float}) | |
float | at (unsigned long) | |
bool | empty () | |
LuaIter | iter () | |
void | push_back (float) | |
unsigned long | size () | |
LuaTable | table () |
∁ C:Int64List
C‡: std::list<long >
Constructor | ||
---|---|---|
ℂ | C.Int64List () | |
Methods | ||
LuaTable | add (LuaTable {long}) | |
long | back () | |
bool | empty () | |
long | front () | |
LuaIter | iter () | |
void | push_back (long) | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () | |
void | unique () |
⋯ C:IntArray
C‡: int*
Methods | ||
---|---|---|
LuaMetaTable | array () | |
LuaTable | get_table () | |
IntArray | offset (unsigned int) | |
void | set_table (LuaTable {int}) |
∁ C:StringList
C‡: std::list<std::string >
Constructor | ||
---|---|---|
ℂ | C.StringList () | |
Methods | ||
LuaTable | add (LuaTable {std::string}) | |
std::string | back () | |
bool | empty () | |
std::string | front () | |
LuaIter | iter () | |
void | push_back (std::string) | |
void | reverse () | |
unsigned long | size () | |
LuaTable | table () | |
void | unique () |
∁ C:StringVector
C‡: std::vector<std::string >
Constructor | ||
---|---|---|
ℂ | C.StringVector () | |
ℂ | C.StringVector () | |
Methods | ||
LuaTable | add (LuaTable { |