src/lib/j2k_encoder.h

   1 /*
   2     Copyright (C) 2012-2021 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
  22 #ifndef DCPOMATIC_J2K_ENCODER_H
  23 #define DCPOMATIC_J2K_ENCODER_H
  24
  25
  26 /** @file  src/j2k_encoder.h
  27  *  @brief J2KEncoder class.
  28  */
  29
  30
  31 #include "cross.h"
  32 #include "enum_indexed_vector.h"
  33 #include "event_history.h"
  34 #include "exception_store.h"
  35 #include "util.h"
  36 #include <boost/optional.hpp>
  37 #include <boost/signals2.hpp>
  38 #include <boost/thread.hpp>
  39 #include <boost/thread/condition.hpp>
  40 #include <boost/thread/mutex.hpp>
  41 #include <list>
  42 #include <stdint.h>
  43
  44
  45 class DCPVideo;
  46 class EncodeServerDescription;
  47 class Film;
  48 class Job;
  49 class PlayerVideo;
  50 class Writer;
  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 class J2KEncoder : public ExceptionStore, public std::enable_shared_from_this<J2KEncoder>
  60 {
  61 public:
  62         J2KEncoder (std::shared_ptr<const Film> film, std::shared_ptr<Writer> writer);
  63         ~J2KEncoder ();
  64
  65         J2KEncoder (J2KEncoder const&) = delete;
  66         J2KEncoder& operator= (J2KEncoder const&) = delete;
  67
  68         /** Called to indicate that a processing run is about to begin */
  69         void begin ();
  70
  71         /** Called to pass a bit of video to be encoded as the next DCP frame */
  72         void encode (std::shared_ptr<PlayerVideo> pv, dcpomatic::DCPTime time);
  73
  74         /** Called when a processing run has finished */
  75         void end ();
  76
  77         boost::optional<float> current_encoding_rate () const;
  78         int video_frames_enqueued () const;
  79
  80         void servers_list_changed ();
  81
  82 private:
  83
  84         static void call_servers_list_changed (std::weak_ptr<J2KEncoder> encoder);
  85
  86         void frame_done ();
  87
  88         void encoder_thread (boost::optional<EncodeServerDescription>);
  89         void terminate_threads ();
  90
  91         /** Film that we are encoding */
  92         std::shared_ptr<const Film> _film;
  93
  94         EventHistory _history;
  95
  96         boost::mutex _threads_mutex;
  97         std::shared_ptr<boost::thread_group> _threads;
  98
  99         mutable boost::mutex _queue_mutex;
 100         std::list<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         std::shared_ptr<Writer> _writer;
 107         Waker _waker;
 108
 109         EnumIndexedVector<std::shared_ptr<PlayerVideo>, Eyes> _last_player_video;
 110         boost::optional<dcpomatic::DCPTime> _last_player_video_time;
 111
 112         boost::signals2::scoped_connection _server_found_connection;
 113 };
 114
 115
 116 #endif