src/lib/encoder.h

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