src/lib/writer.cc

   1 /*
   2     Copyright (C) 2012-2016 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 "md5_digester.h"
  34 #include "version.h"
  35 #include "font.h"
  36 #include "util.h"
  37 #include "reel_writer.h"
  38 #include <dcp/cpl.h>
  39 #include <boost/foreach.hpp>
  40 #include <fstream>
  41 #include <cerrno>
  42 #include <iostream>
  43
  44 #include "i18n.h"
  45
  46 #define LOG_GENERAL(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
  47 #define LOG_GENERAL_NC(...) _film->log()->log (__VA_ARGS__, LogEntry::TYPE_GENERAL);
  48 #define LOG_DEBUG_ENCODE(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_DEBUG_ENCODE);
  49 #define LOG_TIMING(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_TIMING);
  50 #define LOG_WARNING_NC(...) _film->log()->log (__VA_ARGS__, LogEntry::TYPE_WARNING);
  51 #define LOG_WARNING(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_WARNING);
  52 #define LOG_ERROR(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_ERROR);
  53
  54 /* OS X strikes again */
  55 #undef set_key
  56
  57 using std::make_pair;
  58 using std::pair;
  59 using std::string;
  60 using std::list;
  61 using std::cout;
  62 using boost::shared_ptr;
  63 using boost::weak_ptr;
  64 using boost::dynamic_pointer_cast;
  65 using dcp::Data;
  66
  67 Writer::Writer (shared_ptr<const Film> film, weak_ptr<Job> j)
  68         : _film (film)
  69         , _job (j)
  70         , _thread (0)
  71         , _finish (false)
  72         , _queued_full_in_memory (0)
  73         , _maximum_frames_in_memory (0)
  74         , _full_written (0)
  75         , _fake_written (0)
  76         , _repeat_written (0)
  77         , _pushed_to_disk (0)
  78 {
  79         /* Remove any old DCP */
  80         boost::filesystem::remove_all (_film->dir (_film->dcp_name ()));
  81
  82         shared_ptr<Job> job = _job.lock ();
  83         DCPOMATIC_ASSERT (job);
  84
  85         BOOST_FOREACH (DCPTimePeriod p, _film->reels ()) {
  86                 _reels.push_back (ReelWriter (film, p, job));
  87         }
  88
  89         /* We can keep track of the current audio and subtitle reels easily because audio
  90            and subs arrive to the Writer in sequence.  This is not so for video.
  91         */
  92         _audio_reel = _reels.begin ();
  93         _subtitle_reel = _reels.begin ();
  94
  95         /* Check that the signer is OK if we need one */
  96         if (_film->is_signed() && !Config::instance()->signer_chain()->valid ()) {
  97                 throw InvalidSignerError ();
  98         }
  99 }
 100
 101 void
 102 Writer::start ()
 103 {
 104         _thread = new boost::thread (boost::bind (&Writer::thread, this));
 105 }
 106
 107 Writer::~Writer ()
 108 {
 109         terminate_thread (false);
 110 }
 111
 112 /** Pass a video frame to the writer for writing to disk at some point.
 113  *  This method can be called with frames out of order.
 114  *  @param encoded JPEG2000-encoded data.
 115  *  @param frame Frame index within the DCP.
 116  *  @param eyes Eyes that this frame image is for.
 117  */
 118 void
 119 Writer::write (Data encoded, Frame frame, Eyes eyes)
 120 {
 121         boost::mutex::scoped_lock lock (_state_mutex);
 122
 123         while (_queued_full_in_memory > _maximum_frames_in_memory) {
 124                 /* The queue is too big; wait until that is sorted out */
 125                 _full_condition.wait (lock);
 126         }
 127
 128         QueueItem qi;
 129         qi.type = QueueItem::FULL;
 130         qi.encoded = encoded;
 131         qi.reel = video_reel (frame);
 132         qi.frame = frame - _reels[qi.reel].start ();
 133
 134         if (_film->three_d() && eyes == EYES_BOTH) {
 135                 /* 2D material in a 3D DCP; fake the 3D */
 136                 qi.eyes = EYES_LEFT;
 137                 _queue.push_back (qi);
 138                 ++_queued_full_in_memory;
 139                 qi.eyes = EYES_RIGHT;
 140                 _queue.push_back (qi);
 141                 ++_queued_full_in_memory;
 142         } else {
 143                 qi.eyes = eyes;
 144                 _queue.push_back (qi);
 145                 ++_queued_full_in_memory;
 146         }
 147
 148         /* Now there's something to do: wake anything wait()ing on _empty_condition */
 149         _empty_condition.notify_all ();
 150 }
 151
 152 bool
 153 Writer::can_repeat (Frame frame) const
 154 {
 155         return frame > _reels[video_reel(frame)].start();
 156 }
 157
 158 /** Repeat the last frame that was written to a reel as a new frame.
 159  *  @param frame Frame index within the DCP of the new (repeated) frame.
 160  *  @param eyes Eyes that this repeated frame image is for.
 161  */
 162 void
 163 Writer::repeat (Frame frame, Eyes eyes)
 164 {
 165         boost::mutex::scoped_lock lock (_state_mutex);
 166
 167         while (_queued_full_in_memory > _maximum_frames_in_memory) {
 168                 /* The queue is too big; wait until that is sorted out */
 169                 _full_condition.wait (lock);
 170         }
 171
 172         QueueItem qi;
 173         qi.type = QueueItem::REPEAT;
 174         qi.reel = video_reel (frame);
 175         qi.frame = frame - _reels[qi.reel].start ();
 176         if (_film->three_d() && eyes == EYES_BOTH) {
 177                 qi.eyes = EYES_LEFT;
 178                 _queue.push_back (qi);
 179                 qi.eyes = EYES_RIGHT;
 180                 _queue.push_back (qi);
 181         } else {
 182                 qi.eyes = eyes;
 183                 _queue.push_back (qi);
 184         }
 185
 186         /* Now there's something to do: wake anything wait()ing on _empty_condition */
 187         _empty_condition.notify_all ();
 188 }
 189
 190 void
 191 Writer::fake_write (Frame frame, Eyes eyes)
 192 {
 193         boost::mutex::scoped_lock lock (_state_mutex);
 194
 195         while (_queued_full_in_memory > _maximum_frames_in_memory) {
 196                 /* The queue is too big; wait until that is sorted out */
 197                 _full_condition.wait (lock);
 198         }
 199
 200         size_t const reel = video_reel (frame);
 201         Frame const reel_frame = frame - _reels[reel].start ();
 202
 203         FILE* file = fopen_boost (_film->info_file(_reels[reel].period()), "rb");
 204         if (!file) {
 205                 throw ReadFileError (_film->info_file(_reels[reel].period()));
 206         }
 207         dcp::FrameInfo info = _reels[reel].read_frame_info (file, reel_frame, eyes);
 208         fclose (file);
 209
 210         QueueItem qi;
 211         qi.type = QueueItem::FAKE;
 212         qi.size = info.size;
 213         qi.reel = reel;
 214         qi.frame = reel_frame;
 215         if (_film->three_d() && eyes == EYES_BOTH) {
 216                 qi.eyes = EYES_LEFT;
 217                 _queue.push_back (qi);
 218                 qi.eyes = EYES_RIGHT;
 219                 _queue.push_back (qi);
 220         } else {
 221                 qi.eyes = eyes;
 222                 _queue.push_back (qi);
 223         }
 224
 225         /* Now there's something to do: wake anything wait()ing on _empty_condition */
 226         _empty_condition.notify_all ();
 227 }
 228
 229 /** Write one video frame's worth of audio frames to the DCP.
 230  *  @param audio Audio data or 0 if there is no audio to be written here (i.e. it is referenced).
 231  *  This method is not thread safe.
 232  */
 233 void
 234 Writer::write (shared_ptr<const AudioBuffers> audio)
 235 {
 236         if (_audio_reel == _reels.end ()) {
 237                 /* This audio is off the end of the last reel; ignore it */
 238                 return;
 239         }
 240
 241         _audio_reel->write (audio);
 242
 243         /* written is in video frames, not audio frames */
 244         if (_audio_reel->total_written_audio_frames() >= _audio_reel->period().duration().frames_floor (_film->video_frame_rate())) {
 245                 ++_audio_reel;
 246         }
 247 }
 248
 249 /** This must be called from Writer::thread() with an appropriate lock held */
 250 bool
 251 Writer::have_sequenced_image_at_queue_head ()
 252 {
 253         if (_queue.empty ()) {
 254                 return false;
 255         }
 256
 257         _queue.sort ();
 258
 259         QueueItem const & f = _queue.front();
 260         ReelWriter const & reel = _reels[f.reel];
 261
 262         /* The queue should contain only EYES_LEFT/EYES_RIGHT pairs or EYES_BOTH */
 263
 264         if (f.eyes == EYES_BOTH) {
 265                 /* 2D */
 266                 return f.frame == (reel.last_written_video_frame() + 1);
 267         }
 268
 269         /* 3D */
 270
 271         if (reel.last_written_eyes() == EYES_LEFT && f.frame == reel.last_written_video_frame() && f.eyes == EYES_RIGHT) {
 272                 return true;
 273         }
 274
 275         if (reel.last_written_eyes() == EYES_RIGHT && f.frame == (reel.last_written_video_frame() + 1) && f.eyes == EYES_LEFT) {
 276                 return true;
 277         }
 278
 279         return false;
 280 }
 281
 282 void
 283 Writer::thread ()
 284 try
 285 {
 286         while (true)
 287         {
 288                 boost::mutex::scoped_lock lock (_state_mutex);
 289
 290                 while (true) {
 291
 292                         if (_finish || _queued_full_in_memory > _maximum_frames_in_memory || have_sequenced_image_at_queue_head ()) {
 293                                 /* We've got something to do: go and do it */
 294                                 break;
 295                         }
 296
 297                         /* Nothing to do: wait until something happens which may indicate that we do */
 298                         LOG_TIMING (N_("writer-sleep queue=%1"), _queue.size());
 299                         _empty_condition.wait (lock);
 300                         LOG_TIMING (N_("writer-wake queue=%1"), _queue.size());
 301                 }
 302
 303                 if (_finish && _queue.empty()) {
 304                         return;
 305                 }
 306
 307                 /* We stop here if we have been asked to finish, and if either the queue
 308                    is empty or we do not have a sequenced image at its head (if this is the
 309                    case we will never terminate as no new frames will be sent once
 310                    _finish is true).
 311                 */
 312                 if (_finish && (!have_sequenced_image_at_queue_head() || _queue.empty())) {
 313                         /* (Hopefully temporarily) log anything that was not written */
 314                         if (!_queue.empty() && !have_sequenced_image_at_queue_head()) {
 315                                 LOG_WARNING (N_("Finishing writer with a left-over queue of %1:"), _queue.size());
 316                                 for (list<QueueItem>::const_iterator i = _queue.begin(); i != _queue.end(); ++i) {
 317                                         if (i->type == QueueItem::FULL) {
 318                                                 LOG_WARNING (N_("- type FULL, frame %1, eyes %2"), i->frame, i->eyes);
 319                                         } else {
 320                                                 LOG_WARNING (N_("- type FAKE, size %1, frame %2, eyes %3"), i->size, i->frame, i->eyes);
 321                                         }
 322                                 }
 323                         }
 324                         return;
 325                 }
 326
 327                 /* Write any frames that we can write; i.e. those that are in sequence. */
 328                 while (have_sequenced_image_at_queue_head ()) {
 329                         QueueItem qi = _queue.front ();
 330                         _queue.pop_front ();
 331                         if (qi.type == QueueItem::FULL && qi.encoded) {
 332                                 --_queued_full_in_memory;
 333                         }
 334
 335                         lock.unlock ();
 336
 337                         ReelWriter& reel = _reels[qi.reel];
 338
 339                         switch (qi.type) {
 340                         case QueueItem::FULL:
 341                                 LOG_DEBUG_ENCODE (N_("Writer FULL-writes %1 (%2)"), qi.frame, qi.eyes);
 342                                 if (!qi.encoded) {
 343                                         qi.encoded = Data (_film->j2c_path (qi.reel, qi.frame, qi.eyes, false));
 344                                 }
 345                                 reel.write (qi.encoded, qi.frame, qi.eyes);
 346                                 ++_full_written;
 347                                 break;
 348                         case QueueItem::FAKE:
 349                                 LOG_DEBUG_ENCODE (N_("Writer FAKE-writes %1"), qi.frame);
 350                                 reel.fake_write (qi.frame, qi.eyes, qi.size);
 351                                 ++_fake_written;
 352                                 break;
 353                         case QueueItem::REPEAT:
 354                                 LOG_DEBUG_ENCODE (N_("Writer REPEAT-writes %1"), qi.frame);
 355                                 reel.repeat_write (qi.frame, qi.eyes);
 356                                 ++_repeat_written;
 357                                 break;
 358                         }
 359
 360                         lock.lock ();
 361                 }
 362
 363                 while (_queued_full_in_memory > _maximum_frames_in_memory) {
 364                         /* Too many frames in memory which can't yet be written to the stream.
 365                            Write some FULL frames to disk.
 366                         */
 367
 368                         /* Find one from the back of the queue */
 369                         _queue.sort ();
 370                         list<QueueItem>::reverse_iterator i = _queue.rbegin ();
 371                         while (i != _queue.rend() && (i->type != QueueItem::FULL || !i->encoded)) {
 372                                 ++i;
 373                         }
 374
 375                         DCPOMATIC_ASSERT (i != _queue.rend());
 376                         ++_pushed_to_disk;
 377                         lock.unlock ();
 378
 379                         /* i is valid here, even though we don't hold a lock on the mutex,
 380                            since list iterators are unaffected by insertion and only this
 381                            thread could erase the last item in the list.
 382                         */
 383
 384                         LOG_GENERAL ("Writer full; pushes %1 to disk", i->frame);
 385
 386                         i->encoded->write_via_temp (
 387                                 _film->j2c_path (i->reel, i->frame, i->eyes, true),
 388                                 _film->j2c_path (i->reel, i->frame, i->eyes, false)
 389                                 );
 390
 391                         lock.lock ();
 392                         i->encoded.reset ();
 393                         --_queued_full_in_memory;
 394                 }
 395
 396                 /* The queue has probably just gone down a bit; notify anything wait()ing on _full_condition */
 397                 _full_condition.notify_all ();
 398         }
 399 }
 400 catch (...)
 401 {
 402         store_current ();
 403 }
 404
 405 void
 406 Writer::terminate_thread (bool can_throw)
 407 {
 408         boost::mutex::scoped_lock lock (_state_mutex);
 409         if (_thread == 0) {
 410                 return;
 411         }
 412
 413         _finish = true;
 414         _empty_condition.notify_all ();
 415         _full_condition.notify_all ();
 416         lock.unlock ();
 417
 418         if (_thread->joinable ()) {
 419                 _thread->join ();
 420         }
 421
 422         if (can_throw) {
 423                 rethrow ();
 424         }
 425
 426         delete _thread;
 427         _thread = 0;
 428 }
 429
 430 void
 431 Writer::finish ()
 432 {
 433         if (!_thread) {
 434                 return;
 435         }
 436
 437         LOG_GENERAL_NC ("Terminating writer thread");
 438
 439         terminate_thread (true);
 440
 441         LOG_GENERAL_NC ("Finishing ReelWriters");
 442
 443         BOOST_FOREACH (ReelWriter& i, _reels) {
 444                 i.finish ();
 445         }
 446
 447         LOG_GENERAL_NC ("Writing XML");
 448
 449         dcp::DCP dcp (_film->dir (_film->dcp_name()));
 450
 451         shared_ptr<dcp::CPL> cpl (
 452                 new dcp::CPL (
 453                         _film->dcp_name(),
 454                         _film->dcp_content_type()->libdcp_kind ()
 455                         )
 456                 );
 457
 458         dcp.add (cpl);
 459
 460         BOOST_FOREACH (ReelWriter& i, _reels) {
 461
 462                 shared_ptr<Job> job = _job.lock ();
 463                 DCPOMATIC_ASSERT (job);
 464                 i.calculate_digests (job);
 465
 466                 cpl->add (i.create_reel (_reel_assets, _fonts));
 467         }
 468
 469         dcp::XMLMetadata meta;
 470         meta.creator = Config::instance()->dcp_creator ();
 471         if (meta.creator.empty ()) {
 472                 meta.creator = String::compose ("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit);
 473         }
 474         meta.issuer = Config::instance()->dcp_issuer ();
 475         if (meta.issuer.empty ()) {
 476                 meta.issuer = String::compose ("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit);
 477         }
 478         meta.set_issue_date_now ();
 479
 480         cpl->set_metadata (meta);
 481
 482         shared_ptr<const dcp::CertificateChain> signer;
 483         if (_film->is_signed ()) {
 484                 signer = Config::instance()->signer_chain ();
 485                 /* We did check earlier, but check again here to be on the safe side */
 486                 if (!signer->valid ()) {
 487                         throw InvalidSignerError ();
 488                 }
 489         }
 490
 491         dcp.write_xml (_film->interop () ? dcp::INTEROP : dcp::SMPTE, meta, signer);
 492
 493         LOG_GENERAL (
 494                 N_("Wrote %1 FULL, %2 FAKE, %3 REPEAT, %4 pushed to disk"), _full_written, _fake_written, _repeat_written, _pushed_to_disk
 495                 );
 496 }
 497
 498 /** @param frame Frame index within the whole DCP.
 499  *  @return true if we can fake-write this frame.
 500  */
 501 bool
 502 Writer::can_fake_write (Frame frame) const
 503 {
 504         /* We have to do a proper write of the first frame so that we can set up the JPEG2000
 505            parameters in the asset writer.
 506         */
 507
 508         ReelWriter const & reel = _reels[video_reel(frame)];
 509
 510         /* Make frame relative to the start of the reel */
 511         frame -= reel.start ();
 512         return (frame != 0 && frame < reel.first_nonexistant_frame());
 513 }
 514
 515 void
 516 Writer::write (PlayerSubtitles subs)
 517 {
 518         if (subs.text.empty ()) {
 519                 return;
 520         }
 521
 522         if (_subtitle_reel->period().to <= subs.from) {
 523                 ++_subtitle_reel;
 524         }
 525
 526         _subtitle_reel->write (subs);
 527 }
 528
 529 void
 530 Writer::write (list<shared_ptr<Font> > fonts)
 531 {
 532         /* Just keep a list of unique fonts and we'll deal with them in ::finish */
 533
 534         BOOST_FOREACH (shared_ptr<Font> i, fonts) {
 535                 bool got = false;
 536                 BOOST_FOREACH (shared_ptr<Font> j, _fonts) {
 537                         if (*i == *j) {
 538                                 got = true;
 539                         }
 540                 }
 541
 542                 if (!got) {
 543                         _fonts.push_back (i);
 544                 }
 545         }
 546 }
 547
 548 bool
 549 operator< (QueueItem const & a, QueueItem const & b)
 550 {
 551         if (a.reel != b.reel) {
 552                 return a.reel < b.reel;
 553         }
 554
 555         if (a.frame != b.frame) {
 556                 return a.frame < b.frame;
 557         }
 558
 559         return static_cast<int> (a.eyes) < static_cast<int> (b.eyes);
 560 }
 561
 562 bool
 563 operator== (QueueItem const & a, QueueItem const & b)
 564 {
 565         return a.reel == b.reel && a.frame == b.frame && a.eyes == b.eyes;
 566 }
 567
 568 void
 569 Writer::set_encoder_threads (int threads)
 570 {
 571         /* I think the scaling factor here should be the ratio of the longest frame
 572            encode time to the shortest; if the thread count is T, longest time is L
 573            and the shortest time S we could encode L/S frames per thread whilst waiting
 574            for the L frame to encode so we might have to store LT/S frames.
 575
 576            However we don't want to use too much memory, so keep it a bit lower than we'd
 577            perhaps like.  A J2K frame is typically about 1Mb so 3 here will mean we could
 578            use about 240Mb with 72 encoding threads.
 579         */
 580         _maximum_frames_in_memory = lrint (threads * 3);
 581 }
 582
 583 void
 584 Writer::write (ReferencedReelAsset asset)
 585 {
 586         _reel_assets.push_back (asset);
 587 }
 588
 589 size_t
 590 Writer::video_reel (int frame) const
 591 {
 592         DCPTime t = DCPTime::from_frames (frame, _film->video_frame_rate ());
 593         size_t i = 0;
 594         while (i < _reels.size() && !_reels[i].period().contains (t)) {
 595                 ++i;
 596         }
 597
 598         DCPOMATIC_ASSERT (i < _reels.size ());
 599         return i;
 600 }