Add and use new FrameRateChange constructors.
[dcpomatic.git] / src / lib / player.cc
index 91f1cb517c3f6d9fb1db980ad944ebc9807b1278..5a71c133001016b893e6457399d1a8ed1318855e 100644 (file)
@@ -60,7 +60,7 @@
 
 #include "i18n.h"
 
-#define LOG_GENERAL(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
+#define LOG_GENERAL(...) dcpomatic_log->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
 
 using std::list;
 using std::cout;
@@ -87,7 +87,7 @@ int const PlayerProperty::DCP_DECODE_REDUCTION = 704;
 Player::Player (shared_ptr<const Film> film, shared_ptr<const Playlist> playlist)
        : _film (film)
        , _playlist (playlist)
-       , _can_run (false)
+       , _suspended (false)
        , _ignore_video (false)
        , _ignore_audio (false)
        , _ignore_text (false)
@@ -97,14 +97,15 @@ Player::Player (shared_ptr<const Film> film, shared_ptr<const Playlist> playlist
        , _audio_merger (_film->audio_frame_rate())
        , _shuffler (0)
 {
-       _film_changed_connection = _film->Changed.connect (bind (&Player::film_changed, this, _1));
-       _playlist_changed_connection = _playlist->Changed.connect (bind (&Player::playlist_changed, this));
-       _playlist_content_may_change_connection = _playlist->ContentMayChange.connect (bind(&Player::playlist_content_may_change, this));
-       _playlist_content_changed_connection = _playlist->ContentChanged.connect (bind(&Player::playlist_content_changed, this, _1, _2, _3));
-       _playlist_content_not_changed_connection = _playlist->ContentNotChanged.connect (bind(&Player::playlist_content_not_changed, this));
+       _film_changed_connection = _film->Change.connect (bind (&Player::film_change, this, _1, _2));
+       /* The butler must hear about this first, so since we are proxying this through to the butler we must
+          be first.
+       */
+       _playlist_change_connection = _playlist->Change.connect (bind (&Player::playlist_change, this, _1), boost::signals2::at_front);
+       _playlist_content_change_connection = _playlist->ContentChange.connect (bind(&Player::playlist_content_change, this, _1, _3, _4));
        set_video_container_size (_film->frame_size ());
 
-       film_changed (Film::AUDIO_PROCESSOR);
+       film_change (CHANGE_TYPE_DONE, Film::AUDIO_PROCESSOR);
 
        setup_pieces ();
        seek (DCPTime (), true);
@@ -122,6 +123,18 @@ Player::setup_pieces ()
        setup_pieces_unlocked ();
 }
 
+bool
+have_video (shared_ptr<Piece> piece)
+{
+       return piece->decoder && piece->decoder->video;
+}
+
+bool
+have_audio (shared_ptr<Piece> piece)
+{
+       return piece->decoder && piece->decoder->audio;
+}
+
 void
 Player::setup_pieces_unlocked ()
 {
@@ -142,8 +155,8 @@ Player::setup_pieces_unlocked ()
                        continue;
                }
 
-               shared_ptr<Decoder> decoder = decoder_factory (i, _film->log(), _fast);
-               FrameRateChange frc (i->active_video_frame_rate(), _film->video_frame_rate());
+               shared_ptr<Decoder> decoder = decoder_factory (_film, i, _fast);
+               FrameRateChange frc (_film, i);
 
                if (!decoder) {
                        /* Not something that we can decode; e.g. Atmos content */
@@ -198,7 +211,7 @@ Player::setup_pieces_unlocked ()
                                bind(&Player::plain_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
                                );
                        (*j)->Stop.connect (
-                               bind(&Player::subtitle_stop, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1, _2)
+                               bind(&Player::subtitle_stop, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
                                );
 
                        ++j;
@@ -214,98 +227,47 @@ Player::setup_pieces_unlocked ()
                }
        }
 
-       _black = Empty (_film->content(), _film->length(), bind(&Content::video, _1));
-       _silent = Empty (_film->content(), _film->length(), bind(&Content::audio, _1));
+       _black = Empty (_film, _pieces, bind(&have_video, _1));
+       _silent = Empty (_film, _pieces, bind(&have_audio, _1));
 
        _last_video_time = DCPTime ();
        _last_video_eyes = EYES_BOTH;
        _last_audio_time = DCPTime ();
-       _can_run = true;
+       _suspended = false;
 }
 
 void
-Player::playlist_content_may_change ()
+Player::playlist_content_change (ChangeType type, int property, bool frequent)
 {
-       {
+       if (type == CHANGE_TYPE_PENDING) {
                boost::mutex::scoped_lock lm (_mutex);
                /* The player content is probably about to change, so we can't carry on
                   until that has happened and we've rebuilt our pieces.  Stop pass()
                   and seek() from working until then.
                */
-               _can_run = false;
-       }
-
-       MayChange ();
-}
-
-void
-Player::playlist_content_changed (weak_ptr<Content> w, int property, bool frequent)
-{
-       /* A change in our content has gone through.  Re-build our pieces and signal
-          it to anybody that is interested.
-       */
-
-       shared_ptr<Content> c = w.lock ();
-       if (!c) {
-               return;
-       }
-
-       setup_pieces ();
-
-       if (
-               property == ContentProperty::POSITION ||
-               property == ContentProperty::LENGTH ||
-               property == ContentProperty::TRIM_START ||
-               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 == DCPContentProperty::CPL ||
-               property == TextContentProperty::COLOUR ||
-               property == TextContentProperty::EFFECT ||
-               property == TextContentProperty::EFFECT_COLOUR ||
-               property == FFmpegContentProperty::SUBTITLE_STREAM ||
-               property == FFmpegContentProperty::FILTERS ||
-               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 == TextContentProperty::USE ||
-               property == TextContentProperty::X_OFFSET ||
-               property == TextContentProperty::Y_OFFSET ||
-               property == TextContentProperty::X_SCALE ||
-               property == TextContentProperty::FONTS ||
-               property == TextContentProperty::TYPE ||
-               property == VideoContentProperty::CROP ||
-               property == VideoContentProperty::SCALE ||
-               property == VideoContentProperty::FADE_IN ||
-               property == VideoContentProperty::FADE_OUT
-               ) {
-
-               Changed (property, frequent);
+               _suspended = true;
+       } else if (type == CHANGE_TYPE_DONE) {
+               /* A change in our content has gone through.  Re-build our pieces. */
+               setup_pieces ();
+       } else if (type == CHANGE_TYPE_CANCELLED) {
+               boost::mutex::scoped_lock lm (_mutex);
+               _suspended = false;
        }
-}
 
-void
-Player::playlist_content_not_changed ()
-{
-       /* A possible content change did end up happening for some reason */
-       setup_pieces ();
-       NotChanged ();
+       Change (type, property, frequent);
 }
 
 void
 Player::set_video_container_size (dcp::Size s)
 {
+       Change (CHANGE_TYPE_PENDING, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
+
        {
                boost::mutex::scoped_lock lm (_mutex);
 
                if (s == _video_container_size) {
+                       lm.unlock ();
+                       Change (CHANGE_TYPE_CANCELLED, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
                        return;
                }
 
@@ -315,18 +277,20 @@ Player::set_video_container_size (dcp::Size s)
                _black_image->make_black ();
        }
 
-       Changed (PlayerProperty::VIDEO_CONTAINER_SIZE, false);
+       Change (CHANGE_TYPE_DONE, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
 }
 
 void
-Player::playlist_changed ()
+Player::playlist_change (ChangeType type)
 {
-       setup_pieces ();
-       Changed (PlayerProperty::PLAYLIST, false);
+       if (type == CHANGE_TYPE_DONE) {
+               setup_pieces ();
+       }
+       Change (type, PlayerProperty::PLAYLIST, false);
 }
 
 void
-Player::film_changed (Film::Property p)
+Player::film_change (ChangeType type, Film::Property p)
 {
        /* Here we should notice Film properties that affect our output, and
           alert listeners that our output now would be different to how it was
@@ -334,55 +298,26 @@ Player::film_changed (Film::Property p)
        */
 
        if (p == Film::CONTAINER) {
-               Changed (PlayerProperty::FILM_CONTAINER, false);
+               Change (type, 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.
                */
-               setup_pieces ();
-               Changed (PlayerProperty::FILM_VIDEO_FRAME_RATE, false);
+               if (type == CHANGE_TYPE_DONE) {
+                       setup_pieces ();
+               }
+               Change (type, PlayerProperty::FILM_VIDEO_FRAME_RATE, false);
        } else if (p == Film::AUDIO_PROCESSOR) {
-               if (_film->audio_processor ()) {
+               if (type == CHANGE_TYPE_DONE && _film->audio_processor ()) {
                        boost::mutex::scoped_lock lm (_mutex);
                        _audio_processor = _film->audio_processor()->clone (_film->audio_frame_rate ());
                }
        } else if (p == Film::AUDIO_CHANNELS) {
-               boost::mutex::scoped_lock lm (_mutex);
-               _audio_merger.clear ();
-       }
-}
-
-list<PositionImage>
-Player::transform_bitmap_texts (list<BitmapText> subs) const
-{
-       list<PositionImage> all;
-
-       for (list<BitmapText>::const_iterator i = subs.begin(); i != subs.end(); ++i) {
-               if (!i->image) {
-                       continue;
+               if (type == CHANGE_TYPE_DONE) {
+                       boost::mutex::scoped_lock lm (_mutex);
+                       _audio_merger.clear ();
                }
-
-               /* 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);
-
-               all.push_back (
-                       PositionImage (
-                               i->image->scale (
-                                       scaled_size,
-                                       dcp::YUV_TO_RGB_REC601,
-                                       i->image->pixel_format (),
-                                       true,
-                                       _fast
-                                       ),
-                               Position<int> (
-                                       lrint (_video_container_size.width * i->rectangle.x),
-                                       lrint (_video_container_size.height * i->rectangle.y)
-                                       )
-                               )
-                       );
        }
-
-       return all;
 }
 
 shared_ptr<PlayerVideo>
@@ -408,7 +343,7 @@ Frame
 Player::dcp_to_content_video (shared_ptr<const Piece> piece, DCPTime t) const
 {
        DCPTime s = t - piece->content->position ();
-       s = min (piece->content->length_after_trim(), s);
+       s = min (piece->content->length_after_trim(_film), s);
        s = max (DCPTime(), s + DCPTime (piece->content->trim_start(), piece->frc));
 
        /* It might seem more logical here to convert s to a ContentTime (using the FrameRateChange)
@@ -433,7 +368,7 @@ Frame
 Player::dcp_to_resampled_audio (shared_ptr<const Piece> piece, DCPTime t) const
 {
        DCPTime s = t - piece->content->position ();
-       s = min (piece->content->length_after_trim(), s);
+       s = min (piece->content->length_after_trim(_film), s);
        /* See notes in dcp_to_content_video */
        return max (DCPTime (), DCPTime (piece->content->trim_start (), piece->frc) + s).frames_floor (_film->audio_frame_rate ());
 }
@@ -451,7 +386,7 @@ ContentTime
 Player::dcp_to_content_time (shared_ptr<const Piece> piece, DCPTime t) const
 {
        DCPTime s = t - piece->content->position ();
-       s = min (piece->content->length_after_trim(), s);
+       s = min (piece->content->length_after_trim(_film), s);
        return max (ContentTime (), ContentTime (s, piece->frc) + piece->content->trim_start());
 }
 
@@ -545,7 +480,7 @@ Player::get_reel_assets ()
 
                scoped_ptr<DCPDecoder> decoder;
                try {
-                       decoder.reset (new DCPDecoder (j, _film->log(), false));
+                       decoder.reset (new DCPDecoder (_film, j, false));
                } catch (...) {
                        return a;
                }
@@ -591,13 +526,14 @@ Player::get_reel_assets ()
                        }
 
                        if (j->reference_text (TEXT_CLOSED_CAPTION)) {
-                               shared_ptr<dcp::ReelAsset> ra = k->closed_caption ();
-                               DCPOMATIC_ASSERT (ra);
-                               ra->set_entry_point (ra->entry_point() + trim_start);
-                               ra->set_duration (ra->duration() - trim_start - trim_end);
-                               a.push_back (
-                                       ReferencedReelAsset (ra, DCPTimePeriod (from, from + DCPTime::from_frames (ra->duration(), ffr)))
-                                       );
+                               BOOST_FOREACH (shared_ptr<dcp::ReelClosedCaptionAsset> l, k->closed_captions()) {
+                                       DCPOMATIC_ASSERT (l);
+                                       l->set_entry_point (l->entry_point() + trim_start);
+                                       l->set_duration (l->duration() - trim_start - trim_end);
+                                       a.push_back (
+                                               ReferencedReelAsset (l, DCPTimePeriod (from, from + DCPTime::from_frames (l->duration(), ffr)))
+                                               );
+                               }
                        }
 
                        /* Assume that main picture duration is the length of the reel */
@@ -613,12 +549,12 @@ Player::pass ()
 {
        boost::mutex::scoped_lock lm (_mutex);
 
-       if (!_can_run) {
+       if (_suspended) {
                /* We can't pass in this state */
                return false;
        }
 
-       if (_playlist->length() == DCPTime()) {
+       if (_playlist->length(_film) == DCPTime()) {
                /* Special case of an empty Film; just give one black frame */
                emit_video (black_player_video_frame(EYES_BOTH), DCPTime());
                return true;
@@ -635,7 +571,7 @@ Player::pass ()
                }
 
                DCPTime const t = content_time_to_dcp (i, max(i->decoder->position(), i->content->trim_start()));
-               if (t > i->content->end()) {
+               if (t > i->content->end(_film)) {
                        i->done = true;
                } else {
 
@@ -758,8 +694,24 @@ Player::open_subtitles_for_frame (DCPTime time) const
                ) {
 
                /* Bitmap subtitles */
-               list<PositionImage> c = transform_bitmap_texts (j.bitmap);
-               copy (c.begin(), c.end(), back_inserter (captions));
+               BOOST_FOREACH (BitmapText i, j.bitmap) {
+                       if (!i.image) {
+                               continue;
+                       }
+
+                       /* i.image will already have been scaled to fit _video_container_size */
+                       dcp::Size scaled_size (i.rectangle.width * _video_container_size.width, i.rectangle.height * _video_container_size.height);
+
+                       captions.push_back (
+                               PositionImage (
+                                       i.image,
+                                       Position<int> (
+                                               lrint (_video_container_size.width * i.rectangle.x),
+                                               lrint (_video_container_size.height * i.rectangle.y)
+                                               )
+                                       )
+                               );
+               }
 
                /* String subtitles (rendered to an image) */
                if (!j.string.empty ()) {
@@ -783,7 +735,7 @@ Player::video (weak_ptr<Piece> wp, ContentVideo video)
                return;
        }
 
-       FrameRateChange frc(piece->content->active_video_frame_rate(), _film->video_frame_rate());
+       FrameRateChange frc (_film, piece->content);
        if (frc.skip && (video.frame % 2) == 1) {
                return;
        }
@@ -802,14 +754,17 @@ Player::video (weak_ptr<Piece> wp, ContentVideo video)
        /* Fill gaps that we discover now that we have some video which needs to be emitted.
           This is where we need to fill to.
        */
-       DCPTime fill_to = min (time, piece->content->end());
+       DCPTime fill_to = min (time, piece->content->end(_film));
 
        if (_last_video_time) {
                DCPTime fill_from = max (*_last_video_time, piece->content->position());
                LastVideoMap::const_iterator last = _last_video.find (wp);
                if (_film->three_d()) {
                        Eyes fill_to_eyes = video.eyes;
-                       if (fill_to == piece->content->end()) {
+                       if (fill_to_eyes == EYES_BOTH) {
+                               fill_to_eyes = EYES_LEFT;
+                       }
+                       if (fill_to == piece->content->end(_film)) {
                                /* Don't fill after the end of the content */
                                fill_to_eyes = EYES_LEFT;
                        }
@@ -846,7 +801,7 @@ Player::video (weak_ptr<Piece> wp, ContentVideo video)
                new PlayerVideo (
                        video.image,
                        piece->content->video->crop (),
-                       piece->content->video->fade (video.frame),
+                       piece->content->video->fade (_film, video.frame),
                        piece->content->video->scale().size (
                                piece->content->video, _video_container_size, _film->frame_size ()
                                ),
@@ -861,7 +816,7 @@ Player::video (weak_ptr<Piece> wp, ContentVideo video)
 
        DCPTime t = time;
        for (int i = 0; i < frc.repeat; ++i) {
-               if (t < piece->content->end()) {
+               if (t < piece->content->end(_film)) {
                        emit_video (_last_video[wp], t);
                }
                t += one_video_frame ();
@@ -884,7 +839,7 @@ Player::audio (weak_ptr<Piece> wp, AudioStreamPtr stream, ContentAudio content_a
        /* Compute time in the DCP */
        DCPTime time = resampled_audio_to_dcp (piece, content_audio.frame);
        /* And the end of this block in the DCP */
-       DCPTime end = time + DCPTime::from_frames(content_audio.audio->frames(), content->resampled_frame_rate());
+       DCPTime end = time + DCPTime::from_frames(content_audio.audio->frames(), content->resampled_frame_rate(_film));
 
        /* Remove anything that comes before the start or after the end of the content */
        if (time < piece->content->position()) {
@@ -895,11 +850,11 @@ Player::audio (weak_ptr<Piece> wp, AudioStreamPtr stream, ContentAudio content_a
                }
                content_audio.audio = cut.first;
                time = cut.second;
-       } else if (time > piece->content->end()) {
+       } else if (time > piece->content->end(_film)) {
                /* Discard it all */
                return;
-       } else if (end > piece->content->end()) {
-               Frame const remaining_frames = DCPTime(piece->content->end() - time).frames_round(_film->audio_frame_rate());
+       } else if (end > piece->content->end(_film)) {
+               Frame const remaining_frames = DCPTime(piece->content->end(_film) - time).frames_round(_film->audio_frame_rate());
                if (remaining_frames == 0) {
                        return;
                }
@@ -957,10 +912,13 @@ Player::bitmap_text_start (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, C
        subtitle.sub.rectangle.height *= text->y_scale ();
 
        PlayerText ps;
-       ps.bitmap.push_back (subtitle.sub);
+       shared_ptr<Image> image = subtitle.sub.image;
+       /* We will scale the subtitle up to fit _video_container_size */
+       dcp::Size scaled_size (subtitle.sub.rectangle.width * _video_container_size.width, subtitle.sub.rectangle.height * _video_container_size.height);
+       ps.bitmap.push_back (BitmapText(image->scale(scaled_size, dcp::YUV_TO_RGB_REC601, image->pixel_format(), true, _fast), subtitle.sub.rectangle));
        DCPTime from (content_time_to_dcp (piece, subtitle.from()));
 
-       _active_texts[subtitle.type()].add_from (wc, ps, from);
+       _active_texts[text->type()].add_from (wc, ps, from);
 }
 
 void
@@ -975,7 +933,7 @@ Player::plain_text_start (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, Co
        PlayerText ps;
        DCPTime const from (content_time_to_dcp (piece, subtitle.from()));
 
-       if (from > piece->content->end()) {
+       if (from > piece->content->end(_film)) {
                return;
        }
 
@@ -1004,33 +962,37 @@ Player::plain_text_start (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, Co
                ps.add_fonts (text->fonts ());
        }
 
-       _active_texts[subtitle.type()].add_from (wc, ps, from);
+       _active_texts[text->type()].add_from (wc, ps, from);
 }
 
 void
-Player::subtitle_stop (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentTime to, TextType type)
+Player::subtitle_stop (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentTime to)
 {
-       if (!_active_texts[type].have (wc)) {
+       shared_ptr<const TextContent> text = wc.lock ();
+       if (!text) {
+               return;
+       }
+
+       if (!_active_texts[text->type()].have(wc)) {
                return;
        }
 
        shared_ptr<Piece> piece = wp.lock ();
-       shared_ptr<const TextContent> text = wc.lock ();
-       if (!piece || !text) {
+       if (!piece) {
                return;
        }
 
        DCPTime const dcp_to = content_time_to_dcp (piece, to);
 
-       if (dcp_to > piece->content->end()) {
+       if (dcp_to > piece->content->end(_film)) {
                return;
        }
 
-       pair<PlayerText, DCPTime> from = _active_texts[type].add_to (wc, dcp_to);
+       pair<PlayerText, DCPTime> from = _active_texts[text->type()].add_to (wc, dcp_to);
 
-       bool const always = (type == TEXT_OPEN_SUBTITLE && _always_burn_open_subtitles);
+       bool const always = (text->type() == TEXT_OPEN_SUBTITLE && _always_burn_open_subtitles);
        if (text->use() && !always && !text->burn()) {
-               Text (from.first, type, DCPTimePeriod (from.second, dcp_to));
+               Text (from.first, text->type(), text->dcp_track().get_value_or(DCPTextTrack()), DCPTimePeriod (from.second, dcp_to));
        }
 }
 
@@ -1039,7 +1001,7 @@ Player::seek (DCPTime time, bool accurate)
 {
        boost::mutex::scoped_lock lm (_mutex);
 
-       if (!_can_run) {
+       if (_suspended) {
                /* We can't seek in this state */
                return;
        }
@@ -1064,7 +1026,7 @@ Player::seek (DCPTime time, bool 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()) {
+               } else if (i->content->position() <= time && time < i->content->end(_film)) {
                        /* During; seek to position */
                        i->decoder->seek (dcp_to_content_time (i, time), accurate);
                        i->done = false;
@@ -1188,10 +1150,14 @@ Player::discard_audio (shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTi
 void
 Player::set_dcp_decode_reduction (optional<int> reduction)
 {
+       Change (CHANGE_TYPE_PENDING, PlayerProperty::DCP_DECODE_REDUCTION, false);
+
        {
                boost::mutex::scoped_lock lm (_mutex);
 
                if (reduction == _dcp_decode_reduction) {
+                       lm.unlock ();
+                       Change (CHANGE_TYPE_CANCELLED, PlayerProperty::DCP_DECODE_REDUCTION, false);
                        return;
                }
 
@@ -1199,7 +1165,7 @@ Player::set_dcp_decode_reduction (optional<int> reduction)
                setup_pieces_unlocked ();
        }
 
-       Changed (PlayerProperty::DCP_DECODE_REDUCTION, false);
+       Change (CHANGE_TYPE_DONE, PlayerProperty::DCP_DECODE_REDUCTION, false);
 }
 
 optional<DCPTime>