2 Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
22 #include "atmos_decoder.h"
23 #include "audio_buffers.h"
24 #include "audio_content.h"
25 #include "audio_decoder.h"
26 #include "audio_processor.h"
27 #include "compose.hpp"
29 #include "content_audio.h"
30 #include "content_video.h"
31 #include "dcp_content.h"
32 #include "dcp_decoder.h"
33 #include "dcpomatic_log.h"
35 #include "decoder_factory.h"
36 #include "ffmpeg_content.h"
38 #include "frame_rate_change.h"
40 #include "image_decoder.h"
43 #include "maths_util.h"
46 #include "player_video.h"
49 #include "raw_image_proxy.h"
50 #include "referenced_reel_asset.h"
51 #include "render_text.h"
53 #include "text_content.h"
54 #include "text_decoder.h"
56 #include "video_decoder.h"
58 #include <dcp/reel_closed_caption_asset.h>
59 #include <dcp/reel_picture_asset.h>
60 #include <dcp/reel_sound_asset.h>
61 #include <dcp/reel_subtitle_asset.h>
71 using std::dynamic_pointer_cast;
74 using std::make_shared;
75 using std::make_shared;
80 using std::shared_ptr;
83 using boost::optional;
84 using boost::scoped_ptr;
85 #if BOOST_VERSION >= 106100
86 using namespace boost::placeholders;
88 using namespace dcpomatic;
91 int const PlayerProperty::VIDEO_CONTAINER_SIZE = 700;
92 int const PlayerProperty::PLAYLIST = 701;
93 int const PlayerProperty::FILM_CONTAINER = 702;
94 int const PlayerProperty::FILM_VIDEO_FRAME_RATE = 703;
95 int const PlayerProperty::DCP_DECODE_REDUCTION = 704;
96 int const PlayerProperty::PLAYBACK_LENGTH = 705;
99 Player::Player (shared_ptr<const Film> film, Image::Alignment subtitle_alignment)
102 , _tolerant (film->tolerant())
103 , _audio_merger (_film->audio_frame_rate())
104 , _subtitle_alignment (subtitle_alignment)
110 Player::Player (shared_ptr<const Film> film, shared_ptr<const Playlist> playlist_)
112 , _playlist (playlist_)
114 , _tolerant (film->tolerant())
115 , _audio_merger (_film->audio_frame_rate())
124 _film_changed_connection = _film->Change.connect (bind (&Player::film_change, this, _1, _2));
125 /* The butler must hear about this first, so since we are proxying this through to the butler we must
128 _playlist_change_connection = playlist()->Change.connect (bind (&Player::playlist_change, this, _1), boost::signals2::at_front);
129 _playlist_content_change_connection = playlist()->ContentChange.connect (bind(&Player::playlist_content_change, this, _1, _3, _4));
130 set_video_container_size (_film->frame_size ());
132 film_change (ChangeType::DONE, Film::Property::AUDIO_PROCESSOR);
135 seek (DCPTime (), true);
140 Player::setup_pieces ()
142 boost::mutex::scoped_lock lm (_mutex);
143 setup_pieces_unlocked ();
148 have_video (shared_ptr<const Content> content)
150 return static_cast<bool>(content->video) && content->video->use() && content->can_be_played();
155 have_audio (shared_ptr<const Content> content)
157 return static_cast<bool>(content->audio);
162 Player::setup_pieces_unlocked ()
164 _playback_length = _playlist ? _playlist->length(_film) : _film->length();
166 auto old_pieces = _pieces;
169 auto playlist_content = playlist()->content();
170 bool const have_threed = std::any_of(
171 playlist_content.begin(),
172 playlist_content.end(),
173 [](shared_ptr<const Content> c) {
174 return c->video && (c->video->frame_type() == VideoFrameType::THREE_D_LEFT || c->video->frame_type() == VideoFrameType::THREE_D_RIGHT);
179 _shuffler.reset(new Shuffler());
180 _shuffler->Video.connect(bind(&Player::video, this, _1, _2));
183 for (auto i: playlist()->content()) {
185 if (!i->paths_valid ()) {
189 if (_ignore_video && _ignore_audio && i->text.empty()) {
190 /* We're only interested in text and this content has none */
194 shared_ptr<Decoder> old_decoder;
195 for (auto j: old_pieces) {
196 if (j->content == i) {
197 old_decoder = j->decoder;
202 auto decoder = decoder_factory (_film, i, _fast, _tolerant, old_decoder);
203 DCPOMATIC_ASSERT (decoder);
205 FrameRateChange frc (_film, i);
207 if (decoder->video && _ignore_video) {
208 decoder->video->set_ignore (true);
211 if (decoder->audio && _ignore_audio) {
212 decoder->audio->set_ignore (true);
216 for (auto i: decoder->text) {
217 i->set_ignore (true);
221 auto dcp = dynamic_pointer_cast<DCPDecoder> (decoder);
223 dcp->set_decode_referenced (_play_referenced);
224 if (_play_referenced) {
225 dcp->set_forced_reduction (_dcp_decode_reduction);
229 auto piece = make_shared<Piece>(i, decoder, frc);
230 _pieces.push_back (piece);
232 if (decoder->video) {
234 /* We need a Shuffler to cope with 3D L/R video data arriving out of sequence */
235 decoder->video->Data.connect (bind(&Shuffler::video, _shuffler.get(), weak_ptr<Piece>(piece), _1));
237 decoder->video->Data.connect (bind(&Player::video, this, weak_ptr<Piece>(piece), _1));
241 if (decoder->audio) {
242 decoder->audio->Data.connect (bind (&Player::audio, this, weak_ptr<Piece> (piece), _1, _2));
245 auto j = decoder->text.begin();
247 while (j != decoder->text.end()) {
248 (*j)->BitmapStart.connect (
249 bind(&Player::bitmap_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
251 (*j)->PlainStart.connect (
252 bind(&Player::plain_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
255 bind(&Player::subtitle_stop, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
261 if (decoder->atmos) {
262 decoder->atmos->Data.connect (bind(&Player::atmos, this, weak_ptr<Piece>(piece), _1));
266 _stream_states.clear ();
267 for (auto i: _pieces) {
268 if (i->content->audio) {
269 for (auto j: i->content->audio->streams()) {
270 _stream_states[j] = StreamState (i, i->content->position ());
275 auto ignore_overlap = [](shared_ptr<VideoContent> v) {
276 return v && v->use() && v->frame_type() != VideoFrameType::THREE_D_LEFT && v->frame_type() != VideoFrameType::THREE_D_RIGHT;
279 for (auto i = _pieces.begin(); i != _pieces.end(); ++i) {
280 if (ignore_overlap((*i)->content->video)) {
281 /* Look for content later in the content list with in-use video that overlaps this */
282 auto const period = DCPTimePeriod((*i)->content->position(), (*i)->content->end(_film));
283 for (auto j = std::next(i); j != _pieces.end(); ++j) {
284 if ((*j)->content->video && ignore_overlap((*j)->content->video)) {
285 (*i)->ignore_video = DCPTimePeriod((*j)->content->position(), (*j)->content->end(_film)).overlap(period);
291 _black = Empty (_film, playlist(), bind(&have_video, _1), _playback_length);
292 _silent = Empty (_film, playlist(), bind(&have_audio, _1), _playback_length);
294 _next_video_time = boost::none;
295 _next_video_eyes = Eyes::BOTH;
296 _next_audio_time = boost::none;
301 Player::playlist_content_change (ChangeType type, int property, bool frequent)
303 if (property == VideoContentProperty::CROP) {
304 if (type == ChangeType::DONE) {
305 auto const vcs = video_container_size();
306 boost::mutex::scoped_lock lm (_mutex);
307 for (auto const& i: _delay) {
308 i.first->reset_metadata (_film, vcs);
312 if (type == ChangeType::PENDING) {
313 /* The player content is probably about to change, so we can't carry on
314 until that has happened and we've rebuilt our pieces. Stop pass()
315 and seek() from working until then.
318 } else if (type == ChangeType::DONE) {
319 /* A change in our content has gone through. Re-build our pieces. */
322 } else if (type == ChangeType::CANCELLED) {
327 Change (type, property, frequent);
332 Player::set_video_container_size (dcp::Size s)
334 Change (ChangeType::PENDING, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
337 boost::mutex::scoped_lock lm (_mutex);
339 if (s == _video_container_size) {
341 Change (ChangeType::CANCELLED, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
345 _video_container_size = s;
347 _black_image = make_shared<Image>(AV_PIX_FMT_RGB24, _video_container_size, Image::Alignment::PADDED);
348 _black_image->make_black ();
351 Change (ChangeType::DONE, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
356 Player::playlist_change (ChangeType type)
358 if (type == ChangeType::DONE) {
361 Change (type, PlayerProperty::PLAYLIST, false);
366 Player::film_change (ChangeType type, Film::Property p)
368 /* Here we should notice Film properties that affect our output, and
369 alert listeners that our output now would be different to how it was
370 last time we were run.
373 if (p == Film::Property::CONTAINER) {
374 Change (type, PlayerProperty::FILM_CONTAINER, false);
375 } else if (p == Film::Property::VIDEO_FRAME_RATE) {
376 /* Pieces contain a FrameRateChange which contains the DCP frame rate,
377 so we need new pieces here.
379 if (type == ChangeType::DONE) {
382 Change (type, PlayerProperty::FILM_VIDEO_FRAME_RATE, false);
383 } else if (p == Film::Property::AUDIO_PROCESSOR) {
384 if (type == ChangeType::DONE && _film->audio_processor ()) {
385 boost::mutex::scoped_lock lm (_mutex);
386 _audio_processor = _film->audio_processor()->clone (_film->audio_frame_rate ());
388 } else if (p == Film::Property::AUDIO_CHANNELS) {
389 if (type == ChangeType::DONE) {
390 boost::mutex::scoped_lock lm (_mutex);
391 _audio_merger.clear ();
397 shared_ptr<PlayerVideo>
398 Player::black_player_video_frame (Eyes eyes) const
400 return std::make_shared<PlayerVideo> (
401 std::make_shared<const RawImageProxy>(_black_image),
404 _video_container_size,
405 _video_container_size,
408 PresetColourConversion::all().front().conversion,
410 std::weak_ptr<Content>(),
411 boost::optional<Frame>(),
418 Player::dcp_to_content_video (shared_ptr<const Piece> piece, DCPTime t) const
420 auto s = t - piece->content->position ();
421 s = min (piece->content->length_after_trim(_film), s);
422 s = max (DCPTime(), s + DCPTime (piece->content->trim_start(), piece->frc));
424 /* It might seem more logical here to convert s to a ContentTime (using the FrameRateChange)
425 then convert that ContentTime to frames at the content's rate. However this fails for
426 situations like content at 29.9978733fps, DCP at 30fps. The accuracy of the Time type is not
427 enough to distinguish between the two with low values of time (e.g. 3200 in Time units).
429 Instead we convert the DCPTime using the DCP video rate then account for any skip/repeat.
431 return s.frames_floor (piece->frc.dcp) / piece->frc.factor ();
436 Player::content_video_to_dcp (shared_ptr<const Piece> piece, Frame f) const
438 /* See comment in dcp_to_content_video */
439 auto const d = DCPTime::from_frames (f * piece->frc.factor(), piece->frc.dcp) - DCPTime(piece->content->trim_start(), piece->frc);
440 return d + piece->content->position();
445 Player::dcp_to_resampled_audio (shared_ptr<const Piece> piece, DCPTime t) const
447 auto s = t - piece->content->position ();
448 s = min (piece->content->length_after_trim(_film), s);
449 /* See notes in dcp_to_content_video */
450 return max (DCPTime(), DCPTime(piece->content->trim_start(), piece->frc) + s).frames_floor(_film->audio_frame_rate());
455 Player::resampled_audio_to_dcp (shared_ptr<const Piece> piece, Frame f) const
457 /* See comment in dcp_to_content_video */
458 return DCPTime::from_frames (f, _film->audio_frame_rate())
459 - DCPTime (piece->content->trim_start(), piece->frc)
460 + piece->content->position();
465 Player::dcp_to_content_time (shared_ptr<const Piece> piece, DCPTime t) const
467 auto s = t - piece->content->position ();
468 s = min (piece->content->length_after_trim(_film), s);
469 return max (ContentTime (), ContentTime (s, piece->frc) + piece->content->trim_start());
474 Player::content_time_to_dcp (shared_ptr<const Piece> piece, ContentTime t) const
476 return max (DCPTime(), DCPTime(t - piece->content->trim_start(), piece->frc) + piece->content->position());
481 Player::get_subtitle_fonts ()
483 boost::mutex::scoped_lock lm (_mutex);
485 vector<FontData> fonts;
486 for (auto i: _pieces) {
487 /* XXX: things may go wrong if there are duplicate font IDs
488 with different font files.
490 auto f = i->decoder->fonts ();
491 copy (f.begin(), f.end(), back_inserter(fonts));
498 /** Set this player never to produce any video data */
500 Player::set_ignore_video ()
502 boost::mutex::scoped_lock lm (_mutex);
503 _ignore_video = true;
504 setup_pieces_unlocked ();
509 Player::set_ignore_audio ()
511 boost::mutex::scoped_lock lm (_mutex);
512 _ignore_audio = true;
513 setup_pieces_unlocked ();
518 Player::set_ignore_text ()
520 boost::mutex::scoped_lock lm (_mutex);
522 setup_pieces_unlocked ();
526 /** Set the player to always burn open texts into the image regardless of the content settings */
528 Player::set_always_burn_open_subtitles ()
530 boost::mutex::scoped_lock lm (_mutex);
531 _always_burn_open_subtitles = true;
535 /** Sets up the player to be faster, possibly at the expense of quality */
539 boost::mutex::scoped_lock lm (_mutex);
541 setup_pieces_unlocked ();
546 Player::set_play_referenced ()
548 boost::mutex::scoped_lock lm (_mutex);
549 _play_referenced = true;
550 setup_pieces_unlocked ();
555 maybe_add_asset (list<ReferencedReelAsset>& a, shared_ptr<dcp::ReelAsset> r, Frame reel_trim_start, Frame reel_trim_end, DCPTime from, int const ffr)
557 DCPOMATIC_ASSERT (r);
558 r->set_entry_point (r->entry_point().get_value_or(0) + reel_trim_start);
559 r->set_duration (r->actual_duration() - reel_trim_start - reel_trim_end);
560 if (r->actual_duration() > 0) {
562 ReferencedReelAsset(r, DCPTimePeriod(from, from + DCPTime::from_frames(r->actual_duration(), ffr)))
568 list<ReferencedReelAsset>
569 Player::get_reel_assets ()
571 /* Does not require a lock on _mutex as it's only called from DCPEncoder */
573 list<ReferencedReelAsset> reel_assets;
575 for (auto content: playlist()->content()) {
576 auto dcp = dynamic_pointer_cast<DCPContent>(content);
581 if (!dcp->reference_video() && !dcp->reference_audio() && !dcp->reference_text(TextType::OPEN_SUBTITLE) && !dcp->reference_text(TextType::CLOSED_CAPTION)) {
585 scoped_ptr<DCPDecoder> decoder;
587 decoder.reset (new DCPDecoder(_film, dcp, false, false, shared_ptr<DCPDecoder>()));
592 auto const frame_rate = _film->video_frame_rate();
593 DCPOMATIC_ASSERT (dcp->video_frame_rate());
594 /* We should only be referencing if the DCP rate is the same as the film rate */
595 DCPOMATIC_ASSERT (std::round(dcp->video_frame_rate().get()) == frame_rate);
597 Frame const trim_start = dcp->trim_start().frames_round(frame_rate);
598 Frame const trim_end = dcp->trim_end().frames_round(frame_rate);
600 /* position in the asset from the start */
601 int64_t offset_from_start = 0;
602 /* position i the asset from the end */
603 int64_t offset_from_end = 0;
604 for (auto reel: decoder->reels()) {
605 /* Assume that main picture duration is the length of the reel */
606 offset_from_end += reel->main_picture()->actual_duration();
609 for (auto reel: decoder->reels()) {
611 /* Assume that main picture duration is the length of the reel */
612 int64_t const reel_duration = reel->main_picture()->actual_duration();
614 /* See doc/design/trim_reels.svg */
615 Frame const reel_trim_start = min(reel_duration, max(int64_t(0), trim_start - offset_from_start));
616 Frame const reel_trim_end = min(reel_duration, max(int64_t(0), reel_duration - (offset_from_end - trim_end)));
618 auto const from = max(DCPTime(), content->position() + DCPTime::from_frames(offset_from_start, frame_rate) - DCPTime::from_frames(trim_start, frame_rate));
619 if (dcp->reference_video()) {
620 maybe_add_asset (reel_assets, reel->main_picture(), reel_trim_start, reel_trim_end, from, frame_rate);
623 if (dcp->reference_audio()) {
624 maybe_add_asset (reel_assets, reel->main_sound(), reel_trim_start, reel_trim_end, from, frame_rate);
627 if (dcp->reference_text(TextType::OPEN_SUBTITLE)) {
628 maybe_add_asset (reel_assets, reel->main_subtitle(), reel_trim_start, reel_trim_end, from, frame_rate);
631 if (dcp->reference_text(TextType::CLOSED_CAPTION)) {
632 for (auto caption: reel->closed_captions()) {
633 maybe_add_asset (reel_assets, caption, reel_trim_start, reel_trim_end, from, frame_rate);
637 offset_from_start += reel_duration;
638 offset_from_end -= reel_duration;
649 boost::mutex::scoped_lock lm (_mutex);
652 /* We can't pass in this state */
653 LOG_DEBUG_PLAYER_NC ("Player is suspended");
657 if (_playback_length == DCPTime()) {
658 /* Special; just give one black frame */
659 emit_video (black_player_video_frame(Eyes::BOTH), DCPTime());
663 /* Find the decoder or empty which is farthest behind where we are and make it emit some data */
665 shared_ptr<Piece> earliest_content;
666 optional<DCPTime> earliest_time;
668 for (auto i: _pieces) {
673 auto const t = content_time_to_dcp (i, max(i->decoder->position(), i->content->trim_start()));
674 if (t > i->content->end(_film)) {
678 /* Given two choices at the same time, pick the one with texts so we see it before
681 if (!earliest_time || t < *earliest_time || (t == *earliest_time && !i->decoder->text.empty())) {
683 earliest_content = i;
697 if (earliest_content) {
701 if (!_black.done() && !_ignore_video && (!earliest_time || _black.position() < *earliest_time)) {
702 earliest_time = _black.position ();
706 if (!_silent.done() && !_ignore_audio && (!earliest_time || _silent.position() < *earliest_time)) {
707 earliest_time = _silent.position ();
714 LOG_DEBUG_PLAYER ("Calling pass() on %1", earliest_content->content->path(0));
715 earliest_content->done = earliest_content->decoder->pass ();
716 auto dcp = dynamic_pointer_cast<DCPContent>(earliest_content->content);
717 if (dcp && !_play_referenced && dcp->reference_audio()) {
718 /* We are skipping some referenced DCP audio content, so we need to update _next_audio_time
719 to `hide' the fact that no audio was emitted during the referenced DCP (though
720 we need to behave as though it was).
722 _next_audio_time = dcp->end (_film);
727 LOG_DEBUG_PLAYER ("Emit black for gap at %1", to_string(_black.position()));
728 emit_video (black_player_video_frame(Eyes::BOTH), _black.position());
729 _black.set_position (_black.position() + one_video_frame());
733 LOG_DEBUG_PLAYER ("Emit silence for gap at %1", to_string(_silent.position()));
734 DCPTimePeriod period (_silent.period_at_position());
735 if (_next_audio_time) {
736 /* Sometimes the thing that happened last finishes fractionally before
737 or after this silence. Bodge the start time of the silence to fix it.
738 I think this is nothing to worry about since we will just add or
739 remove a little silence at the end of some content.
741 int64_t const error = labs(period.from.get() - _next_audio_time->get());
742 /* Let's not worry about less than a frame at 24fps */
743 int64_t const too_much_error = DCPTime::from_frames(1, 24).get();
744 if (error >= too_much_error) {
745 _film->log()->log(String::compose("Silence starting before or after last audio by %1", error), LogEntry::TYPE_ERROR);
747 DCPOMATIC_ASSERT (error < too_much_error);
748 period.from = *_next_audio_time;
750 if (period.duration() > one_video_frame()) {
751 period.to = period.from + one_video_frame();
754 _silent.set_position (period.to);
762 /* Emit any audio that is ready */
764 /* Work out the time before which the audio is definitely all here. This is the earliest last_push_end of one
765 of our streams, or the position of the _silent. First, though we choose only streams that are less than
766 ignore_streams_behind seconds behind the furthest ahead (we assume that if a stream has fallen that far
767 behind it has finished). This is so that we don't withhold audio indefinitely awaiting data from a stream
768 that will never come, causing bugs like #2101.
770 constexpr int ignore_streams_behind = 5;
772 using state_pair = std::pair<AudioStreamPtr, StreamState>;
774 /* Find the 'leading' stream (i.e. the one that pushed data most recently) */
775 auto latest_last_push_end = std::max_element(
776 _stream_states.begin(),
777 _stream_states.end(),
778 [](state_pair const& a, state_pair const& b) { return a.second.last_push_end < b.second.last_push_end; }
781 if (latest_last_push_end != _stream_states.end()) {
782 LOG_DEBUG_PLAYER("Leading stream is in %1 at %2", latest_last_push_end->second.piece->content->path(0), to_string(latest_last_push_end->second.last_push_end));
785 /* Now make a list of those streams that are less than ignore_streams_behind behind the leader */
786 std::map<AudioStreamPtr, StreamState> alive_stream_states;
787 for (auto const& i: _stream_states) {
788 if ((latest_last_push_end->second.last_push_end - i.second.last_push_end) < dcpomatic::DCPTime::from_seconds(ignore_streams_behind)) {
789 alive_stream_states.insert(i);
791 LOG_DEBUG_PLAYER("Ignoring stream %1 because it is too far behind", i.second.piece->content->path(0));
795 auto pull_to = _playback_length;
796 for (auto const& i: alive_stream_states) {
797 if (!i.second.piece->done && i.second.last_push_end < pull_to) {
798 pull_to = i.second.last_push_end;
801 if (!_silent.done() && _silent.position() < pull_to) {
802 pull_to = _silent.position();
805 LOG_DEBUG_PLAYER("Emitting audio up to %1", to_string(pull_to));
806 auto audio = _audio_merger.pull (pull_to);
807 for (auto i = audio.begin(); i != audio.end(); ++i) {
808 if (_next_audio_time && i->second < *_next_audio_time) {
809 /* This new data comes before the last we emitted (or the last seek); discard it */
810 auto cut = discard_audio (i->first, i->second, *_next_audio_time);
815 } else if (_next_audio_time && i->second > *_next_audio_time) {
816 /* There's a gap between this data and the last we emitted; fill with silence */
817 fill_audio (DCPTimePeriod (*_next_audio_time, i->second));
820 emit_audio (i->first, i->second);
827 for (auto const& i: _delay) {
828 do_emit_video(i.first, i.second);
831 /* Perhaps we should have Empty entries for both eyes in the 3D case (somehow).
832 * However, if we have L and R video files, and one is shorter than the other,
833 * the fill code in ::video mostly takes care of filling in the gaps.
834 * However, since it fills at the point when it knows there is more video coming
835 * at time t (so it should fill any gap up to t) it can't do anything right at the
836 * end. This is particularly bad news if the last frame emitted is a LEFT
837 * eye, as the MXF writer will complain about the 3D sequence being wrong.
838 * Here's a hack to workaround that particular case.
840 if (_next_video_eyes && _next_video_time && *_next_video_eyes == Eyes::RIGHT) {
841 do_emit_video (black_player_video_frame(Eyes::RIGHT), *_next_video_time);
849 /** @return Open subtitles for the frame at the given time, converted to images */
850 optional<PositionImage>
851 Player::open_subtitles_for_frame (DCPTime time) const
853 list<PositionImage> captions;
854 int const vfr = _film->video_frame_rate();
858 _active_texts[static_cast<int>(TextType::OPEN_SUBTITLE)].get_burnt(DCPTimePeriod(time, time + DCPTime::from_frames(1, vfr)), _always_burn_open_subtitles)
861 /* Bitmap subtitles */
862 for (auto i: j.bitmap) {
867 /* i.image will already have been scaled to fit _video_container_size */
868 dcp::Size scaled_size (i.rectangle.width * _video_container_size.width, i.rectangle.height * _video_container_size.height);
874 lrint(_video_container_size.width * i.rectangle.x),
875 lrint(_video_container_size.height * i.rectangle.y)
881 /* String subtitles (rendered to an image) */
882 if (!j.string.empty()) {
883 auto s = render_text (j.string, j.fonts, _video_container_size, time, vfr);
884 copy (s.begin(), s.end(), back_inserter (captions));
888 if (captions.empty()) {
892 return merge (captions, _subtitle_alignment);
897 Player::video (weak_ptr<Piece> weak_piece, ContentVideo video)
903 auto piece = weak_piece.lock ();
908 if (!piece->content->video->use()) {
912 FrameRateChange frc (_film, piece->content);
913 if (frc.skip && (video.frame % 2) == 1) {
917 /* Time of the first frame we will emit */
918 DCPTime const time = content_video_to_dcp (piece, video.frame);
919 LOG_DEBUG_PLAYER("Received video frame %1 at %2", video.frame, to_string(time));
921 /* Discard if it's before the content's period or the last accurate seek. We can't discard
922 if it's after the content's period here as in that case we still need to fill any gap between
923 `now' and the end of the content's period.
925 if (time < piece->content->position() || (_next_video_time && time < *_next_video_time)) {
929 if (piece->ignore_video && piece->ignore_video->contains(time)) {
933 /* Fill gaps that we discover now that we have some video which needs to be emitted.
934 This is where we need to fill to.
936 DCPTime fill_to = min (time, piece->content->end(_film));
938 if (_next_video_time) {
939 DCPTime fill_from = max (*_next_video_time, piece->content->position());
941 /* Fill if we have more than half a frame to do */
942 if ((fill_to - fill_from) > one_video_frame() / 2) {
943 auto last = _last_video.find (weak_piece);
944 if (_film->three_d()) {
945 auto fill_to_eyes = video.eyes;
946 if (fill_to_eyes == Eyes::BOTH) {
947 fill_to_eyes = Eyes::LEFT;
949 if (fill_to == piece->content->end(_film)) {
950 /* Don't fill after the end of the content */
951 fill_to_eyes = Eyes::LEFT;
954 auto eyes = _next_video_eyes.get_value_or(Eyes::LEFT);
955 if (eyes == Eyes::BOTH) {
958 while (j < fill_to || eyes != fill_to_eyes) {
959 if (last != _last_video.end()) {
960 LOG_DEBUG_PLAYER("Fill using last video at %1 in 3D mode", to_string(j));
961 auto copy = last->second->shallow_copy();
962 copy->set_eyes (eyes);
963 emit_video (copy, j);
965 LOG_DEBUG_PLAYER("Fill using black at %1 in 3D mode", to_string(j));
966 emit_video (black_player_video_frame(eyes), j);
968 if (eyes == Eyes::RIGHT) {
969 j += one_video_frame();
971 eyes = increment_eyes (eyes);
974 for (DCPTime j = fill_from; j < fill_to; j += one_video_frame()) {
975 if (last != _last_video.end()) {
976 emit_video (last->second, j);
978 emit_video (black_player_video_frame(Eyes::BOTH), j);
985 auto const content_video = piece->content->video;
987 _last_video[weak_piece] = std::make_shared<PlayerVideo>(
989 content_video->actual_crop(),
990 content_video->fade (_film, video.frame),
992 content_video->scaled_size(_film->frame_size()),
993 _video_container_size,
995 content_video->pixel_quanta()
997 _video_container_size,
1000 content_video->colour_conversion(),
1001 content_video->range(),
1008 for (int i = 0; i < frc.repeat; ++i) {
1009 if (t < piece->content->end(_film)) {
1010 emit_video (_last_video[weak_piece], t);
1012 t += one_video_frame ();
1018 Player::audio (weak_ptr<Piece> weak_piece, AudioStreamPtr stream, ContentAudio content_audio)
1024 DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
1026 auto piece = weak_piece.lock ();
1031 auto content = piece->content->audio;
1032 DCPOMATIC_ASSERT (content);
1034 int const rfr = content->resampled_frame_rate (_film);
1036 /* Compute time in the DCP */
1037 auto time = resampled_audio_to_dcp (piece, content_audio.frame);
1038 LOG_DEBUG_PLAYER("Received audio frame %1 at %2", content_audio.frame, to_string(time));
1040 /* And the end of this block in the DCP */
1041 auto end = time + DCPTime::from_frames(content_audio.audio->frames(), rfr);
1043 /* Remove anything that comes before the start or after the end of the content */
1044 if (time < piece->content->position()) {
1045 auto cut = discard_audio (content_audio.audio, time, piece->content->position());
1047 /* This audio is entirely discarded */
1050 content_audio.audio = cut.first;
1052 } else if (time > piece->content->end(_film)) {
1053 /* Discard it all */
1055 } else if (end > piece->content->end(_film)) {
1056 Frame const remaining_frames = DCPTime(piece->content->end(_film) - time).frames_round(rfr);
1057 if (remaining_frames == 0) {
1060 content_audio.audio = make_shared<AudioBuffers>(content_audio.audio, remaining_frames, 0);
1063 DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
1067 auto const fade_coeffs = content->fade (stream, content_audio.frame, content_audio.audio->frames(), rfr);
1068 if (content->gain() != 0 || !fade_coeffs.empty()) {
1069 auto gain_buffers = make_shared<AudioBuffers>(content_audio.audio);
1070 if (!fade_coeffs.empty()) {
1071 /* Apply both fade and gain */
1072 DCPOMATIC_ASSERT (fade_coeffs.size() == static_cast<size_t>(gain_buffers->frames()));
1073 auto const channels = gain_buffers->channels();
1074 auto const frames = fade_coeffs.size();
1075 auto data = gain_buffers->data();
1076 auto const gain = db_to_linear (content->gain());
1077 for (auto channel = 0; channel < channels; ++channel) {
1078 for (auto frame = 0U; frame < frames; ++frame) {
1079 data[channel][frame] *= gain * fade_coeffs[frame];
1083 /* Just apply gain */
1084 gain_buffers->apply_gain (content->gain());
1086 content_audio.audio = gain_buffers;
1091 content_audio.audio = remap (content_audio.audio, _film->audio_channels(), stream->mapping());
1095 if (_audio_processor) {
1096 content_audio.audio = _audio_processor->run (content_audio.audio, _film->audio_channels ());
1101 _audio_merger.push (content_audio.audio, time);
1102 DCPOMATIC_ASSERT (_stream_states.find (stream) != _stream_states.end ());
1103 _stream_states[stream].last_push_end = time + DCPTime::from_frames (content_audio.audio->frames(), _film->audio_frame_rate());
1108 Player::bitmap_text_start (weak_ptr<Piece> weak_piece, weak_ptr<const TextContent> weak_content, ContentBitmapText subtitle)
1114 auto piece = weak_piece.lock ();
1115 auto content = weak_content.lock ();
1116 if (!piece || !content) {
1121 for (auto& sub: subtitle.subs)
1123 /* Apply content's subtitle offsets */
1124 sub.rectangle.x += content->x_offset ();
1125 sub.rectangle.y += content->y_offset ();
1127 /* Apply a corrective translation to keep the subtitle centred after the scale that is coming up */
1128 sub.rectangle.x -= sub.rectangle.width * ((content->x_scale() - 1) / 2);
1129 sub.rectangle.y -= sub.rectangle.height * ((content->y_scale() - 1) / 2);
1131 /* Apply content's subtitle scale */
1132 sub.rectangle.width *= content->x_scale ();
1133 sub.rectangle.height *= content->y_scale ();
1135 auto image = sub.image;
1137 /* We will scale the subtitle up to fit _video_container_size */
1138 int const width = sub.rectangle.width * _video_container_size.width;
1139 int const height = sub.rectangle.height * _video_container_size.height;
1140 if (width == 0 || height == 0) {
1144 dcp::Size scaled_size (width, height);
1145 ps.bitmap.push_back (BitmapText(image->scale(scaled_size, dcp::YUVToRGB::REC601, image->pixel_format(), Image::Alignment::PADDED, _fast), sub.rectangle));
1148 DCPTime from(content_time_to_dcp(piece, subtitle.from()));
1149 _active_texts[static_cast<int>(content->type())].add_from(weak_content, ps, from);
1154 Player::plain_text_start (weak_ptr<Piece> weak_piece, weak_ptr<const TextContent> weak_content, ContentStringText subtitle)
1160 auto piece = weak_piece.lock ();
1161 auto content = weak_content.lock ();
1162 if (!piece || !content) {
1167 DCPTime const from (content_time_to_dcp (piece, subtitle.from()));
1169 if (from > piece->content->end(_film)) {
1173 for (auto s: subtitle.subs) {
1174 s.set_h_position (s.h_position() + content->x_offset());
1175 s.set_v_position (s.v_position() + content->y_offset());
1176 float const xs = content->x_scale();
1177 float const ys = content->y_scale();
1178 float size = s.size();
1180 /* Adjust size to express the common part of the scaling;
1181 e.g. if xs = ys = 0.5 we scale size by 2.
1183 if (xs > 1e-5 && ys > 1e-5) {
1184 size *= 1 / min (1 / xs, 1 / ys);
1188 /* Then express aspect ratio changes */
1189 if (fabs (1.0 - xs / ys) > dcp::ASPECT_ADJUST_EPSILON) {
1190 s.set_aspect_adjust (xs / ys);
1193 s.set_in (dcp::Time(from.seconds(), 1000));
1194 ps.string.push_back (StringText (s, content->outline_width()));
1195 ps.add_fonts (content->fonts ());
1198 _active_texts[static_cast<int>(content->type())].add_from(weak_content, ps, from);
1203 Player::subtitle_stop (weak_ptr<Piece> weak_piece, weak_ptr<const TextContent> weak_content, ContentTime to)
1209 auto content = weak_content.lock ();
1214 if (!_active_texts[static_cast<int>(content->type())].have(weak_content)) {
1218 auto piece = weak_piece.lock ();
1223 DCPTime const dcp_to = content_time_to_dcp (piece, to);
1225 if (dcp_to > piece->content->end(_film)) {
1229 auto from = _active_texts[static_cast<int>(content->type())].add_to(weak_content, dcp_to);
1231 bool const always = (content->type() == TextType::OPEN_SUBTITLE && _always_burn_open_subtitles);
1232 if (content->use() && !always && !content->burn()) {
1233 Text (from.first, content->type(), content->dcp_track().get_value_or(DCPTextTrack()), DCPTimePeriod(from.second, dcp_to));
1239 Player::seek (DCPTime time, bool accurate)
1241 boost::mutex::scoped_lock lm (_mutex);
1242 LOG_DEBUG_PLAYER("Seek to %1 (%2accurate)", to_string(time), accurate ? "" : "in");
1245 /* We can't seek in this state */
1250 _shuffler->clear ();
1255 if (_audio_processor) {
1256 _audio_processor->flush ();
1259 _audio_merger.clear ();
1260 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
1261 _active_texts[i].clear ();
1264 for (auto i: _pieces) {
1265 if (time < i->content->position()) {
1266 /* Before; seek to the start of the content. Even if this request is for an inaccurate seek
1267 we must seek this (following) content accurately, otherwise when we come to the end of the current
1268 content we may not start right at the beginning of the next, causing a gap (if the next content has
1269 been trimmed to a point between keyframes, or something).
1271 i->decoder->seek (dcp_to_content_time (i, i->content->position()), true);
1273 } else if (i->content->position() <= time && time < i->content->end(_film)) {
1274 /* During; seek to position */
1275 i->decoder->seek (dcp_to_content_time (i, time), accurate);
1278 /* After; this piece is done */
1284 _next_video_time = time;
1285 _next_video_eyes = Eyes::LEFT;
1286 _next_audio_time = time;
1288 _next_video_time = boost::none;
1289 _next_video_eyes = boost::none;
1290 _next_audio_time = boost::none;
1293 _black.set_position (time);
1294 _silent.set_position (time);
1296 _last_video.clear ();
1301 Player::emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1303 if (!_film->three_d()) {
1304 if (pv->eyes() == Eyes::LEFT) {
1305 /* Use left-eye images for both eyes... */
1306 pv->set_eyes (Eyes::BOTH);
1307 } else if (pv->eyes() == Eyes::RIGHT) {
1308 /* ...and discard the right */
1313 /* We need a delay to give a little wiggle room to ensure that relevant subtitles arrive at the
1314 player before the video that requires them.
1316 _delay.push_back (make_pair (pv, time));
1318 if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
1319 _next_video_time = time + one_video_frame();
1321 _next_video_eyes = increment_eyes (pv->eyes());
1323 if (_delay.size() < 3) {
1327 auto to_do = _delay.front();
1329 do_emit_video (to_do.first, to_do.second);
1334 Player::do_emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1336 if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
1337 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
1338 _active_texts[i].clear_before (time);
1342 auto subtitles = open_subtitles_for_frame (time);
1344 pv->set_text (subtitles.get ());
1352 Player::emit_audio (shared_ptr<AudioBuffers> data, DCPTime time)
1354 /* Log if the assert below is about to fail */
1355 if (_next_audio_time && labs(time.get() - _next_audio_time->get()) > 1) {
1356 _film->log()->log(String::compose("Out-of-sequence emit %1 vs %2", to_string(time), to_string(*_next_audio_time)), LogEntry::TYPE_WARNING);
1359 /* This audio must follow on from the previous, allowing for half a sample (at 48kHz) leeway */
1360 DCPOMATIC_ASSERT (!_next_audio_time || labs(time.get() - _next_audio_time->get()) < 2);
1361 Audio (data, time, _film->audio_frame_rate());
1362 _next_audio_time = time + DCPTime::from_frames (data->frames(), _film->audio_frame_rate());
1367 Player::fill_audio (DCPTimePeriod period)
1369 if (period.from == period.to) {
1373 DCPOMATIC_ASSERT (period.from < period.to);
1375 DCPTime t = period.from;
1376 while (t < period.to) {
1377 DCPTime block = min (DCPTime::from_seconds (0.5), period.to - t);
1378 Frame const samples = block.frames_round(_film->audio_frame_rate());
1380 auto silence = make_shared<AudioBuffers>(_film->audio_channels(), samples);
1381 silence->make_silent ();
1382 emit_audio (silence, t);
1390 Player::one_video_frame () const
1392 return DCPTime::from_frames (1, _film->video_frame_rate ());
1396 pair<shared_ptr<AudioBuffers>, DCPTime>
1397 Player::discard_audio (shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to) const
1399 auto const discard_time = discard_to - time;
1400 auto const discard_frames = discard_time.frames_round(_film->audio_frame_rate());
1401 auto remaining_frames = audio->frames() - discard_frames;
1402 if (remaining_frames <= 0) {
1403 return make_pair(shared_ptr<AudioBuffers>(), DCPTime());
1405 auto cut = make_shared<AudioBuffers>(audio, remaining_frames, discard_frames);
1406 return make_pair(cut, time + discard_time);
1411 Player::set_dcp_decode_reduction (optional<int> reduction)
1413 Change (ChangeType::PENDING, PlayerProperty::DCP_DECODE_REDUCTION, false);
1416 boost::mutex::scoped_lock lm (_mutex);
1418 if (reduction == _dcp_decode_reduction) {
1420 Change (ChangeType::CANCELLED, PlayerProperty::DCP_DECODE_REDUCTION, false);
1424 _dcp_decode_reduction = reduction;
1425 setup_pieces_unlocked ();
1428 Change (ChangeType::DONE, PlayerProperty::DCP_DECODE_REDUCTION, false);
1433 Player::content_time_to_dcp (shared_ptr<const Content> content, ContentTime t)
1435 boost::mutex::scoped_lock lm (_mutex);
1437 for (auto i: _pieces) {
1438 if (i->content == content) {
1439 return content_time_to_dcp (i, t);
1443 /* We couldn't find this content; perhaps things are being changed over */
1448 optional<ContentTime>
1449 Player::dcp_to_content_time (shared_ptr<const Content> content, DCPTime t)
1451 boost::mutex::scoped_lock lm (_mutex);
1453 for (auto i: _pieces) {
1454 if (i->content == content) {
1455 return dcp_to_content_time (i, t);
1459 /* We couldn't find this content; perhaps things are being changed over */
1464 shared_ptr<const Playlist>
1465 Player::playlist () const
1467 return _playlist ? _playlist : _film->playlist();
1472 Player::atmos (weak_ptr<Piece> weak_piece, ContentAtmos data)
1478 auto piece = weak_piece.lock ();
1479 DCPOMATIC_ASSERT (piece);
1481 auto const vfr = _film->video_frame_rate();
1483 DCPTime const dcp_time = DCPTime::from_frames(data.frame, vfr) - DCPTime(piece->content->trim_start(), FrameRateChange(vfr, vfr));
1484 if (dcp_time < piece->content->position() || dcp_time >= (piece->content->end(_film))) {
1488 Atmos (data.data, dcp_time, data.metadata);