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, FilmProperty::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 , _disable_audio_processor(other._disable_audio_processor)
193 , _playback_length(other._playback_length.load())
194 , _subtitle_alignment(other._subtitle_alignment)
201 Player::operator=(Player&& other)
203 if (this == &other) {
207 _film = std::move(other._film);
208 _playlist = std::move(other._playlist);
209 _suspended = other._suspended.load();
210 _pieces = std::move(other._pieces);
211 _video_container_size = other._video_container_size.load();
212 _black_image = std::move(other._black_image);
213 _ignore_video = other._ignore_video.load();
214 _ignore_audio = other._ignore_audio.load();
215 _ignore_text = other._ignore_text.load();
216 _always_burn_open_subtitles = other._always_burn_open_subtitles.load();
217 _fast = other._fast.load();
218 _tolerant = other._tolerant;
219 _play_referenced = other._play_referenced.load();
220 _next_video_time = other._next_video_time;
221 _next_audio_time = other._next_audio_time;
222 _dcp_decode_reduction = other._dcp_decode_reduction.load();
223 _last_video = std::move(other._last_video);
224 _audio_merger = std::move(other._audio_merger);
225 _shuffler = std::move(other._shuffler);
226 _delay = std::move(other._delay);
227 _stream_states = std::move(other._stream_states);
228 _black = std::move(other._black);
229 _silent = std::move(other._silent);
230 _active_texts = std::move(other._active_texts);
231 _audio_processor = std::move(other._audio_processor);
232 _disable_audio_processor = other._disable_audio_processor;
233 _playback_length = other._playback_length.load();
234 _subtitle_alignment = other._subtitle_alignment;
243 have_video (shared_ptr<const Content> content)
245 return static_cast<bool>(content->video) && content->video->use() && content->can_be_played();
250 have_audio (shared_ptr<const Content> content)
252 return static_cast<bool>(content->audio) && content->can_be_played();
257 Player::setup_pieces ()
259 boost::mutex::scoped_lock lm (_mutex);
261 auto old_pieces = _pieces;
264 auto film = _film.lock();
269 _playback_length = _playlist ? _playlist->length(film) : film->length();
271 auto playlist_content = playlist()->content();
272 bool const have_threed = std::any_of(
273 playlist_content.begin(),
274 playlist_content.end(),
275 [](shared_ptr<const Content> c) {
276 return c->video && (c->video->frame_type() == VideoFrameType::THREE_D_LEFT || c->video->frame_type() == VideoFrameType::THREE_D_RIGHT);
281 _shuffler.reset(new Shuffler());
282 _shuffler->Video.connect(bind(&Player::video, this, _1, _2));
285 for (auto content: playlist()->content()) {
287 if (!content->paths_valid()) {
291 if (_ignore_video && _ignore_audio && content->text.empty()) {
292 /* We're only interested in text and this content has none */
296 shared_ptr<Decoder> old_decoder;
297 for (auto j: old_pieces) {
298 if (j->content == content) {
299 old_decoder = j->decoder;
304 auto decoder = decoder_factory(film, content, _fast, _tolerant, old_decoder);
305 DCPOMATIC_ASSERT (decoder);
307 FrameRateChange frc(film, content);
309 if (decoder->video && _ignore_video) {
310 decoder->video->set_ignore (true);
313 if (decoder->audio && _ignore_audio) {
314 decoder->audio->set_ignore (true);
318 for (auto i: decoder->text) {
319 i->set_ignore (true);
323 auto dcp = dynamic_pointer_cast<DCPDecoder> (decoder);
325 dcp->set_decode_referenced (_play_referenced);
326 if (_play_referenced) {
327 dcp->set_forced_reduction (_dcp_decode_reduction);
331 auto piece = make_shared<Piece>(content, decoder, frc);
332 _pieces.push_back (piece);
334 if (decoder->video) {
336 /* We need a Shuffler to cope with 3D L/R video data arriving out of sequence */
337 decoder->video->Data.connect (bind(&Shuffler::video, _shuffler.get(), weak_ptr<Piece>(piece), _1));
339 decoder->video->Data.connect (bind(&Player::video, this, weak_ptr<Piece>(piece), _1));
343 if (decoder->audio) {
344 decoder->audio->Data.connect (bind (&Player::audio, this, weak_ptr<Piece> (piece), _1, _2));
347 auto j = decoder->text.begin();
349 while (j != decoder->text.end()) {
350 (*j)->BitmapStart.connect (
351 bind(&Player::bitmap_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
353 (*j)->PlainStart.connect (
354 bind(&Player::plain_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
357 bind(&Player::subtitle_stop, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
363 if (decoder->atmos) {
364 decoder->atmos->Data.connect (bind(&Player::atmos, this, weak_ptr<Piece>(piece), _1));
368 _stream_states.clear ();
369 for (auto i: _pieces) {
370 if (i->content->audio) {
371 for (auto j: i->content->audio->streams()) {
372 _stream_states[j] = StreamState(i);
377 auto ignore_overlap = [](shared_ptr<VideoContent> v) {
378 return v && v->use() && v->frame_type() != VideoFrameType::THREE_D_LEFT && v->frame_type() != VideoFrameType::THREE_D_RIGHT;
381 for (auto piece = _pieces.begin(); piece != _pieces.end(); ++piece) {
382 if (ignore_overlap((*piece)->content->video)) {
383 /* Look for content later in the content list with in-use video that overlaps this */
384 auto const period = (*piece)->content->period(film);
385 for (auto later_piece = std::next(piece); later_piece != _pieces.end(); ++later_piece) {
386 if (ignore_overlap((*later_piece)->content->video)) {
387 if (auto overlap = (*later_piece)->content->period(film).overlap(period)) {
388 (*piece)->ignore_video.push_back(*overlap);
395 for (auto piece = _pieces.begin(); piece != _pieces.end(); ++piece) {
396 if ((*piece)->content->atmos) {
397 /* Look for content later in the content list with ATMOS that overlaps this */
398 auto const period = (*piece)->content->period(film);
399 for (auto later_piece = std::next(piece); later_piece != _pieces.end(); ++later_piece) {
400 if ((*later_piece)->content->atmos) {
401 if (auto overlap = (*later_piece)->content->period(film).overlap(period)) {
402 (*piece)->ignore_atmos.push_back(*overlap);
409 _black = Empty(film, playlist(), bind(&have_video, _1), _playback_length);
410 _silent = Empty(film, playlist(), bind(&have_audio, _1), _playback_length);
412 _next_video_time = boost::none;
413 _next_audio_time = boost::none;
418 Player::playlist_content_change (ChangeType type, int property, bool frequent)
420 auto film = _film.lock();
425 if (property == VideoContentProperty::CROP) {
426 if (type == ChangeType::DONE) {
427 boost::mutex::scoped_lock lm (_mutex);
428 for (auto const& i: _delay) {
429 i.first->reset_metadata(film, _video_container_size);
433 if (type == ChangeType::PENDING) {
434 /* The player content is probably about to change, so we can't carry on
435 until that has happened and we've rebuilt our pieces. Stop pass()
436 and seek() from working until then.
439 } else if (type == ChangeType::DONE) {
440 /* A change in our content has gone through. Re-build our pieces. */
443 } else if (type == ChangeType::CANCELLED) {
448 Change (type, property, frequent);
453 Player::set_video_container_size (dcp::Size s)
455 ChangeSignaller<Player, int> cc(this, PlayerProperty::VIDEO_CONTAINER_SIZE);
457 if (s == _video_container_size) {
462 _video_container_size = s;
465 boost::mutex::scoped_lock lm(_black_image_mutex);
466 _black_image = make_shared<Image>(AV_PIX_FMT_RGB24, _video_container_size, Image::Alignment::PADDED);
467 _black_image->make_black ();
473 Player::playlist_change (ChangeType type)
475 if (type == ChangeType::DONE) {
478 Change (type, PlayerProperty::PLAYLIST, false);
483 Player::film_change(ChangeType type, FilmProperty p)
485 /* Here we should notice Film properties that affect our output, and
486 alert listeners that our output now would be different to how it was
487 last time we were run.
490 auto film = _film.lock();
495 if (p == FilmProperty::CONTAINER) {
496 Change (type, PlayerProperty::FILM_CONTAINER, false);
497 } else if (p == FilmProperty::VIDEO_FRAME_RATE) {
498 /* Pieces contain a FrameRateChange which contains the DCP frame rate,
499 so we need new pieces here.
501 if (type == ChangeType::DONE) {
504 Change (type, PlayerProperty::FILM_VIDEO_FRAME_RATE, false);
505 } else if (p == FilmProperty::AUDIO_PROCESSOR) {
506 if (type == ChangeType::DONE && film->audio_processor ()) {
507 boost::mutex::scoped_lock lm (_mutex);
508 _audio_processor = film->audio_processor()->clone(film->audio_frame_rate());
510 } else if (p == FilmProperty::AUDIO_CHANNELS) {
511 if (type == ChangeType::DONE) {
512 boost::mutex::scoped_lock lm (_mutex);
513 _audio_merger.clear ();
519 shared_ptr<PlayerVideo>
520 Player::black_player_video_frame (Eyes eyes) const
522 boost::mutex::scoped_lock lm(_black_image_mutex);
524 return std::make_shared<PlayerVideo> (
525 make_shared<const RawImageProxy>(_black_image),
528 _video_container_size,
529 _video_container_size,
532 PresetColourConversion::all().front().conversion,
534 std::weak_ptr<Content>(),
535 boost::optional<dcpomatic::ContentTime>(),
542 Player::dcp_to_content_video (shared_ptr<const Piece> piece, DCPTime t) const
544 auto film = _film.lock();
545 DCPOMATIC_ASSERT(film);
547 auto s = t - piece->content->position ();
548 s = min (piece->content->length_after_trim(film), s);
549 s = max (DCPTime(), s + DCPTime (piece->content->trim_start(), piece->frc));
551 /* It might seem more logical here to convert s to a ContentTime (using the FrameRateChange)
552 then convert that ContentTime to frames at the content's rate. However this fails for
553 situations like content at 29.9978733fps, DCP at 30fps. The accuracy of the Time type is not
554 enough to distinguish between the two with low values of time (e.g. 3200 in Time units).
556 Instead we convert the DCPTime using the DCP video rate then account for any skip/repeat.
558 return s.frames_floor (piece->frc.dcp) / piece->frc.factor ();
563 Player::content_video_to_dcp (shared_ptr<const Piece> piece, Frame f) const
565 /* See comment in dcp_to_content_video */
566 auto const d = DCPTime::from_frames (f * piece->frc.factor(), piece->frc.dcp) - DCPTime(piece->content->trim_start(), piece->frc);
567 return d + piece->content->position();
572 Player::dcp_to_resampled_audio (shared_ptr<const Piece> piece, DCPTime t) const
574 auto film = _film.lock();
575 DCPOMATIC_ASSERT(film);
577 auto s = t - piece->content->position ();
578 s = min (piece->content->length_after_trim(film), s);
579 /* See notes in dcp_to_content_video */
580 return max (DCPTime(), DCPTime(piece->content->trim_start(), piece->frc) + s).frames_floor(film->audio_frame_rate());
585 Player::resampled_audio_to_dcp (shared_ptr<const Piece> piece, Frame f) const
587 auto film = _film.lock();
588 DCPOMATIC_ASSERT(film);
590 /* See comment in dcp_to_content_video */
591 return DCPTime::from_frames(f, film->audio_frame_rate())
592 - DCPTime (piece->content->trim_start(), piece->frc)
593 + piece->content->position();
598 Player::dcp_to_content_time (shared_ptr<const Piece> piece, DCPTime t) const
600 auto film = _film.lock();
601 DCPOMATIC_ASSERT(film);
603 auto s = t - piece->content->position ();
604 s = min (piece->content->length_after_trim(film), s);
605 return max (ContentTime (), ContentTime (s, piece->frc) + piece->content->trim_start());
610 Player::content_time_to_dcp (shared_ptr<const Piece> piece, ContentTime t) const
612 return max (DCPTime(), DCPTime(t - piece->content->trim_start(), piece->frc) + piece->content->position());
616 vector<shared_ptr<Font>>
617 Player::get_subtitle_fonts ()
619 boost::mutex::scoped_lock lm (_mutex);
621 vector<shared_ptr<Font>> fonts;
622 for (auto piece: _pieces) {
623 for (auto text: piece->content->text) {
624 auto text_fonts = text->fonts();
625 copy (text_fonts.begin(), text_fonts.end(), back_inserter(fonts));
633 /** Set this player never to produce any video data */
635 Player::set_ignore_video ()
637 ChangeSignaller<Player, int> cc(this, PlayerProperty::IGNORE_VIDEO);
638 _ignore_video = true;
644 Player::set_ignore_audio ()
646 ChangeSignaller<Player, int> cc(this, PlayerProperty::IGNORE_AUDIO);
647 _ignore_audio = true;
653 Player::set_ignore_text ()
655 ChangeSignaller<Player, int> cc(this, PlayerProperty::IGNORE_TEXT);
661 /** Set the player to always burn open texts into the image regardless of the content settings */
663 Player::set_always_burn_open_subtitles ()
665 ChangeSignaller<Player, int> cc(this, PlayerProperty::ALWAYS_BURN_OPEN_SUBTITLES);
666 _always_burn_open_subtitles = true;
670 /** Sets up the player to be faster, possibly at the expense of quality */
680 Player::set_play_referenced ()
682 ChangeSignaller<Player, int> cc(this, PlayerProperty::PLAY_REFERENCED);
683 _play_referenced = true;
691 boost::mutex::scoped_lock lm (_mutex);
694 /* We can't pass in this state */
695 LOG_DEBUG_PLAYER_NC ("Player is suspended");
699 auto film = _film.lock();
701 if (_playback_length.load() == DCPTime() || !film) {
702 /* Special; just give one black frame */
703 use_video(black_player_video_frame(Eyes::BOTH), DCPTime(), one_video_frame());
707 /* Find the decoder or empty which is farthest behind where we are and make it emit some data */
709 shared_ptr<Piece> earliest_content;
710 optional<DCPTime> earliest_time;
712 for (auto i: _pieces) {
717 auto const t = content_time_to_dcp (i, max(i->decoder->position(), i->content->trim_start()));
718 if (t > i->content->end(film)) {
722 /* Given two choices at the same time, pick the one with texts so we see it before
725 if (!earliest_time || t < *earliest_time || (t == *earliest_time && !i->decoder->text.empty())) {
727 earliest_content = i;
741 if (earliest_content) {
745 if (!_black.done() && !_ignore_video && (!earliest_time || _black.position() < *earliest_time)) {
746 earliest_time = _black.position ();
750 if (!_silent.done() && !_ignore_audio && (!earliest_time || _silent.position() < *earliest_time)) {
751 earliest_time = _silent.position ();
758 LOG_DEBUG_PLAYER ("Calling pass() on %1", earliest_content->content->path(0));
759 earliest_content->done = earliest_content->decoder->pass ();
760 auto dcp = dynamic_pointer_cast<DCPContent>(earliest_content->content);
761 if (dcp && !_play_referenced) {
762 if (dcp->reference_video()) {
763 _next_video_time = dcp->end(film);
765 if (dcp->reference_audio()) {
766 /* We are skipping some referenced DCP audio content, so we need to update _next_audio_time
767 to `hide' the fact that no audio was emitted during the referenced DCP (though
768 we need to behave as though it was).
770 _next_audio_time = dcp->end(film);
776 LOG_DEBUG_PLAYER ("Emit black for gap at %1", to_string(_black.position()));
777 if (!_next_video_time) {
778 /* Deciding to emit black has the same effect as getting some video from the content
779 * when we are inaccurately seeking.
781 _next_video_time = _black.position();
783 if (film->three_d()) {
784 use_video(black_player_video_frame(Eyes::LEFT), _black.position(), _black.period_at_position().to);
785 use_video(black_player_video_frame(Eyes::RIGHT), _black.position(), _black.period_at_position().to);
787 use_video(black_player_video_frame(Eyes::BOTH), _black.position(), _black.period_at_position().to);
789 _black.set_position (_black.position() + one_video_frame());
793 LOG_DEBUG_PLAYER ("Emit silence for gap at %1", to_string(_silent.position()));
794 DCPTimePeriod period (_silent.period_at_position());
795 if (_next_audio_time) {
796 /* Sometimes the thing that happened last finishes fractionally before
797 or after this silence. Bodge the start time of the silence to fix it.
798 I think this is nothing to worry about since we will just add or
799 remove a little silence at the end of some content.
801 int64_t const error = labs(period.from.get() - _next_audio_time->get());
802 /* Let's not worry about less than a frame at 24fps */
803 int64_t const too_much_error = DCPTime::from_frames(1, 24).get();
804 if (error >= too_much_error) {
805 film->log()->log(String::compose("Silence starting before or after last audio by %1", error), LogEntry::TYPE_ERROR);
807 DCPOMATIC_ASSERT (error < too_much_error);
808 period.from = *_next_audio_time;
810 if (period.duration() > one_video_frame()) {
811 period.to = period.from + one_video_frame();
814 _silent.set_position (period.to);
822 /* Emit any audio that is ready */
824 /* Work out the time before which the audio is definitely all here. This is the earliest last_push_end of one
825 of our streams, or the position of the _silent. First, though we choose only streams that are less than
826 ignore_streams_behind seconds behind the furthest ahead (we assume that if a stream has fallen that far
827 behind it has finished). This is so that we don't withhold audio indefinitely awaiting data from a stream
828 that will never come, causing bugs like #2101.
830 constexpr int ignore_streams_behind = 5;
832 using state_pair = std::pair<AudioStreamPtr, StreamState>;
834 /* Find streams that have pushed */
835 std::vector<state_pair> have_pushed;
836 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); });
838 /* Find the 'leading' stream (i.e. the one that pushed data most recently) */
839 auto latest_last_push_end = std::max_element(
842 [](state_pair const& a, state_pair const& b) { return a.second.last_push_end.get() < b.second.last_push_end.get(); }
845 std::map<AudioStreamPtr, StreamState> alive_stream_states;
847 if (latest_last_push_end != have_pushed.end()) {
848 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()));
850 /* Now make a list of those streams that are less than ignore_streams_behind behind the leader */
851 for (auto const& i: _stream_states) {
852 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)) {
853 alive_stream_states.insert(i);
855 LOG_DEBUG_PLAYER("Ignoring stream %1 because it is too far behind", i.second.piece->content->path(0));
860 auto pull_to = _playback_length.load();
861 for (auto const& i: alive_stream_states) {
862 auto position = i.second.last_push_end.get_value_or(i.second.piece->content->position());
863 if (!i.second.piece->done && position < pull_to) {
867 if (!_silent.done() && _silent.position() < pull_to) {
868 pull_to = _silent.position();
871 LOG_DEBUG_PLAYER("Emitting audio up to %1", to_string(pull_to));
872 auto audio = _audio_merger.pull (pull_to);
873 for (auto i = audio.begin(); i != audio.end(); ++i) {
874 if (_next_audio_time && i->second < *_next_audio_time) {
875 /* This new data comes before the last we emitted (or the last seek); discard it */
876 auto cut = discard_audio (i->first, i->second, *_next_audio_time);
881 } else if (_next_audio_time && i->second > *_next_audio_time) {
882 /* There's a gap between this data and the last we emitted; fill with silence */
883 fill_audio (DCPTimePeriod (*_next_audio_time, i->second));
886 emit_audio (i->first, i->second);
890 LOG_DEBUG_PLAYER("Done: emit video until end of film at %1", to_string(film->length()));
891 emit_video_until(film->length());
896 for (auto const& i: _delay) {
897 emit_video(i.first, i.second);
905 /** @return Open subtitles for the frame at the given time, converted to images */
906 optional<PositionImage>
907 Player::open_subtitles_for_frame (DCPTime time) const
909 auto film = _film.lock();
914 list<PositionImage> captions;
915 int const vfr = film->video_frame_rate();
919 _active_texts[TextType::OPEN_SUBTITLE].get_burnt(DCPTimePeriod(time, time + DCPTime::from_frames(1, vfr)), _always_burn_open_subtitles)
922 /* Bitmap subtitles */
923 for (auto i: j.bitmap) {
924 if (!i.image || i.image->size().width == 0 || i.image->size().height == 0) {
928 /* i.image will already have been scaled to fit _video_container_size */
929 dcp::Size scaled_size (i.rectangle.width * _video_container_size.load().width, i.rectangle.height * _video_container_size.load().height);
935 lrint(_video_container_size.load().width * i.rectangle.x),
936 lrint(_video_container_size.load().height * i.rectangle.y)
942 /* String subtitles (rendered to an image) */
943 if (!j.string.empty()) {
944 auto s = render_text(j.string, _video_container_size, time, vfr);
945 copy_if(s.begin(), s.end(), back_inserter(captions), [](PositionImage const& image) {
946 return image.image->size().width && image.image->size().height;
952 if (captions.empty()) {
956 return merge (captions, _subtitle_alignment);
961 Player::emit_video_until(DCPTime time)
963 LOG_DEBUG_PLAYER("emit_video_until %1; next video time is %2", to_string(time), to_string(_next_video_time.get_value_or({})));
964 auto frame = [this](shared_ptr<PlayerVideo> pv, DCPTime time) {
965 /* We need a delay to give a little wiggle room to ensure that relevant subtitles arrive at the
966 player before the video that requires them.
968 _delay.push_back(make_pair(pv, time));
970 if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
971 _next_video_time = time + one_video_frame();
974 if (_delay.size() < 3) {
978 auto to_do = _delay.front();
980 emit_video(to_do.first, to_do.second);
983 auto const age_threshold = one_video_frame() * 2;
985 while (_next_video_time.get_value_or({}) < time) {
986 auto left = _last_video[Eyes::LEFT];
987 auto right = _last_video[Eyes::RIGHT];
988 auto both = _last_video[Eyes::BOTH];
990 auto const next = _next_video_time.get_value_or({});
995 (!both.first || (left.second >= both.second && right.second >= both.second)) &&
996 (left.second - next) < age_threshold &&
997 (right.second - next) < age_threshold
999 frame(left.first, next);
1000 frame(right.first, next);
1001 } else if (both.first && (both.second - next) < age_threshold) {
1002 frame(both.first, next);
1003 LOG_DEBUG_PLAYER("Content %1 selected for DCP %2 (age %3)", to_string(both.second), to_string(next), to_string(both.second - next));
1005 auto film = _film.lock();
1006 if (film && film->three_d()) {
1007 frame(black_player_video_frame(Eyes::LEFT), next);
1008 frame(black_player_video_frame(Eyes::RIGHT), next);
1010 frame(black_player_video_frame(Eyes::BOTH), next);
1012 LOG_DEBUG_PLAYER("Black selected for DCP %1", to_string(next));
1019 Player::video (weak_ptr<Piece> weak_piece, ContentVideo video)
1025 auto piece = weak_piece.lock ();
1030 if (!piece->content->video->use()) {
1034 auto film = _film.lock();
1039 vector<Eyes> eyes_to_emit;
1041 if (!film->three_d()) {
1042 if (video.eyes == Eyes::RIGHT) {
1043 /* 2D film, 3D content: discard right */
1045 } else if (video.eyes == Eyes::LEFT) {
1046 /* 2D film, 3D content: emit left as "both" */
1047 video.eyes = Eyes::BOTH;
1048 eyes_to_emit = { Eyes::BOTH };
1051 if (video.eyes == Eyes::BOTH) {
1052 /* 3D film, 2D content; emit "both" for left and right */
1053 eyes_to_emit = { Eyes::LEFT, Eyes::RIGHT };
1057 if (eyes_to_emit.empty()) {
1058 eyes_to_emit = { video.eyes };
1061 /* Time of the frame we just received within the DCP */
1062 auto const time = content_time_to_dcp(piece, video.time);
1063 LOG_DEBUG_PLAYER("Received video frame %1 %2 eyes %3", to_string(video.time), to_string(time), static_cast<int>(video.eyes));
1065 if (time < piece->content->position()) {
1069 auto ignore_video = std::find_if(
1070 piece->ignore_video.begin(),
1071 piece->ignore_video.end(),
1072 [time](DCPTimePeriod period) { return period.contains(time); }
1074 if (ignore_video != piece->ignore_video.end()) {
1078 if (!_next_video_time) {
1079 _next_video_time = time.round(film->video_frame_rate());
1082 auto const content_video = piece->content->video;
1084 auto scaled_size = content_video->scaled_size(film->frame_size());
1085 DCPOMATIC_ASSERT(scaled_size);
1087 for (auto eyes: eyes_to_emit) {
1089 std::make_shared<PlayerVideo>(
1091 content_video->actual_crop(),
1092 content_video->fade(film, video.time),
1095 _video_container_size,
1097 content_video->pixel_quanta()
1099 _video_container_size,
1102 content_video->colour_conversion(),
1103 content_video->range(),
1109 piece->content->end(film)
1115 Player::use_video(shared_ptr<PlayerVideo> pv, DCPTime time, DCPTime end)
1117 _last_video[pv->eyes()] = { pv, time };
1118 if (pv->eyes() != Eyes::LEFT) {
1119 emit_video_until(std::min(time + one_video_frame() / 2, end));
1125 Player::audio (weak_ptr<Piece> weak_piece, AudioStreamPtr stream, ContentAudio content_audio)
1131 DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
1133 auto piece = weak_piece.lock ();
1138 auto film = _film.lock();
1143 auto content = piece->content->audio;
1144 DCPOMATIC_ASSERT (content);
1146 int const rfr = content->resampled_frame_rate(film);
1148 /* Compute time in the DCP */
1149 auto time = resampled_audio_to_dcp (piece, content_audio.frame);
1151 /* And the end of this block in the DCP */
1152 auto end = time + DCPTime::from_frames(content_audio.audio->frames(), rfr);
1153 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());
1155 /* Remove anything that comes before the start or after the end of the content */
1156 if (time < piece->content->position()) {
1157 auto cut = discard_audio (content_audio.audio, time, piece->content->position());
1159 /* This audio is entirely discarded */
1162 content_audio.audio = cut.first;
1164 } else if (time > piece->content->end(film)) {
1165 /* Discard it all */
1167 } else if (end > piece->content->end(film)) {
1168 Frame const remaining_frames = DCPTime(piece->content->end(film) - time).frames_round(rfr);
1169 if (remaining_frames == 0) {
1172 content_audio.audio = make_shared<AudioBuffers>(content_audio.audio, remaining_frames, 0);
1175 DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
1179 auto const fade_coeffs = content->fade (stream, content_audio.frame, content_audio.audio->frames(), rfr);
1180 if (content->gain() != 0 || !fade_coeffs.empty()) {
1181 auto gain_buffers = make_shared<AudioBuffers>(content_audio.audio);
1182 if (!fade_coeffs.empty()) {
1183 /* Apply both fade and gain */
1184 DCPOMATIC_ASSERT (fade_coeffs.size() == static_cast<size_t>(gain_buffers->frames()));
1185 auto const channels = gain_buffers->channels();
1186 auto const frames = fade_coeffs.size();
1187 auto data = gain_buffers->data();
1188 auto const gain = db_to_linear (content->gain());
1189 for (auto channel = 0; channel < channels; ++channel) {
1190 for (auto frame = 0U; frame < frames; ++frame) {
1191 data[channel][frame] *= gain * fade_coeffs[frame];
1195 /* Just apply gain */
1196 gain_buffers->apply_gain (content->gain());
1198 content_audio.audio = gain_buffers;
1203 content_audio.audio = remap(content_audio.audio, film->audio_channels(), stream->mapping());
1207 if (_audio_processor && !_disable_audio_processor) {
1208 content_audio.audio = _audio_processor->run(content_audio.audio, film->audio_channels());
1213 _audio_merger.push (content_audio.audio, time);
1214 DCPOMATIC_ASSERT (_stream_states.find (stream) != _stream_states.end ());
1215 _stream_states[stream].last_push_end = time + DCPTime::from_frames(content_audio.audio->frames(), film->audio_frame_rate());
1220 Player::bitmap_text_start (weak_ptr<Piece> weak_piece, weak_ptr<const TextContent> weak_content, ContentBitmapText subtitle)
1226 auto piece = weak_piece.lock ();
1227 auto content = weak_content.lock ();
1228 if (!piece || !content) {
1233 for (auto& sub: subtitle.subs)
1235 /* Apply content's subtitle offsets */
1236 sub.rectangle.x += content->x_offset ();
1237 sub.rectangle.y += content->y_offset ();
1239 /* Apply a corrective translation to keep the subtitle centred after the scale that is coming up */
1240 sub.rectangle.x -= sub.rectangle.width * ((content->x_scale() - 1) / 2);
1241 sub.rectangle.y -= sub.rectangle.height * ((content->y_scale() - 1) / 2);
1243 /* Apply content's subtitle scale */
1244 sub.rectangle.width *= content->x_scale ();
1245 sub.rectangle.height *= content->y_scale ();
1247 auto image = sub.image;
1249 /* We will scale the subtitle up to fit _video_container_size */
1250 int const width = sub.rectangle.width * _video_container_size.load().width;
1251 int const height = sub.rectangle.height * _video_container_size.load().height;
1252 if (width == 0 || height == 0) {
1256 dcp::Size scaled_size (width, height);
1257 ps.bitmap.push_back (BitmapText(image->scale(scaled_size, dcp::YUVToRGB::REC601, image->pixel_format(), Image::Alignment::PADDED, _fast), sub.rectangle));
1260 DCPTime from(content_time_to_dcp(piece, subtitle.from()));
1261 _active_texts[content->type()].add_from(weak_content, ps, from);
1266 Player::plain_text_start (weak_ptr<Piece> weak_piece, weak_ptr<const TextContent> weak_content, ContentStringText subtitle)
1272 auto piece = weak_piece.lock ();
1273 auto content = weak_content.lock ();
1274 auto film = _film.lock();
1275 if (!piece || !content || !film) {
1280 DCPTime const from (content_time_to_dcp (piece, subtitle.from()));
1282 if (from > piece->content->end(film)) {
1286 for (auto s: subtitle.subs) {
1287 s.set_h_position (s.h_position() + content->x_offset());
1288 s.set_v_position (s.v_position() + content->y_offset());
1289 float const xs = content->x_scale();
1290 float const ys = content->y_scale();
1291 float size = s.size();
1293 /* Adjust size to express the common part of the scaling;
1294 e.g. if xs = ys = 0.5 we scale size by 2.
1296 if (xs > 1e-5 && ys > 1e-5) {
1297 size *= 1 / min (1 / xs, 1 / ys);
1301 /* Then express aspect ratio changes */
1302 if (fabs (1.0 - xs / ys) > dcp::ASPECT_ADJUST_EPSILON) {
1303 s.set_aspect_adjust (xs / ys);
1306 s.set_in (dcp::Time(from.seconds(), 1000));
1307 ps.string.push_back (s);
1310 _active_texts[content->type()].add_from(weak_content, ps, from);
1315 Player::subtitle_stop (weak_ptr<Piece> weak_piece, weak_ptr<const TextContent> weak_content, ContentTime to)
1321 auto content = weak_content.lock ();
1326 if (!_active_texts[content->type()].have(weak_content)) {
1330 auto piece = weak_piece.lock ();
1331 auto film = _film.lock();
1332 if (!piece || !film) {
1336 DCPTime const dcp_to = content_time_to_dcp (piece, to);
1338 if (dcp_to > piece->content->end(film)) {
1342 auto from = _active_texts[content->type()].add_to(weak_content, dcp_to);
1344 bool const always = (content->type() == TextType::OPEN_SUBTITLE && _always_burn_open_subtitles);
1345 if (content->use() && !always && !content->burn()) {
1346 Text (from.first, content->type(), content->dcp_track().get_value_or(DCPTextTrack()), DCPTimePeriod(from.second, dcp_to));
1352 Player::seek (DCPTime time, bool accurate)
1354 boost::mutex::scoped_lock lm (_mutex);
1355 LOG_DEBUG_PLAYER("Seek to %1 (%2accurate)", to_string(time), accurate ? "" : "in");
1358 /* We can't seek in this state */
1362 auto film = _film.lock();
1368 _shuffler->clear ();
1373 if (_audio_processor) {
1374 _audio_processor->flush ();
1377 _audio_merger.clear ();
1378 std::for_each(_active_texts.begin(), _active_texts.end(), [](ActiveText& a) { a.clear(); });
1380 for (auto i: _pieces) {
1381 if (time < i->content->position()) {
1382 /* Before; seek to the start of the content. Even if this request is for an inaccurate seek
1383 we must seek this (following) content accurately, otherwise when we come to the end of the current
1384 content we may not start right at the beginning of the next, causing a gap (if the next content has
1385 been trimmed to a point between keyframes, or something).
1387 i->decoder->seek (dcp_to_content_time (i, i->content->position()), true);
1389 } else if (i->content->position() <= time && time < i->content->end(film)) {
1390 /* During; seek to position */
1391 i->decoder->seek (dcp_to_content_time (i, time), accurate);
1394 /* After; this piece is done */
1400 _next_video_time = time;
1401 _next_audio_time = time;
1403 _next_video_time = boost::none;
1404 _next_audio_time = boost::none;
1407 _black.set_position (time);
1408 _silent.set_position (time);
1410 _last_video[Eyes::LEFT] = {};
1411 _last_video[Eyes::RIGHT] = {};
1412 _last_video[Eyes::BOTH] = {};
1414 for (auto& state: _stream_states) {
1415 state.second.last_push_end = boost::none;
1421 Player::emit_video(shared_ptr<PlayerVideo> pv, DCPTime time)
1423 if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
1424 std::for_each(_active_texts.begin(), _active_texts.end(), [time](ActiveText& a) { a.clear_before(time); });
1427 auto subtitles = open_subtitles_for_frame (time);
1429 pv->set_text (subtitles.get ());
1437 Player::emit_audio (shared_ptr<AudioBuffers> data, DCPTime time)
1439 auto film = _film.lock();
1440 DCPOMATIC_ASSERT(film);
1442 /* Log if the assert below is about to fail */
1443 if (_next_audio_time && labs(time.get() - _next_audio_time->get()) > 1) {
1444 film->log()->log(String::compose("Out-of-sequence emit %1 vs %2", to_string(time), to_string(*_next_audio_time)), LogEntry::TYPE_WARNING);
1447 /* This audio must follow on from the previous, allowing for half a sample (at 48kHz) leeway */
1448 DCPOMATIC_ASSERT (!_next_audio_time || labs(time.get() - _next_audio_time->get()) < 2);
1449 Audio(data, time, film->audio_frame_rate());
1450 _next_audio_time = time + DCPTime::from_frames(data->frames(), film->audio_frame_rate());
1455 Player::fill_audio (DCPTimePeriod period)
1457 auto film = _film.lock();
1458 DCPOMATIC_ASSERT(film);
1460 if (period.from == period.to) {
1464 DCPOMATIC_ASSERT (period.from < period.to);
1466 DCPTime t = period.from;
1467 while (t < period.to) {
1468 DCPTime block = min (DCPTime::from_seconds (0.5), period.to - t);
1469 Frame const samples = block.frames_round(film->audio_frame_rate());
1471 auto silence = make_shared<AudioBuffers>(film->audio_channels(), samples);
1472 silence->make_silent ();
1473 emit_audio (silence, t);
1481 Player::one_video_frame () const
1483 auto film = _film.lock();
1484 DCPOMATIC_ASSERT(film);
1486 return DCPTime::from_frames(1, film->video_frame_rate ());
1490 pair<shared_ptr<AudioBuffers>, DCPTime>
1491 Player::discard_audio (shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to) const
1493 auto film = _film.lock();
1494 DCPOMATIC_ASSERT(film);
1496 auto const discard_time = discard_to - time;
1497 auto const discard_frames = discard_time.frames_round(film->audio_frame_rate());
1498 auto remaining_frames = audio->frames() - discard_frames;
1499 if (remaining_frames <= 0) {
1500 return make_pair(shared_ptr<AudioBuffers>(), DCPTime());
1502 auto cut = make_shared<AudioBuffers>(audio, remaining_frames, discard_frames);
1503 return make_pair(cut, time + discard_time);
1508 Player::set_dcp_decode_reduction (optional<int> reduction)
1510 ChangeSignaller<Player, int> cc(this, PlayerProperty::DCP_DECODE_REDUCTION);
1512 if (reduction == _dcp_decode_reduction.load()) {
1517 _dcp_decode_reduction = reduction;
1523 Player::content_time_to_dcp (shared_ptr<const Content> content, ContentTime t) const
1525 boost::mutex::scoped_lock lm (_mutex);
1527 for (auto i: _pieces) {
1528 if (i->content == content) {
1529 return content_time_to_dcp (i, t);
1533 /* We couldn't find this content; perhaps things are being changed over */
1538 optional<ContentTime>
1539 Player::dcp_to_content_time (shared_ptr<const Content> content, DCPTime t) const
1541 boost::mutex::scoped_lock lm (_mutex);
1543 for (auto i: _pieces) {
1544 if (i->content == content) {
1545 return dcp_to_content_time (i, t);
1549 /* We couldn't find this content; perhaps things are being changed over */
1554 shared_ptr<const Playlist>
1555 Player::playlist () const
1557 auto film = _film.lock();
1562 return _playlist ? _playlist : film->playlist();
1567 Player::atmos (weak_ptr<Piece> weak_piece, ContentAtmos data)
1573 auto film = _film.lock();
1574 DCPOMATIC_ASSERT(film);
1576 auto piece = weak_piece.lock ();
1577 DCPOMATIC_ASSERT (piece);
1579 auto const vfr = film->video_frame_rate();
1581 DCPTime const dcp_time = DCPTime::from_frames(data.frame, vfr) - DCPTime(piece->content->trim_start(), FrameRateChange(vfr, vfr));
1582 if (dcp_time < piece->content->position() || dcp_time >= (piece->content->end(film))) {
1586 auto ignore_atmos = std::find_if(
1587 piece->ignore_atmos.begin(),
1588 piece->ignore_atmos.end(),
1589 [dcp_time](DCPTimePeriod period) { return period.contains(dcp_time); }
1591 if (ignore_atmos != piece->ignore_atmos.end()) {
1595 Atmos (data.data, dcp_time, data.metadata);
1600 Player::signal_change(ChangeType type, int property)
1602 Change(type, property, false);
1606 /** Must be called from the same thread that calls ::pass() */
1608 Player::set_disable_audio_processor()
1610 _disable_audio_processor = true;