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>
32 #include <libavutil/samplefmt.h>
42 * @brief Parent class for classes which can encode video and audio frames.
44 * Video is supplied to process_video as YUV frames, and audio
45 * is supplied as uncompressed PCM in blocks of various sizes.
47 * The subclass is expected to encode the video and/or audio in
48 * some way and write it to disk.
54 Encoder (boost::shared_ptr<const Film> f, boost::shared_ptr<const Options> o);
56 /** Called to indicate that a processing run is about to begin */
57 virtual void process_begin (int64_t audio_channel_layout) = 0;
59 /** Called with a frame of video.
60 * @param i Video frame image.
61 * @param f Frame number within the film.
62 * @param s A subtitle that should be on this frame, or 0.
64 virtual void process_video (boost::shared_ptr<Image> i, int f, boost::shared_ptr<Subtitle> s) = 0;
66 /** Called with some audio data.
67 * @param d Array of pointers to floating point sample data for each channel.
68 * @param s Number of frames (ie number of samples in each channel)
70 virtual void process_audio (boost::shared_ptr<const AudioBuffers>) = 0;
72 /** Called when a processing run has finished */
73 virtual void process_end () = 0;
75 float current_frames_per_second () const;
76 bool skipping () const;
77 int last_frame () const;
80 void frame_done (int n);
81 void frame_skipped ();
83 /** Film that we are encoding */
84 boost::shared_ptr<const Film> _film;
86 boost::shared_ptr<const Options> _opt;
88 /** Mutex for _time_history, _just_skipped and _last_frame */
89 mutable boost::mutex _history_mutex;
90 /** List of the times of completion of the last _history_size frames;
91 first is the most recently completed.
93 std::list<struct timeval> _time_history;
94 /** Number of frames that we should keep history for */
95 static int const _history_size;
96 /** true if the last frame we processed was skipped (because it was already done) */
98 /** Index of the last frame to be processed */