diff options
author | David Robillard <d@drobilla.net> | 2009-10-14 16:10:01 +0000 |
---|---|---|
committer | David Robillard <d@drobilla.net> | 2009-10-14 16:10:01 +0000 |
commit | bb9cc45cd22af67ac275a5e73accbe14fee664d8 (patch) | |
tree | e52977d3eae6ff07b856088041a080a2fa3e5b79 /libs/ardour/ardour/slave.h | |
parent | 8c4ce1e2ce35571aed5a686671431fdfffae7f8c (diff) |
Strip trailing whitespace and fix other whitespace errors (e.g. space/tab mixing). Whitespace changes only.
Vimmers, try let c_space_errors = 1 in your .vimrc to highlight this kind of stuff in red. I don't know the emacs equivalent...
git-svn-id: svn://localhost/ardour2/branches/3.0@5773 d708f5d6-7413-0410-9779-e7cbd77b26cf
Diffstat (limited to 'libs/ardour/ardour/slave.h')
-rw-r--r-- | libs/ardour/ardour/slave.h | 100 |
1 files changed, 50 insertions, 50 deletions
diff --git a/libs/ardour/ardour/slave.h b/libs/ardour/ardour/slave.h index 5987151307..64e350ae9c 100644 --- a/libs/ardour/ardour/slave.h +++ b/libs/ardour/ardour/slave.h @@ -38,10 +38,10 @@ namespace MIDI { namespace ARDOUR { /** * @class Slave - * + * * @brief The Slave interface can be used to sync ARDOURs tempo to an external source * like MTC, MIDI Clock, etc. - * + * * The name of the interface may be a bit misleading: A subclass of Slave actually * acts as a time master for ARDOUR, that means ARDOUR will try to follow the * speed and transport position of the implementation of Slave. @@ -57,7 +57,7 @@ class Slave { * This is the most important function to implement: * Each process cycle, Session::follow_slave will call this method. * and after the method call they should - * + * * Session::follow_slave will then try to follow the given * <emph>position</emph> using a delay locked loop (DLL), * starting with the first given transport speed. @@ -65,92 +65,92 @@ class Slave { * ARDOUR will always follow the position and disregard the speed. * Although, a correct speed is important so that ARDOUR * can sync to the master time source quickly. - * - * For background information on delay locked loops, + * + * For background information on delay locked loops, * see http://www.kokkinizita.net/papers/usingdll.pdf - * + * * The method has the following precondition: * <ul> - * <li> - * Slave::ok() should return true, otherwise playback will stop + * <li> + * Slave::ok() should return true, otherwise playback will stop * immediately and the method will not be called - * </li> + * </li> * <li> * when the references speed and position are passed into the Slave * they are uninitialized * </li> * </ul> - * + * * After the method call the following postconditions should be met: * <ul> - * <li> + * <li> * The first position value on transport start should be 0, - * otherwise ARDOUR will try to locate to the new position + * otherwise ARDOUR will try to locate to the new position * rather than move to it * </li> - * <li> - * the references speed and position should be assigned + * <li> + * the references speed and position should be assigned * to the Slaves current requested transport speed * and transport position. * </li> * <li> - * Slave::resolution() should be greater than the maximum distance of + * Slave::resolution() should be greater than the maximum distance of * ARDOURs transport position to the slaves requested transport position. * </li> - * <li>Slave::locked() should return true, otherwise Session::no_roll will be called</li> - * <li>Slave::starting() should be false, otherwise the transport will not move until it becomes true</li> * + * <li>Slave::locked() should return true, otherwise Session::no_roll will be called</li> + * <li>Slave::starting() should be false, otherwise the transport will not move until it becomes true</li> * * </ul> - * + * * @param speed - The transport speed requested * @param position - The transport position requested * @return - The return value is currently ignored (see Session::follow_slave) */ virtual bool speed_and_position (double& speed, nframes_t& position) = 0; - + /** - * reports to ARDOUR whether the Slave is currently synced to its external + * reports to ARDOUR whether the Slave is currently synced to its external * time source. - * + * * @return - when returning false, the transport will stop rolling */ virtual bool locked() const = 0; - + /** * reports to ARDOUR whether the slave is in a sane state - * - * @return - when returning false, the transport will be stopped and the slave + * + * @return - when returning false, the transport will be stopped and the slave * disconnected from ARDOUR. */ virtual bool ok() const = 0; - + /** * reports to ARDOUR whether the slave is in the process of starting * to roll - * + * * @return - when returning false, transport will not move until this method returns true */ virtual bool starting() const { return false; } - + /** * @return - the timing resolution of the Slave - If the distance of ARDOURs transport * to the slave becomes greater than the resolution, sound will stop */ virtual nframes_t resolution() const = 0; - + /** * @return - when returning true, ARDOUR will wait for one second before transport * starts rolling */ virtual bool requires_seekahead () const = 0; - + /** - * @return - when returning true, ARDOUR will use transport speed 1.0 no matter what + * @return - when returning true, ARDOUR will use transport speed 1.0 no matter what * the slave returns */ virtual bool is_always_synced() const { return false; } - + /** - * @return - whether ARDOUR should use the slave speed without any adjustments + * @return - whether ARDOUR should use the slave speed without any adjustments */ virtual bool give_slave_full_control_over_transport_speed() const { return false; } }; @@ -195,11 +195,11 @@ struct SafeTime { nframes_t timestamp; int guard2; - SafeTime() { - guard1 = 0; - guard2 = 0; - timestamp = 0; - } + SafeTime() { + guard1 = 0; + guard2 = 0; + timestamp = 0; + } }; class MTC_Slave : public Slave, public sigc::trackable { @@ -264,7 +264,7 @@ class MIDIClock_Slave : public Slave, public sigc::trackable { bool give_slave_full_control_over_transport_speed() const { return true; } void set_bandwidth (double a_bandwith) { bandwidth = a_bandwith; } - + private: ISlaveSessionProxy* session; MIDI::Port* port; @@ -272,41 +272,41 @@ class MIDIClock_Slave : public Slave, public sigc::trackable { /// pulses per quarter note for one MIDI clock frame (default 24) int ppqn; - + /// the duration of one ppqn in frame time double one_ppqn_in_frames; /// the timestamp of the first MIDI clock message nframes_t first_timestamp; - + /// the time stamp and should-be transport position of the last inbound MIDI clock message nframes_t last_timestamp; double should_be_position; - + /// the number of midi clock messages received (zero-based) /// since start long midi_clock_count; - + //the delay locked loop (DLL), see www.kokkinizita.net/papers/usingdll.pdf - + /// time at the beginning of the MIDI clock frame double t0; - + /// calculated end of the MIDI clock frame double t1; - + /// loop error = real value - expected value double e; - + /// second order loop error double e2; - + /// DLL filter bandwidth double bandwidth; - + /// DLL filter coefficients double b, c, omega; - + void reset (); void start (MIDI::Parser& parser, nframes_t timestamp); void contineu (MIDI::Parser& parser, nframes_t timestamp); @@ -322,7 +322,7 @@ class MIDIClock_Slave : public Slave, public sigc::trackable { /// whether transport should be rolling bool _started; - + /// is true if the MIDI Start message has just been received until /// the first MIDI Clock Event bool _starting; |