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         }
 182
 183         /* Offset of the last dcp::FrameInfo in the info file */
 184         int const n = (boost::filesystem::file_size (_film->info_file(_period)) / _info_size) - 1;
 185
 186         FILE* info_file = fopen_boost (_film->info_file(_period), "rb");
 187         if (!info_file) {
 188                 LOG_GENERAL_NC ("Could not open film info file");
 189                 fclose (asset_file);
 190                 return;
 191         }
 192
 193         if (_film->three_d ()) {
 194                 /* Start looking at the last left frame */
 195                 _first_nonexistant_frame = n / 2;
 196         } else {
 197                 _first_nonexistant_frame = n;
 198         }
 199
 200         bool ok = false;
 201
 202         while (!ok && _first_nonexistant_frame > 0) {
 203                 /* Read the data from the info file; for 3D we just check the left
 204                    frames until we find a good one.
 205                 */
 206                 dcp::FrameInfo info = read_frame_info (info_file, _first_nonexistant_frame, _film->three_d () ? EYES_LEFT : EYES_BOTH);
 207
 208                 ok = true;
 209
 210                 /* Read the data from the asset and hash it */
 211                 dcpomatic_fseek (asset_file, info.offset, SEEK_SET);
 212                 Data data (info.size);
 213                 size_t const read = fread (data.data().get(), 1, data.size(), asset_file);
 214                 if (read != static_cast<size_t> (data.size ())) {
 215                         LOG_GENERAL ("Existing frame %1 is incomplete", _first_nonexistant_frame);
 216                         ok = false;
 217                 } else {
 218                         MD5Digester digester;
 219                         digester.add (data.data().get(), data.size());
 220                         if (digester.get() != info.hash) {
 221                                 LOG_GENERAL ("Existing frame %1 failed hash check", _first_nonexistant_frame);
 222                                 ok = false;
 223                         }
 224                 }
 225
 226                 if (!ok) {
 227                         --_first_nonexistant_frame;
 228                 }
 229         }
 230
 231         if (!_film->three_d() && ok) {
 232                 /* If we are doing 3D we might have found a good L frame with no R, so only
 233                    do this if we're in 2D and we've just found a good B(oth) frame.
 234                 */
 235                 ++_first_nonexistant_frame;
 236         }
 237
 238         fclose (asset_file);
 239         fclose (info_file);
 240 }
 241
 242 void
 243 ReelWriter::write (optional<Data> encoded, Frame frame, Eyes eyes)
 244 {
 245         dcp::FrameInfo fin = _picture_asset_writer->write (encoded->data().get (), encoded->size());
 246         write_frame_info (frame, eyes, fin);
 247         _last_written[eyes] = encoded;
 248         _last_written_video_frame = frame;
 249         _last_written_eyes = eyes;
 250 }
 251
 252 void
 253 ReelWriter::fake_write (Frame frame, Eyes eyes, int size)
 254 {
 255         _picture_asset_writer->fake_write (size);
 256         _last_written_video_frame = frame;
 257         _last_written_eyes = eyes;
 258 }
 259
 260 void
 261 ReelWriter::repeat_write (Frame frame, Eyes eyes)
 262 {
 263         dcp::FrameInfo fin = _picture_asset_writer->write (
 264                 _last_written[eyes]->data().get(),
 265                 _last_written[eyes]->size()
 266                 );
 267         write_frame_info (frame, eyes, fin);
 268         _last_written_video_frame = frame;
 269         _last_written_eyes = eyes;
 270 }
 271
 272 void
 273 ReelWriter::finish ()
 274 {
 275         if (!_picture_asset_writer->finalize ()) {
 276                 /* Nothing was written to the picture asset */
 277                 _picture_asset.reset ();
 278         }
 279
 280         if (_sound_asset_writer && !_sound_asset_writer->finalize ()) {
 281                 /* Nothing was written to the sound asset */
 282                 _sound_asset.reset ();
 283         }
 284
 285         /* Hard-link any video asset file into the DCP */
 286         if (_picture_asset) {
 287                 boost::filesystem::path video_from = _picture_asset->file ();
 288                 boost::filesystem::path video_to;
 289                 video_to /= _film->dir (_film->dcp_name());
 290                 video_to /= video_asset_filename (_picture_asset);
 291
 292                 boost::system::error_code ec;
 293                 boost::filesystem::create_hard_link (video_from, video_to, ec);
 294                 if (ec) {
 295                         LOG_WARNING_NC ("Hard-link failed; copying instead");
 296                         boost::filesystem::copy_file (video_from, video_to, ec);
 297                         if (ec) {
 298                                 LOG_ERROR ("Failed to copy video file from %1 to %2 (%3)", video_from.string(), video_to.string(), ec.message ());
 299                                 throw FileError (ec.message(), video_from);
 300                         }
 301                 }
 302
 303                 _picture_asset->set_file (video_to);
 304         }
 305
 306         /* Move the audio asset into the DCP */
 307         if (_sound_asset) {
 308                 boost::filesystem::path audio_to;
 309                 audio_to /= _film->dir (_film->dcp_name ());
 310                 audio_to /= audio_asset_filename (_sound_asset);
 311
 312                 boost::system::error_code ec;
 313                 boost::filesystem::rename (_film->file (audio_asset_filename (_sound_asset)), audio_to, ec);
 314                 if (ec) {
 315                         throw FileError (
 316                                 String::compose (_("could not move audio asset into the DCP (%1)"), ec.value ()), audio_asset_filename (_sound_asset)
 317                                 );
 318                 }
 319
 320                 _sound_asset->set_file (audio_to);
 321         }
 322 }
 323
 324 shared_ptr<dcp::Reel>
 325 ReelWriter::create_reel (list<ReferencedReelAsset> const & refs, list<shared_ptr<Font> > const & fonts)
 326 {
 327         shared_ptr<dcp::Reel> reel (new dcp::Reel ());
 328
 329         shared_ptr<dcp::ReelPictureAsset> reel_picture_asset;
 330
 331         if (_picture_asset) {
 332                 /* We have made a picture asset of our own.  Put it into the reel */
 333                 shared_ptr<dcp::MonoPictureAsset> mono = dynamic_pointer_cast<dcp::MonoPictureAsset> (_picture_asset);
 334                 if (mono) {
 335                         reel_picture_asset.reset (new dcp::ReelMonoPictureAsset (mono, 0));
 336                 }
 337
 338                 shared_ptr<dcp::StereoPictureAsset> stereo = dynamic_pointer_cast<dcp::StereoPictureAsset> (_picture_asset);
 339                 if (stereo) {
 340                         reel_picture_asset.reset (new dcp::ReelStereoPictureAsset (stereo, 0));
 341                 }
 342         } else {
 343                 /* We don't have a picture asset of our own; hopefully we have one to reference */
 344                 BOOST_FOREACH (ReferencedReelAsset j, refs) {
 345                         shared_ptr<dcp::ReelPictureAsset> k = dynamic_pointer_cast<dcp::ReelPictureAsset> (j.asset);
 346                         if (k && j.period == _period) {
 347                                 reel_picture_asset = k;
 348                         }
 349                 }
 350         }
 351
 352         reel->add (reel_picture_asset);
 353
 354         if (_sound_asset) {
 355                 /* We have made a sound asset of our own.  Put it into the reel */
 356                 reel->add (shared_ptr<dcp::ReelSoundAsset> (new dcp::ReelSoundAsset (_sound_asset, 0)));
 357         } else {
 358                 /* We don't have a sound asset of our own; hopefully we have one to reference */
 359                 BOOST_FOREACH (ReferencedReelAsset j, refs) {
 360                         shared_ptr<dcp::ReelSoundAsset> k = dynamic_pointer_cast<dcp::ReelSoundAsset> (j.asset);
 361                         if (k && j.period == _period) {
 362                                 reel->add (k);
 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                         }
 422                 }
 423         }
 424
 425         return reel;
 426 }
 427
 428 void
 429 ReelWriter::calculate_digests (shared_ptr<Job> job)
 430 {
 431         job->sub (_("Computing image digest"));
 432         if (_picture_asset) {
 433                 _picture_asset->hash (boost::bind (&Job::set_progress, job.get(), _1, false));
 434         }
 435
 436         if (_sound_asset) {
 437                 job->sub (_("Computing audio digest"));
 438                 _sound_asset->hash (boost::bind (&Job::set_progress, job.get(), _1, false));
 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                         _subtitle_asset = s;
 486                 }
 487         }
 488
 489         BOOST_FOREACH (dcp::SubtitleString i, subs.text) {
 490                 i.set_in  (i.in()  - dcp::Time (_period.from.seconds(), i.in().tcr));
 491                 i.set_out (i.out() - dcp::Time (_period.from.seconds(), i.out().tcr));
 492                 _subtitle_asset->add (i);
 493         }
 494 }