src/lib/writer.cc

   1 /*
   2     Copyright (C) 2012-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 "writer.h"
  22 #include "compose.hpp"
  23 #include "film.h"
  24 #include "ratio.h"
  25 #include "log.h"
  26 #include "dcp_video.h"
  27 #include "dcp_content_type.h"
  28 #include "audio_mapping.h"
  29 #include "config.h"
  30 #include "job.h"
  31 #include "cross.h"
  32 #include "audio_buffers.h"
  33 #include "version.h"
  34 #include "font.h"
  35 #include "util.h"
  36 #include "reel_writer.h"
  37 #include <dcp/cpl.h>
  38 #include <dcp/locale_convert.h>
  39 #include <boost/foreach.hpp>
  40 #include <fstream>
  41 #include <cerrno>
  42 #include <iostream>
  43 #include <cfloat>
  44
  45 #include "i18n.h"
  46
  47 #define LOG_GENERAL(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
  48 #define LOG_GENERAL_NC(...) _film->log()->log (__VA_ARGS__, LogEntry::TYPE_GENERAL);
  49 #define LOG_DEBUG_ENCODE(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_DEBUG_ENCODE);
  50 #define LOG_TIMING(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_TIMING);
  51 #define LOG_WARNING_NC(...) _film->log()->log (__VA_ARGS__, LogEntry::TYPE_WARNING);
  52 #define LOG_WARNING(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_WARNING);
  53 #define LOG_ERROR(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_ERROR);
  54
  55 /* OS X strikes again */
  56 #undef set_key
  57
  58 using std::make_pair;
  59 using std::pair;
  60 using std::string;
  61 using std::list;
  62 using std::cout;
  63 using std::map;
  64 using std::min;
  65 using std::max;
  66 using boost::shared_ptr;
  67 using boost::weak_ptr;
  68 using boost::dynamic_pointer_cast;
  69 using dcp::Data;
  70
  71 Writer::Writer (shared_ptr<const Film> film, weak_ptr<Job> j)
  72         : _film (film)
  73         , _job (j)
  74         , _thread (0)
  75         , _finish (false)
  76         , _queued_full_in_memory (0)
  77         , _maximum_frames_in_memory (0)
  78         , _full_written (0)
  79         , _fake_written (0)
  80         , _repeat_written (0)
  81         , _pushed_to_disk (0)
  82 {
  83         shared_ptr<Job> job = _job.lock ();
  84         DCPOMATIC_ASSERT (job);
  85
  86         int reel_index = 0;
  87         list<DCPTimePeriod> const reels = _film->reels ();
  88         BOOST_FOREACH (DCPTimePeriod p, reels) {
  89                 _reels.push_back (ReelWriter (film, p, job, reel_index++, reels.size(), _film->content_summary(p)));
  90         }
  91
  92         /* We can keep track of the current audio and subtitle reels easily because audio
  93            and subs arrive to the Writer in sequence.  This is not so for video.
  94         */
  95         _audio_reel = _reels.begin ();
  96         _subtitle_reel = _reels.begin ();
  97
  98         /* Check that the signer is OK if we need one */
  99         string reason;
 100         if (_film->is_signed() && !Config::instance()->signer_chain()->valid(&reason)) {
 101                 throw InvalidSignerError (reason);
 102         }
 103 }
 104
 105 void
 106 Writer::start ()
 107 {
 108         _thread = new boost::thread (boost::bind (&Writer::thread, this));
 109 }
 110
 111 Writer::~Writer ()
 112 {
 113         terminate_thread (false);
 114 }
 115
 116 /** Pass a video frame to the writer for writing to disk at some point.
 117  *  This method can be called with frames out of order.
 118  *  @param encoded JPEG2000-encoded data.
 119  *  @param frame Frame index within the DCP.
 120  *  @param eyes Eyes that this frame image is for.
 121  */
 122 void
 123 Writer::write (Data encoded, Frame frame, Eyes eyes)
 124 {
 125         boost::mutex::scoped_lock lock (_state_mutex);
 126
 127         while (_queued_full_in_memory > _maximum_frames_in_memory) {
 128                 /* The queue is too big; wait until that is sorted out */
 129                 _full_condition.wait (lock);
 130         }
 131
 132         QueueItem qi;
 133         qi.type = QueueItem::FULL;
 134         qi.encoded = encoded;
 135         qi.reel = video_reel (frame);
 136         qi.frame = frame - _reels[qi.reel].start ();
 137
 138         if (_film->three_d() && eyes == EYES_BOTH) {
 139                 /* 2D material in a 3D DCP; fake the 3D */
 140                 qi.eyes = EYES_LEFT;
 141                 _queue.push_back (qi);
 142                 ++_queued_full_in_memory;
 143                 qi.eyes = EYES_RIGHT;
 144                 _queue.push_back (qi);
 145                 ++_queued_full_in_memory;
 146         } else {
 147                 qi.eyes = eyes;
 148                 _queue.push_back (qi);
 149                 ++_queued_full_in_memory;
 150         }
 151
 152         /* Now there's something to do: wake anything wait()ing on _empty_condition */
 153         _empty_condition.notify_all ();
 154 }
 155
 156 bool
 157 Writer::can_repeat (Frame frame) const
 158 {
 159         return frame > _reels[video_reel(frame)].start();
 160 }
 161
 162 /** Repeat the last frame that was written to a reel as a new frame.
 163  *  @param frame Frame index within the DCP of the new (repeated) frame.
 164  *  @param eyes Eyes that this repeated frame image is for.
 165  */
 166 void
 167 Writer::repeat (Frame frame, Eyes eyes)
 168 {
 169         boost::mutex::scoped_lock lock (_state_mutex);
 170
 171         while (_queued_full_in_memory > _maximum_frames_in_memory) {
 172                 /* The queue is too big; wait until that is sorted out */
 173                 _full_condition.wait (lock);
 174         }
 175
 176         QueueItem qi;
 177         qi.type = QueueItem::REPEAT;
 178         qi.reel = video_reel (frame);
 179         qi.frame = frame - _reels[qi.reel].start ();
 180         if (_film->three_d() && eyes == EYES_BOTH) {
 181                 qi.eyes = EYES_LEFT;
 182                 _queue.push_back (qi);
 183                 qi.eyes = EYES_RIGHT;
 184                 _queue.push_back (qi);
 185         } else {
 186                 qi.eyes = eyes;
 187                 _queue.push_back (qi);
 188         }
 189
 190         /* Now there's something to do: wake anything wait()ing on _empty_condition */
 191         _empty_condition.notify_all ();
 192 }
 193
 194 void
 195 Writer::fake_write (Frame frame, Eyes eyes)
 196 {
 197         boost::mutex::scoped_lock lock (_state_mutex);
 198
 199         while (_queued_full_in_memory > _maximum_frames_in_memory) {
 200                 /* The queue is too big; wait until that is sorted out */
 201                 _full_condition.wait (lock);
 202         }
 203
 204         size_t const reel = video_reel (frame);
 205         Frame const reel_frame = frame - _reels[reel].start ();
 206
 207         FILE* file = fopen_boost (_film->info_file(_reels[reel].period()), "rb");
 208         if (!file) {
 209                 throw ReadFileError (_film->info_file(_reels[reel].period()));
 210         }
 211         dcp::FrameInfo info = _reels[reel].read_frame_info (file, reel_frame, eyes);
 212         fclose (file);
 213
 214         QueueItem qi;
 215         qi.type = QueueItem::FAKE;
 216         qi.size = info.size;
 217         qi.reel = reel;
 218         qi.frame = reel_frame;
 219         if (_film->three_d() && eyes == EYES_BOTH) {
 220                 qi.eyes = EYES_LEFT;
 221                 _queue.push_back (qi);
 222                 qi.eyes = EYES_RIGHT;
 223                 _queue.push_back (qi);
 224         } else {
 225                 qi.eyes = eyes;
 226                 _queue.push_back (qi);
 227         }
 228
 229         /* Now there's something to do: wake anything wait()ing on _empty_condition */
 230         _empty_condition.notify_all ();
 231 }
 232
 233 /** Write some audio frames to the DCP.
 234  *  @param audio Audio data.
 235  *  @param time Time of this data within the DCP.
 236  *  This method is not thread safe.
 237  */
 238 void
 239 Writer::write (shared_ptr<const AudioBuffers> audio, DCPTime const time)
 240 {
 241         DCPOMATIC_ASSERT (audio);
 242
 243         int const afr = _film->audio_frame_rate();
 244
 245         DCPTime const end = time + DCPTime::from_frames(audio->frames(), afr);
 246
 247         /* The audio we get might span a reel boundary, and if so we have to write it in bits */
 248
 249         DCPTime t = time;
 250         while (t < end) {
 251
 252                 if (_audio_reel == _reels.end ()) {
 253                         /* This audio is off the end of the last reel; ignore it */
 254                         return;
 255                 }
 256
 257                 if (end <= _audio_reel->period().to) {
 258                         /* Easy case: we can write all the audio to this reel */
 259                         _audio_reel->write (audio);
 260                         t = end;
 261                 } else {
 262                         /* Split the audio into two and write the first part */
 263                         DCPTime part_lengths[2] = {
 264                                 _audio_reel->period().to - t,
 265                                 end - _audio_reel->period().to
 266                         };
 267
 268                         Frame part_frames[2] = {
 269                                 part_lengths[0].frames_ceil(afr),
 270                                 part_lengths[1].frames_ceil(afr)
 271                         };
 272
 273                         if (part_frames[0]) {
 274                                 shared_ptr<AudioBuffers> part (new AudioBuffers (audio->channels(), part_frames[0]));
 275                                 part->copy_from (audio.get(), part_frames[0], 0, 0);
 276                                 _audio_reel->write (part);
 277                         }
 278
 279                         if (part_frames[1]) {
 280                                 shared_ptr<AudioBuffers> part (new AudioBuffers (audio->channels(), part_frames[1]));
 281                                 part->copy_from (audio.get(), part_frames[1], part_frames[0], 0);
 282                                 audio = part;
 283                         } else {
 284                                 audio.reset ();
 285                         }
 286
 287                         ++_audio_reel;
 288                         t += part_lengths[0];
 289                 }
 290         }
 291 }
 292
 293 /** This must be called from Writer::thread() with an appropriate lock held */
 294 bool
 295 Writer::have_sequenced_image_at_queue_head ()
 296 {
 297         if (_queue.empty ()) {
 298                 return false;
 299         }
 300
 301         _queue.sort ();
 302
 303         QueueItem const & f = _queue.front();
 304         ReelWriter const & reel = _reels[f.reel];
 305
 306         /* The queue should contain only EYES_LEFT/EYES_RIGHT pairs or EYES_BOTH */
 307
 308         if (f.eyes == EYES_BOTH) {
 309                 /* 2D */
 310                 return f.frame == (reel.last_written_video_frame() + 1);
 311         }
 312
 313         /* 3D */
 314
 315         if (reel.last_written_eyes() == EYES_LEFT && f.frame == reel.last_written_video_frame() && f.eyes == EYES_RIGHT) {
 316                 return true;
 317         }
 318
 319         if (reel.last_written_eyes() == EYES_RIGHT && f.frame == (reel.last_written_video_frame() + 1) && f.eyes == EYES_LEFT) {
 320                 return true;
 321         }
 322
 323         return false;
 324 }
 325
 326 void
 327 Writer::thread ()
 328 try
 329 {
 330         while (true)
 331         {
 332                 boost::mutex::scoped_lock lock (_state_mutex);
 333
 334                 while (true) {
 335
 336                         if (_finish || _queued_full_in_memory > _maximum_frames_in_memory || have_sequenced_image_at_queue_head ()) {
 337                                 /* We've got something to do: go and do it */
 338                                 break;
 339                         }
 340
 341                         /* Nothing to do: wait until something happens which may indicate that we do */
 342                         LOG_TIMING (N_("writer-sleep queue=%1"), _queue.size());
 343                         _empty_condition.wait (lock);
 344                         LOG_TIMING (N_("writer-wake queue=%1"), _queue.size());
 345                 }
 346
 347                 if (_finish && _queue.empty()) {
 348                         return;
 349                 }
 350
 351                 /* We stop here if we have been asked to finish, and if either the queue
 352                    is empty or we do not have a sequenced image at its head (if this is the
 353                    case we will never terminate as no new frames will be sent once
 354                    _finish is true).
 355                 */
 356                 if (_finish && (!have_sequenced_image_at_queue_head() || _queue.empty())) {
 357                         /* (Hopefully temporarily) log anything that was not written */
 358                         if (!_queue.empty() && !have_sequenced_image_at_queue_head()) {
 359                                 LOG_WARNING (N_("Finishing writer with a left-over queue of %1:"), _queue.size());
 360                                 for (list<QueueItem>::const_iterator i = _queue.begin(); i != _queue.end(); ++i) {
 361                                         if (i->type == QueueItem::FULL) {
 362                                                 LOG_WARNING (N_("- type FULL, frame %1, eyes %2"), i->frame, (int) i->eyes);
 363                                         } else {
 364                                                 LOG_WARNING (N_("- type FAKE, size %1, frame %2, eyes %3"), i->size, i->frame, (int) i->eyes);
 365                                         }
 366                                 }
 367                         }
 368                         return;
 369                 }
 370
 371                 /* Write any frames that we can write; i.e. those that are in sequence. */
 372                 while (have_sequenced_image_at_queue_head ()) {
 373                         QueueItem qi = _queue.front ();
 374                         _queue.pop_front ();
 375                         if (qi.type == QueueItem::FULL && qi.encoded) {
 376                                 --_queued_full_in_memory;
 377                         }
 378
 379                         lock.unlock ();
 380
 381                         ReelWriter& reel = _reels[qi.reel];
 382
 383                         switch (qi.type) {
 384                         case QueueItem::FULL:
 385                                 LOG_DEBUG_ENCODE (N_("Writer FULL-writes %1 (%2)"), qi.frame, (int) qi.eyes);
 386                                 if (!qi.encoded) {
 387                                         qi.encoded = Data (_film->j2c_path (qi.reel, qi.frame, qi.eyes, false));
 388                                 }
 389                                 reel.write (qi.encoded, qi.frame, qi.eyes);
 390                                 ++_full_written;
 391                                 break;
 392                         case QueueItem::FAKE:
 393                                 LOG_DEBUG_ENCODE (N_("Writer FAKE-writes %1"), qi.frame);
 394                                 reel.fake_write (qi.frame, qi.eyes, qi.size);
 395                                 ++_fake_written;
 396                                 break;
 397                         case QueueItem::REPEAT:
 398                                 LOG_DEBUG_ENCODE (N_("Writer REPEAT-writes %1"), qi.frame);
 399                                 reel.repeat_write (qi.frame, qi.eyes);
 400                                 ++_repeat_written;
 401                                 break;
 402                         }
 403
 404                         lock.lock ();
 405                 }
 406
 407                 while (_queued_full_in_memory > _maximum_frames_in_memory) {
 408                         /* Too many frames in memory which can't yet be written to the stream.
 409                            Write some FULL frames to disk.
 410                         */
 411
 412                         /* Find one from the back of the queue */
 413                         _queue.sort ();
 414                         list<QueueItem>::reverse_iterator i = _queue.rbegin ();
 415                         while (i != _queue.rend() && (i->type != QueueItem::FULL || !i->encoded)) {
 416                                 ++i;
 417                         }
 418
 419                         DCPOMATIC_ASSERT (i != _queue.rend());
 420                         ++_pushed_to_disk;
 421                         /* For the log message below */
 422                         int const awaiting = _reels[_queue.front().reel].last_written_video_frame();
 423                         lock.unlock ();
 424
 425                         /* i is valid here, even though we don't hold a lock on the mutex,
 426                            since list iterators are unaffected by insertion and only this
 427                            thread could erase the last item in the list.
 428                         */
 429
 430                         LOG_GENERAL ("Writer full; pushes %1 to disk while awaiting %2", i->frame, awaiting);
 431
 432                         i->encoded->write_via_temp (
 433                                 _film->j2c_path (i->reel, i->frame, i->eyes, true),
 434                                 _film->j2c_path (i->reel, i->frame, i->eyes, false)
 435                                 );
 436
 437                         lock.lock ();
 438                         i->encoded.reset ();
 439                         --_queued_full_in_memory;
 440                 }
 441
 442                 /* The queue has probably just gone down a bit; notify anything wait()ing on _full_condition */
 443                 _full_condition.notify_all ();
 444         }
 445 }
 446 catch (...)
 447 {
 448         store_current ();
 449 }
 450
 451 void
 452 Writer::terminate_thread (bool can_throw)
 453 {
 454         boost::mutex::scoped_lock lock (_state_mutex);
 455         if (_thread == 0) {
 456                 return;
 457         }
 458
 459         _finish = true;
 460         _empty_condition.notify_all ();
 461         _full_condition.notify_all ();
 462         lock.unlock ();
 463
 464         if (_thread->joinable ()) {
 465                 _thread->join ();
 466         }
 467
 468         if (can_throw) {
 469                 rethrow ();
 470         }
 471
 472         delete _thread;
 473         _thread = 0;
 474 }
 475
 476 void
 477 Writer::finish ()
 478 {
 479         if (!_thread) {
 480                 return;
 481         }
 482
 483         LOG_GENERAL_NC ("Terminating writer thread");
 484
 485         terminate_thread (true);
 486
 487         LOG_GENERAL_NC ("Finishing ReelWriters");
 488
 489         BOOST_FOREACH (ReelWriter& i, _reels) {
 490                 i.finish ();
 491         }
 492
 493         LOG_GENERAL_NC ("Writing XML");
 494
 495         dcp::DCP dcp (_film->dir (_film->dcp_name()));
 496
 497         shared_ptr<dcp::CPL> cpl (
 498                 new dcp::CPL (
 499                         _film->dcp_name(),
 500                         _film->dcp_content_type()->libdcp_kind ()
 501                         )
 502                 );
 503
 504         dcp.add (cpl);
 505
 506         /* Calculate digests for each reel in parallel */
 507
 508         shared_ptr<Job> job = _job.lock ();
 509         job->sub (_("Computing digests"));
 510
 511         boost::asio::io_service service;
 512         boost::thread_group pool;
 513
 514         shared_ptr<boost::asio::io_service::work> work (new boost::asio::io_service::work (service));
 515
 516         int const threads = max (1, Config::instance()->master_encoding_threads ());
 517
 518         for (int i = 0; i < threads; ++i) {
 519                 pool.create_thread (boost::bind (&boost::asio::io_service::run, &service));
 520         }
 521
 522         BOOST_FOREACH (ReelWriter& i, _reels) {
 523                 boost::function<void (float)> set_progress = boost::bind (&Writer::set_digest_progress, this, job.get(), _1);
 524                 service.post (boost::bind (&ReelWriter::calculate_digests, &i, set_progress));
 525         }
 526
 527         work.reset ();
 528         pool.join_all ();
 529         service.stop ();
 530
 531         /* Add reels to CPL */
 532
 533         BOOST_FOREACH (ReelWriter& i, _reels) {
 534                 cpl->add (i.create_reel (_reel_assets, _fonts));
 535         }
 536
 537         dcp::XMLMetadata meta;
 538         meta.annotation_text = cpl->annotation_text ();
 539         meta.creator = Config::instance()->dcp_creator ();
 540         if (meta.creator.empty ()) {
 541                 meta.creator = String::compose ("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit);
 542         }
 543         meta.issuer = Config::instance()->dcp_issuer ();
 544         if (meta.issuer.empty ()) {
 545                 meta.issuer = String::compose ("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit);
 546         }
 547         meta.set_issue_date_now ();
 548
 549         cpl->set_metadata (meta);
 550
 551         shared_ptr<const dcp::CertificateChain> signer;
 552         if (_film->is_signed ()) {
 553                 signer = Config::instance()->signer_chain ();
 554                 /* We did check earlier, but check again here to be on the safe side */
 555                 string reason;
 556                 if (!signer->valid (&reason)) {
 557                         throw InvalidSignerError (reason);
 558                 }
 559         }
 560
 561         dcp.write_xml (_film->interop () ? dcp::INTEROP : dcp::SMPTE, meta, signer, Config::instance()->dcp_metadata_filename_format());
 562
 563         LOG_GENERAL (
 564                 N_("Wrote %1 FULL, %2 FAKE, %3 REPEAT, %4 pushed to disk"), _full_written, _fake_written, _repeat_written, _pushed_to_disk
 565                 );
 566
 567         write_cover_sheet ();
 568 }
 569
 570 void
 571 Writer::write_cover_sheet ()
 572 {
 573         boost::filesystem::path const cover = _film->file ("COVER_SHEET.txt");
 574         FILE* f = fopen_boost (cover, "w");
 575         if (!f) {
 576                 throw OpenFileError (cover, errno, false);
 577         }
 578
 579         string text = Config::instance()->cover_sheet ();
 580         boost::algorithm::replace_all (text, "$CPL_NAME", _film->name());
 581         boost::algorithm::replace_all (text, "$TYPE", _film->dcp_content_type()->pretty_name());
 582         boost::algorithm::replace_all (text, "$CONTAINER", _film->container()->container_nickname());
 583         boost::algorithm::replace_all (text, "$AUDIO_LANGUAGE", _film->isdcf_metadata().audio_language);
 584         boost::algorithm::replace_all (text, "$SUBTITLE_LANGUAGE", _film->isdcf_metadata().subtitle_language);
 585
 586         boost::uintmax_t size = 0;
 587         for (
 588                 boost::filesystem::recursive_directory_iterator i = boost::filesystem::recursive_directory_iterator(_film->dir(_film->dcp_name()));
 589                 i != boost::filesystem::recursive_directory_iterator();
 590                 ++i) {
 591                 if (boost::filesystem::is_regular_file (i->path ())) {
 592                         size += boost::filesystem::file_size (i->path ());
 593                 }
 594         }
 595
 596         if (size > (1000000000L)) {
 597                 boost::algorithm::replace_all (text, "$SIZE", String::compose ("%1GB", dcp::locale_convert<string> (size / 1000000000.0, 1, true)));
 598         } else {
 599                 boost::algorithm::replace_all (text, "$SIZE", String::compose ("%1MB", dcp::locale_convert<string> (size / 1000000.0, 1, true)));
 600         }
 601
 602         pair<int, int> ch = audio_channel_types (_film->mapped_audio_channels(), _film->audio_channels());
 603         string description = String::compose("%1.%2", ch.first, ch.second);
 604
 605         if (description == "0.0") {
 606                 description = _("None");
 607         } else if (description == "1.0") {
 608                 description = _("Mono");
 609         } else if (description == "2.0") {
 610                 description = _("Stereo");
 611         }
 612         boost::algorithm::replace_all (text, "$AUDIO", description);
 613
 614         int h, m, s, fr;
 615         _film->length().split (_film->video_frame_rate(), h, m, s, fr);
 616         string length;
 617         if (h == 0 && m == 0) {
 618                 length = String::compose("%1s", s);
 619         } else if (h == 0 && m > 0) {
 620                 length = String::compose("%1m%2s", m, s);
 621         } else if (h > 0 && m > 0) {
 622                 length = String::compose("%1h%2m%3s", h, m, s);
 623         }
 624
 625         boost::algorithm::replace_all (text, "$LENGTH", length);
 626
 627         fwrite (text.c_str(), 1, text.length(), f);
 628         fclose (f);
 629 }
 630
 631 /** @param frame Frame index within the whole DCP.
 632  *  @return true if we can fake-write this frame.
 633  */
 634 bool
 635 Writer::can_fake_write (Frame frame) const
 636 {
 637         /* We have to do a proper write of the first frame so that we can set up the JPEG2000
 638            parameters in the asset writer.
 639         */
 640
 641         ReelWriter const & reel = _reels[video_reel(frame)];
 642
 643         /* Make frame relative to the start of the reel */
 644         frame -= reel.start ();
 645         return (frame != 0 && frame < reel.first_nonexistant_frame());
 646 }
 647
 648 void
 649 Writer::write (PlayerSubtitles subs, DCPTimePeriod period)
 650 {
 651         if (subs.text.empty ()) {
 652                 return;
 653         }
 654
 655         if (_subtitle_reel->period().to <= period.from) {
 656                 ++_subtitle_reel;
 657         }
 658
 659         _subtitle_reel->write (subs);
 660 }
 661
 662 void
 663 Writer::write (list<shared_ptr<Font> > fonts)
 664 {
 665         /* Just keep a list of unique fonts and we'll deal with them in ::finish */
 666
 667         BOOST_FOREACH (shared_ptr<Font> i, fonts) {
 668                 bool got = false;
 669                 BOOST_FOREACH (shared_ptr<Font> j, _fonts) {
 670                         if (*i == *j) {
 671                                 got = true;
 672                         }
 673                 }
 674
 675                 if (!got) {
 676                         _fonts.push_back (i);
 677                 }
 678         }
 679 }
 680
 681 bool
 682 operator< (QueueItem const & a, QueueItem const & b)
 683 {
 684         if (a.reel != b.reel) {
 685                 return a.reel < b.reel;
 686         }
 687
 688         if (a.frame != b.frame) {
 689                 return a.frame < b.frame;
 690         }
 691
 692         return static_cast<int> (a.eyes) < static_cast<int> (b.eyes);
 693 }
 694
 695 bool
 696 operator== (QueueItem const & a, QueueItem const & b)
 697 {
 698         return a.reel == b.reel && a.frame == b.frame && a.eyes == b.eyes;
 699 }
 700
 701 void
 702 Writer::set_encoder_threads (int threads)
 703 {
 704         _maximum_frames_in_memory = lrint (threads * Config::instance()->frames_in_memory_multiplier());
 705 }
 706
 707 void
 708 Writer::write (ReferencedReelAsset asset)
 709 {
 710         _reel_assets.push_back (asset);
 711 }
 712
 713 size_t
 714 Writer::video_reel (int frame) const
 715 {
 716         DCPTime t = DCPTime::from_frames (frame, _film->video_frame_rate ());
 717         size_t i = 0;
 718         while (i < _reels.size() && !_reels[i].period().contains (t)) {
 719                 ++i;
 720         }
 721
 722         DCPOMATIC_ASSERT (i < _reels.size ());
 723         return i;
 724 }
 725
 726 void
 727 Writer::set_digest_progress (Job* job, float progress)
 728 {
 729         /* I believe this is thread-safe */
 730         _digest_progresses[boost::this_thread::get_id()] = progress;
 731
 732         boost::mutex::scoped_lock lm (_digest_progresses_mutex);
 733         float min_progress = FLT_MAX;
 734         for (map<boost::thread::id, float>::const_iterator i = _digest_progresses.begin(); i != _digest_progresses.end(); ++i) {
 735                 min_progress = min (min_progress, i->second);
 736         }
 737
 738         job->set_progress (min_progress);
 739 }