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