src/lib/reel_writer.cc

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