src/lib/writer.h

   1 /*
   2     Copyright (C) 2012-2018 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 /** @file  src/lib/writer.h
  22  *  @brief Writer class.
  23  */
  24
  25 #include "types.h"
  26 #include "player_caption.h"
  27 #include "exception_store.h"
  28 #include <boost/shared_ptr.hpp>
  29 #include <boost/weak_ptr.hpp>
  30 #include <boost/thread.hpp>
  31 #include <boost/thread/condition.hpp>
  32 #include <list>
  33
  34 namespace dcp {
  35         class Data;
  36 }
  37
  38 class Film;
  39 class AudioBuffers;
  40 class Job;
  41 class Font;
  42 class ReferencedReelAsset;
  43 class ReelWriter;
  44
  45 struct QueueItem
  46 {
  47 public:
  48         QueueItem ()
  49                 : size (0)
  50                 , reel (0)
  51                 , frame (0)
  52                 , eyes (EYES_BOTH)
  53         {}
  54
  55         enum Type {
  56                 /** a normal frame with some JPEG200 data */
  57                 FULL,
  58                 /** a frame whose data already exists in the MXF,
  59                     and we fake-write it; i.e. we update the writer's
  60                     state but we use the data that is already on disk.
  61                 */
  62                 FAKE,
  63                 REPEAT,
  64         } type;
  65
  66         /** encoded data for FULL */
  67         boost::optional<dcp::Data> encoded;
  68         /** size of data for FAKE */
  69         int size;
  70         /** reel index */
  71         size_t reel;
  72         /** frame index within the reel */
  73         int frame;
  74         /** eyes for FULL, FAKE and REPEAT */
  75         Eyes eyes;
  76 };
  77
  78 bool operator< (QueueItem const & a, QueueItem const & b);
  79 bool operator== (QueueItem const & a, QueueItem const & b);
  80
  81 /** @class Writer
  82  *  @brief Class to manage writing JPEG2000 and audio data to assets on disk.
  83  *
  84  *  This class creates sound and picture assets, then takes Data
  85  *  or AudioBuffers objects (containing image or sound data respectively)
  86  *  and writes them to the assets.
  87  *
  88  *  write() for Data (picture) can be called out of order, and the Writer
  89  *  will sort it out.  write() for AudioBuffers must be called in order.
  90  */
  91
  92 class Writer : public ExceptionStore, public boost::noncopyable
  93 {
  94 public:
  95         Writer (boost::shared_ptr<const Film>, boost::weak_ptr<Job>);
  96         ~Writer ();
  97
  98         void start ();
  99
 100         bool can_fake_write (Frame) const;
 101
 102         void write (dcp::Data, Frame, Eyes);
 103         void fake_write (Frame, Eyes);
 104         bool can_repeat (Frame) const;
 105         void repeat (Frame, Eyes);
 106         void write (boost::shared_ptr<const AudioBuffers>, DCPTime time);
 107         void write (PlayerCaption text, TextType type, DCPTimePeriod period);
 108         void write (std::list<boost::shared_ptr<Font> > fonts);
 109         void write (ReferencedReelAsset asset);
 110         void finish ();
 111
 112         void set_encoder_threads (int threads);
 113
 114 private:
 115         void thread ();
 116         void terminate_thread (bool);
 117         bool have_sequenced_image_at_queue_head ();
 118         size_t video_reel (int frame) const;
 119         void set_digest_progress (Job* job, float progress);
 120         void write_cover_sheet ();
 121
 122         /** our Film */
 123         boost::shared_ptr<const Film> _film;
 124         boost::weak_ptr<Job> _job;
 125         std::vector<ReelWriter> _reels;
 126         std::vector<ReelWriter>::iterator _audio_reel;
 127         std::vector<ReelWriter>::iterator _text_reel[TEXT_COUNT];
 128
 129         /** our thread, or 0 */
 130         boost::thread* _thread;
 131         /** true if our thread should finish */
 132         bool _finish;
 133         /** queue of things to write to disk */
 134         std::list<QueueItem> _queue;
 135         /** number of FULL frames whose JPEG200 data is currently held in RAM */
 136         int _queued_full_in_memory;
 137         /** mutex for thread state */
 138         mutable boost::mutex _state_mutex;
 139         /** condition to manage thread wakeups when we have nothing to do  */
 140         boost::condition _empty_condition;
 141         /** condition to manage thread wakeups when we have too much to do */
 142         boost::condition _full_condition;
 143         /** maximum number of frames to hold in memory, for when we are managing
 144          *  ordering
 145          */
 146         int _maximum_frames_in_memory;
 147         unsigned int _maximum_queue_size;
 148
 149         /** number of FULL written frames */
 150         int _full_written;
 151         /** number of FAKE written frames */
 152         int _fake_written;
 153         int _repeat_written;
 154         /** number of frames pushed to disk and then recovered
 155             due to the limit of frames to be held in memory.
 156         */
 157         int _pushed_to_disk;
 158
 159         boost::mutex _digest_progresses_mutex;
 160         std::map<boost::thread::id, float> _digest_progresses;
 161
 162         std::list<ReferencedReelAsset> _reel_assets;
 163
 164         std::list<boost::shared_ptr<Font> > _fonts;
 165 };