src/lib/encoder.h

   1 /*
   2     Copyright (C) 2012-2015 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 class.
  25  */
  26
  27 #include "util.h"
  28 #include "cross.h"
  29 #include "exception_store.h"
  30 #include <boost/shared_ptr.hpp>
  31 #include <boost/thread/mutex.hpp>
  32 #include <boost/thread/condition.hpp>
  33 #include <boost/thread.hpp>
  34 #include <boost/optional.hpp>
  35 #include <boost/signals2.hpp>
  36 #include <list>
  37 #include <stdint.h>
  38
  39 class Film;
  40 class ServerDescription;
  41 class DCPVideo;
  42 class Writer;
  43 class Job;
  44 class PlayerVideo;
  45
  46 /** @class Encoder
  47  *  @brief Class to manage encoding to JPEG2000.
  48  *
  49  *  This class keeps a queue of frames to be encoded and distributes
  50  *  the work around threads and encoding servers.
  51  */
  52
  53 class Encoder : public boost::noncopyable, public ExceptionStore
  54 {
  55 public:
  56         Encoder (boost::shared_ptr<const Film>, boost::weak_ptr<Job>, boost::shared_ptr<Writer>);
  57         virtual ~Encoder ();
  58
  59         /** Called to indicate that a processing run is about to begin */
  60         void begin ();
  61
  62         /** Call with a frame of video.
  63          *  @param f Video frame.
  64          */
  65         void enqueue (boost::shared_ptr<PlayerVideo> f);
  66
  67         /** Called when a processing run has finished */
  68         void end ();
  69
  70         float current_encoding_rate () const;
  71         int video_frames_out () const;
  72
  73 private:
  74
  75         void frame_done ();
  76
  77         void encoder_thread (boost::optional<ServerDescription>);
  78         void terminate_threads ();
  79         void servers_list_changed ();
  80
  81         /** Film that we are encoding */
  82         boost::shared_ptr<const Film> _film;
  83         boost::weak_ptr<Job> _job;
  84
  85         /** Mutex for _time_history and _video_frames_enqueued */
  86         mutable boost::mutex _state_mutex;
  87         /** List of the times of completion of the last _history_size frames;
  88             first is the most recently completed.
  89         */
  90         std::list<struct timeval> _time_history;
  91         /** Number of frames that we should keep history for */
  92         static int const _history_size;
  93         /** Number of video frames enqueued so far */
  94         int _video_frames_enqueued;
  95         bool _left_done;
  96         bool _right_done;
  97
  98         /* XXX: probably should be atomic */
  99         bool _terminate_enqueue;
 100         bool _terminate_encoding;
 101         /** Mutex for _threads */
 102         mutable boost::mutex _threads_mutex;
 103         std::list<boost::thread *> _threads;
 104         mutable boost::mutex _queue_mutex;
 105         std::list<boost::shared_ptr<DCPVideo> > _queue;
 106         /** condition to manage thread wakeups when we have nothing to do */
 107         boost::condition _empty_condition;
 108         /** condition to manage thread wakeups when we have too much to do */
 109         boost::condition _full_condition;
 110
 111         boost::shared_ptr<Writer> _writer;
 112         Waker _waker;
 113
 114         boost::shared_ptr<PlayerVideo> _last_player_video;
 115
 116         boost::signals2::scoped_connection _server_found_connection;
 117 };
 118
 119 #endif