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