No-op; fix GPL address and use the explicit-program-name version.
[dcpomatic.git] / src / lib / decoder.h
index d0e20b03af5de124a9d5057c267b1f35849e5e98..2a3b56c637be9f5135d1aa933369e077f7ea30a6 100644 (file)
 /*
-    Copyright (C) 2012 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 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 "types.h"
+#include "dcpomatic_time.h"
+#include <boost/utility.hpp>
 
-class Job;
-class Options;
-class Image;
-class Log;
-class DelayLine;
-class TimedSubtitle;
-class Subtitle;
-class Film;
-class FilterGraph;
+class Decoded;
+class VideoDecoder;
+class AudioDecoder;
+class SubtitleDecoder;
 
 /** @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 Options>, Job *);
-       virtual ~Decoder ();
-
-       /* Methods to query our input video */
-
-       /** @return video frames per second, or 0 if unknown */
-       virtual float frames_per_second () const = 0;
-       /** @return native size in pixels */
-       virtual Size native_size () const = 0;
-
-       virtual int time_base_numerator () const = 0;
-       virtual int time_base_denominator () const = 0;
-       virtual int sample_aspect_ratio_numerator () const = 0;
-       virtual int sample_aspect_ratio_denominator () const = 0;
-       
-       void process_begin ();
-       virtual bool pass () = 0;
-       void process_end ();
-       void go ();
-
-       SourceFrame video_frame () const {
-               return _video_frame;
-       }
-
-       virtual void set_audio_stream (boost::optional<AudioStream>);
-       virtual void set_subtitle_stream (boost::optional<SubtitleStream>);
-
-       boost::optional<AudioStream> audio_stream () const {
-               return _audio_stream;
-       }
-
-       boost::optional<SubtitleStream> subtitle_stream () const {
-               return _subtitle_stream;
-       }
-
-       std::vector<AudioStream> audio_streams () const {
-               return _audio_streams;
-       }
-       
-       std::vector<SubtitleStream> subtitle_streams () const {
-               return _subtitle_streams;
-       }
-
-       /** Emitted when a video frame is ready.
-        *  First parameter is the frame within the source.
-        *  Second parameter is its index within the content.
-        *  Third parameter is either 0 or a subtitle that should be on this frame.
+       virtual ~Decoder () {}
+
+       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.
         */
-       boost::signals2::signal<void (boost::shared_ptr<Image>, SourceFrame, boost::shared_ptr<Subtitle>)> Video;
-
-       /** Emitted when some audio data is ready */
-       boost::signals2::signal<void (boost::shared_ptr<AudioBuffers>, int64_t)> Audio;
-
-protected:
-       
-       virtual PixelFormat pixel_format () const = 0;
-       
-       void process_video (AVFrame *);
-       void process_audio (boost::shared_ptr<AudioBuffers>);
-       void process_subtitle (boost::shared_ptr<TimedSubtitle>);
-       void repeat_last_video ();
-
-       /** our Film */
-       boost::shared_ptr<Film> _film;
-       /** our options */
-       boost::shared_ptr<const Options> _opt;
-       /** associated Job, or 0 */
-       Job* _job;
-
-       boost::optional<AudioStream> _audio_stream;
-       boost::optional<SubtitleStream> _subtitle_stream;
-
-       std::vector<AudioStream> _audio_streams;
-       std::vector<SubtitleStream> _subtitle_streams;
-       
-private:
-       void emit_video (boost::shared_ptr<Image>, boost::shared_ptr<Subtitle>);
-       void emit_audio (boost::shared_ptr<AudioBuffers>);
-
-       SourceFrame _video_frame;
-       int64_t _audio_frame;
-
-       std::list<boost::shared_ptr<FilterGraph> > _filter_graphs;
-
-       DelayLine* _delay_line;
-       int _delay_in_frames;
-
-       boost::shared_ptr<TimedSubtitle> _timed_subtitle;
+       virtual void seek (ContentTime time, bool accurate) = 0;
 
-       boost::shared_ptr<Image> _last_image;
-       boost::shared_ptr<Subtitle> _last_subtitle;
+       /** @return true if this decoder has already returned all its data and will give no more */
+       virtual bool pass (PassReason, bool accurate) = 0;
 };
 
 #endif