Ardour  9.0-pre0-582-g084a23a80d
ARDOUR::ControlProtocol Class Referenceabstract

#include <control_protocol.h>

Inheritance diagram for ARDOUR::ControlProtocol:
[legend]

Public Member Functions

 ControlProtocol (Session &, std::string name)
 
virtual ~ControlProtocol ()
 
virtual std::string name () const
 
virtual int set_active (bool yn)
 
virtual bool active () const
 
virtual int set_feedback (bool)
 
virtual bool get_feedback () const
 
virtual void midi_connectivity_established (bool)
 
virtual void stripable_selection_changed ()=0
 
void add_stripable_to_selection (std::shared_ptr< ARDOUR::Stripable >)
 
void set_stripable_selection (std::shared_ptr< ARDOUR::Stripable >)
 
void toggle_stripable_selection (std::shared_ptr< ARDOUR::Stripable >)
 
void remove_stripable_from_selection (std::shared_ptr< ARDOUR::Stripable >)
 
void clear_stripable_selection ()
 
virtual void add_rid_to_selection (int rid)
 
virtual void set_rid_selection (int rid)
 
virtual void toggle_rid_selection (int rid)
 
virtual void remove_rid_from_selection (int rid)
 
std::shared_ptr< ARDOUR::Stripablefirst_selected_stripable () const
 
void set_route_table_size (uint32_t size)
 
void set_route_table (uint32_t table_index, std::shared_ptr< ARDOUR::Route >)
 
bool set_route_table (uint32_t table_index, uint32_t remote_control_id)
 
void route_set_rec_enable (uint32_t table_index, bool yn)
 
bool route_get_rec_enable (uint32_t table_index)
 
float route_get_gain (uint32_t table_index)
 
void route_set_gain (uint32_t table_index, float)
 
float route_get_effective_gain (uint32_t table_index)
 
float route_get_peak_input_power (uint32_t table_index, uint32_t which_input)
 
bool route_get_muted (uint32_t table_index)
 
void route_set_muted (uint32_t table_index, bool)
 
bool route_get_soloed (uint32_t table_index)
 
void route_set_soloed (uint32_t table_index, bool)
 
std::string route_get_name (uint32_t table_index)
 
virtual std::list< std::shared_ptr< ARDOUR::Bundle > > bundles ()
 
virtual bool has_editor () const
 
virtual void * get_gui () const
 
virtual void tear_down_gui ()
 
XMLNodeget_state () const
 
int set_state (XMLNode const &, int version)
 
- Public Member Functions inherited from PBD::Stateful
 Stateful ()
 
virtual ~Stateful ()
 
virtual bool apply_change (PropertyBase const &)
 
PropertyChange apply_changes (PropertyList const &)
 
const OwnedPropertyListproperties () const
 
void add_property (PropertyBase &s)
 
void add_extra_xml (XMLNode &)
 
XMLNodeextra_xml (const std::string &str, bool add_if_missing=false)
 
void save_extra_xml (const XMLNode &)
 
const PBD::IDid () const
 
bool set_id (const XMLNode &)
 
void set_id (const std::string &)
 
void reset_id ()
 
void clear_changes ()
 
virtual void clear_owned_changes ()
 
PropertyListget_changes_as_properties (PBD::Command *) const
 
virtual void rdiff (std::vector< PBD::Command * > &) const
 
bool changed () const
 
virtual PropertyListproperty_factory (const XMLNode &) const
 
virtual void suspend_property_changes ()
 
virtual void resume_property_changes ()
 
bool property_changes_suspended () const
 
- Public Member Functions inherited from PBD::ScopedConnectionList
 ScopedConnectionList ()
 
 ScopedConnectionList (const ScopedConnectionList &)=delete
 
ScopedConnectionListoperator= (const ScopedConnectionList &)=delete
 
virtual ~ScopedConnectionList ()
 
void add_connection (const UnscopedConnection &c)
 
void drop_connections ()
 
- Public Member Functions inherited from BasicUI
 BasicUI (ARDOUR::Session &)
 
virtual ~BasicUI ()
 
void add_marker (const std::string &=std::string())
 
void remove_marker_at_playhead ()
 
void register_thread (std::string name)
 
void loop_toggle ()
 
void loop_location (Temporal::timepos_t const &start, Temporal::timepos_t const &end)
 
void access_action (std::string action_path)
 
void goto_zero ()
 
void goto_start (bool and_roll=false)
 
void goto_end ()
 
void button_varispeed (bool fwd)
 
void rewind ()
 
void ffwd ()
 
void transport_stop ()
 
void transport_play (bool jump_back=false)
 
void set_transport_speed (double speed)
 
double get_transport_speed () const
 
double transport_rolling () const
 
void jump_by_seconds (double sec, ARDOUR::LocateTransportDisposition ltd=ARDOUR::RollIfAppropriate)
 
void jump_by_bars (int bars, ARDOUR::LocateTransportDisposition ltd=ARDOUR::RollIfAppropriate)
 
void jump_by_beats (int beats, ARDOUR::LocateTransportDisposition ltd=ARDOUR::RollIfAppropriate)
 
ARDOUR::samplepos_t transport_sample ()
 
void locate (ARDOUR::samplepos_t sample, ARDOUR::LocateTransportDisposition ltd)
 
void locate (ARDOUR::samplepos_t sample, bool)
 
bool locating ()
 
bool locked ()
 
void save_state ()
 
void prev_marker ()
 
void next_marker ()
 
void undo ()
 
void redo ()
 
void toggle_punch_in ()
 
void toggle_punch_out ()
 
void mark_in ()
 
void mark_out ()
 
void toggle_click ()
 
void midi_panic ()
 
void trigger_cue_row (int cue)
 
void trigger_stop_all (bool stop_now=false)
 
void trigger_stop_col (int col, bool immediately=false)
 
void store_mixer_scene (int scn)
 
void apply_mixer_scene (int scn)
 
void toggle_monitor_mute ()
 
void toggle_monitor_dim ()
 
void toggle_monitor_mono ()
 
void cancel_all_solo ()
 
void quick_snapshot_stay ()
 
void quick_snapshot_switch ()
 
void toggle_roll (bool with_abort, bool roll_out_of_bounded_mode)
 
void stop_forget ()
 
void set_punch_range ()
 
void set_loop_range ()
 
void set_session_range ()
 
void set_record_enable (bool yn)
 
bool get_record_enabled ()
 
void fit_1_track ()
 
void fit_2_tracks ()
 
void fit_4_tracks ()
 
void fit_8_tracks ()
 
void fit_16_tracks ()
 
void fit_32_tracks ()
 
void fit_all_tracks ()
 
void zoom_10_ms ()
 
void zoom_100_ms ()
 
void zoom_1_sec ()
 
void zoom_10_sec ()
 
void zoom_1_min ()
 
void zoom_5_min ()
 
void zoom_10_min ()
 
void zoom_to_session ()
 
void temporal_zoom_in ()
 
void temporal_zoom_out ()
 
void scroll_up_1_track ()
 
void scroll_dn_1_track ()
 
void scroll_up_1_page ()
 
void scroll_dn_1_page ()
 
void rec_enable_toggle ()
 
void toggle_all_rec_enables ()
 
void all_tracks_rec_in ()
 
void all_tracks_rec_out ()
 
void goto_nth_marker (int n)
 
ARDOUR::samplecnt_t timecode_frames_per_hour ()
 
void timecode_time (samplepos_t where, Timecode::Time &)
 
void timecode_to_sample (Timecode::Time &timecode, samplepos_t &sample, bool use_offset, bool use_subframes) const
 
void sample_to_timecode (samplepos_t sample, Timecode::Time &timecode, bool use_offset, bool use_subframes) const
 
bool stop_button_onoff () const
 
bool play_button_onoff () const
 
bool ffwd_button_onoff () const
 
bool rewind_button_onoff () const
 
bool loop_button_onoff () const
 
void tbank_set_size (int route_width, int row_height)
 
void tbank_step_routes (int step_size)
 
void tbank_step_rows (int step_size)
 
float trigger_progress_at (int x)
 
TriggerDisplay trigger_display_at (int x, int y)
 
void bang_trigger_at (int x, int y)
 
void unbang_trigger_at (int x, int y)
 
std::shared_ptr< ARDOUR::Triggerfind_trigger (int x, int y)
 

Static Public Member Functions

static StripableNotificationList const & last_selected ()
 
static void notify_stripable_selection_changed (StripableNotificationListPtr)
 

Public Attributes

PBD::Signal< void()> ActiveChanged
 
- Public Attributes inherited from PBD::Stateful
PBD::Signal< void(const PropertyChange &)> PropertyChanged
 

Static Public Attributes

static PBD::Signal< void()> ZoomToSession
 
static PBD::Signal< void()> ZoomIn
 
static PBD::Signal< void()> ZoomOut
 
static PBD::Signal< void()> Enter
 
static PBD::Signal< void()> Undo
 
static PBD::Signal< void()> Redo
 
static PBD::Signal< void(float)> ScrollTimeline
 
static PBD::Signal< void(uint32_t)> GotoView
 
static PBD::Signal< void()> CloseDialog
 
static PBD::Signal< void()> VerticalZoomInAll
 
static PBD::Signal< void()> VerticalZoomOutAll
 
static PBD::Signal< void()> VerticalZoomInSelected
 
static PBD::Signal< void()> VerticalZoomOutSelected
 
static PBD::Signal< void()> StepTracksDown
 
static PBD::Signal< void()> StepTracksUp
 
static PBD::Signal< void(std::weak_ptr< ARDOUR::PluginInsert >)> PluginSelected
 
static const std::string state_node_name
 
- Static Public Attributes inherited from PBD::Stateful
static int current_state_version
 
static int loading_state_version
 
- Static Public Attributes inherited from BasicUI
static PBD::Signal< void(std::string, std::string)> AccessAction
 

Protected Member Functions

void next_track (uint32_t initial_id)
 
void prev_track (uint32_t initial_id)
 
virtual void event_loop_precall ()
 
void install_precall_handler (Glib::RefPtr< Glib::MainContext >)
 
- Protected Member Functions inherited from PBD::Stateful
void add_instant_xml (XMLNode &, const std::string &directory_path)
 
XMLNodeinstant_xml (const std::string &str, const std::string &directory_path)
 
void add_properties (XMLNode &) const
 
PropertyChange set_values (XMLNode const &)
 
virtual void post_set (const PropertyChange &)
 
virtual void send_change (const PropertyChange &)
 
virtual void mid_thaw (const PropertyChange &)
 
bool regenerate_xml_or_string_ids () const
 
- Protected Member Functions inherited from BasicUI
 BasicUI ()
 

Protected Attributes

std::vector< std::shared_ptr< ARDOUR::Route > > route_table
 
std::string _name
 
GlibEventLoopCallback glib_event_callback
 
- Protected Attributes inherited from PBD::Stateful
XMLNode_extra_xml
 
XMLNode_instant_xml
 
PBD::PropertyChange _pending_changed
 
Glib::Threads::Mutex _lock
 
std::string _xml_node_name
 name of node to use for this object in XML More...
 
OwnedPropertyList_properties
 
- Protected Attributes inherited from BasicUI
ARDOUR::Sessionsession
 
int _tbank_route_width
 
int _tbank_row_height
 
int _tbank_start_route
 
int _tbank_start_row
 

Private Member Functions

LIBCONTROLCP_LOCAL ControlProtocol (const ControlProtocol &)
 

Private Attributes

bool _active
 

Static Private Attributes

static StripableNotificationList _last_selected
 
static PBD::ScopedConnection selection_connection
 
static bool selection_connected
 

Detailed Description

Definition at line 46 of file control_protocol.h.

Constructor & Destructor Documentation

◆ ControlProtocol() [1/2]

ARDOUR::ControlProtocol::ControlProtocol ( Session ,
std::string  name 
)

◆ ~ControlProtocol()

virtual ARDOUR::ControlProtocol::~ControlProtocol ( )
virtual

◆ ControlProtocol() [2/2]

LIBCONTROLCP_LOCAL ARDOUR::ControlProtocol::ControlProtocol ( const ControlProtocol )
private

Member Function Documentation

◆ active()

virtual bool ARDOUR::ControlProtocol::active ( ) const
inlinevirtual

Definition at line 55 of file control_protocol.h.

◆ add_rid_to_selection()

virtual void ARDOUR::ControlProtocol::add_rid_to_selection ( int  rid)
virtual

Reimplemented in GenericMidiControlProtocol.

◆ add_stripable_to_selection()

void ARDOUR::ControlProtocol::add_stripable_to_selection ( std::shared_ptr< ARDOUR::Stripable )

◆ bundles()

◆ clear_stripable_selection()

void ARDOUR::ControlProtocol::clear_stripable_selection ( )

◆ event_loop_precall()

virtual void ARDOUR::ControlProtocol::event_loop_precall ( )
protectedvirtual

◆ first_selected_stripable()

std::shared_ptr<ARDOUR::Stripable> ARDOUR::ControlProtocol::first_selected_stripable ( ) const

◆ get_feedback()

virtual bool ARDOUR::ControlProtocol::get_feedback ( ) const
inlinevirtual

Reimplemented in GenericMidiControlProtocol.

Definition at line 58 of file control_protocol.h.

◆ get_gui()

◆ get_state()

◆ has_editor()

◆ install_precall_handler()

void ARDOUR::ControlProtocol::install_precall_handler ( Glib::RefPtr< Glib::MainContext >  )
protected

◆ last_selected()

static StripableNotificationList const& ARDOUR::ControlProtocol::last_selected ( )
inlinestatic

Definition at line 148 of file control_protocol.h.

◆ midi_connectivity_established()

virtual void ARDOUR::ControlProtocol::midi_connectivity_established ( bool  )
inlinevirtual

Reimplemented in MIDISurface.

Definition at line 60 of file control_protocol.h.

◆ name()

virtual std::string ARDOUR::ControlProtocol::name ( ) const
inlinevirtual

Definition at line 52 of file control_protocol.h.

◆ next_track()

void ARDOUR::ControlProtocol::next_track ( uint32_t  initial_id)
protected

◆ notify_stripable_selection_changed()

static void ARDOUR::ControlProtocol::notify_stripable_selection_changed ( StripableNotificationListPtr  )
static

◆ prev_track()

void ARDOUR::ControlProtocol::prev_track ( uint32_t  initial_id)
protected

◆ remove_rid_from_selection()

virtual void ARDOUR::ControlProtocol::remove_rid_from_selection ( int  rid)
virtual

Reimplemented in GenericMidiControlProtocol.

◆ remove_stripable_from_selection()

void ARDOUR::ControlProtocol::remove_stripable_from_selection ( std::shared_ptr< ARDOUR::Stripable )

◆ route_get_effective_gain()

float ARDOUR::ControlProtocol::route_get_effective_gain ( uint32_t  table_index)

◆ route_get_gain()

float ARDOUR::ControlProtocol::route_get_gain ( uint32_t  table_index)

◆ route_get_muted()

bool ARDOUR::ControlProtocol::route_get_muted ( uint32_t  table_index)

◆ route_get_name()

std::string ARDOUR::ControlProtocol::route_get_name ( uint32_t  table_index)

◆ route_get_peak_input_power()

float ARDOUR::ControlProtocol::route_get_peak_input_power ( uint32_t  table_index,
uint32_t  which_input 
)

◆ route_get_rec_enable()

bool ARDOUR::ControlProtocol::route_get_rec_enable ( uint32_t  table_index)

◆ route_get_soloed()

bool ARDOUR::ControlProtocol::route_get_soloed ( uint32_t  table_index)

◆ route_set_gain()

void ARDOUR::ControlProtocol::route_set_gain ( uint32_t  table_index,
float   
)

◆ route_set_muted()

void ARDOUR::ControlProtocol::route_set_muted ( uint32_t  table_index,
bool   
)

◆ route_set_rec_enable()

void ARDOUR::ControlProtocol::route_set_rec_enable ( uint32_t  table_index,
bool  yn 
)

◆ route_set_soloed()

void ARDOUR::ControlProtocol::route_set_soloed ( uint32_t  table_index,
bool   
)

◆ set_active()

◆ set_feedback()

virtual int ARDOUR::ControlProtocol::set_feedback ( bool  )
inlinevirtual

Reimplemented in GenericMidiControlProtocol.

Definition at line 57 of file control_protocol.h.

◆ set_rid_selection()

virtual void ARDOUR::ControlProtocol::set_rid_selection ( int  rid)
virtual

Reimplemented in GenericMidiControlProtocol.

◆ set_route_table() [1/2]

void ARDOUR::ControlProtocol::set_route_table ( uint32_t  table_index,
std::shared_ptr< ARDOUR::Route  
)

◆ set_route_table() [2/2]

bool ARDOUR::ControlProtocol::set_route_table ( uint32_t  table_index,
uint32_t  remote_control_id 
)

◆ set_route_table_size()

void ARDOUR::ControlProtocol::set_route_table_size ( uint32_t  size)

◆ set_state()

◆ set_stripable_selection()

void ARDOUR::ControlProtocol::set_stripable_selection ( std::shared_ptr< ARDOUR::Stripable )

◆ stripable_selection_changed()

◆ tear_down_gui()

◆ toggle_rid_selection()

virtual void ARDOUR::ControlProtocol::toggle_rid_selection ( int  rid)
virtual

Reimplemented in GenericMidiControlProtocol.

◆ toggle_stripable_selection()

void ARDOUR::ControlProtocol::toggle_stripable_selection ( std::shared_ptr< ARDOUR::Stripable )

Member Data Documentation

◆ _active

bool ARDOUR::ControlProtocol::_active
private

Definition at line 164 of file control_protocol.h.

◆ _last_selected

StripableNotificationList ARDOUR::ControlProtocol::_last_selected
staticprivate

Definition at line 166 of file control_protocol.h.

◆ _name

std::string ARDOUR::ControlProtocol::_name
protected

Definition at line 156 of file control_protocol.h.

◆ ActiveChanged

PBD::Signal<void()> ARDOUR::ControlProtocol::ActiveChanged

Definition at line 64 of file control_protocol.h.

◆ CloseDialog

PBD::Signal<void()> ARDOUR::ControlProtocol::CloseDialog
static

Definition at line 78 of file control_protocol.h.

◆ Enter

PBD::Signal<void()> ARDOUR::ControlProtocol::Enter
static

Definition at line 73 of file control_protocol.h.

◆ glib_event_callback

GlibEventLoopCallback ARDOUR::ControlProtocol::glib_event_callback
protected

Definition at line 157 of file control_protocol.h.

◆ GotoView

PBD::Signal<void(uint32_t)> ARDOUR::ControlProtocol::GotoView
static

Definition at line 77 of file control_protocol.h.

◆ PluginSelected

PBD::Signal<void(std::weak_ptr<ARDOUR::PluginInsert> )> ARDOUR::ControlProtocol::PluginSelected
static

Definition at line 85 of file control_protocol.h.

◆ Redo

PBD::Signal<void()> ARDOUR::ControlProtocol::Redo
static

Definition at line 75 of file control_protocol.h.

◆ route_table

std::vector<std::shared_ptr<ARDOUR::Route> > ARDOUR::ControlProtocol::route_table
protected

Definition at line 155 of file control_protocol.h.

◆ ScrollTimeline

PBD::Signal<void(float)> ARDOUR::ControlProtocol::ScrollTimeline
static

Definition at line 76 of file control_protocol.h.

◆ selection_connected

bool ARDOUR::ControlProtocol::selection_connected
staticprivate

Definition at line 168 of file control_protocol.h.

◆ selection_connection

PBD::ScopedConnection ARDOUR::ControlProtocol::selection_connection
staticprivate

Definition at line 167 of file control_protocol.h.

◆ state_node_name

const std::string ARDOUR::ControlProtocol::state_node_name
static

Definition at line 146 of file control_protocol.h.

◆ StepTracksDown

PBD::Signal<void()> ARDOUR::ControlProtocol::StepTracksDown
static

Definition at line 83 of file control_protocol.h.

◆ StepTracksUp

PBD::Signal<void()> ARDOUR::ControlProtocol::StepTracksUp
static

Definition at line 84 of file control_protocol.h.

◆ Undo

PBD::Signal<void()> ARDOUR::ControlProtocol::Undo
static

Definition at line 74 of file control_protocol.h.

◆ VerticalZoomInAll

PBD::Signal<void()> ARDOUR::ControlProtocol::VerticalZoomInAll
static

Definition at line 79 of file control_protocol.h.

◆ VerticalZoomInSelected

PBD::Signal<void()> ARDOUR::ControlProtocol::VerticalZoomInSelected
static

Definition at line 81 of file control_protocol.h.

◆ VerticalZoomOutAll

PBD::Signal<void()> ARDOUR::ControlProtocol::VerticalZoomOutAll
static

Definition at line 80 of file control_protocol.h.

◆ VerticalZoomOutSelected

PBD::Signal<void()> ARDOUR::ControlProtocol::VerticalZoomOutSelected
static

Definition at line 82 of file control_protocol.h.

◆ ZoomIn

PBD::Signal<void()> ARDOUR::ControlProtocol::ZoomIn
static

Definition at line 71 of file control_protocol.h.

◆ ZoomOut

PBD::Signal<void()> ARDOUR::ControlProtocol::ZoomOut
static

Definition at line 72 of file control_protocol.h.

◆ ZoomToSession

PBD::Signal<void()> ARDOUR::ControlProtocol::ZoomToSession
static

Definition at line 70 of file control_protocol.h.


The documentation for this class was generated from the following file: