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 #include "exceptions.h"
  42
  43 class Image;
  44 class AudioBuffers;
  45 class Film;
  46 class ServerDescription;
  47 class DCPVideo;
  48 class EncodedData;
  49 class Writer;
  50 class Job;
  51 class ServerFinder;
  52 class PlayerVideo;
  53
  54 /** @class Encoder
  55  *  @brief Class to manage encoding to JPEG2000.
  56  *
  57  *  This class keeps a queue of frames to be encoded and distributes
  58  *  the work around threads and encoding servers.
  59  */
  60
  61 class Encoder : public boost::noncopyable, public ExceptionStore
  62 {
  63 public:
  64         Encoder (boost::shared_ptr<const Film> f, boost::weak_ptr<Job>, boost::shared_ptr<Writer>);
  65         virtual ~Encoder ();
  66
  67         /** Called to indicate that a processing run is about to begin */
  68         void begin ();
  69
  70         /** Call with a frame of video.
  71          *  @param f Video frame.
  72          */
  73         void enqueue (boost::shared_ptr<PlayerVideo> f);
  74
  75         /** Called when a processing run has finished */
  76         void 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 add_worker_threads (ServerDescription);
  88         void server_found (ServerDescription);
  89
  90         /** Film that we are encoding */
  91         boost::shared_ptr<const Film> _film;
  92         boost::weak_ptr<Job> _job;
  93
  94         /** Mutex for _time_history and _last_frame */
  95         mutable boost::mutex _state_mutex;
  96         /** List of the times of completion of the last _history_size frames;
  97             first is the most recently completed.
  98         */
  99         std::list<struct timeval> _time_history;
 100         /** Number of frames that we should keep history for */
 101         static int const _history_size;
 102
 103         /** Number of video frames written for the DCP so far */
 104         int _video_frames_out;
 105
 106         bool _terminate;
 107         std::list<boost::shared_ptr<DCPVideo> > _queue;
 108         std::list<boost::thread *> _threads;
 109         mutable boost::mutex _mutex;
 110         /** condition to manage thread wakeups when we have nothing to do */
 111         boost::condition _empty_condition;
 112         /** condition to manage thread wakeups when we have too much to do */
 113         boost::condition _full_condition;
 114
 115         boost::shared_ptr<Writer> _writer;
 116         Waker _waker;
 117 };
 118
 119 #endif