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, Film::Property::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 (*piece)->ignore_video = (*later_piece)->content->period(film).overlap(period);
393 _black = Empty(film, playlist(), bind(&have_video, _1), _playback_length);
394 _silent = Empty(film, playlist(), bind(&have_audio, _1), _playback_length);
396 _next_video_time = boost::none;
397 _next_video_eyes = Eyes::BOTH;
398 _next_audio_time = boost::none;
403 Player::playlist_content_change (ChangeType type, int property, bool frequent)
405 auto film = _film.lock();
410 if (property == VideoContentProperty::CROP) {
411 if (type == ChangeType::DONE) {
412 boost::mutex::scoped_lock lm (_mutex);
413 for (auto const& i: _delay) {
414 i.first->reset_metadata(film, _video_container_size);
418 if (type == ChangeType::PENDING) {
419 /* The player content is probably about to change, so we can't carry on
420 until that has happened and we've rebuilt our pieces. Stop pass()
421 and seek() from working until then.
424 } else if (type == ChangeType::DONE) {
425 /* A change in our content has gone through. Re-build our pieces. */
428 } else if (type == ChangeType::CANCELLED) {
433 Change (type, property, frequent);
438 Player::set_video_container_size (dcp::Size s)
440 ChangeSignaller<Player, int> cc(this, PlayerProperty::VIDEO_CONTAINER_SIZE);
442 if (s == _video_container_size) {
447 _video_container_size = s;
450 boost::mutex::scoped_lock lm(_black_image_mutex);
451 _black_image = make_shared<Image>(AV_PIX_FMT_RGB24, _video_container_size, Image::Alignment::PADDED);
452 _black_image->make_black ();
458 Player::playlist_change (ChangeType type)
460 if (type == ChangeType::DONE) {
463 Change (type, PlayerProperty::PLAYLIST, false);
468 Player::film_change (ChangeType type, Film::Property p)
470 /* Here we should notice Film properties that affect our output, and
471 alert listeners that our output now would be different to how it was
472 last time we were run.
475 auto film = _film.lock();
480 if (p == Film::Property::CONTAINER) {
481 Change (type, PlayerProperty::FILM_CONTAINER, false);
482 } else if (p == Film::Property::VIDEO_FRAME_RATE) {
483 /* Pieces contain a FrameRateChange which contains the DCP frame rate,
484 so we need new pieces here.
486 if (type == ChangeType::DONE) {
489 Change (type, PlayerProperty::FILM_VIDEO_FRAME_RATE, false);
490 } else if (p == Film::Property::AUDIO_PROCESSOR) {
491 if (type == ChangeType::DONE && film->audio_processor ()) {
492 boost::mutex::scoped_lock lm (_mutex);
493 _audio_processor = film->audio_processor()->clone(film->audio_frame_rate());
495 } else if (p == Film::Property::AUDIO_CHANNELS) {
496 if (type == ChangeType::DONE) {
497 boost::mutex::scoped_lock lm (_mutex);
498 _audio_merger.clear ();
504 shared_ptr<PlayerVideo>
505 Player::black_player_video_frame (Eyes eyes) const
507 boost::mutex::scoped_lock lm(_black_image_mutex);
509 return std::make_shared<PlayerVideo> (
510 std::make_shared<const RawImageProxy>(_black_image),
513 _video_container_size,
514 _video_container_size,
517 PresetColourConversion::all().front().conversion,
519 std::weak_ptr<Content>(),
520 boost::optional<Frame>(),
527 Player::dcp_to_content_video (shared_ptr<const Piece> piece, DCPTime t) const
529 auto film = _film.lock();
530 DCPOMATIC_ASSERT(film);
532 auto s = t - piece->content->position ();
533 s = min (piece->content->length_after_trim(film), s);
534 s = max (DCPTime(), s + DCPTime (piece->content->trim_start(), piece->frc));
536 /* It might seem more logical here to convert s to a ContentTime (using the FrameRateChange)
537 then convert that ContentTime to frames at the content's rate. However this fails for
538 situations like content at 29.9978733fps, DCP at 30fps. The accuracy of the Time type is not
539 enough to distinguish between the two with low values of time (e.g. 3200 in Time units).
541 Instead we convert the DCPTime using the DCP video rate then account for any skip/repeat.
543 return s.frames_floor (piece->frc.dcp) / piece->frc.factor ();
548 Player::content_video_to_dcp (shared_ptr<const Piece> piece, Frame f) const
550 /* See comment in dcp_to_content_video */
551 auto const d = DCPTime::from_frames (f * piece->frc.factor(), piece->frc.dcp) - DCPTime(piece->content->trim_start(), piece->frc);
552 return d + piece->content->position();
557 Player::dcp_to_resampled_audio (shared_ptr<const Piece> piece, DCPTime t) const
559 auto film = _film.lock();
560 DCPOMATIC_ASSERT(film);
562 auto s = t - piece->content->position ();
563 s = min (piece->content->length_after_trim(film), s);
564 /* See notes in dcp_to_content_video */
565 return max (DCPTime(), DCPTime(piece->content->trim_start(), piece->frc) + s).frames_floor(film->audio_frame_rate());
570 Player::resampled_audio_to_dcp (shared_ptr<const Piece> piece, Frame f) const
572 auto film = _film.lock();
573 DCPOMATIC_ASSERT(film);
575 /* See comment in dcp_to_content_video */
576 return DCPTime::from_frames(f, film->audio_frame_rate())
577 - DCPTime (piece->content->trim_start(), piece->frc)
578 + piece->content->position();
583 Player::dcp_to_content_time (shared_ptr<const Piece> piece, DCPTime t) const
585 auto film = _film.lock();
586 DCPOMATIC_ASSERT(film);
588 auto s = t - piece->content->position ();
589 s = min (piece->content->length_after_trim(film), s);
590 return max (ContentTime (), ContentTime (s, piece->frc) + piece->content->trim_start());
595 Player::content_time_to_dcp (shared_ptr<const Piece> piece, ContentTime t) const
597 return max (DCPTime(), DCPTime(t - piece->content->trim_start(), piece->frc) + piece->content->position());
601 vector<shared_ptr<Font>>
602 Player::get_subtitle_fonts ()
604 boost::mutex::scoped_lock lm (_mutex);
606 vector<shared_ptr<Font>> fonts;
607 for (auto piece: _pieces) {
608 for (auto text: piece->content->text) {
609 auto text_fonts = text->fonts();
610 copy (text_fonts.begin(), text_fonts.end(), back_inserter(fonts));
618 /** Set this player never to produce any video data */
620 Player::set_ignore_video ()
622 ChangeSignaller<Player, int> cc(this, PlayerProperty::IGNORE_VIDEO);
623 _ignore_video = true;
629 Player::set_ignore_audio ()
631 ChangeSignaller<Player, int> cc(this, PlayerProperty::IGNORE_AUDIO);
632 _ignore_audio = true;
638 Player::set_ignore_text ()
640 ChangeSignaller<Player, int> cc(this, PlayerProperty::IGNORE_TEXT);
646 /** Set the player to always burn open texts into the image regardless of the content settings */
648 Player::set_always_burn_open_subtitles ()
650 ChangeSignaller<Player, int> cc(this, PlayerProperty::ALWAYS_BURN_OPEN_SUBTITLES);
651 _always_burn_open_subtitles = true;
655 /** Sets up the player to be faster, possibly at the expense of quality */
665 Player::set_play_referenced ()
667 ChangeSignaller<Player, int> cc(this, PlayerProperty::PLAY_REFERENCED);
668 _play_referenced = true;
676 boost::mutex::scoped_lock lm (_mutex);
679 /* We can't pass in this state */
680 LOG_DEBUG_PLAYER_NC ("Player is suspended");
684 auto film = _film.lock();
686 if (_playback_length.load() == DCPTime() || !film) {
687 /* Special; just give one black frame */
688 emit_video (black_player_video_frame(Eyes::BOTH), DCPTime());
692 /* Find the decoder or empty which is farthest behind where we are and make it emit some data */
694 shared_ptr<Piece> earliest_content;
695 optional<DCPTime> earliest_time;
697 for (auto i: _pieces) {
702 auto const t = content_time_to_dcp (i, max(i->decoder->position(), i->content->trim_start()));
703 if (t > i->content->end(film)) {
707 /* Given two choices at the same time, pick the one with texts so we see it before
710 if (!earliest_time || t < *earliest_time || (t == *earliest_time && !i->decoder->text.empty())) {
712 earliest_content = i;
726 if (earliest_content) {
730 if (!_black.done() && !_ignore_video && (!earliest_time || _black.position() < *earliest_time)) {
731 earliest_time = _black.position ();
735 if (!_silent.done() && !_ignore_audio && (!earliest_time || _silent.position() < *earliest_time)) {
736 earliest_time = _silent.position ();
743 LOG_DEBUG_PLAYER ("Calling pass() on %1", earliest_content->content->path(0));
744 earliest_content->done = earliest_content->decoder->pass ();
745 auto dcp = dynamic_pointer_cast<DCPContent>(earliest_content->content);
746 if (dcp && !_play_referenced && dcp->reference_audio()) {
747 /* We are skipping some referenced DCP audio content, so we need to update _next_audio_time
748 to `hide' the fact that no audio was emitted during the referenced DCP (though
749 we need to behave as though it was).
751 _next_audio_time = dcp->end(film);
756 LOG_DEBUG_PLAYER ("Emit black for gap at %1", to_string(_black.position()));
757 emit_video (black_player_video_frame(Eyes::BOTH), _black.position());
758 _black.set_position (_black.position() + one_video_frame());
762 LOG_DEBUG_PLAYER ("Emit silence for gap at %1", to_string(_silent.position()));
763 DCPTimePeriod period (_silent.period_at_position());
764 if (_next_audio_time) {
765 /* Sometimes the thing that happened last finishes fractionally before
766 or after this silence. Bodge the start time of the silence to fix it.
767 I think this is nothing to worry about since we will just add or
768 remove a little silence at the end of some content.
770 int64_t const error = labs(period.from.get() - _next_audio_time->get());
771 /* Let's not worry about less than a frame at 24fps */
772 int64_t const too_much_error = DCPTime::from_frames(1, 24).get();
773 if (error >= too_much_error) {
774 film->log()->log(String::compose("Silence starting before or after last audio by %1", error), LogEntry::TYPE_ERROR);
776 DCPOMATIC_ASSERT (error < too_much_error);
777 period.from = *_next_audio_time;
779 if (period.duration() > one_video_frame()) {
780 period.to = period.from + one_video_frame();
783 _silent.set_position (period.to);
791 /* Emit any audio that is ready */
793 /* Work out the time before which the audio is definitely all here. This is the earliest last_push_end of one
794 of our streams, or the position of the _silent. First, though we choose only streams that are less than
795 ignore_streams_behind seconds behind the furthest ahead (we assume that if a stream has fallen that far
796 behind it has finished). This is so that we don't withhold audio indefinitely awaiting data from a stream
797 that will never come, causing bugs like #2101.
799 constexpr int ignore_streams_behind = 5;
801 using state_pair = std::pair<AudioStreamPtr, StreamState>;
803 /* Find streams that have pushed */
804 std::vector<state_pair> have_pushed;
805 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); });
807 /* Find the 'leading' stream (i.e. the one that pushed data most recently) */
808 auto latest_last_push_end = std::max_element(
811 [](state_pair const& a, state_pair const& b) { return a.second.last_push_end.get() < b.second.last_push_end.get(); }
814 if (latest_last_push_end != have_pushed.end()) {
815 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()));
818 /* Now make a list of those streams that are less than ignore_streams_behind behind the leader */
819 std::map<AudioStreamPtr, StreamState> alive_stream_states;
820 for (auto const& i: _stream_states) {
821 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)) {
822 alive_stream_states.insert(i);
824 LOG_DEBUG_PLAYER("Ignoring stream %1 because it is too far behind", i.second.piece->content->path(0));
828 auto pull_to = _playback_length.load();
829 for (auto const& i: alive_stream_states) {
830 auto position = i.second.last_push_end.get_value_or(i.second.piece->content->position());
831 if (!i.second.piece->done && position < pull_to) {
835 if (!_silent.done() && _silent.position() < pull_to) {
836 pull_to = _silent.position();
839 LOG_DEBUG_PLAYER("Emitting audio up to %1", to_string(pull_to));
840 auto audio = _audio_merger.pull (pull_to);
841 for (auto i = audio.begin(); i != audio.end(); ++i) {
842 if (_next_audio_time && i->second < *_next_audio_time) {
843 /* This new data comes before the last we emitted (or the last seek); discard it */
844 auto cut = discard_audio (i->first, i->second, *_next_audio_time);
849 } else if (_next_audio_time && i->second > *_next_audio_time) {
850 /* There's a gap between this data and the last we emitted; fill with silence */
851 fill_audio (DCPTimePeriod (*_next_audio_time, i->second));
854 emit_audio (i->first, i->second);
861 for (auto const& i: _delay) {
862 do_emit_video(i.first, i.second);
865 /* Perhaps we should have Empty entries for both eyes in the 3D case (somehow).
866 * However, if we have L and R video files, and one is shorter than the other,
867 * the fill code in ::video mostly takes care of filling in the gaps.
868 * However, since it fills at the point when it knows there is more video coming
869 * at time t (so it should fill any gap up to t) it can't do anything right at the
870 * end. This is particularly bad news if the last frame emitted is a LEFT
871 * eye, as the MXF writer will complain about the 3D sequence being wrong.
872 * Here's a hack to workaround that particular case.
874 if (_next_video_eyes && _next_video_time && *_next_video_eyes == Eyes::RIGHT) {
875 do_emit_video (black_player_video_frame(Eyes::RIGHT), *_next_video_time);
883 /** @return Open subtitles for the frame at the given time, converted to images */
884 optional<PositionImage>
885 Player::open_subtitles_for_frame (DCPTime time) const
887 auto film = _film.lock();
892 list<PositionImage> captions;
893 int const vfr = film->video_frame_rate();
897 _active_texts[TextType::OPEN_SUBTITLE].get_burnt(DCPTimePeriod(time, time + DCPTime::from_frames(1, vfr)), _always_burn_open_subtitles)
900 /* Bitmap subtitles */
901 for (auto i: j.bitmap) {
906 /* i.image will already have been scaled to fit _video_container_size */
907 dcp::Size scaled_size (i.rectangle.width * _video_container_size.load().width, i.rectangle.height * _video_container_size.load().height);
913 lrint(_video_container_size.load().width * i.rectangle.x),
914 lrint(_video_container_size.load().height * i.rectangle.y)
920 /* String subtitles (rendered to an image) */
921 if (!j.string.empty()) {
922 auto s = render_text(j.string, _video_container_size, time, vfr);
923 copy (s.begin(), s.end(), back_inserter (captions));
927 if (captions.empty()) {
931 return merge (captions, _subtitle_alignment);
937 increment_eyes (Eyes e)
939 if (e == Eyes::LEFT) {
948 Player::video (weak_ptr<Piece> weak_piece, ContentVideo video)
954 auto piece = weak_piece.lock ();
959 if (!piece->content->video->use()) {
963 auto film = _film.lock();
968 FrameRateChange frc(film, piece->content);
969 if (frc.skip && (video.frame % 2) == 1) {
973 vector<Eyes> eyes_to_emit;
975 if (!film->three_d()) {
976 if (video.eyes == Eyes::RIGHT) {
977 /* 2D film, 3D content: discard right */
979 } else if (video.eyes == Eyes::LEFT) {
980 /* 2D film, 3D content: emit left as "both" */
981 video.eyes = Eyes::BOTH;
982 eyes_to_emit = { Eyes::BOTH };
985 if (video.eyes == Eyes::BOTH) {
986 /* 3D film, 2D content; emit "both" for left and right */
987 eyes_to_emit = { Eyes::LEFT, Eyes::RIGHT };
991 if (eyes_to_emit.empty()) {
992 eyes_to_emit = { video.eyes };
995 /* Time of the first frame we will emit */
996 DCPTime const time = content_video_to_dcp (piece, video.frame);
997 LOG_DEBUG_PLAYER("Received video frame %1 at %2", video.frame, to_string(time));
999 /* Discard if it's before the content's period or the last accurate seek. We can't discard
1000 if it's after the content's period here as in that case we still need to fill any gap between
1001 `now' and the end of the content's period.
1003 if (time < piece->content->position() || (_next_video_time && time < *_next_video_time)) {
1007 if (piece->ignore_video && piece->ignore_video->contains(time)) {
1011 /* Fill gaps that we discover now that we have some video which needs to be emitted.
1012 This is where we need to fill to.
1014 DCPTime fill_to = min(time, piece->content->end(film));
1016 if (_next_video_time) {
1017 DCPTime fill_from = max (*_next_video_time, piece->content->position());
1019 /* Fill if we have more than half a frame to do */
1020 if ((fill_to - fill_from) > one_video_frame() / 2) {
1021 auto last = _last_video.find (weak_piece);
1022 if (film->three_d()) {
1023 auto fill_to_eyes = eyes_to_emit[0];
1024 if (fill_to_eyes == Eyes::BOTH) {
1025 fill_to_eyes = Eyes::LEFT;
1027 if (fill_to == piece->content->end(film)) {
1028 /* Don't fill after the end of the content */
1029 fill_to_eyes = Eyes::LEFT;
1032 auto eyes = _next_video_eyes.get_value_or(Eyes::LEFT);
1033 if (eyes == Eyes::BOTH) {
1036 while (j < fill_to || eyes != fill_to_eyes) {
1037 if (last != _last_video.end()) {
1038 LOG_DEBUG_PLAYER("Fill using last video at %1 in 3D mode", to_string(j));
1039 auto copy = last->second->shallow_copy();
1040 copy->set_eyes (eyes);
1041 emit_video (copy, j);
1043 LOG_DEBUG_PLAYER("Fill using black at %1 in 3D mode", to_string(j));
1044 emit_video (black_player_video_frame(eyes), j);
1046 if (eyes == Eyes::RIGHT) {
1047 j += one_video_frame();
1049 eyes = increment_eyes (eyes);
1052 for (DCPTime j = fill_from; j < fill_to; j += one_video_frame()) {
1053 if (last != _last_video.end()) {
1054 emit_video (last->second, j);
1056 emit_video (black_player_video_frame(Eyes::BOTH), j);
1063 auto const content_video = piece->content->video;
1065 for (auto eyes: eyes_to_emit) {
1066 _last_video[weak_piece] = std::make_shared<PlayerVideo>(
1068 content_video->actual_crop(),
1069 content_video->fade(film, video.frame),
1071 content_video->scaled_size(film->frame_size()),
1072 _video_container_size,
1074 content_video->pixel_quanta()
1076 _video_container_size,
1079 content_video->colour_conversion(),
1080 content_video->range(),
1087 for (int i = 0; i < frc.repeat; ++i) {
1088 if (t < piece->content->end(film)) {
1089 emit_video (_last_video[weak_piece], t);
1091 t += one_video_frame ();
1098 Player::audio (weak_ptr<Piece> weak_piece, AudioStreamPtr stream, ContentAudio content_audio)
1104 DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
1106 auto piece = weak_piece.lock ();
1111 auto film = _film.lock();
1116 auto content = piece->content->audio;
1117 DCPOMATIC_ASSERT (content);
1119 int const rfr = content->resampled_frame_rate(film);
1121 /* Compute time in the DCP */
1122 auto time = resampled_audio_to_dcp (piece, content_audio.frame);
1124 /* And the end of this block in the DCP */
1125 auto end = time + DCPTime::from_frames(content_audio.audio->frames(), rfr);
1126 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());
1128 /* Remove anything that comes before the start or after the end of the content */
1129 if (time < piece->content->position()) {
1130 auto cut = discard_audio (content_audio.audio, time, piece->content->position());
1132 /* This audio is entirely discarded */
1135 content_audio.audio = cut.first;
1137 } else if (time > piece->content->end(film)) {
1138 /* Discard it all */
1140 } else if (end > piece->content->end(film)) {
1141 Frame const remaining_frames = DCPTime(piece->content->end(film) - time).frames_round(rfr);
1142 if (remaining_frames == 0) {
1145 content_audio.audio = make_shared<AudioBuffers>(content_audio.audio, remaining_frames, 0);
1148 DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
1152 auto const fade_coeffs = content->fade (stream, content_audio.frame, content_audio.audio->frames(), rfr);
1153 if (content->gain() != 0 || !fade_coeffs.empty()) {
1154 auto gain_buffers = make_shared<AudioBuffers>(content_audio.audio);
1155 if (!fade_coeffs.empty()) {
1156 /* Apply both fade and gain */
1157 DCPOMATIC_ASSERT (fade_coeffs.size() == static_cast<size_t>(gain_buffers->frames()));
1158 auto const channels = gain_buffers->channels();
1159 auto const frames = fade_coeffs.size();
1160 auto data = gain_buffers->data();
1161 auto const gain = db_to_linear (content->gain());
1162 for (auto channel = 0; channel < channels; ++channel) {
1163 for (auto frame = 0U; frame < frames; ++frame) {
1164 data[channel][frame] *= gain * fade_coeffs[frame];
1168 /* Just apply gain */
1169 gain_buffers->apply_gain (content->gain());
1171 content_audio.audio = gain_buffers;
1176 content_audio.audio = remap(content_audio.audio, film->audio_channels(), stream->mapping());
1180 if (_audio_processor) {
1181 content_audio.audio = _audio_processor->run(content_audio.audio, film->audio_channels());
1186 _audio_merger.push (content_audio.audio, time);
1187 DCPOMATIC_ASSERT (_stream_states.find (stream) != _stream_states.end ());
1188 _stream_states[stream].last_push_end = time + DCPTime::from_frames(content_audio.audio->frames(), film->audio_frame_rate());
1193 Player::bitmap_text_start (weak_ptr<Piece> weak_piece, weak_ptr<const TextContent> weak_content, ContentBitmapText subtitle)
1199 auto piece = weak_piece.lock ();
1200 auto content = weak_content.lock ();
1201 if (!piece || !content) {
1206 for (auto& sub: subtitle.subs)
1208 /* Apply content's subtitle offsets */
1209 sub.rectangle.x += content->x_offset ();
1210 sub.rectangle.y += content->y_offset ();
1212 /* Apply a corrective translation to keep the subtitle centred after the scale that is coming up */
1213 sub.rectangle.x -= sub.rectangle.width * ((content->x_scale() - 1) / 2);
1214 sub.rectangle.y -= sub.rectangle.height * ((content->y_scale() - 1) / 2);
1216 /* Apply content's subtitle scale */
1217 sub.rectangle.width *= content->x_scale ();
1218 sub.rectangle.height *= content->y_scale ();
1220 auto image = sub.image;
1222 /* We will scale the subtitle up to fit _video_container_size */
1223 int const width = sub.rectangle.width * _video_container_size.load().width;
1224 int const height = sub.rectangle.height * _video_container_size.load().height;
1225 if (width == 0 || height == 0) {
1229 dcp::Size scaled_size (width, height);
1230 ps.bitmap.push_back (BitmapText(image->scale(scaled_size, dcp::YUVToRGB::REC601, image->pixel_format(), Image::Alignment::PADDED, _fast), sub.rectangle));
1233 DCPTime from(content_time_to_dcp(piece, subtitle.from()));
1234 _active_texts[content->type()].add_from(weak_content, ps, from);
1239 Player::plain_text_start (weak_ptr<Piece> weak_piece, weak_ptr<const TextContent> weak_content, ContentStringText subtitle)
1245 auto piece = weak_piece.lock ();
1246 auto content = weak_content.lock ();
1247 auto film = _film.lock();
1248 if (!piece || !content || !film) {
1253 DCPTime const from (content_time_to_dcp (piece, subtitle.from()));
1255 if (from > piece->content->end(film)) {
1259 for (auto s: subtitle.subs) {
1260 s.set_h_position (s.h_position() + content->x_offset());
1261 s.set_v_position (s.v_position() + content->y_offset());
1262 float const xs = content->x_scale();
1263 float const ys = content->y_scale();
1264 float size = s.size();
1266 /* Adjust size to express the common part of the scaling;
1267 e.g. if xs = ys = 0.5 we scale size by 2.
1269 if (xs > 1e-5 && ys > 1e-5) {
1270 size *= 1 / min (1 / xs, 1 / ys);
1274 /* Then express aspect ratio changes */
1275 if (fabs (1.0 - xs / ys) > dcp::ASPECT_ADJUST_EPSILON) {
1276 s.set_aspect_adjust (xs / ys);
1279 s.set_in (dcp::Time(from.seconds(), 1000));
1280 ps.string.push_back (s);
1283 _active_texts[content->type()].add_from(weak_content, ps, from);
1288 Player::subtitle_stop (weak_ptr<Piece> weak_piece, weak_ptr<const TextContent> weak_content, ContentTime to)
1294 auto content = weak_content.lock ();
1299 if (!_active_texts[content->type()].have(weak_content)) {
1303 auto piece = weak_piece.lock ();
1304 auto film = _film.lock();
1305 if (!piece || !film) {
1309 DCPTime const dcp_to = content_time_to_dcp (piece, to);
1311 if (dcp_to > piece->content->end(film)) {
1315 auto from = _active_texts[content->type()].add_to(weak_content, dcp_to);
1317 bool const always = (content->type() == TextType::OPEN_SUBTITLE && _always_burn_open_subtitles);
1318 if (content->use() && !always && !content->burn()) {
1319 Text (from.first, content->type(), content->dcp_track().get_value_or(DCPTextTrack()), DCPTimePeriod(from.second, dcp_to));
1325 Player::seek (DCPTime time, bool accurate)
1327 boost::mutex::scoped_lock lm (_mutex);
1328 LOG_DEBUG_PLAYER("Seek to %1 (%2accurate)", to_string(time), accurate ? "" : "in");
1331 /* We can't seek in this state */
1335 auto film = _film.lock();
1341 _shuffler->clear ();
1346 if (_audio_processor) {
1347 _audio_processor->flush ();
1350 _audio_merger.clear ();
1351 std::for_each(_active_texts.begin(), _active_texts.end(), [](ActiveText& a) { a.clear(); });
1353 for (auto i: _pieces) {
1354 if (time < i->content->position()) {
1355 /* Before; seek to the start of the content. Even if this request is for an inaccurate seek
1356 we must seek this (following) content accurately, otherwise when we come to the end of the current
1357 content we may not start right at the beginning of the next, causing a gap (if the next content has
1358 been trimmed to a point between keyframes, or something).
1360 i->decoder->seek (dcp_to_content_time (i, i->content->position()), true);
1362 } else if (i->content->position() <= time && time < i->content->end(film)) {
1363 /* During; seek to position */
1364 i->decoder->seek (dcp_to_content_time (i, time), accurate);
1367 /* After; this piece is done */
1373 _next_video_time = time;
1374 _next_video_eyes = Eyes::LEFT;
1375 _next_audio_time = time;
1377 _next_video_time = boost::none;
1378 _next_video_eyes = boost::none;
1379 _next_audio_time = boost::none;
1382 _black.set_position (time);
1383 _silent.set_position (time);
1385 _last_video.clear ();
1387 for (auto& state: _stream_states) {
1388 state.second.last_push_end = boost::none;
1394 Player::emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1396 auto film = _film.lock();
1397 DCPOMATIC_ASSERT(film);
1399 if (!film->three_d()) {
1400 if (pv->eyes() == Eyes::LEFT) {
1401 /* Use left-eye images for both eyes... */
1402 pv->set_eyes (Eyes::BOTH);
1403 } else if (pv->eyes() == Eyes::RIGHT) {
1404 /* ...and discard the right */
1409 /* We need a delay to give a little wiggle room to ensure that relevant subtitles arrive at the
1410 player before the video that requires them.
1412 _delay.push_back (make_pair (pv, time));
1414 if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
1415 _next_video_time = time + one_video_frame();
1417 _next_video_eyes = increment_eyes (pv->eyes());
1419 if (_delay.size() < 3) {
1423 auto to_do = _delay.front();
1425 do_emit_video (to_do.first, to_do.second);
1430 Player::do_emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1432 if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
1433 std::for_each(_active_texts.begin(), _active_texts.end(), [time](ActiveText& a) { a.clear_before(time); });
1436 auto subtitles = open_subtitles_for_frame (time);
1438 pv->set_text (subtitles.get ());
1446 Player::emit_audio (shared_ptr<AudioBuffers> data, DCPTime time)
1448 auto film = _film.lock();
1449 DCPOMATIC_ASSERT(film);
1451 /* Log if the assert below is about to fail */
1452 if (_next_audio_time && labs(time.get() - _next_audio_time->get()) > 1) {
1453 film->log()->log(String::compose("Out-of-sequence emit %1 vs %2", to_string(time), to_string(*_next_audio_time)), LogEntry::TYPE_WARNING);
1456 /* This audio must follow on from the previous, allowing for half a sample (at 48kHz) leeway */
1457 DCPOMATIC_ASSERT (!_next_audio_time || labs(time.get() - _next_audio_time->get()) < 2);
1458 Audio(data, time, film->audio_frame_rate());
1459 _next_audio_time = time + DCPTime::from_frames(data->frames(), film->audio_frame_rate());
1464 Player::fill_audio (DCPTimePeriod period)
1466 auto film = _film.lock();
1467 DCPOMATIC_ASSERT(film);
1469 if (period.from == period.to) {
1473 DCPOMATIC_ASSERT (period.from < period.to);
1475 DCPTime t = period.from;
1476 while (t < period.to) {
1477 DCPTime block = min (DCPTime::from_seconds (0.5), period.to - t);
1478 Frame const samples = block.frames_round(film->audio_frame_rate());
1480 auto silence = make_shared<AudioBuffers>(film->audio_channels(), samples);
1481 silence->make_silent ();
1482 emit_audio (silence, t);
1490 Player::one_video_frame () const
1492 auto film = _film.lock();
1493 DCPOMATIC_ASSERT(film);
1495 return DCPTime::from_frames(1, film->video_frame_rate ());
1499 pair<shared_ptr<AudioBuffers>, DCPTime>
1500 Player::discard_audio (shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to) const
1502 auto film = _film.lock();
1503 DCPOMATIC_ASSERT(film);
1505 auto const discard_time = discard_to - time;
1506 auto const discard_frames = discard_time.frames_round(film->audio_frame_rate());
1507 auto remaining_frames = audio->frames() - discard_frames;
1508 if (remaining_frames <= 0) {
1509 return make_pair(shared_ptr<AudioBuffers>(), DCPTime());
1511 auto cut = make_shared<AudioBuffers>(audio, remaining_frames, discard_frames);
1512 return make_pair(cut, time + discard_time);
1517 Player::set_dcp_decode_reduction (optional<int> reduction)
1519 ChangeSignaller<Player, int> cc(this, PlayerProperty::DCP_DECODE_REDUCTION);
1521 if (reduction == _dcp_decode_reduction.load()) {
1526 _dcp_decode_reduction = reduction;
1532 Player::content_time_to_dcp (shared_ptr<const Content> content, ContentTime t) const
1534 boost::mutex::scoped_lock lm (_mutex);
1536 for (auto i: _pieces) {
1537 if (i->content == content) {
1538 return content_time_to_dcp (i, t);
1542 /* We couldn't find this content; perhaps things are being changed over */
1547 optional<ContentTime>
1548 Player::dcp_to_content_time (shared_ptr<const Content> content, DCPTime t) const
1550 boost::mutex::scoped_lock lm (_mutex);
1552 for (auto i: _pieces) {
1553 if (i->content == content) {
1554 return dcp_to_content_time (i, t);
1558 /* We couldn't find this content; perhaps things are being changed over */
1563 shared_ptr<const Playlist>
1564 Player::playlist () const
1566 auto film = _film.lock();
1571 return _playlist ? _playlist : film->playlist();
1576 Player::atmos (weak_ptr<Piece> weak_piece, ContentAtmos data)
1582 auto film = _film.lock();
1583 DCPOMATIC_ASSERT(film);
1585 auto piece = weak_piece.lock ();
1586 DCPOMATIC_ASSERT (piece);
1588 auto const vfr = film->video_frame_rate();
1590 DCPTime const dcp_time = DCPTime::from_frames(data.frame, vfr) - DCPTime(piece->content->trim_start(), FrameRateChange(vfr, vfr));
1591 if (dcp_time < piece->content->position() || dcp_time >= (piece->content->end(film))) {
1595 Atmos (data.data, dcp_time, data.metadata);
1600 Player::signal_change(ChangeType type, int property)
1602 Change(type, property, false);