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 , _ignore_video(false)
103 , _ignore_audio(false)
104 , _ignore_text(false)
105 , _always_burn_open_subtitles(false)
107 , _tolerant (film->tolerant())
108 , _audio_merger (_film->audio_frame_rate())
109 , _subtitle_alignment (subtitle_alignment)
115 Player::Player (shared_ptr<const Film> film, shared_ptr<const Playlist> playlist_)
117 , _playlist (playlist_)
119 , _ignore_video(false)
120 , _ignore_audio(false)
121 , _ignore_text(false)
122 , _always_burn_open_subtitles(false)
124 , _tolerant (film->tolerant())
125 , _audio_merger (_film->audio_frame_rate())
134 _film_changed_connection = _film->Change.connect (bind (&Player::film_change, this, _1, _2));
135 /* The butler must hear about this first, so since we are proxying this through to the butler we must
138 _playlist_change_connection = playlist()->Change.connect (bind (&Player::playlist_change, this, _1), boost::signals2::at_front);
139 _playlist_content_change_connection = playlist()->ContentChange.connect (bind(&Player::playlist_content_change, this, _1, _3, _4));
140 set_video_container_size (_film->frame_size ());
142 film_change (ChangeType::DONE, Film::Property::AUDIO_PROCESSOR);
145 seek (DCPTime (), true);
150 Player::setup_pieces ()
152 boost::mutex::scoped_lock lm (_mutex);
153 setup_pieces_unlocked ();
158 have_video (shared_ptr<const Content> content)
160 return static_cast<bool>(content->video) && content->video->use() && content->can_be_played();
165 have_audio (shared_ptr<const Content> content)
167 return static_cast<bool>(content->audio) && content->can_be_played();
172 Player::setup_pieces_unlocked ()
174 _playback_length = _playlist ? _playlist->length(_film) : _film->length();
176 auto old_pieces = _pieces;
179 auto playlist_content = playlist()->content();
180 bool const have_threed = std::any_of(
181 playlist_content.begin(),
182 playlist_content.end(),
183 [](shared_ptr<const Content> c) {
184 return c->video && (c->video->frame_type() == VideoFrameType::THREE_D_LEFT || c->video->frame_type() == VideoFrameType::THREE_D_RIGHT);
189 _shuffler.reset(new Shuffler());
190 _shuffler->Video.connect(bind(&Player::video, this, _1, _2));
193 for (auto i: playlist()->content()) {
195 if (!i->paths_valid ()) {
199 if (_ignore_video && _ignore_audio && i->text.empty()) {
200 /* We're only interested in text and this content has none */
204 shared_ptr<Decoder> old_decoder;
205 for (auto j: old_pieces) {
206 if (j->content == i) {
207 old_decoder = j->decoder;
212 auto decoder = decoder_factory (_film, i, _fast, _tolerant, old_decoder);
213 DCPOMATIC_ASSERT (decoder);
215 FrameRateChange frc (_film, i);
217 if (decoder->video && _ignore_video) {
218 decoder->video->set_ignore (true);
221 if (decoder->audio && _ignore_audio) {
222 decoder->audio->set_ignore (true);
226 for (auto i: decoder->text) {
227 i->set_ignore (true);
231 auto dcp = dynamic_pointer_cast<DCPDecoder> (decoder);
233 dcp->set_decode_referenced (_play_referenced);
234 if (_play_referenced) {
235 dcp->set_forced_reduction (_dcp_decode_reduction);
239 auto piece = make_shared<Piece>(i, decoder, frc);
240 _pieces.push_back (piece);
242 if (decoder->video) {
244 /* We need a Shuffler to cope with 3D L/R video data arriving out of sequence */
245 decoder->video->Data.connect (bind(&Shuffler::video, _shuffler.get(), weak_ptr<Piece>(piece), _1));
247 decoder->video->Data.connect (bind(&Player::video, this, weak_ptr<Piece>(piece), _1));
251 if (decoder->audio) {
252 decoder->audio->Data.connect (bind (&Player::audio, this, weak_ptr<Piece> (piece), _1, _2));
255 auto j = decoder->text.begin();
257 while (j != decoder->text.end()) {
258 (*j)->BitmapStart.connect (
259 bind(&Player::bitmap_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
261 (*j)->PlainStart.connect (
262 bind(&Player::plain_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
265 bind(&Player::subtitle_stop, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
271 if (decoder->atmos) {
272 decoder->atmos->Data.connect (bind(&Player::atmos, this, weak_ptr<Piece>(piece), _1));
276 _stream_states.clear ();
277 for (auto i: _pieces) {
278 if (i->content->audio) {
279 for (auto j: i->content->audio->streams()) {
280 _stream_states[j] = StreamState (i, i->content->position ());
285 auto ignore_overlap = [](shared_ptr<VideoContent> v) {
286 return v && v->use() && v->frame_type() != VideoFrameType::THREE_D_LEFT && v->frame_type() != VideoFrameType::THREE_D_RIGHT;
289 for (auto i = _pieces.begin(); i != _pieces.end(); ++i) {
290 if (ignore_overlap((*i)->content->video)) {
291 /* Look for content later in the content list with in-use video that overlaps this */
292 auto const period = DCPTimePeriod((*i)->content->position(), (*i)->content->end(_film));
293 for (auto j = std::next(i); j != _pieces.end(); ++j) {
294 if ((*j)->content->video && ignore_overlap((*j)->content->video)) {
295 (*i)->ignore_video = DCPTimePeriod((*j)->content->position(), (*j)->content->end(_film)).overlap(period);
301 _black = Empty (_film, playlist(), bind(&have_video, _1), _playback_length);
302 _silent = Empty (_film, playlist(), bind(&have_audio, _1), _playback_length);
304 _next_video_time = boost::none;
305 _next_video_eyes = Eyes::BOTH;
306 _next_audio_time = boost::none;
311 Player::playlist_content_change (ChangeType type, int property, bool frequent)
313 if (property == VideoContentProperty::CROP) {
314 if (type == ChangeType::DONE) {
315 auto const vcs = video_container_size();
316 boost::mutex::scoped_lock lm (_mutex);
317 for (auto const& i: _delay) {
318 i.first->reset_metadata (_film, vcs);
322 if (type == ChangeType::PENDING) {
323 /* The player content is probably about to change, so we can't carry on
324 until that has happened and we've rebuilt our pieces. Stop pass()
325 and seek() from working until then.
328 } else if (type == ChangeType::DONE) {
329 /* A change in our content has gone through. Re-build our pieces. */
332 } else if (type == ChangeType::CANCELLED) {
337 Change (type, property, frequent);
342 Player::set_video_container_size (dcp::Size s)
344 Change (ChangeType::PENDING, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
347 boost::mutex::scoped_lock lm (_mutex);
349 if (s == _video_container_size) {
351 Change (ChangeType::CANCELLED, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
355 _video_container_size = s;
357 _black_image = make_shared<Image>(AV_PIX_FMT_RGB24, _video_container_size, Image::Alignment::PADDED);
358 _black_image->make_black ();
361 Change (ChangeType::DONE, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
366 Player::playlist_change (ChangeType type)
368 if (type == ChangeType::DONE) {
371 Change (type, PlayerProperty::PLAYLIST, false);
376 Player::film_change (ChangeType type, Film::Property p)
378 /* Here we should notice Film properties that affect our output, and
379 alert listeners that our output now would be different to how it was
380 last time we were run.
383 if (p == Film::Property::CONTAINER) {
384 Change (type, PlayerProperty::FILM_CONTAINER, false);
385 } else if (p == Film::Property::VIDEO_FRAME_RATE) {
386 /* Pieces contain a FrameRateChange which contains the DCP frame rate,
387 so we need new pieces here.
389 if (type == ChangeType::DONE) {
392 Change (type, PlayerProperty::FILM_VIDEO_FRAME_RATE, false);
393 } else if (p == Film::Property::AUDIO_PROCESSOR) {
394 if (type == ChangeType::DONE && _film->audio_processor ()) {
395 boost::mutex::scoped_lock lm (_mutex);
396 _audio_processor = _film->audio_processor()->clone (_film->audio_frame_rate ());
398 } else if (p == Film::Property::AUDIO_CHANNELS) {
399 if (type == ChangeType::DONE) {
400 boost::mutex::scoped_lock lm (_mutex);
401 _audio_merger.clear ();
407 shared_ptr<PlayerVideo>
408 Player::black_player_video_frame (Eyes eyes) const
410 return std::make_shared<PlayerVideo> (
411 std::make_shared<const RawImageProxy>(_black_image),
414 _video_container_size,
415 _video_container_size,
418 PresetColourConversion::all().front().conversion,
420 std::weak_ptr<Content>(),
421 boost::optional<Frame>(),
428 Player::dcp_to_content_video (shared_ptr<const Piece> piece, DCPTime t) const
430 auto s = t - piece->content->position ();
431 s = min (piece->content->length_after_trim(_film), s);
432 s = max (DCPTime(), s + DCPTime (piece->content->trim_start(), piece->frc));
434 /* It might seem more logical here to convert s to a ContentTime (using the FrameRateChange)
435 then convert that ContentTime to frames at the content's rate. However this fails for
436 situations like content at 29.9978733fps, DCP at 30fps. The accuracy of the Time type is not
437 enough to distinguish between the two with low values of time (e.g. 3200 in Time units).
439 Instead we convert the DCPTime using the DCP video rate then account for any skip/repeat.
441 return s.frames_floor (piece->frc.dcp) / piece->frc.factor ();
446 Player::content_video_to_dcp (shared_ptr<const Piece> piece, Frame f) const
448 /* See comment in dcp_to_content_video */
449 auto const d = DCPTime::from_frames (f * piece->frc.factor(), piece->frc.dcp) - DCPTime(piece->content->trim_start(), piece->frc);
450 return d + piece->content->position();
455 Player::dcp_to_resampled_audio (shared_ptr<const Piece> piece, DCPTime t) const
457 auto s = t - piece->content->position ();
458 s = min (piece->content->length_after_trim(_film), s);
459 /* See notes in dcp_to_content_video */
460 return max (DCPTime(), DCPTime(piece->content->trim_start(), piece->frc) + s).frames_floor(_film->audio_frame_rate());
465 Player::resampled_audio_to_dcp (shared_ptr<const Piece> piece, Frame f) const
467 /* See comment in dcp_to_content_video */
468 return DCPTime::from_frames (f, _film->audio_frame_rate())
469 - DCPTime (piece->content->trim_start(), piece->frc)
470 + piece->content->position();
475 Player::dcp_to_content_time (shared_ptr<const Piece> piece, DCPTime t) const
477 auto s = t - piece->content->position ();
478 s = min (piece->content->length_after_trim(_film), s);
479 return max (ContentTime (), ContentTime (s, piece->frc) + piece->content->trim_start());
484 Player::content_time_to_dcp (shared_ptr<const Piece> piece, ContentTime t) const
486 return max (DCPTime(), DCPTime(t - piece->content->trim_start(), piece->frc) + piece->content->position());
490 vector<shared_ptr<Font>>
491 Player::get_subtitle_fonts ()
493 boost::mutex::scoped_lock lm (_mutex);
495 vector<shared_ptr<Font>> fonts;
496 for (auto piece: _pieces) {
497 for (auto text: piece->content->text) {
498 auto text_fonts = text->fonts();
499 copy (text_fonts.begin(), text_fonts.end(), back_inserter(fonts));
507 /** Set this player never to produce any video data */
509 Player::set_ignore_video ()
511 _ignore_video = true;
517 Player::set_ignore_audio ()
519 _ignore_audio = true;
525 Player::set_ignore_text ()
532 /** Set the player to always burn open texts into the image regardless of the content settings */
534 Player::set_always_burn_open_subtitles ()
536 _always_burn_open_subtitles = true;
540 /** Sets up the player to be faster, possibly at the expense of quality */
550 Player::set_play_referenced ()
552 boost::mutex::scoped_lock lm (_mutex);
553 _play_referenced = true;
554 setup_pieces_unlocked ();
559 maybe_add_asset (list<ReferencedReelAsset>& a, shared_ptr<dcp::ReelAsset> r, Frame reel_trim_start, Frame reel_trim_end, DCPTime from, int const ffr)
561 DCPOMATIC_ASSERT (r);
562 r->set_entry_point (r->entry_point().get_value_or(0) + reel_trim_start);
563 r->set_duration (r->actual_duration() - reel_trim_start - reel_trim_end);
564 if (r->actual_duration() > 0) {
566 ReferencedReelAsset(r, DCPTimePeriod(from, from + DCPTime::from_frames(r->actual_duration(), ffr)))
572 list<ReferencedReelAsset>
573 Player::get_reel_assets ()
575 /* Does not require a lock on _mutex as it's only called from DCPEncoder */
577 list<ReferencedReelAsset> reel_assets;
579 for (auto content: playlist()->content()) {
580 auto dcp = dynamic_pointer_cast<DCPContent>(content);
585 if (!dcp->reference_video() && !dcp->reference_audio() && !dcp->reference_text(TextType::OPEN_SUBTITLE) && !dcp->reference_text(TextType::CLOSED_CAPTION)) {
589 scoped_ptr<DCPDecoder> decoder;
591 decoder.reset (new DCPDecoder(_film, dcp, false, false, shared_ptr<DCPDecoder>()));
596 auto const frame_rate = _film->video_frame_rate();
597 DCPOMATIC_ASSERT (dcp->video_frame_rate());
598 /* We should only be referencing if the DCP rate is the same as the film rate */
599 DCPOMATIC_ASSERT (std::round(dcp->video_frame_rate().get()) == frame_rate);
601 Frame const trim_start = dcp->trim_start().frames_round(frame_rate);
602 Frame const trim_end = dcp->trim_end().frames_round(frame_rate);
604 /* position in the asset from the start */
605 int64_t offset_from_start = 0;
606 /* position i the asset from the end */
607 int64_t offset_from_end = 0;
608 for (auto reel: decoder->reels()) {
609 /* Assume that main picture duration is the length of the reel */
610 offset_from_end += reel->main_picture()->actual_duration();
613 for (auto reel: decoder->reels()) {
615 /* Assume that main picture duration is the length of the reel */
616 int64_t const reel_duration = reel->main_picture()->actual_duration();
618 /* See doc/design/trim_reels.svg */
619 Frame const reel_trim_start = min(reel_duration, max(int64_t(0), trim_start - offset_from_start));
620 Frame const reel_trim_end = min(reel_duration, max(int64_t(0), reel_duration - (offset_from_end - trim_end)));
622 auto const from = content->position() + std::max(DCPTime(), DCPTime::from_frames(offset_from_start - trim_start, frame_rate));
623 if (dcp->reference_video()) {
624 maybe_add_asset (reel_assets, reel->main_picture(), reel_trim_start, reel_trim_end, from, frame_rate);
627 if (dcp->reference_audio()) {
628 maybe_add_asset (reel_assets, reel->main_sound(), reel_trim_start, reel_trim_end, from, frame_rate);
631 if (dcp->reference_text(TextType::OPEN_SUBTITLE)) {
632 maybe_add_asset (reel_assets, reel->main_subtitle(), reel_trim_start, reel_trim_end, from, frame_rate);
635 if (dcp->reference_text(TextType::CLOSED_CAPTION)) {
636 for (auto caption: reel->closed_captions()) {
637 maybe_add_asset (reel_assets, caption, reel_trim_start, reel_trim_end, from, frame_rate);
641 offset_from_start += reel_duration;
642 offset_from_end -= reel_duration;
653 boost::mutex::scoped_lock lm (_mutex);
656 /* We can't pass in this state */
657 LOG_DEBUG_PLAYER_NC ("Player is suspended");
661 if (_playback_length == DCPTime()) {
662 /* Special; just give one black frame */
663 emit_video (black_player_video_frame(Eyes::BOTH), DCPTime());
667 /* Find the decoder or empty which is farthest behind where we are and make it emit some data */
669 shared_ptr<Piece> earliest_content;
670 optional<DCPTime> earliest_time;
672 for (auto i: _pieces) {
677 auto const t = content_time_to_dcp (i, max(i->decoder->position(), i->content->trim_start()));
678 if (t > i->content->end(_film)) {
682 /* Given two choices at the same time, pick the one with texts so we see it before
685 if (!earliest_time || t < *earliest_time || (t == *earliest_time && !i->decoder->text.empty())) {
687 earliest_content = i;
701 if (earliest_content) {
705 if (!_black.done() && !_ignore_video && (!earliest_time || _black.position() < *earliest_time)) {
706 earliest_time = _black.position ();
710 if (!_silent.done() && !_ignore_audio && (!earliest_time || _silent.position() < *earliest_time)) {
711 earliest_time = _silent.position ();
718 LOG_DEBUG_PLAYER ("Calling pass() on %1", earliest_content->content->path(0));
719 earliest_content->done = earliest_content->decoder->pass ();
720 auto dcp = dynamic_pointer_cast<DCPContent>(earliest_content->content);
721 if (dcp && !_play_referenced && dcp->reference_audio()) {
722 /* We are skipping some referenced DCP audio content, so we need to update _next_audio_time
723 to `hide' the fact that no audio was emitted during the referenced DCP (though
724 we need to behave as though it was).
726 _next_audio_time = dcp->end (_film);
731 LOG_DEBUG_PLAYER ("Emit black for gap at %1", to_string(_black.position()));
732 emit_video (black_player_video_frame(Eyes::BOTH), _black.position());
733 _black.set_position (_black.position() + one_video_frame());
737 LOG_DEBUG_PLAYER ("Emit silence for gap at %1", to_string(_silent.position()));
738 DCPTimePeriod period (_silent.period_at_position());
739 if (_next_audio_time) {
740 /* Sometimes the thing that happened last finishes fractionally before
741 or after this silence. Bodge the start time of the silence to fix it.
742 I think this is nothing to worry about since we will just add or
743 remove a little silence at the end of some content.
745 int64_t const error = labs(period.from.get() - _next_audio_time->get());
746 /* Let's not worry about less than a frame at 24fps */
747 int64_t const too_much_error = DCPTime::from_frames(1, 24).get();
748 if (error >= too_much_error) {
749 _film->log()->log(String::compose("Silence starting before or after last audio by %1", error), LogEntry::TYPE_ERROR);
751 DCPOMATIC_ASSERT (error < too_much_error);
752 period.from = *_next_audio_time;
754 if (period.duration() > one_video_frame()) {
755 period.to = period.from + one_video_frame();
758 _silent.set_position (period.to);
766 /* Emit any audio that is ready */
768 /* Work out the time before which the audio is definitely all here. This is the earliest last_push_end of one
769 of our streams, or the position of the _silent. First, though we choose only streams that are less than
770 ignore_streams_behind seconds behind the furthest ahead (we assume that if a stream has fallen that far
771 behind it has finished). This is so that we don't withhold audio indefinitely awaiting data from a stream
772 that will never come, causing bugs like #2101.
774 constexpr int ignore_streams_behind = 5;
776 using state_pair = std::pair<AudioStreamPtr, StreamState>;
778 /* Find the 'leading' stream (i.e. the one that pushed data most recently) */
779 auto latest_last_push_end = std::max_element(
780 _stream_states.begin(),
781 _stream_states.end(),
782 [](state_pair const& a, state_pair const& b) { return a.second.last_push_end < b.second.last_push_end; }
785 if (latest_last_push_end != _stream_states.end()) {
786 LOG_DEBUG_PLAYER("Leading audio 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));
789 /* Now make a list of those streams that are less than ignore_streams_behind behind the leader */
790 std::map<AudioStreamPtr, StreamState> alive_stream_states;
791 for (auto const& i: _stream_states) {
792 if ((latest_last_push_end->second.last_push_end - i.second.last_push_end) < dcpomatic::DCPTime::from_seconds(ignore_streams_behind)) {
793 alive_stream_states.insert(i);
795 LOG_DEBUG_PLAYER("Ignoring stream %1 because it is too far behind", i.second.piece->content->path(0));
799 auto pull_to = _playback_length;
800 for (auto const& i: alive_stream_states) {
801 if (!i.second.piece->done && i.second.last_push_end < pull_to) {
802 pull_to = i.second.last_push_end;
805 if (!_silent.done() && _silent.position() < pull_to) {
806 pull_to = _silent.position();
809 LOG_DEBUG_PLAYER("Emitting audio up to %1", to_string(pull_to));
810 auto audio = _audio_merger.pull (pull_to);
811 for (auto i = audio.begin(); i != audio.end(); ++i) {
812 if (_next_audio_time && i->second < *_next_audio_time) {
813 /* This new data comes before the last we emitted (or the last seek); discard it */
814 auto cut = discard_audio (i->first, i->second, *_next_audio_time);
819 } else if (_next_audio_time && i->second > *_next_audio_time) {
820 /* There's a gap between this data and the last we emitted; fill with silence */
821 fill_audio (DCPTimePeriod (*_next_audio_time, i->second));
824 emit_audio (i->first, i->second);
831 for (auto const& i: _delay) {
832 do_emit_video(i.first, i.second);
835 /* Perhaps we should have Empty entries for both eyes in the 3D case (somehow).
836 * However, if we have L and R video files, and one is shorter than the other,
837 * the fill code in ::video mostly takes care of filling in the gaps.
838 * However, since it fills at the point when it knows there is more video coming
839 * at time t (so it should fill any gap up to t) it can't do anything right at the
840 * end. This is particularly bad news if the last frame emitted is a LEFT
841 * eye, as the MXF writer will complain about the 3D sequence being wrong.
842 * Here's a hack to workaround that particular case.
844 if (_next_video_eyes && _next_video_time && *_next_video_eyes == Eyes::RIGHT) {
845 do_emit_video (black_player_video_frame(Eyes::RIGHT), *_next_video_time);
853 /** @return Open subtitles for the frame at the given time, converted to images */
854 optional<PositionImage>
855 Player::open_subtitles_for_frame (DCPTime time) const
857 list<PositionImage> captions;
858 int const vfr = _film->video_frame_rate();
862 _active_texts[static_cast<int>(TextType::OPEN_SUBTITLE)].get_burnt(DCPTimePeriod(time, time + DCPTime::from_frames(1, vfr)), _always_burn_open_subtitles)
865 /* Bitmap subtitles */
866 for (auto i: j.bitmap) {
871 /* i.image will already have been scaled to fit _video_container_size */
872 dcp::Size scaled_size (i.rectangle.width * _video_container_size.width, i.rectangle.height * _video_container_size.height);
878 lrint(_video_container_size.width * i.rectangle.x),
879 lrint(_video_container_size.height * i.rectangle.y)
885 /* String subtitles (rendered to an image) */
886 if (!j.string.empty()) {
887 auto s = render_text(j.string, _video_container_size, time, vfr);
888 copy (s.begin(), s.end(), back_inserter (captions));
892 if (captions.empty()) {
896 return merge (captions, _subtitle_alignment);
901 Player::video (weak_ptr<Piece> weak_piece, ContentVideo video)
907 auto piece = weak_piece.lock ();
912 if (!piece->content->video->use()) {
916 FrameRateChange frc (_film, piece->content);
917 if (frc.skip && (video.frame % 2) == 1) {
921 /* Time of the first frame we will emit */
922 DCPTime const time = content_video_to_dcp (piece, video.frame);
923 LOG_DEBUG_PLAYER("Received video frame %1 at %2", video.frame, to_string(time));
925 /* Discard if it's before the content's period or the last accurate seek. We can't discard
926 if it's after the content's period here as in that case we still need to fill any gap between
927 `now' and the end of the content's period.
929 if (time < piece->content->position() || (_next_video_time && time < *_next_video_time)) {
933 if (piece->ignore_video && piece->ignore_video->contains(time)) {
937 /* Fill gaps that we discover now that we have some video which needs to be emitted.
938 This is where we need to fill to.
940 DCPTime fill_to = min (time, piece->content->end(_film));
942 if (_next_video_time) {
943 DCPTime fill_from = max (*_next_video_time, piece->content->position());
945 /* Fill if we have more than half a frame to do */
946 if ((fill_to - fill_from) > one_video_frame() / 2) {
947 auto last = _last_video.find (weak_piece);
948 if (_film->three_d()) {
949 auto fill_to_eyes = video.eyes;
950 if (fill_to_eyes == Eyes::BOTH) {
951 fill_to_eyes = Eyes::LEFT;
953 if (fill_to == piece->content->end(_film)) {
954 /* Don't fill after the end of the content */
955 fill_to_eyes = Eyes::LEFT;
958 auto eyes = _next_video_eyes.get_value_or(Eyes::LEFT);
959 if (eyes == Eyes::BOTH) {
962 while (j < fill_to || eyes != fill_to_eyes) {
963 if (last != _last_video.end()) {
964 LOG_DEBUG_PLAYER("Fill using last video at %1 in 3D mode", to_string(j));
965 auto copy = last->second->shallow_copy();
966 copy->set_eyes (eyes);
967 emit_video (copy, j);
969 LOG_DEBUG_PLAYER("Fill using black at %1 in 3D mode", to_string(j));
970 emit_video (black_player_video_frame(eyes), j);
972 if (eyes == Eyes::RIGHT) {
973 j += one_video_frame();
975 eyes = increment_eyes (eyes);
978 for (DCPTime j = fill_from; j < fill_to; j += one_video_frame()) {
979 if (last != _last_video.end()) {
980 emit_video (last->second, j);
982 emit_video (black_player_video_frame(Eyes::BOTH), j);
989 auto const content_video = piece->content->video;
991 _last_video[weak_piece] = std::make_shared<PlayerVideo>(
993 content_video->actual_crop(),
994 content_video->fade (_film, video.frame),
996 content_video->scaled_size(_film->frame_size()),
997 _video_container_size,
999 content_video->pixel_quanta()
1001 _video_container_size,
1004 content_video->colour_conversion(),
1005 content_video->range(),
1012 for (int i = 0; i < frc.repeat; ++i) {
1013 if (t < piece->content->end(_film)) {
1014 emit_video (_last_video[weak_piece], t);
1016 t += one_video_frame ();
1022 Player::audio (weak_ptr<Piece> weak_piece, AudioStreamPtr stream, ContentAudio content_audio)
1028 DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
1030 auto piece = weak_piece.lock ();
1035 auto content = piece->content->audio;
1036 DCPOMATIC_ASSERT (content);
1038 int const rfr = content->resampled_frame_rate (_film);
1040 /* Compute time in the DCP */
1041 auto time = resampled_audio_to_dcp (piece, content_audio.frame);
1042 LOG_DEBUG_PLAYER("Received audio frame %1 at %2", content_audio.frame, to_string(time));
1044 /* And the end of this block in the DCP */
1045 auto end = time + DCPTime::from_frames(content_audio.audio->frames(), rfr);
1047 /* Remove anything that comes before the start or after the end of the content */
1048 if (time < piece->content->position()) {
1049 auto cut = discard_audio (content_audio.audio, time, piece->content->position());
1051 /* This audio is entirely discarded */
1054 content_audio.audio = cut.first;
1056 } else if (time > piece->content->end(_film)) {
1057 /* Discard it all */
1059 } else if (end > piece->content->end(_film)) {
1060 Frame const remaining_frames = DCPTime(piece->content->end(_film) - time).frames_round(rfr);
1061 if (remaining_frames == 0) {
1064 content_audio.audio = make_shared<AudioBuffers>(content_audio.audio, remaining_frames, 0);
1067 DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
1071 auto const fade_coeffs = content->fade (stream, content_audio.frame, content_audio.audio->frames(), rfr);
1072 if (content->gain() != 0 || !fade_coeffs.empty()) {
1073 auto gain_buffers = make_shared<AudioBuffers>(content_audio.audio);
1074 if (!fade_coeffs.empty()) {
1075 /* Apply both fade and gain */
1076 DCPOMATIC_ASSERT (fade_coeffs.size() == static_cast<size_t>(gain_buffers->frames()));
1077 auto const channels = gain_buffers->channels();
1078 auto const frames = fade_coeffs.size();
1079 auto data = gain_buffers->data();
1080 auto const gain = db_to_linear (content->gain());
1081 for (auto channel = 0; channel < channels; ++channel) {
1082 for (auto frame = 0U; frame < frames; ++frame) {
1083 data[channel][frame] *= gain * fade_coeffs[frame];
1087 /* Just apply gain */
1088 gain_buffers->apply_gain (content->gain());
1090 content_audio.audio = gain_buffers;
1095 content_audio.audio = remap (content_audio.audio, _film->audio_channels(), stream->mapping());
1099 if (_audio_processor) {
1100 content_audio.audio = _audio_processor->run (content_audio.audio, _film->audio_channels ());
1105 _audio_merger.push (content_audio.audio, time);
1106 DCPOMATIC_ASSERT (_stream_states.find (stream) != _stream_states.end ());
1107 _stream_states[stream].last_push_end = time + DCPTime::from_frames (content_audio.audio->frames(), _film->audio_frame_rate());
1112 Player::bitmap_text_start (weak_ptr<Piece> weak_piece, weak_ptr<const TextContent> weak_content, ContentBitmapText subtitle)
1118 auto piece = weak_piece.lock ();
1119 auto content = weak_content.lock ();
1120 if (!piece || !content) {
1125 for (auto& sub: subtitle.subs)
1127 /* Apply content's subtitle offsets */
1128 sub.rectangle.x += content->x_offset ();
1129 sub.rectangle.y += content->y_offset ();
1131 /* Apply a corrective translation to keep the subtitle centred after the scale that is coming up */
1132 sub.rectangle.x -= sub.rectangle.width * ((content->x_scale() - 1) / 2);
1133 sub.rectangle.y -= sub.rectangle.height * ((content->y_scale() - 1) / 2);
1135 /* Apply content's subtitle scale */
1136 sub.rectangle.width *= content->x_scale ();
1137 sub.rectangle.height *= content->y_scale ();
1139 auto image = sub.image;
1141 /* We will scale the subtitle up to fit _video_container_size */
1142 int const width = sub.rectangle.width * _video_container_size.width;
1143 int const height = sub.rectangle.height * _video_container_size.height;
1144 if (width == 0 || height == 0) {
1148 dcp::Size scaled_size (width, height);
1149 ps.bitmap.push_back (BitmapText(image->scale(scaled_size, dcp::YUVToRGB::REC601, image->pixel_format(), Image::Alignment::PADDED, _fast), sub.rectangle));
1152 DCPTime from(content_time_to_dcp(piece, subtitle.from()));
1153 _active_texts[static_cast<int>(content->type())].add_from(weak_content, ps, from);
1158 Player::plain_text_start (weak_ptr<Piece> weak_piece, weak_ptr<const TextContent> weak_content, ContentStringText subtitle)
1164 auto piece = weak_piece.lock ();
1165 auto content = weak_content.lock ();
1166 if (!piece || !content) {
1171 DCPTime const from (content_time_to_dcp (piece, subtitle.from()));
1173 if (from > piece->content->end(_film)) {
1177 for (auto s: subtitle.subs) {
1178 s.set_h_position (s.h_position() + content->x_offset());
1179 s.set_v_position (s.v_position() + content->y_offset());
1180 float const xs = content->x_scale();
1181 float const ys = content->y_scale();
1182 float size = s.size();
1184 /* Adjust size to express the common part of the scaling;
1185 e.g. if xs = ys = 0.5 we scale size by 2.
1187 if (xs > 1e-5 && ys > 1e-5) {
1188 size *= 1 / min (1 / xs, 1 / ys);
1192 /* Then express aspect ratio changes */
1193 if (fabs (1.0 - xs / ys) > dcp::ASPECT_ADJUST_EPSILON) {
1194 s.set_aspect_adjust (xs / ys);
1197 s.set_in (dcp::Time(from.seconds(), 1000));
1198 ps.string.push_back (s);
1201 _active_texts[static_cast<int>(content->type())].add_from(weak_content, ps, from);
1206 Player::subtitle_stop (weak_ptr<Piece> weak_piece, weak_ptr<const TextContent> weak_content, ContentTime to)
1212 auto content = weak_content.lock ();
1217 if (!_active_texts[static_cast<int>(content->type())].have(weak_content)) {
1221 auto piece = weak_piece.lock ();
1226 DCPTime const dcp_to = content_time_to_dcp (piece, to);
1228 if (dcp_to > piece->content->end(_film)) {
1232 auto from = _active_texts[static_cast<int>(content->type())].add_to(weak_content, dcp_to);
1234 bool const always = (content->type() == TextType::OPEN_SUBTITLE && _always_burn_open_subtitles);
1235 if (content->use() && !always && !content->burn()) {
1236 Text (from.first, content->type(), content->dcp_track().get_value_or(DCPTextTrack()), DCPTimePeriod(from.second, dcp_to));
1242 Player::seek (DCPTime time, bool accurate)
1244 boost::mutex::scoped_lock lm (_mutex);
1245 LOG_DEBUG_PLAYER("Seek to %1 (%2accurate)", to_string(time), accurate ? "" : "in");
1248 /* We can't seek in this state */
1253 _shuffler->clear ();
1258 if (_audio_processor) {
1259 _audio_processor->flush ();
1262 _audio_merger.clear ();
1263 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
1264 _active_texts[i].clear ();
1267 for (auto i: _pieces) {
1268 if (time < i->content->position()) {
1269 /* Before; seek to the start of the content. Even if this request is for an inaccurate seek
1270 we must seek this (following) content accurately, otherwise when we come to the end of the current
1271 content we may not start right at the beginning of the next, causing a gap (if the next content has
1272 been trimmed to a point between keyframes, or something).
1274 i->decoder->seek (dcp_to_content_time (i, i->content->position()), true);
1276 } else if (i->content->position() <= time && time < i->content->end(_film)) {
1277 /* During; seek to position */
1278 i->decoder->seek (dcp_to_content_time (i, time), accurate);
1281 /* After; this piece is done */
1287 _next_video_time = time;
1288 _next_video_eyes = Eyes::LEFT;
1289 _next_audio_time = time;
1291 _next_video_time = boost::none;
1292 _next_video_eyes = boost::none;
1293 _next_audio_time = boost::none;
1296 _black.set_position (time);
1297 _silent.set_position (time);
1299 _last_video.clear ();
1304 Player::emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1306 if (!_film->three_d()) {
1307 if (pv->eyes() == Eyes::LEFT) {
1308 /* Use left-eye images for both eyes... */
1309 pv->set_eyes (Eyes::BOTH);
1310 } else if (pv->eyes() == Eyes::RIGHT) {
1311 /* ...and discard the right */
1316 /* We need a delay to give a little wiggle room to ensure that relevant subtitles arrive at the
1317 player before the video that requires them.
1319 _delay.push_back (make_pair (pv, time));
1321 if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
1322 _next_video_time = time + one_video_frame();
1324 _next_video_eyes = increment_eyes (pv->eyes());
1326 if (_delay.size() < 3) {
1330 auto to_do = _delay.front();
1332 do_emit_video (to_do.first, to_do.second);
1337 Player::do_emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1339 if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
1340 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
1341 _active_texts[i].clear_before (time);
1345 auto subtitles = open_subtitles_for_frame (time);
1347 pv->set_text (subtitles.get ());
1355 Player::emit_audio (shared_ptr<AudioBuffers> data, DCPTime time)
1357 /* Log if the assert below is about to fail */
1358 if (_next_audio_time && labs(time.get() - _next_audio_time->get()) > 1) {
1359 _film->log()->log(String::compose("Out-of-sequence emit %1 vs %2", to_string(time), to_string(*_next_audio_time)), LogEntry::TYPE_WARNING);
1362 /* This audio must follow on from the previous, allowing for half a sample (at 48kHz) leeway */
1363 DCPOMATIC_ASSERT (!_next_audio_time || labs(time.get() - _next_audio_time->get()) < 2);
1364 Audio (data, time, _film->audio_frame_rate());
1365 _next_audio_time = time + DCPTime::from_frames (data->frames(), _film->audio_frame_rate());
1370 Player::fill_audio (DCPTimePeriod period)
1372 if (period.from == period.to) {
1376 DCPOMATIC_ASSERT (period.from < period.to);
1378 DCPTime t = period.from;
1379 while (t < period.to) {
1380 DCPTime block = min (DCPTime::from_seconds (0.5), period.to - t);
1381 Frame const samples = block.frames_round(_film->audio_frame_rate());
1383 auto silence = make_shared<AudioBuffers>(_film->audio_channels(), samples);
1384 silence->make_silent ();
1385 emit_audio (silence, t);
1393 Player::one_video_frame () const
1395 return DCPTime::from_frames (1, _film->video_frame_rate ());
1399 pair<shared_ptr<AudioBuffers>, DCPTime>
1400 Player::discard_audio (shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to) const
1402 auto const discard_time = discard_to - time;
1403 auto const discard_frames = discard_time.frames_round(_film->audio_frame_rate());
1404 auto remaining_frames = audio->frames() - discard_frames;
1405 if (remaining_frames <= 0) {
1406 return make_pair(shared_ptr<AudioBuffers>(), DCPTime());
1408 auto cut = make_shared<AudioBuffers>(audio, remaining_frames, discard_frames);
1409 return make_pair(cut, time + discard_time);
1414 Player::set_dcp_decode_reduction (optional<int> reduction)
1416 Change (ChangeType::PENDING, PlayerProperty::DCP_DECODE_REDUCTION, false);
1419 boost::mutex::scoped_lock lm (_mutex);
1421 if (reduction == _dcp_decode_reduction) {
1423 Change (ChangeType::CANCELLED, PlayerProperty::DCP_DECODE_REDUCTION, false);
1427 _dcp_decode_reduction = reduction;
1428 setup_pieces_unlocked ();
1431 Change (ChangeType::DONE, PlayerProperty::DCP_DECODE_REDUCTION, false);
1436 Player::content_time_to_dcp (shared_ptr<const Content> content, ContentTime t)
1438 boost::mutex::scoped_lock lm (_mutex);
1440 for (auto i: _pieces) {
1441 if (i->content == content) {
1442 return content_time_to_dcp (i, t);
1446 /* We couldn't find this content; perhaps things are being changed over */
1451 optional<ContentTime>
1452 Player::dcp_to_content_time (shared_ptr<const Content> content, DCPTime t)
1454 boost::mutex::scoped_lock lm (_mutex);
1456 for (auto i: _pieces) {
1457 if (i->content == content) {
1458 return dcp_to_content_time (i, t);
1462 /* We couldn't find this content; perhaps things are being changed over */
1467 shared_ptr<const Playlist>
1468 Player::playlist () const
1470 return _playlist ? _playlist : _film->playlist();
1475 Player::atmos (weak_ptr<Piece> weak_piece, ContentAtmos data)
1481 auto piece = weak_piece.lock ();
1482 DCPOMATIC_ASSERT (piece);
1484 auto const vfr = _film->video_frame_rate();
1486 DCPTime const dcp_time = DCPTime::from_frames(data.frame, vfr) - DCPTime(piece->content->trim_start(), FrameRateChange(vfr, vfr));
1487 if (dcp_time < piece->content->position() || dcp_time >= (piece->content->end(_film))) {
1491 Atmos (data.data, dcp_time, data.metadata);