Don't add fonts to SMPTE closed caption MXFs (#2505).
[dcpomatic.git] / src / lib / reel_writer.cc
index d64cfb81a4a6b553778fcef43bafa3aa0d7233fc..5d9f4dae0d9a19e1af95c1dd19b08ffc10ad4fe0 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 "font_data.h"
 #include "image.h"
 #include "image_png.h"
 #include "job.h"
@@ -115,6 +115,7 @@ ReelWriter::ReelWriter (
        , _content_summary (film()->content_summary(period))
        , _job (job)
        , _text_only (text_only)
+       , _font_metrics(film()->frame_size().height)
 {
        /* Create or find our picture asset in a subdirectory, named
           according to those film's parameters which affect the video
@@ -126,9 +127,9 @@ ReelWriter::ReelWriter (
        boost::filesystem::path const asset =
                film()->internal_video_asset_dir() / film()->internal_video_asset_filename(_period);
 
-       _first_nonexistant_frame = check_existing_picture_asset (asset);
+       _first_nonexistent_frame = check_existing_picture_asset (asset);
 
-       if (_first_nonexistant_frame < period.duration().frames_round(film()->video_frame_rate())) {
+       if (_first_nonexistent_frame < period.duration().frames_round(film()->video_frame_rate())) {
                /* We do not have a complete picture asset.  If there is an
                   existing asset, break any hard links to it as we are about
                   to change its contents (if only by changing the IDs); see
@@ -161,7 +162,7 @@ ReelWriter::ReelWriter (
                }
 
                _picture_asset->set_file (asset);
-               _picture_asset_writer = _picture_asset->start_write (asset, _first_nonexistant_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? */
@@ -177,7 +178,8 @@ ReelWriter::ReelWriter (
                _sound_asset = make_shared<dcp::SoundAsset> (
                        dcp::Fraction(film()->video_frame_rate(), 1),
                        film()->audio_frame_rate(),
-                       film()->audio_channels(),
+                       /* Always make 16-channel sound assets for SMPTE; libdcp will pad unused channels for us */
+                       standard == dcp::Standard::SMPTE ? MAX_DCP_AUDIO_CHANNELS : film()->audio_channels(),
                        lang ? *lang : dcp::LanguageTag("en-US"),
                        standard
                        );
@@ -190,12 +192,27 @@ ReelWriter::ReelWriter (
 
                DCPOMATIC_ASSERT (film()->directory());
 
+               auto mapped = film()->mapped_audio_channels();
+               std::vector<dcp::Channel> extra_active_channels;
+               auto add_if_mapped = [mapped, &extra_active_channels](dcp::Channel channel) {
+                       if (std::find(mapped.begin(), mapped.end(), static_cast<int>(channel)) != mapped.end()) {
+                               extra_active_channels.push_back(channel);
+                       }
+               };
+
+               add_if_mapped(dcp::Channel::HI);
+               add_if_mapped(dcp::Channel::VI);
+               add_if_mapped(dcp::Channel::BSL);
+               add_if_mapped(dcp::Channel::BSR);
+
                /* 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
                        );
        }
 
@@ -281,28 +298,28 @@ ReelWriter::check_existing_picture_asset (boost::filesystem::path asset)
        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);
 
-       Frame first_nonexistant_frame;
+       Frame first_nonexistent_frame;
        if (film()->three_d()) {
                /* Start looking at the last left frame */
-               first_nonexistant_frame = n / 2;
+               first_nonexistent_frame = n / 2;
        } else {
-               first_nonexistant_frame = n;
+               first_nonexistent_frame = n;
        }
 
-       while (!existing_picture_frame_ok(asset_file, info_file, first_nonexistant_frame) && first_nonexistant_frame > 0) {
-               --first_nonexistant_frame;
+       while (!existing_picture_frame_ok(asset_file, info_file, first_nonexistent_frame) && first_nonexistent_frame > 0) {
+               --first_nonexistent_frame;
        }
 
-       if (!film()->three_d() && first_nonexistant_frame > 0) {
+       if (!film()->three_d() && first_nonexistent_frame > 0) {
                /* If we are doing 3D we might have found a good L frame with no R, so only
                   do this if we're in 2D and we've just found a good B(oth) frame.
                */
-               ++first_nonexistant_frame;
+               ++first_nonexistent_frame;
        }
 
-       LOG_GENERAL ("Proceeding with first nonexistant frame %1", first_nonexistant_frame);
+       LOG_GENERAL ("Proceeding with first nonexistent frame %1", first_nonexistent_frame);
 
-       return first_nonexistant_frame;
+       return first_nonexistent_frame;
 }
 
 
@@ -316,7 +333,7 @@ ReelWriter::write (shared_ptr<const Data> encoded, Frame frame, Eyes eyes)
 
        auto fin = _picture_asset_writer->write (encoded->data(), encoded->size());
        write_frame_info (frame, eyes, fin);
-       _last_written[static_cast<int>(eyes)] = encoded;
+       _last_written[eyes] = encoded;
 }
 
 
@@ -356,10 +373,7 @@ ReelWriter::repeat_write (Frame frame, Eyes eyes)
                return;
        }
 
-       auto fin = _picture_asset_writer->write (
-               _last_written[static_cast<int>(eyes)]->data(),
-               _last_written[static_cast<int>(eyes)]->size()
-               );
+       auto fin = _picture_asset_writer->write(_last_written[eyes]->data(), _last_written[eyes]->size());
        write_frame_info (frame, eyes, fin);
 }
 
@@ -392,7 +406,7 @@ ReelWriter::finish (boost::filesystem::path output_dcp)
 
                boost::filesystem::create_hard_link (video_from, video_to, ec);
                if (ec) {
-                       LOG_WARNING_NC ("Hard-link failed; copying instead");
+                       LOG_WARNING("Hard-link failed (%1); copying instead", error_details(ec));
                        auto job = _job.lock ();
                        if (job) {
                                job->sub (_("Copying video file into DCP"));
@@ -405,7 +419,7 @@ ReelWriter::finish (boost::filesystem::path output_dcp)
                        } else {
                                boost::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(), ec.message());
+                                       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);
                                }
                        }
@@ -424,7 +438,7 @@ ReelWriter::finish (boost::filesystem::path output_dcp)
                boost::filesystem::rename (film()->file(aaf), audio_to, ec);
                if (ec) {
                        throw FileError (
-                               String::compose (_("could not move audio asset into the DCP (%1)"), ec.value ()), aaf
+                               String::compose(_("could not move audio asset into the DCP (%1)"), error_details(ec)), aaf
                                );
                }
 
@@ -441,7 +455,7 @@ ReelWriter::finish (boost::filesystem::path output_dcp)
                boost::filesystem::rename (film()->file(aaf), atmos_to, ec);
                if (ec) {
                        throw FileError (
-                               String::compose (_("could not move atmos asset into the DCP (%1)"), ec.value ()), aaf
+                               String::compose(_("could not move atmos asset into the DCP (%1)"), error_details(ec)), aaf
                                );
                }
 
@@ -463,7 +477,8 @@ maybe_add_text (
        int reel_count,
        optional<string> content_summary,
        list<ReferencedReelAsset> const & refs,
-       vector<FontData> const & fonts,
+       FontIdMap const& fonts,
+       shared_ptr<dcpomatic::Font> chosen_interop_font,
        dcp::ArrayData default_font,
        shared_ptr<const Film> film,
        DCPTimePeriod period,
@@ -476,15 +491,25 @@ maybe_add_text (
        shared_ptr<Result> reel_asset;
 
        if (asset) {
-               /* Add the font to the subtitle content */
-               for (auto const& j: fonts) {
-                       asset->add_font (j.id, j.data.get_value_or(default_font));
+               if (!std::is_same<Result, dcp::ReelClosedCaptionAsset>::value) {
+                       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);
-                       interop->write (directory / subtitle_asset_filename(asset, reel_index, reel_count, content_summary));
+                       interop->write (directory / subtitle_asset_filename(asset, reel_index, reel_count, content_summary, ".xml"));
                        reel_asset = make_shared<Interop> (
                                interop,
                                dcp::Fraction(film->video_frame_rate(), 1),
@@ -499,7 +524,7 @@ maybe_add_text (
                        */
                        smpte->set_intrinsic_duration(picture_duration);
                        smpte->write (
-                               output_dcp / subtitle_asset_filename(asset, reel_index, reel_count, content_summary)
+                               output_dcp / subtitle_asset_filename(asset, reel_index, reel_count, content_summary, ".mxf")
                                );
                        reel_asset = make_shared<SMPTE> (
                                smpte,
@@ -638,7 +663,8 @@ void
 ReelWriter::create_reel_text (
        shared_ptr<dcp::Reel> reel,
        list<ReferencedReelAsset> const & refs,
-       vector<FontData> const& fonts,
+       FontIdMap const& fonts,
+       shared_ptr<dcpomatic::Font> chosen_interop_font,
        int64_t duration,
        boost::filesystem::path output_dcp,
        bool ensure_subtitles,
@@ -646,7 +672,7 @@ 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, _default_font, film(), _period, output_dcp, _text_only
+               _subtitle_asset, duration, reel, _reel_index, _reel_count, _content_summary, refs, fonts, chosen_interop_font, _default_font, film(), _period, output_dcp, _text_only
                );
 
        if (subtitle) {
@@ -665,6 +691,7 @@ ReelWriter::create_reel_text (
                        _content_summary,
                        refs,
                        fonts,
+                       chosen_interop_font,
                        _default_font,
                        film(),
                        _period,
@@ -675,7 +702,7 @@ ReelWriter::create_reel_text (
 
        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, _default_font, film(), _period, output_dcp, _text_only
+                       i.second, duration, reel, _reel_index, _reel_count, _content_summary, refs, fonts, chosen_interop_font, _default_font, film(), _period, output_dcp, _text_only
                        );
                DCPOMATIC_ASSERT (a);
                a->set_annotation_text (i.first.name);
@@ -697,6 +724,7 @@ ReelWriter::create_reel_text (
                        _content_summary,
                        refs,
                        fonts,
+                       chosen_interop_font,
                        _default_font,
                        film(),
                        _period,
@@ -742,7 +770,8 @@ ReelWriter::create_reel_markers (shared_ptr<dcp::Reel> reel) const
 shared_ptr<dcp::Reel>
 ReelWriter::create_reel (
        list<ReferencedReelAsset> const & refs,
-       vector<FontData> const & fonts,
+       FontIdMap const & fonts,
+       shared_ptr<dcpomatic::Font> chosen_interop_font,
        boost::filesystem::path output_dcp,
        bool ensure_subtitles,
        set<DCPTextTrack> ensure_closed_captions
@@ -764,7 +793,7 @@ ReelWriter::create_reel (
                create_reel_markers (reel);
        }
 
-       create_reel_text (reel, refs, fonts, duration, output_dcp, ensure_subtitles, ensure_closed_captions);
+       create_reel_text (reel, refs, fonts, chosen_interop_font, duration, output_dcp, ensure_subtitles, ensure_closed_captions);
 
        if (_atmos_asset) {
                reel->add (make_shared<dcp::ReelAtmosAsset>(_atmos_asset, 0));
@@ -810,7 +839,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());
 }
 
 
@@ -846,41 +875,71 @@ ReelWriter::empty_text_asset (TextType type, optional<DCPTextTrack> track, bool
                if (film()->encrypted()) {
                        s->set_key (film()->key());
                }
-               if (with_dummy) {
-                       s->add (
-                               std::make_shared<dcp::SubtitleString>(
-                                       optional<std::string>(),
-                                       false,
-                                       false,
-                                       false,
-                                       dcp::Colour(),
-                                       42,
-                                       1.0,
-                                       dcp::Time(0, 0, 0, 0, 24),
-                                       dcp::Time(0, 0, 1, 0, 24),
-                                       0.5,
-                                       dcp::HAlign::CENTER,
-                                       0.5,
-                                       dcp::VAlign::CENTER,
-                                       dcp::Direction::LTR,
-                                       " ",
-                                       dcp::Effect::NONE,
-                                       dcp::Colour(),
-                                       dcp::Time(),
-                                       dcp::Time(),
-                                       0
-                                       )
-                              );
-               }
                asset = s;
        }
 
+       if (with_dummy) {
+               asset->add(
+                       std::make_shared<dcp::SubtitleString>(
+                               optional<std::string>(),
+                               false,
+                               false,
+                               false,
+                               dcp::Colour(),
+                               42,
+                               1.0,
+                               dcp::Time(0, 0, 0, 0, 24),
+                               dcp::Time(0, 0, 1, 0, 24),
+                               0.5,
+                               dcp::HAlign::CENTER,
+                               0.5,
+                               dcp::VAlign::CENTER,
+                               0,
+                               dcp::Direction::LTR,
+                               " ",
+                               dcp::Effect::NONE,
+                               dcp::Colour(),
+                               dcp::Time(),
+                               dcp::Time(),
+                               0
+                               )
+                      );
+       }
+
        return asset;
 }
 
 
+float
+ReelWriter::convert_vertical_position(StringText const& subtitle, dcp::SubtitleStandard to) const
+{
+       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();
+       }
+
+       auto const baseline_to_bottom = _font_metrics.baseline_to_bottom(subtitle);
+       auto const height = _font_metrics.height(subtitle);
+
+       float correction = 0;
+       switch (subtitle.v_align()) {
+       case dcp::VAlign::TOP:
+               correction = height - baseline_to_bottom;
+               break;
+       case dcp::VAlign::CENTER:
+               correction = (height / 2) - baseline_to_bottom;
+               break;
+       case dcp::VAlign::BOTTOM:
+               correction = baseline_to_bottom;
+               break;
+       }
+
+       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)
+ReelWriter::write (PlayerText subs, TextType type, optional<DCPTextTrack> track, DCPTimePeriod period, FontIdMap const& fonts)
 {
        shared_ptr<dcp::SubtitleAsset> asset;
 
@@ -918,7 +977,12 @@ 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));
-               asset->add (make_shared<dcp::SubtitleString>(i));
+               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));
+               }
+               asset->add(sub);
        }
 
        for (auto i: subs.bitmap) {
@@ -927,7 +991,7 @@ ReelWriter::write (PlayerText subs, TextType type, optional<DCPTextTrack> track,
                                image_as_png(i.image),
                                dcp::Time(period.from.seconds() - _period.from.seconds(), tcr),
                                dcp::Time(period.to.seconds() - _period.from.seconds(), tcr),
-                               i.rectangle.x, dcp::HAlign::LEFT, i.rectangle.y, dcp::VAlign::TOP,
+                               i.rectangle.x, dcp::HAlign::LEFT, i.rectangle.y, dcp::VAlign::TOP, 0,
                                dcp::Time(), dcp::Time()
                                )
                        );