Continue with comparison even if lengths differ.
[libdcp.git] / src / picture_asset.cc
1 /*
2     Copyright (C) 2012 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 /** @file  src/picture_asset.cc
21  *  @brief An asset made up of JPEG2000 files
22  */
23
24 #include <list>
25 #include <stdexcept>
26 #include <iostream>
27 #include <sstream>
28 #include <fstream>
29 #include <boost/filesystem.hpp>
30 #include <boost/lexical_cast.hpp>
31 #include <openjpeg.h>
32 #include <libxml++/nodes/element.h>
33 #include "AS_DCP.h"
34 #include "KM_fileio.h"
35 #include "picture_asset.h"
36 #include "util.h"
37 #include "exceptions.h"
38 #include "picture_frame.h"
39 #include "xyz_frame.h"
40
41 using std::string;
42 using std::ostream;
43 using std::list;
44 using std::vector;
45 using std::max;
46 using std::stringstream;
47 using std::pair;
48 using std::make_pair;
49 using std::istream;
50 using std::cout;
51 using boost::shared_ptr;
52 using boost::dynamic_pointer_cast;
53 using boost::lexical_cast;
54 using namespace libdcp;
55
56 PictureAsset::PictureAsset (string directory, string mxf_name, boost::signals2::signal<void (float)>* progress, int fps, int intrinsic_duration, bool encrypted, Size size)
57         : MXFAsset (directory, mxf_name, progress, fps, intrinsic_duration, encrypted)
58         , _size (size)
59 {
60
61 }
62
63 PictureAsset::PictureAsset (string directory, string mxf_name)
64         : MXFAsset (directory, mxf_name)
65 {
66
67 }
68
69 string
70 PictureAsset::cpl_node_name () const
71 {
72         return "MainPicture";
73 }
74
75 void
76 PictureAsset::write_to_cpl (xmlpp::Node* node) const
77 {
78         MXFAsset::write_to_cpl (node);
79         
80         xmlpp::Node::NodeList c = node->get_children ();
81         xmlpp::Node::NodeList::iterator i = c.begin();
82         while (i != c.end() && (*i)->get_name() != cpl_node_name ()) {
83                 ++i;
84         }
85
86         assert (i != c.end ());
87
88         (*i)->add_child ("FrameRate")->add_child_text (lexical_cast<string> (_edit_rate) + " 1");
89         (*i)->add_child ("ScreenAspectRatio")->add_child_text (lexical_cast<string> (_size.width) + " " + lexical_cast<string> (_size.height));
90 }
91
92 bool
93 PictureAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, string)> note) const
94 {
95         if (!MXFAsset::equals (other, opt, note)) {
96                 return false;
97         }
98                      
99         ASDCP::JP2K::MXFReader reader_A;
100         if (ASDCP_FAILURE (reader_A.OpenRead (path().string().c_str()))) {
101                 boost::throw_exception (MXFFileError ("could not open MXF file for reading", path().string()));
102         }
103         
104         ASDCP::JP2K::MXFReader reader_B;
105         if (ASDCP_FAILURE (reader_B.OpenRead (other->path().string().c_str()))) {
106                 boost::throw_exception (MXFFileError ("could not open MXF file for reading", path().string()));
107         }
108         
109         ASDCP::JP2K::PictureDescriptor desc_A;
110         if (ASDCP_FAILURE (reader_A.FillPictureDescriptor (desc_A))) {
111                 boost::throw_exception (DCPReadError ("could not read video MXF information"));
112         }
113         ASDCP::JP2K::PictureDescriptor desc_B;
114         if (ASDCP_FAILURE (reader_B.FillPictureDescriptor (desc_B))) {
115                 boost::throw_exception (DCPReadError ("could not read video MXF information"));
116         }
117         
118         if (
119                 desc_A.EditRate != desc_B.EditRate ||
120                 desc_A.ContainerDuration != desc_B.ContainerDuration ||
121                 desc_A.SampleRate != desc_B.SampleRate ||
122                 desc_A.StoredWidth != desc_B.StoredWidth ||
123                 desc_A.StoredHeight != desc_B.StoredHeight ||
124                 desc_A.AspectRatio != desc_B.AspectRatio ||
125                 desc_A.Rsize != desc_B.Rsize ||
126                 desc_A.Xsize != desc_B.Xsize ||
127                 desc_A.Ysize != desc_B.Ysize ||
128                 desc_A.XOsize != desc_B.XOsize ||
129                 desc_A.YOsize != desc_B.YOsize ||
130                 desc_A.XTsize != desc_B.XTsize ||
131                 desc_A.YTsize != desc_B.YTsize ||
132                 desc_A.XTOsize != desc_B.XTOsize ||
133                 desc_A.YTOsize != desc_B.YTOsize ||
134                 desc_A.Csize != desc_B.Csize
135 //              desc_A.CodingStyleDefault != desc_B.CodingStyleDefault ||
136 //              desc_A.QuantizationDefault != desc_B.QuantizationDefault
137                 ) {
138                 
139                 note (ERROR, "video MXF picture descriptors differ");
140                 return false;
141         }
142
143 //              for (unsigned int j = 0; j < ASDCP::JP2K::MaxComponents; ++j) {
144 //                      if (desc_A.ImageComponents[j] != desc_B.ImageComponents[j]) {
145 //                              notes.pack_start ("video MXF picture descriptors differ");
146 //                      }
147 //              }
148
149         return true;
150 }
151
152
153 MonoPictureAsset::MonoPictureAsset (
154         boost::function<string (int)> get_path,
155         string directory,
156         string mxf_name,
157         boost::signals2::signal<void (float)>* progress,
158         int fps,
159         int intrinsic_duration,
160         bool encrypted,
161         Size size,
162         MXFMetadata const & metadata
163         )
164         : PictureAsset (directory, mxf_name, progress, fps, intrinsic_duration, encrypted, size)
165 {
166         construct (get_path, metadata);
167 }
168
169 MonoPictureAsset::MonoPictureAsset (
170         vector<string> const & files,
171         string directory,
172         string mxf_name,
173         boost::signals2::signal<void (float)>* progress,
174         int fps,
175         int intrinsic_duration,
176         bool encrypted,
177         Size size,
178         MXFMetadata const & metadata
179         )
180         : PictureAsset (directory, mxf_name, progress, fps, intrinsic_duration, encrypted, size)
181 {
182         construct (boost::bind (&MonoPictureAsset::path_from_list, this, _1, files), metadata);
183 }
184
185 MonoPictureAsset::MonoPictureAsset (string directory, string mxf_name, int fps, Size size)
186         : PictureAsset (directory, mxf_name, 0, fps, 0, false, size)
187 {
188
189 }
190
191 MonoPictureAsset::MonoPictureAsset (string directory, string mxf_name)
192         : PictureAsset (directory, mxf_name)
193 {
194         ASDCP::JP2K::MXFReader reader;
195         if (ASDCP_FAILURE (reader.OpenRead (path().string().c_str()))) {
196                 boost::throw_exception (MXFFileError ("could not open MXF file for reading", path().string()));
197         }
198         
199         ASDCP::JP2K::PictureDescriptor desc;
200         if (ASDCP_FAILURE (reader.FillPictureDescriptor (desc))) {
201                 boost::throw_exception (DCPReadError ("could not read video MXF information"));
202         }
203
204         _size.width = desc.StoredWidth;
205         _size.height = desc.StoredHeight;
206         _edit_rate = desc.EditRate.Numerator;
207         assert (desc.EditRate.Denominator == 1);
208         _intrinsic_duration = desc.ContainerDuration;
209 }
210
211 void
212 MonoPictureAsset::construct (boost::function<string (int)> get_path, MXFMetadata const & metadata)
213 {
214         ASDCP::JP2K::CodestreamParser j2k_parser;
215         ASDCP::JP2K::FrameBuffer frame_buffer (4 * Kumu::Megabyte);
216         if (ASDCP_FAILURE (j2k_parser.OpenReadFrame (get_path(0).c_str(), frame_buffer))) {
217                 boost::throw_exception (FileError ("could not open JPEG2000 file for reading", get_path (0)));
218         }
219         
220         ASDCP::JP2K::PictureDescriptor picture_desc;
221         j2k_parser.FillPictureDescriptor (picture_desc);
222         picture_desc.EditRate = ASDCP::Rational (_edit_rate, 1);
223         
224         ASDCP::WriterInfo writer_info;
225         fill_writer_info (&writer_info, _uuid, metadata);
226         
227         ASDCP::JP2K::MXFWriter mxf_writer;
228         if (ASDCP_FAILURE (mxf_writer.OpenWrite (path().string().c_str(), writer_info, picture_desc, 16384, false))) {
229                 boost::throw_exception (MXFFileError ("could not open MXF file for writing", path().string()));
230         }
231
232         for (int i = 0; i < _intrinsic_duration; ++i) {
233
234                 string const path = get_path (i);
235
236                 if (ASDCP_FAILURE (j2k_parser.OpenReadFrame (path.c_str(), frame_buffer))) {
237                         boost::throw_exception (FileError ("could not open JPEG2000 file for reading", path));
238                 }
239
240                 if (ASDCP_FAILURE (mxf_writer.WriteFrame (frame_buffer, _encryption_context, 0))) {
241                         boost::throw_exception (MXFFileError ("error in writing video MXF", this->path().string()));
242                 }
243
244                 if (_progress) {
245                         (*_progress) (0.5 * float (i) / _intrinsic_duration);
246                 }
247         }
248         
249         if (ASDCP_FAILURE (mxf_writer.Finalize())) {
250                 boost::throw_exception (MXFFileError ("error in finalising video MXF", path().string()));
251         }
252 }
253
254 string
255 MonoPictureAsset::path_from_list (int f, vector<string> const & files) const
256 {
257         return files[f];
258 }
259
260 shared_ptr<const MonoPictureFrame>
261 MonoPictureAsset::get_frame (int n) const
262 {
263         return shared_ptr<const MonoPictureFrame> (new MonoPictureFrame (path().string(), n, _decryption_context));
264 }
265
266
267 bool
268 MonoPictureAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, string)> note) const
269 {
270         if (!PictureAsset::equals (other, opt, note)) {
271                 return false;
272         }
273
274         shared_ptr<const MonoPictureAsset> other_picture = dynamic_pointer_cast<const MonoPictureAsset> (other);
275         assert (other_picture);
276
277         for (int i = 0; i < _intrinsic_duration; ++i) {
278                 if (i >= other_picture->intrinsic_duration()) {
279                         return false;
280                 }
281                 
282                 note (PROGRESS, "Comparing video frame " + lexical_cast<string> (i) + " of " + lexical_cast<string> (_intrinsic_duration));
283                 shared_ptr<const MonoPictureFrame> frame_A = get_frame (i);
284                 shared_ptr<const MonoPictureFrame> frame_B = other_picture->get_frame (i);
285                 
286                 if (!frame_buffer_equals (
287                             i, opt, note,
288                             frame_A->j2k_data(), frame_A->j2k_size(),
289                             frame_B->j2k_data(), frame_B->j2k_size()
290                             )) {
291                         return false;
292                 }
293         }
294
295         return true;
296 }
297
298 bool
299 StereoPictureAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, string)> note) const
300 {
301         if (!PictureAsset::equals (other, opt, note)) {
302                 return false;
303         }
304         
305         shared_ptr<const StereoPictureAsset> other_picture = dynamic_pointer_cast<const StereoPictureAsset> (other);
306         assert (other_picture);
307
308         for (int i = 0; i < _intrinsic_duration; ++i) {
309                 shared_ptr<const StereoPictureFrame> frame_A = get_frame (i);
310                 shared_ptr<const StereoPictureFrame> frame_B = other_picture->get_frame (i);
311                 
312                 if (!frame_buffer_equals (
313                             i, opt, note,
314                             frame_A->left_j2k_data(), frame_A->left_j2k_size(),
315                             frame_B->left_j2k_data(), frame_B->left_j2k_size()
316                             )) {
317                         return false;
318                 }
319                 
320                 if (!frame_buffer_equals (
321                             i, opt, note,
322                             frame_A->right_j2k_data(), frame_A->right_j2k_size(),
323                             frame_B->right_j2k_data(), frame_B->right_j2k_size()
324                             )) {
325                         return false;
326                 }
327         }
328
329         return true;
330 }
331
332 bool
333 PictureAsset::frame_buffer_equals (
334         int frame, EqualityOptions opt, boost::function<void (NoteType, string)> note,
335         uint8_t const * data_A, unsigned int size_A, uint8_t const * data_B, unsigned int size_B
336         ) const
337 {
338         if (size_A == size_B && memcmp (data_A, data_B, size_A) == 0) {
339                 note (NOTE, "J2K identical");
340                 /* Easy result; the J2K data is identical */
341                 return true;
342         }
343                 
344         /* Decompress the images to bitmaps */
345         shared_ptr<XYZFrame> image_A = decompress_j2k (const_cast<uint8_t*> (data_A), size_A, 0);
346         shared_ptr<XYZFrame> image_B = decompress_j2k (const_cast<uint8_t*> (data_B), size_B, 0);
347         
348         /* Compare them */
349         
350         vector<int> abs_diffs (image_A->size().width * image_A->size().height * 3);
351         int d = 0;
352         int max_diff = 0;
353         
354         for (int c = 0; c < 3; ++c) {
355                 
356                 if (image_A->size() != image_B->size()) {
357                         note (ERROR, "image sizes for frame " + lexical_cast<string>(frame) + " differ");
358                         return false;
359                 }
360                 
361                 int const pixels = image_A->size().width * image_A->size().height;
362                 for (int j = 0; j < pixels; ++j) {
363                         int const t = abs (image_A->data(c)[j] - image_B->data(c)[j]);
364                         abs_diffs[d++] = t;
365                         max_diff = max (max_diff, t);
366                 }
367         }
368                 
369         uint64_t total = 0;
370         for (vector<int>::iterator j = abs_diffs.begin(); j != abs_diffs.end(); ++j) {
371                 total += *j;
372         }
373         
374         double const mean = double (total) / abs_diffs.size ();
375         
376         uint64_t total_squared_deviation = 0;
377         for (vector<int>::iterator j = abs_diffs.begin(); j != abs_diffs.end(); ++j) {
378                 total_squared_deviation += pow (*j - mean, 2);
379         }
380         
381         double const std_dev = sqrt (double (total_squared_deviation) / abs_diffs.size());
382         
383         note (NOTE, "mean difference " + lexical_cast<string> (mean) + ", deviation " + lexical_cast<string> (std_dev));
384         
385         if (mean > opt.max_mean_pixel_error) {
386                 note (ERROR, "mean " + lexical_cast<string>(mean) + " out of range " + lexical_cast<string>(opt.max_mean_pixel_error) + " in frame " + lexical_cast<string>(frame));
387                 return false;
388         }
389
390         if (std_dev > opt.max_std_dev_pixel_error) {
391                 note (ERROR, "standard deviation " + lexical_cast<string>(std_dev) + " out of range " + lexical_cast<string>(opt.max_std_dev_pixel_error) + " in frame " + lexical_cast<string>(frame));
392                 return false;
393         }
394
395         return true;
396 }
397
398
399 StereoPictureAsset::StereoPictureAsset (string directory, string mxf_name, int fps, int intrinsic_duration)
400         : PictureAsset (directory, mxf_name, 0, fps, intrinsic_duration, false, Size (0, 0))
401 {
402         ASDCP::JP2K::MXFSReader reader;
403         if (ASDCP_FAILURE (reader.OpenRead (path().string().c_str()))) {
404                 boost::throw_exception (MXFFileError ("could not open MXF file for reading", path().string()));
405         }
406         
407         ASDCP::JP2K::PictureDescriptor desc;
408         if (ASDCP_FAILURE (reader.FillPictureDescriptor (desc))) {
409                 boost::throw_exception (DCPReadError ("could not read video MXF information"));
410         }
411
412         _size.width = desc.StoredWidth;
413         _size.height = desc.StoredHeight;
414 }
415
416 shared_ptr<const StereoPictureFrame>
417 StereoPictureAsset::get_frame (int n) const
418 {
419         return shared_ptr<const StereoPictureFrame> (new StereoPictureFrame (path().string(), n));
420 }
421
422 shared_ptr<MonoPictureAssetWriter>
423 MonoPictureAsset::start_write (bool overwrite, MXFMetadata const & metadata)
424 {
425         /* XXX: can't we use shared_ptr here? */
426         return shared_ptr<MonoPictureAssetWriter> (new MonoPictureAssetWriter (this, overwrite, metadata));
427 }
428
429 FrameInfo::FrameInfo (istream& s)
430 {
431         s >> offset >> size >> hash;
432 }
433
434 void
435 FrameInfo::write (ostream& s)
436 {
437         s << offset << " " << size << " " << hash;
438 }
439
440 struct MonoPictureAssetWriter::ASDCPState
441 {
442         ASDCPState()
443                 : frame_buffer (4 * Kumu::Megabyte)
444         {}
445         
446         ASDCP::JP2K::CodestreamParser j2k_parser;
447         ASDCP::JP2K::FrameBuffer frame_buffer;
448         ASDCP::JP2K::MXFWriter mxf_writer;
449         ASDCP::WriterInfo writer_info;
450         ASDCP::JP2K::PictureDescriptor picture_descriptor;
451 };
452
453
454 /** @param a Asset to write to.  `a' must not be deleted while
455  *  this writer class still exists, or bad things will happen.
456  */
457 MonoPictureAssetWriter::MonoPictureAssetWriter (MonoPictureAsset* a, bool overwrite, MXFMetadata const & m)
458         : _state (new MonoPictureAssetWriter::ASDCPState)
459         , _asset (a)
460         , _frames_written (0)
461         , _started (false)
462         , _finalized (false)
463         , _overwrite (overwrite)
464         , _metadata (m)
465 {
466
467 }
468
469
470 void
471 MonoPictureAssetWriter::start (uint8_t* data, int size)
472 {
473         if (ASDCP_FAILURE (_state->j2k_parser.OpenReadFrame (data, size, _state->frame_buffer))) {
474                 boost::throw_exception (MiscError ("could not parse J2K frame"));
475         }
476
477         _state->j2k_parser.FillPictureDescriptor (_state->picture_descriptor);
478         _state->picture_descriptor.EditRate = ASDCP::Rational (_asset->edit_rate(), 1);
479         
480         _asset->fill_writer_info (&_state->writer_info, _asset->uuid(), _metadata);
481         
482         if (ASDCP_FAILURE (_state->mxf_writer.OpenWrite (
483                                    _asset->path().string().c_str(),
484                                    _state->writer_info,
485                                    _state->picture_descriptor,
486                                    16384,
487                                    _overwrite)
488                     )) {
489                 
490                 boost::throw_exception (MXFFileError ("could not open MXF file for writing", _asset->path().string()));
491         }
492
493         _started = true;
494 }
495
496 FrameInfo
497 MonoPictureAssetWriter::write (uint8_t* data, int size)
498 {
499         assert (!_finalized);
500
501         if (!_started) {
502                 start (data, size);
503         }
504
505         if (ASDCP_FAILURE (_state->j2k_parser.OpenReadFrame (data, size, _state->frame_buffer))) {
506                 boost::throw_exception (MiscError ("could not parse J2K frame"));
507         }
508
509         uint64_t const before_offset = _state->mxf_writer.Tell ();
510
511         string hash;
512         if (ASDCP_FAILURE (_state->mxf_writer.WriteFrame (_state->frame_buffer, 0, 0, &hash))) {
513                 boost::throw_exception (MXFFileError ("error in writing video MXF", _asset->path().string()));
514         }
515
516         ++_frames_written;
517         return FrameInfo (before_offset, _state->mxf_writer.Tell() - before_offset, hash);
518 }
519
520 void
521 MonoPictureAssetWriter::fake_write (int size)
522 {
523         assert (_started);
524         assert (!_finalized);
525
526         if (ASDCP_FAILURE (_state->mxf_writer.FakeWriteFrame (size))) {
527                 boost::throw_exception (MXFFileError ("error in writing video MXF", _asset->path().string()));
528         }
529
530         ++_frames_written;
531 }
532
533 void
534 MonoPictureAssetWriter::finalize ()
535 {
536         assert (!_finalized);
537         
538         if (ASDCP_FAILURE (_state->mxf_writer.Finalize())) {
539                 boost::throw_exception (MXFFileError ("error in finalizing video MXF", _asset->path().string()));
540         }
541
542         _finalized = true;
543         _asset->set_intrinsic_duration (_frames_written);
544         _asset->set_duration (_frames_written);
545 }
546
547 string
548 PictureAsset::key_type () const
549 {
550         return "MDIK";
551 }