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 DCPOMATIC_ENCODER_H
  21 #define DCPOMATIC_ENCODER_H
  22
  23 /** @file src/encoder.h
  24  *  @brief Encoder to J2K and WAV for DCP.
  25  */
  26
  27 #include <boost/shared_ptr.hpp>
  28 #include <boost/thread/mutex.hpp>
  29 #include <boost/thread/condition.hpp>
  30 #include <boost/thread.hpp>
  31 #include <boost/optional.hpp>
  32 #include <list>
  33 #include <stdint.h>
  34 extern "C" {
  35 #include <libavutil/samplefmt.h>
  36 #include <libswresample/swresample.h>
  37 }
  38 #include "util.h"
  39
  40 class Image;
  41 class AudioBuffers;
  42 class Film;
  43 class ServerDescription;
  44 class DCPVideoFrame;
  45 class EncodedData;
  46 class Writer;
  47 class Job;
  48
  49 /** @class Encoder
  50  *  @brief Encoder to J2K and WAV for DCP.
  51  *
  52  *  Video is supplied to process_video as RGB frames, and audio
  53  *  is supplied as uncompressed PCM in blocks of various sizes.
  54  */
  55
  56 class Encoder : public boost::noncopyable
  57 {
  58 public:
  59         Encoder (boost::shared_ptr<const Film> f, boost::shared_ptr<Job>);
  60         virtual ~Encoder ();
  61
  62         /** Called to indicate that a processing run is about to begin */
  63         void process_begin ();
  64
  65         /** Call with a frame of video.
  66          *  @param i Video frame image.
  67          *  @param same true if i is the same as the last time we were called.
  68          */
  69         void process_video (boost::shared_ptr<const Image> i, bool same);
  70
  71         /** Call with some audio data */
  72         void process_audio (boost::shared_ptr<const AudioBuffers>);
  73
  74         /** Called when a processing run has finished */
  75         void process_end ();
  76
  77         float current_encoding_rate () const;
  78         int video_frames_out () const;
  79
  80 private:
  81
  82         void frame_done ();
  83
  84         void encoder_thread (ServerDescription *);
  85         void terminate_threads ();
  86
  87         /** Film that we are encoding */
  88         boost::shared_ptr<const Film> _film;
  89         boost::shared_ptr<Job> _job;
  90
  91         /** Mutex for _time_history and _last_frame */
  92         mutable boost::mutex _history_mutex;
  93         /** List of the times of completion of the last _history_size frames;
  94             first is the most recently completed.
  95         */
  96         std::list<struct timeval> _time_history;
  97         /** Number of frames that we should keep history for */
  98         static int const _history_size;
  99
 100         /** Number of video frames written for the DCP so far */
 101         int _video_frames_out;
 102
 103         bool _have_a_real_frame;
 104         bool _terminate;
 105         std::list<boost::shared_ptr<DCPVideoFrame> > _queue;
 106         std::list<boost::thread *> _threads;
 107         mutable boost::mutex _mutex;
 108         boost::condition _condition;
 109
 110         boost::shared_ptr<Writer> _writer;
 111 };
 112
 113 #endif