Fix subtitle vertical position (#2367).
[dcpomatic.git] / src / lib / reel_writer.cc
index baeabc4fd0ff2ddf09fc0371fe1779d55147d794..94b12ec7d38506147541c09d2b99634f82945a6d 100644 (file)
@@ -114,6 +114,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 +126,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 +161,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);
        } 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? */
@@ -280,28 +281,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 +316,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 +356,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);
 }
 
@@ -874,6 +872,7 @@ ReelWriter::empty_text_asset (TextType type, optional<DCPTextTrack> track, bool
                                        dcp::HAlign::CENTER,
                                        0.5,
                                        dcp::VAlign::CENTER,
+                                       0,
                                        dcp::Direction::LTR,
                                        " ",
                                        dcp::Effect::NONE,
@@ -891,6 +890,33 @@ ReelWriter::empty_text_asset (TextType type, optional<DCPTextTrack> track, bool
 }
 
 
+float
+ReelWriter::convert_vertical_position(StringText const& subtitle, dcp::Standard to) const
+{
+       if (subtitle.valign_standard == to) {
+               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() + ((subtitle.valign_standard == dcp::Standard::SMPTE) ? correction : -correction);
+}
+
+
 void
 ReelWriter::write (PlayerText subs, TextType type, optional<DCPTextTrack> track, DCPTimePeriod period, FontIdMap const& fonts)
 {
@@ -930,6 +956,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::Standard::INTEROP : dcp::Standard::SMPTE));
                auto sub = make_shared<dcp::SubtitleString>(i);
                if (type == TextType::OPEN_SUBTITLE) {
                        sub->set_font(fonts.get(i.font));
@@ -943,7 +970,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()
                                )
                        );