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