Fix some spelling mistakes (mostly in comments).
[dcpomatic.git] / src / lib / reel_writer.h
index a80f51dc255c814311ca9d4356e15cba24b5bc95..6e92e89230937bb2f8555b5e6c0695d6c6120462 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
 
 */
 
-#include "types.h"
+
+#include "atmos_metadata.h"
+#include "dcp_text_track.h"
 #include "dcpomatic_time.h"
+#include "font_id_map.h"
+#include "player_text.h"
 #include "referenced_reel_asset.h"
-#include "player_subtitles.h"
+#include "types.h"
+#include "weak_film.h"
+#include <dcp/atmos_asset_writer.h>
+#include <dcp/file.h>
 #include <dcp/picture_asset_writer.h>
-#include <boost/shared_ptr.hpp>
 
+
+class AudioBuffers;
 class Film;
+class InfoFileHandle;
 class Job;
-class Font;
-class AudioBuffers;
+struct write_frame_info_test;
 
 namespace dcp {
+       class AtmosAsset;
        class MonoPictureAsset;
        class MonoPictureAssetWriter;
-       class StereoPictureAsset;
-       class StereoPictureAssetWriter;
        class PictureAsset;
        class PictureAssetWriter;
+       class Reel;
+       class ReelAsset;
+       class ReelPictureAsset;
        class SoundAsset;
        class SoundAssetWriter;
+       class StereoPictureAsset;
+       class StereoPictureAssetWriter;
        class SubtitleAsset;
-       class ReelAsset;
-       class Reel;
 }
 
-class ReelWriter
+
+class ReelWriter : public WeakConstFilm
 {
 public:
-       ReelWriter (boost::shared_ptr<const Film> film, DCPTimePeriod period, boost::shared_ptr<Job> job, int reel_index, int reel_count);
-
-       void write (boost::optional<dcp::Data> encoded, Frame frame, Eyes eyes);
-       void fake_write (Frame frame, Eyes eyes, int size);
+       ReelWriter (
+               std::weak_ptr<const Film> film,
+               dcpomatic::DCPTimePeriod period,
+               std::shared_ptr<Job> job,
+               int reel_index,
+               int reel_count,
+               bool text_only
+               );
+
+       void write (std::shared_ptr<const dcp::Data> encoded, Frame frame, Eyes eyes);
+       void fake_write (int size);
        void repeat_write (Frame frame, Eyes eyes);
-       void write (boost::shared_ptr<const AudioBuffers> audio);
-       void write (PlayerSubtitles subs);
-
-       void finish ();
-       boost::shared_ptr<dcp::Reel> create_reel (std::list<ReferencedReelAsset> const & refs, std::list<boost::shared_ptr<Font> > const & fonts);
-       void calculate_digests (boost::function<void (float)> set_progress);
+       void write (std::shared_ptr<const AudioBuffers> audio);
+       void write (PlayerText text, TextType type, boost::optional<DCPTextTrack> track, dcpomatic::DCPTimePeriod period, FontIdMap const& fonts);
+       void write (std::shared_ptr<const dcp::AtmosFrame> atmos, AtmosMetadata metadata);
+
+       void finish (boost::filesystem::path output_dcp);
+       std::shared_ptr<dcp::Reel> create_reel (
+               std::list<ReferencedReelAsset> const & refs,
+               FontIdMap const & fonts,
+               std::shared_ptr<dcpomatic::Font> chosen_interop_font,
+               boost::filesystem::path output_dcp,
+               bool ensure_subtitles,
+               std::set<DCPTextTrack> ensure_closed_captions
+               );
+       void calculate_digests (std::function<void (float)> set_progress);
 
        Frame start () const;
 
-       DCPTimePeriod period () const {
+       dcpomatic::DCPTimePeriod period () const {
                return _period;
        }
 
-       int total_written_audio_frames () const {
-               return _total_written_audio_frames;
+       int first_nonexistent_frame () const {
+               return _first_nonexistent_frame;
        }
 
-       int last_written_video_frame () const {
-               return _last_written_video_frame;
-       }
-
-       Eyes last_written_eyes () const {
-               return _last_written_eyes;
-       }
-
-       int first_nonexistant_frame () const {
-               return _first_nonexistant_frame;
-       }
-
-       dcp::FrameInfo read_frame_info (FILE* file, Frame frame, Eyes eyes) const;
+       dcp::FrameInfo read_frame_info (std::shared_ptr<InfoFileHandle> info, Frame frame, Eyes eyes) const;
 
 private:
 
+       friend struct ::write_frame_info_test;
+
        void write_frame_info (Frame frame, Eyes eyes, dcp::FrameInfo info) const;
        long frame_info_position (Frame frame, Eyes eyes) const;
-       void check_existing_picture_asset ();
-       bool existing_picture_frame_ok (FILE* asset_file, FILE* info_file) const;
-
-       boost::shared_ptr<const Film> _film;
-
-       DCPTimePeriod _period;
-       /** the first frame index that does not already exist in our MXF */
-       int _first_nonexistant_frame;
+       Frame check_existing_picture_asset (boost::filesystem::path asset);
+       bool existing_picture_frame_ok (dcp::File& asset_file, std::shared_ptr<InfoFileHandle> info_file, Frame frame) const;
+       std::shared_ptr<dcp::SubtitleAsset> empty_text_asset (TextType type, boost::optional<DCPTextTrack> track, bool with_dummy) const;
+
+       std::shared_ptr<dcp::ReelPictureAsset> create_reel_picture (std::shared_ptr<dcp::Reel> reel, std::list<ReferencedReelAsset> const & refs) const;
+       void create_reel_sound (std::shared_ptr<dcp::Reel> reel, std::list<ReferencedReelAsset> const & refs) const;
+       void create_reel_text (
+               std::shared_ptr<dcp::Reel> reel,
+               std::list<ReferencedReelAsset> const & refs,
+               FontIdMap const& fonts,
+               std::shared_ptr<dcpomatic::Font> chosen_interop_font,
+               int64_t duration,
+               boost::filesystem::path output_dcp,
+               bool ensure_subtitles,
+               std::set<DCPTextTrack> ensure_closed_captions
+               ) const;
+       void create_reel_markers (std::shared_ptr<dcp::Reel> reel) const;
+
+       dcpomatic::DCPTimePeriod _period;
+       /** the first picture frame index that does not already exist in our MXF */
+       int _first_nonexistent_frame;
        /** the data of the last written frame, if there is one */
-       boost::optional<dcp::Data> _last_written[EYES_COUNT];
-       /** the index of the last written video frame within the reel */
-       int _last_written_video_frame;
-       Eyes _last_written_eyes;
-       /** the number of audio frames that have been written to the reel */
-       int _total_written_audio_frames;
+       std::shared_ptr<const dcp::Data> _last_written[static_cast<int>(Eyes::COUNT)];
        /** index of this reel within the DCP (starting from 0) */
        int _reel_index;
        /** number of reels in the DCP */
        int _reel_count;
-
-       boost::shared_ptr<dcp::PictureAsset> _picture_asset;
-       boost::shared_ptr<dcp::PictureAssetWriter> _picture_asset_writer;
-       boost::shared_ptr<dcp::SoundAsset> _sound_asset;
-       boost::shared_ptr<dcp::SoundAssetWriter> _sound_asset_writer;
-       boost::shared_ptr<dcp::SubtitleAsset> _subtitle_asset;
+       boost::optional<std::string> _content_summary;
+       std::weak_ptr<Job> _job;
+       bool _text_only;
+
+       dcp::ArrayData _default_font;
+
+       std::shared_ptr<dcp::PictureAsset> _picture_asset;
+       /** picture asset writer, or 0 if we are not writing any picture because we already have one */
+       std::shared_ptr<dcp::PictureAssetWriter> _picture_asset_writer;
+       std::shared_ptr<dcp::SoundAsset> _sound_asset;
+       std::shared_ptr<dcp::SoundAssetWriter> _sound_asset_writer;
+       std::shared_ptr<dcp::SubtitleAsset> _subtitle_asset;
+       std::map<DCPTextTrack, std::shared_ptr<dcp::SubtitleAsset>> _closed_caption_assets;
+       std::shared_ptr<dcp::AtmosAsset> _atmos_asset;
+       std::shared_ptr<dcp::AtmosAssetWriter> _atmos_asset_writer;
 
        static int const _info_size;
 };