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