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 #ifdef HAVE_SWRESAMPLE
  35 extern "C" {
  36 #include <libswresample/swresample.h>
  37 }
  38 #endif
  39 #include <sndfile.h>
  40 #include "util.h"
  41 #include "video_sink.h"
  42 #include "audio_sink.h"
  43
  44 class EncodeOptions;
  45 class Image;
  46 class Subtitle;
  47 class AudioBuffers;
  48 class Film;
  49
  50 /** @class Encoder
  51  *  @brief Parent class for classes which can encode video and audio frames.
  52  *
  53  *  Video is supplied to process_video as YUV frames, and audio
  54  *  is supplied as uncompressed PCM in blocks of various sizes.
  55  *
  56  *  The subclass is expected to encode the video and/or audio in
  57  *  some way and write it to disk.
  58  */
  59
  60 class Encoder : public VideoSink, public AudioSink
  61 {
  62 public:
  63         Encoder (boost::shared_ptr<const Film> f, boost::shared_ptr<const EncodeOptions> o);
  64         virtual ~Encoder ();
  65
  66         /** Called to indicate that a processing run is about to begin */
  67         virtual void process_begin ();
  68
  69         /** Call with a frame of video.
  70          *  @param i Video frame image.
  71          *  @param s A subtitle that should be on this frame, or 0.
  72          */
  73         void process_video (boost::shared_ptr<Image> i, boost::shared_ptr<Subtitle> s);
  74
  75         /** Call with some audio data */
  76         void process_audio (boost::shared_ptr<AudioBuffers>);
  77
  78         /** Called when a processing run has finished */
  79         virtual void process_end ();
  80
  81         float current_frames_per_second () const;
  82         bool skipping () const;
  83         SourceFrame video_frame () const;
  84
  85 protected:
  86
  87         /** Called with a frame of video.
  88          *  @param i Video frame image.
  89          *  @param s A subtitle that should be on this frame, or 0.
  90          */
  91         virtual void do_process_video (boost::shared_ptr<Image> i, boost::shared_ptr<Subtitle> s) = 0;
  92
  93         void frame_done ();
  94         void frame_skipped ();
  95
  96         /** Film that we are encoding */
  97         boost::shared_ptr<const Film> _film;
  98         /** Options */
  99         boost::shared_ptr<const EncodeOptions> _opt;
 100
 101         /** Mutex for _time_history, _just_skipped and _last_frame */
 102         mutable boost::mutex _history_mutex;
 103         /** List of the times of completion of the last _history_size frames;
 104             first is the most recently completed.
 105         */
 106         std::list<struct timeval> _time_history;
 107         /** Number of frames that we should keep history for */
 108         static int const _history_size;
 109         /** true if the last frame we processed was skipped (because it was already done) */
 110         bool _just_skipped;
 111
 112         /** Number of video frames received so far */
 113         SourceFrame _video_frame;
 114         /** Number of audio frames received so far */
 115         int64_t _audio_frame;
 116
 117 private:
 118         void close_sound_files ();
 119         void write_audio (boost::shared_ptr<const AudioBuffers> audio);
 120
 121 #if HAVE_SWRESAMPLE
 122         SwrContext* _swr_context;
 123 #endif
 124
 125         std::vector<SNDFILE*> _sound_files;
 126         int64_t _audio_frames_written;
 127 };
 128
 129 #endif