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