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