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 #include "picture_asset_writer.h"
  41
  42 using std::string;
  43 using std::ostream;
  44 using std::list;
  45 using std::vector;
  46 using std::max;
  47 using std::stringstream;
  48 using std::pair;
  49 using std::make_pair;
  50 using std::istream;
  51 using std::cout;
  52 using boost::shared_ptr;
  53 using boost::dynamic_pointer_cast;
  54 using boost::lexical_cast;
  55 using namespace libdcp;
  56
  57 PictureAsset::PictureAsset (string directory, string mxf_name, boost::signals2::signal<void (float)>* progress, int fps, int intrinsic_duration, bool encrypted, Size size)
  58         : MXFAsset (directory, mxf_name, progress, fps, intrinsic_duration, encrypted)
  59         , _size (size)
  60 {
  61
  62 }
  63
  64 PictureAsset::PictureAsset (string directory, string mxf_name)
  65         : MXFAsset (directory, mxf_name)
  66 {
  67
  68 }
  69
  70 string
  71 MonoPictureAsset::cpl_node_name () const
  72 {
  73         return "MainPicture";
  74 }
  75
  76 int
  77 MonoPictureAsset::edit_rate_factor () const
  78 {
  79         return 1;
  80 }
  81
  82 string
  83 StereoPictureAsset::cpl_node_name () const
  84 {
  85         return "MainStereoscopicPicture";
  86 }
  87
  88 int
  89 StereoPictureAsset::edit_rate_factor () const
  90 {
  91         return 2;
  92 }
  93
  94 void
  95 PictureAsset::write_to_cpl (xmlpp::Node* node) const
  96 {
  97         MXFAsset::write_to_cpl (node);
  98
  99         xmlpp::Node::NodeList c = node->get_children ();
 100         xmlpp::Node::NodeList::iterator i = c.begin();
 101         while (i != c.end() && (*i)->get_name() != cpl_node_name ()) {
 102                 ++i;
 103         }
 104
 105         assert (i != c.end ());
 106
 107         (*i)->add_child ("FrameRate")->add_child_text (lexical_cast<string> (_edit_rate * edit_rate_factor ()) + " 1");
 108         (*i)->add_child ("ScreenAspectRatio")->add_child_text (lexical_cast<string> (_size.width) + " " + lexical_cast<string> (_size.height));
 109 }
 110
 111 bool
 112 PictureAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, string)> note) const
 113 {
 114         if (!MXFAsset::equals (other, opt, note)) {
 115                 return false;
 116         }
 117
 118         ASDCP::JP2K::MXFReader reader_A;
 119         if (ASDCP_FAILURE (reader_A.OpenRead (path().string().c_str()))) {
 120                 boost::throw_exception (MXFFileError ("could not open MXF file for reading", path().string()));
 121         }
 122
 123         ASDCP::JP2K::MXFReader reader_B;
 124         if (ASDCP_FAILURE (reader_B.OpenRead (other->path().string().c_str()))) {
 125                 boost::throw_exception (MXFFileError ("could not open MXF file for reading", path().string()));
 126         }
 127
 128         ASDCP::JP2K::PictureDescriptor desc_A;
 129         if (ASDCP_FAILURE (reader_A.FillPictureDescriptor (desc_A))) {
 130                 boost::throw_exception (DCPReadError ("could not read video MXF information"));
 131         }
 132         ASDCP::JP2K::PictureDescriptor desc_B;
 133         if (ASDCP_FAILURE (reader_B.FillPictureDescriptor (desc_B))) {
 134                 boost::throw_exception (DCPReadError ("could not read video MXF information"));
 135         }
 136
 137         if (
 138                 desc_A.EditRate != desc_B.EditRate ||
 139                 desc_A.SampleRate != desc_B.SampleRate ||
 140                 desc_A.StoredWidth != desc_B.StoredWidth ||
 141                 desc_A.StoredHeight != desc_B.StoredHeight ||
 142                 desc_A.AspectRatio != desc_B.AspectRatio ||
 143                 desc_A.Rsize != desc_B.Rsize ||
 144                 desc_A.Xsize != desc_B.Xsize ||
 145                 desc_A.Ysize != desc_B.Ysize ||
 146                 desc_A.XOsize != desc_B.XOsize ||
 147                 desc_A.YOsize != desc_B.YOsize ||
 148                 desc_A.XTsize != desc_B.XTsize ||
 149                 desc_A.YTsize != desc_B.YTsize ||
 150                 desc_A.XTOsize != desc_B.XTOsize ||
 151                 desc_A.YTOsize != desc_B.YTOsize ||
 152                 desc_A.Csize != desc_B.Csize
 153 //              desc_A.CodingStyleDefault != desc_B.CodingStyleDefault ||
 154 //              desc_A.QuantizationDefault != desc_B.QuantizationDefault
 155                 ) {
 156
 157                 note (ERROR, "video MXF picture descriptors differ");
 158                 return false;
 159         }
 160
 161         if (desc_A.ContainerDuration != desc_B.ContainerDuration) {
 162                 note (ERROR, "video container durations differ");
 163         }
 164
 165 //              for (unsigned int j = 0; j < ASDCP::JP2K::MaxComponents; ++j) {
 166 //                      if (desc_A.ImageComponents[j] != desc_B.ImageComponents[j]) {
 167 //                              notes.pack_start ("video MXF picture descriptors differ");
 168 //                      }
 169 //              }
 170
 171         return true;
 172 }
 173
 174
 175 MonoPictureAsset::MonoPictureAsset (
 176         boost::function<string (int)> get_path,
 177         string directory,
 178         string mxf_name,
 179         boost::signals2::signal<void (float)>* progress,
 180         int fps,
 181         int intrinsic_duration,
 182         bool encrypted,
 183         Size size,
 184         bool interop,
 185         MXFMetadata const & metadata
 186         )
 187         : PictureAsset (directory, mxf_name, progress, fps, intrinsic_duration, encrypted, size)
 188 {
 189         construct (get_path, interop, metadata);
 190 }
 191
 192 MonoPictureAsset::MonoPictureAsset (
 193         vector<string> const & files,
 194         string directory,
 195         string mxf_name,
 196         boost::signals2::signal<void (float)>* progress,
 197         int fps,
 198         int intrinsic_duration,
 199         bool encrypted,
 200         Size size,
 201         bool interop,
 202         MXFMetadata const & metadata
 203         )
 204         : PictureAsset (directory, mxf_name, progress, fps, intrinsic_duration, encrypted, size)
 205 {
 206         construct (boost::bind (&MonoPictureAsset::path_from_list, this, _1, files), interop, metadata);
 207 }
 208
 209 MonoPictureAsset::MonoPictureAsset (string directory, string mxf_name, int fps, Size size)
 210         : PictureAsset (directory, mxf_name, 0, fps, 0, false, size)
 211 {
 212
 213 }
 214
 215 MonoPictureAsset::MonoPictureAsset (string directory, string mxf_name)
 216         : PictureAsset (directory, mxf_name)
 217 {
 218         ASDCP::JP2K::MXFReader reader;
 219         if (ASDCP_FAILURE (reader.OpenRead (path().string().c_str()))) {
 220                 boost::throw_exception (MXFFileError ("could not open MXF file for reading", path().string()));
 221         }
 222
 223         ASDCP::JP2K::PictureDescriptor desc;
 224         if (ASDCP_FAILURE (reader.FillPictureDescriptor (desc))) {
 225                 boost::throw_exception (DCPReadError ("could not read video MXF information"));
 226         }
 227
 228         _size.width = desc.StoredWidth;
 229         _size.height = desc.StoredHeight;
 230         _edit_rate = desc.EditRate.Numerator;
 231         assert (desc.EditRate.Denominator == 1);
 232         _intrinsic_duration = desc.ContainerDuration;
 233 }
 234
 235 void
 236 MonoPictureAsset::construct (boost::function<string (int)> get_path, bool interop, MXFMetadata const & metadata)
 237 {
 238         ASDCP::JP2K::CodestreamParser j2k_parser;
 239         ASDCP::JP2K::FrameBuffer frame_buffer (4 * Kumu::Megabyte);
 240         if (ASDCP_FAILURE (j2k_parser.OpenReadFrame (get_path(0).c_str(), frame_buffer))) {
 241                 boost::throw_exception (FileError ("could not open JPEG2000 file for reading", get_path (0)));
 242         }
 243
 244         ASDCP::JP2K::PictureDescriptor picture_desc;
 245         j2k_parser.FillPictureDescriptor (picture_desc);
 246         picture_desc.EditRate = ASDCP::Rational (_edit_rate, 1);
 247
 248         ASDCP::WriterInfo writer_info;
 249         fill_writer_info (&writer_info, _uuid, interop, metadata);
 250
 251         ASDCP::JP2K::MXFWriter mxf_writer;
 252         if (ASDCP_FAILURE (mxf_writer.OpenWrite (path().string().c_str(), writer_info, picture_desc, 16384, false))) {
 253                 boost::throw_exception (MXFFileError ("could not open MXF file for writing", path().string()));
 254         }
 255
 256         for (int i = 0; i < _intrinsic_duration; ++i) {
 257
 258                 string const path = get_path (i);
 259
 260                 if (ASDCP_FAILURE (j2k_parser.OpenReadFrame (path.c_str(), frame_buffer))) {
 261                         boost::throw_exception (FileError ("could not open JPEG2000 file for reading", path));
 262                 }
 263
 264                 if (ASDCP_FAILURE (mxf_writer.WriteFrame (frame_buffer, _encryption_context, 0))) {
 265                         boost::throw_exception (MXFFileError ("error in writing video MXF", this->path().string()));
 266                 }
 267
 268                 if (_progress) {
 269                         (*_progress) (0.5 * float (i) / _intrinsic_duration);
 270                 }
 271         }
 272
 273         if (ASDCP_FAILURE (mxf_writer.Finalize())) {
 274                 boost::throw_exception (MXFFileError ("error in finalising video MXF", path().string()));
 275         }
 276 }
 277
 278 string
 279 MonoPictureAsset::path_from_list (int f, vector<string> const & files) const
 280 {
 281         return files[f];
 282 }
 283
 284 shared_ptr<const MonoPictureFrame>
 285 MonoPictureAsset::get_frame (int n) const
 286 {
 287         return shared_ptr<const MonoPictureFrame> (new MonoPictureFrame (path().string(), n, _decryption_context));
 288 }
 289
 290
 291 bool
 292 MonoPictureAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, string)> note) const
 293 {
 294         if (!PictureAsset::equals (other, opt, note)) {
 295                 return false;
 296         }
 297
 298         shared_ptr<const MonoPictureAsset> other_picture = dynamic_pointer_cast<const MonoPictureAsset> (other);
 299         assert (other_picture);
 300
 301         for (int i = 0; i < _intrinsic_duration; ++i) {
 302                 if (i >= other_picture->intrinsic_duration()) {
 303                         return false;
 304                 }
 305
 306                 note (PROGRESS, "Comparing video frame " + lexical_cast<string> (i) + " of " + lexical_cast<string> (_intrinsic_duration));
 307                 shared_ptr<const MonoPictureFrame> frame_A = get_frame (i);
 308                 shared_ptr<const MonoPictureFrame> frame_B = other_picture->get_frame (i);
 309
 310                 if (!frame_buffer_equals (
 311                             i, opt, note,
 312                             frame_A->j2k_data(), frame_A->j2k_size(),
 313                             frame_B->j2k_data(), frame_B->j2k_size()
 314                             )) {
 315                         return false;
 316                 }
 317         }
 318
 319         return true;
 320 }
 321
 322 bool
 323 StereoPictureAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, string)> note) const
 324 {
 325         if (!PictureAsset::equals (other, opt, note)) {
 326                 return false;
 327         }
 328
 329         shared_ptr<const StereoPictureAsset> other_picture = dynamic_pointer_cast<const StereoPictureAsset> (other);
 330         assert (other_picture);
 331
 332         for (int i = 0; i < _intrinsic_duration; ++i) {
 333                 shared_ptr<const StereoPictureFrame> frame_A = get_frame (i);
 334                 shared_ptr<const StereoPictureFrame> frame_B = other_picture->get_frame (i);
 335
 336                 if (!frame_buffer_equals (
 337                             i, opt, note,
 338                             frame_A->left_j2k_data(), frame_A->left_j2k_size(),
 339                             frame_B->left_j2k_data(), frame_B->left_j2k_size()
 340                             )) {
 341                         return false;
 342                 }
 343
 344                 if (!frame_buffer_equals (
 345                             i, opt, note,
 346                             frame_A->right_j2k_data(), frame_A->right_j2k_size(),
 347                             frame_B->right_j2k_data(), frame_B->right_j2k_size()
 348                             )) {
 349                         return false;
 350                 }
 351         }
 352
 353         return true;
 354 }
 355
 356 bool
 357 PictureAsset::frame_buffer_equals (
 358         int frame, EqualityOptions opt, boost::function<void (NoteType, string)> note,
 359         uint8_t const * data_A, unsigned int size_A, uint8_t const * data_B, unsigned int size_B
 360         ) const
 361 {
 362         if (size_A == size_B && memcmp (data_A, data_B, size_A) == 0) {
 363                 note (NOTE, "J2K identical");
 364                 /* Easy result; the J2K data is identical */
 365                 return true;
 366         }
 367
 368         /* Decompress the images to bitmaps */
 369         shared_ptr<XYZFrame> image_A = decompress_j2k (const_cast<uint8_t*> (data_A), size_A, 0);
 370         shared_ptr<XYZFrame> image_B = decompress_j2k (const_cast<uint8_t*> (data_B), size_B, 0);
 371
 372         /* Compare them */
 373
 374         vector<int> abs_diffs (image_A->size().width * image_A->size().height * 3);
 375         int d = 0;
 376         int max_diff = 0;
 377
 378         for (int c = 0; c < 3; ++c) {
 379
 380                 if (image_A->size() != image_B->size()) {
 381                         note (ERROR, "image sizes for frame " + lexical_cast<string>(frame) + " differ");
 382                         return false;
 383                 }
 384
 385                 int const pixels = image_A->size().width * image_A->size().height;
 386                 for (int j = 0; j < pixels; ++j) {
 387                         int const t = abs (image_A->data(c)[j] - image_B->data(c)[j]);
 388                         abs_diffs[d++] = t;
 389                         max_diff = max (max_diff, t);
 390                 }
 391         }
 392
 393         uint64_t total = 0;
 394         for (vector<int>::iterator j = abs_diffs.begin(); j != abs_diffs.end(); ++j) {
 395                 total += *j;
 396         }
 397
 398         double const mean = double (total) / abs_diffs.size ();
 399
 400         uint64_t total_squared_deviation = 0;
 401         for (vector<int>::iterator j = abs_diffs.begin(); j != abs_diffs.end(); ++j) {
 402                 total_squared_deviation += pow (*j - mean, 2);
 403         }
 404
 405         double const std_dev = sqrt (double (total_squared_deviation) / abs_diffs.size());
 406
 407         note (NOTE, "mean difference " + lexical_cast<string> (mean) + ", deviation " + lexical_cast<string> (std_dev));
 408
 409         if (mean > opt.max_mean_pixel_error) {
 410                 note (ERROR, "mean " + lexical_cast<string>(mean) + " out of range " + lexical_cast<string>(opt.max_mean_pixel_error) + " in frame " + lexical_cast<string>(frame));
 411                 return false;
 412         }
 413
 414         if (std_dev > opt.max_std_dev_pixel_error) {
 415                 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));
 416                 return false;
 417         }
 418
 419         return true;
 420 }
 421
 422
 423 StereoPictureAsset::StereoPictureAsset (string directory, string mxf_name, int fps, int intrinsic_duration)
 424         : PictureAsset (directory, mxf_name, 0, fps, intrinsic_duration, false, Size (0, 0))
 425 {
 426         ASDCP::JP2K::MXFSReader reader;
 427         if (ASDCP_FAILURE (reader.OpenRead (path().string().c_str()))) {
 428                 boost::throw_exception (MXFFileError ("could not open MXF file for reading", path().string()));
 429         }
 430
 431         ASDCP::JP2K::PictureDescriptor desc;
 432         if (ASDCP_FAILURE (reader.FillPictureDescriptor (desc))) {
 433                 boost::throw_exception (DCPReadError ("could not read video MXF information"));
 434         }
 435
 436         _size.width = desc.StoredWidth;
 437         _size.height = desc.StoredHeight;
 438 }
 439
 440 shared_ptr<const StereoPictureFrame>
 441 StereoPictureAsset::get_frame (int n) const
 442 {
 443         return shared_ptr<const StereoPictureFrame> (new StereoPictureFrame (path().string(), n));
 444 }
 445
 446 shared_ptr<PictureAssetWriter>
 447 MonoPictureAsset::start_write (bool overwrite, bool interop, MXFMetadata const & metadata)
 448 {
 449         /* XXX: can't we use shared_ptr here? */
 450         return shared_ptr<MonoPictureAssetWriter> (new MonoPictureAssetWriter (this, overwrite, interop, metadata));
 451 }
 452
 453 string
 454 PictureAsset::key_type () const
 455 {
 456         return "MDIK";
 457 }
 458
 459 StereoPictureAsset::StereoPictureAsset (string directory, string mxf_name, int fps, Size size)
 460         : PictureAsset (directory, mxf_name, 0, fps, 0, false, size)
 461 {
 462
 463 }
 464
 465 shared_ptr<PictureAssetWriter>
 466 StereoPictureAsset::start_write (bool overwrite, bool interop, MXFMetadata const & metadata)
 467 {
 468         /* XXX: can't we use shared_ptr here? */
 469         return shared_ptr<StereoPictureAssetWriter> (new StereoPictureAssetWriter (this, overwrite, interop, metadata));
 470 }
 471