const bool METHOD() const makes no sense
[ardour.git] / libs / ardour / ardour / slave.h
index adf425ea439c017587d33adc8e1b2458d71f2662..cf8060d029efeb6dd98a4b810fe3b86be2da4425 100644 (file)
 
 #include <glibmm/threads.h>
 
-#include <jack/jack.h>
+#include <ltc.h>
 
 #include "pbd/signals.h"
 
 #include "timecode/time.h"
-#include "ltc/ltc.h"
 
+#include "ardour/libardour_visibility.h"
 #include "ardour/types.h"
 #include "midi++/parser.h"
 #include "midi++/types.h"
@@ -59,20 +59,11 @@ class MidiPort;
  * Therefore it is rather that class, that makes ARDOUR a slave by connecting it
  * to its external time master.
  */
-class Slave {
+class LIBARDOUR_API Slave {
   public:
        Slave() { }
        virtual ~Slave() {}
 
-        /** The slave should read any incoming information in this method
-        *  and use it adjust its current idea of reality. If no such
-        *  processing is required, it does need to be implemented.
-        *
-        * @param nframes specifies the number of frames-worth of data that
-        * can be read from any ports used by the slave.
-        */
-         virtual int process (pframes_t) { return 0; }
-
        /**
         * This is the most important function to implement:
         * Each process cycle, Session::follow_slave will call this method.
@@ -189,15 +180,17 @@ class Slave {
 };
 
 /// We need this wrapper for testability, it's just too hard to mock up a session class
-class ISlaveSessionProxy {
+class LIBARDOUR_API ISlaveSessionProxy {
   public:
        virtual ~ISlaveSessionProxy() {}
-       virtual TempoMap&  tempo_map()                 const   { return *((TempoMap *) 0); }
-       virtual framecnt_t frame_rate()                const   { return 0; }
-       virtual framepos_t audible_frame ()            const   { return 0; }
-       virtual framepos_t transport_frame ()          const   { return 0; }
-       virtual pframes_t  frames_since_cycle_start () const   { return 0; }
-       virtual framepos_t frame_time ()               const   { return 0; }
+       virtual TempoMap&  tempo_map()                  const   { return *((TempoMap *) 0); }
+       virtual framecnt_t frame_rate()                 const   { return 0; }
+       virtual pframes_t  frames_per_cycle()           const   { return 0; }
+       virtual framepos_t audible_frame ()             const   { return 0; }
+       virtual framepos_t transport_frame ()           const   { return 0; }
+       virtual pframes_t  frames_since_cycle_start ()  const   { return 0; }
+       virtual framepos_t sample_time_at_cycle_start() const   { return 0; }
+       virtual framepos_t frame_time ()                const   { return 0; }
 
        virtual void request_locate (framepos_t /*frame*/, bool with_roll = false) {
                (void) with_roll;
@@ -207,24 +200,26 @@ class ISlaveSessionProxy {
 
 
 /// The Session Proxy for use in real Ardour
-class SlaveSessionProxy : public ISlaveSessionProxy {
+class LIBARDOUR_API SlaveSessionProxy : public ISlaveSessionProxy {
        Session&    session;
 
   public:
        SlaveSessionProxy(Session &s) : session(s) {}
 
-       TempoMap&  tempo_map()                 const;
-       framecnt_t frame_rate()                const;
-       framepos_t audible_frame ()            const;
-       framepos_t transport_frame ()          const;
-       pframes_t  frames_since_cycle_start () const;
-       framepos_t frame_time ()               const;
+       TempoMap&  tempo_map()                   const;
+       framecnt_t frame_rate()                  const;
+       pframes_t  frames_per_cycle()            const;
+       framepos_t audible_frame ()              const;
+       framepos_t transport_frame ()            const;
+       pframes_t  frames_since_cycle_start ()   const;
+       framepos_t sample_time_at_cycle_start()  const;
+       framepos_t frame_time ()                 const;
 
        void request_locate (framepos_t frame, bool with_roll = false);
        void request_transport_speed (double speed);
 };
 
-struct SafeTime {
+struct LIBARDOUR_API SafeTime {
        volatile int guard1;
        framepos_t   position;
        framepos_t   timestamp;
@@ -240,30 +235,31 @@ struct SafeTime {
        }
 };
 
-class TimecodeSlave : public Slave {
+class LIBARDOUR_API TimecodeSlave : public Slave {
   public:
-    TimecodeSlave () {}
+       TimecodeSlave () {}
+
+       virtual Timecode::TimecodeFormat apparent_timecode_format() const = 0;
 
-    virtual Timecode::TimecodeFormat apparent_timecode_format() const = 0;
+       /* this is intended to be used by a UI and polled from a timeout. it should
+          return a string describing the current position of the TC source. it
+          should NOT do any computation, but should use a cached value
+          of the TC source position.
+       */
+       virtual std::string approximate_current_position() const = 0;
 
-    /* this is intended to be used by a UI and polled from a timeout. it should
-       return a string describing the current position of the TC source. it
-       should NOT do any computation, but should use a cached value
-       of the TC source position.
-    */
-    virtual std::string approximate_current_position() const = 0;
+       framepos_t        timecode_offset;
+       bool              timecode_negative_offset;
 
-    framepos_t        timecode_offset;
-    bool              timecode_negative_offset;
+       PBD::Signal1<void, bool> ActiveChanged;
 };
 
-class MTC_Slave : public TimecodeSlave {
+class LIBARDOUR_API MTC_Slave : public TimecodeSlave {
   public:
        MTC_Slave (Session&, MidiPort&);
        ~MTC_Slave ();
 
        void rebind (MidiPort&);
-        int process (pframes_t);
        bool speed_and_position (double&, framepos_t&);
 
        bool locked() const;
@@ -282,7 +278,6 @@ class MTC_Slave : public TimecodeSlave {
   private:
        Session&    session;
        MidiPort*   port;
-        MIDI::Parser    parser;
        PBD::ScopedConnectionList port_connections;
        PBD::ScopedConnection     config_connection;
        bool        can_notify_on_unknown_rate;
@@ -343,7 +338,7 @@ class MTC_Slave : public TimecodeSlave {
        void parameter_changed(std::string const & p);
 };
 
-class LTC_Slave : public TimecodeSlave {
+class LIBARDOUR_API LTC_Slave : public TimecodeSlave {
 public:
        LTC_Slave (Session&);
        ~LTC_Slave ();
@@ -363,7 +358,7 @@ public:
        std::string approximate_current_delta() const;
 
   private:
-       void parse_ltc(const jack_nframes_t, const jack_default_audio_sample_t * const, const framecnt_t);
+       void parse_ltc(const pframes_t, const Sample* const, const framecnt_t);
        void process_ltc(framepos_t const);
        void init_engine_dll (framepos_t, int32_t);
        bool detect_discontinuity(LTCFrameExt *, int, bool);
@@ -395,6 +390,7 @@ public:
        int            ltc_detect_fps_cnt;
        int            ltc_detect_fps_max;
        bool           printed_timecode_warning;
+       bool           sync_lock_broken;
        Timecode::TimecodeFormat ltc_timecode;
        Timecode::TimecodeFormat a3e_timecode;
 
@@ -411,7 +407,7 @@ public:
        double b, c; ///< DLL filter coefficients
 };
 
-class MIDIClock_Slave : public Slave {
+class LIBARDOUR_API MIDIClock_Slave : public Slave {
   public:
        MIDIClock_Slave (Session&, MidiPort&, int ppqn = 24);
 
@@ -420,7 +416,6 @@ class MIDIClock_Slave : public Slave {
        ~MIDIClock_Slave ();
 
        void rebind (MidiPort&);
-        int process (pframes_t);
        bool speed_and_position (double&, framepos_t&);
 
        bool locked() const;
@@ -436,8 +431,6 @@ class MIDIClock_Slave : public Slave {
 
   protected:
        ISlaveSessionProxy* session;
-       MidiPort* port;
-        MIDI::Parser parser;
        PBD::ScopedConnectionList port_connections;
 
        /// pulses per quarter note for one MIDI clock frame (default 24)
@@ -500,11 +493,11 @@ class MIDIClock_Slave : public Slave {
        bool _starting;
 };
 
-class JACK_Slave : public Slave
+class LIBARDOUR_API Engine_Slave : public Slave
 {
   public:
-       JACK_Slave (AudioEngine&);
-       ~JACK_Slave ();
+       Engine_Slave (AudioEngine&);
+       ~Engine_Slave ();
 
        bool speed_and_position (double& speed, framepos_t& pos);
 
@@ -517,7 +510,6 @@ class JACK_Slave : public Slave
 
   private:
         AudioEngine& engine;
-       double speed;
        bool _starting;
 };