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;
74 using std::make_shared;
79 using std::shared_ptr;
82 using boost::optional;
83 using boost::scoped_ptr;
84 #if BOOST_VERSION >= 106100
85 using namespace boost::placeholders;
87 using namespace dcpomatic;
90 int const PlayerProperty::VIDEO_CONTAINER_SIZE = 700;
91 int const PlayerProperty::PLAYLIST = 701;
92 int const PlayerProperty::FILM_CONTAINER = 702;
93 int const PlayerProperty::FILM_VIDEO_FRAME_RATE = 703;
94 int const PlayerProperty::DCP_DECODE_REDUCTION = 704;
95 int const PlayerProperty::PLAYBACK_LENGTH = 705;
96 int const PlayerProperty::IGNORE_VIDEO = 706;
97 int const PlayerProperty::IGNORE_AUDIO = 707;
98 int const PlayerProperty::IGNORE_TEXT = 708;
99 int const PlayerProperty::ALWAYS_BURN_OPEN_SUBTITLES = 709;
100 int const PlayerProperty::PLAY_REFERENCED = 710;
103 Player::Player (shared_ptr<const Film> film, Image::Alignment subtitle_alignment)
106 , _ignore_video(false)
107 , _ignore_audio(false)
108 , _ignore_text(false)
109 , _always_burn_open_subtitles(false)
111 , _tolerant (film->tolerant())
112 , _play_referenced(false)
113 , _audio_merger(film->audio_frame_rate())
114 , _subtitle_alignment (subtitle_alignment)
120 Player::Player (shared_ptr<const Film> film, shared_ptr<const Playlist> playlist_)
122 , _playlist (playlist_)
124 , _ignore_video(false)
125 , _ignore_audio(false)
126 , _ignore_text(false)
127 , _always_burn_open_subtitles(false)
129 , _tolerant (film->tolerant())
130 , _play_referenced(false)
131 , _audio_merger(film->audio_frame_rate())
140 auto film = _film.lock();
141 DCPOMATIC_ASSERT(film);
144 set_video_container_size(film->frame_size());
146 film_change(ChangeType::DONE, FilmProperty::AUDIO_PROCESSOR);
149 seek (DCPTime (), true);
156 auto film = _film.lock();
157 DCPOMATIC_ASSERT(film);
159 _film_changed_connection = film->Change.connect(bind(&Player::film_change, this, _1, _2));
160 /* The butler must hear about this first, so since we are proxying this through to the butler we must
163 _playlist_change_connection = playlist()->Change.connect (bind (&Player::playlist_change, this, _1), boost::signals2::at_front);
164 _playlist_content_change_connection = playlist()->ContentChange.connect (bind(&Player::playlist_content_change, this, _1, _3, _4));
168 Player::Player(Player&& other)
170 , _playlist(std::move(other._playlist))
171 , _suspended(other._suspended.load())
172 , _pieces(std::move(other._pieces))
173 , _video_container_size(other._video_container_size.load())
174 , _black_image(std::move(other._black_image))
175 , _ignore_video(other._ignore_video.load())
176 , _ignore_audio(other._ignore_audio.load())
177 , _ignore_text(other._ignore_text.load())
178 , _always_burn_open_subtitles(other._always_burn_open_subtitles.load())
179 , _fast(other._fast.load())
180 , _tolerant(other._tolerant)
181 , _play_referenced(other._play_referenced.load())
182 , _next_video_time(other._next_video_time)
183 , _next_audio_time(other._next_audio_time)
184 , _dcp_decode_reduction(other._dcp_decode_reduction.load())
185 , _last_video(std::move(other._last_video))
186 , _audio_merger(std::move(other._audio_merger))
187 , _shuffler(std::move(other._shuffler))
188 , _delay(std::move(other._delay))
189 , _stream_states(std::move(other._stream_states))
190 , _black(std::move(other._black))
191 , _silent(std::move(other._silent))
192 , _active_texts(std::move(other._active_texts))
193 , _audio_processor(std::move(other._audio_processor))
194 , _playback_length(other._playback_length.load())
195 , _subtitle_alignment(other._subtitle_alignment)
202 Player::operator=(Player&& other)
204 if (this == &other) {
208 _film = std::move(other._film);
209 _playlist = std::move(other._playlist);
210 _suspended = other._suspended.load();
211 _pieces = std::move(other._pieces);
212 _video_container_size = other._video_container_size.load();
213 _black_image = std::move(other._black_image);
214 _ignore_video = other._ignore_video.load();
215 _ignore_audio = other._ignore_audio.load();
216 _ignore_text = other._ignore_text.load();
217 _always_burn_open_subtitles = other._always_burn_open_subtitles.load();
218 _fast = other._fast.load();
219 _tolerant = other._tolerant;
220 _play_referenced = other._play_referenced.load();
221 _next_video_time = other._next_video_time;
222 _next_audio_time = other._next_audio_time;
223 _dcp_decode_reduction = other._dcp_decode_reduction.load();
224 _last_video = std::move(other._last_video);
225 _audio_merger = std::move(other._audio_merger);
226 _shuffler = std::move(other._shuffler);
227 _delay = std::move(other._delay);
228 _stream_states = std::move(other._stream_states);
229 _black = std::move(other._black);
230 _silent = std::move(other._silent);
231 _active_texts = std::move(other._active_texts);
232 _audio_processor = std::move(other._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_video_eyes = Eyes::BOTH;
414 _next_audio_time = boost::none;
419 Player::playlist_content_change (ChangeType type, int property, bool frequent)
421 auto film = _film.lock();
426 if (property == VideoContentProperty::CROP) {
427 if (type == ChangeType::DONE) {
428 boost::mutex::scoped_lock lm (_mutex);
429 for (auto const& i: _delay) {
430 i.first->reset_metadata(film, _video_container_size);
434 if (type == ChangeType::PENDING) {
435 /* The player content is probably about to change, so we can't carry on
436 until that has happened and we've rebuilt our pieces. Stop pass()
437 and seek() from working until then.
440 } else if (type == ChangeType::DONE) {
441 /* A change in our content has gone through. Re-build our pieces. */
444 } else if (type == ChangeType::CANCELLED) {
449 Change (type, property, frequent);
454 Player::set_video_container_size (dcp::Size s)
456 ChangeSignaller<Player, int> cc(this, PlayerProperty::VIDEO_CONTAINER_SIZE);
458 if (s == _video_container_size) {
463 _video_container_size = s;
466 boost::mutex::scoped_lock lm(_black_image_mutex);
467 _black_image = make_shared<Image>(AV_PIX_FMT_RGB24, _video_container_size, Image::Alignment::PADDED);
468 _black_image->make_black ();
474 Player::playlist_change (ChangeType type)
476 if (type == ChangeType::DONE) {
479 Change (type, PlayerProperty::PLAYLIST, false);
484 Player::film_change(ChangeType type, FilmProperty p)
486 /* Here we should notice Film properties that affect our output, and
487 alert listeners that our output now would be different to how it was
488 last time we were run.
491 auto film = _film.lock();
496 if (p == FilmProperty::CONTAINER) {
497 Change (type, PlayerProperty::FILM_CONTAINER, false);
498 } else if (p == FilmProperty::VIDEO_FRAME_RATE) {
499 /* Pieces contain a FrameRateChange which contains the DCP frame rate,
500 so we need new pieces here.
502 if (type == ChangeType::DONE) {
505 Change (type, PlayerProperty::FILM_VIDEO_FRAME_RATE, false);
506 } else if (p == FilmProperty::AUDIO_PROCESSOR) {
507 if (type == ChangeType::DONE && film->audio_processor ()) {
508 boost::mutex::scoped_lock lm (_mutex);
509 _audio_processor = film->audio_processor()->clone(film->audio_frame_rate());
511 } else if (p == FilmProperty::AUDIO_CHANNELS) {
512 if (type == ChangeType::DONE) {
513 boost::mutex::scoped_lock lm (_mutex);
514 _audio_merger.clear ();
520 shared_ptr<PlayerVideo>
521 Player::black_player_video_frame (Eyes eyes) const
523 boost::mutex::scoped_lock lm(_black_image_mutex);
525 return std::make_shared<PlayerVideo> (
526 std::make_shared<const RawImageProxy>(_black_image),
529 _video_container_size,
530 _video_container_size,
533 PresetColourConversion::all().front().conversion,
535 std::weak_ptr<Content>(),
536 boost::optional<Frame>(),
543 Player::dcp_to_content_video (shared_ptr<const Piece> piece, DCPTime t) const
545 auto film = _film.lock();
546 DCPOMATIC_ASSERT(film);
548 auto s = t - piece->content->position ();
549 s = min (piece->content->length_after_trim(film), s);
550 s = max (DCPTime(), s + DCPTime (piece->content->trim_start(), piece->frc));
552 /* It might seem more logical here to convert s to a ContentTime (using the FrameRateChange)
553 then convert that ContentTime to frames at the content's rate. However this fails for
554 situations like content at 29.9978733fps, DCP at 30fps. The accuracy of the Time type is not
555 enough to distinguish between the two with low values of time (e.g. 3200 in Time units).
557 Instead we convert the DCPTime using the DCP video rate then account for any skip/repeat.
559 return s.frames_floor (piece->frc.dcp) / piece->frc.factor ();
564 Player::content_video_to_dcp (shared_ptr<const Piece> piece, Frame f) const
566 /* See comment in dcp_to_content_video */
567 auto const d = DCPTime::from_frames (f * piece->frc.factor(), piece->frc.dcp) - DCPTime(piece->content->trim_start(), piece->frc);
568 return d + piece->content->position();
573 Player::dcp_to_resampled_audio (shared_ptr<const Piece> piece, DCPTime t) const
575 auto film = _film.lock();
576 DCPOMATIC_ASSERT(film);
578 auto s = t - piece->content->position ();
579 s = min (piece->content->length_after_trim(film), s);
580 /* See notes in dcp_to_content_video */
581 return max (DCPTime(), DCPTime(piece->content->trim_start(), piece->frc) + s).frames_floor(film->audio_frame_rate());
586 Player::resampled_audio_to_dcp (shared_ptr<const Piece> piece, Frame f) const
588 auto film = _film.lock();
589 DCPOMATIC_ASSERT(film);
591 /* See comment in dcp_to_content_video */
592 return DCPTime::from_frames(f, film->audio_frame_rate())
593 - DCPTime (piece->content->trim_start(), piece->frc)
594 + piece->content->position();
599 Player::dcp_to_content_time (shared_ptr<const Piece> piece, DCPTime t) const
601 auto film = _film.lock();
602 DCPOMATIC_ASSERT(film);
604 auto s = t - piece->content->position ();
605 s = min (piece->content->length_after_trim(film), s);
606 return max (ContentTime (), ContentTime (s, piece->frc) + piece->content->trim_start());
611 Player::content_time_to_dcp (shared_ptr<const Piece> piece, ContentTime t) const
613 return max (DCPTime(), DCPTime(t - piece->content->trim_start(), piece->frc) + piece->content->position());
617 vector<shared_ptr<Font>>
618 Player::get_subtitle_fonts ()
620 boost::mutex::scoped_lock lm (_mutex);
622 vector<shared_ptr<Font>> fonts;
623 for (auto piece: _pieces) {
624 for (auto text: piece->content->text) {
625 auto text_fonts = text->fonts();
626 copy (text_fonts.begin(), text_fonts.end(), back_inserter(fonts));
634 /** Set this player never to produce any video data */
636 Player::set_ignore_video ()
638 ChangeSignaller<Player, int> cc(this, PlayerProperty::IGNORE_VIDEO);
639 _ignore_video = true;
645 Player::set_ignore_audio ()
647 ChangeSignaller<Player, int> cc(this, PlayerProperty::IGNORE_AUDIO);
648 _ignore_audio = true;
654 Player::set_ignore_text ()
656 ChangeSignaller<Player, int> cc(this, PlayerProperty::IGNORE_TEXT);
662 /** Set the player to always burn open texts into the image regardless of the content settings */
664 Player::set_always_burn_open_subtitles ()
666 ChangeSignaller<Player, int> cc(this, PlayerProperty::ALWAYS_BURN_OPEN_SUBTITLES);
667 _always_burn_open_subtitles = true;
671 /** Sets up the player to be faster, possibly at the expense of quality */
681 Player::set_play_referenced ()
683 ChangeSignaller<Player, int> cc(this, PlayerProperty::PLAY_REFERENCED);
684 _play_referenced = true;
692 boost::mutex::scoped_lock lm (_mutex);
695 /* We can't pass in this state */
696 LOG_DEBUG_PLAYER_NC ("Player is suspended");
700 auto film = _film.lock();
702 if (_playback_length.load() == DCPTime() || !film) {
703 /* Special; just give one black frame */
704 emit_video (black_player_video_frame(Eyes::BOTH), DCPTime());
708 /* Find the decoder or empty which is farthest behind where we are and make it emit some data */
710 shared_ptr<Piece> earliest_content;
711 optional<DCPTime> earliest_time;
713 for (auto i: _pieces) {
718 auto const t = content_time_to_dcp (i, max(i->decoder->position(), i->content->trim_start()));
719 if (t > i->content->end(film)) {
723 /* Given two choices at the same time, pick the one with texts so we see it before
726 if (!earliest_time || t < *earliest_time || (t == *earliest_time && !i->decoder->text.empty())) {
728 earliest_content = i;
742 if (earliest_content) {
746 if (!_black.done() && !_ignore_video && (!earliest_time || _black.position() < *earliest_time)) {
747 earliest_time = _black.position ();
751 if (!_silent.done() && !_ignore_audio && (!earliest_time || _silent.position() < *earliest_time)) {
752 earliest_time = _silent.position ();
759 LOG_DEBUG_PLAYER ("Calling pass() on %1", earliest_content->content->path(0));
760 earliest_content->done = earliest_content->decoder->pass ();
761 auto dcp = dynamic_pointer_cast<DCPContent>(earliest_content->content);
762 if (dcp && !_play_referenced && dcp->reference_audio()) {
763 /* We are skipping some referenced DCP audio content, so we need to update _next_audio_time
764 to `hide' the fact that no audio was emitted during the referenced DCP (though
765 we need to behave as though it was).
767 _next_audio_time = dcp->end(film);
772 LOG_DEBUG_PLAYER ("Emit black for gap at %1", to_string(_black.position()));
773 if (film->three_d()) {
774 emit_video(black_player_video_frame(Eyes::LEFT), _black.position());
775 emit_video(black_player_video_frame(Eyes::RIGHT), _black.position());
777 emit_video(black_player_video_frame(Eyes::BOTH), _black.position());
779 _black.set_position (_black.position() + one_video_frame());
783 LOG_DEBUG_PLAYER ("Emit silence for gap at %1", to_string(_silent.position()));
784 DCPTimePeriod period (_silent.period_at_position());
785 if (_next_audio_time) {
786 /* Sometimes the thing that happened last finishes fractionally before
787 or after this silence. Bodge the start time of the silence to fix it.
788 I think this is nothing to worry about since we will just add or
789 remove a little silence at the end of some content.
791 int64_t const error = labs(period.from.get() - _next_audio_time->get());
792 /* Let's not worry about less than a frame at 24fps */
793 int64_t const too_much_error = DCPTime::from_frames(1, 24).get();
794 if (error >= too_much_error) {
795 film->log()->log(String::compose("Silence starting before or after last audio by %1", error), LogEntry::TYPE_ERROR);
797 DCPOMATIC_ASSERT (error < too_much_error);
798 period.from = *_next_audio_time;
800 if (period.duration() > one_video_frame()) {
801 period.to = period.from + one_video_frame();
804 _silent.set_position (period.to);
812 /* Emit any audio that is ready */
814 /* Work out the time before which the audio is definitely all here. This is the earliest last_push_end of one
815 of our streams, or the position of the _silent. First, though we choose only streams that are less than
816 ignore_streams_behind seconds behind the furthest ahead (we assume that if a stream has fallen that far
817 behind it has finished). This is so that we don't withhold audio indefinitely awaiting data from a stream
818 that will never come, causing bugs like #2101.
820 constexpr int ignore_streams_behind = 5;
822 using state_pair = std::pair<AudioStreamPtr, StreamState>;
824 /* Find streams that have pushed */
825 std::vector<state_pair> have_pushed;
826 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); });
828 /* Find the 'leading' stream (i.e. the one that pushed data most recently) */
829 auto latest_last_push_end = std::max_element(
832 [](state_pair const& a, state_pair const& b) { return a.second.last_push_end.get() < b.second.last_push_end.get(); }
835 std::map<AudioStreamPtr, StreamState> alive_stream_states;
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()));
840 /* Now make a list of those streams that are less than ignore_streams_behind behind the leader */
841 for (auto const& i: _stream_states) {
842 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)) {
843 alive_stream_states.insert(i);
845 LOG_DEBUG_PLAYER("Ignoring stream %1 because it is too far behind", i.second.piece->content->path(0));
850 auto pull_to = _playback_length.load();
851 for (auto const& i: alive_stream_states) {
852 auto position = i.second.last_push_end.get_value_or(i.second.piece->content->position());
853 if (!i.second.piece->done && position < pull_to) {
857 if (!_silent.done() && _silent.position() < pull_to) {
858 pull_to = _silent.position();
861 LOG_DEBUG_PLAYER("Emitting audio up to %1", to_string(pull_to));
862 auto audio = _audio_merger.pull (pull_to);
863 for (auto i = audio.begin(); i != audio.end(); ++i) {
864 if (_next_audio_time && i->second < *_next_audio_time) {
865 /* This new data comes before the last we emitted (or the last seek); discard it */
866 auto cut = discard_audio (i->first, i->second, *_next_audio_time);
871 } else if (_next_audio_time && i->second > *_next_audio_time) {
872 /* There's a gap between this data and the last we emitted; fill with silence */
873 fill_audio (DCPTimePeriod (*_next_audio_time, i->second));
876 emit_audio (i->first, i->second);
883 for (auto const& i: _delay) {
884 do_emit_video(i.first, i.second);
887 /* Perhaps we should have Empty entries for both eyes in the 3D case (somehow).
888 * However, if we have L and R video files, and one is shorter than the other,
889 * the fill code in ::video mostly takes care of filling in the gaps.
890 * However, since it fills at the point when it knows there is more video coming
891 * at time t (so it should fill any gap up to t) it can't do anything right at the
892 * end. This is particularly bad news if the last frame emitted is a LEFT
893 * eye, as the MXF writer will complain about the 3D sequence being wrong.
894 * Here's a hack to workaround that particular case.
896 if (_next_video_eyes && _next_video_time && *_next_video_eyes == Eyes::RIGHT) {
897 do_emit_video (black_player_video_frame(Eyes::RIGHT), *_next_video_time);
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) {
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 (s.begin(), s.end(), back_inserter (captions));
949 if (captions.empty()) {
953 return merge (captions, _subtitle_alignment);
959 increment_eyes (Eyes e)
961 if (e == Eyes::LEFT) {
970 Player::video (weak_ptr<Piece> weak_piece, ContentVideo video)
976 auto piece = weak_piece.lock ();
981 if (!piece->content->video->use()) {
985 auto film = _film.lock();
990 FrameRateChange frc(film, piece->content);
991 if (frc.skip && (video.frame % 2) == 1) {
995 vector<Eyes> eyes_to_emit;
997 if (!film->three_d()) {
998 if (video.eyes == Eyes::RIGHT) {
999 /* 2D film, 3D content: discard right */
1001 } else if (video.eyes == Eyes::LEFT) {
1002 /* 2D film, 3D content: emit left as "both" */
1003 video.eyes = Eyes::BOTH;
1004 eyes_to_emit = { Eyes::BOTH };
1007 if (video.eyes == Eyes::BOTH) {
1008 /* 3D film, 2D content; emit "both" for left and right */
1009 eyes_to_emit = { Eyes::LEFT, Eyes::RIGHT };
1013 if (eyes_to_emit.empty()) {
1014 eyes_to_emit = { video.eyes };
1017 /* Time of the first frame we will emit */
1018 DCPTime const time = content_video_to_dcp (piece, video.frame);
1019 LOG_DEBUG_PLAYER("Received video frame %1 at %2", video.frame, to_string(time));
1021 /* Discard if it's before the content's period or the last accurate seek. We can't discard
1022 if it's after the content's period here as in that case we still need to fill any gap between
1023 `now' and the end of the content's period.
1025 if (time < piece->content->position() || (_next_video_time && time < *_next_video_time)) {
1029 auto ignore_video = std::find_if(
1030 piece->ignore_video.begin(),
1031 piece->ignore_video.end(),
1032 [time](DCPTimePeriod period) { return period.contains(time); }
1034 if (ignore_video != piece->ignore_video.end()) {
1038 /* Fill gaps that we discover now that we have some video which needs to be emitted.
1039 This is where we need to fill to.
1041 DCPTime fill_to = min(time, piece->content->end(film));
1043 if (_next_video_time) {
1044 DCPTime fill_from = max (*_next_video_time, piece->content->position());
1046 /* Fill if we have more than half a frame to do */
1047 if ((fill_to - fill_from) > one_video_frame() / 2) {
1048 auto last = _last_video.find (weak_piece);
1049 if (film->three_d()) {
1050 auto fill_to_eyes = eyes_to_emit[0];
1051 if (fill_to_eyes == Eyes::BOTH) {
1052 fill_to_eyes = Eyes::LEFT;
1054 if (fill_to == piece->content->end(film)) {
1055 /* Don't fill after the end of the content */
1056 fill_to_eyes = Eyes::LEFT;
1059 auto eyes = _next_video_eyes.get_value_or(Eyes::LEFT);
1060 if (eyes == Eyes::BOTH) {
1063 while (j < fill_to || eyes != fill_to_eyes) {
1064 if (last != _last_video.end()) {
1065 LOG_DEBUG_PLAYER("Fill using last video at %1 in 3D mode", to_string(j));
1066 auto copy = last->second->shallow_copy();
1067 copy->set_eyes (eyes);
1068 emit_video (copy, j);
1070 LOG_DEBUG_PLAYER("Fill using black at %1 in 3D mode", to_string(j));
1071 emit_video (black_player_video_frame(eyes), j);
1073 if (eyes == Eyes::RIGHT) {
1074 j += one_video_frame();
1076 eyes = increment_eyes (eyes);
1079 for (DCPTime j = fill_from; j < fill_to; j += one_video_frame()) {
1080 if (last != _last_video.end()) {
1081 emit_video (last->second, j);
1083 emit_video (black_player_video_frame(Eyes::BOTH), j);
1090 auto const content_video = piece->content->video;
1092 for (auto eyes: eyes_to_emit) {
1093 _last_video[weak_piece] = std::make_shared<PlayerVideo>(
1095 content_video->actual_crop(),
1096 content_video->fade(film, video.frame),
1098 content_video->scaled_size(film->frame_size()),
1099 _video_container_size,
1101 content_video->pixel_quanta()
1103 _video_container_size,
1106 content_video->colour_conversion(),
1107 content_video->range(),
1114 for (int i = 0; i < frc.repeat; ++i) {
1115 if (t < piece->content->end(film)) {
1116 emit_video (_last_video[weak_piece], t);
1118 t += one_video_frame ();
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) {
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_video_eyes = Eyes::LEFT;
1402 _next_audio_time = time;
1404 _next_video_time = boost::none;
1405 _next_video_eyes = boost::none;
1406 _next_audio_time = boost::none;
1409 _black.set_position (time);
1410 _silent.set_position (time);
1412 _last_video.clear ();
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 auto film = _film.lock();
1424 DCPOMATIC_ASSERT(film);
1426 /* We need a delay to give a little wiggle room to ensure that relevant subtitles arrive at the
1427 player before the video that requires them.
1429 _delay.push_back (make_pair (pv, time));
1431 if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
1432 _next_video_time = time + one_video_frame();
1434 _next_video_eyes = increment_eyes (pv->eyes());
1436 if (_delay.size() < 3) {
1440 auto to_do = _delay.front();
1442 do_emit_video (to_do.first, to_do.second);
1447 Player::do_emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1449 if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
1450 std::for_each(_active_texts.begin(), _active_texts.end(), [time](ActiveText& a) { a.clear_before(time); });
1453 auto subtitles = open_subtitles_for_frame (time);
1455 pv->set_text (subtitles.get ());
1463 Player::emit_audio (shared_ptr<AudioBuffers> data, DCPTime time)
1465 auto film = _film.lock();
1466 DCPOMATIC_ASSERT(film);
1468 /* Log if the assert below is about to fail */
1469 if (_next_audio_time && labs(time.get() - _next_audio_time->get()) > 1) {
1470 film->log()->log(String::compose("Out-of-sequence emit %1 vs %2", to_string(time), to_string(*_next_audio_time)), LogEntry::TYPE_WARNING);
1473 /* This audio must follow on from the previous, allowing for half a sample (at 48kHz) leeway */
1474 DCPOMATIC_ASSERT (!_next_audio_time || labs(time.get() - _next_audio_time->get()) < 2);
1475 Audio(data, time, film->audio_frame_rate());
1476 _next_audio_time = time + DCPTime::from_frames(data->frames(), film->audio_frame_rate());
1481 Player::fill_audio (DCPTimePeriod period)
1483 auto film = _film.lock();
1484 DCPOMATIC_ASSERT(film);
1486 if (period.from == period.to) {
1490 DCPOMATIC_ASSERT (period.from < period.to);
1492 DCPTime t = period.from;
1493 while (t < period.to) {
1494 DCPTime block = min (DCPTime::from_seconds (0.5), period.to - t);
1495 Frame const samples = block.frames_round(film->audio_frame_rate());
1497 auto silence = make_shared<AudioBuffers>(film->audio_channels(), samples);
1498 silence->make_silent ();
1499 emit_audio (silence, t);
1507 Player::one_video_frame () const
1509 auto film = _film.lock();
1510 DCPOMATIC_ASSERT(film);
1512 return DCPTime::from_frames(1, film->video_frame_rate ());
1516 pair<shared_ptr<AudioBuffers>, DCPTime>
1517 Player::discard_audio (shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to) const
1519 auto film = _film.lock();
1520 DCPOMATIC_ASSERT(film);
1522 auto const discard_time = discard_to - time;
1523 auto const discard_frames = discard_time.frames_round(film->audio_frame_rate());
1524 auto remaining_frames = audio->frames() - discard_frames;
1525 if (remaining_frames <= 0) {
1526 return make_pair(shared_ptr<AudioBuffers>(), DCPTime());
1528 auto cut = make_shared<AudioBuffers>(audio, remaining_frames, discard_frames);
1529 return make_pair(cut, time + discard_time);
1534 Player::set_dcp_decode_reduction (optional<int> reduction)
1536 ChangeSignaller<Player, int> cc(this, PlayerProperty::DCP_DECODE_REDUCTION);
1538 if (reduction == _dcp_decode_reduction.load()) {
1543 _dcp_decode_reduction = reduction;
1549 Player::content_time_to_dcp (shared_ptr<const Content> content, ContentTime t) const
1551 boost::mutex::scoped_lock lm (_mutex);
1553 for (auto i: _pieces) {
1554 if (i->content == content) {
1555 return content_time_to_dcp (i, t);
1559 /* We couldn't find this content; perhaps things are being changed over */
1564 optional<ContentTime>
1565 Player::dcp_to_content_time (shared_ptr<const Content> content, DCPTime t) const
1567 boost::mutex::scoped_lock lm (_mutex);
1569 for (auto i: _pieces) {
1570 if (i->content == content) {
1571 return dcp_to_content_time (i, t);
1575 /* We couldn't find this content; perhaps things are being changed over */
1580 shared_ptr<const Playlist>
1581 Player::playlist () const
1583 auto film = _film.lock();
1588 return _playlist ? _playlist : film->playlist();
1593 Player::atmos (weak_ptr<Piece> weak_piece, ContentAtmos data)
1599 auto film = _film.lock();
1600 DCPOMATIC_ASSERT(film);
1602 auto piece = weak_piece.lock ();
1603 DCPOMATIC_ASSERT (piece);
1605 auto const vfr = film->video_frame_rate();
1607 DCPTime const dcp_time = DCPTime::from_frames(data.frame, vfr) - DCPTime(piece->content->trim_start(), FrameRateChange(vfr, vfr));
1608 if (dcp_time < piece->content->position() || dcp_time >= (piece->content->end(film))) {
1612 auto ignore_atmos = std::find_if(
1613 piece->ignore_atmos.begin(),
1614 piece->ignore_atmos.end(),
1615 [dcp_time](DCPTimePeriod period) { return period.contains(dcp_time); }
1617 if (ignore_atmos != piece->ignore_atmos.end()) {
1621 Atmos (data.data, dcp_time, data.metadata);
1626 Player::signal_change(ChangeType type, int property)
1628 Change(type, property, false);