src/lib/player.cc

   1 /*
   2     Copyright (C) 2013-2021 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
  22 #include "atmos_decoder.h"
  23 #include "audio_buffers.h"
  24 #include "audio_content.h"
  25 #include "audio_decoder.h"
  26 #include "audio_processor.h"
  27 #include "compose.hpp"
  28 #include "config.h"
  29 #include "content_audio.h"
  30 #include "content_video.h"
  31 #include "dcp_content.h"
  32 #include "dcp_decoder.h"
  33 #include "dcpomatic_log.h"
  34 #include "decoder.h"
  35 #include "decoder_factory.h"
  36 #include "ffmpeg_content.h"
  37 #include "film.h"
  38 #include "frame_rate_change.h"
  39 #include "image.h"
  40 #include "image_decoder.h"
  41 #include "job.h"
  42 #include "log.h"
  43 #include "maths_util.h"
  44 #include "piece.h"
  45 #include "player.h"
  46 #include "player_video.h"
  47 #include "playlist.h"
  48 #include "ratio.h"
  49 #include "raw_image_proxy.h"
  50 #include "render_text.h"
  51 #include "shuffler.h"
  52 #include "text_content.h"
  53 #include "text_decoder.h"
  54 #include "timer.h"
  55 #include "video_decoder.h"
  56 #include <dcp/reel.h>
  57 #include <dcp/reel_closed_caption_asset.h>
  58 #include <dcp/reel_picture_asset.h>
  59 #include <dcp/reel_sound_asset.h>
  60 #include <dcp/reel_subtitle_asset.h>
  61 #include <algorithm>
  62 #include <iostream>
  63 #include <stdint.h>
  64
  65 #include "i18n.h"
  66
  67
  68 using std::copy;
  69 using std::cout;
  70 using std::dynamic_pointer_cast;
  71 using std::list;
  72 using std::make_pair;
  73 using std::make_shared;
  74 using std::make_shared;
  75 using std::max;
  76 using std::min;
  77 using std::min;
  78 using std::pair;
  79 using std::shared_ptr;
  80 using std::vector;
  81 using std::weak_ptr;
  82 using boost::optional;
  83 using boost::scoped_ptr;
  84 #if BOOST_VERSION >= 106100
  85 using namespace boost::placeholders;
  86 #endif
  87 using namespace dcpomatic;
  88
  89
  90 int const PlayerProperty::VIDEO_CONTAINER_SIZE = 700;
  91 int const PlayerProperty::PLAYLIST = 701;
  92 int const PlayerProperty::FILM_CONTAINER = 702;
  93 int const PlayerProperty::FILM_VIDEO_FRAME_RATE = 703;
  94 int const PlayerProperty::DCP_DECODE_REDUCTION = 704;
  95 int const PlayerProperty::PLAYBACK_LENGTH = 705;
  96 int const PlayerProperty::IGNORE_VIDEO = 706;
  97 int const PlayerProperty::IGNORE_AUDIO = 707;
  98 int const PlayerProperty::IGNORE_TEXT = 708;
  99 int const PlayerProperty::ALWAYS_BURN_OPEN_SUBTITLES = 709;
 100 int const PlayerProperty::PLAY_REFERENCED = 710;
 101
 102
 103 Player::Player (shared_ptr<const Film> film, Image::Alignment subtitle_alignment)
 104         : _film (film)
 105         , _suspended (0)
 106         , _ignore_video(false)
 107         , _ignore_audio(false)
 108         , _ignore_text(false)
 109         , _always_burn_open_subtitles(false)
 110         , _fast(false)
 111         , _tolerant (film->tolerant())
 112         , _play_referenced(false)
 113         , _audio_merger(film->audio_frame_rate())
 114         , _subtitle_alignment (subtitle_alignment)
 115 {
 116         construct ();
 117 }
 118
 119
 120 Player::Player (shared_ptr<const Film> film, shared_ptr<const Playlist> playlist_)
 121         : _film (film)
 122         , _playlist (playlist_)
 123         , _suspended (0)
 124         , _ignore_video(false)
 125         , _ignore_audio(false)
 126         , _ignore_text(false)
 127         , _always_burn_open_subtitles(false)
 128         , _fast(false)
 129         , _tolerant (film->tolerant())
 130         , _play_referenced(false)
 131         , _audio_merger(film->audio_frame_rate())
 132 {
 133         construct ();
 134 }
 135
 136
 137 void
 138 Player::construct ()
 139 {
 140         auto film = _film.lock();
 141         DCPOMATIC_ASSERT(film);
 142
 143         connect();
 144         set_video_container_size(film->frame_size());
 145
 146         film_change(ChangeType::DONE, FilmProperty::AUDIO_PROCESSOR);
 147
 148         setup_pieces ();
 149         seek (DCPTime (), true);
 150 }
 151
 152
 153 void
 154 Player::connect()
 155 {
 156         auto film = _film.lock();
 157         DCPOMATIC_ASSERT(film);
 158
 159         _film_changed_connection = film->Change.connect(bind(&Player::film_change, this, _1, _2));
 160         /* The butler must hear about this first, so since we are proxying this through to the butler we must
 161            be first.
 162         */
 163         _playlist_change_connection = playlist()->Change.connect (bind (&Player::playlist_change, this, _1), boost::signals2::at_front);
 164         _playlist_content_change_connection = playlist()->ContentChange.connect (bind(&Player::playlist_content_change, this, _1, _3, _4));
 165 }
 166
 167
 168 Player::Player(Player&& other)
 169         : _film(other._film)
 170         , _playlist(std::move(other._playlist))
 171         , _suspended(other._suspended.load())
 172         , _pieces(std::move(other._pieces))
 173         , _video_container_size(other._video_container_size.load())
 174         , _black_image(std::move(other._black_image))
 175         , _ignore_video(other._ignore_video.load())
 176         , _ignore_audio(other._ignore_audio.load())
 177         , _ignore_text(other._ignore_text.load())
 178         , _always_burn_open_subtitles(other._always_burn_open_subtitles.load())
 179         , _fast(other._fast.load())
 180         , _tolerant(other._tolerant)
 181         , _play_referenced(other._play_referenced.load())
 182         , _next_video_time(other._next_video_time)
 183         , _next_audio_time(other._next_audio_time)
 184         , _dcp_decode_reduction(other._dcp_decode_reduction.load())
 185         , _last_video(std::move(other._last_video))
 186         , _audio_merger(std::move(other._audio_merger))
 187         , _shuffler(std::move(other._shuffler))
 188         , _delay(std::move(other._delay))
 189         , _stream_states(std::move(other._stream_states))
 190         , _black(std::move(other._black))
 191         , _silent(std::move(other._silent))
 192         , _active_texts(std::move(other._active_texts))
 193         , _audio_processor(std::move(other._audio_processor))
 194         , _disable_audio_processor(other._disable_audio_processor)
 195         , _playback_length(other._playback_length.load())
 196         , _subtitle_alignment(other._subtitle_alignment)
 197 {
 198         connect();
 199 }
 200
 201
 202 Player&
 203 Player::operator=(Player&& other)
 204 {
 205         if (this == &other) {
 206                 return *this;
 207         }
 208
 209         _film = std::move(other._film);
 210         _playlist = std::move(other._playlist);
 211         _suspended = other._suspended.load();
 212         _pieces = std::move(other._pieces);
 213         _video_container_size = other._video_container_size.load();
 214         _black_image = std::move(other._black_image);
 215         _ignore_video = other._ignore_video.load();
 216         _ignore_audio = other._ignore_audio.load();
 217         _ignore_text = other._ignore_text.load();
 218         _always_burn_open_subtitles = other._always_burn_open_subtitles.load();
 219         _fast = other._fast.load();
 220         _tolerant = other._tolerant;
 221         _play_referenced = other._play_referenced.load();
 222         _next_video_time = other._next_video_time;
 223         _next_audio_time = other._next_audio_time;
 224         _dcp_decode_reduction = other._dcp_decode_reduction.load();
 225         _last_video = std::move(other._last_video);
 226         _audio_merger = std::move(other._audio_merger);
 227         _shuffler = std::move(other._shuffler);
 228         _delay = std::move(other._delay);
 229         _stream_states = std::move(other._stream_states);
 230         _black = std::move(other._black);
 231         _silent = std::move(other._silent);
 232         _active_texts = std::move(other._active_texts);
 233         _audio_processor = std::move(other._audio_processor);
 234         _disable_audio_processor = other._disable_audio_processor;
 235         _playback_length = other._playback_length.load();
 236         _subtitle_alignment = other._subtitle_alignment;
 237
 238         connect();
 239
 240         return *this;
 241 }
 242
 243
 244 bool
 245 have_video (shared_ptr<const Content> content)
 246 {
 247         return static_cast<bool>(content->video) && content->video->use() && content->can_be_played();
 248 }
 249
 250
 251 bool
 252 have_audio (shared_ptr<const Content> content)
 253 {
 254         return static_cast<bool>(content->audio) && content->can_be_played();
 255 }
 256
 257
 258 void
 259 Player::setup_pieces ()
 260 {
 261         boost::mutex::scoped_lock lm (_mutex);
 262
 263         auto old_pieces = _pieces;
 264         _pieces.clear ();
 265
 266         auto film = _film.lock();
 267         if (!film) {
 268                 return;
 269         }
 270
 271         _playback_length = _playlist ? _playlist->length(film) : film->length();
 272
 273         auto playlist_content = playlist()->content();
 274         bool const have_threed = std::any_of(
 275                 playlist_content.begin(),
 276                 playlist_content.end(),
 277                 [](shared_ptr<const Content> c) {
 278                         return c->video && (c->video->frame_type() == VideoFrameType::THREE_D_LEFT || c->video->frame_type() == VideoFrameType::THREE_D_RIGHT);
 279                 });
 280
 281
 282         if (have_threed) {
 283                 _shuffler.reset(new Shuffler());
 284                 _shuffler->Video.connect(bind(&Player::video, this, _1, _2));
 285         }
 286
 287         for (auto content: playlist()->content()) {
 288
 289                 if (!content->paths_valid()) {
 290                         continue;
 291                 }
 292
 293                 if (_ignore_video && _ignore_audio && content->text.empty()) {
 294                         /* We're only interested in text and this content has none */
 295                         continue;
 296                 }
 297
 298                 shared_ptr<Decoder> old_decoder;
 299                 for (auto j: old_pieces) {
 300                         if (j->content == content) {
 301                                 old_decoder = j->decoder;
 302                                 break;
 303                         }
 304                 }
 305
 306                 auto decoder = decoder_factory(film, content, _fast, _tolerant, old_decoder);
 307                 DCPOMATIC_ASSERT (decoder);
 308
 309                 FrameRateChange frc(film, content);
 310
 311                 if (decoder->video && _ignore_video) {
 312                         decoder->video->set_ignore (true);
 313                 }
 314
 315                 if (decoder->audio && _ignore_audio) {
 316                         decoder->audio->set_ignore (true);
 317                 }
 318
 319                 if (_ignore_text) {
 320                         for (auto i: decoder->text) {
 321                                 i->set_ignore (true);
 322                         }
 323                 }
 324
 325                 auto dcp = dynamic_pointer_cast<DCPDecoder> (decoder);
 326                 if (dcp) {
 327                         dcp->set_decode_referenced (_play_referenced);
 328                         if (_play_referenced) {
 329                                 dcp->set_forced_reduction (_dcp_decode_reduction);
 330                         }
 331                 }
 332
 333                 auto piece = make_shared<Piece>(content, decoder, frc);
 334                 _pieces.push_back (piece);
 335
 336                 if (decoder->video) {
 337                         if (have_threed) {
 338                                 /* We need a Shuffler to cope with 3D L/R video data arriving out of sequence */
 339                                 decoder->video->Data.connect (bind(&Shuffler::video, _shuffler.get(), weak_ptr<Piece>(piece), _1));
 340                         } else {
 341                                 decoder->video->Data.connect (bind(&Player::video, this, weak_ptr<Piece>(piece), _1));
 342                         }
 343                 }
 344
 345                 if (decoder->audio) {
 346                         decoder->audio->Data.connect (bind (&Player::audio, this, weak_ptr<Piece> (piece), _1, _2));
 347                 }
 348
 349                 auto j = decoder->text.begin();
 350
 351                 while (j != decoder->text.end()) {
 352                         (*j)->BitmapStart.connect (
 353                                 bind(&Player::bitmap_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
 354                                 );
 355                         (*j)->PlainStart.connect (
 356                                 bind(&Player::plain_text_start, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
 357                                 );
 358                         (*j)->Stop.connect (
 359                                 bind(&Player::subtitle_stop, this, weak_ptr<Piece>(piece), weak_ptr<const TextContent>((*j)->content()), _1)
 360                                 );
 361
 362                         ++j;
 363                 }
 364
 365                 if (decoder->atmos) {
 366                         decoder->atmos->Data.connect (bind(&Player::atmos, this, weak_ptr<Piece>(piece), _1));
 367                 }
 368         }
 369
 370         _stream_states.clear ();
 371         for (auto i: _pieces) {
 372                 if (i->content->audio) {
 373                         for (auto j: i->content->audio->streams()) {
 374                                 _stream_states[j] = StreamState(i);
 375                         }
 376                 }
 377         }
 378
 379         auto ignore_overlap = [](shared_ptr<VideoContent> v) {
 380                 return v && v->use() && v->frame_type() != VideoFrameType::THREE_D_LEFT && v->frame_type() != VideoFrameType::THREE_D_RIGHT;
 381         };
 382
 383         for (auto piece = _pieces.begin(); piece != _pieces.end(); ++piece) {
 384                 if (ignore_overlap((*piece)->content->video)) {
 385                         /* Look for content later in the content list with in-use video that overlaps this */
 386                         auto const period = (*piece)->content->period(film);
 387                         for (auto later_piece = std::next(piece); later_piece != _pieces.end(); ++later_piece) {
 388                                 if (ignore_overlap((*later_piece)->content->video)) {
 389                                         if (auto overlap = (*later_piece)->content->period(film).overlap(period)) {
 390                                                 (*piece)->ignore_video.push_back(*overlap);
 391                                         }
 392                                 }
 393                         }
 394                 }
 395         }
 396
 397         for (auto piece = _pieces.begin(); piece != _pieces.end(); ++piece) {
 398                 if ((*piece)->content->atmos) {
 399                         /* Look for content later in the content list with ATMOS that overlaps this */
 400                         auto const period = (*piece)->content->period(film);
 401                         for (auto later_piece = std::next(piece); later_piece != _pieces.end(); ++later_piece) {
 402                                 if ((*later_piece)->content->atmos) {
 403                                         if (auto overlap = (*later_piece)->content->period(film).overlap(period)) {
 404                                                 (*piece)->ignore_atmos.push_back(*overlap);
 405                                         }
 406                                 }
 407                         }
 408                 }
 409         }
 410
 411         _black = Empty(film, playlist(), bind(&have_video, _1), _playback_length);
 412         _silent = Empty(film, playlist(), bind(&have_audio, _1), _playback_length);
 413
 414         _next_video_time = boost::none;
 415         _next_video_eyes = Eyes::BOTH;
 416         _next_audio_time = boost::none;
 417 }
 418
 419
 420 void
 421 Player::playlist_content_change (ChangeType type, int property, bool frequent)
 422 {
 423         auto film = _film.lock();
 424         if (!film) {
 425                 return;
 426         }
 427
 428         if (property == VideoContentProperty::CROP) {
 429                 if (type == ChangeType::DONE) {
 430                         boost::mutex::scoped_lock lm (_mutex);
 431                         for (auto const& i: _delay) {
 432                                 i.first->reset_metadata(film, _video_container_size);
 433                         }
 434                 }
 435         } else {
 436                 if (type == ChangeType::PENDING) {
 437                         /* The player content is probably about to change, so we can't carry on
 438                            until that has happened and we've rebuilt our pieces.  Stop pass()
 439                            and seek() from working until then.
 440                         */
 441                         ++_suspended;
 442                 } else if (type == ChangeType::DONE) {
 443                         /* A change in our content has gone through.  Re-build our pieces. */
 444                         setup_pieces ();
 445                         --_suspended;
 446                 } else if (type == ChangeType::CANCELLED) {
 447                         --_suspended;
 448                 }
 449         }
 450
 451         Change (type, property, frequent);
 452 }
 453
 454
 455 void
 456 Player::set_video_container_size (dcp::Size s)
 457 {
 458         ChangeSignaller<Player, int> cc(this, PlayerProperty::VIDEO_CONTAINER_SIZE);
 459
 460         if (s == _video_container_size) {
 461                 cc.abort();
 462                 return;
 463         }
 464
 465         _video_container_size = s;
 466
 467         {
 468                 boost::mutex::scoped_lock lm(_black_image_mutex);
 469                 _black_image = make_shared<Image>(AV_PIX_FMT_RGB24, _video_container_size, Image::Alignment::PADDED);
 470                 _black_image->make_black ();
 471         }
 472 }
 473
 474
 475 void
 476 Player::playlist_change (ChangeType type)
 477 {
 478         if (type == ChangeType::DONE) {
 479                 setup_pieces ();
 480         }
 481         Change (type, PlayerProperty::PLAYLIST, false);
 482 }
 483
 484
 485 void
 486 Player::film_change(ChangeType type, FilmProperty p)
 487 {
 488         /* Here we should notice Film properties that affect our output, and
 489            alert listeners that our output now would be different to how it was
 490            last time we were run.
 491         */
 492
 493         auto film = _film.lock();
 494         if (!film) {
 495                 return;
 496         }
 497
 498         if (p == FilmProperty::CONTAINER) {
 499                 Change (type, PlayerProperty::FILM_CONTAINER, false);
 500         } else if (p == FilmProperty::VIDEO_FRAME_RATE) {
 501                 /* Pieces contain a FrameRateChange which contains the DCP frame rate,
 502                    so we need new pieces here.
 503                 */
 504                 if (type == ChangeType::DONE) {
 505                         setup_pieces ();
 506                 }
 507                 Change (type, PlayerProperty::FILM_VIDEO_FRAME_RATE, false);
 508         } else if (p == FilmProperty::AUDIO_PROCESSOR) {
 509                 if (type == ChangeType::DONE && film->audio_processor ()) {
 510                         boost::mutex::scoped_lock lm (_mutex);
 511                         _audio_processor = film->audio_processor()->clone(film->audio_frame_rate());
 512                 }
 513         } else if (p == FilmProperty::AUDIO_CHANNELS) {
 514                 if (type == ChangeType::DONE) {
 515                         boost::mutex::scoped_lock lm (_mutex);
 516                         _audio_merger.clear ();
 517                 }
 518         }
 519 }
 520
 521
 522 shared_ptr<PlayerVideo>
 523 Player::black_player_video_frame (Eyes eyes) const
 524 {
 525         boost::mutex::scoped_lock lm(_black_image_mutex);
 526
 527         return std::make_shared<PlayerVideo> (
 528                 std::make_shared<const RawImageProxy>(_black_image),
 529                 Crop(),
 530                 optional<double>(),
 531                 _video_container_size,
 532                 _video_container_size,
 533                 eyes,
 534                 Part::WHOLE,
 535                 PresetColourConversion::all().front().conversion,
 536                 VideoRange::FULL,
 537                 std::weak_ptr<Content>(),
 538                 boost::optional<Frame>(),
 539                 false
 540         );
 541 }
 542
 543
 544 Frame
 545 Player::dcp_to_content_video (shared_ptr<const Piece> piece, DCPTime t) const
 546 {
 547         auto film = _film.lock();
 548         DCPOMATIC_ASSERT(film);
 549
 550         auto s = t - piece->content->position ();
 551         s = min (piece->content->length_after_trim(film), s);
 552         s = max (DCPTime(), s + DCPTime (piece->content->trim_start(), piece->frc));
 553
 554         /* It might seem more logical here to convert s to a ContentTime (using the FrameRateChange)
 555            then convert that ContentTime to frames at the content's rate.  However this fails for
 556            situations like content at 29.9978733fps, DCP at 30fps.  The accuracy of the Time type is not
 557            enough to distinguish between the two with low values of time (e.g. 3200 in Time units).
 558
 559            Instead we convert the DCPTime using the DCP video rate then account for any skip/repeat.
 560         */
 561         return s.frames_floor (piece->frc.dcp) / piece->frc.factor ();
 562 }
 563
 564
 565 DCPTime
 566 Player::content_video_to_dcp (shared_ptr<const Piece> piece, Frame f) const
 567 {
 568         /* See comment in dcp_to_content_video */
 569         auto const d = DCPTime::from_frames (f * piece->frc.factor(), piece->frc.dcp) - DCPTime(piece->content->trim_start(), piece->frc);
 570         return d + piece->content->position();
 571 }
 572
 573
 574 Frame
 575 Player::dcp_to_resampled_audio (shared_ptr<const Piece> piece, DCPTime t) const
 576 {
 577         auto film = _film.lock();
 578         DCPOMATIC_ASSERT(film);
 579
 580         auto s = t - piece->content->position ();
 581         s = min (piece->content->length_after_trim(film), s);
 582         /* See notes in dcp_to_content_video */
 583         return max (DCPTime(), DCPTime(piece->content->trim_start(), piece->frc) + s).frames_floor(film->audio_frame_rate());
 584 }
 585
 586
 587 DCPTime
 588 Player::resampled_audio_to_dcp (shared_ptr<const Piece> piece, Frame f) const
 589 {
 590         auto film = _film.lock();
 591         DCPOMATIC_ASSERT(film);
 592
 593         /* See comment in dcp_to_content_video */
 594         return DCPTime::from_frames(f, film->audio_frame_rate())
 595                 - DCPTime (piece->content->trim_start(), piece->frc)
 596                 + piece->content->position();
 597 }
 598
 599
 600 ContentTime
 601 Player::dcp_to_content_time (shared_ptr<const Piece> piece, DCPTime t) const
 602 {
 603         auto film = _film.lock();
 604         DCPOMATIC_ASSERT(film);
 605
 606         auto s = t - piece->content->position ();
 607         s = min (piece->content->length_after_trim(film), s);
 608         return max (ContentTime (), ContentTime (s, piece->frc) + piece->content->trim_start());
 609 }
 610
 611
 612 DCPTime
 613 Player::content_time_to_dcp (shared_ptr<const Piece> piece, ContentTime t) const
 614 {
 615         return max (DCPTime(), DCPTime(t - piece->content->trim_start(), piece->frc) + piece->content->position());
 616 }
 617
 618
 619 vector<shared_ptr<Font>>
 620 Player::get_subtitle_fonts ()
 621 {
 622         boost::mutex::scoped_lock lm (_mutex);
 623
 624         vector<shared_ptr<Font>> fonts;
 625         for (auto piece: _pieces) {
 626                 for (auto text: piece->content->text) {
 627                         auto text_fonts = text->fonts();
 628                         copy (text_fonts.begin(), text_fonts.end(), back_inserter(fonts));
 629                 }
 630         }
 631
 632         return fonts;
 633 }
 634
 635
 636 /** Set this player never to produce any video data */
 637 void
 638 Player::set_ignore_video ()
 639 {
 640         ChangeSignaller<Player, int> cc(this, PlayerProperty::IGNORE_VIDEO);
 641         _ignore_video = true;
 642         setup_pieces();
 643 }
 644
 645
 646 void
 647 Player::set_ignore_audio ()
 648 {
 649         ChangeSignaller<Player, int> cc(this, PlayerProperty::IGNORE_AUDIO);
 650         _ignore_audio = true;
 651         setup_pieces();
 652 }
 653
 654
 655 void
 656 Player::set_ignore_text ()
 657 {
 658         ChangeSignaller<Player, int> cc(this, PlayerProperty::IGNORE_TEXT);
 659         _ignore_text = true;
 660         setup_pieces();
 661 }
 662
 663
 664 /** Set the player to always burn open texts into the image regardless of the content settings */
 665 void
 666 Player::set_always_burn_open_subtitles ()
 667 {
 668         ChangeSignaller<Player, int> cc(this, PlayerProperty::ALWAYS_BURN_OPEN_SUBTITLES);
 669         _always_burn_open_subtitles = true;
 670 }
 671
 672
 673 /** Sets up the player to be faster, possibly at the expense of quality */
 674 void
 675 Player::set_fast ()
 676 {
 677         _fast = true;
 678         setup_pieces();
 679 }
 680
 681
 682 void
 683 Player::set_play_referenced ()
 684 {
 685         ChangeSignaller<Player, int> cc(this, PlayerProperty::PLAY_REFERENCED);
 686         _play_referenced = true;
 687         setup_pieces();
 688 }
 689
 690
 691 pair<shared_ptr<Piece>, optional<DCPTime>>
 692 Player::earliest_piece_and_time() const
 693 {
 694         auto film = _film.lock();
 695         DCPOMATIC_ASSERT(film);
 696
 697         shared_ptr<Piece> earliest_content;
 698         optional<DCPTime> earliest_time;
 699
 700         for (auto const& piece: _pieces) {
 701                 if (piece->done) {
 702                         continue;
 703                 }
 704
 705                 auto const t = content_time_to_dcp(piece, max(piece->decoder->position(), piece->content->trim_start()));
 706                 if (t > piece->content->end(film)) {
 707                         piece->done = true;
 708                 } else {
 709
 710                         /* Given two choices at the same time, pick the one with texts so we see it before
 711                            the video.
 712                         */
 713                         if (!earliest_time || t < *earliest_time || (t == *earliest_time && !piece->decoder->text.empty())) {
 714                                 earliest_time = t;
 715                                 earliest_content = piece;
 716                         }
 717                 }
 718         }
 719
 720         return { earliest_content, earliest_time };
 721 }
 722
 723
 724 bool
 725 Player::pass ()
 726 {
 727         boost::mutex::scoped_lock lm (_mutex);
 728
 729         if (_suspended) {
 730                 /* We can't pass in this state */
 731                 LOG_DEBUG_PLAYER_NC ("Player is suspended");
 732                 return false;
 733         }
 734
 735         auto film = _film.lock();
 736
 737         if (_playback_length.load() == DCPTime() || !film) {
 738                 /* Special; just give one black frame */
 739                 emit_video (black_player_video_frame(Eyes::BOTH), DCPTime());
 740                 return true;
 741         }
 742
 743         /* Find the decoder or empty which is farthest behind where we are and make it emit some data */
 744
 745         shared_ptr<Piece> earliest_content;
 746         optional<DCPTime> earliest_time;
 747         std::tie(earliest_content, earliest_time) = earliest_piece_and_time();
 748
 749         bool done = false;
 750
 751         enum {
 752                 NONE,
 753                 CONTENT,
 754                 BLACK,
 755                 SILENT
 756         } which = NONE;
 757
 758         if (earliest_content) {
 759                 which = CONTENT;
 760         }
 761
 762         if (!_black.done() && !_ignore_video && (!earliest_time || _black.position() < *earliest_time)) {
 763                 earliest_time = _black.position ();
 764                 which = BLACK;
 765         }
 766
 767         if (!_silent.done() && !_ignore_audio && (!earliest_time || _silent.position() < *earliest_time)) {
 768                 earliest_time = _silent.position ();
 769                 which = SILENT;
 770         }
 771
 772         switch (which) {
 773         case CONTENT:
 774         {
 775                 LOG_DEBUG_PLAYER ("Calling pass() on %1", earliest_content->content->path(0));
 776                 earliest_content->done = earliest_content->decoder->pass ();
 777                 auto dcp = dynamic_pointer_cast<DCPContent>(earliest_content->content);
 778                 if (dcp && !_play_referenced && dcp->reference_audio()) {
 779                         /* We are skipping some referenced DCP audio content, so we need to update _next_audio_time
 780                            to `hide' the fact that no audio was emitted during the referenced DCP (though
 781                            we need to behave as though it was).
 782                         */
 783                         _next_audio_time = dcp->end(film);
 784                 }
 785                 break;
 786         }
 787         case BLACK:
 788                 LOG_DEBUG_PLAYER ("Emit black for gap at %1", to_string(_black.position()));
 789                 if (film->three_d()) {
 790                         emit_video(black_player_video_frame(Eyes::LEFT), _black.position());
 791                         emit_video(black_player_video_frame(Eyes::RIGHT), _black.position());
 792                 } else {
 793                         emit_video(black_player_video_frame(Eyes::BOTH), _black.position());
 794                 }
 795                 _black.set_position (_black.position() + one_video_frame());
 796                 break;
 797         case SILENT:
 798         {
 799                 LOG_DEBUG_PLAYER ("Emit silence for gap at %1", to_string(_silent.position()));
 800                 DCPTimePeriod period (_silent.period_at_position());
 801                 if (_next_audio_time) {
 802                         /* Sometimes the thing that happened last finishes fractionally before
 803                            or after this silence.  Bodge the start time of the silence to fix it.
 804                            I think this is nothing to worry about since we will just add or
 805                            remove a little silence at the end of some content.
 806                         */
 807                         int64_t const error = labs(period.from.get() - _next_audio_time->get());
 808                         /* Let's not worry about less than a frame at 24fps */
 809                         int64_t const too_much_error = DCPTime::from_frames(1, 24).get();
 810                         if (error >= too_much_error) {
 811                                 film->log()->log(String::compose("Silence starting before or after last audio by %1", error), LogEntry::TYPE_ERROR);
 812                         }
 813                         DCPOMATIC_ASSERT (error < too_much_error);
 814                         period.from = *_next_audio_time;
 815                 }
 816                 if (period.duration() > one_video_frame()) {
 817                         period.to = period.from + one_video_frame();
 818                 }
 819                 fill_audio (period);
 820                 _silent.set_position (period.to);
 821                 break;
 822         }
 823         case NONE:
 824                 done = true;
 825                 break;
 826         }
 827
 828         /* Emit any audio that is ready */
 829
 830         /* Work out the time before which the audio is definitely all here.  This is the earliest last_push_end of one
 831            of our streams, or the position of the _silent.  First, though we choose only streams that are less than
 832            ignore_streams_behind seconds behind the furthest ahead (we assume that if a stream has fallen that far
 833            behind it has finished).  This is so that we don't withhold audio indefinitely awaiting data from a stream
 834            that will never come, causing bugs like #2101.
 835         */
 836         constexpr int ignore_streams_behind = 5;
 837
 838         using state_pair = std::pair<AudioStreamPtr, StreamState>;
 839
 840         /* Find streams that have pushed */
 841         std::vector<state_pair> have_pushed;
 842         std::copy_if(_stream_states.begin(), _stream_states.end(), std::back_inserter(have_pushed), [](state_pair const& a) { return static_cast<bool>(a.second.last_push_end); });
 843
 844         /* Find the 'leading' stream (i.e. the one that pushed data most recently) */
 845         auto latest_last_push_end = std::max_element(
 846                 have_pushed.begin(),
 847                 have_pushed.end(),
 848                 [](state_pair const& a, state_pair const& b) { return a.second.last_push_end.get() < b.second.last_push_end.get(); }
 849                 );
 850
 851         std::map<AudioStreamPtr, StreamState> alive_stream_states;
 852
 853         if (latest_last_push_end != have_pushed.end()) {
 854                 LOG_DEBUG_PLAYER("Leading audio stream is in %1 at %2", latest_last_push_end->second.piece->content->path(0), to_string(latest_last_push_end->second.last_push_end.get()));
 855
 856                 /* Now make a list of those streams that are less than ignore_streams_behind behind the leader */
 857                 for (auto const& i: _stream_states) {
 858                         if (!i.second.last_push_end || (latest_last_push_end->second.last_push_end.get() - i.second.last_push_end.get()) < dcpomatic::DCPTime::from_seconds(ignore_streams_behind)) {
 859                                 alive_stream_states.insert(i);
 860                         } else {
 861                                 LOG_DEBUG_PLAYER("Ignoring stream %1 because it is too far behind", i.second.piece->content->path(0));
 862                         }
 863                 }
 864         }
 865
 866         auto pull_to = _playback_length.load();
 867         for (auto const& i: alive_stream_states) {
 868                 auto position = i.second.last_push_end.get_value_or(i.second.piece->content->position());
 869                 if (!i.second.piece->done && position < pull_to) {
 870                         pull_to = position;
 871                 }
 872         }
 873         if (!_silent.done() && _silent.position() < pull_to) {
 874                 pull_to = _silent.position();
 875         }
 876
 877         LOG_DEBUG_PLAYER("Emitting audio up to %1", to_string(pull_to));
 878         auto audio = _audio_merger.pull (pull_to);
 879         for (auto i = audio.begin(); i != audio.end(); ++i) {
 880                 if (_next_audio_time && i->second < *_next_audio_time) {
 881                         /* This new data comes before the last we emitted (or the last seek); discard it */
 882                         auto cut = discard_audio (i->first, i->second, *_next_audio_time);
 883                         if (!cut.first) {
 884                                 continue;
 885                         }
 886                         *i = cut;
 887                 } else if (_next_audio_time && i->second > *_next_audio_time) {
 888                         /* There's a gap between this data and the last we emitted; fill with silence */
 889                         fill_audio (DCPTimePeriod (*_next_audio_time, i->second));
 890                 }
 891
 892                 emit_audio (i->first, i->second);
 893         }
 894
 895         if (done) {
 896                 if (_shuffler) {
 897                         _shuffler->flush ();
 898                 }
 899                 for (auto const& i: _delay) {
 900                         do_emit_video(i.first, i.second);
 901                 }
 902
 903                 /* Perhaps we should have Empty entries for both eyes in the 3D case (somehow).
 904                  * However, if we have L and R video files, and one is shorter than the other,
 905                  * the fill code in ::video mostly takes care of filling in the gaps.
 906                  * However, since it fills at the point when it knows there is more video coming
 907                  * at time t (so it should fill any gap up to t) it can't do anything right at the
 908                  * end.  This is particularly bad news if the last frame emitted is a LEFT
 909                  * eye, as the MXF writer will complain about the 3D sequence being wrong.
 910                  * Here's a hack to workaround that particular case.
 911                  */
 912                 if (_next_video_eyes && _next_video_time && *_next_video_eyes == Eyes::RIGHT) {
 913                         do_emit_video (black_player_video_frame(Eyes::RIGHT), *_next_video_time);
 914                 }
 915         }
 916
 917         return done;
 918 }
 919
 920
 921 /** @return Open subtitles for the frame at the given time, converted to images */
 922 optional<PositionImage>
 923 Player::open_subtitles_for_frame (DCPTime time) const
 924 {
 925         auto film = _film.lock();
 926         if (!film) {
 927                 return {};
 928         }
 929
 930         list<PositionImage> captions;
 931         int const vfr = film->video_frame_rate();
 932
 933         for (
 934                 auto j:
 935                 _active_texts[TextType::OPEN_SUBTITLE].get_burnt(DCPTimePeriod(time, time + DCPTime::from_frames(1, vfr)), _always_burn_open_subtitles)
 936                 ) {
 937
 938                 /* Bitmap subtitles */
 939                 for (auto i: j.bitmap) {
 940                         if (!i.image || i.image->size().width == 0 || i.image->size().height == 0) {
 941                                 continue;
 942                         }
 943
 944                         /* i.image will already have been scaled to fit _video_container_size */
 945                         dcp::Size scaled_size (i.rectangle.width * _video_container_size.load().width, i.rectangle.height * _video_container_size.load().height);
 946
 947                         captions.push_back (
 948                                 PositionImage (
 949                                         i.image,
 950                                         Position<int> (
 951                                                 lrint(_video_container_size.load().width * i.rectangle.x),
 952                                                 lrint(_video_container_size.load().height * i.rectangle.y)
 953                                                 )
 954                                         )
 955                                 );
 956                 }
 957
 958                 /* String subtitles (rendered to an image) */
 959                 if (!j.string.empty()) {
 960                         auto s = render_text(j.string, _video_container_size, time, vfr);
 961                         copy_if(s.begin(), s.end(), back_inserter(captions), [](PositionImage const& image) {
 962                                 return image.image->size().width && image.image->size().height;
 963                         });
 964
 965                 }
 966         }
 967
 968         if (captions.empty()) {
 969                 return {};
 970         }
 971
 972         return merge (captions, _subtitle_alignment);
 973 }
 974
 975
 976 static
 977 Eyes
 978 increment_eyes (Eyes e)
 979 {
 980         if (e == Eyes::LEFT) {
 981                 return Eyes::RIGHT;
 982         }
 983
 984         return Eyes::LEFT;
 985 }
 986
 987
 988 void
 989 Player::video (weak_ptr<Piece> weak_piece, ContentVideo video)
 990 {
 991         if (_suspended) {
 992                 return;
 993         }
 994
 995         auto piece = weak_piece.lock ();
 996         if (!piece) {
 997                 return;
 998         }
 999
1000         if (!piece->content->video->use()) {
1001                 return;
1002         }
1003
1004         auto film = _film.lock();
1005         if (!film) {
1006                 return;
1007         }
1008
1009         FrameRateChange frc(film, piece->content);
1010         if (frc.skip && (video.frame % 2) == 1) {
1011                 return;
1012         }
1013
1014         vector<Eyes> eyes_to_emit;
1015
1016         if (!film->three_d()) {
1017                 if (video.eyes == Eyes::RIGHT) {
1018                         /* 2D film, 3D content: discard right */
1019                         return;
1020                 } else if (video.eyes == Eyes::LEFT) {
1021                         /* 2D film, 3D content: emit left as "both" */
1022                         video.eyes = Eyes::BOTH;
1023                         eyes_to_emit = { Eyes::BOTH };
1024                 }
1025         } else {
1026                 if (video.eyes == Eyes::BOTH) {
1027                         /* 3D film, 2D content; emit "both" for left and right */
1028                         eyes_to_emit = { Eyes::LEFT, Eyes::RIGHT };
1029                 }
1030         }
1031
1032         if (eyes_to_emit.empty()) {
1033                 eyes_to_emit = { video.eyes };
1034         }
1035
1036         /* Time of the first frame we will emit */
1037         DCPTime const time = content_video_to_dcp (piece, video.frame);
1038         LOG_DEBUG_PLAYER("Received video frame %1 at %2", video.frame, to_string(time));
1039
1040         /* Discard if it's before the content's period or the last accurate seek.  We can't discard
1041            if it's after the content's period here as in that case we still need to fill any gap between
1042            `now' and the end of the content's period.
1043         */
1044         if (time < piece->content->position() || (_next_video_time && time < *_next_video_time)) {
1045                 return;
1046         }
1047
1048         auto ignore_video = std::find_if(
1049                 piece->ignore_video.begin(),
1050                 piece->ignore_video.end(),
1051                 [time](DCPTimePeriod period) { return period.contains(time); }
1052                 );
1053         if (ignore_video != piece->ignore_video.end()) {
1054                 return;
1055         }
1056
1057         /* Fill gaps that we discover now that we have some video which needs to be emitted.
1058            This is where we need to fill to.
1059         */
1060         DCPTime fill_to = min(time, piece->content->end(film));
1061
1062         if (_next_video_time) {
1063                 DCPTime fill_from = max (*_next_video_time, piece->content->position());
1064
1065                 /* Fill if we have more than half a frame to do */
1066                 if ((fill_to - fill_from) > one_video_frame() / 2) {
1067                         auto last = _last_video.find (weak_piece);
1068                         if (film->three_d()) {
1069                                 auto fill_to_eyes = eyes_to_emit[0];
1070                                 if (fill_to_eyes == Eyes::BOTH) {
1071                                         fill_to_eyes = Eyes::LEFT;
1072                                 }
1073                                 if (fill_to == piece->content->end(film)) {
1074                                         /* Don't fill after the end of the content */
1075                                         fill_to_eyes = Eyes::LEFT;
1076                                 }
1077                                 auto j = fill_from;
1078                                 auto eyes = _next_video_eyes.get_value_or(Eyes::LEFT);
1079                                 if (eyes == Eyes::BOTH) {
1080                                         eyes = Eyes::LEFT;
1081                                 }
1082                                 while (j < fill_to || eyes != fill_to_eyes) {
1083                                         if (last != _last_video.end()) {
1084                                                 LOG_DEBUG_PLAYER("Fill using last video at %1 in 3D mode", to_string(j));
1085                                                 auto copy = last->second->shallow_copy();
1086                                                 copy->set_eyes (eyes);
1087                                                 emit_video (copy, j);
1088                                         } else {
1089                                                 LOG_DEBUG_PLAYER("Fill using black at %1 in 3D mode", to_string(j));
1090                                                 emit_video (black_player_video_frame(eyes), j);
1091                                         }
1092                                         if (eyes == Eyes::RIGHT) {
1093                                                 j += one_video_frame();
1094                                         }
1095                                         eyes = increment_eyes (eyes);
1096                                 }
1097                         } else {
1098                                 for (DCPTime j = fill_from; j < fill_to; j += one_video_frame()) {
1099                                         if (last != _last_video.end()) {
1100                                                 emit_video (last->second, j);
1101                                         } else {
1102                                                 emit_video (black_player_video_frame(Eyes::BOTH), j);
1103                                         }
1104                                 }
1105                         }
1106                 }
1107         }
1108
1109         auto const content_video = piece->content->video;
1110
1111         auto scaled_size = content_video->scaled_size(film->frame_size());
1112         DCPOMATIC_ASSERT(scaled_size);
1113
1114         for (auto eyes: eyes_to_emit) {
1115                 _last_video[weak_piece] = std::make_shared<PlayerVideo>(
1116                         video.image,
1117                         content_video->actual_crop(),
1118                         content_video->fade(film, video.frame),
1119                         scale_for_display(
1120                                 *scaled_size,
1121                                 _video_container_size,
1122                                 film->frame_size(),
1123                                 content_video->pixel_quanta()
1124                                 ),
1125                         _video_container_size,
1126                         eyes,
1127                         video.part,
1128                         content_video->colour_conversion(),
1129                         content_video->range(),
1130                         piece->content,
1131                         video.frame,
1132                         false
1133                         );
1134
1135                 DCPTime t = time;
1136                 for (int i = 0; i < frc.repeat; ++i) {
1137                         if (t < piece->content->end(film)) {
1138                                 emit_video (_last_video[weak_piece], t);
1139                         }
1140                         t += one_video_frame ();
1141                 }
1142         }
1143 }
1144
1145
1146 void
1147 Player::audio (weak_ptr<Piece> weak_piece, AudioStreamPtr stream, ContentAudio content_audio)
1148 {
1149         if (_suspended) {
1150                 return;
1151         }
1152
1153         DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
1154
1155         auto piece = weak_piece.lock ();
1156         if (!piece) {
1157                 return;
1158         }
1159
1160         auto film = _film.lock();
1161         if (!film) {
1162                 return;
1163         }
1164
1165         auto content = piece->content->audio;
1166         DCPOMATIC_ASSERT (content);
1167
1168         int const rfr = content->resampled_frame_rate(film);
1169
1170         /* Compute time in the DCP */
1171         auto time = resampled_audio_to_dcp (piece, content_audio.frame);
1172
1173         /* And the end of this block in the DCP */
1174         auto end = time + DCPTime::from_frames(content_audio.audio->frames(), rfr);
1175         LOG_DEBUG_PLAYER("Received audio frame %1 covering %2 to %3 (%4)", content_audio.frame, to_string(time), to_string(end), piece->content->path(0).filename());
1176
1177         /* Remove anything that comes before the start or after the end of the content */
1178         if (time < piece->content->position()) {
1179                 auto cut = discard_audio (content_audio.audio, time, piece->content->position());
1180                 if (!cut.first) {
1181                         /* This audio is entirely discarded */
1182                         return;
1183                 }
1184                 content_audio.audio = cut.first;
1185                 time = cut.second;
1186         } else if (time > piece->content->end(film)) {
1187                 /* Discard it all */
1188                 return;
1189         } else if (end > piece->content->end(film)) {
1190                 Frame const remaining_frames = DCPTime(piece->content->end(film) - time).frames_round(rfr);
1191                 if (remaining_frames == 0) {
1192                         return;
1193                 }
1194                 content_audio.audio = make_shared<AudioBuffers>(content_audio.audio, remaining_frames, 0);
1195         }
1196
1197         DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
1198
1199         /* Gain and fade */
1200
1201         auto const fade_coeffs = content->fade (stream, content_audio.frame, content_audio.audio->frames(), rfr);
1202         if (content->gain() != 0 || !fade_coeffs.empty()) {
1203                 auto gain_buffers = make_shared<AudioBuffers>(content_audio.audio);
1204                 if (!fade_coeffs.empty()) {
1205                         /* Apply both fade and gain */
1206                         DCPOMATIC_ASSERT (fade_coeffs.size() == static_cast<size_t>(gain_buffers->frames()));
1207                         auto const channels = gain_buffers->channels();
1208                         auto const frames = fade_coeffs.size();
1209                         auto data = gain_buffers->data();
1210                         auto const gain = db_to_linear (content->gain());
1211                         for (auto channel = 0; channel < channels; ++channel) {
1212                                 for (auto frame = 0U; frame < frames; ++frame) {
1213                                         data[channel][frame] *= gain * fade_coeffs[frame];
1214                                 }
1215                         }
1216                 } else {
1217                         /* Just apply gain */
1218                         gain_buffers->apply_gain (content->gain());
1219                 }
1220                 content_audio.audio = gain_buffers;
1221         }
1222
1223         /* Remap */
1224
1225         content_audio.audio = remap(content_audio.audio, film->audio_channels(), stream->mapping());
1226
1227         /* Process */
1228
1229         if (_audio_processor && !_disable_audio_processor) {
1230                 content_audio.audio = _audio_processor->run(content_audio.audio, film->audio_channels());
1231         }
1232
1233         /* Push */
1234
1235         _audio_merger.push (content_audio.audio, time);
1236         DCPOMATIC_ASSERT (_stream_states.find (stream) != _stream_states.end ());
1237         _stream_states[stream].last_push_end = time + DCPTime::from_frames(content_audio.audio->frames(), film->audio_frame_rate());
1238 }
1239
1240
1241 void
1242 Player::bitmap_text_start (weak_ptr<Piece> weak_piece, weak_ptr<const TextContent> weak_content, ContentBitmapText subtitle)
1243 {
1244         if (_suspended) {
1245                 return;
1246         }
1247
1248         auto piece = weak_piece.lock ();
1249         auto content = weak_content.lock ();
1250         if (!piece || !content) {
1251                 return;
1252         }
1253
1254         PlayerText ps;
1255         for (auto& sub: subtitle.subs)
1256         {
1257                 /* Apply content's subtitle offsets */
1258                 sub.rectangle.x += content->x_offset ();
1259                 sub.rectangle.y += content->y_offset ();
1260
1261                 /* Apply a corrective translation to keep the subtitle centred after the scale that is coming up */
1262                 sub.rectangle.x -= sub.rectangle.width * ((content->x_scale() - 1) / 2);
1263                 sub.rectangle.y -= sub.rectangle.height * ((content->y_scale() - 1) / 2);
1264
1265                 /* Apply content's subtitle scale */
1266                 sub.rectangle.width *= content->x_scale ();
1267                 sub.rectangle.height *= content->y_scale ();
1268
1269                 auto image = sub.image;
1270
1271                 /* We will scale the subtitle up to fit _video_container_size */
1272                 int const width = sub.rectangle.width * _video_container_size.load().width;
1273                 int const height = sub.rectangle.height * _video_container_size.load().height;
1274                 if (width == 0 || height == 0) {
1275                         return;
1276                 }
1277
1278                 dcp::Size scaled_size (width, height);
1279                 ps.bitmap.push_back (BitmapText(image->scale(scaled_size, dcp::YUVToRGB::REC601, image->pixel_format(), Image::Alignment::PADDED, _fast), sub.rectangle));
1280         }
1281
1282         DCPTime from(content_time_to_dcp(piece, subtitle.from()));
1283         _active_texts[content->type()].add_from(weak_content, ps, from);
1284 }
1285
1286
1287 void
1288 Player::plain_text_start (weak_ptr<Piece> weak_piece, weak_ptr<const TextContent> weak_content, ContentStringText subtitle)
1289 {
1290         if (_suspended) {
1291                 return;
1292         }
1293
1294         auto piece = weak_piece.lock ();
1295         auto content = weak_content.lock ();
1296         auto film = _film.lock();
1297         if (!piece || !content || !film) {
1298                 return;
1299         }
1300
1301         PlayerText ps;
1302         DCPTime const from (content_time_to_dcp (piece, subtitle.from()));
1303
1304         if (from > piece->content->end(film)) {
1305                 return;
1306         }
1307
1308         for (auto s: subtitle.subs) {
1309                 s.set_h_position (s.h_position() + content->x_offset());
1310                 s.set_v_position (s.v_position() + content->y_offset());
1311                 float const xs = content->x_scale();
1312                 float const ys = content->y_scale();
1313                 float size = s.size();
1314
1315                 /* Adjust size to express the common part of the scaling;
1316                    e.g. if xs = ys = 0.5 we scale size by 2.
1317                 */
1318                 if (xs > 1e-5 && ys > 1e-5) {
1319                         size *= 1 / min (1 / xs, 1 / ys);
1320                 }
1321                 s.set_size (size);
1322
1323                 /* Then express aspect ratio changes */
1324                 if (fabs (1.0 - xs / ys) > dcp::ASPECT_ADJUST_EPSILON) {
1325                         s.set_aspect_adjust (xs / ys);
1326                 }
1327
1328                 s.set_in (dcp::Time(from.seconds(), 1000));
1329                 ps.string.push_back (s);
1330         }
1331
1332         _active_texts[content->type()].add_from(weak_content, ps, from);
1333 }
1334
1335
1336 void
1337 Player::subtitle_stop (weak_ptr<Piece> weak_piece, weak_ptr<const TextContent> weak_content, ContentTime to)
1338 {
1339         if (_suspended) {
1340                 return;
1341         }
1342
1343         auto content = weak_content.lock ();
1344         if (!content) {
1345                 return;
1346         }
1347
1348         if (!_active_texts[content->type()].have(weak_content)) {
1349                 return;
1350         }
1351
1352         auto piece = weak_piece.lock ();
1353         auto film = _film.lock();
1354         if (!piece || !film) {
1355                 return;
1356         }
1357
1358         DCPTime const dcp_to = content_time_to_dcp (piece, to);
1359
1360         if (dcp_to > piece->content->end(film)) {
1361                 return;
1362         }
1363
1364         auto from = _active_texts[content->type()].add_to(weak_content, dcp_to);
1365
1366         bool const always = (content->type() == TextType::OPEN_SUBTITLE && _always_burn_open_subtitles);
1367         if (content->use() && !always && !content->burn()) {
1368                 Text (from.first, content->type(), content->dcp_track().get_value_or(DCPTextTrack()), DCPTimePeriod(from.second, dcp_to));
1369         }
1370 }
1371
1372
1373 void
1374 Player::seek (DCPTime time, bool accurate)
1375 {
1376         boost::mutex::scoped_lock lm (_mutex);
1377         LOG_DEBUG_PLAYER("Seek to %1 (%2accurate)", to_string(time), accurate ? "" : "in");
1378
1379         if (_suspended) {
1380                 /* We can't seek in this state */
1381                 return;
1382         }
1383
1384         auto film = _film.lock();
1385         if (!film) {
1386                 return;
1387         }
1388
1389         if (_shuffler) {
1390                 _shuffler->clear ();
1391         }
1392
1393         _delay.clear ();
1394
1395         if (_audio_processor) {
1396                 _audio_processor->flush ();
1397         }
1398
1399         _audio_merger.clear ();
1400         std::for_each(_active_texts.begin(), _active_texts.end(), [](ActiveText& a) { a.clear(); });
1401
1402         for (auto i: _pieces) {
1403                 if (time < i->content->position()) {
1404                         /* Before; seek to the start of the content.  Even if this request is for an inaccurate seek
1405                            we must seek this (following) content accurately, otherwise when we come to the end of the current
1406                            content we may not start right at the beginning of the next, causing a gap (if the next content has
1407                            been trimmed to a point between keyframes, or something).
1408                         */
1409                         i->decoder->seek (dcp_to_content_time (i, i->content->position()), true);
1410                         i->done = false;
1411                 } else if (i->content->position() <= time && time < i->content->end(film)) {
1412                         /* During; seek to position */
1413                         i->decoder->seek (dcp_to_content_time (i, time), accurate);
1414                         i->done = false;
1415                 } else {
1416                         /* After; this piece is done */
1417                         i->done = true;
1418                 }
1419         }
1420
1421         if (accurate) {
1422                 _next_video_time = time;
1423                 _next_video_eyes = Eyes::LEFT;
1424                 _next_audio_time = time;
1425         } else {
1426                 _next_video_time = boost::none;
1427                 _next_video_eyes = boost::none;
1428                 _next_audio_time = boost::none;
1429         }
1430
1431         _black.set_position (time);
1432         _silent.set_position (time);
1433
1434         _last_video.clear ();
1435
1436         for (auto& state: _stream_states) {
1437                 state.second.last_push_end = boost::none;
1438         }
1439 }
1440
1441
1442 void
1443 Player::emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1444 {
1445         auto film = _film.lock();
1446         DCPOMATIC_ASSERT(film);
1447
1448         /* We need a delay to give a little wiggle room to ensure that relevant subtitles arrive at the
1449            player before the video that requires them.
1450         */
1451         _delay.push_back (make_pair (pv, time));
1452
1453         if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
1454                 _next_video_time = time + one_video_frame();
1455         }
1456         _next_video_eyes = increment_eyes (pv->eyes());
1457
1458         if (_delay.size() < 3) {
1459                 return;
1460         }
1461
1462         auto to_do = _delay.front();
1463         _delay.pop_front();
1464         do_emit_video (to_do.first, to_do.second);
1465 }
1466
1467
1468 void
1469 Player::do_emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
1470 {
1471         if (pv->eyes() == Eyes::BOTH || pv->eyes() == Eyes::RIGHT) {
1472                 std::for_each(_active_texts.begin(), _active_texts.end(), [time](ActiveText& a) { a.clear_before(time); });
1473         }
1474
1475         auto subtitles = open_subtitles_for_frame (time);
1476         if (subtitles) {
1477                 pv->set_text (subtitles.get ());
1478         }
1479
1480         Video (pv, time);
1481 }
1482
1483
1484 void
1485 Player::emit_audio (shared_ptr<AudioBuffers> data, DCPTime time)
1486 {
1487         auto film = _film.lock();
1488         DCPOMATIC_ASSERT(film);
1489
1490         /* Log if the assert below is about to fail */
1491         if (_next_audio_time && labs(time.get() - _next_audio_time->get()) > 1) {
1492                 film->log()->log(String::compose("Out-of-sequence emit %1 vs %2", to_string(time), to_string(*_next_audio_time)), LogEntry::TYPE_WARNING);
1493         }
1494
1495         /* This audio must follow on from the previous, allowing for half a sample (at 48kHz) leeway */
1496         DCPOMATIC_ASSERT (!_next_audio_time || labs(time.get() - _next_audio_time->get()) < 2);
1497         Audio(data, time, film->audio_frame_rate());
1498         _next_audio_time = time + DCPTime::from_frames(data->frames(), film->audio_frame_rate());
1499 }
1500
1501
1502 void
1503 Player::fill_audio (DCPTimePeriod period)
1504 {
1505         auto film = _film.lock();
1506         DCPOMATIC_ASSERT(film);
1507
1508         if (period.from == period.to) {
1509                 return;
1510         }
1511
1512         DCPOMATIC_ASSERT (period.from < period.to);
1513
1514         DCPTime t = period.from;
1515         while (t < period.to) {
1516                 DCPTime block = min (DCPTime::from_seconds (0.5), period.to - t);
1517                 Frame const samples = block.frames_round(film->audio_frame_rate());
1518                 if (samples) {
1519                         auto silence = make_shared<AudioBuffers>(film->audio_channels(), samples);
1520                         silence->make_silent ();
1521                         emit_audio (silence, t);
1522                 }
1523                 t += block;
1524         }
1525 }
1526
1527
1528 DCPTime
1529 Player::one_video_frame () const
1530 {
1531         auto film = _film.lock();
1532         DCPOMATIC_ASSERT(film);
1533
1534         return DCPTime::from_frames(1, film->video_frame_rate ());
1535 }
1536
1537
1538 pair<shared_ptr<AudioBuffers>, DCPTime>
1539 Player::discard_audio (shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to) const
1540 {
1541         auto film = _film.lock();
1542         DCPOMATIC_ASSERT(film);
1543
1544         auto const discard_time = discard_to - time;
1545         auto const discard_frames = discard_time.frames_round(film->audio_frame_rate());
1546         auto remaining_frames = audio->frames() - discard_frames;
1547         if (remaining_frames <= 0) {
1548                 return make_pair(shared_ptr<AudioBuffers>(), DCPTime());
1549         }
1550         auto cut = make_shared<AudioBuffers>(audio, remaining_frames, discard_frames);
1551         return make_pair(cut, time + discard_time);
1552 }
1553
1554
1555 void
1556 Player::set_dcp_decode_reduction (optional<int> reduction)
1557 {
1558         ChangeSignaller<Player, int> cc(this, PlayerProperty::DCP_DECODE_REDUCTION);
1559
1560         if (reduction == _dcp_decode_reduction.load()) {
1561                 cc.abort();
1562                 return;
1563         }
1564
1565         _dcp_decode_reduction = reduction;
1566         setup_pieces();
1567 }
1568
1569
1570 optional<DCPTime>
1571 Player::content_time_to_dcp (shared_ptr<const Content> content, ContentTime t) const
1572 {
1573         boost::mutex::scoped_lock lm (_mutex);
1574
1575         for (auto i: _pieces) {
1576                 if (i->content == content) {
1577                         return content_time_to_dcp (i, t);
1578                 }
1579         }
1580
1581         /* We couldn't find this content; perhaps things are being changed over */
1582         return {};
1583 }
1584
1585
1586 optional<ContentTime>
1587 Player::dcp_to_content_time (shared_ptr<const Content> content, DCPTime t) const
1588 {
1589         boost::mutex::scoped_lock lm (_mutex);
1590
1591         for (auto i: _pieces) {
1592                 if (i->content == content) {
1593                         return dcp_to_content_time (i, t);
1594                 }
1595         }
1596
1597         /* We couldn't find this content; perhaps things are being changed over */
1598         return {};
1599 }
1600
1601
1602 shared_ptr<const Playlist>
1603 Player::playlist () const
1604 {
1605         auto film = _film.lock();
1606         if (!film) {
1607                 return {};
1608         }
1609
1610         return _playlist ? _playlist : film->playlist();
1611 }
1612
1613
1614 void
1615 Player::atmos (weak_ptr<Piece> weak_piece, ContentAtmos data)
1616 {
1617         if (_suspended) {
1618                 return;
1619         }
1620
1621         auto film = _film.lock();
1622         DCPOMATIC_ASSERT(film);
1623
1624         auto piece = weak_piece.lock ();
1625         DCPOMATIC_ASSERT (piece);
1626
1627         auto const vfr = film->video_frame_rate();
1628
1629         DCPTime const dcp_time = DCPTime::from_frames(data.frame, vfr) - DCPTime(piece->content->trim_start(), FrameRateChange(vfr, vfr));
1630         if (dcp_time < piece->content->position() || dcp_time >= (piece->content->end(film))) {
1631                 return;
1632         }
1633
1634         auto ignore_atmos = std::find_if(
1635                 piece->ignore_atmos.begin(),
1636                 piece->ignore_atmos.end(),
1637                 [dcp_time](DCPTimePeriod period) { return period.contains(dcp_time); }
1638                 );
1639         if (ignore_atmos != piece->ignore_atmos.end()) {
1640                 return;
1641         }
1642
1643         Atmos (data.data, dcp_time, data.metadata);
1644 }
1645
1646
1647 void
1648 Player::signal_change(ChangeType type, int property)
1649 {
1650         Change(type, property, false);
1651 }
1652
1653
1654 /** Must be called from the same thread that calls ::pass() */
1655 void
1656 Player::set_disable_audio_processor()
1657 {
1658         _disable_audio_processor = true;
1659 }
1660
1661
1662 Frame
1663 Player::frames_done() const
1664 {
1665         auto film = _film.lock();
1666         DCPOMATIC_ASSERT(film);
1667
1668         shared_ptr<Piece> earliest_content;
1669         optional<DCPTime> earliest_time;
1670         std::tie(earliest_content, earliest_time) = earliest_piece_and_time();
1671
1672         return earliest_time.get_value_or({}).frames_round(film->video_frame_rate());
1673 }
1674
1675
1676 float
1677 Player::progress() const
1678 {
1679         auto film = _film.lock();
1680         DCPOMATIC_ASSERT(film);
1681
1682         shared_ptr<Piece> earliest_content;
1683         optional<DCPTime> earliest_time;
1684         std::tie(earliest_content, earliest_time) = earliest_piece_and_time();
1685
1686         return static_cast<float>(earliest_time.get_value_or({}).get()) / film->length().get();
1687 }