2 Copyright (C) 2012-2013 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 /** @file src/decoder.h
21 * @brief Parent class for decoders of content.
24 #ifndef DCPOMATIC_DECODER_H
25 #define DCPOMATIC_DECODER_H
30 #include <boost/shared_ptr.hpp>
31 #include <boost/signals2.hpp>
32 #include "video_source.h"
33 #include "audio_source.h"
44 * @brief Parent class for decoders of content.
49 Decoder (boost::shared_ptr<const Film>);
50 virtual ~Decoder () {}
52 /** Perform one decode pass of the content, which may or may not
53 * cause the object to emit some data.
55 virtual void pass () = 0;
57 /** Seek this decoder to as close as possible to some time,
58 * expressed relative to our source's start.
60 * @param a true to try hard to be accurate, otherwise false.
62 virtual void seek (Time) = 0;
64 /** Seek back one video frame */
65 virtual void seek_back () = 0;
67 /** Seek forward one video frame */
68 virtual void seek_forward () = 0;
70 /** @return Approximate time of the next content that we will emit,
71 * expressed relative to the start of our source.
73 virtual Time next () const = 0;
77 /** The Film that we are decoding in */
78 boost::weak_ptr<const Film> _film;
81 /** This will be called when our Film emits Changed */
82 virtual void film_changed (Film::Property) {}
84 /** Connection to our Film */
85 boost::signals2::scoped_connection _film_connection;