Add OpenSSL licence exception.
[libdcp.git] / src / picture_asset.cc
index 848a2c270c0ed149643e1e30a4119710d2f40073..338be329b429a5c65400396bccd0523affb45dad 100644 (file)
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2015 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.
 */
 
+#include "picture_asset.h"
+#include "util.h"
+#include "exceptions.h"
+#include "openjpeg_image.h"
+#include "picture_asset_writer.h"
+#include "dcp_assert.h"
+#include "compose.hpp"
+#include "AS_DCP.h"
+#include "KM_fileio.h"
+#include "j2k.h"
+#include <libxml++/nodes/element.h>
+#include <boost/filesystem.hpp>
 #include <list>
 #include <stdexcept>
 #include <iostream>
-#include <boost/filesystem.hpp>
-#include "AS_DCP.h"
-#include "KM_fileio.h"
-#include "picture_asset.h"
-#include "util.h"
+#include <sstream>
 
-using namespace std;
-using namespace boost;
-using namespace libdcp;
+using std::string;
+using std::ostream;
+using std::list;
+using std::vector;
+using std::max;
+using std::stringstream;
+using std::pair;
+using std::make_pair;
+using std::istream;
+using std::cout;
+using boost::shared_ptr;
+using namespace dcp;
 
-PictureAsset::PictureAsset (list<string> const & files, string p, int fps, int len, int w, int h)
-       : Asset (p, fps, len)
-       , _width (w)
-       , _height (h)
+PictureAsset::PictureAsset (boost::filesystem::path file)
+       : Asset (file)
+       , _intrinsic_duration (0)
 {
-       ASDCP::JP2K::CodestreamParser j2k_parser;
-       ASDCP::JP2K::FrameBuffer frame_buffer (4 * Kumu::Megabyte);
-       if (ASDCP_FAILURE (j2k_parser.OpenReadFrame (files.front().c_str(), frame_buffer))) {
-               throw runtime_error ("could not open J2K file for reading");
+
+}
+
+PictureAsset::PictureAsset (Fraction edit_rate)
+       : _edit_rate (edit_rate)
+       , _intrinsic_duration (0)
+{
+
+}
+
+void
+PictureAsset::read_picture_descriptor (ASDCP::JP2K::PictureDescriptor const & desc)
+{
+       _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);
+}
+
+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 (DCP_ERROR, "video MXF picture descriptors differ");
+               return false;
        }
-       
-       ASDCP::JP2K::PictureDescriptor picture_desc;
-       j2k_parser.FillPictureDescriptor (picture_desc);
-       /* XXX: we round for DCP: not sure if this is right */
-       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 (_mxf_path.c_str(), writer_info, picture_desc))) {
-               throw runtime_error ("could not open MXF for writing");
+
+       if (a.ContainerDuration != b.ContainerDuration) {
+               note (DCP_ERROR, "video container durations differ");
+       }
+
+//             for (unsigned int j = 0; j < ASDCP::JP2K::MaxComponents; ++j) {
+//                     if (a.ImageComponents[j] != b.ImageComponents[j]) {
+//                             notes.pack_start ("video MXF picture descriptors differ");
+//                     }
+//             }
+
+       return true;
+}
+
+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
+{
+       if (size_A == size_B && memcmp (data_A, data_B, size_A) == 0) {
+               note (DCP_NOTE, "J2K identical");
+               /* Easy result; the J2K data is identical */
+               return true;
        }
 
-       int j = 0;
-       for (list<string>::const_iterator i = files.begin(); i != files.end(); ++i) {
-               if (ASDCP_FAILURE (j2k_parser.OpenReadFrame (i->c_str(), frame_buffer))) {
-                       throw runtime_error ("could not open J2K file for reading");
+       /* Decompress the images to bitmaps */
+       shared_ptr<OpenJPEGImage> image_A = decompress_j2k (const_cast<uint8_t*> (data_A), size_A, 0);
+       shared_ptr<OpenJPEGImage> image_B = decompress_j2k (const_cast<uint8_t*> (data_B), size_B, 0);
+
+       /* Compare them */
+
+       vector<int> abs_diffs (image_A->size().width * image_A->size().height * 3);
+       int d = 0;
+       int max_diff = 0;
+
+       for (int c = 0; c < 3; ++c) {
+
+               if (image_A->size() != image_B->size()) {
+                       note (DCP_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 runtime_error ("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);
                }
-               
-               ++j;
-               Progress (float (j) / files.size ());
        }
-       
-       if (ASDCP_FAILURE (mxf_writer.Finalize())) {
-               throw runtime_error ("error in finalising video MXF");
+
+       uint64_t total = 0;
+       for (vector<int>::iterator j = abs_diffs.begin(); j != abs_diffs.end(); ++j) {
+               total += *j;
        }
 
-       _digest = make_digest (_mxf_path);
+       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());
+
+       note (DCP_NOTE, String::compose ("mean difference %1 deviation %2", mean, std_dev));
+
+       if (mean > opt.max_mean_pixel_error) {
+               note (
+                       DCP_ERROR,
+                       String::compose ("mean %1 out of range %2 in frame %3", mean, opt.max_mean_pixel_error, frame)
+                       );
+
+               return false;
+       }
+
+       if (std_dev > opt.max_std_dev_pixel_error) {
+               note (
+                       DCP_ERROR,
+                       String::compose ("standard deviation %1 out of range %2 in frame %3", std_dev, opt.max_std_dev_pixel_error, frame)
+                       );
+
+               return false;
+       }
+
+       return true;
 }
 
-void
-PictureAsset::write_to_cpl (ostream& s) const
+string
+PictureAsset::pkl_type (Standard standard) const
 {
-       s << "        <MainPicture>\n"
-         << "          <Id>" << _uuid << "</Id>\n"
-         << "          <AnnotationText>" << filesystem::path(_mxf_path).filename() << "</AnnotationText>\n"
-         << "          <EditRate>" << _fps << "</EditRate>\n"
-         << "          <IntrinsicDuration>" << _length << "</IntrinsicDuration>\n"
-         << "          <EntryPoint>0</EntryPoint>\n"
-         << "          <Duration>" << _length << "</Duration>\n"
-         << "          <FrameRate>" << _fps << "</FrameRate>\n"
-         << "          <ScreenAspectRatio>" << _width << " " << _height << "</ScreenAspectRatio>\n"
-         << "        </MainPicture>\n";
+       switch (standard) {
+       case INTEROP:
+               return "application/x-smpte-mxf;asdcpKind=Picture";
+       case SMPTE:
+               return "application/mxf";
+       default:
+               DCP_ASSERT (false);
+       }
 }