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 "referenced_reel_asset.h"
51 #include "render_text.h"
53 #include "text_content.h"
54 #include "text_decoder.h"
56 #include "video_decoder.h"
58 #include <dcp/reel_closed_caption_asset.h>
59 #include <dcp/reel_picture_asset.h>
60 #include <dcp/reel_sound_asset.h>
61 #include <dcp/reel_subtitle_asset.h>
71 using std::dynamic_pointer_cast;
74 using std::make_shared;
75 using std::make_shared;
80 using std::shared_ptr;
83 using boost::optional;
84 using boost::scoped_ptr;
85 #if BOOST_VERSION >= 106100
86 using namespace boost::placeholders;
88 using namespace dcpomatic;
91 int const PlayerProperty::VIDEO_CONTAINER_SIZE = 700;
92 int const PlayerProperty::PLAYLIST = 701;
93 int const PlayerProperty::FILM_CONTAINER = 702;
94 int const PlayerProperty::FILM_VIDEO_FRAME_RATE = 703;
95 int const PlayerProperty::DCP_DECODE_REDUCTION = 704;
96 int const PlayerProperty::PLAYBACK_LENGTH = 705;
99 Player::Player (shared_ptr<const Film> film, Image::Alignment subtitle_alignment)
102 , _ignore_video(false)
103 , _ignore_audio(false)
104 , _ignore_text(false)
105 , _always_burn_open_subtitles(false)
107 , _tolerant (film->tolerant())
108 , _play_referenced(false)
109 , _audio_merger (_film->audio_frame_rate())
110 , _subtitle_alignment (subtitle_alignment)
116 Player::Player (shared_ptr<const Film> film, shared_ptr<const Playlist> playlist_)
118 , _playlist (playlist_)
120 , _ignore_video(false)
121 , _ignore_audio(false)
122 , _ignore_text(false)
123 , _always_burn_open_subtitles(false)
125 , _tolerant (film->tolerant())
126 , _play_referenced(false)
127 , _audio_merger (_film->audio_frame_rate())
136 _film_changed_connection = _film->Change.connect (bind (&Player::film_change, this, _1, _2));
137 /* The butler must hear about this first, so since we are proxying this through to the butler we must
140 _playlist_change_connection = playlist()->Change.connect (bind (&Player::playlist_change, this, _1), boost::signals2::at_front);
141 _playlist_content_change_connection = playlist()->ContentChange.connect (bind(&Player::playlist_content_change, this, _1, _3, _4));
142 set_video_container_size (_film->frame_size ());
144 film_change (ChangeType::DONE, Film::Property::AUDIO_PROCESSOR);
147 seek (DCPTime (), true);
152 have_video (shared_ptr<const Content> content)
154 return static_cast<bool>(content->video) && content->video->use() && content->can_be_played();
159 have_audio (shared_ptr<const Content> content)
161 return static_cast<bool>(content->audio) && content->can_be_played();
166 Player::setup_pieces ()
168 boost::mutex::scoped_lock lm (_mutex);
170 _playback_length = _playlist ? _playlist->length(_film) : _film->length();
172 auto old_pieces = _pieces;
175 auto playlist_content = playlist()->content();
176 bool const have_threed = std::any_of(
177 playlist_content.begin(),
178 playlist_content.end(),
179 [](shared_ptr<const Content> c) {
180 return c->video && (c->video->frame_type() == VideoFrameType::THREE_D_LEFT || c->video->frame_type() == VideoFrameType::THREE_D_RIGHT);
185 _shuffler.reset(new Shuffler());
186 _shuffler->Video.connect(bind(&Player::video, this, _1, _2));
189 for (auto i: playlist()->content()) {
191 if (!i->paths_valid ()) {
195 if (_ignore_video && _ignore_audio && i->text.empty()) {
196 /* We're only interested in text and this content has none */
200 shared_ptr<Decoder> old_decoder;
201 for (auto j: old_pieces) {
202 if (j->content == i) {
203 old_decoder = j->decoder;
208 auto decoder = decoder_factory (_film, i, _fast, _tolerant, old_decoder);
209 DCPOMATIC_ASSERT (decoder);
211 FrameRateChange frc (_film, i);
213 if (decoder->video && _ignore_video) {
214 decoder->video->set_ignore (true);
217 if (decoder->audio && _ignore_audio) {
218 decoder->audio->set_ignore (true);
222 for (auto i: decoder->text) {
223 i->set_ignore (true);
227 auto dcp = dynamic_pointer_cast<DCPDecoder> (decoder);
229 dcp->set_decode_referenced (_play_referenced);
230 if (_play_referenced) {
231 dcp->set_forced_reduction (_dcp_decode_reduction);
235 auto piece = make_shared<Piece>(i, decoder, frc);
236 _pieces.push_back (piece);
238 if (decoder->video) {
240 /* We need a Shuffler to cope with 3D L/R video data arriving out of sequence */
241 decoder->video->Data.connect (bind(&Shuffler::video, _shuffler.get(), weak_ptr<Piece>(piece), _1));
243 decoder->video->Data.connect (bind(&Player::video, this, weak_ptr<Piece>(piece), _1));
247 if (decoder->audio) {
248 decoder->audio->Data.connect (bind (&Player::audio, this, weak_ptr<Piece> (piece), _1, _2));
251 auto j = decoder->text.begin();
253 while (j != decoder->text.end()) {
254 (*j)->BitmapStart.connect (
255 bind(&Player::bitmap_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
257 (*j)->PlainStart.connect (
258 bind(&Player::plain_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
261 bind(&Player::subtitle_stop, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
267 if (decoder->atmos) {
268 decoder->atmos->Data.connect (bind(&Player::atmos, this, weak_ptr<Piece>(piece), _1));
272 _stream_states.clear ();
273 for (auto i: _pieces) {
274 if (i->content->audio) {
275 for (auto j: i->content->audio->streams()) {
276 _stream_states[j] = StreamState (i, i->content->position ());
281 auto ignore_overlap = [](shared_ptr<VideoContent> v) {
282 return v && v->use() && v->frame_type() != VideoFrameType::THREE_D_LEFT && v->frame_type() != VideoFrameType::THREE_D_RIGHT;
285 for (auto i = _pieces.begin(); i != _pieces.end(); ++i) {
286 if (ignore_overlap((*i)->content->video)) {
287 /* Look for content later in the content list with in-use video that overlaps this */
288 auto const period = DCPTimePeriod((*i)->content->position(), (*i)->content->end(_film));
289 for (auto j = std::next(i); j != _pieces.end(); ++j) {
290 if ((*j)->content->video && ignore_overlap((*j)->content->video)) {
291 (*i)->ignore_video = DCPTimePeriod((*j)->content->position(), (*j)->content->end(_film)).overlap(period);
297 _black = Empty (_film, playlist(), bind(&have_video, _1), _playback_length);
298 _silent = Empty (_film, playlist(), bind(&have_audio, _1), _playback_length);
300 _next_video_time = boost::none;
301 _next_video_eyes = Eyes::BOTH;
302 _next_audio_time = boost::none;
307 Player::playlist_content_change (ChangeType type, int property, bool frequent)
309 if (property == VideoContentProperty::CROP) {
310 if (type == ChangeType::DONE) {
311 auto const vcs = video_container_size();
312 boost::mutex::scoped_lock lm (_mutex);
313 for (auto const& i: _delay) {
314 i.first->reset_metadata (_film, vcs);
318 if (type == ChangeType::PENDING) {
319 /* The player content is probably about to change, so we can't carry on
320 until that has happened and we've rebuilt our pieces. Stop pass()
321 and seek() from working until then.
324 } else if (type == ChangeType::DONE) {
325 /* A change in our content has gone through. Re-build our pieces. */
328 } else if (type == ChangeType::CANCELLED) {
333 Change (type, property, frequent);
338 Player::set_video_container_size (dcp::Size s)
340 Change (ChangeType::PENDING, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
342 if (s == _video_container_size) {
343 Change(ChangeType::CANCELLED, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
347 _video_container_size = s;
350 boost::mutex::scoped_lock lm (_mutex);
351 _black_image = make_shared<Image>(AV_PIX_FMT_RGB24, _video_container_size, Image::Alignment::PADDED);
352 _black_image->make_black ();
355 Change (ChangeType::DONE, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
360 Player::playlist_change (ChangeType type)
362 if (type == ChangeType::DONE) {
365 Change (type, PlayerProperty::PLAYLIST, false);
370 Player::film_change (ChangeType type, Film::Property p)
372 /* Here we should notice Film properties that affect our output, and
373 alert listeners that our output now would be different to how it was
374 last time we were run.
377 if (p == Film::Property::CONTAINER) {
378 Change (type, PlayerProperty::FILM_CONTAINER, false);
379 } else if (p == Film::Property::VIDEO_FRAME_RATE) {
380 /* Pieces contain a FrameRateChange which contains the DCP frame rate,
381 so we need new pieces here.
383 if (type == ChangeType::DONE) {
386 Change (type, PlayerProperty::FILM_VIDEO_FRAME_RATE, false);
387 } else if (p == Film::Property::AUDIO_PROCESSOR) {
388 if (type == ChangeType::DONE && _film->audio_processor ()) {
389 boost::mutex::scoped_lock lm (_mutex);
390 _audio_processor = _film->audio_processor()->clone (_film->audio_frame_rate ());
392 } else if (p == Film::Property::AUDIO_CHANNELS) {
393 if (type == ChangeType::DONE) {
394 boost::mutex::scoped_lock lm (_mutex);
395 _audio_merger.clear ();
401 shared_ptr<PlayerVideo>
402 Player::black_player_video_frame (Eyes eyes) const
404 return std::make_shared<PlayerVideo> (
405 std::make_shared<const RawImageProxy>(_black_image),
408 _video_container_size,
409 _video_container_size,
412 PresetColourConversion::all().front().conversion,
414 std::weak_ptr<Content>(),
415 boost::optional<Frame>(),
422 Player::dcp_to_content_video (shared_ptr<const Piece> piece, DCPTime t) const
424 auto s = t - piece->content->position ();
425 s = min (piece->content->length_after_trim(_film), s);
426 s = max (DCPTime(), s + DCPTime (piece->content->trim_start(), piece->frc));
428 /* It might seem more logical here to convert s to a ContentTime (using the FrameRateChange)
429 then convert that ContentTime to frames at the content's rate. However this fails for
430 situations like content at 29.9978733fps, DCP at 30fps. The accuracy of the Time type is not
431 enough to distinguish between the two with low values of time (e.g. 3200 in Time units).
433 Instead we convert the DCPTime using the DCP video rate then account for any skip/repeat.
435 return s.frames_floor (piece->frc.dcp) / piece->frc.factor ();
440 Player::content_video_to_dcp (shared_ptr<const Piece> piece, Frame f) const
442 /* See comment in dcp_to_content_video */
443 auto const d = DCPTime::from_frames (f * piece->frc.factor(), piece->frc.dcp) - DCPTime(piece->content->trim_start(), piece->frc);
444 return d + piece->content->position();
449 Player::dcp_to_resampled_audio (shared_ptr<const Piece> piece, DCPTime t) const
451 auto s = t - piece->content->position ();
452 s = min (piece->content->length_after_trim(_film), s);
453 /* See notes in dcp_to_content_video */
454 return max (DCPTime(), DCPTime(piece->content->trim_start(), piece->frc) + s).frames_floor(_film->audio_frame_rate());
459 Player::resampled_audio_to_dcp (shared_ptr<const Piece> piece, Frame f) const
461 /* See comment in dcp_to_content_video */
462 return DCPTime::from_frames (f, _film->audio_frame_rate())
463 - DCPTime (piece->content->trim_start(), piece->frc)
464 + piece->content->position();
469 Player::dcp_to_content_time (shared_ptr<const Piece> piece, DCPTime t) const
471 auto s = t - piece->content->position ();
472 s = min (piece->content->length_after_trim(_film), s);
473 return max (ContentTime (), ContentTime (s, piece->frc) + piece->content->trim_start());
478 Player::content_time_to_dcp (shared_ptr<const Piece> piece, ContentTime t) const
480 return max (DCPTime(), DCPTime(t - piece->content->trim_start(), piece->frc) + piece->content->position());
484 vector<shared_ptr<Font>>
485 Player::get_subtitle_fonts ()
487 boost::mutex::scoped_lock lm (_mutex);
489 vector<shared_ptr<Font>> fonts;
490 for (auto piece: _pieces) {
491 for (auto text: piece->content->text) {
492 auto text_fonts = text->fonts();
493 copy (text_fonts.begin(), text_fonts.end(), back_inserter(fonts));
501 /** Set this player never to produce any video data */
503 Player::set_ignore_video ()
505 _ignore_video = true;
511 Player::set_ignore_audio ()
513 _ignore_audio = true;
519 Player::set_ignore_text ()
526 /** Set the player to always burn open texts into the image regardless of the content settings */
528 Player::set_always_burn_open_subtitles ()
530 _always_burn_open_subtitles = true;
534 /** Sets up the player to be faster, possibly at the expense of quality */
544 Player::set_play_referenced ()
546 _play_referenced = true;
552 maybe_add_asset (list<ReferencedReelAsset>& a, shared_ptr<dcp::ReelAsset> r, Frame reel_trim_start, Frame reel_trim_end, DCPTime from, int const ffr)
554 DCPOMATIC_ASSERT (r);
555 r->set_entry_point (r->entry_point().get_value_or(0) + reel_trim_start);
556 r->set_duration (r->actual_duration() - reel_trim_start - reel_trim_end);
557 if (r->actual_duration() > 0) {
559 ReferencedReelAsset(r, DCPTimePeriod(from, from + DCPTime::from_frames(r->actual_duration(), ffr)))
565 list<ReferencedReelAsset>
566 Player::get_reel_assets ()
568 /* Does not require a lock on _mutex as it's only called from DCPEncoder */
570 list<ReferencedReelAsset> reel_assets;
572 for (auto content: playlist()->content()) {
573 auto dcp = dynamic_pointer_cast<DCPContent>(content);
578 if (!dcp->reference_video() && !dcp->reference_audio() && !dcp->reference_text(TextType::OPEN_SUBTITLE) && !dcp->reference_text(TextType::CLOSED_CAPTION)) {
582 scoped_ptr<DCPDecoder> decoder;
584 decoder.reset (new DCPDecoder(_film, dcp, false, false, shared_ptr<DCPDecoder>()));
589 auto const frame_rate = _film->video_frame_rate();
590 DCPOMATIC_ASSERT (dcp->video_frame_rate());
591 /* We should only be referencing if the DCP rate is the same as the film rate */
592 DCPOMATIC_ASSERT (std::round(dcp->video_frame_rate().get()) == frame_rate);
594 Frame const trim_start = dcp->trim_start().frames_round(frame_rate);
595 Frame const trim_end = dcp->trim_end().frames_round(frame_rate);
597 /* position in the asset from the start */
598 int64_t offset_from_start = 0;
599 /* position i the asset from the end */
600 int64_t offset_from_end = 0;
601 for (auto reel: decoder->reels()) {
602 /* Assume that main picture duration is the length of the reel */
603 offset_from_end += reel->main_picture()->actual_duration();
606 for (auto reel: decoder->reels()) {
608 /* Assume that main picture duration is the length of the reel */
609 int64_t const reel_duration = reel->main_picture()->actual_duration();
611 /* See doc/design/trim_reels.svg */
612 Frame const reel_trim_start = min(reel_duration, max(int64_t(0), trim_start - offset_from_start));
613 Frame const reel_trim_end = min(reel_duration, max(int64_t(0), reel_duration - (offset_from_end - trim_end)));
615 auto const from = content->position() + std::max(DCPTime(), DCPTime::from_frames(offset_from_start - trim_start, frame_rate));
616 if (dcp->reference_video()) {
617 maybe_add_asset (reel_assets, reel->main_picture(), reel_trim_start, reel_trim_end, from, frame_rate);
620 if (dcp->reference_audio()) {
621 maybe_add_asset (reel_assets, reel->main_sound(), reel_trim_start, reel_trim_end, from, frame_rate);
624 if (dcp->reference_text(TextType::OPEN_SUBTITLE)) {
625 maybe_add_asset (reel_assets, reel->main_subtitle(), reel_trim_start, reel_trim_end, from, frame_rate);
628 if (dcp->reference_text(TextType::CLOSED_CAPTION)) {
629 for (auto caption: reel->closed_captions()) {
630 maybe_add_asset (reel_assets, caption, reel_trim_start, reel_trim_end, from, frame_rate);
634 offset_from_start += reel_duration;
635 offset_from_end -= reel_duration;
646 boost::mutex::scoped_lock lm (_mutex);
649 /* We can't pass in this state */
650 LOG_DEBUG_PLAYER_NC ("Player is suspended");
654 if (_playback_length == DCPTime()) {
655 /* Special; just give one black frame */
656 emit_video (black_player_video_frame(Eyes::BOTH), DCPTime());
660 /* Find the decoder or empty which is farthest behind where we are and make it emit some data */
662 shared_ptr<Piece> earliest_content;
663 optional<DCPTime> earliest_time;
665 for (auto i: _pieces) {
670 auto const t = content_time_to_dcp (i, max(i->decoder->position(), i->content->trim_start()));
671 if (t > i->content->end(_film)) {
675 /* Given two choices at the same time, pick the one with texts so we see it before
678 if (!earliest_time || t < *earliest_time || (t == *earliest_time && !i->decoder->text.empty())) {
680 earliest_content = i;
694 if (earliest_content) {
698 if (!_black.done() && !_ignore_video && (!earliest_time || _black.position() < *earliest_time)) {
699 earliest_time = _black.position ();
703 if (!_silent.done() && !_ignore_audio && (!earliest_time || _silent.position() < *earliest_time)) {
704 earliest_time = _silent.position ();
711 LOG_DEBUG_PLAYER ("Calling pass() on %1", earliest_content->content->path(0));
712 earliest_content->done = earliest_content->decoder->pass ();
713 auto dcp = dynamic_pointer_cast<DCPContent>(earliest_content->content);
714 if (dcp && !_play_referenced && dcp->reference_audio()) {
715 /* We are skipping some referenced DCP audio content, so we need to update _next_audio_time
716 to `hide' the fact that no audio was emitted during the referenced DCP (though
717 we need to behave as though it was).
719 _next_audio_time = dcp->end (_film);
724 LOG_DEBUG_PLAYER ("Emit black for gap at %1", to_string(_black.position()));
725 emit_video (black_player_video_frame(Eyes::BOTH), _black.position());
726 _black.set_position (_black.position() + one_video_frame());
730 LOG_DEBUG_PLAYER ("Emit silence for gap at %1", to_string(_silent.position()));
731 DCPTimePeriod period (_silent.period_at_position());
732 if (_next_audio_time) {
733 /* Sometimes the thing that happened last finishes fractionally before
734 or after this silence. Bodge the start time of the silence to fix it.
735 I think this is nothing to worry about since we will just add or
736 remove a little silence at the end of some content.
738 int64_t const error = labs(period.from.get() - _next_audio_time->get());
739 /* Let's not worry about less than a frame at 24fps */
740 int64_t const too_much_error = DCPTime::from_frames(1, 24).get();
741 if (error >= too_much_error) {
742 _film->log()->log(String::compose("Silence starting before or after last audio by %1", error), LogEntry::TYPE_ERROR);
744 DCPOMATIC_ASSERT (error < too_much_error);
745 period.from = *_next_audio_time;
747 if (period.duration() > one_video_frame()) {
748 period.to = period.from + one_video_frame();
751 _silent.set_position (period.to);
759 /* Emit any audio that is ready */
761 /* Work out the time before which the audio is definitely all here. This is the earliest last_push_end of one
762 of our streams, or the position of the _silent. First, though we choose only streams that are less than
763 ignore_streams_behind seconds behind the furthest ahead (we assume that if a stream has fallen that far
764 behind it has finished). This is so that we don't withhold audio indefinitely awaiting data from a stream
765 that will never come, causing bugs like #2101.
767 constexpr int ignore_streams_behind = 5;
769 using state_pair = std::pair<AudioStreamPtr, StreamState>;
771 /* Find the 'leading' stream (i.e. the one that pushed data most recently) */
772 auto latest_last_push_end = std::max_element(
773 _stream_states.begin(),
774 _stream_states.end(),
775 [](state_pair const& a, state_pair const& b) { return a.second.last_push_end < b.second.last_push_end; }
778 if (latest_last_push_end != _stream_states.end()) {
779 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));
782 /* Now make a list of those streams that are less than ignore_streams_behind behind the leader */
783 std::map<AudioStreamPtr, StreamState> alive_stream_states;
784 for (auto const& i: _stream_states) {
785 if ((latest_last_push_end->second.last_push_end - i.second.last_push_end) < dcpomatic::DCPTime::from_seconds(ignore_streams_behind)) {
786 alive_stream_states.insert(i);
788 LOG_DEBUG_PLAYER("Ignoring stream %1 because it is too far behind", i.second.piece->content->path(0));
792 auto pull_to = _playback_length;
793 for (auto const& i: alive_stream_states) {
794 if (!i.second.piece->done && i.second.last_push_end < pull_to) {
795 pull_to = i.second.last_push_end;
798 if (!_silent.done() && _silent.position() < pull_to) {
799 pull_to = _silent.position();
802 LOG_DEBUG_PLAYER("Emitting audio up to %1", to_string(pull_to));
803 auto audio = _audio_merger.pull (pull_to);
804 for (auto i = audio.begin(); i != audio.end(); ++i) {
805 if (_next_audio_time && i->second < *_next_audio_time) {
806 /* This new data comes before the last we emitted (or the last seek); discard it */
807 auto cut = discard_audio (i->first, i->second, *_next_audio_time);
812 } else if (_next_audio_time && i->second > *_next_audio_time) {
813 /* There's a gap between this data and the last we emitted; fill with silence */
814 fill_audio (DCPTimePeriod (*_next_audio_time, i->second));
817 emit_audio (i->first, i->second);
824 for (auto const& i: _delay) {
825 do_emit_video(i.first, i.second);
828 /* Perhaps we should have Empty entries for both eyes in the 3D case (somehow).
829 * However, if we have L and R video files, and one is shorter than the other,
830 * the fill code in ::video mostly takes care of filling in the gaps.
831 * However, since it fills at the point when it knows there is more video coming
832 * at time t (so it should fill any gap up to t) it can't do anything right at the
833 * end. This is particularly bad news if the last frame emitted is a LEFT
834 * eye, as the MXF writer will complain about the 3D sequence being wrong.
835 * Here's a hack to workaround that particular case.
837 if (_next_video_eyes && _next_video_time && *_next_video_eyes == Eyes::RIGHT) {
838 do_emit_video (black_player_video_frame(Eyes::RIGHT), *_next_video_time);
846 /** @return Open subtitles for the frame at the given time, converted to images */
847 optional<PositionImage>
848 Player::open_subtitles_for_frame (DCPTime time) const
850 list<PositionImage> captions;
851 int const vfr = _film->video_frame_rate();
855 _active_texts[static_cast<int>(TextType::OPEN_SUBTITLE)].get_burnt(DCPTimePeriod(time, time + DCPTime::from_frames(1, vfr)), _always_burn_open_subtitles)
858 /* Bitmap subtitles */
859 for (auto i: j.bitmap) {
864 /* i.image will already have been scaled to fit _video_container_size */
865 dcp::Size scaled_size (i.rectangle.width * _video_container_size.load().width, i.rectangle.height * _video_container_size.load().height);
871 lrint(_video_container_size.load().width * i.rectangle.x),
872 lrint(_video_container_size.load().height * i.rectangle.y)
878 /* String subtitles (rendered to an image) */
879 if (!j.string.empty()) {
880 auto s = render_text(j.string, _video_container_size, time, vfr);
881 copy (s.begin(), s.end(), back_inserter (captions));
885 if (captions.empty()) {
889 return merge (captions, _subtitle_alignment);
894 Player::video (weak_ptr<Piece> weak_piece, ContentVideo video)
900 auto piece = weak_piece.lock ();
905 if (!piece->content->video->use()) {
909 FrameRateChange frc (_film, piece->content);
910 if (frc.skip && (video.frame % 2) == 1) {
914 /* Time of the first frame we will emit */
915 DCPTime const time = content_video_to_dcp (piece, video.frame);
916 LOG_DEBUG_PLAYER("Received video frame %1 at %2", video.frame, to_string(time));
918 /* Discard if it's before the content's period or the last accurate seek. We can't discard
919 if it's after the content's period here as in that case we still need to fill any gap between
920 `now' and the end of the content's period.
922 if (time < piece->content->position() || (_next_video_time && time < *_next_video_time)) {
926 if (piece->ignore_video && piece->ignore_video->contains(time)) {
930 /* Fill gaps that we discover now that we have some video which needs to be emitted.
931 This is where we need to fill to.
933 DCPTime fill_to = min (time, piece->content->end(_film));
935 if (_next_video_time) {
936 DCPTime fill_from = max (*_next_video_time, piece->content->position());
938 /* Fill if we have more than half a frame to do */
939 if ((fill_to - fill_from) > one_video_frame() / 2) {
940 auto last = _last_video.find (weak_piece);
941 if (_film->three_d()) {
942 auto fill_to_eyes = video.eyes;
943 if (fill_to_eyes == Eyes::BOTH) {
944 fill_to_eyes = Eyes::LEFT;
946 if (fill_to == piece->content->end(_film)) {
947 /* Don't fill after the end of the content */
948 fill_to_eyes = Eyes::LEFT;
951 auto eyes = _next_video_eyes.get_value_or(Eyes::LEFT);
952 if (eyes == Eyes::BOTH) {
955 while (j < fill_to || eyes != fill_to_eyes) {
956 if (last != _last_video.end()) {
957 LOG_DEBUG_PLAYER("Fill using last video at %1 in 3D mode", to_string(j));
958 auto copy = last->second->shallow_copy();
959 copy->set_eyes (eyes);
960 emit_video (copy, j);
962 LOG_DEBUG_PLAYER("Fill using black at %1 in 3D mode", to_string(j));
963 emit_video (black_player_video_frame(eyes), j);
965 if (eyes == Eyes::RIGHT) {
966 j += one_video_frame();
968 eyes = increment_eyes (eyes);
971 for (DCPTime j = fill_from; j < fill_to; j += one_video_frame()) {
972 if (last != _last_video.end()) {
973 emit_video (last->second, j);
975 emit_video (black_player_video_frame(Eyes::BOTH), j);
982 auto const content_video = piece->content->video;
984 _last_video[weak_piece] = std::make_shared<PlayerVideo>(
986 content_video->actual_crop(),
987 content_video->fade (_film, video.frame),
989 content_video->scaled_size(_film->frame_size()),
990 _video_container_size,
992 content_video->pixel_quanta()
994 _video_container_size,
997 content_video->colour_conversion(),
998 content_video->range(),
1005 for (int i = 0; i < frc.repeat; ++i) {
1006 if (t < piece->content->end(_film)) {
1007 emit_video (_last_video[weak_piece], t);
1009 t += one_video_frame ();
1015 Player::audio (weak_ptr<Piece> weak_piece, AudioStreamPtr stream, ContentAudio content_audio)
1021 DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
1023 auto piece = weak_piece.lock ();
1028 auto content = piece->content->audio;
1029 DCPOMATIC_ASSERT (content);
1031 int const rfr = content->resampled_frame_rate (_film);
1033 /* Compute time in the DCP */
1034 auto time = resampled_audio_to_dcp (piece, content_audio.frame);
1035 LOG_DEBUG_PLAYER("Received audio frame %1 at %2", content_audio.frame, to_string(time));
1037 /* And the end of this block in the DCP */
1038 auto end = time + DCPTime::from_frames(content_audio.audio->frames(), rfr);
1040 /* Remove anything that comes before the start or after the end of the content */
1041 if (time < piece->content->position()) {
1042 auto cut = discard_audio (content_audio.audio, time, piece->content->position());
1044 /* This audio is entirely discarded */
1047 content_audio.audio = cut.first;
1049 } else if (time > piece->content->end(_film)) {
1050 /* Discard it all */
1052 } else if (end > piece->content->end(_film)) {
1053 Frame const remaining_frames = DCPTime(piece->content->end(_film) - time).frames_round(rfr);
1054 if (remaining_frames == 0) {
1057 content_audio.audio = make_shared<AudioBuffers>(content_audio.audio, remaining_frames, 0);
1060 DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
1064 auto const fade_coeffs = content->fade (stream, content_audio.frame, content_audio.audio->frames(), rfr);
1065 if (content->gain() != 0 || !fade_coeffs.empty()) {
1066 auto gain_buffers = make_shared<AudioBuffers>(content_audio.audio);
1067 if (!fade_coeffs.empty()) {
1068 /* Apply both fade and gain */
1069 DCPOMATIC_ASSERT (fade_coeffs.size() == static_cast<size_t>(gain_buffers->frames()));
1070 auto const channels = gain_buffers->channels();
1071 auto const frames = fade_coeffs.size();
1072 auto data = gain_buffers->data();
1073 auto const gain = db_to_linear (content->gain());
1074 for (auto channel = 0; channel < channels; ++channel) {
1075 for (auto frame = 0U; frame < frames; ++frame) {
1076 data[channel][frame] *= gain * fade_coeffs[frame];
1080 /* Just apply gain */
1081 gain_buffers->apply_gain (content->gain());
1083 content_audio.audio = gain_buffers;
1088 content_audio.audio = remap (content_audio.audio, _film->audio_channels(), stream->mapping());
1092 if (_audio_processor) {
1093 content_audio.audio = _audio_processor->run (content_audio.audio, _film->audio_channels ());
1098 _audio_merger.push (content_audio.audio, time);
1099 DCPOMATIC_ASSERT (_stream_states.find (stream) != _stream_states.end ());
1100 _stream_states[stream].last_push_end = time + DCPTime::from_frames (content_audio.audio->frames(), _film->audio_frame_rate());
1105 Player::bitmap_text_start (weak_ptr<Piece> weak_piece, weak_ptr<const TextContent> weak_content, ContentBitmapText subtitle)
1111 auto piece = weak_piece.lock ();
1112 auto content = weak_content.lock ();
1113 if (!piece || !content) {
1118 for (auto& sub: subtitle.subs)
1120 /* Apply content's subtitle offsets */
1121 sub.rectangle.x += content->x_offset ();
1122 sub.rectangle.y += content->y_offset ();
1124 /* Apply a corrective translation to keep the subtitle centred after the scale that is coming up */
1125 sub.rectangle.x -= sub.rectangle.width * ((content->x_scale() - 1) / 2);
1126 sub.rectangle.y -= sub.rectangle.height * ((content->y_scale() - 1) / 2);
1128 /* Apply content's subtitle scale */
1129 sub.rectangle.width *= content->x_scale ();
1130 sub.rectangle.height *= content->y_scale ();
1132 auto image = sub.image;
1134 /* We will scale the subtitle up to fit _video_container_size */
1135 int const width = sub.rectangle.width * _video_container_size.load().width;
1136 int const height = sub.rectangle.height * _video_container_size.load().height;
1137 if (width == 0 || height == 0) {
1141 dcp::Size scaled_size (width, height);
1142 ps.bitmap.push_back (BitmapText(image->scale(scaled_size, dcp::YUVToRGB::REC601, image->pixel_format(), Image::Alignment::PADDED, _fast), sub.rectangle));
1145 DCPTime from(content_time_to_dcp(piece, subtitle.from()));
1146 _active_texts[static_cast<int>(content->type())].add_from(weak_content, ps, from);
1151 Player::plain_text_start (weak_ptr<Piece> weak_piece, weak_ptr<const TextContent> weak_content, ContentStringText subtitle)
1157 auto piece = weak_piece.lock ();
1158 auto content = weak_content.lock ();
1159 if (!piece || !content) {
1164 DCPTime const from (content_time_to_dcp (piece, subtitle.from()));
1166 if (from > piece->content->end(_film)) {
1170 for (auto s: subtitle.subs) {
1171 s.set_h_position (s.h_position() + content->x_offset());
1172 s.set_v_position (s.v_position() + content->y_offset());
1173 float const xs = content->x_scale();
1174 float const ys = content->y_scale();
1175 float size = s.size();
1177 /* Adjust size to express the common part of the scaling;
1178 e.g. if xs = ys = 0.5 we scale size by 2.
1180 if (xs > 1e-5 && ys > 1e-5) {
1181 size *= 1 / min (1 / xs, 1 / ys);
1185 /* Then express aspect ratio changes */
1186 if (fabs (1.0 - xs / ys) > dcp::ASPECT_ADJUST_EPSILON) {
1187 s.set_aspect_adjust (xs / ys);
1190 s.set_in (dcp::Time(from.seconds(), 1000));
1191 ps.string.push_back (s);
1194 _active_texts[static_cast<int>(content->type())].add_from(weak_content, ps, from);
1199 Player::subtitle_stop (weak_ptr<Piece> weak_piece, weak_ptr<const TextContent> weak_content, ContentTime to)
1205 auto content = weak_content.lock ();
1210 if (!_active_texts[static_cast<int>(content->type())].have(weak_content)) {
1214 auto piece = weak_piece.lock ();
1219 DCPTime const dcp_to = content_time_to_dcp (piece, to);
1221 if (dcp_to > piece->content->end(_film)) {
1225 auto from = _active_texts[static_cast<int>(content->type())].add_to(weak_content, dcp_to);
1227 bool const always = (content->type() == TextType::OPEN_SUBTITLE && _always_burn_open_subtitles);
1228 if (content->use() && !always && !content->burn()) {
1229 Text (from.first, content->type(), content->dcp_track().get_value_or(DCPTextTrack()), DCPTimePeriod(from.second, dcp_to));
1235 Player::seek (DCPTime time, bool accurate)
1237 boost::mutex::scoped_lock lm (_mutex);
1238 LOG_DEBUG_PLAYER("Seek to %1 (%2accurate)", to_string(time), accurate ? "" : "in");
1241 /* We can't seek in this state */
1246 _shuffler->clear ();
1251 if (_audio_processor) {
1252 _audio_processor->flush ();
1255 _audio_merger.clear ();
1256 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
1257 _active_texts[i].clear ();
1260 for (auto i: _pieces) {
1261 if (time < i->content->position()) {
1262 /* Before; seek to the start of the content. Even if this request is for an inaccurate seek
1263 we must seek this (following) content accurately, otherwise when we come to the end of the current
1264 content we may not start right at the beginning of the next, causing a gap (if the next content has
1265 been trimmed to a point between keyframes, or something).
1267 i->decoder->seek (dcp_to_content_time (i, i->content->position()), true);
1269 } else if (i->content->position() <= time && time < i->content->end(_film)) {
1270 /* During; seek to position */
1271 i->decoder->seek (dcp_to_content_time (i, time), accurate);
1274 /* After; this piece is done */
1280 _next_video_time = time;
1281 _next_video_eyes = Eyes::LEFT;
1282 _next_audio_time = time;
1284 _next_video_time = boost::none;
1285 _next_video_eyes = boost::none;
1286 _next_audio_time = boost::none;
1289 _black.set_position (time);
1290 _silent.set_position (time);
1292 _last_video.clear ();
1297 Player::emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1299 if (!_film->three_d()) {
1300 if (pv->eyes() == Eyes::LEFT) {
1301 /* Use left-eye images for both eyes... */
1302 pv->set_eyes (Eyes::BOTH);
1303 } else if (pv->eyes() == Eyes::RIGHT) {
1304 /* ...and discard the right */
1309 /* We need a delay to give a little wiggle room to ensure that relevant subtitles arrive at the
1310 player before the video that requires them.
1312 _delay.push_back (make_pair (pv, time));
1314 if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
1315 _next_video_time = time + one_video_frame();
1317 _next_video_eyes = increment_eyes (pv->eyes());
1319 if (_delay.size() < 3) {
1323 auto to_do = _delay.front();
1325 do_emit_video (to_do.first, to_do.second);
1330 Player::do_emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1332 if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
1333 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
1334 _active_texts[i].clear_before (time);
1338 auto subtitles = open_subtitles_for_frame (time);
1340 pv->set_text (subtitles.get ());
1348 Player::emit_audio (shared_ptr<AudioBuffers> data, DCPTime time)
1350 /* Log if the assert below is about to fail */
1351 if (_next_audio_time && labs(time.get() - _next_audio_time->get()) > 1) {
1352 _film->log()->log(String::compose("Out-of-sequence emit %1 vs %2", to_string(time), to_string(*_next_audio_time)), LogEntry::TYPE_WARNING);
1355 /* This audio must follow on from the previous, allowing for half a sample (at 48kHz) leeway */
1356 DCPOMATIC_ASSERT (!_next_audio_time || labs(time.get() - _next_audio_time->get()) < 2);
1357 Audio (data, time, _film->audio_frame_rate());
1358 _next_audio_time = time + DCPTime::from_frames (data->frames(), _film->audio_frame_rate());
1363 Player::fill_audio (DCPTimePeriod period)
1365 if (period.from == period.to) {
1369 DCPOMATIC_ASSERT (period.from < period.to);
1371 DCPTime t = period.from;
1372 while (t < period.to) {
1373 DCPTime block = min (DCPTime::from_seconds (0.5), period.to - t);
1374 Frame const samples = block.frames_round(_film->audio_frame_rate());
1376 auto silence = make_shared<AudioBuffers>(_film->audio_channels(), samples);
1377 silence->make_silent ();
1378 emit_audio (silence, t);
1386 Player::one_video_frame () const
1388 return DCPTime::from_frames (1, _film->video_frame_rate ());
1392 pair<shared_ptr<AudioBuffers>, DCPTime>
1393 Player::discard_audio (shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to) const
1395 auto const discard_time = discard_to - time;
1396 auto const discard_frames = discard_time.frames_round(_film->audio_frame_rate());
1397 auto remaining_frames = audio->frames() - discard_frames;
1398 if (remaining_frames <= 0) {
1399 return make_pair(shared_ptr<AudioBuffers>(), DCPTime());
1401 auto cut = make_shared<AudioBuffers>(audio, remaining_frames, discard_frames);
1402 return make_pair(cut, time + discard_time);
1407 Player::set_dcp_decode_reduction (optional<int> reduction)
1409 Change (ChangeType::PENDING, PlayerProperty::DCP_DECODE_REDUCTION, false);
1411 if (reduction == _dcp_decode_reduction.load()) {
1412 Change(ChangeType::CANCELLED, PlayerProperty::DCP_DECODE_REDUCTION, false);
1416 _dcp_decode_reduction = reduction;
1419 Change (ChangeType::DONE, PlayerProperty::DCP_DECODE_REDUCTION, false);
1424 Player::content_time_to_dcp (shared_ptr<const Content> content, ContentTime t)
1426 boost::mutex::scoped_lock lm (_mutex);
1428 for (auto i: _pieces) {
1429 if (i->content == content) {
1430 return content_time_to_dcp (i, t);
1434 /* We couldn't find this content; perhaps things are being changed over */
1439 optional<ContentTime>
1440 Player::dcp_to_content_time (shared_ptr<const Content> content, DCPTime t)
1442 boost::mutex::scoped_lock lm (_mutex);
1444 for (auto i: _pieces) {
1445 if (i->content == content) {
1446 return dcp_to_content_time (i, t);
1450 /* We couldn't find this content; perhaps things are being changed over */
1455 shared_ptr<const Playlist>
1456 Player::playlist () const
1458 return _playlist ? _playlist : _film->playlist();
1463 Player::atmos (weak_ptr<Piece> weak_piece, ContentAtmos data)
1469 auto piece = weak_piece.lock ();
1470 DCPOMATIC_ASSERT (piece);
1472 auto const vfr = _film->video_frame_rate();
1474 DCPTime const dcp_time = DCPTime::from_frames(data.frame, vfr) - DCPTime(piece->content->trim_start(), FrameRateChange(vfr, vfr));
1475 if (dcp_time < piece->content->position() || dcp_time >= (piece->content->end(_film))) {
1479 Atmos (data.data, dcp_time, data.metadata);