| Automatable | to_automatable () | |
| PluginInsert | to_insert () | |
| IOProcessor | to_ioprocessor () | |
| MonitorProcessor | to_monitorprocessor () | |
| PeakMeter | to_peakmeter () | |
| SideChain | to_sidechain () | |
| UnknownProcessor | to_unknownprocessor () |
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).
C‡: boost::shared_ptr< ARDOUR::AudioPlaylist >, boost::weak_ptr< ARDOUR::AudioPlaylist >
+is-a: ARDOUR:Playlist
+ +A named object associated with a Session. Objects derived from this class are expected to be destroyed before the session calls drop_references().
| Methods | ||
|---|---|---|
| bool | isnil () | |
| long | read (FloatArray, FloatArray, FloatArray, long, long, unsigned int) | |
| bool | sameinstance (AudioPlaylist) | |
| Methods | ||
|---|---|---|
| void | add_region (Region, long, float, bool, int) | |
| 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) | |
| void | lower_region (Region) | |
| void | lower_region_to_bottom (Region) | |
| unsigned int | n_regions () | |
| void | raise_region (Region) | |
| void | raise_region_to_top (Region) | |
| Region | region_by_id (ID) | |
| RegionListPtr | region_list () | |
| RegionListPtr | regions_at (long) | |
| RegionListPtr | regions_touched (long, long) | |
Returns regions which have some part within this range. | ||
| RegionListPtr | regions_with_end_within (Range) | |
| RegionListPtr | regions_with_start_within (Range) | |
| void | remove_region (Region) | |
| void | split (long) | |
| void | split_region (Region, long, int) | |
| Region | top_region_at (long) | |
| Region | top_unmuted_region_at (long) | |
| void | uncombine (Region) | |
| Cast | ||
| AudioPlaylist | to_audioplaylist () | |
| MidiPlaylist | to_midiplaylist () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Cast | ||
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
C‡: boost::shared_ptr< ARDOUR::AudioPort >, boost::weak_ptr< ARDOUR::AudioPort >
is-a: ARDOUR:Port
@@ -273,6 +333,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (AudioPort) | |
| bool | isnil () | |
| unsigned int | n_channels () | |
| long | readable_length () | |
| bool | sameinstance (AudioSource) |
C‡: boost::shared_ptr< ARDOUR::AudioTrack >, boost::weak_ptr< ARDOUR::AudioTrack >
@@ -344,6 +406,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (AudioTrack) | |
| Processor | nth_plugin (unsigned int) | |
| Processor | nth_processor (unsigned int) | |
| Processor | nth_send (unsigned int) | |
| PeakMeter | peak_meter () | |
************************************************************* Pure interface begins here************************************************************* | ||
| int | remove_processor (Processor, ProcessorStreams, bool) | |
remove plugin/processor
Returns 0 on success | ||
| bool | remove_sidechain (Processor) | |
reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused)
Returns true if successful | ||
| void | set_active (bool, void*) | |
| void | set_comment (std::string, void*) | |
| void | set_meter_point (MeterPoint, bool) | |
| bool | set_strict_io (bool) | |
| bool | soloed () | |
| bool | strict_io () | |
| Methods | ||
|---|---|---|
| AutomationControl | comp_enable_control () | |
| AutomationControl | comp_makeup_control () | |
| AutomationControl | comp_mode_control () | |
| std::string | comp_mode_name (unsigned int) | |
| AutomationControl | comp_redux_control () | |
| AutomationControl | comp_speed_control () | |
| std::string | comp_speed_name (unsigned int) | |
| AutomationControl | comp_threshold_control () | |
| unsigned int | eq_band_cnt () | |
| std::string | eq_band_name (unsigned int) | |
| AutomationControl | eq_enable_control () | |
| AutomationControl | eq_freq_control (unsigned int) | |
| AutomationControl | eq_gain_control (unsigned int) | |
| AutomationControl | eq_hpf_control () | |
| AutomationControl | eq_q_control (unsigned int) | |
| AutomationControl | eq_shape_control (unsigned int) | |
| GainControl | gain_control () | |
| bool | is_auditioner () | |
| bool | is_hidden () | |
| bool | is_master () | |
| bool | is_monitor () | |
| bool | is_selected () | |
| AutomationControl | master_send_enable_control () | |
| MonitorProcessor | monitor_control () | |
| MuteControl | mute_control () | |
| AutomationControl | pan_azimuth_control () | |
| AutomationControl | pan_elevation_control () | |
| AutomationControl | pan_frontback_control () | |
| AutomationControl | pan_lfe_control () | |
| AutomationControl | pan_width_control () | |
| PhaseControl | phase_control () | |
| PresentationInfo | presentation_info_ptr () | |
| AutomationControl | rec_enable_control () | |
| AutomationControl | rec_safe_control () | |
| AutomationControl | send_enable_control (unsigned int) | |
| AutomationControl | send_level_control (unsigned int) | |
| std::string | send_name (unsigned int) | |
| void | set_presentation_order (unsigned int, bool) | |
| SoloControl | solo_control () | |
| SoloIsolateControl | solo_isolate_control () | |
| Methods | ||
| AutomationControl | automation_control (Parameter, bool) | |
| bool | isnil () | |
| bool | sameinstance (Automatable) | |
C‡: boost::shared_ptr< ARDOUR::AutomatableSequence<Evoral::Beats> >, boost::weak_ptr< ARDOUR::AutomatableSequence<Evoral::Beats> >
+is-a: ARDOUR:Automatable
+ +| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (AutomatableSequence) | |
| Cast | ||
| Sequence | to_sequence () | |
| Methods | ||
|---|---|---|
| AutomationControl | automation_control (Parameter, bool) | |
C‡: boost::shared_ptr< ARDOUR::AutomationControl >, boost::weak_ptr< ARDOUR::AutomationControl >
is-a: PBD:Controllable
@@ -464,6 +573,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CGet the current effective `user' value based on automation state
| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (Delivery) | |
| Automatable | to_automatable () | |
| PluginInsert | to_insert () | |
| IOProcessor | to_ioprocessor () | |
| MonitorProcessor | to_monitorprocessor () | |
| PeakMeter | to_peakmeter () | |
| SideChain | to_sidechain () | |
| UnknownProcessor | to_unknownprocessor () |
C‡: ARDOUR::FluidSynth
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.FluidSynth (float, int) | |
instantiate a Synth
| ||
| Methods | ||
| bool | load_sf2 (std::string) | |
| bool | midi_event (unsigned char*, unsigned long) | |
| void | panic () | |
| unsigned int | program_count () | |
| std::string | program_name (unsigned int) | |
| bool | select_program (unsigned int, unsigned char) | |
| bool | synth (FloatArray, FloatArray, unsigned int) | |
C‡: boost::shared_ptr< ARDOUR::GainControl >, boost::weak_ptr< ARDOUR::GainControl >
is-a: ARDOUR:SlavableAutomationControl,
@@ -755,6 +885,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (GainControl) | |
| bool | physically_connected () | |
| Port | port_by_name (unsigned int) | |
| int | remove_port (Port, void*) | |
| bool | sameinstance (IO) |
| ChanCount | natural_input_streams () | |
| ChanCount | natural_output_streams () | |
| IO | output () | |
| bool | sameinstance (IOProcessor) |
| Automatable | to_automatable () | |
| PluginInsert | to_insert () | |
| IOProcessor | to_ioprocessor () | |
| MonitorProcessor | to_monitorprocessor () | |
| PeakMeter | to_peakmeter () | |
| SideChain | to_sidechain () | |
| UnknownProcessor | to_unknownprocessor () |
Set end position.
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.
| Methods | ||
|---|---|---|
| LuaTable | build_filename () | |
| LuaTable(float, ...) | get_plugin_insert_param (PluginInsert, unsigned int, bool&) | |
get a plugin control parameter value
Returns value | ||
| LuaTable(float, ...) | get_processor_param (Processor, unsigned int, bool&) | |
get a plugin control parameter value
Returns value | ||
| LuaTable | hsla_to_rgba () | |
A convenience function for colorspace HSL to RGB conversion. All ranges are 0..1 Example: local r, g, b, a = ARDOUR.LuaAPI.hsla_to_rgba (hue, saturation, luminosity, alpha) Returns 4 parameters: red, green, blue, alpha (in range 0..1) | ||
| Processor | new_luaproc (Session, std::string) | |
create a new Lua Processor (Plugin)
Returns Processor object (may be nil) | ||
| NotePtr | new_noteptr (unsigned char, Beats, Beats, unsigned char, unsigned char) | |
| Processor | new_plugin (Session, std::string, PluginType, std::string) | |
create a new Plugin Instance
Returns Processor or nil | ||
| PluginInfo | new_plugin_info (std::string, PluginType) | |
set a plugin control-input parameter value
Returns true on success, false on error or out-of-bounds value | ||
| void | usleep (unsigned long) | |
C‡: ARDOUR::LuaAPI::Vamp
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.LuaAPI.Vamp (std::string, float) | |
| Methods | ||
| int | analyze (Readable, unsigned int, Lua-Function) | |
high-level abstraction to process a single channel of the given Readable. If the plugin is not yet initialized, initialize() is called. if is not nil, it is called with the immediate Vamp::Plugin::Features on every process call.
Returns 0 on success | ||
| bool | initialize () | |
initialize the plugin for use with analyze(). This is equivalent to plugin():initialise (1, ssiz, bsiz) and prepares a plugin for analyze. (by preferred step and block sizes are used. if the plugin does not specify them or they're larger than 8K, both are set to 1024) Manual initialization is only required to set plugin-parameters which depend on prior initialization of the plugin. vamp:reset () + vamp:initialize () + vamp:plugin():setParameter (0, 1.5, nil) + vamp:analyze (r, 0) | ||
| StringVector | list_plugins () | |
| Plugin | plugin () | |
| FeatureSet | process (FloatArrayVector, RealTime) | |
process given array of audio-samples. This is a lua-binding for vamp:plugin():process ()
Returns features extracted from that data (if the plugin is causal) | ||
| void | reset () | |
call plugin():reset() and clear intialization flag | ||
C‡: ARDOUR::LuaOSC::Address
@@ -1056,6 +1220,129 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: boost::shared_ptr< ARDOUR::MidiModel >, boost::weak_ptr< ARDOUR::MidiModel >
+is-a: ARDOUR:AutomatableSequence
+ +This is a higher level (than MidiBuffer) model of MIDI data, with separate representations for notes (instead of just unassociated note on/off events) and controller data. Controller data is represented as part of the Automatable base (i.e. in a map of AutomationList, keyed by Parameter). Because of this MIDI controllers and automatable controllers/widgets/etc are easily interchangeable.
| Methods | ||
|---|---|---|
| void | apply_command (Session, Command) | |
| bool | isnil () | |
| NoteDiffCommand | new_note_diff_command (std::string) | |
Start a new NoteDiff command. This has no side-effects on the model or Session, the returned command can be held on to for as long as the caller wishes, or discarded without formality, until apply_command is called and ownership is taken. | ||
| bool | sameinstance (MidiModel) | |
| Cast | ||
|---|---|---|
| Sequence | to_sequence () | |
| Methods | ||
|---|---|---|
| AutomationControl | automation_control (Parameter, bool) | |
C‡: ARDOUR::MidiModel::DiffCommand
+is-a: PBD:Command
+ +Base class for Undo/Redo commands and changesets
This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.
+| 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‡: ARDOUR::MidiModel::NoteDiffCommand
+is-a: ARDOUR:MidiModel:DiffCommand
+ +Base class for Undo/Redo commands and changesets
| Methods | ||
|---|---|---|
| void | add (NotePtr) | |
| void | remove (NotePtr) | |
| 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< ARDOUR::MidiPlaylist >, boost::weak_ptr< ARDOUR::MidiPlaylist >
+is-a: ARDOUR:Playlist
+ +A named object associated with a Session. Objects derived from this class are expected to be destroyed before the session calls drop_references().
| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (MidiPlaylist) | |
| void | set_note_mode (NoteMode) | |
| Methods | ||
|---|---|---|
| void | add_region (Region, long, float, bool, int) | |
| 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) | |
| void | lower_region (Region) | |
| void | lower_region_to_bottom (Region) | |
| unsigned int | n_regions () | |
| void | raise_region (Region) | |
| void | raise_region_to_top (Region) | |
| Region | region_by_id (ID) | |
| RegionListPtr | region_list () | |
| RegionListPtr | regions_at (long) | |
| RegionListPtr | regions_touched (long, long) | |
Returns regions which have some part within this range. | ||
| RegionListPtr | regions_with_end_within (Range) | |
| RegionListPtr | regions_with_start_within (Range) | |
| void | remove_region (Region) | |
| void | split (long) | |
| void | split_region (Region, long, int) | |
| Region | top_region_at (long) | |
| Region | top_unmuted_region_at (long) | |
| void | uncombine (Region) | |
| Cast | ||
| AudioPlaylist | to_audioplaylist () | |
| MidiPlaylist | to_midiplaylist () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Cast | ||
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
C‡: boost::shared_ptr< ARDOUR::MidiPort >, boost::weak_ptr< ARDOUR::MidiPort >
is-a: ARDOUR:Port
@@ -1065,6 +1352,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: boost::shared_ptr< ARDOUR::MidiRegion >, boost::weak_ptr< ARDOUR::MidiRegion >
+is-a: ARDOUR:Region
+ +A named object associated with a Session. Objects derived from this class are expected to be destroyed before the session calls drop_references().
| Methods | ||
|---|---|---|
| bool | do_export (std::string) | |
Export the MIDI data of the MidiRegion to a new MIDI file (SMF). | ||
| bool | isnil () | |
| MidiSource | midi_source (unsigned int) | |
| MidiModel | model () | |
| bool | sameinstance (MidiRegion) | |
| Methods | ||
|---|---|---|
| bool | at_natural_position () | |
| bool | automatic () | |
| bool | can_move () | |
| bool | captured () | |
| void | clear_sync_position () | |
| bool | covers (long) | |
| void | cut_end (long, int) | |
| void | cut_front (long, int) | |
| DataType | data_type () | |
| bool | external () | |
| bool | hidden () | |
| bool | import () | |
| bool | is_compound () | |
| unsigned int | layer () | |
| long | length () | |
| bool | locked () | |
| void | lower () | |
| void | lower_to_bottom () | |
| void | move_start (long, int) | |
| void | move_to_natural_position () | |
| bool | muted () | |
| void | nudge_position (long) | |
| bool | opaque () | |
| long | position () | |
How the region parameters play together: POSITION: first frame of the region along the timeline START: first frame of the region within its source(s) LENGTH: number of frames the region represents | ||
| bool | position_locked () | |
| void | raise () | |
| void | raise_to_top () | |
| void | set_hidden (bool) | |
| void | set_initial_position (long) | |
A gui may need to create a region, then place it in an initial position determined by the user. When this takes place within one gui operation, we have to reset _last_position to prevent an implied move. | ||
| void | set_length (long, int) | |
| void | set_locked (bool) | |
| void | set_muted (bool) | |
| void | set_opaque (bool) | |
| void | set_position (long, int) | |
| void | set_position_locked (bool) | |
| void | set_start (long) | |
| void | set_sync_position (long) | |
Set the region's sync point.
| ||
| void | set_video_locked (bool) | |
| float | shift () | |
| long | start () | |
| float | stretch () | |
| bool | sync_marked () | |
| LuaTable(long, ...) | sync_offset (int&) | |
| long | sync_position () | |
Returns Sync position in session time | ||
| void | trim_end (long, int) | |
| void | trim_front (long, int) | |
| void | trim_to (long, long, int) | |
| bool | video_locked () | |
| bool | whole_file () | |
| Cast | ||
| MidiRegion | to_midiregion () | |
| Readable | to_readable () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Cast | ||
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
C‡: boost::shared_ptr< ARDOUR::MidiSource >, boost::weak_ptr< ARDOUR::MidiSource >
+is-a: ARDOUR:Source
+ +Source for MIDI data
| Methods | ||
|---|---|---|
| bool | empty () | |
| bool | isnil () | |
| long | length (long) | |
| MidiModel | model () | |
| bool | sameinstance (MidiSource) | |
C‡: boost::shared_ptr< ARDOUR::MidiTrack >, boost::weak_ptr< ARDOUR::MidiTrack >
is-a: ARDOUR:Track
@@ -1099,6 +1482,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (MidiTrack) | |
| Processor | nth_plugin (unsigned int) | |
| Processor | nth_processor (unsigned int) | |
| Processor | nth_send (unsigned int) | |
| PeakMeter | peak_meter () | |
************************************************************* Pure interface begins here************************************************************* | ||
| int | remove_processor (Processor, ProcessorStreams, bool) | |
remove plugin/processor
Returns 0 on success | ||
| bool | remove_sidechain (Processor) | |
reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused)
Returns true if successful | ||
| void | set_active (bool, void*) | |
| void | set_comment (std::string, void*) | |
| void | set_meter_point (MeterPoint, bool) | |
| bool | set_strict_io (bool) | |
| bool | soloed () | |
| bool | strict_io () | |
| Methods | ||
|---|---|---|
| AutomationControl | comp_enable_control () | |
| AutomationControl | comp_makeup_control () | |
| AutomationControl | comp_mode_control () | |
| std::string | comp_mode_name (unsigned int) | |
| AutomationControl | comp_redux_control () | |
| AutomationControl | comp_speed_control () | |
| std::string | comp_speed_name (unsigned int) | |
| AutomationControl | comp_threshold_control () | |
| unsigned int | eq_band_cnt () | |
| std::string | eq_band_name (unsigned int) | |
| AutomationControl | eq_enable_control () | |
| AutomationControl | eq_freq_control (unsigned int) | |
| AutomationControl | eq_gain_control (unsigned int) | |
| AutomationControl | eq_hpf_control () | |
| AutomationControl | eq_q_control (unsigned int) | |
| AutomationControl | eq_shape_control (unsigned int) | |
| GainControl | gain_control () | |
| bool | is_auditioner () | |
| bool | is_hidden () | |
| bool | is_master () | |
| bool | is_monitor () | |
| bool | is_selected () | |
| AutomationControl | master_send_enable_control () | |
| MonitorProcessor | monitor_control () | |
| MuteControl | mute_control () | |
| AutomationControl | pan_azimuth_control () | |
| AutomationControl | pan_elevation_control () | |
| AutomationControl | pan_frontback_control () | |
| AutomationControl | pan_lfe_control () | |
| AutomationControl | pan_width_control () | |
| PhaseControl | phase_control () | |
| PresentationInfo | presentation_info_ptr () | |
| AutomationControl | rec_enable_control () | |
| AutomationControl | rec_safe_control () | |
| AutomationControl | send_enable_control (unsigned int) | |
| AutomationControl | send_level_control (unsigned int) | |
| std::string | send_name (unsigned int) | |
| void | set_presentation_order (unsigned int, bool) | |
| SoloControl | solo_control () | |
| SoloIsolateControl | solo_isolate_control () | |
| LuaTable | table () | |
| void | unique () | |
C‡: boost::shared_ptr< ARDOUR::MonitorProcessor >, boost::weak_ptr< ARDOUR::MonitorProcessor >
+is-a: ARDOUR:Processor
+ +A mixer strip element - plugin, send, meter, etc
| Methods | ||
|---|---|---|
| Controllable | channel_cut_control (unsigned int) | |
| Controllable | channel_dim_control (unsigned int) | |
| Controllable | channel_polarity_control (unsigned int) | |
| Controllable | channel_solo_control (unsigned int) | |
| bool | cut (unsigned int) | |
| bool | cut_all () | |
| Controllable | cut_control () | |
| bool | dim_all () | |
| Controllable | dim_control () | |
| float | dim_level () | |
| Controllable | dim_level_control () | |
| bool | dimmed (unsigned int) | |
| bool | inverted (unsigned int) | |
| bool | isnil () | |
| bool | monitor_active () | |
| bool | mono () | |
| Controllable | mono_control () | |
| bool | sameinstance (MonitorProcessor) | |
| void | set_cut (unsigned int, bool) | |
| void | set_cut_all (bool) | |
| void | set_dim (unsigned int, bool) | |
| void | set_dim_all (bool) | |
| void | set_mono (bool) | |
| void | set_polarity (unsigned int, bool) | |
| void | set_solo (unsigned int, bool) | |
| Controllable | solo_boost_control () | |
| float | solo_boost_level () | |
| bool | soloed (unsigned int) | |
| Methods | ||
|---|---|---|
| void | activate () | |
| bool | active () | |
| void | deactivate () | |
| std::string | display_name () | |
| Cast | ||
| Amp | to_amp () | |
| Automatable | to_automatable () | |
| PluginInsert | to_insert () | |
| IOProcessor | to_ioprocessor () | |
| MonitorProcessor | to_monitorprocessor () | |
| PeakMeter | to_peakmeter () | |
| SideChain | to_sidechain () | |
| UnknownProcessor | to_unknownprocessor () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Cast | ||
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
C‡: boost::shared_ptr< ARDOUR::MuteControl >, boost::weak_ptr< ARDOUR::MuteControl >
is-a: ARDOUR:SlavableAutomationControl,
@@ -1207,6 +1681,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| ℂ | Evoral.ParameterDescriptor () | |
| Data Members | ||
|---|---|---|
| float | lower | |
Minimum value (in Hz, for frequencies) | ||
| float | normal | |
Default value | ||
| bool | toggled | |
True iff parameter is boolean | ||
| float | upper | |
Maximum value (in Hz, for frequencies) | ||
C‡: boost::shared_ptr< ARDOUR::PeakMeter >, boost::weak_ptr< ARDOUR::PeakMeter >
+is-a: ARDOUR:Processor
+ +Meters peaks on the input and stores them for access.
| Methods | ||
|---|---|---|
| bool | isnil () | |
| float | meter_level (unsigned int, MeterType) | |
| void | reset_max () | |
| bool | sameinstance (PeakMeter) | |
| void | set_type (MeterType) | |
| Methods | ||
|---|---|---|
| void | activate () | |
| bool | active () | |
| void | deactivate () | |
| std::string | display_name () | |
| Cast | ||
| Amp | to_amp () | |
| Automatable | to_automatable () | |
| PluginInsert | to_insert () | |
| IOProcessor | to_ioprocessor () | |
| MonitorProcessor | to_monitorprocessor () | |
| PeakMeter | to_peakmeter () | |
| SideChain | to_sidechain () | |
| UnknownProcessor | to_unknownprocessor () | |
| Methods | ||
|---|---|---|
| std::string | name () | |
| Cast | ||
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
C‡: boost::shared_ptr< ARDOUR::PhaseControl >, boost::weak_ptr< ARDOUR::PhaseControl >
@@ -1289,6 +1806,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| Methods | ||
|---|---|---|
| std::string | get_docs () | |
| PluginInfo | get_info () | |
| LuaTable(int, ...) | get_parameter_descriptor (unsigned int, ParameterDescriptor&) | |
| std::string | get_parameter_docs (unsigned int) | |
| bool | isnil () | |
| bool | parameter_is_input (unsigned int) | |
| PresetRecord | preset_by_label (std::string) | |
| PresetRecord | preset_by_uri (std::string) | |
| bool | sameinstance (Plugin) | |
| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (PluginControl) | |
| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.PluginInfo () | |
| Methods | ||
| PresetVector | get_presets (bool) | |
| bool | is_instrument () | |
| bool | isnil () | |
| bool | sameinstance (PluginInfo) | |
| Data Members | ||
| std::string | category | |
| std::string | creator | |
| ARDOUR:ChanCount | n_inputs | |
| ARDOUR:ChanCount | n_outputs | |
| std::string | name | |
| std::string | path | |
| ARDOUR.PluginType | type | |
| std::string | unique_id | |
C‡: boost::shared_ptr< ARDOUR::PluginInsert >, boost::weak_ptr< ARDOUR::PluginInsert >
@@ -1462,6 +1999,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CReturns Port human readable name
Returns true if this Port receives input, otherwise false
Returns true if this Port sends output, otherwise false
nth port of type t, or nth port if t = NIL
C‡: ARDOUR::PresentationInfo
@@ -1604,6 +2146,21 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: std::vector<ARDOUR::Plugin::PresetRecord >
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.PresetVector () | |
| Methods | ||
| LuaTable | add (LuaTable {PresetRecord}) | |
| PresetRecord | at (unsigned long) | |
| bool | empty () | |
| LuaIter | iter () | |
| void | push_back (PresetRecord) | |
| unsigned long | size () | |
| LuaTable | table () | |
C‡: boost::shared_ptr< ARDOUR::Processor >, boost::weak_ptr< ARDOUR::Processor >
is-a: ARDOUR:SessionObject
@@ -1616,11 +2173,14 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: std::vector<boost::shared_ptr<ARDOUR::Processor> >
+ +| Constructor | ||
|---|---|---|
| ℂ | ARDOUR.ProcessorVector () | |
| Methods | ||
| LuaTable | add (LuaTable {Processor}) | |
| Processor | at (unsigned long) | |
| bool | empty () | |
| LuaIter | iter () | |
| void | push_back (Processor) | |
| unsigned long | size () | |
| LuaTable | table () | |
C‡: PBD::PropertyDescriptor<bool>
@@ -1659,6 +2234,17 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CA 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.
+C‡: boost::shared_ptr< ARDOUR::Readable >, boost::weak_ptr< ARDOUR::Readable >
+ +| Methods | ||
|---|---|---|
| bool | isnil () | |
| unsigned int | n_channels () | |
| long | read (FloatArray, long, long, int) | |
| long | readable_length () | |
| bool | sameinstance (Readable) | |
C‡: boost::shared_ptr< ARDOUR::Region >, boost::weak_ptr< ARDOUR::Region >
is-a: ARDOUR:SessionObject
@@ -1695,6 +2281,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CA 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.
| Processor | nth_plugin (unsigned int) | |
| Processor | nth_processor (unsigned int) | |
| Processor | nth_send (unsigned int) | |
| PeakMeter | peak_meter () | |
************************************************************* Pure interface begins here************************************************************* | ||
| int | remove_processor (Processor, ProcessorStreams, bool) | |
remove plugin/processor
Returns 0 on success | ||
| bool | remove_sidechain (Processor) | |
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 | ||
| bool | sameinstance (Route) | |
| void | set_active (bool, void*) | |
| void | set_comment (std::string, void*) | |
| void | set_meter_point (MeterPoint, bool) | |
| bool | set_name (std::string) | |
| bool | set_strict_io (bool) | |
| bool | soloed () | |
| Methods | ||
|---|---|---|
| AutomationControl | comp_enable_control () | |
| AutomationControl | comp_makeup_control () | |
| AutomationControl | comp_mode_control () | |
| std::string | comp_mode_name (unsigned int) | |
| AutomationControl | comp_redux_control () | |
| AutomationControl | comp_speed_control () | |
| std::string | comp_speed_name (unsigned int) | |
| AutomationControl | comp_threshold_control () | |
| unsigned int | eq_band_cnt () | |
| std::string | eq_band_name (unsigned int) | |
| AutomationControl | eq_enable_control () | |
| AutomationControl | eq_freq_control (unsigned int) | |
| AutomationControl | eq_gain_control (unsigned int) | |
| AutomationControl | eq_hpf_control () | |
| AutomationControl | eq_q_control (unsigned int) | |
| AutomationControl | eq_shape_control (unsigned int) | |
| GainControl | gain_control () | |
| bool | is_auditioner () | |
| bool | is_hidden () | |
| bool | is_master () | |
| bool | is_monitor () | |
| bool | is_selected () | |
| AutomationControl | master_send_enable_control () | |
| MonitorProcessor | monitor_control () | |
| MuteControl | mute_control () | |
| AutomationControl | pan_azimuth_control () | |
| AutomationControl | pan_elevation_control () | |
| AutomationControl | pan_frontback_control () | |
| AutomationControl | pan_lfe_control () | |
| AutomationControl | pan_width_control () | |
| PhaseControl | phase_control () | |
| PresentationInfo | presentation_info_ptr () | |
| AutomationControl | rec_enable_control () | |
| AutomationControl | rec_safe_control () | |
| AutomationControl | send_enable_control (unsigned int) | |
| AutomationControl | send_level_control (unsigned int) | |
| std::string | send_name (unsigned int) | |
| void | set_presentation_order (unsigned int, bool) | |
| SoloControl | solo_control () | |
| SoloIsolateControl | solo_isolate_control () | |
| Controllable | controllable_by_id (ID) | |
| long | current_end_frame () | |
| long | current_start_frame () | |
| void | disable_record (bool, bool) | |
| 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 () | |
| bool | get_play_loop () | |
| Route | get_remote_nth_route (unsigned int) | |
| Stripable | get_remote_nth_stripable (unsigned int, Flag) | |
| RouteListPtr | get_routes () | |
| BufferSet | get_silent_buffers (ChanCount) | |
| RouteListPtr | get_tracks () | |
| void | goto_end () | |
| void | goto_start () | |
| void | goto_start (bool) | |
| long | last_transport_start () | |
| Locations | locations () | |
| Route | master_out () | |
| void | maybe_enable_record () | |
| Route | monitor_out () | |
| std::string | name () | |
| RouteList | new_audio_route (int, int, RouteGroup, unsigned int, std::string, Flag, unsigned int) | |
| AudioTrackList | new_audio_track (int, int, RouteGroup, unsigned int, std::string, unsigned int, TrackMode) | |
| RouteList | new_midi_route (RouteGroup, unsigned int, std::string, PluginInfo, PresetRecord, Flag, unsigned int) | |
| MidiTrackList | new_midi_track (ChanCount, ChanCount, PluginInfo, PresetRecord, RouteGroup, unsigned int, std::string, unsigned int, TrackMode) | |
| 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 | ||
| RouteList | new_route_from_template (unsigned int, unsigned int, std::string, std::string, PlaylistDisposition) | |
| long | nominal_frame_rate () | |
"native" sample rate of session, regardless of current audioengine rate, pullup/down etc | ||
| std::string | path () | |
| Processor | processor_by_id (ID) | |
| RecordState | record_status () | |
| void | request_locate (long, bool) | |
| void | request_play_loop (bool, bool) | |
| void | request_stop (bool, bool) | |
| void | request_transport_speed (double, bool) | |
| Route | route_by_id (ID) | |
| Methods | ||
| bool | isnil () | |
| std::string | name () | |
| bool | sameinstance (SessionObject) | |
| Cast | ||
| Stateful | to_stateful () | |
| StatefulDestructible | to_statefuldestructible () | |
| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (SideChain) | |
| Automatable | to_automatable () | |
| PluginInsert | to_insert () | |
| IOProcessor | to_ioprocessor () | |
| MonitorProcessor | to_monitorprocessor () | |
| PeakMeter | to_peakmeter () | |
| SideChain | to_sidechain () | |
| UnknownProcessor | to_unknownprocessor () |
| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (SoloIsolateControl) | |
| bool | self_solo_isolated () | |
| bool | solo_isolated () | |
| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (SoloSafeControl) | |
| bool | solo_safe () | |
| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (Source) | |
C‡: boost::shared_ptr< ARDOUR::Stripable >, boost::weak_ptr< ARDOUR::Stripable >
@@ -2387,6 +3019,22 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CA named object associated with a Session. Objects derived from this class are expected to be destroyed before the session calls drop_references().
| Methods | ||
|---|---|---|
| AutomationControl | comp_enable_control () | |
| AutomationControl | comp_makeup_control () | |
| AutomationControl | comp_mode_control () | |
| std::string | comp_mode_name (unsigned int) | |
| AutomationControl | comp_redux_control () | |
| AutomationControl | comp_speed_control () | |
| std::string | comp_speed_name (unsigned int) | |
| AutomationControl | comp_threshold_control () | |
| unsigned int | eq_band_cnt () | |
| std::string | eq_band_name (unsigned int) | |
| AutomationControl | eq_enable_control () | |
| AutomationControl | eq_freq_control (unsigned int) | |
| AutomationControl | eq_gain_control (unsigned int) | |
| AutomationControl | eq_hpf_control () | |
| AutomationControl | eq_q_control (unsigned int) | |
| AutomationControl | eq_shape_control (unsigned int) | |
| GainControl | gain_control () | |
| bool | is_auditioner () | |
| bool | is_hidden () | |
| bool | is_monitor () | |
| bool | is_selected () | |
| bool | isnil () | |
| AutomationControl | master_send_enable_control () | |
| MonitorProcessor | monitor_control () | |
| MuteControl | mute_control () | |
| AutomationControl | pan_azimuth_control () | |
| AutomationControl | pan_elevation_control () | |
| AutomationControl | pan_frontback_control () | |
| AutomationControl | pan_lfe_control () | |
| AutomationControl | pan_width_control () | |
| PhaseControl | phase_control () | |
| PresentationInfo | presentation_info_ptr () | |
| AutomationControl | rec_enable_control () | |
| AutomationControl | rec_safe_control () | |
| bool | sameinstance (Stripable) | |
| AutomationControl | send_enable_control (unsigned int) | |
| AutomationControl | send_level_control (unsigned int) | |
| std::string | send_name (unsigned int) | |
| void | set_presentation_order (unsigned int, bool) | |
| SoloControl | solo_control () | |
| SoloIsolateControl | solo_isolate_control () | |
| Methods | ||
| MeterSection | add_meter (Meter, double, BBT_TIME, long, PositionLockStyle) | |
| TempoSection | add_tempo (Tempo, double, long, Type, PositionLockStyle) | |
| BBT_TIME | bbt_at_frame (long) | |
| double | exact_beat_at_frame (long, int) | |
| double | exact_qn_at_frame (long, int) | |
| MeterSection | meter_section_at_beat (double) | |
| MeterSection | meter_section_at_frame (long) | |
| TempoSection | tempo_section_at_frame (long) | |
| bool | can_record () | |
| bool | isnil () | |
| Playlist | playlist () | |
| bool | sameinstance (Track) | |
| bool | set_name (std::string) | |
| Cast | ||
| AudioTrack | to_audio_track () | |
| Processor | nth_plugin (unsigned int) | |
| Processor | nth_processor (unsigned int) | |
| Processor | nth_send (unsigned int) | |
| PeakMeter | peak_meter () | |
************************************************************* Pure interface begins here************************************************************* | ||
| int | remove_processor (Processor, ProcessorStreams, bool) | |
remove plugin/processor
Returns 0 on success | ||
| bool | remove_sidechain (Processor) | |
reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused)
Returns true if successful | ||
| void | set_active (bool, void*) | |
| void | set_comment (std::string, void*) | |
| void | set_meter_point (MeterPoint, bool) | |
| bool | set_strict_io (bool) | |
| bool | soloed () | |
| bool | strict_io () | |
| Methods | ||
|---|---|---|
| AutomationControl | comp_enable_control () | |
| AutomationControl | comp_makeup_control () | |
| AutomationControl | comp_mode_control () | |
| std::string | comp_mode_name (unsigned int) | |
| AutomationControl | comp_redux_control () | |
| AutomationControl | comp_speed_control () | |
| std::string | comp_speed_name (unsigned int) | |
| AutomationControl | comp_threshold_control () | |
| unsigned int | eq_band_cnt () | |
| std::string | eq_band_name (unsigned int) | |
| AutomationControl | eq_enable_control () | |
| AutomationControl | eq_freq_control (unsigned int) | |
| AutomationControl | eq_gain_control (unsigned int) | |
| AutomationControl | eq_hpf_control () | |
| AutomationControl | eq_q_control (unsigned int) | |
| AutomationControl | eq_shape_control (unsigned int) | |
| GainControl | gain_control () | |
| bool | is_auditioner () | |
| bool | is_hidden () | |
| bool | is_master () | |
| bool | is_monitor () | |
| bool | is_selected () | |
| AutomationControl | master_send_enable_control () | |
| MonitorProcessor | monitor_control () | |
| MuteControl | mute_control () | |
| AutomationControl | pan_azimuth_control () | |
| AutomationControl | pan_elevation_control () | |
| AutomationControl | pan_frontback_control () | |
| AutomationControl | pan_lfe_control () | |
| AutomationControl | pan_width_control () | |
| PhaseControl | phase_control () | |
| PresentationInfo | presentation_info_ptr () | |
| AutomationControl | rec_enable_control () | |
| AutomationControl | rec_safe_control () | |
| AutomationControl | send_enable_control (unsigned int) | |
| AutomationControl | send_level_control (unsigned int) | |
| std::string | send_name (unsigned int) | |
| void | set_presentation_order (unsigned int, bool) | |
| SoloControl | solo_control () | |
| SoloIsolateControl | solo_isolate_control () | |
| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (UnknownProcessor) | |
| Automatable | to_automatable () | |
| PluginInsert | to_insert () | |
| IOProcessor | to_ioprocessor () | |
| MonitorProcessor | to_monitorprocessor () | |
| PeakMeter | to_peakmeter () | |
| SideChain | to_sidechain () | |
| UnknownProcessor | to_unknownprocessor () |
| Methods | ||
|---|---|---|
| std::string | http_get (std::string) | |
| ProcessorVector | processor_selection () | |
C‡: ArdourMarker
@@ -2636,7 +3332,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CImport existing media
Returns true if the playhead is currently being dragged, otherwise false
C‡: std::vector<float* >
+ +| Constructor | ||
|---|---|---|
| ℂ | C.FloatArrayVector () | |
| Methods | ||
| LuaTable | add (LuaTable {FloatArray}) | |
| FloatArray | at (unsigned long) | |
| bool | empty () | |
| LuaIter | iter () | |
| void | push_back (FloatArray) | |
| unsigned long | size () | |
| LuaTable | table () | |
C‡: std::vector<float >
+ +| Constructor | ||
|---|---|---|
| ℂ | C.FloatVector () | |
| Methods | ||
| LuaTable | add (LuaTable {float}) | |
| float | at (unsigned long) | |
| bool | empty () | |
| LuaIter | iter () | |
| void | push_back (float) | |
| unsigned long | size () | |
| LuaTable | table () | |
C‡: int*
@@ -2969,6 +3696,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CModifies 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 dash pattern to be used by stroke(). A dash pattern is specified by dashes, an array of positive values. Each value provides the user-space length of altenate "on" and "off" portions of the stroke. The offset specifies an offset into the pattern at which the stroke begins.
Each "on" segment will have caps applied as if the segment were a separate sub-path. In particular, it is valid to use an "on" length of 0.0 with Cairo::LINE_CAP_ROUND or Cairo::LINE_CAP_SQUARE in order to distributed dots or squares along a path.
Note: The length values are in user-space units as evaluated at the time of stroking. This is not necessarily the same as the user space at the time of set_dash().
If dashes is empty dashing is disabled. If the size of dashes is 1, a symmetric pattern is assumed with alternating on and off portions of the size specified by the single value in dashes.
It is invalid for any value in dashes to be negative, or for all values to be 0. If this is the case, an exception will be thrown
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.
Musical time in beats.
| Constructor | ||
|---|---|---|
| ℂ | Evoral.Beats (double) | |
Create from a real number of beats. | ||
| Methods | ||
| double | to_double () | |
C‡: boost::shared_ptr< Evoral::ControlList >, boost::weak_ptr< Evoral::ControlList >
@@ -3078,6 +3810,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to Crealtime safe version of eval, may fail if read-lock cannot be taken
Returns parameter value
set the interpolation style of the automation data
| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (ControlSet) | |
C‡: Evoral::Event<long>
@@ -3125,6 +3859,20 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: boost::shared_ptr< Evoral::Note<Evoral::Beats> >, boost::weak_ptr< Evoral::Note<Evoral::Beats> >
+ +| Methods | ||
|---|---|---|
| unsigned char | channel () | |
| bool | isnil () | |
| Beats | length () | |
| unsigned char | note () | |
| unsigned char | off_velocity () | |
| bool | sameinstance (NotePtr) | |
| Beats | time () | |
| unsigned char | velocity () | |
C‡: Evoral::Parameter
@@ -3146,9 +3894,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CMinimum value (in Hz, for frequencies)
Default value
True iff parameter is boolean
Maximum value (in Hz, for frequencies)
C‡: Evoral::Range<long>
@@ -3160,6 +3912,15 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: boost::shared_ptr< Evoral::Sequence<Evoral::Beats> >, boost::weak_ptr< Evoral::Sequence<Evoral::Beats> >
+is-a: Evoral:ControlSet
+ +| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (Sequence) | |
C‡: std::bitset<47ul>
@@ -3167,7 +3928,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (StatefulDestructible) | |
| ID | id () | |
| bool | isnil () | |
| OwnedPropertyList | properties () | |
| bool | sameinstance (Stateful) |
C‡: XMLNode
@@ -3400,6 +4164,256 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| Constructor | ||
|---|---|---|
| ℂ | Timecode.BBT_TIME (unsigned int, unsigned int, unsigned int) | |
| Data Members | ||
| unsigned int | bars | |
| unsigned int | beats | |
| unsigned int | ticks | |
C‡: Vamp::Plugin
+is-a: Vamp:PluginBase
+ +Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio or related data.
In most cases, the input will be audio and the output will be a stream of derived data at a lower sampling resolution than the input.
Note that this class inherits several abstract methods from PluginBase. These must be implemented by the subclass.
PLUGIN LIFECYCLE
Feature extraction plugins are managed differently from real-time plugins (such as VST effects). The main difference is that the parameters for a feature extraction plugin are configured before the plugin is used, and do not change during use.
1. Host constructs the plugin, passing it the input sample rate. The plugin may do basic initialisation, but should not do anything computationally expensive at this point. You must make sure your plugin is cheap to construct, otherwise you'll seriously affect the startup performance of almost all hosts. If you have serious initialisation to do, the proper place is in initialise() (step 5).
2. Host may query the plugin's available outputs.
3. Host queries programs and parameter descriptors, and may set some or all of them. Parameters that are not explicitly set should take their default values as specified in the parameter descriptor. When a program is set, the parameter values may change and the host will re-query them to check.
4. Host queries the preferred step size, block size and number of channels. These may all vary depending on the parameter values. (Note however that you cannot make the number of distinct outputs dependent on parameter values.)
5. Plugin is properly initialised with a call to initialise. This fixes the step size, block size, and number of channels, as well as all of the parameter and program settings. If the values passed in to initialise do not match the plugin's advertised preferred values from step 4, the plugin may refuse to initialise and return false (although if possible it should accept the new values). Any computationally expensive setup code should take place here.
6. Host finally checks the number of values, resolution, extents etc per output (which may vary depending on the number of channels, step size and block size as well as the parameter values).
7. Host will repeatedly call the process method to pass in blocks of input data. This method may return features extracted from that data (if the plugin is causal).
8. Host will call getRemainingFeatures exactly once, after all the input data has been processed. This may return any non-causal or leftover features.
9. At any point after initialise was called, the host may optionally call the reset method and restart processing. (This does not mean it can change the parameters, which are fixed from initialise until destruction.)
A plugin does not need to handle the case where setParameter or selectProgram is called after initialise has been called. It's the host's responsibility not to do that. Similarly, the plugin may safely assume that initialise is called no more than once.
| Methods | ||
|---|---|---|
| InputDomain | getInputDomain () | |
Get the plugin's required input domain. If this is TimeDomain, the samples provided to the process() function (below) will be in the time domain, as for a traditional audio processing plugin. If this is FrequencyDomain, the host will carry out a windowed FFT of size equal to the negotiated block size on the data before passing the frequency bin data in to process(). The input data for the FFT will be rotated so as to place the origin in the centre of the block. The plugin does not get to choose the window type -- the host will either let the user do so, or will use a Hanning window. | ||
| unsigned long | getMaxChannelCount () | |
Get the maximum supported number of input channels. | ||
| unsigned long | getMinChannelCount () | |
Get the minimum supported number of input channels. | ||
| OutputList | getOutputDescriptors () | |
Get the outputs of this plugin. An output's index in this list is used as its numeric index when looking it up in the FeatureSet returned from the process() call. | ||
| unsigned long | getPreferredBlockSize () | |
Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function). This should be called before initialise(). A plugin that can handle any block size may return 0. The final block size will be set in the initialise() call. | ||
| unsigned long | getPreferredStepSize () | |
Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the process() function) for the plugin. This should be called before initialise(). A plugin may return 0 if it has no particular interest in the step size. In this case, the host should make the step size equal to the block size if the plugin is accepting input in the time domain. If the plugin is accepting input in the frequency domain, the host may use any step size. The final step size will be set in the initialise() call. | ||
| FeatureSet | getRemainingFeatures () | |
After all blocks have been processed, calculate and return any remaining features derived from the complete input. | ||
| std::string | getType () | |
Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase. Do not reimplement this function in your subclass. | ||
| bool | initialise (unsigned long, unsigned long, unsigned long) | |
Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames). The input sample rate should have been already specified at construction time. Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. | ||
| void | reset () | |
Reset the plugin after use, to prepare it for another clean run. Not called for the first initialisation (i.e. initialise must also do a reset). | ||
| Methods | ||
|---|---|---|
| std::string | getCopyright () | |
Get the copyright statement or licensing summary for the plugin. This can be an informative text, without the same presentation constraints as mentioned for getMaker above. | ||
| std::string | getCurrentProgram () | |
Get the current program. | ||
| std::string | getDescription () | |
Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name". May be empty if the name has said it all already. Example: "Detect and count zero crossing points" | ||
| std::string | getIdentifier () | |
Get the computer-usable name of the plugin. This should be reasonably short and contain no whitespace or punctuation characters. It may only contain the characters [a-zA-Z0-9_-]. This is the authoritative way for a program to identify a plugin within a given library. This text may be visible to the user, but it should not be the main text used to identify a plugin to the user (that will be the name, below). Example: "zero_crossings" | ||
| std::string | getMaker () | |
Get the name of the author or vendor of the plugin in human-readable form. This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar. | ||
| std::string | getName () | |
Get a human-readable name or title of the plugin. This should be brief and self-contained, as it may be used to identify the plugin to the user in isolation (i.e. without also showing the plugin's "identifier"). Example: "Zero Crossings" | ||
| float | getParameter (std::string) | |
Get the value of a named parameter. The argument is the identifier field from that parameter's descriptor. | ||
| ParameterList | getParameterDescriptors () | |
Get the controllable parameters of this plugin. | ||
| int | getPluginVersion () | |
Get the version number of the plugin. | ||
| StringVector | getPrograms () | |
Get the program settings available in this plugin. A program is a named shorthand for a set of parameter values; changing the program may cause the plugin to alter the values of its published parameters (and/or non-public internal processing parameters). The host should re-read the plugin's parameter values after setting a new program. The programs must have unique names. | ||
| void | selectProgram (std::string) | |
Select a program. (If the given program name is not one of the available programs, do nothing.) | ||
| void | setParameter (std::string, float) | |
Set a named parameter. The first argument is the identifier field from that parameter's descriptor. | ||
C‡: Vamp::Plugin::Feature
+ +| Data Members | ||
|---|---|---|
| Vamp:RealTime | duration | |
Duration of the output feature. This is mandatory if the output has VariableSampleRate or FixedSampleRate and hasDuration is true, and unused otherwise. | ||
| bool | hasDuration | |
True if an output feature has a specified duration. This is optional if the output has VariableSampleRate or FixedSampleRate, and and unused if the output has OneSamplePerStep. | ||
| bool | hasTimestamp | |
True if an output feature has its own timestamp. This is mandatory if the output has VariableSampleRate, optional if the output has FixedSampleRate, and unused if the output has OneSamplePerStep. | ||
| std::string | label | |
Label for the sample of this feature. | ||
| Vamp:RealTime | timestamp | |
Timestamp of the output feature. This is mandatory if the output has VariableSampleRate or if the output has FixedSampleRate and hasTimestamp is true, and unused otherwise. | ||
| C:FloatVector | values | |
Results for a single sample of this feature. If the output hasFixedBinCount, there must be the same number of values as the output's binCount count. | ||
C‡: std::vector<Vamp::Plugin::Feature >
+ +| Constructor | ||
|---|---|---|
| ℂ | Vamp.Plugin.FeatureList () | |
| Methods | ||
| LuaTable | add (LuaTable {Feature}) | |
| Feature | at (unsigned long) | |
| bool | empty () | |
| LuaIter | iter () | |
| void | push_back (Feature) | |
| unsigned long | size () | |
| LuaTable | table () | |
C‡: std::map<int, std::vector<Vamp::Plugin::Feature > > > >
+ +| Constructor | ||
|---|---|---|
| ℂ | Vamp.Plugin.FeatureSet () | |
| Methods | ||
| LuaTable | add (LuaTable {Feature}) | |
| ... | at (--lua--) | |
| void | clear () | |
| unsigned long | count (int) | |
| bool | empty () | |
| LuaIter | iter () | |
| unsigned long | size () | |
| LuaTable | table () | |
C‡: Vamp::Plugin::OutputDescriptor
+ +| Data Members | ||
|---|---|---|
| unsigned long | binCount | |
The number of values per result of the output. Undefined if hasFixedBinCount is false. If this is zero, the output is point data (i.e. only the time of each output is of interest, the value list will be empty). | ||
| C:StringVector | binNames | |
The (human-readable) names of each of the bins, if appropriate. This is always optional. | ||
| std::string | description | |
A human-readable short text describing the output. May be empty if the name has said it all already. Example: "The number of zero crossing points per processing block" | ||
| bool | hasDuration | |
True if the returned results for this output are known to have a duration field. | ||
| bool | hasFixedBinCount | |
True if the output has the same number of values per sample for every output sample. Outputs for which this is false are unlikely to be very useful in a general-purpose host. | ||
| bool | hasKnownExtents | |
True if the results in each output bin fall within a fixed numeric range (minimum and maximum values). Undefined if binCount is zero. | ||
| std::string | identifier | |
The name of the output, in computer-usable form. Should be reasonably short and without whitespace or punctuation, using the characters [a-zA-Z0-9_-] only. Example: "zero_crossing_count" | ||
| bool | isQuantized | |
True if the output values are quantized to a particular resolution. Undefined if binCount is zero. | ||
| float | maxValue | |
Maximum value of the results in the output. Undefined if hasKnownExtents is false or binCount is zero. | ||
| float | minValue | |
Minimum value of the results in the output. Undefined if hasKnownExtents is false or binCount is zero. | ||
| float | quantizeStep | |
Quantization resolution of the output values (e.g. 1.0 if they are all integers). Undefined if isQuantized is false or binCount is zero. | ||
| float | sampleRate | |
Sample rate of the output results, as samples per second. Undefined if sampleType is OneSamplePerStep. If sampleType is VariableSampleRate and this value is non-zero, then it may be used to calculate a resolution for the output (i.e. the "duration" of each sample, in time, will be 1/sampleRate seconds). It's recommended to set this to zero if that behaviour is not desired. | ||
| Vamp.Plugin.OutputDescriptor.SampleType | sampleType | |
Positioning in time of the output results. | ||
| std::string | unit | |
The unit of the output, in human-readable form. | ||
C‡: std::vector<Vamp::Plugin::OutputDescriptor >
+ +| Constructor | ||
|---|---|---|
| ℂ | Vamp.Plugin.OutputList () | |
| Methods | ||
| LuaTable | add (LuaTable {OutputDescriptor}) | |
| OutputDescriptor | at (unsigned long) | |
| bool | empty () | |
| LuaIter | iter () | |
| void | push_back (OutputDescriptor) | |
| unsigned long | size () | |
| LuaTable | table () | |
C‡: Vamp::PluginBase
+ +A base class for plugins with optional configurable parameters, programs, etc. The Vamp::Plugin is derived from this, and individual Vamp plugins should derive from that.
This class does not provide the necessary interfaces to instantiate or run a plugin. It only specifies an interface for retrieving those controls that the host may wish to show to the user for editing. It could meaningfully be subclassed by real-time plugins or other sorts of plugin as well as Vamp plugins.
| Methods | ||
|---|---|---|
| std::string | getCopyright () | |
Get the copyright statement or licensing summary for the plugin. This can be an informative text, without the same presentation constraints as mentioned for getMaker above. | ||
| std::string | getCurrentProgram () | |
Get the current program. | ||
| std::string | getDescription () | |
Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name". May be empty if the name has said it all already. Example: "Detect and count zero crossing points" | ||
| std::string | getIdentifier () | |
Get the computer-usable name of the plugin. This should be reasonably short and contain no whitespace or punctuation characters. It may only contain the characters [a-zA-Z0-9_-]. This is the authoritative way for a program to identify a plugin within a given library. This text may be visible to the user, but it should not be the main text used to identify a plugin to the user (that will be the name, below). Example: "zero_crossings" | ||
| std::string | getMaker () | |
Get the name of the author or vendor of the plugin in human-readable form. This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar. | ||
| std::string | getName () | |
Get a human-readable name or title of the plugin. This should be brief and self-contained, as it may be used to identify the plugin to the user in isolation (i.e. without also showing the plugin's "identifier"). Example: "Zero Crossings" | ||
| float | getParameter (std::string) | |
Get the value of a named parameter. The argument is the identifier field from that parameter's descriptor. | ||
| ParameterList | getParameterDescriptors () | |
Get the controllable parameters of this plugin. | ||
| int | getPluginVersion () | |
Get the version number of the plugin. | ||
| StringVector | getPrograms () | |
Get the program settings available in this plugin. A program is a named shorthand for a set of parameter values; changing the program may cause the plugin to alter the values of its published parameters (and/or non-public internal processing parameters). The host should re-read the plugin's parameter values after setting a new program. The programs must have unique names. | ||
| std::string | getType () | |
Get the type of plugin. This is to be implemented by the immediate subclass, not by actual plugins. Do not attempt to implement this in plugin code. | ||
| void | selectProgram (std::string) | |
Select a program. (If the given program name is not one of the available programs, do nothing.) | ||
| void | setParameter (std::string, float) | |
Set a named parameter. The first argument is the identifier field from that parameter's descriptor. | ||
C‡: Vamp::PluginBase::ParameterDescriptor
+ +| Data Members | ||
|---|---|---|
| float | defaultValue | |
The default value of the parameter. The plugin should ensure that parameters have this value on initialisation (i.e. the host is not required to explicitly set parameters if it wants to use their default values). | ||
| std::string | description | |
A human-readable short text describing the parameter. May be empty if the name has said it all already. | ||
| std::string | identifier | |
The name of the parameter, in computer-usable form. Should be reasonably short, and may only contain the characters [a-zA-Z0-9_-]. | ||
| bool | isQuantized | |
True if the parameter values are quantized to a particular resolution. | ||
| float | maxValue | |
The maximum value of the parameter. | ||
| float | minValue | |
The minimum value of the parameter. | ||
| std::string | name | |
The human-readable name of the parameter. | ||
| float | quantizeStep | |
Quantization resolution of the parameter values (e.g. 1.0 if they are all integers). Undefined if isQuantized is false. | ||
| std::string | unit | |
The unit of the parameter, in human-readable form. | ||
| C:StringVector | valueNames | |
Names for the quantized values. If isQuantized is true, this may either be empty or contain one string for each of the quantize steps from minValue up to maxValue inclusive. Undefined if isQuantized is false. If these names are provided, they should be shown to the user in preference to the values themselves. The user may never see the actual numeric values unless they are also encoded in the names. | ||
C‡: std::vector<Vamp::PluginBase::ParameterDescriptor >
+ +| Constructor | ||
|---|---|---|
| ℂ | Vamp.PluginBase.ParameterList () | |
| Methods | ||
| LuaTable | add (LuaTable {ParameterDescriptor}) | |
| ParameterDescriptor | at (unsigned long) | |
| bool | empty () | |
| LuaIter | iter () | |
| void | push_back (ParameterDescriptor) | |
| unsigned long | size () | |
| LuaTable | table () | |
C‡: Vamp::RealTime
+ +RealTime represents time values to nanosecond precision with accurate arithmetic and frame-rate conversion functions.
| Constructor | ||
|---|---|---|
| ℂ | Vamp.RealTime (int, int) | |
| Methods | ||
| RealTime | frame2RealTime (long, unsigned int) | |
| int | msec () | |
| long | realTime2Frame (RealTime, unsigned int) | |
| std::string | toString () | |
Return a human-readable debug-type string to full precision (probably not a format to show to a user directly) | ||
| int | usec () | |
| Data Members | ||
| int | nsec | |
| int | sec | |