Merge master.
[dcpomatic.git] / src / lib / decoder.h
index be1fe38b6ef2ff52e6f0b6e22b4ec7785af5baf9..aeb39d0b2a05483cc2afe5f736e0534d44658d5d 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2013 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
  *  @brief Parent class for decoders of content.
  */
 
-#ifndef DVDOMATIC_DECODER_H
-#define DVDOMATIC_DECODER_H
+#ifndef DCPOMATIC_DECODER_H
+#define DCPOMATIC_DECODER_H
 
-#include <vector>
-#include <string>
-#include <stdint.h>
 #include <boost/shared_ptr.hpp>
-#include <boost/signals2.hpp>
-#include "util.h"
-#include "stream.h"
-#include "video_source.h"
-#include "audio_source.h"
+#include <boost/weak_ptr.hpp>
+#include <boost/utility.hpp>
+#include "types.h"
+#include "dcpomatic_time.h"
 
-class Job;
-class DecodeOptions;
-class Image;
-class Log;
-class DelayLine;
-class TimedSubtitle;
-class Subtitle;
 class Film;
-class FilterGraph;
+class Decoded;
 
 /** @class Decoder.
  *  @brief Parent class for decoders of content.
- *
- *  These classes can be instructed run through their content (by
- *  calling ::go), and they emit signals when video or audio data is
- *  ready for something else to process.
  */
-class Decoder
+class Decoder : public boost::noncopyable
 {
 public:
-       Decoder (boost::shared_ptr<Film>, boost::shared_ptr<const DecodeOptions>, Job *);
+       Decoder (boost::shared_ptr<const Film>);
        virtual ~Decoder () {}
 
-       virtual bool pass () = 0;
-       /** Seek.
-        *  @return true on error.
+       /** 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.
+        */
+       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().
         */
-       virtual bool seek (SourceFrame);
+       void consume ();
 
 protected:
-       /** our Film */
-       boost::shared_ptr<Film> _film;
-       /** our options */
-       boost::shared_ptr<const DecodeOptions> _opt;
-       /** associated Job, or 0 */
-       Job* _job;
+
+       /** Perform one decode pass of the content, which may or may not
+        *  result in a complete quantum (Decoded object) of decoded stuff
+        *  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).
+        */
+       virtual bool pass () = 0;
+       virtual void flush () {};
+       
+       /** The Film that we are decoding in */
+       boost::weak_ptr<const Film> _film;
+
+       std::list<boost::shared_ptr<Decoded> > _pending;
+       bool _done;
 };
 
 #endif