Basics of splitting up Decoder tree like Content.

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

diff --git a/src/lib/decoder.h b/src/lib/decoder.h
index 38556c8188a3932a319c5c3c3a7e463fa0fde435..979c6cf582777766b867212a61cc67a7a174890f 100644 (file)
--- a/src/lib/decoder.h
+++ b/src/lib/decoder.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -18,20 +18,20 @@
 */
 
 /** @file  src/decoder.h
- *  @brief Parent class for decoders of content.
+ *  @brief Decoder class.
  */
 
 #ifndef DCPOMATIC_DECODER_H
 #define DCPOMATIC_DECODER_H
 
-#include <boost/shared_ptr.hpp>
-#include <boost/weak_ptr.hpp>
-#include <boost/utility.hpp>
 #include "types.h"
 #include "dcpomatic_time.h"
+#include <boost/utility.hpp>
 
 class Decoded;
-class Film;
+class VideoDecoder;
+class AudioDecoder;
+class SubtitleDecoder;
 
 /** @class Decoder.
  *  @brief Parent class for decoders of content.
@@ -41,16 +41,28 @@ class Decoder : public boost::noncopyable
 public:
        virtual ~Decoder () {}
 
-protected:     
+       boost::shared_ptr<VideoDecoder> video;
+       boost::shared_ptr<AudioDecoder> audio;
+       boost::shared_ptr<SubtitleDecoder> subtitle;
+
+       enum PassReason {
+               PASS_REASON_VIDEO,
+               PASS_REASON_AUDIO,
+               PASS_REASON_SUBTITLE
+       };
+
        /** 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;
+
+       /** @return true if this decoder has already returned all its data and will give no more */
+       virtual bool pass (PassReason, bool accurate) = 0;
 };
 
 #endif