Some compilers don't like x = {} where x is a boost::optional<string>
[libdcp.git] / src / picture_asset.cc
index 142bc8fc6ab053efa14372b1bcb1f110fe48295f..86d85d464e45d725c9886790ccd7514f22f84a99 100644 (file)
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of libdcp.
+
+    libdcp is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    libdcp is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
+    along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
+
+    In addition, as a special exception, the copyright holders give
+    permission to link the code of portions of this program with the
+    OpenSSL library under certain conditions as described in each
+    individual source file, and distribute linked combinations
+    including the two.
+
+    You must obey the GNU General Public License in all respects
+    for all of the code used other than OpenSSL.  If you modify
+    file(s) with this exception, you may extend this exception to your
+    version of the file(s), but you are not obligated to do so.  If you
+    do not wish to do so, delete this exception statement from your
+    version.  If you delete this exception statement from all source
+    files in the program, then also delete it here.
 */
 
+
 /** @file  src/picture_asset.cc
- *  @brief An asset made up of JPEG2000 files
+ *  @brief PictureAsset class
  */
 
-#include <list>
-#include <stdexcept>
-#include <iostream>
-#include <sstream>
-#include <fstream>
-#include <boost/filesystem.hpp>
-#include <boost/lexical_cast.hpp>
-#include <openjpeg.h>
-#include "AS_DCP.h"
-#include "KM_fileio.h"
+
 #include "picture_asset.h"
 #include "util.h"
 #include "exceptions.h"
-#include "picture_frame.h"
+#include "openjpeg_image.h"
+#include "picture_asset_writer.h"
+#include "dcp_assert.h"
+#include "compose.hpp"
+#include "j2k.h"
+#include <asdcp/AS_DCP.h>
+#include <asdcp/KM_fileio.h>
+#include <libxml++/nodes/element.h>
+#include <boost/filesystem.hpp>
+#include <list>
+#include <stdexcept>
+
+
+using std::string;
+using std::list;
+using std::vector;
+using std::max;
+using std::pair;
+using std::make_pair;
+using std::shared_ptr;
+using namespace dcp;
 
-using namespace std;
-using namespace boost;
-using namespace libdcp;
 
-PictureAsset::PictureAsset (string directory, string mxf_name, sigc::signal1<void, float>* progress, int fps, int entry_point, int length)
-       : MXFAsset (directory, mxf_name, progress, fps, entry_point, length)
-       , _width (0)
-       , _height (0)
+PictureAsset::PictureAsset (boost::filesystem::path file)
+       : Asset (file)
+       , _intrinsic_duration (0)
 {
 
 }
 
-void
-PictureAsset::write_to_cpl (ostream& s) const
+
+PictureAsset::PictureAsset (Fraction edit_rate, Standard standard)
+       : MXF (standard)
+       , _edit_rate (edit_rate)
+       , _intrinsic_duration (0)
 {
-       s << "        <MainPicture>\n"
-         << "          <Id>urn:uuid:" << _uuid << "</Id>\n"
-         << "          <AnnotationText>" << _file_name << "</AnnotationText>\n"
-         << "          <EditRate>" << _fps << " 1</EditRate>\n"
-         << "          <IntrinsicDuration>" << _length << "</IntrinsicDuration>\n"
-         << "          <EntryPoint>0</EntryPoint>\n"
-         << "          <Duration>" << _length << "</Duration>\n"
-         << "          <FrameRate>" << _fps << " 1</FrameRate>\n"
-         << "          <ScreenAspectRatio>" << _width << " " << _height << "</ScreenAspectRatio>\n"
-         << "        </MainPicture>\n";
+
 }
 
-/* XXX: could use get_frame()? */
-list<string>
-PictureAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt) const
+
+void
+PictureAsset::read_picture_descriptor (ASDCP::JP2K::PictureDescriptor const & desc)
 {
-       list<string> notes = MXFAsset::equals (other, opt);
-                    
-       if (opt.flags & MXF_INSPECT) {
-               ASDCP::JP2K::MXFReader reader_A;
-               if (ASDCP_FAILURE (reader_A.OpenRead (path().string().c_str()))) {
-                       throw MXFFileError ("could not open MXF file for reading", path().string());
-               }
+       _size.width = desc.StoredWidth;
+       _size.height = desc.StoredHeight;
+       _edit_rate = Fraction (desc.EditRate.Numerator, desc.EditRate.Denominator);
+       _intrinsic_duration = desc.ContainerDuration;
+       _frame_rate = Fraction (desc.SampleRate.Numerator, desc.SampleRate.Denominator);
+       _screen_aspect_ratio = Fraction (desc.AspectRatio.Numerator, desc.AspectRatio.Denominator);
+}
 
-               ASDCP::JP2K::MXFReader reader_B;
-               if (ASDCP_FAILURE (reader_B.OpenRead (other->path().string().c_str()))) {
-                       throw MXFFileError ("could not open MXF file for reading", path().string());
-               }
 
-               ASDCP::JP2K::PictureDescriptor desc_A;
-               if (ASDCP_FAILURE (reader_A.FillPictureDescriptor (desc_A))) {
-                       throw DCPReadError ("could not read video MXF information");
-               }
-               ASDCP::JP2K::PictureDescriptor desc_B;
-               if (ASDCP_FAILURE (reader_B.FillPictureDescriptor (desc_B))) {
-                       throw DCPReadError ("could not read video MXF information");
-               }
+bool
+PictureAsset::descriptor_equals (
+       ASDCP::JP2K::PictureDescriptor const & a, ASDCP::JP2K::PictureDescriptor const & b, NoteHandler note
+       ) const
+{
+       if (
+               a.EditRate != b.EditRate ||
+               a.SampleRate != b.SampleRate ||
+               a.StoredWidth != b.StoredWidth ||
+               a.StoredHeight != b.StoredHeight ||
+               a.AspectRatio != b.AspectRatio ||
+               a.Rsize != b.Rsize ||
+               a.Xsize != b.Xsize ||
+               a.Ysize != b.Ysize ||
+               a.XOsize != b.XOsize ||
+               a.YOsize != b.YOsize ||
+               a.XTsize != b.XTsize ||
+               a.YTsize != b.YTsize ||
+               a.XTOsize != b.XTOsize ||
+               a.YTOsize != b.YTOsize ||
+               a.Csize != b.Csize
+//             a.CodingStyleDefault != b.CodingStyleDefault ||
+//             a.QuantizationDefault != b.QuantizationDefault
+               ) {
+
+               note (NoteType::ERROR, "video MXF picture descriptors differ");
+               return false;
+       }
 
-               if (
-                       desc_A.EditRate != desc_B.EditRate ||
-                       desc_A.ContainerDuration != desc_B.ContainerDuration ||
-                       desc_A.SampleRate != desc_B.SampleRate ||
-                       desc_A.StoredWidth != desc_B.StoredWidth ||
-                       desc_A.StoredHeight != desc_B.StoredHeight ||
-                       desc_A.AspectRatio != desc_B.AspectRatio ||
-                       desc_A.Rsize != desc_B.Rsize ||
-                       desc_A.Xsize != desc_B.Xsize ||
-                       desc_A.Ysize != desc_B.Ysize ||
-                       desc_A.XOsize != desc_B.XOsize ||
-                       desc_A.YOsize != desc_B.YOsize ||
-                       desc_A.XTsize != desc_B.XTsize ||
-                       desc_A.YTsize != desc_B.YTsize ||
-                       desc_A.XTOsize != desc_B.XTOsize ||
-                       desc_A.YTOsize != desc_B.YTOsize ||
-                       desc_A.Csize != desc_B.Csize
-//                     desc_A.CodingStyleDefault != desc_B.CodingStyleDefault ||
-//                     desc_A.QuantizationDefault != desc_B.QuantizationDefault
-                       ) {
-               
-                       notes.push_back ("video MXF picture descriptors differ");
-               }
+       if (a.ContainerDuration != b.ContainerDuration) {
+               note (NoteType::ERROR, "video container durations differ");
+       }
 
 //             for (unsigned int j = 0; j < ASDCP::JP2K::MaxComponents; ++j) {
-//                     if (desc_A.ImageComponents[j] != desc_B.ImageComponents[j]) {
+//                     if (a.ImageComponents[j] != b.ImageComponents[j]) {
 //                             notes.pack_start ("video MXF picture descriptors differ");
 //                     }
 //             }
-                               
-
-               ASDCP::JP2K::FrameBuffer buffer_A (4 * Kumu::Megabyte);
-               ASDCP::JP2K::FrameBuffer buffer_B (4 * Kumu::Megabyte);
-
-               for (int i = 0; i < _length; ++i) {
-                       if (ASDCP_FAILURE (reader_A.ReadFrame (i, buffer_A))) {
-                               throw DCPReadError ("could not read video frame");
-                       }
-
-                       if (ASDCP_FAILURE (reader_B.ReadFrame (i, buffer_B))) {
-                               throw DCPReadError ("could not read video frame");
-                       }
-
-                       bool j2k_same = true;
-
-                       if (buffer_A.Size() != buffer_B.Size()) {
-                               notes.push_back ("sizes of video data for frame " + lexical_cast<string>(i) + " differ");
-                               j2k_same = false;
-                       } else if (memcmp (buffer_A.RoData(), buffer_B.RoData(), buffer_A.Size()) != 0) {
-                               notes.push_back ("J2K data for frame " + lexical_cast<string>(i) + " differ");
-                               j2k_same = false;
-                       }
-
-                       if (!j2k_same) {
-
-                               if (opt.verbose) {
-                                       cout << "J2K images for " << i << " differ; checking by pixel\n";
-                               }
-                               
-                               /* Decompress the images to bitmaps */
-                               opj_image_t* image_A = decompress_j2k (const_cast<uint8_t*> (buffer_A.RoData()), buffer_A.Size (), 0);
-                               opj_image_t* image_B = decompress_j2k (const_cast<uint8_t*> (buffer_B.RoData()), buffer_B.Size (), 0);
-
-                               /* Compare them */
-                               
-                               if (image_A->numcomps != image_B->numcomps) {
-                                       notes.push_back ("image component counts for frame " + lexical_cast<string>(i) + " differ");
-                               }
-
-                               vector<int> abs_diffs (image_A->comps[0].w * image_A->comps[0].h * image_A->numcomps);
-                               int d = 0;
-                               int max_diff = 0;
-
-                               for (int c = 0; c < image_A->numcomps; ++c) {
-
-                                       if (image_A->comps[c].w != image_B->comps[c].w || image_A->comps[c].h != image_B->comps[c].h) {
-                                               notes.push_back ("image sizes for frame " + lexical_cast<string>(i) + " differ");
-                                       }
-
-                                       int const pixels = image_A->comps[c].w * image_A->comps[c].h;
-                                       for (int j = 0; j < pixels; ++j) {
-                                               int const t = abs (image_A->comps[c].data[j] - image_B->comps[c].data[j]);
-                                               abs_diffs[d++] = t;
-                                               max_diff = max (max_diff, t);
-                                       }
-                               }
-
-                               uint64_t total = 0;
-                               for (vector<int>::iterator j = abs_diffs.begin(); j != abs_diffs.end(); ++j) {
-                                       total += *j;
-                               }
-
-                               double const mean = double (total) / abs_diffs.size ();
-
-                               uint64_t total_squared_deviation = 0;
-                               for (vector<int>::iterator j = abs_diffs.begin(); j != abs_diffs.end(); ++j) {
-                                       total_squared_deviation += pow (*j - mean, 2);
-                               }
-
-                               double const std_dev = sqrt (double (total_squared_deviation) / abs_diffs.size());
-
-                               if (mean > opt.max_mean_pixel_error || std_dev > opt.max_std_dev_pixel_error) {
-                                       notes.push_back ("mean or standard deviation out of range for " + lexical_cast<string>(i));
-                               }
-
-                               if (opt.verbose) {
-                                       cout << "\tmax pixel error " << max_diff << ", mean pixel error " << mean << ", standard deviation " << std_dev << "\n";
-                               }
-
-                               opj_image_destroy (image_A);
-                               opj_image_destroy (image_B);
-                       }
-               }
-       }
 
-       return notes;
+       return true;
 }
 
-MonoPictureAsset::MonoPictureAsset (
-       sigc::slot<string, int> get_path,
-       string directory,
-       string mxf_name,
-       sigc::signal1<void, float>* progress,
-       int fps,
-       int length,
-       int width,
-       int height)
-       : PictureAsset (directory, mxf_name, progress, fps, 0, length)
-{
-       _width = width;
-       _height = height;
-       construct (get_path);
-}
 
-MonoPictureAsset::MonoPictureAsset (
-       vector<string> const & files,
-       string directory,
-       string mxf_name,
-       sigc::signal1<void, float>* progress,
-       int fps,
-       int length,
-       int width,
-       int height)
-       : PictureAsset (directory, mxf_name, progress, fps, 0, length)
+bool
+PictureAsset::frame_buffer_equals (
+       int frame, EqualityOptions opt, NoteHandler note,
+       uint8_t const * data_A, unsigned int size_A, uint8_t const * data_B, unsigned int size_B
+       ) const
 {
-       _width = width;
-       _height = height;
-       construct (sigc::bind (sigc::mem_fun (*this, &MonoPictureAsset::path_from_list), files));
-}
-
-MonoPictureAsset::MonoPictureAsset (string directory, string mxf_name, int fps, int entry_point, int length)
-       : PictureAsset (directory, mxf_name, 0, fps, entry_point, length)
-{
-       ASDCP::JP2K::MXFReader reader;
-       if (ASDCP_FAILURE (reader.OpenRead (path().string().c_str()))) {
-               throw MXFFileError ("could not open MXF file for reading", path().string());
-       }
-       
-       ASDCP::JP2K::PictureDescriptor desc;
-       if (ASDCP_FAILURE (reader.FillPictureDescriptor (desc))) {
-               throw DCPReadError ("could not read video MXF information");
+       if (size_A == size_B && memcmp (data_A, data_B, size_A) == 0) {
+               note (NoteType::NOTE, "J2K identical");
+               /* Easy result; the J2K data is identical */
+               return true;
        }
 
-       _width = desc.StoredWidth;
-       _height = desc.StoredHeight;
-}
+       /* Decompress the images to bitmaps */
+       auto image_A = decompress_j2k (const_cast<uint8_t*>(data_A), size_A, 0);
+       auto image_B = decompress_j2k (const_cast<uint8_t*>(data_B), size_B, 0);
 
-void
-MonoPictureAsset::construct (sigc::slot<string, int> get_path)
-{
-       ASDCP::JP2K::CodestreamParser j2k_parser;
-       ASDCP::JP2K::FrameBuffer frame_buffer (4 * Kumu::Megabyte);
-       if (ASDCP_FAILURE (j2k_parser.OpenReadFrame (get_path(0).c_str(), frame_buffer))) {
-               throw FileError ("could not open JPEG2000 file for reading", get_path (0));
-       }
-       
-       ASDCP::JP2K::PictureDescriptor picture_desc;
-       j2k_parser.FillPictureDescriptor (picture_desc);
-       picture_desc.EditRate = ASDCP::Rational (_fps, 1);
-       
-       ASDCP::WriterInfo writer_info;
-       fill_writer_info (&writer_info);
-       
-       ASDCP::JP2K::MXFWriter mxf_writer;
-       if (ASDCP_FAILURE (mxf_writer.OpenWrite (path().string().c_str(), writer_info, picture_desc))) {
-               throw MXFFileError ("could not open MXF file for writing", path().string());
-       }
+       /* Compare them */
 
-       for (int i = 0; i < _length; ++i) {
+       vector<int> abs_diffs (image_A->size().width * image_A->size().height * 3);
+       int d = 0;
+       int max_diff = 0;
 
-               string const path = get_path (i);
+       for (int c = 0; c < 3; ++c) {
 
-               if (ASDCP_FAILURE (j2k_parser.OpenReadFrame (path.c_str(), frame_buffer))) {
-                       throw FileError ("could not open JPEG2000 file for reading", path);
+               if (image_A->size() != image_B->size()) {
+                       note (NoteType::ERROR, String::compose ("image sizes for frame %1 differ", frame));
+                       return false;
                }
 
-               /* XXX: passing 0 to WriteFrame ok? */
-               if (ASDCP_FAILURE (mxf_writer.WriteFrame (frame_buffer, 0, 0))) {
-                       throw MiscError ("error in writing video MXF");
+               int const pixels = image_A->size().width * image_A->size().height;
+               for (int j = 0; j < pixels; ++j) {
+                       int const t = abs (image_A->data(c)[j] - image_B->data(c)[j]);
+                       abs_diffs[d++] = t;
+                       max_diff = max (max_diff, t);
                }
+       }
 
-               if (_progress) {
-                       (*_progress) (0.5 * float (i) / _length);
-               }
+       uint64_t total = 0;
+       for (vector<int>::iterator j = abs_diffs.begin(); j != abs_diffs.end(); ++j) {
+               total += *j;
        }
-       
-       if (ASDCP_FAILURE (mxf_writer.Finalize())) {
-               throw MiscError ("error in finalising video MXF");
+
+       double const mean = double (total) / abs_diffs.size ();
+
+       uint64_t total_squared_deviation = 0;
+       for (auto j: abs_diffs) {
+               total_squared_deviation += pow (j - mean, 2);
        }
-}
 
-string
-MonoPictureAsset::path_from_list (int f, vector<string> const & files) const
-{
-       return files[f];
-}
+       auto const std_dev = sqrt (double (total_squared_deviation) / abs_diffs.size());
 
-shared_ptr<const MonoPictureFrame>
-MonoPictureAsset::get_frame (int n) const
-{
-       return shared_ptr<const MonoPictureFrame> (new MonoPictureFrame (path().string(), n + _entry_point));
-}
+       note (NoteType::NOTE, String::compose("mean difference %1 deviation %2", mean, std_dev));
 
-StereoPictureAsset::StereoPictureAsset (string directory, string mxf_name, int fps, int entry_point, int length)
-       : PictureAsset (directory, mxf_name, 0, fps, entry_point, length)
-{
-       ASDCP::JP2K::MXFSReader reader;
-       if (ASDCP_FAILURE (reader.OpenRead (path().string().c_str()))) {
-               throw MXFFileError ("could not open MXF file for reading", path().string());
+       if (mean > opt.max_mean_pixel_error) {
+               note (
+                       NoteType::ERROR,
+                       String::compose ("mean %1 out of range %2 in frame %3", mean, opt.max_mean_pixel_error, frame)
+                       );
+
+               return false;
        }
-       
-       ASDCP::JP2K::PictureDescriptor desc;
-       if (ASDCP_FAILURE (reader.FillPictureDescriptor (desc))) {
-               throw DCPReadError ("could not read video MXF information");
+
+       if (std_dev > opt.max_std_dev_pixel_error) {
+               note (
+                       NoteType::ERROR,
+                       String::compose ("standard deviation %1 out of range %2 in frame %3", std_dev, opt.max_std_dev_pixel_error, frame)
+                       );
+
+               return false;
        }
 
-       _width = desc.StoredWidth;
-       _height = desc.StoredHeight;
+       return true;
 }
 
-shared_ptr<const StereoPictureFrame>
-StereoPictureAsset::get_frame (int n) const
+
+string
+PictureAsset::static_pkl_type (Standard standard)
+{
+       switch (standard) {
+       case Standard::INTEROP:
+               return "application/x-smpte-mxf;asdcpKind=Picture";
+       case Standard::SMPTE:
+               return "application/mxf";
+       default:
+               DCP_ASSERT (false);
+       }
+}
+
+
+string
+PictureAsset::pkl_type (Standard standard) const
 {
-       return shared_ptr<const StereoPictureFrame> (new StereoPictureFrame (path().string(), n + _entry_point));
+       return static_pkl_type (standard);
 }