src/lib/j2k_encoder.h

   1 /*
   2     Copyright (C) 2012-2020 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_J2K_ENCODER_H
  22 #define DCPOMATIC_J2K_ENCODER_H
  23
  24 /** @file  src/j2k_encoder.h
  25  *  @brief J2KEncoder class.
  26  */
  27
  28 #include "util.h"
  29 #include "cross.h"
  30 #include "event_history.h"
  31 #include "exception_store.h"
  32 #include <boost/shared_ptr.hpp>
  33 #include <boost/thread/mutex.hpp>
  34 #include <boost/thread/condition.hpp>
  35 #include <boost/thread.hpp>
  36 #include <boost/optional.hpp>
  37 #include <boost/signals2.hpp>
  38 #include <boost/enable_shared_from_this.hpp>
  39 #include <list>
  40 #include <stdint.h>
  41
  42 class Film;
  43 class EncodeServerDescription;
  44 class DCPVideo;
  45 class Writer;
  46 class Job;
  47 class PlayerVideo;
  48 class J2KEncoderBackend;
  49 class J2KEncoderCPUBackend;
  50 class J2KEncoderRemoteBackend;
  51
  52
  53 /** @class J2KEncoder
  54  *  @brief Class to manage encoding to J2K.
  55  *
  56  *  This class keeps a queue of frames to be encoded and distributes
  57  *  the work around threads and encoding servers.
  58  */
  59
  60 class J2KEncoder : public boost::noncopyable, public ExceptionStore, public boost::enable_shared_from_this<J2KEncoder>
  61 {
  62 public:
  63         J2KEncoder (boost::shared_ptr<const Film> film, boost::shared_ptr<Writer> writer);
  64         ~J2KEncoder ();
  65
  66         /** Called to indicate that a processing run is about to begin */
  67         void begin ();
  68
  69         /** Called to pass a bit of video to be encoded as the next DCP frame */
  70         void encode (boost::shared_ptr<PlayerVideo> pv, dcpomatic::DCPTime time);
  71
  72         /** Called when a processing run has finished */
  73         void end ();
  74
  75         boost::optional<float> current_encoding_rate () const;
  76         int video_frames_enqueued () const;
  77
  78         void servers_list_changed ();
  79
  80 private:
  81
  82         static void call_servers_list_changed (boost::weak_ptr<J2KEncoder> encoder);
  83
  84         void frames_done (int number);
  85
  86         void encoder_thread (boost::shared_ptr<J2KEncoderBackend> backend);
  87         void terminate_threads ();
  88
  89         boost::shared_ptr<const Film> _film;
  90
  91         EventHistory _history;
  92
  93         boost::shared_ptr<boost::thread_group> _threads;
  94
  95         boost::shared_ptr<J2KEncoderCPUBackend> _cpu_backend;
  96
  97         mutable boost::mutex _queue_mutex;
  98         std::list<boost::shared_ptr<DCPVideo> > _queue;
  99         /** condition to manage thread wakeups when we have nothing to do */
 100         boost::condition _empty_condition;
 101         /** condition to manage thread wakeups when we have too much to do */
 102         boost::condition _full_condition;
 103
 104         boost::shared_ptr<Writer> _writer;
 105         Waker _waker;
 106
 107         boost::shared_ptr<PlayerVideo> _last_player_video[EYES_COUNT];
 108         boost::optional<dcpomatic::DCPTime> _last_player_video_time;
 109
 110         boost::signals2::scoped_connection _server_found_connection;
 111 };
 112
 113 #endif