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>
43 * @brief Parent class for classes which can encode video and audio frames.
45 * Video is supplied to process_video as YUV frames, and audio
46 * is supplied as uncompressed PCM in blocks of various sizes.
48 * The subclass is expected to encode the video and/or audio in
49 * some way and write it to disk.
55 Encoder (boost::shared_ptr<const Film> f, boost::shared_ptr<const Options> o);
57 /** Called to indicate that a processing run is about to begin */
58 virtual void process_begin () {}
60 /** Call with a frame of video.
61 * @param i Video frame image.
62 * @param f Frame number within the film's source.
63 * @param s A subtitle that should be on this frame, or 0.
65 void process_video (boost::shared_ptr<const Image> i, SourceFrame f, boost::shared_ptr<Subtitle> s);
67 /** Call with some audio data */
68 void process_audio (boost::shared_ptr<const AudioBuffers>, int64_t);
70 /** Called when a processing run has finished */
71 virtual void process_end () {}
73 float current_frames_per_second () const;
74 bool skipping () const;
75 SourceFrame last_frame () const;
79 /** Called with a frame of video.
80 * @param i Video frame image.
81 * @param f Frame number within the film's source.
82 * @param s A subtitle that should be on this frame, or 0.
84 virtual void do_process_video (boost::shared_ptr<const Image> i, SourceFrame f, boost::shared_ptr<Subtitle> s) = 0;
86 /** Called with some audio data */
87 virtual void do_process_audio (boost::shared_ptr<const AudioBuffers>) = 0;
89 void frame_done (SourceFrame n);
90 void frame_skipped ();
92 /** Film that we are encoding */
93 boost::shared_ptr<const Film> _film;
95 boost::shared_ptr<const Options> _opt;
97 /** Mutex for _time_history, _just_skipped and _last_frame */
98 mutable boost::mutex _history_mutex;
99 /** List of the times of completion of the last _history_size frames;
100 first is the most recently completed.
102 std::list<struct timeval> _time_history;
103 /** Number of frames that we should keep history for */
104 static int const _history_size;
105 /** true if the last frame we processed was skipped (because it was already done) */
107 /** Source index of the last frame to be processed */
108 SourceFrame _last_frame;