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);
144 Player::setup_pieces ()
146 boost::mutex::scoped_lock lm (_mutex);
147 setup_pieces_unlocked ();
152 have_video (shared_ptr<const Content> content)
154 return static_cast<bool>(content->video) && content->video->use();
159 have_audio (shared_ptr<const Content> content)
161 return static_cast<bool>(content->audio);
166 Player::setup_pieces_unlocked ()
168 _playback_length = _playlist ? _playlist->length(_film) : _film->length();
170 auto old_pieces = _pieces;
174 _shuffler = new Shuffler();
175 _shuffler->Video.connect(bind(&Player::video, this, _1, _2));
177 for (auto i: playlist()->content()) {
179 if (!i->paths_valid ()) {
183 if (_ignore_video && _ignore_audio && i->text.empty()) {
184 /* We're only interested in text and this content has none */
188 shared_ptr<Decoder> old_decoder;
189 for (auto j: old_pieces) {
190 if (j->content == i) {
191 old_decoder = j->decoder;
196 auto decoder = decoder_factory (_film, i, _fast, _tolerant, old_decoder);
197 DCPOMATIC_ASSERT (decoder);
199 FrameRateChange frc (_film, i);
201 if (decoder->video && _ignore_video) {
202 decoder->video->set_ignore (true);
205 if (decoder->audio && _ignore_audio) {
206 decoder->audio->set_ignore (true);
210 for (auto i: decoder->text) {
211 i->set_ignore (true);
215 auto dcp = dynamic_pointer_cast<DCPDecoder> (decoder);
217 dcp->set_decode_referenced (_play_referenced);
218 if (_play_referenced) {
219 dcp->set_forced_reduction (_dcp_decode_reduction);
223 auto piece = make_shared<Piece>(i, decoder, frc);
224 _pieces.push_back (piece);
226 if (decoder->video) {
227 if (i->video->frame_type() == VideoFrameType::THREE_D_LEFT || i->video->frame_type() == VideoFrameType::THREE_D_RIGHT) {
228 /* We need a Shuffler to cope with 3D L/R video data arriving out of sequence */
229 decoder->video->Data.connect (bind(&Shuffler::video, _shuffler, weak_ptr<Piece>(piece), _1));
231 decoder->video->Data.connect (bind(&Player::video, this, weak_ptr<Piece>(piece), _1));
235 if (decoder->audio) {
236 decoder->audio->Data.connect (bind (&Player::audio, this, weak_ptr<Piece> (piece), _1, _2));
239 auto j = decoder->text.begin();
241 while (j != decoder->text.end()) {
242 (*j)->BitmapStart.connect (
243 bind(&Player::bitmap_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
245 (*j)->PlainStart.connect (
246 bind(&Player::plain_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
249 bind(&Player::subtitle_stop, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
255 if (decoder->atmos) {
256 decoder->atmos->Data.connect (bind(&Player::atmos, this, weak_ptr<Piece>(piece), _1));
260 _stream_states.clear ();
261 for (auto i: _pieces) {
262 if (i->content->audio) {
263 for (auto j: i->content->audio->streams()) {
264 _stream_states[j] = StreamState (i, i->content->position ());
269 for (auto i = _pieces.begin(); i != _pieces.end(); ++i) {
270 if (auto video = (*i)->content->video) {
271 if (video->use() && video->frame_type() != VideoFrameType::THREE_D_LEFT && video->frame_type() != VideoFrameType::THREE_D_RIGHT) {
272 /* Look for content later in the content list with in-use video that overlaps this */
273 auto period = DCPTimePeriod((*i)->content->position(), (*i)->content->end(_film));
276 for (; j != _pieces.end(); ++j) {
277 if ((*j)->content->video && (*j)->content->video->use()) {
278 (*i)->ignore_video = DCPTimePeriod((*j)->content->position(), (*j)->content->end(_film)).overlap(period);
285 _black = Empty (_film, playlist(), bind(&have_video, _1), _playback_length);
286 _silent = Empty (_film, playlist(), bind(&have_audio, _1), _playback_length);
288 _last_video_time = boost::optional<dcpomatic::DCPTime>();
289 _last_video_eyes = Eyes::BOTH;
290 _last_audio_time = boost::optional<dcpomatic::DCPTime>();
295 Player::playlist_content_change (ChangeType type, int property, bool frequent)
297 if (property == VideoContentProperty::CROP) {
298 if (type == ChangeType::DONE) {
299 auto const vcs = video_container_size();
300 boost::mutex::scoped_lock lm (_mutex);
301 for (auto const& i: _delay) {
302 i.first->reset_metadata (_film, vcs);
306 if (type == ChangeType::PENDING) {
307 /* The player content is probably about to change, so we can't carry on
308 until that has happened and we've rebuilt our pieces. Stop pass()
309 and seek() from working until then.
312 } else if (type == ChangeType::DONE) {
313 /* A change in our content has gone through. Re-build our pieces. */
316 } else if (type == ChangeType::CANCELLED) {
321 Change (type, property, frequent);
326 Player::set_video_container_size (dcp::Size s)
328 Change (ChangeType::PENDING, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
331 boost::mutex::scoped_lock lm (_mutex);
333 if (s == _video_container_size) {
335 Change (ChangeType::CANCELLED, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
339 _video_container_size = s;
341 _black_image.reset (new Image (AV_PIX_FMT_RGB24, _video_container_size, true));
342 _black_image->make_black ();
345 Change (ChangeType::DONE, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
350 Player::playlist_change (ChangeType type)
352 if (type == ChangeType::DONE) {
355 Change (type, PlayerProperty::PLAYLIST, false);
360 Player::film_change (ChangeType type, Film::Property p)
362 /* Here we should notice Film properties that affect our output, and
363 alert listeners that our output now would be different to how it was
364 last time we were run.
367 if (p == Film::Property::CONTAINER) {
368 Change (type, PlayerProperty::FILM_CONTAINER, false);
369 } else if (p == Film::Property::VIDEO_FRAME_RATE) {
370 /* Pieces contain a FrameRateChange which contains the DCP frame rate,
371 so we need new pieces here.
373 if (type == ChangeType::DONE) {
376 Change (type, PlayerProperty::FILM_VIDEO_FRAME_RATE, false);
377 } else if (p == Film::Property::AUDIO_PROCESSOR) {
378 if (type == ChangeType::DONE && _film->audio_processor ()) {
379 boost::mutex::scoped_lock lm (_mutex);
380 _audio_processor = _film->audio_processor()->clone (_film->audio_frame_rate ());
382 } else if (p == Film::Property::AUDIO_CHANNELS) {
383 if (type == ChangeType::DONE) {
384 boost::mutex::scoped_lock lm (_mutex);
385 _audio_merger.clear ();
391 shared_ptr<PlayerVideo>
392 Player::black_player_video_frame (Eyes eyes) const
394 return std::make_shared<PlayerVideo> (
395 std::make_shared<const RawImageProxy>(_black_image),
398 _video_container_size,
399 _video_container_size,
402 PresetColourConversion::all().front().conversion,
404 std::weak_ptr<Content>(),
405 boost::optional<Frame>(),
412 Player::dcp_to_content_video (shared_ptr<const Piece> piece, DCPTime t) const
414 auto s = t - piece->content->position ();
415 s = min (piece->content->length_after_trim(_film), s);
416 s = max (DCPTime(), s + DCPTime (piece->content->trim_start(), piece->frc));
418 /* It might seem more logical here to convert s to a ContentTime (using the FrameRateChange)
419 then convert that ContentTime to frames at the content's rate. However this fails for
420 situations like content at 29.9978733fps, DCP at 30fps. The accuracy of the Time type is not
421 enough to distinguish between the two with low values of time (e.g. 3200 in Time units).
423 Instead we convert the DCPTime using the DCP video rate then account for any skip/repeat.
425 return s.frames_floor (piece->frc.dcp) / piece->frc.factor ();
430 Player::content_video_to_dcp (shared_ptr<const Piece> piece, Frame f) const
432 /* See comment in dcp_to_content_video */
433 auto const d = DCPTime::from_frames (f * piece->frc.factor(), piece->frc.dcp) - DCPTime(piece->content->trim_start(), piece->frc);
434 return d + piece->content->position();
439 Player::dcp_to_resampled_audio (shared_ptr<const Piece> piece, DCPTime t) const
441 auto s = t - piece->content->position ();
442 s = min (piece->content->length_after_trim(_film), s);
443 /* See notes in dcp_to_content_video */
444 return max (DCPTime(), DCPTime(piece->content->trim_start(), piece->frc) + s).frames_floor(_film->audio_frame_rate());
449 Player::resampled_audio_to_dcp (shared_ptr<const Piece> piece, Frame f) const
451 /* See comment in dcp_to_content_video */
452 return DCPTime::from_frames (f, _film->audio_frame_rate())
453 - DCPTime (piece->content->trim_start(), piece->frc)
454 + piece->content->position();
459 Player::dcp_to_content_time (shared_ptr<const Piece> piece, DCPTime t) const
461 auto s = t - piece->content->position ();
462 s = min (piece->content->length_after_trim(_film), s);
463 return max (ContentTime (), ContentTime (s, piece->frc) + piece->content->trim_start());
468 Player::content_time_to_dcp (shared_ptr<const Piece> piece, ContentTime t) const
470 return max (DCPTime(), DCPTime(t - piece->content->trim_start(), piece->frc) + piece->content->position());
475 Player::get_subtitle_fonts ()
477 boost::mutex::scoped_lock lm (_mutex);
479 vector<FontData> fonts;
480 for (auto i: _pieces) {
481 /* XXX: things may go wrong if there are duplicate font IDs
482 with different font files.
484 auto f = i->decoder->fonts ();
485 copy (f.begin(), f.end(), back_inserter(fonts));
492 /** Set this player never to produce any video data */
494 Player::set_ignore_video ()
496 boost::mutex::scoped_lock lm (_mutex);
497 _ignore_video = true;
498 setup_pieces_unlocked ();
503 Player::set_ignore_audio ()
505 boost::mutex::scoped_lock lm (_mutex);
506 _ignore_audio = true;
507 setup_pieces_unlocked ();
512 Player::set_ignore_text ()
514 boost::mutex::scoped_lock lm (_mutex);
516 setup_pieces_unlocked ();
520 /** Set the player to always burn open texts into the image regardless of the content settings */
522 Player::set_always_burn_open_subtitles ()
524 boost::mutex::scoped_lock lm (_mutex);
525 _always_burn_open_subtitles = true;
529 /** Sets up the player to be faster, possibly at the expense of quality */
533 boost::mutex::scoped_lock lm (_mutex);
535 setup_pieces_unlocked ();
540 Player::set_play_referenced ()
542 boost::mutex::scoped_lock lm (_mutex);
543 _play_referenced = true;
544 setup_pieces_unlocked ();
549 maybe_add_asset (list<ReferencedReelAsset>& a, shared_ptr<dcp::ReelAsset> r, Frame reel_trim_start, Frame reel_trim_end, DCPTime from, int const ffr)
551 DCPOMATIC_ASSERT (r);
552 r->set_entry_point (r->entry_point().get_value_or(0) + reel_trim_start);
553 r->set_duration (r->actual_duration() - reel_trim_start - reel_trim_end);
554 if (r->actual_duration() > 0) {
556 ReferencedReelAsset(r, DCPTimePeriod(from, from + DCPTime::from_frames(r->actual_duration(), ffr)))
562 list<ReferencedReelAsset>
563 Player::get_reel_assets ()
565 /* Does not require a lock on _mutex as it's only called from DCPEncoder */
567 list<ReferencedReelAsset> a;
569 for (auto i: playlist()->content()) {
570 auto j = dynamic_pointer_cast<DCPContent> (i);
575 scoped_ptr<DCPDecoder> decoder;
577 decoder.reset (new DCPDecoder(_film, j, false, false, shared_ptr<DCPDecoder>()));
582 DCPOMATIC_ASSERT (j->video_frame_rate ());
583 double const cfr = j->video_frame_rate().get();
584 Frame const trim_start = j->trim_start().frames_round (cfr);
585 Frame const trim_end = j->trim_end().frames_round (cfr);
586 int const ffr = _film->video_frame_rate ();
588 /* position in the asset from the start */
589 int64_t offset_from_start = 0;
590 /* position in the asset from the end */
591 int64_t offset_from_end = 0;
592 for (auto k: decoder->reels()) {
593 /* Assume that main picture duration is the length of the reel */
594 offset_from_end += k->main_picture()->actual_duration();
597 for (auto k: decoder->reels()) {
599 /* Assume that main picture duration is the length of the reel */
600 int64_t const reel_duration = k->main_picture()->actual_duration();
602 /* See doc/design/trim_reels.svg */
603 Frame const reel_trim_start = min(reel_duration, max(int64_t(0), trim_start - offset_from_start));
604 Frame const reel_trim_end = min(reel_duration, max(int64_t(0), reel_duration - (offset_from_end - trim_end)));
606 auto const from = i->position() + DCPTime::from_frames (offset_from_start, _film->video_frame_rate());
607 if (j->reference_video ()) {
608 maybe_add_asset (a, k->main_picture(), reel_trim_start, reel_trim_end, from, ffr);
611 if (j->reference_audio ()) {
612 maybe_add_asset (a, k->main_sound(), reel_trim_start, reel_trim_end, from, ffr);
615 if (j->reference_text (TextType::OPEN_SUBTITLE)) {
616 maybe_add_asset (a, k->main_subtitle(), reel_trim_start, reel_trim_end, from, ffr);
619 if (j->reference_text (TextType::CLOSED_CAPTION)) {
620 for (auto l: k->closed_captions()) {
621 maybe_add_asset (a, l, reel_trim_start, reel_trim_end, from, ffr);
625 offset_from_start += reel_duration;
626 offset_from_end -= reel_duration;
637 boost::mutex::scoped_lock lm (_mutex);
640 /* We can't pass in this state */
641 LOG_DEBUG_PLAYER_NC ("Player is suspended");
645 if (_playback_length == DCPTime()) {
646 /* Special; just give one black frame */
647 emit_video (black_player_video_frame(Eyes::BOTH), DCPTime());
651 /* Find the decoder or empty which is farthest behind where we are and make it emit some data */
653 shared_ptr<Piece> earliest_content;
654 optional<DCPTime> earliest_time;
656 for (auto i: _pieces) {
661 auto const t = content_time_to_dcp (i, max(i->decoder->position(), i->content->trim_start()));
662 if (t > i->content->end(_film)) {
666 /* Given two choices at the same time, pick the one with texts so we see it before
669 if (!earliest_time || t < *earliest_time || (t == *earliest_time && !i->decoder->text.empty())) {
671 earliest_content = i;
685 if (earliest_content) {
689 if (!_black.done() && !_ignore_video && (!earliest_time || _black.position() < *earliest_time)) {
690 earliest_time = _black.position ();
694 if (!_silent.done() && !_ignore_audio && (!earliest_time || _silent.position() < *earliest_time)) {
695 earliest_time = _silent.position ();
702 LOG_DEBUG_PLAYER ("Calling pass() on %1", earliest_content->content->path(0));
703 earliest_content->done = earliest_content->decoder->pass ();
704 auto dcp = dynamic_pointer_cast<DCPContent>(earliest_content->content);
705 if (dcp && !_play_referenced && dcp->reference_audio()) {
706 /* We are skipping some referenced DCP audio content, so we need to update _last_audio_time
707 to `hide' the fact that no audio was emitted during the referenced DCP (though
708 we need to behave as though it was).
710 _last_audio_time = dcp->end (_film);
715 LOG_DEBUG_PLAYER ("Emit black for gap at %1", to_string(_black.position()));
716 emit_video (black_player_video_frame(Eyes::BOTH), _black.position());
717 _black.set_position (_black.position() + one_video_frame());
721 LOG_DEBUG_PLAYER ("Emit silence for gap at %1", to_string(_silent.position()));
722 DCPTimePeriod period (_silent.period_at_position());
723 if (_last_audio_time) {
724 /* Sometimes the thing that happened last finishes fractionally before
725 or after this silence. Bodge the start time of the silence to fix it.
726 I think this is nothing to worry about since we will just add or
727 remove a little silence at the end of some content.
729 int64_t const error = labs(period.from.get() - _last_audio_time->get());
730 /* Let's not worry about less than a frame at 24fps */
731 int64_t const too_much_error = DCPTime::from_frames(1, 24).get();
732 if (error >= too_much_error) {
733 _film->log()->log(String::compose("Silence starting before or after last audio by %1", error), LogEntry::TYPE_ERROR);
735 DCPOMATIC_ASSERT (error < too_much_error);
736 period.from = *_last_audio_time;
738 if (period.duration() > one_video_frame()) {
739 period.to = period.from + one_video_frame();
742 _silent.set_position (period.to);
750 /* Emit any audio that is ready */
752 /* Work out the time before which the audio is definitely all here. This is the earliest last_push_end of one
753 of our streams, or the position of the _silent.
755 auto pull_to = _playback_length;
756 for (auto const& i: _stream_states) {
757 if (!i.second.piece->done && i.second.last_push_end < pull_to) {
758 pull_to = i.second.last_push_end;
761 if (!_silent.done() && _silent.position() < pull_to) {
762 pull_to = _silent.position();
765 LOG_DEBUG_PLAYER("Emitting audio up to %1", to_string(pull_to));
766 auto audio = _audio_merger.pull (pull_to);
767 for (auto i = audio.begin(); i != audio.end(); ++i) {
768 if (_last_audio_time && i->second < *_last_audio_time) {
769 /* This new data comes before the last we emitted (or the last seek); discard it */
770 auto cut = discard_audio (i->first, i->second, *_last_audio_time);
775 } else if (_last_audio_time && i->second > *_last_audio_time) {
776 /* There's a gap between this data and the last we emitted; fill with silence */
777 fill_audio (DCPTimePeriod (*_last_audio_time, i->second));
780 emit_audio (i->first, i->second);
785 for (auto const& i: _delay) {
786 do_emit_video(i.first, i.second);
794 /** @return Open subtitles for the frame at the given time, converted to images */
795 optional<PositionImage>
796 Player::open_subtitles_for_frame (DCPTime time) const
798 list<PositionImage> captions;
799 int const vfr = _film->video_frame_rate();
803 _active_texts[static_cast<int>(TextType::OPEN_SUBTITLE)].get_burnt(DCPTimePeriod(time, time + DCPTime::from_frames(1, vfr)), _always_burn_open_subtitles)
806 /* Bitmap subtitles */
807 for (auto i: j.bitmap) {
812 /* i.image will already have been scaled to fit _video_container_size */
813 dcp::Size scaled_size (i.rectangle.width * _video_container_size.width, i.rectangle.height * _video_container_size.height);
819 lrint(_video_container_size.width * i.rectangle.x),
820 lrint(_video_container_size.height * i.rectangle.y)
826 /* String subtitles (rendered to an image) */
827 if (!j.string.empty()) {
828 auto s = render_text (j.string, j.fonts, _video_container_size, time, vfr);
829 copy (s.begin(), s.end(), back_inserter (captions));
833 if (captions.empty()) {
837 return merge (captions);
842 Player::video (weak_ptr<Piece> wp, ContentVideo video)
848 auto piece = wp.lock ();
853 if (!piece->content->video->use()) {
857 FrameRateChange frc (_film, piece->content);
858 if (frc.skip && (video.frame % 2) == 1) {
862 /* Time of the first frame we will emit */
863 DCPTime const time = content_video_to_dcp (piece, video.frame);
864 LOG_DEBUG_PLAYER("Received video frame %1 at %2", video.frame, to_string(time));
866 /* Discard if it's before the content's period or the last accurate seek. We can't discard
867 if it's after the content's period here as in that case we still need to fill any gap between
868 `now' and the end of the content's period.
870 if (time < piece->content->position() || (_last_video_time && time < *_last_video_time)) {
874 if (piece->ignore_video && piece->ignore_video->contains(time)) {
878 /* Fill gaps that we discover now that we have some video which needs to be emitted.
879 This is where we need to fill to.
881 DCPTime fill_to = min (time, piece->content->end(_film));
883 if (_last_video_time) {
884 DCPTime fill_from = max (*_last_video_time, piece->content->position());
886 /* Fill if we have more than half a frame to do */
887 if ((fill_to - fill_from) > one_video_frame() / 2) {
888 auto last = _last_video.find (wp);
889 if (_film->three_d()) {
890 auto fill_to_eyes = video.eyes;
891 if (fill_to_eyes == Eyes::BOTH) {
892 fill_to_eyes = Eyes::LEFT;
894 if (fill_to == piece->content->end(_film)) {
895 /* Don't fill after the end of the content */
896 fill_to_eyes = Eyes::LEFT;
899 auto eyes = _last_video_eyes.get_value_or(Eyes::LEFT);
900 if (eyes == Eyes::BOTH) {
903 while (j < fill_to || eyes != fill_to_eyes) {
904 if (last != _last_video.end()) {
905 LOG_DEBUG_PLAYER("Fill using last video at %1 in 3D mode", to_string(j));
906 auto copy = last->second->shallow_copy();
907 copy->set_eyes (eyes);
908 emit_video (copy, j);
910 LOG_DEBUG_PLAYER("Fill using black at %1 in 3D mode", to_string(j));
911 emit_video (black_player_video_frame(eyes), j);
913 if (eyes == Eyes::RIGHT) {
914 j += one_video_frame();
916 eyes = increment_eyes (eyes);
919 for (DCPTime j = fill_from; j < fill_to; j += one_video_frame()) {
920 if (last != _last_video.end()) {
921 emit_video (last->second, j);
923 emit_video (black_player_video_frame(Eyes::BOTH), j);
930 _last_video[wp] = std::make_shared<PlayerVideo>(
932 piece->content->video->crop (),
933 piece->content->video->fade (_film, video.frame),
934 scale_for_display(piece->content->video->scaled_size(_film->frame_size()), _video_container_size, _film->frame_size()),
935 _video_container_size,
938 piece->content->video->colour_conversion(),
939 piece->content->video->range(),
946 for (int i = 0; i < frc.repeat; ++i) {
947 if (t < piece->content->end(_film)) {
948 emit_video (_last_video[wp], t);
950 t += one_video_frame ();
956 Player::audio (weak_ptr<Piece> wp, AudioStreamPtr stream, ContentAudio content_audio)
962 DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
964 auto piece = wp.lock ();
969 auto content = piece->content->audio;
970 DCPOMATIC_ASSERT (content);
972 int const rfr = content->resampled_frame_rate (_film);
974 /* Compute time in the DCP */
975 auto time = resampled_audio_to_dcp (piece, content_audio.frame);
976 LOG_DEBUG_PLAYER("Received audio frame %1 at %2", content_audio.frame, to_string(time));
978 /* And the end of this block in the DCP */
979 auto end = time + DCPTime::from_frames(content_audio.audio->frames(), rfr);
981 /* Remove anything that comes before the start or after the end of the content */
982 if (time < piece->content->position()) {
983 auto cut = discard_audio (content_audio.audio, time, piece->content->position());
985 /* This audio is entirely discarded */
988 content_audio.audio = cut.first;
990 } else if (time > piece->content->end(_film)) {
993 } else if (end > piece->content->end(_film)) {
994 Frame const remaining_frames = DCPTime(piece->content->end(_film) - time).frames_round(rfr);
995 if (remaining_frames == 0) {
998 content_audio.audio = make_shared<AudioBuffers>(content_audio.audio, remaining_frames, 0);
1001 DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
1005 if (content->gain() != 0) {
1006 auto gain = make_shared<AudioBuffers>(content_audio.audio);
1007 gain->apply_gain (content->gain());
1008 content_audio.audio = gain;
1013 content_audio.audio = remap (content_audio.audio, _film->audio_channels(), stream->mapping());
1017 if (_audio_processor) {
1018 content_audio.audio = _audio_processor->run (content_audio.audio, _film->audio_channels ());
1023 _audio_merger.push (content_audio.audio, time);
1024 DCPOMATIC_ASSERT (_stream_states.find (stream) != _stream_states.end ());
1025 _stream_states[stream].last_push_end = time + DCPTime::from_frames (content_audio.audio->frames(), _film->audio_frame_rate());
1030 Player::bitmap_text_start (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentBitmapText subtitle)
1036 auto piece = wp.lock ();
1037 auto text = wc.lock ();
1038 if (!piece || !text) {
1042 /* Apply content's subtitle offsets */
1043 subtitle.sub.rectangle.x += text->x_offset ();
1044 subtitle.sub.rectangle.y += text->y_offset ();
1046 /* Apply a corrective translation to keep the subtitle centred after the scale that is coming up */
1047 subtitle.sub.rectangle.x -= subtitle.sub.rectangle.width * ((text->x_scale() - 1) / 2);
1048 subtitle.sub.rectangle.y -= subtitle.sub.rectangle.height * ((text->y_scale() - 1) / 2);
1050 /* Apply content's subtitle scale */
1051 subtitle.sub.rectangle.width *= text->x_scale ();
1052 subtitle.sub.rectangle.height *= text->y_scale ();
1055 auto image = subtitle.sub.image;
1057 /* We will scale the subtitle up to fit _video_container_size */
1058 int const width = subtitle.sub.rectangle.width * _video_container_size.width;
1059 int const height = subtitle.sub.rectangle.height * _video_container_size.height;
1060 if (width == 0 || height == 0) {
1064 dcp::Size scaled_size (width, height);
1065 ps.bitmap.push_back (BitmapText(image->scale(scaled_size, dcp::YUVToRGB::REC601, image->pixel_format(), true, _fast), subtitle.sub.rectangle));
1066 DCPTime from (content_time_to_dcp (piece, subtitle.from()));
1068 _active_texts[static_cast<int>(text->type())].add_from (wc, ps, from);
1073 Player::plain_text_start (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentStringText subtitle)
1079 auto piece = wp.lock ();
1080 auto text = wc.lock ();
1081 if (!piece || !text) {
1086 DCPTime const from (content_time_to_dcp (piece, subtitle.from()));
1088 if (from > piece->content->end(_film)) {
1092 for (auto s: subtitle.subs) {
1093 s.set_h_position (s.h_position() + text->x_offset ());
1094 s.set_v_position (s.v_position() + text->y_offset ());
1095 float const xs = text->x_scale();
1096 float const ys = text->y_scale();
1097 float size = s.size();
1099 /* Adjust size to express the common part of the scaling;
1100 e.g. if xs = ys = 0.5 we scale size by 2.
1102 if (xs > 1e-5 && ys > 1e-5) {
1103 size *= 1 / min (1 / xs, 1 / ys);
1107 /* Then express aspect ratio changes */
1108 if (fabs (1.0 - xs / ys) > dcp::ASPECT_ADJUST_EPSILON) {
1109 s.set_aspect_adjust (xs / ys);
1112 s.set_in (dcp::Time(from.seconds(), 1000));
1113 ps.string.push_back (StringText (s, text->outline_width()));
1114 ps.add_fonts (text->fonts ());
1117 _active_texts[static_cast<int>(text->type())].add_from (wc, ps, from);
1122 Player::subtitle_stop (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentTime to)
1128 auto text = wc.lock ();
1133 if (!_active_texts[static_cast<int>(text->type())].have(wc)) {
1137 shared_ptr<Piece> piece = wp.lock ();
1142 DCPTime const dcp_to = content_time_to_dcp (piece, to);
1144 if (dcp_to > piece->content->end(_film)) {
1148 auto from = _active_texts[static_cast<int>(text->type())].add_to (wc, dcp_to);
1150 bool const always = (text->type() == TextType::OPEN_SUBTITLE && _always_burn_open_subtitles);
1151 if (text->use() && !always && !text->burn()) {
1152 Text (from.first, text->type(), text->dcp_track().get_value_or(DCPTextTrack()), DCPTimePeriod (from.second, dcp_to));
1158 Player::seek (DCPTime time, bool accurate)
1160 boost::mutex::scoped_lock lm (_mutex);
1161 LOG_DEBUG_PLAYER("Seek to %1 (%2accurate)", to_string(time), accurate ? "" : "in");
1164 /* We can't seek in this state */
1169 _shuffler->clear ();
1174 if (_audio_processor) {
1175 _audio_processor->flush ();
1178 _audio_merger.clear ();
1179 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
1180 _active_texts[i].clear ();
1183 for (auto i: _pieces) {
1184 if (time < i->content->position()) {
1185 /* Before; seek to the start of the content. Even if this request is for an inaccurate seek
1186 we must seek this (following) content accurately, otherwise when we come to the end of the current
1187 content we may not start right at the beginning of the next, causing a gap (if the next content has
1188 been trimmed to a point between keyframes, or something).
1190 i->decoder->seek (dcp_to_content_time (i, i->content->position()), true);
1192 } else if (i->content->position() <= time && time < i->content->end(_film)) {
1193 /* During; seek to position */
1194 i->decoder->seek (dcp_to_content_time (i, time), accurate);
1197 /* After; this piece is done */
1203 _last_video_time = time;
1204 _last_video_eyes = Eyes::LEFT;
1205 _last_audio_time = time;
1207 _last_video_time = optional<DCPTime>();
1208 _last_video_eyes = optional<Eyes>();
1209 _last_audio_time = optional<DCPTime>();
1212 _black.set_position (time);
1213 _silent.set_position (time);
1215 _last_video.clear ();
1220 Player::emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1222 if (!_film->three_d()) {
1223 if (pv->eyes() == Eyes::LEFT) {
1224 /* Use left-eye images for both eyes... */
1225 pv->set_eyes (Eyes::BOTH);
1226 } else if (pv->eyes() == Eyes::RIGHT) {
1227 /* ...and discard the right */
1232 /* We need a delay to give a little wiggle room to ensure that relevent subtitles arrive at the
1233 player before the video that requires them.
1235 _delay.push_back (make_pair (pv, time));
1237 if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
1238 _last_video_time = time + one_video_frame();
1240 _last_video_eyes = increment_eyes (pv->eyes());
1242 if (_delay.size() < 3) {
1246 auto to_do = _delay.front();
1248 do_emit_video (to_do.first, to_do.second);
1253 Player::do_emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1255 if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
1256 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
1257 _active_texts[i].clear_before (time);
1261 auto subtitles = open_subtitles_for_frame (time);
1263 pv->set_text (subtitles.get ());
1271 Player::emit_audio (shared_ptr<AudioBuffers> data, DCPTime time)
1273 /* Log if the assert below is about to fail */
1274 if (_last_audio_time && labs(time.get() - _last_audio_time->get()) > 1) {
1275 _film->log()->log(String::compose("Out-of-sequence emit %1 vs %2", to_string(time), to_string(*_last_audio_time)), LogEntry::TYPE_WARNING);
1278 /* This audio must follow on from the previous, allowing for half a sample (at 48kHz) leeway */
1279 DCPOMATIC_ASSERT (!_last_audio_time || labs(time.get() - _last_audio_time->get()) < 2);
1280 Audio (data, time, _film->audio_frame_rate());
1281 _last_audio_time = time + DCPTime::from_frames (data->frames(), _film->audio_frame_rate());
1286 Player::fill_audio (DCPTimePeriod period)
1288 if (period.from == period.to) {
1292 DCPOMATIC_ASSERT (period.from < period.to);
1294 DCPTime t = period.from;
1295 while (t < period.to) {
1296 DCPTime block = min (DCPTime::from_seconds (0.5), period.to - t);
1297 Frame const samples = block.frames_round(_film->audio_frame_rate());
1299 auto silence = make_shared<AudioBuffers>(_film->audio_channels(), samples);
1300 silence->make_silent ();
1301 emit_audio (silence, t);
1309 Player::one_video_frame () const
1311 return DCPTime::from_frames (1, _film->video_frame_rate ());
1315 pair<shared_ptr<AudioBuffers>, DCPTime>
1316 Player::discard_audio (shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to) const
1318 auto const discard_time = discard_to - time;
1319 auto const discard_frames = discard_time.frames_round(_film->audio_frame_rate());
1320 auto remaining_frames = audio->frames() - discard_frames;
1321 if (remaining_frames <= 0) {
1322 return make_pair(shared_ptr<AudioBuffers>(), DCPTime());
1324 auto cut = make_shared<AudioBuffers>(audio, remaining_frames, discard_frames);
1325 return make_pair(cut, time + discard_time);
1330 Player::set_dcp_decode_reduction (optional<int> reduction)
1332 Change (ChangeType::PENDING, PlayerProperty::DCP_DECODE_REDUCTION, false);
1335 boost::mutex::scoped_lock lm (_mutex);
1337 if (reduction == _dcp_decode_reduction) {
1339 Change (ChangeType::CANCELLED, PlayerProperty::DCP_DECODE_REDUCTION, false);
1343 _dcp_decode_reduction = reduction;
1344 setup_pieces_unlocked ();
1347 Change (ChangeType::DONE, PlayerProperty::DCP_DECODE_REDUCTION, false);
1352 Player::content_time_to_dcp (shared_ptr<Content> content, ContentTime t)
1354 boost::mutex::scoped_lock lm (_mutex);
1356 for (auto i: _pieces) {
1357 if (i->content == content) {
1358 return content_time_to_dcp (i, t);
1362 /* We couldn't find this content; perhaps things are being changed over */
1367 shared_ptr<const Playlist>
1368 Player::playlist () const
1370 return _playlist ? _playlist : _film->playlist();
1375 Player::atmos (weak_ptr<Piece>, ContentAtmos data)
1381 Atmos (data.data, DCPTime::from_frames(data.frame, _film->video_frame_rate()), data.metadata);