/*
- 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
-
-#include <vector>
-#include <string>
-#include <stdint.h>
-#include <boost/shared_ptr.hpp>
-#include <boost/signals2.hpp>
-#include "util.h"
-#include "stream.h"
-
-class Job;
-class Options;
-class Image;
-class Log;
-class DelayLine;
-class TimedSubtitle;
-class Subtitle;
-class Film;
-class FilterGraph;
+#ifndef DCPOMATIC_DECODER_H
+#define DCPOMATIC_DECODER_H
+
+#include "types.h"
+#include "dcpomatic_time.h"
+#include <boost/utility.hpp>
+
+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 *, bool, bool);
- 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;
- /** @return number of audio channels */
- virtual int audio_channels () const = 0;
- /** @return audio sampling rate in Hz */
- virtual int audio_sample_rate () const = 0;
- /** @return format of audio samples */
- virtual AVSampleFormat audio_sample_format () const = 0;
- virtual int64_t audio_channel_layout () const = 0;
- virtual bool has_subtitles () 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 ();
- bool pass ();
- void process_end ();
- void go ();
-
- /** @return the index of the last video frame to be processed */
- int video_frame_index () const {
- return _video_frame_index;
- }
-
- virtual std::vector<AudioStream> audio_streams () const {
- return std::vector<AudioStream> ();
- }
-
- virtual std::vector<SubtitleStream> subtitle_streams () const {
- return std::vector<SubtitleStream> ();
- }
-
- /** Emitted when a video frame is ready.
- * First parameter is the frame.
- * Second parameter is its index within the content.
- * Third parameter is either 0 or a subtitle that should be on this frame.
- */
- boost::signals2::signal<void (boost::shared_ptr<Image>, int, boost::shared_ptr<Subtitle>)> Video;
-
- /** Emitted when some audio data is ready */
- boost::signals2::signal<void (boost::shared_ptr<AudioBuffers>)> Audio;
-
-protected:
-
- /** perform a single pass at our content */
- virtual bool do_pass () = 0;
- virtual PixelFormat pixel_format () const = 0;
-
- void process_video (AVFrame *);
- void process_audio (uint8_t *, int);
- void process_subtitle (boost::shared_ptr<TimedSubtitle>);
- void repeat_last_video ();
-
- int bytes_per_audio_sample () const;
-
- /** our Film */
- boost::shared_ptr<Film> _film;
- /** our options */
- boost::shared_ptr<const Options> _opt;
- /** associated Job, or 0 */
- Job* _job;
-
- /** true to do the bare minimum of work; just run through the content. Useful for acquiring
- * accurate frame counts as quickly as possible. This generates no video or audio output.
+ 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.
*/
- bool _minimal;
-
- /** ignore_length Ignore the content's claimed length when computing progress */
- bool _ignore_length;
+ virtual void seek (ContentTime time, bool accurate) = 0;
-private:
- void emit_audio (uint8_t* data, int size);
-
- /** last video frame to be processed */
- int _video_frame_index;
+ /** @return true if this decoder has already returned all its data and will give no more */
+ virtual bool pass (PassReason, bool accurate) = 0;
- std::list<boost::shared_ptr<FilterGraph> > _filter_graphs;
-
- DelayLine* _delay_line;
- int _delay_in_bytes;
-
- /* Number of audio frames that we have pushed to the encoder
- (at the DCP sample rate).
- */
- int64_t _audio_frames_processed;
-
- boost::shared_ptr<TimedSubtitle> _timed_subtitle;
-
- boost::shared_ptr<Image> _last_image;
- boost::shared_ptr<Subtitle> _last_subtitle;
+ /** Ensure that any future get() calls return data that reflect
+ * changes in our content's settings.
+ */
+ virtual void reset () {}
};
#endif