src/lib/writer.h

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