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 #include "config.h"
  40
  41 class Image;
  42 class AudioBuffers;
  43 class Film;
  44 class ServerDescription;
  45 class DCPVideoFrame;
  46 class EncodedData;
  47 class Writer;
  48 class Job;
  49
  50 /** @class Encoder
  51  *  @brief Encoder to J2K and WAV for DCP.
  52  *
  53  *  Video is supplied to process_video as RGB frames, and audio
  54  *  is supplied as uncompressed PCM in blocks of various sizes.
  55  */
  56
  57 class Encoder : public boost::noncopyable
  58 {
  59 public:
  60         Encoder (boost::shared_ptr<const Film> f, boost::shared_ptr<Job>);
  61         virtual ~Encoder ();
  62
  63         /** Called to indicate that a processing run is about to begin */
  64         void process_begin ();
  65
  66         /** Call with a frame of video.
  67          *  @param i Video frame image.
  68          *  @param same true if i is the same as the last time we were called.
  69          */
  70         void process_video (boost::shared_ptr<const Image> i, Eyes eyes, ColourConversion, bool same);
  71
  72         /** Call with some audio data */
  73         void process_audio (boost::shared_ptr<const AudioBuffers>);
  74
  75         /** Called when a processing run has finished */
  76         void process_end ();
  77
  78         float current_encoding_rate () const;
  79         int video_frames_out () const;
  80
  81 private:
  82
  83         void frame_done ();
  84
  85         void encoder_thread (boost::optional<ServerDescription>);
  86         void terminate_threads ();
  87         void broadcast_thread ();
  88         void listen_thread ();
  89         void add_worker_threads (ServerDescription);
  90
  91         /** Film that we are encoding */
  92         boost::shared_ptr<const Film> _film;
  93         boost::shared_ptr<Job> _job;
  94
  95         /** Mutex for _time_history and _last_frame */
  96         mutable boost::mutex _state_mutex;
  97         /** List of the times of completion of the last _history_size frames;
  98             first is the most recently completed.
  99         */
 100         std::list<struct timeval> _time_history;
 101         /** Number of frames that we should keep history for */
 102         static int const _history_size;
 103
 104         /** Number of video frames written for the DCP so far */
 105         int _video_frames_out;
 106
 107         bool _have_a_real_frame[EYES_COUNT];
 108         bool _terminate;
 109         std::list<boost::shared_ptr<DCPVideoFrame> > _queue;
 110         typedef std::list<std::pair<boost::optional<ServerDescription>, boost::thread *> > ThreadList;
 111         ThreadList _threads;
 112         mutable boost::mutex _mutex;
 113         boost::condition _condition;
 114
 115         boost::shared_ptr<Writer> _writer;
 116
 117         /** A thread to periodically issue broadcasts to find encoding servers */
 118         boost::thread* _broadcast_thread;
 119         boost::thread* _listen_thread;
 120 };
 121
 122 #endif