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;
78 using std::shared_ptr;
81 using std::make_shared;
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;
98 Player::Player (shared_ptr<const Film> film)
101 , _tolerant (film->tolerant())
102 , _audio_merger (_film->audio_frame_rate())
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.reset (new Image (AV_PIX_FMT_RGB24, _video_container_size, true));
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> a;
562 for (auto i: playlist()->content()) {
563 auto j = dynamic_pointer_cast<DCPContent> (i);
568 scoped_ptr<DCPDecoder> decoder;
570 decoder.reset (new DCPDecoder(_film, j, false, false, shared_ptr<DCPDecoder>()));
575 DCPOMATIC_ASSERT (j->video_frame_rate ());
576 double const cfr = j->video_frame_rate().get();
577 Frame const trim_start = j->trim_start().frames_round (cfr);
578 Frame const trim_end = j->trim_end().frames_round (cfr);
579 int const ffr = _film->video_frame_rate ();
581 /* position in the asset from the start */
582 int64_t offset_from_start = 0;
583 /* position in the asset from the end */
584 int64_t offset_from_end = 0;
585 for (auto k: decoder->reels()) {
586 /* Assume that main picture duration is the length of the reel */
587 offset_from_end += k->main_picture()->actual_duration();
590 for (auto k: decoder->reels()) {
592 /* Assume that main picture duration is the length of the reel */
593 int64_t const reel_duration = k->main_picture()->actual_duration();
595 /* See doc/design/trim_reels.svg */
596 Frame const reel_trim_start = min(reel_duration, max(int64_t(0), trim_start - offset_from_start));
597 Frame const reel_trim_end = min(reel_duration, max(int64_t(0), reel_duration - (offset_from_end - trim_end)));
599 auto const from = i->position() + DCPTime::from_frames (offset_from_start, _film->video_frame_rate());
600 if (j->reference_video ()) {
601 maybe_add_asset (a, k->main_picture(), reel_trim_start, reel_trim_end, from, ffr);
604 if (j->reference_audio ()) {
605 maybe_add_asset (a, k->main_sound(), reel_trim_start, reel_trim_end, from, ffr);
608 if (j->reference_text (TextType::OPEN_SUBTITLE)) {
609 maybe_add_asset (a, k->main_subtitle(), reel_trim_start, reel_trim_end, from, ffr);
612 if (j->reference_text (TextType::CLOSED_CAPTION)) {
613 for (auto l: k->closed_captions()) {
614 maybe_add_asset (a, l, reel_trim_start, reel_trim_end, from, ffr);
618 offset_from_start += reel_duration;
619 offset_from_end -= reel_duration;
630 boost::mutex::scoped_lock lm (_mutex);
633 /* We can't pass in this state */
634 LOG_DEBUG_PLAYER_NC ("Player is suspended");
638 if (_playback_length == DCPTime()) {
639 /* Special; just give one black frame */
640 emit_video (black_player_video_frame(Eyes::BOTH), DCPTime());
644 /* Find the decoder or empty which is farthest behind where we are and make it emit some data */
646 shared_ptr<Piece> earliest_content;
647 optional<DCPTime> earliest_time;
649 for (auto i: _pieces) {
654 auto const t = content_time_to_dcp (i, max(i->decoder->position(), i->content->trim_start()));
655 if (t > i->content->end(_film)) {
659 /* Given two choices at the same time, pick the one with texts so we see it before
662 if (!earliest_time || t < *earliest_time || (t == *earliest_time && !i->decoder->text.empty())) {
664 earliest_content = i;
678 if (earliest_content) {
682 if (!_black.done() && !_ignore_video && (!earliest_time || _black.position() < *earliest_time)) {
683 earliest_time = _black.position ();
687 if (!_silent.done() && !_ignore_audio && (!earliest_time || _silent.position() < *earliest_time)) {
688 earliest_time = _silent.position ();
695 LOG_DEBUG_PLAYER ("Calling pass() on %1", earliest_content->content->path(0));
696 earliest_content->done = earliest_content->decoder->pass ();
697 auto dcp = dynamic_pointer_cast<DCPContent>(earliest_content->content);
698 if (dcp && !_play_referenced && dcp->reference_audio()) {
699 /* We are skipping some referenced DCP audio content, so we need to update _last_audio_time
700 to `hide' the fact that no audio was emitted during the referenced DCP (though
701 we need to behave as though it was).
703 _last_audio_time = dcp->end (_film);
708 LOG_DEBUG_PLAYER ("Emit black for gap at %1", to_string(_black.position()));
709 emit_video (black_player_video_frame(Eyes::BOTH), _black.position());
710 _black.set_position (_black.position() + one_video_frame());
714 LOG_DEBUG_PLAYER ("Emit silence for gap at %1", to_string(_silent.position()));
715 DCPTimePeriod period (_silent.period_at_position());
716 if (_last_audio_time) {
717 /* Sometimes the thing that happened last finishes fractionally before
718 or after this silence. Bodge the start time of the silence to fix it.
719 I think this is nothing to worry about since we will just add or
720 remove a little silence at the end of some content.
722 int64_t const error = labs(period.from.get() - _last_audio_time->get());
723 /* Let's not worry about less than a frame at 24fps */
724 int64_t const too_much_error = DCPTime::from_frames(1, 24).get();
725 if (error >= too_much_error) {
726 _film->log()->log(String::compose("Silence starting before or after last audio by %1", error), LogEntry::TYPE_ERROR);
728 DCPOMATIC_ASSERT (error < too_much_error);
729 period.from = *_last_audio_time;
731 if (period.duration() > one_video_frame()) {
732 period.to = period.from + one_video_frame();
735 _silent.set_position (period.to);
743 /* Emit any audio that is ready */
745 /* Work out the time before which the audio is definitely all here. This is the earliest last_push_end of one
746 of our streams, or the position of the _silent.
748 auto pull_to = _playback_length;
749 for (auto const& i: _stream_states) {
750 if (!i.second.piece->done && i.second.last_push_end < pull_to) {
751 pull_to = i.second.last_push_end;
754 if (!_silent.done() && _silent.position() < pull_to) {
755 pull_to = _silent.position();
758 LOG_DEBUG_PLAYER("Emitting audio up to %1", to_string(pull_to));
759 auto audio = _audio_merger.pull (pull_to);
760 for (auto i = audio.begin(); i != audio.end(); ++i) {
761 if (_last_audio_time && i->second < *_last_audio_time) {
762 /* This new data comes before the last we emitted (or the last seek); discard it */
763 auto cut = discard_audio (i->first, i->second, *_last_audio_time);
768 } else if (_last_audio_time && i->second > *_last_audio_time) {
769 /* There's a gap between this data and the last we emitted; fill with silence */
770 fill_audio (DCPTimePeriod (*_last_audio_time, i->second));
773 emit_audio (i->first, i->second);
778 for (auto const& i: _delay) {
779 do_emit_video(i.first, i.second);
787 /** @return Open subtitles for the frame at the given time, converted to images */
788 optional<PositionImage>
789 Player::open_subtitles_for_frame (DCPTime time) const
791 list<PositionImage> captions;
792 int const vfr = _film->video_frame_rate();
796 _active_texts[static_cast<int>(TextType::OPEN_SUBTITLE)].get_burnt(DCPTimePeriod(time, time + DCPTime::from_frames(1, vfr)), _always_burn_open_subtitles)
799 /* Bitmap subtitles */
800 for (auto i: j.bitmap) {
805 /* i.image will already have been scaled to fit _video_container_size */
806 dcp::Size scaled_size (i.rectangle.width * _video_container_size.width, i.rectangle.height * _video_container_size.height);
812 lrint(_video_container_size.width * i.rectangle.x),
813 lrint(_video_container_size.height * i.rectangle.y)
819 /* String subtitles (rendered to an image) */
820 if (!j.string.empty()) {
821 auto s = render_text (j.string, j.fonts, _video_container_size, time, vfr);
822 copy (s.begin(), s.end(), back_inserter (captions));
826 if (captions.empty()) {
830 return merge (captions);
835 Player::video (weak_ptr<Piece> wp, ContentVideo video)
841 auto piece = wp.lock ();
846 if (!piece->content->video->use()) {
850 FrameRateChange frc (_film, piece->content);
851 if (frc.skip && (video.frame % 2) == 1) {
855 /* Time of the first frame we will emit */
856 DCPTime const time = content_video_to_dcp (piece, video.frame);
857 LOG_DEBUG_PLAYER("Received video frame %1 at %2", video.frame, to_string(time));
859 /* Discard if it's before the content's period or the last accurate seek. We can't discard
860 if it's after the content's period here as in that case we still need to fill any gap between
861 `now' and the end of the content's period.
863 if (time < piece->content->position() || (_last_video_time && time < *_last_video_time)) {
867 if (piece->ignore_video && piece->ignore_video->contains(time)) {
871 /* Fill gaps that we discover now that we have some video which needs to be emitted.
872 This is where we need to fill to.
874 DCPTime fill_to = min (time, piece->content->end(_film));
876 if (_last_video_time) {
877 DCPTime fill_from = max (*_last_video_time, piece->content->position());
879 /* Fill if we have more than half a frame to do */
880 if ((fill_to - fill_from) > one_video_frame() / 2) {
881 auto last = _last_video.find (wp);
882 if (_film->three_d()) {
883 auto fill_to_eyes = video.eyes;
884 if (fill_to_eyes == Eyes::BOTH) {
885 fill_to_eyes = Eyes::LEFT;
887 if (fill_to == piece->content->end(_film)) {
888 /* Don't fill after the end of the content */
889 fill_to_eyes = Eyes::LEFT;
892 auto eyes = _last_video_eyes.get_value_or(Eyes::LEFT);
893 if (eyes == Eyes::BOTH) {
896 while (j < fill_to || eyes != fill_to_eyes) {
897 if (last != _last_video.end()) {
898 LOG_DEBUG_PLAYER("Fill using last video at %1 in 3D mode", to_string(j));
899 auto copy = last->second->shallow_copy();
900 copy->set_eyes (eyes);
901 emit_video (copy, j);
903 LOG_DEBUG_PLAYER("Fill using black at %1 in 3D mode", to_string(j));
904 emit_video (black_player_video_frame(eyes), j);
906 if (eyes == Eyes::RIGHT) {
907 j += one_video_frame();
909 eyes = increment_eyes (eyes);
912 for (DCPTime j = fill_from; j < fill_to; j += one_video_frame()) {
913 if (last != _last_video.end()) {
914 emit_video (last->second, j);
916 emit_video (black_player_video_frame(Eyes::BOTH), j);
923 _last_video[wp] = std::make_shared<PlayerVideo>(
925 piece->content->video->crop (),
926 piece->content->video->fade (_film, video.frame),
927 scale_for_display(piece->content->video->scaled_size(_film->frame_size()), _video_container_size, _film->frame_size()),
928 _video_container_size,
931 piece->content->video->colour_conversion(),
932 piece->content->video->range(),
939 for (int i = 0; i < frc.repeat; ++i) {
940 if (t < piece->content->end(_film)) {
941 emit_video (_last_video[wp], t);
943 t += one_video_frame ();
949 Player::audio (weak_ptr<Piece> wp, AudioStreamPtr stream, ContentAudio content_audio)
955 DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
957 auto piece = wp.lock ();
962 auto content = piece->content->audio;
963 DCPOMATIC_ASSERT (content);
965 int const rfr = content->resampled_frame_rate (_film);
967 /* Compute time in the DCP */
968 auto time = resampled_audio_to_dcp (piece, content_audio.frame);
969 LOG_DEBUG_PLAYER("Received audio frame %1 at %2", content_audio.frame, to_string(time));
971 /* And the end of this block in the DCP */
972 auto end = time + DCPTime::from_frames(content_audio.audio->frames(), rfr);
974 /* Remove anything that comes before the start or after the end of the content */
975 if (time < piece->content->position()) {
976 auto cut = discard_audio (content_audio.audio, time, piece->content->position());
978 /* This audio is entirely discarded */
981 content_audio.audio = cut.first;
983 } else if (time > piece->content->end(_film)) {
986 } else if (end > piece->content->end(_film)) {
987 Frame const remaining_frames = DCPTime(piece->content->end(_film) - time).frames_round(rfr);
988 if (remaining_frames == 0) {
991 content_audio.audio = make_shared<AudioBuffers>(content_audio.audio, remaining_frames, 0);
994 DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
998 if (content->gain() != 0) {
999 auto gain = make_shared<AudioBuffers>(content_audio.audio);
1000 gain->apply_gain (content->gain());
1001 content_audio.audio = gain;
1006 content_audio.audio = remap (content_audio.audio, _film->audio_channels(), stream->mapping());
1010 if (_audio_processor) {
1011 content_audio.audio = _audio_processor->run (content_audio.audio, _film->audio_channels ());
1016 _audio_merger.push (content_audio.audio, time);
1017 DCPOMATIC_ASSERT (_stream_states.find (stream) != _stream_states.end ());
1018 _stream_states[stream].last_push_end = time + DCPTime::from_frames (content_audio.audio->frames(), _film->audio_frame_rate());
1023 Player::bitmap_text_start (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentBitmapText subtitle)
1029 auto piece = wp.lock ();
1030 auto text = wc.lock ();
1031 if (!piece || !text) {
1035 /* Apply content's subtitle offsets */
1036 subtitle.sub.rectangle.x += text->x_offset ();
1037 subtitle.sub.rectangle.y += text->y_offset ();
1039 /* Apply a corrective translation to keep the subtitle centred after the scale that is coming up */
1040 subtitle.sub.rectangle.x -= subtitle.sub.rectangle.width * ((text->x_scale() - 1) / 2);
1041 subtitle.sub.rectangle.y -= subtitle.sub.rectangle.height * ((text->y_scale() - 1) / 2);
1043 /* Apply content's subtitle scale */
1044 subtitle.sub.rectangle.width *= text->x_scale ();
1045 subtitle.sub.rectangle.height *= text->y_scale ();
1048 auto image = subtitle.sub.image;
1050 /* We will scale the subtitle up to fit _video_container_size */
1051 int const width = subtitle.sub.rectangle.width * _video_container_size.width;
1052 int const height = subtitle.sub.rectangle.height * _video_container_size.height;
1053 if (width == 0 || height == 0) {
1057 dcp::Size scaled_size (width, height);
1058 ps.bitmap.push_back (BitmapText(image->scale(scaled_size, dcp::YUVToRGB::REC601, image->pixel_format(), true, _fast), subtitle.sub.rectangle));
1059 DCPTime from (content_time_to_dcp (piece, subtitle.from()));
1061 _active_texts[static_cast<int>(text->type())].add_from (wc, ps, from);
1066 Player::plain_text_start (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentStringText subtitle)
1072 auto piece = wp.lock ();
1073 auto text = wc.lock ();
1074 if (!piece || !text) {
1079 DCPTime const from (content_time_to_dcp (piece, subtitle.from()));
1081 if (from > piece->content->end(_film)) {
1085 for (auto s: subtitle.subs) {
1086 s.set_h_position (s.h_position() + text->x_offset ());
1087 s.set_v_position (s.v_position() + text->y_offset ());
1088 float const xs = text->x_scale();
1089 float const ys = text->y_scale();
1090 float size = s.size();
1092 /* Adjust size to express the common part of the scaling;
1093 e.g. if xs = ys = 0.5 we scale size by 2.
1095 if (xs > 1e-5 && ys > 1e-5) {
1096 size *= 1 / min (1 / xs, 1 / ys);
1100 /* Then express aspect ratio changes */
1101 if (fabs (1.0 - xs / ys) > dcp::ASPECT_ADJUST_EPSILON) {
1102 s.set_aspect_adjust (xs / ys);
1105 s.set_in (dcp::Time(from.seconds(), 1000));
1106 ps.string.push_back (StringText (s, text->outline_width()));
1107 ps.add_fonts (text->fonts ());
1110 _active_texts[static_cast<int>(text->type())].add_from (wc, ps, from);
1115 Player::subtitle_stop (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentTime to)
1121 auto text = wc.lock ();
1126 if (!_active_texts[static_cast<int>(text->type())].have(wc)) {
1130 shared_ptr<Piece> piece = wp.lock ();
1135 DCPTime const dcp_to = content_time_to_dcp (piece, to);
1137 if (dcp_to > piece->content->end(_film)) {
1141 auto from = _active_texts[static_cast<int>(text->type())].add_to (wc, dcp_to);
1143 bool const always = (text->type() == TextType::OPEN_SUBTITLE && _always_burn_open_subtitles);
1144 if (text->use() && !always && !text->burn()) {
1145 Text (from.first, text->type(), text->dcp_track().get_value_or(DCPTextTrack()), DCPTimePeriod (from.second, dcp_to));
1151 Player::seek (DCPTime time, bool accurate)
1153 boost::mutex::scoped_lock lm (_mutex);
1154 LOG_DEBUG_PLAYER("Seek to %1 (%2accurate)", to_string(time), accurate ? "" : "in");
1157 /* We can't seek in this state */
1162 _shuffler->clear ();
1167 if (_audio_processor) {
1168 _audio_processor->flush ();
1171 _audio_merger.clear ();
1172 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
1173 _active_texts[i].clear ();
1176 for (auto i: _pieces) {
1177 if (time < i->content->position()) {
1178 /* Before; seek to the start of the content. Even if this request is for an inaccurate seek
1179 we must seek this (following) content accurately, otherwise when we come to the end of the current
1180 content we may not start right at the beginning of the next, causing a gap (if the next content has
1181 been trimmed to a point between keyframes, or something).
1183 i->decoder->seek (dcp_to_content_time (i, i->content->position()), true);
1185 } else if (i->content->position() <= time && time < i->content->end(_film)) {
1186 /* During; seek to position */
1187 i->decoder->seek (dcp_to_content_time (i, time), accurate);
1190 /* After; this piece is done */
1196 _last_video_time = time;
1197 _last_video_eyes = Eyes::LEFT;
1198 _last_audio_time = time;
1200 _last_video_time = optional<DCPTime>();
1201 _last_video_eyes = optional<Eyes>();
1202 _last_audio_time = optional<DCPTime>();
1205 _black.set_position (time);
1206 _silent.set_position (time);
1208 _last_video.clear ();
1213 Player::emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1215 if (!_film->three_d()) {
1216 if (pv->eyes() == Eyes::LEFT) {
1217 /* Use left-eye images for both eyes... */
1218 pv->set_eyes (Eyes::BOTH);
1219 } else if (pv->eyes() == Eyes::RIGHT) {
1220 /* ...and discard the right */
1225 /* We need a delay to give a little wiggle room to ensure that relevent subtitles arrive at the
1226 player before the video that requires them.
1228 _delay.push_back (make_pair (pv, time));
1230 if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
1231 _last_video_time = time + one_video_frame();
1233 _last_video_eyes = increment_eyes (pv->eyes());
1235 if (_delay.size() < 3) {
1239 auto to_do = _delay.front();
1241 do_emit_video (to_do.first, to_do.second);
1246 Player::do_emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1248 if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
1249 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
1250 _active_texts[i].clear_before (time);
1254 auto subtitles = open_subtitles_for_frame (time);
1256 pv->set_text (subtitles.get ());
1264 Player::emit_audio (shared_ptr<AudioBuffers> data, DCPTime time)
1266 /* Log if the assert below is about to fail */
1267 if (_last_audio_time && labs(time.get() - _last_audio_time->get()) > 1) {
1268 _film->log()->log(String::compose("Out-of-sequence emit %1 vs %2", to_string(time), to_string(*_last_audio_time)), LogEntry::TYPE_WARNING);
1271 /* This audio must follow on from the previous, allowing for half a sample (at 48kHz) leeway */
1272 DCPOMATIC_ASSERT (!_last_audio_time || labs(time.get() - _last_audio_time->get()) < 2);
1273 Audio (data, time, _film->audio_frame_rate());
1274 _last_audio_time = time + DCPTime::from_frames (data->frames(), _film->audio_frame_rate());
1279 Player::fill_audio (DCPTimePeriod period)
1281 if (period.from == period.to) {
1285 DCPOMATIC_ASSERT (period.from < period.to);
1287 DCPTime t = period.from;
1288 while (t < period.to) {
1289 DCPTime block = min (DCPTime::from_seconds (0.5), period.to - t);
1290 Frame const samples = block.frames_round(_film->audio_frame_rate());
1292 auto silence = make_shared<AudioBuffers>(_film->audio_channels(), samples);
1293 silence->make_silent ();
1294 emit_audio (silence, t);
1302 Player::one_video_frame () const
1304 return DCPTime::from_frames (1, _film->video_frame_rate ());
1308 pair<shared_ptr<AudioBuffers>, DCPTime>
1309 Player::discard_audio (shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to) const
1311 auto const discard_time = discard_to - time;
1312 auto const discard_frames = discard_time.frames_round(_film->audio_frame_rate());
1313 auto remaining_frames = audio->frames() - discard_frames;
1314 if (remaining_frames <= 0) {
1315 return make_pair(shared_ptr<AudioBuffers>(), DCPTime());
1317 auto cut = make_shared<AudioBuffers>(audio, remaining_frames, discard_frames);
1318 return make_pair(cut, time + discard_time);
1323 Player::set_dcp_decode_reduction (optional<int> reduction)
1325 Change (ChangeType::PENDING, PlayerProperty::DCP_DECODE_REDUCTION, false);
1328 boost::mutex::scoped_lock lm (_mutex);
1330 if (reduction == _dcp_decode_reduction) {
1332 Change (ChangeType::CANCELLED, PlayerProperty::DCP_DECODE_REDUCTION, false);
1336 _dcp_decode_reduction = reduction;
1337 setup_pieces_unlocked ();
1340 Change (ChangeType::DONE, PlayerProperty::DCP_DECODE_REDUCTION, false);
1345 Player::content_time_to_dcp (shared_ptr<Content> content, ContentTime t)
1347 boost::mutex::scoped_lock lm (_mutex);
1349 for (auto i: _pieces) {
1350 if (i->content == content) {
1351 return content_time_to_dcp (i, t);
1355 /* We couldn't find this content; perhaps things are being changed over */
1360 shared_ptr<const Playlist>
1361 Player::playlist () const
1363 return _playlist ? _playlist : _film->playlist();
1368 Player::atmos (weak_ptr<Piece>, ContentAtmos data)
1374 Atmos (data.data, DCPTime::from_frames(data.frame, _film->video_frame_rate()), data.metadata);