src/lib/writer.h

   1 /*
   2     Copyright (C) 2012-2021 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
  22 #ifndef DCPOMATIC_WRITER_H
  23 #define DCPOMATIC_WRITER_H
  24
  25
  26 /** @file  src/lib/writer.h
  27  *  @brief Writer class.
  28  */
  29
  30
  31 #include "atmos_metadata.h"
  32 #include "dcp_text_track.h"
  33 #include "dcpomatic_time.h"
  34 #include "exception_store.h"
  35 #include "font_id_map.h"
  36 #include "player_text.h"
  37 #include "text_type.h"
  38 #include "types.h"
  39 #include "weak_film.h"
  40 #include <dcp/atmos_frame.h>
  41 #include <boost/thread.hpp>
  42 #include <boost/thread/condition.hpp>
  43 #include <list>
  44
  45
  46 namespace dcp {
  47         class Data;
  48 }
  49
  50 class AudioBuffers;
  51 class Film;
  52 class Job;
  53 class ReelWriter;
  54 class ReferencedReelAsset;
  55 struct writer_disambiguate_font_ids1;
  56 struct writer_disambiguate_font_ids2;
  57 struct writer_disambiguate_font_ids3;
  58
  59
  60 struct QueueItem
  61 {
  62 public:
  63         QueueItem () {}
  64
  65         enum class Type {
  66                 /** a normal frame with some JPEG200 data */
  67                 FULL,
  68                 /** a frame whose data already exists in the MXF,
  69                     and we fake-write it; i.e. we update the writer's
  70                     state but we use the data that is already on disk.
  71                 */
  72                 FAKE,
  73                 REPEAT,
  74         } type;
  75
  76         /** encoded data for FULL */
  77         std::shared_ptr<const dcp::Data> encoded;
  78         /** size of data for FAKE */
  79         int size = 0;
  80         /** reel index */
  81         size_t reel = 0;
  82         /** frame index within the reel */
  83         int frame = 0;
  84         /** eyes for FULL, FAKE and REPEAT */
  85         Eyes eyes = Eyes::BOTH;
  86 };
  87
  88
  89 bool operator< (QueueItem const & a, QueueItem const & b);
  90 bool operator== (QueueItem const & a, QueueItem const & b);
  91
  92
  93 /** @class Writer
  94  *  @brief Class to manage writing JPEG2000 and audio data to assets on disk.
  95  *
  96  *  This class creates sound and picture assets, then takes Data
  97  *  or AudioBuffers objects (containing image or sound data respectively)
  98  *  and writes them to the assets.
  99  *
 100  *  write() for Data (picture) can be called out of order, and the Writer
 101  *  will sort it out.  write() for AudioBuffers must be called in order.
 102  */
 103
 104 class Writer : public ExceptionStore, public WeakConstFilm
 105 {
 106 public:
 107         Writer (std::weak_ptr<const Film>, std::weak_ptr<Job>, bool text_only = false);
 108         ~Writer ();
 109
 110         Writer (Writer const &) = delete;
 111         Writer& operator= (Writer const &) = delete;
 112
 113         void start ();
 114
 115         bool can_fake_write (Frame) const;
 116
 117         void write (std::shared_ptr<const dcp::Data>, Frame, Eyes);
 118         void fake_write (Frame, Eyes);
 119         bool can_repeat (Frame) const;
 120         void repeat (Frame, Eyes);
 121         void write (std::shared_ptr<const AudioBuffers>, dcpomatic::DCPTime time);
 122         void write (PlayerText text, TextType type, boost::optional<DCPTextTrack>, dcpomatic::DCPTimePeriod period);
 123         void write (std::vector<std::shared_ptr<dcpomatic::Font>> fonts);
 124         void write (ReferencedReelAsset asset);
 125         void write (std::shared_ptr<const dcp::AtmosFrame> atmos, dcpomatic::DCPTime time, AtmosMetadata metadata);
 126         void finish (boost::filesystem::path output_dcp);
 127
 128         void set_encoder_threads (int threads);
 129
 130         void zombify();
 131
 132 private:
 133         friend struct ::writer_disambiguate_font_ids1;
 134         friend struct ::writer_disambiguate_font_ids2;
 135         friend struct ::writer_disambiguate_font_ids3;
 136
 137         void thread ();
 138         void terminate_thread (bool);
 139         bool have_sequenced_image_at_queue_head ();
 140         size_t video_reel (int frame) const;
 141         void set_digest_progress(Job* job, int id, int64_t done, int64_t size);
 142         void write_cover_sheet (boost::filesystem::path output_dcp);
 143         void calculate_referenced_digests(std::function<void (int64_t, int64_t)> set_progress);
 144         void write_hanging_text (ReelWriter& reel);
 145         void calculate_digests ();
 146
 147         std::weak_ptr<Job> _job;
 148         std::vector<ReelWriter> _reels;
 149         std::vector<ReelWriter>::iterator _audio_reel;
 150         std::vector<ReelWriter>::iterator _subtitle_reel;
 151         std::map<DCPTextTrack, std::vector<ReelWriter>::iterator> _caption_reels;
 152         std::vector<ReelWriter>::iterator _atmos_reel;
 153
 154         /** our thread */
 155         boost::thread _thread;
 156         /** true if our thread should finish */
 157         bool _finish = false;
 158         /** queue of things to write to disk */
 159         std::list<QueueItem> _queue;
 160         /** number of FULL frames whose JPEG200 data is currently held in RAM */
 161         int _queued_full_in_memory = 0;
 162         /** mutex for thread state */
 163         mutable boost::mutex _state_mutex;
 164         /** condition to manage thread wakeups when we have nothing to do  */
 165         boost::condition _empty_condition;
 166         /** condition to manage thread wakeups when we have too much to do */
 167         boost::condition _full_condition;
 168         /** maximum number of frames to hold in memory, for when we are managing
 169          *  ordering
 170          */
 171         int _maximum_frames_in_memory;
 172         unsigned int _maximum_queue_size;
 173
 174         class LastWritten
 175         {
 176         public:
 177                 LastWritten()
 178                         : _frame(-1)
 179                         , _eyes(Eyes::RIGHT)
 180                 {}
 181
 182                 /** @return true if qi is the next item after this one */
 183                 bool next (QueueItem qi) const;
 184                 void update (QueueItem qi);
 185
 186                 int frame () const {
 187                         return _frame;
 188                 }
 189
 190         private:
 191                 int _frame;
 192                 Eyes _eyes;
 193         };
 194
 195         /** The last frame written to each reel */
 196         std::vector<LastWritten> _last_written;
 197
 198         /** number of FULL written frames */
 199         int _full_written = 0;
 200         /** number of FAKE written frames */
 201         int _fake_written = 0;
 202         int _repeat_written = 0;
 203         /** number of frames pushed to disk and then recovered
 204             due to the limit of frames to be held in memory.
 205         */
 206         int _pushed_to_disk = 0;
 207
 208         bool _text_only;
 209
 210         boost::mutex _digest_progresses_mutex;
 211         std::map<int, std::pair<int64_t, int64_t>> _digest_progresses;
 212
 213         std::list<ReferencedReelAsset> _reel_assets;
 214
 215         FontIdMap _fonts;
 216         /** If we are given many fonts, but we're making an Interop DCP, we'll choose a single
 217          *  one that we'll use everywher.  This is that chosen font.
 218          */
 219         std::shared_ptr<dcpomatic::Font> _chosen_interop_font;
 220
 221         /** true if any reel has any subtitles */
 222         bool _have_subtitles = false;
 223         /** all closed caption tracks that we have on any reel */
 224         std::set<DCPTextTrack> _have_closed_captions;
 225
 226         struct HangingText {
 227                 PlayerText text;
 228                 TextType type;
 229                 boost::optional<DCPTextTrack> track;
 230                 dcpomatic::DCPTimePeriod period;
 231         };
 232
 233         std::vector<HangingText> _hanging_texts;
 234
 235         bool _zombie = false;
 236 };
 237
 238
 239 #endif
 240