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() + reel_trim_start);
 471         r->set_duration (r->duration() - reel_trim_start - reel_trim_end);
 472         if (r->duration() > 0) {
 473                 a.push_back (
 474                         ReferencedReelAsset(r, DCPTimePeriod(from, from + DCPTime::from_frames(r->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()->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()->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                            I think this is nothing to worry about since we will just add or
 639                            remove a little silence at the end of some content.
 640                         */
 641                         int64_t const error = labs(period.from.get() - _last_audio_time->get());
 642                         int64_t const too_much_error = 4;
 643                         if (error >= too_much_error) {
 644                                 _film->log()->log(String::compose("Silence starting before or after last audio by %1", error), LogEntry::TYPE_ERROR);
 645                         }
 646                         DCPOMATIC_ASSERT (error < too_much_error);
 647                         period.from = *_last_audio_time;
 648                 }
 649                 if (period.duration() > one_video_frame()) {
 650                         period.to = period.from + one_video_frame();
 651                 }
 652                 fill_audio (period);
 653                 _silent.set_position (period.to);
 654                 break;
 655         }
 656         case NONE:
 657                 done = true;
 658                 break;
 659         }
 660
 661         /* Emit any audio that is ready */
 662
 663         /* Work out the time before which the audio is definitely all here.  This is the earliest last_push_end of one
 664            of our streams, or the position of the _silent.
 665         */
 666         DCPTime pull_to = _film->length ();
 667         for (map<AudioStreamPtr, StreamState>::const_iterator i = _stream_states.begin(); i != _stream_states.end(); ++i) {
 668                 if (!i->second.piece->done && i->second.last_push_end < pull_to) {
 669                         pull_to = i->second.last_push_end;
 670                 }
 671         }
 672         if (!_silent.done() && _silent.position() < pull_to) {
 673                 pull_to = _silent.position();
 674         }
 675
 676         list<pair<shared_ptr<AudioBuffers>, DCPTime> > audio = _audio_merger.pull (pull_to);
 677         for (list<pair<shared_ptr<AudioBuffers>, DCPTime> >::iterator i = audio.begin(); i != audio.end(); ++i) {
 678                 if (_last_audio_time && i->second < *_last_audio_time) {
 679                         /* This new data comes before the last we emitted (or the last seek); discard it */
 680                         pair<shared_ptr<AudioBuffers>, DCPTime> cut = discard_audio (i->first, i->second, *_last_audio_time);
 681                         if (!cut.first) {
 682                                 continue;
 683                         }
 684                         *i = cut;
 685                 } else if (_last_audio_time && i->second > *_last_audio_time) {
 686                         /* There's a gap between this data and the last we emitted; fill with silence */
 687                         fill_audio (DCPTimePeriod (*_last_audio_time, i->second));
 688                 }
 689
 690                 emit_audio (i->first, i->second);
 691         }
 692
 693         if (done) {
 694                 _shuffler->flush ();
 695                 for (list<pair<shared_ptr<PlayerVideo>, DCPTime> >::const_iterator i = _delay.begin(); i != _delay.end(); ++i) {
 696                         do_emit_video(i->first, i->second);
 697                 }
 698         }
 699
 700         return done;
 701 }
 702
 703 /** @return Open subtitles for the frame at the given time, converted to images */
 704 optional<PositionImage>
 705 Player::open_subtitles_for_frame (DCPTime time) const
 706 {
 707         list<PositionImage> captions;
 708         int const vfr = _film->video_frame_rate();
 709
 710         BOOST_FOREACH (
 711                 PlayerText j,
 712                 _active_texts[TEXT_OPEN_SUBTITLE].get_burnt(DCPTimePeriod(time, time + DCPTime::from_frames(1, vfr)), _always_burn_open_subtitles)
 713                 ) {
 714
 715                 /* Bitmap subtitles */
 716                 BOOST_FOREACH (BitmapText i, j.bitmap) {
 717                         if (!i.image) {
 718                                 continue;
 719                         }
 720
 721                         /* i.image will already have been scaled to fit _video_container_size */
 722                         dcp::Size scaled_size (i.rectangle.width * _video_container_size.width, i.rectangle.height * _video_container_size.height);
 723
 724                         captions.push_back (
 725                                 PositionImage (
 726                                         i.image,
 727                                         Position<int> (
 728                                                 lrint (_video_container_size.width * i.rectangle.x),
 729                                                 lrint (_video_container_size.height * i.rectangle.y)
 730                                                 )
 731                                         )
 732                                 );
 733                 }
 734
 735                 /* String subtitles (rendered to an image) */
 736                 if (!j.string.empty ()) {
 737                         list<PositionImage> s = render_text (j.string, j.fonts, _video_container_size, time, vfr);
 738                         copy (s.begin(), s.end(), back_inserter (captions));
 739                 }
 740         }
 741
 742         if (captions.empty ()) {
 743                 return optional<PositionImage> ();
 744         }
 745
 746         return merge (captions);
 747 }
 748
 749 void
 750 Player::video (weak_ptr<Piece> wp, ContentVideo video)
 751 {
 752         shared_ptr<Piece> piece = wp.lock ();
 753         if (!piece) {
 754                 return;
 755         }
 756
 757         FrameRateChange frc (_film, piece->content);
 758         if (frc.skip && (video.frame % 2) == 1) {
 759                 return;
 760         }
 761
 762         /* Time of the first frame we will emit */
 763         DCPTime const time = content_video_to_dcp (piece, video.frame);
 764
 765         /* Discard if it's before the content's period or the last accurate seek.  We can't discard
 766            if it's after the content's period here as in that case we still need to fill any gap between
 767            `now' and the end of the content's period.
 768         */
 769         if (time < piece->content->position() || (_last_video_time && time < *_last_video_time)) {
 770                 return;
 771         }
 772
 773         /* Fill gaps that we discover now that we have some video which needs to be emitted.
 774            This is where we need to fill to.
 775         */
 776         DCPTime fill_to = min (time, piece->content->end(_film));
 777
 778         if (_last_video_time) {
 779                 DCPTime fill_from = max (*_last_video_time, piece->content->position());
 780
 781                 /* Fill if we have more than half a frame to do */
 782                 if ((fill_to - fill_from) > one_video_frame() / 2) {
 783                         LastVideoMap::const_iterator last = _last_video.find (wp);
 784                         if (_film->three_d()) {
 785                                 Eyes fill_to_eyes = video.eyes;
 786                                 if (fill_to_eyes == EYES_BOTH) {
 787                                         fill_to_eyes = EYES_LEFT;
 788                                 }
 789                                 if (fill_to == piece->content->end(_film)) {
 790                                         /* Don't fill after the end of the content */
 791                                         fill_to_eyes = EYES_LEFT;
 792                                 }
 793                                 DCPTime j = fill_from;
 794                                 Eyes eyes = _last_video_eyes.get_value_or(EYES_LEFT);
 795                                 if (eyes == EYES_BOTH) {
 796                                         eyes = EYES_LEFT;
 797                                 }
 798                                 while (j < fill_to || eyes != fill_to_eyes) {
 799                                         if (last != _last_video.end()) {
 800                                                 shared_ptr<PlayerVideo> copy = last->second->shallow_copy();
 801                                                 copy->set_eyes (eyes);
 802                                                 emit_video (copy, j);
 803                                         } else {
 804                                                 emit_video (black_player_video_frame(eyes), j);
 805                                         }
 806                                         if (eyes == EYES_RIGHT) {
 807                                                 j += one_video_frame();
 808                                         }
 809                                         eyes = increment_eyes (eyes);
 810                                 }
 811                         } else {
 812                                 for (DCPTime j = fill_from; j < fill_to; j += one_video_frame()) {
 813                                         if (last != _last_video.end()) {
 814                                                 emit_video (last->second, j);
 815                                         } else {
 816                                                 emit_video (black_player_video_frame(EYES_BOTH), j);
 817                                         }
 818                                 }
 819                         }
 820                 }
 821         }
 822
 823         _last_video[wp].reset (
 824                 new PlayerVideo (
 825                         video.image,
 826                         piece->content->video->crop (),
 827                         piece->content->video->fade (_film, video.frame),
 828                         piece->content->video->scale().size (
 829                                 piece->content->video, _video_container_size, _film->frame_size ()
 830                                 ),
 831                         _video_container_size,
 832                         video.eyes,
 833                         video.part,
 834                         piece->content->video->colour_conversion(),
 835                         piece->content,
 836                         video.frame
 837                         )
 838                 );
 839
 840         DCPTime t = time;
 841         for (int i = 0; i < frc.repeat; ++i) {
 842                 if (t < piece->content->end(_film)) {
 843                         emit_video (_last_video[wp], t);
 844                 }
 845                 t += one_video_frame ();
 846         }
 847 }
 848
 849 void
 850 Player::audio (weak_ptr<Piece> wp, AudioStreamPtr stream, ContentAudio content_audio)
 851 {
 852         DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
 853
 854         shared_ptr<Piece> piece = wp.lock ();
 855         if (!piece) {
 856                 return;
 857         }
 858
 859         shared_ptr<AudioContent> content = piece->content->audio;
 860         DCPOMATIC_ASSERT (content);
 861
 862         /* Compute time in the DCP */
 863         DCPTime time = resampled_audio_to_dcp (piece, content_audio.frame);
 864         /* And the end of this block in the DCP */
 865         DCPTime end = time + DCPTime::from_frames(content_audio.audio->frames(), content->resampled_frame_rate(_film));
 866
 867         /* Remove anything that comes before the start or after the end of the content */
 868         if (time < piece->content->position()) {
 869                 pair<shared_ptr<AudioBuffers>, DCPTime> cut = discard_audio (content_audio.audio, time, piece->content->position());
 870                 if (!cut.first) {
 871                         /* This audio is entirely discarded */
 872                         return;
 873                 }
 874                 content_audio.audio = cut.first;
 875                 time = cut.second;
 876         } else if (time > piece->content->end(_film)) {
 877                 /* Discard it all */
 878                 return;
 879         } else if (end > piece->content->end(_film)) {
 880                 Frame const remaining_frames = DCPTime(piece->content->end(_film) - time).frames_round(_film->audio_frame_rate());
 881                 if (remaining_frames == 0) {
 882                         return;
 883                 }
 884                 shared_ptr<AudioBuffers> cut (new AudioBuffers (content_audio.audio->channels(), remaining_frames));
 885                 cut->copy_from (content_audio.audio.get(), remaining_frames, 0, 0);
 886                 content_audio.audio = cut;
 887         }
 888
 889         DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
 890
 891         /* Gain */
 892
 893         if (content->gain() != 0) {
 894                 shared_ptr<AudioBuffers> gain (new AudioBuffers (content_audio.audio));
 895                 gain->apply_gain (content->gain ());
 896                 content_audio.audio = gain;
 897         }
 898
 899         /* Remap */
 900
 901         content_audio.audio = remap (content_audio.audio, _film->audio_channels(), stream->mapping());
 902
 903         /* Process */
 904
 905         if (_audio_processor) {
 906                 content_audio.audio = _audio_processor->run (content_audio.audio, _film->audio_channels ());
 907         }
 908
 909         /* Push */
 910
 911         _audio_merger.push (content_audio.audio, time);
 912         DCPOMATIC_ASSERT (_stream_states.find (stream) != _stream_states.end ());
 913         _stream_states[stream].last_push_end = time + DCPTime::from_frames (content_audio.audio->frames(), _film->audio_frame_rate());
 914 }
 915
 916 void
 917 Player::bitmap_text_start (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentBitmapText subtitle)
 918 {
 919         shared_ptr<Piece> piece = wp.lock ();
 920         shared_ptr<const TextContent> text = wc.lock ();
 921         if (!piece || !text) {
 922                 return;
 923         }
 924
 925         /* Apply content's subtitle offsets */
 926         subtitle.sub.rectangle.x += text->x_offset ();
 927         subtitle.sub.rectangle.y += text->y_offset ();
 928
 929         /* Apply a corrective translation to keep the subtitle centred after the scale that is coming up */
 930         subtitle.sub.rectangle.x -= subtitle.sub.rectangle.width * ((text->x_scale() - 1) / 2);
 931         subtitle.sub.rectangle.y -= subtitle.sub.rectangle.height * ((text->y_scale() - 1) / 2);
 932
 933         /* Apply content's subtitle scale */
 934         subtitle.sub.rectangle.width *= text->x_scale ();
 935         subtitle.sub.rectangle.height *= text->y_scale ();
 936
 937         PlayerText ps;
 938         shared_ptr<Image> image = subtitle.sub.image;
 939         /* We will scale the subtitle up to fit _video_container_size */
 940         dcp::Size scaled_size (subtitle.sub.rectangle.width * _video_container_size.width, subtitle.sub.rectangle.height * _video_container_size.height);
 941         ps.bitmap.push_back (BitmapText(image->scale(scaled_size, dcp::YUV_TO_RGB_REC601, image->pixel_format(), true, _fast), subtitle.sub.rectangle));
 942         DCPTime from (content_time_to_dcp (piece, subtitle.from()));
 943
 944         _active_texts[text->type()].add_from (wc, ps, from);
 945 }
 946
 947 void
 948 Player::plain_text_start (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentStringText subtitle)
 949 {
 950         shared_ptr<Piece> piece = wp.lock ();
 951         shared_ptr<const TextContent> text = wc.lock ();
 952         if (!piece || !text) {
 953                 return;
 954         }
 955
 956         PlayerText ps;
 957         DCPTime const from (content_time_to_dcp (piece, subtitle.from()));
 958
 959         if (from > piece->content->end(_film)) {
 960                 return;
 961         }
 962
 963         BOOST_FOREACH (dcp::SubtitleString s, subtitle.subs) {
 964                 s.set_h_position (s.h_position() + text->x_offset ());
 965                 s.set_v_position (s.v_position() + text->y_offset ());
 966                 float const xs = text->x_scale();
 967                 float const ys = text->y_scale();
 968                 float size = s.size();
 969
 970                 /* Adjust size to express the common part of the scaling;
 971                    e.g. if xs = ys = 0.5 we scale size by 2.
 972                 */
 973                 if (xs > 1e-5 && ys > 1e-5) {
 974                         size *= 1 / min (1 / xs, 1 / ys);
 975                 }
 976                 s.set_size (size);
 977
 978                 /* Then express aspect ratio changes */
 979                 if (fabs (1.0 - xs / ys) > dcp::ASPECT_ADJUST_EPSILON) {
 980                         s.set_aspect_adjust (xs / ys);
 981                 }
 982
 983                 s.set_in (dcp::Time(from.seconds(), 1000));
 984                 ps.string.push_back (StringText (s, text->outline_width()));
 985                 ps.add_fonts (text->fonts ());
 986         }
 987
 988         _active_texts[text->type()].add_from (wc, ps, from);
 989 }
 990
 991 void
 992 Player::subtitle_stop (weak_ptr<Piece> wp, weak_ptr<const TextContent> wc, ContentTime to)
 993 {
 994         shared_ptr<const TextContent> text = wc.lock ();
 995         if (!text) {
 996                 return;
 997         }
 998
 999         if (!_active_texts[text->type()].have(wc)) {
1000                 return;
1001         }
1002
1003         shared_ptr<Piece> piece = wp.lock ();
1004         if (!piece) {
1005                 return;
1006         }
1007
1008         DCPTime const dcp_to = content_time_to_dcp (piece, to);
1009
1010         if (dcp_to > piece->content->end(_film)) {
1011                 return;
1012         }
1013
1014         pair<PlayerText, DCPTime> from = _active_texts[text->type()].add_to (wc, dcp_to);
1015
1016         bool const always = (text->type() == TEXT_OPEN_SUBTITLE && _always_burn_open_subtitles);
1017         if (text->use() && !always && !text->burn()) {
1018                 Text (from.first, text->type(), text->dcp_track().get_value_or(DCPTextTrack()), DCPTimePeriod (from.second, dcp_to));
1019         }
1020 }
1021
1022 void
1023 Player::seek (DCPTime time, bool accurate)
1024 {
1025         boost::mutex::scoped_lock lm (_mutex);
1026
1027         if (_suspended) {
1028                 /* We can't seek in this state */
1029                 return;
1030         }
1031
1032         if (_shuffler) {
1033                 _shuffler->clear ();
1034         }
1035
1036         _delay.clear ();
1037
1038         if (_audio_processor) {
1039                 _audio_processor->flush ();
1040         }
1041
1042         _audio_merger.clear ();
1043         for (int i = 0; i < TEXT_COUNT; ++i) {
1044                 _active_texts[i].clear ();
1045         }
1046
1047         BOOST_FOREACH (shared_ptr<Piece> i, _pieces) {
1048                 if (time < i->content->position()) {
1049                         /* Before; seek to the start of the content */
1050                         i->decoder->seek (dcp_to_content_time (i, i->content->position()), accurate);
1051                         i->done = false;
1052                 } else if (i->content->position() <= time && time < i->content->end(_film)) {
1053                         /* During; seek to position */
1054                         i->decoder->seek (dcp_to_content_time (i, time), accurate);
1055                         i->done = false;
1056                 } else {
1057                         /* After; this piece is done */
1058                         i->done = true;
1059                 }
1060         }
1061
1062         if (accurate) {
1063                 _last_video_time = time;
1064                 _last_video_eyes = EYES_LEFT;
1065                 _last_audio_time = time;
1066         } else {
1067                 _last_video_time = optional<DCPTime>();
1068                 _last_video_eyes = optional<Eyes>();
1069                 _last_audio_time = optional<DCPTime>();
1070         }
1071
1072         _black.set_position (time);
1073         _silent.set_position (time);
1074
1075         _last_video.clear ();
1076 }
1077
1078 void
1079 Player::emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1080 {
1081         /* We need a delay to give a little wiggle room to ensure that relevent subtitles arrive at the
1082            player before the video that requires them.
1083         */
1084         _delay.push_back (make_pair (pv, time));
1085
1086         if (pv->eyes() == EYES_BOTH || pv->eyes() == EYES_RIGHT) {
1087                 _last_video_time = time + one_video_frame();
1088         }
1089         _last_video_eyes = increment_eyes (pv->eyes());
1090
1091         if (_delay.size() < 3) {
1092                 return;
1093         }
1094
1095         pair<shared_ptr<PlayerVideo>, DCPTime> to_do = _delay.front();
1096         _delay.pop_front();
1097         do_emit_video (to_do.first, to_do.second);
1098 }
1099
1100 void
1101 Player::do_emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1102 {
1103         if (pv->eyes() == EYES_BOTH || pv->eyes() == EYES_RIGHT) {
1104                 for (int i = 0; i < TEXT_COUNT; ++i) {
1105                         _active_texts[i].clear_before (time);
1106                 }
1107         }
1108
1109         optional<PositionImage> subtitles = open_subtitles_for_frame (time);
1110         if (subtitles) {
1111                 pv->set_text (subtitles.get ());
1112         }
1113
1114         Video (pv, time);
1115 }
1116
1117 void
1118 Player::emit_audio (shared_ptr<AudioBuffers> data, DCPTime time)
1119 {
1120         /* Log if the assert below is about to fail */
1121         if (_last_audio_time && labs(time.get() - _last_audio_time->get()) > 1) {
1122                 _film->log()->log(String::compose("Out-of-sequence emit %1 vs %2", to_string(time), to_string(*_last_audio_time)), LogEntry::TYPE_WARNING);
1123         }
1124
1125         /* This audio must follow on from the previous, allowing for half a sample (at 48kHz) leeway */
1126         DCPOMATIC_ASSERT (!_last_audio_time || labs(time.get() - _last_audio_time->get()) < 2);
1127         Audio (data, time, _film->audio_frame_rate());
1128         _last_audio_time = time + DCPTime::from_frames (data->frames(), _film->audio_frame_rate());
1129 }
1130
1131 void
1132 Player::fill_audio (DCPTimePeriod period)
1133 {
1134         if (period.from == period.to) {
1135                 return;
1136         }
1137
1138         DCPOMATIC_ASSERT (period.from < period.to);
1139
1140         DCPTime t = period.from;
1141         while (t < period.to) {
1142                 DCPTime block = min (DCPTime::from_seconds (0.5), period.to - t);
1143                 Frame const samples = block.frames_round(_film->audio_frame_rate());
1144                 if (samples) {
1145                         shared_ptr<AudioBuffers> silence (new AudioBuffers (_film->audio_channels(), samples));
1146                         silence->make_silent ();
1147                         emit_audio (silence, t);
1148                 }
1149                 t += block;
1150         }
1151 }
1152
1153 DCPTime
1154 Player::one_video_frame () const
1155 {
1156         return DCPTime::from_frames (1, _film->video_frame_rate ());
1157 }
1158
1159 pair<shared_ptr<AudioBuffers>, DCPTime>
1160 Player::discard_audio (shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to) const
1161 {
1162         DCPTime const discard_time = discard_to - time;
1163         Frame const discard_frames = discard_time.frames_round(_film->audio_frame_rate());
1164         Frame remaining_frames = audio->frames() - discard_frames;
1165         if (remaining_frames <= 0) {
1166                 return make_pair(shared_ptr<AudioBuffers>(), DCPTime());
1167         }
1168         shared_ptr<AudioBuffers> cut (new AudioBuffers (audio->channels(), remaining_frames));
1169         cut->copy_from (audio.get(), remaining_frames, discard_frames, 0);
1170         return make_pair(cut, time + discard_time);
1171 }
1172
1173 void
1174 Player::set_dcp_decode_reduction (optional<int> reduction)
1175 {
1176         Change (CHANGE_TYPE_PENDING, PlayerProperty::DCP_DECODE_REDUCTION, false);
1177
1178         {
1179                 boost::mutex::scoped_lock lm (_mutex);
1180
1181                 if (reduction == _dcp_decode_reduction) {
1182                         lm.unlock ();
1183                         Change (CHANGE_TYPE_CANCELLED, PlayerProperty::DCP_DECODE_REDUCTION, false);
1184                         return;
1185                 }
1186
1187                 _dcp_decode_reduction = reduction;
1188                 setup_pieces_unlocked ();
1189         }
1190
1191         Change (CHANGE_TYPE_DONE, PlayerProperty::DCP_DECODE_REDUCTION, false);
1192 }
1193
1194 optional<DCPTime>
1195 Player::content_time_to_dcp (shared_ptr<Content> content, ContentTime t)
1196 {
1197         boost::mutex::scoped_lock lm (_mutex);
1198
1199         BOOST_FOREACH (shared_ptr<Piece> i, _pieces) {
1200                 if (i->content == content) {
1201                         return content_time_to_dcp (i, t);
1202                 }
1203         }
1204
1205         /* We couldn't find this content; perhaps things are being changed over */
1206         return optional<DCPTime>();
1207 }