src/lib/j2k_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_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/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 <list>
  38 #include <stdint.h>
  39
  40 class Film;
  41 class EncodeServerDescription;
  42 class DCPVideo;
  43 class Writer;
  44 class Job;
  45 class PlayerVideo;
  46
  47 /** @class J2KEncoder
  48  *  @brief Class to manage encoding to J2K.
  49  *
  50  *  This class keeps a queue of frames to be encoded and distributes
  51  *  the work around threads and encoding servers.
  52  */
  53
  54 class J2KEncoder : public boost::noncopyable, public ExceptionStore, public std::enable_shared_from_this<J2KEncoder>
  55 {
  56 public:
  57         J2KEncoder (std::shared_ptr<const Film> film, std::shared_ptr<Writer> writer);
  58         ~J2KEncoder ();
  59
  60         /** Called to indicate that a processing run is about to begin */
  61         void begin ();
  62
  63         /** Called to pass a bit of video to be encoded as the next DCP frame */
  64         void encode (std::shared_ptr<PlayerVideo> pv, dcpomatic::DCPTime time);
  65
  66         /** Called when a processing run has finished */
  67         void end ();
  68
  69         boost::optional<float> current_encoding_rate () const;
  70         int video_frames_enqueued () const;
  71
  72         void servers_list_changed ();
  73
  74 private:
  75
  76         static void call_servers_list_changed (std::weak_ptr<J2KEncoder> encoder);
  77
  78         void frame_done ();
  79
  80         void encoder_thread (boost::optional<EncodeServerDescription>);
  81         void terminate_threads ();
  82
  83         /** Film that we are encoding */
  84         std::shared_ptr<const Film> _film;
  85
  86         EventHistory _history;
  87
  88         boost::mutex _threads_mutex;
  89         std::shared_ptr<boost::thread_group> _threads;
  90
  91         mutable boost::mutex _queue_mutex;
  92         std::list<std::shared_ptr<DCPVideo> > _queue;
  93         /** condition to manage thread wakeups when we have nothing to do */
  94         boost::condition _empty_condition;
  95         /** condition to manage thread wakeups when we have too much to do */
  96         boost::condition _full_condition;
  97
  98         std::shared_ptr<Writer> _writer;
  99         Waker _waker;
 100
 101         std::shared_ptr<PlayerVideo> _last_player_video[EYES_COUNT];
 102         boost::optional<dcpomatic::DCPTime> _last_player_video_time;
 103
 104         boost::signals2::scoped_connection _server_found_connection;
 105 };
 106
 107 #endif