src/lib/player.cc

   1 /*
   2     Copyright (C) 2013-2017 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_subtitles.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 "subtitle_content.h"
  44 #include "subtitle_decoder.h"
  45 #include "ffmpeg_content.h"
  46 #include "audio_content.h"
  47 #include "content_subtitle.h"
  48 #include "dcp_decoder.h"
  49 #include "image_decoder.h"
  50 #include "resampler.h"
  51 #include "compose.hpp"
  52 #include <dcp/reel.h>
  53 #include <dcp/reel_sound_asset.h>
  54 #include <dcp/reel_subtitle_asset.h>
  55 #include <dcp/reel_picture_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 Player::Player (shared_ptr<const Film> film, shared_ptr<const Playlist> playlist)
  82         : _film (film)
  83         , _playlist (playlist)
  84         , _have_valid_pieces (false)
  85         , _ignore_video (false)
  86         , _ignore_audio (false)
  87         , _always_burn_subtitles (false)
  88         , _fast (false)
  89         , _play_referenced (false)
  90         , _audio_merger (_film->audio_frame_rate())
  91 {
  92         _film_changed_connection = _film->Changed.connect (bind (&Player::film_changed, this, _1));
  93         _playlist_changed_connection = _playlist->Changed.connect (bind (&Player::playlist_changed, this));
  94         _playlist_content_changed_connection = _playlist->ContentChanged.connect (bind (&Player::playlist_content_changed, this, _1, _2, _3));
  95         set_video_container_size (_film->frame_size ());
  96
  97         film_changed (Film::AUDIO_PROCESSOR);
  98
  99         seek (DCPTime (), true);
 100 }
 101
 102 void
 103 Player::setup_pieces ()
 104 {
 105         _pieces.clear ();
 106
 107         BOOST_FOREACH (shared_ptr<Content> i, _playlist->content ()) {
 108
 109                 if (!i->paths_valid ()) {
 110                         continue;
 111                 }
 112
 113                 shared_ptr<Decoder> decoder = decoder_factory (i, _film->log());
 114                 FrameRateChange frc (i->active_video_frame_rate(), _film->video_frame_rate());
 115
 116                 if (!decoder) {
 117                         /* Not something that we can decode; e.g. Atmos content */
 118                         continue;
 119                 }
 120
 121                 if (decoder->video && _ignore_video) {
 122                         decoder->video->set_ignore ();
 123                 }
 124
 125                 if (decoder->audio && _ignore_audio) {
 126                         decoder->audio->set_ignore ();
 127                 }
 128
 129                 shared_ptr<DCPDecoder> dcp = dynamic_pointer_cast<DCPDecoder> (decoder);
 130                 if (dcp && _play_referenced) {
 131                         dcp->set_decode_referenced ();
 132                 }
 133
 134                 shared_ptr<Piece> piece (new Piece (i, decoder, frc));
 135                 _pieces.push_back (piece);
 136
 137                 if (decoder->video) {
 138                         decoder->video->Data.connect (bind (&Player::video, this, weak_ptr<Piece> (piece), _1));
 139                 }
 140
 141                 if (decoder->audio) {
 142                         decoder->audio->Data.connect (bind (&Player::audio, this, weak_ptr<Piece> (piece), _1, _2));
 143                 }
 144
 145                 if (decoder->subtitle) {
 146                         decoder->subtitle->ImageStart.connect (bind (&Player::image_subtitle_start, this, weak_ptr<Piece> (piece), _1));
 147                         decoder->subtitle->TextStart.connect (bind (&Player::text_subtitle_start, this, weak_ptr<Piece> (piece), _1));
 148                         decoder->subtitle->Stop.connect (bind (&Player::subtitle_stop, this, weak_ptr<Piece> (piece), _1));
 149                 }
 150         }
 151
 152         BOOST_FOREACH (shared_ptr<Piece> i, _pieces) {
 153                 if (i->content->audio) {
 154                         BOOST_FOREACH (AudioStreamPtr j, i->content->audio->streams()) {
 155                                 _stream_states[j] = StreamState (i, i->content->position ());
 156                         }
 157                 }
 158         }
 159
 160         if (!_play_referenced) {
 161                 BOOST_FOREACH (shared_ptr<Piece> i, _pieces) {
 162                         shared_ptr<DCPContent> dc = dynamic_pointer_cast<DCPContent> (i->content);
 163                         if (dc) {
 164                                 if (dc->reference_video()) {
 165                                         _no_video.push_back (DCPTimePeriod (dc->position(), dc->end()));
 166                                 }
 167                                 if (dc->reference_audio()) {
 168                                         _no_audio.push_back (DCPTimePeriod (dc->position(), dc->end()));
 169                                 }
 170                         }
 171                 }
 172         }
 173
 174         _last_video_time = DCPTime ();
 175         _last_audio_time = DCPTime ();
 176         _have_valid_pieces = true;
 177 }
 178
 179 void
 180 Player::playlist_content_changed (weak_ptr<Content> w, int property, bool frequent)
 181 {
 182         shared_ptr<Content> c = w.lock ();
 183         if (!c) {
 184                 return;
 185         }
 186
 187         if (
 188                 property == ContentProperty::POSITION ||
 189                 property == ContentProperty::LENGTH ||
 190                 property == ContentProperty::TRIM_START ||
 191                 property == ContentProperty::TRIM_END ||
 192                 property == ContentProperty::PATH ||
 193                 property == VideoContentProperty::FRAME_TYPE ||
 194                 property == DCPContentProperty::NEEDS_ASSETS ||
 195                 property == DCPContentProperty::NEEDS_KDM ||
 196                 property == SubtitleContentProperty::COLOUR ||
 197                 property == SubtitleContentProperty::OUTLINE ||
 198                 property == SubtitleContentProperty::SHADOW ||
 199                 property == SubtitleContentProperty::EFFECT_COLOUR ||
 200                 property == FFmpegContentProperty::SUBTITLE_STREAM ||
 201                 property == VideoContentProperty::COLOUR_CONVERSION
 202                 ) {
 203
 204                 _have_valid_pieces = false;
 205                 Changed (frequent);
 206
 207         } else if (
 208                 property == SubtitleContentProperty::LINE_SPACING ||
 209                 property == SubtitleContentProperty::OUTLINE_WIDTH ||
 210                 property == SubtitleContentProperty::Y_SCALE ||
 211                 property == SubtitleContentProperty::FADE_IN ||
 212                 property == SubtitleContentProperty::FADE_OUT ||
 213                 property == ContentProperty::VIDEO_FRAME_RATE ||
 214                 property == SubtitleContentProperty::USE ||
 215                 property == SubtitleContentProperty::X_OFFSET ||
 216                 property == SubtitleContentProperty::Y_OFFSET ||
 217                 property == SubtitleContentProperty::X_SCALE ||
 218                 property == SubtitleContentProperty::FONTS ||
 219                 property == VideoContentProperty::CROP ||
 220                 property == VideoContentProperty::SCALE ||
 221                 property == VideoContentProperty::FADE_IN ||
 222                 property == VideoContentProperty::FADE_OUT
 223                 ) {
 224
 225                 Changed (frequent);
 226         }
 227 }
 228
 229 void
 230 Player::set_video_container_size (dcp::Size s)
 231 {
 232         if (s == _video_container_size) {
 233                 return;
 234         }
 235
 236         _video_container_size = s;
 237
 238         _black_image.reset (new Image (AV_PIX_FMT_RGB24, _video_container_size, true));
 239         _black_image->make_black ();
 240
 241         Changed (false);
 242 }
 243
 244 void
 245 Player::playlist_changed ()
 246 {
 247         _have_valid_pieces = false;
 248         Changed (false);
 249 }
 250
 251 void
 252 Player::film_changed (Film::Property p)
 253 {
 254         /* Here we should notice Film properties that affect our output, and
 255            alert listeners that our output now would be different to how it was
 256            last time we were run.
 257         */
 258
 259         if (p == Film::CONTAINER) {
 260                 Changed (false);
 261         } else if (p == Film::VIDEO_FRAME_RATE) {
 262                 /* Pieces contain a FrameRateChange which contains the DCP frame rate,
 263                    so we need new pieces here.
 264                 */
 265                 _have_valid_pieces = false;
 266                 Changed (false);
 267         } else if (p == Film::AUDIO_PROCESSOR) {
 268                 if (_film->audio_processor ()) {
 269                         _audio_processor = _film->audio_processor()->clone (_film->audio_frame_rate ());
 270                 }
 271         }
 272 }
 273
 274 list<PositionImage>
 275 Player::transform_image_subtitles (list<ImageSubtitle> subs) const
 276 {
 277         list<PositionImage> all;
 278
 279         for (list<ImageSubtitle>::const_iterator i = subs.begin(); i != subs.end(); ++i) {
 280                 if (!i->image) {
 281                         continue;
 282                 }
 283
 284                 /* We will scale the subtitle up to fit _video_container_size */
 285                 dcp::Size scaled_size (i->rectangle.width * _video_container_size.width, i->rectangle.height * _video_container_size.height);
 286
 287                 /* Then we need a corrective translation, consisting of two parts:
 288                  *
 289                  * 1.  that which is the result of the scaling of the subtitle by _video_container_size; this will be
 290                  *     rect.x * _video_container_size.width and rect.y * _video_container_size.height.
 291                  *
 292                  * 2.  that to shift the origin of the scale by subtitle_scale to the centre of the subtitle; this will be
 293                  *     (width_before_subtitle_scale * (1 - subtitle_x_scale) / 2) and
 294                  *     (height_before_subtitle_scale * (1 - subtitle_y_scale) / 2).
 295                  *
 296                  * Combining these two translations gives these expressions.
 297                  */
 298
 299                 all.push_back (
 300                         PositionImage (
 301                                 i->image->scale (
 302                                         scaled_size,
 303                                         dcp::YUV_TO_RGB_REC601,
 304                                         i->image->pixel_format (),
 305                                         true,
 306                                         _fast
 307                                         ),
 308                                 Position<int> (
 309                                         lrint (_video_container_size.width * i->rectangle.x),
 310                                         lrint (_video_container_size.height * i->rectangle.y)
 311                                         )
 312                                 )
 313                         );
 314         }
 315
 316         return all;
 317 }
 318
 319 shared_ptr<PlayerVideo>
 320 Player::black_player_video_frame () const
 321 {
 322         return shared_ptr<PlayerVideo> (
 323                 new PlayerVideo (
 324                         shared_ptr<const ImageProxy> (new RawImageProxy (_black_image)),
 325                         Crop (),
 326                         optional<double> (),
 327                         _video_container_size,
 328                         _video_container_size,
 329                         EYES_BOTH,
 330                         PART_WHOLE,
 331                         PresetColourConversion::all().front().conversion
 332                 )
 333         );
 334 }
 335
 336 Frame
 337 Player::dcp_to_content_video (shared_ptr<const Piece> piece, DCPTime t) const
 338 {
 339         DCPTime s = t - piece->content->position ();
 340         s = min (piece->content->length_after_trim(), s);
 341         s = max (DCPTime(), s + DCPTime (piece->content->trim_start(), piece->frc));
 342
 343         /* It might seem more logical here to convert s to a ContentTime (using the FrameRateChange)
 344            then convert that ContentTime to frames at the content's rate.  However this fails for
 345            situations like content at 29.9978733fps, DCP at 30fps.  The accuracy of the Time type is not
 346            enough to distinguish between the two with low values of time (e.g. 3200 in Time units).
 347
 348            Instead we convert the DCPTime using the DCP video rate then account for any skip/repeat.
 349         */
 350         return s.frames_floor (piece->frc.dcp) / piece->frc.factor ();
 351 }
 352
 353 DCPTime
 354 Player::content_video_to_dcp (shared_ptr<const Piece> piece, Frame f) const
 355 {
 356         /* See comment in dcp_to_content_video */
 357         DCPTime const d = DCPTime::from_frames (f * piece->frc.factor(), piece->frc.dcp) - DCPTime (piece->content->trim_start (), piece->frc);
 358         return max (DCPTime (), d + piece->content->position ());
 359 }
 360
 361 Frame
 362 Player::dcp_to_resampled_audio (shared_ptr<const Piece> piece, DCPTime t) const
 363 {
 364         DCPTime s = t - piece->content->position ();
 365         s = min (piece->content->length_after_trim(), s);
 366         /* See notes in dcp_to_content_video */
 367         return max (DCPTime (), DCPTime (piece->content->trim_start (), piece->frc) + s).frames_floor (_film->audio_frame_rate ());
 368 }
 369
 370 DCPTime
 371 Player::resampled_audio_to_dcp (shared_ptr<const Piece> piece, Frame f) const
 372 {
 373         /* See comment in dcp_to_content_video */
 374         DCPTime const d = DCPTime::from_frames (f, _film->audio_frame_rate()) - DCPTime (piece->content->trim_start(), piece->frc);
 375         return max (DCPTime (), d + piece->content->position ());
 376 }
 377
 378 ContentTime
 379 Player::dcp_to_content_time (shared_ptr<const Piece> piece, DCPTime t) const
 380 {
 381         DCPTime s = t - piece->content->position ();
 382         s = min (piece->content->length_after_trim(), s);
 383         return max (ContentTime (), ContentTime (s, piece->frc) + piece->content->trim_start());
 384 }
 385
 386 DCPTime
 387 Player::content_time_to_dcp (shared_ptr<const Piece> piece, ContentTime t) const
 388 {
 389         return max (DCPTime (), DCPTime (t - piece->content->trim_start(), piece->frc) + piece->content->position());
 390 }
 391
 392 list<shared_ptr<Font> >
 393 Player::get_subtitle_fonts ()
 394 {
 395         if (!_have_valid_pieces) {
 396                 setup_pieces ();
 397         }
 398
 399         list<shared_ptr<Font> > fonts;
 400         BOOST_FOREACH (shared_ptr<Piece>& p, _pieces) {
 401                 if (p->content->subtitle) {
 402                         /* XXX: things may go wrong if there are duplicate font IDs
 403                            with different font files.
 404                         */
 405                         list<shared_ptr<Font> > f = p->content->subtitle->fonts ();
 406                         copy (f.begin(), f.end(), back_inserter (fonts));
 407                 }
 408         }
 409
 410         return fonts;
 411 }
 412
 413 /** Set this player never to produce any video data */
 414 void
 415 Player::set_ignore_video ()
 416 {
 417         _ignore_video = true;
 418 }
 419
 420 /** Set whether or not this player should always burn text subtitles into the image,
 421  *  regardless of the content settings.
 422  *  @param burn true to always burn subtitles, false to obey content settings.
 423  */
 424 void
 425 Player::set_always_burn_subtitles (bool burn)
 426 {
 427         _always_burn_subtitles = burn;
 428 }
 429
 430 void
 431 Player::set_fast ()
 432 {
 433         _fast = true;
 434         _have_valid_pieces = false;
 435 }
 436
 437 void
 438 Player::set_play_referenced ()
 439 {
 440         _play_referenced = true;
 441         _have_valid_pieces = false;
 442 }
 443
 444 list<ReferencedReelAsset>
 445 Player::get_reel_assets ()
 446 {
 447         list<ReferencedReelAsset> a;
 448
 449         BOOST_FOREACH (shared_ptr<Content> i, _playlist->content ()) {
 450                 shared_ptr<DCPContent> j = dynamic_pointer_cast<DCPContent> (i);
 451                 if (!j) {
 452                         continue;
 453                 }
 454
 455                 scoped_ptr<DCPDecoder> decoder;
 456                 try {
 457                         decoder.reset (new DCPDecoder (j, _film->log()));
 458                 } catch (...) {
 459                         return a;
 460                 }
 461
 462                 int64_t offset = 0;
 463                 BOOST_FOREACH (shared_ptr<dcp::Reel> k, decoder->reels()) {
 464
 465                         DCPOMATIC_ASSERT (j->video_frame_rate ());
 466                         double const cfr = j->video_frame_rate().get();
 467                         Frame const trim_start = j->trim_start().frames_round (cfr);
 468                         Frame const trim_end = j->trim_end().frames_round (cfr);
 469                         int const ffr = _film->video_frame_rate ();
 470
 471                         DCPTime const from = i->position() + DCPTime::from_frames (offset, _film->video_frame_rate());
 472                         if (j->reference_video ()) {
 473                                 shared_ptr<dcp::ReelAsset> ra = k->main_picture ();
 474                                 DCPOMATIC_ASSERT (ra);
 475                                 ra->set_entry_point (ra->entry_point() + trim_start);
 476                                 ra->set_duration (ra->duration() - trim_start - trim_end);
 477                                 a.push_back (
 478                                         ReferencedReelAsset (ra, DCPTimePeriod (from, from + DCPTime::from_frames (ra->duration(), ffr)))
 479                                         );
 480                         }
 481
 482                         if (j->reference_audio ()) {
 483                                 shared_ptr<dcp::ReelAsset> ra = k->main_sound ();
 484                                 DCPOMATIC_ASSERT (ra);
 485                                 ra->set_entry_point (ra->entry_point() + trim_start);
 486                                 ra->set_duration (ra->duration() - trim_start - trim_end);
 487                                 a.push_back (
 488                                         ReferencedReelAsset (ra, DCPTimePeriod (from, from + DCPTime::from_frames (ra->duration(), ffr)))
 489                                         );
 490                         }
 491
 492                         if (j->reference_subtitle ()) {
 493                                 shared_ptr<dcp::ReelAsset> ra = k->main_subtitle ();
 494                                 DCPOMATIC_ASSERT (ra);
 495                                 ra->set_entry_point (ra->entry_point() + trim_start);
 496                                 ra->set_duration (ra->duration() - trim_start - trim_end);
 497                                 a.push_back (
 498                                         ReferencedReelAsset (ra, DCPTimePeriod (from, from + DCPTime::from_frames (ra->duration(), ffr)))
 499                                         );
 500                         }
 501
 502                         /* Assume that main picture duration is the length of the reel */
 503                         offset += k->main_picture()->duration ();
 504                 }
 505         }
 506
 507         return a;
 508 }
 509
 510 bool
 511 Player::pass ()
 512 {
 513         if (!_have_valid_pieces) {
 514                 setup_pieces ();
 515         }
 516
 517         shared_ptr<Piece> earliest;
 518         DCPTime earliest_content;
 519
 520         BOOST_FOREACH (shared_ptr<Piece> i, _pieces) {
 521                 if (!i->done) {
 522                         DCPTime const t = i->content->position() + DCPTime (i->decoder->position(), i->frc);
 523                         if (!earliest || t < earliest_content) {
 524                                 earliest_content = t;
 525                                 earliest = i;
 526                         }
 527                 }
 528         }
 529
 530         if (earliest) {
 531                 earliest->done = earliest->decoder->pass ();
 532                 if (earliest->done && earliest->content->audio) {
 533                         /* Flush the Player audio system for this piece */
 534                         BOOST_FOREACH (AudioStreamPtr i, earliest->content->audio->streams()) {
 535                                 audio_flush (earliest, i);
 536                         }
 537                 }
 538         }
 539
 540         /* Fill towards the next thing that might happen (or the end of the playlist).  This is to fill gaps between content,
 541            NOT to fill gaps within content (the latter is done in ::video())
 542         */
 543         DCPTime fill_towards = earliest ? earliest_content : _playlist->length();
 544
 545         /* Work out where to fill video from */
 546         optional<DCPTime> video_fill_from;
 547         if (_last_video_time && !_playlist->video_content_at(*_last_video_time)) {
 548                 /* Fill from the last video or seek time */
 549                 video_fill_from = _last_video_time;
 550         }
 551
 552         bool filled = false;
 553         /* Fill some black if we would emit before the earliest piece of content.  This is so we act like a phantom
 554            Piece which emits black in spaces (we only emit if we are the earliest thing)
 555         */
 556         /* XXX: this should take _no_video into account */
 557         if (earliest && video_fill_from && *video_fill_from < earliest_content && ((fill_towards - *video_fill_from)) >= one_video_frame()) {
 558                 emit_video (black_player_video_frame(), *video_fill_from);
 559                 filled = true;
 560         } else if (_playlist->length() == DCPTime()) {
 561                 /* Special case of an empty Film; just give one black frame */
 562                 emit_video (black_player_video_frame(), DCPTime());
 563                 filled = true;
 564         }
 565
 566         optional<DCPTime> audio_fill_from;
 567         if (_last_audio_time && !_playlist->audio_content_at(*_last_audio_time)) {
 568                 /* Fill from the last audio or seek time */
 569                 audio_fill_from = _last_audio_time;
 570         }
 571
 572         /* XXX: _no_audio */
 573         if (audio_fill_from && audio_fill_from < fill_towards) {
 574                 DCPTimePeriod period (*audio_fill_from, fill_towards);
 575                 if (period.duration() > one_video_frame()) {
 576                         period.to = period.from + one_video_frame();
 577                 }
 578                 fill_audio (period);
 579                 filled = true;
 580         }
 581
 582         /* Emit any audio that is ready */
 583
 584         DCPTime pull_to = _playlist->length ();
 585         for (map<AudioStreamPtr, StreamState>::const_iterator i = _stream_states.begin(); i != _stream_states.end(); ++i) {
 586                 if (!i->second.piece->done && i->second.last_push_end < pull_to) {
 587                         pull_to = i->second.last_push_end;
 588                 }
 589         }
 590
 591         list<pair<shared_ptr<AudioBuffers>, DCPTime> > audio = _audio_merger.pull (pull_to);
 592         for (list<pair<shared_ptr<AudioBuffers>, DCPTime> >::iterator i = audio.begin(); i != audio.end(); ++i) {
 593                 if (_last_audio_time && i->second < *_last_audio_time) {
 594                         /* There has been an accurate seek and we have received some audio before the seek time;
 595                            discard it.
 596                         */
 597                         pair<shared_ptr<AudioBuffers>, DCPTime> cut = discard_audio (i->first, i->second, *_last_audio_time);
 598                         if (!cut.first) {
 599                                 continue;
 600                         }
 601                         *i = cut;
 602                 }
 603
 604                 if (_last_audio_time) {
 605                         fill_audio (DCPTimePeriod (*_last_audio_time, i->second));
 606                 }
 607
 608                 emit_audio (i->first, i->second);
 609         }
 610
 611         return !earliest && !filled;
 612 }
 613
 614 optional<PositionImage>
 615 Player::subtitles_for_frame (DCPTime time) const
 616 {
 617         list<PositionImage> subtitles;
 618
 619         BOOST_FOREACH (PlayerSubtitles i, _active_subtitles.get_burnt (time, _always_burn_subtitles)) {
 620
 621                 /* Image subtitles */
 622                 list<PositionImage> c = transform_image_subtitles (i.image);
 623                 copy (c.begin(), c.end(), back_inserter (subtitles));
 624
 625                 /* Text subtitles (rendered to an image) */
 626                 if (!i.text.empty ()) {
 627                         list<PositionImage> s = render_subtitles (i.text, i.fonts, _video_container_size, time);
 628                         copy (s.begin(), s.end(), back_inserter (subtitles));
 629                 }
 630         }
 631
 632         if (subtitles.empty ()) {
 633                 return optional<PositionImage> ();
 634         }
 635
 636         return merge (subtitles);
 637 }
 638
 639 void
 640 Player::video (weak_ptr<Piece> wp, ContentVideo video)
 641 {
 642         shared_ptr<Piece> piece = wp.lock ();
 643         if (!piece) {
 644                 return;
 645         }
 646
 647         FrameRateChange frc(piece->content->active_video_frame_rate(), _film->video_frame_rate());
 648         if (frc.skip && (video.frame % 2) == 1) {
 649                 return;
 650         }
 651
 652         /* Time and period of the frame we will emit */
 653         DCPTime const time = content_video_to_dcp (piece, video.frame);
 654         DCPTimePeriod const period (time, time + one_video_frame());
 655
 656         /* Discard if it's outside the content's period or if it's before the last accurate seek */
 657         if (
 658                 time < piece->content->position() ||
 659                 time >= piece->content->end() ||
 660                 (_last_video_time && time < *_last_video_time)) {
 661                 return;
 662         }
 663
 664         /* Fill gaps that we discover now that we have some video which needs to be emitted */
 665
 666         optional<DCPTime> fill_to;
 667         if (_last_video_time) {
 668                 fill_to = _last_video_time;
 669         }
 670
 671         if (fill_to) {
 672                 /* XXX: this may not work for 3D */
 673                 BOOST_FOREACH (DCPTimePeriod i, subtract(DCPTimePeriod (*fill_to, time), _no_video)) {
 674                         for (DCPTime j = i.from; j < i.to; j += one_video_frame()) {
 675                                 LastVideoMap::const_iterator k = _last_video.find (wp);
 676                                 if (k != _last_video.end ()) {
 677                                         emit_video (k->second, j);
 678                                 } else {
 679                                         emit_video (black_player_video_frame(), j);
 680                                 }
 681                         }
 682                 }
 683         }
 684
 685         _last_video[wp].reset (
 686                 new PlayerVideo (
 687                         video.image,
 688                         piece->content->video->crop (),
 689                         piece->content->video->fade (video.frame),
 690                         piece->content->video->scale().size (
 691                                 piece->content->video, _video_container_size, _film->frame_size ()
 692                                 ),
 693                         _video_container_size,
 694                         video.eyes,
 695                         video.part,
 696                         piece->content->video->colour_conversion ()
 697                         )
 698                 );
 699
 700         emit_video (_last_video[wp], time);
 701 }
 702
 703 void
 704 Player::audio_flush (shared_ptr<Piece> piece, AudioStreamPtr stream)
 705 {
 706         shared_ptr<AudioContent> content = piece->content->audio;
 707         DCPOMATIC_ASSERT (content);
 708
 709         shared_ptr<Resampler> r = resampler (content, stream, false);
 710         if (!r) {
 711                 return;
 712         }
 713
 714         pair<shared_ptr<const AudioBuffers>, Frame> ro = r->flush ();
 715         if (ro.first->frames() == 0) {
 716                 return;
 717         }
 718
 719         ContentAudio content_audio;
 720         content_audio.audio = ro.first;
 721         content_audio.frame = ro.second;
 722
 723         /* Compute time in the DCP */
 724         DCPTime time = resampled_audio_to_dcp (piece, content_audio.frame) + DCPTime::from_seconds (content->delay() / 1000.0);
 725
 726         audio_transform (content, stream, content_audio, time);
 727 }
 728
 729 /** Do our common processing on some audio */
 730 void
 731 Player::audio_transform (shared_ptr<AudioContent> content, AudioStreamPtr stream, ContentAudio content_audio, DCPTime time)
 732 {
 733         DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
 734
 735         /* Gain */
 736
 737         if (content->gain() != 0) {
 738                 shared_ptr<AudioBuffers> gain (new AudioBuffers (content_audio.audio));
 739                 gain->apply_gain (content->gain ());
 740                 content_audio.audio = gain;
 741         }
 742
 743         /* Remap */
 744
 745         shared_ptr<AudioBuffers> dcp_mapped (new AudioBuffers (_film->audio_channels(), content_audio.audio->frames()));
 746         dcp_mapped->make_silent ();
 747
 748         AudioMapping map = stream->mapping ();
 749         for (int i = 0; i < map.input_channels(); ++i) {
 750                 for (int j = 0; j < dcp_mapped->channels(); ++j) {
 751                         if (map.get (i, static_cast<dcp::Channel> (j)) > 0) {
 752                                 dcp_mapped->accumulate_channel (
 753                                         content_audio.audio.get(),
 754                                         i,
 755                                         static_cast<dcp::Channel> (j),
 756                                         map.get (i, static_cast<dcp::Channel> (j))
 757                                         );
 758                         }
 759                 }
 760         }
 761
 762         content_audio.audio = dcp_mapped;
 763
 764         /* Process */
 765
 766         if (_audio_processor) {
 767                 content_audio.audio = _audio_processor->run (content_audio.audio, _film->audio_channels ());
 768         }
 769
 770         /* Push */
 771
 772         _audio_merger.push (content_audio.audio, time);
 773         DCPOMATIC_ASSERT (_stream_states.find (stream) != _stream_states.end ());
 774         _stream_states[stream].last_push_end = time + DCPTime::from_frames (content_audio.audio->frames(), _film->audio_frame_rate());
 775 }
 776
 777 void
 778 Player::audio (weak_ptr<Piece> wp, AudioStreamPtr stream, ContentAudio content_audio)
 779 {
 780         DCPOMATIC_ASSERT (content_audio.audio->frames() > 0);
 781
 782         shared_ptr<Piece> piece = wp.lock ();
 783         if (!piece) {
 784                 return;
 785         }
 786
 787         shared_ptr<AudioContent> content = piece->content->audio;
 788         DCPOMATIC_ASSERT (content);
 789
 790         /* Resample */
 791         if (stream->frame_rate() != content->resampled_frame_rate()) {
 792                 shared_ptr<Resampler> r = resampler (content, stream, true);
 793                 pair<shared_ptr<const AudioBuffers>, Frame> ro = r->run (content_audio.audio, content_audio.frame);
 794                 if (ro.first->frames() == 0) {
 795                         return;
 796                 }
 797                 content_audio.audio = ro.first;
 798                 content_audio.frame = ro.second;
 799         }
 800
 801         /* Compute time in the DCP */
 802         DCPTime time = resampled_audio_to_dcp (piece, content_audio.frame) + DCPTime::from_seconds (content->delay() / 1000.0);
 803         /* And the end of this block in the DCP */
 804         DCPTime end = time + DCPTime::from_frames(content_audio.audio->frames(), content->resampled_frame_rate());
 805
 806         /* Pad any gap which may be caused by audio delay */
 807         if (_last_audio_time) {
 808                 fill_audio (DCPTimePeriod (*_last_audio_time, time));
 809         }
 810
 811         /* Remove anything that comes before the start or after the end of the content */
 812         if (time < piece->content->position()) {
 813                 pair<shared_ptr<AudioBuffers>, DCPTime> cut = discard_audio (content_audio.audio, time, piece->content->position());
 814                 if (!cut.first) {
 815                         /* This audio is entirely discarded */
 816                         return;
 817                 }
 818                 content_audio.audio = cut.first;
 819                 time = cut.second;
 820         } else if (time > piece->content->end()) {
 821                 /* Discard it all */
 822                 return;
 823         } else if (end > piece->content->end()) {
 824                 Frame const remaining_frames = DCPTime(piece->content->end() - time).frames_round(_film->audio_frame_rate());
 825                 if (remaining_frames == 0) {
 826                         return;
 827                 }
 828                 shared_ptr<AudioBuffers> cut (new AudioBuffers (content_audio.audio->channels(), remaining_frames));
 829                 cut->copy_from (content_audio.audio.get(), remaining_frames, 0, 0);
 830                 content_audio.audio = cut;
 831         }
 832
 833         audio_transform (content, stream, content_audio, time);
 834 }
 835
 836 void
 837 Player::image_subtitle_start (weak_ptr<Piece> wp, ContentImageSubtitle subtitle)
 838 {
 839         shared_ptr<Piece> piece = wp.lock ();
 840         if (!piece) {
 841                 return;
 842         }
 843
 844         /* Apply content's subtitle offsets */
 845         subtitle.sub.rectangle.x += piece->content->subtitle->x_offset ();
 846         subtitle.sub.rectangle.y += piece->content->subtitle->y_offset ();
 847
 848         /* Apply content's subtitle scale */
 849         subtitle.sub.rectangle.width *= piece->content->subtitle->x_scale ();
 850         subtitle.sub.rectangle.height *= piece->content->subtitle->y_scale ();
 851
 852         /* Apply a corrective translation to keep the subtitle centred after that scale */
 853         subtitle.sub.rectangle.x -= subtitle.sub.rectangle.width * (piece->content->subtitle->x_scale() - 1);
 854         subtitle.sub.rectangle.y -= subtitle.sub.rectangle.height * (piece->content->subtitle->y_scale() - 1);
 855
 856         PlayerSubtitles ps;
 857         ps.image.push_back (subtitle.sub);
 858         DCPTime from (content_time_to_dcp (piece, subtitle.from()));
 859
 860         _active_subtitles.add_from (wp, ps, from);
 861 }
 862
 863 void
 864 Player::text_subtitle_start (weak_ptr<Piece> wp, ContentTextSubtitle subtitle)
 865 {
 866         shared_ptr<Piece> piece = wp.lock ();
 867         if (!piece) {
 868                 return;
 869         }
 870
 871         PlayerSubtitles ps;
 872         DCPTime const from (content_time_to_dcp (piece, subtitle.from()));
 873
 874         BOOST_FOREACH (dcp::SubtitleString s, subtitle.subs) {
 875                 s.set_h_position (s.h_position() + piece->content->subtitle->x_offset ());
 876                 s.set_v_position (s.v_position() + piece->content->subtitle->y_offset ());
 877                 float const xs = piece->content->subtitle->x_scale();
 878                 float const ys = piece->content->subtitle->y_scale();
 879                 float size = s.size();
 880
 881                 /* Adjust size to express the common part of the scaling;
 882                    e.g. if xs = ys = 0.5 we scale size by 2.
 883                 */
 884                 if (xs > 1e-5 && ys > 1e-5) {
 885                         size *= 1 / min (1 / xs, 1 / ys);
 886                 }
 887                 s.set_size (size);
 888
 889                 /* Then express aspect ratio changes */
 890                 if (fabs (1.0 - xs / ys) > dcp::ASPECT_ADJUST_EPSILON) {
 891                         s.set_aspect_adjust (xs / ys);
 892                 }
 893
 894                 s.set_in (dcp::Time(from.seconds(), 1000));
 895                 ps.text.push_back (SubtitleString (s, piece->content->subtitle->outline_width()));
 896                 ps.add_fonts (piece->content->subtitle->fonts ());
 897         }
 898
 899         _active_subtitles.add_from (wp, ps, from);
 900 }
 901
 902 void
 903 Player::subtitle_stop (weak_ptr<Piece> wp, ContentTime to)
 904 {
 905         if (!_active_subtitles.have (wp)) {
 906                 return;
 907         }
 908
 909         shared_ptr<Piece> piece = wp.lock ();
 910         if (!piece) {
 911                 return;
 912         }
 913
 914         DCPTime const dcp_to = content_time_to_dcp (piece, to);
 915
 916         pair<PlayerSubtitles, DCPTime> from = _active_subtitles.add_to (wp, dcp_to);
 917
 918         if (piece->content->subtitle->use() && !_always_burn_subtitles && !piece->content->subtitle->burn()) {
 919                 Subtitle (from.first, DCPTimePeriod (from.second, dcp_to));
 920         }
 921 }
 922
 923 void
 924 Player::seek (DCPTime time, bool accurate)
 925 {
 926         if (_audio_processor) {
 927                 _audio_processor->flush ();
 928         }
 929
 930         for (ResamplerMap::iterator i = _resamplers.begin(); i != _resamplers.end(); ++i) {
 931                 i->second->flush ();
 932                 i->second->reset ();
 933         }
 934
 935         _audio_merger.clear ();
 936         _active_subtitles.clear ();
 937
 938         BOOST_FOREACH (shared_ptr<Piece> i, _pieces) {
 939                 if (time < i->content->position()) {
 940                         /* Before; seek to 0 */
 941                         i->decoder->seek (ContentTime(), accurate);
 942                         i->done = false;
 943                 } else if (i->content->position() <= time && time < i->content->end()) {
 944                         /* During; seek to position */
 945                         i->decoder->seek (dcp_to_content_time (i, time), accurate);
 946                         i->done = false;
 947                 } else {
 948                         /* After; this piece is done */
 949                         i->done = true;
 950                 }
 951         }
 952
 953         if (accurate) {
 954                 _last_video_time = time;
 955                 _last_audio_time = time;
 956         } else {
 957                 _last_video_time = optional<DCPTime>();
 958                 _last_audio_time = optional<DCPTime>();
 959         }
 960 }
 961
 962 shared_ptr<Resampler>
 963 Player::resampler (shared_ptr<const AudioContent> content, AudioStreamPtr stream, bool create)
 964 {
 965         ResamplerMap::const_iterator i = _resamplers.find (make_pair (content, stream));
 966         if (i != _resamplers.end ()) {
 967                 return i->second;
 968         }
 969
 970         if (!create) {
 971                 return shared_ptr<Resampler> ();
 972         }
 973
 974         LOG_GENERAL (
 975                 "Creating new resampler from %1 to %2 with %3 channels",
 976                 stream->frame_rate(),
 977                 content->resampled_frame_rate(),
 978                 stream->channels()
 979                 );
 980
 981         shared_ptr<Resampler> r (
 982                 new Resampler (stream->frame_rate(), content->resampled_frame_rate(), stream->channels())
 983                 );
 984
 985         _resamplers[make_pair(content, stream)] = r;
 986         return r;
 987 }
 988
 989 void
 990 Player::emit_video (shared_ptr<PlayerVideo> pv, DCPTime time)
 991 {
 992         optional<PositionImage> subtitles = subtitles_for_frame (time);
 993         if (subtitles) {
 994                 pv->set_subtitle (subtitles.get ());
 995         }
 996         Video (pv, time);
 997         _last_video_time = time + one_video_frame();
 998         _active_subtitles.clear_before (time);
 999 }
1000
1001 void
1002 Player::emit_audio (shared_ptr<AudioBuffers> data, DCPTime time)
1003 {
1004         Audio (data, time);
1005         _last_audio_time = time + DCPTime::from_frames (data->frames(), _film->audio_frame_rate ());
1006 }
1007
1008 void
1009 Player::fill_audio (DCPTimePeriod period)
1010 {
1011         BOOST_FOREACH (DCPTimePeriod i, subtract(period, _no_audio)) {
1012                 DCPTime t = i.from;
1013                 while (t < i.to) {
1014                         DCPTime block = min (DCPTime::from_seconds (0.5), i.to - t);
1015                         Frame const samples = block.frames_round(_film->audio_frame_rate());
1016                         if (samples) {
1017                                 shared_ptr<AudioBuffers> silence (new AudioBuffers (_film->audio_channels(), samples));
1018                                 silence->make_silent ();
1019                                 emit_audio (silence, t);
1020                         }
1021                         t += block;
1022                 }
1023         }
1024 }
1025
1026 DCPTime
1027 Player::one_video_frame () const
1028 {
1029         return DCPTime::from_frames (1, _film->video_frame_rate ());
1030 }
1031
1032 pair<shared_ptr<AudioBuffers>, DCPTime>
1033 Player::discard_audio (shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to) const
1034 {
1035         DCPTime const discard_time = discard_to - time;
1036         Frame const discard_frames = discard_time.frames_round(_film->audio_frame_rate());
1037         Frame remaining_frames = audio->frames() - discard_frames;
1038         if (remaining_frames <= 0) {
1039                 return make_pair(shared_ptr<AudioBuffers>(), DCPTime());
1040         }
1041         shared_ptr<AudioBuffers> cut (new AudioBuffers (audio->channels(), remaining_frames));
1042         cut->copy_from (audio.get(), remaining_frames, discard_frames, 0);
1043         return make_pair(cut, time + discard_time);
1044 }