src/lib/writer.h

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