Ardour  9.0-pre0-582-g084a23a80d
ARDOUR::MIDIClock_TransportMaster Class Reference

#include <transport_master.h>

Inheritance diagram for ARDOUR::MIDIClock_TransportMaster:
[legend]

Public Member Functions

 MIDIClock_TransportMaster (std::string const &name, int ppqn=24)
 
 ~MIDIClock_TransportMaster ()
 Constructor for unit tests. More...
 
void set_session (Session *)
 
void unregister_port ()
 
void pre_process (pframes_t nframes, samplepos_t now, std::optional< samplepos_t >)
 
void rebind (MidiPort &)
 
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 ()
 
std::string position_string () const
 
std::string delta_string () const
 
float bpm () const
 
void create_port ()
 
- 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)
 
sampleoffset_t current_delta () const
 
virtual bool can_loop () const
 
virtual Locationloop_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)
 
XMLNodeget_state () const
 
std::shared_ptr< Portport () const
 
bool check_collect ()
 
virtual void set_collect (bool)
 
bool collect () const
 
virtual void check_backend ()
 
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
 
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 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 ARDOUR::TransportMasterViaMIDI
virtual ~TransportMasterViaMIDI ()
 
MIDI::Parsertransport_parser ()
 
std::shared_ptr< MidiPortmidi_port () const
 
std::shared_ptr< Portcreate_midi_port (std::string const &port_name)
 

Protected Member Functions

void start (MIDI::Parser &parser, samplepos_t timestamp)
 
void contineu (MIDI::Parser &parser, samplepos_t timestamp)
 
void stop (MIDI::Parser &parser, samplepos_t timestamp)
 
void position (MIDI::Parser &parser, MIDI::byte *message, size_t size, samplepos_t timestamp)
 
void calculate_one_ppqn_in_samples_at (samplepos_t time)
 
samplepos_t calculate_song_position (uint16_t song_position_in_sixteenth_notes)
 
void calculate_filter_coefficients (double qpm)
 
void update_midi_clock (MIDI::Parser &parser, samplepos_t timestamp)
 
void connection_handler (std::weak_ptr< ARDOUR::Port >, std::string, std::weak_ptr< ARDOUR::Port >, std::string, bool)
 
- Protected Member Functions inherited from ARDOUR::TransportMaster
virtual void register_properties ()
 
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)
 
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 ARDOUR::TransportMasterViaMIDI
 TransportMasterViaMIDI ()
 
void resync_latency (bool)
 
virtual void parameter_changed (std::string const &p)
 

Protected Attributes

PBD::ScopedConnectionList port_connections
 
int ppqn
 pulses per quarter note for one MIDI clock sample (default 24) More...
 
double one_ppqn_in_samples
 the duration of one ppqn in sample time More...
 
samplepos_t first_timestamp
 the timestamp of the first MIDI clock message More...
 
samplepos_t last_timestamp
 the time stamp and should-be transport position of the last inbound MIDI clock message More...
 
double should_be_position
 
long midi_clock_count
 
double _speed
 a DLL to track MIDI clock More...
 
bool _running
 
double _bpm
 
- 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
 
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 ARDOUR::TransportMasterViaMIDI
MIDI::Parser parser
 
std::shared_ptr< MidiPort_midi_port
 
LatencyRange midi_port_latency
 

Additional Inherited Members

- Static Public Member Functions inherited from ARDOUR::TransportMaster
static std::shared_ptr< TransportMasterfactory (SyncSource, std::string const &, bool removeable)
 
static std::shared_ptr< TransportMasterfactory (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
 

Detailed Description

Definition at line 657 of file transport_master.h.

Constructor & Destructor Documentation

◆ MIDIClock_TransportMaster()

ARDOUR::MIDIClock_TransportMaster::MIDIClock_TransportMaster ( std::string const &  name,
int  ppqn = 24 
)

◆ ~MIDIClock_TransportMaster()

ARDOUR::MIDIClock_TransportMaster::~MIDIClock_TransportMaster ( )

Constructor for unit tests.

Member Function Documentation

◆ bpm()

float ARDOUR::MIDIClock_TransportMaster::bpm ( ) const
inline

Definition at line 688 of file transport_master.h.

◆ calculate_filter_coefficients()

void ARDOUR::MIDIClock_TransportMaster::calculate_filter_coefficients ( double  qpm)
protected

◆ calculate_one_ppqn_in_samples_at()

void ARDOUR::MIDIClock_TransportMaster::calculate_one_ppqn_in_samples_at ( samplepos_t  time)
protected

◆ calculate_song_position()

samplepos_t ARDOUR::MIDIClock_TransportMaster::calculate_song_position ( uint16_t  song_position_in_sixteenth_notes)
protected

◆ connection_handler()

void ARDOUR::MIDIClock_TransportMaster::connection_handler ( std::weak_ptr< ARDOUR::Port ,
std::string  ,
std::weak_ptr< ARDOUR::Port ,
std::string  ,
bool   
)
protectedvirtual

Reimplemented from ARDOUR::TransportMaster.

◆ contineu()

void ARDOUR::MIDIClock_TransportMaster::contineu ( MIDI::Parser parser,
samplepos_t  timestamp 
)
protected

◆ create_port()

void ARDOUR::MIDIClock_TransportMaster::create_port ( )
virtual

◆ delta_string()

std::string ARDOUR::MIDIClock_TransportMaster::delta_string ( ) const
virtual
Returns
- current time-delta between engine and sync-source

Reimplemented from ARDOUR::TransportMaster.

◆ init()

void ARDOUR::MIDIClock_TransportMaster::init ( )
virtual

◆ locked()

bool ARDOUR::MIDIClock_TransportMaster::locked ( ) const
virtual

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.

◆ ok()

bool ARDOUR::MIDIClock_TransportMaster::ok ( ) const
virtual

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.

◆ position()

void ARDOUR::MIDIClock_TransportMaster::position ( MIDI::Parser parser,
MIDI::byte message,
size_t  size,
samplepos_t  timestamp 
)
protected

◆ position_string()

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

◆ pre_process()

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

◆ rebind()

void ARDOUR::MIDIClock_TransportMaster::rebind ( MidiPort )

◆ requires_seekahead()

bool ARDOUR::MIDIClock_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 679 of file transport_master.h.

◆ reset()

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

◆ resolution()

samplecnt_t ARDOUR::MIDIClock_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::MIDIClock_TransportMaster::set_session ( Session )
virtual

Reimplemented from ARDOUR::TransportMaster.

◆ start()

void ARDOUR::MIDIClock_TransportMaster::start ( MIDI::Parser parser,
samplepos_t  timestamp 
)
protected

◆ stop()

void ARDOUR::MIDIClock_TransportMaster::stop ( MIDI::Parser parser,
samplepos_t  timestamp 
)
protected

◆ unregister_port()

void ARDOUR::MIDIClock_TransportMaster::unregister_port ( )
virtual

Reimplemented from ARDOUR::TransportMaster.

◆ update_interval()

samplecnt_t ARDOUR::MIDIClock_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.

◆ update_midi_clock()

void ARDOUR::MIDIClock_TransportMaster::update_midi_clock ( MIDI::Parser parser,
samplepos_t  timestamp 
)
protected

Member Data Documentation

◆ _bpm

double ARDOUR::MIDIClock_TransportMaster::_bpm
protected

Definition at line 719 of file transport_master.h.

◆ _running

bool ARDOUR::MIDIClock_TransportMaster::_running
protected

Definition at line 718 of file transport_master.h.

◆ _speed

double ARDOUR::MIDIClock_TransportMaster::_speed
protected

a DLL to track MIDI clock

Definition at line 717 of file transport_master.h.

◆ first_timestamp

samplepos_t ARDOUR::MIDIClock_TransportMaster::first_timestamp
protected

the timestamp of the first MIDI clock message

Definition at line 705 of file transport_master.h.

◆ last_timestamp

samplepos_t ARDOUR::MIDIClock_TransportMaster::last_timestamp
protected

the time stamp and should-be transport position of the last inbound MIDI clock message

Definition at line 708 of file transport_master.h.

◆ midi_clock_count

long ARDOUR::MIDIClock_TransportMaster::midi_clock_count
protected

the number of midi clock messages received (zero-based) since start

Definition at line 713 of file transport_master.h.

◆ one_ppqn_in_samples

double ARDOUR::MIDIClock_TransportMaster::one_ppqn_in_samples
protected

the duration of one ppqn in sample time

Definition at line 702 of file transport_master.h.

◆ port_connections

PBD::ScopedConnectionList ARDOUR::MIDIClock_TransportMaster::port_connections
protected

Definition at line 696 of file transport_master.h.

◆ ppqn

int ARDOUR::MIDIClock_TransportMaster::ppqn
protected

pulses per quarter note for one MIDI clock sample (default 24)

Definition at line 699 of file transport_master.h.

◆ should_be_position

double ARDOUR::MIDIClock_TransportMaster::should_be_position
protected

Definition at line 709 of file transport_master.h.


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