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"
25 #include "audio_buffers.h"
26 #include "content_audio.h"
27 #include "dcp_content.h"
28 #include "dcpomatic_log.h"
31 #include "raw_image_proxy.h"
34 #include "render_text.h"
36 #include "content_video.h"
37 #include "player_video.h"
38 #include "frame_rate_change.h"
39 #include "audio_processor.h"
41 #include "referenced_reel_asset.h"
42 #include "decoder_factory.h"
44 #include "video_decoder.h"
45 #include "audio_decoder.h"
46 #include "text_content.h"
47 #include "text_decoder.h"
48 #include "ffmpeg_content.h"
49 #include "audio_content.h"
50 #include "dcp_decoder.h"
51 #include "image_decoder.h"
52 #include "compose.hpp"
56 #include <dcp/reel_sound_asset.h>
57 #include <dcp/reel_subtitle_asset.h>
58 #include <dcp/reel_picture_asset.h>
59 #include <dcp/reel_closed_caption_asset.h>
69 using std::dynamic_pointer_cast;
72 using std::make_shared;
77 using std::shared_ptr;
80 using std::make_shared;
81 using boost::optional;
82 using boost::scoped_ptr;
83 #if BOOST_VERSION >= 106100
84 using namespace boost::placeholders;
86 using namespace dcpomatic;
89 int const PlayerProperty::VIDEO_CONTAINER_SIZE = 700;
90 int const PlayerProperty::PLAYLIST = 701;
91 int const PlayerProperty::FILM_CONTAINER = 702;
92 int const PlayerProperty::FILM_VIDEO_FRAME_RATE = 703;
93 int const PlayerProperty::DCP_DECODE_REDUCTION = 704;
94 int const PlayerProperty::PLAYBACK_LENGTH = 705;
97 Player::Player (shared_ptr<const Film> film, Image::Alignment subtitle_alignment)
100 , _tolerant (film->tolerant())
101 , _audio_merger (_film->audio_frame_rate())
102 , _subtitle_alignment (subtitle_alignment)
108 Player::Player (shared_ptr<const Film> film, shared_ptr<const Playlist> playlist_)
110 , _playlist (playlist_)
112 , _tolerant (film->tolerant())
113 , _audio_merger (_film->audio_frame_rate())
122 _film_changed_connection = _film->Change.connect (bind (&Player::film_change, this, _1, _2));
123 /* The butler must hear about this first, so since we are proxying this through to the butler we must
126 _playlist_change_connection = playlist()->Change.connect (bind (&Player::playlist_change, this, _1), boost::signals2::at_front);
127 _playlist_content_change_connection = playlist()->ContentChange.connect (bind(&Player::playlist_content_change, this, _1, _3, _4));
128 set_video_container_size (_film->frame_size ());
130 film_change (ChangeType::DONE, Film::Property::AUDIO_PROCESSOR);
133 seek (DCPTime (), true);
138 Player::setup_pieces ()
140 boost::mutex::scoped_lock lm (_mutex);
141 setup_pieces_unlocked ();
146 have_video (shared_ptr<const Content> content)
148 return static_cast<bool>(content->video) && content->video->use();
153 have_audio (shared_ptr<const Content> content)
155 return static_cast<bool>(content->audio);
160 Player::setup_pieces_unlocked ()
162 _playback_length = _playlist ? _playlist->length(_film) : _film->length();
164 auto old_pieces = _pieces;
167 _shuffler.reset (new Shuffler());
168 _shuffler->Video.connect(bind(&Player::video, this, _1, _2));
170 for (auto i: playlist()->content()) {
172 if (!i->paths_valid ()) {
176 if (_ignore_video && _ignore_audio && i->text.empty()) {
177 /* We're only interested in text and this content has none */
181 shared_ptr<Decoder> old_decoder;
182 for (auto j: old_pieces) {
183 if (j->content == i) {
184 old_decoder = j->decoder;
189 auto decoder = decoder_factory (_film, i, _fast, _tolerant, old_decoder);
190 DCPOMATIC_ASSERT (decoder);
192 FrameRateChange frc (_film, i);
194 if (decoder->video && _ignore_video) {
195 decoder->video->set_ignore (true);
198 if (decoder->audio && _ignore_audio) {
199 decoder->audio->set_ignore (true);
203 for (auto i: decoder->text) {
204 i->set_ignore (true);
208 auto dcp = dynamic_pointer_cast<DCPDecoder> (decoder);
210 dcp->set_decode_referenced (_play_referenced);
211 if (_play_referenced) {
212 dcp->set_forced_reduction (_dcp_decode_reduction);
216 auto piece = make_shared<Piece>(i, decoder, frc);
217 _pieces.push_back (piece);
219 if (decoder->video) {
220 if (i->video->frame_type() == VideoFrameType::THREE_D_LEFT || i->video->frame_type() == VideoFrameType::THREE_D_RIGHT) {
221 /* We need a Shuffler to cope with 3D L/R video data arriving out of sequence */
222 decoder->video->Data.connect (bind(&Shuffler::video, _shuffler.get(), weak_ptr<Piece>(piece), _1));
224 decoder->video->Data.connect (bind(&Player::video, this, weak_ptr<Piece>(piece), _1));
228 if (decoder->audio) {
229 decoder->audio->Data.connect (bind (&Player::audio, this, weak_ptr<Piece> (piece), _1, _2));
232 auto j = decoder->text.begin();
234 while (j != decoder->text.end()) {
235 (*j)->BitmapStart.connect (
236 bind(&Player::bitmap_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
238 (*j)->PlainStart.connect (
239 bind(&Player::plain_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
242 bind(&Player::subtitle_stop, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
248 if (decoder->atmos) {
249 decoder->atmos->Data.connect (bind(&Player::atmos, this, weak_ptr<Piece>(piece), _1));
253 _stream_states.clear ();
254 for (auto i: _pieces) {
255 if (i->content->audio) {
256 for (auto j: i->content->audio->streams()) {
257 _stream_states[j] = StreamState (i, i->content->position ());
262 for (auto i = _pieces.begin(); i != _pieces.end(); ++i) {
263 if (auto video = (*i)->content->video) {
264 if (video->use() && video->frame_type() != VideoFrameType::THREE_D_LEFT && video->frame_type() != VideoFrameType::THREE_D_RIGHT) {
265 /* Look for content later in the content list with in-use video that overlaps this */
266 auto period = DCPTimePeriod((*i)->content->position(), (*i)->content->end(_film));
269 for (; j != _pieces.end(); ++j) {
270 if ((*j)->content->video && (*j)->content->video->use()) {
271 (*i)->ignore_video = DCPTimePeriod((*j)->content->position(), (*j)->content->end(_film)).overlap(period);
278 _black = Empty (_film, playlist(), bind(&have_video, _1), _playback_length);
279 _silent = Empty (_film, playlist(), bind(&have_audio, _1), _playback_length);
281 _last_video_time = boost::optional<dcpomatic::DCPTime>();
282 _last_video_eyes = Eyes::BOTH;
283 _last_audio_time = boost::optional<dcpomatic::DCPTime>();
288 Player::playlist_content_change (ChangeType type, int property, bool frequent)
290 if (property == VideoContentProperty::CROP) {
291 if (type == ChangeType::DONE) {
292 auto const vcs = video_container_size();
293 boost::mutex::scoped_lock lm (_mutex);
294 for (auto const& i: _delay) {
295 i.first->reset_metadata (_film, vcs);
299 if (type == ChangeType::PENDING) {
300 /* The player content is probably about to change, so we can't carry on
301 until that has happened and we've rebuilt our pieces. Stop pass()
302 and seek() from working until then.
305 } else if (type == ChangeType::DONE) {
306 /* A change in our content has gone through. Re-build our pieces. */
309 } else if (type == ChangeType::CANCELLED) {
314 Change (type, property, frequent);
319 Player::set_video_container_size (dcp::Size s)
321 Change (ChangeType::PENDING, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
324 boost::mutex::scoped_lock lm (_mutex);
326 if (s == _video_container_size) {
328 Change (ChangeType::CANCELLED, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
332 _video_container_size = s;
334 _black_image = make_shared<Image>(AV_PIX_FMT_RGB24, _video_container_size, Image::Alignment::PADDED);
335 _black_image->make_black ();
338 Change (ChangeType::DONE, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
343 Player::playlist_change (ChangeType type)
345 if (type == ChangeType::DONE) {
348 Change (type, PlayerProperty::PLAYLIST, false);
353 Player::film_change (ChangeType type, Film::Property p)
355 /* Here we should notice Film properties that affect our output, and
356 alert listeners that our output now would be different to how it was
357 last time we were run.
360 if (p == Film::Property::CONTAINER) {
361 Change (type, PlayerProperty::FILM_CONTAINER, false);
362 } else if (p == Film::Property::VIDEO_FRAME_RATE) {
363 /* Pieces contain a FrameRateChange which contains the DCP frame rate,
364 so we need new pieces here.
366 if (type == ChangeType::DONE) {
369 Change (type, PlayerProperty::FILM_VIDEO_FRAME_RATE, false);
370 } else if (p == Film::Property::AUDIO_PROCESSOR) {
371 if (type == ChangeType::DONE && _film->audio_processor ()) {
372 boost::mutex::scoped_lock lm (_mutex);
373 _audio_processor = _film->audio_processor()->clone (_film->audio_frame_rate ());
375 } else if (p == Film::Property::AUDIO_CHANNELS) {
376 if (type == ChangeType::DONE) {
377 boost::mutex::scoped_lock lm (_mutex);
378 _audio_merger.clear ();
384 shared_ptr<PlayerVideo>
385 Player::black_player_video_frame (Eyes eyes) const
387 return std::make_shared<PlayerVideo> (
388 std::make_shared<const RawImageProxy>(_black_image),
391 _video_container_size,
392 _video_container_size,
395 PresetColourConversion::all().front().conversion,
397 std::weak_ptr<Content>(),
398 boost::optional<Frame>(),
405 Player::dcp_to_content_video (shared_ptr<const Piece> piece, DCPTime t) const
407 auto s = t - piece->content->position ();
408 s = min (piece->content->length_after_trim(_film), s);
409 s = max (DCPTime(), s + DCPTime (piece->content->trim_start(), piece->frc));
411 /* It might seem more logical here to convert s to a ContentTime (using the FrameRateChange)
412 then convert that ContentTime to frames at the content's rate. However this fails for
413 situations like content at 29.9978733fps, DCP at 30fps. The accuracy of the Time type is not
414 enough to distinguish between the two with low values of time (e.g. 3200 in Time units).
416 Instead we convert the DCPTime using the DCP video rate then account for any skip/repeat.
418 return s.frames_floor (piece->frc.dcp) / piece->frc.factor ();
423 Player::content_video_to_dcp (shared_ptr<const Piece> piece, Frame f) const
425 /* See comment in dcp_to_content_video */
426 auto const d = DCPTime::from_frames (f * piece->frc.factor(), piece->frc.dcp) - DCPTime(piece->content->trim_start(), piece->frc);
427 return d + piece->content->position();
432 Player::dcp_to_resampled_audio (shared_ptr<const Piece> piece, DCPTime t) const
434 auto s = t - piece->content->position ();
435 s = min (piece->content->length_after_trim(_film), s);
436 /* See notes in dcp_to_content_video */
437 return max (DCPTime(), DCPTime(piece->content->trim_start(), piece->frc) + s).frames_floor(_film->audio_frame_rate());
442 Player::resampled_audio_to_dcp (shared_ptr<const Piece> piece, Frame f) const
444 /* See comment in dcp_to_content_video */
445 return DCPTime::from_frames (f, _film->audio_frame_rate())
446 - DCPTime (piece->content->trim_start(), piece->frc)
447 + piece->content->position();
452 Player::dcp_to_content_time (shared_ptr<const Piece> piece, DCPTime t) const
454 auto s = t - piece->content->position ();
455 s = min (piece->content->length_after_trim(_film), s);
456 return max (ContentTime (), ContentTime (s, piece->frc) + piece->content->trim_start());
461 Player::content_time_to_dcp (shared_ptr<const Piece> piece, ContentTime t) const
463 return max (DCPTime(), DCPTime(t - piece->content->trim_start(), piece->frc) + piece->content->position());
468 Player::get_subtitle_fonts ()
470 boost::mutex::scoped_lock lm (_mutex);
472 vector<FontData> fonts;
473 for (auto i: _pieces) {
474 /* XXX: things may go wrong if there are duplicate font IDs
475 with different font files.
477 auto f = i->decoder->fonts ();
478 copy (f.begin(), f.end(), back_inserter(fonts));
485 /** Set this player never to produce any video data */
487 Player::set_ignore_video ()
489 boost::mutex::scoped_lock lm (_mutex);
490 _ignore_video = true;
491 setup_pieces_unlocked ();
496 Player::set_ignore_audio ()
498 boost::mutex::scoped_lock lm (_mutex);
499 _ignore_audio = true;
500 setup_pieces_unlocked ();
505 Player::set_ignore_text ()
507 boost::mutex::scoped_lock lm (_mutex);
509 setup_pieces_unlocked ();
513 /** Set the player to always burn open texts into the image regardless of the content settings */
515 Player::set_always_burn_open_subtitles ()
517 boost::mutex::scoped_lock lm (_mutex);
518 _always_burn_open_subtitles = true;
522 /** Sets up the player to be faster, possibly at the expense of quality */
526 boost::mutex::scoped_lock lm (_mutex);
528 setup_pieces_unlocked ();
533 Player::set_play_referenced ()
535 boost::mutex::scoped_lock lm (_mutex);
536 _play_referenced = true;
537 setup_pieces_unlocked ();
542 maybe_add_asset (list<ReferencedReelAsset>& a, shared_ptr<dcp::ReelAsset> r, Frame reel_trim_start, Frame reel_trim_end, DCPTime from, int const ffr)
544 DCPOMATIC_ASSERT (r);
545 r->set_entry_point (r->entry_point().get_value_or(0) + reel_trim_start);
546 r->set_duration (r->actual_duration() - reel_trim_start - reel_trim_end);
547 if (r->actual_duration() > 0) {
549 ReferencedReelAsset(r, DCPTimePeriod(from, from + DCPTime::from_frames(r->actual_duration(), ffr)))
555 list<ReferencedReelAsset>
556 Player::get_reel_assets ()
558 /* Does not require a lock on _mutex as it's only called from DCPEncoder */
560 list<ReferencedReelAsset> reel_assets;
562 for (auto content: playlist()->content()) {
563 auto dcp = dynamic_pointer_cast<DCPContent>(content);
568 if (!dcp->reference_video() && !dcp->reference_audio() && !dcp->reference_text(TextType::OPEN_SUBTITLE) && !dcp->reference_text(TextType::CLOSED_CAPTION)) {
572 scoped_ptr<DCPDecoder> decoder;
574 decoder.reset (new DCPDecoder(_film, dcp, false, false, shared_ptr<DCPDecoder>()));
579 DCPOMATIC_ASSERT (dcp->video_frame_rate());
580 double const cfr = dcp->video_frame_rate().get();
581 Frame const trim_start = dcp->trim_start().frames_round(cfr);
582 Frame const trim_end = dcp->trim_end().frames_round(cfr);
583 int const ffr = _film->video_frame_rate ();
585 /* position in the asset from the start */
586 int64_t offset_from_start = 0;
587 /* position i the asset from the end */
588 int64_t offset_from_end = 0;
589 for (auto reel: decoder->reels()) {
590 /* Assume that main picture duration is the length of the reel */
591 offset_from_end += reel->main_picture()->actual_duration();
594 for (auto reel: decoder->reels()) {
596 /* Assume that main picture duration is the length of the reel */
597 int64_t const reel_duration = reel->main_picture()->actual_duration();
599 /* See doc/design/trim_reels.svg */
600 Frame const reel_trim_start = min(reel_duration, max(int64_t(0), trim_start - offset_from_start));
601 Frame const reel_trim_end = min(reel_duration, max(int64_t(0), reel_duration - (offset_from_end - trim_end)));
603 auto const from = max(DCPTime(), content->position() + DCPTime::from_frames(offset_from_start, ffr) - DCPTime::from_frames(trim_start, cfr));
604 if (dcp->reference_video()) {
605 maybe_add_asset (reel_assets, reel->main_picture(), reel_trim_start, reel_trim_end, from, ffr);
608 if (dcp->reference_audio()) {
609 maybe_add_asset (reel_assets, reel->main_sound(), reel_trim_start, reel_trim_end, from, ffr);
612 if (dcp->reference_text(TextType::OPEN_SUBTITLE)) {
613 maybe_add_asset (reel_assets, reel->main_subtitle(), reel_trim_start, reel_trim_end, from, ffr);
616 if (dcp->reference_text(TextType::CLOSED_CAPTION)) {
617 for (auto caption: reel->closed_captions()) {
618 maybe_add_asset (reel_assets, caption, reel_trim_start, reel_trim_end, from, ffr);
622 offset_from_start += reel_duration;
623 offset_from_end -= reel_duration;
634 boost::mutex::scoped_lock lm (_mutex);
637 /* We can't pass in this state */
638 LOG_DEBUG_PLAYER_NC ("Player is suspended");
642 if (_playback_length == DCPTime()) {
643 /* Special; just give one black frame */
644 emit_video (black_player_video_frame(Eyes::BOTH), DCPTime());
648 /* Find the decoder or empty which is farthest behind where we are and make it emit some data */
650 shared_ptr<Piece> earliest_content;
651 optional<DCPTime> earliest_time;
653 for (auto i: _pieces) {
658 auto const t = content_time_to_dcp (i, max(i->decoder->position(), i->content->trim_start()));
659 if (t > i->content->end(_film)) {
663 /* Given two choices at the same time, pick the one with texts so we see it before
666 if (!earliest_time || t < *earliest_time || (t == *earliest_time && !i->decoder->text.empty())) {
668 earliest_content = i;
682 if (earliest_content) {
686 if (!_black.done() && !_ignore_video && (!earliest_time || _black.position() < *earliest_time)) {
687 earliest_time = _black.position ();
691 if (!_silent.done() && !_ignore_audio && (!earliest_time || _silent.position() < *earliest_time)) {
692 earliest_time = _silent.position ();
699 LOG_DEBUG_PLAYER ("Calling pass() on %1", earliest_content->content->path(0));
700 earliest_content->done = earliest_content->decoder->pass ();
701 auto dcp = dynamic_pointer_cast<DCPContent>(earliest_content->content);
702 if (dcp && !_play_referenced && dcp->reference_audio()) {
703 /* We are skipping some referenced DCP audio content, so we need to update _last_audio_time
704 to `hide' the fact that no audio was emitted during the referenced DCP (though
705 we need to behave as though it was).
707 _last_audio_time = dcp->end (_film);
712 LOG_DEBUG_PLAYER ("Emit black for gap at %1", to_string(_black.position()));
713 emit_video (black_player_video_frame(Eyes::BOTH), _black.position());
714 _black.set_position (_black.position() + one_video_frame());
718 LOG_DEBUG_PLAYER ("Emit silence for gap at %1", to_string(_silent.position()));
719 DCPTimePeriod period (_silent.period_at_position());
720 if (_last_audio_time) {
721 /* Sometimes the thing that happened last finishes fractionally before
722 or after this silence. Bodge the start time of the silence to fix it.
723 I think this is nothing to worry about since we will just add or
724 remove a little silence at the end of some content.
726 int64_t const error = labs(period.from.get() - _last_audio_time->get());
727 /* Let's not worry about less than a frame at 24fps */
728 int64_t const too_much_error = DCPTime::from_frames(1, 24).get();
729 if (error >= too_much_error) {
730 _film->log()->log(String::compose("Silence starting before or after last audio by %1", error), LogEntry::TYPE_ERROR);
732 DCPOMATIC_ASSERT (error < too_much_error);
733 period.from = *_last_audio_time;
735 if (period.duration() > one_video_frame()) {
736 period.to = period.from + one_video_frame();
739 _silent.set_position (period.to);
747 /* Emit any audio that is ready */
749 /* Work out the time before which the audio is definitely all here. This is the earliest last_push_end of one
750 of our streams, or the position of the _silent. First, though we choose only streams that are less than
751 ignore_streams_behind seconds behind the furthest ahead (we assume that if a stream has fallen that far
752 behind it has finished). This is so that we don't withhold audio indefinitely awaiting data from a stream
753 that will never come, causing bugs like #2101.
755 constexpr int ignore_streams_behind = 5;
757 using state_pair = std::pair<AudioStreamPtr, StreamState>;
759 /* Find the 'leading' stream (i.e. the one that pushed data most recently) */
760 auto latest_last_push_end = std::max_element(
761 _stream_states.begin(),
762 _stream_states.end(),
763 [](state_pair const& a, state_pair const& b) { return a.second.last_push_end < b.second.last_push_end; }
766 if (latest_last_push_end != _stream_states.end()) {
767 LOG_DEBUG_PLAYER("Leading 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));
770 /* Now make a list of those streams that are less than ignore_streams_behind behind the leader */
771 std::map<AudioStreamPtr, StreamState> alive_stream_states;
772 for (auto const& i: _stream_states) {
773 if ((latest_last_push_end->second.last_push_end - i.second.last_push_end) < dcpomatic::DCPTime::from_seconds(ignore_streams_behind)) {
774 alive_stream_states.insert(i);
776 LOG_DEBUG_PLAYER("Ignoring stream %1 because it is too far behind", i.second.piece->content->path(0));
780 auto pull_to = _playback_length;
781 for (auto const& i: alive_stream_states) {
782 if (!i.second.piece->done && i.second.last_push_end < pull_to) {
783 pull_to = i.second.last_push_end;
786 if (!_silent.done() && _silent.position() < pull_to) {
787 pull_to = _silent.position();
790 LOG_DEBUG_PLAYER("Emitting audio up to %1", to_string(pull_to));
791 auto audio = _audio_merger.pull (pull_to);
792 for (auto i = audio.begin(); i != audio.end(); ++i) {
793 if (_last_audio_time && i->second < *_last_audio_time) {
794 /* This new data comes before the last we emitted (or the last seek); discard it */
795 auto cut = discard_audio (i->first, i->second, *_last_audio_time);
800 } else if (_last_audio_time && i->second > *_last_audio_time) {
801 /* There's a gap between this data and the last we emitted; fill with silence */
802 fill_audio (DCPTimePeriod (*_last_audio_time, i->second));
805 emit_audio (i->first, i->second);
810 for (auto const& i: _delay) {
811 do_emit_video(i.first, i.second);
819 /** @return Open subtitles for the frame at the given time, converted to images */
820 optional<PositionImage>
821 Player::open_subtitles_for_frame (DCPTime time) const
823 list<PositionImage> captions;
824 int const vfr = _film->video_frame_rate();
828 _active_texts[static_cast<int>(TextType::OPEN_SUBTITLE)].get_burnt(DCPTimePeriod(time, time + DCPTime::from_frames(1, vfr)), _always_burn_open_subtitles)
831 /* Bitmap subtitles */
832 for (auto i: j.bitmap) {
837 /* i.image will already have been scaled to fit _video_container_size */
838 dcp::Size scaled_size (i.rectangle.width * _video_container_size.width, i.rectangle.height * _video_container_size.height);
844 lrint(_video_container_size.width * i.rectangle.x),
845 lrint(_video_container_size.height * i.rectangle.y)
851 /* String subtitles (rendered to an image) */
852 if (!j.string.empty()) {
853 auto s = render_text (j.string, j.fonts, _video_container_size, time, vfr);
854 copy (s.begin(), s.end(), back_inserter (captions));
858 if (captions.empty()) {
862 return merge (captions, _subtitle_alignment);
867 Player::video (weak_ptr<Piece> wp, ContentVideo video)
873 auto piece = wp.lock ();
878 if (!piece->content->video->use()) {
882 FrameRateChange frc (_film, piece->content);
883 if (frc.skip && (video.frame % 2) == 1) {
887 /* Time of the first frame we will emit */
888 DCPTime const time = content_video_to_dcp (piece, video.frame);
889 LOG_DEBUG_PLAYER("Received video frame %1 at %2", video.frame, to_string(time));
891 /* Discard if it's before the content's period or the last accurate seek. We can't discard
892 if it's after the content's period here as in that case we still need to fill any gap between
893 `now' and the end of the content's period.
895 if (time < piece->content->position() || (_last_video_time && time < *_last_video_time)) {
899 if (piece->ignore_video && piece->ignore_video->contains(time)) {
903 /* Fill gaps that we discover now that we have some video which needs to be emitted.
904 This is where we need to fill to.
906 DCPTime fill_to = min (time, piece->content->end(_film));
908 if (_last_video_time) {
909 DCPTime fill_from = max (*_last_video_time, piece->content->position());
911 /* Fill if we have more than half a frame to do */
912 if ((fill_to - fill_from) > one_video_frame() / 2) {
913 auto last = _last_video.find (wp);
914 if (_film->three_d()) {
915 auto fill_to_eyes = video.eyes;
916 if (fill_to_eyes == Eyes::BOTH) {
917 fill_to_eyes = Eyes::LEFT;
919 if (fill_to == piece->content->end(_film)) {
920 /* Don't fill after the end of the content */
921 fill_to_eyes = Eyes::LEFT;
924 auto eyes = _last_video_eyes.get_value_or(Eyes::LEFT);
925 if (eyes == Eyes::BOTH) {
928 while (j < fill_to || eyes != fill_to_eyes) {
929 if (last != _last_video.end()) {
930 LOG_DEBUG_PLAYER("Fill using last video at %1 in 3D mode", to_string(j));
931 auto copy = last->second->shallow_copy();
932 copy->set_eyes (eyes);
933 emit_video (copy, j);
935 LOG_DEBUG_PLAYER("Fill using black at %1 in 3D mode", to_string(j));
936 emit_video (black_player_video_frame(eyes), j);
938 if (eyes == Eyes::RIGHT) {
939 j += one_video_frame();
941 eyes = increment_eyes (eyes);
944 for (DCPTime j = fill_from; j < fill_to; j += one_video_frame()) {
945 if (last != _last_video.end()) {
946 emit_video (last->second, j);
948 emit_video (black_player_video_frame(Eyes::BOTH), j);
955 auto const content_video = piece->content->video;
957 _last_video[wp] = std::make_shared<PlayerVideo>(
959 content_video->actual_crop(),
960 content_video->fade (_film, video.frame),
962 content_video->scaled_size(_film->frame_size()),
963 _video_container_size,
965 content_video->pixel_quanta()
967 _video_container_size,
970 content_video->colour_conversion(),
971 content_video->range(),
978 for (int i = 0; i < frc.repeat; ++i) {
979 if (t < piece->content->end(_film)) {
980 emit_video (_last_video[wp], t);
982 t += one_video_frame ();
988 Player::audio (weak_ptr<Piece> wp, AudioStreamPtr stream, ContentAudio content_audio)
994 DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
996 auto piece = wp.lock ();
1001 auto content = piece->content->audio;
1002 DCPOMATIC_ASSERT (content);
1004 int const rfr = content->resampled_frame_rate (_film);
1006 /* Compute time in the DCP */
1007 auto time = resampled_audio_to_dcp (piece, content_audio.frame);
1008 LOG_DEBUG_PLAYER("Received audio frame %1 at %2", content_audio.frame, to_string(time));
1010 /* And the end of this block in the DCP */
1011 auto end = time + DCPTime::from_frames(content_audio.audio->frames(), rfr);
1013 /* Remove anything that comes before the start or after the end of the content */
1014 if (time < piece->content->position()) {
1015 auto cut = discard_audio (content_audio.audio, time, piece->content->position());
1017 /* This audio is entirely discarded */
1020 content_audio.audio = cut.first;
1022 } else if (time > piece->content->end(_film)) {
1023 /* Discard it all */
1025 } else if (end > piece->content->end(_film)) {
1026 Frame const remaining_frames = DCPTime(piece->content->end(_film) - time).frames_round(rfr);
1027 if (remaining_frames == 0) {
1030 content_audio.audio = make_shared<AudioBuffers>(content_audio.audio, remaining_frames, 0);
1033 DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
1037 if (content->gain() != 0) {
1038 auto gain = make_shared<AudioBuffers>(content_audio.audio);
1039 gain->apply_gain (content->gain());
1040 content_audio.audio = gain;
1045 content_audio.audio = remap (content_audio.audio, _film->audio_channels(), stream->mapping());
1049 if (_audio_processor) {
1050 content_audio.audio = _audio_processor->run (content_audio.audio, _film->audio_channels ());
1055 _audio_merger.push (content_audio.audio, time);
1056 DCPOMATIC_ASSERT (_stream_states.find (stream) != _stream_states.end ());
1057 _stream_states[stream].last_push_end = time + DCPTime::from_frames (content_audio.audio->frames(), _film->audio_frame_rate());
1062 Player::bitmap_text_start (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentBitmapText subtitle)
1068 auto piece = wp.lock ();
1069 auto text = wc.lock ();
1070 if (!piece || !text) {
1074 /* Apply content's subtitle offsets */
1075 subtitle.sub.rectangle.x += text->x_offset ();
1076 subtitle.sub.rectangle.y += text->y_offset ();
1078 /* Apply a corrective translation to keep the subtitle centred after the scale that is coming up */
1079 subtitle.sub.rectangle.x -= subtitle.sub.rectangle.width * ((text->x_scale() - 1) / 2);
1080 subtitle.sub.rectangle.y -= subtitle.sub.rectangle.height * ((text->y_scale() - 1) / 2);
1082 /* Apply content's subtitle scale */
1083 subtitle.sub.rectangle.width *= text->x_scale ();
1084 subtitle.sub.rectangle.height *= text->y_scale ();
1087 auto image = subtitle.sub.image;
1089 /* We will scale the subtitle up to fit _video_container_size */
1090 int const width = subtitle.sub.rectangle.width * _video_container_size.width;
1091 int const height = subtitle.sub.rectangle.height * _video_container_size.height;
1092 if (width == 0 || height == 0) {
1096 dcp::Size scaled_size (width, height);
1097 ps.bitmap.push_back (BitmapText(image->scale(scaled_size, dcp::YUVToRGB::REC601, image->pixel_format(), Image::Alignment::PADDED, _fast), subtitle.sub.rectangle));
1098 DCPTime from (content_time_to_dcp (piece, subtitle.from()));
1100 _active_texts[static_cast<int>(text->type())].add_from (wc, ps, from);
1105 Player::plain_text_start (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentStringText subtitle)
1111 auto piece = wp.lock ();
1112 auto text = wc.lock ();
1113 if (!piece || !text) {
1118 DCPTime const from (content_time_to_dcp (piece, subtitle.from()));
1120 if (from > piece->content->end(_film)) {
1124 for (auto s: subtitle.subs) {
1125 s.set_h_position (s.h_position() + text->x_offset ());
1126 s.set_v_position (s.v_position() + text->y_offset ());
1127 float const xs = text->x_scale();
1128 float const ys = text->y_scale();
1129 float size = s.size();
1131 /* Adjust size to express the common part of the scaling;
1132 e.g. if xs = ys = 0.5 we scale size by 2.
1134 if (xs > 1e-5 && ys > 1e-5) {
1135 size *= 1 / min (1 / xs, 1 / ys);
1139 /* Then express aspect ratio changes */
1140 if (fabs (1.0 - xs / ys) > dcp::ASPECT_ADJUST_EPSILON) {
1141 s.set_aspect_adjust (xs / ys);
1144 s.set_in (dcp::Time(from.seconds(), 1000));
1145 ps.string.push_back (StringText (s, text->outline_width()));
1146 ps.add_fonts (text->fonts ());
1149 _active_texts[static_cast<int>(text->type())].add_from (wc, ps, from);
1154 Player::subtitle_stop (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentTime to)
1160 auto text = wc.lock ();
1165 if (!_active_texts[static_cast<int>(text->type())].have(wc)) {
1169 shared_ptr<Piece> piece = wp.lock ();
1174 DCPTime const dcp_to = content_time_to_dcp (piece, to);
1176 if (dcp_to > piece->content->end(_film)) {
1180 auto from = _active_texts[static_cast<int>(text->type())].add_to (wc, dcp_to);
1182 bool const always = (text->type() == TextType::OPEN_SUBTITLE && _always_burn_open_subtitles);
1183 if (text->use() && !always && !text->burn()) {
1184 Text (from.first, text->type(), text->dcp_track().get_value_or(DCPTextTrack()), DCPTimePeriod (from.second, dcp_to));
1190 Player::seek (DCPTime time, bool accurate)
1192 boost::mutex::scoped_lock lm (_mutex);
1193 LOG_DEBUG_PLAYER("Seek to %1 (%2accurate)", to_string(time), accurate ? "" : "in");
1196 /* We can't seek in this state */
1201 _shuffler->clear ();
1206 if (_audio_processor) {
1207 _audio_processor->flush ();
1210 _audio_merger.clear ();
1211 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
1212 _active_texts[i].clear ();
1215 for (auto i: _pieces) {
1216 if (time < i->content->position()) {
1217 /* Before; seek to the start of the content. Even if this request is for an inaccurate seek
1218 we must seek this (following) content accurately, otherwise when we come to the end of the current
1219 content we may not start right at the beginning of the next, causing a gap (if the next content has
1220 been trimmed to a point between keyframes, or something).
1222 i->decoder->seek (dcp_to_content_time (i, i->content->position()), true);
1224 } else if (i->content->position() <= time && time < i->content->end(_film)) {
1225 /* During; seek to position */
1226 i->decoder->seek (dcp_to_content_time (i, time), accurate);
1229 /* After; this piece is done */
1235 _last_video_time = time;
1236 _last_video_eyes = Eyes::LEFT;
1237 _last_audio_time = time;
1239 _last_video_time = optional<DCPTime>();
1240 _last_video_eyes = optional<Eyes>();
1241 _last_audio_time = optional<DCPTime>();
1244 _black.set_position (time);
1245 _silent.set_position (time);
1247 _last_video.clear ();
1252 Player::emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1254 if (!_film->three_d()) {
1255 if (pv->eyes() == Eyes::LEFT) {
1256 /* Use left-eye images for both eyes... */
1257 pv->set_eyes (Eyes::BOTH);
1258 } else if (pv->eyes() == Eyes::RIGHT) {
1259 /* ...and discard the right */
1264 /* We need a delay to give a little wiggle room to ensure that relevent subtitles arrive at the
1265 player before the video that requires them.
1267 _delay.push_back (make_pair (pv, time));
1269 if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
1270 _last_video_time = time + one_video_frame();
1272 _last_video_eyes = increment_eyes (pv->eyes());
1274 if (_delay.size() < 3) {
1278 auto to_do = _delay.front();
1280 do_emit_video (to_do.first, to_do.second);
1285 Player::do_emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1287 if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
1288 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
1289 _active_texts[i].clear_before (time);
1293 auto subtitles = open_subtitles_for_frame (time);
1295 pv->set_text (subtitles.get ());
1303 Player::emit_audio (shared_ptr<AudioBuffers> data, DCPTime time)
1305 /* Log if the assert below is about to fail */
1306 if (_last_audio_time && labs(time.get() - _last_audio_time->get()) > 1) {
1307 _film->log()->log(String::compose("Out-of-sequence emit %1 vs %2", to_string(time), to_string(*_last_audio_time)), LogEntry::TYPE_WARNING);
1310 /* This audio must follow on from the previous, allowing for half a sample (at 48kHz) leeway */
1311 DCPOMATIC_ASSERT (!_last_audio_time || labs(time.get() - _last_audio_time->get()) < 2);
1312 Audio (data, time, _film->audio_frame_rate());
1313 _last_audio_time = time + DCPTime::from_frames (data->frames(), _film->audio_frame_rate());
1318 Player::fill_audio (DCPTimePeriod period)
1320 if (period.from == period.to) {
1324 DCPOMATIC_ASSERT (period.from < period.to);
1326 DCPTime t = period.from;
1327 while (t < period.to) {
1328 DCPTime block = min (DCPTime::from_seconds (0.5), period.to - t);
1329 Frame const samples = block.frames_round(_film->audio_frame_rate());
1331 auto silence = make_shared<AudioBuffers>(_film->audio_channels(), samples);
1332 silence->make_silent ();
1333 emit_audio (silence, t);
1341 Player::one_video_frame () const
1343 return DCPTime::from_frames (1, _film->video_frame_rate ());
1347 pair<shared_ptr<AudioBuffers>, DCPTime>
1348 Player::discard_audio (shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to) const
1350 auto const discard_time = discard_to - time;
1351 auto const discard_frames = discard_time.frames_round(_film->audio_frame_rate());
1352 auto remaining_frames = audio->frames() - discard_frames;
1353 if (remaining_frames <= 0) {
1354 return make_pair(shared_ptr<AudioBuffers>(), DCPTime());
1356 auto cut = make_shared<AudioBuffers>(audio, remaining_frames, discard_frames);
1357 return make_pair(cut, time + discard_time);
1362 Player::set_dcp_decode_reduction (optional<int> reduction)
1364 Change (ChangeType::PENDING, PlayerProperty::DCP_DECODE_REDUCTION, false);
1367 boost::mutex::scoped_lock lm (_mutex);
1369 if (reduction == _dcp_decode_reduction) {
1371 Change (ChangeType::CANCELLED, PlayerProperty::DCP_DECODE_REDUCTION, false);
1375 _dcp_decode_reduction = reduction;
1376 setup_pieces_unlocked ();
1379 Change (ChangeType::DONE, PlayerProperty::DCP_DECODE_REDUCTION, false);
1384 Player::content_time_to_dcp (shared_ptr<Content> content, ContentTime t)
1386 boost::mutex::scoped_lock lm (_mutex);
1388 for (auto i: _pieces) {
1389 if (i->content == content) {
1390 return content_time_to_dcp (i, t);
1394 /* We couldn't find this content; perhaps things are being changed over */
1399 shared_ptr<const Playlist>
1400 Player::playlist () const
1402 return _playlist ? _playlist : _film->playlist();
1407 Player::atmos (weak_ptr<Piece>, ContentAtmos data)
1413 Atmos (data.data, DCPTime::from_frames(data.frame, _film->video_frame_rate()), data.metadata);