Reword again: Text -> Caption and Plain -> Text.
[dcpomatic.git] / src / lib / player.cc
index 25f60d349de0502ee68e2f59dfd501f97135031e..a7cd0fd94ce93bf402b2ac152d4f9842c09f694e 100644 (file)
@@ -28,7 +28,7 @@
 #include "raw_image_proxy.h"
 #include "ratio.h"
 #include "log.h"
-#include "render_subtitles.h"
+#include "render_text.h"
 #include "config.h"
 #include "content_video.h"
 #include "player_video.h"
 #include "decoder.h"
 #include "video_decoder.h"
 #include "audio_decoder.h"
-#include "subtitle_content.h"
-#include "subtitle_decoder.h"
+#include "text_content.h"
+#include "text_decoder.h"
 #include "ffmpeg_content.h"
 #include "audio_content.h"
-#include "content_subtitle.h"
 #include "dcp_decoder.h"
 #include "image_decoder.h"
 #include "compose.hpp"
@@ -78,6 +77,12 @@ using boost::dynamic_pointer_cast;
 using boost::optional;
 using boost::scoped_ptr;
 
+int const PlayerProperty::VIDEO_CONTAINER_SIZE = 700;
+int const PlayerProperty::PLAYLIST = 701;
+int const PlayerProperty::FILM_CONTAINER = 702;
+int const PlayerProperty::FILM_VIDEO_FRAME_RATE = 703;
+int const PlayerProperty::DCP_DECODE_REDUCTION = 704;
+
 Player::Player (shared_ptr<const Film> film, shared_ptr<const Playlist> playlist)
        : _film (film)
        , _playlist (playlist)
@@ -129,19 +134,19 @@ Player::setup_pieces ()
                }
 
                if (decoder->video && _ignore_video) {
-                       decoder->video->set_ignore ();
+                       decoder->video->set_ignore (true);
                }
 
                if (decoder->subtitle && _ignore_subtitle) {
-                       decoder->subtitle->set_ignore ();
+                       decoder->subtitle->set_ignore (true);
                }
 
                shared_ptr<DCPDecoder> dcp = dynamic_pointer_cast<DCPDecoder> (decoder);
-               if (dcp && _play_referenced) {
+               if (dcp) {
+                       dcp->set_decode_referenced (_play_referenced);
                        if (_play_referenced) {
-                               dcp->set_decode_referenced ();
+                               dcp->set_forced_reduction (_dcp_decode_reduction);
                        }
-                       dcp->set_forced_reduction (_dcp_decode_reduction);
                }
 
                shared_ptr<Piece> piece (new Piece (i, decoder, frc));
@@ -149,6 +154,7 @@ Player::setup_pieces ()
 
                if (decoder->video) {
                        if (i->video->frame_type() == VIDEO_FRAME_TYPE_3D_LEFT || i->video->frame_type() == VIDEO_FRAME_TYPE_3D_RIGHT) {
+                               /* We need a Shuffler to cope with 3D L/R video data arriving out of sequence */
                                decoder->video->Data.connect (bind (&Shuffler::video, _shuffler, weak_ptr<Piece>(piece), _1));
                        } else {
                                decoder->video->Data.connect (bind (&Player::video, this, weak_ptr<Piece>(piece), _1));
@@ -160,9 +166,9 @@ Player::setup_pieces ()
                }
 
                if (decoder->subtitle) {
-                       decoder->subtitle->ImageStart.connect (bind (&Player::image_subtitle_start, this, weak_ptr<Piece> (piece), _1));
-                       decoder->subtitle->TextStart.connect (bind (&Player::text_subtitle_start, this, weak_ptr<Piece> (piece), _1));
-                       decoder->subtitle->Stop.connect (bind (&Player::subtitle_stop, this, weak_ptr<Piece> (piece), _1));
+                       decoder->subtitle->BitmapStart.connect (bind (&Player::bitmap_text_start, this, weak_ptr<Piece> (piece), _1));
+                       decoder->subtitle->PlainStart.connect (bind (&Player::plain_text_start, this, weak_ptr<Piece> (piece), _1));
+                       decoder->subtitle->Stop.connect (bind (&Player::subtitle_stop, this, weak_ptr<Piece> (piece), _1, _2));
                }
        }
 
@@ -199,38 +205,39 @@ Player::playlist_content_changed (weak_ptr<Content> w, int property, bool freque
                property == ContentProperty::TRIM_END ||
                property == ContentProperty::PATH ||
                property == VideoContentProperty::FRAME_TYPE ||
+               property == VideoContentProperty::COLOUR_CONVERSION ||
+               property == AudioContentProperty::STREAMS ||
                property == DCPContentProperty::NEEDS_ASSETS ||
                property == DCPContentProperty::NEEDS_KDM ||
-               property == SubtitleContentProperty::COLOUR ||
-               property == SubtitleContentProperty::EFFECT ||
-               property == SubtitleContentProperty::EFFECT_COLOUR ||
+               property == TextContentProperty::COLOUR ||
+               property == TextContentProperty::EFFECT ||
+               property == TextContentProperty::EFFECT_COLOUR ||
                property == FFmpegContentProperty::SUBTITLE_STREAM ||
-               property == FFmpegContentProperty::FILTERS ||
-               property == VideoContentProperty::COLOUR_CONVERSION
+               property == FFmpegContentProperty::FILTERS
                ) {
 
                _have_valid_pieces = false;
-               Changed (frequent);
+               Changed (property, frequent);
 
        } else if (
-               property == SubtitleContentProperty::LINE_SPACING ||
-               property == SubtitleContentProperty::OUTLINE_WIDTH ||
-               property == SubtitleContentProperty::Y_SCALE ||
-               property == SubtitleContentProperty::FADE_IN ||
-               property == SubtitleContentProperty::FADE_OUT ||
+               property == TextContentProperty::LINE_SPACING ||
+               property == TextContentProperty::OUTLINE_WIDTH ||
+               property == TextContentProperty::Y_SCALE ||
+               property == TextContentProperty::FADE_IN ||
+               property == TextContentProperty::FADE_OUT ||
                property == ContentProperty::VIDEO_FRAME_RATE ||
-               property == SubtitleContentProperty::USE ||
-               property == SubtitleContentProperty::X_OFFSET ||
-               property == SubtitleContentProperty::Y_OFFSET ||
-               property == SubtitleContentProperty::X_SCALE ||
-               property == SubtitleContentProperty::FONTS ||
+               property == TextContentProperty::USE ||
+               property == TextContentProperty::X_OFFSET ||
+               property == TextContentProperty::Y_OFFSET ||
+               property == TextContentProperty::X_SCALE ||
+               property == TextContentProperty::FONTS ||
                property == VideoContentProperty::CROP ||
                property == VideoContentProperty::SCALE ||
                property == VideoContentProperty::FADE_IN ||
                property == VideoContentProperty::FADE_OUT
                ) {
 
-               Changed (frequent);
+               Changed (property, frequent);
        }
 }
 
@@ -246,14 +253,14 @@ Player::set_video_container_size (dcp::Size s)
        _black_image.reset (new Image (AV_PIX_FMT_RGB24, _video_container_size, true));
        _black_image->make_black ();
 
-       Changed (false);
+       Changed (PlayerProperty::VIDEO_CONTAINER_SIZE, false);
 }
 
 void
 Player::playlist_changed ()
 {
        _have_valid_pieces = false;
-       Changed (false);
+       Changed (PlayerProperty::PLAYLIST, false);
 }
 
 void
@@ -265,26 +272,28 @@ Player::film_changed (Film::Property p)
        */
 
        if (p == Film::CONTAINER) {
-               Changed (false);
+               Changed (PlayerProperty::FILM_CONTAINER, false);
        } else if (p == Film::VIDEO_FRAME_RATE) {
                /* Pieces contain a FrameRateChange which contains the DCP frame rate,
                   so we need new pieces here.
                */
                _have_valid_pieces = false;
-               Changed (false);
+               Changed (PlayerProperty::FILM_VIDEO_FRAME_RATE, false);
        } else if (p == Film::AUDIO_PROCESSOR) {
                if (_film->audio_processor ()) {
                        _audio_processor = _film->audio_processor()->clone (_film->audio_frame_rate ());
                }
+       } else if (p == Film::AUDIO_CHANNELS) {
+               _audio_merger.clear ();
        }
 }
 
 list<PositionImage>
-Player::transform_image_subtitles (list<ImageSubtitle> subs) const
+Player::transform_bitmap_texts (list<BitmapText> subs) const
 {
        list<PositionImage> all;
 
-       for (list<ImageSubtitle>::const_iterator i = subs.begin(); i != subs.end(); ++i) {
+       for (list<BitmapText>::const_iterator i = subs.begin(); i != subs.end(); ++i) {
                if (!i->image) {
                        continue;
                }
@@ -292,18 +301,6 @@ Player::transform_image_subtitles (list<ImageSubtitle> subs) const
                /* We will scale the subtitle up to fit _video_container_size */
                dcp::Size scaled_size (i->rectangle.width * _video_container_size.width, i->rectangle.height * _video_container_size.height);
 
-               /* Then we need a corrective translation, consisting of two parts:
-                *
-                * 1.  that which is the result of the scaling of the subtitle by _video_container_size; this will be
-                *     rect.x * _video_container_size.width and rect.y * _video_container_size.height.
-                *
-                * 2.  that to shift the origin of the scale by subtitle_scale to the centre of the subtitle; this will be
-                *     (width_before_subtitle_scale * (1 - subtitle_x_scale) / 2) and
-                *     (height_before_subtitle_scale * (1 - subtitle_y_scale) / 2).
-                *
-                * Combining these two translations gives these expressions.
-                */
-
                all.push_back (
                        PositionImage (
                                i->image->scale (
@@ -336,7 +333,9 @@ Player::black_player_video_frame (Eyes eyes) const
                        _video_container_size,
                        eyes,
                        PART_WHOLE,
-                       PresetColourConversion::all().front().conversion
+                       PresetColourConversion::all().front().conversion,
+                       boost::weak_ptr<Content>(),
+                       boost::optional<Frame>()
                )
        );
 }
@@ -546,7 +545,7 @@ Player::pass ()
                        continue;
                }
 
-               DCPTime const t = content_time_to_dcp (i, i->decoder->position());
+               DCPTime const t = content_time_to_dcp (i, max(i->decoder->position(), i->content->trim_start()));
                if (t > i->content->end()) {
                        i->done = true;
                } else {
@@ -649,7 +648,11 @@ Player::pass ()
 
        if (done) {
                _shuffler->flush ();
+               for (list<pair<shared_ptr<PlayerVideo>, DCPTime> >::const_iterator i = _delay.begin(); i != _delay.end(); ++i) {
+                       do_emit_video(i->first, i->second);
+               }
        }
+
        return done;
 }
 
@@ -660,15 +663,15 @@ Player::subtitles_for_frame (DCPTime time) const
 
        int const vfr = _film->video_frame_rate();
 
-       BOOST_FOREACH (PlayerSubtitles i, _active_subtitles.get_burnt (DCPTimePeriod(time, time + DCPTime::from_frames(1, vfr)), _always_burn_subtitles)) {
+       BOOST_FOREACH (PlayerCaption i, _active_text[TEXT_SUBTITLE].get_burnt (DCPTimePeriod(time, time + DCPTime::from_frames(1, vfr)), _always_burn_subtitles)) {
 
                /* Image subtitles */
-               list<PositionImage> c = transform_image_subtitles (i.image);
+               list<PositionImage> c = transform_bitmap_texts (i.image);
                copy (c.begin(), c.end(), back_inserter (subtitles));
 
                /* Text subtitles (rendered to an image) */
                if (!i.text.empty ()) {
-                       list<PositionImage> s = render_subtitles (i.text, i.fonts, _video_container_size, time, vfr);
+                       list<PositionImage> s = render_text (i.text, i.fonts, _video_container_size, time, vfr);
                        copy (s.begin(), s.end(), back_inserter (subtitles));
                }
        }
@@ -704,7 +707,6 @@ Player::video (weak_ptr<Piece> wp, ContentVideo video)
                return;
        }
 
-
        /* Fill gaps that we discover now that we have some video which needs to be emitted.
           This is where we need to fill to.
        */
@@ -754,7 +756,9 @@ Player::video (weak_ptr<Piece> wp, ContentVideo video)
                        _video_container_size,
                        video.eyes,
                        video.part,
-                       piece->content->video->colour_conversion ()
+                       piece->content->video->colour_conversion(),
+                       piece->content,
+                       video.frame
                        )
                );
 
@@ -835,7 +839,7 @@ Player::audio (weak_ptr<Piece> wp, AudioStreamPtr stream, ContentAudio content_a
 }
 
 void
-Player::image_subtitle_start (weak_ptr<Piece> wp, ContentImageSubtitle subtitle)
+Player::bitmap_text_start (weak_ptr<Piece> wp, ContentBitmapCaption subtitle)
 {
        shared_ptr<Piece> piece = wp.lock ();
        if (!piece) {
@@ -846,32 +850,36 @@ Player::image_subtitle_start (weak_ptr<Piece> wp, ContentImageSubtitle subtitle)
        subtitle.sub.rectangle.x += piece->content->subtitle->x_offset ();
        subtitle.sub.rectangle.y += piece->content->subtitle->y_offset ();
 
+       /* Apply a corrective translation to keep the subtitle centred after the scale that is coming up */
+       subtitle.sub.rectangle.x -= subtitle.sub.rectangle.width * ((piece->content->subtitle->x_scale() - 1) / 2);
+       subtitle.sub.rectangle.y -= subtitle.sub.rectangle.height * ((piece->content->subtitle->y_scale() - 1) / 2);
+
        /* Apply content's subtitle scale */
        subtitle.sub.rectangle.width *= piece->content->subtitle->x_scale ();
        subtitle.sub.rectangle.height *= piece->content->subtitle->y_scale ();
 
-       /* Apply a corrective translation to keep the subtitle centred after that scale */
-       subtitle.sub.rectangle.x -= subtitle.sub.rectangle.width * (piece->content->subtitle->x_scale() - 1);
-       subtitle.sub.rectangle.y -= subtitle.sub.rectangle.height * (piece->content->subtitle->y_scale() - 1);
-
-       PlayerSubtitles ps;
+       PlayerCaption ps;
        ps.image.push_back (subtitle.sub);
        DCPTime from (content_time_to_dcp (piece, subtitle.from()));
 
-       _active_subtitles.add_from (wp, ps, from);
+       _active_text[subtitle.type()].add_from (wp, ps, from);
 }
 
 void
-Player::text_subtitle_start (weak_ptr<Piece> wp, ContentTextSubtitle subtitle)
+Player::plain_text_start (weak_ptr<Piece> wp, ContentTextCaption subtitle)
 {
        shared_ptr<Piece> piece = wp.lock ();
        if (!piece) {
                return;
        }
 
-       PlayerSubtitles ps;
+       PlayerCaption ps;
        DCPTime const from (content_time_to_dcp (piece, subtitle.from()));
 
+       if (from > piece->content->end()) {
+               return;
+       }
+
        BOOST_FOREACH (dcp::SubtitleString s, subtitle.subs) {
                s.set_h_position (s.h_position() + piece->content->subtitle->x_offset ());
                s.set_v_position (s.v_position() + piece->content->subtitle->y_offset ());
@@ -893,17 +901,17 @@ Player::text_subtitle_start (weak_ptr<Piece> wp, ContentTextSubtitle subtitle)
                }
 
                s.set_in (dcp::Time(from.seconds(), 1000));
-               ps.text.push_back (SubtitleString (s, piece->content->subtitle->outline_width()));
+               ps.text.push_back (TextCaption (s, piece->content->subtitle->outline_width()));
                ps.add_fonts (piece->content->subtitle->fonts ());
        }
 
-       _active_subtitles.add_from (wp, ps, from);
+       _active_text[subtitle.type()].add_from (wp, ps, from);
 }
 
 void
-Player::subtitle_stop (weak_ptr<Piece> wp, ContentTime to)
+Player::subtitle_stop (weak_ptr<Piece> wp, ContentTime to, TextType type)
 {
-       if (!_active_subtitles.have (wp)) {
+       if (!_active_text[type].have (wp)) {
                return;
        }
 
@@ -914,10 +922,14 @@ Player::subtitle_stop (weak_ptr<Piece> wp, ContentTime to)
 
        DCPTime const dcp_to = content_time_to_dcp (piece, to);
 
-       pair<PlayerSubtitles, DCPTime> from = _active_subtitles.add_to (wp, dcp_to);
+       if (dcp_to > piece->content->end()) {
+               return;
+       }
+
+       pair<PlayerCaption, DCPTime> from = _active_text[type].add_to (wp, dcp_to);
 
        if (piece->content->subtitle->use() && !_always_burn_subtitles && !piece->content->subtitle->burn()) {
-               Subtitle (from.first, DCPTimePeriod (from.second, dcp_to));
+               Text (from.first, type, DCPTimePeriod (from.second, dcp_to));
        }
 }
 
@@ -932,17 +944,21 @@ Player::seek (DCPTime time, bool accurate)
                _shuffler->clear ();
        }
 
+       _delay.clear ();
+
        if (_audio_processor) {
                _audio_processor->flush ();
        }
 
        _audio_merger.clear ();
-       _active_subtitles.clear ();
+       for (int i = 0; i < TEXT_COUNT; ++i) {
+               _active_text[i].clear ();
+       }
 
        BOOST_FOREACH (shared_ptr<Piece> i, _pieces) {
                if (time < i->content->position()) {
-                       /* Before; seek to 0 */
-                       i->decoder->seek (ContentTime(), accurate);
+                       /* Before; seek to the start of the content */
+                       i->decoder->seek (dcp_to_content_time (i, i->content->position()), accurate);
                        i->done = false;
                } else if (i->content->position() <= time && time < i->content->end()) {
                        /* During; seek to position */
@@ -973,23 +989,50 @@ Player::seek (DCPTime time, bool accurate)
 void
 Player::emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
 {
+       /* We need a delay to give a little wiggle room to ensure that relevent subtitles arrive at the
+          player before the video that requires them.
+       */
+       _delay.push_back (make_pair (pv, time));
+
+       if (pv->eyes() == EYES_BOTH || pv->eyes() == EYES_RIGHT) {
+               _last_video_time = time + one_video_frame();
+       }
+       _last_video_eyes = increment_eyes (pv->eyes());
+
+       if (_delay.size() < 3) {
+               return;
+       }
+
+       pair<shared_ptr<PlayerVideo>, DCPTime> to_do = _delay.front();
+       _delay.pop_front();
+       do_emit_video (to_do.first, to_do.second);
+}
+
+void
+Player::do_emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
+{
+       if (pv->eyes() == EYES_BOTH || pv->eyes() == EYES_RIGHT) {
+               for (int i = 0; i < TEXT_COUNT; ++i) {
+                       _active_text[i].clear_before (time);
+               }
+       }
+
        optional<PositionImage> subtitles = subtitles_for_frame (time);
        if (subtitles) {
                pv->set_subtitle (subtitles.get ());
        }
 
        Video (pv, time);
-
-       if (pv->eyes() == EYES_BOTH || pv->eyes() == EYES_RIGHT) {
-               _last_video_time = time + one_video_frame();
-               _active_subtitles.clear_before (time);
-       }
-       _last_video_eyes = increment_eyes (pv->eyes());
 }
 
 void
 Player::emit_audio (shared_ptr<AudioBuffers> data, DCPTime time)
 {
+       /* Log if the assert below is about to fail */
+       if (_last_audio_time && time != *_last_audio_time) {
+               _film->log()->log(String::compose("Out-of-sequence emit %1 vs %2", to_string(time), to_string(*_last_audio_time)), LogEntry::TYPE_WARNING);
+       }
+
        /* This audio must follow on from the previous */
        DCPOMATIC_ASSERT (!_last_audio_time || time == *_last_audio_time);
        Audio (data, time);
@@ -1047,5 +1090,22 @@ Player::set_dcp_decode_reduction (optional<int> reduction)
 
        _dcp_decode_reduction = reduction;
        _have_valid_pieces = false;
-       Changed (false);
+       Changed (PlayerProperty::DCP_DECODE_REDUCTION, false);
+}
+
+DCPTime
+Player::content_time_to_dcp (shared_ptr<Content> content, ContentTime t)
+{
+       if (_have_valid_pieces) {
+               setup_pieces ();
+       }
+
+       BOOST_FOREACH (shared_ptr<Piece> i, _pieces) {
+               if (i->content == content) {
+                       return content_time_to_dcp (i, t);
+               }
+       }
+
+       DCPOMATIC_ASSERT (false);
+       return DCPTime ();
 }