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 "render_text.h"
52 #include "text_content.h"
53 #include "text_decoder.h"
55 #include "video_decoder.h"
57 #include <dcp/reel_closed_caption_asset.h>
58 #include <dcp/reel_picture_asset.h>
59 #include <dcp/reel_sound_asset.h>
60 #include <dcp/reel_subtitle_asset.h>
70 using std::dynamic_pointer_cast;
73 using std::make_shared;
77 using std::shared_ptr;
80 using boost::optional;
81 using boost::scoped_ptr;
82 #if BOOST_VERSION >= 106100
83 using namespace boost::placeholders;
85 using namespace dcpomatic;
88 int const PlayerProperty::VIDEO_CONTAINER_SIZE = 700;
89 int const PlayerProperty::PLAYLIST = 701;
90 int const PlayerProperty::FILM_CONTAINER = 702;
91 int const PlayerProperty::FILM_VIDEO_FRAME_RATE = 703;
92 int const PlayerProperty::DCP_DECODE_REDUCTION = 704;
93 int const PlayerProperty::PLAYBACK_LENGTH = 705;
94 int const PlayerProperty::IGNORE_VIDEO = 706;
95 int const PlayerProperty::IGNORE_AUDIO = 707;
96 int const PlayerProperty::IGNORE_TEXT = 708;
97 int const PlayerProperty::ALWAYS_BURN_OPEN_SUBTITLES = 709;
98 int const PlayerProperty::PLAY_REFERENCED = 710;
101 Player::Player (shared_ptr<const Film> film, Image::Alignment subtitle_alignment)
104 , _ignore_video(false)
105 , _ignore_audio(false)
106 , _ignore_text(false)
107 , _always_burn_open_subtitles(false)
109 , _tolerant (film->tolerant())
110 , _play_referenced(false)
111 , _audio_merger(film->audio_frame_rate())
112 , _subtitle_alignment (subtitle_alignment)
118 Player::Player (shared_ptr<const Film> film, shared_ptr<const Playlist> playlist_)
120 , _playlist (playlist_)
122 , _ignore_video(false)
123 , _ignore_audio(false)
124 , _ignore_text(false)
125 , _always_burn_open_subtitles(false)
127 , _tolerant (film->tolerant())
128 , _play_referenced(false)
129 , _audio_merger(film->audio_frame_rate())
138 auto film = _film.lock();
139 DCPOMATIC_ASSERT(film);
142 set_video_container_size(film->frame_size());
144 film_change (ChangeType::DONE, Film::Property::AUDIO_PROCESSOR);
147 seek (DCPTime (), true);
154 auto film = _film.lock();
155 DCPOMATIC_ASSERT(film);
157 _film_changed_connection = film->Change.connect(bind(&Player::film_change, this, _1, _2));
158 /* The butler must hear about this first, so since we are proxying this through to the butler we must
161 _playlist_change_connection = playlist()->Change.connect (bind (&Player::playlist_change, this, _1), boost::signals2::at_front);
162 _playlist_content_change_connection = playlist()->ContentChange.connect (bind(&Player::playlist_content_change, this, _1, _3, _4));
166 Player::Player(Player&& other)
168 , _playlist(std::move(other._playlist))
169 , _suspended(other._suspended.load())
170 , _pieces(std::move(other._pieces))
171 , _video_container_size(other._video_container_size.load())
172 , _black_image(std::move(other._black_image))
173 , _ignore_video(other._ignore_video.load())
174 , _ignore_audio(other._ignore_audio.load())
175 , _ignore_text(other._ignore_text.load())
176 , _always_burn_open_subtitles(other._always_burn_open_subtitles.load())
177 , _fast(other._fast.load())
178 , _tolerant(other._tolerant)
179 , _play_referenced(other._play_referenced.load())
180 , _next_video_time(other._next_video_time)
181 , _next_audio_time(other._next_audio_time)
182 , _dcp_decode_reduction(other._dcp_decode_reduction.load())
183 , _last_video(std::move(other._last_video))
184 , _audio_merger(std::move(other._audio_merger))
185 , _shuffler(std::move(other._shuffler))
186 , _delay(std::move(other._delay))
187 , _stream_states(std::move(other._stream_states))
188 , _black(std::move(other._black))
189 , _silent(std::move(other._silent))
190 , _active_texts(std::move(other._active_texts))
191 , _audio_processor(std::move(other._audio_processor))
192 , _playback_length(other._playback_length.load())
193 , _subtitle_alignment(other._subtitle_alignment)
200 Player::operator=(Player&& other)
202 if (this == &other) {
206 _film = std::move(other._film);
207 _playlist = std::move(other._playlist);
208 _suspended = other._suspended.load();
209 _pieces = std::move(other._pieces);
210 _video_container_size = other._video_container_size.load();
211 _black_image = std::move(other._black_image);
212 _ignore_video = other._ignore_video.load();
213 _ignore_audio = other._ignore_audio.load();
214 _ignore_text = other._ignore_text.load();
215 _always_burn_open_subtitles = other._always_burn_open_subtitles.load();
216 _fast = other._fast.load();
217 _tolerant = other._tolerant;
218 _play_referenced = other._play_referenced.load();
219 _next_video_time = other._next_video_time;
220 _next_audio_time = other._next_audio_time;
221 _dcp_decode_reduction = other._dcp_decode_reduction.load();
222 _last_video = std::move(other._last_video);
223 _audio_merger = std::move(other._audio_merger);
224 _shuffler = std::move(other._shuffler);
225 _delay = std::move(other._delay);
226 _stream_states = std::move(other._stream_states);
227 _black = std::move(other._black);
228 _silent = std::move(other._silent);
229 _active_texts = std::move(other._active_texts);
230 _audio_processor = std::move(other._audio_processor);
231 _playback_length = other._playback_length.load();
232 _subtitle_alignment = other._subtitle_alignment;
241 have_video (shared_ptr<const Content> content)
243 return static_cast<bool>(content->video) && content->video->use() && content->can_be_played();
248 have_audio (shared_ptr<const Content> content)
250 return static_cast<bool>(content->audio) && content->can_be_played();
255 Player::setup_pieces ()
257 boost::mutex::scoped_lock lm (_mutex);
259 auto old_pieces = _pieces;
262 auto film = _film.lock();
267 _playback_length = _playlist ? _playlist->length(film) : film->length();
269 auto playlist_content = playlist()->content();
270 bool const have_threed = std::any_of(
271 playlist_content.begin(),
272 playlist_content.end(),
273 [](shared_ptr<const Content> c) {
274 return c->video && (c->video->frame_type() == VideoFrameType::THREE_D_LEFT || c->video->frame_type() == VideoFrameType::THREE_D_RIGHT);
279 _shuffler.reset(new Shuffler());
280 _shuffler->Video.connect(bind(&Player::video, this, _1, _2));
283 for (auto content: playlist()->content()) {
285 if (!content->paths_valid()) {
289 if (_ignore_video && _ignore_audio && content->text.empty()) {
290 /* We're only interested in text and this content has none */
294 shared_ptr<Decoder> old_decoder;
295 for (auto j: old_pieces) {
296 if (j->content == content) {
297 old_decoder = j->decoder;
302 auto decoder = decoder_factory(film, content, _fast, _tolerant, old_decoder);
303 DCPOMATIC_ASSERT (decoder);
305 FrameRateChange frc(film, content);
307 if (decoder->video && _ignore_video) {
308 decoder->video->set_ignore (true);
311 if (decoder->audio && _ignore_audio) {
312 decoder->audio->set_ignore (true);
316 for (auto i: decoder->text) {
317 i->set_ignore (true);
321 auto dcp = dynamic_pointer_cast<DCPDecoder> (decoder);
323 dcp->set_decode_referenced (_play_referenced);
324 if (_play_referenced) {
325 dcp->set_forced_reduction (_dcp_decode_reduction);
329 auto piece = make_shared<Piece>(content, decoder, frc);
330 _pieces.push_back (piece);
332 if (decoder->video) {
334 /* We need a Shuffler to cope with 3D L/R video data arriving out of sequence */
335 decoder->video->Data.connect (bind(&Shuffler::video, _shuffler.get(), weak_ptr<Piece>(piece), _1));
337 decoder->video->Data.connect (bind(&Player::video, this, weak_ptr<Piece>(piece), _1));
341 if (decoder->audio) {
342 decoder->audio->Data.connect (bind (&Player::audio, this, weak_ptr<Piece> (piece), _1, _2));
345 auto j = decoder->text.begin();
347 while (j != decoder->text.end()) {
348 (*j)->BitmapStart.connect (
349 bind(&Player::bitmap_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
351 (*j)->PlainStart.connect (
352 bind(&Player::plain_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
355 bind(&Player::subtitle_stop, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
361 if (decoder->atmos) {
362 decoder->atmos->Data.connect (bind(&Player::atmos, this, weak_ptr<Piece>(piece), _1));
366 _stream_states.clear ();
367 for (auto i: _pieces) {
368 if (i->content->audio) {
369 for (auto j: i->content->audio->streams()) {
370 _stream_states[j] = StreamState(i);
375 auto ignore_overlap = [](shared_ptr<VideoContent> v) {
376 return v && v->use() && v->frame_type() != VideoFrameType::THREE_D_LEFT && v->frame_type() != VideoFrameType::THREE_D_RIGHT;
379 for (auto piece = _pieces.begin(); piece != _pieces.end(); ++piece) {
380 if (ignore_overlap((*piece)->content->video)) {
381 /* Look for content later in the content list with in-use video that overlaps this */
382 auto const period = (*piece)->content->period(film);
383 for (auto later_piece = std::next(piece); later_piece != _pieces.end(); ++later_piece) {
384 if (ignore_overlap((*later_piece)->content->video)) {
385 if (auto overlap = (*later_piece)->content->period(film).overlap(period)) {
386 (*piece)->ignore_video.push_back(*overlap);
393 for (auto piece = _pieces.begin(); piece != _pieces.end(); ++piece) {
394 if ((*piece)->content->atmos) {
395 /* Look for content later in the content list with ATMOS that overlaps this */
396 auto const period = (*piece)->content->period(film);
397 for (auto later_piece = std::next(piece); later_piece != _pieces.end(); ++later_piece) {
398 if ((*later_piece)->content->atmos) {
399 if (auto overlap = (*later_piece)->content->period(film).overlap(period)) {
400 (*piece)->ignore_atmos.push_back(*overlap);
407 _black = Empty(film, playlist(), bind(&have_video, _1), _playback_length);
408 _silent = Empty(film, playlist(), bind(&have_audio, _1), _playback_length);
410 _next_video_time = boost::none;
411 _next_audio_time = boost::none;
416 Player::playlist_content_change (ChangeType type, int property, bool frequent)
418 auto film = _film.lock();
423 if (property == VideoContentProperty::CROP) {
424 if (type == ChangeType::DONE) {
425 boost::mutex::scoped_lock lm (_mutex);
426 for (auto const& i: _delay) {
427 i.first->reset_metadata(film, _video_container_size);
431 if (type == ChangeType::PENDING) {
432 /* The player content is probably about to change, so we can't carry on
433 until that has happened and we've rebuilt our pieces. Stop pass()
434 and seek() from working until then.
437 } else if (type == ChangeType::DONE) {
438 /* A change in our content has gone through. Re-build our pieces. */
441 } else if (type == ChangeType::CANCELLED) {
446 Change (type, property, frequent);
451 Player::set_video_container_size (dcp::Size s)
453 ChangeSignaller<Player, int> cc(this, PlayerProperty::VIDEO_CONTAINER_SIZE);
455 if (s == _video_container_size) {
460 _video_container_size = s;
463 boost::mutex::scoped_lock lm(_black_image_mutex);
464 _black_image = make_shared<Image>(AV_PIX_FMT_RGB24, _video_container_size, Image::Alignment::PADDED);
465 _black_image->make_black ();
471 Player::playlist_change (ChangeType type)
473 if (type == ChangeType::DONE) {
476 Change (type, PlayerProperty::PLAYLIST, false);
481 Player::film_change (ChangeType type, Film::Property p)
483 /* Here we should notice Film properties that affect our output, and
484 alert listeners that our output now would be different to how it was
485 last time we were run.
488 auto film = _film.lock();
493 if (p == Film::Property::CONTAINER) {
494 Change (type, PlayerProperty::FILM_CONTAINER, false);
495 } else if (p == Film::Property::VIDEO_FRAME_RATE) {
496 /* Pieces contain a FrameRateChange which contains the DCP frame rate,
497 so we need new pieces here.
499 if (type == ChangeType::DONE) {
502 Change (type, PlayerProperty::FILM_VIDEO_FRAME_RATE, false);
503 } else if (p == Film::Property::AUDIO_PROCESSOR) {
504 if (type == ChangeType::DONE && film->audio_processor ()) {
505 boost::mutex::scoped_lock lm (_mutex);
506 _audio_processor = film->audio_processor()->clone(film->audio_frame_rate());
508 } else if (p == Film::Property::AUDIO_CHANNELS) {
509 if (type == ChangeType::DONE) {
510 boost::mutex::scoped_lock lm (_mutex);
511 _audio_merger.clear ();
517 shared_ptr<PlayerVideo>
518 Player::black_player_video_frame (Eyes eyes) const
520 boost::mutex::scoped_lock lm(_black_image_mutex);
522 return std::make_shared<PlayerVideo> (
523 make_shared<const RawImageProxy>(_black_image),
526 _video_container_size,
527 _video_container_size,
530 PresetColourConversion::all().front().conversion,
532 std::weak_ptr<Content>(),
533 boost::optional<dcpomatic::ContentTime>(),
540 Player::dcp_to_content_video (shared_ptr<const Piece> piece, DCPTime t) const
542 auto film = _film.lock();
543 DCPOMATIC_ASSERT(film);
545 auto s = t - piece->content->position ();
546 s = min (piece->content->length_after_trim(film), s);
547 s = max (DCPTime(), s + DCPTime (piece->content->trim_start(), piece->frc));
549 /* It might seem more logical here to convert s to a ContentTime (using the FrameRateChange)
550 then convert that ContentTime to frames at the content's rate. However this fails for
551 situations like content at 29.9978733fps, DCP at 30fps. The accuracy of the Time type is not
552 enough to distinguish between the two with low values of time (e.g. 3200 in Time units).
554 Instead we convert the DCPTime using the DCP video rate then account for any skip/repeat.
556 return s.frames_floor (piece->frc.dcp) / piece->frc.factor ();
561 Player::content_video_to_dcp (shared_ptr<const Piece> piece, Frame f) const
563 /* See comment in dcp_to_content_video */
564 auto const d = DCPTime::from_frames (f * piece->frc.factor(), piece->frc.dcp) - DCPTime(piece->content->trim_start(), piece->frc);
565 return d + piece->content->position();
570 Player::dcp_to_resampled_audio (shared_ptr<const Piece> piece, DCPTime t) const
572 auto film = _film.lock();
573 DCPOMATIC_ASSERT(film);
575 auto s = t - piece->content->position ();
576 s = min (piece->content->length_after_trim(film), s);
577 /* See notes in dcp_to_content_video */
578 return max (DCPTime(), DCPTime(piece->content->trim_start(), piece->frc) + s).frames_floor(film->audio_frame_rate());
583 Player::resampled_audio_to_dcp (shared_ptr<const Piece> piece, Frame f) const
585 auto film = _film.lock();
586 DCPOMATIC_ASSERT(film);
588 /* See comment in dcp_to_content_video */
589 return DCPTime::from_frames(f, film->audio_frame_rate())
590 - DCPTime (piece->content->trim_start(), piece->frc)
591 + piece->content->position();
596 Player::dcp_to_content_time (shared_ptr<const Piece> piece, DCPTime t) const
598 auto film = _film.lock();
599 DCPOMATIC_ASSERT(film);
601 auto s = t - piece->content->position ();
602 s = min (piece->content->length_after_trim(film), s);
603 return max (ContentTime (), ContentTime (s, piece->frc) + piece->content->trim_start());
608 Player::content_time_to_dcp (shared_ptr<const Piece> piece, ContentTime t) const
610 return max (DCPTime(), DCPTime(t - piece->content->trim_start(), piece->frc) + piece->content->position());
614 vector<shared_ptr<Font>>
615 Player::get_subtitle_fonts ()
617 boost::mutex::scoped_lock lm (_mutex);
619 vector<shared_ptr<Font>> fonts;
620 for (auto piece: _pieces) {
621 for (auto text: piece->content->text) {
622 auto text_fonts = text->fonts();
623 copy (text_fonts.begin(), text_fonts.end(), back_inserter(fonts));
631 /** Set this player never to produce any video data */
633 Player::set_ignore_video ()
635 ChangeSignaller<Player, int> cc(this, PlayerProperty::IGNORE_VIDEO);
636 _ignore_video = true;
642 Player::set_ignore_audio ()
644 ChangeSignaller<Player, int> cc(this, PlayerProperty::IGNORE_AUDIO);
645 _ignore_audio = true;
651 Player::set_ignore_text ()
653 ChangeSignaller<Player, int> cc(this, PlayerProperty::IGNORE_TEXT);
659 /** Set the player to always burn open texts into the image regardless of the content settings */
661 Player::set_always_burn_open_subtitles ()
663 ChangeSignaller<Player, int> cc(this, PlayerProperty::ALWAYS_BURN_OPEN_SUBTITLES);
664 _always_burn_open_subtitles = true;
668 /** Sets up the player to be faster, possibly at the expense of quality */
678 Player::set_play_referenced ()
680 ChangeSignaller<Player, int> cc(this, PlayerProperty::PLAY_REFERENCED);
681 _play_referenced = true;
689 boost::mutex::scoped_lock lm (_mutex);
692 /* We can't pass in this state */
693 LOG_DEBUG_PLAYER_NC ("Player is suspended");
697 auto film = _film.lock();
699 if (_playback_length.load() == DCPTime() || !film) {
700 /* Special; just give one black frame */
701 use_video(black_player_video_frame(Eyes::BOTH), DCPTime(), one_video_frame());
705 /* Find the decoder or empty which is farthest behind where we are and make it emit some data */
707 shared_ptr<Piece> earliest_content;
708 optional<DCPTime> earliest_time;
710 for (auto i: _pieces) {
715 auto const t = content_time_to_dcp (i, max(i->decoder->position(), i->content->trim_start()));
716 if (t > i->content->end(film)) {
720 /* Given two choices at the same time, pick the one with texts so we see it before
723 if (!earliest_time || t < *earliest_time || (t == *earliest_time && !i->decoder->text.empty())) {
725 earliest_content = i;
739 if (earliest_content) {
743 if (!_black.done() && !_ignore_video && (!earliest_time || _black.position() < *earliest_time)) {
744 earliest_time = _black.position ();
748 if (!_silent.done() && !_ignore_audio && (!earliest_time || _silent.position() < *earliest_time)) {
749 earliest_time = _silent.position ();
756 LOG_DEBUG_PLAYER ("Calling pass() on %1", earliest_content->content->path(0));
757 earliest_content->done = earliest_content->decoder->pass ();
758 auto dcp = dynamic_pointer_cast<DCPContent>(earliest_content->content);
759 if (dcp && !_play_referenced) {
760 if (dcp->reference_video()) {
761 _next_video_time = dcp->end(film);
763 if (dcp->reference_audio()) {
764 /* We are skipping some referenced DCP audio content, so we need to update _next_audio_time
765 to `hide' the fact that no audio was emitted during the referenced DCP (though
766 we need to behave as though it was).
768 _next_audio_time = dcp->end(film);
774 LOG_DEBUG_PLAYER ("Emit black for gap at %1", to_string(_black.position()));
775 if (film->three_d()) {
776 use_video(black_player_video_frame(Eyes::LEFT), _black.position(), _black.period_at_position().to);
777 use_video(black_player_video_frame(Eyes::RIGHT), _black.position(), _black.period_at_position().to);
779 use_video(black_player_video_frame(Eyes::BOTH), _black.position(), _black.period_at_position().to);
781 _black.set_position (_black.position() + one_video_frame());
785 LOG_DEBUG_PLAYER ("Emit silence for gap at %1", to_string(_silent.position()));
786 DCPTimePeriod period (_silent.period_at_position());
787 if (_next_audio_time) {
788 /* Sometimes the thing that happened last finishes fractionally before
789 or after this silence. Bodge the start time of the silence to fix it.
790 I think this is nothing to worry about since we will just add or
791 remove a little silence at the end of some content.
793 int64_t const error = labs(period.from.get() - _next_audio_time->get());
794 /* Let's not worry about less than a frame at 24fps */
795 int64_t const too_much_error = DCPTime::from_frames(1, 24).get();
796 if (error >= too_much_error) {
797 film->log()->log(String::compose("Silence starting before or after last audio by %1", error), LogEntry::TYPE_ERROR);
799 DCPOMATIC_ASSERT (error < too_much_error);
800 period.from = *_next_audio_time;
802 if (period.duration() > one_video_frame()) {
803 period.to = period.from + one_video_frame();
806 _silent.set_position (period.to);
814 /* Emit any audio that is ready */
816 /* Work out the time before which the audio is definitely all here. This is the earliest last_push_end of one
817 of our streams, or the position of the _silent. First, though we choose only streams that are less than
818 ignore_streams_behind seconds behind the furthest ahead (we assume that if a stream has fallen that far
819 behind it has finished). This is so that we don't withhold audio indefinitely awaiting data from a stream
820 that will never come, causing bugs like #2101.
822 constexpr int ignore_streams_behind = 5;
824 using state_pair = std::pair<AudioStreamPtr, StreamState>;
826 /* Find streams that have pushed */
827 std::vector<state_pair> have_pushed;
828 std::copy_if(_stream_states.begin(), _stream_states.end(), std::back_inserter(have_pushed), [](state_pair const& a) { return static_cast<bool>(a.second.last_push_end); });
830 /* Find the 'leading' stream (i.e. the one that pushed data most recently) */
831 auto latest_last_push_end = std::max_element(
834 [](state_pair const& a, state_pair const& b) { return a.second.last_push_end.get() < b.second.last_push_end.get(); }
837 if (latest_last_push_end != have_pushed.end()) {
838 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.get()));
841 /* Now make a list of those streams that are less than ignore_streams_behind behind the leader */
842 std::map<AudioStreamPtr, StreamState> alive_stream_states;
843 for (auto const& i: _stream_states) {
844 if (!i.second.last_push_end || (latest_last_push_end->second.last_push_end.get() - i.second.last_push_end.get()) < dcpomatic::DCPTime::from_seconds(ignore_streams_behind)) {
845 alive_stream_states.insert(i);
847 LOG_DEBUG_PLAYER("Ignoring stream %1 because it is too far behind", i.second.piece->content->path(0));
851 auto pull_to = _playback_length.load();
852 for (auto const& i: alive_stream_states) {
853 auto position = i.second.last_push_end.get_value_or(i.second.piece->content->position());
854 if (!i.second.piece->done && position < pull_to) {
858 if (!_silent.done() && _silent.position() < pull_to) {
859 pull_to = _silent.position();
862 LOG_DEBUG_PLAYER("Emitting audio up to %1", to_string(pull_to));
863 auto audio = _audio_merger.pull (pull_to);
864 for (auto i = audio.begin(); i != audio.end(); ++i) {
865 if (_next_audio_time && i->second < *_next_audio_time) {
866 /* This new data comes before the last we emitted (or the last seek); discard it */
867 auto cut = discard_audio (i->first, i->second, *_next_audio_time);
872 } else if (_next_audio_time && i->second > *_next_audio_time) {
873 /* There's a gap between this data and the last we emitted; fill with silence */
874 fill_audio (DCPTimePeriod (*_next_audio_time, i->second));
877 emit_audio (i->first, i->second);
881 emit_video_until(film->length());
886 for (auto const& i: _delay) {
887 emit_video(i.first, i.second);
895 /** @return Open subtitles for the frame at the given time, converted to images */
896 optional<PositionImage>
897 Player::open_subtitles_for_frame (DCPTime time) const
899 auto film = _film.lock();
904 list<PositionImage> captions;
905 int const vfr = film->video_frame_rate();
909 _active_texts[TextType::OPEN_SUBTITLE].get_burnt(DCPTimePeriod(time, time + DCPTime::from_frames(1, vfr)), _always_burn_open_subtitles)
912 /* Bitmap subtitles */
913 for (auto i: j.bitmap) {
918 /* i.image will already have been scaled to fit _video_container_size */
919 dcp::Size scaled_size (i.rectangle.width * _video_container_size.load().width, i.rectangle.height * _video_container_size.load().height);
925 lrint(_video_container_size.load().width * i.rectangle.x),
926 lrint(_video_container_size.load().height * i.rectangle.y)
932 /* String subtitles (rendered to an image) */
933 if (!j.string.empty()) {
934 auto s = render_text(j.string, _video_container_size, time, vfr);
935 copy (s.begin(), s.end(), back_inserter (captions));
939 if (captions.empty()) {
943 return merge (captions, _subtitle_alignment);
948 Player::emit_video_until(DCPTime time)
950 auto frame = [this](shared_ptr<PlayerVideo> pv, DCPTime time) {
951 /* We need a delay to give a little wiggle room to ensure that relevant subtitles arrive at the
952 player before the video that requires them.
954 _delay.push_back(make_pair(pv, time));
956 if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
957 _next_video_time = time + one_video_frame();
960 if (_delay.size() < 3) {
964 auto to_do = _delay.front();
966 emit_video(to_do.first, to_do.second);
969 auto const age_threshold = one_video_frame() * 2;
971 while (_next_video_time.get_value_or({}) < time) {
972 auto left = _last_video[Eyes::LEFT];
973 auto right = _last_video[Eyes::RIGHT];
974 auto both = _last_video[Eyes::BOTH];
976 auto const next = _next_video_time.get_value_or({});
981 (!both.first || (left.second >= both.second && right.second >= both.second)) &&
982 (left.second - next) < age_threshold &&
983 (right.second - next) < age_threshold
985 frame(left.first, next);
986 frame(right.first, next);
987 } else if (both.first && (both.second - next) < age_threshold) {
988 frame(both.first, next);
989 LOG_DEBUG_PLAYER("Content %1 selected for DCP %2 (age %3)", to_string(both.second), to_string(next), to_string(both.second - next));
991 auto film = _film.lock();
992 if (film && film->three_d()) {
993 frame(black_player_video_frame(Eyes::LEFT), next);
994 frame(black_player_video_frame(Eyes::RIGHT), next);
996 frame(black_player_video_frame(Eyes::BOTH), next);
998 LOG_DEBUG_PLAYER("Black selected for DCP %1", to_string(next));
1005 Player::video (weak_ptr<Piece> weak_piece, ContentVideo video)
1011 auto piece = weak_piece.lock ();
1016 if (!piece->content->video->use()) {
1020 auto film = _film.lock();
1025 vector<Eyes> eyes_to_emit;
1027 if (!film->three_d()) {
1028 if (video.eyes == Eyes::RIGHT) {
1029 /* 2D film, 3D content: discard right */
1031 } else if (video.eyes == Eyes::LEFT) {
1032 /* 2D film, 3D content: emit left as "both" */
1033 video.eyes = Eyes::BOTH;
1034 eyes_to_emit = { Eyes::BOTH };
1037 if (video.eyes == Eyes::BOTH) {
1038 /* 3D film, 2D content; emit "both" for left and right */
1039 eyes_to_emit = { Eyes::LEFT, Eyes::RIGHT };
1043 if (eyes_to_emit.empty()) {
1044 eyes_to_emit = { video.eyes };
1047 /* Time of the frame we just received within the DCP */
1048 auto const time = content_time_to_dcp(piece, video.time);
1049 LOG_DEBUG_PLAYER("Received video frame %1 %2 eyes %3", to_string(video.time), to_string(time), static_cast<int>(video.eyes));
1051 if (time < piece->content->position()) {
1055 auto ignore_video = std::find_if(
1056 piece->ignore_video.begin(),
1057 piece->ignore_video.end(),
1058 [time](DCPTimePeriod period) { return period.contains(time); }
1060 if (ignore_video != piece->ignore_video.end()) {
1064 if (!_next_video_time) {
1065 _next_video_time = time.round(film->video_frame_rate());
1068 auto const content_video = piece->content->video;
1070 for (auto eyes: eyes_to_emit) {
1072 std::make_shared<PlayerVideo>(
1074 content_video->actual_crop(),
1075 content_video->fade(film, video.time),
1077 content_video->scaled_size(film->frame_size()),
1078 _video_container_size,
1080 content_video->pixel_quanta()
1082 _video_container_size,
1085 content_video->colour_conversion(),
1086 content_video->range(),
1092 piece->content->end(film)
1098 Player::use_video(shared_ptr<PlayerVideo> pv, DCPTime time, DCPTime end)
1100 _last_video[pv->eyes()] = { pv, time };
1101 if (pv->eyes() != Eyes::LEFT) {
1102 emit_video_until(std::min(time + one_video_frame() / 2, end));
1108 Player::audio (weak_ptr<Piece> weak_piece, AudioStreamPtr stream, ContentAudio content_audio)
1114 DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
1116 auto piece = weak_piece.lock ();
1121 auto film = _film.lock();
1126 auto content = piece->content->audio;
1127 DCPOMATIC_ASSERT (content);
1129 int const rfr = content->resampled_frame_rate(film);
1131 /* Compute time in the DCP */
1132 auto time = resampled_audio_to_dcp (piece, content_audio.frame);
1134 /* And the end of this block in the DCP */
1135 auto end = time + DCPTime::from_frames(content_audio.audio->frames(), rfr);
1136 LOG_DEBUG_PLAYER("Received audio frame %1 covering %2 to %3 (%4)", content_audio.frame, to_string(time), to_string(end), piece->content->path(0).filename());
1138 /* Remove anything that comes before the start or after the end of the content */
1139 if (time < piece->content->position()) {
1140 auto cut = discard_audio (content_audio.audio, time, piece->content->position());
1142 /* This audio is entirely discarded */
1145 content_audio.audio = cut.first;
1147 } else if (time > piece->content->end(film)) {
1148 /* Discard it all */
1150 } else if (end > piece->content->end(film)) {
1151 Frame const remaining_frames = DCPTime(piece->content->end(film) - time).frames_round(rfr);
1152 if (remaining_frames == 0) {
1155 content_audio.audio = make_shared<AudioBuffers>(content_audio.audio, remaining_frames, 0);
1158 DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
1162 auto const fade_coeffs = content->fade (stream, content_audio.frame, content_audio.audio->frames(), rfr);
1163 if (content->gain() != 0 || !fade_coeffs.empty()) {
1164 auto gain_buffers = make_shared<AudioBuffers>(content_audio.audio);
1165 if (!fade_coeffs.empty()) {
1166 /* Apply both fade and gain */
1167 DCPOMATIC_ASSERT (fade_coeffs.size() == static_cast<size_t>(gain_buffers->frames()));
1168 auto const channels = gain_buffers->channels();
1169 auto const frames = fade_coeffs.size();
1170 auto data = gain_buffers->data();
1171 auto const gain = db_to_linear (content->gain());
1172 for (auto channel = 0; channel < channels; ++channel) {
1173 for (auto frame = 0U; frame < frames; ++frame) {
1174 data[channel][frame] *= gain * fade_coeffs[frame];
1178 /* Just apply gain */
1179 gain_buffers->apply_gain (content->gain());
1181 content_audio.audio = gain_buffers;
1186 content_audio.audio = remap(content_audio.audio, film->audio_channels(), stream->mapping());
1190 if (_audio_processor) {
1191 content_audio.audio = _audio_processor->run(content_audio.audio, film->audio_channels());
1196 _audio_merger.push (content_audio.audio, time);
1197 DCPOMATIC_ASSERT (_stream_states.find (stream) != _stream_states.end ());
1198 _stream_states[stream].last_push_end = time + DCPTime::from_frames(content_audio.audio->frames(), film->audio_frame_rate());
1203 Player::bitmap_text_start (weak_ptr<Piece> weak_piece, weak_ptr<const TextContent> weak_content, ContentBitmapText subtitle)
1209 auto piece = weak_piece.lock ();
1210 auto content = weak_content.lock ();
1211 if (!piece || !content) {
1216 for (auto& sub: subtitle.subs)
1218 /* Apply content's subtitle offsets */
1219 sub.rectangle.x += content->x_offset ();
1220 sub.rectangle.y += content->y_offset ();
1222 /* Apply a corrective translation to keep the subtitle centred after the scale that is coming up */
1223 sub.rectangle.x -= sub.rectangle.width * ((content->x_scale() - 1) / 2);
1224 sub.rectangle.y -= sub.rectangle.height * ((content->y_scale() - 1) / 2);
1226 /* Apply content's subtitle scale */
1227 sub.rectangle.width *= content->x_scale ();
1228 sub.rectangle.height *= content->y_scale ();
1230 auto image = sub.image;
1232 /* We will scale the subtitle up to fit _video_container_size */
1233 int const width = sub.rectangle.width * _video_container_size.load().width;
1234 int const height = sub.rectangle.height * _video_container_size.load().height;
1235 if (width == 0 || height == 0) {
1239 dcp::Size scaled_size (width, height);
1240 ps.bitmap.push_back (BitmapText(image->scale(scaled_size, dcp::YUVToRGB::REC601, image->pixel_format(), Image::Alignment::PADDED, _fast), sub.rectangle));
1243 DCPTime from(content_time_to_dcp(piece, subtitle.from()));
1244 _active_texts[content->type()].add_from(weak_content, ps, from);
1249 Player::plain_text_start (weak_ptr<Piece> weak_piece, weak_ptr<const TextContent> weak_content, ContentStringText subtitle)
1255 auto piece = weak_piece.lock ();
1256 auto content = weak_content.lock ();
1257 auto film = _film.lock();
1258 if (!piece || !content || !film) {
1263 DCPTime const from (content_time_to_dcp (piece, subtitle.from()));
1265 if (from > piece->content->end(film)) {
1269 for (auto s: subtitle.subs) {
1270 s.set_h_position (s.h_position() + content->x_offset());
1271 s.set_v_position (s.v_position() + content->y_offset());
1272 float const xs = content->x_scale();
1273 float const ys = content->y_scale();
1274 float size = s.size();
1276 /* Adjust size to express the common part of the scaling;
1277 e.g. if xs = ys = 0.5 we scale size by 2.
1279 if (xs > 1e-5 && ys > 1e-5) {
1280 size *= 1 / min (1 / xs, 1 / ys);
1284 /* Then express aspect ratio changes */
1285 if (fabs (1.0 - xs / ys) > dcp::ASPECT_ADJUST_EPSILON) {
1286 s.set_aspect_adjust (xs / ys);
1289 s.set_in (dcp::Time(from.seconds(), 1000));
1290 ps.string.push_back (s);
1293 _active_texts[content->type()].add_from(weak_content, ps, from);
1298 Player::subtitle_stop (weak_ptr<Piece> weak_piece, weak_ptr<const TextContent> weak_content, ContentTime to)
1304 auto content = weak_content.lock ();
1309 if (!_active_texts[content->type()].have(weak_content)) {
1313 auto piece = weak_piece.lock ();
1314 auto film = _film.lock();
1315 if (!piece || !film) {
1319 DCPTime const dcp_to = content_time_to_dcp (piece, to);
1321 if (dcp_to > piece->content->end(film)) {
1325 auto from = _active_texts[content->type()].add_to(weak_content, dcp_to);
1327 bool const always = (content->type() == TextType::OPEN_SUBTITLE && _always_burn_open_subtitles);
1328 if (content->use() && !always && !content->burn()) {
1329 Text (from.first, content->type(), content->dcp_track().get_value_or(DCPTextTrack()), DCPTimePeriod(from.second, dcp_to));
1335 Player::seek (DCPTime time, bool accurate)
1337 boost::mutex::scoped_lock lm (_mutex);
1338 LOG_DEBUG_PLAYER("Seek to %1 (%2accurate)", to_string(time), accurate ? "" : "in");
1341 /* We can't seek in this state */
1345 auto film = _film.lock();
1351 _shuffler->clear ();
1356 if (_audio_processor) {
1357 _audio_processor->flush ();
1360 _audio_merger.clear ();
1361 std::for_each(_active_texts.begin(), _active_texts.end(), [](ActiveText& a) { a.clear(); });
1363 for (auto i: _pieces) {
1364 if (time < i->content->position()) {
1365 /* Before; seek to the start of the content. Even if this request is for an inaccurate seek
1366 we must seek this (following) content accurately, otherwise when we come to the end of the current
1367 content we may not start right at the beginning of the next, causing a gap (if the next content has
1368 been trimmed to a point between keyframes, or something).
1370 i->decoder->seek (dcp_to_content_time (i, i->content->position()), true);
1372 } else if (i->content->position() <= time && time < i->content->end(film)) {
1373 /* During; seek to position */
1374 i->decoder->seek (dcp_to_content_time (i, time), accurate);
1377 /* After; this piece is done */
1383 _next_video_time = time;
1384 _next_audio_time = time;
1386 _next_video_time = boost::none;
1387 _next_audio_time = boost::none;
1390 _black.set_position (time);
1391 _silent.set_position (time);
1393 _last_video[Eyes::LEFT] = {};
1394 _last_video[Eyes::RIGHT] = {};
1395 _last_video[Eyes::BOTH] = {};
1397 for (auto& state: _stream_states) {
1398 state.second.last_push_end = boost::none;
1404 Player::emit_video(shared_ptr<PlayerVideo> pv, DCPTime time)
1406 if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
1407 std::for_each(_active_texts.begin(), _active_texts.end(), [time](ActiveText& a) { a.clear_before(time); });
1410 auto subtitles = open_subtitles_for_frame (time);
1412 pv->set_text (subtitles.get ());
1420 Player::emit_audio (shared_ptr<AudioBuffers> data, DCPTime time)
1422 auto film = _film.lock();
1423 DCPOMATIC_ASSERT(film);
1425 /* Log if the assert below is about to fail */
1426 if (_next_audio_time && labs(time.get() - _next_audio_time->get()) > 1) {
1427 film->log()->log(String::compose("Out-of-sequence emit %1 vs %2", to_string(time), to_string(*_next_audio_time)), LogEntry::TYPE_WARNING);
1430 /* This audio must follow on from the previous, allowing for half a sample (at 48kHz) leeway */
1431 DCPOMATIC_ASSERT (!_next_audio_time || labs(time.get() - _next_audio_time->get()) < 2);
1432 Audio(data, time, film->audio_frame_rate());
1433 _next_audio_time = time + DCPTime::from_frames(data->frames(), film->audio_frame_rate());
1438 Player::fill_audio (DCPTimePeriod period)
1440 auto film = _film.lock();
1441 DCPOMATIC_ASSERT(film);
1443 if (period.from == period.to) {
1447 DCPOMATIC_ASSERT (period.from < period.to);
1449 DCPTime t = period.from;
1450 while (t < period.to) {
1451 DCPTime block = min (DCPTime::from_seconds (0.5), period.to - t);
1452 Frame const samples = block.frames_round(film->audio_frame_rate());
1454 auto silence = make_shared<AudioBuffers>(film->audio_channels(), samples);
1455 silence->make_silent ();
1456 emit_audio (silence, t);
1464 Player::one_video_frame () const
1466 auto film = _film.lock();
1467 DCPOMATIC_ASSERT(film);
1469 return DCPTime::from_frames(1, film->video_frame_rate ());
1473 pair<shared_ptr<AudioBuffers>, DCPTime>
1474 Player::discard_audio (shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to) const
1476 auto film = _film.lock();
1477 DCPOMATIC_ASSERT(film);
1479 auto const discard_time = discard_to - time;
1480 auto const discard_frames = discard_time.frames_round(film->audio_frame_rate());
1481 auto remaining_frames = audio->frames() - discard_frames;
1482 if (remaining_frames <= 0) {
1483 return make_pair(shared_ptr<AudioBuffers>(), DCPTime());
1485 auto cut = make_shared<AudioBuffers>(audio, remaining_frames, discard_frames);
1486 return make_pair(cut, time + discard_time);
1491 Player::set_dcp_decode_reduction (optional<int> reduction)
1493 ChangeSignaller<Player, int> cc(this, PlayerProperty::DCP_DECODE_REDUCTION);
1495 if (reduction == _dcp_decode_reduction.load()) {
1500 _dcp_decode_reduction = reduction;
1506 Player::content_time_to_dcp (shared_ptr<const Content> content, ContentTime t) const
1508 boost::mutex::scoped_lock lm (_mutex);
1510 for (auto i: _pieces) {
1511 if (i->content == content) {
1512 return content_time_to_dcp (i, t);
1516 /* We couldn't find this content; perhaps things are being changed over */
1521 optional<ContentTime>
1522 Player::dcp_to_content_time (shared_ptr<const Content> content, DCPTime t) const
1524 boost::mutex::scoped_lock lm (_mutex);
1526 for (auto i: _pieces) {
1527 if (i->content == content) {
1528 return dcp_to_content_time (i, t);
1532 /* We couldn't find this content; perhaps things are being changed over */
1537 shared_ptr<const Playlist>
1538 Player::playlist () const
1540 auto film = _film.lock();
1545 return _playlist ? _playlist : film->playlist();
1550 Player::atmos (weak_ptr<Piece> weak_piece, ContentAtmos data)
1556 auto film = _film.lock();
1557 DCPOMATIC_ASSERT(film);
1559 auto piece = weak_piece.lock ();
1560 DCPOMATIC_ASSERT (piece);
1562 auto const vfr = film->video_frame_rate();
1564 DCPTime const dcp_time = DCPTime::from_frames(data.frame, vfr) - DCPTime(piece->content->trim_start(), FrameRateChange(vfr, vfr));
1565 if (dcp_time < piece->content->position() || dcp_time >= (piece->content->end(film))) {
1569 auto ignore_atmos = std::find_if(
1570 piece->ignore_atmos.begin(),
1571 piece->ignore_atmos.end(),
1572 [dcp_time](DCPTimePeriod period) { return period.contains(dcp_time); }
1574 if (ignore_atmos != piece->ignore_atmos.end()) {
1578 Atmos (data.data, dcp_time, data.metadata);
1583 Player::signal_change(ChangeType type, int property)
1585 Change(type, property, false);