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