-This documention is far from complete may be inaccurate and subject to change. +This documentation is far from complete may be inaccurate and subject to change.
+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 explicily 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 inhertis 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.
@@ -119,9 +126,43 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: 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 () | |
| Methods | ||
|---|---|---|
| void | activate () | |
| bool | active () | |
| AutomationControl | automation_control (Parameter, bool) | |
| Control | control (Parameter, bool) | |
| void | deactivate () | |
| std::string | display_name () | |
| Cast | ||
| Automatable | to_automatable () | |
| PluginInsert | to_insert () | |
| IOProcessor | to_ioprocessor () | |
| SideChain | to_sidechain () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Cast | ||
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
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 () | |
| 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) | |
| bool | sameinstance (AudioBuffer) | |
| void | silence (long, long) | |
Clear (eg zero, or empty) buffer | ||
silence buffer
| ||
C‡: ARDOUR::AudioEngine
+is-a: ARDOUR:PortManager
| Methods | ||
|---|---|---|
| int | start (bool) | |
| int | stop (bool) | |
| 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&) | |
| void | get_physical_outputs (DataType, StringVector&) | |
| 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) | |
| --MISSING (ARDOUR::PortEngine&)-- | port_engine () | |
| bool | port_is_physical (std::string) | |
C‡: boost::shared_ptr< ARDOUR::AudioPort >, boost::weak_ptr< ARDOUR::AudioPort >
+is-a: ARDOUR:Port
+ +| Methods | ||
|---|---|---|
| bool | isnil () | |
| Methods | ||
|---|---|---|
| int | connect (Port) | |
| int | connect_by_name (std::string) | |
| bool | connected () | |
Returns true if this port is connected to anything | ||
| bool | connected_to (Port) | |
| bool | connected_to_name (std::string) | |
| int | disconnect (Port) | |
| int | disconnect_all () | |
| int | disconnect_by_name (std::string) | |
| 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 | ||
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 | |
C‡: std::list<ARDOUR::AudioRange >
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.AudioRangeList () | |
| Methods | ||
| bool | empty () | |
| LuaIter | iter () | |
| void | reverse () | |
| unsigned long | size () | |
| LuaTable | table () | |
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 | ||
|---|---|---|
| bool | isnil () | |
| Methods | ||
|---|---|---|
| bool | isnil () | |
| 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 | record_enabled () | |
| bool | record_safe () | |
| bool | set_name (std::string) | |
| void | set_record_enabled (bool, GroupControlDisposition) | |
| void | set_record_safe (bool, GroupControlDisposition) | |
| Cast | ||
| AudioTrack | to_audio_track () | |
| MidiTrack | to_midi_track () | |
| 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) | |
| bool | customize_plugin_insert (Processor, unsigned int, ChanCount, ChanCount) | |
enable custom plugin-insert configuration
Returns true if successful | ||
| 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) | |
| int | remove_processor (Processor, ProcessorStreams, bool) | |
remove plugin/processor
Returns 0 on success | ||
| bool | remove_sidechain (Processor) | |
| 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*) | |
| bool | set_strict_io (bool) | |
| bool | soloed () | |
| bool | strict_io () | |
| Amp | trim () | |
| Cast | ||
| Track | to_track () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Methods | ||
|---|---|---|
| OwnedPropertyList | properties () | |
| Cast | ||
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
C‡: std::list<boost::shared_ptr<ARDOUR::AudioTrack> >
@@ -282,25 +430,57 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: boost::shared_ptr< ARDOUR::AutomationControl >, boost::weak_ptr< ARDOUR::AutomationControl >
-is-a: Evoral:Control
+is-a: PBD:Controllable
+A PBD::Controllable with associated automation data (AutomationList)
| Methods | ||
|---|---|---|
| AutomationList | alist () | |
| AutoState | automation_state () | |
| AutoStyle | automation_style () | |
| double | get_value () | |
Get the current effective `user' value based on automation state | ||
| bool | isnil () | |
| void | set_automation_state (AutoState) | |
| void | set_automation_style (AutoStyle) | |
| 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 (bool, double) | |
| bool | writable () | |
| Cast | ||
| Control | to_ctrl () | |
| Methods | ||
|---|---|---|
| ControlList | list () | |
| std::string | name () | |
| Methods | ||
|---|---|---|
| void | clear_changes () | |
Forget about any changes to this object's properties | ||
| ID | id () | |
| OwnedPropertyList | properties () | |
C‡: boost::shared_ptr< ARDOUR::AutomationList >, boost::weak_ptr< ARDOUR::AutomationList >
+ +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 () | |
C‡: std::vector<ARDOUR::AudioBackendInfo const* >
@@ -324,6 +504,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: ARDOUR::ChanCount
@@ -350,15 +531,15 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: ARDOUR::ChanMapping
-A mapping from one set of channels to another (e.g. how to 'connect' two BufferSets).
for plugins the form is "pin" -> "buffer"
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 | ||
| unsigned int | get (DataType, unsigned int) | |
get buffer mapping for given data type and pin
Returns mapped buffer number (or ChanMapping::Invalid) | ||
| unsigned int | get (DataType, unsigned int) | |
get buffer mapping for given data type and pin
Returns mapped buffer number (or ChanMapping::Invalid) | ||
| void | set (DataType, unsigned int, unsigned int) | |
set buffer mapping for given data type
| ||
set buffer mapping for given data type
| ||
calculate peaks
C‡: 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 | reset () | |
| void | compute (Type, double, double, double) | |
setup filter, compute coefficients
| ||
| 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) | |
| void | run (FloatArray, unsigned int) | |
process audio data
| ||
| 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 | ||
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 () | |
| Methods | ||
|---|---|---|
| IO | input () | |
| ChanCount | natural_input_streams () | |
| ChanCount | natural_output_streams () | |
| IO | output () | |
| Methods | ||
|---|---|---|
| void | activate () | |
| bool | active () | |
| AutomationControl | automation_control (Parameter, bool) | |
| Control | control (Parameter, bool) | |
| void | deactivate () | |
| std::string | display_name () | |
| Cast | ||
| Automatable | to_automatable () | |
| PluginInsert | to_insert () | |
| IOProcessor | to_ioprocessor () | |
| SideChain | to_sidechain () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Cast | ||
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
C‡: ARDOUR::AudioBackend::DeviceStatus
@@ -468,11 +701,127 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: boost::shared_ptr< ARDOUR::GainControl >, boost::weak_ptr< ARDOUR::GainControl >
+is-a: ARDOUR:AutomationControl
+ +A PBD::Controllable with associated automation data (AutomationList)
| Methods | ||
|---|---|---|
| bool | isnil () | |
| Methods | ||
|---|---|---|
| AutomationList | alist () | |
| AutoState | automation_state () | |
| AutoStyle | automation_style () | |
| double | get_value () | |
Get the current effective `user' value based on automation state | ||
| void | set_automation_state (AutoState) | |
| void | set_automation_style (AutoStyle) | |
| 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 (bool, double) | |
| bool | writable () | |
| Cast | ||
| Control | to_ctrl () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Methods | ||
|---|---|---|
| void | clear_changes () | |
Forget about any changes to this object's properties | ||
| ID | id () | |
| OwnedPropertyList | properties () | |
C‡: boost::shared_ptr< ARDOUR::IO >, boost::weak_ptr< ARDOUR::IO >
+is-a: ARDOUR:SessionObject
+ +A collection of ports (all input or all output) with connections.
An IO can contain ports of varying types, making routes/inserts/etc with varied combinations of types (eg MIDI and audio) possible.
| Methods | ||
|---|---|---|
| bool | active () | |
| int | add_port (std::string, void*, DataType) | |
Add a port.
| ||
| AudioPort | audio (unsigned int) | |
| int | connect (Port, std::string, void*) | |
| int | disconnect (Port, std::string, void*) | |
| 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*) | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Cast | ||
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
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 () | |
| Methods | ||
|---|---|---|
| void | activate () | |
| bool | active () | |
| AutomationControl | automation_control (Parameter, bool) | |
| Control | control (Parameter, bool) | |
| void | deactivate () | |
| std::string | display_name () | |
| Cast | ||
| Automatable | to_automatable () | |
| PluginInsert | to_insert () | |
| IOProcessor | to_ioprocessor () | |
| SideChain | to_sidechain () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Cast | ||
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
C‡: ARDOUR::InterThreadInfo
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.InterThreadInfo () | |
| Data Members | ||
| bool | done | |
| float | progress | |
C‡: ARDOUR::Location
is-a: PBD:StatefulDestructible
-Base class for objects with saveable and undoable state
Location on Timeline - abstract representation for Markers, Loop/Punch Ranges, CD-Markers etc.
| Methods | ||
|---|---|---|
| long | end () | |
| bool | locked () | |
| int | move_to (long) | |
| int | set_end (long, bool, bool) | |
Set end position.
| ||
| int | set_length (long, long, bool) | |
| int | set_start (long, bool, bool) | |
Set start position.
| ||
| long | start () | |
| Methods | ||
|---|---|---|
| void | clear_changes () | |
Forget about any changes to this object's properties | ||
| ID | id () | |
| OwnedPropertyList | properties () | |
C‡: std::list<ARDOUR::Location* >
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.LocationList () | |
| Methods | ||
| bool | empty () | |
| LuaIter | iter () | |
| void | reverse () | |
| unsigned long | size () | |
| LuaTable | table () | |
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) | |
| 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.
| ||
| Location | session_range_location () | |
| Methods | ||
|---|---|---|
| void | clear_changes () | |
Forget about any changes to this object's properties | ||
| ID | id () | |
| OwnedPropertyList | properties () | |
create a new Plugin Instance
Returns Processor or nil
search a Plugin
Returns PluginInfo or nil if not found
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
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
set a plugin control-input parameter value
Returns true on success, false on error or out-of-bounds value
C‡: ARDOUR::LuaOSC::Address
@@ -537,13 +941,46 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| Methods | ||
|---|---|---|
| bool | empty () | |
| bool | sameinstance (MidiBuffer) | |
| void | silence (long, long) | |
Clear (eg zero, or empty) buffer | ||
C‡: boost::shared_ptr< ARDOUR::MidiPort >, boost::weak_ptr< ARDOUR::MidiPort >
+is-a: ARDOUR:Port
+ +| Methods | ||
|---|---|---|
| bool | input_active () | |
| bool | isnil () | |
| void | set_input_active (bool) | |
| Methods | ||
|---|---|---|
| int | connect (Port) | |
| int | connect_by_name (std::string) | |
| bool | connected () | |
Returns true if this port is connected to anything | ||
| bool | connected_to (Port) | |
| bool | connected_to_name (std::string) | |
| int | disconnect (Port) | |
| int | disconnect_all () | |
| int | disconnect_by_name (std::string) | |
| 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 | ||
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 () | |
| 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 | record_enabled () | |
| bool | record_safe () | |
| bool | set_name (std::string) | |
| void | set_record_enabled (bool, GroupControlDisposition) | |
| void | set_record_safe (bool, GroupControlDisposition) | |
| Cast | ||
| AudioTrack | to_audio_track () | |
| MidiTrack | to_midi_track () | |
| 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) | |
| bool | customize_plugin_insert (Processor, unsigned int, ChanCount, ChanCount) | |
enable custom plugin-insert configuration
Returns true if successful | ||
| 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) | |
| int | remove_processor (Processor, ProcessorStreams, bool) | |
remove plugin/processor
Returns 0 on success | ||
| bool | remove_sidechain (Processor) | |
| 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*) | |
| bool | set_strict_io (bool) | |
| bool | soloed () | |
| bool | strict_io () | |
| Amp | trim () | |
| Cast | ||
| Track | to_track () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Methods | ||
|---|---|---|
| OwnedPropertyList | properties () | |
| Cast | ||
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
C‡: std::list<boost::shared_ptr<ARDOUR::MidiTrack> >
@@ -630,10 +1090,58 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: boost::shared_ptr< ARDOUR::Playlist >, boost::weak_ptr< ARDOUR::Playlist >
+is-a: 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 | ||
|---|---|---|
| void | add_region (Region, long, float, 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) | |
| 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 | 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, long) | |
| Region | top_region_at (long) | |
| Region | top_unmuted_region_at (long) | |
| void | uncombine (Region) | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Cast | ||
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
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 | ||
|---|---|---|
| std::string | get_docs () | |
| 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&) | |
| Methods | ||
|---|---|---|
| void | clear_changes () | |
Forget about any changes to this object's properties | ||
| ID | id () | |
| OwnedPropertyList | properties () | |
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 () | |
| Methods | ||
|---|---|---|
| AutomationList | alist () | |
| AutoState | automation_state () | |
| AutoStyle | automation_style () | |
| double | get_value () | |
Get the current effective `user' value based on automation state | ||
| void | set_automation_state (AutoState) | |
| void | set_automation_style (AutoStyle) | |
| 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 (bool, double) | |
| bool | writable () | |
| Cast | ||
| Control | to_ctrl () | |
| Methods | ||
|---|---|---|
| ControlList | list () | |
| std::string | name () | |
| Methods | ||
|---|---|---|
| void | clear_changes () | |
Forget about any changes to this object's properties | ||
| ID | id () | |
| OwnedPropertyList | properties () | |
C‡: boost::shared_ptr< ARDOUR::PluginInfo >, boost::weak_ptr< ARDOUR::PluginInfo >
@@ -693,18 +1220,18 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: 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 () | |
| bool | no_inplace () | |
| ChanMapping | output_map (unsigned int) | |
| Plugin | plugin (unsigned int) | |
| void | set_input_map (unsigned int, ChanMapping) | |
| void | set_no_inplace (bool) | |
| void | set_output_map (unsigned int, ChanMapping) | |
| IO | sidechain_input () | |
| bool | strict_io_configured () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Cast | ||
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
C‡: boost::shared_ptr< ARDOUR::Port >, boost::weak_ptr< ARDOUR::Port >
+| Methods | ||
|---|---|---|
| OwnedPropertyList | properties () | |
Returns true if this port is connected to anything
Returns Port short name
Returns Port human readable name
Returns true if this Port receives input, otherwise false
Returns true if this Port sends output, otherwise false
C‡: std::list<boost::shared_ptr<ARDOUR::Port> >
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.PortList () | |
| Methods | ||
| bool | empty () | |
| LuaIter | iter () | |
| void | reverse () | |
| unsigned long | size () | |
| LuaTable | table () | |
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&) | |
| void | get_physical_outputs (DataType, StringVector&) | |
| 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) | |
| --MISSING (ARDOUR::PortEngine&)-- | port_engine () | |
| bool | port_is_physical (std::string) | |
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) | |
C‡: ARDOUR::Plugin::PresetRecord
| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.PresetRecord () | |
| Data Members | ||
| std::string | label | |
| std::string | uri | |
C‡: boost::shared_ptr< ARDOUR::Processor >, boost::weak_ptr< ARDOUR::Processor >
-is-a: ARDOUR:Automatable, ARDOUR:SessionObject
+is-a: ARDOUR:SessionObject
+A mixer strip element - plugin, send, meter, etc
| Methods | ||
|---|---|---|
| void | activate () | |
| void | deactivate () | |
| std::string | display_name () | |
| bool | isnil () | |
| bool | isnil () | |
| Cast | ||
| Automatable | to_automatable () | |
| PluginInsert | to_insert () | |
| IOProcessor | to_ioprocessor () | |
| SideChain | to_sidechain () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Methods | ||
|---|---|---|
| OwnedPropertyList | properties () | |
| Cast | ||
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
C‡: PBD::PropertyDescriptor<bool>
@@ -793,6 +1403,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: boost::shared_ptr< ARDOUR::Region >, boost::weak_ptr< ARDOUR::Region >
is-a: 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 | at_natural_position () | |
| 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) | |
| void | set_locked (bool) | |
| void | set_muted (bool) | |
| 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 () | |
| long | start () | |
| bool | sync_marked () | |
| LuaTable(long, ...) | sync_offset (int&) | |
| long | sync_position () | |
Returns Sync position in session time | ||
| void | trim_end (long) | |
| ||
| void | trim_front (long) | |
| void | trim_to (long, long) | |
| bool | valid_transients () | |
| bool | video_locked () | |
| bool | whole_file () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Methods | ||
|---|---|---|
| OwnedPropertyList | properties () | |
| Cast | ||
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
C‡: ARDOUR::RegionFactory
@@ -865,38 +1477,81 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: std::list<boost::shared_ptr<ARDOUR::Region> >
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.RegionList () | |
| Methods | ||
| bool | empty () | |
| LuaIter | iter () | |
| void | reverse () | |
| unsigned long | size () | |
| LuaTable | table () | |
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 () | |
C‡: boost::shared_ptr< ARDOUR::Route >, boost::weak_ptr< ARDOUR::Route >
is-a: 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 | 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) | |
| bool | customize_plugin_insert (Processor, unsigned int, ChanCount, ChanCount) | |
enable custom plugin-insert configuration
Returns true if successful | ||
| 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) | |
| int | remove_processor (Processor, ProcessorStreams, bool) | |
remove plugin/processor
Returns 0 on success | ||
| bool | remove_sidechain (Processor) | |
| 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*) | |
| bool | set_name (std::string) | |
| bool | set_strict_io (bool) | |
| bool | soloed () | |
| bool | strict_io () | |
| Amp | trim () | |
| Cast | ||
| Track | to_track () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Methods | ||
|---|---|---|
| OwnedPropertyList | properties () | |
| Cast | ||
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
C‡: ARDOUR::Route::ProcessorStreams
@@ -906,6 +1561,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: ARDOUR::RouteGroup
+ +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.
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
C‡: std::list<boost::shared_ptr<ARDOUR::Route> >
@@ -938,16 +1598,27 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: ARDOUR::Session
-Base class for objects with saveable and undoable state
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) | |
| 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 | 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 () | |
| AudioEngine | engine () | |
| long | frame_rate () | |
"actual" sample rate of session, set by current audioengine rate, pullup/down etc. | ||
| double | frames_per_timecode_frame () | |
| unsigned int | get_block_size () | |
| RouteListPtr | get_routes () | |
| BufferSet | get_scratch_buffers (ChanCount, bool) | |
| BufferSet | get_silent_buffers (ChanCount) | |
| void | goto_end () | |
| void | goto_start () | |
| long | last_transport_start () | |
| Locations | locations () | |
| Route | master_out () | |
| Route | monitor_out () | |
| std::string | name () | |
| RouteList | new_audio_route (int, int, RouteGroup, unsigned int, std::string) | |
Caller must not hold process lock.
| ||
| AudioTrackList | new_audio_track (int, int, TrackMode, RouteGroup, unsigned int, std::string) | |
Caller must not hold process lock
| ||
| RouteList | new_midi_route (RouteGroup, unsigned int, std::string, PluginInfo, PresetRecord) | |
| MidiTrackList | new_midi_track (ChanCount, ChanCount, PluginInfo, TrackMode, RouteGroup, unsigned int, std::string, PresetRecord) | |
| RouteList | new_route_from_template (unsigned int, std::string, std::string, PlaylistDisposition) | |
create a new track or bus from a template (XML path)
Returns list of newly created routes | ||
| long | nominal_frame_rate () | |
"native" sample rate of session, regardless of current audioengine rate, pullup/down etc | ||
| std::string | path () | |
| Route | route_by_name (std::string) | |
| Route | route_by_remote_id (unsigned int) | |
| int | save_state (std::string, bool, bool, bool) | |
save session
Returns zero on success | ||
| void | scripts_changed () | |
| void | set_dirty () | |
| std::string | snap_name () | |
| bool | transport_rolling () | |
| double | transport_speed () | |
| StringList | unknown_processors () | |
| long | worst_input_latency () | |
| long | worst_output_latency () | |
| long | worst_playback_latency () | |
| long | worst_track_latency () | |
C‡: boost::shared_ptr< ARDOUR::SessionObject >, boost::weak_ptr< ARDOUR::SessionObject >
-is-a: PBD:StatefulDestructiblePtr
+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 () | |
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 | ||
|---|---|---|
| OwnedPropertyList | properties () | |
| bool | isnil () | |
| Methods | ||
|---|---|---|
| IO | input () | |
| ChanCount | natural_input_streams () | |
| ChanCount | natural_output_streams () | |
| IO | output () | |
| Methods | ||
|---|---|---|
| void | activate () | |
| bool | active () | |
| AutomationControl | automation_control (Parameter, bool) | |
| Control | control (Parameter, bool) | |
| void | deactivate () | |
| std::string | display_name () | |
| Cast | ||
| Automatable | to_automatable () | |
| PluginInsert | to_insert () | |
| IOProcessor | to_ioprocessor () | |
| SideChain | to_sidechain () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Cast | ||
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
C‡: boost::shared_ptr< ARDOUR::Source >, boost::weak_ptr< 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 | ||
|---|---|---|
| bool | isnil () | |
| Methods | ||
|---|---|---|
| void | add_meter (Meter, BBT_TIME) | |
| 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 | record_enabled () | |
| bool | record_safe () | |
| bool | set_name (std::string) | |
| void | set_record_enabled (bool, GroupControlDisposition) | |
| void | set_record_safe (bool, GroupControlDisposition) | |
| Cast | ||
| AudioTrack | to_audio_track () | |
| MidiTrack | to_midi_track () | |
| 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) | |
| bool | customize_plugin_insert (Processor, unsigned int, ChanCount, ChanCount) | |
enable custom plugin-insert configuration
Returns true if successful | ||
| 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) | |
| int | remove_processor (Processor, ProcessorStreams, bool) | |
remove plugin/processor
Returns 0 on success | ||
| bool | remove_sidechain (Processor) | |
| 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*) | |
| bool | set_strict_io (bool) | |
| bool | soloed () | |
| bool | strict_io () | |
| Amp | trim () | |
| Cast | ||
| Track | to_track () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Methods | ||
|---|---|---|
| OwnedPropertyList | properties () | |
| Cast | ||
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
C‡: std::list<boost::weak_ptr<ARDOUR::AudioSource> >
@@ -1082,20 +1831,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: std::set<boost::weak_ptr<ARDOUR::AudioPort> > >
- -| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.WeakPortSet () | |
| Methods | ||
| LuaTable | add (LuaTable {ARDOUR::AudioPort}) | |
| void | clear () | |
| bool | empty () | |
| LuaIter | iter () | |
| unsigned long | size () | |
| LuaTable | table () | |
C‡: std::list<boost::weak_ptr<ARDOUR::Route> >
@@ -1122,14 +1857,36 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: ArdourMarker
-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.
+Location Marker
Editor ruler representation of a location marker or range on the timeline.
| Methods | ||
|---|---|---|
| std::string | name () | |
| long | position () | |
| Type | type () | |
C‡: std::list<ArdourMarker* >
+ +| Constructor | ||
|---|---|---|
| ℂ | ArdourUI.ArdourMarkerList () | |
| Methods | ||
| LuaTable | add (LuaTable {ArdourMarker* }) | |
| bool | empty () | |
| LuaIter | iter () | |
| void | push_back (ArdourMarker) | |
| void | reverse () | |
| unsigned long | size () | |
| LuaTable | table () | |
| void | unique () | |
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) | |
| 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 () | |
| int | get_videotl_bar_height () | |
| double | get_y_origin () | |
| 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_show_measures (bool) | |
| void | set_snap_mode (SnapMode) | |
Set the snap mode.
| ||
Undo some transactions.
| ||
| double | visible_canvas_height () | |
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.
+| Constructor | ||
|---|---|---|
| ℂ | ArdourUI.ArdourMarkerList () | |
| Methods | ||
| LuaTable | add (LuaTable {ArdourMarker* }) | |
| bool | empty () | |
| LuaIter | iter () | |
| void | push_back (ArdourMarker) | |
| void | reverse () | |
| unsigned long | size () | |
| LuaTable | table () | |
| void | unique () | |
C‡: RegionSelection
@@ -1225,10 +2006,67 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| Methods | ||
|---|---|---|
| void | clear_all () | |
Empty this RegionSelection. | ||
| long | end_frame () | |
| unsigned long | n_midi_regions () | |
| RegionList | regionlist () | |
| long | start () | |
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 | |
C‡: TimeSelection
+is-a: ARDOUR:AudioRangeList
+ +| Methods | ||
|---|---|---|
| long | end_frame () | |
| long | length () | |
| long | start () | |
| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.AudioRangeList () | |
| Methods | ||
| bool | empty () | |
| LuaIter | iter () | |
| void | reverse () | |
| unsigned long | size () | |
| LuaTable | table () | |
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.
+| Methods | ||
|---|---|---|
| RouteList | routelist () | |
C‡: TrackViewList
+ +| Methods | ||
|---|---|---|
| RouteList | routelist () | |
C‡: std::vector<double >
@@ -1251,6 +2089,8 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CMakes a copy of the current state of the Context and saves it on an internal stack of saved states. When restore() is called, it will be restored to the saved state. Multiple calls to save() and restore() can be nested; each call to restore() restores the state from the matching paired save().
It isn't necessary to clear all saved states before a cairo_t is freed. Any saved states will be freed when the Context is destroyed.
restore()
Modifies the current transformation matrix (CTM) by scaling the X and Y user-space axes by sx and sy respectively. The scaling of the axes takes place after any existing transformation of user space.
Sets the current font matrix to a scale by a factor of size, replacing any font matrix previously set with set_font_size() or set_font_matrix(). This results in a font size of size user space units. (More precisely, this matrix will result in the font's em-square being a by size square in user space.)
If text is drawn without a call to set_font_size(), (nor set_font_matrix() nor set_scaled_font()), the default font size is 10.0.
C‡: boost::shared_ptr< Evoral::Control >, boost::weak_ptr< Evoral::Control >
+Base class representing some kind of (automatable) control; a fader's gain, for example, or a compressor plugin's threshold.
The class knows the Evoral::Parameter that it is controlling, and has a list of values for automation.
| Methods | ||
|---|---|---|
| bool | isnil () | |
| Methods | ||
|---|---|---|
| void | add (double, double, bool, bool) | |
add automation events
| ||
| void | clear (double, double) | |
remove all automation events between the given time range
| ||
| double | eval (double) | |
query value at given time (takes a read-lock, not safe while writing automation)
Returns parameter value | ||
| bool | in_write_pass () | |
| InterpolationStyle | interpolation () | |
query interpolation style of the automation data Returns Interpolation Style | ||
| bool | isnil () | |
| LuaTable(double, ...) | rt_safe_eval (double, bool&) | |
realtime safe version of eval, may fail if read-lock cannot be taken
Returns parameter value | ||
| void | set_interpolation (InterpolationStyle) | |
set the interpolation style of the automation data
| ||
| 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
| ||
C‡: boost::shared_ptr< Evoral::ControlSet >, boost::weak_ptr< Evoral::ControlSet >
@@ -1464,6 +2326,16 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: Evoral::Range<long>
+ +| Constructor | ||
|---|---|---|
| ℂ | Evoral.Range (long, long) | |
| Data Members | ||
| long | from | |
| long | to | |
C‡: std::bitset<47ul>
@@ -1481,23 +2353,47 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: Command
+is-a: PBD:StatefulDestructible
+ +Base class for Undo/Redo commands and changesets
| Methods | ||
|---|---|---|
| std::string | name () | |
| void | set_name (std::string) | |
| Methods | ||
|---|---|---|
| void | clear_changes () | |
Forget about any changes to this object's properties | ||
| ID | id () | |
| OwnedPropertyList | properties () | |
C‡: boost::shared_ptr< PBD::Controllable >, boost::weak_ptr< PBD::Controllable >
is-a: PBD:StatefulDestructiblePtr
+This is a pure virtual class to represent a scalar control.
Note that it contains no storage/state for the controllable thing that it represents. Derived classes must provide set_value()/get_value() methods, which will involve (somehow) an actual location to store the value.
In essence, this is an interface, not a class.
Without overriding upper() and lower(), a derived class will function as a control whose value can range between 0 and 1.0.
| Methods | ||
|---|---|---|
| double | get_value () | |
| bool | isnil () | |
| std::string | name () | |
| Methods | ||
|---|---|---|
| void | clear_changes () | |
Forget about any changes to this object's properties | ||
| ID | id () | |
| OwnedPropertyList | properties () | |
C‡: PBD::ID
+a unique ID to identify objects numerically
| Constructor | ||
|---|---|---|
| ℂ | PBD.ID (std::string) | |
| Methods | ||
|---|---|---|
| void | clear_changes () | |
Forget about any changes to this object's properties | ||
| ID | id () | |
| OwnedPropertyList | properties () | |
C‡: PBD::StatefulDestructible
is-a: PBD:Stateful
-Base class for objects with saveable and undoable state
Base class for objects with saveable and undoable state with destruction notification
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
| Methods | ||
|---|---|---|
| void | clear_changes () | |
Forget about any changes to this object's properties | ||
| ID | id () | |
| OwnedPropertyList | properties () | |
C‡: boost::shared_ptr< PBD::StatefulDestructible >, boost::weak_ptr< PBD::StatefulDestructible >
is-a: PBD:StatefulPtr
+Base class for objects with saveable and undoable state with destruction notification
| Methods | ||
|---|---|---|
| bool | isnil () | |
| Methods | ||
|---|---|---|
| void | clear_changes () | |
Forget about any changes to this object's properties | ||
| ID | id () | |
| OwnedPropertyList | properties () | |
C‡: PBD::StatefulDiffCommand
+is-a: PBD:Command
+ +A Command which stores its action as the differences between the before and after state of a Stateful object.
| Methods | ||
|---|---|---|
| bool | empty () | |
| void | undo () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| void | set_name (std::string) | |
| Methods | ||
|---|---|---|
| void | clear_changes () | |
Forget about any changes to this object's properties | ||
| ID | id () | |
| OwnedPropertyList | properties () | |
C‡: boost::shared_ptr< PBD::Stateful >, boost::weak_ptr< PBD::Stateful >
+Base class for objects with saveable and undoable state
| Methods | ||
|---|---|---|
| void | clear_changes () | |
Forget about any changes to this object's properties | ||
| ID | id () | |
| bool | isnil () | |
| OwnedPropertyList | properties () | |
C‡: XMLNode
+ +| Methods | ||
|---|---|---|
| std::string | name () | |
C‡: Timecode::BBT_Time
@@ -1559,6 +2500,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C