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"
45 #include "player_video.h"
48 #include "raw_image_proxy.h"
49 #include "referenced_reel_asset.h"
50 #include "render_text.h"
52 #include "text_content.h"
53 #include "text_decoder.h"
55 #include "video_decoder.h"
57 #include <dcp/reel_closed_caption_asset.h>
58 #include <dcp/reel_picture_asset.h>
59 #include <dcp/reel_sound_asset.h>
60 #include <dcp/reel_subtitle_asset.h>
70 using std::dynamic_pointer_cast;
73 using std::make_shared;
74 using std::make_shared;
79 using std::shared_ptr;
82 using boost::optional;
83 using boost::scoped_ptr;
84 #if BOOST_VERSION >= 106100
85 using namespace boost::placeholders;
87 using namespace dcpomatic;
90 int const PlayerProperty::VIDEO_CONTAINER_SIZE = 700;
91 int const PlayerProperty::PLAYLIST = 701;
92 int const PlayerProperty::FILM_CONTAINER = 702;
93 int const PlayerProperty::FILM_VIDEO_FRAME_RATE = 703;
94 int const PlayerProperty::DCP_DECODE_REDUCTION = 704;
95 int const PlayerProperty::PLAYBACK_LENGTH = 705;
98 Player::Player (shared_ptr<const Film> film, Image::Alignment subtitle_alignment)
101 , _tolerant (film->tolerant())
102 , _audio_merger (_film->audio_frame_rate())
103 , _subtitle_alignment (subtitle_alignment)
109 Player::Player (shared_ptr<const Film> film, shared_ptr<const Playlist> playlist_)
111 , _playlist (playlist_)
113 , _tolerant (film->tolerant())
114 , _audio_merger (_film->audio_frame_rate())
123 _film_changed_connection = _film->Change.connect (bind (&Player::film_change, this, _1, _2));
124 /* The butler must hear about this first, so since we are proxying this through to the butler we must
127 _playlist_change_connection = playlist()->Change.connect (bind (&Player::playlist_change, this, _1), boost::signals2::at_front);
128 _playlist_content_change_connection = playlist()->ContentChange.connect (bind(&Player::playlist_content_change, this, _1, _3, _4));
129 set_video_container_size (_film->frame_size ());
131 film_change (ChangeType::DONE, Film::Property::AUDIO_PROCESSOR);
134 seek (DCPTime (), true);
139 Player::setup_pieces ()
141 boost::mutex::scoped_lock lm (_mutex);
142 setup_pieces_unlocked ();
147 have_video (shared_ptr<const Content> content)
149 return static_cast<bool>(content->video) && content->video->use();
154 have_audio (shared_ptr<const Content> content)
156 return static_cast<bool>(content->audio);
161 Player::setup_pieces_unlocked ()
163 _playback_length = _playlist ? _playlist->length(_film) : _film->length();
165 auto old_pieces = _pieces;
168 _shuffler.reset (new Shuffler());
169 _shuffler->Video.connect(bind(&Player::video, this, _1, _2));
171 for (auto i: playlist()->content()) {
173 if (!i->paths_valid ()) {
177 if (_ignore_video && _ignore_audio && i->text.empty()) {
178 /* We're only interested in text and this content has none */
182 shared_ptr<Decoder> old_decoder;
183 for (auto j: old_pieces) {
184 if (j->content == i) {
185 old_decoder = j->decoder;
190 auto decoder = decoder_factory (_film, i, _fast, _tolerant, old_decoder);
191 DCPOMATIC_ASSERT (decoder);
193 FrameRateChange frc (_film, i);
195 if (decoder->video && _ignore_video) {
196 decoder->video->set_ignore (true);
199 if (decoder->audio && _ignore_audio) {
200 decoder->audio->set_ignore (true);
204 for (auto i: decoder->text) {
205 i->set_ignore (true);
209 auto dcp = dynamic_pointer_cast<DCPDecoder> (decoder);
211 dcp->set_decode_referenced (_play_referenced);
212 if (_play_referenced) {
213 dcp->set_forced_reduction (_dcp_decode_reduction);
217 auto piece = make_shared<Piece>(i, decoder, frc);
218 _pieces.push_back (piece);
220 if (decoder->video) {
221 if (i->video->frame_type() == VideoFrameType::THREE_D_LEFT || i->video->frame_type() == VideoFrameType::THREE_D_RIGHT) {
222 /* We need a Shuffler to cope with 3D L/R video data arriving out of sequence */
223 decoder->video->Data.connect (bind(&Shuffler::video, _shuffler.get(), weak_ptr<Piece>(piece), _1));
225 decoder->video->Data.connect (bind(&Player::video, this, weak_ptr<Piece>(piece), _1));
229 if (decoder->audio) {
230 decoder->audio->Data.connect (bind (&Player::audio, this, weak_ptr<Piece> (piece), _1, _2));
233 auto j = decoder->text.begin();
235 while (j != decoder->text.end()) {
236 (*j)->BitmapStart.connect (
237 bind(&Player::bitmap_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
239 (*j)->PlainStart.connect (
240 bind(&Player::plain_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
243 bind(&Player::subtitle_stop, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
249 if (decoder->atmos) {
250 decoder->atmos->Data.connect (bind(&Player::atmos, this, weak_ptr<Piece>(piece), _1));
254 _stream_states.clear ();
255 for (auto i: _pieces) {
256 if (i->content->audio) {
257 for (auto j: i->content->audio->streams()) {
258 _stream_states[j] = StreamState (i, i->content->position ());
263 for (auto i = _pieces.begin(); i != _pieces.end(); ++i) {
264 if (auto video = (*i)->content->video) {
265 if (video->use() && video->frame_type() != VideoFrameType::THREE_D_LEFT && video->frame_type() != VideoFrameType::THREE_D_RIGHT) {
266 /* Look for content later in the content list with in-use video that overlaps this */
267 auto period = DCPTimePeriod((*i)->content->position(), (*i)->content->end(_film));
270 for (; j != _pieces.end(); ++j) {
271 if ((*j)->content->video && (*j)->content->video->use()) {
272 (*i)->ignore_video = DCPTimePeriod((*j)->content->position(), (*j)->content->end(_film)).overlap(period);
279 _black = Empty (_film, playlist(), bind(&have_video, _1), _playback_length);
280 _silent = Empty (_film, playlist(), bind(&have_audio, _1), _playback_length);
282 _last_video_time = boost::optional<dcpomatic::DCPTime>();
283 _last_video_eyes = Eyes::BOTH;
284 _last_audio_time = boost::optional<dcpomatic::DCPTime>();
289 Player::playlist_content_change (ChangeType type, int property, bool frequent)
291 if (property == VideoContentProperty::CROP) {
292 if (type == ChangeType::DONE) {
293 auto const vcs = video_container_size();
294 boost::mutex::scoped_lock lm (_mutex);
295 for (auto const& i: _delay) {
296 i.first->reset_metadata (_film, vcs);
300 if (type == ChangeType::PENDING) {
301 /* The player content is probably about to change, so we can't carry on
302 until that has happened and we've rebuilt our pieces. Stop pass()
303 and seek() from working until then.
306 } else if (type == ChangeType::DONE) {
307 /* A change in our content has gone through. Re-build our pieces. */
310 } else if (type == ChangeType::CANCELLED) {
315 Change (type, property, frequent);
320 Player::set_video_container_size (dcp::Size s)
322 Change (ChangeType::PENDING, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
325 boost::mutex::scoped_lock lm (_mutex);
327 if (s == _video_container_size) {
329 Change (ChangeType::CANCELLED, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
333 _video_container_size = s;
335 _black_image = make_shared<Image>(AV_PIX_FMT_RGB24, _video_container_size, Image::Alignment::PADDED);
336 _black_image->make_black ();
339 Change (ChangeType::DONE, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
344 Player::playlist_change (ChangeType type)
346 if (type == ChangeType::DONE) {
349 Change (type, PlayerProperty::PLAYLIST, false);
354 Player::film_change (ChangeType type, Film::Property p)
356 /* Here we should notice Film properties that affect our output, and
357 alert listeners that our output now would be different to how it was
358 last time we were run.
361 if (p == Film::Property::CONTAINER) {
362 Change (type, PlayerProperty::FILM_CONTAINER, false);
363 } else if (p == Film::Property::VIDEO_FRAME_RATE) {
364 /* Pieces contain a FrameRateChange which contains the DCP frame rate,
365 so we need new pieces here.
367 if (type == ChangeType::DONE) {
370 Change (type, PlayerProperty::FILM_VIDEO_FRAME_RATE, false);
371 } else if (p == Film::Property::AUDIO_PROCESSOR) {
372 if (type == ChangeType::DONE && _film->audio_processor ()) {
373 boost::mutex::scoped_lock lm (_mutex);
374 _audio_processor = _film->audio_processor()->clone (_film->audio_frame_rate ());
376 } else if (p == Film::Property::AUDIO_CHANNELS) {
377 if (type == ChangeType::DONE) {
378 boost::mutex::scoped_lock lm (_mutex);
379 _audio_merger.clear ();
385 shared_ptr<PlayerVideo>
386 Player::black_player_video_frame (Eyes eyes) const
388 return std::make_shared<PlayerVideo> (
389 std::make_shared<const RawImageProxy>(_black_image),
392 _video_container_size,
393 _video_container_size,
396 PresetColourConversion::all().front().conversion,
398 std::weak_ptr<Content>(),
399 boost::optional<Frame>(),
406 Player::dcp_to_content_video (shared_ptr<const Piece> piece, DCPTime t) const
408 auto s = t - piece->content->position ();
409 s = min (piece->content->length_after_trim(_film), s);
410 s = max (DCPTime(), s + DCPTime (piece->content->trim_start(), piece->frc));
412 /* It might seem more logical here to convert s to a ContentTime (using the FrameRateChange)
413 then convert that ContentTime to frames at the content's rate. However this fails for
414 situations like content at 29.9978733fps, DCP at 30fps. The accuracy of the Time type is not
415 enough to distinguish between the two with low values of time (e.g. 3200 in Time units).
417 Instead we convert the DCPTime using the DCP video rate then account for any skip/repeat.
419 return s.frames_floor (piece->frc.dcp) / piece->frc.factor ();
424 Player::content_video_to_dcp (shared_ptr<const Piece> piece, Frame f) const
426 /* See comment in dcp_to_content_video */
427 auto const d = DCPTime::from_frames (f * piece->frc.factor(), piece->frc.dcp) - DCPTime(piece->content->trim_start(), piece->frc);
428 return d + piece->content->position();
433 Player::dcp_to_resampled_audio (shared_ptr<const Piece> piece, DCPTime t) const
435 auto s = t - piece->content->position ();
436 s = min (piece->content->length_after_trim(_film), s);
437 /* See notes in dcp_to_content_video */
438 return max (DCPTime(), DCPTime(piece->content->trim_start(), piece->frc) + s).frames_floor(_film->audio_frame_rate());
443 Player::resampled_audio_to_dcp (shared_ptr<const Piece> piece, Frame f) const
445 /* See comment in dcp_to_content_video */
446 return DCPTime::from_frames (f, _film->audio_frame_rate())
447 - DCPTime (piece->content->trim_start(), piece->frc)
448 + piece->content->position();
453 Player::dcp_to_content_time (shared_ptr<const Piece> piece, DCPTime t) const
455 auto s = t - piece->content->position ();
456 s = min (piece->content->length_after_trim(_film), s);
457 return max (ContentTime (), ContentTime (s, piece->frc) + piece->content->trim_start());
462 Player::content_time_to_dcp (shared_ptr<const Piece> piece, ContentTime t) const
464 return max (DCPTime(), DCPTime(t - piece->content->trim_start(), piece->frc) + piece->content->position());
469 Player::get_subtitle_fonts ()
471 boost::mutex::scoped_lock lm (_mutex);
473 vector<FontData> fonts;
474 for (auto i: _pieces) {
475 /* XXX: things may go wrong if there are duplicate font IDs
476 with different font files.
478 auto f = i->decoder->fonts ();
479 copy (f.begin(), f.end(), back_inserter(fonts));
486 /** Set this player never to produce any video data */
488 Player::set_ignore_video ()
490 boost::mutex::scoped_lock lm (_mutex);
491 _ignore_video = true;
492 setup_pieces_unlocked ();
497 Player::set_ignore_audio ()
499 boost::mutex::scoped_lock lm (_mutex);
500 _ignore_audio = true;
501 setup_pieces_unlocked ();
506 Player::set_ignore_text ()
508 boost::mutex::scoped_lock lm (_mutex);
510 setup_pieces_unlocked ();
514 /** Set the player to always burn open texts into the image regardless of the content settings */
516 Player::set_always_burn_open_subtitles ()
518 boost::mutex::scoped_lock lm (_mutex);
519 _always_burn_open_subtitles = true;
523 /** Sets up the player to be faster, possibly at the expense of quality */
527 boost::mutex::scoped_lock lm (_mutex);
529 setup_pieces_unlocked ();
534 Player::set_play_referenced ()
536 boost::mutex::scoped_lock lm (_mutex);
537 _play_referenced = true;
538 setup_pieces_unlocked ();
543 maybe_add_asset (list<ReferencedReelAsset>& a, shared_ptr<dcp::ReelAsset> r, Frame reel_trim_start, Frame reel_trim_end, DCPTime from, int const ffr)
545 DCPOMATIC_ASSERT (r);
546 r->set_entry_point (r->entry_point().get_value_or(0) + reel_trim_start);
547 r->set_duration (r->actual_duration() - reel_trim_start - reel_trim_end);
548 if (r->actual_duration() > 0) {
550 ReferencedReelAsset(r, DCPTimePeriod(from, from + DCPTime::from_frames(r->actual_duration(), ffr)))
556 list<ReferencedReelAsset>
557 Player::get_reel_assets ()
559 /* Does not require a lock on _mutex as it's only called from DCPEncoder */
561 list<ReferencedReelAsset> reel_assets;
563 for (auto content: playlist()->content()) {
564 auto dcp = dynamic_pointer_cast<DCPContent>(content);
569 if (!dcp->reference_video() && !dcp->reference_audio() && !dcp->reference_text(TextType::OPEN_SUBTITLE) && !dcp->reference_text(TextType::CLOSED_CAPTION)) {
573 scoped_ptr<DCPDecoder> decoder;
575 decoder.reset (new DCPDecoder(_film, dcp, false, false, shared_ptr<DCPDecoder>()));
580 auto const frame_rate = _film->video_frame_rate();
581 DCPOMATIC_ASSERT (dcp->video_frame_rate());
582 /* We should only be referencing if the DCP rate is the same as the film rate */
583 DCPOMATIC_ASSERT (std::round(dcp->video_frame_rate().get()) == frame_rate);
585 Frame const trim_start = dcp->trim_start().frames_round(frame_rate);
586 Frame const trim_end = dcp->trim_end().frames_round(frame_rate);
588 /* position in the asset from the start */
589 int64_t offset_from_start = 0;
590 /* position i the asset from the end */
591 int64_t offset_from_end = 0;
592 for (auto reel: decoder->reels()) {
593 /* Assume that main picture duration is the length of the reel */
594 offset_from_end += reel->main_picture()->actual_duration();
597 for (auto reel: decoder->reels()) {
599 /* Assume that main picture duration is the length of the reel */
600 int64_t const reel_duration = reel->main_picture()->actual_duration();
602 /* See doc/design/trim_reels.svg */
603 Frame const reel_trim_start = min(reel_duration, max(int64_t(0), trim_start - offset_from_start));
604 Frame const reel_trim_end = min(reel_duration, max(int64_t(0), reel_duration - (offset_from_end - trim_end)));
606 auto const from = max(DCPTime(), content->position() + DCPTime::from_frames(offset_from_start, frame_rate) - DCPTime::from_frames(trim_start, frame_rate));
607 if (dcp->reference_video()) {
608 maybe_add_asset (reel_assets, reel->main_picture(), reel_trim_start, reel_trim_end, from, frame_rate);
611 if (dcp->reference_audio()) {
612 maybe_add_asset (reel_assets, reel->main_sound(), reel_trim_start, reel_trim_end, from, frame_rate);
615 if (dcp->reference_text(TextType::OPEN_SUBTITLE)) {
616 maybe_add_asset (reel_assets, reel->main_subtitle(), reel_trim_start, reel_trim_end, from, frame_rate);
619 if (dcp->reference_text(TextType::CLOSED_CAPTION)) {
620 for (auto caption: reel->closed_captions()) {
621 maybe_add_asset (reel_assets, caption, reel_trim_start, reel_trim_end, from, frame_rate);
625 offset_from_start += reel_duration;
626 offset_from_end -= reel_duration;
637 boost::mutex::scoped_lock lm (_mutex);
640 /* We can't pass in this state */
641 LOG_DEBUG_PLAYER_NC ("Player is suspended");
645 if (_playback_length == DCPTime()) {
646 /* Special; just give one black frame */
647 emit_video (black_player_video_frame(Eyes::BOTH), DCPTime());
651 /* Find the decoder or empty which is farthest behind where we are and make it emit some data */
653 shared_ptr<Piece> earliest_content;
654 optional<DCPTime> earliest_time;
656 for (auto i: _pieces) {
661 auto const t = content_time_to_dcp (i, max(i->decoder->position(), i->content->trim_start()));
662 if (t > i->content->end(_film)) {
666 /* Given two choices at the same time, pick the one with texts so we see it before
669 if (!earliest_time || t < *earliest_time || (t == *earliest_time && !i->decoder->text.empty())) {
671 earliest_content = i;
685 if (earliest_content) {
689 if (!_black.done() && !_ignore_video && (!earliest_time || _black.position() < *earliest_time)) {
690 earliest_time = _black.position ();
694 if (!_silent.done() && !_ignore_audio && (!earliest_time || _silent.position() < *earliest_time)) {
695 earliest_time = _silent.position ();
702 LOG_DEBUG_PLAYER ("Calling pass() on %1", earliest_content->content->path(0));
703 earliest_content->done = earliest_content->decoder->pass ();
704 auto dcp = dynamic_pointer_cast<DCPContent>(earliest_content->content);
705 if (dcp && !_play_referenced && dcp->reference_audio()) {
706 /* We are skipping some referenced DCP audio content, so we need to update _last_audio_time
707 to `hide' the fact that no audio was emitted during the referenced DCP (though
708 we need to behave as though it was).
710 _last_audio_time = dcp->end (_film);
715 LOG_DEBUG_PLAYER ("Emit black for gap at %1", to_string(_black.position()));
716 emit_video (black_player_video_frame(Eyes::BOTH), _black.position());
717 _black.set_position (_black.position() + one_video_frame());
721 LOG_DEBUG_PLAYER ("Emit silence for gap at %1", to_string(_silent.position()));
722 DCPTimePeriod period (_silent.period_at_position());
723 if (_last_audio_time) {
724 /* Sometimes the thing that happened last finishes fractionally before
725 or after this silence. Bodge the start time of the silence to fix it.
726 I think this is nothing to worry about since we will just add or
727 remove a little silence at the end of some content.
729 int64_t const error = labs(period.from.get() - _last_audio_time->get());
730 /* Let's not worry about less than a frame at 24fps */
731 int64_t const too_much_error = DCPTime::from_frames(1, 24).get();
732 if (error >= too_much_error) {
733 _film->log()->log(String::compose("Silence starting before or after last audio by %1", error), LogEntry::TYPE_ERROR);
735 DCPOMATIC_ASSERT (error < too_much_error);
736 period.from = *_last_audio_time;
738 if (period.duration() > one_video_frame()) {
739 period.to = period.from + one_video_frame();
742 _silent.set_position (period.to);
750 /* Emit any audio that is ready */
752 /* Work out the time before which the audio is definitely all here. This is the earliest last_push_end of one
753 of our streams, or the position of the _silent. First, though we choose only streams that are less than
754 ignore_streams_behind seconds behind the furthest ahead (we assume that if a stream has fallen that far
755 behind it has finished). This is so that we don't withhold audio indefinitely awaiting data from a stream
756 that will never come, causing bugs like #2101.
758 constexpr int ignore_streams_behind = 5;
760 using state_pair = std::pair<AudioStreamPtr, StreamState>;
762 /* Find the 'leading' stream (i.e. the one that pushed data most recently) */
763 auto latest_last_push_end = std::max_element(
764 _stream_states.begin(),
765 _stream_states.end(),
766 [](state_pair const& a, state_pair const& b) { return a.second.last_push_end < b.second.last_push_end; }
769 if (latest_last_push_end != _stream_states.end()) {
770 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));
773 /* Now make a list of those streams that are less than ignore_streams_behind behind the leader */
774 std::map<AudioStreamPtr, StreamState> alive_stream_states;
775 for (auto const& i: _stream_states) {
776 if ((latest_last_push_end->second.last_push_end - i.second.last_push_end) < dcpomatic::DCPTime::from_seconds(ignore_streams_behind)) {
777 alive_stream_states.insert(i);
779 LOG_DEBUG_PLAYER("Ignoring stream %1 because it is too far behind", i.second.piece->content->path(0));
783 auto pull_to = _playback_length;
784 for (auto const& i: alive_stream_states) {
785 if (!i.second.piece->done && i.second.last_push_end < pull_to) {
786 pull_to = i.second.last_push_end;
789 if (!_silent.done() && _silent.position() < pull_to) {
790 pull_to = _silent.position();
793 LOG_DEBUG_PLAYER("Emitting audio up to %1", to_string(pull_to));
794 auto audio = _audio_merger.pull (pull_to);
795 for (auto i = audio.begin(); i != audio.end(); ++i) {
796 if (_last_audio_time && i->second < *_last_audio_time) {
797 /* This new data comes before the last we emitted (or the last seek); discard it */
798 auto cut = discard_audio (i->first, i->second, *_last_audio_time);
803 } else if (_last_audio_time && i->second > *_last_audio_time) {
804 /* There's a gap between this data and the last we emitted; fill with silence */
805 fill_audio (DCPTimePeriod (*_last_audio_time, i->second));
808 emit_audio (i->first, i->second);
813 for (auto const& i: _delay) {
814 do_emit_video(i.first, i.second);
822 /** @return Open subtitles for the frame at the given time, converted to images */
823 optional<PositionImage>
824 Player::open_subtitles_for_frame (DCPTime time) const
826 list<PositionImage> captions;
827 int const vfr = _film->video_frame_rate();
831 _active_texts[static_cast<int>(TextType::OPEN_SUBTITLE)].get_burnt(DCPTimePeriod(time, time + DCPTime::from_frames(1, vfr)), _always_burn_open_subtitles)
834 /* Bitmap subtitles */
835 for (auto i: j.bitmap) {
840 /* i.image will already have been scaled to fit _video_container_size */
841 dcp::Size scaled_size (i.rectangle.width * _video_container_size.width, i.rectangle.height * _video_container_size.height);
847 lrint(_video_container_size.width * i.rectangle.x),
848 lrint(_video_container_size.height * i.rectangle.y)
854 /* String subtitles (rendered to an image) */
855 if (!j.string.empty()) {
856 auto s = render_text (j.string, j.fonts, _video_container_size, time, vfr);
857 copy (s.begin(), s.end(), back_inserter (captions));
861 if (captions.empty()) {
865 return merge (captions, _subtitle_alignment);
870 Player::video (weak_ptr<Piece> wp, ContentVideo video)
876 auto piece = wp.lock ();
881 if (!piece->content->video->use()) {
885 FrameRateChange frc (_film, piece->content);
886 if (frc.skip && (video.frame % 2) == 1) {
890 /* Time of the first frame we will emit */
891 DCPTime const time = content_video_to_dcp (piece, video.frame);
892 LOG_DEBUG_PLAYER("Received video frame %1 at %2", video.frame, to_string(time));
894 /* Discard if it's before the content's period or the last accurate seek. We can't discard
895 if it's after the content's period here as in that case we still need to fill any gap between
896 `now' and the end of the content's period.
898 if (time < piece->content->position() || (_last_video_time && time < *_last_video_time)) {
902 if (piece->ignore_video && piece->ignore_video->contains(time)) {
906 /* Fill gaps that we discover now that we have some video which needs to be emitted.
907 This is where we need to fill to.
909 DCPTime fill_to = min (time, piece->content->end(_film));
911 if (_last_video_time) {
912 DCPTime fill_from = max (*_last_video_time, piece->content->position());
914 /* Fill if we have more than half a frame to do */
915 if ((fill_to - fill_from) > one_video_frame() / 2) {
916 auto last = _last_video.find (wp);
917 if (_film->three_d()) {
918 auto fill_to_eyes = video.eyes;
919 if (fill_to_eyes == Eyes::BOTH) {
920 fill_to_eyes = Eyes::LEFT;
922 if (fill_to == piece->content->end(_film)) {
923 /* Don't fill after the end of the content */
924 fill_to_eyes = Eyes::LEFT;
927 auto eyes = _last_video_eyes.get_value_or(Eyes::LEFT);
928 if (eyes == Eyes::BOTH) {
931 while (j < fill_to || eyes != fill_to_eyes) {
932 if (last != _last_video.end()) {
933 LOG_DEBUG_PLAYER("Fill using last video at %1 in 3D mode", to_string(j));
934 auto copy = last->second->shallow_copy();
935 copy->set_eyes (eyes);
936 emit_video (copy, j);
938 LOG_DEBUG_PLAYER("Fill using black at %1 in 3D mode", to_string(j));
939 emit_video (black_player_video_frame(eyes), j);
941 if (eyes == Eyes::RIGHT) {
942 j += one_video_frame();
944 eyes = increment_eyes (eyes);
947 for (DCPTime j = fill_from; j < fill_to; j += one_video_frame()) {
948 if (last != _last_video.end()) {
949 emit_video (last->second, j);
951 emit_video (black_player_video_frame(Eyes::BOTH), j);
958 auto const content_video = piece->content->video;
960 _last_video[wp] = std::make_shared<PlayerVideo>(
962 content_video->actual_crop(),
963 content_video->fade (_film, video.frame),
965 content_video->scaled_size(_film->frame_size()),
966 _video_container_size,
968 content_video->pixel_quanta()
970 _video_container_size,
973 content_video->colour_conversion(),
974 content_video->range(),
981 for (int i = 0; i < frc.repeat; ++i) {
982 if (t < piece->content->end(_film)) {
983 emit_video (_last_video[wp], t);
985 t += one_video_frame ();
991 Player::audio (weak_ptr<Piece> wp, AudioStreamPtr stream, ContentAudio content_audio)
997 DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
999 auto piece = wp.lock ();
1004 auto content = piece->content->audio;
1005 DCPOMATIC_ASSERT (content);
1007 int const rfr = content->resampled_frame_rate (_film);
1009 /* Compute time in the DCP */
1010 auto time = resampled_audio_to_dcp (piece, content_audio.frame);
1011 LOG_DEBUG_PLAYER("Received audio frame %1 at %2", content_audio.frame, to_string(time));
1013 /* And the end of this block in the DCP */
1014 auto end = time + DCPTime::from_frames(content_audio.audio->frames(), rfr);
1016 /* Remove anything that comes before the start or after the end of the content */
1017 if (time < piece->content->position()) {
1018 auto cut = discard_audio (content_audio.audio, time, piece->content->position());
1020 /* This audio is entirely discarded */
1023 content_audio.audio = cut.first;
1025 } else if (time > piece->content->end(_film)) {
1026 /* Discard it all */
1028 } else if (end > piece->content->end(_film)) {
1029 Frame const remaining_frames = DCPTime(piece->content->end(_film) - time).frames_round(rfr);
1030 if (remaining_frames == 0) {
1033 content_audio.audio = make_shared<AudioBuffers>(content_audio.audio, remaining_frames, 0);
1036 DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
1040 if (content->gain() != 0) {
1041 auto gain = make_shared<AudioBuffers>(content_audio.audio);
1042 gain->apply_gain (content->gain());
1043 content_audio.audio = gain;
1048 content_audio.audio = remap (content_audio.audio, _film->audio_channels(), stream->mapping());
1052 if (_audio_processor) {
1053 content_audio.audio = _audio_processor->run (content_audio.audio, _film->audio_channels ());
1058 _audio_merger.push (content_audio.audio, time);
1059 DCPOMATIC_ASSERT (_stream_states.find (stream) != _stream_states.end ());
1060 _stream_states[stream].last_push_end = time + DCPTime::from_frames (content_audio.audio->frames(), _film->audio_frame_rate());
1065 Player::bitmap_text_start (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentBitmapText subtitle)
1071 auto piece = wp.lock ();
1072 auto text = wc.lock ();
1073 if (!piece || !text) {
1077 /* Apply content's subtitle offsets */
1078 subtitle.sub.rectangle.x += text->x_offset ();
1079 subtitle.sub.rectangle.y += text->y_offset ();
1081 /* Apply a corrective translation to keep the subtitle centred after the scale that is coming up */
1082 subtitle.sub.rectangle.x -= subtitle.sub.rectangle.width * ((text->x_scale() - 1) / 2);
1083 subtitle.sub.rectangle.y -= subtitle.sub.rectangle.height * ((text->y_scale() - 1) / 2);
1085 /* Apply content's subtitle scale */
1086 subtitle.sub.rectangle.width *= text->x_scale ();
1087 subtitle.sub.rectangle.height *= text->y_scale ();
1090 auto image = subtitle.sub.image;
1092 /* We will scale the subtitle up to fit _video_container_size */
1093 int const width = subtitle.sub.rectangle.width * _video_container_size.width;
1094 int const height = subtitle.sub.rectangle.height * _video_container_size.height;
1095 if (width == 0 || height == 0) {
1099 dcp::Size scaled_size (width, height);
1100 ps.bitmap.push_back (BitmapText(image->scale(scaled_size, dcp::YUVToRGB::REC601, image->pixel_format(), Image::Alignment::PADDED, _fast), subtitle.sub.rectangle));
1101 DCPTime from (content_time_to_dcp (piece, subtitle.from()));
1103 _active_texts[static_cast<int>(text->type())].add_from (wc, ps, from);
1108 Player::plain_text_start (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentStringText subtitle)
1114 auto piece = wp.lock ();
1115 auto text = wc.lock ();
1116 if (!piece || !text) {
1121 DCPTime const from (content_time_to_dcp (piece, subtitle.from()));
1123 if (from > piece->content->end(_film)) {
1127 for (auto s: subtitle.subs) {
1128 s.set_h_position (s.h_position() + text->x_offset ());
1129 s.set_v_position (s.v_position() + text->y_offset ());
1130 float const xs = text->x_scale();
1131 float const ys = text->y_scale();
1132 float size = s.size();
1134 /* Adjust size to express the common part of the scaling;
1135 e.g. if xs = ys = 0.5 we scale size by 2.
1137 if (xs > 1e-5 && ys > 1e-5) {
1138 size *= 1 / min (1 / xs, 1 / ys);
1142 /* Then express aspect ratio changes */
1143 if (fabs (1.0 - xs / ys) > dcp::ASPECT_ADJUST_EPSILON) {
1144 s.set_aspect_adjust (xs / ys);
1147 s.set_in (dcp::Time(from.seconds(), 1000));
1148 ps.string.push_back (StringText (s, text->outline_width()));
1149 ps.add_fonts (text->fonts ());
1152 _active_texts[static_cast<int>(text->type())].add_from (wc, ps, from);
1157 Player::subtitle_stop (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentTime to)
1163 auto text = wc.lock ();
1168 if (!_active_texts[static_cast<int>(text->type())].have(wc)) {
1172 shared_ptr<Piece> piece = wp.lock ();
1177 DCPTime const dcp_to = content_time_to_dcp (piece, to);
1179 if (dcp_to > piece->content->end(_film)) {
1183 auto from = _active_texts[static_cast<int>(text->type())].add_to (wc, dcp_to);
1185 bool const always = (text->type() == TextType::OPEN_SUBTITLE && _always_burn_open_subtitles);
1186 if (text->use() && !always && !text->burn()) {
1187 Text (from.first, text->type(), text->dcp_track().get_value_or(DCPTextTrack()), DCPTimePeriod (from.second, dcp_to));
1193 Player::seek (DCPTime time, bool accurate)
1195 boost::mutex::scoped_lock lm (_mutex);
1196 LOG_DEBUG_PLAYER("Seek to %1 (%2accurate)", to_string(time), accurate ? "" : "in");
1199 /* We can't seek in this state */
1204 _shuffler->clear ();
1209 if (_audio_processor) {
1210 _audio_processor->flush ();
1213 _audio_merger.clear ();
1214 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
1215 _active_texts[i].clear ();
1218 for (auto i: _pieces) {
1219 if (time < i->content->position()) {
1220 /* Before; seek to the start of the content. Even if this request is for an inaccurate seek
1221 we must seek this (following) content accurately, otherwise when we come to the end of the current
1222 content we may not start right at the beginning of the next, causing a gap (if the next content has
1223 been trimmed to a point between keyframes, or something).
1225 i->decoder->seek (dcp_to_content_time (i, i->content->position()), true);
1227 } else if (i->content->position() <= time && time < i->content->end(_film)) {
1228 /* During; seek to position */
1229 i->decoder->seek (dcp_to_content_time (i, time), accurate);
1232 /* After; this piece is done */
1238 _last_video_time = time;
1239 _last_video_eyes = Eyes::LEFT;
1240 _last_audio_time = time;
1242 _last_video_time = optional<DCPTime>();
1243 _last_video_eyes = optional<Eyes>();
1244 _last_audio_time = optional<DCPTime>();
1247 _black.set_position (time);
1248 _silent.set_position (time);
1250 _last_video.clear ();
1255 Player::emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1257 if (!_film->three_d()) {
1258 if (pv->eyes() == Eyes::LEFT) {
1259 /* Use left-eye images for both eyes... */
1260 pv->set_eyes (Eyes::BOTH);
1261 } else if (pv->eyes() == Eyes::RIGHT) {
1262 /* ...and discard the right */
1267 /* We need a delay to give a little wiggle room to ensure that relevent subtitles arrive at the
1268 player before the video that requires them.
1270 _delay.push_back (make_pair (pv, time));
1272 if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
1273 _last_video_time = time + one_video_frame();
1275 _last_video_eyes = increment_eyes (pv->eyes());
1277 if (_delay.size() < 3) {
1281 auto to_do = _delay.front();
1283 do_emit_video (to_do.first, to_do.second);
1288 Player::do_emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1290 if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
1291 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
1292 _active_texts[i].clear_before (time);
1296 auto subtitles = open_subtitles_for_frame (time);
1298 pv->set_text (subtitles.get ());
1306 Player::emit_audio (shared_ptr<AudioBuffers> data, DCPTime time)
1308 /* Log if the assert below is about to fail */
1309 if (_last_audio_time && labs(time.get() - _last_audio_time->get()) > 1) {
1310 _film->log()->log(String::compose("Out-of-sequence emit %1 vs %2", to_string(time), to_string(*_last_audio_time)), LogEntry::TYPE_WARNING);
1313 /* This audio must follow on from the previous, allowing for half a sample (at 48kHz) leeway */
1314 DCPOMATIC_ASSERT (!_last_audio_time || labs(time.get() - _last_audio_time->get()) < 2);
1315 Audio (data, time, _film->audio_frame_rate());
1316 _last_audio_time = time + DCPTime::from_frames (data->frames(), _film->audio_frame_rate());
1321 Player::fill_audio (DCPTimePeriod period)
1323 if (period.from == period.to) {
1327 DCPOMATIC_ASSERT (period.from < period.to);
1329 DCPTime t = period.from;
1330 while (t < period.to) {
1331 DCPTime block = min (DCPTime::from_seconds (0.5), period.to - t);
1332 Frame const samples = block.frames_round(_film->audio_frame_rate());
1334 auto silence = make_shared<AudioBuffers>(_film->audio_channels(), samples);
1335 silence->make_silent ();
1336 emit_audio (silence, t);
1344 Player::one_video_frame () const
1346 return DCPTime::from_frames (1, _film->video_frame_rate ());
1350 pair<shared_ptr<AudioBuffers>, DCPTime>
1351 Player::discard_audio (shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to) const
1353 auto const discard_time = discard_to - time;
1354 auto const discard_frames = discard_time.frames_round(_film->audio_frame_rate());
1355 auto remaining_frames = audio->frames() - discard_frames;
1356 if (remaining_frames <= 0) {
1357 return make_pair(shared_ptr<AudioBuffers>(), DCPTime());
1359 auto cut = make_shared<AudioBuffers>(audio, remaining_frames, discard_frames);
1360 return make_pair(cut, time + discard_time);
1365 Player::set_dcp_decode_reduction (optional<int> reduction)
1367 Change (ChangeType::PENDING, PlayerProperty::DCP_DECODE_REDUCTION, false);
1370 boost::mutex::scoped_lock lm (_mutex);
1372 if (reduction == _dcp_decode_reduction) {
1374 Change (ChangeType::CANCELLED, PlayerProperty::DCP_DECODE_REDUCTION, false);
1378 _dcp_decode_reduction = reduction;
1379 setup_pieces_unlocked ();
1382 Change (ChangeType::DONE, PlayerProperty::DCP_DECODE_REDUCTION, false);
1387 Player::content_time_to_dcp (shared_ptr<Content> content, ContentTime t)
1389 boost::mutex::scoped_lock lm (_mutex);
1391 for (auto i: _pieces) {
1392 if (i->content == content) {
1393 return content_time_to_dcp (i, t);
1397 /* We couldn't find this content; perhaps things are being changed over */
1402 shared_ptr<const Playlist>
1403 Player::playlist () const
1405 return _playlist ? _playlist : _film->playlist();
1410 Player::atmos (weak_ptr<Piece> weak_piece, ContentAtmos data)
1416 auto piece = weak_piece.lock ();
1417 DCPOMATIC_ASSERT (piece);
1419 auto const vfr = _film->video_frame_rate();
1421 DCPTime const dcp_time = DCPTime::from_frames(data.frame, vfr) - DCPTime(piece->content->trim_start(), FrameRateChange(vfr, vfr));
1422 if (dcp_time < piece->content->position() || dcp_time >= (piece->content->end(_film))) {
1426 Atmos (data.data, dcp_time, data.metadata);