Changeset 392 for branches/streaming-rework

Timestamp:

02/10/07 04:06:26 (16 years ago)

Author:

pieterpalmers

Message:

- document TimestampedBuffer? class
- partially ported timestamp handling to TimestampedBuffer?
- introduced test for TimestampedBuffer? class

Files:

• branches/streaming-rework/src/debugmodule/debugmodule.cpp (modified) (1 diff)
• branches/streaming-rework/src/debugmodule/debugmodule.h (modified) (1 diff)
• branches/streaming-rework/src/libstreaming/AmdtpStreamProcessor.cpp (modified) (9 diffs)
• branches/streaming-rework/src/libstreaming/StreamProcessor.cpp (modified) (1 diff)
• branches/streaming-rework/src/libstreaming/StreamProcessor.h (modified) (5 diffs)
• branches/streaming-rework/src/libutil/TimestampedBuffer.cpp (modified) (19 diffs)
• branches/streaming-rework/src/libutil/TimestampedBuffer.h (modified) (6 diffs)
• branches/streaming-rework/tests/Makefile.am (modified) (3 diffs)
• branches/streaming-rework/tests/SytMonitor.h (modified) (1 diff)
• branches/streaming-rework/tests/test-sytmonitor.cpp (modified) (2 diffs)
• branches/streaming-rework/tests/test-timestampedbuffer.cpp (added)

branches/streaming-rework/src/debugmodule/debugmodule.cpp

@@ -270 +270 @@
-}
-
+void
+DebugModuleManager::sync()
+{
+    mb_flush();
+}
-
-void

branches/streaming-rework/src/debugmodule/debugmodule.h

@@ -199 +199 @@
-    bool setMgrDebugLevel( std::string name, debug_level_t level );
-
+    void sync();
+
-protected:
-    bool registerModule( DebugModule& debugModule );

branches/streaming-rework/src/libstreaming/AmdtpStreamProcessor.cpp

@@ -392 +392 @@
-        // update the frame counter such that it reflects the new value
-        // done in the SP base class
-
-
-
-
+// 
+// 
+// 
+// 
-        
-        return RAW1394_ISO_OK;    
@@ -471 +471 @@
-    // this base timestamp is the timestamp of the
-    // last buffer transfer.
-
-
-
+// 
+// 
+// 
-
-    // update the frame counter such that it reflects the buffer content,
-    // the buffer tail timestamp is initialized when the SP is enabled
-    // done in the SP base class
-
-
-
-
-
+// 
+// 
+// 
+// 
+// 
-
-    return true;
@@ -582 +582 @@
-    m_data_buffer->setUpdatePeriod(m_period);
-    m_data_buffer->setNominalRate(m_ticks_per_frame);
+    
+    m_data_buffer->setWrapValue(128L*TICKS_PER_SECOND);
-    
-    m_data_buffer->prepare();
@@ -730 +732 @@
-
-    // add the silence data to the ringbuffer
-
+, 0
-        retval=true;
-    } else {
@@ -784 +786 @@
-    // and also update the buffer tail timestamp
-    // done in the SP base class
-
-
-
-
+// 
+// 
+// 
+// 
-
-    return true;
@@ -1232 +1234 @@
-        //=> process the packet
-        // add the data payload to the ringbuffer
-
+, m_last_timestamp
-            retval=RAW1394_ISO_OK;
-            
@@ -1275 +1277 @@
-        // and also update the buffer tail timestamp, as we add new frames
-        // done in the SP base class
-
-
-
-
+// 
+// 
+// 
+// 
-
-    } 
@@ -1496 +1498 @@
-    m_data_buffer->setUpdatePeriod(m_syt_interval);
-    m_data_buffer->setNominalRate(m_ticks_per_frame);
+    
+    m_data_buffer->setWrapValue(128L*TICKS_PER_SECOND);
-    
-    m_data_buffer->prepare();
@@ -1606 +1610 @@
-    // which should be ours
-    m_data_buffer->blockProcessReadFrames(nbframes);
-
+
-    // update the frame counter such that it reflects the new value,
-    // done in the SP base class
-
+/*
-    if (!StreamProcessor::getFrames(nbframes)) {
-        debugError("Could not do StreamProcessor::getFrames(%d)\n", nbframes);
-        return false;
-
-
+*/
+
-    return true;
-}

branches/streaming-rework/src/libstreaming/StreamProcessor.cpp

@@ -166 +166 @@
-}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+/ /
+// 
+// 
+// 
+// 
+// 
+// 
+// 
+// 
+// 
+// 
+// 
+
+// 
+// // 
+// 
+// 
+
+/ /
+//
+//
+//
+//
+//
+//
+//
+//
+// 
+
+// 
+// // 
+// 
+// 
-
-uint64_t StreamProcessor::getTimeNow() {

branches/streaming-rework/src/libstreaming/StreamProcessor.h

@@ -88 +88 @@
-    bool isEnabled() {return !m_is_disabled;};
-
-
-
+ = 0
+ = 0
-
-    virtual bool reset(); ///< reset the streams & buffers (e.g. after xrun)
@@ -175 +175 @@
-         */
-        virtual uint64_t getTimeAtPeriodUsecs() = 0;
-
+
-        /**
-         * \brief return the time of the next period boundary (in internal units) 
@@ -184 +184 @@
-         */
-        virtual uint64_t getTimeAtPeriod() = 0;
-
+
-        uint64_t getTimeNow();
-
+
-        bool setSyncSource(StreamProcessor *s);
-        float getTicksPerFrame() {return m_ticks_per_frame;};
-
+
-        int getLastCycle() {return m_last_cycle;};
-
-
+
-    protected:
-        StreamProcessor *m_SyncSource;
-
+
-        float m_ticks_per_frame;
-
+
-        int m_last_cycle;
-
@@ -221 +220 @@
-                      int cycle, unsigned int dropped, unsigned int max_length) 
-                      {return RAW1394_ISO_STOP;};
-
-
+
+
+
-                      unsigned char channel, unsigned char tag, unsigned char sy, 
-                          unsigned int cycle, unsigned int dropped) = 0;
@@ -251 +251 @@
-                      unsigned char channel, unsigned char tag, unsigned char sy, 
-                          unsigned int cycle, unsigned int dropped) {return RAW1394_ISO_STOP;};
-
+
+
-        virtual enum raw1394_iso_disposition 
-                getPacket(unsigned char *data, unsigned int *length,

branches/streaming-rework/src/libutil/TimestampedBuffer.cpp

@@ -41 +41 @@
-      m_event_size(0), m_events_per_frame(0), m_buffer_size(0), 
-      m_bytes_per_frame(0), m_bytes_per_buffer(0),
+      m_wrap_at(0xFFFFFFFFFFFFFFFFLLU),
-      m_Client(c), m_framecounter(0), m_buffer_tail_timestamp(0), 
+      m_buffer_next_tail_timestamp(0),
-      m_dll_e2(0.0), m_dll_b(0.877), m_dll_c(0.384),
-      m_nominal_rate(0.0), m_update_period(0)
-{
+    pthread_mutex_init(&m_framecounter_lock, NULL);
-
-}
@@ -53 +56 @@
-}
-
+/**
+ * \brief Set the nominal rate in frames/timeunit
+ *
+ * Sets the nominal rate in frames per time unit. This rate is used
+ * to initialize the DLL that will extract the effective rate based
+ * upon the timestamps it gets fed.
+ *
+ * @param r rate
+ * @return true if successful
+ */
+bool TimestampedBuffer::setNominalRate(float r) {
+    m_nominal_rate=r;
+    debugOutput(DEBUG_LEVEL_VERBOSE," nominal rate=%e set to %e\n",
+                                    m_nominal_rate, r);    
+    return true;
+}
+
+/**
+ * \brief Set the nominal update period (in frames)
+ *
+ * Sets the nominal update period. This period is the number of frames
+ * between two timestamp updates (hence buffer writes)
+ *
+ * @param n period in frames
+ * @return true if successful
+ */
+bool TimestampedBuffer::setUpdatePeriod(unsigned int n) {
+    m_update_period=n;
+    return true;
+}
+
+/**
+ * \brief set the value at which timestamps should wrap around
+ * @param w value to wrap at
+ * @return true if successful
+ */
+bool TimestampedBuffer::setWrapValue(uint64_t w) {
+    m_wrap_at=w;
+    return true;
+}
+
+/**
+ * \brief return the effective rate 
+ *
+ * Returns the effective rate calculated by the DLL.
+ *
+ * @return rate (in frames/timeunit)
+ */
+float TimestampedBuffer::getRate() {
+    return ((float) m_update_period)/m_dll_e2;
+}
+
+/**
+ * \brief Sets the size of the events
+ * @param s event size in bytes
+ * @return true if successful
+ */
-bool TimestampedBuffer::setEventSize(unsigned int s) {
-    m_event_size=s;
@@ -62 +122 @@
-}
-
-
-
+
+
+
+
+
+
+
-    
-    m_bytes_per_frame=m_event_size*m_events_per_frame;
@@ -70 +135 @@
-    return true;
-}
-
-
-
-
+
+
+
+
+
+
+
+
-    m_bytes_per_frame=m_event_size*m_events_per_frame;
-    m_bytes_per_buffer=m_bytes_per_frame*m_buffer_size;
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-unsigned int TimestampedBuffer::getBufferFill() {
-    return freebob_ringbuffer_read_space(m_event_buffer)/(m_bytes_per_frame);
-}
-
+/**
+ * \brief Initializes the TimestampedBuffer
+ *
+ * Initializes the TimestampedBuffer, should be called before anything else
+ * is done.
+ *
+ * @return true if successful
+ */
-bool TimestampedBuffer::init() {
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-bool TimestampedBuffer::reset() {
-    freebob_ringbuffer_reset(m_event_buffer);
@@ -99 +197 @@
-}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
-bool TimestampedBuffer::prepare() {
-    debugOutput(DEBUG_LEVEL_VERBOSE,"Preparing buffer (%p)\n",this);
-    debugOutput(DEBUG_LEVEL_VERBOSE," Size=%u events, events/frame=%u, event size=%ubytes\n",
-                                        m_buffer_size,m_events_per_frame,m_event_size);
+                                        
+    debugOutput(DEBUG_LEVEL_VERBOSE," update period %u\n",
+                                    m_update_period);
+    debugOutput(DEBUG_LEVEL_VERBOSE," nominal rate=%f\n",
+                                    m_nominal_rate);
+                                    
+    debugOutput(DEBUG_LEVEL_VERBOSE," wrapping at %llu\n",m_wrap_at);
-
-    assert(m_buffer_size);
@@ -123 +224 @@
-    assert(m_event_size);
-
+    assert(m_nominal_rate != 0.0L);
+    assert(m_update_period != 0);
+    
-    if( !(m_event_buffer=freebob_ringbuffer_create(
-            (m_events_per_frame * m_buffer_size) * m_event_size))) {
-            
-        debugFatal("Could not allocate memory event ringbuffer\n");
-        return false;
@@ -136 +239 @@
-        return false;
-    }
-
-    assert(m_nominal_rate != 0.0);
-    assert(m_update_period != 0);
-    
-    // init the DLL
@@ -149 +249 @@
-}
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-    // add the data payload to the ringbuffer
@@ -159 +270 @@
-        return false;
-    }
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-    // get the data payload to the ringbuffer
@@ -173 +296 @@
-        return false;
-    }
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-bool TimestampedBuffer::blockProcessWriteFrames(unsigned int nbframes, int64_t ts) {
-
@@ -266 +405 @@
-    }
-    
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-bool TimestampedBuffer::blockProcessReadFrames(unsigned int nbframes) {
-
@@ -302 +454 @@
-
-        if(vec[0].len==0) { // this indicates an empty event buffer
-RCV: Event buffer underrun in processo
+Event buffer underrun in buffe
-            return false;
-        }
@@ -321 +473 @@
-            if(xrun<0) {
-                // xrun detected
-RCV: Frame buffer overrun in processo
+Frame buffer overrun in buffe
-                    return false;
-            }
@@ -342 +494 @@
-            if(xrun<0) {
-                // xrun detected
-RCV: Frame buffer overrun in processo
+Frame buffer overrun in buffe
-                return false;
-            }
@@ -354 +506 @@
-    }
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- * is thread safe.
+ */
+void TimestampedBuffer::resetFrameCounter() {
+    pthread_mutex_lock(&m_framecounter_lock);
+    m_framecounter = 0;
+    pthread_mutex_unlock(&m_framecounter_lock);
+}
+
+/**
+ * Decrements the frame counter in a thread safe way.
+ * 
+ * @param nbframes number of frames to decrement
- */
-void TimestampedBuffer::decrementFrameCounter(int nbframes) {
@@ -368 +620 @@
-
-/**
-
-
-
+
+
+
+
+
- */
-void TimestampedBuffer::incrementFrameCounter(int nbframes, uint64_t new_timestamp) {
-Y_VER
+
-                this, new_timestamp);
-    
@@ -390 +644 @@
-                    
-    // the maximal difference we can allow (64secs)
-TICKS_PER_SECOND*64L
+m_wrap_at/2
-    
-    if(diff > max) {
-TICKS_PER_SECOND*128L
+m_wrap_at
-    } else if (diff < -max) {
-TICKS_PER_SECOND*128L
+m_wrap_at
-    }
-
@@ -401 +655 @@
-    
-    debugOutputShort(DEBUG_LEVEL_VERY_VERBOSE, "diff2=%lld err=%f\n",
-
-
+
+
+
-    
-    m_buffer_tail_timestamp=m_buffer_next_tail_timestamp;
-    m_buffer_next_tail_timestamp += (uint64_t)(m_dll_b * err + m_dll_e2);
-    
-
-
+
+
+
+
+
-    }
-    
-    m_dll_e2 += m_dll_c*err;
-    
-Y_VERBOSE, "
+BOSE, "A: 
-                m_buffer_tail_timestamp, m_buffer_next_tail_timestamp, m_dll_e2);
-    
-    pthread_mutex_unlock(&m_framecounter_lock);
+    
+    if(m_buffer_tail_timestamp>=m_wrap_at) {
+        debugError("Wrapping failed for m_buffer_tail_timestamp!\n");
+    }
+    if(m_buffer_next_tail_timestamp>=m_wrap_at) {
+        debugError("Wrapping failed for m_buffer_next_tail_timestamp!\n");
+    }
-    
-    // this DLL allows the calculation of any sample timestamp relative to the buffer tail,
@@ -427 +692 @@
-
-/**
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-} // end of namespace FreebobUtil

branches/streaming-rework/src/libutil/TimestampedBuffer.h

@@ -36 +36 @@
-class TimestampedBufferClient;
-
+/**
+ * \brief Class implementing a frame buffer that is time-aware
+ *
+ * This class implements a buffer that is time-aware. Whenever new frames 
+ * are written to the buffer, the timestamp corresponding to the last frame
+ * in the buffer is updated. This allows to calculate the timestamp of any
+ * other frame in the buffer.
+ *
+ * The buffer is a frame buffer, having the following parameters defining
+ * it's behaviour:
+ * - buff_size: buffer size in frames (setBufferSize())
+ * - events_per_frame: the number of events per frame (setEventsPerFrame())
+ * - event_size: the storage size of the events (in bytes) (setEventSize())
+ *
+ * The total size of the buffer (in bytes) is at least 
+ * buff_size*events_per_frame*event_size.
+ *
+ * Timestamp tracking is done by requiring that a timestamp is specified every
+ * time frames are added to the buffer. In combination with the buffer fill and
+ * the frame rate (calculated internally), this allows to calculate the timestamp
+ * of any frame in the buffer. In order to initialize the internal data structures,
+ * the setNominalRate() and setUpdatePeriod() functions are provided.
+ *
+ * \note Currently the class only supports fixed size writes of size update_period.
+ *       This can change in the future, implementation ideas are already in place.
+ *
+ * The TimestampedBuffer class is time unit agnostic. It can handle any time unit
+ * as long as it fits in a 64 bit unsigned integer. The buffer supports wrapped 
+ * timestamps using (...).
+ *
+ * There are two methods of reading and writing to the buffer. 
+ *
+ * The first method uses conventional readFrames() and writeFrames() functions.
+ *
+ * The second method makes use of the TimestampedBufferClient interface. When a 
+ * TimestampedBuffer is created, it is required that a TimestampedBufferClient is
+ * registered. This client implements the processReadBlock and processWriteBlock
+ * functions. These are block processing 'callbacks' that allow zero-copy processing
+ * of the buffer contents. In order to initiate block processing, the
+ * blockProcessWriteFrames and blockProcessReadFrames functions are provided by 
+ * TimestampedBuffer.
+ *
+ */
-class TimestampedBuffer {
-
-public:
-
+
-    TimestampedBuffer(TimestampedBufferClient *);
-    virtual ~TimestampedBuffer();
-    
-
+, uint64_t ts
-    bool readFrames(unsigned int nbframes, char *data);
-    
@@ -57 +101 @@
-    bool setBufferSize(unsigned int s);
-    
+    bool setWrapValue(uint64_t w);
+    
-    unsigned int getBufferFill();
-    
@@ -62 +108 @@
-    int getFrameCounter() {return m_framecounter;};
-
-    void decrementFrameCounter(int nbframes);
-    void incrementFrameCounter(int nbframes, uint64_t new_timestamp);
-    void resetFrameCounter();
-    
-    void getBufferHeadTimestamp(uint64_t *ts, uint64_t *fc);
-    void getBufferTailTimestamp(uint64_t *ts, uint64_t *fc);
@@ -72 +114 @@
-   
-    // dll stuff
-void setNominalRate(double r) {m_nominal_rate=r;}
-double getRate() {return m_dll_e2;}
+bool setNominalRate(float r)
+float getRate()
-    
-void setUpdatePeriod(unsigned int t) {m_update_period=t;}
+bool setUpdatePeriod(unsigned int t)
-    
-    // misc stuff
-    void dumpInfo();
-
-
+
+
+
+
+
+
+
-protected:
-
@@ -91 +138 @@
-    unsigned int m_bytes_per_frame;
-    unsigned int m_bytes_per_buffer;
+    
+    uint64_t m_wrap_at; // value to wrap at
-    
-    TimestampedBufferClient *m_Client;
@@ -117 +166 @@
-    double m_dll_c;
-    
-double
+float
-    unsigned int m_update_period;
-};
-
+/**
+ * \brief Interface to be implemented by TimestampedBuffer clients
+ */
-class TimestampedBufferClient {
-    public:

branches/streaming-rework/tests/Makefile.am

@@ -22 +22 @@
-
-noinst_PROGRAMS = test-freebob test-extplugcmd test-fw410 freebob-server \
-
+
+
-
-noinst_HEADERS = 
@@ -49 +50 @@
-        $(LIBAVC1394_LIBS) $(LIBIEC61883_LIBS) -lrom1394
-
-
-#TESTS_ENVIRONMENT
-TEST = test-freebob
@@ -61 +61 @@
-test_sytmonitor_SOURCES = test-sytmonitor.cpp SytMonitor.cpp \
-                          SytMonitor.h
+
+test_timestampedbuffer_LDADD = $(top_builddir)/src/libfreebob.la $(LIBIEC61883_LIBS) \
+        $(LIBRAW1394_LIBS) $(LIBAVC1394_LIBS)
+test_timestampedbuffer_SOURCES = test-timestampedbuffer.cpp

branches/streaming-rework/tests/SytMonitor.h

@@ -7 +7 @@
- *   http://freebob.sf.net
- *
-5,2006
+7
- *
- *   This program is free software {} you can redistribute it and/or modify

branches/streaming-rework/tests/test-sytmonitor.cpp

@@ -1 +1 @@
-/***************************************************************************
-5
+7
-                                                                        *
-This program is free software; you can redistribute it and/or modify  *
@@ -41 +41 @@
-#include "src/libutil/SystemTimeSource.h"
-
-"pthread.h"
+<pthread.h>
-
-using namespace FreebobStreaming;