src/lib/player.cc

   1 /*
   2     Copyright (C) 2013-2018 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 #include "player.h"
  22 #include "film.h"
  23 #include "audio_buffers.h"
  24 #include "content_audio.h"
  25 #include "dcp_content.h"
  26 #include "job.h"
  27 #include "image.h"
  28 #include "raw_image_proxy.h"
  29 #include "ratio.h"
  30 #include "log.h"
  31 #include "render_text.h"
  32 #include "config.h"
  33 #include "content_video.h"
  34 #include "player_video.h"
  35 #include "frame_rate_change.h"
  36 #include "audio_processor.h"
  37 #include "playlist.h"
  38 #include "referenced_reel_asset.h"
  39 #include "decoder_factory.h"
  40 #include "decoder.h"
  41 #include "video_decoder.h"
  42 #include "audio_decoder.h"
  43 #include "text_content.h"
  44 #include "text_decoder.h"
  45 #include "ffmpeg_content.h"
  46 #include "audio_content.h"
  47 #include "dcp_decoder.h"
  48 #include "image_decoder.h"
  49 #include "compose.hpp"
  50 #include "shuffler.h"
  51 #include <dcp/reel.h>
  52 #include <dcp/reel_sound_asset.h>
  53 #include <dcp/reel_subtitle_asset.h>
  54 #include <dcp/reel_picture_asset.h>
  55 #include <dcp/reel_closed_caption_asset.h>
  56 #include <boost/foreach.hpp>
  57 #include <stdint.h>
  58 #include <algorithm>
  59 #include <iostream>
  60
  61 #include "i18n.h"
  62
  63 using std::list;
  64 using std::cout;
  65 using std::min;
  66 using std::max;
  67 using std::min;
  68 using std::vector;
  69 using std::pair;
  70 using std::map;
  71 using std::make_pair;
  72 using std::copy;
  73 using boost::shared_ptr;
  74 using boost::weak_ptr;
  75 using boost::dynamic_pointer_cast;
  76 using boost::optional;
  77 using boost::scoped_ptr;
  78
  79 int const PlayerProperty::VIDEO_CONTAINER_SIZE = 700;
  80 int const PlayerProperty::PLAYLIST = 701;
  81 int const PlayerProperty::FILM_CONTAINER = 702;
  82 int const PlayerProperty::FILM_VIDEO_FRAME_RATE = 703;
  83 int const PlayerProperty::DCP_DECODE_REDUCTION = 704;
  84
  85 Player::Player (shared_ptr<const Film> film, shared_ptr<const Playlist> playlist)
  86         : _film (film)
  87         , _playlist (playlist)
  88         , _suspended (false)
  89         , _ignore_video (false)
  90         , _ignore_audio (false)
  91         , _ignore_text (false)
  92         , _always_burn_open_subtitles (false)
  93         , _fast (false)
  94         , _play_referenced (false)
  95         , _audio_merger (_film->audio_frame_rate())
  96         , _shuffler (0)
  97 {
  98         _film_changed_connection = _film->Change.connect (bind (&Player::film_change, this, _1, _2));
  99         /* The butler must hear about this first, so since we are proxying this through to the butler we must
 100            be first.
 101         */
 102         _playlist_change_connection = _playlist->Change.connect (bind (&Player::playlist_change, this, _1), boost::signals2::at_front);
 103         _playlist_content_change_connection = _playlist->ContentChange.connect (bind(&Player::playlist_content_change, this, _1, _3, _4));
 104         set_video_container_size (_film->frame_size ());
 105
 106         film_change (CHANGE_TYPE_DONE, Film::AUDIO_PROCESSOR);
 107
 108         setup_pieces ();
 109         seek (DCPTime (), true);
 110 }
 111
 112 Player::~Player ()
 113 {
 114         delete _shuffler;
 115 }
 116
 117 void
 118 Player::setup_pieces ()
 119 {
 120         boost::mutex::scoped_lock lm (_mutex);
 121         setup_pieces_unlocked ();
 122 }
 123
 124 bool
 125 have_video (shared_ptr<Piece> piece)
 126 {
 127         return piece->decoder && piece->decoder->video;
 128 }
 129
 130 bool
 131 have_audio (shared_ptr<Piece> piece)
 132 {
 133         return piece->decoder && piece->decoder->audio;
 134 }
 135
 136 void
 137 Player::setup_pieces_unlocked ()
 138 {
 139         _pieces.clear ();
 140
 141         delete _shuffler;
 142         _shuffler = new Shuffler();
 143         _shuffler->Video.connect(bind(&Player::video, this, _1, _2));
 144
 145         BOOST_FOREACH (shared_ptr<Content> i, _playlist->content ()) {
 146
 147                 if (!i->paths_valid ()) {
 148                         continue;
 149                 }
 150
 151                 if (_ignore_video && _ignore_audio && i->text.empty()) {
 152                         /* We're only interested in text and this content has none */
 153                         continue;
 154                 }
 155
 156                 shared_ptr<Decoder> decoder = decoder_factory (_film, i, _fast);
 157                 FrameRateChange frc (_film, i);
 158
 159                 if (!decoder) {
 160                         /* Not something that we can decode; e.g. Atmos content */
 161                         continue;
 162                 }
 163
 164                 if (decoder->video && _ignore_video) {
 165                         decoder->video->set_ignore (true);
 166                 }
 167
 168                 if (decoder->audio && _ignore_audio) {
 169                         decoder->audio->set_ignore (true);
 170                 }
 171
 172                 if (_ignore_text) {
 173                         BOOST_FOREACH (shared_ptr<TextDecoder> i, decoder->text) {
 174                                 i->set_ignore (true);
 175                         }
 176                 }
 177
 178                 shared_ptr<DCPDecoder> dcp = dynamic_pointer_cast<DCPDecoder> (decoder);
 179                 if (dcp) {
 180                         dcp->set_decode_referenced (_play_referenced);
 181                         if (_play_referenced) {
 182                                 dcp->set_forced_reduction (_dcp_decode_reduction);
 183                         }
 184                 }
 185
 186                 shared_ptr<Piece> piece (new Piece (i, decoder, frc));
 187                 _pieces.push_back (piece);
 188
 189                 if (decoder->video) {
 190                         if (i->video->frame_type() == VIDEO_FRAME_TYPE_3D_LEFT || i->video->frame_type() == VIDEO_FRAME_TYPE_3D_RIGHT) {
 191                                 /* We need a Shuffler to cope with 3D L/R video data arriving out of sequence */
 192                                 decoder->video->Data.connect (bind (&Shuffler::video, _shuffler, weak_ptr<Piece>(piece), _1));
 193                         } else {
 194                                 decoder->video->Data.connect (bind (&Player::video, this, weak_ptr<Piece>(piece), _1));
 195                         }
 196                 }
 197
 198                 if (decoder->audio) {
 199                         decoder->audio->Data.connect (bind (&Player::audio, this, weak_ptr<Piece> (piece), _1, _2));
 200                 }
 201
 202                 list<shared_ptr<TextDecoder> >::const_iterator j = decoder->text.begin();
 203
 204                 while (j != decoder->text.end()) {
 205                         (*j)->BitmapStart.connect (
 206                                 bind(&Player::bitmap_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
 207                                 );
 208                         (*j)->PlainStart.connect (
 209                                 bind(&Player::plain_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
 210                                 );
 211                         (*j)->Stop.connect (
 212                                 bind(&Player::subtitle_stop, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
 213                                 );
 214
 215                         ++j;
 216                 }
 217         }
 218
 219         _stream_states.clear ();
 220         BOOST_FOREACH (shared_ptr<Piece> i, _pieces) {
 221                 if (i->content->audio) {
 222                         BOOST_FOREACH (AudioStreamPtr j, i->content->audio->streams()) {
 223                                 _stream_states[j] = StreamState (i, i->content->position ());
 224                         }
 225                 }
 226         }
 227
 228         _black = Empty (_film, _pieces, bind(&have_video, _1));
 229         _silent = Empty (_film, _pieces, bind(&have_audio, _1));
 230
 231         _last_video_time = DCPTime ();
 232         _last_video_eyes = EYES_BOTH;
 233         _last_audio_time = DCPTime ();
 234 }
 235
 236 void
 237 Player::playlist_content_change (ChangeType type, int property, bool frequent)
 238 {
 239         if (type == CHANGE_TYPE_PENDING) {
 240                 boost::mutex::scoped_lock lm (_mutex);
 241                 /* The player content is probably about to change, so we can't carry on
 242                    until that has happened and we've rebuilt our pieces.  Stop pass()
 243                    and seek() from working until then.
 244                 */
 245                 _suspended = true;
 246         } else if (type == CHANGE_TYPE_DONE) {
 247                 /* A change in our content has gone through.  Re-build our pieces. */
 248                 setup_pieces ();
 249                 _suspended = false;
 250         } else if (type == CHANGE_TYPE_CANCELLED) {
 251                 boost::mutex::scoped_lock lm (_mutex);
 252                 _suspended = false;
 253         }
 254
 255         Change (type, property, frequent);
 256 }
 257
 258 void
 259 Player::set_video_container_size (dcp::Size s)
 260 {
 261         Change (CHANGE_TYPE_PENDING, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
 262
 263         {
 264                 boost::mutex::scoped_lock lm (_mutex);
 265
 266                 if (s == _video_container_size) {
 267                         lm.unlock ();
 268                         Change (CHANGE_TYPE_CANCELLED, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
 269                         return;
 270                 }
 271
 272                 _video_container_size = s;
 273
 274                 _black_image.reset (new Image (AV_PIX_FMT_RGB24, _video_container_size, true));
 275                 _black_image->make_black ();
 276         }
 277
 278         Change (CHANGE_TYPE_DONE, PlayerProperty::VIDEO_CONTAINER_SIZE, false);
 279 }
 280
 281 void
 282 Player::playlist_change (ChangeType type)
 283 {
 284         if (type == CHANGE_TYPE_DONE) {
 285                 setup_pieces ();
 286         }
 287         Change (type, PlayerProperty::PLAYLIST, false);
 288 }
 289
 290 void
 291 Player::film_change (ChangeType type, Film::Property p)
 292 {
 293         /* Here we should notice Film properties that affect our output, and
 294            alert listeners that our output now would be different to how it was
 295            last time we were run.
 296         */
 297
 298         if (p == Film::CONTAINER) {
 299                 Change (type, PlayerProperty::FILM_CONTAINER, false);
 300         } else if (p == Film::VIDEO_FRAME_RATE) {
 301                 /* Pieces contain a FrameRateChange which contains the DCP frame rate,
 302                    so we need new pieces here.
 303                 */
 304                 if (type == CHANGE_TYPE_DONE) {
 305                         setup_pieces ();
 306                 }
 307                 Change (type, PlayerProperty::FILM_VIDEO_FRAME_RATE, false);
 308         } else if (p == Film::AUDIO_PROCESSOR) {
 309                 if (type == CHANGE_TYPE_DONE && _film->audio_processor ()) {
 310                         boost::mutex::scoped_lock lm (_mutex);
 311                         _audio_processor = _film->audio_processor()->clone (_film->audio_frame_rate ());
 312                 }
 313         } else if (p == Film::AUDIO_CHANNELS) {
 314                 if (type == CHANGE_TYPE_DONE) {
 315                         boost::mutex::scoped_lock lm (_mutex);
 316                         _audio_merger.clear ();
 317                 }
 318         }
 319 }
 320
 321 shared_ptr<PlayerVideo>
 322 Player::black_player_video_frame (Eyes eyes) const
 323 {
 324         return shared_ptr<PlayerVideo> (
 325                 new PlayerVideo (
 326                         shared_ptr<const ImageProxy> (new RawImageProxy (_black_image)),
 327                         Crop (),
 328                         optional<double> (),
 329                         _video_container_size,
 330                         _video_container_size,
 331                         eyes,
 332                         PART_WHOLE,
 333                         PresetColourConversion::all().front().conversion,
 334                         boost::weak_ptr<Content>(),
 335                         boost::optional<Frame>()
 336                 )
 337         );
 338 }
 339
 340 Frame
 341 Player::dcp_to_content_video (shared_ptr<const Piece> piece, DCPTime t) const
 342 {
 343         DCPTime s = t - piece->content->position ();
 344         s = min (piece->content->length_after_trim(_film), s);
 345         s = max (DCPTime(), s + DCPTime (piece->content->trim_start(), piece->frc));
 346
 347         /* It might seem more logical here to convert s to a ContentTime (using the FrameRateChange)
 348            then convert that ContentTime to frames at the content's rate.  However this fails for
 349            situations like content at 29.9978733fps, DCP at 30fps.  The accuracy of the Time type is not
 350            enough to distinguish between the two with low values of time (e.g. 3200 in Time units).
 351
 352            Instead we convert the DCPTime using the DCP video rate then account for any skip/repeat.
 353         */
 354         return s.frames_floor (piece->frc.dcp) / piece->frc.factor ();
 355 }
 356
 357 DCPTime
 358 Player::content_video_to_dcp (shared_ptr<const Piece> piece, Frame f) const
 359 {
 360         /* See comment in dcp_to_content_video */
 361         DCPTime const d = DCPTime::from_frames (f * piece->frc.factor(), piece->frc.dcp) - DCPTime(piece->content->trim_start(), piece->frc);
 362         return d + piece->content->position();
 363 }
 364
 365 Frame
 366 Player::dcp_to_resampled_audio (shared_ptr<const Piece> piece, DCPTime t) const
 367 {
 368         DCPTime s = t - piece->content->position ();
 369         s = min (piece->content->length_after_trim(_film), s);
 370         /* See notes in dcp_to_content_video */
 371         return max (DCPTime (), DCPTime (piece->content->trim_start (), piece->frc) + s).frames_floor (_film->audio_frame_rate ());
 372 }
 373
 374 DCPTime
 375 Player::resampled_audio_to_dcp (shared_ptr<const Piece> piece, Frame f) const
 376 {
 377         /* See comment in dcp_to_content_video */
 378         return DCPTime::from_frames (f, _film->audio_frame_rate())
 379                 - DCPTime (piece->content->trim_start(), piece->frc)
 380                 + piece->content->position();
 381 }
 382
 383 ContentTime
 384 Player::dcp_to_content_time (shared_ptr<const Piece> piece, DCPTime t) const
 385 {
 386         DCPTime s = t - piece->content->position ();
 387         s = min (piece->content->length_after_trim(_film), s);
 388         return max (ContentTime (), ContentTime (s, piece->frc) + piece->content->trim_start());
 389 }
 390
 391 DCPTime
 392 Player::content_time_to_dcp (shared_ptr<const Piece> piece, ContentTime t) const
 393 {
 394         return max (DCPTime (), DCPTime (t - piece->content->trim_start(), piece->frc) + piece->content->position());
 395 }
 396
 397 list<shared_ptr<Font> >
 398 Player::get_subtitle_fonts ()
 399 {
 400         boost::mutex::scoped_lock lm (_mutex);
 401
 402         list<shared_ptr<Font> > fonts;
 403         BOOST_FOREACH (shared_ptr<Piece> i, _pieces) {
 404                 BOOST_FOREACH (shared_ptr<TextContent> j, i->content->text) {
 405                         /* XXX: things may go wrong if there are duplicate font IDs
 406                            with different font files.
 407                         */
 408                         list<shared_ptr<Font> > f = j->fonts ();
 409                         copy (f.begin(), f.end(), back_inserter (fonts));
 410                 }
 411         }
 412
 413         return fonts;
 414 }
 415
 416 /** Set this player never to produce any video data */
 417 void
 418 Player::set_ignore_video ()
 419 {
 420         boost::mutex::scoped_lock lm (_mutex);
 421         _ignore_video = true;
 422         setup_pieces_unlocked ();
 423 }
 424
 425 void
 426 Player::set_ignore_audio ()
 427 {
 428         boost::mutex::scoped_lock lm (_mutex);
 429         _ignore_audio = true;
 430         setup_pieces_unlocked ();
 431 }
 432
 433 void
 434 Player::set_ignore_text ()
 435 {
 436         boost::mutex::scoped_lock lm (_mutex);
 437         _ignore_text = true;
 438         setup_pieces_unlocked ();
 439 }
 440
 441 /** Set the player to always burn open texts into the image regardless of the content settings */
 442 void
 443 Player::set_always_burn_open_subtitles ()
 444 {
 445         boost::mutex::scoped_lock lm (_mutex);
 446         _always_burn_open_subtitles = true;
 447 }
 448
 449 /** Sets up the player to be faster, possibly at the expense of quality */
 450 void
 451 Player::set_fast ()
 452 {
 453         boost::mutex::scoped_lock lm (_mutex);
 454         _fast = true;
 455         setup_pieces_unlocked ();
 456 }
 457
 458 void
 459 Player::set_play_referenced ()
 460 {
 461         boost::mutex::scoped_lock lm (_mutex);
 462         _play_referenced = true;
 463         setup_pieces_unlocked ();
 464 }
 465
 466 static void
 467 maybe_add_asset (list<ReferencedReelAsset>& a, shared_ptr<dcp::ReelAsset> r, Frame reel_trim_start, Frame reel_trim_end, DCPTime from, int const ffr)
 468 {
 469         DCPOMATIC_ASSERT (r);
 470         r->set_entry_point (r->entry_point().get_value_or(0) + reel_trim_start);
 471         r->set_duration (r->actual_duration() - reel_trim_start - reel_trim_end);
 472         if (r->actual_duration() > 0) {
 473                 a.push_back (
 474                         ReferencedReelAsset(r, DCPTimePeriod(from, from + DCPTime::from_frames(r->actual_duration(), ffr)))
 475                         );
 476         }
 477 }
 478
 479 list<ReferencedReelAsset>
 480 Player::get_reel_assets ()
 481 {
 482         /* Does not require a lock on _mutex as it's only called from DCPEncoder */
 483
 484         list<ReferencedReelAsset> a;
 485
 486         BOOST_FOREACH (shared_ptr<Content> i, _playlist->content ()) {
 487                 shared_ptr<DCPContent> j = dynamic_pointer_cast<DCPContent> (i);
 488                 if (!j) {
 489                         continue;
 490                 }
 491
 492                 scoped_ptr<DCPDecoder> decoder;
 493                 try {
 494                         decoder.reset (new DCPDecoder (_film, j, false));
 495                 } catch (...) {
 496                         return a;
 497                 }
 498
 499                 DCPOMATIC_ASSERT (j->video_frame_rate ());
 500                 double const cfr = j->video_frame_rate().get();
 501                 Frame const trim_start = j->trim_start().frames_round (cfr);
 502                 Frame const trim_end = j->trim_end().frames_round (cfr);
 503                 int const ffr = _film->video_frame_rate ();
 504
 505                 /* position in the asset from the start */
 506                 int64_t offset_from_start = 0;
 507                 /* position in the asset from the end */
 508                 int64_t offset_from_end = 0;
 509                 BOOST_FOREACH (shared_ptr<dcp::Reel> k, decoder->reels()) {
 510                         /* Assume that main picture duration is the length of the reel */
 511                         offset_from_end += k->main_picture()->actual_duration();
 512                 }
 513
 514                 BOOST_FOREACH (shared_ptr<dcp::Reel> k, decoder->reels()) {
 515
 516                         /* Assume that main picture duration is the length of the reel */
 517                         int64_t const reel_duration = k->main_picture()->actual_duration();
 518
 519                         /* See doc/design/trim_reels.svg */
 520                         Frame const reel_trim_start = min(reel_duration, max(int64_t(0), trim_start - offset_from_start));
 521                         Frame const reel_trim_end =   min(reel_duration, max(int64_t(0), reel_duration - (offset_from_end - trim_end)));
 522
 523                         DCPTime const from = i->position() + DCPTime::from_frames (offset_from_start, _film->video_frame_rate());
 524                         if (j->reference_video ()) {
 525                                 maybe_add_asset (a, k->main_picture(), reel_trim_start, reel_trim_end, from, ffr);
 526                         }
 527
 528                         if (j->reference_audio ()) {
 529                                 maybe_add_asset (a, k->main_sound(), reel_trim_start, reel_trim_end, from, ffr);
 530                         }
 531
 532                         if (j->reference_text (TEXT_OPEN_SUBTITLE)) {
 533                                 maybe_add_asset (a, k->main_subtitle(), reel_trim_start, reel_trim_end, from, ffr);
 534                         }
 535
 536                         if (j->reference_text (TEXT_CLOSED_CAPTION)) {
 537                                 BOOST_FOREACH (shared_ptr<dcp::ReelClosedCaptionAsset> l, k->closed_captions()) {
 538                                         maybe_add_asset (a, l, reel_trim_start, reel_trim_end, from, ffr);
 539                                 }
 540                         }
 541
 542                         offset_from_start += reel_duration;
 543                         offset_from_end -= reel_duration;
 544                 }
 545         }
 546
 547         return a;
 548 }
 549
 550 bool
 551 Player::pass ()
 552 {
 553         boost::mutex::scoped_lock lm (_mutex);
 554
 555         if (_suspended) {
 556                 /* We can't pass in this state */
 557                 return false;
 558         }
 559
 560         if (_playlist->length(_film) == DCPTime()) {
 561                 /* Special case of an empty Film; just give one black frame */
 562                 emit_video (black_player_video_frame(EYES_BOTH), DCPTime());
 563                 return true;
 564         }
 565
 566         /* Find the decoder or empty which is farthest behind where we are and make it emit some data */
 567
 568         shared_ptr<Piece> earliest_content;
 569         optional<DCPTime> earliest_time;
 570
 571         BOOST_FOREACH (shared_ptr<Piece> i, _pieces) {
 572                 if (i->done) {
 573                         continue;
 574                 }
 575
 576                 DCPTime const t = content_time_to_dcp (i, max(i->decoder->position(), i->content->trim_start()));
 577                 if (t > i->content->end(_film)) {
 578                         i->done = true;
 579                 } else {
 580
 581                         /* Given two choices at the same time, pick the one with texts so we see it before
 582                            the video.
 583                         */
 584                         if (!earliest_time || t < *earliest_time || (t == *earliest_time && !i->decoder->text.empty())) {
 585                                 earliest_time = t;
 586                                 earliest_content = i;
 587                         }
 588                 }
 589         }
 590
 591         bool done = false;
 592
 593         enum {
 594                 NONE,
 595                 CONTENT,
 596                 BLACK,
 597                 SILENT
 598         } which = NONE;
 599
 600         if (earliest_content) {
 601                 which = CONTENT;
 602         }
 603
 604         if (!_black.done() && (!earliest_time || _black.position() < *earliest_time)) {
 605                 earliest_time = _black.position ();
 606                 which = BLACK;
 607         }
 608
 609         if (!_silent.done() && (!earliest_time || _silent.position() < *earliest_time)) {
 610                 earliest_time = _silent.position ();
 611                 which = SILENT;
 612         }
 613
 614         switch (which) {
 615         case CONTENT:
 616         {
 617                 earliest_content->done = earliest_content->decoder->pass ();
 618                 shared_ptr<DCPContent> dcp = dynamic_pointer_cast<DCPContent>(earliest_content->content);
 619                 if (dcp && !_play_referenced && dcp->reference_audio()) {
 620                         /* We are skipping some referenced DCP audio content, so we need to update _last_audio_time
 621                            to `hide' the fact that no audio was emitted during the referenced DCP (though
 622                            we need to behave as though it was).
 623                         */
 624                         _last_audio_time = dcp->end (_film);
 625                 }
 626                 break;
 627         }
 628         case BLACK:
 629                 emit_video (black_player_video_frame(EYES_BOTH), _black.position());
 630                 _black.set_position (_black.position() + one_video_frame());
 631                 break;
 632         case SILENT:
 633         {
 634                 DCPTimePeriod period (_silent.period_at_position());
 635                 if (_last_audio_time) {
 636                         /* Sometimes the thing that happened last finishes fractionally before
 637                            or after this silence.  Bodge the start time of the silence to fix it.
 638                         */
 639                         DCPOMATIC_ASSERT (labs(period.from.get() - _last_audio_time->get()) < 2);
 640                         period.from = *_last_audio_time;
 641                 }
 642                 if (period.duration() > one_video_frame()) {
 643                         period.to = period.from + one_video_frame();
 644                 }
 645                 fill_audio (period);
 646                 _silent.set_position (period.to);
 647                 break;
 648         }
 649         case NONE:
 650                 done = true;
 651                 break;
 652         }
 653
 654         /* Emit any audio that is ready */
 655
 656         /* Work out the time before which the audio is definitely all here.  This is the earliest last_push_end of one
 657            of our streams, or the position of the _silent.
 658         */
 659         DCPTime pull_to = _film->length ();
 660         for (map<AudioStreamPtr, StreamState>::const_iterator i = _stream_states.begin(); i != _stream_states.end(); ++i) {
 661                 if (!i->second.piece->done && i->second.last_push_end < pull_to) {
 662                         pull_to = i->second.last_push_end;
 663                 }
 664         }
 665         if (!_silent.done() && _silent.position() < pull_to) {
 666                 pull_to = _silent.position();
 667         }
 668
 669         list<pair<shared_ptr<AudioBuffers>, DCPTime> > audio = _audio_merger.pull (pull_to);
 670         for (list<pair<shared_ptr<AudioBuffers>, DCPTime> >::iterator i = audio.begin(); i != audio.end(); ++i) {
 671                 if (_last_audio_time && i->second < *_last_audio_time) {
 672                         /* This new data comes before the last we emitted (or the last seek); discard it */
 673                         pair<shared_ptr<AudioBuffers>, DCPTime> cut = discard_audio (i->first, i->second, *_last_audio_time);
 674                         if (!cut.first) {
 675                                 continue;
 676                         }
 677                         *i = cut;
 678                 } else if (_last_audio_time && i->second > *_last_audio_time) {
 679                         /* There's a gap between this data and the last we emitted; fill with silence */
 680                         fill_audio (DCPTimePeriod (*_last_audio_time, i->second));
 681                 }
 682
 683                 emit_audio (i->first, i->second);
 684         }
 685
 686         if (done) {
 687                 _shuffler->flush ();
 688                 for (list<pair<shared_ptr<PlayerVideo>, DCPTime> >::const_iterator i = _delay.begin(); i != _delay.end(); ++i) {
 689                         do_emit_video(i->first, i->second);
 690                 }
 691         }
 692
 693         return done;
 694 }
 695
 696 /** @return Open subtitles for the frame at the given time, converted to images */
 697 optional<PositionImage>
 698 Player::open_subtitles_for_frame (DCPTime time) const
 699 {
 700         list<PositionImage> captions;
 701         int const vfr = _film->video_frame_rate();
 702
 703         BOOST_FOREACH (
 704                 PlayerText j,
 705                 _active_texts[TEXT_OPEN_SUBTITLE].get_burnt(DCPTimePeriod(time, time + DCPTime::from_frames(1, vfr)), _always_burn_open_subtitles)
 706                 ) {
 707
 708                 /* Bitmap subtitles */
 709                 BOOST_FOREACH (BitmapText i, j.bitmap) {
 710                         if (!i.image) {
 711                                 continue;
 712                         }
 713
 714                         /* i.image will already have been scaled to fit _video_container_size */
 715                         dcp::Size scaled_size (i.rectangle.width * _video_container_size.width, i.rectangle.height * _video_container_size.height);
 716
 717                         captions.push_back (
 718                                 PositionImage (
 719                                         i.image,
 720                                         Position<int> (
 721                                                 lrint (_video_container_size.width * i.rectangle.x),
 722                                                 lrint (_video_container_size.height * i.rectangle.y)
 723                                                 )
 724                                         )
 725                                 );
 726                 }
 727
 728                 /* String subtitles (rendered to an image) */
 729                 if (!j.string.empty ()) {
 730                         list<PositionImage> s = render_text (j.string, j.fonts, _video_container_size, time, vfr);
 731                         copy (s.begin(), s.end(), back_inserter (captions));
 732                 }
 733         }
 734
 735         if (captions.empty ()) {
 736                 return optional<PositionImage> ();
 737         }
 738
 739         return merge (captions);
 740 }
 741
 742 void
 743 Player::video (weak_ptr<Piece> wp, ContentVideo video)
 744 {
 745         shared_ptr<Piece> piece = wp.lock ();
 746         if (!piece) {
 747                 return;
 748         }
 749
 750         FrameRateChange frc (_film, piece->content);
 751         if (frc.skip && (video.frame % 2) == 1) {
 752                 return;
 753         }
 754
 755         /* Time of the first frame we will emit */
 756         DCPTime const time = content_video_to_dcp (piece, video.frame);
 757
 758         /* Discard if it's before the content's period or the last accurate seek.  We can't discard
 759            if it's after the content's period here as in that case we still need to fill any gap between
 760            `now' and the end of the content's period.
 761         */
 762         if (time < piece->content->position() || (_last_video_time && time < *_last_video_time)) {
 763                 return;
 764         }
 765
 766         /* Fill gaps that we discover now that we have some video which needs to be emitted.
 767            This is where we need to fill to.
 768         */
 769         DCPTime fill_to = min (time, piece->content->end(_film));
 770
 771         if (_last_video_time) {
 772                 DCPTime fill_from = max (*_last_video_time, piece->content->position());
 773
 774                 /* Fill if we have more than half a frame to do */
 775                 if ((fill_to - fill_from) > one_video_frame() / 2) {
 776                         LastVideoMap::const_iterator last = _last_video.find (wp);
 777                         if (_film->three_d()) {
 778                                 Eyes fill_to_eyes = video.eyes;
 779                                 if (fill_to_eyes == EYES_BOTH) {
 780                                         fill_to_eyes = EYES_LEFT;
 781                                 }
 782                                 if (fill_to == piece->content->end(_film)) {
 783                                         /* Don't fill after the end of the content */
 784                                         fill_to_eyes = EYES_LEFT;
 785                                 }
 786                                 DCPTime j = fill_from;
 787                                 Eyes eyes = _last_video_eyes.get_value_or(EYES_LEFT);
 788                                 if (eyes == EYES_BOTH) {
 789                                         eyes = EYES_LEFT;
 790                                 }
 791                                 while (j < fill_to || eyes != fill_to_eyes) {
 792                                         if (last != _last_video.end()) {
 793                                                 shared_ptr<PlayerVideo> copy = last->second->shallow_copy();
 794                                                 copy->set_eyes (eyes);
 795                                                 emit_video (copy, j);
 796                                         } else {
 797                                                 emit_video (black_player_video_frame(eyes), j);
 798                                         }
 799                                         if (eyes == EYES_RIGHT) {
 800                                                 j += one_video_frame();
 801                                         }
 802                                         eyes = increment_eyes (eyes);
 803                                 }
 804                         } else {
 805                                 for (DCPTime j = fill_from; j < fill_to; j += one_video_frame()) {
 806                                         if (last != _last_video.end()) {
 807                                                 emit_video (last->second, j);
 808                                         } else {
 809                                                 emit_video (black_player_video_frame(EYES_BOTH), j);
 810                                         }
 811                                 }
 812                         }
 813                 }
 814         }
 815
 816         _last_video[wp].reset (
 817                 new PlayerVideo (
 818                         video.image,
 819                         piece->content->video->crop (),
 820                         piece->content->video->fade (_film, video.frame),
 821                         piece->content->video->scale().size (
 822                                 piece->content->video, _video_container_size, _film->frame_size ()
 823                                 ),
 824                         _video_container_size,
 825                         video.eyes,
 826                         video.part,
 827                         piece->content->video->colour_conversion(),
 828                         piece->content,
 829                         video.frame
 830                         )
 831                 );
 832
 833         DCPTime t = time;
 834         for (int i = 0; i < frc.repeat; ++i) {
 835                 if (t < piece->content->end(_film)) {
 836                         emit_video (_last_video[wp], t);
 837                 }
 838                 t += one_video_frame ();
 839         }
 840 }
 841
 842 void
 843 Player::audio (weak_ptr<Piece> wp, AudioStreamPtr stream, ContentAudio content_audio)
 844 {
 845         DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
 846
 847         shared_ptr<Piece> piece = wp.lock ();
 848         if (!piece) {
 849                 return;
 850         }
 851
 852         shared_ptr<AudioContent> content = piece->content->audio;
 853         DCPOMATIC_ASSERT (content);
 854
 855         /* Compute time in the DCP */
 856         DCPTime time = resampled_audio_to_dcp (piece, content_audio.frame);
 857         /* And the end of this block in the DCP */
 858         DCPTime end = time + DCPTime::from_frames(content_audio.audio->frames(), content->resampled_frame_rate(_film));
 859
 860         /* Remove anything that comes before the start or after the end of the content */
 861         if (time < piece->content->position()) {
 862                 pair<shared_ptr<AudioBuffers>, DCPTime> cut = discard_audio (content_audio.audio, time, piece->content->position());
 863                 if (!cut.first) {
 864                         /* This audio is entirely discarded */
 865                         return;
 866                 }
 867                 content_audio.audio = cut.first;
 868                 time = cut.second;
 869         } else if (time > piece->content->end(_film)) {
 870                 /* Discard it all */
 871                 return;
 872         } else if (end > piece->content->end(_film)) {
 873                 Frame const remaining_frames = DCPTime(piece->content->end(_film) - time).frames_round(_film->audio_frame_rate());
 874                 if (remaining_frames == 0) {
 875                         return;
 876                 }
 877                 shared_ptr<AudioBuffers> cut (new AudioBuffers (content_audio.audio->channels(), remaining_frames));
 878                 cut->copy_from (content_audio.audio.get(), remaining_frames, 0, 0);
 879                 content_audio.audio = cut;
 880         }
 881
 882         DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
 883
 884         /* Gain */
 885
 886         if (content->gain() != 0) {
 887                 shared_ptr<AudioBuffers> gain (new AudioBuffers (content_audio.audio));
 888                 gain->apply_gain (content->gain ());
 889                 content_audio.audio = gain;
 890         }
 891
 892         /* Remap */
 893
 894         content_audio.audio = remap (content_audio.audio, _film->audio_channels(), stream->mapping());
 895
 896         /* Process */
 897
 898         if (_audio_processor) {
 899                 content_audio.audio = _audio_processor->run (content_audio.audio, _film->audio_channels ());
 900         }
 901
 902         /* Push */
 903
 904         _audio_merger.push (content_audio.audio, time);
 905         DCPOMATIC_ASSERT (_stream_states.find (stream) != _stream_states.end ());
 906         _stream_states[stream].last_push_end = time + DCPTime::from_frames (content_audio.audio->frames(), _film->audio_frame_rate());
 907 }
 908
 909 void
 910 Player::bitmap_text_start (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentBitmapText subtitle)
 911 {
 912         shared_ptr<Piece> piece = wp.lock ();
 913         shared_ptr<const TextContent> text = wc.lock ();
 914         if (!piece || !text) {
 915                 return;
 916         }
 917
 918         /* Apply content's subtitle offsets */
 919         subtitle.sub.rectangle.x += text->x_offset ();
 920         subtitle.sub.rectangle.y += text->y_offset ();
 921
 922         /* Apply a corrective translation to keep the subtitle centred after the scale that is coming up */
 923         subtitle.sub.rectangle.x -= subtitle.sub.rectangle.width * ((text->x_scale() - 1) / 2);
 924         subtitle.sub.rectangle.y -= subtitle.sub.rectangle.height * ((text->y_scale() - 1) / 2);
 925
 926         /* Apply content's subtitle scale */
 927         subtitle.sub.rectangle.width *= text->x_scale ();
 928         subtitle.sub.rectangle.height *= text->y_scale ();
 929
 930         PlayerText ps;
 931         shared_ptr<Image> image = subtitle.sub.image;
 932         /* We will scale the subtitle up to fit _video_container_size */
 933         dcp::Size scaled_size (subtitle.sub.rectangle.width * _video_container_size.width, subtitle.sub.rectangle.height * _video_container_size.height);
 934         ps.bitmap.push_back (BitmapText(image->scale(scaled_size, dcp::YUV_TO_RGB_REC601, image->pixel_format(), true, _fast), subtitle.sub.rectangle));
 935         DCPTime from (content_time_to_dcp (piece, subtitle.from()));
 936
 937         _active_texts[text->type()].add_from (wc, ps, from);
 938 }
 939
 940 void
 941 Player::plain_text_start (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentStringText subtitle)
 942 {
 943         shared_ptr<Piece> piece = wp.lock ();
 944         shared_ptr<const TextContent> text = wc.lock ();
 945         if (!piece || !text) {
 946                 return;
 947         }
 948
 949         PlayerText ps;
 950         DCPTime const from (content_time_to_dcp (piece, subtitle.from()));
 951
 952         if (from > piece->content->end(_film)) {
 953                 return;
 954         }
 955
 956         BOOST_FOREACH (dcp::SubtitleString s, subtitle.subs) {
 957                 s.set_h_position (s.h_position() + text->x_offset ());
 958                 s.set_v_position (s.v_position() + text->y_offset ());
 959                 float const xs = text->x_scale();
 960                 float const ys = text->y_scale();
 961                 float size = s.size();
 962
 963                 /* Adjust size to express the common part of the scaling;
 964                    e.g. if xs = ys = 0.5 we scale size by 2.
 965                 */
 966                 if (xs > 1e-5 && ys > 1e-5) {
 967                         size *= 1 / min (1 / xs, 1 / ys);
 968                 }
 969                 s.set_size (size);
 970
 971                 /* Then express aspect ratio changes */
 972                 if (fabs (1.0 - xs / ys) > dcp::ASPECT_ADJUST_EPSILON) {
 973                         s.set_aspect_adjust (xs / ys);
 974                 }
 975
 976                 s.set_in (dcp::Time(from.seconds(), 1000));
 977                 ps.string.push_back (StringText (s, text->outline_width()));
 978                 ps.add_fonts (text->fonts ());
 979         }
 980
 981         _active_texts[text->type()].add_from (wc, ps, from);
 982 }
 983
 984 void
 985 Player::subtitle_stop (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentTime to)
 986 {
 987         shared_ptr<const TextContent> text = wc.lock ();
 988         if (!text) {
 989                 return;
 990         }
 991
 992         if (!_active_texts[text->type()].have(wc)) {
 993                 return;
 994         }
 995
 996         shared_ptr<Piece> piece = wp.lock ();
 997         if (!piece) {
 998                 return;
 999         }
1000
1001         DCPTime const dcp_to = content_time_to_dcp (piece, to);
1002
1003         if (dcp_to > piece->content->end(_film)) {
1004                 return;
1005         }
1006
1007         pair<PlayerText, DCPTime> from = _active_texts[text->type()].add_to (wc, dcp_to);
1008
1009         bool const always = (text->type() == TEXT_OPEN_SUBTITLE && _always_burn_open_subtitles);
1010         if (text->use() && !always && !text->burn()) {
1011                 Text (from.first, text->type(), text->dcp_track().get_value_or(DCPTextTrack()), DCPTimePeriod (from.second, dcp_to));
1012         }
1013 }
1014
1015 void
1016 Player::seek (DCPTime time, bool accurate)
1017 {
1018         boost::mutex::scoped_lock lm (_mutex);
1019
1020         if (_suspended) {
1021                 /* We can't seek in this state */
1022                 return;
1023         }
1024
1025         if (_shuffler) {
1026                 _shuffler->clear ();
1027         }
1028
1029         _delay.clear ();
1030
1031         if (_audio_processor) {
1032                 _audio_processor->flush ();
1033         }
1034
1035         _audio_merger.clear ();
1036         for (int i = 0; i < TEXT_COUNT; ++i) {
1037                 _active_texts[i].clear ();
1038         }
1039
1040         BOOST_FOREACH (shared_ptr<Piece> i, _pieces) {
1041                 if (time < i->content->position()) {
1042                         /* Before; seek to the start of the content */
1043                         i->decoder->seek (dcp_to_content_time (i, i->content->position()), accurate);
1044                         i->done = false;
1045                 } else if (i->content->position() <= time && time < i->content->end(_film)) {
1046                         /* During; seek to position */
1047                         i->decoder->seek (dcp_to_content_time (i, time), accurate);
1048                         i->done = false;
1049                 } else {
1050                         /* After; this piece is done */
1051                         i->done = true;
1052                 }
1053         }
1054
1055         if (accurate) {
1056                 _last_video_time = time;
1057                 _last_video_eyes = EYES_LEFT;
1058                 _last_audio_time = time;
1059         } else {
1060                 _last_video_time = optional<DCPTime>();
1061                 _last_video_eyes = optional<Eyes>();
1062                 _last_audio_time = optional<DCPTime>();
1063         }
1064
1065         _black.set_position (time);
1066         _silent.set_position (time);
1067
1068         _last_video.clear ();
1069 }
1070
1071 void
1072 Player::emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1073 {
1074         /* We need a delay to give a little wiggle room to ensure that relevent subtitles arrive at the
1075            player before the video that requires them.
1076         */
1077         _delay.push_back (make_pair (pv, time));
1078
1079         if (pv->eyes() == EYES_BOTH || pv->eyes() == EYES_RIGHT) {
1080                 _last_video_time = time + one_video_frame();
1081         }
1082         _last_video_eyes = increment_eyes (pv->eyes());
1083
1084         if (_delay.size() < 3) {
1085                 return;
1086         }
1087
1088         pair<shared_ptr<PlayerVideo>, DCPTime> to_do = _delay.front();
1089         _delay.pop_front();
1090         do_emit_video (to_do.first, to_do.second);
1091 }
1092
1093 void
1094 Player::do_emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1095 {
1096         if (pv->eyes() == EYES_BOTH || pv->eyes() == EYES_RIGHT) {
1097                 for (int i = 0; i < TEXT_COUNT; ++i) {
1098                         _active_texts[i].clear_before (time);
1099                 }
1100         }
1101
1102         optional<PositionImage> subtitles = open_subtitles_for_frame (time);
1103         if (subtitles) {
1104                 pv->set_text (subtitles.get ());
1105         }
1106
1107         Video (pv, time);
1108 }
1109
1110 void
1111 Player::emit_audio (shared_ptr<AudioBuffers> data, DCPTime time)
1112 {
1113         /* Log if the assert below is about to fail */
1114         if (_last_audio_time && labs(time.get() - _last_audio_time->get()) > 1) {
1115                 _film->log()->log(String::compose("Out-of-sequence emit %1 vs %2", to_string(time), to_string(*_last_audio_time)), LogEntry::TYPE_WARNING);
1116         }
1117
1118         /* This audio must follow on from the previous, allowing for half a sample (at 48kHz) leeway */
1119         DCPOMATIC_ASSERT (!_last_audio_time || labs(time.get() - _last_audio_time->get()) < 2);
1120         Audio (data, time, _film->audio_frame_rate());
1121         _last_audio_time = time + DCPTime::from_frames (data->frames(), _film->audio_frame_rate());
1122 }
1123
1124 void
1125 Player::fill_audio (DCPTimePeriod period)
1126 {
1127         if (period.from == period.to) {
1128                 return;
1129         }
1130
1131         DCPOMATIC_ASSERT (period.from < period.to);
1132
1133         DCPTime t = period.from;
1134         while (t < period.to) {
1135                 DCPTime block = min (DCPTime::from_seconds (0.5), period.to - t);
1136                 Frame const samples = block.frames_round(_film->audio_frame_rate());
1137                 if (samples) {
1138                         shared_ptr<AudioBuffers> silence (new AudioBuffers (_film->audio_channels(), samples));
1139                         silence->make_silent ();
1140                         emit_audio (silence, t);
1141                 }
1142                 t += block;
1143         }
1144 }
1145
1146 DCPTime
1147 Player::one_video_frame () const
1148 {
1149         return DCPTime::from_frames (1, _film->video_frame_rate ());
1150 }
1151
1152 pair<shared_ptr<AudioBuffers>, DCPTime>
1153 Player::discard_audio (shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to) const
1154 {
1155         DCPTime const discard_time = discard_to - time;
1156         Frame const discard_frames = discard_time.frames_round(_film->audio_frame_rate());
1157         Frame remaining_frames = audio->frames() - discard_frames;
1158         if (remaining_frames <= 0) {
1159                 return make_pair(shared_ptr<AudioBuffers>(), DCPTime());
1160         }
1161         shared_ptr<AudioBuffers> cut (new AudioBuffers (audio->channels(), remaining_frames));
1162         cut->copy_from (audio.get(), remaining_frames, discard_frames, 0);
1163         return make_pair(cut, time + discard_time);
1164 }
1165
1166 void
1167 Player::set_dcp_decode_reduction (optional<int> reduction)
1168 {
1169         Change (CHANGE_TYPE_PENDING, PlayerProperty::DCP_DECODE_REDUCTION, false);
1170
1171         {
1172                 boost::mutex::scoped_lock lm (_mutex);
1173
1174                 if (reduction == _dcp_decode_reduction) {
1175                         lm.unlock ();
1176                         Change (CHANGE_TYPE_CANCELLED, PlayerProperty::DCP_DECODE_REDUCTION, false);
1177                         return;
1178                 }
1179
1180                 _dcp_decode_reduction = reduction;
1181                 setup_pieces_unlocked ();
1182         }
1183
1184         Change (CHANGE_TYPE_DONE, PlayerProperty::DCP_DECODE_REDUCTION, false);
1185 }
1186
1187 optional<DCPTime>
1188 Player::content_time_to_dcp (shared_ptr<Content> content, ContentTime t)
1189 {
1190         boost::mutex::scoped_lock lm (_mutex);
1191
1192         BOOST_FOREACH (shared_ptr<Piece> i, _pieces) {
1193                 if (i->content == content) {
1194                         return content_time_to_dcp (i, t);
1195                 }
1196         }
1197
1198         /* We couldn't find this content; perhaps things are being changed over */
1199         return optional<DCPTime>();
1200 }