Fix tm_to_string to use local timezone on all platforms. Some comments.
[libdcp.git] / src / picture_asset.cc
index 564ada796ee927ea2f7bafa277f78d8799c3db35..8d3b0347fe144a9ef8c3f8acd4cfaa6f4800f631 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 #include <stdexcept>
 #include <iostream>
 #include <sstream>
-#include <fstream>
 #include <boost/filesystem.hpp>
 #include <boost/lexical_cast.hpp>
 #include <openjpeg.h>
+#include <libxml++/nodes/element.h>
 #include "AS_DCP.h"
 #include "KM_fileio.h"
 #include "picture_asset.h"
 #include "util.h"
 #include "exceptions.h"
-#include "picture_frame.h"
+#include "xyz_frame.h"
+#include "picture_asset_writer.h"
+#include "raw_convert.h"
 
 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 boost::dynamic_pointer_cast;
 using boost::lexical_cast;
 using namespace libdcp;
 
-PictureAsset::PictureAsset (string directory, string mxf_name, boost::signals2::signal<void (float)>* progress, int fps, int intrinsic_duration, Size size)
-       : MXFAsset (directory, mxf_name, progress, fps, intrinsic_duration)
-       , _size (size)
-{
-
-}
-
-PictureAsset::PictureAsset (string directory, string mxf_name)
+PictureAsset::PictureAsset (boost::filesystem::path directory, boost::filesystem::path mxf_name)
        : MXFAsset (directory, mxf_name)
 {
 
 }
 
 void
-PictureAsset::write_to_cpl (ostream& s) const
-{
-       s << "        <MainPicture>\n"
-         << "          <Id>urn:uuid:" << _uuid << "</Id>\n"
-         << "          <AnnotationText>" << _file_name << "</AnnotationText>\n"
-         << "          <EditRate>" << _edit_rate << " 1</EditRate>\n"
-         << "          <IntrinsicDuration>" << _intrinsic_duration << "</IntrinsicDuration>\n"
-         << "          <EntryPoint>" << _entry_point << "</EntryPoint>\n"
-         << "          <Duration>" << _duration << "</Duration>\n"
-         << "          <FrameRate>" << _edit_rate << " 1</FrameRate>\n"
-         << "          <ScreenAspectRatio>" << _size.width << " " << _size.height << "</ScreenAspectRatio>\n"
-         << "        </MainPicture>\n";
-}
-
-bool
-PictureAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, list<string>& notes) const
-{
-       if (!MXFAsset::equals (other, opt, notes)) {
-               return false;
-       }
-                    
-       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());
-       }
-       
-       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");
-       }
-       
-       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");
-               return false;
-       }
-
-//             for (unsigned int j = 0; j < ASDCP::JP2K::MaxComponents; ++j) {
-//                     if (desc_A.ImageComponents[j] != desc_B.ImageComponents[j]) {
-//                             notes.pack_start ("video MXF picture descriptors differ");
-//                     }
-//             }
-
-       return true;
-}
-
-
-MonoPictureAsset::MonoPictureAsset (
-       boost::function<string (int)> get_path,
-       string directory,
-       string mxf_name,
-       boost::signals2::signal<void (float)>* progress,
-       int fps,
-       int intrinsic_duration,
-       Size size)
-       : PictureAsset (directory, mxf_name, progress, fps, intrinsic_duration, size)
-{
-       construct (get_path);
-}
-
-MonoPictureAsset::MonoPictureAsset (
-       vector<string> const & files,
-       string directory,
-       string mxf_name,
-       boost::signals2::signal<void (float)>* progress,
-       int fps,
-       int intrinsic_duration,
-       Size size)
-       : PictureAsset (directory, mxf_name, progress, fps, intrinsic_duration, size)
-{
-       construct (boost::bind (&MonoPictureAsset::path_from_list, this, _1, files));
-}
-
-MonoPictureAsset::MonoPictureAsset (string directory, string mxf_name, int fps, Size size)
-       : PictureAsset (directory, mxf_name, 0, fps, 0, size)
-{
-
-}
-
-MonoPictureAsset::MonoPictureAsset (string directory, string mxf_name)
-       : PictureAsset (directory, mxf_name)
-{
-       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");
-       }
-
-       _size.width = desc.StoredWidth;
-       _size.height = desc.StoredHeight;
-       _edit_rate = desc.EditRate.Numerator;
-       assert (desc.EditRate.Denominator == 1);
-       _intrinsic_duration = desc.ContainerDuration;
-}
-
-void
-MonoPictureAsset::construct (boost::function<string (int)> get_path)
+PictureAsset::write_to_cpl (xmlpp::Element* node) const
 {
-       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));
-       }
+       MXFAsset::write_to_cpl (node);
        
-       ASDCP::JP2K::PictureDescriptor picture_desc;
-       j2k_parser.FillPictureDescriptor (picture_desc);
-       picture_desc.EditRate = ASDCP::Rational (_edit_rate, 1);
-       
-       ASDCP::WriterInfo writer_info;
-       fill_writer_info (&writer_info, _uuid);
-       
-       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());
+       xmlpp::Node::NodeList c = node->get_children ();
+       xmlpp::Node::NodeList::iterator i = c.begin();
+       while (i != c.end() && (*i)->get_name() != cpl_node_name ()) {
+               ++i;
        }
 
-       for (int i = 0; i < _intrinsic_duration; ++i) {
+       assert (i != c.end ());
 
-               string const path = get_path (i);
-
-               if (ASDCP_FAILURE (j2k_parser.OpenReadFrame (path.c_str(), frame_buffer))) {
-                       throw FileError ("could not open JPEG2000 file for reading", path);
-               }
-
-               /* XXX: passing 0 to WriteFrame ok? */
-               if (ASDCP_FAILURE (mxf_writer.WriteFrame (frame_buffer, 0, 0))) {
-                       throw MiscError ("error in writing video MXF");
-               }
-
-               if (_progress) {
-                       (*_progress) (0.5 * float (i) / _intrinsic_duration);
-               }
+       (*i)->add_child ("FrameRate")->add_child_text (raw_convert<string> (_edit_rate * edit_rate_factor ()) + " 1");
+       if (_interop) {
+               stringstream s;
+               s << std::fixed << std::setprecision (2) << (float (_size.width) / _size.height);
+               (*i)->add_child ("ScreenAspectRatio")->add_child_text (s.str ());
+       } else {
+               (*i)->add_child ("ScreenAspectRatio")->add_child_text (raw_convert<string> (_size.width) + " " + raw_convert<string> (_size.height));
        }
-       
-       if (ASDCP_FAILURE (mxf_writer.Finalize())) {
-               throw MiscError ("error in finalising video MXF");
-       }
-}
-
-string
-MonoPictureAsset::path_from_list (int f, vector<string> const & files) const
-{
-       return files[f];
 }
 
-shared_ptr<const MonoPictureFrame>
-MonoPictureAsset::get_frame (int n) const
-{
-       return shared_ptr<const MonoPictureFrame> (new MonoPictureFrame (path().string(), n + _entry_point));
-}
-
-
 bool
-MonoPictureAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, list<string>& notes) const
+PictureAsset::descriptor_equals (
+       ASDCP::JP2K::PictureDescriptor const & a, ASDCP::JP2K::PictureDescriptor const & b, boost::function<void (NoteType, string)> note
+       ) const
 {
-       if (!PictureAsset::equals (other, opt, notes)) {
-               return false;
-       }
-
-       shared_ptr<const MonoPictureAsset> other_picture = dynamic_pointer_cast<const MonoPictureAsset> (other);
-       assert (other_picture);
-
-       for (int i = 0; i < _intrinsic_duration; ++i) {
-               shared_ptr<const MonoPictureFrame> frame_A = get_frame (i);
-               shared_ptr<const MonoPictureFrame> frame_B = other_picture->get_frame (i);
+       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
+               ) {
                
-               if (!frame_buffer_equals (
-                           i, opt, notes,
-                           frame_A->j2k_frame()->RoData(), frame_A->j2k_frame()->Size(),
-                           frame_B->j2k_frame()->RoData(), frame_B->j2k_frame()->Size()
-                           )) {
-                       return false;
-               }
-       }
-
-       return true;
-}
-
-bool
-StereoPictureAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, list<string>& notes) const
-{
-       if (!PictureAsset::equals (other, opt, notes)) {
+               note (ERROR, "video MXF picture descriptors differ");
                return false;
        }
-       
-       shared_ptr<const StereoPictureAsset> other_picture = dynamic_pointer_cast<const StereoPictureAsset> (other);
-       assert (other_picture);
 
-       for (int i = 0; i < _intrinsic_duration; ++i) {
-               shared_ptr<const StereoPictureFrame> frame_A = get_frame (i);
-               shared_ptr<const StereoPictureFrame> frame_B = other_picture->get_frame (i);
-               
-               if (!frame_buffer_equals (
-                           i, opt, notes,
-                           frame_A->j2k_frame()->Left.RoData(), frame_A->j2k_frame()->Left.Size(),
-                           frame_B->j2k_frame()->Left.RoData(), frame_B->j2k_frame()->Left.Size()
-                           )) {
-                       return false;
-               }
-               
-               if (!frame_buffer_equals (
-                           i, opt, notes,
-                           frame_A->j2k_frame()->Right.RoData(), frame_A->j2k_frame()->Right.Size(),
-                           frame_B->j2k_frame()->Right.RoData(), frame_B->j2k_frame()->Right.Size()
-                           )) {
-                       return false;
-               }
+       if (a.ContainerDuration != b.ContainerDuration) {
+               note (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, list<string>& notes, uint8_t const * data_A, unsigned int size_A, uint8_t const * data_B, unsigned int size_B
+       int frame, EqualityOptions opt, boost::function<void (NoteType, string)> 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 (NOTE, "J2K identical");
                /* Easy result; the J2K data is identical */
                return true;
        }
                
        /* Decompress the images to bitmaps */
-       opj_image_t* image_A = decompress_j2k (const_cast<uint8_t*> (data_A), size_A, 0);
-       opj_image_t* image_B = decompress_j2k (const_cast<uint8_t*> (data_B), size_B, 0);
+       shared_ptr<XYZFrame> image_A = decompress_j2k (const_cast<uint8_t*> (data_A), size_A, 0);
+       shared_ptr<XYZFrame> image_B = decompress_j2k (const_cast<uint8_t*> (data_B), size_B, 0);
        
        /* Compare them */
        
-       if (image_A->numcomps != image_B->numcomps) {
-               notes.push_back ("image component counts for frame " + lexical_cast<string>(frame) + " differ");
-               return false;
-       }
-       
-       vector<int> abs_diffs (image_A->comps[0].w * image_A->comps[0].h * image_A->numcomps);
+       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 < image_A->numcomps; ++c) {
+       for (int c = 0; c < 3; ++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>(frame) + " differ");
+               if (image_A->size() != image_B->size()) {
+                       note (ERROR, "image sizes for frame " + lexical_cast<string>(frame) + " differ");
                        return false;
                }
                
-               int const pixels = image_A->comps[c].w * image_A->comps[c].h;
+               int const pixels = image_A->size().width * image_A->size().height;
                for (int j = 0; j < pixels; ++j) {
-                       int const t = abs (image_A->comps[c].data[j] - image_B->comps[c].data[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);
                }
@@ -358,116 +175,38 @@ PictureAsset::frame_buffer_equals (
        
        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>(frame));
+       note (NOTE, "mean difference " + lexical_cast<string> (mean) + ", deviation " + lexical_cast<string> (std_dev));
+       
+       if (mean > opt.max_mean_pixel_error) {
+               note (
+                       ERROR,
+                       "mean " + lexical_cast<string>(mean) +
+                       " out of range " + lexical_cast<string>(opt.max_mean_pixel_error) +
+                       " in frame " + lexical_cast<string>(frame)
+                       );
+               
                return false;
        }
-       
-       opj_image_destroy (image_A);
-       opj_image_destroy (image_B);
-
-       return true;
-}
 
-
-StereoPictureAsset::StereoPictureAsset (string directory, string mxf_name, int fps, int intrinsic_duration)
-       : PictureAsset (directory, mxf_name, 0, fps, intrinsic_duration, Size (0, 0))
-{
-       ASDCP::JP2K::MXFSReader 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 (std_dev > opt.max_std_dev_pixel_error) {
+               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)
+                       );
+               
+               return false;
        }
 
-       _size.width = desc.StoredWidth;
-       _size.height = desc.StoredHeight;
-}
-
-shared_ptr<const StereoPictureFrame>
-StereoPictureAsset::get_frame (int n) const
-{
-       return shared_ptr<const StereoPictureFrame> (new StereoPictureFrame (path().string(), n + _entry_point));
-}
-
-shared_ptr<MonoPictureAssetWriter>
-MonoPictureAsset::start_write ()
-{
-       /* XXX: can't we use a shared_ptr here? */
-       return shared_ptr<MonoPictureAssetWriter> (new MonoPictureAssetWriter (this));
-}
-
-struct MonoPictureAssetWriter::ASDCPState
-{
-       ASDCPState()
-               : frame_buffer (4 * Kumu::Megabyte)
-       {}
-       
-       ASDCP::JP2K::CodestreamParser j2k_parser;
-       ASDCP::JP2K::FrameBuffer frame_buffer;
-       ASDCP::JP2K::MXFWriter mxf_writer;
-       ASDCP::WriterInfo writer_info;
-       ASDCP::JP2K::PictureDescriptor picture_descriptor;
-};
-
-
-/** @param a Asset to write to.  `a' must not be deleted while
- *  this writer class still exists, or bad things will happen.
- */
-MonoPictureAssetWriter::MonoPictureAssetWriter (MonoPictureAsset* a)
-       : _state (new MonoPictureAssetWriter::ASDCPState)
-       , _asset (a)
-       , _frames_written (0)
-       , _finalized (false)
-{
-
+       return true;
 }
 
-void
-MonoPictureAssetWriter::write (uint8_t* data, int size)
+string
+PictureAsset::key_type () const
 {
-       assert (!_finalized);
-       
-       if (ASDCP_FAILURE (_state->j2k_parser.OpenReadFrame (data, size, _state->frame_buffer))) {
-               throw MiscError ("could not parse J2K frame");
-       }
-
-       if (_frames_written == 0) {
-               /* This is our first frame; set up the writer */
-               
-               _state->j2k_parser.FillPictureDescriptor (_state->picture_descriptor);
-               _state->picture_descriptor.EditRate = ASDCP::Rational (_asset->edit_rate(), 1);
-       
-               MXFAsset::fill_writer_info (&_state->writer_info, _asset->uuid());
-               
-               if (ASDCP_FAILURE (_state->mxf_writer.OpenWrite (_asset->path().c_str(), _state->writer_info, _state->picture_descriptor))) {
-                       throw MXFFileError ("could not open MXF file for writing", _asset->path().string());
-               }
-       }
-
-       if (ASDCP_FAILURE (_state->mxf_writer.WriteFrame (_state->frame_buffer, 0, 0))) {
-               throw MiscError ("error in writing video MXF");
-       }
-
-       _frames_written++;
+       return "MDIK";
 }
 
-void
-MonoPictureAssetWriter::finalize ()
-{
-       if (ASDCP_FAILURE (_state->mxf_writer.Finalize())) {
-               throw MiscError ("error in finalizing video MXF");
-       }
 
-       _finalized = true;
-       _asset->set_intrinsic_duration (_frames_written);
-       _asset->set_duration (_frames_written);
-}
 
-MonoPictureAssetWriter::~MonoPictureAssetWriter ()
-{
-       assert (_finalized);
-}