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