Merge master.

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

diff --git a/src/lib/decoder.h b/src/lib/decoder.h
index df3ac4f39c4a734b9c433673e36ff2500b50d774..583a92636443ba7cd1bd650eb3cf61144017394c 100644 (file)
--- a/src/lib/decoder.h
+++ b/src/lib/decoder.h
@@ -18,7 +18,7 @@
 */
 
 /** @file  src/decoder.h
- *  @brief Parent class for decoders of content.
+ *  @brief Decoder class.
  */
 
 #ifndef DCPOMATIC_DECODER_H
@@ -31,7 +31,6 @@
 #include "dcpomatic_time.h"
 
 class Decoded;
-class Film;
 
 /** @class Decoder.
  *  @brief Parent class for decoders of content.
@@ -42,10 +41,13 @@ public:
        virtual ~Decoder () {}
 
 protected:     
-       /** Seek so that the next peek() will yield the next thing
+       /** 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.
+        *  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;