2 Copyright (C) 2012 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 #ifndef DVDOMATIC_ENCODER_H
21 #define DVDOMATIC_ENCODER_H
23 /** @file src/encoder.h
24 * @brief Parent class for classes which can encode video and audio frames.
27 #include <boost/shared_ptr.hpp>
28 #include <boost/thread/mutex.hpp>
38 * @brief Parent class for classes which can encode video and audio frames.
40 * Video is supplied to process_video as YUV frames, and audio
41 * is supplied as uncompressed PCM in blocks of various sizes.
43 * The subclass is expected to encode the video and/or audio in
44 * some way and write it to disk.
50 Encoder (boost::shared_ptr<const FilmState> s, boost::shared_ptr<const Options> o, Log* l);
52 /** Called to indicate that a processing run is about to begin */
53 virtual void process_begin () = 0;
55 /** Called with a frame of video.
56 * @param i Video frame image.
57 * @param f Frame number within the film.
59 virtual void process_video (boost::shared_ptr<Image> i, int f) = 0;
61 /** Called with some audio data.
63 * @param s Size of data (in bytes)
65 virtual void process_audio (uint8_t* d, int s) = 0;
67 /** Called when a processing run has finished */
68 virtual void process_end () = 0;
70 float current_frames_per_second () const;
75 /** FilmState of the film that we are encoding */
76 boost::shared_ptr<const FilmState> _fs;
78 boost::shared_ptr<const Options> _opt;
82 mutable boost::mutex _history_mutex;
83 std::list<struct timeval> _time_history;
84 static int const _history_size;