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 "j2k_encoder_thread.h"
  36 #include "writer.h"
  37 #include "video_encoder.h"
  38 #include <boost/optional.hpp>
  39 #include <boost/signals2.hpp>
  40 #include <boost/thread.hpp>
  41 #include <boost/thread/condition.hpp>
  42 #include <boost/thread/mutex.hpp>
  43 #include <list>
  44 #include <stdint.h>
  45
  46
  47 class DCPVideo;
  48 class EncodeServerDescription;
  49 class Film;
  50 class Job;
  51 class PlayerVideo;
  52
  53 namespace grk_plugin {
  54         struct DcpomaticContext;
  55         struct GrokContext;
  56 }
  57
  58 struct local_threads_created_and_destroyed;
  59 struct remote_threads_created_and_destroyed;
  60 struct frames_not_lost_when_threads_disappear;
  61
  62
  63 /** @class J2KEncoder
  64  *  @brief Class to manage encoding to J2K.
  65  *
  66  *  This class keeps a queue of frames to be encoded and distributes
  67  *  the work around threads and encoding servers.
  68  */
  69 class J2KEncoder : public VideoEncoder, public ExceptionStore
  70 {
  71 public:
  72         J2KEncoder(std::shared_ptr<const Film> film, Writer& writer);
  73         ~J2KEncoder ();
  74
  75         J2KEncoder (J2KEncoder const&) = delete;
  76         J2KEncoder& operator= (J2KEncoder const&) = delete;
  77
  78         /** Called to indicate that a processing run is about to begin */
  79         void begin() override;
  80
  81         /** Called to pass a bit of video to be encoded as the next DCP frame */
  82         void encode (std::shared_ptr<PlayerVideo> pv, dcpomatic::DCPTime time) override;
  83
  84         void pause() override;
  85         void resume() override;
  86
  87         /** Called when a processing run has finished */
  88         void end() override;
  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         boost::mutex _threads_mutex;
 105         std::vector<std::shared_ptr<J2KEncoderThread>> _threads;
 106
 107         mutable boost::mutex _queue_mutex;
 108         std::list<DCPVideo> _queue;
 109         /** condition to manage thread wakeups when we have nothing to do */
 110         boost::condition _empty_condition;
 111         /** condition to manage thread wakeups when we have too much to do */
 112         boost::condition _full_condition;
 113
 114         Waker _waker;
 115
 116         EnumIndexedVector<std::shared_ptr<PlayerVideo>, Eyes> _last_player_video;
 117
 118         boost::signals2::scoped_connection _server_found_connection;
 119
 120 #ifdef DCPOMATIC_GROK
 121         grk_plugin::DcpomaticContext* _dcpomatic_context = nullptr;
 122         grk_plugin::GrokContext *_context = nullptr;
 123 #endif
 124
 125         bool _ending = false;
 126 };
 127
 128
 129 #endif