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"
25 #include "audio_buffers.h"
26 #include "content_audio.h"
27 #include "dcp_content.h"
28 #include "dcpomatic_log.h"
31 #include "raw_image_proxy.h"
34 #include "render_text.h"
36 #include "content_video.h"
37 #include "player_video.h"
38 #include "frame_rate_change.h"
39 #include "audio_processor.h"
41 #include "referenced_reel_asset.h"
42 #include "decoder_factory.h"
44 #include "video_decoder.h"
45 #include "audio_decoder.h"
46 #include "text_content.h"
47 #include "text_decoder.h"
48 #include "ffmpeg_content.h"
49 #include "audio_content.h"
50 #include "dcp_decoder.h"
51 #include "image_decoder.h"
52 #include "compose.hpp"
56 #include <dcp/reel_sound_asset.h>
57 #include <dcp/reel_subtitle_asset.h>
58 #include <dcp/reel_picture_asset.h>
59 #include <dcp/reel_closed_caption_asset.h>
69 using std::dynamic_pointer_cast;
72 using std::make_shared;
77 using std::shared_ptr;
80 using std::make_shared;
81 using boost::optional;
82 using boost::scoped_ptr;
83 #if BOOST_VERSION >= 106100
84 using namespace boost::placeholders;
86 using namespace dcpomatic;
89 int const PlayerProperty::VIDEO_CONTAINER_SIZE = 700;
90 int const PlayerProperty::PLAYLIST = 701;
91 int const PlayerProperty::FILM_CONTAINER = 702;
92 int const PlayerProperty::FILM_VIDEO_FRAME_RATE = 703;
93 int const PlayerProperty::DCP_DECODE_REDUCTION = 704;
94 int const PlayerProperty::PLAYBACK_LENGTH = 705;
97 Player::Player (shared_ptr<const Film> film, Image::Alignment subtitle_alignment)
100 , _tolerant (film->tolerant())
101 , _audio_merger (_film->audio_frame_rate())
102 , _subtitle_alignment (subtitle_alignment)
108 Player::Player (shared_ptr<const Film> film, shared_ptr<const Playlist> playlist_)
110 , _playlist (playlist_)
112 , _tolerant (film->tolerant())
113 , _audio_merger (_film->audio_frame_rate())
122 _film_changed_connection = _film->Change.connect (bind (&Player::film_change, this, _1, _2));
123 /* The butler must hear about this first, so since we are proxying this through to the butler we must
126 _playlist_change_connection = playlist()->Change.connect (bind (&Player::playlist_change, this, _1), boost::signals2::at_front);
127 _playlist_content_change_connection = playlist()->ContentChange.connect (bind(&Player::playlist_content_change, this, _1, _3, _4));
128 set_video_container_size (_film->frame_size ());
130 film_change (ChangeType::DONE, Film::Property::AUDIO_PROCESSOR);
133 seek (DCPTime (), true);
138 Player::setup_pieces ()
140 boost::mutex::scoped_lock lm (_mutex);
141 setup_pieces_unlocked ();
146 have_video (shared_ptr<const Content> content)
148 return static_cast<bool>(content->video) && content->video->use();
153 have_audio (shared_ptr<const Content> content)
155 return static_cast<bool>(content->audio);
160 Player::setup_pieces_unlocked ()
162 _playback_length = _playlist ? _playlist->length(_film) : _film->length();
164 auto old_pieces = _pieces;
167 _shuffler.reset (new Shuffler());
168 _shuffler->Video.connect(bind(&Player::video, this, _1, _2));
170 for (auto i: playlist()->content()) {
172 if (!i->paths_valid ()) {
176 if (_ignore_video && _ignore_audio && i->text.empty()) {
177 /* We're only interested in text and this content has none */
181 shared_ptr<Decoder> old_decoder;
182 for (auto j: old_pieces) {
183 if (j->content == i) {
184 old_decoder = j->decoder;
189 auto decoder = decoder_factory (_film, i, _fast, _tolerant, old_decoder);
190 DCPOMATIC_ASSERT (decoder);
192 FrameRateChange frc (_film, i);
194 if (decoder->video && _ignore_video) {
195 decoder->video->set_ignore (true);
198 if (decoder->audio && _ignore_audio) {
199 decoder->audio->set_ignore (true);
203 for (auto i: decoder->text) {
204 i->set_ignore (true);
208 auto dcp = dynamic_pointer_cast<DCPDecoder> (decoder);
210 dcp->set_decode_referenced (_play_referenced);
211 if (_play_referenced) {
212 dcp->set_forced_reduction (_dcp_decode_reduction);
216 auto piece = make_shared<Piece>(i, decoder, frc);
217 _pieces.push_back (piece);
219 if (decoder->video) {
220 if (i->video->frame_type() == VideoFrameType::THREE_D_LEFT || i->video->frame_type() == VideoFrameType::THREE_D_RIGHT) {
221 /* We need a Shuffler to cope with 3D L/R video data arriving out of sequence */
222 decoder->video->Data.connect (bind(&Shuffler::video, _shuffler.get(), weak_ptr<Piece>(piece), _1));
224 decoder->video->Data.connect (bind(&Player::video, this, weak_ptr<Piece>(piece), _1));
228 if (decoder->audio) {
229 decoder->audio->Data.connect (bind (&Player::audio, this, weak_ptr<Piece> (piece), _1, _2));
232 auto j = decoder->text.begin();
234 while (j != decoder->text.end()) {
235 (*j)->BitmapStart.connect (
236 bind(&Player::bitmap_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
238 (*j)->PlainStart.connect (
239 bind(&Player::plain_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
242 bind(&Player::subtitle_stop, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
248 if (decoder->atmos) {
249 decoder->atmos->Data.connect (bind(&Player::atmos, this, weak_ptr<Piece>(piece), _1));
253 _stream_states.clear ();
254 for (auto i: _pieces) {
255 if (i->content->audio) {
256 for (auto j: i->content->audio->streams()) {
257 _stream_states[j] = StreamState (i, i->content->position ());
262 for (auto i = _pieces.begin(); i != _pieces.end(); ++i) {
263 if (auto video = (*i)->content->video) {
264 if (video->use() && video->frame_type() != VideoFrameType::THREE_D_LEFT && video->frame_type() != VideoFrameType::THREE_D_RIGHT) {
265 /* Look for content later in the content list with in-use video that overlaps this */
266 auto period = DCPTimePeriod((*i)->content->position(), (*i)->content->end(_film));
269 for (; j != _pieces.end(); ++j) {
270 if ((*j)->content->video && (*j)->content->video->use()) {
271 (*i)->ignore_video = DCPTimePeriod((*j)->content->position(), (*j)->content->end(_film)).overlap(period);
278 _black = Empty (_film, playlist(), bind(&have_video, _1), _playback_length);
279 _silent = Empty (_film, playlist(), bind(&have_audio, _1), _playback_length);
281 _last_video_time = boost::optional<dcpomatic::DCPTime>();
282 _last_video_eyes = Eyes::BOTH;
283 _last_audio_time = boost::optional<dcpomatic::DCPTime>();
288 Player::playlist_content_change (ChangeType type, int property, bool frequent)
290 if (property == VideoContentProperty::CROP) {
291 if (type == ChangeType::DONE) {
292 auto const vcs = video_container_size();
293 boost::mutex::scoped_lock lm (_mutex);
294 for (auto const& i: _delay) {
295 i.first->reset_metadata (_film, vcs);
299 if (type == ChangeType::PENDING) {
300 /* The player content is probably about to change, so we can't carry on
301 until that has happened and we've rebuilt our pieces. Stop pass()
302 and seek() from working until then.
305 } else if (type == ChangeType::DONE) {
306 /* A change in our content has gone through. Re-build our pieces. */
309 } else if (type == ChangeType::CANCELLED) {
314 Change (type, property, frequent);
319 Player::set_video_container_size (dcp::Size s)
321 Change (ChangeType::PENDING, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
324 boost::mutex::scoped_lock lm (_mutex);
326 if (s == _video_container_size) {
328 Change (ChangeType::CANCELLED, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
332 _video_container_size = s;
334 _black_image = make_shared<Image>(AV_PIX_FMT_RGB24, _video_container_size, Image::Alignment::PADDED);
335 _black_image->make_black ();
338 Change (ChangeType::DONE, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
343 Player::playlist_change (ChangeType type)
345 if (type == ChangeType::DONE) {
348 Change (type, PlayerProperty::PLAYLIST, false);
353 Player::film_change (ChangeType type, Film::Property p)
355 /* Here we should notice Film properties that affect our output, and
356 alert listeners that our output now would be different to how it was
357 last time we were run.
360 if (p == Film::Property::CONTAINER) {
361 Change (type, PlayerProperty::FILM_CONTAINER, false);
362 } else if (p == Film::Property::VIDEO_FRAME_RATE) {
363 /* Pieces contain a FrameRateChange which contains the DCP frame rate,
364 so we need new pieces here.
366 if (type == ChangeType::DONE) {
369 Change (type, PlayerProperty::FILM_VIDEO_FRAME_RATE, false);
370 } else if (p == Film::Property::AUDIO_PROCESSOR) {
371 if (type == ChangeType::DONE && _film->audio_processor ()) {
372 boost::mutex::scoped_lock lm (_mutex);
373 _audio_processor = _film->audio_processor()->clone (_film->audio_frame_rate ());
375 } else if (p == Film::Property::AUDIO_CHANNELS) {
376 if (type == ChangeType::DONE) {
377 boost::mutex::scoped_lock lm (_mutex);
378 _audio_merger.clear ();
384 shared_ptr<PlayerVideo>
385 Player::black_player_video_frame (Eyes eyes) const
387 return std::make_shared<PlayerVideo> (
388 std::make_shared<const RawImageProxy>(_black_image),
391 _video_container_size,
392 _video_container_size,
395 PresetColourConversion::all().front().conversion,
397 std::weak_ptr<Content>(),
398 boost::optional<Frame>(),
405 Player::dcp_to_content_video (shared_ptr<const Piece> piece, DCPTime t) const
407 auto s = t - piece->content->position ();
408 s = min (piece->content->length_after_trim(_film), s);
409 s = max (DCPTime(), s + DCPTime (piece->content->trim_start(), piece->frc));
411 /* It might seem more logical here to convert s to a ContentTime (using the FrameRateChange)
412 then convert that ContentTime to frames at the content's rate. However this fails for
413 situations like content at 29.9978733fps, DCP at 30fps. The accuracy of the Time type is not
414 enough to distinguish between the two with low values of time (e.g. 3200 in Time units).
416 Instead we convert the DCPTime using the DCP video rate then account for any skip/repeat.
418 return s.frames_floor (piece->frc.dcp) / piece->frc.factor ();
423 Player::content_video_to_dcp (shared_ptr<const Piece> piece, Frame f) const
425 /* See comment in dcp_to_content_video */
426 auto const d = DCPTime::from_frames (f * piece->frc.factor(), piece->frc.dcp) - DCPTime(piece->content->trim_start(), piece->frc);
427 return d + piece->content->position();
432 Player::dcp_to_resampled_audio (shared_ptr<const Piece> piece, DCPTime t) const
434 auto s = t - piece->content->position ();
435 s = min (piece->content->length_after_trim(_film), s);
436 /* See notes in dcp_to_content_video */
437 return max (DCPTime(), DCPTime(piece->content->trim_start(), piece->frc) + s).frames_floor(_film->audio_frame_rate());
442 Player::resampled_audio_to_dcp (shared_ptr<const Piece> piece, Frame f) const
444 /* See comment in dcp_to_content_video */
445 return DCPTime::from_frames (f, _film->audio_frame_rate())
446 - DCPTime (piece->content->trim_start(), piece->frc)
447 + piece->content->position();
452 Player::dcp_to_content_time (shared_ptr<const Piece> piece, DCPTime t) const
454 auto s = t - piece->content->position ();
455 s = min (piece->content->length_after_trim(_film), s);
456 return max (ContentTime (), ContentTime (s, piece->frc) + piece->content->trim_start());
461 Player::content_time_to_dcp (shared_ptr<const Piece> piece, ContentTime t) const
463 return max (DCPTime(), DCPTime(t - piece->content->trim_start(), piece->frc) + piece->content->position());
468 Player::get_subtitle_fonts ()
470 boost::mutex::scoped_lock lm (_mutex);
472 vector<FontData> fonts;
473 for (auto i: _pieces) {
474 /* XXX: things may go wrong if there are duplicate font IDs
475 with different font files.
477 auto f = i->decoder->fonts ();
478 copy (f.begin(), f.end(), back_inserter(fonts));
485 /** Set this player never to produce any video data */
487 Player::set_ignore_video ()
489 boost::mutex::scoped_lock lm (_mutex);
490 _ignore_video = true;
491 setup_pieces_unlocked ();
496 Player::set_ignore_audio ()
498 boost::mutex::scoped_lock lm (_mutex);
499 _ignore_audio = true;
500 setup_pieces_unlocked ();
505 Player::set_ignore_text ()
507 boost::mutex::scoped_lock lm (_mutex);
509 setup_pieces_unlocked ();
513 /** Set the player to always burn open texts into the image regardless of the content settings */
515 Player::set_always_burn_open_subtitles ()
517 boost::mutex::scoped_lock lm (_mutex);
518 _always_burn_open_subtitles = true;
522 /** Sets up the player to be faster, possibly at the expense of quality */
526 boost::mutex::scoped_lock lm (_mutex);
528 setup_pieces_unlocked ();
533 Player::set_play_referenced ()
535 boost::mutex::scoped_lock lm (_mutex);
536 _play_referenced = true;
537 setup_pieces_unlocked ();
542 maybe_add_asset (list<ReferencedReelAsset>& a, shared_ptr<dcp::ReelAsset> r, Frame reel_trim_start, Frame reel_trim_end, DCPTime from, int const ffr)
544 DCPOMATIC_ASSERT (r);
545 r->set_entry_point (r->entry_point().get_value_or(0) + reel_trim_start);
546 r->set_duration (r->actual_duration() - reel_trim_start - reel_trim_end);
547 if (r->actual_duration() > 0) {
549 ReferencedReelAsset(r, DCPTimePeriod(from, from + DCPTime::from_frames(r->actual_duration(), ffr)))
555 list<ReferencedReelAsset>
556 Player::get_reel_assets ()
558 /* Does not require a lock on _mutex as it's only called from DCPEncoder */
560 list<ReferencedReelAsset> reel_assets;
562 for (auto content: playlist()->content()) {
563 auto dcp = dynamic_pointer_cast<DCPContent>(content);
568 if (!dcp->reference_video() && !dcp->reference_audio() && !dcp->reference_text(TextType::OPEN_SUBTITLE) && !dcp->reference_text(TextType::CLOSED_CAPTION)) {
572 scoped_ptr<DCPDecoder> decoder;
574 decoder.reset (new DCPDecoder(_film, dcp, false, false, shared_ptr<DCPDecoder>()));
579 auto const frame_rate = _film->video_frame_rate();
580 DCPOMATIC_ASSERT (dcp->video_frame_rate());
581 /* We should only be referencing if the DCP rate is the same as the film rate */
582 DCPOMATIC_ASSERT (std::round(dcp->video_frame_rate().get()) == frame_rate);
584 Frame const trim_start = dcp->trim_start().frames_round(frame_rate);
585 Frame const trim_end = dcp->trim_end().frames_round(frame_rate);
587 /* position in the asset from the start */
588 int64_t offset_from_start = 0;
589 /* position i the asset from the end */
590 int64_t offset_from_end = 0;
591 for (auto reel: decoder->reels()) {
592 /* Assume that main picture duration is the length of the reel */
593 offset_from_end += reel->main_picture()->actual_duration();
596 for (auto reel: decoder->reels()) {
598 /* Assume that main picture duration is the length of the reel */
599 int64_t const reel_duration = reel->main_picture()->actual_duration();
601 /* See doc/design/trim_reels.svg */
602 Frame const reel_trim_start = min(reel_duration, max(int64_t(0), trim_start - offset_from_start));
603 Frame const reel_trim_end = min(reel_duration, max(int64_t(0), reel_duration - (offset_from_end - trim_end)));
605 auto const from = max(DCPTime(), content->position() + DCPTime::from_frames(offset_from_start, frame_rate) - DCPTime::from_frames(trim_start, frame_rate));
606 if (dcp->reference_video()) {
607 maybe_add_asset (reel_assets, reel->main_picture(), reel_trim_start, reel_trim_end, from, frame_rate);
610 if (dcp->reference_audio()) {
611 maybe_add_asset (reel_assets, reel->main_sound(), reel_trim_start, reel_trim_end, from, frame_rate);
614 if (dcp->reference_text(TextType::OPEN_SUBTITLE)) {
615 maybe_add_asset (reel_assets, reel->main_subtitle(), reel_trim_start, reel_trim_end, from, frame_rate);
618 if (dcp->reference_text(TextType::CLOSED_CAPTION)) {
619 for (auto caption: reel->closed_captions()) {
620 maybe_add_asset (reel_assets, caption, reel_trim_start, reel_trim_end, from, frame_rate);
624 offset_from_start += reel_duration;
625 offset_from_end -= reel_duration;
636 boost::mutex::scoped_lock lm (_mutex);
639 /* We can't pass in this state */
640 LOG_DEBUG_PLAYER_NC ("Player is suspended");
644 if (_playback_length == DCPTime()) {
645 /* Special; just give one black frame */
646 emit_video (black_player_video_frame(Eyes::BOTH), DCPTime());
650 /* Find the decoder or empty which is farthest behind where we are and make it emit some data */
652 shared_ptr<Piece> earliest_content;
653 optional<DCPTime> earliest_time;
655 for (auto i: _pieces) {
660 auto const t = content_time_to_dcp (i, max(i->decoder->position(), i->content->trim_start()));
661 if (t > i->content->end(_film)) {
665 /* Given two choices at the same time, pick the one with texts so we see it before
668 if (!earliest_time || t < *earliest_time || (t == *earliest_time && !i->decoder->text.empty())) {
670 earliest_content = i;
684 if (earliest_content) {
688 if (!_black.done() && !_ignore_video && (!earliest_time || _black.position() < *earliest_time)) {
689 earliest_time = _black.position ();
693 if (!_silent.done() && !_ignore_audio && (!earliest_time || _silent.position() < *earliest_time)) {
694 earliest_time = _silent.position ();
701 LOG_DEBUG_PLAYER ("Calling pass() on %1", earliest_content->content->path(0));
702 earliest_content->done = earliest_content->decoder->pass ();
703 auto dcp = dynamic_pointer_cast<DCPContent>(earliest_content->content);
704 if (dcp && !_play_referenced && dcp->reference_audio()) {
705 /* We are skipping some referenced DCP audio content, so we need to update _last_audio_time
706 to `hide' the fact that no audio was emitted during the referenced DCP (though
707 we need to behave as though it was).
709 _last_audio_time = dcp->end (_film);
714 LOG_DEBUG_PLAYER ("Emit black for gap at %1", to_string(_black.position()));
715 emit_video (black_player_video_frame(Eyes::BOTH), _black.position());
716 _black.set_position (_black.position() + one_video_frame());
720 LOG_DEBUG_PLAYER ("Emit silence for gap at %1", to_string(_silent.position()));
721 DCPTimePeriod period (_silent.period_at_position());
722 if (_last_audio_time) {
723 /* Sometimes the thing that happened last finishes fractionally before
724 or after this silence. Bodge the start time of the silence to fix it.
725 I think this is nothing to worry about since we will just add or
726 remove a little silence at the end of some content.
728 int64_t const error = labs(period.from.get() - _last_audio_time->get());
729 /* Let's not worry about less than a frame at 24fps */
730 int64_t const too_much_error = DCPTime::from_frames(1, 24).get();
731 if (error >= too_much_error) {
732 _film->log()->log(String::compose("Silence starting before or after last audio by %1", error), LogEntry::TYPE_ERROR);
734 DCPOMATIC_ASSERT (error < too_much_error);
735 period.from = *_last_audio_time;
737 if (period.duration() > one_video_frame()) {
738 period.to = period.from + one_video_frame();
741 _silent.set_position (period.to);
749 /* Emit any audio that is ready */
751 /* Work out the time before which the audio is definitely all here. This is the earliest last_push_end of one
752 of our streams, or the position of the _silent. First, though we choose only streams that are less than
753 ignore_streams_behind seconds behind the furthest ahead (we assume that if a stream has fallen that far
754 behind it has finished). This is so that we don't withhold audio indefinitely awaiting data from a stream
755 that will never come, causing bugs like #2101.
757 constexpr int ignore_streams_behind = 5;
759 using state_pair = std::pair<AudioStreamPtr, StreamState>;
761 /* Find the 'leading' stream (i.e. the one that pushed data most recently) */
762 auto latest_last_push_end = std::max_element(
763 _stream_states.begin(),
764 _stream_states.end(),
765 [](state_pair const& a, state_pair const& b) { return a.second.last_push_end < b.second.last_push_end; }
768 if (latest_last_push_end != _stream_states.end()) {
769 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));
772 /* Now make a list of those streams that are less than ignore_streams_behind behind the leader */
773 std::map<AudioStreamPtr, StreamState> alive_stream_states;
774 for (auto const& i: _stream_states) {
775 if ((latest_last_push_end->second.last_push_end - i.second.last_push_end) < dcpomatic::DCPTime::from_seconds(ignore_streams_behind)) {
776 alive_stream_states.insert(i);
778 LOG_DEBUG_PLAYER("Ignoring stream %1 because it is too far behind", i.second.piece->content->path(0));
782 auto pull_to = _playback_length;
783 for (auto const& i: alive_stream_states) {
784 if (!i.second.piece->done && i.second.last_push_end < pull_to) {
785 pull_to = i.second.last_push_end;
788 if (!_silent.done() && _silent.position() < pull_to) {
789 pull_to = _silent.position();
792 LOG_DEBUG_PLAYER("Emitting audio up to %1", to_string(pull_to));
793 auto audio = _audio_merger.pull (pull_to);
794 for (auto i = audio.begin(); i != audio.end(); ++i) {
795 if (_last_audio_time && i->second < *_last_audio_time) {
796 /* This new data comes before the last we emitted (or the last seek); discard it */
797 auto cut = discard_audio (i->first, i->second, *_last_audio_time);
802 } else if (_last_audio_time && i->second > *_last_audio_time) {
803 /* There's a gap between this data and the last we emitted; fill with silence */
804 fill_audio (DCPTimePeriod (*_last_audio_time, i->second));
807 emit_audio (i->first, i->second);
812 for (auto const& i: _delay) {
813 do_emit_video(i.first, i.second);
821 /** @return Open subtitles for the frame at the given time, converted to images */
822 optional<PositionImage>
823 Player::open_subtitles_for_frame (DCPTime time) const
825 list<PositionImage> captions;
826 int const vfr = _film->video_frame_rate();
830 _active_texts[static_cast<int>(TextType::OPEN_SUBTITLE)].get_burnt(DCPTimePeriod(time, time + DCPTime::from_frames(1, vfr)), _always_burn_open_subtitles)
833 /* Bitmap subtitles */
834 for (auto i: j.bitmap) {
839 /* i.image will already have been scaled to fit _video_container_size */
840 dcp::Size scaled_size (i.rectangle.width * _video_container_size.width, i.rectangle.height * _video_container_size.height);
846 lrint(_video_container_size.width * i.rectangle.x),
847 lrint(_video_container_size.height * i.rectangle.y)
853 /* String subtitles (rendered to an image) */
854 if (!j.string.empty()) {
855 auto s = render_text (j.string, j.fonts, _video_container_size, time, vfr);
856 copy (s.begin(), s.end(), back_inserter (captions));
860 if (captions.empty()) {
864 return merge (captions, _subtitle_alignment);
869 Player::video (weak_ptr<Piece> wp, ContentVideo video)
875 auto piece = wp.lock ();
880 if (!piece->content->video->use()) {
884 FrameRateChange frc (_film, piece->content);
885 if (frc.skip && (video.frame % 2) == 1) {
889 /* Time of the first frame we will emit */
890 DCPTime const time = content_video_to_dcp (piece, video.frame);
891 LOG_DEBUG_PLAYER("Received video frame %1 at %2", video.frame, to_string(time));
893 /* Discard if it's before the content's period or the last accurate seek. We can't discard
894 if it's after the content's period here as in that case we still need to fill any gap between
895 `now' and the end of the content's period.
897 if (time < piece->content->position() || (_last_video_time && time < *_last_video_time)) {
901 if (piece->ignore_video && piece->ignore_video->contains(time)) {
905 /* Fill gaps that we discover now that we have some video which needs to be emitted.
906 This is where we need to fill to.
908 DCPTime fill_to = min (time, piece->content->end(_film));
910 if (_last_video_time) {
911 DCPTime fill_from = max (*_last_video_time, piece->content->position());
913 /* Fill if we have more than half a frame to do */
914 if ((fill_to - fill_from) > one_video_frame() / 2) {
915 auto last = _last_video.find (wp);
916 if (_film->three_d()) {
917 auto fill_to_eyes = video.eyes;
918 if (fill_to_eyes == Eyes::BOTH) {
919 fill_to_eyes = Eyes::LEFT;
921 if (fill_to == piece->content->end(_film)) {
922 /* Don't fill after the end of the content */
923 fill_to_eyes = Eyes::LEFT;
926 auto eyes = _last_video_eyes.get_value_or(Eyes::LEFT);
927 if (eyes == Eyes::BOTH) {
930 while (j < fill_to || eyes != fill_to_eyes) {
931 if (last != _last_video.end()) {
932 LOG_DEBUG_PLAYER("Fill using last video at %1 in 3D mode", to_string(j));
933 auto copy = last->second->shallow_copy();
934 copy->set_eyes (eyes);
935 emit_video (copy, j);
937 LOG_DEBUG_PLAYER("Fill using black at %1 in 3D mode", to_string(j));
938 emit_video (black_player_video_frame(eyes), j);
940 if (eyes == Eyes::RIGHT) {
941 j += one_video_frame();
943 eyes = increment_eyes (eyes);
946 for (DCPTime j = fill_from; j < fill_to; j += one_video_frame()) {
947 if (last != _last_video.end()) {
948 emit_video (last->second, j);
950 emit_video (black_player_video_frame(Eyes::BOTH), j);
957 auto const content_video = piece->content->video;
959 _last_video[wp] = std::make_shared<PlayerVideo>(
961 content_video->actual_crop(),
962 content_video->fade (_film, video.frame),
964 content_video->scaled_size(_film->frame_size()),
965 _video_container_size,
967 content_video->pixel_quanta()
969 _video_container_size,
972 content_video->colour_conversion(),
973 content_video->range(),
980 for (int i = 0; i < frc.repeat; ++i) {
981 if (t < piece->content->end(_film)) {
982 emit_video (_last_video[wp], t);
984 t += one_video_frame ();
990 Player::audio (weak_ptr<Piece> wp, AudioStreamPtr stream, ContentAudio content_audio)
996 DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
998 auto piece = wp.lock ();
1003 auto content = piece->content->audio;
1004 DCPOMATIC_ASSERT (content);
1006 int const rfr = content->resampled_frame_rate (_film);
1008 /* Compute time in the DCP */
1009 auto time = resampled_audio_to_dcp (piece, content_audio.frame);
1010 LOG_DEBUG_PLAYER("Received audio frame %1 at %2", content_audio.frame, to_string(time));
1012 /* And the end of this block in the DCP */
1013 auto end = time + DCPTime::from_frames(content_audio.audio->frames(), rfr);
1015 /* Remove anything that comes before the start or after the end of the content */
1016 if (time < piece->content->position()) {
1017 auto cut = discard_audio (content_audio.audio, time, piece->content->position());
1019 /* This audio is entirely discarded */
1022 content_audio.audio = cut.first;
1024 } else if (time > piece->content->end(_film)) {
1025 /* Discard it all */
1027 } else if (end > piece->content->end(_film)) {
1028 Frame const remaining_frames = DCPTime(piece->content->end(_film) - time).frames_round(rfr);
1029 if (remaining_frames == 0) {
1032 content_audio.audio = make_shared<AudioBuffers>(content_audio.audio, remaining_frames, 0);
1035 DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
1039 if (content->gain() != 0) {
1040 auto gain = make_shared<AudioBuffers>(content_audio.audio);
1041 gain->apply_gain (content->gain());
1042 content_audio.audio = gain;
1047 content_audio.audio = remap (content_audio.audio, _film->audio_channels(), stream->mapping());
1051 if (_audio_processor) {
1052 content_audio.audio = _audio_processor->run (content_audio.audio, _film->audio_channels ());
1057 _audio_merger.push (content_audio.audio, time);
1058 DCPOMATIC_ASSERT (_stream_states.find (stream) != _stream_states.end ());
1059 _stream_states[stream].last_push_end = time + DCPTime::from_frames (content_audio.audio->frames(), _film->audio_frame_rate());
1064 Player::bitmap_text_start (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentBitmapText subtitle)
1070 auto piece = wp.lock ();
1071 auto text = wc.lock ();
1072 if (!piece || !text) {
1076 /* Apply content's subtitle offsets */
1077 subtitle.sub.rectangle.x += text->x_offset ();
1078 subtitle.sub.rectangle.y += text->y_offset ();
1080 /* Apply a corrective translation to keep the subtitle centred after the scale that is coming up */
1081 subtitle.sub.rectangle.x -= subtitle.sub.rectangle.width * ((text->x_scale() - 1) / 2);
1082 subtitle.sub.rectangle.y -= subtitle.sub.rectangle.height * ((text->y_scale() - 1) / 2);
1084 /* Apply content's subtitle scale */
1085 subtitle.sub.rectangle.width *= text->x_scale ();
1086 subtitle.sub.rectangle.height *= text->y_scale ();
1089 auto image = subtitle.sub.image;
1091 /* We will scale the subtitle up to fit _video_container_size */
1092 int const width = subtitle.sub.rectangle.width * _video_container_size.width;
1093 int const height = subtitle.sub.rectangle.height * _video_container_size.height;
1094 if (width == 0 || height == 0) {
1098 dcp::Size scaled_size (width, height);
1099 ps.bitmap.push_back (BitmapText(image->scale(scaled_size, dcp::YUVToRGB::REC601, image->pixel_format(), Image::Alignment::PADDED, _fast), subtitle.sub.rectangle));
1100 DCPTime from (content_time_to_dcp (piece, subtitle.from()));
1102 _active_texts[static_cast<int>(text->type())].add_from (wc, ps, from);
1107 Player::plain_text_start (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentStringText subtitle)
1113 auto piece = wp.lock ();
1114 auto text = wc.lock ();
1115 if (!piece || !text) {
1120 DCPTime const from (content_time_to_dcp (piece, subtitle.from()));
1122 if (from > piece->content->end(_film)) {
1126 for (auto s: subtitle.subs) {
1127 s.set_h_position (s.h_position() + text->x_offset ());
1128 s.set_v_position (s.v_position() + text->y_offset ());
1129 float const xs = text->x_scale();
1130 float const ys = text->y_scale();
1131 float size = s.size();
1133 /* Adjust size to express the common part of the scaling;
1134 e.g. if xs = ys = 0.5 we scale size by 2.
1136 if (xs > 1e-5 && ys > 1e-5) {
1137 size *= 1 / min (1 / xs, 1 / ys);
1141 /* Then express aspect ratio changes */
1142 if (fabs (1.0 - xs / ys) > dcp::ASPECT_ADJUST_EPSILON) {
1143 s.set_aspect_adjust (xs / ys);
1146 s.set_in (dcp::Time(from.seconds(), 1000));
1147 ps.string.push_back (StringText (s, text->outline_width()));
1148 ps.add_fonts (text->fonts ());
1151 _active_texts[static_cast<int>(text->type())].add_from (wc, ps, from);
1156 Player::subtitle_stop (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentTime to)
1162 auto text = wc.lock ();
1167 if (!_active_texts[static_cast<int>(text->type())].have(wc)) {
1171 shared_ptr<Piece> piece = wp.lock ();
1176 DCPTime const dcp_to = content_time_to_dcp (piece, to);
1178 if (dcp_to > piece->content->end(_film)) {
1182 auto from = _active_texts[static_cast<int>(text->type())].add_to (wc, dcp_to);
1184 bool const always = (text->type() == TextType::OPEN_SUBTITLE && _always_burn_open_subtitles);
1185 if (text->use() && !always && !text->burn()) {
1186 Text (from.first, text->type(), text->dcp_track().get_value_or(DCPTextTrack()), DCPTimePeriod (from.second, dcp_to));
1192 Player::seek (DCPTime time, bool accurate)
1194 boost::mutex::scoped_lock lm (_mutex);
1195 LOG_DEBUG_PLAYER("Seek to %1 (%2accurate)", to_string(time), accurate ? "" : "in");
1198 /* We can't seek in this state */
1203 _shuffler->clear ();
1208 if (_audio_processor) {
1209 _audio_processor->flush ();
1212 _audio_merger.clear ();
1213 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
1214 _active_texts[i].clear ();
1217 for (auto i: _pieces) {
1218 if (time < i->content->position()) {
1219 /* Before; seek to the start of the content. Even if this request is for an inaccurate seek
1220 we must seek this (following) content accurately, otherwise when we come to the end of the current
1221 content we may not start right at the beginning of the next, causing a gap (if the next content has
1222 been trimmed to a point between keyframes, or something).
1224 i->decoder->seek (dcp_to_content_time (i, i->content->position()), true);
1226 } else if (i->content->position() <= time && time < i->content->end(_film)) {
1227 /* During; seek to position */
1228 i->decoder->seek (dcp_to_content_time (i, time), accurate);
1231 /* After; this piece is done */
1237 _last_video_time = time;
1238 _last_video_eyes = Eyes::LEFT;
1239 _last_audio_time = time;
1241 _last_video_time = optional<DCPTime>();
1242 _last_video_eyes = optional<Eyes>();
1243 _last_audio_time = optional<DCPTime>();
1246 _black.set_position (time);
1247 _silent.set_position (time);
1249 _last_video.clear ();
1254 Player::emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1256 if (!_film->three_d()) {
1257 if (pv->eyes() == Eyes::LEFT) {
1258 /* Use left-eye images for both eyes... */
1259 pv->set_eyes (Eyes::BOTH);
1260 } else if (pv->eyes() == Eyes::RIGHT) {
1261 /* ...and discard the right */
1266 /* We need a delay to give a little wiggle room to ensure that relevent subtitles arrive at the
1267 player before the video that requires them.
1269 _delay.push_back (make_pair (pv, time));
1271 if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
1272 _last_video_time = time + one_video_frame();
1274 _last_video_eyes = increment_eyes (pv->eyes());
1276 if (_delay.size() < 3) {
1280 auto to_do = _delay.front();
1282 do_emit_video (to_do.first, to_do.second);
1287 Player::do_emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1289 if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
1290 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
1291 _active_texts[i].clear_before (time);
1295 auto subtitles = open_subtitles_for_frame (time);
1297 pv->set_text (subtitles.get ());
1305 Player::emit_audio (shared_ptr<AudioBuffers> data, DCPTime time)
1307 /* Log if the assert below is about to fail */
1308 if (_last_audio_time && labs(time.get() - _last_audio_time->get()) > 1) {
1309 _film->log()->log(String::compose("Out-of-sequence emit %1 vs %2", to_string(time), to_string(*_last_audio_time)), LogEntry::TYPE_WARNING);
1312 /* This audio must follow on from the previous, allowing for half a sample (at 48kHz) leeway */
1313 DCPOMATIC_ASSERT (!_last_audio_time || labs(time.get() - _last_audio_time->get()) < 2);
1314 Audio (data, time, _film->audio_frame_rate());
1315 _last_audio_time = time + DCPTime::from_frames (data->frames(), _film->audio_frame_rate());
1320 Player::fill_audio (DCPTimePeriod period)
1322 if (period.from == period.to) {
1326 DCPOMATIC_ASSERT (period.from < period.to);
1328 DCPTime t = period.from;
1329 while (t < period.to) {
1330 DCPTime block = min (DCPTime::from_seconds (0.5), period.to - t);
1331 Frame const samples = block.frames_round(_film->audio_frame_rate());
1333 auto silence = make_shared<AudioBuffers>(_film->audio_channels(), samples);
1334 silence->make_silent ();
1335 emit_audio (silence, t);
1343 Player::one_video_frame () const
1345 return DCPTime::from_frames (1, _film->video_frame_rate ());
1349 pair<shared_ptr<AudioBuffers>, DCPTime>
1350 Player::discard_audio (shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to) const
1352 auto const discard_time = discard_to - time;
1353 auto const discard_frames = discard_time.frames_round(_film->audio_frame_rate());
1354 auto remaining_frames = audio->frames() - discard_frames;
1355 if (remaining_frames <= 0) {
1356 return make_pair(shared_ptr<AudioBuffers>(), DCPTime());
1358 auto cut = make_shared<AudioBuffers>(audio, remaining_frames, discard_frames);
1359 return make_pair(cut, time + discard_time);
1364 Player::set_dcp_decode_reduction (optional<int> reduction)
1366 Change (ChangeType::PENDING, PlayerProperty::DCP_DECODE_REDUCTION, false);
1369 boost::mutex::scoped_lock lm (_mutex);
1371 if (reduction == _dcp_decode_reduction) {
1373 Change (ChangeType::CANCELLED, PlayerProperty::DCP_DECODE_REDUCTION, false);
1377 _dcp_decode_reduction = reduction;
1378 setup_pieces_unlocked ();
1381 Change (ChangeType::DONE, PlayerProperty::DCP_DECODE_REDUCTION, false);
1386 Player::content_time_to_dcp (shared_ptr<Content> content, ContentTime t)
1388 boost::mutex::scoped_lock lm (_mutex);
1390 for (auto i: _pieces) {
1391 if (i->content == content) {
1392 return content_time_to_dcp (i, t);
1396 /* We couldn't find this content; perhaps things are being changed over */
1401 shared_ptr<const Playlist>
1402 Player::playlist () const
1404 return _playlist ? _playlist : _film->playlist();
1409 Player::atmos (weak_ptr<Piece>, ContentAtmos data)
1415 Atmos (data.data, DCPTime::from_frames(data.frame, _film->video_frame_rate()), data.metadata);