Fix up black-filling logic.
[dcpomatic.git] / src / lib / player.cc
index 44e2d16526ffddf58425f4c965dc4ee501937857..11440ec5e6d15d82355173162650e05b5df1f8c9 100644 (file)
@@ -87,6 +87,7 @@ Player::Player (shared_ptr<const Film> film, shared_ptr<const Playlist> playlist
        , _always_burn_subtitles (false)
        , _fast (false)
        , _play_referenced (false)
+       , _last_seek_accurate (true)
        , _audio_merger (_film->audio_frame_rate())
 {
        _film_changed_connection = _film->Changed.connect (bind (&Player::film_changed, this, _1));
@@ -143,8 +144,9 @@ Player::setup_pieces ()
                }
 
                if (decoder->subtitle) {
-                       decoder->subtitle->ImageData.connect (bind (&Player::image_subtitle, this, weak_ptr<Piece> (piece), _1));
-                       decoder->subtitle->TextData.connect (bind (&Player::text_subtitle, this, weak_ptr<Piece> (piece), _1));
+                       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));
                }
        }
 
@@ -416,13 +418,6 @@ Player::set_ignore_video ()
        _ignore_video = true;
 }
 
-/** Set this player never to produce any audio data */
-void
-Player::set_ignore_audio ()
-{
-       _ignore_audio = true;
-}
-
 /** Set whether or not this player should always burn text subtitles into the image,
  *  regardless of the content settings.
  *  @param burn true to always burn subtitles, false to obey content settings.
@@ -513,23 +508,6 @@ Player::get_reel_assets ()
        return a;
 }
 
-list<shared_ptr<Piece> >
-Player::overlaps (DCPTime from, DCPTime to, boost::function<bool (Content *)> valid)
-{
-       if (!_have_valid_pieces) {
-               setup_pieces ();
-       }
-
-       list<shared_ptr<Piece> > overlaps;
-       BOOST_FOREACH (shared_ptr<Piece> i, _pieces) {
-               if (valid (i->content.get ()) && i->content->position() < to && i->content->end() > from) {
-                       overlaps.push_back (i);
-               }
-       }
-
-       return overlaps;
-}
-
 bool
 Player::pass ()
 {
@@ -550,27 +528,35 @@ Player::pass ()
                }
        }
 
-       if (!earliest) {
-               /* No more content; fill up with silent black */
-               DCPTimePeriod remaining_video (DCPTime(), _playlist->length());
-               if (_last_video_time) {
-                       remaining_video.from = _last_video_time.get() + one_video_frame();
-               }
-               fill_video (remaining_video);
-               DCPTimePeriod remaining_audio (DCPTime(), _playlist->length());
-               if (_last_audio_time) {
-                       remaining_audio.from = _last_audio_time.get();
+       if (earliest) {
+               earliest->done = earliest->decoder->pass ();
+               if (earliest->done && earliest->content->audio) {
+                       /* Flush the Player audio system for this piece */
+                       BOOST_FOREACH (AudioStreamPtr i, earliest->content->audio->streams()) {
+                               audio_flush (earliest, i);
+                       }
                }
-               fill_audio (remaining_audio);
-               return true;
        }
 
-       earliest->done = earliest->decoder->pass ();
-       if (earliest->done && earliest->content->audio) {
-               /* Flush the Player audio system for this piece */
-               BOOST_FOREACH (AudioStreamPtr i, earliest->content->audio->streams()) {
-                       audio_flush (earliest, i);
-               }
+       DCPTime fill_towards = earliest ? earliest_content : _playlist->length();
+
+       optional<DCPTime> fill_from;
+       if (_last_video_time) {
+               /* No seek; fill towards the next thing that might happen (or the end of the playlist) */
+               fill_from = _last_video_time;
+       } else if (_last_seek_time && !_playlist->video_content_at(_last_seek_time.get())) {
+               /* Seek into an empty area; fill from the seek time */
+               fill_from = _last_seek_time;
+       }
+
+       if (fill_from && ((fill_towards - fill_from.get())) > one_video_frame()) {
+               emit_video (black_player_video_frame(), fill_from.get());
+       } else if (_playlist->length() == DCPTime()) {
+               emit_video (black_player_video_frame(), DCPTime());
+       }
+
+       if (!earliest && !fill_from) {
+               return true;
        }
 
        /* Emit any audio that is ready */
@@ -584,10 +570,21 @@ Player::pass ()
 
        list<pair<shared_ptr<AudioBuffers>, DCPTime> > audio = _audio_merger.pull (pull_from);
        for (list<pair<shared_ptr<AudioBuffers>, DCPTime> >::iterator i = audio.begin(); i != audio.end(); ++i) {
-               DCPOMATIC_ASSERT (!_last_audio_time || i->second >= _last_audio_time.get());
+               if (_last_audio_time && i->second < _last_audio_time.get()) {
+                       /* There has been an accurate seek and we have received some audio before the seek time;
+                          discard it.
+                       */
+                       pair<shared_ptr<AudioBuffers>, DCPTime> cut = discard_audio (i->first, i->second, *_last_audio_time);
+                       if (!cut.first) {
+                               continue;
+                       }
+                       *i = cut;
+               }
+
                if (_last_audio_time) {
                        fill_audio (DCPTimePeriod (_last_audio_time.get(), i->second));
                }
+
                Audio (i->first, i->second);
                _last_audio_time = i->second + DCPTime::from_frames(i->first->frames(), _film->audio_frame_rate());
        }
@@ -595,6 +592,31 @@ Player::pass ()
        return false;
 }
 
+optional<PositionImage>
+Player::subtitles_for_frame (DCPTime time) const
+{
+       list<PositionImage> subtitles;
+
+       BOOST_FOREACH (PlayerSubtitles i, _active_subtitles.get_burnt (time, _always_burn_subtitles)) {
+
+               /* Image subtitles */
+               list<PositionImage> c = transform_image_subtitles (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);
+                       copy (s.begin(), s.end(), back_inserter (subtitles));
+               }
+       }
+
+       if (subtitles.empty ()) {
+               return optional<PositionImage> ();
+       }
+
+       return merge (subtitles);
+}
+
 void
 Player::video (weak_ptr<Piece> wp, ContentVideo video)
 {
@@ -612,42 +634,29 @@ Player::video (weak_ptr<Piece> wp, ContentVideo video)
        DCPTime const time = content_video_to_dcp (piece, video.frame);
        DCPTimePeriod const period (time, time + one_video_frame());
 
-       /* Discard if it's outside the content's period */
-       if (time < piece->content->position() || time >= piece->content->end()) {
+       /* Discard if it's outside the content's period or if it's before the last accurate seek */
+       if (
+               time < piece->content->position() ||
+               time >= piece->content->end() ||
+               (_last_seek_time && _last_seek_accurate && time < _last_seek_time.get())) {
                return;
        }
 
-       /* Get any subtitles */
-
-       optional<PositionImage> subtitles;
-
-       for (list<pair<PlayerSubtitles, DCPTimePeriod> >::const_iterator i = _subtitles.begin(); i != _subtitles.end(); ++i) {
-
-               if (!i->second.overlap (period)) {
-                       continue;
-               }
-
-               list<PositionImage> sub_images;
-
-               /* Image subtitles */
-               list<PositionImage> c = transform_image_subtitles (i->first.image);
-               copy (c.begin(), c.end(), back_inserter (sub_images));
-
-               /* Text subtitles (rendered to an image) */
-               if (!i->first.text.empty ()) {
-                       list<PositionImage> s = render_subtitles (i->first.text, i->first.fonts, _video_container_size, time);
-                       copy (s.begin (), s.end (), back_inserter (sub_images));
-               }
-
-               if (!sub_images.empty ()) {
-                       subtitles = merge (sub_images);
-               }
-       }
-
-       /* Fill gaps */
+       /* Fill gaps caused by (the hopefully rare event of) a decoder not emitting contiguous video.  We have to do this here
+          as in the problematic case we are about to emit a frame which is not contiguous with the previous.
+       */
 
        if (_last_video_time) {
-               fill_video (DCPTimePeriod (_last_video_time.get() + one_video_frame(), time));
+               /* XXX: this may not work for 3D */
+               BOOST_FOREACH (DCPTimePeriod i, subtract(DCPTimePeriod (_last_video_time.get(), time), _no_video)) {
+                       for (DCPTime j = i.from; j < i.to; j += one_video_frame()) {
+                               if (_last_video) {
+                                       emit_video (shared_ptr<PlayerVideo> (new PlayerVideo (*_last_video)), j);
+                               } else {
+                                       emit_video (black_player_video_frame(), j);
+                               }
+                       }
+               }
        }
 
        _last_video.reset (
@@ -665,26 +674,7 @@ Player::video (weak_ptr<Piece> wp, ContentVideo video)
                        )
                );
 
-       if (subtitles) {
-               _last_video->set_subtitle (subtitles.get ());
-       }
-
-       _last_video_time = time;
-
-       Video (_last_video, *_last_video_time);
-
-       /* Discard any subtitles we no longer need */
-
-       for (list<pair<PlayerSubtitles, DCPTimePeriod> >::iterator i = _subtitles.begin (); i != _subtitles.end(); ) {
-               list<pair<PlayerSubtitles, DCPTimePeriod> >::iterator tmp = i;
-               ++tmp;
-
-               if (i->second.to < time) {
-                       _subtitles.erase (i);
-               }
-
-               i = tmp;
-       }
+       emit_video (_last_video, time);
 }
 
 void
@@ -699,6 +689,10 @@ Player::audio_flush (shared_ptr<Piece> piece, AudioStreamPtr stream)
        }
 
        pair<shared_ptr<const AudioBuffers>, Frame> ro = r->flush ();
+       if (ro.first->frames() == 0) {
+               return;
+       }
+
        ContentAudio content_audio;
        content_audio.audio = ro.first;
        content_audio.frame = ro.second;
@@ -713,6 +707,8 @@ Player::audio_flush (shared_ptr<Piece> piece, AudioStreamPtr stream)
 void
 Player::audio_transform (shared_ptr<AudioContent> content, AudioStreamPtr stream, ContentAudio content_audio, DCPTime time)
 {
+       DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
+
        /* Gain */
 
        if (content->gain() != 0) {
@@ -758,6 +754,8 @@ Player::audio_transform (shared_ptr<AudioContent> content, AudioStreamPtr stream
 void
 Player::audio (weak_ptr<Piece> wp, AudioStreamPtr stream, ContentAudio content_audio)
 {
+       DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
+
        shared_ptr<Piece> piece = wp.lock ();
        if (!piece) {
                return;
@@ -770,6 +768,9 @@ Player::audio (weak_ptr<Piece> wp, AudioStreamPtr stream, ContentAudio content_a
        if (stream->frame_rate() != content->resampled_frame_rate()) {
                shared_ptr<Resampler> r = resampler (content, stream, true);
                pair<shared_ptr<const AudioBuffers>, Frame> ro = r->run (content_audio.audio, content_audio.frame);
+               if (ro.first->frames() == 0) {
+                       return;
+               }
                content_audio.audio = ro.first;
                content_audio.frame = ro.second;
        }
@@ -781,22 +782,19 @@ Player::audio (weak_ptr<Piece> wp, AudioStreamPtr stream, ContentAudio content_a
 
        /* Remove anything that comes before the start or after the end of the content */
        if (time < piece->content->position()) {
-               DCPTime const discard_time = piece->content->position() - time;
-               Frame discard_frames = discard_time.frames_round(_film->audio_frame_rate());
-               Frame remaining_frames = content_audio.audio->frames() - discard_frames;
-               if (remaining_frames <= 0) {
+               pair<shared_ptr<AudioBuffers>, DCPTime> cut = discard_audio (content_audio.audio, time, piece->content->position());
+               if (!cut.first) {
                        /* This audio is entirely discarded */
                        return;
                }
-               shared_ptr<AudioBuffers> cut (new AudioBuffers (content_audio.audio->channels(), remaining_frames));
-               cut->copy_from (content_audio.audio.get(), remaining_frames, discard_frames, 0);
-               content_audio.audio = cut;
-               time += discard_time;
+               content_audio.audio = cut.first;
+               time = cut.second;
        } else if (time > piece->content->end()) {
                /* 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());
+               DCPOMATIC_ASSERT (remaining_frames > 0);
                shared_ptr<AudioBuffers> cut (new AudioBuffers (content_audio.audio->channels(), remaining_frames));
                cut->copy_from (content_audio.audio.get(), remaining_frames, 0, 0);
                content_audio.audio = cut;
@@ -806,7 +804,7 @@ Player::audio (weak_ptr<Piece> wp, AudioStreamPtr stream, ContentAudio content_a
 }
 
 void
-Player::image_subtitle (weak_ptr<Piece> wp, ContentImageSubtitle subtitle)
+Player::image_subtitle_start (weak_ptr<Piece> wp, ContentImageSubtitle subtitle)
 {
        shared_ptr<Piece> piece = wp.lock ();
        if (!piece) {
@@ -827,17 +825,13 @@ Player::image_subtitle (weak_ptr<Piece> wp, ContentImageSubtitle subtitle)
 
        PlayerSubtitles ps;
        ps.image.push_back (subtitle.sub);
-       DCPTimePeriod period (content_time_to_dcp (piece, subtitle.period().from), content_time_to_dcp (piece, subtitle.period().to));
+       DCPTime from (content_time_to_dcp (piece, subtitle.from()));
 
-       if (piece->content->subtitle->use() && (piece->content->subtitle->burn() || _always_burn_subtitles)) {
-               _subtitles.push_back (make_pair (ps, period));
-       } else {
-               Subtitle (ps, period);
-       }
+       _active_subtitles.add_from (wp, ps, from);
 }
 
 void
-Player::text_subtitle (weak_ptr<Piece> wp, ContentTextSubtitle subtitle)
+Player::text_subtitle_start (weak_ptr<Piece> wp, ContentTextSubtitle subtitle)
 {
        shared_ptr<Piece> piece = wp.lock ();
        if (!piece) {
@@ -845,7 +839,7 @@ Player::text_subtitle (weak_ptr<Piece> wp, ContentTextSubtitle subtitle)
        }
 
        PlayerSubtitles ps;
-       DCPTimePeriod const period (content_time_to_dcp (piece, subtitle.period().from), content_time_to_dcp (piece, subtitle.period().to));
+       DCPTime const from (content_time_to_dcp (piece, subtitle.from()));
 
        BOOST_FOREACH (dcp::SubtitleString s, subtitle.subs) {
                s.set_h_position (s.h_position() + piece->content->subtitle->x_offset ());
@@ -867,16 +861,32 @@ Player::text_subtitle (weak_ptr<Piece> wp, ContentTextSubtitle subtitle)
                        s.set_aspect_adjust (xs / ys);
                }
 
-               s.set_in (dcp::Time(period.from.seconds(), 1000));
-               s.set_out (dcp::Time(period.to.seconds(), 1000));
+               s.set_in (dcp::Time(from.seconds(), 1000));
                ps.text.push_back (SubtitleString (s, piece->content->subtitle->outline_width()));
                ps.add_fonts (piece->content->subtitle->fonts ());
        }
 
-       if (piece->content->subtitle->use() && (piece->content->subtitle->burn() || _always_burn_subtitles)) {
-               _subtitles.push_back (make_pair (ps, period));
-       } else {
-               Subtitle (ps, period);
+       _active_subtitles.add_from (wp, ps, from);
+}
+
+void
+Player::subtitle_stop (weak_ptr<Piece> wp, ContentTime to)
+{
+       if (!_active_subtitles.have (wp)) {
+               return;
+       }
+
+       shared_ptr<Piece> piece = wp.lock ();
+       if (!piece) {
+               return;
+       }
+
+       DCPTime const dcp_to = content_time_to_dcp (piece, to);
+
+       pair<PlayerSubtitles, DCPTime> from = _active_subtitles.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));
        }
 }
 
@@ -887,20 +897,33 @@ Player::seek (DCPTime time, bool accurate)
                _audio_processor->flush ();
        }
 
+       for (ResamplerMap::iterator i = _resamplers.begin(); i != _resamplers.end(); ++i) {
+               i->second->flush ();
+               i->second->reset ();
+       }
+
+       _audio_merger.clear ();
+       _active_subtitles.clear ();
+
        BOOST_FOREACH (shared_ptr<Piece> i, _pieces) {
-               if (i->content->position() <= time && time < i->content->end()) {
+               if (time < i->content->position()) {
+                       /* Before; seek to 0 */
+                       i->decoder->seek (ContentTime(), accurate);
+                       i->done = false;
+               } else if (i->content->position() <= time && time < i->content->end()) {
+                       /* During; seek to position */
                        i->decoder->seek (dcp_to_content_time (i, time), accurate);
                        i->done = false;
+               } else {
+                       /* After; this piece is done */
+                       i->done = true;
                }
        }
 
-       if (accurate) {
-               _last_video_time = time - one_video_frame ();
-               _last_audio_time = time;
-       } else {
-               _last_video_time = optional<DCPTime> ();
-               _last_audio_time = optional<DCPTime> ();
-       }
+       _last_video_time = optional<DCPTime> ();
+       _last_audio_time = optional<DCPTime> ();
+       _last_seek_time = time;
+       _last_seek_accurate = accurate;
 }
 
 shared_ptr<Resampler>
@@ -931,18 +954,15 @@ Player::resampler (shared_ptr<const AudioContent> content, AudioStreamPtr stream
 }
 
 void
-Player::fill_video (DCPTimePeriod period)
-{
-       /* XXX: this may not work for 3D */
-       BOOST_FOREACH (DCPTimePeriod i, subtract(period, _no_video)) {
-               for (DCPTime j = i.from; j < i.to; j += one_video_frame()) {
-                       if (_playlist->video_content_at(j) && _last_video) {
-                               Video (shared_ptr<PlayerVideo> (new PlayerVideo (*_last_video)), j);
-                       } else {
-                               Video (black_player_video_frame(), j);
-                       }
-               }
+Player::emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
+{
+       optional<PositionImage> subtitles = subtitles_for_frame (time);
+       if (subtitles) {
+               pv->set_subtitle (subtitles.get ());
        }
+       Video (pv, time);
+       _last_video_time = time + one_video_frame();
+       _active_subtitles.clear_before (time);
 }
 
 void
@@ -968,3 +988,17 @@ Player::one_video_frame () const
 {
        return DCPTime::from_frames (1, _film->video_frame_rate ());
 }
+
+pair<shared_ptr<AudioBuffers>, DCPTime>
+Player::discard_audio (shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to) const
+{
+       DCPTime const discard_time = discard_to - time;
+       Frame const discard_frames = discard_time.frames_round(_film->audio_frame_rate());
+       Frame remaining_frames = audio->frames() - discard_frames;
+       if (remaining_frames <= 0) {
+               return make_pair(shared_ptr<AudioBuffers>(), DCPTime());
+       }
+       shared_ptr<AudioBuffers> cut (new AudioBuffers (audio->channels(), remaining_frames));
+       cut->copy_from (audio.get(), remaining_frames, discard_frames, 0);
+       return make_pair(cut, time + discard_time);
+}