Don't add fonts to SMPTE closed caption MXFs (#2505).
[dcpomatic.git] / src / lib / reel_writer.cc
index baeabc4fd0ff2ddf09fc0371fe1779d55147d794..5d9f4dae0d9a19e1af95c1dd19b08ffc10ad4fe0 100644 (file)
@@ -22,6 +22,7 @@
 #include "audio_buffers.h"
 #include "compose.hpp"
 #include "config.h"
+#include "constants.h"
 #include "cross.h"
 #include "dcpomatic_log.h"
 #include "digester.h"
@@ -114,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
@@ -125,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
@@ -160,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? */
@@ -176,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
                        );
@@ -189,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
                        );
        }
 
@@ -280,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;
 }
 
 
@@ -315,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;
 }
 
 
@@ -355,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);
 }
 
@@ -476,16 +491,18 @@ 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 (!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));
+                               }
                        }
                }
 
@@ -822,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());
 }
 
 
@@ -858,39 +875,69 @@ 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, FontIdMap const& fonts)
 {
@@ -930,6 +977,7 @@ 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::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));
@@ -943,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()
                                )
                        );