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