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 Player::setup_pieces_unlocked ()
150 _playback_length = _playlist ? _playlist->length(_film) : _film->length();
152 auto old_pieces = _pieces;
155 auto playlist_content = playlist()->content();
156 bool const have_threed = std::any_of(
157 playlist_content.begin(),
158 playlist_content.end(),
159 [](shared_ptr<const Content> c) {
160 return c->video && (c->video->frame_type() == VideoFrameType::THREE_D_LEFT || c->video->frame_type() == VideoFrameType::THREE_D_RIGHT);
165 _shuffler.reset(new Shuffler());
166 _shuffler->Video.connect(bind(&Player::video, this, _1, _2));
169 for (auto i: playlist()->content()) {
171 if (!i->paths_valid ()) {
175 if (_ignore_video && _ignore_audio && i->text.empty()) {
176 /* We're only interested in text and this content has none */
180 shared_ptr<Decoder> old_decoder;
181 for (auto j: old_pieces) {
182 if (j->content == i) {
183 old_decoder = j->decoder;
188 auto decoder = decoder_factory (_film, i, _fast, _tolerant, old_decoder);
189 DCPOMATIC_ASSERT (decoder);
191 FrameRateChange frc (_film, i);
193 if (decoder->video && _ignore_video) {
194 decoder->video->set_ignore (true);
197 if (decoder->audio && _ignore_audio) {
198 decoder->audio->set_ignore (true);
202 for (auto i: decoder->text) {
203 i->set_ignore (true);
207 auto dcp = dynamic_pointer_cast<DCPDecoder> (decoder);
209 dcp->set_decode_referenced (_play_referenced);
210 if (_play_referenced) {
211 dcp->set_forced_reduction (_dcp_decode_reduction);
215 auto piece = make_shared<Piece>(i, decoder, frc);
216 _pieces.push_back (piece);
218 if (decoder->video) {
220 /* We need a Shuffler to cope with 3D L/R video data arriving out of sequence */
221 decoder->video->Data.connect (bind(&Shuffler::video, _shuffler.get(), weak_ptr<Piece>(piece), _1));
223 decoder->video->Data.connect (bind(&Player::video, this, weak_ptr<Piece>(piece), _1));
227 if (decoder->audio) {
228 decoder->audio->Data.connect (bind (&Player::audio, this, weak_ptr<Piece> (piece), _1, _2));
231 auto j = decoder->text.begin();
233 while (j != decoder->text.end()) {
234 (*j)->BitmapStart.connect (
235 bind(&Player::bitmap_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
237 (*j)->PlainStart.connect (
238 bind(&Player::plain_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
241 bind(&Player::subtitle_stop, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
247 if (decoder->atmos) {
248 decoder->atmos->Data.connect (bind(&Player::atmos, this, weak_ptr<Piece>(piece), _1));
252 _stream_states.clear ();
253 for (auto i: _pieces) {
254 if (i->content->audio) {
255 for (auto j: i->content->audio->streams()) {
256 _stream_states[j] = StreamState (i, i->content->position ());
261 auto ignore_overlap = [](shared_ptr<VideoContent> v) {
262 return v && v->use() && v->frame_type() != VideoFrameType::THREE_D_LEFT && v->frame_type() != VideoFrameType::THREE_D_RIGHT;
265 for (auto i = _pieces.begin(); i != _pieces.end(); ++i) {
266 if (ignore_overlap((*i)->content->video)) {
267 /* Look for content later in the content list with in-use video that overlaps this */
268 auto const period = DCPTimePeriod((*i)->content->position(), (*i)->content->end(_film));
269 for (auto j = std::next(i); j != _pieces.end(); ++j) {
270 if ((*j)->content->video && ignore_overlap((*j)->content->video)) {
271 (*i)->ignore_video = DCPTimePeriod((*j)->content->position(), (*j)->content->end(_film)).overlap(period);
277 _black = EmptyVideo (_film, playlist(), _playback_length);
278 _silent = EmptyAudio (_film, playlist(), _playback_length);
280 _next_video_time = boost::none;
281 _next_video_eyes = Eyes::BOTH;
282 _next_audio_time = boost::none;
287 Player::playlist_content_change (ChangeType type, int property, bool frequent)
289 if (property == VideoContentProperty::CROP) {
290 if (type == ChangeType::DONE) {
291 auto const vcs = video_container_size();
292 boost::mutex::scoped_lock lm (_mutex);
293 for (auto const& i: _delay) {
294 i.first->reset_metadata (_film, vcs);
298 if (type == ChangeType::PENDING) {
299 /* The player content is probably about to change, so we can't carry on
300 until that has happened and we've rebuilt our pieces. Stop pass()
301 and seek() from working until then.
304 } else if (type == ChangeType::DONE) {
305 /* A change in our content has gone through. Re-build our pieces. */
308 } else if (type == ChangeType::CANCELLED) {
313 Change (type, property, frequent);
318 Player::set_video_container_size (dcp::Size s)
320 Change (ChangeType::PENDING, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
323 boost::mutex::scoped_lock lm (_mutex);
325 if (s == _video_container_size) {
327 Change (ChangeType::CANCELLED, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
331 _video_container_size = s;
333 _black_image = make_shared<Image>(AV_PIX_FMT_RGB24, _video_container_size, Image::Alignment::PADDED);
334 _black_image->make_black ();
337 Change (ChangeType::DONE, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
342 Player::playlist_change (ChangeType type)
344 if (type == ChangeType::DONE) {
347 Change (type, PlayerProperty::PLAYLIST, false);
352 Player::film_change (ChangeType type, Film::Property p)
354 /* Here we should notice Film properties that affect our output, and
355 alert listeners that our output now would be different to how it was
356 last time we were run.
359 if (p == Film::Property::CONTAINER) {
360 Change (type, PlayerProperty::FILM_CONTAINER, false);
361 } else if (p == Film::Property::VIDEO_FRAME_RATE) {
362 /* Pieces contain a FrameRateChange which contains the DCP frame rate,
363 so we need new pieces here.
365 if (type == ChangeType::DONE) {
368 Change (type, PlayerProperty::FILM_VIDEO_FRAME_RATE, false);
369 } else if (p == Film::Property::AUDIO_PROCESSOR) {
370 if (type == ChangeType::DONE && _film->audio_processor ()) {
371 boost::mutex::scoped_lock lm (_mutex);
372 _audio_processor = _film->audio_processor()->clone (_film->audio_frame_rate ());
374 } else if (p == Film::Property::AUDIO_CHANNELS) {
375 if (type == ChangeType::DONE) {
376 boost::mutex::scoped_lock lm (_mutex);
377 _audio_merger.clear ();
383 shared_ptr<PlayerVideo>
384 Player::black_player_video_frame (Eyes eyes) const
386 return std::make_shared<PlayerVideo> (
387 std::make_shared<const RawImageProxy>(_black_image),
390 _video_container_size,
391 _video_container_size,
394 PresetColourConversion::all().front().conversion,
396 std::weak_ptr<Content>(),
397 boost::optional<Frame>(),
404 Player::dcp_to_content_video (shared_ptr<const Piece> piece, DCPTime t) const
406 auto s = t - piece->content->position ();
407 s = min (piece->content->length_after_trim(_film), s);
408 s = max (DCPTime(), s + DCPTime (piece->content->trim_start(), piece->frc));
410 /* It might seem more logical here to convert s to a ContentTime (using the FrameRateChange)
411 then convert that ContentTime to frames at the content's rate. However this fails for
412 situations like content at 29.9978733fps, DCP at 30fps. The accuracy of the Time type is not
413 enough to distinguish between the two with low values of time (e.g. 3200 in Time units).
415 Instead we convert the DCPTime using the DCP video rate then account for any skip/repeat.
417 return s.frames_floor (piece->frc.dcp) / piece->frc.factor ();
422 Player::content_video_to_dcp (shared_ptr<const Piece> piece, Frame f) const
424 /* See comment in dcp_to_content_video */
425 auto const d = DCPTime::from_frames (f * piece->frc.factor(), piece->frc.dcp) - DCPTime(piece->content->trim_start(), piece->frc);
426 return d + piece->content->position();
431 Player::dcp_to_resampled_audio (shared_ptr<const Piece> piece, DCPTime t) const
433 auto s = t - piece->content->position ();
434 s = min (piece->content->length_after_trim(_film), s);
435 /* See notes in dcp_to_content_video */
436 return max (DCPTime(), DCPTime(piece->content->trim_start(), piece->frc) + s).frames_floor(_film->audio_frame_rate());
441 Player::resampled_audio_to_dcp (shared_ptr<const Piece> piece, Frame f) const
443 /* See comment in dcp_to_content_video */
444 return DCPTime::from_frames (f, _film->audio_frame_rate())
445 - DCPTime (piece->content->trim_start(), piece->frc)
446 + piece->content->position();
451 Player::dcp_to_content_time (shared_ptr<const Piece> piece, DCPTime t) const
453 auto s = t - piece->content->position ();
454 s = min (piece->content->length_after_trim(_film), s);
455 return max (ContentTime (), ContentTime (s, piece->frc) + piece->content->trim_start());
460 Player::content_time_to_dcp (shared_ptr<const Piece> piece, ContentTime t) const
462 return max (DCPTime(), DCPTime(t - piece->content->trim_start(), piece->frc) + piece->content->position());
467 Player::get_subtitle_fonts ()
469 boost::mutex::scoped_lock lm (_mutex);
471 vector<FontData> fonts;
472 for (auto i: _pieces) {
473 /* XXX: things may go wrong if there are duplicate font IDs
474 with different font files.
476 auto f = i->decoder->fonts ();
477 copy (f.begin(), f.end(), back_inserter(fonts));
484 /** Set this player never to produce any video data */
486 Player::set_ignore_video ()
488 boost::mutex::scoped_lock lm (_mutex);
489 _ignore_video = true;
490 setup_pieces_unlocked ();
495 Player::set_ignore_audio ()
497 boost::mutex::scoped_lock lm (_mutex);
498 _ignore_audio = true;
499 setup_pieces_unlocked ();
504 Player::set_ignore_text ()
506 boost::mutex::scoped_lock lm (_mutex);
508 setup_pieces_unlocked ();
512 /** Set the player to always burn open texts into the image regardless of the content settings */
514 Player::set_always_burn_open_subtitles ()
516 boost::mutex::scoped_lock lm (_mutex);
517 _always_burn_open_subtitles = true;
521 /** Sets up the player to be faster, possibly at the expense of quality */
525 boost::mutex::scoped_lock lm (_mutex);
527 setup_pieces_unlocked ();
532 Player::set_play_referenced ()
534 boost::mutex::scoped_lock lm (_mutex);
535 _play_referenced = true;
536 setup_pieces_unlocked ();
541 maybe_add_asset (list<ReferencedReelAsset>& a, shared_ptr<dcp::ReelAsset> r, Frame reel_trim_start, Frame reel_trim_end, DCPTime from, int const ffr)
543 DCPOMATIC_ASSERT (r);
544 r->set_entry_point (r->entry_point().get_value_or(0) + reel_trim_start);
545 r->set_duration (r->actual_duration() - reel_trim_start - reel_trim_end);
546 if (r->actual_duration() > 0) {
548 ReferencedReelAsset(r, DCPTimePeriod(from, from + DCPTime::from_frames(r->actual_duration(), ffr)))
554 list<ReferencedReelAsset>
555 Player::get_reel_assets ()
557 /* Does not require a lock on _mutex as it's only called from DCPEncoder */
559 list<ReferencedReelAsset> reel_assets;
561 for (auto content: playlist()->content()) {
562 auto dcp = dynamic_pointer_cast<DCPContent>(content);
567 if (!dcp->reference_video() && !dcp->reference_audio() && !dcp->reference_text(TextType::OPEN_SUBTITLE) && !dcp->reference_text(TextType::CLOSED_CAPTION)) {
571 scoped_ptr<DCPDecoder> decoder;
573 decoder.reset (new DCPDecoder(_film, dcp, false, false, shared_ptr<DCPDecoder>()));
578 auto const frame_rate = _film->video_frame_rate();
579 DCPOMATIC_ASSERT (dcp->video_frame_rate());
580 /* We should only be referencing if the DCP rate is the same as the film rate */
581 DCPOMATIC_ASSERT (std::round(dcp->video_frame_rate().get()) == frame_rate);
583 Frame const trim_start = dcp->trim_start().frames_round(frame_rate);
584 Frame const trim_end = dcp->trim_end().frames_round(frame_rate);
586 /* position in the asset from the start */
587 int64_t offset_from_start = 0;
588 /* position i the asset from the end */
589 int64_t offset_from_end = 0;
590 for (auto reel: decoder->reels()) {
591 /* Assume that main picture duration is the length of the reel */
592 offset_from_end += reel->main_picture()->actual_duration();
595 for (auto reel: decoder->reels()) {
597 /* Assume that main picture duration is the length of the reel */
598 int64_t const reel_duration = reel->main_picture()->actual_duration();
600 /* See doc/design/trim_reels.svg */
601 Frame const reel_trim_start = min(reel_duration, max(int64_t(0), trim_start - offset_from_start));
602 Frame const reel_trim_end = min(reel_duration, max(int64_t(0), reel_duration - (offset_from_end - trim_end)));
604 auto const from = max(DCPTime(), content->position() + DCPTime::from_frames(offset_from_start, frame_rate) - DCPTime::from_frames(trim_start, frame_rate));
605 if (dcp->reference_video()) {
606 maybe_add_asset (reel_assets, reel->main_picture(), reel_trim_start, reel_trim_end, from, frame_rate);
609 if (dcp->reference_audio()) {
610 maybe_add_asset (reel_assets, reel->main_sound(), reel_trim_start, reel_trim_end, from, frame_rate);
613 if (dcp->reference_text(TextType::OPEN_SUBTITLE)) {
614 maybe_add_asset (reel_assets, reel->main_subtitle(), reel_trim_start, reel_trim_end, from, frame_rate);
617 if (dcp->reference_text(TextType::CLOSED_CAPTION)) {
618 for (auto caption: reel->closed_captions()) {
619 maybe_add_asset (reel_assets, caption, reel_trim_start, reel_trim_end, from, frame_rate);
623 offset_from_start += reel_duration;
624 offset_from_end -= reel_duration;
635 boost::mutex::scoped_lock lm (_mutex);
638 /* We can't pass in this state */
639 LOG_DEBUG_PLAYER_NC ("Player is suspended");
643 if (_playback_length == DCPTime()) {
644 /* Special; just give one black frame */
645 emit_video (black_player_video_frame(Eyes::BOTH), DCPTime());
649 /* Find the decoder or empty which is farthest behind where we are and make it emit some data */
651 shared_ptr<Piece> earliest_content;
652 optional<DCPTime> earliest_time;
654 for (auto i: _pieces) {
659 auto const t = content_time_to_dcp (i, max(i->decoder->position(), i->content->trim_start()));
660 if (t > i->content->end(_film)) {
664 /* Given two choices at the same time, pick the one with texts so we see it before
667 if (!earliest_time || t < *earliest_time || (t == *earliest_time && !i->decoder->text.empty())) {
669 earliest_content = i;
683 if (earliest_content) {
687 if (!_black.done() && !_ignore_video && (!earliest_time || _black.position() < *earliest_time)) {
688 earliest_time = _black.position ();
692 if (!_silent.done() && !_ignore_audio && (!earliest_time || _silent.position() < *earliest_time)) {
693 earliest_time = _silent.position ();
700 LOG_DEBUG_PLAYER ("Calling pass() on %1", earliest_content->content->path(0));
701 earliest_content->done = earliest_content->decoder->pass ();
702 auto dcp = dynamic_pointer_cast<DCPContent>(earliest_content->content);
703 if (dcp && !_play_referenced && dcp->reference_audio()) {
704 /* We are skipping some referenced DCP audio content, so we need to update _next_audio_time
705 to `hide' the fact that no audio was emitted during the referenced DCP (though
706 we need to behave as though it was).
708 _next_audio_time = dcp->end (_film);
713 LOG_DEBUG_PLAYER ("Emit black for gap at %1", to_string(_black.position()));
714 emit_video (black_player_video_frame(Eyes::BOTH), _black.position());
715 _black.set_position (_black.position() + one_video_frame());
719 LOG_DEBUG_PLAYER ("Emit silence for gap at %1", to_string(_silent.position()));
720 DCPTimePeriod period (_silent.period_at_position());
721 if (_next_audio_time) {
722 /* Sometimes the thing that happened last finishes fractionally before
723 or after this silence. Bodge the start time of the silence to fix it.
724 I think this is nothing to worry about since we will just add or
725 remove a little silence at the end of some content.
727 int64_t const error = labs(period.from.get() - _next_audio_time->get());
728 /* Let's not worry about less than a frame at 24fps */
729 int64_t const too_much_error = DCPTime::from_frames(1, 24).get();
730 if (error >= too_much_error) {
731 _film->log()->log(String::compose("Silence starting before or after last audio by %1", error), LogEntry::TYPE_ERROR);
733 DCPOMATIC_ASSERT (error < too_much_error);
734 period.from = *_next_audio_time;
736 if (period.duration() > one_video_frame()) {
737 period.to = period.from + one_video_frame();
740 _silent.set_position (period.to);
748 /* Emit any audio that is ready */
750 /* Work out the time before which the audio is definitely all here. This is the earliest last_push_end of one
751 of our streams, or the position of the _silent. First, though we choose only streams that are less than
752 ignore_streams_behind seconds behind the furthest ahead (we assume that if a stream has fallen that far
753 behind it has finished). This is so that we don't withhold audio indefinitely awaiting data from a stream
754 that will never come, causing bugs like #2101.
756 constexpr int ignore_streams_behind = 5;
758 using state_pair = std::pair<AudioStreamPtr, StreamState>;
760 /* Find the 'leading' stream (i.e. the one that pushed data most recently) */
761 auto latest_last_push_end = std::max_element(
762 _stream_states.begin(),
763 _stream_states.end(),
764 [](state_pair const& a, state_pair const& b) { return a.second.last_push_end < b.second.last_push_end; }
767 if (latest_last_push_end != _stream_states.end()) {
768 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));
771 /* Now make a list of those streams that are less than ignore_streams_behind behind the leader */
772 std::map<AudioStreamPtr, StreamState> alive_stream_states;
773 for (auto const& i: _stream_states) {
774 if ((latest_last_push_end->second.last_push_end - i.second.last_push_end) < dcpomatic::DCPTime::from_seconds(ignore_streams_behind)) {
775 alive_stream_states.insert(i);
777 LOG_DEBUG_PLAYER("Ignoring stream %1 because it is too far behind", i.second.piece->content->path(0));
781 auto pull_to = _playback_length;
782 for (auto const& i: alive_stream_states) {
783 if (!i.second.piece->done && i.second.last_push_end < pull_to) {
784 pull_to = i.second.last_push_end;
787 if (!_silent.done() && _silent.position() < pull_to) {
788 pull_to = _silent.position();
791 LOG_DEBUG_PLAYER("Emitting audio up to %1", to_string(pull_to));
792 auto audio = _audio_merger.pull (pull_to);
793 for (auto i = audio.begin(); i != audio.end(); ++i) {
794 if (_next_audio_time && i->second < *_next_audio_time) {
795 /* This new data comes before the last we emitted (or the last seek); discard it */
796 auto cut = discard_audio (i->first, i->second, *_next_audio_time);
801 } else if (_next_audio_time && i->second > *_next_audio_time) {
802 /* There's a gap between this data and the last we emitted; fill with silence */
803 fill_audio (DCPTimePeriod (*_next_audio_time, i->second));
806 emit_audio (i->first, i->second);
813 for (auto const& i: _delay) {
814 do_emit_video(i.first, i.second);
817 /* Perhaps we should have Empty entries for both eyes in the 3D case (somehow).
818 * However, if we have L and R video files, and one is shorter than the other,
819 * the fill code in ::video mostly takes care of filling in the gaps.
820 * However, since it fills at the point when it knows there is more video coming
821 * at time t (so it should fill any gap up to t) it can't do anything right at the
822 * end. This is particularly bad news if the last frame emitted is a LEFT
823 * eye, as the MXF writer will complain about the 3D sequence being wrong.
824 * Here's a hack to workaround that particular case.
826 if (_next_video_eyes && _next_video_time && *_next_video_eyes == Eyes::RIGHT) {
827 do_emit_video (black_player_video_frame(Eyes::RIGHT), *_next_video_time);
835 /** @return Open subtitles for the frame at the given time, converted to images */
836 optional<PositionImage>
837 Player::open_subtitles_for_frame (DCPTime time) const
839 list<PositionImage> captions;
840 int const vfr = _film->video_frame_rate();
844 _active_texts[static_cast<int>(TextType::OPEN_SUBTITLE)].get_burnt(DCPTimePeriod(time, time + DCPTime::from_frames(1, vfr)), _always_burn_open_subtitles)
847 /* Bitmap subtitles */
848 for (auto i: j.bitmap) {
853 /* i.image will already have been scaled to fit _video_container_size */
854 dcp::Size scaled_size (i.rectangle.width * _video_container_size.width, i.rectangle.height * _video_container_size.height);
860 lrint(_video_container_size.width * i.rectangle.x),
861 lrint(_video_container_size.height * i.rectangle.y)
867 /* String subtitles (rendered to an image) */
868 if (!j.string.empty()) {
869 auto s = render_text (j.string, j.fonts, _video_container_size, time, vfr);
870 copy (s.begin(), s.end(), back_inserter (captions));
874 if (captions.empty()) {
878 return merge (captions, _subtitle_alignment);
883 Player::video (weak_ptr<Piece> weak_piece, ContentVideo video)
889 auto piece = weak_piece.lock ();
894 if (!piece->content->video->use()) {
898 FrameRateChange frc (_film, piece->content);
899 if (frc.skip && (video.frame % 2) == 1) {
903 /* Time of the first frame we will emit */
904 DCPTime const time = content_video_to_dcp (piece, video.frame);
905 if (video.eyes == Eyes::BOTH) {
906 LOG_DEBUG_PLAYER("Received video frame %1 at %2", video.frame, to_string(time));
908 LOG_DEBUG_PLAYER("Received video frame %1 %2 at %3", (video.eyes == Eyes::LEFT ? "L" : "R"), video.frame, to_string(time));
911 /* Discard if it's before the content's period or the last accurate seek. We can't discard
912 if it's after the content's period here as in that case we still need to fill any gap between
913 `now' and the end of the content's period.
915 if (time < piece->content->position() || (_next_video_time && time < *_next_video_time)) {
919 if (piece->ignore_video && piece->ignore_video->contains(time)) {
923 /* Fill gaps that we discover now that we have some video which needs to be emitted.
924 This is where we need to fill to.
926 DCPTime fill_to = min (time, piece->content->end(_film));
928 if (_next_video_time) {
929 DCPTime fill_from = max (*_next_video_time, piece->content->position());
931 /* Fill if we have more than half a frame to do */
932 if ((fill_to - fill_from) > one_video_frame() / 2) {
933 auto last = _last_video.find (weak_piece);
934 if (_film->three_d()) {
935 auto fill_to_eyes = video.eyes;
936 if (fill_to_eyes == Eyes::BOTH) {
937 fill_to_eyes = Eyes::LEFT;
939 if (fill_to == piece->content->end(_film)) {
940 /* Don't fill after the end of the content */
941 fill_to_eyes = Eyes::LEFT;
944 auto eyes = _next_video_eyes.get_value_or(Eyes::LEFT);
945 if (eyes == Eyes::BOTH) {
948 while (j < fill_to || eyes != fill_to_eyes) {
949 if (last != _last_video.end()) {
950 LOG_DEBUG_PLAYER("Fill using last video at %1 in 3D mode", to_string(j));
951 auto copy = last->second->shallow_copy();
952 copy->set_eyes (eyes);
953 emit_video (copy, j);
955 LOG_DEBUG_PLAYER("Fill using black at %1 in 3D mode", to_string(j));
956 emit_video (black_player_video_frame(eyes), j);
958 if (eyes == Eyes::RIGHT) {
959 j += one_video_frame();
961 eyes = increment_eyes (eyes);
964 for (DCPTime j = fill_from; j < fill_to; j += one_video_frame()) {
965 if (last != _last_video.end()) {
966 emit_video (last->second, j);
968 emit_video (black_player_video_frame(Eyes::BOTH), j);
975 auto const content_video = piece->content->video;
977 _last_video[weak_piece] = std::make_shared<PlayerVideo>(
979 content_video->actual_crop(),
980 content_video->fade (_film, video.frame),
982 content_video->scaled_size(_film->frame_size()),
983 _video_container_size,
985 content_video->pixel_quanta()
987 _video_container_size,
990 content_video->colour_conversion(),
991 content_video->range(),
998 for (int i = 0; i < frc.repeat; ++i) {
999 if (t < piece->content->end(_film)) {
1000 emit_video (_last_video[weak_piece], t);
1002 t += one_video_frame ();
1008 Player::audio (weak_ptr<Piece> weak_piece, AudioStreamPtr stream, ContentAudio content_audio)
1014 DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
1016 auto piece = weak_piece.lock ();
1021 auto content = piece->content->audio;
1022 DCPOMATIC_ASSERT (content);
1024 int const rfr = content->resampled_frame_rate (_film);
1026 /* Compute time in the DCP */
1027 auto time = resampled_audio_to_dcp (piece, content_audio.frame);
1028 LOG_DEBUG_PLAYER("Received audio frame %1 at %2", content_audio.frame, to_string(time));
1030 /* And the end of this block in the DCP */
1031 auto end = time + DCPTime::from_frames(content_audio.audio->frames(), rfr);
1033 /* Remove anything that comes before the start or after the end of the content */
1034 if (time < piece->content->position()) {
1035 auto cut = discard_audio (content_audio.audio, time, piece->content->position());
1037 /* This audio is entirely discarded */
1040 content_audio.audio = cut.first;
1042 } else if (time > piece->content->end(_film)) {
1043 /* Discard it all */
1045 } else if (end > piece->content->end(_film)) {
1046 Frame const remaining_frames = DCPTime(piece->content->end(_film) - time).frames_round(rfr);
1047 if (remaining_frames == 0) {
1050 content_audio.audio = make_shared<AudioBuffers>(content_audio.audio, remaining_frames, 0);
1053 DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
1057 auto const fade_coeffs = content->fade (stream, content_audio.frame, content_audio.audio->frames(), rfr);
1058 if (content->gain() != 0 || !fade_coeffs.empty()) {
1059 auto gain_buffers = make_shared<AudioBuffers>(content_audio.audio);
1060 if (!fade_coeffs.empty()) {
1061 /* Apply both fade and gain */
1062 DCPOMATIC_ASSERT (fade_coeffs.size() == static_cast<size_t>(gain_buffers->frames()));
1063 auto const channels = gain_buffers->channels();
1064 auto const frames = fade_coeffs.size();
1065 auto data = gain_buffers->data();
1066 auto const gain = db_to_linear (content->gain());
1067 for (auto channel = 0; channel < channels; ++channel) {
1068 for (auto frame = 0U; frame < frames; ++frame) {
1069 data[channel][frame] *= gain * fade_coeffs[frame];
1073 /* Just apply gain */
1074 gain_buffers->apply_gain (content->gain());
1076 content_audio.audio = gain_buffers;
1081 content_audio.audio = remap (content_audio.audio, _film->audio_channels(), stream->mapping());
1085 if (_audio_processor) {
1086 content_audio.audio = _audio_processor->run (content_audio.audio, _film->audio_channels ());
1091 _audio_merger.push (content_audio.audio, time);
1092 DCPOMATIC_ASSERT (_stream_states.find (stream) != _stream_states.end ());
1093 _stream_states[stream].last_push_end = time + DCPTime::from_frames (content_audio.audio->frames(), _film->audio_frame_rate());
1098 Player::bitmap_text_start (weak_ptr<Piece> weak_piece, weak_ptr<const TextContent> weak_content, ContentBitmapText subtitle)
1104 auto piece = weak_piece.lock ();
1105 auto content = weak_content.lock ();
1106 if (!piece || !content) {
1111 for (auto& sub: subtitle.subs)
1113 /* Apply content's subtitle offsets */
1114 sub.rectangle.x += content->x_offset ();
1115 sub.rectangle.y += content->y_offset ();
1117 /* Apply a corrective translation to keep the subtitle centred after the scale that is coming up */
1118 sub.rectangle.x -= sub.rectangle.width * ((content->x_scale() - 1) / 2);
1119 sub.rectangle.y -= sub.rectangle.height * ((content->y_scale() - 1) / 2);
1121 /* Apply content's subtitle scale */
1122 sub.rectangle.width *= content->x_scale ();
1123 sub.rectangle.height *= content->y_scale ();
1125 auto image = sub.image;
1127 /* We will scale the subtitle up to fit _video_container_size */
1128 int const width = sub.rectangle.width * _video_container_size.width;
1129 int const height = sub.rectangle.height * _video_container_size.height;
1130 if (width == 0 || height == 0) {
1134 dcp::Size scaled_size (width, height);
1135 ps.bitmap.push_back (BitmapText(image->scale(scaled_size, dcp::YUVToRGB::REC601, image->pixel_format(), Image::Alignment::PADDED, _fast), sub.rectangle));
1138 DCPTime from(content_time_to_dcp(piece, subtitle.from()));
1139 _active_texts[static_cast<int>(content->type())].add_from(weak_content, ps, from);
1144 Player::plain_text_start (weak_ptr<Piece> weak_piece, weak_ptr<const TextContent> weak_content, ContentStringText subtitle)
1150 auto piece = weak_piece.lock ();
1151 auto content = weak_content.lock ();
1152 if (!piece || !content) {
1157 DCPTime const from (content_time_to_dcp (piece, subtitle.from()));
1159 if (from > piece->content->end(_film)) {
1163 for (auto s: subtitle.subs) {
1164 s.set_h_position (s.h_position() + content->x_offset());
1165 s.set_v_position (s.v_position() + content->y_offset());
1166 float const xs = content->x_scale();
1167 float const ys = content->y_scale();
1168 float size = s.size();
1170 /* Adjust size to express the common part of the scaling;
1171 e.g. if xs = ys = 0.5 we scale size by 2.
1173 if (xs > 1e-5 && ys > 1e-5) {
1174 size *= 1 / min (1 / xs, 1 / ys);
1178 /* Then express aspect ratio changes */
1179 if (fabs (1.0 - xs / ys) > dcp::ASPECT_ADJUST_EPSILON) {
1180 s.set_aspect_adjust (xs / ys);
1183 s.set_in (dcp::Time(from.seconds(), 1000));
1184 ps.string.push_back (StringText (s, content->outline_width()));
1185 ps.add_fonts (content->fonts ());
1188 _active_texts[static_cast<int>(content->type())].add_from(weak_content, ps, from);
1193 Player::subtitle_stop (weak_ptr<Piece> weak_piece, weak_ptr<const TextContent> weak_content, ContentTime to)
1199 auto content = weak_content.lock ();
1204 if (!_active_texts[static_cast<int>(content->type())].have(weak_content)) {
1208 auto piece = weak_piece.lock ();
1213 DCPTime const dcp_to = content_time_to_dcp (piece, to);
1215 if (dcp_to > piece->content->end(_film)) {
1219 auto from = _active_texts[static_cast<int>(content->type())].add_to(weak_content, dcp_to);
1221 bool const always = (content->type() == TextType::OPEN_SUBTITLE && _always_burn_open_subtitles);
1222 if (content->use() && !always && !content->burn()) {
1223 Text (from.first, content->type(), content->dcp_track().get_value_or(DCPTextTrack()), DCPTimePeriod(from.second, dcp_to));
1229 Player::seek (DCPTime time, bool accurate)
1231 boost::mutex::scoped_lock lm (_mutex);
1232 LOG_DEBUG_PLAYER("Seek to %1 (%2accurate)", to_string(time), accurate ? "" : "in");
1235 /* We can't seek in this state */
1240 _shuffler->clear ();
1245 if (_audio_processor) {
1246 _audio_processor->flush ();
1249 _audio_merger.clear ();
1250 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
1251 _active_texts[i].clear ();
1254 for (auto i: _pieces) {
1255 if (time < i->content->position()) {
1256 /* Before; seek to the start of the content. Even if this request is for an inaccurate seek
1257 we must seek this (following) content accurately, otherwise when we come to the end of the current
1258 content we may not start right at the beginning of the next, causing a gap (if the next content has
1259 been trimmed to a point between keyframes, or something).
1261 i->decoder->seek (dcp_to_content_time (i, i->content->position()), true);
1263 } else if (i->content->position() <= time && time < i->content->end(_film)) {
1264 /* During; seek to position */
1265 i->decoder->seek (dcp_to_content_time (i, time), accurate);
1268 /* After; this piece is done */
1274 _next_video_time = time;
1275 _next_video_eyes = Eyes::LEFT;
1276 _next_audio_time = time;
1278 _next_video_time = boost::none;
1279 _next_video_eyes = boost::none;
1280 _next_audio_time = boost::none;
1283 _black.set_position (time);
1284 _silent.set_position (time);
1286 _last_video.clear ();
1291 Player::emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1293 if (!_film->three_d()) {
1294 if (pv->eyes() == Eyes::LEFT) {
1295 /* Use left-eye images for both eyes... */
1296 pv->set_eyes (Eyes::BOTH);
1297 } else if (pv->eyes() == Eyes::RIGHT) {
1298 /* ...and discard the right */
1303 /* We need a delay to give a little wiggle room to ensure that relevant subtitles arrive at the
1304 player before the video that requires them.
1306 _delay.push_back (make_pair (pv, time));
1308 if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
1309 _next_video_time = time + one_video_frame();
1311 _next_video_eyes = increment_eyes (pv->eyes());
1313 if (_delay.size() < 3) {
1317 auto to_do = _delay.front();
1319 do_emit_video (to_do.first, to_do.second);
1324 Player::do_emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1326 if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
1327 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
1328 _active_texts[i].clear_before (time);
1332 auto subtitles = open_subtitles_for_frame (time);
1334 pv->set_text (subtitles.get ());
1337 LOG_DEBUG_PLAYER("Player --> Video %1 %2", to_string(time), static_cast<int>(pv->eyes()));
1343 Player::emit_audio (shared_ptr<AudioBuffers> data, DCPTime time)
1345 /* Log if the assert below is about to fail */
1346 if (_next_audio_time && labs(time.get() - _next_audio_time->get()) > 1) {
1347 _film->log()->log(String::compose("Out-of-sequence emit %1 vs %2", to_string(time), to_string(*_next_audio_time)), LogEntry::TYPE_WARNING);
1350 /* This audio must follow on from the previous, allowing for half a sample (at 48kHz) leeway */
1351 DCPOMATIC_ASSERT (!_next_audio_time || labs(time.get() - _next_audio_time->get()) < 2);
1352 Audio (data, time, _film->audio_frame_rate());
1353 _next_audio_time = time + DCPTime::from_frames (data->frames(), _film->audio_frame_rate());
1358 Player::fill_audio (DCPTimePeriod period)
1360 if (period.from == period.to) {
1364 DCPOMATIC_ASSERT (period.from < period.to);
1366 DCPTime t = period.from;
1367 while (t < period.to) {
1368 DCPTime block = min (DCPTime::from_seconds (0.5), period.to - t);
1369 Frame const samples = block.frames_round(_film->audio_frame_rate());
1371 auto silence = make_shared<AudioBuffers>(_film->audio_channels(), samples);
1372 silence->make_silent ();
1373 emit_audio (silence, t);
1381 Player::one_video_frame () const
1383 return DCPTime::from_frames (1, _film->video_frame_rate ());
1387 pair<shared_ptr<AudioBuffers>, DCPTime>
1388 Player::discard_audio (shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to) const
1390 auto const discard_time = discard_to - time;
1391 auto const discard_frames = discard_time.frames_round(_film->audio_frame_rate());
1392 auto remaining_frames = audio->frames() - discard_frames;
1393 if (remaining_frames <= 0) {
1394 return make_pair(shared_ptr<AudioBuffers>(), DCPTime());
1396 auto cut = make_shared<AudioBuffers>(audio, remaining_frames, discard_frames);
1397 return make_pair(cut, time + discard_time);
1402 Player::set_dcp_decode_reduction (optional<int> reduction)
1404 Change (ChangeType::PENDING, PlayerProperty::DCP_DECODE_REDUCTION, false);
1407 boost::mutex::scoped_lock lm (_mutex);
1409 if (reduction == _dcp_decode_reduction) {
1411 Change (ChangeType::CANCELLED, PlayerProperty::DCP_DECODE_REDUCTION, false);
1415 _dcp_decode_reduction = reduction;
1416 setup_pieces_unlocked ();
1419 Change (ChangeType::DONE, PlayerProperty::DCP_DECODE_REDUCTION, false);
1424 Player::content_time_to_dcp (shared_ptr<const Content> content, ContentTime t)
1426 boost::mutex::scoped_lock lm (_mutex);
1428 for (auto i: _pieces) {
1429 if (i->content == content) {
1430 return content_time_to_dcp (i, t);
1434 /* We couldn't find this content; perhaps things are being changed over */
1439 optional<ContentTime>
1440 Player::dcp_to_content_time (shared_ptr<const Content> content, DCPTime t)
1442 boost::mutex::scoped_lock lm (_mutex);
1444 for (auto i: _pieces) {
1445 if (i->content == content) {
1446 return dcp_to_content_time (i, t);
1450 /* We couldn't find this content; perhaps things are being changed over */
1455 shared_ptr<const Playlist>
1456 Player::playlist () const
1458 return _playlist ? _playlist : _film->playlist();
1463 Player::atmos (weak_ptr<Piece> weak_piece, ContentAtmos data)
1469 auto piece = weak_piece.lock ();
1470 DCPOMATIC_ASSERT (piece);
1472 auto const vfr = _film->video_frame_rate();
1474 DCPTime const dcp_time = DCPTime::from_frames(data.frame, vfr) - DCPTime(piece->content->trim_start(), FrameRateChange(vfr, vfr));
1475 if (dcp_time < piece->content->position() || dcp_time >= (piece->content->end(_film))) {
1479 Atmos (data.data, dcp_time, data.metadata);