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 , _disable_audio_processor(other._disable_audio_processor)
195 , _playback_length(other._playback_length.load())
196 , _subtitle_alignment(other._subtitle_alignment)
203 Player::operator=(Player&& other)
205 if (this == &other) {
209 _film = std::move(other._film);
210 _playlist = std::move(other._playlist);
211 _suspended = other._suspended.load();
212 _pieces = std::move(other._pieces);
213 _video_container_size = other._video_container_size.load();
214 _black_image = std::move(other._black_image);
215 _ignore_video = other._ignore_video.load();
216 _ignore_audio = other._ignore_audio.load();
217 _ignore_text = other._ignore_text.load();
218 _always_burn_open_subtitles = other._always_burn_open_subtitles.load();
219 _fast = other._fast.load();
220 _tolerant = other._tolerant;
221 _play_referenced = other._play_referenced.load();
222 _next_video_time = other._next_video_time;
223 _next_audio_time = other._next_audio_time;
224 _dcp_decode_reduction = other._dcp_decode_reduction.load();
225 _last_video = std::move(other._last_video);
226 _audio_merger = std::move(other._audio_merger);
227 _shuffler = std::move(other._shuffler);
228 _delay = std::move(other._delay);
229 _stream_states = std::move(other._stream_states);
230 _black = std::move(other._black);
231 _silent = std::move(other._silent);
232 _active_texts = std::move(other._active_texts);
233 _audio_processor = std::move(other._audio_processor);
234 _disable_audio_processor = other._disable_audio_processor;
235 _playback_length = other._playback_length.load();
236 _subtitle_alignment = other._subtitle_alignment;
245 have_video (shared_ptr<const Content> content)
247 return static_cast<bool>(content->video) && content->video->use() && content->can_be_played();
252 have_audio (shared_ptr<const Content> content)
254 return static_cast<bool>(content->audio) && content->can_be_played();
259 Player::setup_pieces ()
261 boost::mutex::scoped_lock lm (_mutex);
263 auto old_pieces = _pieces;
266 auto film = _film.lock();
271 _playback_length = _playlist ? _playlist->length(film) : film->length();
273 auto playlist_content = playlist()->content();
274 bool const have_threed = std::any_of(
275 playlist_content.begin(),
276 playlist_content.end(),
277 [](shared_ptr<const Content> c) {
278 return c->video && (c->video->frame_type() == VideoFrameType::THREE_D_LEFT || c->video->frame_type() == VideoFrameType::THREE_D_RIGHT);
283 _shuffler.reset(new Shuffler());
284 _shuffler->Video.connect(bind(&Player::video, this, _1, _2));
287 for (auto content: playlist()->content()) {
289 if (!content->paths_valid()) {
293 if (_ignore_video && _ignore_audio && content->text.empty()) {
294 /* We're only interested in text and this content has none */
298 shared_ptr<Decoder> old_decoder;
299 for (auto j: old_pieces) {
300 if (j->content == content) {
301 old_decoder = j->decoder;
306 auto decoder = decoder_factory(film, content, _fast, _tolerant, old_decoder);
307 DCPOMATIC_ASSERT (decoder);
309 FrameRateChange frc(film, content);
311 if (decoder->video && _ignore_video) {
312 decoder->video->set_ignore (true);
315 if (decoder->audio && _ignore_audio) {
316 decoder->audio->set_ignore (true);
320 for (auto i: decoder->text) {
321 i->set_ignore (true);
325 auto dcp = dynamic_pointer_cast<DCPDecoder> (decoder);
327 dcp->set_decode_referenced (_play_referenced);
328 if (_play_referenced) {
329 dcp->set_forced_reduction (_dcp_decode_reduction);
333 auto piece = make_shared<Piece>(content, decoder, frc);
334 _pieces.push_back (piece);
336 if (decoder->video) {
338 /* We need a Shuffler to cope with 3D L/R video data arriving out of sequence */
339 decoder->video->Data.connect (bind(&Shuffler::video, _shuffler.get(), weak_ptr<Piece>(piece), _1));
341 decoder->video->Data.connect (bind(&Player::video, this, weak_ptr<Piece>(piece), _1));
345 if (decoder->audio) {
346 decoder->audio->Data.connect (bind (&Player::audio, this, weak_ptr<Piece> (piece), _1, _2));
349 auto j = decoder->text.begin();
351 while (j != decoder->text.end()) {
352 (*j)->BitmapStart.connect (
353 bind(&Player::bitmap_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
355 (*j)->PlainStart.connect (
356 bind(&Player::plain_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
359 bind(&Player::subtitle_stop, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
365 if (decoder->atmos) {
366 decoder->atmos->Data.connect (bind(&Player::atmos, this, weak_ptr<Piece>(piece), _1));
370 _stream_states.clear ();
371 for (auto i: _pieces) {
372 if (i->content->audio) {
373 for (auto j: i->content->audio->streams()) {
374 _stream_states[j] = StreamState(i);
379 auto ignore_overlap = [](shared_ptr<VideoContent> v) {
380 return v && v->use() && v->frame_type() != VideoFrameType::THREE_D_LEFT && v->frame_type() != VideoFrameType::THREE_D_RIGHT;
383 for (auto piece = _pieces.begin(); piece != _pieces.end(); ++piece) {
384 if (ignore_overlap((*piece)->content->video)) {
385 /* Look for content later in the content list with in-use video that overlaps this */
386 auto const period = (*piece)->content->period(film);
387 for (auto later_piece = std::next(piece); later_piece != _pieces.end(); ++later_piece) {
388 if (ignore_overlap((*later_piece)->content->video)) {
389 if (auto overlap = (*later_piece)->content->period(film).overlap(period)) {
390 (*piece)->ignore_video.push_back(*overlap);
397 for (auto piece = _pieces.begin(); piece != _pieces.end(); ++piece) {
398 if ((*piece)->content->atmos) {
399 /* Look for content later in the content list with ATMOS that overlaps this */
400 auto const period = (*piece)->content->period(film);
401 for (auto later_piece = std::next(piece); later_piece != _pieces.end(); ++later_piece) {
402 if ((*later_piece)->content->atmos) {
403 if (auto overlap = (*later_piece)->content->period(film).overlap(period)) {
404 (*piece)->ignore_atmos.push_back(*overlap);
411 _black = Empty(film, playlist(), bind(&have_video, _1), _playback_length);
412 _silent = Empty(film, playlist(), bind(&have_audio, _1), _playback_length);
414 _next_video_time = boost::none;
415 _next_video_eyes = Eyes::BOTH;
416 _next_audio_time = boost::none;
421 Player::playlist_content_change (ChangeType type, int property, bool frequent)
423 auto film = _film.lock();
428 if (property == VideoContentProperty::CROP) {
429 if (type == ChangeType::DONE) {
430 boost::mutex::scoped_lock lm (_mutex);
431 for (auto const& i: _delay) {
432 i.first->reset_metadata(film, _video_container_size);
436 if (type == ChangeType::PENDING) {
437 /* The player content is probably about to change, so we can't carry on
438 until that has happened and we've rebuilt our pieces. Stop pass()
439 and seek() from working until then.
442 } else if (type == ChangeType::DONE) {
443 /* A change in our content has gone through. Re-build our pieces. */
446 } else if (type == ChangeType::CANCELLED) {
451 Change (type, property, frequent);
456 Player::set_video_container_size (dcp::Size s)
458 ChangeSignaller<Player, int> cc(this, PlayerProperty::VIDEO_CONTAINER_SIZE);
460 if (s == _video_container_size) {
465 _video_container_size = s;
468 boost::mutex::scoped_lock lm(_black_image_mutex);
469 _black_image = make_shared<Image>(AV_PIX_FMT_RGB24, _video_container_size, Image::Alignment::PADDED);
470 _black_image->make_black ();
476 Player::playlist_change (ChangeType type)
478 if (type == ChangeType::DONE) {
481 Change (type, PlayerProperty::PLAYLIST, false);
486 Player::film_change(ChangeType type, FilmProperty p)
488 /* Here we should notice Film properties that affect our output, and
489 alert listeners that our output now would be different to how it was
490 last time we were run.
493 auto film = _film.lock();
498 if (p == FilmProperty::CONTAINER) {
499 Change (type, PlayerProperty::FILM_CONTAINER, false);
500 } else if (p == FilmProperty::VIDEO_FRAME_RATE) {
501 /* Pieces contain a FrameRateChange which contains the DCP frame rate,
502 so we need new pieces here.
504 if (type == ChangeType::DONE) {
507 Change (type, PlayerProperty::FILM_VIDEO_FRAME_RATE, false);
508 } else if (p == FilmProperty::AUDIO_PROCESSOR) {
509 if (type == ChangeType::DONE && film->audio_processor ()) {
510 boost::mutex::scoped_lock lm (_mutex);
511 _audio_processor = film->audio_processor()->clone(film->audio_frame_rate());
513 } else if (p == FilmProperty::AUDIO_CHANNELS) {
514 if (type == ChangeType::DONE) {
515 boost::mutex::scoped_lock lm (_mutex);
516 _audio_merger.clear ();
522 shared_ptr<PlayerVideo>
523 Player::black_player_video_frame (Eyes eyes) const
525 boost::mutex::scoped_lock lm(_black_image_mutex);
527 return std::make_shared<PlayerVideo> (
528 std::make_shared<const RawImageProxy>(_black_image),
531 _video_container_size,
532 _video_container_size,
535 PresetColourConversion::all().front().conversion,
537 std::weak_ptr<Content>(),
538 boost::optional<Frame>(),
545 Player::dcp_to_content_video (shared_ptr<const Piece> piece, DCPTime t) const
547 auto film = _film.lock();
548 DCPOMATIC_ASSERT(film);
550 auto s = t - piece->content->position ();
551 s = min (piece->content->length_after_trim(film), s);
552 s = max (DCPTime(), s + DCPTime (piece->content->trim_start(), piece->frc));
554 /* It might seem more logical here to convert s to a ContentTime (using the FrameRateChange)
555 then convert that ContentTime to frames at the content's rate. However this fails for
556 situations like content at 29.9978733fps, DCP at 30fps. The accuracy of the Time type is not
557 enough to distinguish between the two with low values of time (e.g. 3200 in Time units).
559 Instead we convert the DCPTime using the DCP video rate then account for any skip/repeat.
561 return s.frames_floor (piece->frc.dcp) / piece->frc.factor ();
566 Player::content_video_to_dcp (shared_ptr<const Piece> piece, Frame f) const
568 /* See comment in dcp_to_content_video */
569 auto const d = DCPTime::from_frames (f * piece->frc.factor(), piece->frc.dcp) - DCPTime(piece->content->trim_start(), piece->frc);
570 return d + piece->content->position();
575 Player::dcp_to_resampled_audio (shared_ptr<const Piece> piece, DCPTime t) const
577 auto film = _film.lock();
578 DCPOMATIC_ASSERT(film);
580 auto s = t - piece->content->position ();
581 s = min (piece->content->length_after_trim(film), s);
582 /* See notes in dcp_to_content_video */
583 return max (DCPTime(), DCPTime(piece->content->trim_start(), piece->frc) + s).frames_floor(film->audio_frame_rate());
588 Player::resampled_audio_to_dcp (shared_ptr<const Piece> piece, Frame f) const
590 auto film = _film.lock();
591 DCPOMATIC_ASSERT(film);
593 /* See comment in dcp_to_content_video */
594 return DCPTime::from_frames(f, film->audio_frame_rate())
595 - DCPTime (piece->content->trim_start(), piece->frc)
596 + piece->content->position();
601 Player::dcp_to_content_time (shared_ptr<const Piece> piece, DCPTime t) const
603 auto film = _film.lock();
604 DCPOMATIC_ASSERT(film);
606 auto s = t - piece->content->position ();
607 s = min (piece->content->length_after_trim(film), s);
608 return max (ContentTime (), ContentTime (s, piece->frc) + piece->content->trim_start());
613 Player::content_time_to_dcp (shared_ptr<const Piece> piece, ContentTime t) const
615 return max (DCPTime(), DCPTime(t - piece->content->trim_start(), piece->frc) + piece->content->position());
619 vector<shared_ptr<Font>>
620 Player::get_subtitle_fonts ()
622 boost::mutex::scoped_lock lm (_mutex);
624 vector<shared_ptr<Font>> fonts;
625 for (auto piece: _pieces) {
626 for (auto text: piece->content->text) {
627 auto text_fonts = text->fonts();
628 copy (text_fonts.begin(), text_fonts.end(), back_inserter(fonts));
636 /** Set this player never to produce any video data */
638 Player::set_ignore_video ()
640 ChangeSignaller<Player, int> cc(this, PlayerProperty::IGNORE_VIDEO);
641 _ignore_video = true;
647 Player::set_ignore_audio ()
649 ChangeSignaller<Player, int> cc(this, PlayerProperty::IGNORE_AUDIO);
650 _ignore_audio = true;
656 Player::set_ignore_text ()
658 ChangeSignaller<Player, int> cc(this, PlayerProperty::IGNORE_TEXT);
664 /** Set the player to always burn open texts into the image regardless of the content settings */
666 Player::set_always_burn_open_subtitles ()
668 ChangeSignaller<Player, int> cc(this, PlayerProperty::ALWAYS_BURN_OPEN_SUBTITLES);
669 _always_burn_open_subtitles = true;
673 /** Sets up the player to be faster, possibly at the expense of quality */
683 Player::set_play_referenced ()
685 ChangeSignaller<Player, int> cc(this, PlayerProperty::PLAY_REFERENCED);
686 _play_referenced = true;
694 boost::mutex::scoped_lock lm (_mutex);
697 /* We can't pass in this state */
698 LOG_DEBUG_PLAYER_NC ("Player is suspended");
702 auto film = _film.lock();
704 if (_playback_length.load() == DCPTime() || !film) {
705 /* Special; just give one black frame */
706 emit_video (black_player_video_frame(Eyes::BOTH), DCPTime());
710 /* Find the decoder or empty which is farthest behind where we are and make it emit some data */
712 shared_ptr<Piece> earliest_content;
713 optional<DCPTime> earliest_time;
715 for (auto i: _pieces) {
720 auto const t = content_time_to_dcp (i, max(i->decoder->position(), i->content->trim_start()));
721 if (t > i->content->end(film)) {
725 /* Given two choices at the same time, pick the one with texts so we see it before
728 if (!earliest_time || t < *earliest_time || (t == *earliest_time && !i->decoder->text.empty())) {
730 earliest_content = i;
744 if (earliest_content) {
748 if (!_black.done() && !_ignore_video && (!earliest_time || _black.position() < *earliest_time)) {
749 earliest_time = _black.position ();
753 if (!_silent.done() && !_ignore_audio && (!earliest_time || _silent.position() < *earliest_time)) {
754 earliest_time = _silent.position ();
761 LOG_DEBUG_PLAYER ("Calling pass() on %1", earliest_content->content->path(0));
762 earliest_content->done = earliest_content->decoder->pass ();
763 auto dcp = dynamic_pointer_cast<DCPContent>(earliest_content->content);
764 if (dcp && !_play_referenced && dcp->reference_audio()) {
765 /* We are skipping some referenced DCP audio content, so we need to update _next_audio_time
766 to `hide' the fact that no audio was emitted during the referenced DCP (though
767 we need to behave as though it was).
769 _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 emit_video(black_player_video_frame(Eyes::LEFT), _black.position());
777 emit_video(black_player_video_frame(Eyes::RIGHT), _black.position());
779 emit_video(black_player_video_frame(Eyes::BOTH), _black.position());
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 std::map<AudioStreamPtr, StreamState> alive_stream_states;
839 if (latest_last_push_end != have_pushed.end()) {
840 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()));
842 /* Now make a list of those streams that are less than ignore_streams_behind behind the leader */
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));
852 auto pull_to = _playback_length.load();
853 for (auto const& i: alive_stream_states) {
854 auto position = i.second.last_push_end.get_value_or(i.second.piece->content->position());
855 if (!i.second.piece->done && position < pull_to) {
859 if (!_silent.done() && _silent.position() < pull_to) {
860 pull_to = _silent.position();
863 LOG_DEBUG_PLAYER("Emitting audio up to %1", to_string(pull_to));
864 auto audio = _audio_merger.pull (pull_to);
865 for (auto i = audio.begin(); i != audio.end(); ++i) {
866 if (_next_audio_time && i->second < *_next_audio_time) {
867 /* This new data comes before the last we emitted (or the last seek); discard it */
868 auto cut = discard_audio (i->first, i->second, *_next_audio_time);
873 } else if (_next_audio_time && i->second > *_next_audio_time) {
874 /* There's a gap between this data and the last we emitted; fill with silence */
875 fill_audio (DCPTimePeriod (*_next_audio_time, i->second));
878 emit_audio (i->first, i->second);
885 for (auto const& i: _delay) {
886 do_emit_video(i.first, i.second);
889 /* Perhaps we should have Empty entries for both eyes in the 3D case (somehow).
890 * However, if we have L and R video files, and one is shorter than the other,
891 * the fill code in ::video mostly takes care of filling in the gaps.
892 * However, since it fills at the point when it knows there is more video coming
893 * at time t (so it should fill any gap up to t) it can't do anything right at the
894 * end. This is particularly bad news if the last frame emitted is a LEFT
895 * eye, as the MXF writer will complain about the 3D sequence being wrong.
896 * Here's a hack to workaround that particular case.
898 if (_next_video_eyes && _next_video_time && *_next_video_eyes == Eyes::RIGHT) {
899 do_emit_video (black_player_video_frame(Eyes::RIGHT), *_next_video_time);
907 /** @return Open subtitles for the frame at the given time, converted to images */
908 optional<PositionImage>
909 Player::open_subtitles_for_frame (DCPTime time) const
911 auto film = _film.lock();
916 list<PositionImage> captions;
917 int const vfr = film->video_frame_rate();
921 _active_texts[TextType::OPEN_SUBTITLE].get_burnt(DCPTimePeriod(time, time + DCPTime::from_frames(1, vfr)), _always_burn_open_subtitles)
924 /* Bitmap subtitles */
925 for (auto i: j.bitmap) {
926 if (!i.image || i.image->size().width == 0 || i.image->size().height == 0) {
930 /* i.image will already have been scaled to fit _video_container_size */
931 dcp::Size scaled_size (i.rectangle.width * _video_container_size.load().width, i.rectangle.height * _video_container_size.load().height);
937 lrint(_video_container_size.load().width * i.rectangle.x),
938 lrint(_video_container_size.load().height * i.rectangle.y)
944 /* String subtitles (rendered to an image) */
945 if (!j.string.empty()) {
946 auto s = render_text(j.string, _video_container_size, time, vfr);
947 copy_if(s.begin(), s.end(), back_inserter(captions), [](PositionImage const& image) {
948 return image.image->size().width && image.image->size().height;
954 if (captions.empty()) {
958 return merge (captions, _subtitle_alignment);
964 increment_eyes (Eyes e)
966 if (e == Eyes::LEFT) {
975 Player::video (weak_ptr<Piece> weak_piece, ContentVideo video)
981 auto piece = weak_piece.lock ();
986 if (!piece->content->video->use()) {
990 auto film = _film.lock();
995 FrameRateChange frc(film, piece->content);
996 if (frc.skip && (video.frame % 2) == 1) {
1000 vector<Eyes> eyes_to_emit;
1002 if (!film->three_d()) {
1003 if (video.eyes == Eyes::RIGHT) {
1004 /* 2D film, 3D content: discard right */
1006 } else if (video.eyes == Eyes::LEFT) {
1007 /* 2D film, 3D content: emit left as "both" */
1008 video.eyes = Eyes::BOTH;
1009 eyes_to_emit = { Eyes::BOTH };
1012 if (video.eyes == Eyes::BOTH) {
1013 /* 3D film, 2D content; emit "both" for left and right */
1014 eyes_to_emit = { Eyes::LEFT, Eyes::RIGHT };
1018 if (eyes_to_emit.empty()) {
1019 eyes_to_emit = { video.eyes };
1022 /* Time of the first frame we will emit */
1023 DCPTime const time = content_video_to_dcp (piece, video.frame);
1024 LOG_DEBUG_PLAYER("Received video frame %1 at %2", video.frame, to_string(time));
1026 /* Discard if it's before the content's period or the last accurate seek. We can't discard
1027 if it's after the content's period here as in that case we still need to fill any gap between
1028 `now' and the end of the content's period.
1030 if (time < piece->content->position() || (_next_video_time && time < *_next_video_time)) {
1034 auto ignore_video = std::find_if(
1035 piece->ignore_video.begin(),
1036 piece->ignore_video.end(),
1037 [time](DCPTimePeriod period) { return period.contains(time); }
1039 if (ignore_video != piece->ignore_video.end()) {
1043 /* Fill gaps that we discover now that we have some video which needs to be emitted.
1044 This is where we need to fill to.
1046 DCPTime fill_to = min(time, piece->content->end(film));
1048 if (_next_video_time) {
1049 DCPTime fill_from = max (*_next_video_time, piece->content->position());
1051 /* Fill if we have more than half a frame to do */
1052 if ((fill_to - fill_from) > one_video_frame() / 2) {
1053 auto last = _last_video.find (weak_piece);
1054 if (film->three_d()) {
1055 auto fill_to_eyes = eyes_to_emit[0];
1056 if (fill_to_eyes == Eyes::BOTH) {
1057 fill_to_eyes = Eyes::LEFT;
1059 if (fill_to == piece->content->end(film)) {
1060 /* Don't fill after the end of the content */
1061 fill_to_eyes = Eyes::LEFT;
1064 auto eyes = _next_video_eyes.get_value_or(Eyes::LEFT);
1065 if (eyes == Eyes::BOTH) {
1068 while (j < fill_to || eyes != fill_to_eyes) {
1069 if (last != _last_video.end()) {
1070 LOG_DEBUG_PLAYER("Fill using last video at %1 in 3D mode", to_string(j));
1071 auto copy = last->second->shallow_copy();
1072 copy->set_eyes (eyes);
1073 emit_video (copy, j);
1075 LOG_DEBUG_PLAYER("Fill using black at %1 in 3D mode", to_string(j));
1076 emit_video (black_player_video_frame(eyes), j);
1078 if (eyes == Eyes::RIGHT) {
1079 j += one_video_frame();
1081 eyes = increment_eyes (eyes);
1084 for (DCPTime j = fill_from; j < fill_to; j += one_video_frame()) {
1085 if (last != _last_video.end()) {
1086 emit_video (last->second, j);
1088 emit_video (black_player_video_frame(Eyes::BOTH), j);
1095 auto const content_video = piece->content->video;
1097 auto scaled_size = content_video->scaled_size(film->frame_size());
1098 DCPOMATIC_ASSERT(scaled_size);
1100 for (auto eyes: eyes_to_emit) {
1101 _last_video[weak_piece] = std::make_shared<PlayerVideo>(
1103 content_video->actual_crop(),
1104 content_video->fade(film, video.frame),
1107 _video_container_size,
1109 content_video->pixel_quanta()
1111 _video_container_size,
1114 content_video->colour_conversion(),
1115 content_video->range(),
1122 for (int i = 0; i < frc.repeat; ++i) {
1123 if (t < piece->content->end(film)) {
1124 emit_video (_last_video[weak_piece], t);
1126 t += one_video_frame ();
1133 Player::audio (weak_ptr<Piece> weak_piece, AudioStreamPtr stream, ContentAudio content_audio)
1139 DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
1141 auto piece = weak_piece.lock ();
1146 auto film = _film.lock();
1151 auto content = piece->content->audio;
1152 DCPOMATIC_ASSERT (content);
1154 int const rfr = content->resampled_frame_rate(film);
1156 /* Compute time in the DCP */
1157 auto time = resampled_audio_to_dcp (piece, content_audio.frame);
1159 /* And the end of this block in the DCP */
1160 auto end = time + DCPTime::from_frames(content_audio.audio->frames(), rfr);
1161 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());
1163 /* Remove anything that comes before the start or after the end of the content */
1164 if (time < piece->content->position()) {
1165 auto cut = discard_audio (content_audio.audio, time, piece->content->position());
1167 /* This audio is entirely discarded */
1170 content_audio.audio = cut.first;
1172 } else if (time > piece->content->end(film)) {
1173 /* Discard it all */
1175 } else if (end > piece->content->end(film)) {
1176 Frame const remaining_frames = DCPTime(piece->content->end(film) - time).frames_round(rfr);
1177 if (remaining_frames == 0) {
1180 content_audio.audio = make_shared<AudioBuffers>(content_audio.audio, remaining_frames, 0);
1183 DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
1187 auto const fade_coeffs = content->fade (stream, content_audio.frame, content_audio.audio->frames(), rfr);
1188 if (content->gain() != 0 || !fade_coeffs.empty()) {
1189 auto gain_buffers = make_shared<AudioBuffers>(content_audio.audio);
1190 if (!fade_coeffs.empty()) {
1191 /* Apply both fade and gain */
1192 DCPOMATIC_ASSERT (fade_coeffs.size() == static_cast<size_t>(gain_buffers->frames()));
1193 auto const channels = gain_buffers->channels();
1194 auto const frames = fade_coeffs.size();
1195 auto data = gain_buffers->data();
1196 auto const gain = db_to_linear (content->gain());
1197 for (auto channel = 0; channel < channels; ++channel) {
1198 for (auto frame = 0U; frame < frames; ++frame) {
1199 data[channel][frame] *= gain * fade_coeffs[frame];
1203 /* Just apply gain */
1204 gain_buffers->apply_gain (content->gain());
1206 content_audio.audio = gain_buffers;
1211 content_audio.audio = remap(content_audio.audio, film->audio_channels(), stream->mapping());
1215 if (_audio_processor && !_disable_audio_processor) {
1216 content_audio.audio = _audio_processor->run(content_audio.audio, film->audio_channels());
1221 _audio_merger.push (content_audio.audio, time);
1222 DCPOMATIC_ASSERT (_stream_states.find (stream) != _stream_states.end ());
1223 _stream_states[stream].last_push_end = time + DCPTime::from_frames(content_audio.audio->frames(), film->audio_frame_rate());
1228 Player::bitmap_text_start (weak_ptr<Piece> weak_piece, weak_ptr<const TextContent> weak_content, ContentBitmapText subtitle)
1234 auto piece = weak_piece.lock ();
1235 auto content = weak_content.lock ();
1236 auto film = _film.lock();
1237 if (!piece || !content || !film) {
1242 for (auto& sub: subtitle.subs)
1244 /* Apply content's subtitle offsets */
1245 sub.rectangle.x += content->x_offset ();
1246 sub.rectangle.y += content->y_offset ();
1248 /* Apply a corrective translation to keep the subtitle centred after the scale that is coming up */
1249 sub.rectangle.x -= sub.rectangle.width * ((content->x_scale() - 1) / 2);
1250 sub.rectangle.y -= sub.rectangle.height * ((content->y_scale() - 1) / 2);
1252 /* Apply content's subtitle scale */
1253 sub.rectangle.width *= content->x_scale ();
1254 sub.rectangle.height *= content->y_scale ();
1256 auto image = sub.image;
1258 auto const inter_size = scale_for_display(sub.parent_size, _video_container_size.load(), film->frame_size(), {});
1260 int const width = sub.rectangle.width * inter_size.width;
1261 int const height = sub.rectangle.height * inter_size.height;
1262 if (width == 0 || height == 0) {
1266 dcp::Size scaled_size (width, height);
1267 ps.bitmap.push_back(BitmapText(sub.parent_size, image->scale(scaled_size, dcp::YUVToRGB::REC601, image->pixel_format(), Image::Alignment::PADDED, _fast), sub.rectangle));
1270 DCPTime from(content_time_to_dcp(piece, subtitle.from()));
1271 _active_texts[content->type()].add_from(weak_content, ps, from);
1276 Player::plain_text_start (weak_ptr<Piece> weak_piece, weak_ptr<const TextContent> weak_content, ContentStringText subtitle)
1282 auto piece = weak_piece.lock ();
1283 auto content = weak_content.lock ();
1284 auto film = _film.lock();
1285 if (!piece || !content || !film) {
1290 DCPTime const from (content_time_to_dcp (piece, subtitle.from()));
1292 if (from > piece->content->end(film)) {
1296 for (auto s: subtitle.subs) {
1297 s.set_h_position (s.h_position() + content->x_offset());
1298 s.set_v_position (s.v_position() + content->y_offset());
1299 float const xs = content->x_scale();
1300 float const ys = content->y_scale();
1301 float size = s.size();
1303 /* Adjust size to express the common part of the scaling;
1304 e.g. if xs = ys = 0.5 we scale size by 2.
1306 if (xs > 1e-5 && ys > 1e-5) {
1307 size *= 1 / min (1 / xs, 1 / ys);
1311 /* Then express aspect ratio changes */
1312 if (fabs (1.0 - xs / ys) > dcp::ASPECT_ADJUST_EPSILON) {
1313 s.set_aspect_adjust (xs / ys);
1316 s.set_in (dcp::Time(from.seconds(), 1000));
1317 ps.string.push_back (s);
1320 _active_texts[content->type()].add_from(weak_content, ps, from);
1325 Player::subtitle_stop (weak_ptr<Piece> weak_piece, weak_ptr<const TextContent> weak_content, ContentTime to)
1331 auto content = weak_content.lock ();
1336 if (!_active_texts[content->type()].have(weak_content)) {
1340 auto piece = weak_piece.lock ();
1341 auto film = _film.lock();
1342 if (!piece || !film) {
1346 DCPTime const dcp_to = content_time_to_dcp (piece, to);
1348 if (dcp_to > piece->content->end(film)) {
1352 auto from = _active_texts[content->type()].add_to(weak_content, dcp_to);
1354 bool const always = (content->type() == TextType::OPEN_SUBTITLE && _always_burn_open_subtitles);
1355 if (content->use() && !always && !content->burn()) {
1356 Text (from.first, content->type(), content->dcp_track().get_value_or(DCPTextTrack()), DCPTimePeriod(from.second, dcp_to));
1362 Player::seek (DCPTime time, bool accurate)
1364 boost::mutex::scoped_lock lm (_mutex);
1365 LOG_DEBUG_PLAYER("Seek to %1 (%2accurate)", to_string(time), accurate ? "" : "in");
1368 /* We can't seek in this state */
1372 auto film = _film.lock();
1378 _shuffler->clear ();
1383 if (_audio_processor) {
1384 _audio_processor->flush ();
1387 _audio_merger.clear ();
1388 std::for_each(_active_texts.begin(), _active_texts.end(), [](ActiveText& a) { a.clear(); });
1390 for (auto i: _pieces) {
1391 if (time < i->content->position()) {
1392 /* Before; seek to the start of the content. Even if this request is for an inaccurate seek
1393 we must seek this (following) content accurately, otherwise when we come to the end of the current
1394 content we may not start right at the beginning of the next, causing a gap (if the next content has
1395 been trimmed to a point between keyframes, or something).
1397 i->decoder->seek (dcp_to_content_time (i, i->content->position()), true);
1399 } else if (i->content->position() <= time && time < i->content->end(film)) {
1400 /* During; seek to position */
1401 i->decoder->seek (dcp_to_content_time (i, time), accurate);
1404 /* After; this piece is done */
1410 _next_video_time = time;
1411 _next_video_eyes = Eyes::LEFT;
1412 _next_audio_time = time;
1414 _next_video_time = boost::none;
1415 _next_video_eyes = boost::none;
1416 _next_audio_time = boost::none;
1419 _black.set_position (time);
1420 _silent.set_position (time);
1422 _last_video.clear ();
1424 for (auto& state: _stream_states) {
1425 state.second.last_push_end = boost::none;
1431 Player::emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1433 auto film = _film.lock();
1434 DCPOMATIC_ASSERT(film);
1436 /* We need a delay to give a little wiggle room to ensure that relevant subtitles arrive at the
1437 player before the video that requires them.
1439 _delay.push_back (make_pair (pv, time));
1441 if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
1442 _next_video_time = time + one_video_frame();
1444 _next_video_eyes = increment_eyes (pv->eyes());
1446 if (_delay.size() < 3) {
1450 auto to_do = _delay.front();
1452 do_emit_video (to_do.first, to_do.second);
1457 Player::do_emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1459 if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
1460 std::for_each(_active_texts.begin(), _active_texts.end(), [time](ActiveText& a) { a.clear_before(time); });
1463 auto subtitles = open_subtitles_for_frame (time);
1465 pv->set_text (subtitles.get ());
1473 Player::emit_audio (shared_ptr<AudioBuffers> data, DCPTime time)
1475 auto film = _film.lock();
1476 DCPOMATIC_ASSERT(film);
1478 /* Log if the assert below is about to fail */
1479 if (_next_audio_time && labs(time.get() - _next_audio_time->get()) > 1) {
1480 film->log()->log(String::compose("Out-of-sequence emit %1 vs %2", to_string(time), to_string(*_next_audio_time)), LogEntry::TYPE_WARNING);
1483 /* This audio must follow on from the previous, allowing for half a sample (at 48kHz) leeway */
1484 DCPOMATIC_ASSERT (!_next_audio_time || labs(time.get() - _next_audio_time->get()) < 2);
1485 Audio(data, time, film->audio_frame_rate());
1486 _next_audio_time = time + DCPTime::from_frames(data->frames(), film->audio_frame_rate());
1491 Player::fill_audio (DCPTimePeriod period)
1493 auto film = _film.lock();
1494 DCPOMATIC_ASSERT(film);
1496 if (period.from == period.to) {
1500 DCPOMATIC_ASSERT (period.from < period.to);
1502 DCPTime t = period.from;
1503 while (t < period.to) {
1504 DCPTime block = min (DCPTime::from_seconds (0.5), period.to - t);
1505 Frame const samples = block.frames_round(film->audio_frame_rate());
1507 auto silence = make_shared<AudioBuffers>(film->audio_channels(), samples);
1508 silence->make_silent ();
1509 emit_audio (silence, t);
1517 Player::one_video_frame () const
1519 auto film = _film.lock();
1520 DCPOMATIC_ASSERT(film);
1522 return DCPTime::from_frames(1, film->video_frame_rate ());
1526 pair<shared_ptr<AudioBuffers>, DCPTime>
1527 Player::discard_audio (shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to) const
1529 auto film = _film.lock();
1530 DCPOMATIC_ASSERT(film);
1532 auto const discard_time = discard_to - time;
1533 auto const discard_frames = discard_time.frames_round(film->audio_frame_rate());
1534 auto remaining_frames = audio->frames() - discard_frames;
1535 if (remaining_frames <= 0) {
1536 return make_pair(shared_ptr<AudioBuffers>(), DCPTime());
1538 auto cut = make_shared<AudioBuffers>(audio, remaining_frames, discard_frames);
1539 return make_pair(cut, time + discard_time);
1544 Player::set_dcp_decode_reduction (optional<int> reduction)
1546 ChangeSignaller<Player, int> cc(this, PlayerProperty::DCP_DECODE_REDUCTION);
1548 if (reduction == _dcp_decode_reduction.load()) {
1553 _dcp_decode_reduction = reduction;
1559 Player::content_time_to_dcp (shared_ptr<const Content> content, ContentTime t) const
1561 boost::mutex::scoped_lock lm (_mutex);
1563 for (auto i: _pieces) {
1564 if (i->content == content) {
1565 return content_time_to_dcp (i, t);
1569 /* We couldn't find this content; perhaps things are being changed over */
1574 optional<ContentTime>
1575 Player::dcp_to_content_time (shared_ptr<const Content> content, DCPTime t) const
1577 boost::mutex::scoped_lock lm (_mutex);
1579 for (auto i: _pieces) {
1580 if (i->content == content) {
1581 return dcp_to_content_time (i, t);
1585 /* We couldn't find this content; perhaps things are being changed over */
1590 shared_ptr<const Playlist>
1591 Player::playlist () const
1593 auto film = _film.lock();
1598 return _playlist ? _playlist : film->playlist();
1603 Player::atmos (weak_ptr<Piece> weak_piece, ContentAtmos data)
1609 auto film = _film.lock();
1610 DCPOMATIC_ASSERT(film);
1612 auto piece = weak_piece.lock ();
1613 DCPOMATIC_ASSERT (piece);
1615 auto const vfr = film->video_frame_rate();
1617 DCPTime const dcp_time = DCPTime::from_frames(data.frame, vfr) - DCPTime(piece->content->trim_start(), FrameRateChange(vfr, vfr));
1618 if (dcp_time < piece->content->position() || dcp_time >= (piece->content->end(film))) {
1622 auto ignore_atmos = std::find_if(
1623 piece->ignore_atmos.begin(),
1624 piece->ignore_atmos.end(),
1625 [dcp_time](DCPTimePeriod period) { return period.contains(dcp_time); }
1627 if (ignore_atmos != piece->ignore_atmos.end()) {
1631 Atmos (data.data, dcp_time, data.metadata);
1636 Player::signal_change(ChangeType type, int property)
1638 Change(type, property, false);
1642 /** Must be called from the same thread that calls ::pass() */
1644 Player::set_disable_audio_processor()
1646 _disable_audio_processor = true;