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