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 #ifdef DCPOMATIC_GROK
  36 #include "grok/context.h"
  37 #endif
  38 #include "j2k_encoder_thread.h"
  39 #include "writer.h"
  40 #include <boost/optional.hpp>
  41 #include <boost/signals2.hpp>
  42 #include <boost/thread.hpp>
  43 #include <boost/thread/condition.hpp>
  44 #include <boost/thread/mutex.hpp>
  45 #include <list>
  46 #include <stdint.h>
  47
  48
  49 class DCPVideo;
  50 class EncodeServerDescription;
  51 class Film;
  52 class Job;
  53 class PlayerVideo;
  54
  55 struct local_threads_created_and_destroyed;
  56 struct remote_threads_created_and_destroyed;
  57 struct frames_not_lost_when_threads_disappear;
  58
  59
  60 /** @class J2KEncoder
  61  *  @brief Class to manage encoding to J2K.
  62  *
  63  *  This class keeps a queue of frames to be encoded and distributes
  64  *  the work around threads and encoding servers.
  65  */
  66 class J2KEncoder : public ExceptionStore
  67 {
  68 public:
  69         J2KEncoder(std::shared_ptr<const Film> film, Writer& writer);
  70         ~J2KEncoder ();
  71
  72         J2KEncoder (J2KEncoder const&) = delete;
  73         J2KEncoder& operator= (J2KEncoder const&) = delete;
  74
  75         /** Called to indicate that a processing run is about to begin */
  76         void begin ();
  77
  78         /** Called to pass a bit of video to be encoded as the next DCP frame */
  79         void encode (std::shared_ptr<PlayerVideo> pv, dcpomatic::DCPTime time);
  80
  81         void pause();
  82         void resume();
  83
  84         /** Called when a processing run has finished */
  85         void end();
  86
  87         boost::optional<float> current_encoding_rate () const;
  88         int video_frames_enqueued () const;
  89
  90         DCPVideo pop();
  91         void retry(DCPVideo frame);
  92         void write(std::shared_ptr<const dcp::Data> data, int index, Eyes eyes);
  93
  94 private:
  95         friend struct ::local_threads_created_and_destroyed;
  96         friend struct ::remote_threads_created_and_destroyed;
  97         friend struct ::frames_not_lost_when_threads_disappear;
  98
  99         void frame_done ();
 100         void servers_list_changed ();
 101         void remake_threads(int cpu, int gpu, std::list<EncodeServerDescription> servers);
 102         void terminate_threads ();
 103
 104         /** Film that we are encoding */
 105         std::shared_ptr<const Film> _film;
 106
 107         EventHistory _history;
 108
 109         boost::mutex _threads_mutex;
 110         std::vector<std::shared_ptr<J2KEncoderThread>> _threads;
 111
 112         mutable boost::mutex _queue_mutex;
 113         std::list<DCPVideo> _queue;
 114         /** condition to manage thread wakeups when we have nothing to do */
 115         boost::condition _empty_condition;
 116         /** condition to manage thread wakeups when we have too much to do */
 117         boost::condition _full_condition;
 118
 119         Writer& _writer;
 120         Waker _waker;
 121
 122         EnumIndexedVector<std::shared_ptr<PlayerVideo>, Eyes> _last_player_video;
 123         boost::optional<dcpomatic::DCPTime> _last_player_video_time;
 124
 125         boost::signals2::scoped_connection _server_found_connection;
 126
 127 #ifdef DCPOMATIC_GROK
 128         grk_plugin::DcpomaticContext _dcpomatic_context;
 129         grk_plugin::GrokContext *_context;
 130 #endif
 131
 132         bool _ending = false;
 133 };
 134
 135
 136 #endif