No-op; fix GPL address and use the explicit-program-name version.
[dcpomatic.git] / src / lib / decoder.h
index b550bf5cbe55e990eadd13aa95baab47a7f3f010..2a3b56c637be9f5135d1aa933369e077f7ea30a6 100644 (file)
@@ -1,90 +1,69 @@
 /*
-    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
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
 /** @file  src/decoder.h
- *  @brief Parent class for decoders of content.
+ *  @brief Decoder class.
  */
 
 #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 "video_source.h"
-#include "audio_source.h"
-#include "film.h"
+#include "types.h"
+#include "dcpomatic_time.h"
+#include <boost/utility.hpp>
 
-class Image;
-class Log;
-class DelayLine;
-class TimedSubtitle;
-class Subtitle;
-class FilterGraph;
+class Decoded;
+class VideoDecoder;
+class AudioDecoder;
+class SubtitleDecoder;
 
 /** @class Decoder.
  *  @brief Parent class for decoders of content.
  */
-class Decoder
+class Decoder : public boost::noncopyable
 {
 public:
-       Decoder (boost::shared_ptr<const Film>);
        virtual ~Decoder () {}
 
-       /** Perform one decode pass of the content, which may or may not
-        *  cause the object to emit some data.
-        */
-       virtual void pass () = 0;
-
-       /** Seek this decoder to as close as possible to some time,
-        *  expressed relative to our source's start.
-        *  @param t Time.
-        *  @param a true to try hard to be accurate, otherwise false.
-        */
-       virtual void seek (Time) = 0;
-
-       /** Seek back one video frame */
-       virtual void seek_back () = 0;
-
-       /** Seek forward one video frame */
-       virtual void seek_forward () = 0;
-
-       /** @return Approximate time of the next content that we will emit,
-        *  expressed relative to the start of our source.
+       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 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 Time next () const = 0;
-
-       virtual bool done () const = 0;
-
-protected:
-
-       /** 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) {}
+       virtual void seek (ContentTime time, bool accurate) = 0;
 
-       /** Connection to our Film */
-       boost::signals2::scoped_connection _film_connection;
+       /** @return true if this decoder has already returned all its data and will give no more */
+       virtual bool pass (PassReason, bool accurate) = 0;
 };
 
 #endif