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