X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Fwriter.h;h=1e25c3bdf644d455434622e761629af9fcc3cb90;hp=95530a9d973587906af25a8ae290131bba5460a5;hb=ac34066d5e448d1984d11a180be74e31b6e13b5c;hpb=2c5398adaea8bc56fe196144a9a233981657fba0 diff --git a/src/lib/writer.h b/src/lib/writer.h index 95530a9d9..1e25c3bdf 100644 --- a/src/lib/writer.h +++ b/src/lib/writer.h @@ -1,65 +1,62 @@ /* - Copyright (C) 2012-2015 Carl Hetherington + Copyright (C) 2012-2021 Carl Hetherington - This program is free software; you can redistribute it and/or modify + This file is part of DCP-o-matic. + + DCP-o-matic is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. - This program is distributed in the hope that it will be useful, + DCP-o-matic is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + along with DCP-o-matic. If not, see . */ + /** @file src/lib/writer.h * @brief Writer class. */ + +#include "atmos_metadata.h" #include "types.h" -#include "player_subtitles.h" -#include "data.h" +#include "player_text.h" #include "exception_store.h" -#include -#include -#include +#include "dcp_text_track.h" +#include "weak_film.h" +#include #include #include #include + +namespace dcp { + class Data; +} + +namespace dcpomatic { + class FontData; +} + class Film; -class Data; class AudioBuffers; class Job; -class Font; class ReferencedReelAsset; +class ReelWriter; -namespace dcp { - class MonoPictureAsset; - class MonoPictureAssetWriter; - class StereoPictureAsset; - class StereoPictureAssetWriter; - class PictureAsset; - class PictureAssetWriter; - class SoundAsset; - class SoundAssetWriter; - class SubtitleAsset; - class ReelAsset; -} struct QueueItem { public: - QueueItem () - : size (0) - {} + QueueItem () {} - enum Type { + enum class Type { /** a normal frame with some JPEG200 data */ FULL, /** a frame whose data already exists in the MXF, @@ -68,22 +65,25 @@ public: */ FAKE, REPEAT, - REF, } type; /** encoded data for FULL */ - boost::optional encoded; + std::shared_ptr encoded; /** size of data for FAKE */ - int size; - /** frame index */ - int frame; + int size = 0; + /** reel index */ + size_t reel = 0; + /** frame index within the reel */ + int frame = 0; /** eyes for FULL, FAKE and REPEAT */ - Eyes eyes; + Eyes eyes = Eyes::BOTH; }; + bool operator< (QueueItem const & a, QueueItem const & b); bool operator== (QueueItem const & a, QueueItem const & b); + /** @class Writer * @brief Class to manage writing JPEG2000 and audio data to assets on disk. * @@ -91,107 +91,128 @@ bool operator== (QueueItem const & a, QueueItem const & b); * or AudioBuffers objects (containing image or sound data respectively) * and writes them to the assets. * - * ::write() for Data can be called out of order, and the Writer + * write() for Data (picture) can be called out of order, and the Writer * will sort it out. write() for AudioBuffers must be called in order. */ -class Writer : public ExceptionStore, public boost::noncopyable +class Writer : public ExceptionStore, public WeakConstFilm { public: - Writer (boost::shared_ptr, boost::weak_ptr); + Writer (std::weak_ptr, std::weak_ptr, bool text_only = false); ~Writer (); + Writer (Writer const &) = delete; + Writer& operator= (Writer const &) = delete; + void start (); bool can_fake_write (Frame) const; - void write (Data, Frame, Eyes); + void write (std::shared_ptr, Frame, Eyes); void fake_write (Frame, Eyes); - void ref_write (Frame); + bool can_repeat (Frame) const; void repeat (Frame, Eyes); - void write (boost::shared_ptr); - void write (PlayerSubtitles subs); - void write (std::list > fonts); + void write (std::shared_ptr, dcpomatic::DCPTime time); + void write (PlayerText text, TextType type, boost::optional, dcpomatic::DCPTimePeriod period); + void write (std::vector fonts); void write (ReferencedReelAsset asset); - void finish (); + void write (std::shared_ptr atmos, dcpomatic::DCPTime time, AtmosMetadata metadata); + void finish (boost::filesystem::path output_dcp); void set_encoder_threads (int threads); private: - - class Reel { - public: - Reel () - : first_nonexistant_frame (0) - , written (0) - {} - - DCPTimePeriod period; - /** the first frame index that does not already exist in our MXF */ - int first_nonexistant_frame; - Frame written; - - boost::shared_ptr picture_asset; - boost::shared_ptr picture_asset_writer; - boost::shared_ptr sound_asset; - boost::shared_ptr sound_asset_writer; - boost::shared_ptr subtitle_asset; - }; - void thread (); void terminate_thread (bool); - void check_existing_picture_asset (Reel& reel); bool have_sequenced_image_at_queue_head (); - void write_frame_info (int frame, Eyes eyes, dcp::FrameInfo info) const; - long frame_info_position (int frame, Eyes eyes) const; - dcp::FrameInfo read_frame_info (FILE* file, int frame, Eyes eyes) const; - Reel const & video_reel (int frame) const; - - /** our Film */ - boost::shared_ptr _film; - boost::weak_ptr _job; - std::list _reels; - std::list::iterator _audio_reel; - std::list::iterator _subtitle_reel; - - /** our thread, or 0 */ - boost::thread* _thread; + size_t video_reel (int frame) const; + void set_digest_progress (Job* job, float progress); + void write_cover_sheet (boost::filesystem::path output_dcp); + void calculate_referenced_digests (std::function set_progress); + void write_hanging_text (ReelWriter& reel); + void calculate_digests (); + + std::weak_ptr _job; + std::vector _reels; + std::vector::iterator _audio_reel; + std::vector::iterator _subtitle_reel; + std::map::iterator> _caption_reels; + std::vector::iterator _atmos_reel; + + /** our thread */ + boost::thread _thread; /** true if our thread should finish */ - bool _finish; + bool _finish = false; /** queue of things to write to disk */ std::list _queue; /** number of FULL frames whose JPEG200 data is currently held in RAM */ - int _queued_full_in_memory; + int _queued_full_in_memory = 0; /** mutex for thread state */ mutable boost::mutex _state_mutex; /** condition to manage thread wakeups when we have nothing to do */ boost::condition _empty_condition; /** condition to manage thread wakeups when we have too much to do */ boost::condition _full_condition; - /** the data of the last written frame, if there is one */ - boost::optional _last_written[EYES_COUNT]; - /** the index of the last written frame */ - int _last_written_frame; - Eyes _last_written_eyes; /** maximum number of frames to hold in memory, for when we are managing * ordering */ int _maximum_frames_in_memory; + unsigned int _maximum_queue_size; + + class LastWritten + { + public: + LastWritten() + : _frame(-1) + , _eyes(Eyes::RIGHT) + {} + + /** @return true if qi is the next item after this one */ + bool next (QueueItem qi) const; + void update (QueueItem qi); + + int frame () const { + return _frame; + } + + private: + int _frame; + Eyes _eyes; + }; + + /** The last frame written to each reel */ + std::vector _last_written; /** number of FULL written frames */ - int _full_written; + int _full_written = 0; /** number of FAKE written frames */ - int _fake_written; - int _repeat_written; - int _ref_written; + int _fake_written = 0; + int _repeat_written = 0; /** number of frames pushed to disk and then recovered due to the limit of frames to be held in memory. */ - int _pushed_to_disk; + int _pushed_to_disk = 0; + + bool _text_only; + + boost::mutex _digest_progresses_mutex; + std::map _digest_progresses; std::list _reel_assets; - std::list > _fonts; + std::vector _fonts; + + /** true if any reel has any subtitles */ + bool _have_subtitles = false; + /** all closed caption tracks that we have on any reel */ + std::set _have_closed_captions; + + struct HangingText { + PlayerText text; + TextType type; + boost::optional track; + dcpomatic::DCPTimePeriod period; + }; - static int const _info_size; + std::vector _hanging_texts; };