src/lib/reel_writer.cc

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