Ardour  9.8-201-g363d29fd54
ARDOUR::WallClock_TransportMaster Class Reference

#include <transport_master.h>

Inheritance diagram for ARDOUR::WallClock_TransportMaster:
[legend]

Public Member Functions

 WallClock_TransportMaster (std::string const &)
 
 ~WallClock_TransportMaster ()
 
void set_session (Session *)
 
void pre_process (pframes_t nframes, samplepos_t now, std::optional< samplepos_t >)
 
void reset (bool with_pos)
 
bool locked () const
 
bool ok () const
 
samplecnt_t update_interval () const
 
samplecnt_t resolution () const
 
bool requires_seekahead () const
 
void init ()
 
Timecode::TimecodeFormat apparent_timecode_format () const
 
std::string position_string () const
 
void create_port ()
 
void check_backend ()
 
- Public Member Functions inherited from ARDOUR::TimecodeTransportMaster
 TimecodeTransportMaster (std::string const &name, SyncSource type)
 
bool apparent_timecode_format_valid () const
 
bool fr2997 () const
 
void set_fr2997 (bool)
 
- Public Member Functions inherited from ARDOUR::TransportMaster
 TransportMaster (SyncSource t, std::string const &name)
 
virtual ~TransportMaster ()
 
virtual bool speed_and_position (double &speed, samplepos_t &position, samplepos_t &lp, samplepos_t &when, samplepos_t now)
 
virtual bool usable () const
 
virtual bool starting () const
 
virtual samplecnt_t seekahead_distance () const
 
virtual bool sample_clock_synced () const
 
virtual void set_sample_clock_synced (bool)
 
virtual std::string delta_string () const
 
sampleoffset_t current_delta () const
 
virtual bool valid_position (std::string &tc, samplepos_t &pos, samplepos_t &when) const
 
virtual bool can_loop () const
 
virtual Location * loop_location () const
 
bool has_loop () const
 
SyncSource type () const
 
TransportRequestSource request_type () const
 
std::string name () const
 
void set_name (std::string const &)
 
int set_state (XMLNode const &, int)
 
XMLNode & get_state () const
 
std::shared_ptr< Port > port () const
 
bool check_collect ()
 
virtual void set_collect (bool)
 
bool collect () const
 
virtual bool allow_request (TransportRequestSource, TransportRequestType) const
 
std::string allowed_request_string () const
 
TransportRequestType request_mask () const
 
void set_request_mask (TransportRequestType)
 
bool removeable () const
 
void set_removeable (bool yn)
 
std::string display_name (bool sh=true) const
 
virtual void unregister_port ()
 
void connect_port_using_state ()
 
- Public Member Functions inherited from PBD::Stateful
 Stateful ()
 
virtual ~Stateful ()
 
virtual bool apply_change (PropertyBase const &)
 
PropertyChange apply_changes (PropertyList const &)
 
const OwnedPropertyList & properties () const
 
void add_property (PropertyBase &s)
 
void add_extra_xml (XMLNode &)
 
XMLNode * extra_xml (const std::string &str, bool add_if_missing=false)
 
void save_extra_xml (const XMLNode &)
 
const PBD::ID & id () const
 
bool set_id (const XMLNode &)
 
void set_id (const std::string &)
 
void reset_id ()
 
void clear_changes ()
 
virtual void clear_owned_changes ()
 
PropertyList * get_changes_as_properties (PBD::Command *) const
 
virtual void rdiff (std::vector< PBD::Command * > &) const
 
bool changed () const
 
virtual PropertyList * property_factory (const XMLNode &) const
 
virtual void suspend_property_changes ()
 
virtual void resume_property_changes ()
 
bool property_changes_suspended () const
 

Private Attributes

samplepos_t _time
 
bool _set
 

Additional Inherited Members

- Static Public Member Functions inherited from ARDOUR::TransportMaster
static std::shared_ptr< TransportMaster > factory (SyncSource, std::string const &, bool removeable)
 
static std::shared_ptr< TransportMaster > factory (XMLNode const &)
 
static void make_property_quarks ()
 
- Public Attributes inherited from PBD::Stateful
PBD::Signal< void(const PropertyChange &)> PropertyChanged
 
- Static Public Attributes inherited from ARDOUR::TransportMaster
static const std::string state_node_name
 
- Static Public Attributes inherited from PBD::Stateful
static int current_state_version
 
static int loading_state_version
 
- Protected Member Functions inherited from ARDOUR::TimecodeTransportMaster
void register_properties ()
 
- Protected Member Functions inherited from ARDOUR::TransportMaster
virtual void connection_handler (std::weak_ptr< ARDOUR::Port >, std::string name1, std::weak_ptr< ARDOUR::Port >, std::string name2, bool yn)
 
virtual std::string format_delta_time (sampleoffset_t) const
 
- Protected Member Functions inherited from PBD::Stateful
void add_instant_xml (XMLNode &, const std::string &directory_path)
 
XMLNode * instant_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 Attributes inherited from ARDOUR::TimecodeTransportMaster
samplepos_t timecode_offset
 
bool timecode_negative_offset
 
bool timecode_format_valid
 
- Protected Attributes inherited from ARDOUR::TransportMaster
SyncSource _type
 
PBD::Property< std::string > _name
 
Session * _session
 
sampleoffset_t _current_delta
 
bool _pending_collect
 
bool _removeable
 
PBD::Property< TransportRequestType > _request_mask
 
PBD::Property< bool > _sclock_synced
 
PBD::Property< bool > _collect
 
PBD::Property< bool > _connected
 
SafeTime current
 
int transport_direction
 
int dll_initstate
 
double t0
 
double t1
 
double e2
 
double b
 
double c
 
std::shared_ptr< Port > _port
 
XMLNode port_node
 
PBD::ScopedConnection port_connection
 
PBD::ScopedConnection backend_connection
 
- Protected Attributes inherited from PBD::Stateful
XMLNode * _extra_xml
 
XMLNode * _instant_xml
 
PBD::PropertyChange _pending_changed
 
PBD::Mutex _lock
 
std::string _xml_node_name
 name of node to use for this object in XML More...
 
OwnedPropertyList * _properties
 

Detailed Description

Definition at line 671 of file transport_master.h.

Constructor & Destructor Documentation

◆ WallClock_TransportMaster()

ARDOUR::WallClock_TransportMaster::WallClock_TransportMaster ( std::string const &  )

◆ ~WallClock_TransportMaster()

ARDOUR::WallClock_TransportMaster::~WallClock_TransportMaster ( )

Member Function Documentation

◆ apparent_timecode_format()

Timecode::TimecodeFormat ARDOUR::WallClock_TransportMaster::apparent_timecode_format ( ) const
virtual

◆ check_backend()

void ARDOUR::WallClock_TransportMaster::check_backend ( )
virtual

Reimplemented from ARDOUR::TransportMaster.

◆ create_port()

void ARDOUR::WallClock_TransportMaster::create_port ( )
inlinevirtual

Implements ARDOUR::TransportMaster.

Definition at line 693 of file transport_master.h.

◆ init()

void ARDOUR::WallClock_TransportMaster::init ( )
virtual

◆ locked()

bool ARDOUR::WallClock_TransportMaster::locked ( ) const
inlinevirtual

reports to ARDOUR whether the TransportMaster is currently synced to its external time source.

Returns
- when returning false, the transport will stop rolling

Implements ARDOUR::TransportMaster.

Definition at line 682 of file transport_master.h.

◆ ok()

bool ARDOUR::WallClock_TransportMaster::ok ( ) const
inlinevirtual

reports to ARDOUR whether the slave is in a sane state

Returns
- when returning false, the transport will be stopped and the slave disconnected from ARDOUR.

Implements ARDOUR::TransportMaster.

Definition at line 683 of file transport_master.h.

◆ position_string()

std::string ARDOUR::WallClock_TransportMaster::position_string ( ) const
virtual

◆ pre_process()

void ARDOUR::WallClock_TransportMaster::pre_process ( pframes_t  nframes,
samplepos_t  now,
std::optional< samplepos_t >   
)
virtual

◆ requires_seekahead()

bool ARDOUR::WallClock_TransportMaster::requires_seekahead ( ) const
inlinevirtual
Returns
- when returning true, ARDOUR will wait for seekahead_distance() before transport starts rolling

Implements ARDOUR::TransportMaster.

Definition at line 687 of file transport_master.h.

◆ reset()

void ARDOUR::WallClock_TransportMaster::reset ( bool  with_pos)
virtual

◆ resolution()

samplecnt_t ARDOUR::WallClock_TransportMaster::resolution ( ) const
virtual
Returns
- the timing resolution of the TransportMaster - If the distance of ARDOURs transport to the slave becomes greater than the resolution, sound will stop

Implements ARDOUR::TransportMaster.

◆ set_session()

void ARDOUR::WallClock_TransportMaster::set_session ( Session *  )
virtual

Reimplemented from ARDOUR::TransportMaster.

◆ update_interval()

samplecnt_t ARDOUR::WallClock_TransportMaster::update_interval ( ) const
virtual
Returns
- the expected update interval for the data source used by this transport master. Even if the data is effectively continuous, this number indicates how long it is between changes to the known position of the master.

Implements ARDOUR::TransportMaster.

Member Data Documentation

◆ _set

bool ARDOUR::WallClock_TransportMaster::_set
private

Definition at line 698 of file transport_master.h.

◆ _time

samplepos_t ARDOUR::WallClock_TransportMaster::_time
private

Definition at line 697 of file transport_master.h.


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