Don't scale chroma subsampled images to sizes that don't align with the subsampling...
[dcpomatic.git] / src / lib / player.cc
1 /*
2     Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
3
4     This file is part of DCP-o-matic.
5
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.
10
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.
15
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/>.
18
19 */
20
21
22 #include "atmos_decoder.h"
23 #include "player.h"
24 #include "film.h"
25 #include "audio_buffers.h"
26 #include "content_audio.h"
27 #include "dcp_content.h"
28 #include "dcpomatic_log.h"
29 #include "job.h"
30 #include "image.h"
31 #include "raw_image_proxy.h"
32 #include "ratio.h"
33 #include "log.h"
34 #include "render_text.h"
35 #include "config.h"
36 #include "content_video.h"
37 #include "player_video.h"
38 #include "frame_rate_change.h"
39 #include "audio_processor.h"
40 #include "playlist.h"
41 #include "referenced_reel_asset.h"
42 #include "decoder_factory.h"
43 #include "decoder.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"
53 #include "shuffler.h"
54 #include "timer.h"
55 #include <dcp/reel.h>
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>
60 #include <stdint.h>
61 #include <algorithm>
62 #include <iostream>
63
64 #include "i18n.h"
65
66
67 using std::copy;
68 using std::cout;
69 using std::dynamic_pointer_cast;
70 using std::list;
71 using std::make_pair;
72 using std::make_shared;
73 using std::max;
74 using std::min;
75 using std::min;
76 using std::pair;
77 using std::shared_ptr;
78 using std::vector;
79 using std::weak_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;
85 #endif
86 using namespace dcpomatic;
87
88
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;
95
96
97 Player::Player (shared_ptr<const Film> film, Image::Alignment subtitle_alignment)
98         : _film (film)
99         , _suspended (0)
100         , _tolerant (film->tolerant())
101         , _audio_merger (_film->audio_frame_rate())
102         , _subtitle_alignment (subtitle_alignment)
103 {
104         construct ();
105 }
106
107
108 Player::Player (shared_ptr<const Film> film, shared_ptr<const Playlist> playlist_)
109         : _film (film)
110         , _playlist (playlist_)
111         , _suspended (0)
112         , _tolerant (film->tolerant())
113         , _audio_merger (_film->audio_frame_rate())
114 {
115         construct ();
116 }
117
118
119 void
120 Player::construct ()
121 {
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
124            be first.
125         */
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 ());
129
130         film_change (ChangeType::DONE, Film::Property::AUDIO_PROCESSOR);
131
132         setup_pieces ();
133         seek (DCPTime (), true);
134 }
135
136
137 void
138 Player::setup_pieces ()
139 {
140         boost::mutex::scoped_lock lm (_mutex);
141         setup_pieces_unlocked ();
142 }
143
144
145 bool
146 have_video (shared_ptr<const Content> content)
147 {
148         return static_cast<bool>(content->video) && content->video->use();
149 }
150
151
152 bool
153 have_audio (shared_ptr<const Content> content)
154 {
155         return static_cast<bool>(content->audio);
156 }
157
158
159 void
160 Player::setup_pieces_unlocked ()
161 {
162         _playback_length = _playlist ? _playlist->length(_film) : _film->length();
163
164         auto old_pieces = _pieces;
165         _pieces.clear ();
166
167         _shuffler.reset (new Shuffler());
168         _shuffler->Video.connect(bind(&Player::video, this, _1, _2));
169
170         for (auto i: playlist()->content()) {
171
172                 if (!i->paths_valid ()) {
173                         continue;
174                 }
175
176                 if (_ignore_video && _ignore_audio && i->text.empty()) {
177                         /* We're only interested in text and this content has none */
178                         continue;
179                 }
180
181                 shared_ptr<Decoder> old_decoder;
182                 for (auto j: old_pieces) {
183                         if (j->content == i) {
184                                 old_decoder = j->decoder;
185                                 break;
186                         }
187                 }
188
189                 auto decoder = decoder_factory (_film, i, _fast, _tolerant, old_decoder);
190                 DCPOMATIC_ASSERT (decoder);
191
192                 FrameRateChange frc (_film, i);
193
194                 if (decoder->video && _ignore_video) {
195                         decoder->video->set_ignore (true);
196                 }
197
198                 if (decoder->audio && _ignore_audio) {
199                         decoder->audio->set_ignore (true);
200                 }
201
202                 if (_ignore_text) {
203                         for (auto i: decoder->text) {
204                                 i->set_ignore (true);
205                         }
206                 }
207
208                 auto dcp = dynamic_pointer_cast<DCPDecoder> (decoder);
209                 if (dcp) {
210                         dcp->set_decode_referenced (_play_referenced);
211                         if (_play_referenced) {
212                                 dcp->set_forced_reduction (_dcp_decode_reduction);
213                         }
214                 }
215
216                 auto piece = make_shared<Piece>(i, decoder, frc);
217                 _pieces.push_back (piece);
218
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));
223                         } else {
224                                 decoder->video->Data.connect (bind(&Player::video, this, weak_ptr<Piece>(piece), _1));
225                         }
226                 }
227
228                 if (decoder->audio) {
229                         decoder->audio->Data.connect (bind (&Player::audio, this, weak_ptr<Piece> (piece), _1, _2));
230                 }
231
232                 auto j = decoder->text.begin();
233
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)
237                                 );
238                         (*j)->PlainStart.connect (
239                                 bind(&Player::plain_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
240                                 );
241                         (*j)->Stop.connect (
242                                 bind(&Player::subtitle_stop, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
243                                 );
244
245                         ++j;
246                 }
247
248                 if (decoder->atmos) {
249                         decoder->atmos->Data.connect (bind(&Player::atmos, this, weak_ptr<Piece>(piece), _1));
250                 }
251         }
252
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 ());
258                         }
259                 }
260         }
261
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));
267                                 auto j = i;
268                                 ++j;
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);
272                                         }
273                                 }
274                         }
275                 }
276         }
277
278         _black = Empty (_film, playlist(), bind(&have_video, _1), _playback_length);
279         _silent = Empty (_film, playlist(), bind(&have_audio, _1), _playback_length);
280
281         _last_video_time = boost::optional<dcpomatic::DCPTime>();
282         _last_video_eyes = Eyes::BOTH;
283         _last_audio_time = boost::optional<dcpomatic::DCPTime>();
284 }
285
286
287 void
288 Player::playlist_content_change (ChangeType type, int property, bool frequent)
289 {
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);
296                         }
297                 }
298         } else {
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.
303                         */
304                         ++_suspended;
305                 } else if (type == ChangeType::DONE) {
306                         /* A change in our content has gone through.  Re-build our pieces. */
307                         setup_pieces ();
308                         --_suspended;
309                 } else if (type == ChangeType::CANCELLED) {
310                         --_suspended;
311                 }
312         }
313
314         Change (type, property, frequent);
315 }
316
317
318 void
319 Player::set_video_container_size (dcp::Size s)
320 {
321         Change (ChangeType::PENDING, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
322
323         {
324                 boost::mutex::scoped_lock lm (_mutex);
325
326                 if (s == _video_container_size) {
327                         lm.unlock ();
328                         Change (ChangeType::CANCELLED, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
329                         return;
330                 }
331
332                 _video_container_size = s;
333
334                 _black_image = make_shared<Image>(AV_PIX_FMT_RGB24, _video_container_size, Image::Alignment::PADDED);
335                 _black_image->make_black ();
336         }
337
338         Change (ChangeType::DONE, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
339 }
340
341
342 void
343 Player::playlist_change (ChangeType type)
344 {
345         if (type == ChangeType::DONE) {
346                 setup_pieces ();
347         }
348         Change (type, PlayerProperty::PLAYLIST, false);
349 }
350
351
352 void
353 Player::film_change (ChangeType type, Film::Property p)
354 {
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.
358         */
359
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.
365                 */
366                 if (type == ChangeType::DONE) {
367                         setup_pieces ();
368                 }
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 ());
374                 }
375         } else if (p == Film::Property::AUDIO_CHANNELS) {
376                 if (type == ChangeType::DONE) {
377                         boost::mutex::scoped_lock lm (_mutex);
378                         _audio_merger.clear ();
379                 }
380         }
381 }
382
383
384 shared_ptr<PlayerVideo>
385 Player::black_player_video_frame (Eyes eyes) const
386 {
387         return std::make_shared<PlayerVideo> (
388                 std::make_shared<const RawImageProxy>(_black_image),
389                 Crop(),
390                 optional<double>(),
391                 _video_container_size,
392                 _video_container_size,
393                 eyes,
394                 Part::WHOLE,
395                 PresetColourConversion::all().front().conversion,
396                 VideoRange::FULL,
397                 std::weak_ptr<Content>(),
398                 boost::optional<Frame>(),
399                 false
400         );
401 }
402
403
404 Frame
405 Player::dcp_to_content_video (shared_ptr<const Piece> piece, DCPTime t) const
406 {
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));
410
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).
415
416            Instead we convert the DCPTime using the DCP video rate then account for any skip/repeat.
417         */
418         return s.frames_floor (piece->frc.dcp) / piece->frc.factor ();
419 }
420
421
422 DCPTime
423 Player::content_video_to_dcp (shared_ptr<const Piece> piece, Frame f) const
424 {
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();
428 }
429
430
431 Frame
432 Player::dcp_to_resampled_audio (shared_ptr<const Piece> piece, DCPTime t) const
433 {
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());
438 }
439
440
441 DCPTime
442 Player::resampled_audio_to_dcp (shared_ptr<const Piece> piece, Frame f) const
443 {
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();
448 }
449
450
451 ContentTime
452 Player::dcp_to_content_time (shared_ptr<const Piece> piece, DCPTime t) const
453 {
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());
457 }
458
459
460 DCPTime
461 Player::content_time_to_dcp (shared_ptr<const Piece> piece, ContentTime t) const
462 {
463         return max (DCPTime(), DCPTime(t - piece->content->trim_start(), piece->frc) + piece->content->position());
464 }
465
466
467 vector<FontData>
468 Player::get_subtitle_fonts ()
469 {
470         boost::mutex::scoped_lock lm (_mutex);
471
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.
476                 */
477                 auto f = i->decoder->fonts ();
478                 copy (f.begin(), f.end(), back_inserter(fonts));
479         }
480
481         return fonts;
482 }
483
484
485 /** Set this player never to produce any video data */
486 void
487 Player::set_ignore_video ()
488 {
489         boost::mutex::scoped_lock lm (_mutex);
490         _ignore_video = true;
491         setup_pieces_unlocked ();
492 }
493
494
495 void
496 Player::set_ignore_audio ()
497 {
498         boost::mutex::scoped_lock lm (_mutex);
499         _ignore_audio = true;
500         setup_pieces_unlocked ();
501 }
502
503
504 void
505 Player::set_ignore_text ()
506 {
507         boost::mutex::scoped_lock lm (_mutex);
508         _ignore_text = true;
509         setup_pieces_unlocked ();
510 }
511
512
513 /** Set the player to always burn open texts into the image regardless of the content settings */
514 void
515 Player::set_always_burn_open_subtitles ()
516 {
517         boost::mutex::scoped_lock lm (_mutex);
518         _always_burn_open_subtitles = true;
519 }
520
521
522 /** Sets up the player to be faster, possibly at the expense of quality */
523 void
524 Player::set_fast ()
525 {
526         boost::mutex::scoped_lock lm (_mutex);
527         _fast = true;
528         setup_pieces_unlocked ();
529 }
530
531
532 void
533 Player::set_play_referenced ()
534 {
535         boost::mutex::scoped_lock lm (_mutex);
536         _play_referenced = true;
537         setup_pieces_unlocked ();
538 }
539
540
541 static void
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)
543 {
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) {
548                 a.push_back (
549                         ReferencedReelAsset(r, DCPTimePeriod(from, from + DCPTime::from_frames(r->actual_duration(), ffr)))
550                         );
551         }
552 }
553
554
555 list<ReferencedReelAsset>
556 Player::get_reel_assets ()
557 {
558         /* Does not require a lock on _mutex as it's only called from DCPEncoder */
559
560         list<ReferencedReelAsset> a;
561
562         for (auto i: playlist()->content()) {
563                 auto j = dynamic_pointer_cast<DCPContent> (i);
564                 if (!j) {
565                         continue;
566                 }
567
568                 scoped_ptr<DCPDecoder> decoder;
569                 try {
570                         decoder.reset (new DCPDecoder(_film, j, false, false, shared_ptr<DCPDecoder>()));
571                 } catch (...) {
572                         return a;
573                 }
574
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 ();
580
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();
588                 }
589
590                 for (auto k: decoder->reels()) {
591
592                         /* Assume that main picture duration is the length of the reel */
593                         int64_t const reel_duration = k->main_picture()->actual_duration();
594
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)));
598
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);
602                         }
603
604                         if (j->reference_audio ()) {
605                                 maybe_add_asset (a, k->main_sound(), reel_trim_start, reel_trim_end, from, ffr);
606                         }
607
608                         if (j->reference_text (TextType::OPEN_SUBTITLE)) {
609                                 maybe_add_asset (a, k->main_subtitle(), reel_trim_start, reel_trim_end, from, ffr);
610                         }
611
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);
615                                 }
616                         }
617
618                         offset_from_start += reel_duration;
619                         offset_from_end -= reel_duration;
620                 }
621         }
622
623         return a;
624 }
625
626
627 bool
628 Player::pass ()
629 {
630         boost::mutex::scoped_lock lm (_mutex);
631
632         if (_suspended) {
633                 /* We can't pass in this state */
634                 LOG_DEBUG_PLAYER_NC ("Player is suspended");
635                 return false;
636         }
637
638         if (_playback_length == DCPTime()) {
639                 /* Special; just give one black frame */
640                 emit_video (black_player_video_frame(Eyes::BOTH), DCPTime());
641                 return true;
642         }
643
644         /* Find the decoder or empty which is farthest behind where we are and make it emit some data */
645
646         shared_ptr<Piece> earliest_content;
647         optional<DCPTime> earliest_time;
648
649         for (auto i: _pieces) {
650                 if (i->done) {
651                         continue;
652                 }
653
654                 auto const t = content_time_to_dcp (i, max(i->decoder->position(), i->content->trim_start()));
655                 if (t > i->content->end(_film)) {
656                         i->done = true;
657                 } else {
658
659                         /* Given two choices at the same time, pick the one with texts so we see it before
660                            the video.
661                         */
662                         if (!earliest_time || t < *earliest_time || (t == *earliest_time && !i->decoder->text.empty())) {
663                                 earliest_time = t;
664                                 earliest_content = i;
665                         }
666                 }
667         }
668
669         bool done = false;
670
671         enum {
672                 NONE,
673                 CONTENT,
674                 BLACK,
675                 SILENT
676         } which = NONE;
677
678         if (earliest_content) {
679                 which = CONTENT;
680         }
681
682         if (!_black.done() && !_ignore_video && (!earliest_time || _black.position() < *earliest_time)) {
683                 earliest_time = _black.position ();
684                 which = BLACK;
685         }
686
687         if (!_silent.done() && !_ignore_audio && (!earliest_time || _silent.position() < *earliest_time)) {
688                 earliest_time = _silent.position ();
689                 which = SILENT;
690         }
691
692         switch (which) {
693         case CONTENT:
694         {
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).
702                         */
703                         _last_audio_time = dcp->end (_film);
704                 }
705                 break;
706         }
707         case BLACK:
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());
711                 break;
712         case SILENT:
713         {
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.
721                         */
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);
727                         }
728                         DCPOMATIC_ASSERT (error < too_much_error);
729                         period.from = *_last_audio_time;
730                 }
731                 if (period.duration() > one_video_frame()) {
732                         period.to = period.from + one_video_frame();
733                 }
734                 fill_audio (period);
735                 _silent.set_position (period.to);
736                 break;
737         }
738         case NONE:
739                 done = true;
740                 break;
741         }
742
743         /* Emit any audio that is ready */
744
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.
747         */
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;
752                 }
753         }
754         if (!_silent.done() && _silent.position() < pull_to) {
755                 pull_to = _silent.position();
756         }
757
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);
764                         if (!cut.first) {
765                                 continue;
766                         }
767                         *i = cut;
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));
771                 }
772
773                 emit_audio (i->first, i->second);
774         }
775
776         if (done) {
777                 _shuffler->flush ();
778                 for (auto const& i: _delay) {
779                         do_emit_video(i.first, i.second);
780                 }
781         }
782
783         return done;
784 }
785
786
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
790 {
791         list<PositionImage> captions;
792         int const vfr = _film->video_frame_rate();
793
794         for (
795                 auto j:
796                 _active_texts[static_cast<int>(TextType::OPEN_SUBTITLE)].get_burnt(DCPTimePeriod(time, time + DCPTime::from_frames(1, vfr)), _always_burn_open_subtitles)
797                 ) {
798
799                 /* Bitmap subtitles */
800                 for (auto i: j.bitmap) {
801                         if (!i.image) {
802                                 continue;
803                         }
804
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);
807
808                         captions.push_back (
809                                 PositionImage (
810                                         i.image,
811                                         Position<int> (
812                                                 lrint(_video_container_size.width * i.rectangle.x),
813                                                 lrint(_video_container_size.height * i.rectangle.y)
814                                                 )
815                                         )
816                                 );
817                 }
818
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));
823                 }
824         }
825
826         if (captions.empty()) {
827                 return {};
828         }
829
830         return merge (captions, _subtitle_alignment);
831 }
832
833
834 void
835 Player::video (weak_ptr<Piece> wp, ContentVideo video)
836 {
837         if (_suspended) {
838                 return;
839         }
840
841         auto piece = wp.lock ();
842         if (!piece) {
843                 return;
844         }
845
846         if (!piece->content->video->use()) {
847                 return;
848         }
849
850         FrameRateChange frc (_film, piece->content);
851         if (frc.skip && (video.frame % 2) == 1) {
852                 return;
853         }
854
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));
858
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.
862         */
863         if (time < piece->content->position() || (_last_video_time && time < *_last_video_time)) {
864                 return;
865         }
866
867         if (piece->ignore_video && piece->ignore_video->contains(time)) {
868                 return;
869         }
870
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.
873         */
874         DCPTime fill_to = min (time, piece->content->end(_film));
875
876         if (_last_video_time) {
877                 DCPTime fill_from = max (*_last_video_time, piece->content->position());
878
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;
886                                 }
887                                 if (fill_to == piece->content->end(_film)) {
888                                         /* Don't fill after the end of the content */
889                                         fill_to_eyes = Eyes::LEFT;
890                                 }
891                                 auto j = fill_from;
892                                 auto eyes = _last_video_eyes.get_value_or(Eyes::LEFT);
893                                 if (eyes == Eyes::BOTH) {
894                                         eyes = Eyes::LEFT;
895                                 }
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);
902                                         } else {
903                                                 LOG_DEBUG_PLAYER("Fill using black at %1 in 3D mode", to_string(j));
904                                                 emit_video (black_player_video_frame(eyes), j);
905                                         }
906                                         if (eyes == Eyes::RIGHT) {
907                                                 j += one_video_frame();
908                                         }
909                                         eyes = increment_eyes (eyes);
910                                 }
911                         } else {
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);
915                                         } else {
916                                                 emit_video (black_player_video_frame(Eyes::BOTH), j);
917                                         }
918                                 }
919                         }
920                 }
921         }
922
923         auto const content_video = piece->content->video;
924
925         _last_video[wp] = std::make_shared<PlayerVideo>(
926                 video.image,
927                 content_video->actual_crop(),
928                 content_video->fade (_film, video.frame),
929                 scale_for_display(
930                         content_video->scaled_size(_film->frame_size()),
931                         _video_container_size,
932                         _film->frame_size(),
933                         content_video->pixel_quanta()
934                         ),
935                 _video_container_size,
936                 video.eyes,
937                 video.part,
938                 content_video->colour_conversion(),
939                 content_video->range(),
940                 piece->content,
941                 video.frame,
942                 false
943                 );
944
945         DCPTime t = time;
946         for (int i = 0; i < frc.repeat; ++i) {
947                 if (t < piece->content->end(_film)) {
948                         emit_video (_last_video[wp], t);
949                 }
950                 t += one_video_frame ();
951         }
952 }
953
954
955 void
956 Player::audio (weak_ptr<Piece> wp, AudioStreamPtr stream, ContentAudio content_audio)
957 {
958         if (_suspended) {
959                 return;
960         }
961
962         DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
963
964         auto piece = wp.lock ();
965         if (!piece) {
966                 return;
967         }
968
969         auto content = piece->content->audio;
970         DCPOMATIC_ASSERT (content);
971
972         int const rfr = content->resampled_frame_rate (_film);
973
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));
977
978         /* And the end of this block in the DCP */
979         auto end = time + DCPTime::from_frames(content_audio.audio->frames(), rfr);
980
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());
984                 if (!cut.first) {
985                         /* This audio is entirely discarded */
986                         return;
987                 }
988                 content_audio.audio = cut.first;
989                 time = cut.second;
990         } else if (time > piece->content->end(_film)) {
991                 /* Discard it all */
992                 return;
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) {
996                         return;
997                 }
998                 content_audio.audio = make_shared<AudioBuffers>(content_audio.audio, remaining_frames, 0);
999         }
1000
1001         DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
1002
1003         /* Gain */
1004
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;
1009         }
1010
1011         /* Remap */
1012
1013         content_audio.audio = remap (content_audio.audio, _film->audio_channels(), stream->mapping());
1014
1015         /* Process */
1016
1017         if (_audio_processor) {
1018                 content_audio.audio = _audio_processor->run (content_audio.audio, _film->audio_channels ());
1019         }
1020
1021         /* Push */
1022
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());
1026 }
1027
1028
1029 void
1030 Player::bitmap_text_start (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentBitmapText subtitle)
1031 {
1032         if (_suspended) {
1033                 return;
1034         }
1035
1036         auto piece = wp.lock ();
1037         auto text = wc.lock ();
1038         if (!piece || !text) {
1039                 return;
1040         }
1041
1042         /* Apply content's subtitle offsets */
1043         subtitle.sub.rectangle.x += text->x_offset ();
1044         subtitle.sub.rectangle.y += text->y_offset ();
1045
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);
1049
1050         /* Apply content's subtitle scale */
1051         subtitle.sub.rectangle.width *= text->x_scale ();
1052         subtitle.sub.rectangle.height *= text->y_scale ();
1053
1054         PlayerText ps;
1055         auto image = subtitle.sub.image;
1056
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) {
1061                 return;
1062         }
1063
1064         dcp::Size scaled_size (width, height);
1065         ps.bitmap.push_back (BitmapText(image->scale(scaled_size, dcp::YUVToRGB::REC601, image->pixel_format(), Image::Alignment::PADDED, _fast), subtitle.sub.rectangle));
1066         DCPTime from (content_time_to_dcp (piece, subtitle.from()));
1067
1068         _active_texts[static_cast<int>(text->type())].add_from (wc, ps, from);
1069 }
1070
1071
1072 void
1073 Player::plain_text_start (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentStringText subtitle)
1074 {
1075         if (_suspended) {
1076                 return;
1077         }
1078
1079         auto piece = wp.lock ();
1080         auto text = wc.lock ();
1081         if (!piece || !text) {
1082                 return;
1083         }
1084
1085         PlayerText ps;
1086         DCPTime const from (content_time_to_dcp (piece, subtitle.from()));
1087
1088         if (from > piece->content->end(_film)) {
1089                 return;
1090         }
1091
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();
1098
1099                 /* Adjust size to express the common part of the scaling;
1100                    e.g. if xs = ys = 0.5 we scale size by 2.
1101                 */
1102                 if (xs > 1e-5 && ys > 1e-5) {
1103                         size *= 1 / min (1 / xs, 1 / ys);
1104                 }
1105                 s.set_size (size);
1106
1107                 /* Then express aspect ratio changes */
1108                 if (fabs (1.0 - xs / ys) > dcp::ASPECT_ADJUST_EPSILON) {
1109                         s.set_aspect_adjust (xs / ys);
1110                 }
1111
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 ());
1115         }
1116
1117         _active_texts[static_cast<int>(text->type())].add_from (wc, ps, from);
1118 }
1119
1120
1121 void
1122 Player::subtitle_stop (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentTime to)
1123 {
1124         if (_suspended) {
1125                 return;
1126         }
1127
1128         auto text = wc.lock ();
1129         if (!text) {
1130                 return;
1131         }
1132
1133         if (!_active_texts[static_cast<int>(text->type())].have(wc)) {
1134                 return;
1135         }
1136
1137         shared_ptr<Piece> piece = wp.lock ();
1138         if (!piece) {
1139                 return;
1140         }
1141
1142         DCPTime const dcp_to = content_time_to_dcp (piece, to);
1143
1144         if (dcp_to > piece->content->end(_film)) {
1145                 return;
1146         }
1147
1148         auto from = _active_texts[static_cast<int>(text->type())].add_to (wc, dcp_to);
1149
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));
1153         }
1154 }
1155
1156
1157 void
1158 Player::seek (DCPTime time, bool accurate)
1159 {
1160         boost::mutex::scoped_lock lm (_mutex);
1161         LOG_DEBUG_PLAYER("Seek to %1 (%2accurate)", to_string(time), accurate ? "" : "in");
1162
1163         if (_suspended) {
1164                 /* We can't seek in this state */
1165                 return;
1166         }
1167
1168         if (_shuffler) {
1169                 _shuffler->clear ();
1170         }
1171
1172         _delay.clear ();
1173
1174         if (_audio_processor) {
1175                 _audio_processor->flush ();
1176         }
1177
1178         _audio_merger.clear ();
1179         for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
1180                 _active_texts[i].clear ();
1181         }
1182
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).
1189                         */
1190                         i->decoder->seek (dcp_to_content_time (i, i->content->position()), true);
1191                         i->done = false;
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);
1195                         i->done = false;
1196                 } else {
1197                         /* After; this piece is done */
1198                         i->done = true;
1199                 }
1200         }
1201
1202         if (accurate) {
1203                 _last_video_time = time;
1204                 _last_video_eyes = Eyes::LEFT;
1205                 _last_audio_time = time;
1206         } else {
1207                 _last_video_time = optional<DCPTime>();
1208                 _last_video_eyes = optional<Eyes>();
1209                 _last_audio_time = optional<DCPTime>();
1210         }
1211
1212         _black.set_position (time);
1213         _silent.set_position (time);
1214
1215         _last_video.clear ();
1216 }
1217
1218
1219 void
1220 Player::emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1221 {
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 */
1228                         return;
1229                 }
1230         }
1231
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.
1234         */
1235         _delay.push_back (make_pair (pv, time));
1236
1237         if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
1238                 _last_video_time = time + one_video_frame();
1239         }
1240         _last_video_eyes = increment_eyes (pv->eyes());
1241
1242         if (_delay.size() < 3) {
1243                 return;
1244         }
1245
1246         auto to_do = _delay.front();
1247         _delay.pop_front();
1248         do_emit_video (to_do.first, to_do.second);
1249 }
1250
1251
1252 void
1253 Player::do_emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1254 {
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);
1258                 }
1259         }
1260
1261         auto subtitles = open_subtitles_for_frame (time);
1262         if (subtitles) {
1263                 pv->set_text (subtitles.get ());
1264         }
1265
1266         Video (pv, time);
1267 }
1268
1269
1270 void
1271 Player::emit_audio (shared_ptr<AudioBuffers> data, DCPTime time)
1272 {
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);
1276         }
1277
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());
1282 }
1283
1284
1285 void
1286 Player::fill_audio (DCPTimePeriod period)
1287 {
1288         if (period.from == period.to) {
1289                 return;
1290         }
1291
1292         DCPOMATIC_ASSERT (period.from < period.to);
1293
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());
1298                 if (samples) {
1299                         auto silence = make_shared<AudioBuffers>(_film->audio_channels(), samples);
1300                         silence->make_silent ();
1301                         emit_audio (silence, t);
1302                 }
1303                 t += block;
1304         }
1305 }
1306
1307
1308 DCPTime
1309 Player::one_video_frame () const
1310 {
1311         return DCPTime::from_frames (1, _film->video_frame_rate ());
1312 }
1313
1314
1315 pair<shared_ptr<AudioBuffers>, DCPTime>
1316 Player::discard_audio (shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to) const
1317 {
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());
1323         }
1324         auto cut = make_shared<AudioBuffers>(audio, remaining_frames, discard_frames);
1325         return make_pair(cut, time + discard_time);
1326 }
1327
1328
1329 void
1330 Player::set_dcp_decode_reduction (optional<int> reduction)
1331 {
1332         Change (ChangeType::PENDING, PlayerProperty::DCP_DECODE_REDUCTION, false);
1333
1334         {
1335                 boost::mutex::scoped_lock lm (_mutex);
1336
1337                 if (reduction == _dcp_decode_reduction) {
1338                         lm.unlock ();
1339                         Change (ChangeType::CANCELLED, PlayerProperty::DCP_DECODE_REDUCTION, false);
1340                         return;
1341                 }
1342
1343                 _dcp_decode_reduction = reduction;
1344                 setup_pieces_unlocked ();
1345         }
1346
1347         Change (ChangeType::DONE, PlayerProperty::DCP_DECODE_REDUCTION, false);
1348 }
1349
1350
1351 optional<DCPTime>
1352 Player::content_time_to_dcp (shared_ptr<Content> content, ContentTime t)
1353 {
1354         boost::mutex::scoped_lock lm (_mutex);
1355
1356         for (auto i: _pieces) {
1357                 if (i->content == content) {
1358                         return content_time_to_dcp (i, t);
1359                 }
1360         }
1361
1362         /* We couldn't find this content; perhaps things are being changed over */
1363         return {};
1364 }
1365
1366
1367 shared_ptr<const Playlist>
1368 Player::playlist () const
1369 {
1370         return _playlist ? _playlist : _film->playlist();
1371 }
1372
1373
1374 void
1375 Player::atmos (weak_ptr<Piece>, ContentAtmos data)
1376 {
1377         if (_suspended) {
1378                 return;
1379         }
1380
1381         Atmos (data.data, DCPTime::from_frames(data.frame, _film->video_frame_rate()), data.metadata);
1382 }
1383