Some include tidying.
[dcpomatic.git] / src / lib / decoder.h
index 18f612e538c5e645470c33cfcca91175a58a0b13..c1b8598650357b6a9978efdbcc28eb495ba69511 100644 (file)
 #ifndef DCPOMATIC_DECODER_H
 #define DCPOMATIC_DECODER_H
 
+#include "types.h"
+#include "dcpomatic_time.h"
 #include <boost/shared_ptr.hpp>
 #include <boost/weak_ptr.hpp>
 #include <boost/utility.hpp>
-#include "types.h"
-#include "dcpomatic_time.h"
 
 class Decoded;
 
@@ -43,10 +43,11 @@ public:
 protected:     
        /** Seek so that the next pass() will yield the next thing
         *  (video/sound frame, subtitle etc.) at or after the requested
-        *  time.  Pass accurate = true to try harder to get close to
-        *  the request.  Note that seeking to time t may mean that
-        *  the next pass() yields, for example, audio at time t and then
-        *  video before it.
+        *  time.  Pass accurate = true to try harder to ensure that, at worst,
+        *  the next thing we yield comes before `time'.  This may entail
+        *  seeking some way before `time' to be on the safe side.
+        *  Alternatively, if seeking is 100% accurate for this decoder,
+        *  it may seek to just the right spot.
         */
        virtual void seek (ContentTime time, bool accurate) = 0;
        virtual bool pass () = 0;