Use an enum for the effect in SubtitleContent.
[dcpomatic.git] / src / lib / player.cc
index 82159df719800fc36028267160472f3087fe453d..8e56991f816eb10a843fdf90261d561937fcaa5d 100644 (file)
@@ -82,7 +82,7 @@ Player::Player (shared_ptr<const Film> film, shared_ptr<const Playlist> playlist
        , _playlist (playlist)
        , _have_valid_pieces (false)
        , _ignore_video (false)
-       , _ignore_audio (false)
+       , _ignore_subtitle (false)
        , _always_burn_subtitles (false)
        , _fast (false)
        , _play_referenced (false)
@@ -109,7 +109,7 @@ Player::setup_pieces ()
                        continue;
                }
 
-               shared_ptr<Decoder> decoder = decoder_factory (i, _film->log());
+               shared_ptr<Decoder> decoder = decoder_factory (i, _film->log(), _fast);
                FrameRateChange frc (i->active_video_frame_rate(), _film->video_frame_rate());
 
                if (!decoder) {
@@ -121,13 +121,16 @@ Player::setup_pieces ()
                        decoder->video->set_ignore ();
                }
 
-               if (decoder->audio && _ignore_audio) {
-                       decoder->audio->set_ignore ();
+               if (decoder->subtitle && _ignore_subtitle) {
+                       decoder->subtitle->set_ignore ();
                }
 
                shared_ptr<DCPDecoder> dcp = dynamic_pointer_cast<DCPDecoder> (decoder);
                if (dcp && _play_referenced) {
-                       dcp->set_decode_referenced ();
+                       if (_play_referenced) {
+                               dcp->set_decode_referenced ();
+                       }
+                       dcp->set_forced_reduction (_dcp_decode_reduction);
                }
 
                shared_ptr<Piece> piece (new Piece (i, decoder, frc));
@@ -148,6 +151,7 @@ Player::setup_pieces ()
                }
        }
 
+       _stream_states.clear ();
        BOOST_FOREACH (shared_ptr<Piece> i, _pieces) {
                if (i->content->audio) {
                        BOOST_FOREACH (AudioStreamPtr j, i->content->audio->streams()) {
@@ -156,19 +160,8 @@ Player::setup_pieces ()
                }
        }
 
-       if (!_play_referenced) {
-               BOOST_FOREACH (shared_ptr<Piece> i, _pieces) {
-                       shared_ptr<DCPContent> dc = dynamic_pointer_cast<DCPContent> (i->content);
-                       if (dc) {
-                               if (dc->reference_video()) {
-                                       _no_video.push_back (DCPTimePeriod (dc->position(), dc->end()));
-                               }
-                               if (dc->reference_audio()) {
-                                       _no_audio.push_back (DCPTimePeriod (dc->position(), dc->end()));
-                               }
-                       }
-               }
-       }
+       _black = Empty (_film->content(), _film->length(), bind(&Content::video, _1));
+       _silent = Empty (_film->content(), _film->length(), bind(&Content::audio, _1));
 
        _last_video_time = DCPTime ();
        _last_audio_time = DCPTime ();
@@ -193,10 +186,10 @@ Player::playlist_content_changed (weak_ptr<Content> w, int property, bool freque
                property == DCPContentProperty::NEEDS_ASSETS ||
                property == DCPContentProperty::NEEDS_KDM ||
                property == SubtitleContentProperty::COLOUR ||
-               property == SubtitleContentProperty::OUTLINE ||
-               property == SubtitleContentProperty::SHADOW ||
+               property == SubtitleContentProperty::EFFECT ||
                property == SubtitleContentProperty::EFFECT_COLOUR ||
                property == FFmpegContentProperty::SUBTITLE_STREAM ||
+               property == FFmpegContentProperty::FILTERS ||
                property == VideoContentProperty::COLOUR_CONVERSION
                ) {
 
@@ -353,8 +346,8 @@ DCPTime
 Player::content_video_to_dcp (shared_ptr<const Piece> piece, Frame f) const
 {
        /* See comment in dcp_to_content_video */
-       DCPTime const d = DCPTime::from_frames (f * piece->frc.factor(), piece->frc.dcp) - DCPTime (piece->content->trim_start (), piece->frc);
-       return max (DCPTime (), d + piece->content->position ());
+       DCPTime const d = DCPTime::from_frames (f * piece->frc.factor(), piece->frc.dcp) - DCPTime(piece->content->trim_start(), piece->frc);
+       return d + piece->content->position();
 }
 
 Frame
@@ -370,8 +363,9 @@ DCPTime
 Player::resampled_audio_to_dcp (shared_ptr<const Piece> piece, Frame f) const
 {
        /* See comment in dcp_to_content_video */
-       DCPTime const d = DCPTime::from_frames (f, _film->audio_frame_rate()) - DCPTime (piece->content->trim_start(), piece->frc);
-       return max (DCPTime (), d + piece->content->position ());
+       return DCPTime::from_frames (f, _film->audio_frame_rate())
+               - DCPTime (piece->content->trim_start(), piece->frc)
+               + piece->content->position();
 }
 
 ContentTime
@@ -416,6 +410,12 @@ Player::set_ignore_video ()
        _ignore_video = true;
 }
 
+void
+Player::set_ignore_subtitle ()
+{
+       _ignore_subtitle = 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.
@@ -426,6 +426,7 @@ Player::set_always_burn_subtitles (bool burn)
        _always_burn_subtitles = burn;
 }
 
+/** Sets up the player to be faster, possibly at the expense of quality */
 void
 Player::set_fast ()
 {
@@ -453,7 +454,7 @@ Player::get_reel_assets ()
 
                scoped_ptr<DCPDecoder> decoder;
                try {
-                       decoder.reset (new DCPDecoder (j, _film->log()));
+                       decoder.reset (new DCPDecoder (j, _film->log(), false));
                } catch (...) {
                        return a;
                }
@@ -513,77 +514,85 @@ Player::pass ()
                setup_pieces ();
        }
 
-       shared_ptr<Piece> earliest;
-       DCPTime earliest_content;
+       if (_playlist->length() == DCPTime()) {
+               /* Special case of an empty Film; just give one black frame */
+               emit_video (black_player_video_frame(), DCPTime());
+               return true;
+       }
+
+       /* Find the decoder or empty which is farthest behind where we are and make it emit some data */
+
+       shared_ptr<Piece> earliest_content;
+       optional<DCPTime> earliest_time;
 
        BOOST_FOREACH (shared_ptr<Piece> i, _pieces) {
-               if (!i->done) {
-                       DCPTime const t = content_time_to_dcp (i, i->decoder->position());
-                       if (!earliest || t < earliest_content) {
-                               earliest_content = t;
-                               earliest = i;
+               if (i->done) {
+                       continue;
+               }
+
+               DCPTime const t = content_time_to_dcp (i, i->decoder->position());
+               if (t > i->content->end()) {
+                       i->done = true;
+               } else {
+                       /* Given two choices at the same time, pick the one with a subtitle so we see it before
+                          the video.
+                       */
+                       if (!earliest_time || t < *earliest_time || (t == *earliest_time && i->decoder->subtitle)) {
+                               earliest_time = t;
+                               earliest_content = i;
                        }
                }
        }
 
-       /* Fill towards the next thing that might happen (or the end of the playlist).  This is to fill gaps between content,
-          NOT to fill gaps within content (the latter is done in ::video())
-       */
-       DCPTime fill_towards = earliest ? earliest_content : _playlist->length().ceil(_film->video_frame_rate());
+       bool done = false;
 
-       /* Work out where to fill video from */
-       optional<DCPTime> video_fill_from;
-       if (_last_video_time) {
-               /* Fill from the last video or seek time */
-               video_fill_from = _last_video_time;
-       }
+       enum {
+               NONE,
+               CONTENT,
+               BLACK,
+               SILENT
+       } which = NONE;
 
-       bool filled = false;
-       /* Fill some black if we would emit before the earliest piece of content.  This is so we act like a phantom
-          Piece which emits black in spaces (we only emit if we are the earliest thing)
-       */
-       if (video_fill_from && (!earliest || *video_fill_from < earliest_content) && ((fill_towards - *video_fill_from)) >= one_video_frame()) {
-               list<DCPTimePeriod> p = subtract(DCPTimePeriod(*video_fill_from, *video_fill_from + one_video_frame()), _no_video);
-               if (!p.empty ()) {
-                       emit_video (black_player_video_frame(), p.front().from);
-                       filled = true;
-               }
-       } else if (_playlist->length() == DCPTime()) {
-               /* Special case of an empty Film; just give one black frame */
-               emit_video (black_player_video_frame(), DCPTime());
-               filled = true;
+       if (earliest_content) {
+               which = CONTENT;
        }
 
-       optional<DCPTime> audio_fill_from;
-       if (_last_audio_time) {
-               /* Fill from the last audio or seek time */
-               audio_fill_from = _last_audio_time;
+       if (!_black.done() && (!earliest_time || _black.position() < *earliest_time)) {
+               earliest_time = _black.position ();
+               which = BLACK;
        }
 
-       DCPTime audio_fill_towards = fill_towards;
-       if (earliest && earliest->content->audio) {
-               audio_fill_towards += DCPTime::from_seconds (earliest->content->audio->delay() / 1000.0);
+       if (!_silent.done() && (!earliest_time || _silent.position() < *earliest_time)) {
+               earliest_time = _silent.position ();
+               which = SILENT;
        }
 
-       if (audio_fill_from && audio_fill_from < audio_fill_towards && ((audio_fill_towards - *audio_fill_from) >= one_video_frame())) {
-               DCPTimePeriod period (*audio_fill_from, audio_fill_towards);
+       switch (which) {
+       case CONTENT:
+               earliest_content->done = earliest_content->decoder->pass ();
+               break;
+       case BLACK:
+               emit_video (black_player_video_frame(), _black.position());
+               _black.set_position (_black.position() + one_video_frame());
+               break;
+       case SILENT:
+       {
+               DCPTimePeriod period (_silent.period_at_position());
                if (period.duration() > one_video_frame()) {
                        period.to = period.from + one_video_frame();
                }
-               list<DCPTimePeriod> p = subtract(period, _no_audio);
-               if (!p.empty ()) {
-                       fill_audio (p.front());
-                       filled = true;
-               }
+               fill_audio (period);
+               _silent.set_position (period.to);
+               break;
        }
-
-       if (earliest) {
-               earliest->done = earliest->decoder->pass ();
+       case NONE:
+               done = true;
+               break;
        }
 
        /* Emit any audio that is ready */
 
-       DCPTime pull_to = _playlist->length ();
+       DCPTime pull_to = _film->length ();
        for (map<AudioStreamPtr, StreamState>::const_iterator i = _stream_states.begin(); i != _stream_states.end(); ++i) {
                if (!i->second.piece->done && i->second.last_push_end < pull_to) {
                        pull_to = i->second.last_push_end;
@@ -593,24 +602,21 @@ Player::pass ()
        list<pair<shared_ptr<AudioBuffers>, DCPTime> > audio = _audio_merger.pull (pull_to);
        for (list<pair<shared_ptr<AudioBuffers>, DCPTime> >::iterator i = audio.begin(); i != audio.end(); ++i) {
                if (_last_audio_time && i->second < *_last_audio_time) {
-                       /* There has been an accurate seek and we have received some audio before the seek time;
-                          discard it.
-                       */
+                       /* This new data comes before the last we emitted (or the last seek); 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) {
+               } else if (_last_audio_time && i->second > *_last_audio_time) {
+                       /* There's a gap between this data and the last we emitted; fill with silence */
                        fill_audio (DCPTimePeriod (*_last_audio_time, i->second));
                }
 
                emit_audio (i->first, i->second);
        }
 
-       return !earliest && !filled;
+       return done;
 }
 
 optional<PositionImage>
@@ -651,9 +657,8 @@ Player::video (weak_ptr<Piece> wp, ContentVideo video)
                return;
        }
 
-       /* Time and period of the frame we will emit */
+       /* Time of the first frame we will emit */
        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 or if it's before the last accurate seek */
        if (
@@ -665,21 +670,15 @@ Player::video (weak_ptr<Piece> wp, ContentVideo video)
 
        /* Fill gaps that we discover now that we have some video which needs to be emitted */
 
-       optional<DCPTime> fill_to;
        if (_last_video_time) {
-               fill_to = _last_video_time;
-       }
-
-       if (fill_to) {
                /* XXX: this may not work for 3D */
-               BOOST_FOREACH (DCPTimePeriod i, subtract(DCPTimePeriod (*fill_to, time), _no_video)) {
-                       for (DCPTime j = i.from; j < i.to; j += one_video_frame()) {
-                               LastVideoMap::const_iterator k = _last_video.find (wp);
-                               if (k != _last_video.end ()) {
-                                       emit_video (k->second, j);
-                               } else {
-                                       emit_video (black_player_video_frame(), j);
-                               }
+               DCPTime fill_from = max (*_last_video_time, piece->content->position());
+               for (DCPTime j = fill_from; j < time; j += one_video_frame()) {
+                       LastVideoMap::const_iterator k = _last_video.find (wp);
+                       if (k != _last_video.end ()) {
+                               emit_video (k->second, j);
+                       } else {
+                               emit_video (black_player_video_frame(), j);
                        }
                }
        }
@@ -699,38 +698,11 @@ Player::video (weak_ptr<Piece> wp, ContentVideo video)
                        )
                );
 
-       emit_video (_last_video[wp], time);
-}
-
-/** Do our common processing on some audio */
-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) {
-               shared_ptr<AudioBuffers> gain (new AudioBuffers (content_audio.audio));
-               gain->apply_gain (content->gain ());
-               content_audio.audio = gain;
+       DCPTime t = time;
+       for (int i = 0; i < frc.repeat; ++i) {
+               emit_video (_last_video[wp], t);
+               t += one_video_frame ();
        }
-
-       /* Remap */
-
-       content_audio.audio = remap (content_audio.audio, _film->audio_channels(), stream->mapping());
-
-       /* Process */
-
-       if (_audio_processor) {
-               content_audio.audio = _audio_processor->run (content_audio.audio, _film->audio_channels ());
-       }
-
-       /* Push */
-
-       _audio_merger.push (content_audio.audio, time);
-       DCPOMATIC_ASSERT (_stream_states.find (stream) != _stream_states.end ());
-       _stream_states[stream].last_push_end = time + DCPTime::from_frames (content_audio.audio->frames(), _film->audio_frame_rate());
 }
 
 void
@@ -747,7 +719,7 @@ Player::audio (weak_ptr<Piece> wp, AudioStreamPtr stream, ContentAudio content_a
        DCPOMATIC_ASSERT (content);
 
        /* Compute time in the DCP */
-       DCPTime time = resampled_audio_to_dcp (piece, content_audio.frame) + DCPTime::from_seconds (content->delay() / 1000.0);
+       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());
 
@@ -773,7 +745,31 @@ Player::audio (weak_ptr<Piece> wp, AudioStreamPtr stream, ContentAudio content_a
                content_audio.audio = cut;
        }
 
-       audio_transform (content, stream, content_audio, time);
+       DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
+
+       /* Gain */
+
+       if (content->gain() != 0) {
+               shared_ptr<AudioBuffers> gain (new AudioBuffers (content_audio.audio));
+               gain->apply_gain (content->gain ());
+               content_audio.audio = gain;
+       }
+
+       /* Remap */
+
+       content_audio.audio = remap (content_audio.audio, _film->audio_channels(), stream->mapping());
+
+       /* Process */
+
+       if (_audio_processor) {
+               content_audio.audio = _audio_processor->run (content_audio.audio, _film->audio_channels ());
+       }
+
+       /* Push */
+
+       _audio_merger.push (content_audio.audio, time);
+       DCPOMATIC_ASSERT (_stream_states.find (stream) != _stream_states.end ());
+       _stream_states[stream].last_push_end = time + DCPTime::from_frames (content_audio.audio->frames(), _film->audio_frame_rate());
 }
 
 void
@@ -866,6 +862,10 @@ Player::subtitle_stop (weak_ptr<Piece> wp, ContentTime to)
 void
 Player::seek (DCPTime time, bool accurate)
 {
+       if (!_have_valid_pieces) {
+               setup_pieces ();
+       }
+
        if (_audio_processor) {
                _audio_processor->flush ();
        }
@@ -896,6 +896,9 @@ Player::seek (DCPTime time, bool accurate)
                _last_audio_time = optional<DCPTime>();
        }
 
+       _black.set_position (time);
+       _silent.set_position (time);
+
        _last_video.clear ();
 }
 
@@ -931,18 +934,16 @@ Player::fill_audio (DCPTimePeriod period)
 
        DCPOMATIC_ASSERT (period.from < period.to);
 
-       BOOST_FOREACH (DCPTimePeriod i, subtract(period, _no_audio)) {
-               DCPTime t = i.from;
-               while (t < i.to) {
-                       DCPTime block = min (DCPTime::from_seconds (0.5), i.to - t);
-                       Frame const samples = block.frames_round(_film->audio_frame_rate());
-                       if (samples) {
-                               shared_ptr<AudioBuffers> silence (new AudioBuffers (_film->audio_channels(), samples));
-                               silence->make_silent ();
-                               emit_audio (silence, t);
-                       }
-                       t += block;
+       DCPTime t = period.from;
+       while (t < period.to) {
+               DCPTime block = min (DCPTime::from_seconds (0.5), period.to - t);
+               Frame const samples = block.frames_round(_film->audio_frame_rate());
+               if (samples) {
+                       shared_ptr<AudioBuffers> silence (new AudioBuffers (_film->audio_channels(), samples));
+                       silence->make_silent ();
+                       emit_audio (silence, t);
                }
+               t += block;
        }
 }
 
@@ -965,3 +966,15 @@ Player::discard_audio (shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTi
        cut->copy_from (audio.get(), remaining_frames, discard_frames, 0);
        return make_pair(cut, time + discard_time);
 }
+
+void
+Player::set_dcp_decode_reduction (optional<int> reduction)
+{
+       if (reduction == _dcp_decode_reduction) {
+               return;
+       }
+
+       _dcp_decode_reduction = reduction;
+       _have_valid_pieces = false;
+       Changed (false);
+}