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         _suspended = false;
 235 }
 236
 237 void
 238 Player::playlist_content_change (ChangeType type, int property, bool frequent)
 239 {
 240         if (type == CHANGE_TYPE_PENDING) {
 241                 boost::mutex::scoped_lock lm (_mutex);
 242                 /* The player content is probably about to change, so we can't carry on
 243                    until that has happened and we've rebuilt our pieces.  Stop pass()
 244                    and seek() from working until then.
 245                 */
 246                 _suspended = true;
 247         } else if (type == CHANGE_TYPE_DONE) {
 248                 /* A change in our content has gone through.  Re-build our pieces. */
 249                 setup_pieces ();
 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 list<ReferencedReelAsset>
 467 Player::get_reel_assets ()
 468 {
 469         /* Does not require a lock on _mutex as it's only called from DCPEncoder */
 470
 471         list<ReferencedReelAsset> a;
 472
 473         BOOST_FOREACH (shared_ptr<Content> i, _playlist->content ()) {
 474                 shared_ptr<DCPContent> j = dynamic_pointer_cast<DCPContent> (i);
 475                 if (!j) {
 476                         continue;
 477                 }
 478
 479                 scoped_ptr<DCPDecoder> decoder;
 480                 try {
 481                         decoder.reset (new DCPDecoder (_film, j, false));
 482                 } catch (...) {
 483                         return a;
 484                 }
 485
 486                 int64_t offset = 0;
 487                 BOOST_FOREACH (shared_ptr<dcp::Reel> k, decoder->reels()) {
 488
 489                         DCPOMATIC_ASSERT (j->video_frame_rate ());
 490                         double const cfr = j->video_frame_rate().get();
 491                         Frame const trim_start = j->trim_start().frames_round (cfr);
 492                         Frame const trim_end = j->trim_end().frames_round (cfr);
 493                         int const ffr = _film->video_frame_rate ();
 494
 495                         DCPTime const from = i->position() + DCPTime::from_frames (offset, _film->video_frame_rate());
 496                         if (j->reference_video ()) {
 497                                 shared_ptr<dcp::ReelAsset> ra = k->main_picture ();
 498                                 DCPOMATIC_ASSERT (ra);
 499                                 ra->set_entry_point (ra->entry_point() + trim_start);
 500                                 ra->set_duration (ra->duration() - trim_start - trim_end);
 501                                 a.push_back (
 502                                         ReferencedReelAsset (ra, DCPTimePeriod (from, from + DCPTime::from_frames (ra->duration(), ffr)))
 503                                         );
 504                         }
 505
 506                         if (j->reference_audio ()) {
 507                                 shared_ptr<dcp::ReelAsset> ra = k->main_sound ();
 508                                 DCPOMATIC_ASSERT (ra);
 509                                 ra->set_entry_point (ra->entry_point() + trim_start);
 510                                 ra->set_duration (ra->duration() - trim_start - trim_end);
 511                                 a.push_back (
 512                                         ReferencedReelAsset (ra, DCPTimePeriod (from, from + DCPTime::from_frames (ra->duration(), ffr)))
 513                                         );
 514                         }
 515
 516                         if (j->reference_text (TEXT_OPEN_SUBTITLE)) {
 517                                 shared_ptr<dcp::ReelAsset> ra = k->main_subtitle ();
 518                                 DCPOMATIC_ASSERT (ra);
 519                                 ra->set_entry_point (ra->entry_point() + trim_start);
 520                                 ra->set_duration (ra->duration() - trim_start - trim_end);
 521                                 a.push_back (
 522                                         ReferencedReelAsset (ra, DCPTimePeriod (from, from + DCPTime::from_frames (ra->duration(), ffr)))
 523                                         );
 524                         }
 525
 526                         if (j->reference_text (TEXT_CLOSED_CAPTION)) {
 527                                 BOOST_FOREACH (shared_ptr<dcp::ReelClosedCaptionAsset> l, k->closed_captions()) {
 528                                         DCPOMATIC_ASSERT (l);
 529                                         l->set_entry_point (l->entry_point() + trim_start);
 530                                         l->set_duration (l->duration() - trim_start - trim_end);
 531                                         a.push_back (
 532                                                 ReferencedReelAsset (l, DCPTimePeriod (from, from + DCPTime::from_frames (l->duration(), ffr)))
 533                                                 );
 534                                 }
 535                         }
 536
 537                         /* Assume that main picture duration is the length of the reel */
 538                         offset += k->main_picture()->duration ();
 539                 }
 540         }
 541
 542         return a;
 543 }
 544
 545 bool
 546 Player::pass ()
 547 {
 548         boost::mutex::scoped_lock lm (_mutex);
 549
 550         if (_suspended) {
 551                 /* We can't pass in this state */
 552                 return false;
 553         }
 554
 555         if (_playlist->length(_film) == DCPTime()) {
 556                 /* Special case of an empty Film; just give one black frame */
 557                 emit_video (black_player_video_frame(EYES_BOTH), DCPTime());
 558                 return true;
 559         }
 560
 561         /* Find the decoder or empty which is farthest behind where we are and make it emit some data */
 562
 563         shared_ptr<Piece> earliest_content;
 564         optional<DCPTime> earliest_time;
 565
 566         BOOST_FOREACH (shared_ptr<Piece> i, _pieces) {
 567                 if (i->done) {
 568                         continue;
 569                 }
 570
 571                 DCPTime const t = content_time_to_dcp (i, max(i->decoder->position(), i->content->trim_start()));
 572                 if (t > i->content->end(_film)) {
 573                         i->done = true;
 574                 } else {
 575
 576                         /* Given two choices at the same time, pick the one with texts so we see it before
 577                            the video.
 578                         */
 579                         if (!earliest_time || t < *earliest_time || (t == *earliest_time && !i->decoder->text.empty())) {
 580                                 earliest_time = t;
 581                                 earliest_content = i;
 582                         }
 583                 }
 584         }
 585
 586         bool done = false;
 587
 588         enum {
 589                 NONE,
 590                 CONTENT,
 591                 BLACK,
 592                 SILENT
 593         } which = NONE;
 594
 595         if (earliest_content) {
 596                 which = CONTENT;
 597         }
 598
 599         if (!_black.done() && (!earliest_time || _black.position() < *earliest_time)) {
 600                 earliest_time = _black.position ();
 601                 which = BLACK;
 602         }
 603
 604         if (!_silent.done() && (!earliest_time || _silent.position() < *earliest_time)) {
 605                 earliest_time = _silent.position ();
 606                 which = SILENT;
 607         }
 608
 609         switch (which) {
 610         case CONTENT:
 611                 earliest_content->done = earliest_content->decoder->pass ();
 612                 break;
 613         case BLACK:
 614                 emit_video (black_player_video_frame(EYES_BOTH), _black.position());
 615                 _black.set_position (_black.position() + one_video_frame());
 616                 break;
 617         case SILENT:
 618         {
 619                 DCPTimePeriod period (_silent.period_at_position());
 620                 if (_last_audio_time) {
 621                         /* Sometimes the thing that happened last finishes fractionally before
 622                            or after this silence.  Bodge the start time of the silence to fix it.
 623                         */
 624                         DCPOMATIC_ASSERT (labs(period.from.get() - _last_audio_time->get()) < 2);
 625                         period.from = *_last_audio_time;
 626                 }
 627                 if (period.duration() > one_video_frame()) {
 628                         period.to = period.from + one_video_frame();
 629                 }
 630                 fill_audio (period);
 631                 _silent.set_position (period.to);
 632                 break;
 633         }
 634         case NONE:
 635                 done = true;
 636                 break;
 637         }
 638
 639         /* Emit any audio that is ready */
 640
 641         /* Work out the time before which the audio is definitely all here.  This is the earliest last_push_end of one
 642            of our streams, or the position of the _silent.
 643         */
 644         DCPTime pull_to = _film->length ();
 645         for (map<AudioStreamPtr, StreamState>::const_iterator i = _stream_states.begin(); i != _stream_states.end(); ++i) {
 646                 if (!i->second.piece->done && i->second.last_push_end < pull_to) {
 647                         pull_to = i->second.last_push_end;
 648                 }
 649         }
 650         if (!_silent.done() && _silent.position() < pull_to) {
 651                 pull_to = _silent.position();
 652         }
 653
 654         list<pair<shared_ptr<AudioBuffers>, DCPTime> > audio = _audio_merger.pull (pull_to);
 655         for (list<pair<shared_ptr<AudioBuffers>, DCPTime> >::iterator i = audio.begin(); i != audio.end(); ++i) {
 656                 if (_last_audio_time && i->second < *_last_audio_time) {
 657                         /* This new data comes before the last we emitted (or the last seek); discard it */
 658                         pair<shared_ptr<AudioBuffers>, DCPTime> cut = discard_audio (i->first, i->second, *_last_audio_time);
 659                         if (!cut.first) {
 660                                 continue;
 661                         }
 662                         *i = cut;
 663                 } else if (_last_audio_time && i->second > *_last_audio_time) {
 664                         /* There's a gap between this data and the last we emitted; fill with silence */
 665                         fill_audio (DCPTimePeriod (*_last_audio_time, i->second));
 666                 }
 667
 668                 emit_audio (i->first, i->second);
 669         }
 670
 671         if (done) {
 672                 _shuffler->flush ();
 673                 for (list<pair<shared_ptr<PlayerVideo>, DCPTime> >::const_iterator i = _delay.begin(); i != _delay.end(); ++i) {
 674                         do_emit_video(i->first, i->second);
 675                 }
 676         }
 677
 678         return done;
 679 }
 680
 681 /** @return Open subtitles for the frame at the given time, converted to images */
 682 optional<PositionImage>
 683 Player::open_subtitles_for_frame (DCPTime time) const
 684 {
 685         list<PositionImage> captions;
 686         int const vfr = _film->video_frame_rate();
 687
 688         BOOST_FOREACH (
 689                 PlayerText j,
 690                 _active_texts[TEXT_OPEN_SUBTITLE].get_burnt(DCPTimePeriod(time, time + DCPTime::from_frames(1, vfr)), _always_burn_open_subtitles)
 691                 ) {
 692
 693                 /* Bitmap subtitles */
 694                 BOOST_FOREACH (BitmapText i, j.bitmap) {
 695                         if (!i.image) {
 696                                 continue;
 697                         }
 698
 699                         /* i.image will already have been scaled to fit _video_container_size */
 700                         dcp::Size scaled_size (i.rectangle.width * _video_container_size.width, i.rectangle.height * _video_container_size.height);
 701
 702                         captions.push_back (
 703                                 PositionImage (
 704                                         i.image,
 705                                         Position<int> (
 706                                                 lrint (_video_container_size.width * i.rectangle.x),
 707                                                 lrint (_video_container_size.height * i.rectangle.y)
 708                                                 )
 709                                         )
 710                                 );
 711                 }
 712
 713                 /* String subtitles (rendered to an image) */
 714                 if (!j.string.empty ()) {
 715                         list<PositionImage> s = render_text (j.string, j.fonts, _video_container_size, time, vfr);
 716                         copy (s.begin(), s.end(), back_inserter (captions));
 717                 }
 718         }
 719
 720         if (captions.empty ()) {
 721                 return optional<PositionImage> ();
 722         }
 723
 724         return merge (captions);
 725 }
 726
 727 void
 728 Player::video (weak_ptr<Piece> wp, ContentVideo video)
 729 {
 730         shared_ptr<Piece> piece = wp.lock ();
 731         if (!piece) {
 732                 return;
 733         }
 734
 735         FrameRateChange frc (_film, piece->content);
 736         if (frc.skip && (video.frame % 2) == 1) {
 737                 return;
 738         }
 739
 740         /* Time of the first frame we will emit */
 741         DCPTime const time = content_video_to_dcp (piece, video.frame);
 742
 743         /* Discard if it's before the content's period or the last accurate seek.  We can't discard
 744            if it's after the content's period here as in that case we still need to fill any gap between
 745            `now' and the end of the content's period.
 746         */
 747         if (time < piece->content->position() || (_last_video_time && time < *_last_video_time)) {
 748                 return;
 749         }
 750
 751         /* Fill gaps that we discover now that we have some video which needs to be emitted.
 752            This is where we need to fill to.
 753         */
 754         DCPTime fill_to = min (time, piece->content->end(_film));
 755
 756         if (_last_video_time) {
 757                 DCPTime fill_from = max (*_last_video_time, piece->content->position());
 758
 759                 /* Fill if we have more than half a frame to do */
 760                 if ((fill_to - fill_from) > one_video_frame() / 2) {
 761                         LastVideoMap::const_iterator last = _last_video.find (wp);
 762                         if (_film->three_d()) {
 763                                 Eyes fill_to_eyes = video.eyes;
 764                                 if (fill_to_eyes == EYES_BOTH) {
 765                                         fill_to_eyes = EYES_LEFT;
 766                                 }
 767                                 if (fill_to == piece->content->end(_film)) {
 768                                         /* Don't fill after the end of the content */
 769                                         fill_to_eyes = EYES_LEFT;
 770                                 }
 771                                 DCPTime j = fill_from;
 772                                 Eyes eyes = _last_video_eyes.get_value_or(EYES_LEFT);
 773                                 if (eyes == EYES_BOTH) {
 774                                         eyes = EYES_LEFT;
 775                                 }
 776                                 while (j < fill_to || eyes != fill_to_eyes) {
 777                                         if (last != _last_video.end()) {
 778                                                 shared_ptr<PlayerVideo> copy = last->second->shallow_copy();
 779                                                 copy->set_eyes (eyes);
 780                                                 emit_video (copy, j);
 781                                         } else {
 782                                                 emit_video (black_player_video_frame(eyes), j);
 783                                         }
 784                                         if (eyes == EYES_RIGHT) {
 785                                                 j += one_video_frame();
 786                                         }
 787                                         eyes = increment_eyes (eyes);
 788                                 }
 789                         } else {
 790                                 for (DCPTime j = fill_from; j < fill_to; j += one_video_frame()) {
 791                                         if (last != _last_video.end()) {
 792                                                 emit_video (last->second, j);
 793                                         } else {
 794                                                 emit_video (black_player_video_frame(EYES_BOTH), j);
 795                                         }
 796                                 }
 797                         }
 798                 }
 799         }
 800
 801         _last_video[wp].reset (
 802                 new PlayerVideo (
 803                         video.image,
 804                         piece->content->video->crop (),
 805                         piece->content->video->fade (_film, video.frame),
 806                         piece->content->video->scale().size (
 807                                 piece->content->video, _video_container_size, _film->frame_size ()
 808                                 ),
 809                         _video_container_size,
 810                         video.eyes,
 811                         video.part,
 812                         piece->content->video->colour_conversion(),
 813                         piece->content,
 814                         video.frame
 815                         )
 816                 );
 817
 818         DCPTime t = time;
 819         for (int i = 0; i < frc.repeat; ++i) {
 820                 if (t < piece->content->end(_film)) {
 821                         emit_video (_last_video[wp], t);
 822                 }
 823                 t += one_video_frame ();
 824         }
 825 }
 826
 827 void
 828 Player::audio (weak_ptr<Piece> wp, AudioStreamPtr stream, ContentAudio content_audio)
 829 {
 830         DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
 831
 832         shared_ptr<Piece> piece = wp.lock ();
 833         if (!piece) {
 834                 return;
 835         }
 836
 837         shared_ptr<AudioContent> content = piece->content->audio;
 838         DCPOMATIC_ASSERT (content);
 839
 840         /* Compute time in the DCP */
 841         DCPTime time = resampled_audio_to_dcp (piece, content_audio.frame);
 842         /* And the end of this block in the DCP */
 843         DCPTime end = time + DCPTime::from_frames(content_audio.audio->frames(), content->resampled_frame_rate(_film));
 844
 845         /* Remove anything that comes before the start or after the end of the content */
 846         if (time < piece->content->position()) {
 847                 pair<shared_ptr<AudioBuffers>, DCPTime> cut = discard_audio (content_audio.audio, time, piece->content->position());
 848                 if (!cut.first) {
 849                         /* This audio is entirely discarded */
 850                         return;
 851                 }
 852                 content_audio.audio = cut.first;
 853                 time = cut.second;
 854         } else if (time > piece->content->end(_film)) {
 855                 /* Discard it all */
 856                 return;
 857         } else if (end > piece->content->end(_film)) {
 858                 Frame const remaining_frames = DCPTime(piece->content->end(_film) - time).frames_round(_film->audio_frame_rate());
 859                 if (remaining_frames == 0) {
 860                         return;
 861                 }
 862                 shared_ptr<AudioBuffers> cut (new AudioBuffers (content_audio.audio->channels(), remaining_frames));
 863                 cut->copy_from (content_audio.audio.get(), remaining_frames, 0, 0);
 864                 content_audio.audio = cut;
 865         }
 866
 867         DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
 868
 869         /* Gain */
 870
 871         if (content->gain() != 0) {
 872                 shared_ptr<AudioBuffers> gain (new AudioBuffers (content_audio.audio));
 873                 gain->apply_gain (content->gain ());
 874                 content_audio.audio = gain;
 875         }
 876
 877         /* Remap */
 878
 879         content_audio.audio = remap (content_audio.audio, _film->audio_channels(), stream->mapping());
 880
 881         /* Process */
 882
 883         if (_audio_processor) {
 884                 content_audio.audio = _audio_processor->run (content_audio.audio, _film->audio_channels ());
 885         }
 886
 887         /* Push */
 888
 889         _audio_merger.push (content_audio.audio, time);
 890         DCPOMATIC_ASSERT (_stream_states.find (stream) != _stream_states.end ());
 891         _stream_states[stream].last_push_end = time + DCPTime::from_frames (content_audio.audio->frames(), _film->audio_frame_rate());
 892 }
 893
 894 void
 895 Player::bitmap_text_start (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentBitmapText subtitle)
 896 {
 897         shared_ptr<Piece> piece = wp.lock ();
 898         shared_ptr<const TextContent> text = wc.lock ();
 899         if (!piece || !text) {
 900                 return;
 901         }
 902
 903         /* Apply content's subtitle offsets */
 904         subtitle.sub.rectangle.x += text->x_offset ();
 905         subtitle.sub.rectangle.y += text->y_offset ();
 906
 907         /* Apply a corrective translation to keep the subtitle centred after the scale that is coming up */
 908         subtitle.sub.rectangle.x -= subtitle.sub.rectangle.width * ((text->x_scale() - 1) / 2);
 909         subtitle.sub.rectangle.y -= subtitle.sub.rectangle.height * ((text->y_scale() - 1) / 2);
 910
 911         /* Apply content's subtitle scale */
 912         subtitle.sub.rectangle.width *= text->x_scale ();
 913         subtitle.sub.rectangle.height *= text->y_scale ();
 914
 915         PlayerText ps;
 916         shared_ptr<Image> image = subtitle.sub.image;
 917         /* We will scale the subtitle up to fit _video_container_size */
 918         dcp::Size scaled_size (subtitle.sub.rectangle.width * _video_container_size.width, subtitle.sub.rectangle.height * _video_container_size.height);
 919         ps.bitmap.push_back (BitmapText(image->scale(scaled_size, dcp::YUV_TO_RGB_REC601, image->pixel_format(), true, _fast), subtitle.sub.rectangle));
 920         DCPTime from (content_time_to_dcp (piece, subtitle.from()));
 921
 922         _active_texts[text->type()].add_from (wc, ps, from);
 923 }
 924
 925 void
 926 Player::plain_text_start (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentStringText subtitle)
 927 {
 928         shared_ptr<Piece> piece = wp.lock ();
 929         shared_ptr<const TextContent> text = wc.lock ();
 930         if (!piece || !text) {
 931                 return;
 932         }
 933
 934         PlayerText ps;
 935         DCPTime const from (content_time_to_dcp (piece, subtitle.from()));
 936
 937         if (from > piece->content->end(_film)) {
 938                 return;
 939         }
 940
 941         BOOST_FOREACH (dcp::SubtitleString s, subtitle.subs) {
 942                 s.set_h_position (s.h_position() + text->x_offset ());
 943                 s.set_v_position (s.v_position() + text->y_offset ());
 944                 float const xs = text->x_scale();
 945                 float const ys = text->y_scale();
 946                 float size = s.size();
 947
 948                 /* Adjust size to express the common part of the scaling;
 949                    e.g. if xs = ys = 0.5 we scale size by 2.
 950                 */
 951                 if (xs > 1e-5 && ys > 1e-5) {
 952                         size *= 1 / min (1 / xs, 1 / ys);
 953                 }
 954                 s.set_size (size);
 955
 956                 /* Then express aspect ratio changes */
 957                 if (fabs (1.0 - xs / ys) > dcp::ASPECT_ADJUST_EPSILON) {
 958                         s.set_aspect_adjust (xs / ys);
 959                 }
 960
 961                 s.set_in (dcp::Time(from.seconds(), 1000));
 962                 ps.string.push_back (StringText (s, text->outline_width()));
 963                 ps.add_fonts (text->fonts ());
 964         }
 965
 966         _active_texts[text->type()].add_from (wc, ps, from);
 967 }
 968
 969 void
 970 Player::subtitle_stop (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentTime to)
 971 {
 972         shared_ptr<const TextContent> text = wc.lock ();
 973         if (!text) {
 974                 return;
 975         }
 976
 977         if (!_active_texts[text->type()].have(wc)) {
 978                 return;
 979         }
 980
 981         shared_ptr<Piece> piece = wp.lock ();
 982         if (!piece) {
 983                 return;
 984         }
 985
 986         DCPTime const dcp_to = content_time_to_dcp (piece, to);
 987
 988         if (dcp_to > piece->content->end(_film)) {
 989                 return;
 990         }
 991
 992         pair<PlayerText, DCPTime> from = _active_texts[text->type()].add_to (wc, dcp_to);
 993
 994         bool const always = (text->type() == TEXT_OPEN_SUBTITLE && _always_burn_open_subtitles);
 995         if (text->use() && !always && !text->burn()) {
 996                 Text (from.first, text->type(), text->dcp_track().get_value_or(DCPTextTrack()), DCPTimePeriod (from.second, dcp_to));
 997         }
 998 }
 999
1000 void
1001 Player::seek (DCPTime time, bool accurate)
1002 {
1003         boost::mutex::scoped_lock lm (_mutex);
1004
1005         if (_suspended) {
1006                 /* We can't seek in this state */
1007                 return;
1008         }
1009
1010         if (_shuffler) {
1011                 _shuffler->clear ();
1012         }
1013
1014         _delay.clear ();
1015
1016         if (_audio_processor) {
1017                 _audio_processor->flush ();
1018         }
1019
1020         _audio_merger.clear ();
1021         for (int i = 0; i < TEXT_COUNT; ++i) {
1022                 _active_texts[i].clear ();
1023         }
1024
1025         BOOST_FOREACH (shared_ptr<Piece> i, _pieces) {
1026                 if (time < i->content->position()) {
1027                         /* Before; seek to the start of the content */
1028                         i->decoder->seek (dcp_to_content_time (i, i->content->position()), accurate);
1029                         i->done = false;
1030                 } else if (i->content->position() <= time && time < i->content->end(_film)) {
1031                         /* During; seek to position */
1032                         i->decoder->seek (dcp_to_content_time (i, time), accurate);
1033                         i->done = false;
1034                 } else {
1035                         /* After; this piece is done */
1036                         i->done = true;
1037                 }
1038         }
1039
1040         if (accurate) {
1041                 _last_video_time = time;
1042                 _last_video_eyes = EYES_LEFT;
1043                 _last_audio_time = time;
1044         } else {
1045                 _last_video_time = optional<DCPTime>();
1046                 _last_video_eyes = optional<Eyes>();
1047                 _last_audio_time = optional<DCPTime>();
1048         }
1049
1050         _black.set_position (time);
1051         _silent.set_position (time);
1052
1053         _last_video.clear ();
1054 }
1055
1056 void
1057 Player::emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1058 {
1059         /* We need a delay to give a little wiggle room to ensure that relevent subtitles arrive at the
1060            player before the video that requires them.
1061         */
1062         _delay.push_back (make_pair (pv, time));
1063
1064         if (pv->eyes() == EYES_BOTH || pv->eyes() == EYES_RIGHT) {
1065                 _last_video_time = time + one_video_frame();
1066         }
1067         _last_video_eyes = increment_eyes (pv->eyes());
1068
1069         if (_delay.size() < 3) {
1070                 return;
1071         }
1072
1073         pair<shared_ptr<PlayerVideo>, DCPTime> to_do = _delay.front();
1074         _delay.pop_front();
1075         do_emit_video (to_do.first, to_do.second);
1076 }
1077
1078 void
1079 Player::do_emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1080 {
1081         if (pv->eyes() == EYES_BOTH || pv->eyes() == EYES_RIGHT) {
1082                 for (int i = 0; i < TEXT_COUNT; ++i) {
1083                         _active_texts[i].clear_before (time);
1084                 }
1085         }
1086
1087         optional<PositionImage> subtitles = open_subtitles_for_frame (time);
1088         if (subtitles) {
1089                 pv->set_text (subtitles.get ());
1090         }
1091
1092         Video (pv, time);
1093 }
1094
1095 void
1096 Player::emit_audio (shared_ptr<AudioBuffers> data, DCPTime time)
1097 {
1098         /* Log if the assert below is about to fail */
1099         if (_last_audio_time && labs(time.get() - _last_audio_time->get()) > 1) {
1100                 _film->log()->log(String::compose("Out-of-sequence emit %1 vs %2", to_string(time), to_string(*_last_audio_time)), LogEntry::TYPE_WARNING);
1101         }
1102
1103         /* This audio must follow on from the previous, allowing for half a sample (at 48kHz) leeway */
1104         DCPOMATIC_ASSERT (!_last_audio_time || labs(time.get() - _last_audio_time->get()) < 2);
1105         Audio (data, time, _film->audio_frame_rate());
1106         _last_audio_time = time + DCPTime::from_frames (data->frames(), _film->audio_frame_rate());
1107 }
1108
1109 void
1110 Player::fill_audio (DCPTimePeriod period)
1111 {
1112         if (period.from == period.to) {
1113                 return;
1114         }
1115
1116         DCPOMATIC_ASSERT (period.from < period.to);
1117
1118         DCPTime t = period.from;
1119         while (t < period.to) {
1120                 DCPTime block = min (DCPTime::from_seconds (0.5), period.to - t);
1121                 Frame const samples = block.frames_round(_film->audio_frame_rate());
1122                 if (samples) {
1123                         shared_ptr<AudioBuffers> silence (new AudioBuffers (_film->audio_channels(), samples));
1124                         silence->make_silent ();
1125                         emit_audio (silence, t);
1126                 }
1127                 t += block;
1128         }
1129 }
1130
1131 DCPTime
1132 Player::one_video_frame () const
1133 {
1134         return DCPTime::from_frames (1, _film->video_frame_rate ());
1135 }
1136
1137 pair<shared_ptr<AudioBuffers>, DCPTime>
1138 Player::discard_audio (shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to) const
1139 {
1140         DCPTime const discard_time = discard_to - time;
1141         Frame const discard_frames = discard_time.frames_round(_film->audio_frame_rate());
1142         Frame remaining_frames = audio->frames() - discard_frames;
1143         if (remaining_frames <= 0) {
1144                 return make_pair(shared_ptr<AudioBuffers>(), DCPTime());
1145         }
1146         shared_ptr<AudioBuffers> cut (new AudioBuffers (audio->channels(), remaining_frames));
1147         cut->copy_from (audio.get(), remaining_frames, discard_frames, 0);
1148         return make_pair(cut, time + discard_time);
1149 }
1150
1151 void
1152 Player::set_dcp_decode_reduction (optional<int> reduction)
1153 {
1154         Change (CHANGE_TYPE_PENDING, PlayerProperty::DCP_DECODE_REDUCTION, false);
1155
1156         {
1157                 boost::mutex::scoped_lock lm (_mutex);
1158
1159                 if (reduction == _dcp_decode_reduction) {
1160                         lm.unlock ();
1161                         Change (CHANGE_TYPE_CANCELLED, PlayerProperty::DCP_DECODE_REDUCTION, false);
1162                         return;
1163                 }
1164
1165                 _dcp_decode_reduction = reduction;
1166                 setup_pieces_unlocked ();
1167         }
1168
1169         Change (CHANGE_TYPE_DONE, PlayerProperty::DCP_DECODE_REDUCTION, false);
1170 }
1171
1172 optional<DCPTime>
1173 Player::content_time_to_dcp (shared_ptr<Content> content, ContentTime t)
1174 {
1175         boost::mutex::scoped_lock lm (_mutex);
1176
1177         BOOST_FOREACH (shared_ptr<Piece> i, _pieces) {
1178                 if (i->content == content) {
1179                         return content_time_to_dcp (i, t);
1180                 }
1181         }
1182
1183         /* We couldn't find this content; perhaps things are being changed over */
1184         return optional<DCPTime>();
1185 }