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 boost::shared_ptr;
  55 using boost::optional;
  56 using boost::dynamic_pointer_cast;
  57
  58 int const ReelWriter::_info_size = 48;
  59
  60 ReelWriter::ReelWriter (shared_ptr<const Film> film, DCPTimePeriod period, shared_ptr<Job> job)
  61         : _film (film)
  62         , _period (period)
  63         , _first_nonexistant_frame (0)
  64         , _last_written_video_frame (-1)
  65         , _last_written_eyes (EYES_RIGHT)
  66         , _total_written_audio_frames (0)
  67 {
  68         /* Create our picture asset in a subdirectory, named according to those
  69            film's parameters which affect the video output.  We will hard-link
  70            it into the DCP later.
  71         */
  72
  73         if (_film->three_d ()) {
  74                 _picture_asset.reset (new dcp::StereoPictureAsset (dcp::Fraction (_film->video_frame_rate (), 1)));
  75         } else {
  76                 _picture_asset.reset (new dcp::MonoPictureAsset (dcp::Fraction (_film->video_frame_rate (), 1)));
  77         }
  78
  79         _picture_asset->set_size (_film->frame_size ());
  80
  81         if (_film->encrypted ()) {
  82                 _picture_asset->set_key (_film->key ());
  83         }
  84
  85         _picture_asset->set_file (
  86                 _film->internal_video_asset_dir() / _film->internal_video_asset_filename(_period)
  87                 );
  88
  89         job->sub (_("Checking existing image data"));
  90         check_existing_picture_asset ();
  91
  92         _picture_asset_writer = _picture_asset->start_write (
  93                 _film->internal_video_asset_dir() / _film->internal_video_asset_filename(_period),
  94                 _film->interop() ? dcp::INTEROP : dcp::SMPTE,
  95                 _first_nonexistant_frame > 0
  96                 );
  97
  98         if (_film->audio_channels ()) {
  99                 _sound_asset.reset (
 100                         new dcp::SoundAsset (dcp::Fraction (_film->video_frame_rate(), 1), _film->audio_frame_rate (), _film->audio_channels ())
 101                         );
 102
 103                 if (_film->encrypted ()) {
 104                         _sound_asset->set_key (_film->key ());
 105                 }
 106
 107                 /* Write the sound asset into the film directory so that we leave the creation
 108                    of the DCP directory until the last minute.
 109                 */
 110                 _sound_asset_writer = _sound_asset->start_write (
 111                         _film->directory() / audio_asset_filename (_sound_asset),
 112                         _film->interop() ? dcp::INTEROP : dcp::SMPTE
 113                         );
 114         }
 115 }
 116
 117 /** @param frame reel-relative frame */
 118 void
 119 ReelWriter::write_frame_info (Frame frame, Eyes eyes, dcp::FrameInfo info) const
 120 {
 121         FILE* file = 0;
 122         boost::filesystem::path info_file = _film->info_file (_period);
 123         if (boost::filesystem::exists (info_file)) {
 124                 file = fopen_boost (info_file, "r+b");
 125         } else {
 126                 file = fopen_boost (info_file, "wb");
 127         }
 128         if (!file) {
 129                 throw OpenFileError (info_file);
 130         }
 131         dcpomatic_fseek (file, frame_info_position (frame, eyes), SEEK_SET);
 132         fwrite (&info.offset, sizeof (info.offset), 1, file);
 133         fwrite (&info.size, sizeof (info.size), 1, file);
 134         fwrite (info.hash.c_str(), 1, info.hash.size(), file);
 135         fclose (file);
 136 }
 137
 138 dcp::FrameInfo
 139 ReelWriter::read_frame_info (FILE* file, Frame frame, Eyes eyes) const
 140 {
 141         dcp::FrameInfo info;
 142         dcpomatic_fseek (file, frame_info_position (frame, eyes), SEEK_SET);
 143         fread (&info.offset, sizeof (info.offset), 1, file);
 144         fread (&info.size, sizeof (info.size), 1, file);
 145
 146         char hash_buffer[33];
 147         fread (hash_buffer, 1, 32, file);
 148         hash_buffer[32] = '\0';
 149         info.hash = hash_buffer;
 150
 151         return info;
 152 }
 153
 154 long
 155 ReelWriter::frame_info_position (Frame frame, Eyes eyes) const
 156 {
 157         switch (eyes) {
 158         case EYES_BOTH:
 159                 return frame * _info_size;
 160         case EYES_LEFT:
 161                 return frame * _info_size * 2;
 162         case EYES_RIGHT:
 163                 return frame * _info_size * 2 + _info_size;
 164         default:
 165                 DCPOMATIC_ASSERT (false);
 166         }
 167
 168         DCPOMATIC_ASSERT (false);
 169 }
 170
 171 void
 172 ReelWriter::check_existing_picture_asset ()
 173 {
 174         /* Try to open the existing asset */
 175         FILE* asset_file = fopen_boost (_picture_asset->file(), "rb");
 176         if (!asset_file) {
 177                 LOG_GENERAL ("Could not open existing asset at %1 (errno=%2)", _picture_asset->file().string(), errno);
 178                 return;
 179         }
 180
 181         /* Offset of the last dcp::FrameInfo in the info file */
 182         int const n = (boost::filesystem::file_size (_film->info_file(_period)) / _info_size) - 1;
 183
 184         FILE* info_file = fopen_boost (_film->info_file(_period), "rb");
 185         if (!info_file) {
 186                 LOG_GENERAL_NC ("Could not open film info file");
 187                 fclose (asset_file);
 188                 return;
 189         }
 190
 191         if (_film->three_d ()) {
 192                 /* Start looking at the last left frame */
 193                 _first_nonexistant_frame = n / 2;
 194         } else {
 195                 _first_nonexistant_frame = n;
 196         }
 197
 198         bool ok = false;
 199
 200         while (!ok) {
 201                 /* Read the data from the info file; for 3D we just check the left
 202                    frames until we find a good one.
 203                 */
 204                 dcp::FrameInfo info = read_frame_info (info_file, _first_nonexistant_frame, _film->three_d () ? EYES_LEFT : EYES_BOTH);
 205
 206                 ok = true;
 207
 208                 /* Read the data from the asset and hash it */
 209                 dcpomatic_fseek (asset_file, info.offset, SEEK_SET);
 210                 Data data (info.size);
 211                 size_t const read = fread (data.data().get(), 1, data.size(), asset_file);
 212                 if (read != static_cast<size_t> (data.size ())) {
 213                         LOG_GENERAL ("Existing frame %1 is incomplete", _first_nonexistant_frame);
 214                         ok = false;
 215                 } else {
 216                         MD5Digester digester;
 217                         digester.add (data.data().get(), data.size());
 218                         if (digester.get() != info.hash) {
 219                                 LOG_GENERAL ("Existing frame %1 failed hash check", _first_nonexistant_frame);
 220                                 ok = false;
 221                         }
 222                 }
 223
 224                 if (!ok) {
 225                         --_first_nonexistant_frame;
 226                 }
 227         }
 228
 229         if (!_film->three_d ()) {
 230                 /* If we are doing 3D we might have found a good L frame with no R, so only
 231                    do this if we're in 2D and we've just found a good B(oth) frame.
 232                 */
 233                 ++_first_nonexistant_frame;
 234         }
 235
 236         fclose (asset_file);
 237         fclose (info_file);
 238 }
 239
 240 void
 241 ReelWriter::write (optional<Data> encoded, Frame frame, Eyes eyes)
 242 {
 243         dcp::FrameInfo fin = _picture_asset_writer->write (encoded->data().get (), encoded->size());
 244         write_frame_info (frame, eyes, fin);
 245         _last_written[eyes] = encoded;
 246         _last_written_video_frame = frame;
 247         _last_written_eyes = eyes;
 248 }
 249
 250 void
 251 ReelWriter::fake_write (Frame frame, Eyes eyes, int size)
 252 {
 253         _picture_asset_writer->fake_write (size);
 254         _last_written_video_frame = frame;
 255         _last_written_eyes = eyes;
 256 }
 257
 258 void
 259 ReelWriter::repeat_write (Frame frame, Eyes eyes)
 260 {
 261         dcp::FrameInfo fin = _picture_asset_writer->write (
 262                 _last_written[eyes]->data().get(),
 263                 _last_written[eyes]->size()
 264                 );
 265         write_frame_info (frame, eyes, fin);
 266         _last_written_video_frame = frame;
 267         _last_written_eyes = eyes;
 268 }
 269
 270 void
 271 ReelWriter::finish ()
 272 {
 273         if (!_picture_asset_writer->finalize ()) {
 274                 /* Nothing was written to the picture asset */
 275                 _picture_asset.reset ();
 276         }
 277
 278         if (_sound_asset_writer && !_sound_asset_writer->finalize ()) {
 279                 /* Nothing was written to the sound asset */
 280                 _sound_asset.reset ();
 281         }
 282
 283         /* Hard-link any video asset file into the DCP */
 284         if (_picture_asset) {
 285                 boost::filesystem::path video_from = _picture_asset->file ();
 286                 boost::filesystem::path video_to;
 287                 video_to /= _film->dir (_film->dcp_name());
 288                 video_to /= video_asset_filename (_picture_asset);
 289
 290                 boost::system::error_code ec;
 291                 boost::filesystem::create_hard_link (video_from, video_to, ec);
 292                 if (ec) {
 293                         LOG_WARNING_NC ("Hard-link failed; copying instead");
 294                         boost::filesystem::copy_file (video_from, video_to, ec);
 295                         if (ec) {
 296                                 LOG_ERROR ("Failed to copy video file from %1 to %2 (%3)", video_from.string(), video_to.string(), ec.message ());
 297                                 throw FileError (ec.message(), video_from);
 298                         }
 299                 }
 300
 301                 _picture_asset->set_file (video_to);
 302         }
 303
 304         /* Move the audio asset into the DCP */
 305         if (_sound_asset) {
 306                 boost::filesystem::path audio_to;
 307                 audio_to /= _film->dir (_film->dcp_name ());
 308                 audio_to /= audio_asset_filename (_sound_asset);
 309
 310                 boost::system::error_code ec;
 311                 boost::filesystem::rename (_film->file (audio_asset_filename (_sound_asset)), audio_to, ec);
 312                 if (ec) {
 313                         throw FileError (
 314                                 String::compose (_("could not move audio asset into the DCP (%1)"), ec.value ()), audio_asset_filename (_sound_asset)
 315                                 );
 316                 }
 317
 318                 _sound_asset->set_file (audio_to);
 319         }
 320 }
 321
 322 shared_ptr<dcp::Reel>
 323 ReelWriter::create_reel (list<ReferencedReelAsset> const & refs, list<shared_ptr<Font> > const & fonts)
 324 {
 325         shared_ptr<dcp::Reel> reel (new dcp::Reel ());
 326
 327         shared_ptr<dcp::ReelPictureAsset> reel_picture_asset;
 328
 329         if (_picture_asset) {
 330                 /* We have made a picture asset of our own.  Put it into the reel */
 331                 shared_ptr<dcp::MonoPictureAsset> mono = dynamic_pointer_cast<dcp::MonoPictureAsset> (_picture_asset);
 332                 if (mono) {
 333                         reel_picture_asset.reset (new dcp::ReelMonoPictureAsset (mono, 0));
 334                 }
 335
 336                 shared_ptr<dcp::StereoPictureAsset> stereo = dynamic_pointer_cast<dcp::StereoPictureAsset> (_picture_asset);
 337                 if (stereo) {
 338                         reel_picture_asset.reset (new dcp::ReelStereoPictureAsset (stereo, 0));
 339                 }
 340         } else {
 341                 /* We don't have a picture asset of our own; hopefully we have one to reference */
 342                 BOOST_FOREACH (ReferencedReelAsset j, refs) {
 343                         shared_ptr<dcp::ReelPictureAsset> k = dynamic_pointer_cast<dcp::ReelPictureAsset> (j.asset);
 344                         if (k && j.period == _period) {
 345                                 reel_picture_asset = k;
 346                         }
 347                 }
 348         }
 349
 350         reel->add (reel_picture_asset);
 351
 352         if (_sound_asset) {
 353                 /* We have made a sound asset of our own.  Put it into the reel */
 354                 reel->add (shared_ptr<dcp::ReelSoundAsset> (new dcp::ReelSoundAsset (_sound_asset, 0)));
 355         } else {
 356                 /* We don't have a sound asset of our own; hopefully we have one to reference */
 357                 BOOST_FOREACH (ReferencedReelAsset j, refs) {
 358                         shared_ptr<dcp::ReelSoundAsset> k = dynamic_pointer_cast<dcp::ReelSoundAsset> (j.asset);
 359                         if (k && j.period == _period) {
 360                                 reel->add (k);
 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                         }
 420                 }
 421         }
 422
 423         return reel;
 424 }
 425
 426 void
 427 ReelWriter::calculate_digests (shared_ptr<Job> job)
 428 {
 429         job->sub (_("Computing image digest"));
 430         if (_picture_asset) {
 431                 _picture_asset->hash (boost::bind (&Job::set_progress, job.get(), _1, false));
 432         }
 433
 434         if (_sound_asset) {
 435                 job->sub (_("Computing audio digest"));
 436                 _sound_asset->hash (boost::bind (&Job::set_progress, job.get(), _1, false));
 437         }
 438 }
 439
 440 Frame
 441 ReelWriter::start () const
 442 {
 443         return _period.from.frames_floor (_film->video_frame_rate());
 444 }
 445
 446
 447 void
 448 ReelWriter::write (shared_ptr<const AudioBuffers> audio)
 449 {
 450         if (!_sound_asset_writer) {
 451                 return;
 452         }
 453
 454         if (audio) {
 455                 _sound_asset_writer->write (audio->data(), audio->frames());
 456         }
 457
 458         ++_total_written_audio_frames;
 459 }
 460
 461 void
 462 ReelWriter::write (PlayerSubtitles subs)
 463 {
 464         if (!_subtitle_asset) {
 465                 string lang = _film->subtitle_language ();
 466                 if (lang.empty ()) {
 467                         lang = "Unknown";
 468                 }
 469                 if (_film->interop ()) {
 470                         shared_ptr<dcp::InteropSubtitleAsset> s (new dcp::InteropSubtitleAsset ());
 471                         s->set_movie_title (_film->name ());
 472                         s->set_language (lang);
 473                         s->set_reel_number ("1");
 474                         _subtitle_asset = s;
 475                 } else {
 476                         shared_ptr<dcp::SMPTESubtitleAsset> s (new dcp::SMPTESubtitleAsset ());
 477                         s->set_content_title_text (_film->name ());
 478                         s->set_language (lang);
 479                         s->set_edit_rate (dcp::Fraction (_film->video_frame_rate (), 1));
 480                         s->set_reel_number (1);
 481                         s->set_time_code_rate (_film->video_frame_rate ());
 482                         s->set_start_time (dcp::Time ());
 483                         _subtitle_asset = s;
 484                 }
 485         }
 486
 487         for (list<dcp::SubtitleString>::const_iterator i = subs.text.begin(); i != subs.text.end(); ++i) {
 488                 _subtitle_asset->add (*i);
 489         }
 490 }