Another try at sorting out the thorny question of timing.

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

diff --git a/src/lib/decoder.h b/src/lib/decoder.h
index 34accf6c740afdd60eb0e97a1a2e763d28a2c7e8..cfca6867f652d3fc9d2d5be7320d75128060cffe 100644 (file)
--- a/src/lib/decoder.h
+++ b/src/lib/decoder.h
@@ -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
@@ -21,17 +21,14 @@
  *  @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 "video_source.h"
-#include "audio_source.h"
 #include "film.h"
 
 class Image;
@@ -43,10 +40,6 @@ class FilterGraph;
 
 /** @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
 {
@@ -54,16 +47,23 @@ public:
        Decoder (boost::shared_ptr<const Film>);
        virtual ~Decoder () {}
 
-       virtual bool pass () = 0;
-       virtual bool seek (double);
-       virtual bool seek_to_last ();
+       /** Perform one decode pass of the content, which may or may not
+        *  cause the object to emit some data.
+        */
+       virtual void pass () = 0;
+
+       virtual bool done () const = 0;
 
 protected:
-       boost::shared_ptr<const Film> _film;
+
+       /** The Film that we are decoding in */
+       boost::weak_ptr<const Film> _film;
 
 private:
+       /** This will be called when our Film emits Changed */
        virtual void film_changed (Film::Property) {}
 
+       /** Connection to our Film */
        boost::signals2::scoped_connection _film_connection;
 };