2 Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
22 #include "atmos_decoder.h"
23 #include "audio_buffers.h"
24 #include "audio_content.h"
25 #include "audio_decoder.h"
26 #include "audio_processor.h"
27 #include "compose.hpp"
29 #include "content_audio.h"
30 #include "content_video.h"
31 #include "dcp_content.h"
32 #include "dcp_decoder.h"
33 #include "dcpomatic_log.h"
35 #include "decoder_factory.h"
36 #include "ffmpeg_content.h"
38 #include "frame_rate_change.h"
40 #include "image_decoder.h"
43 #include "maths_util.h"
46 #include "player_video.h"
49 #include "raw_image_proxy.h"
50 #include "referenced_reel_asset.h"
51 #include "render_text.h"
53 #include "text_content.h"
54 #include "text_decoder.h"
56 #include "video_decoder.h"
58 #include <dcp/reel_closed_caption_asset.h>
59 #include <dcp/reel_picture_asset.h>
60 #include <dcp/reel_sound_asset.h>
61 #include <dcp/reel_subtitle_asset.h>
71 using std::dynamic_pointer_cast;
74 using std::make_shared;
75 using std::make_shared;
80 using std::shared_ptr;
83 using boost::optional;
84 using boost::scoped_ptr;
85 #if BOOST_VERSION >= 106100
86 using namespace boost::placeholders;
88 using namespace dcpomatic;
91 int const PlayerProperty::VIDEO_CONTAINER_SIZE = 700;
92 int const PlayerProperty::PLAYLIST = 701;
93 int const PlayerProperty::FILM_CONTAINER = 702;
94 int const PlayerProperty::FILM_VIDEO_FRAME_RATE = 703;
95 int const PlayerProperty::DCP_DECODE_REDUCTION = 704;
96 int const PlayerProperty::PLAYBACK_LENGTH = 705;
99 Player::Player (shared_ptr<const Film> film, Image::Alignment subtitle_alignment)
102 , _tolerant (film->tolerant())
103 , _audio_merger (_film->audio_frame_rate())
104 , _subtitle_alignment (subtitle_alignment)
110 Player::Player (shared_ptr<const Film> film, shared_ptr<const Playlist> playlist_)
112 , _playlist (playlist_)
114 , _tolerant (film->tolerant())
115 , _audio_merger (_film->audio_frame_rate())
124 _film_changed_connection = _film->Change.connect (bind (&Player::film_change, this, _1, _2));
125 /* The butler must hear about this first, so since we are proxying this through to the butler we must
128 _playlist_change_connection = playlist()->Change.connect (bind (&Player::playlist_change, this, _1), boost::signals2::at_front);
129 _playlist_content_change_connection = playlist()->ContentChange.connect (bind(&Player::playlist_content_change, this, _1, _3, _4));
130 set_video_container_size (_film->frame_size ());
132 film_change (ChangeType::DONE, Film::Property::AUDIO_PROCESSOR);
135 seek (DCPTime (), true);
140 Player::setup_pieces ()
142 boost::mutex::scoped_lock lm (_mutex);
143 setup_pieces_unlocked ();
148 have_video (shared_ptr<const Content> content)
150 return static_cast<bool>(content->video) && content->video->use() && content->can_be_played();
155 have_audio (shared_ptr<const Content> content)
157 return static_cast<bool>(content->audio) && content->can_be_played();
162 Player::setup_pieces_unlocked ()
164 _playback_length = _playlist ? _playlist->length(_film) : _film->length();
166 auto old_pieces = _pieces;
169 auto playlist_content = playlist()->content();
170 bool const have_threed = std::any_of(
171 playlist_content.begin(),
172 playlist_content.end(),
173 [](shared_ptr<const Content> c) {
174 return c->video && (c->video->frame_type() == VideoFrameType::THREE_D_LEFT || c->video->frame_type() == VideoFrameType::THREE_D_RIGHT);
179 _shuffler.reset(new Shuffler());
180 _shuffler->Video.connect(bind(&Player::video, this, _1, _2));
183 for (auto i: playlist()->content()) {
185 if (!i->paths_valid ()) {
189 if (_ignore_video && _ignore_audio && i->text.empty()) {
190 /* We're only interested in text and this content has none */
194 shared_ptr<Decoder> old_decoder;
195 for (auto j: old_pieces) {
196 if (j->content == i) {
197 old_decoder = j->decoder;
202 auto decoder = decoder_factory (_film, i, _fast, _tolerant, old_decoder);
203 DCPOMATIC_ASSERT (decoder);
205 FrameRateChange frc (_film, i);
207 if (decoder->video && _ignore_video) {
208 decoder->video->set_ignore (true);
211 if (decoder->audio && _ignore_audio) {
212 decoder->audio->set_ignore (true);
216 for (auto i: decoder->text) {
217 i->set_ignore (true);
221 auto dcp = dynamic_pointer_cast<DCPDecoder> (decoder);
223 dcp->set_decode_referenced (_play_referenced);
224 if (_play_referenced) {
225 dcp->set_forced_reduction (_dcp_decode_reduction);
229 auto piece = make_shared<Piece>(i, decoder, frc);
230 _pieces.push_back (piece);
232 if (decoder->video) {
234 /* We need a Shuffler to cope with 3D L/R video data arriving out of sequence */
235 decoder->video->Data.connect (bind(&Shuffler::video, _shuffler.get(), weak_ptr<Piece>(piece), _1));
237 decoder->video->Data.connect (bind(&Player::video, this, weak_ptr<Piece>(piece), _1));
241 if (decoder->audio) {
242 decoder->audio->Data.connect (bind (&Player::audio, this, weak_ptr<Piece> (piece), _1, _2));
245 auto j = decoder->text.begin();
247 while (j != decoder->text.end()) {
248 (*j)->BitmapStart.connect (
249 bind(&Player::bitmap_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
251 (*j)->PlainStart.connect (
252 bind(&Player::plain_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
255 bind(&Player::subtitle_stop, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
261 if (decoder->atmos) {
262 decoder->atmos->Data.connect (bind(&Player::atmos, this, weak_ptr<Piece>(piece), _1));
266 _stream_states.clear ();
267 for (auto i: _pieces) {
268 if (i->content->audio) {
269 for (auto j: i->content->audio->streams()) {
270 _stream_states[j] = StreamState (i, i->content->position ());
275 auto ignore_overlap = [](shared_ptr<VideoContent> v) {
276 return v && v->use() && v->frame_type() != VideoFrameType::THREE_D_LEFT && v->frame_type() != VideoFrameType::THREE_D_RIGHT;
279 for (auto i = _pieces.begin(); i != _pieces.end(); ++i) {
280 if (ignore_overlap((*i)->content->video)) {
281 /* Look for content later in the content list with in-use video that overlaps this */
282 auto const period = DCPTimePeriod((*i)->content->position(), (*i)->content->end(_film));
283 for (auto j = std::next(i); j != _pieces.end(); ++j) {
284 if ((*j)->content->video && ignore_overlap((*j)->content->video)) {
285 (*i)->ignore_video = DCPTimePeriod((*j)->content->position(), (*j)->content->end(_film)).overlap(period);
291 _black = Empty (_film, playlist(), bind(&have_video, _1), _playback_length);
292 _silent = Empty (_film, playlist(), bind(&have_audio, _1), _playback_length);
294 _next_video_time = boost::none;
295 _next_video_eyes = Eyes::BOTH;
296 _next_audio_time = boost::none;
301 Player::playlist_content_change (ChangeType type, int property, bool frequent)
303 if (property == VideoContentProperty::CROP) {
304 if (type == ChangeType::DONE) {
305 auto const vcs = video_container_size();
306 boost::mutex::scoped_lock lm (_mutex);
307 for (auto const& i: _delay) {
308 i.first->reset_metadata (_film, vcs);
312 if (type == ChangeType::PENDING) {
313 /* The player content is probably about to change, so we can't carry on
314 until that has happened and we've rebuilt our pieces. Stop pass()
315 and seek() from working until then.
318 } else if (type == ChangeType::DONE) {
319 /* A change in our content has gone through. Re-build our pieces. */
322 } else if (type == ChangeType::CANCELLED) {
327 Change (type, property, frequent);
332 Player::set_video_container_size (dcp::Size s)
334 Change (ChangeType::PENDING, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
337 boost::mutex::scoped_lock lm (_mutex);
339 if (s == _video_container_size) {
341 Change (ChangeType::CANCELLED, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
345 _video_container_size = s;
347 _black_image = make_shared<Image>(AV_PIX_FMT_RGB24, _video_container_size, Image::Alignment::PADDED);
348 _black_image->make_black ();
351 Change (ChangeType::DONE, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
356 Player::playlist_change (ChangeType type)
358 if (type == ChangeType::DONE) {
361 Change (type, PlayerProperty::PLAYLIST, false);
366 Player::film_change (ChangeType type, Film::Property p)
368 /* Here we should notice Film properties that affect our output, and
369 alert listeners that our output now would be different to how it was
370 last time we were run.
373 if (p == Film::Property::CONTAINER) {
374 Change (type, PlayerProperty::FILM_CONTAINER, false);
375 } else if (p == Film::Property::VIDEO_FRAME_RATE) {
376 /* Pieces contain a FrameRateChange which contains the DCP frame rate,
377 so we need new pieces here.
379 if (type == ChangeType::DONE) {
382 Change (type, PlayerProperty::FILM_VIDEO_FRAME_RATE, false);
383 } else if (p == Film::Property::AUDIO_PROCESSOR) {
384 if (type == ChangeType::DONE && _film->audio_processor ()) {
385 boost::mutex::scoped_lock lm (_mutex);
386 _audio_processor = _film->audio_processor()->clone (_film->audio_frame_rate ());
388 } else if (p == Film::Property::AUDIO_CHANNELS) {
389 if (type == ChangeType::DONE) {
390 boost::mutex::scoped_lock lm (_mutex);
391 _audio_merger.clear ();
397 shared_ptr<PlayerVideo>
398 Player::black_player_video_frame (Eyes eyes) const
400 return std::make_shared<PlayerVideo> (
401 std::make_shared<const RawImageProxy>(_black_image),
404 _video_container_size,
405 _video_container_size,
408 PresetColourConversion::all().front().conversion,
410 std::weak_ptr<Content>(),
411 boost::optional<Frame>(),
418 Player::dcp_to_content_video (shared_ptr<const Piece> piece, DCPTime t) const
420 auto s = t - piece->content->position ();
421 s = min (piece->content->length_after_trim(_film), s);
422 s = max (DCPTime(), s + DCPTime (piece->content->trim_start(), piece->frc));
424 /* It might seem more logical here to convert s to a ContentTime (using the FrameRateChange)
425 then convert that ContentTime to frames at the content's rate. However this fails for
426 situations like content at 29.9978733fps, DCP at 30fps. The accuracy of the Time type is not
427 enough to distinguish between the two with low values of time (e.g. 3200 in Time units).
429 Instead we convert the DCPTime using the DCP video rate then account for any skip/repeat.
431 return s.frames_floor (piece->frc.dcp) / piece->frc.factor ();
436 Player::content_video_to_dcp (shared_ptr<const Piece> piece, Frame f) const
438 /* See comment in dcp_to_content_video */
439 auto const d = DCPTime::from_frames (f * piece->frc.factor(), piece->frc.dcp) - DCPTime(piece->content->trim_start(), piece->frc);
440 return d + piece->content->position();
445 Player::dcp_to_resampled_audio (shared_ptr<const Piece> piece, DCPTime t) const
447 auto s = t - piece->content->position ();
448 s = min (piece->content->length_after_trim(_film), s);
449 /* See notes in dcp_to_content_video */
450 return max (DCPTime(), DCPTime(piece->content->trim_start(), piece->frc) + s).frames_floor(_film->audio_frame_rate());
455 Player::resampled_audio_to_dcp (shared_ptr<const Piece> piece, Frame f) const
457 /* See comment in dcp_to_content_video */
458 return DCPTime::from_frames (f, _film->audio_frame_rate())
459 - DCPTime (piece->content->trim_start(), piece->frc)
460 + piece->content->position();
465 Player::dcp_to_content_time (shared_ptr<const Piece> piece, DCPTime t) const
467 auto s = t - piece->content->position ();
468 s = min (piece->content->length_after_trim(_film), s);
469 return max (ContentTime (), ContentTime (s, piece->frc) + piece->content->trim_start());
474 Player::content_time_to_dcp (shared_ptr<const Piece> piece, ContentTime t) const
476 return max (DCPTime(), DCPTime(t - piece->content->trim_start(), piece->frc) + piece->content->position());
480 vector<shared_ptr<Font>>
481 Player::get_subtitle_fonts ()
483 boost::mutex::scoped_lock lm (_mutex);
485 vector<shared_ptr<Font>> fonts;
486 for (auto piece: _pieces) {
487 for (auto text: piece->content->text) {
488 auto text_fonts = text->fonts();
489 copy (text_fonts.begin(), text_fonts.end(), back_inserter(fonts));
497 /** Set this player never to produce any video data */
499 Player::set_ignore_video ()
501 boost::mutex::scoped_lock lm (_mutex);
502 _ignore_video = true;
503 setup_pieces_unlocked ();
508 Player::set_ignore_audio ()
510 boost::mutex::scoped_lock lm (_mutex);
511 _ignore_audio = true;
512 setup_pieces_unlocked ();
517 Player::set_ignore_text ()
519 boost::mutex::scoped_lock lm (_mutex);
521 setup_pieces_unlocked ();
525 /** Set the player to always burn open texts into the image regardless of the content settings */
527 Player::set_always_burn_open_subtitles ()
529 boost::mutex::scoped_lock lm (_mutex);
530 _always_burn_open_subtitles = true;
534 /** Sets up the player to be faster, possibly at the expense of quality */
538 boost::mutex::scoped_lock lm (_mutex);
540 setup_pieces_unlocked ();
545 Player::set_play_referenced ()
547 boost::mutex::scoped_lock lm (_mutex);
548 _play_referenced = true;
549 setup_pieces_unlocked ();
554 maybe_add_asset (list<ReferencedReelAsset>& a, shared_ptr<dcp::ReelAsset> r, Frame reel_trim_start, Frame reel_trim_end, DCPTime from, int const ffr)
556 DCPOMATIC_ASSERT (r);
557 r->set_entry_point (r->entry_point().get_value_or(0) + reel_trim_start);
558 r->set_duration (r->actual_duration() - reel_trim_start - reel_trim_end);
559 if (r->actual_duration() > 0) {
561 ReferencedReelAsset(r, DCPTimePeriod(from, from + DCPTime::from_frames(r->actual_duration(), ffr)))
567 list<ReferencedReelAsset>
568 Player::get_reel_assets ()
570 /* Does not require a lock on _mutex as it's only called from DCPEncoder */
572 list<ReferencedReelAsset> reel_assets;
574 for (auto content: playlist()->content()) {
575 auto dcp = dynamic_pointer_cast<DCPContent>(content);
580 if (!dcp->reference_video() && !dcp->reference_audio() && !dcp->reference_text(TextType::OPEN_SUBTITLE) && !dcp->reference_text(TextType::CLOSED_CAPTION)) {
584 scoped_ptr<DCPDecoder> decoder;
586 decoder.reset (new DCPDecoder(_film, dcp, false, false, shared_ptr<DCPDecoder>()));
591 auto const frame_rate = _film->video_frame_rate();
592 DCPOMATIC_ASSERT (dcp->video_frame_rate());
593 /* We should only be referencing if the DCP rate is the same as the film rate */
594 DCPOMATIC_ASSERT (std::round(dcp->video_frame_rate().get()) == frame_rate);
596 Frame const trim_start = dcp->trim_start().frames_round(frame_rate);
597 Frame const trim_end = dcp->trim_end().frames_round(frame_rate);
599 /* position in the asset from the start */
600 int64_t offset_from_start = 0;
601 /* position i the asset from the end */
602 int64_t offset_from_end = 0;
603 for (auto reel: decoder->reels()) {
604 /* Assume that main picture duration is the length of the reel */
605 offset_from_end += reel->main_picture()->actual_duration();
608 for (auto reel: decoder->reels()) {
610 /* Assume that main picture duration is the length of the reel */
611 int64_t const reel_duration = reel->main_picture()->actual_duration();
613 /* See doc/design/trim_reels.svg */
614 Frame const reel_trim_start = min(reel_duration, max(int64_t(0), trim_start - offset_from_start));
615 Frame const reel_trim_end = min(reel_duration, max(int64_t(0), reel_duration - (offset_from_end - trim_end)));
617 auto const from = content->position() + std::max(DCPTime(), DCPTime::from_frames(offset_from_start - trim_start, frame_rate));
618 if (dcp->reference_video()) {
619 maybe_add_asset (reel_assets, reel->main_picture(), reel_trim_start, reel_trim_end, from, frame_rate);
622 if (dcp->reference_audio()) {
623 maybe_add_asset (reel_assets, reel->main_sound(), reel_trim_start, reel_trim_end, from, frame_rate);
626 if (dcp->reference_text(TextType::OPEN_SUBTITLE)) {
627 maybe_add_asset (reel_assets, reel->main_subtitle(), reel_trim_start, reel_trim_end, from, frame_rate);
630 if (dcp->reference_text(TextType::CLOSED_CAPTION)) {
631 for (auto caption: reel->closed_captions()) {
632 maybe_add_asset (reel_assets, caption, reel_trim_start, reel_trim_end, from, frame_rate);
636 offset_from_start += reel_duration;
637 offset_from_end -= reel_duration;
648 boost::mutex::scoped_lock lm (_mutex);
651 /* We can't pass in this state */
652 LOG_DEBUG_PLAYER_NC ("Player is suspended");
656 if (_playback_length == DCPTime()) {
657 /* Special; just give one black frame */
658 emit_video (black_player_video_frame(Eyes::BOTH), DCPTime());
662 /* Find the decoder or empty which is farthest behind where we are and make it emit some data */
664 shared_ptr<Piece> earliest_content;
665 optional<DCPTime> earliest_time;
667 for (auto i: _pieces) {
672 auto const t = content_time_to_dcp (i, max(i->decoder->position(), i->content->trim_start()));
673 if (t > i->content->end(_film)) {
677 /* Given two choices at the same time, pick the one with texts so we see it before
680 if (!earliest_time || t < *earliest_time || (t == *earliest_time && !i->decoder->text.empty())) {
682 earliest_content = i;
696 if (earliest_content) {
700 if (!_black.done() && !_ignore_video && (!earliest_time || _black.position() < *earliest_time)) {
701 earliest_time = _black.position ();
705 if (!_silent.done() && !_ignore_audio && (!earliest_time || _silent.position() < *earliest_time)) {
706 earliest_time = _silent.position ();
713 LOG_DEBUG_PLAYER ("Calling pass() on %1", earliest_content->content->path(0));
714 earliest_content->done = earliest_content->decoder->pass ();
715 auto dcp = dynamic_pointer_cast<DCPContent>(earliest_content->content);
716 if (dcp && !_play_referenced && dcp->reference_audio()) {
717 /* We are skipping some referenced DCP audio content, so we need to update _next_audio_time
718 to `hide' the fact that no audio was emitted during the referenced DCP (though
719 we need to behave as though it was).
721 _next_audio_time = dcp->end (_film);
726 LOG_DEBUG_PLAYER ("Emit black for gap at %1", to_string(_black.position()));
727 emit_video (black_player_video_frame(Eyes::BOTH), _black.position());
728 _black.set_position (_black.position() + one_video_frame());
732 LOG_DEBUG_PLAYER ("Emit silence for gap at %1", to_string(_silent.position()));
733 DCPTimePeriod period (_silent.period_at_position());
734 if (_next_audio_time) {
735 /* Sometimes the thing that happened last finishes fractionally before
736 or after this silence. Bodge the start time of the silence to fix it.
737 I think this is nothing to worry about since we will just add or
738 remove a little silence at the end of some content.
740 int64_t const error = labs(period.from.get() - _next_audio_time->get());
741 /* Let's not worry about less than a frame at 24fps */
742 int64_t const too_much_error = DCPTime::from_frames(1, 24).get();
743 if (error >= too_much_error) {
744 _film->log()->log(String::compose("Silence starting before or after last audio by %1", error), LogEntry::TYPE_ERROR);
746 DCPOMATIC_ASSERT (error < too_much_error);
747 period.from = *_next_audio_time;
749 if (period.duration() > one_video_frame()) {
750 period.to = period.from + one_video_frame();
753 _silent.set_position (period.to);
761 /* Emit any audio that is ready */
763 /* Work out the time before which the audio is definitely all here. This is the earliest last_push_end of one
764 of our streams, or the position of the _silent. First, though we choose only streams that are less than
765 ignore_streams_behind seconds behind the furthest ahead (we assume that if a stream has fallen that far
766 behind it has finished). This is so that we don't withhold audio indefinitely awaiting data from a stream
767 that will never come, causing bugs like #2101.
769 constexpr int ignore_streams_behind = 5;
771 using state_pair = std::pair<AudioStreamPtr, StreamState>;
773 /* Find the 'leading' stream (i.e. the one that pushed data most recently) */
774 auto latest_last_push_end = std::max_element(
775 _stream_states.begin(),
776 _stream_states.end(),
777 [](state_pair const& a, state_pair const& b) { return a.second.last_push_end < b.second.last_push_end; }
780 if (latest_last_push_end != _stream_states.end()) {
781 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));
784 /* Now make a list of those streams that are less than ignore_streams_behind behind the leader */
785 std::map<AudioStreamPtr, StreamState> alive_stream_states;
786 for (auto const& i: _stream_states) {
787 if ((latest_last_push_end->second.last_push_end - i.second.last_push_end) < dcpomatic::DCPTime::from_seconds(ignore_streams_behind)) {
788 alive_stream_states.insert(i);
790 LOG_DEBUG_PLAYER("Ignoring stream %1 because it is too far behind", i.second.piece->content->path(0));
794 auto pull_to = _playback_length;
795 for (auto const& i: alive_stream_states) {
796 if (!i.second.piece->done && i.second.last_push_end < pull_to) {
797 pull_to = i.second.last_push_end;
800 if (!_silent.done() && _silent.position() < pull_to) {
801 pull_to = _silent.position();
804 LOG_DEBUG_PLAYER("Emitting audio up to %1", to_string(pull_to));
805 auto audio = _audio_merger.pull (pull_to);
806 for (auto i = audio.begin(); i != audio.end(); ++i) {
807 if (_next_audio_time && i->second < *_next_audio_time) {
808 /* This new data comes before the last we emitted (or the last seek); discard it */
809 auto cut = discard_audio (i->first, i->second, *_next_audio_time);
814 } else if (_next_audio_time && i->second > *_next_audio_time) {
815 /* There's a gap between this data and the last we emitted; fill with silence */
816 fill_audio (DCPTimePeriod (*_next_audio_time, i->second));
819 emit_audio (i->first, i->second);
826 for (auto const& i: _delay) {
827 do_emit_video(i.first, i.second);
830 /* Perhaps we should have Empty entries for both eyes in the 3D case (somehow).
831 * However, if we have L and R video files, and one is shorter than the other,
832 * the fill code in ::video mostly takes care of filling in the gaps.
833 * However, since it fills at the point when it knows there is more video coming
834 * at time t (so it should fill any gap up to t) it can't do anything right at the
835 * end. This is particularly bad news if the last frame emitted is a LEFT
836 * eye, as the MXF writer will complain about the 3D sequence being wrong.
837 * Here's a hack to workaround that particular case.
839 if (_next_video_eyes && _next_video_time && *_next_video_eyes == Eyes::RIGHT) {
840 do_emit_video (black_player_video_frame(Eyes::RIGHT), *_next_video_time);
848 /** @return Open subtitles for the frame at the given time, converted to images */
849 optional<PositionImage>
850 Player::open_subtitles_for_frame (DCPTime time, Eyes eyes) const
852 list<PositionImage> captions;
853 int const vfr = _film->video_frame_rate();
857 _active_texts[static_cast<int>(TextType::OPEN_SUBTITLE)].get_burnt(DCPTimePeriod(time, time + DCPTime::from_frames(1, vfr)), _always_burn_open_subtitles)
860 /* Bitmap subtitles */
861 for (auto i: burnt.bitmap) {
866 /* i.image will already have been scaled to fit _video_container_size */
867 dcp::Size scaled_size (i.rectangle.width * _video_container_size.width, i.rectangle.height * _video_container_size.height);
873 lrint(_video_container_size.width * i.rectangle.x),
874 lrint(_video_container_size.height * i.rectangle.y)
880 /* String subtitles (rendered to an image) */
881 if (!burnt.string.empty()) {
882 int stereo_offset = 0;
883 if (eyes == Eyes::LEFT) {
884 stereo_offset = -burnt.z_position;
885 } else if (eyes == Eyes::RIGHT) {
886 stereo_offset = burnt.z_position;
888 for (auto subtitle: render_text(burnt.string, _video_container_size, time, vfr)) {
889 subtitle.position.x += stereo_offset;
890 captions.push_back (subtitle);
895 if (captions.empty()) {
899 return merge (captions, _subtitle_alignment);
904 Player::video (weak_ptr<Piece> weak_piece, ContentVideo video)
910 auto piece = weak_piece.lock ();
915 if (!piece->content->video->use()) {
919 FrameRateChange frc (_film, piece->content);
920 if (frc.skip && (video.frame % 2) == 1) {
924 /* Time of the first frame we will emit */
925 DCPTime const time = content_video_to_dcp (piece, video.frame);
926 LOG_DEBUG_PLAYER("Received video frame %1 at %2", video.frame, to_string(time));
928 /* Discard if it's before the content's period or the last accurate seek. We can't discard
929 if it's after the content's period here as in that case we still need to fill any gap between
930 `now' and the end of the content's period.
932 if (time < piece->content->position() || (_next_video_time && time < *_next_video_time)) {
936 if (piece->ignore_video && piece->ignore_video->contains(time)) {
940 /* Fill gaps that we discover now that we have some video which needs to be emitted.
941 This is where we need to fill to.
943 DCPTime fill_to = min (time, piece->content->end(_film));
945 if (_next_video_time) {
946 DCPTime fill_from = max (*_next_video_time, piece->content->position());
948 /* Fill if we have more than half a frame to do */
949 if ((fill_to - fill_from) > one_video_frame() / 2) {
950 auto last = _last_video.find (weak_piece);
951 if (_film->three_d()) {
952 auto fill_to_eyes = video.eyes;
953 if (fill_to_eyes == Eyes::BOTH) {
954 fill_to_eyes = Eyes::LEFT;
956 if (fill_to == piece->content->end(_film)) {
957 /* Don't fill after the end of the content */
958 fill_to_eyes = Eyes::LEFT;
961 auto eyes = _next_video_eyes.get_value_or(Eyes::LEFT);
962 if (eyes == Eyes::BOTH) {
965 while (j < fill_to || eyes != fill_to_eyes) {
966 if (last != _last_video.end()) {
967 LOG_DEBUG_PLAYER("Fill using last video at %1 in 3D mode", to_string(j));
968 auto copy = last->second->shallow_copy();
969 copy->set_eyes (eyes);
970 emit_video (copy, j);
972 LOG_DEBUG_PLAYER("Fill using black at %1 in 3D mode", to_string(j));
973 emit_video (black_player_video_frame(eyes), j);
975 if (eyes == Eyes::RIGHT) {
976 j += one_video_frame();
978 eyes = increment_eyes (eyes);
981 for (DCPTime j = fill_from; j < fill_to; j += one_video_frame()) {
982 if (last != _last_video.end()) {
983 emit_video (last->second, j);
985 emit_video (black_player_video_frame(Eyes::BOTH), j);
992 auto const content_video = piece->content->video;
994 _last_video[weak_piece] = std::make_shared<PlayerVideo>(
996 content_video->actual_crop(),
997 content_video->fade (_film, video.frame),
999 content_video->scaled_size(_film->frame_size()),
1000 _video_container_size,
1001 _film->frame_size(),
1002 content_video->pixel_quanta()
1004 _video_container_size,
1007 content_video->colour_conversion(),
1008 content_video->range(),
1015 for (int i = 0; i < frc.repeat; ++i) {
1016 if (t < piece->content->end(_film)) {
1017 emit_video (_last_video[weak_piece], t);
1019 t += one_video_frame ();
1025 Player::audio (weak_ptr<Piece> weak_piece, AudioStreamPtr stream, ContentAudio content_audio)
1031 DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
1033 auto piece = weak_piece.lock ();
1038 auto content = piece->content->audio;
1039 DCPOMATIC_ASSERT (content);
1041 int const rfr = content->resampled_frame_rate (_film);
1043 /* Compute time in the DCP */
1044 auto time = resampled_audio_to_dcp (piece, content_audio.frame);
1045 LOG_DEBUG_PLAYER("Received audio frame %1 at %2", content_audio.frame, to_string(time));
1047 /* And the end of this block in the DCP */
1048 auto end = time + DCPTime::from_frames(content_audio.audio->frames(), rfr);
1050 /* Remove anything that comes before the start or after the end of the content */
1051 if (time < piece->content->position()) {
1052 auto cut = discard_audio (content_audio.audio, time, piece->content->position());
1054 /* This audio is entirely discarded */
1057 content_audio.audio = cut.first;
1059 } else if (time > piece->content->end(_film)) {
1060 /* Discard it all */
1062 } else if (end > piece->content->end(_film)) {
1063 Frame const remaining_frames = DCPTime(piece->content->end(_film) - time).frames_round(rfr);
1064 if (remaining_frames == 0) {
1067 content_audio.audio = make_shared<AudioBuffers>(content_audio.audio, remaining_frames, 0);
1070 DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
1074 auto const fade_coeffs = content->fade (stream, content_audio.frame, content_audio.audio->frames(), rfr);
1075 if (content->gain() != 0 || !fade_coeffs.empty()) {
1076 auto gain_buffers = make_shared<AudioBuffers>(content_audio.audio);
1077 if (!fade_coeffs.empty()) {
1078 /* Apply both fade and gain */
1079 DCPOMATIC_ASSERT (fade_coeffs.size() == static_cast<size_t>(gain_buffers->frames()));
1080 auto const channels = gain_buffers->channels();
1081 auto const frames = fade_coeffs.size();
1082 auto data = gain_buffers->data();
1083 auto const gain = db_to_linear (content->gain());
1084 for (auto channel = 0; channel < channels; ++channel) {
1085 for (auto frame = 0U; frame < frames; ++frame) {
1086 data[channel][frame] *= gain * fade_coeffs[frame];
1090 /* Just apply gain */
1091 gain_buffers->apply_gain (content->gain());
1093 content_audio.audio = gain_buffers;
1098 content_audio.audio = remap (content_audio.audio, _film->audio_channels(), stream->mapping());
1102 if (_audio_processor) {
1103 content_audio.audio = _audio_processor->run (content_audio.audio, _film->audio_channels ());
1108 _audio_merger.push (content_audio.audio, time);
1109 DCPOMATIC_ASSERT (_stream_states.find (stream) != _stream_states.end ());
1110 _stream_states[stream].last_push_end = time + DCPTime::from_frames (content_audio.audio->frames(), _film->audio_frame_rate());
1115 Player::bitmap_text_start (weak_ptr<Piece> weak_piece, weak_ptr<const TextContent> weak_content, ContentBitmapText subtitle)
1121 auto piece = weak_piece.lock ();
1122 auto content = weak_content.lock ();
1123 if (!piece || !content) {
1128 for (auto& sub: subtitle.subs)
1130 /* Apply content's subtitle offsets */
1131 sub.rectangle.x += content->x_offset ();
1132 sub.rectangle.y += content->y_offset ();
1134 /* Apply a corrective translation to keep the subtitle centred after the scale that is coming up */
1135 sub.rectangle.x -= sub.rectangle.width * ((content->x_scale() - 1) / 2);
1136 sub.rectangle.y -= sub.rectangle.height * ((content->y_scale() - 1) / 2);
1138 /* Apply content's subtitle scale */
1139 sub.rectangle.width *= content->x_scale ();
1140 sub.rectangle.height *= content->y_scale ();
1142 auto image = sub.image;
1144 /* We will scale the subtitle up to fit _video_container_size */
1145 int const width = sub.rectangle.width * _video_container_size.width;
1146 int const height = sub.rectangle.height * _video_container_size.height;
1147 if (width == 0 || height == 0) {
1151 dcp::Size scaled_size (width, height);
1152 ps.bitmap.push_back (BitmapText(image->scale(scaled_size, dcp::YUVToRGB::REC601, image->pixel_format(), Image::Alignment::PADDED, _fast), sub.rectangle));
1155 DCPTime from(content_time_to_dcp(piece, subtitle.from()));
1156 _active_texts[static_cast<int>(content->type())].add_from(weak_content, ps, from);
1161 Player::plain_text_start (weak_ptr<Piece> weak_piece, weak_ptr<const TextContent> weak_content, ContentStringText subtitle)
1167 auto piece = weak_piece.lock ();
1168 auto content = weak_content.lock ();
1169 if (!piece || !content) {
1174 DCPTime const from (content_time_to_dcp (piece, subtitle.from()));
1176 if (from > piece->content->end(_film)) {
1180 for (auto s: subtitle.subs) {
1181 s.set_h_position (s.h_position() + content->x_offset());
1182 s.set_v_position (s.v_position() + content->y_offset());
1183 float const xs = content->x_scale();
1184 float const ys = content->y_scale();
1185 float size = s.size();
1187 /* Adjust size to express the common part of the scaling;
1188 e.g. if xs = ys = 0.5 we scale size by 2.
1190 if (xs > 1e-5 && ys > 1e-5) {
1191 size *= 1 / min (1 / xs, 1 / ys);
1195 /* Then express aspect ratio changes */
1196 if (fabs (1.0 - xs / ys) > dcp::ASPECT_ADJUST_EPSILON) {
1197 s.set_aspect_adjust (xs / ys);
1200 s.set_in (dcp::Time(from.seconds(), 1000));
1201 ps.string.push_back (s);
1204 ps.z_position = content->z_position();
1205 _active_texts[static_cast<int>(content->type())].add_from(weak_content, ps, from);
1210 Player::subtitle_stop (weak_ptr<Piece> weak_piece, weak_ptr<const TextContent> weak_content, ContentTime to)
1216 auto content = weak_content.lock ();
1221 if (!_active_texts[static_cast<int>(content->type())].have(weak_content)) {
1225 auto piece = weak_piece.lock ();
1230 DCPTime const dcp_to = content_time_to_dcp (piece, to);
1232 if (dcp_to > piece->content->end(_film)) {
1236 auto from = _active_texts[static_cast<int>(content->type())].add_to(weak_content, dcp_to);
1238 bool const always = (content->type() == TextType::OPEN_SUBTITLE && _always_burn_open_subtitles);
1239 if (content->use() && !always && !content->burn()) {
1240 Text (from.first, content->type(), content->dcp_track().get_value_or(DCPTextTrack()), DCPTimePeriod(from.second, dcp_to));
1246 Player::seek (DCPTime time, bool accurate)
1248 boost::mutex::scoped_lock lm (_mutex);
1249 LOG_DEBUG_PLAYER("Seek to %1 (%2accurate)", to_string(time), accurate ? "" : "in");
1252 /* We can't seek in this state */
1257 _shuffler->clear ();
1262 if (_audio_processor) {
1263 _audio_processor->flush ();
1266 _audio_merger.clear ();
1267 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
1268 _active_texts[i].clear ();
1271 for (auto i: _pieces) {
1272 if (time < i->content->position()) {
1273 /* Before; seek to the start of the content. Even if this request is for an inaccurate seek
1274 we must seek this (following) content accurately, otherwise when we come to the end of the current
1275 content we may not start right at the beginning of the next, causing a gap (if the next content has
1276 been trimmed to a point between keyframes, or something).
1278 i->decoder->seek (dcp_to_content_time (i, i->content->position()), true);
1280 } else if (i->content->position() <= time && time < i->content->end(_film)) {
1281 /* During; seek to position */
1282 i->decoder->seek (dcp_to_content_time (i, time), accurate);
1285 /* After; this piece is done */
1291 _next_video_time = time;
1292 _next_video_eyes = Eyes::LEFT;
1293 _next_audio_time = time;
1295 _next_video_time = boost::none;
1296 _next_video_eyes = boost::none;
1297 _next_audio_time = boost::none;
1300 _black.set_position (time);
1301 _silent.set_position (time);
1303 _last_video.clear ();
1308 Player::emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1310 if (!_film->three_d()) {
1311 if (pv->eyes() == Eyes::LEFT) {
1312 /* Use left-eye images for both eyes... */
1313 pv->set_eyes (Eyes::BOTH);
1314 } else if (pv->eyes() == Eyes::RIGHT) {
1315 /* ...and discard the right */
1320 /* We need a delay to give a little wiggle room to ensure that relevant subtitles arrive at the
1321 player before the video that requires them.
1323 _delay.push_back (make_pair (pv, time));
1325 if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
1326 _next_video_time = time + one_video_frame();
1328 _next_video_eyes = increment_eyes (pv->eyes());
1330 if (_delay.size() < 3) {
1334 auto to_do = _delay.front();
1336 if (_film->three_d() && to_do.first->eyes() == Eyes::BOTH) {
1337 /* Duplicate BOTH to LEFT and RIGHT here so that we can to 3D
1338 * subtitles over 2D content.
1340 auto left = to_do.first->shallow_copy();
1341 left->set_eyes (Eyes::LEFT);
1342 do_emit_video (left, to_do.second);
1343 auto right = to_do.first->shallow_copy();
1344 right->set_eyes (Eyes::RIGHT);
1345 do_emit_video (right, to_do.second);
1347 do_emit_video (to_do.first, to_do.second);
1353 Player::do_emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1355 if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
1356 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
1357 _active_texts[i].clear_before (time);
1361 auto subtitles = open_subtitles_for_frame (time, pv->eyes());
1363 pv->set_text (subtitles.get ());
1371 Player::emit_audio (shared_ptr<AudioBuffers> data, DCPTime time)
1373 /* Log if the assert below is about to fail */
1374 if (_next_audio_time && labs(time.get() - _next_audio_time->get()) > 1) {
1375 _film->log()->log(String::compose("Out-of-sequence emit %1 vs %2", to_string(time), to_string(*_next_audio_time)), LogEntry::TYPE_WARNING);
1378 /* This audio must follow on from the previous, allowing for half a sample (at 48kHz) leeway */
1379 DCPOMATIC_ASSERT (!_next_audio_time || labs(time.get() - _next_audio_time->get()) < 2);
1380 Audio (data, time, _film->audio_frame_rate());
1381 _next_audio_time = time + DCPTime::from_frames (data->frames(), _film->audio_frame_rate());
1386 Player::fill_audio (DCPTimePeriod period)
1388 if (period.from == period.to) {
1392 DCPOMATIC_ASSERT (period.from < period.to);
1394 DCPTime t = period.from;
1395 while (t < period.to) {
1396 DCPTime block = min (DCPTime::from_seconds (0.5), period.to - t);
1397 Frame const samples = block.frames_round(_film->audio_frame_rate());
1399 auto silence = make_shared<AudioBuffers>(_film->audio_channels(), samples);
1400 silence->make_silent ();
1401 emit_audio (silence, t);
1409 Player::one_video_frame () const
1411 return DCPTime::from_frames (1, _film->video_frame_rate ());
1415 pair<shared_ptr<AudioBuffers>, DCPTime>
1416 Player::discard_audio (shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to) const
1418 auto const discard_time = discard_to - time;
1419 auto const discard_frames = discard_time.frames_round(_film->audio_frame_rate());
1420 auto remaining_frames = audio->frames() - discard_frames;
1421 if (remaining_frames <= 0) {
1422 return make_pair(shared_ptr<AudioBuffers>(), DCPTime());
1424 auto cut = make_shared<AudioBuffers>(audio, remaining_frames, discard_frames);
1425 return make_pair(cut, time + discard_time);
1430 Player::set_dcp_decode_reduction (optional<int> reduction)
1432 Change (ChangeType::PENDING, PlayerProperty::DCP_DECODE_REDUCTION, false);
1435 boost::mutex::scoped_lock lm (_mutex);
1437 if (reduction == _dcp_decode_reduction) {
1439 Change (ChangeType::CANCELLED, PlayerProperty::DCP_DECODE_REDUCTION, false);
1443 _dcp_decode_reduction = reduction;
1444 setup_pieces_unlocked ();
1447 Change (ChangeType::DONE, PlayerProperty::DCP_DECODE_REDUCTION, false);
1452 Player::content_time_to_dcp (shared_ptr<const Content> content, ContentTime t)
1454 boost::mutex::scoped_lock lm (_mutex);
1456 for (auto i: _pieces) {
1457 if (i->content == content) {
1458 return content_time_to_dcp (i, t);
1462 /* We couldn't find this content; perhaps things are being changed over */
1467 optional<ContentTime>
1468 Player::dcp_to_content_time (shared_ptr<const Content> content, DCPTime t)
1470 boost::mutex::scoped_lock lm (_mutex);
1472 for (auto i: _pieces) {
1473 if (i->content == content) {
1474 return dcp_to_content_time (i, t);
1478 /* We couldn't find this content; perhaps things are being changed over */
1483 shared_ptr<const Playlist>
1484 Player::playlist () const
1486 return _playlist ? _playlist : _film->playlist();
1491 Player::atmos (weak_ptr<Piece> weak_piece, ContentAtmos data)
1497 auto piece = weak_piece.lock ();
1498 DCPOMATIC_ASSERT (piece);
1500 auto const vfr = _film->video_frame_rate();
1502 DCPTime const dcp_time = DCPTime::from_frames(data.frame, vfr) - DCPTime(piece->content->trim_start(), FrameRateChange(vfr, vfr));
1503 if (dcp_time < piece->content->position() || dcp_time >= (piece->content->end(_film))) {
1507 Atmos (data.data, dcp_time, data.metadata);