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