Allow incremental writing of picture MXFs.
[libdcp.git] / src / picture_asset.cc
index 4c66bd021f89d38106971c5df2b0ed5efbc3335c..f3d523963abec33620447b14e51aa1b5b93dcae3 100644 (file)
 #include "exceptions.h"
 #include "picture_frame.h"
 
-using namespace std;
-using namespace boost;
+using std::string;
+using std::ostream;
+using std::list;
+using std::vector;
+using std::max;
+using boost::shared_ptr;
+using boost::dynamic_pointer_cast;
+using boost::lexical_cast;
 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 (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)
 {
 
 }
@@ -55,171 +60,85 @@ PictureAsset::write_to_cpl (ostream& s) const
          << "          <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"
+         << "          <IntrinsicDuration>" << _intrinsic_duration << "</IntrinsicDuration>\n"
+         << "          <EntryPoint>" << _entry_point << "</EntryPoint>\n"
+         << "          <Duration>" << _duration << "</Duration>\n"
          << "          <FrameRate>" << _fps << " 1</FrameRate>\n"
-         << "          <ScreenAspectRatio>" << _width << " " << _height << "</ScreenAspectRatio>\n"
+         << "          <ScreenAspectRatio>" << _size.width << " " << _size.height << "</ScreenAspectRatio>\n"
          << "        </MainPicture>\n";
 }
 
-/* XXX: could use get_frame()? */
-list<string>
-PictureAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt) const
+bool
+PictureAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, list<string>& notes) const
 {
-       list<string> notes = MXFAsset::equals (other, opt);
+       if (!MXFAsset::equals (other, opt, notes)) {
+               return false;
+       }
                     
-       if (opt.flags & MXF_INSPECT) {
-               ASDCP::JP2K::MXFReader reader_A;
-               if (ASDCP_FAILURE (reader_A.OpenRead (path().string().c_str()))) {
-                       throw FileError ("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 FileError ("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
-                       ) {
+       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");
-               }
+               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");
 //                     }
 //             }
-                               
-
-               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,
+       boost::function<string (int)> get_path,
        string directory,
        string mxf_name,
-       sigc::signal1<void, float>* progress,
+       boost::signals2::signal<void (float)>* progress,
        int fps,
-       int length,
-       int width,
-       int height)
-       : PictureAsset (directory, mxf_name, progress, fps, 0, length)
+       int intrinsic_duration,
+       Size size)
+       : PictureAsset (directory, mxf_name, progress, fps, intrinsic_duration, size)
 {
-       _width = width;
-       _height = height;
        construct (get_path);
 }
 
@@ -227,24 +146,27 @@ MonoPictureAsset::MonoPictureAsset (
        vector<string> const & files,
        string directory,
        string mxf_name,
-       sigc::signal1<void, float>* progress,
+       boost::signals2::signal<void (float)>* progress,
        int fps,
-       int length,
-       int width,
-       int height)
-       : PictureAsset (directory, mxf_name, progress, fps, 0, length)
+       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)
 {
-       _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)
+MonoPictureAsset::MonoPictureAsset (string directory, string mxf_name, int fps, int intrinsic_duration)
+       : PictureAsset (directory, mxf_name, 0, fps, intrinsic_duration, Size (0, 0))
 {
        ASDCP::JP2K::MXFReader reader;
        if (ASDCP_FAILURE (reader.OpenRead (path().string().c_str()))) {
-               throw FileError ("could not open MXF file for reading", path().string());
+               throw MXFFileError ("could not open MXF file for reading", path().string());
        }
        
        ASDCP::JP2K::PictureDescriptor desc;
@@ -252,12 +174,12 @@ MonoPictureAsset::MonoPictureAsset (string directory, string mxf_name, int fps,
                throw DCPReadError ("could not read video MXF information");
        }
 
-       _width = desc.StoredWidth;
-       _height = desc.StoredHeight;
+       _size.width = desc.StoredWidth;
+       _size.height = desc.StoredHeight;
 }
 
 void
-MonoPictureAsset::construct (sigc::slot<string, int> get_path)
+MonoPictureAsset::construct (boost::function<string (int)> get_path)
 {
        ASDCP::JP2K::CodestreamParser j2k_parser;
        ASDCP::JP2K::FrameBuffer frame_buffer (4 * Kumu::Megabyte);
@@ -270,14 +192,14 @@ MonoPictureAsset::construct (sigc::slot<string, int> get_path)
        picture_desc.EditRate = ASDCP::Rational (_fps, 1);
        
        ASDCP::WriterInfo writer_info;
-       fill_writer_info (&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 FileError ("could not open MXF file for writing", path().string());
+               throw MXFFileError ("could not open MXF file for writing", path().string());
        }
 
-       for (int i = 0; i < _length; ++i) {
+       for (int i = 0; i < _intrinsic_duration; ++i) {
 
                string const path = get_path (i);
 
@@ -291,7 +213,7 @@ MonoPictureAsset::construct (sigc::slot<string, int> get_path)
                }
 
                if (_progress) {
-                       (*_progress) (0.5 * float (i) / _length);
+                       (*_progress) (0.5 * float (i) / _intrinsic_duration);
                }
        }
        
@@ -312,12 +234,139 @@ MonoPictureAsset::get_frame (int n) const
        return shared_ptr<const MonoPictureFrame> (new MonoPictureFrame (path().string(), n + _entry_point));
 }
 
-StereoPictureAsset::StereoPictureAsset (string directory, string mxf_name, int fps, int entry_point, int length)
-       : PictureAsset (directory, mxf_name, 0, fps, entry_point, length)
+
+bool
+MonoPictureAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, list<string>& notes) 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 (!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)) {
+               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;
+               }
+       }
+
+       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
+       ) const
+{
+       if (size_A == size_B && memcmp (data_A, data_B, size_A) == 0) {
+               /* 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);
+       
+       /* 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);
+       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>(frame) + " differ");
+                       return false;
+               }
+               
+               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>(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 FileError ("could not open MXF file for reading", path().string());
+               throw MXFFileError ("could not open MXF file for reading", path().string());
        }
        
        ASDCP::JP2K::PictureDescriptor desc;
@@ -325,8 +374,8 @@ StereoPictureAsset::StereoPictureAsset (string directory, string mxf_name, int f
                throw DCPReadError ("could not read video MXF information");
        }
 
-       _width = desc.StoredWidth;
-       _height = desc.StoredHeight;
+       _size.width = desc.StoredWidth;
+       _size.height = desc.StoredHeight;
 }
 
 shared_ptr<const StereoPictureFrame>
@@ -334,3 +383,60 @@ 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));
+}
+
+MonoPictureAssetWriter::MonoPictureAssetWriter (MonoPictureAsset* a)
+       : _frame_buffer (4 * Kumu::Megabyte)
+       , _asset (a)
+       , _frames_written (0)
+       , _finalized (false)
+{
+
+}
+
+void
+MonoPictureAssetWriter::write (uint8_t* data, int size)
+{
+       if (ASDCP_FAILURE (_j2k_parser.OpenReadFrame (data, size, _frame_buffer))) {
+               throw MiscError ("could not parse J2K frame");
+       }
+
+       if (_frames_written == 0) {
+               _j2k_parser.FillPictureDescriptor (_picture_descriptor);
+               _picture_descriptor.EditRate = ASDCP::Rational (_asset->frames_per_second(), 1);
+       
+               MXFAsset::fill_writer_info (&_writer_info, _asset->uuid());
+               
+               if (ASDCP_FAILURE (_mxf_writer.OpenWrite (_asset->path().c_str(), _writer_info, _picture_descriptor))) {
+                       throw MXFFileError ("could not open MXF file for writing", _asset->path().string());
+               }
+       }
+
+       if (ASDCP_FAILURE (_mxf_writer.WriteFrame (_frame_buffer, 0, 0))) {
+               throw MiscError ("error in writing video MXF");
+       }
+
+       _frames_written++;
+}
+
+void
+MonoPictureAssetWriter::finalize ()
+{
+       if (ASDCP_FAILURE (_mxf_writer.Finalize())) {
+               throw MiscError ("error in finalizing video MXF");
+       }
+
+       _finalized = true;
+       _asset->set_intrinsic_duration (_frames_written);
+}
+
+MonoPictureAssetWriter::~MonoPictureAssetWriter ()
+{
+       assert (_finalized);
+}