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