src/lib/writer.cc

   1 /*
   2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include "writer.h"
  21 #include "compose.hpp"
  22 #include "film.h"
  23 #include "ratio.h"
  24 #include "log.h"
  25 #include "dcp_video.h"
  26 #include "dcp_content_type.h"
  27 #include "audio_mapping.h"
  28 #include "config.h"
  29 #include "job.h"
  30 #include "cross.h"
  31 #include "audio_buffers.h"
  32 #include "md5_digester.h"
  33 #include "data.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
  66 Writer::Writer (shared_ptr<const Film> film, weak_ptr<Job> j)
  67         : _film (film)
  68         , _job (j)
  69         , _thread (0)
  70         , _finish (false)
  71         , _queued_full_in_memory (0)
  72         , _maximum_frames_in_memory (0)
  73         , _full_written (0)
  74         , _fake_written (0)
  75         , _repeat_written (0)
  76         , _pushed_to_disk (0)
  77 {
  78         /* Remove any old DCP */
  79         boost::filesystem::remove_all (_film->dir (_film->dcp_name ()));
  80
  81         shared_ptr<Job> job = _job.lock ();
  82         DCPOMATIC_ASSERT (job);
  83
  84         BOOST_FOREACH (DCPTimePeriod p, _film->reels ()) {
  85                 _reels.push_back (ReelWriter (film, p, job));
  86         }
  87
  88         /* We can keep track of the current audio and subtitle reels easily because audio
  89            and subs arrive to the Writer in sequence.  This is not so for video.
  90         */
  91         _audio_reel = _reels.begin ();
  92         _subtitle_reel = _reels.begin ();
  93
  94         /* Check that the signer is OK if we need one */
  95         if (_film->is_signed() && !Config::instance()->signer_chain()->valid ()) {
  96                 throw InvalidSignerError ();
  97         }
  98
  99         job->sub (_("Encoding image data"));
 100 }
 101
 102 void
 103 Writer::start ()
 104 {
 105         _thread = new boost::thread (boost::bind (&Writer::thread, this));
 106 }
 107
 108 Writer::~Writer ()
 109 {
 110         terminate_thread (false);
 111 }
 112
 113 /** Pass a video frame to the writer for writing to disk at some point.
 114  *  This method can be called with frames out of order.
 115  *  @param encoded JPEG2000-encoded data.
 116  *  @param frame Frame index within the DCP.
 117  *  @param eyes Eyes that this frame image is for.
 118  */
 119 void
 120 Writer::write (Data encoded, Frame frame, Eyes eyes)
 121 {
 122         boost::mutex::scoped_lock lock (_state_mutex);
 123
 124         while (_queued_full_in_memory > _maximum_frames_in_memory) {
 125                 /* The queue is too big; wait until that is sorted out */
 126                 _full_condition.wait (lock);
 127         }
 128
 129         QueueItem qi;
 130         qi.type = QueueItem::FULL;
 131         qi.encoded = encoded;
 132         qi.reel = video_reel (frame);
 133         qi.frame = frame - _reels[qi.reel].start ();
 134
 135         if (_film->three_d() && eyes == EYES_BOTH) {
 136                 /* 2D material in a 3D DCP; fake the 3D */
 137                 qi.eyes = EYES_LEFT;
 138                 _queue.push_back (qi);
 139                 ++_queued_full_in_memory;
 140                 qi.eyes = EYES_RIGHT;
 141                 _queue.push_back (qi);
 142                 ++_queued_full_in_memory;
 143         } else {
 144                 qi.eyes = eyes;
 145                 _queue.push_back (qi);
 146                 ++_queued_full_in_memory;
 147         }
 148
 149         /* Now there's something to do: wake anything wait()ing on _empty_condition */
 150         _empty_condition.notify_all ();
 151 }
 152
 153 /** Repeat the last frame that was written to a reel as a new frame.
 154  *  @param frame Frame index within the DCP of the new (repeated) frame.
 155  *  @param eyes Eyes that this repeated frame image is for.
 156  */
 157 void
 158 Writer::repeat (Frame frame, Eyes eyes)
 159 {
 160         boost::mutex::scoped_lock lock (_state_mutex);
 161
 162         while (_queued_full_in_memory > _maximum_frames_in_memory) {
 163                 /* The queue is too big; wait until that is sorted out */
 164                 _full_condition.wait (lock);
 165         }
 166
 167         QueueItem qi;
 168         qi.type = QueueItem::REPEAT;
 169         qi.reel = video_reel (frame);
 170         qi.frame = frame - _reels[qi.reel].start ();
 171         if (_film->three_d() && eyes == EYES_BOTH) {
 172                 qi.eyes = EYES_LEFT;
 173                 _queue.push_back (qi);
 174                 qi.eyes = EYES_RIGHT;
 175                 _queue.push_back (qi);
 176         } else {
 177                 qi.eyes = eyes;
 178                 _queue.push_back (qi);
 179         }
 180
 181         /* Now there's something to do: wake anything wait()ing on _empty_condition */
 182         _empty_condition.notify_all ();
 183 }
 184
 185 void
 186 Writer::fake_write (Frame frame, Eyes eyes)
 187 {
 188         boost::mutex::scoped_lock lock (_state_mutex);
 189
 190         while (_queued_full_in_memory > _maximum_frames_in_memory) {
 191                 /* The queue is too big; wait until that is sorted out */
 192                 _full_condition.wait (lock);
 193         }
 194
 195         size_t const reel = video_reel (frame);
 196         Frame const reel_frame = frame - _reels[reel].start ();
 197
 198         FILE* file = fopen_boost (_film->info_file(_reels[reel].period()), "rb");
 199         if (!file) {
 200                 throw ReadFileError (_film->info_file(_reels[reel].period()));
 201         }
 202         dcp::FrameInfo info = _reels[reel].read_frame_info (file, reel_frame, eyes);
 203         fclose (file);
 204
 205         QueueItem qi;
 206         qi.type = QueueItem::FAKE;
 207         qi.size = info.size;
 208         qi.reel = reel;
 209         qi.frame = reel_frame;
 210         if (_film->three_d() && eyes == EYES_BOTH) {
 211                 qi.eyes = EYES_LEFT;
 212                 _queue.push_back (qi);
 213                 qi.eyes = EYES_RIGHT;
 214                 _queue.push_back (qi);
 215         } else {
 216                 qi.eyes = eyes;
 217                 _queue.push_back (qi);
 218         }
 219
 220         /* Now there's something to do: wake anything wait()ing on _empty_condition */
 221         _empty_condition.notify_all ();
 222 }
 223
 224 /** Write one video frame's worth of audio frames to the DCP.
 225  *  @param audio Audio data or 0 if there is no audio to be written here (i.e. it is referenced).
 226  *  This method is not thread safe.
 227  */
 228 void
 229 Writer::write (shared_ptr<const AudioBuffers> audio)
 230 {
 231         if (_audio_reel == _reels.end ()) {
 232                 /* This audio is off the end of the last reel; ignore it */
 233                 return;
 234         }
 235
 236         _audio_reel->write (audio);
 237
 238         /* written is in video frames, not audio frames */
 239         if (_audio_reel->total_written_audio_frames() >= _audio_reel->period().duration().frames_floor (_film->video_frame_rate())) {
 240                 ++_audio_reel;
 241         }
 242 }
 243
 244 /** This must be called from Writer::thread() with an appropriate lock held */
 245 bool
 246 Writer::have_sequenced_image_at_queue_head ()
 247 {
 248         if (_queue.empty ()) {
 249                 return false;
 250         }
 251
 252         _queue.sort ();
 253
 254         QueueItem const & f = _queue.front();
 255         ReelWriter const & reel = _reels[f.reel];
 256
 257         /* The queue should contain only EYES_LEFT/EYES_RIGHT pairs or EYES_BOTH */
 258
 259         if (f.eyes == EYES_BOTH) {
 260                 /* 2D */
 261                 return f.frame == (reel.last_written_video_frame() + 1);
 262         }
 263
 264         /* 3D */
 265
 266         if (reel.last_written_eyes() == EYES_LEFT && f.frame == reel.last_written_video_frame() && f.eyes == EYES_RIGHT) {
 267                 return true;
 268         }
 269
 270         if (reel.last_written_eyes() == EYES_RIGHT && f.frame == (reel.last_written_video_frame() + 1) && f.eyes == EYES_LEFT) {
 271                 return true;
 272         }
 273
 274         return false;
 275 }
 276
 277 void
 278 Writer::thread ()
 279 try
 280 {
 281         while (true)
 282         {
 283                 boost::mutex::scoped_lock lock (_state_mutex);
 284
 285                 while (true) {
 286
 287                         if (_finish || _queued_full_in_memory > _maximum_frames_in_memory || have_sequenced_image_at_queue_head ()) {
 288                                 /* We've got something to do: go and do it */
 289                                 break;
 290                         }
 291
 292                         /* Nothing to do: wait until something happens which may indicate that we do */
 293                         LOG_TIMING (N_("writer-sleep queue=%1"), _queue.size());
 294                         _empty_condition.wait (lock);
 295                         LOG_TIMING (N_("writer-wake queue=%1"), _queue.size());
 296                 }
 297
 298                 if (_finish && _queue.empty()) {
 299                         return;
 300                 }
 301
 302                 /* We stop here if we have been asked to finish, and if either the queue
 303                    is empty or we do not have a sequenced image at its head (if this is the
 304                    case we will never terminate as no new frames will be sent once
 305                    _finish is true).
 306                 */
 307                 if (_finish && (!have_sequenced_image_at_queue_head() || _queue.empty())) {
 308                         /* (Hopefully temporarily) log anything that was not written */
 309                         if (!_queue.empty() && !have_sequenced_image_at_queue_head()) {
 310                                 LOG_WARNING (N_("Finishing writer with a left-over queue of %1:"), _queue.size());
 311                                 for (list<QueueItem>::const_iterator i = _queue.begin(); i != _queue.end(); ++i) {
 312                                         if (i->type == QueueItem::FULL) {
 313                                                 LOG_WARNING (N_("- type FULL, frame %1, eyes %2"), i->frame, i->eyes);
 314                                         } else {
 315                                                 LOG_WARNING (N_("- type FAKE, size %1, frame %2, eyes %3"), i->size, i->frame, i->eyes);
 316                                         }
 317                                 }
 318                         }
 319                         return;
 320                 }
 321
 322                 /* Write any frames that we can write; i.e. those that are in sequence. */
 323                 while (have_sequenced_image_at_queue_head ()) {
 324                         QueueItem qi = _queue.front ();
 325                         _queue.pop_front ();
 326                         if (qi.type == QueueItem::FULL && qi.encoded) {
 327                                 --_queued_full_in_memory;
 328                         }
 329
 330                         lock.unlock ();
 331
 332                         ReelWriter& reel = _reels[qi.reel];
 333
 334                         switch (qi.type) {
 335                         case QueueItem::FULL:
 336                                 LOG_DEBUG_ENCODE (N_("Writer FULL-writes %1 (%2)"), qi.frame, qi.eyes);
 337                                 if (!qi.encoded) {
 338                                         qi.encoded = Data (_film->j2c_path (qi.reel, qi.frame, qi.eyes, false));
 339                                 }
 340                                 reel.write (qi.encoded, qi.frame, qi.eyes);
 341                                 ++_full_written;
 342                                 break;
 343                         case QueueItem::FAKE:
 344                                 LOG_DEBUG_ENCODE (N_("Writer FAKE-writes %1"), qi.frame);
 345                                 reel.fake_write (qi.frame, qi.eyes, qi.size);
 346                                 ++_fake_written;
 347                                 break;
 348                         case QueueItem::REPEAT:
 349                                 LOG_DEBUG_ENCODE (N_("Writer REPEAT-writes %1"), qi.frame);
 350                                 reel.repeat_write (qi.frame, qi.eyes);
 351                                 ++_repeat_written;
 352                                 break;
 353                         }
 354
 355                         lock.lock ();
 356
 357                         shared_ptr<Job> job = _job.lock ();
 358                         DCPOMATIC_ASSERT (job);
 359                         int64_t total = _film->length().frames_round (_film->video_frame_rate ());
 360                         if (_film->three_d ()) {
 361                                 /* _full_written and so on are incremented for each eye, so we need to double the total
 362                                    frames to get the correct progress.
 363                                 */
 364                                 total *= 2;
 365                         }
 366                         if (total) {
 367                                 job->set_progress (float (_full_written + _fake_written + _repeat_written) / total);
 368                         }
 369                 }
 370
 371                 while (_queued_full_in_memory > _maximum_frames_in_memory) {
 372                         /* Too many frames in memory which can't yet be written to the stream.
 373                            Write some FULL frames to disk.
 374                         */
 375
 376                         /* Find one from the back of the queue */
 377                         _queue.sort ();
 378                         list<QueueItem>::reverse_iterator i = _queue.rbegin ();
 379                         while (i != _queue.rend() && (i->type != QueueItem::FULL || !i->encoded)) {
 380                                 ++i;
 381                         }
 382
 383                         DCPOMATIC_ASSERT (i != _queue.rend());
 384                         ++_pushed_to_disk;
 385                         lock.unlock ();
 386
 387                         /* i is valid here, even though we don't hold a lock on the mutex,
 388                            since list iterators are unaffected by insertion and only this
 389                            thread could erase the last item in the list.
 390                         */
 391
 392                         LOG_GENERAL ("Writer full; pushes %1 to disk", i->frame);
 393
 394                         i->encoded->write_via_temp (
 395                                 _film->j2c_path (i->reel, i->frame, i->eyes, true),
 396                                 _film->j2c_path (i->reel, i->frame, i->eyes, false)
 397                                 );
 398
 399                         lock.lock ();
 400                         i->encoded.reset ();
 401                         --_queued_full_in_memory;
 402                 }
 403
 404                 /* The queue has probably just gone down a bit; notify anything wait()ing on _full_condition */
 405                 _full_condition.notify_all ();
 406         }
 407 }
 408 catch (...)
 409 {
 410         store_current ();
 411 }
 412
 413 void
 414 Writer::terminate_thread (bool can_throw)
 415 {
 416         boost::mutex::scoped_lock lock (_state_mutex);
 417         if (_thread == 0) {
 418                 return;
 419         }
 420
 421         _finish = true;
 422         _empty_condition.notify_all ();
 423         _full_condition.notify_all ();
 424         lock.unlock ();
 425
 426         DCPOMATIC_ASSERT (_thread->joinable ());
 427         _thread->join ();
 428         if (can_throw) {
 429                 rethrow ();
 430         }
 431
 432         delete _thread;
 433         _thread = 0;
 434 }
 435
 436 void
 437 Writer::finish ()
 438 {
 439         if (!_thread) {
 440                 return;
 441         }
 442
 443         terminate_thread (true);
 444
 445         BOOST_FOREACH (ReelWriter& i, _reels) {
 446                 i.finish ();
 447         }
 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                 cpl->add (i.create_reel (_reel_assets, _fonts));
 463
 464                 shared_ptr<Job> job = _job.lock ();
 465                 DCPOMATIC_ASSERT (job);
 466                 i.calculate_digests (job);
 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 fonts and we'll deal with them in ::finish */
 533         copy (fonts.begin (), fonts.end (), back_inserter (_fonts));
 534 }
 535
 536 bool
 537 operator< (QueueItem const & a, QueueItem const & b)
 538 {
 539         if (a.reel != b.reel) {
 540                 return a.reel < b.reel;
 541         }
 542
 543         if (a.frame != b.frame) {
 544                 return a.frame < b.frame;
 545         }
 546
 547         return static_cast<int> (a.eyes) < static_cast<int> (b.eyes);
 548 }
 549
 550 bool
 551 operator== (QueueItem const & a, QueueItem const & b)
 552 {
 553         return a.reel == b.reel && a.frame == b.frame && a.eyes == b.eyes;
 554 }
 555
 556 void
 557 Writer::set_encoder_threads (int threads)
 558 {
 559         _maximum_frames_in_memory = lrint (threads * 1.1);
 560 }
 561
 562 void
 563 Writer::write (ReferencedReelAsset asset)
 564 {
 565         _reel_assets.push_back (asset);
 566 }
 567
 568 size_t
 569 Writer::video_reel (int frame) const
 570 {
 571         DCPTime t = DCPTime::from_frames (frame, _film->video_frame_rate ());
 572         size_t i = 0;
 573         while (i < _reels.size() && !_reels[i].period().contains (t)) {
 574                 ++i;
 575         }
 576
 577         DCPOMATIC_ASSERT (i < _reels.size ());
 578         return i;
 579 }