src/lib/reel_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
  22 #include "atmos_metadata.h"
  23 #include "dcp_text_track.h"
  24 #include "dcpomatic_time.h"
  25 #include "enum_indexed_vector.h"
  26 #include "font_id_map.h"
  27 #include "player_text.h"
  28 #include "referenced_reel_asset.h"
  29 #include "render_text.h"
  30 #include "types.h"
  31 #include "weak_film.h"
  32 #include <dcp/atmos_asset_writer.h>
  33 #include <dcp/file.h>
  34 #include <dcp/picture_asset_writer.h>
  35
  36
  37 class AudioBuffers;
  38 class Film;
  39 class InfoFileHandle;
  40 class Job;
  41 struct write_frame_info_test;
  42
  43 namespace dcp {
  44         class AtmosAsset;
  45         class MonoPictureAsset;
  46         class MonoPictureAssetWriter;
  47         class PictureAsset;
  48         class PictureAssetWriter;
  49         class Reel;
  50         class ReelAsset;
  51         class ReelPictureAsset;
  52         class SoundAsset;
  53         class SoundAssetWriter;
  54         class StereoPictureAsset;
  55         class StereoPictureAssetWriter;
  56         class SubtitleAsset;
  57 }
  58
  59
  60 class ReelWriter : public WeakConstFilm
  61 {
  62 public:
  63         ReelWriter (
  64                 std::weak_ptr<const Film> film,
  65                 dcpomatic::DCPTimePeriod period,
  66                 std::shared_ptr<Job> job,
  67                 int reel_index,
  68                 int reel_count,
  69                 bool text_only
  70                 );
  71
  72         void write (std::shared_ptr<const dcp::Data> encoded, Frame frame, Eyes eyes);
  73         void fake_write (int size);
  74         void repeat_write (Frame frame, Eyes eyes);
  75         void write (std::shared_ptr<const AudioBuffers> audio);
  76         void write (PlayerText text, TextType type, boost::optional<DCPTextTrack> track, dcpomatic::DCPTimePeriod period, FontIdMap const& fonts);
  77         void write (std::shared_ptr<const dcp::AtmosFrame> atmos, AtmosMetadata metadata);
  78
  79         void finish (boost::filesystem::path output_dcp);
  80         std::shared_ptr<dcp::Reel> create_reel (
  81                 std::list<ReferencedReelAsset> const & refs,
  82                 FontIdMap const & fonts,
  83                 std::shared_ptr<dcpomatic::Font> chosen_interop_font,
  84                 boost::filesystem::path output_dcp,
  85                 bool ensure_subtitles,
  86                 std::set<DCPTextTrack> ensure_closed_captions
  87                 );
  88         void calculate_digests (std::function<void (float)> set_progress);
  89
  90         Frame start () const;
  91
  92         dcpomatic::DCPTimePeriod period () const {
  93                 return _period;
  94         }
  95
  96         int first_nonexistent_frame () const {
  97                 return _first_nonexistent_frame;
  98         }
  99
 100         dcp::FrameInfo read_frame_info (std::shared_ptr<InfoFileHandle> info, Frame frame, Eyes eyes) const;
 101
 102 private:
 103
 104         friend struct ::write_frame_info_test;
 105
 106         void write_frame_info (Frame frame, Eyes eyes, dcp::FrameInfo info) const;
 107         long frame_info_position (Frame frame, Eyes eyes) const;
 108         Frame check_existing_picture_asset (boost::filesystem::path asset);
 109         bool existing_picture_frame_ok (dcp::File& asset_file, std::shared_ptr<InfoFileHandle> info_file, Frame frame) const;
 110         std::shared_ptr<dcp::SubtitleAsset> empty_text_asset (TextType type, boost::optional<DCPTextTrack> track, bool with_dummy) const;
 111
 112         std::shared_ptr<dcp::ReelPictureAsset> create_reel_picture (std::shared_ptr<dcp::Reel> reel, std::list<ReferencedReelAsset> const & refs) const;
 113         void create_reel_sound (std::shared_ptr<dcp::Reel> reel, std::list<ReferencedReelAsset> const & refs) const;
 114         void create_reel_text (
 115                 std::shared_ptr<dcp::Reel> reel,
 116                 std::list<ReferencedReelAsset> const & refs,
 117                 FontIdMap const& fonts,
 118                 std::shared_ptr<dcpomatic::Font> chosen_interop_font,
 119                 int64_t duration,
 120                 boost::filesystem::path output_dcp,
 121                 bool ensure_subtitles,
 122                 std::set<DCPTextTrack> ensure_closed_captions
 123                 ) const;
 124         void create_reel_markers (std::shared_ptr<dcp::Reel> reel) const;
 125         float convert_vertical_position(StringText const& subtitle, dcp::Standard to) const;
 126
 127         dcpomatic::DCPTimePeriod _period;
 128         /** the first picture frame index that does not already exist in our MXF */
 129         int _first_nonexistent_frame;
 130         /** the data of the last written frame, if there is one */
 131         EnumIndexedVector<std::shared_ptr<const dcp::Data>, Eyes> _last_written;
 132         /** index of this reel within the DCP (starting from 0) */
 133         int _reel_index;
 134         /** number of reels in the DCP */
 135         int _reel_count;
 136         boost::optional<std::string> _content_summary;
 137         std::weak_ptr<Job> _job;
 138         bool _text_only;
 139
 140         dcp::ArrayData _default_font;
 141
 142         std::shared_ptr<dcp::PictureAsset> _picture_asset;
 143         /** picture asset writer, or 0 if we are not writing any picture because we already have one */
 144         std::shared_ptr<dcp::PictureAssetWriter> _picture_asset_writer;
 145         std::shared_ptr<dcp::SoundAsset> _sound_asset;
 146         std::shared_ptr<dcp::SoundAssetWriter> _sound_asset_writer;
 147         std::shared_ptr<dcp::SubtitleAsset> _subtitle_asset;
 148         std::map<DCPTextTrack, std::shared_ptr<dcp::SubtitleAsset>> _closed_caption_assets;
 149         std::shared_ptr<dcp::AtmosAsset> _atmos_asset;
 150         std::shared_ptr<dcp::AtmosAssetWriter> _atmos_asset_writer;
 151
 152         mutable FontMetrics _font_metrics;
 153
 154         static int const _info_size;
 155 };