From: Robin Gareus Date: Sat, 26 Mar 2016 20:23:35 +0000 (+0100) Subject: include generated lua class reference X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2cb1352946cba2bb946114738fdb987ae1ce7f17;p=ardour-manual include generated lua class reference --- diff --git a/_layouts/bootstrap.html b/_layouts/bootstrap.html index dec5312..f949bbb 100644 --- a/_layouts/bootstrap.html +++ b/_layouts/bootstrap.html @@ -16,6 +16,9 @@ page_title: The Ardour Manual + {% if page.style %} + + {% endif %} diff --git a/_manual/24_lua-scripting/01_brain_dump.html b/_manual/24_lua-scripting/01_brain_dump.html index 1250415..fe3820b 100644 --- a/_manual/24_lua-scripting/01_brain_dump.html +++ b/_manual/24_lua-scripting/01_brain_dump.html @@ -1,6 +1,6 @@ --- layout: default -title: Lua Scripting Documentation +title: Scripting Documentation ---

diff --git a/_manual/24_lua-scripting/02_class_reference.html b/_manual/24_lua-scripting/02_class_reference.html new file mode 100644 index 0000000..8f71da0 --- /dev/null +++ b/_manual/24_lua-scripting/02_class_reference.html @@ -0,0 +1,1843 @@ +--- +layout: default +style: luadoc +title: Class Reference +--- + +

+This documention 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"). +

+

+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. +

+ +
+
C++ + +
void set_ref (int& var, long& val)
+{
+	printf ("%d %ld\n", var, val);
+	var = 5;
+	val = 7;
+}
+
+ +
+
Lua + +
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 abstration 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 inidicated 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:AudioBackend

+

C‡: boost::shared_ptr< ARDOUR::AudioBackend >, boost::weak_ptr< ARDOUR::AudioBackend >

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods
unsigned intbuffer_size ()
std::stringdevice_name ()
std::stringdriver_name ()

override this if this implementation returns true from requires_driver_selection()

floatdsp_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).

DeviceStatusVectorenumerate_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.

StringVectorenumerate_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.

DeviceStatusVectorenumerate_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.

DeviceStatusVectorenumerate_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.

AudioBackendInfoinfo ()

Return the AudioBackendInfo object from which this backend was constructed.

unsigned intinput_channels ()
std::stringinput_device_name ()
boolisnil ()
unsigned intoutput_channels ()
std::stringoutput_device_name ()
unsigned intperiod_size ()
floatsample_rate ()
intset_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).

intset_device_name (std::string)

Set the name of the device to be used

intset_driver (std::string)

Returns zero if the backend can successfully use

Should not be used unless the backend returns true from requires_driver_selection()

name
as the driver, non-zero otherwise.
intset_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()

intset_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()

intset_peridod_size (unsigned int)

Set the period size to be used. must be called before starting the backend.

intset_sample_rate (float)

Set the sample rate to be used

booluse_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
voidapply_gain (float, long)
FloatArraydata (long)
voidsilence (long, long)

Clear (eg zero, or empty) buffer

+

∁ ARDOUR:AudioEngine

+

C‡: ARDOUR::AudioEngine

+
+ + + + + + + + + + + + + +
Methods
BackendVectoravailable_backends ()
std::stringcurrent_backend_name ()
floatget_dsp_load ()
std::stringget_last_backend_error ()
AudioBackendset_backend (std::string, std::string, std::string)
intset_buffer_size (unsigned int)
intset_device_name (std::string)
intset_sample_rate (float)
boolsetup_required ()
intstart (bool)
intstop (bool)
+

↠ ARDOUR:AudioSource

+

C‡: boost::shared_ptr< ARDOUR::AudioSource >, boost::weak_ptr< ARDOUR::AudioSource >

+

is-a: ARDOUR:Source

+
+ + + + + +
Methods
boolisnil ()
unsigned intn_channels ()
longreadable_length ()
+

↠ ARDOUR:AudioTrack

+

C‡: boost::shared_ptr< ARDOUR::AudioTrack >, boost::weak_ptr< ARDOUR::AudioTrack >

+

is-a: ARDOUR:Track

+
+ + + +
Methods
boolisnil ()
+

Inherited from ARDOUR:Track

+ + + + + + + + +
Methods
boolcan_record ()
boolrecord_enabled ()
boolrecord_safe ()
boolset_name (std::string)
voidset_record_enabled (bool, GroupControlDisposition)
voidset_record_safe (bool, GroupControlDisposition)
+

Inherited from ARDOUR:Route

+ + + + + + + + + + + + + + +
Methods
boolactive ()
intadd_processor_by_index (Processor, int, ProcessorStreams, bool)
std::stringcomment ()
ChanCountn_inputs ()
ChanCountn_outputs ()
Processornth_plugin (unsigned int)
intremove_processor (Processor, ProcessorStreams, bool)
intreplace_processor (Processor, Processor, ProcessorStreams)
voidset_active (bool, void*)
voidset_comment (std::string, void*)
boolset_strict_io (bool)
boolstrict_io ()
+

Inherited from ARDOUR:SessionObject

+ + + +
Methods
std::stringname ()
+

Inherited from PBD:StatefulPtr

+ + + +
Methods
OwnedPropertyListproperties ()
+

∁ ARDOUR:AudioTrackList

+

C‡: std::list<boost::shared_ptr<ARDOUR::AudioTrack> >

+
+ + + + + + + + + + + + +
Constructor
ℂARDOUR.AudioTrackList ()
Methods
LuaTableadd (LuaTable {AudioTrack})
boolempty ()
LuaIteriter ()
voidpush_back (AudioTrack)
voidreverse ()
unsigned longsize ()
LuaTabletable ()
voidunique ()
+

↠ ARDOUR:Automatable

+

C‡: boost::shared_ptr< ARDOUR::Automatable >, boost::weak_ptr< ARDOUR::Automatable >

+

is-a: Evoral:ControlSet

+
+ + + + +
Methods
AutomationControlautomation_control (Parameter, bool)
boolisnil ()
+

↠ ARDOUR:AutomationControl

+

C‡: boost::shared_ptr< ARDOUR::AutomationControl >, boost::weak_ptr< ARDOUR::AutomationControl >

+

is-a: Evoral:Control

+
+ + + + + + + + + + + +
Methods
AutoStateautomation_state ()
doubleget_value ()
boolisnil ()
voidset_automation_style (AutoStyle)
voidset_value (double, GroupControlDisposition)

Get and Set `internal' value

All derived classes must implement this.

Basic derived classes will ignore

group_override,
but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.
voidstart_touch (double)
voidstop_touch (bool, double)
boolwritable ()
+

Inherited from Evoral:Control

+ + + +
Methods
ControlListlist ()
+

∁ ARDOUR:BackendVector

+

C‡: std::vector<ARDOUR::AudioBackendInfo const* >

+
+ + + + + + + + + + + +
Constructor
ℂARDOUR.BackendVector ()
Methods
LuaTableadd (LuaTable {ARDOUR::AudioBackendInfo* })
AudioBackendInfoat (unsigned long)
boolempty ()
LuaIteriter ()
voidpush_back (AudioBackendInfo)
unsigned longsize ()
LuaTabletable ()
+

∁ ARDOUR:BufferSet

+

C‡: ARDOUR::BufferSet

+
+

A set of buffers of various types.

These are mainly accessed from Session and passed around as scratch buffers (eg as parameters to run() methods) to do in-place signal processing.

There are two types of counts associated with a BufferSet - available, and the 'use count'. Available is the actual number of allocated buffers (and so is the maximum acceptable value for the use counts).

The use counts are how things determine the form of their input and inform others the form of their output (eg what they did to the BufferSet). Setting the use counts is realtime safe.

+ + + + +
Methods
ChanCountcount ()
AudioBufferget_audio (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.

+ + + +
Methods
unsigned intn_audio ()
+

∁ ARDOUR:ChanMapping

+

C‡: ARDOUR::ChanMapping

+
+

A mapping from one set of channels to another (e.g. how to 'connect' two BufferSets).

+ + + + + + +
Constructor
ℂARDOUR.ChanMapping ()
Methods
unsigned intget (DataType, unsigned int)
voidset (DataType, unsigned int, unsigned int)
+

ℕ ARDOUR.DSP

+
+ + + + + + + + + + + + + + + + + + + + + +
Methods
floataccurate_coefficient_to_dB (float)
voidapply_gain_to_buffer (FloatArray, unsigned int, float)
floatcompute_peak (FloatArray, unsigned int, float)
voidcopy_vector (FloatArray, FloatArray, unsigned int)
floatdB_to_coefficient (float)
floatfast_coefficient_to_dB (float)
voidfind_peaks (FloatArray, unsigned int, FloatArray, FloatArray)
floatlog_meter (float)

non-linear power-scale meter deflection

power
signal power (dB)

Returns deflected value

floatlog_meter_coeff (float)

non-linear power-scale meter deflection

coeff
signal value

Returns deflected value

voidmemset (FloatArray, float, unsigned int)

lua wrapper to memset()

voidmix_buffers_no_gain (FloatArray, FloatArray, unsigned int)
voidmix_buffers_with_gain (FloatArray, FloatArray, unsigned int, float)
voidmmult (FloatArray, FloatArray, unsigned int)

matrix multiply multiply every sample of `data' with the corresponding sample at `mult'.

data
multiplicand
mult
multiplicand
n_samples
number of samples in data and mmult
LuaTable(...)peaks (FloatArray, float&, float&, unsigned int)

calculate peaks

data
data to analyze
min
result, minimum value found in range
max
result, max value found in range
n_samples
number of samples to analyze
+

∁ ARDOUR:DSP:Biquad

+

C‡: ARDOUR::DSP::BiQuad

+
+

Biquad Filter

+ + + + + + + + + + +
Constructor
ℂARDOUR.DSP.Biquad (double)
Methods
voidcompute (Type, double, double, double)

setup filter, compute coefficients

t
filter type (LowPass, HighPass, etc)
freq
filter frequency
Q
filter quality
gain
filter gain
voidreset ()

reset filter state

voidrun (FloatArray, unsigned int)

process audio data

data
pointer to audio-data
n_samples
number of samples to process
+

∁ 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.

+ + + + + + + + + + + + + + +
Methods
voidallocate (unsigned long)

[re] allocate memory in host's memory space

s
size, total number of float or integer elements to store.
intatomic_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.

off
offset in shared memory region

Returns value at offset

voidatomic_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.

off
offset in shared memory region
val
value to set
voidclear ()

clear memory (set to zero)

FloatArrayto_float (unsigned long)

access memory as float array

off
offset in shared memory region

Returns float[]

IntArrayto_int (unsigned long)

access memory as integer array

off
offset in shared memory region

Returns int_32_t[]

+

∁ ARDOUR:DSP:LowPass

+

C‡: ARDOUR::DSP::LowPass

+
+

1st order Low Pass filter

+ + + + + + + + + + + + + +
Constructor
ℂARDOUR.DSP.LowPass (double, float)

instantiate a LPF

samplerate
samplerate
freq
cut-off frequency
Methods
voidctrl (FloatArray, float, unsigned int)

filter control data

This is useful for parameter smoothing.

data
pointer to control-data array
val
target value
array
length
voidproc (FloatArray, unsigned int)

process audio data

data
pointer to audio-data
n_samples
number of samples to process
voidreset ()

reset filter state

voidset_cutoff (float)

update filter cut-off frequency

freq
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)
+

∁ ARDOUR:DeviceStatus

+

C‡: ARDOUR::AudioBackend::DeviceStatus

+
+

used to list device names along with whether or not they are currently available.

+ + + + +
Data Members
boolavailable
std::stringname
+

∁ ARDOUR:DeviceStatusVector

+

C‡: std::vector<ARDOUR::AudioBackend::DeviceStatus >

+
+ + + + + + + + + + + +
Constructor
ℂARDOUR.DeviceStatusVector ()
Methods
LuaTableadd (LuaTable {DeviceStatus})
DeviceStatusat (unsigned long)
boolempty ()
LuaIteriter ()
voidpush_back (DeviceStatus)
unsigned longsize ()
LuaTabletable ()
+

∁ ARDOUR:Location

+

C‡: ARDOUR::Location

+

is-a: PBD:StatefulDestructible

+
+

Base class for objects with saveable and undoable state

+ + + + + + + + + + + +
Methods
longend ()
longlength ()
voidlock ()
boollocked ()
intmove_to (long)
intset_end (long, bool, bool)
intset_length (long, long, bool)
intset_start (long, bool, bool)
longstart ()
+

Inherited from PBD:Stateful

+ + + +
Methods
OwnedPropertyListproperties ()
+

ℕ ARDOUR.LuaAPI

+
+ + + + + + + + + + + + +
Methods
Processornew_luaproc (Session, std::string)

create a new Lua Processor (Plugin)

s
Session Handle
p
Identifier or Name of the Processor

Returns Processor object (may be nil)

Processornew_plugin (Session, std::string, PluginType, std::string)

create a new Plugin Instance

s
Session Handle
id
Plugin Name, ID or URI
type
Plugin Type

Returns Processor or nil

PluginInfonew_plugin_info (std::string, PluginType)

search a Plugin

id
Plugin Name, ID or URI
type
Plugin Type

Returns PluginInfo or nil if not found

boolset_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.

which
control-input to set (starting at 0)
proc
Plugin-Insert
value
value to set

Returns true on success, false on error or out-of-bounds value

boolset_processor_param (Processor, unsigned int, float)

set a plugin control-input parameter value

proc
Plugin-Processor
which
control-input to set (starting at 0)
value
value to set

Returns true on success, false on error or out-of-bounds value

+

∁ 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

uri
the destination uri e.g. "osc.udp://localhost:7890"
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

lua:
lua arguments: path, types, ...

Returns boolean true if successful, false on error.

+

∁ 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
doubledivisions_per_bar ()
doubleframes_per_bar (Tempo, long)
doubleframes_per_grid (Tempo, long)
doublenote_divisor ()
+

∁ ARDOUR:MidiBuffer

+

C‡: ARDOUR::MidiBuffer

+
+

Buffer containing 8-bit unsigned char (MIDI) data.

+ + + + + +
Methods
boolempty ()
voidsilence (long, long)

Clear (eg zero, or empty) buffer

+

↠ ARDOUR:MidiTrack

+

C‡: boost::shared_ptr< ARDOUR::MidiTrack >, boost::weak_ptr< ARDOUR::MidiTrack >

+

is-a: ARDOUR:Track

+
+ + + +
Methods
boolisnil ()
+

Inherited from ARDOUR:Track

+ + + + + + + + +
Methods
boolcan_record ()
boolrecord_enabled ()
boolrecord_safe ()
boolset_name (std::string)
voidset_record_enabled (bool, GroupControlDisposition)
voidset_record_safe (bool, GroupControlDisposition)
+

Inherited from ARDOUR:Route

+ + + + + + + + + + + + + + +
Methods
boolactive ()
intadd_processor_by_index (Processor, int, ProcessorStreams, bool)
std::stringcomment ()
ChanCountn_inputs ()
ChanCountn_outputs ()
Processornth_plugin (unsigned int)
intremove_processor (Processor, ProcessorStreams, bool)
intreplace_processor (Processor, Processor, ProcessorStreams)
voidset_active (bool, void*)
voidset_comment (std::string, void*)
boolset_strict_io (bool)
boolstrict_io ()
+

Inherited from ARDOUR:SessionObject

+ + + +
Methods
std::stringname ()
+

Inherited from PBD:StatefulPtr

+ + + +
Methods
OwnedPropertyListproperties ()
+

∁ ARDOUR:MidiTrackList

+

C‡: std::list<boost::shared_ptr<ARDOUR::MidiTrack> >

+
+ + + + + + + + + + + + +
Constructor
ℂARDOUR.MidiTrackList ()
Methods
LuaTableadd (LuaTable {MidiTrack})
boolempty ()
LuaIteriter ()
voidpush_back (MidiTrack)
voidreverse ()
unsigned longsize ()
LuaTabletable ()
voidunique ()
+

∅ ARDOUR:OwnedPropertyList

+

C‡: PBD::OwnedPropertyList

+

is-a: ARDOUR:PropertyList

+
+

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: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 ()
Data Members
std::stringlabel
boollogarithmic
+

Inherited from Evoral:ParameterDescriptor

+ + + + + + + + +
Constructor
ℂEvoral.ParameterDescriptor ()
Data Members
floatlower
floatnormal
booltoggled
floatupper
+

↠ ARDOUR:Plugin

+

C‡: boost::shared_ptr< ARDOUR::Plugin >, boost::weak_ptr< ARDOUR::Plugin >

+

is-a: PBD:StatefulDestructiblePtr

+
+ + + + + + + + + + + + + + + +
Methods
std::stringget_docs ()
LuaTable(int, ...)get_parameter_descriptor (unsigned int, ParameterDescriptor&)
std::stringget_parameter_docs (unsigned int)
boolisnil ()
char*label ()
boolload_preset (PresetRecord)
char*maker ()
char*name ()
LuaTable(unsigned int, ...)nth_parameter (unsigned int, bool&)
unsigned intparameter_count ()
boolparameter_is_input (unsigned int)
PresetRecordpreset_by_label (std::string)
PresetRecordpreset_by_uri (std::string)
+

Inherited from PBD:StatefulPtr

+ + + +
Methods
OwnedPropertyListproperties ()
+

↠ ARDOUR:PluginControl

+

C‡: boost::shared_ptr< ARDOUR::PluginInsert::PluginControl >, boost::weak_ptr< ARDOUR::PluginInsert::PluginControl >

+

is-a: ARDOUR:AutomationControl

+
+ + + +
Methods
boolisnil ()
+

Inherited from ARDOUR:AutomationControl

+ + + + + + + + + + +
Methods
AutoStateautomation_state ()
doubleget_value ()
voidset_automation_style (AutoStyle)
voidset_value (double, GroupControlDisposition)

Get and Set `internal' value

All derived classes must implement this.

Basic derived classes will ignore

group_override,
but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.
voidstart_touch (double)
voidstop_touch (bool, double)
boolwritable ()
+

Inherited from Evoral:Control

+ + + +
Methods
ControlListlist ()
+

↠ ARDOUR:PluginInfo

+

C‡: boost::shared_ptr< ARDOUR::PluginInfo >, boost::weak_ptr< ARDOUR::PluginInfo >

+
+ + + + + +
Constructor
ℂARDOUR.PluginInfo ()
Methods
boolisnil ()
+

↠ ARDOUR:PluginInsert

+

C‡: boost::shared_ptr< ARDOUR::PluginInsert >, boost::weak_ptr< ARDOUR::PluginInsert >

+

is-a: ARDOUR:Processor

+
+ + + + + + + + + + + + + + +
Methods
voidactivate ()
voiddeactivate ()
ChanMappinginput_map (unsigned int)
boolisnil ()
boolno_inplace ()
ChanMappingoutput_map (unsigned int)
Pluginplugin (unsigned int)
voidset_input_map (unsigned int, ChanMapping)
voidset_no_inplace (bool)
voidset_output_map (unsigned int, ChanMapping)
voidset_strict_io (bool)
boolstrict_io_configured ()
+

Inherited from ARDOUR:Processor

+ + + + + + + +
Methods
boolactive ()
AutomationControlautomation_control (Parameter, bool)
Controlcontrol (Parameter, bool)
std::stringdisplay_name ()
PluginInsertto_insert ()
+

Inherited from ARDOUR:SessionObject

+ + + +
Methods
std::stringname ()
+

Inherited from PBD:StatefulPtr

+ + + +
Methods
OwnedPropertyListproperties ()
+

∁ ARDOUR:PresetRecord

+

C‡: ARDOUR::Plugin::PresetRecord

+
+ + + + + + +
Data Members
std::stringlabel
std::stringuri
booluser
boolvalid
+

↠ ARDOUR:Processor

+

C‡: boost::shared_ptr< ARDOUR::Processor >, boost::weak_ptr< ARDOUR::Processor >

+

is-a: ARDOUR:Automatable, ARDOUR:SessionObject

+
+ + + + + + + + + + + +
Methods
voidactivate ()
boolactive ()
AutomationControlautomation_control (Parameter, bool)
Controlcontrol (Parameter, bool)
voiddeactivate ()
std::stringdisplay_name ()
boolisnil ()
boolisnil ()
PluginInsertto_insert ()
+

Inherited from ARDOUR:SessionObject

+ + + +
Methods
std::stringname ()
+

Inherited from PBD:StatefulPtr

+ + + +
Methods
OwnedPropertyListproperties ()
+

∅ 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
boolcontainsBool (BoolProperty)
boolcontainsFloat (FloatProperty)
boolcontainsFramePos (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:Region

+

C‡: boost::shared_ptr< ARDOUR::Region >, boost::weak_ptr< ARDOUR::Region >

+

is-a: ARDOUR:SessionObject

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods
boolat_natural_position ()
boolautomatic ()
boolcan_move ()
boolcaptured ()
voidclear_sync_position ()
boolcovers (long)
voidcut_end (long)
voidcut_front (long)
DataTypedata_type ()
boolexternal ()
boolhidden ()
boolimport ()
boolis_compound ()
boolisnil ()
unsigned intlayer ()
longlength ()
boollocked ()
voidlower ()
voidlower_to_bottom ()
voidmove_start (long)
voidmove_to_natural_position ()
boolmuted ()
voidnudge_position (long)
boolopaque ()
longposition ()

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

boolposition_locked ()
voidraise ()
voidraise_to_top ()
voidset_hidden (bool)
voidset_initial_position (long)
voidset_length (long)
voidset_locked (bool)
voidset_muted (bool)
voidset_opaque (bool)
voidset_position (long)
voidset_position_locked (bool)
voidset_start (long)
voidset_sync_position (long)
voidset_video_locked (bool)
floatshift ()
longstart ()
floatstretch ()
boolsync_marked ()
LuaTable(long, ...)sync_offset (int&)
longsync_position ()
voidtrim_end (long)
voidtrim_front (long)
voidtrim_to (long, long)
boolvalid_transients ()
boolvideo_locked ()
boolwhole_file ()
+

Inherited from ARDOUR:SessionObject

+ + + +
Methods
std::stringname ()
+

Inherited from PBD:StatefulPtr

+ + + +
Methods
OwnedPropertyListproperties ()
+

∁ ARDOUR:RegionFactory

+

C‡: ARDOUR::RegionFactory

+
+ + + +
Methods
Regionregion_by_id (ID)
+

↠ ARDOUR:Route

+

C‡: boost::shared_ptr< ARDOUR::Route >, boost::weak_ptr< ARDOUR::Route >

+

is-a: ARDOUR:SessionObject

+
+ + + + + + + + + + + + + + + + +
Methods
boolactive ()
intadd_processor_by_index (Processor, int, ProcessorStreams, bool)
std::stringcomment ()
boolisnil ()
ChanCountn_inputs ()
ChanCountn_outputs ()
Processornth_plugin (unsigned int)
intremove_processor (Processor, ProcessorStreams, bool)
intreplace_processor (Processor, Processor, ProcessorStreams)
voidset_active (bool, void*)
voidset_comment (std::string, void*)
boolset_name (std::string)
boolset_strict_io (bool)
boolstrict_io ()
+

Inherited from ARDOUR:SessionObject

+ + + +
Methods
std::stringname ()
+

Inherited from PBD:StatefulPtr

+ + + +
Methods
OwnedPropertyListproperties ()
+

∁ 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:RouteList

+

C‡: std::list<boost::shared_ptr<ARDOUR::Route> >

+
+ + + + + + + + + +
Constructor
ℂARDOUR.RouteList ()
Methods
boolempty ()
LuaIteriter ()
voidreverse ()
unsigned longsize ()
LuaTabletable ()
+

∁ ARDOUR:RouteListPtr

+

C‡: boost::shared_ptr<std::list<boost::shared_ptr<ARDOUR::Route> > >

+
+ + + + + + + + + + + + +
Constructor
ℂARDOUR.RouteListPtr ()
Methods
LuaTableadd (LuaTable {Route})
boolempty ()
LuaIteriter ()
voidpush_back (Route)
voidreverse ()
unsigned longsize ()
LuaTabletable ()
voidunique ()
+

∁ ARDOUR:Session

+

C‡: ARDOUR::Session

+
+

Base class for objects with saveable and undoable state

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods
boolactively_recording ()
Controllablecontrollable_by_id (ID)
longcurrent_end_frame ()
longcurrent_start_frame ()
longframe_rate ()

"actual" sample rate of session, set by current audioengine rate, pullup/down etc.

doubleframes_per_timecode_frame ()
RouteListPtrget_routes ()
BufferSetget_scratch_buffers (ChanCount, bool)
BufferSetget_silent_buffers (ChanCount)
RouteListPtrget_tracks ()
voidgoto_end ()
voidgoto_start ()
longlast_transport_start ()
std::stringname ()
RouteListnew_route_from_template (unsigned int, std::string, std::string, PlaylistDisposition)
longnominal_frame_rate ()

"native" sample rate of session, regardless of current audioengine rate, pullup/down etc

std::stringpath ()
Processorprocessor_by_id (ID)
RecordStaterecord_status ()
voidrequest_locate (long, bool)
voidrequest_stop (bool, bool)
voidrequest_transport_speed (double, bool)
Routeroute_by_id (ID)
Routeroute_by_name (std::string)
Routeroute_by_remote_id (unsigned int)
intsave_state (std::string, bool, bool, bool)
voidscripts_changed ()
voidset_dirty ()
std::stringsnap_name ()
Sourcesource_by_id (ID)
TempoMaptempo_map ()
booltimecode_drop_frames ()
longtimecode_frames_per_hour ()
doubletimecode_frames_per_second ()
Tracktrack_by_diskstream_id (ID)
longtransport_frame ()
booltransport_rolling ()
doubletransport_speed ()
StringListunknown_processors ()
+

↠ ARDOUR:SessionObject

+

C‡: boost::shared_ptr< ARDOUR::SessionObject >, boost::weak_ptr< ARDOUR::SessionObject >

+

is-a: PBD:StatefulDestructiblePtr

+
+ + + + +
Methods
boolisnil ()
std::stringname ()
+

Inherited from PBD:StatefulPtr

+ + + +
Methods
OwnedPropertyListproperties ()
+

↠ ARDOUR:Source

+

C‡: boost::shared_ptr< ARDOUR::Source >, boost::weak_ptr< ARDOUR::Source >

+
+ + + +
Methods
boolisnil ()
+

∁ ARDOUR:Tempo

+

C‡: ARDOUR::Tempo

+
+

Tempo, the speed at which musical time progresses (BPM).

+ + + + + + + + + +
Constructor
ℂARDOUR.Tempo (double, double)
bpm
Beats Per Minute
type
Note Type (default `4': quarter note)
Methods
doublebeats_per_minute ()
doubleframes_per_beat (long)

audio samples per beat

sr
samplerate
doublenote_type ()
+

∁ ARDOUR:TempoMap

+

C‡: ARDOUR::TempoMap

+
+

Base class for objects with saveable and undoable state

+ + + + +
Methods
voidadd_meter (Meter, BBT_TIME)
voidadd_tempo (Tempo, BBT_TIME)
+

↠ ARDOUR:Track

+

C‡: boost::shared_ptr< ARDOUR::Track >, boost::weak_ptr< ARDOUR::Track >

+

is-a: ARDOUR:Route

+
+ + + + + + + + + +
Methods
boolcan_record ()
boolisnil ()
boolrecord_enabled ()
boolrecord_safe ()
boolset_name (std::string)
voidset_record_enabled (bool, GroupControlDisposition)
voidset_record_safe (bool, GroupControlDisposition)
+

Inherited from ARDOUR:Route

+ + + + + + + + + + + + + + +
Methods
boolactive ()
intadd_processor_by_index (Processor, int, ProcessorStreams, bool)
std::stringcomment ()
ChanCountn_inputs ()
ChanCountn_outputs ()
Processornth_plugin (unsigned int)
intremove_processor (Processor, ProcessorStreams, bool)
intreplace_processor (Processor, Processor, ProcessorStreams)
voidset_active (bool, void*)
voidset_comment (std::string, void*)
boolset_strict_io (bool)
boolstrict_io ()
+

Inherited from ARDOUR:SessionObject

+ + + +
Methods
std::stringname ()
+

Inherited from PBD:StatefulPtr

+ + + +
Methods
OwnedPropertyListproperties ()
+

∁ ARDOUR:WeakAudioSourceList

+

C‡: std::list<boost::weak_ptr<ARDOUR::AudioSource> >

+
+ + + + + + + + + +
Constructor
ℂARDOUR.WeakAudioSourceList ()
Methods
boolempty ()
LuaIteriter ()
voidreverse ()
unsigned longsize ()
LuaTabletable ()
+

∁ ARDOUR:WeakPortSet

+

C‡: std::set<boost::weak_ptr<ARDOUR::AudioPort> > >

+
+ + + + + + + + + + +
Constructor
ℂARDOUR.WeakPortSet ()
Methods
LuaTableadd (LuaTable {ARDOUR::AudioPort})
voidclear ()
boolempty ()
LuaIteriter ()
unsigned longsize ()
LuaTabletable ()
+

∁ ARDOUR:WeakRouteList

+

C‡: std::list<boost::weak_ptr<ARDOUR::Route> >

+
+ + + + + + + + + +
Constructor
ℂARDOUR.WeakRouteList ()
Methods
boolempty ()
LuaIteriter ()
voidreverse ()
unsigned longsize ()
LuaTabletable ()
+

∁ ARDOUR:WeakSourceList

+

C‡: std::list<boost::weak_ptr<ARDOUR::Source> >

+
+ + + + + + + + + +
Constructor
ℂARDOUR.WeakSourceList ()
Methods
boolempty ()
LuaIteriter ()
voidreverse ()
unsigned longsize ()
LuaTabletable ()
+

∅ ArdourUI:ArdourMarker

+

C‡: 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.

+

∁ ArdourUI:Editor

+

C‡: PublicEditor

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods
voidaccess_action (std::string, std::string)
voidadd_location_from_playhead_cursor ()
voidcenter_screen (long)
voidconsider_auditioning (Region)

Possibly start the audition of a region. If

r
is 0, or not an AudioRegion any current audition is cancelled. If we are currently auditioning
r
will start.
r
Region to consider.
r,
the audition will be cancelled. Otherwise an audition of
MouseModecurrent_mouse_mode ()

Returns The current mouse mode (gain, object, range, timefx etc.) (defined in editing_syms.h)

longcurrent_page_samples ()
voiddeselect_all ()
LuaTable(...)do_embed (StringVector, ImportDisposition, ImportMode, long&, PluginInfo)
LuaTable(...)do_import (StringVector, ImportDisposition, ImportMode, SrcQuality, long&, PluginInfo)
booldragging_playhead ()

Returns true if the playhead is currently being dragged, otherwise false

MouseModeeffective_mouse_mode ()
voidexport_audio ()

Open main export dialog

voidexport_range ()

Open export dialog with current range pre-selected

voidexport_selection ()

Open export dialog with current selection pre-selected

LuaTable(Location, ...)find_location_from_marker (ArdourMarker, bool&)
ArdourMarkerfind_marker_from_location_id (ID, bool)
boolfollow_playhead ()

Returns true if the editor is following the playhead

longget_current_zoom ()
unsigned intget_grid_beat_divisions (long)
LuaTable(Beats, ...)get_grid_type_as_beats (bool&, long)
LuaTable(long, ...)get_nudge_distance (long, long&)
longget_paste_offset (long, unsigned int, long)
LuaTable(...)get_pointer_position (double&, double&)
boolget_smart_mode ()
intget_videotl_bar_height ()
doubleget_y_origin ()
ZoomFocusget_zoom_focus ()
voidgoto_nth_marker (int)
longleftmost_sample ()
voidmaximise_editing_space ()
voidmaybe_locate_with_edit_preroll (long)
voidmouse_add_new_marker (long, bool)
voidnew_region_from_selection ()
voidoverride_visible_track_count ()
longpixel_to_sample (double)
voidplay_selection ()
voidplay_with_preroll ()
voidredo (unsigned int)

Redo some transactions.

n
Number of transaction to redo.
voidremove_last_capture ()
voidremove_location_at_playhead_cursor ()
voidremove_tracks ()
voidreset_x_origin (long)
voidreset_y_origin (double)
voidreset_zoom (long)
voidrestore_editing_space ()
doublesample_to_pixel (long)
boolscroll_down_one_track (bool)
voidscroll_tracks_down_line ()
voidscroll_tracks_up_line ()
boolscroll_up_one_track (bool)
voidselect_all_tracks ()
voidseparate_region_from_selection ()
voidset_follow_playhead (bool, bool)

Set whether the editor should follow the playhead.

yn
true to follow playhead, otherwise false.
catch_up
true to reset the editor view to show the playhead (if yn == true), otherwise false.
voidset_mouse_mode (MouseMode, bool)

Set the mouse mode (gain, object, range, timefx etc.)

m
Mouse mode (defined in editing_syms.h)
force
Perform the effects of the change even if no change is required (ie even if the current mouse mode is equal to
voidset_show_measures (bool)
voidset_snap_mode (SnapMode)

Set the snap mode.

m
Snap mode (defined in editing_syms.h)
voidset_snap_threshold (double)

Set the snap threshold.

t
Snap threshold in `units'.
voidset_stationary_playhead (bool)
voidset_video_timeline_height (int)
voidset_zoom_focus (ZoomFocus)
boolshow_measures ()
SnapModesnap_mode ()
SnapTypesnap_type ()
boolstationary_playhead ()
voidstem_export ()

Open stem export dialog

voidtemporal_zoom_step (bool)
voidtoggle_meter_updating ()
voidtoggle_ruler_video (bool)
voidtoggle_xjadeo_proc (int)
voidundo (unsigned int)

Undo some transactions.

n
Number of transactions to undo.
doublevisible_canvas_height ()
+

∁ ArdourUI:RegionSelection

+

C‡: RegionSelection

+
+

Class to represent list of selected regions.

+ + + + + + +
Methods
voidclear_all ()
longend_frame ()
unsigned longn_midi_regions ()
longstart ()
+

∁ C:DoubleVector

+

C‡: std::vector<double >

+
+ + + + + + + + + + + +
Constructor
ℂC.DoubleVector ()
Methods
LuaTableadd (LuaTable {double})
doubleat (unsigned long)
boolempty ()
LuaIteriter ()
voidpush_back (double)
unsigned longsize ()
LuaTabletable ()
+

⋯ C:FloatArray

+

C‡: float*

+
+ + + + + +
Methods
LuaMetaTablearray ()
LuaTableget_table ()
voidset_table (LuaTable {float})
+

⋯ C:IntArray

+

C‡: int*

+
+ + + + + +
Methods
LuaMetaTablearray ()
LuaTableget_table ()
voidset_table (LuaTable {int})
+

∁ C:StringList

+

C‡: std::list<std::string >

+
+ + + + + + + + + + + + +
Constructor
ℂC.StringList ()
Methods
LuaTableadd (LuaTable {std::string})
boolempty ()
LuaIteriter ()
voidpush_back (std::string)
voidreverse ()
unsigned longsize ()
LuaTabletable ()
voidunique ()
+

∁ C:StringVector

+

C‡: std::vector<std::string >

+
+ + + + + + + + + + + +
Constructor
ℂC.StringVector ()
Methods
LuaTableadd (LuaTable {std::string})
std::stringat (unsigned long)
boolempty ()
LuaIteriter ()
voidpush_back (std::string)
unsigned longsize ()
LuaTabletable ()
+

∁ Cairo:Context

+

C‡: Cairo::Context

+
+

Context is the main class used to draw in cairomm. It contains the current state of the rendering device, including coordinates of yet to be drawn shapes.

In the simplest case, create a Context with its target Surface, set its drawing options (line width, color, etc), create shapes with methods like move_to() and line_to(), and then draw the shapes to the Surface using methods such as stroke() or fill().

Context is a reference-counted object that should be used via Cairo::RefPtr.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods
voidarc (double, double, double, double, double)

Adds a circular arc of the given radius to the current path. The arc is centered at (xc, yc), begins at angle1 and proceeds in the direction of increasing angles to end at angle2. If angle2 is less than angle1 it will be progressively increased by 2*M_PI until it is greater than angle1.

If there is a current point, an initial line segment will be added to the path to connect the current point to the beginning of the arc. If this initial line is undesired, it can be avoided by calling begin_new_sub_path() before calling arc().

Angles are measured in radians. An angle of 0 is in the direction of the positive X axis (in user-space). An angle of M_PI/2.0 radians (90 degrees) is in the direction of the positive Y axis (in user-space). Angles increase in the direction from the positive X axis toward the positive Y axis. So with the default transformation matrix, angles increase in a clockwise direction.

( To convert from degrees to radians, use degrees * (M_PI / 180.0). )

This function gives the arc in the direction of increasing angles; see arc_negative() to get the arc in the direction of decreasing angles.

The arc is circular in user-space. To achieve an elliptical arc, you can scale the current transformation matrix by different amounts in the X and Y directions. For example, to draw an ellipse in the box given by x, y, width, height:

 context->save();
+ context->translate(x, y);
+ context->scale(width / 2.0, height / 2.0);
+ context->arc(0.0, 0.0, 1.0, 0.0, 2 * M_PI);
+ context->restore();
xc
X position of the center of the arc
yc
Y position of the center of the arc
radius
the radius of the arc
angle1
the start angle, in radians
angle2
the end angle, in radians
voidarc_negative (double, double, double, double, double)

Adds a circular arc of the given radius to the current path. The arc is centered at (xc, yc), begins at angle1 and proceeds in the direction of decreasing angles to end at angle2. If angle2 is greater than angle1 it will be progressively decreased by 2*M_PI until it is greater than angle1.

See arc() for more details. This function differs only in the direction of the arc between the two angles.

xc
X position of the center of the arc
yc
Y position of the center of the arc
radius
the radius of the arc
angle1
the start angle, in radians
angle2
the end angle, in radians
voidbegin_new_path ()

Clears the current path. After this call there will be no current point.

voidbegin_new_sub_path ()

Begin a new subpath. Note that the existing path is not affected. After this call there will be no current point.

In many cases, this call is not needed since new subpaths are frequently started with move_to().

A call to begin_new_sub_path() is particularly useful when beginning a new subpath with one of the arc() calls. This makes things easier as it is no longer necessary to manually compute the arc's initial coordinates for a call to move_to().

1.2

voidclip ()

Establishes a new clip region by intersecting the current clip region with the current Path as it would be filled by fill() and according to the current fill rule.

After clip(), the current path will be cleared from the cairo Context.

The current clip region affects all drawing operations by effectively masking out any changes to the surface that are outside the current clip region.

Calling clip() can only make the clip region smaller, never larger. But the current clip is part of the graphics state, so a temporary restriction of the clip region can be achieved by calling clip() within a save()/restore() pair. The only other means of increasing the size of the clip region is reset_clip().

set_fill_rule()

voidclip_preserve ()

Establishes a new clip region by intersecting the current clip region with the current path as it would be filled by fill() and according to the current fill rule.

Unlike clip(), clip_preserve preserves the path within the cairo Context.

clip()

set_fill_rule()

voidclose_path ()

Adds a line segment to the path from the current point to the beginning of the current subpath, (the most recent point passed to move_to()), and closes this subpath. After this call the current point will be at the joined endpoint of the sub-path.

The behavior of close_path() is distinct from simply calling line_to() with the equivalent coordinate in the case of stroking. When a closed subpath is stroked, there are no caps on the ends of the subpath. Instead, there is a line join connecting the final and initial segments of the subpath.

If there is no current point before the call to close_path(), this function will have no effect.

voidcurve_to (double, double, double, double, double, double)

Adds a cubic Bezier spline to the path from the current point to position (x3, y3) in user-space coordinates, using (x1, y1) and (x2, y2) as the control points. After this call the current point will be (x3, y3).

If there is no current point before the call to curve_to() this function will behave as if preceded by a call to move_to(x1, y1).

x1
the X coordinate of the first control point
y1
the Y coordinate of the first control point
x2
the X coordinate of the second control point
y2
the Y coordinate of the second control point
x3
the X coordinate of the end of the curve
y3
the Y coordinate of the end of the curve
voidfill ()

A drawing operator that fills the current path according to the current fill rule, (each sub-path is implicitly closed before being filled). After fill(), the current path will be cleared from the cairo context.

set_fill_rule()

fill_preserve()

voidfill_preserve ()

A drawing operator that fills the current path according to the current fill rule, (each sub-path is implicitly closed before being filled). Unlike fill(), fill_preserve() preserves the path within the cairo Context.

set_fill_rule()

fill().

voidline_to (double, double)

Adds a line to the path from the current point to position (x, y) in user-space coordinates. After this call the current point will be (x, y).

If there is no current point before the call to line_to() this function will behave as move_to(x, y).

x
the X coordinate of the end of the new line
y
the Y coordinate of the end of the new line
voidmove_to (double, double)

If the current subpath is not empty, begin a new subpath. After this call the current point will be (x, y).

x
the X coordinate of the new position
y
the Y coordinate of the new position
voidpaint ()

A drawing operator that paints the current source everywhere within the current clip region.

voidpaint_with_alpha (double)

A drawing operator that paints the current source everywhere within the current clip region using a mask of constant alpha value alpha. The effect is similar to paint(), but the drawing is faded out using the alpha value.

alpha
an alpha value, between 0 (transparent) and 1 (opaque)
voidrectangle (double, double, double, double)

Adds a closed-subpath rectangle of the given size to the current path at position (x, y) in user-space coordinates.

This function is logically equivalent to:

 context->move_to(x, y);
+ context->rel_line_to(width, 0);
+ context->rel_line_to(0, height);
+ context->rel_line_to(-width, 0);
+ context->close_path();
x
the X coordinate of the top left corner of the rectangle
y
the Y coordinate to the top left corner of the rectangle
width
the width of the rectangle
height
the height of the rectangle
voidrel_curve_to (double, double, double, double, double, double)

Relative-coordinate version of curve_to(). All offsets are relative to the current point. Adds a cubic Bezier spline to the path from the current point to a point offset from the current point by (dx3, dy3), using points offset by (dx1, dy1) and (dx2, dy2) as the control points. After this call the current point will be offset by (dx3, dy3).

Given a current point of (x, y), 

 rel_curve_to(dx1, dy1, dx2, dy2, dx3, dy3)

is logically equivalent to 

 curve_to(x + dx1, y + dy1, x + dx2, y + dy2, x + dx3, y + dy3).

It is an error to call this function with no current point. Doing so will cause this to shutdown with a status of CAIRO_STATUS_NO_CURRENT_POINT. Cairomm will then throw an exception.

dx1
the X offset to the first control point
dy1
the Y offset to the first control point
dx2
the X offset to the second control point
dy2
the Y offset to the second control point
dx3
the X offset to the end of the curve
dy3
the Y offset to the end of the curve
voidrel_line_to (double, double)

Relative-coordinate version of line_to(). Adds a line to the path from the current point to a point that is offset from the current point by (dx, dy) in user space. After this call the current point will be offset by (dx, dy).

Given a current point of (x, y), 

 rel_line_to(dx, dy)

is logically equivalent to 

 line_to(x + dx, y + dy).

It is an error to call this function with no current point. Doing so will cause this to shutdown with a status of CAIRO_STATUS_NO_CURRENT_POINT. Cairomm will then throw an exception.

dx
the X offset to the end of the new line
dy
the Y offset to the end of the new line
voidrel_move_to (double, double)

If the current subpath is not empty, begin a new subpath. After this call the current point will offset by (x, y).

Given a current point of (x, y), 

 rel_move_to(dx, dy)

is logically equivalent to 

 move_to(x + dx, y + dy)

It is an error to call this function with no current point. Doing so will cause this to shutdown with a status of CAIRO_STATUS_NO_CURRENT_POINT. Cairomm will then throw an exception.

dx
the X offset
dy
the Y offset
voidreset_clip ()

Reset the current clip region to its original, unrestricted state. That is, set the clip region to an infinitely large shape containing the target surface. Equivalently, if infinity is too hard to grasp, one can imagine the clip region being reset to the exact bounds of the target surface.

Note that code meant to be reusable should not call reset_clip() as it will cause results unexpected by higher-level code which calls clip(). Consider using save() and restore() around clip() as a more robust means of temporarily restricting the clip region.

voidrestore ()

Restores cr to the state saved by a preceding call to save() and removes that state from the stack of saved states.

save()

voidrotate (double)

Modifies the current transformation matrix (CTM) by rotating the user-space axes by angle radians. The rotation of the axes takes places after any existing transformation of user space. The rotation direction for positive angles is from the positive X axis toward the positive Y axis.

angle
angle (in radians) by which the user-space axes will be rotated
voidsave ()

Makes 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()

voidscale (double, double)

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.

sx
scale factor for the X dimension
sy
scale factor for the Y dimension
voidset_dash (DoubleVector&, double)
voidset_font_size (double)

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.

size
the new font size, in user space units)
voidset_line_cap (LineCap)

Sets the current line cap style within the cairo Context. See LineCap for details about how the available line cap styles are drawn.

As with the other stroke parameters, the current line cap style is examined by stroke(), stroke_extents(), and stroke_to_path(), but does not have any effect during path construction.

The default line cap style is Cairo::LINE_CAP_BUTT.

line_cap
a line cap style, as a LineCap
voidset_line_join (LineJoin)

Sets the current line join style within the cairo Context. See LineJoin for details about how the available line join styles are drawn.

As with the other stroke parameters, the current line join style is examined by stroke(), stroke_extents(), and stroke_to_path(), but does not have any effect during path construction.

The default line join style is Cairo::LINE_JOIN_MITER.

line_join
a line joint style, as a LineJoin
voidset_line_width (double)

Sets the current line width within the cairo Context. The line width specifies the diameter of a pen that is circular in user-space, (though device-space pen may be an ellipse in general due to scaling/shear/rotation of the CTM).

Note: When the description above refers to user space and CTM it refers to the user space and CTM in effect at the time of the stroking operation, not the user space and CTM in effect at the time of the call to set_line_width(). The simplest usage makes both of these spaces identical. That is, if there is no change to the CTM between a call to set_line_width() and the stroking operation, then one can just pass user-space values to set_line_width() and ignore this note.

As with the other stroke parameters, the current line cap style is examined by stroke(), stroke_extents(), and stroke_to_path(), but does not have any effect during path construction.

The default line width value is 2.0.

width
a line width, as a user-space value
voidset_operator (Operator)

Sets the compositing operator to be used for all drawing operations. See Operator for details on the semantics of each available compositing operator.

op
a compositing operator, specified as a Operator
voidset_source_rgb (double, double, double)

Sets the source pattern within the Context to an opaque color. This opaque color will then be used for any subsequent drawing operation until a new source pattern is set.

The color components are floating point numbers in the range 0 to 1. If the values passed in are outside that range, they will be clamped.

set_source_rgba()

set_source()

red
red component of color
green
green component of color
blue
blue component of color
voidset_source_rgba (double, double, double, double)

Sets the source pattern within the Context to a translucent color. This color will then be used for any subsequent drawing operation until a new source pattern is set.

The color and alpha components are floating point numbers in the range 0 to 1. If the values passed in are outside that range, they will be clamped.

set_source_rgb()

set_source()

red
red component of color
green
green component of color
blue
blue component of color
alpha
alpha component of color
voidshow_text (std::string)

A drawing operator that generates the shape from a string of UTF-8 characters, rendered according to the current font_face, font_size (font_matrix), and font_options.

This function first computes a set of glyphs for the string of text. The first glyph is placed so that its origin is at the current point. The origin of each subsequent glyph is offset from that of the previous glyph by the advance values of the previous glyph.

After this call the current point is moved to the origin of where the next glyph would be placed in this same progression. That is, the current point will be at the origin of the final glyph offset by its advance values. This allows for easy display of a single logical string with multiple calls to show_text().

Note: The show_text() function call is part of what the cairo designers call the "toy" text API. It is convenient for short demos and simple programs, but it is not expected to be adequate for serious text-using applications. See show_glyphs() for the "real" text display API in cairo.

utf8
a string containing text encoded in UTF-8
voidstroke ()

A drawing operator that strokes the current Path according to the current line width, line join, line cap, and dash settings. After stroke(), the current Path will be cleared from the cairo Context.

set_line_width()

set_line_join()

set_line_cap()

set_dash()

stroke_preserve().

Note: Degenerate segments and sub-paths are treated specially and provide a useful result. These can result in two different situations:

1. Zero-length "on" segments set in set_dash(). If the cap style is Cairo::LINE_CAP_ROUND or Cairo::LINE_CAP_SQUARE then these segments will be drawn as circular dots or squares respectively. In the case of Cairo::LINE_CAP_SQUARE, the orientation of the squares is determined by the direction of the underlying path.

2. A sub-path created by move_to() followed by either a close_path() or one or more calls to line_to() to the same coordinate as the move_to(). If the cap style is Cairo::LINE_CAP_ROUND then these sub-paths will be drawn as circular dots. Note that in the case of Cairo::LINE_CAP_SQUARE a degenerate sub-path will not be drawn at all, (since the correct orientation is indeterminate).

In no case will a cap style of Cairo::LINE_CAP_BUTT cause anything to be drawn in the case of either degenerate segments or sub-paths.

voidstroke_preserve ()

A drawing operator that strokes the current Path according to the current line width, line join, line cap, and dash settings. Unlike stroke(), stroke_preserve() preserves the Path within the cairo Context.

set_line_width()

set_line_join()

set_line_cap()

set_dash()

stroke_preserve().

voidtranslate (double, double)

Modifies the current transformation matrix (CTM) by translating the user-space origin by (tx, ty). This offset is interpreted as a user-space coordinate according to the CTM in place before the new call to translate. In other words, the translation of the user-space origin takes place after any existing transformation.

tx
amount to translate in the X direction
ty
amount to translate in the Y direction
voidunset_dash ()

This function disables a dash pattern that was set with set_dash()

+

∁ Evoral:Beats

+

C‡: Evoral::Beats

+
+

Musical time in beats.

+ + + +
Methods
doubleto_double ()
+

↠ Evoral:Control

+

C‡: boost::shared_ptr< Evoral::Control >, boost::weak_ptr< Evoral::Control >

+
+ + + + +
Methods
boolisnil ()
ControlListlist ()
+

↠ Evoral:ControlList

+

C‡: boost::shared_ptr< Evoral::ControlList >, boost::weak_ptr< Evoral::ControlList >

+
+ + + + +
Methods
voidadd (double, double, bool, bool)
boolisnil ()
+

↠ Evoral:ControlSet

+

C‡: boost::shared_ptr< Evoral::ControlSet >, boost::weak_ptr< Evoral::ControlSet >

+
+ + + +
Methods
boolisnil ()
+

∁ Evoral:Event

+

C‡: Evoral::Event<long>

+
+ + + + + + +
Methods
unsigned char*buffer ()
voidclear ()
voidset_buffer (unsigned int, unsigned char*, bool)
unsigned intsize ()
+

∁ Evoral:MidiEvent

+

C‡: Evoral::MIDIEvent<long>

+

is-a: Evoral:Event

+
+ + + + + + +
Methods
unsigned charchannel ()
unsigned charset_channel ()
unsigned charset_type ()
unsigned chartype ()
+

Inherited from Evoral:Event

+ + + + + + +
Methods
unsigned char*buffer ()
voidclear ()
voidset_buffer (unsigned int, unsigned char*, bool)
unsigned intsize ()
+

∁ Evoral:Parameter

+

C‡: Evoral::Parameter

+
+

ID of a [play|record|automate]able parameter.

A parameter is defined by (type, id, channel). Type is an integer which can be used in any way by the application (e.g. cast to a custom enum, map to/from a URI, etc). ID is type specific (e.g. MIDI controller #).

This class defines a < operator which is a strict weak ordering, so Parameter may be stored in a std::set, used as a std::map key, etc.

+ + + + + + + +
Constructor
ℂEvoral.Parameter (unsigned int, unsigned char, unsigned int)
Methods
unsigned charchannel ()
unsigned intid ()
unsigned inttype ()
+

∁ Evoral:ParameterDescriptor

+

C‡: Evoral::ParameterDescriptor

+
+

Description of the value range of a parameter or control.

+ + + + + + + + +
Constructor
ℂEvoral.ParameterDescriptor ()
Data Members
floatlower
floatnormal
booltoggled
floatupper
+

∁ LuaSignal:Set

+

C‡: std::bitset<47ul>

+
+ + + + + + + + + + + + + +
Constructor
ℂLuaSignal.Set ()
Methods
LuaTableadd (LuaTable {47ul})
boolany ()
unsigned longcount ()
boolnone ()
Setreset ()
Setset (unsigned long, bool)
unsigned longsize ()
LuaTabletable ()
booltest (unsigned long)
+

↠ PBD:Controllable

+

C‡: boost::shared_ptr< PBD::Controllable >, boost::weak_ptr< PBD::Controllable >

+

is-a: PBD:StatefulDestructiblePtr

+
+ + + + +
Methods
doubleget_value ()
boolisnil ()
+

Inherited from PBD:StatefulPtr

+ + + +
Methods
OwnedPropertyListproperties ()
+

∁ PBD:ID

+

C‡: PBD::ID

+
+ + + + + +
Constructor
ℂPBD.ID (std::string)
Methods
std::stringto_s ()
+

∁ PBD:Stateful

+

C‡: PBD::Stateful

+
+

Base class for objects with saveable and undoable state

+ + + +
Methods
OwnedPropertyListproperties ()
+

∅ PBD:StatefulDestructible

+

C‡: PBD::StatefulDestructible

+

is-a: PBD:Stateful

+
+

Base class for objects with saveable and undoable state

+

This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.

+

Inherited from PBD:Stateful

+ + + +
Methods
OwnedPropertyListproperties ()
+

↠ PBD:StatefulDestructiblePtr

+

C‡: boost::shared_ptr< PBD::StatefulDestructible >, boost::weak_ptr< PBD::StatefulDestructible >

+

is-a: PBD:StatefulPtr

+
+ + + +
Methods
boolisnil ()
+

Inherited from PBD:StatefulPtr

+ + + +
Methods
OwnedPropertyListproperties ()
+

↠ PBD:StatefulPtr

+

C‡: boost::shared_ptr< PBD::Stateful >, boost::weak_ptr< PBD::Stateful >

+
+ + + + +
Methods
boolisnil ()
OwnedPropertyListproperties ()
+

∁ Timecode:BBT_TIME

+

C‡: Timecode::BBT_Time

+
+

Bar, Beat, Tick Time (i.e. Tempo-Based Time)

+ + + +
Constructor
ℂTimecode.BBT_TIME (unsigned int, unsigned int, unsigned int)
+

Enum/Constants

+

∈ PBD.Controllable.GroupControlDisposition

+ +

∈ ARDOUR.ChanMapping

+ +

∈ PBD.PropertyDescriptor<long>*

+ +

∈ ARDOUR.PluginType

+ +

∈ ARDOUR.AutoStyle

+ +

∈ ARDOUR.AutoState

+ +

∈ ARDOUR.AutomationType

+ +

∈ ARDOUR.SrcQuality

+ +

∈ ARDOUR.PlaylistDisposition

+ +

∈ ARDOUR.Session.RecordState

+ +

∈ Cairo.LineCap

+ +

∈ Cairo.LineJoin

+ +

∈ Cairo.Operator

+ +

∈ LuaSignal.LuaSignal

+ +

∈ Editing.SnapType

+ +

∈ Editing.SnapMode

+ +

∈ Editing.MouseMode

+ +

∈ Editing.ZoomFocus

+ +

∈ Editing.DisplayControl

+ +

∈ Editing.ImportMode

+ +

∈ Editing.ImportPosition

+ +

∈ Editing.ImportDisposition

+ +

∈ ARDOUR.DSP.BiQuad.Type

+ +

Class Index

+ +
+
Ardour 4.7-469-g3f71e66  -  Sat, 26 Mar 2016 21:11:56 +0100
+ + diff --git a/source/css/luadoc.css b/source/css/luadoc.css new file mode 100644 index 0000000..09eca60 --- /dev/null +++ b/source/css/luadoc.css @@ -0,0 +1,38 @@ +div.luafooter { text-align:center; font-size:80%; color: #888; margin: 2em 0; } +#luaref h2 { margin:2em 0 0 0; padding:0em; border-bottom: 1px solid black; } +#luaref h3.cls { margin:2em 0 0 0; padding: 0 0 0 1em; border: 1px dashed #6666ee; } +#luaref h3.cls abbr { text-decoration:none; cursor:default; } +#luaref h4.cls { margin:1em 0 0 0; } +#luaref h3.class { background-color: #aaee66; } +#luaref h3.enum { background-color: #aaaaaa; } +#luaref h3.pointerclass { background-color: #eeaa66; } +#luaref h3.array { background-color: #66aaee; } +#luaref h3.opaque { background-color: #6666aa; } +#luaref p { text-align: justify; } +#luaref p.cdecl { text-align: right; float:right; font-size:90%; margin:0; padding: 0 0 0 1em; } +#luaref ul.classindex { columns: 2; -webkit-columns: 2; -moz-columns: 2; } +#luaref div.clear { clear:both; } +#luaref p.classinfo { margin: .25em 0; } +#luaref div.code { width:80%; margin:.5em auto; } +#luaref div.code div { width:45%; } +#luaref div.code pre { line-height: 1.2em; margin: .25em 0; } +#luaref div.code samp { color: green; font-weight: bold; background-color: #eee; } +#luaref div.classdox { padding: .1em 1em; } +#luaref div.classdox p { margin: .5em 0 .5em .6em; } +#luaref div.classdox p { margin: .5em 0 .5em .6em; } +#luaref div.classdox { padding: .1em 1em; } +#luaref div.classdox p { margin: .5em 0 .5em .6em; } +#luaref table.classmembers { width: 100%; } +#luaref table.classmembers th { text-align:left; border-bottom:1px solid black; padding-top:1em; } +#luaref table.classmembers td.def { text-align:right; padding-right:.5em; white-space: nowrap; } +#luaref table.classmembers td.decl { text-align:left; padding-left:.5em; white-space: nowrap; } +#luaref table.classmembers td.doc { text-align:left; padding-left:.6em; line-height: 1.2em; font-size:80%; } +#luaref table.classmembers td.doc div.dox {background-color:#eee; padding: .1em 1em; } +#luaref table.classmembers td.doc p { margin: .5em 0; } +#luaref table.classmembers td.doc p.para-brief { font-size:120%; } +#luaref table.classmembers td.doc p.para-returns { font-size:120%; } +#luaref table.classmembers td.doc dl { font-size:120%; line-height: 1.3em; } +#luaref table.classmembers td.doc dt { font-style: italic; } +#luaref table.classmembers td.fill { width: 99%; } +#luaref table.classmembers span.em { font-style: italic; } +#luaref span.functionname abbr { text-decoration:none; cursor:default; }