Supporters update.
[dcpomatic.git] / src / lib / reel_writer.cc
index e0279725bc79b50a43c4bb95d25a2e1cda504610..1b33cae852eedcbb1ed5330d9e20bf52bc77bd03 100644 (file)
 #include "audio_buffers.h"
 #include "compose.hpp"
 #include "config.h"
+#include "constants.h"
 #include "cross.h"
 #include "dcpomatic_log.h"
 #include "digester.h"
 #include "film.h"
+#include "film_util.h"
 #include "image.h"
 #include "image_png.h"
 #include "job.h"
@@ -36,6 +38,7 @@
 #include <dcp/certificate_chain.h>
 #include <dcp/cpl.h>
 #include <dcp/dcp.h>
+#include <dcp/filesystem.h>
 #include <dcp/interop_subtitle_asset.h>
 #include <dcp/mono_picture_asset.h>
 #include <dcp/raw_convert.h>
@@ -134,15 +137,15 @@ ReelWriter::ReelWriter (
                   to change its contents (if only by changing the IDs); see
                   #1126.
                */
-               if (boost::filesystem::exists(asset) && boost::filesystem::hard_link_count(asset) > 1) {
+               if (dcp::filesystem::exists(asset) && dcp::filesystem::hard_link_count(asset) > 1) {
                        if (job) {
                                job->sub (_("Copying old video file"));
                                copy_in_bits (asset, asset.string() + ".tmp", bind(&Job::set_progress, job.get(), _1, false));
                        } else {
-                               boost::filesystem::copy_file (asset, asset.string() + ".tmp");
+                               dcp::filesystem::copy_file(asset, asset.string() + ".tmp");
                        }
-                       boost::filesystem::remove (asset);
-                       boost::filesystem::rename (asset.string() + ".tmp", asset);
+                       dcp::filesystem::remove(asset);
+                       dcp::filesystem::rename(asset.string() + ".tmp", asset);
                }
 
 
@@ -161,7 +164,7 @@ ReelWriter::ReelWriter (
                }
 
                _picture_asset->set_file (asset);
-               _picture_asset_writer = _picture_asset->start_write (asset, _first_nonexistent_frame > 0);
+               _picture_asset_writer = _picture_asset->start_write(asset, _first_nonexistent_frame > 0 ? dcp::PictureAsset::Behaviour::OVERWRITE_EXISTING : dcp::PictureAsset::Behaviour::MAKE_NEW);
        } else if (!text_only) {
                /* We already have a complete picture asset that we can just re-use */
                /* XXX: what about if the encryption key changes? */
@@ -190,12 +193,21 @@ ReelWriter::ReelWriter (
 
                DCPOMATIC_ASSERT (film()->directory());
 
+               std::vector<dcp::Channel> extra_active_channels;
+               for (auto channel: std::vector<dcp::Channel>{dcp::Channel::HI, dcp::Channel::VI, dcp::Channel::BSL, dcp::Channel::BSR}) {
+                       if (channel_is_mapped(film(), channel)) {
+                               extra_active_channels.push_back(channel);
+                       }
+               }
+
                /* Write the sound asset into the film directory so that we leave the creation
                   of the DCP directory until the last minute.
                */
                _sound_asset_writer = _sound_asset->start_write (
                        film()->directory().get() / audio_asset_filename (_sound_asset, _reel_index, _reel_count, _content_summary),
-                       film()->contains_atmos_content()
+                       extra_active_channels,
+                       film()->contains_atmos_content() ? dcp::SoundAsset::AtmosSync::ENABLED : dcp::SoundAsset::AtmosSync::DISABLED,
+                       film()->limit_to_smpte_bv20() ? dcp::SoundAsset::MCASubDescriptors::DISABLED : dcp::SoundAsset::MCASubDescriptors::ENABLED
                        );
        }
 
@@ -278,8 +290,8 @@ ReelWriter::check_existing_picture_asset (boost::filesystem::path asset)
        }
 
        /* Offset of the last dcp::FrameInfo in the info file */
-       int const n = (boost::filesystem::file_size(info_file->get().path()) / _info_size) - 1;
-       LOG_GENERAL ("The last FI is %1; info file is %2, info size %3", n, boost::filesystem::file_size(info_file->get().path()), _info_size);
+       int const n = (dcp::filesystem::file_size(info_file->get().path()) / _info_size) - 1;
+       LOG_GENERAL ("The last FI is %1; info file is %2, info size %3", n, dcp::filesystem::file_size(info_file->get().path()), _info_size);
 
        Frame first_nonexistent_frame;
        if (film()->three_d()) {
@@ -385,9 +397,9 @@ ReelWriter::finish (boost::filesystem::path output_dcp)
                   changing any video.
                */
                boost::system::error_code ec;
-               boost::filesystem::remove (video_to, ec);
+               dcp::filesystem::remove(video_to, ec);
 
-               boost::filesystem::create_hard_link (video_from, video_to, ec);
+               dcp::filesystem::create_hard_link(video_from, video_to, ec);
                if (ec) {
                        LOG_WARNING("Hard-link failed (%1); copying instead", error_details(ec));
                        auto job = _job.lock ();
@@ -400,7 +412,7 @@ ReelWriter::finish (boost::filesystem::path output_dcp)
                                        throw FileError (e.what(), video_from);
                                }
                        } else {
-                               boost::filesystem::copy_file (video_from, video_to, ec);
+                               dcp::filesystem::copy_file(video_from, video_to, ec);
                                if (ec) {
                                        LOG_ERROR("Failed to copy video file from %1 to %2 (%3)", video_from.string(), video_to.string(), error_details(ec));
                                        throw FileError (ec.message(), video_from);
@@ -418,7 +430,7 @@ ReelWriter::finish (boost::filesystem::path output_dcp)
                audio_to /= aaf;
 
                boost::system::error_code ec;
-               boost::filesystem::rename (film()->file(aaf), audio_to, ec);
+               dcp::filesystem::rename(film()->file(aaf), audio_to, ec);
                if (ec) {
                        throw FileError (
                                String::compose(_("could not move audio asset into the DCP (%1)"), error_details(ec)), aaf
@@ -435,7 +447,7 @@ ReelWriter::finish (boost::filesystem::path output_dcp)
                atmos_to /= aaf;
 
                boost::system::error_code ec;
-               boost::filesystem::rename (film()->file(aaf), atmos_to, ec);
+               dcp::filesystem::rename(film()->file(aaf), atmos_to, ec);
                if (ec) {
                        throw FileError (
                                String::compose(_("could not move atmos asset into the DCP (%1)"), error_details(ec)), aaf
@@ -460,9 +472,6 @@ maybe_add_text (
        int reel_count,
        optional<string> content_summary,
        list<ReferencedReelAsset> const & refs,
-       FontIdMap const& fonts,
-       shared_ptr<dcpomatic::Font> chosen_interop_font,
-       dcp::ArrayData default_font,
        shared_ptr<const Film> film,
        DCPTimePeriod period,
        boost::filesystem::path output_dcp,
@@ -474,22 +483,9 @@ maybe_add_text (
        shared_ptr<Result> reel_asset;
 
        if (asset) {
-               if (film->interop()) {
-                       if (chosen_interop_font) {
-                               /* We only add one font, as Interop will ignore subsequent ones (and some validators will
-                                * complain if they are even present)
-                                */
-                               asset->add_font(fonts.get(chosen_interop_font), chosen_interop_font->data().get_value_or(default_font));
-                       }
-               } else {
-                       for (auto const& font: fonts.map()) {
-                               asset->add_font(font.second, font.first->data().get_value_or(default_font));
-                       }
-               }
-
                if (auto interop = dynamic_pointer_cast<dcp::InteropSubtitleAsset>(asset)) {
                        auto directory = output_dcp / interop->id ();
-                       boost::filesystem::create_directories (directory);
+                       dcp::filesystem::create_directories(directory);
                        interop->write (directory / subtitle_asset_filename(asset, reel_index, reel_count, content_summary, ".xml"));
                        reel_asset = make_shared<Interop> (
                                interop,
@@ -644,8 +640,6 @@ void
 ReelWriter::create_reel_text (
        shared_ptr<dcp::Reel> reel,
        list<ReferencedReelAsset> const & refs,
-       FontIdMap const& fonts,
-       shared_ptr<dcpomatic::Font> chosen_interop_font,
        int64_t duration,
        boost::filesystem::path output_dcp,
        bool ensure_subtitles,
@@ -653,15 +647,10 @@ ReelWriter::create_reel_text (
        ) const
 {
        auto subtitle = maybe_add_text<dcp::ReelInteropSubtitleAsset, dcp::ReelSMPTESubtitleAsset, dcp::ReelSubtitleAsset> (
-               _subtitle_asset, duration, reel, _reel_index, _reel_count, _content_summary, refs, fonts, chosen_interop_font, _default_font, film(), _period, output_dcp, _text_only
+               _subtitle_asset, duration, reel, _reel_index, _reel_count, _content_summary, refs, film(), _period, output_dcp, _text_only
                );
 
-       if (subtitle) {
-               /* We have a subtitle asset that we either made or are referencing */
-               if (auto main_language = film()->subtitle_languages().first) {
-                       subtitle->set_language (*main_language);
-               }
-       } else if (ensure_subtitles) {
+       if (!subtitle && ensure_subtitles) {
                /* We had no subtitle asset, but we've been asked to make sure there is one */
                subtitle = maybe_add_text<dcp::ReelInteropSubtitleAsset, dcp::ReelSMPTESubtitleAsset, dcp::ReelSubtitleAsset> (
                        empty_text_asset(TextType::OPEN_SUBTITLE, optional<DCPTextTrack>(), true),
@@ -671,9 +660,6 @@ ReelWriter::create_reel_text (
                        _reel_count,
                        _content_summary,
                        refs,
-                       fonts,
-                       chosen_interop_font,
-                       _default_font,
                        film(),
                        _period,
                        output_dcp,
@@ -681,9 +667,16 @@ ReelWriter::create_reel_text (
                        );
        }
 
+       if (subtitle) {
+               /* We have a subtitle asset that we either made or are referencing */
+               if (auto main_language = film()->subtitle_languages().first) {
+                       subtitle->set_language (*main_language);
+               }
+       }
+
        for (auto const& i: _closed_caption_assets) {
                auto a = maybe_add_text<dcp::ReelInteropClosedCaptionAsset, dcp::ReelSMPTEClosedCaptionAsset, dcp::ReelClosedCaptionAsset> (
-                       i.second, duration, reel, _reel_index, _reel_count, _content_summary, refs, fonts, chosen_interop_font, _default_font, film(), _period, output_dcp, _text_only
+                       i.second, duration, reel, _reel_index, _reel_count, _content_summary, refs, film(), _period, output_dcp, _text_only
                        );
                DCPOMATIC_ASSERT (a);
                a->set_annotation_text (i.first.name);
@@ -704,9 +697,6 @@ ReelWriter::create_reel_text (
                        _reel_count,
                        _content_summary,
                        refs,
-                       fonts,
-                       chosen_interop_font,
-                       _default_font,
                        film(),
                        _period,
                        output_dcp,
@@ -751,8 +741,6 @@ ReelWriter::create_reel_markers (shared_ptr<dcp::Reel> reel) const
 shared_ptr<dcp::Reel>
 ReelWriter::create_reel (
        list<ReferencedReelAsset> const & refs,
-       FontIdMap const & fonts,
-       shared_ptr<dcpomatic::Font> chosen_interop_font,
        boost::filesystem::path output_dcp,
        bool ensure_subtitles,
        set<DCPTextTrack> ensure_closed_captions
@@ -771,10 +759,12 @@ ReelWriter::create_reel (
                auto reel_picture_asset = create_reel_picture (reel, refs);
                duration = reel_picture_asset->actual_duration ();
                create_reel_sound (reel, refs);
-               create_reel_markers (reel);
+               if (!film()->interop()) {
+                       create_reel_markers(reel);
+               }
        }
 
-       create_reel_text (reel, refs, fonts, chosen_interop_font, duration, output_dcp, ensure_subtitles, ensure_closed_captions);
+       create_reel_text(reel, refs, duration, output_dcp, ensure_subtitles, ensure_closed_captions);
 
        if (_atmos_asset) {
                reel->add (make_shared<dcp::ReelAtmosAsset>(_atmos_asset, 0));
@@ -783,21 +773,39 @@ ReelWriter::create_reel (
        return reel;
 }
 
+
+/** @param set_progress Method to call with progress; first parameter is the number of bytes
+ *  done, second parameter is the number of bytes in total.
+ */
 void
-ReelWriter::calculate_digests (std::function<void (float)> set_progress)
+ReelWriter::calculate_digests(std::function<void (int64_t, int64_t)> set_progress)
 try
 {
+       vector<shared_ptr<const dcp::Asset>> assets;
+
        if (_picture_asset) {
-               _picture_asset->hash (set_progress);
+               assets.push_back(_picture_asset);
        }
-
        if (_sound_asset) {
-               _sound_asset->hash (set_progress);
+               assets.push_back(_sound_asset);
        }
-
        if (_atmos_asset) {
-               _atmos_asset->hash (set_progress);
+               assets.push_back(_atmos_asset);
+       }
+
+       int64_t total_size = 0;
+       for (auto asset: assets) {
+               total_size += asset->file() ? boost::filesystem::file_size(*asset->file()) : 0;
        }
+
+       int64_t total_done = 0;
+       for (auto asset: assets) {
+               asset->hash([&total_done, total_size, set_progress](int64_t done, int64_t) {
+                       set_progress(total_done + done, total_size);
+               });
+               total_done += asset->file() ? boost::filesystem::file_size(*asset->file()) : 0;
+       }
+
 } catch (boost::thread_interrupted) {
        /* set_progress contains an interruption_point, so any of these methods
         * may throw thread_interrupted, at which point we just give up.
@@ -820,7 +828,7 @@ ReelWriter::write (shared_ptr<const AudioBuffers> audio)
        }
 
        DCPOMATIC_ASSERT (audio);
-       _sound_asset_writer->write (audio->data(), audio->frames());
+       _sound_asset_writer->write(audio->data(), audio->channels(), audio->frames());
 }
 
 
@@ -828,6 +836,7 @@ shared_ptr<dcp::SubtitleAsset>
 ReelWriter::empty_text_asset (TextType type, optional<DCPTextTrack> track, bool with_dummy) const
 {
        shared_ptr<dcp::SubtitleAsset> asset;
+       optional<string> font;
 
        auto lang = film()->subtitle_languages();
        if (film()->interop()) {
@@ -862,7 +871,7 @@ ReelWriter::empty_text_asset (TextType type, optional<DCPTextTrack> track, bool
        if (with_dummy) {
                asset->add(
                        std::make_shared<dcp::SubtitleString>(
-                               optional<std::string>(),
+                               font,
                                false,
                                false,
                                false,
@@ -882,9 +891,16 @@ ReelWriter::empty_text_asset (TextType type, optional<DCPTextTrack> track, bool
                                dcp::Colour(),
                                dcp::Time(),
                                dcp::Time(),
-                               0
+                               0,
+                               std::vector<dcp::Ruby>()
                                )
                       );
+
+               if (!film()->interop()) {
+                       /* We must have a LoadFont since we have a Text */
+                       font = "font";
+                       asset->ensure_font(*font, _default_font);
+               }
        }
 
        return asset;
@@ -892,9 +908,10 @@ ReelWriter::empty_text_asset (TextType type, optional<DCPTextTrack> track, bool
 
 
 float
-ReelWriter::convert_vertical_position(StringText const& subtitle, dcp::Standard to) const
+ReelWriter::convert_vertical_position(StringText const& subtitle, dcp::SubtitleStandard to) const
 {
-       if (subtitle.valign_standard == to) {
+       if (dcp::uses_baseline(subtitle.valign_standard) == dcp::uses_baseline(to)) {
+               /* The from and to standards use the same alignment reference */
                return subtitle.v_position();
        }
 
@@ -914,12 +931,12 @@ ReelWriter::convert_vertical_position(StringText const& subtitle, dcp::Standard
                break;
        }
 
-       return subtitle.v_position() + ((subtitle.valign_standard == dcp::Standard::SMPTE) ? correction : -correction);
+       return subtitle.v_position() + (dcp::uses_bounding_box(subtitle.valign_standard) ? correction : -correction);
 }
 
 
 void
-ReelWriter::write (PlayerText subs, TextType type, optional<DCPTextTrack> track, DCPTimePeriod period, FontIdMap const& fonts)
+ReelWriter::write(PlayerText subs, TextType type, optional<DCPTextTrack> track, DCPTimePeriod period, FontIdMap const& fonts, shared_ptr<dcpomatic::Font> chosen_interop_font)
 {
        shared_ptr<dcp::SubtitleAsset> asset;
 
@@ -957,12 +974,20 @@ ReelWriter::write (PlayerText subs, TextType type, optional<DCPTextTrack> track,
        for (auto i: subs.string) {
                i.set_in  (dcp::Time(period.from.seconds() - _period.from.seconds(), tcr));
                i.set_out (dcp::Time(period.to.seconds() - _period.from.seconds(), tcr));
-               i.set_v_position(convert_vertical_position(i, film()->interop() ? dcp::Standard::INTEROP : dcp::Standard::SMPTE));
+               i.set_v_position(convert_vertical_position(i, film()->interop() ? dcp::SubtitleStandard::INTEROP : dcp::SubtitleStandard::SMPTE_2014));
                auto sub = make_shared<dcp::SubtitleString>(i);
-               if (type == TextType::OPEN_SUBTITLE) {
-                       sub->set_font(fonts.get(i.font));
-               }
+               /* i.font is a shared_ptr<Font> which uniquely identifies the font we want,
+                * though if we are Interop we can only have one font, so we'll use the chosen
+                * one instead.
+                */
+               auto font = film()->interop() ? chosen_interop_font : i.font;
+               /* We can get the corresponding ID from fonts */
+               auto const font_id_to_use = fonts.get(font);
+               /* Give this subtitle the correct font ID */
+               sub->set_font(font_id_to_use);
                asset->add(sub);
+               /* Make sure the asset LoadFonts the font we just asked for */
+               asset->ensure_font(font_id_to_use, font->data().get_value_or(_default_font));
        }
 
        for (auto i: subs.bitmap) {