src/lib/reel_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 "reel_writer.h"
  22 #include "film.h"
  23 #include "cross.h"
  24 #include "job.h"
  25 #include "log.h"
  26 #include "digester.h"
  27 #include "font.h"
  28 #include "compose.hpp"
  29 #include "audio_buffers.h"
  30 #include <dcp/mono_picture_asset.h>
  31 #include <dcp/stereo_picture_asset.h>
  32 #include <dcp/sound_asset.h>
  33 #include <dcp/sound_asset_writer.h>
  34 #include <dcp/reel.h>
  35 #include <dcp/reel_mono_picture_asset.h>
  36 #include <dcp/reel_stereo_picture_asset.h>
  37 #include <dcp/reel_sound_asset.h>
  38 #include <dcp/reel_subtitle_asset.h>
  39 #include <dcp/dcp.h>
  40 #include <dcp/cpl.h>
  41 #include <dcp/certificate_chain.h>
  42 #include <dcp/interop_subtitle_asset.h>
  43 #include <dcp/smpte_subtitle_asset.h>
  44 #include <boost/foreach.hpp>
  45
  46 #include "i18n.h"
  47
  48 #define LOG_GENERAL(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
  49 #define LOG_GENERAL_NC(...) _film->log()->log (__VA_ARGS__, LogEntry::TYPE_GENERAL);
  50 #define LOG_WARNING_NC(...) _film->log()->log (__VA_ARGS__, LogEntry::TYPE_WARNING);
  51 #define LOG_ERROR(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_ERROR);
  52
  53 using std::list;
  54 using std::string;
  55 using std::cout;
  56 using boost::shared_ptr;
  57 using boost::optional;
  58 using boost::dynamic_pointer_cast;
  59 using dcp::Data;
  60
  61 int const ReelWriter::_info_size = 48;
  62
  63 ReelWriter::ReelWriter (
  64         shared_ptr<const Film> film, DCPTimePeriod period, shared_ptr<Job> job, int reel_index, int reel_count, optional<string> content_summary
  65         )
  66         : _film (film)
  67         , _period (period)
  68         , _first_nonexistant_frame (0)
  69         , _last_written_video_frame (-1)
  70         , _last_written_eyes (EYES_RIGHT)
  71         , _total_written_audio_frames (0)
  72         , _reel_index (reel_index)
  73         , _reel_count (reel_count)
  74         , _content_summary (content_summary)
  75 {
  76         /* Create our picture asset in a subdirectory, named according to those
  77            film's parameters which affect the video output.  We will hard-link
  78            it into the DCP later.
  79         */
  80
  81         if (_film->three_d ()) {
  82                 _picture_asset.reset (new dcp::StereoPictureAsset (dcp::Fraction (_film->video_frame_rate (), 1)));
  83         } else {
  84                 _picture_asset.reset (new dcp::MonoPictureAsset (dcp::Fraction (_film->video_frame_rate (), 1)));
  85         }
  86
  87         _picture_asset->set_size (_film->frame_size ());
  88
  89         if (_film->encrypted ()) {
  90                 _picture_asset->set_key (_film->key ());
  91                 _picture_asset->set_context_id (_film->context_id ());
  92         }
  93
  94         _picture_asset->set_file (
  95                 _film->internal_video_asset_dir() / _film->internal_video_asset_filename(_period)
  96                 );
  97
  98         job->sub (_("Checking existing image data"));
  99         check_existing_picture_asset ();
 100
 101         _picture_asset_writer = _picture_asset->start_write (
 102                 _film->internal_video_asset_dir() / _film->internal_video_asset_filename(_period),
 103                 _film->interop() ? dcp::INTEROP : dcp::SMPTE,
 104                 _first_nonexistant_frame > 0
 105                 );
 106
 107         if (_film->audio_channels ()) {
 108                 _sound_asset.reset (
 109                         new dcp::SoundAsset (dcp::Fraction (_film->video_frame_rate(), 1), _film->audio_frame_rate (), _film->audio_channels ())
 110                         );
 111
 112                 if (_film->encrypted ()) {
 113                         _sound_asset->set_key (_film->key ());
 114                 }
 115
 116                 DCPOMATIC_ASSERT (_film->directory());
 117
 118                 /* Write the sound asset into the film directory so that we leave the creation
 119                    of the DCP directory until the last minute.
 120                 */
 121                 _sound_asset_writer = _sound_asset->start_write (
 122                         _film->directory().get() / audio_asset_filename (_sound_asset, _reel_index, _reel_count, _content_summary),
 123                         _film->interop() ? dcp::INTEROP : dcp::SMPTE
 124                         );
 125         }
 126 }
 127
 128 /** @param frame reel-relative frame */
 129 void
 130 ReelWriter::write_frame_info (Frame frame, Eyes eyes, dcp::FrameInfo info) const
 131 {
 132         FILE* file = 0;
 133         boost::filesystem::path info_file = _film->info_file (_period);
 134
 135         bool const read = boost::filesystem::exists (info_file);
 136
 137 #ifdef DCPOMATIC_WINDOWS
 138         if (read) {
 139                 LOG_GENERAL (
 140                         "Checked %1 (which exists) length is %2 perms are %3",
 141                         info_file, boost::filesystem::file_size (info_file), int(boost::filesystem::status(info_file).permissions())
 142                         );
 143         } else {
 144                 LOG_GENERAL ("Checked %1 (which does not exist)", info_file);
 145         }
 146 #endif
 147
 148         if (read) {
 149                 file = fopen_boost (info_file, "r+b");
 150         } else {
 151                 file = fopen_boost (info_file, "wb");
 152         }
 153         if (!file) {
 154                 throw OpenFileError (info_file, errno, read);
 155         }
 156         dcpomatic_fseek (file, frame_info_position (frame, eyes), SEEK_SET);
 157         fwrite (&info.offset, sizeof (info.offset), 1, file);
 158         fwrite (&info.size, sizeof (info.size), 1, file);
 159         fwrite (info.hash.c_str(), 1, info.hash.size(), file);
 160         fclose (file);
 161 }
 162
 163 dcp::FrameInfo
 164 ReelWriter::read_frame_info (FILE* file, Frame frame, Eyes eyes) const
 165 {
 166         dcp::FrameInfo info;
 167         dcpomatic_fseek (file, frame_info_position (frame, eyes), SEEK_SET);
 168         fread (&info.offset, sizeof (info.offset), 1, file);
 169         fread (&info.size, sizeof (info.size), 1, file);
 170
 171         char hash_buffer[33];
 172         fread (hash_buffer, 1, 32, file);
 173         hash_buffer[32] = '\0';
 174         info.hash = hash_buffer;
 175
 176         return info;
 177 }
 178
 179 long
 180 ReelWriter::frame_info_position (Frame frame, Eyes eyes) const
 181 {
 182         switch (eyes) {
 183         case EYES_BOTH:
 184                 return frame * _info_size;
 185         case EYES_LEFT:
 186                 return frame * _info_size * 2;
 187         case EYES_RIGHT:
 188                 return frame * _info_size * 2 + _info_size;
 189         default:
 190                 DCPOMATIC_ASSERT (false);
 191         }
 192
 193         DCPOMATIC_ASSERT (false);
 194 }
 195
 196 void
 197 ReelWriter::check_existing_picture_asset ()
 198 {
 199         /* Try to open the existing asset */
 200         DCPOMATIC_ASSERT (_picture_asset->file());
 201         FILE* asset_file = fopen_boost (_picture_asset->file().get(), "rb");
 202         if (!asset_file) {
 203                 LOG_GENERAL ("Could not open existing asset at %1 (errno=%2)", _picture_asset->file()->string(), errno);
 204                 return;
 205         } else {
 206                 LOG_GENERAL ("Opened existing asset at %1", _picture_asset->file()->string());
 207         }
 208
 209         /* Offset of the last dcp::FrameInfo in the info file */
 210         int const n = (boost::filesystem::file_size (_film->info_file(_period)) / _info_size) - 1;
 211         LOG_GENERAL ("The last FI is %1; info file is %2, info size %3", n, boost::filesystem::file_size (_film->info_file(_period)), _info_size);
 212
 213         FILE* info_file = fopen_boost (_film->info_file(_period), "rb");
 214         if (!info_file) {
 215                 LOG_GENERAL_NC ("Could not open film info file");
 216                 fclose (asset_file);
 217                 return;
 218         }
 219
 220         if (_film->three_d ()) {
 221                 /* Start looking at the last left frame */
 222                 _first_nonexistant_frame = n / 2;
 223         } else {
 224                 _first_nonexistant_frame = n;
 225         }
 226
 227         while (!existing_picture_frame_ok(asset_file, info_file) && _first_nonexistant_frame > 0) {
 228                 --_first_nonexistant_frame;
 229         }
 230
 231         if (!_film->three_d() && _first_nonexistant_frame > 0) {
 232                 /* If we are doing 3D we might have found a good L frame with no R, so only
 233                    do this if we're in 2D and we've just found a good B(oth) frame.
 234                 */
 235                 ++_first_nonexistant_frame;
 236         }
 237
 238         LOG_GENERAL ("Proceeding with first nonexistant frame %1", _first_nonexistant_frame);
 239
 240         fclose (asset_file);
 241         fclose (info_file);
 242 }
 243
 244 void
 245 ReelWriter::write (optional<Data> encoded, Frame frame, Eyes eyes)
 246 {
 247         dcp::FrameInfo fin = _picture_asset_writer->write (encoded->data().get (), encoded->size());
 248         write_frame_info (frame, eyes, fin);
 249         _last_written[eyes] = encoded;
 250         _last_written_video_frame = frame;
 251         _last_written_eyes = eyes;
 252 }
 253
 254 void
 255 ReelWriter::fake_write (Frame frame, Eyes eyes, int size)
 256 {
 257         _picture_asset_writer->fake_write (size);
 258         _last_written_video_frame = frame;
 259         _last_written_eyes = eyes;
 260 }
 261
 262 void
 263 ReelWriter::repeat_write (Frame frame, Eyes eyes)
 264 {
 265         dcp::FrameInfo fin = _picture_asset_writer->write (
 266                 _last_written[eyes]->data().get(),
 267                 _last_written[eyes]->size()
 268                 );
 269         write_frame_info (frame, eyes, fin);
 270         _last_written_video_frame = frame;
 271         _last_written_eyes = eyes;
 272 }
 273
 274 void
 275 ReelWriter::finish ()
 276 {
 277         if (!_picture_asset_writer->finalize ()) {
 278                 /* Nothing was written to the picture asset */
 279                 LOG_GENERAL ("Nothing was written to reel %1 of %2", _reel_index, _reel_count);
 280                 _picture_asset.reset ();
 281         }
 282
 283         if (_sound_asset_writer && !_sound_asset_writer->finalize ()) {
 284                 /* Nothing was written to the sound asset */
 285                 _sound_asset.reset ();
 286         }
 287
 288         /* Hard-link any video asset file into the DCP */
 289         if (_picture_asset) {
 290                 DCPOMATIC_ASSERT (_picture_asset->file());
 291                 boost::filesystem::path video_from = _picture_asset->file().get();
 292                 boost::filesystem::path video_to;
 293                 video_to /= _film->dir (_film->dcp_name());
 294                 video_to /= video_asset_filename (_picture_asset, _reel_index, _reel_count, _content_summary);
 295
 296                 boost::system::error_code ec;
 297                 boost::filesystem::create_hard_link (video_from, video_to, ec);
 298                 if (ec) {
 299                         LOG_WARNING_NC ("Hard-link failed; copying instead");
 300                         boost::filesystem::copy_file (video_from, video_to, ec);
 301                         if (ec) {
 302                                 LOG_ERROR ("Failed to copy video file from %1 to %2 (%3)", video_from.string(), video_to.string(), ec.message ());
 303                                 throw FileError (ec.message(), video_from);
 304                         }
 305                 }
 306
 307                 _picture_asset->set_file (video_to);
 308         }
 309
 310         /* Move the audio asset into the DCP */
 311         if (_sound_asset) {
 312                 boost::filesystem::path audio_to;
 313                 audio_to /= _film->dir (_film->dcp_name ());
 314                 string const aaf = audio_asset_filename (_sound_asset, _reel_index, _reel_count, _content_summary);
 315                 audio_to /= aaf;
 316
 317                 boost::system::error_code ec;
 318                 boost::filesystem::rename (_film->file (aaf), audio_to, ec);
 319                 if (ec) {
 320                         throw FileError (
 321                                 String::compose (_("could not move audio asset into the DCP (%1)"), ec.value ()), aaf
 322                                 );
 323                 }
 324
 325                 _sound_asset->set_file (audio_to);
 326         }
 327 }
 328
 329 shared_ptr<dcp::Reel>
 330 ReelWriter::create_reel (list<ReferencedReelAsset> const & refs, list<shared_ptr<Font> > const & fonts)
 331 {
 332         shared_ptr<dcp::Reel> reel (new dcp::Reel ());
 333
 334         shared_ptr<dcp::ReelPictureAsset> reel_picture_asset;
 335
 336         if (_picture_asset) {
 337                 /* We have made a picture asset of our own.  Put it into the reel */
 338                 shared_ptr<dcp::MonoPictureAsset> mono = dynamic_pointer_cast<dcp::MonoPictureAsset> (_picture_asset);
 339                 if (mono) {
 340                         reel_picture_asset.reset (new dcp::ReelMonoPictureAsset (mono, 0));
 341                 }
 342
 343                 shared_ptr<dcp::StereoPictureAsset> stereo = dynamic_pointer_cast<dcp::StereoPictureAsset> (_picture_asset);
 344                 if (stereo) {
 345                         reel_picture_asset.reset (new dcp::ReelStereoPictureAsset (stereo, 0));
 346                 }
 347         } else {
 348                 LOG_GENERAL ("no picture asset of our own; look through %1", refs.size());
 349                 /* We don't have a picture asset of our own; hopefully we have one to reference */
 350                 BOOST_FOREACH (ReferencedReelAsset j, refs) {
 351                         shared_ptr<dcp::ReelPictureAsset> k = dynamic_pointer_cast<dcp::ReelPictureAsset> (j.asset);
 352                         if (k) {
 353                                 LOG_GENERAL ("candidate picture asset period is %1-%2", j.period.from.get(), j.period.to.get());
 354                         }
 355                         if (k && j.period == _period) {
 356                                 reel_picture_asset = k;
 357                         }
 358                 }
 359         }
 360
 361         LOG_GENERAL ("create_reel for %1-%2; %3 of %4", _period.from.get(), _period.to.get(), _reel_index, _reel_count);
 362
 363         DCPOMATIC_ASSERT (reel_picture_asset);
 364         DCPOMATIC_ASSERT (reel_picture_asset->intrinsic_duration() == _period.duration().frames_round (_film->video_frame_rate ()));
 365         reel->add (reel_picture_asset);
 366
 367         /* If we have a hash for this asset in the CPL, assume that it is correct */
 368         if (reel_picture_asset->hash()) {
 369                 reel_picture_asset->asset_ref()->set_hash (reel_picture_asset->hash().get());
 370         }
 371
 372         shared_ptr<dcp::ReelSoundAsset> reel_sound_asset;
 373
 374         if (_sound_asset) {
 375                 /* We have made a sound asset of our own.  Put it into the reel */
 376                 reel_sound_asset.reset (new dcp::ReelSoundAsset (_sound_asset, 0));
 377         } else {
 378                 /* We don't have a sound asset of our own; hopefully we have one to reference */
 379                 BOOST_FOREACH (ReferencedReelAsset j, refs) {
 380                         shared_ptr<dcp::ReelSoundAsset> k = dynamic_pointer_cast<dcp::ReelSoundAsset> (j.asset);
 381                         if (k && j.period == _period) {
 382                                 reel_sound_asset = k;
 383                                 /* If we have a hash for this asset in the CPL, assume that it is correct */
 384                                 if (k->hash()) {
 385                                         k->asset_ref()->set_hash (k->hash().get());
 386                                 }
 387                         }
 388                 }
 389         }
 390
 391         DCPOMATIC_ASSERT (reel_sound_asset);
 392         DCPOMATIC_ASSERT (reel_sound_asset->intrinsic_duration() == _period.duration().frames_round (_film->video_frame_rate ()));
 393         reel->add (reel_sound_asset);
 394
 395         shared_ptr<dcp::ReelSubtitleAsset> reel_subtitle_asset;
 396
 397         if (_subtitle_asset) {
 398
 399                 boost::filesystem::path liberation_normal;
 400                 try {
 401                         liberation_normal = shared_path() / "LiberationSans-Regular.ttf";
 402                         if (!boost::filesystem::exists (liberation_normal)) {
 403                                 /* Hack for unit tests */
 404                                 liberation_normal = shared_path() / "fonts" / "LiberationSans-Regular.ttf";
 405                         }
 406                 } catch (boost::filesystem::filesystem_error& e) {
 407
 408                 }
 409
 410                 if (!boost::filesystem::exists(liberation_normal)) {
 411                         liberation_normal = "/usr/share/fonts/truetype/liberation/LiberationSans-Regular.ttf";
 412                 }
 413
 414                 /* Add all the fonts to the subtitle content */
 415                 BOOST_FOREACH (shared_ptr<Font> j, fonts) {
 416                         _subtitle_asset->add_font (j->id(), j->file(FontFiles::NORMAL).get_value_or(liberation_normal));
 417                 }
 418
 419                 if (dynamic_pointer_cast<dcp::InteropSubtitleAsset> (_subtitle_asset)) {
 420                         boost::filesystem::path directory = _film->dir (_film->dcp_name ()) / _subtitle_asset->id ();
 421                         boost::filesystem::create_directories (directory);
 422                         _subtitle_asset->write (directory / ("sub_" + _subtitle_asset->id() + ".xml"));
 423                 } else {
 424
 425                         /* All our assets should be the same length; use the picture asset length here
 426                            as a reference to set the subtitle one.
 427                         */
 428                         dynamic_pointer_cast<dcp::SMPTESubtitleAsset>(_subtitle_asset)->set_intrinsic_duration (
 429                                 reel_picture_asset->intrinsic_duration ()
 430                                 );
 431
 432                         _subtitle_asset->write (
 433                                 _film->dir (_film->dcp_name ()) / ("sub_" + _subtitle_asset->id() + ".mxf")
 434                                 );
 435                 }
 436
 437                 reel_subtitle_asset.reset (
 438                         new dcp::ReelSubtitleAsset (
 439                                 _subtitle_asset,
 440                                 dcp::Fraction (_film->video_frame_rate(), 1),
 441                                 reel_picture_asset->intrinsic_duration (),
 442                                 0
 443                                 )
 444                         );
 445         } else {
 446                 /* We don't have a subtitle asset of our own; hopefully we have one to reference */
 447                 BOOST_FOREACH (ReferencedReelAsset j, refs) {
 448                         shared_ptr<dcp::ReelSubtitleAsset> k = dynamic_pointer_cast<dcp::ReelSubtitleAsset> (j.asset);
 449                         if (k && j.period == _period) {
 450                                 reel_subtitle_asset = k;
 451                                 /* If we have a hash for this asset in the CPL, assume that it is correct */
 452                                 if (k->hash()) {
 453                                         k->asset_ref()->set_hash (k->hash().get());
 454                                 }
 455                         }
 456                 }
 457         }
 458
 459         if (reel_subtitle_asset) {
 460                 DCPOMATIC_ASSERT (reel_subtitle_asset->intrinsic_duration() == _period.duration().frames_round (_film->video_frame_rate ()));
 461                 reel->add (reel_subtitle_asset);
 462         }
 463
 464         return reel;
 465 }
 466
 467 void
 468 ReelWriter::calculate_digests (boost::function<void (float)> set_progress)
 469 {
 470         if (_picture_asset) {
 471                 _picture_asset->hash (set_progress);
 472         }
 473
 474         if (_sound_asset) {
 475                 _sound_asset->hash (set_progress);
 476         }
 477 }
 478
 479 Frame
 480 ReelWriter::start () const
 481 {
 482         return _period.from.frames_floor (_film->video_frame_rate());
 483 }
 484
 485
 486 void
 487 ReelWriter::write (shared_ptr<const AudioBuffers> audio)
 488 {
 489         if (!_sound_asset_writer) {
 490                 return;
 491         }
 492
 493         if (audio) {
 494                 _sound_asset_writer->write (audio->data(), audio->frames());
 495         }
 496
 497         _total_written_audio_frames += audio->frames ();
 498 }
 499
 500 void
 501 ReelWriter::write (PlayerSubtitles subs)
 502 {
 503         if (!_subtitle_asset) {
 504                 string lang = _film->subtitle_language ();
 505                 if (lang.empty ()) {
 506                         lang = "Unknown";
 507                 }
 508                 if (_film->interop ()) {
 509                         shared_ptr<dcp::InteropSubtitleAsset> s (new dcp::InteropSubtitleAsset ());
 510                         s->set_movie_title (_film->name ());
 511                         s->set_language (lang);
 512                         s->set_reel_number ("1");
 513                         _subtitle_asset = s;
 514                 } else {
 515                         shared_ptr<dcp::SMPTESubtitleAsset> s (new dcp::SMPTESubtitleAsset ());
 516                         s->set_content_title_text (_film->name ());
 517                         s->set_language (lang);
 518                         s->set_edit_rate (dcp::Fraction (_film->video_frame_rate (), 1));
 519                         s->set_reel_number (1);
 520                         s->set_time_code_rate (_film->video_frame_rate ());
 521                         s->set_start_time (dcp::Time ());
 522                         if (_film->encrypted ()) {
 523                                 s->set_key (_film->key ());
 524                         }
 525                         _subtitle_asset = s;
 526                 }
 527         }
 528
 529         BOOST_FOREACH (SubtitleString i, subs.text) {
 530                 i.set_in  (i.in()  - dcp::Time (_period.from.seconds(), i.in().tcr));
 531                 i.set_out (i.out() - dcp::Time (_period.from.seconds(), i.out().tcr));
 532                 _subtitle_asset->add (i);
 533         }
 534 }
 535
 536 bool
 537 ReelWriter::existing_picture_frame_ok (FILE* asset_file, FILE* info_file) const
 538 {
 539         LOG_GENERAL ("Checking existing picture frame %1", _first_nonexistant_frame);
 540
 541         /* Read the data from the info file; for 3D we just check the left
 542            frames until we find a good one.
 543         */
 544         dcp::FrameInfo const info = read_frame_info (info_file, _first_nonexistant_frame, _film->three_d () ? EYES_LEFT : EYES_BOTH);
 545
 546         bool ok = true;
 547
 548         /* Read the data from the asset and hash it */
 549         dcpomatic_fseek (asset_file, info.offset, SEEK_SET);
 550         Data data (info.size);
 551         size_t const read = fread (data.data().get(), 1, data.size(), asset_file);
 552         LOG_GENERAL ("Read %1 bytes of asset data; wanted %2", read, info.size);
 553         if (read != static_cast<size_t> (data.size ())) {
 554                 LOG_GENERAL ("Existing frame %1 is incomplete", _first_nonexistant_frame);
 555                 ok = false;
 556         } else {
 557                 Digester digester;
 558                 digester.add (data.data().get(), data.size());
 559                 LOG_GENERAL ("Hash %1 vs %2", digester.get(), info.hash);
 560                 if (digester.get() != info.hash) {
 561                         LOG_GENERAL ("Existing frame %1 failed hash check", _first_nonexistant_frame);
 562                         ok = false;
 563                 }
 564         }
 565
 566         return ok;
 567 }