src/lib/encoder.h

   1 /*
   2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19
  20 #ifndef DVDOMATIC_ENCODER_H
  21 #define DVDOMATIC_ENCODER_H
  22
  23 /** @file src/encoder.h
  24  *  @brief Parent class for classes which can encode video and audio frames.
  25  */
  26
  27 #include <boost/shared_ptr.hpp>
  28 #include <boost/thread/mutex.hpp>
  29 #include <list>
  30 #include <stdint.h>
  31 extern "C" {
  32 #include <libavutil/samplefmt.h>
  33 }
  34 #include "util.h"
  35 #include "video_sink.h"
  36 #include "audio_sink.h"
  37
  38 class Options;
  39 class Image;
  40 class Subtitle;
  41 class AudioBuffers;
  42 class Film;
  43
  44 /** @class Encoder
  45  *  @brief Parent class for classes which can encode video and audio frames.
  46  *
  47  *  Video is supplied to process_video as YUV frames, and audio
  48  *  is supplied as uncompressed PCM in blocks of various sizes.
  49  *
  50  *  The subclass is expected to encode the video and/or audio in
  51  *  some way and write it to disk.
  52  */
  53
  54 class Encoder : public VideoSink, public AudioSink
  55 {
  56 public:
  57         Encoder (boost::shared_ptr<const Film> f, boost::shared_ptr<const Options> o);
  58
  59         /** Called to indicate that a processing run is about to begin */
  60         virtual void process_begin () {}
  61
  62         /** Call with a frame of video.
  63          *  @param i Video frame image.
  64          *  @param s A subtitle that should be on this frame, or 0.
  65          */
  66         void process_video (boost::shared_ptr<Image> i, boost::shared_ptr<Subtitle> s);
  67
  68         /** Call with some audio data */
  69         void process_audio (boost::shared_ptr<AudioBuffers>);
  70
  71         /** Called when a processing run has finished */
  72         virtual void process_end () {}
  73
  74         float current_frames_per_second () const;
  75         bool skipping () const;
  76         SourceFrame video_frame () const;
  77
  78 protected:
  79
  80         /** Called with a frame of video.
  81          *  @param i Video frame image.
  82          *  @param s A subtitle that should be on this frame, or 0.
  83          */
  84         virtual void do_process_video (boost::shared_ptr<Image> i, boost::shared_ptr<Subtitle> s) = 0;
  85
  86         /** Called with some audio data */
  87         virtual void do_process_audio (boost::shared_ptr<AudioBuffers>) = 0;
  88
  89         void frame_done ();
  90         void frame_skipped ();
  91
  92         /** Film that we are encoding */
  93         boost::shared_ptr<const Film> _film;
  94         /** Options */
  95         boost::shared_ptr<const Options> _opt;
  96
  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.
 101         */
 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) */
 106         bool _just_skipped;
 107
 108         /** Number of video frames received so far */
 109         SourceFrame _video_frame;
 110         /** Number of audio frames received so far */
 111         int64_t _audio_frame;
 112 };
 113
 114 #endif