Merge master.

[dcpomatic.git] / src / lib / decoder.h

diff --git a/src/lib/decoder.h b/src/lib/decoder.h
index 6646b0e76acc66b14edb78d698bd9c48412e07c4..aeb39d0b2a05483cc2afe5f736e0534d44658d5d 100644 (file)
--- a/src/lib/decoder.h
+++ b/src/lib/decoder.h
@@ -28,6 +28,7 @@
 #include <boost/weak_ptr.hpp>
 #include <boost/utility.hpp>
 #include "types.h"
+#include "dcpomatic_time.h"
 
 class Film;
 class Decoded;
@@ -41,7 +42,7 @@ public:
        Decoder (boost::shared_ptr<const Film>);
        virtual ~Decoder () {}
 
-       /** Seek so that the next get_*() will yield the next thing
+       /** Seek so that the next peek() 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.
@@ -49,13 +50,17 @@ public:
        virtual void seek (ContentTime time, bool accurate);
        
        boost::shared_ptr<Decoded> peek ();
+
+       /* Consume the last peek()ed thing so that it won't be returned
+        * from the next peek().
+        */
        void consume ();
 
 protected:
 
        /** Perform one decode pass of the content, which may or may not
         *  result in a complete quantum (Decoded object) of decoded stuff
-        *  being made ready.
+        *  being added to _pending.
         *  @return true if the decoder is done (i.e. no more data will be
         *  produced by any future calls to pass() without a seek() first).
         */