src/lib/encoder.h

   1 /*
   2     Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #ifndef DCPOMATIC_ENCODER_H
  22 #define DCPOMATIC_ENCODER_H
  23
  24 /** @file  src/encoder.h
  25  *  @brief Encoder class.
  26  */
  27
  28 #include "util.h"
  29 #include "cross.h"
  30 #include "exception_store.h"
  31 #include <boost/shared_ptr.hpp>
  32 #include <boost/thread/mutex.hpp>
  33 #include <boost/thread/condition.hpp>
  34 #include <boost/thread.hpp>
  35 #include <boost/optional.hpp>
  36 #include <boost/signals2.hpp>
  37 #include <boost/enable_shared_from_this.hpp>
  38 #include <list>
  39 #include <stdint.h>
  40
  41 class Film;
  42 class EncodeServerDescription;
  43 class DCPVideo;
  44 class Writer;
  45 class Job;
  46 class PlayerVideo;
  47
  48 /** @class Encoder
  49  *  @brief Class to manage encoding to JPEG2000.
  50  *
  51  *  This class keeps a queue of frames to be encoded and distributes
  52  *  the work around threads and encoding servers.
  53  */
  54
  55 class Encoder : public boost::noncopyable, public ExceptionStore, public boost::enable_shared_from_this<Encoder>
  56 {
  57 public:
  58         Encoder (boost::shared_ptr<const Film>, boost::shared_ptr<Writer>);
  59         ~Encoder ();
  60
  61         /** Called to indicate that a processing run is about to begin */
  62         void begin ();
  63
  64         /** Called to pass a bit of video to be encoded as the next DCP frame */
  65         void encode (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_enqueued () const;
  72
  73         void servers_list_changed ();
  74
  75 private:
  76
  77         static void call_servers_list_changed (boost::weak_ptr<Encoder> encoder);
  78
  79         void frame_done ();
  80
  81         void encoder_thread (boost::optional<EncodeServerDescription>);
  82         void terminate_threads ();
  83
  84         /** Film that we are encoding */
  85         boost::shared_ptr<const Film> _film;
  86
  87         /** Mutex for _time_history */
  88         mutable boost::mutex _state_mutex;
  89         /** List of the times of completion of the last _history_size frames;
  90             first is the most recently completed.
  91         */
  92         std::list<struct timeval> _time_history;
  93         /** Number of frames that we should keep history for */
  94         static int const _history_size;
  95
  96         /** Mutex for _threads */
  97         mutable boost::mutex _threads_mutex;
  98         std::list<boost::thread *> _threads;
  99         mutable boost::mutex _queue_mutex;
 100         std::list<boost::shared_ptr<DCPVideo> > _queue;
 101         /** condition to manage thread wakeups when we have nothing to do */
 102         boost::condition _empty_condition;
 103         /** condition to manage thread wakeups when we have too much to do */
 104         boost::condition _full_condition;
 105
 106         boost::shared_ptr<Writer> _writer;
 107         Waker _waker;
 108
 109         boost::shared_ptr<PlayerVideo> _last_player_video;
 110
 111         boost::signals2::scoped_connection _server_found_connection;
 112 };
 113
 114 #endif