Missing install file.
[libdcp.git] / src / picture_asset.cc
index 118157619074846bf26033e4db2545ea2c76acac..b5f59f3be0ce04aa3dd19b757c92e62c9657cccc 100644 (file)
@@ -44,6 +44,7 @@ using std::max;
 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;
@@ -63,44 +64,43 @@ PictureAsset::PictureAsset (string directory, string mxf_name)
 }
 
 void
-PictureAsset::write_to_cpl (ostream& s) const
+PictureAsset::write_to_cpl (xmlpp::Node* node) 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";
+       xmlpp::Node* mp = node->add_child ("MainPicture");
+       mp->add_child ("Id")->add_child_text ("urn:uuid:" + _uuid);
+       mp->add_child ("AnnotationText")->add_child_text (_file_name);
+       mp->add_child ("EditRate")->add_child_text (lexical_cast<string> (_edit_rate) + " 1");
+       mp->add_child ("IntrinsicDuration")->add_child_text (lexical_cast<string> (_intrinsic_duration));
+       mp->add_child ("EntryPoint")->add_child_text (lexical_cast<string> (_entry_point));
+       mp->add_child ("Duration")->add_child_text (lexical_cast<string> (_duration));
+       mp->add_child ("FrameRate")->add_child_text (lexical_cast<string> (_edit_rate) + " 1");
+       mp->add_child ("ScreenAspectRatio")->add_child_text (lexical_cast<string> (_size.width) + " " + lexical_cast<string> (_size.height));
 }
 
 bool
-PictureAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, list<string>& notes) const
+PictureAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, string)> note) const
 {
-       if (!MXFAsset::equals (other, opt, notes)) {
+       if (!MXFAsset::equals (other, opt, note)) {
                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());
+               boost::throw_exception (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());
+               boost::throw_exception (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");
+               boost::throw_exception (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");
+               boost::throw_exception (DCPReadError ("could not read video MXF information"));
        }
        
        if (
@@ -124,7 +124,7 @@ PictureAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, list<s
 //             desc_A.QuantizationDefault != desc_B.QuantizationDefault
                ) {
                
-               notes.push_back ("video MXF picture descriptors differ");
+               note (ERROR, "video MXF picture descriptors differ");
                return false;
        }
 
@@ -145,10 +145,12 @@ MonoPictureAsset::MonoPictureAsset (
        boost::signals2::signal<void (float)>* progress,
        int fps,
        int intrinsic_duration,
-       Size size)
+       Size size,
+       MXFMetadata const & metadata
+       )
        : PictureAsset (directory, mxf_name, progress, fps, intrinsic_duration, size)
 {
-       construct (get_path);
+       construct (get_path, metadata);
 }
 
 MonoPictureAsset::MonoPictureAsset (
@@ -158,10 +160,12 @@ MonoPictureAsset::MonoPictureAsset (
        boost::signals2::signal<void (float)>* progress,
        int fps,
        int intrinsic_duration,
-       Size size)
+       Size size,
+       MXFMetadata const & metadata
+       )
        : PictureAsset (directory, mxf_name, progress, fps, intrinsic_duration, size)
 {
-       construct (boost::bind (&MonoPictureAsset::path_from_list, this, _1, files));
+       construct (boost::bind (&MonoPictureAsset::path_from_list, this, _1, files), metadata);
 }
 
 MonoPictureAsset::MonoPictureAsset (string directory, string mxf_name, int fps, Size size)
@@ -175,12 +179,12 @@ MonoPictureAsset::MonoPictureAsset (string directory, string 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());
+               boost::throw_exception (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");
+               boost::throw_exception (DCPReadError ("could not read video MXF information"));
        }
 
        _size.width = desc.StoredWidth;
@@ -191,12 +195,12 @@ MonoPictureAsset::MonoPictureAsset (string directory, string mxf_name)
 }
 
 void
-MonoPictureAsset::construct (boost::function<string (int)> get_path)
+MonoPictureAsset::construct (boost::function<string (int)> get_path, MXFMetadata const & metadata)
 {
        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));
+               boost::throw_exception (FileError ("could not open JPEG2000 file for reading", get_path (0)));
        }
        
        ASDCP::JP2K::PictureDescriptor picture_desc;
@@ -204,11 +208,11 @@ MonoPictureAsset::construct (boost::function<string (int)> get_path)
        picture_desc.EditRate = ASDCP::Rational (_edit_rate, 1);
        
        ASDCP::WriterInfo writer_info;
-       fill_writer_info (&writer_info, _uuid);
+       fill_writer_info (&writer_info, _uuid, metadata);
        
        ASDCP::JP2K::MXFWriter mxf_writer;
        if (ASDCP_FAILURE (mxf_writer.OpenWrite (path().string().c_str(), writer_info, picture_desc, 16384, false))) {
-               throw MXFFileError ("could not open MXF file for writing", path().string());
+               boost::throw_exception (MXFFileError ("could not open MXF file for writing", path().string()));
        }
 
        for (int i = 0; i < _intrinsic_duration; ++i) {
@@ -216,11 +220,11 @@ MonoPictureAsset::construct (boost::function<string (int)> get_path)
                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);
+                       boost::throw_exception (FileError ("could not open JPEG2000 file for reading", path));
                }
 
                if (ASDCP_FAILURE (mxf_writer.WriteFrame (frame_buffer, 0, 0))) {
-                       throw MiscError ("error in writing video MXF");
+                       boost::throw_exception (MXFFileError ("error in writing video MXF", this->path().string()));
                }
 
                if (_progress) {
@@ -229,7 +233,7 @@ MonoPictureAsset::construct (boost::function<string (int)> get_path)
        }
        
        if (ASDCP_FAILURE (mxf_writer.Finalize())) {
-               throw MiscError ("error in finalising video MXF");
+               boost::throw_exception (MXFFileError ("error in finalising video MXF", path().string()));
        }
 }
 
@@ -247,9 +251,9 @@ MonoPictureAsset::get_frame (int n) const
 
 
 bool
-MonoPictureAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, list<string>& notes) const
+MonoPictureAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, string)> note) const
 {
-       if (!PictureAsset::equals (other, opt, notes)) {
+       if (!PictureAsset::equals (other, opt, note)) {
                return false;
        }
 
@@ -257,11 +261,12 @@ MonoPictureAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, li
        assert (other_picture);
 
        for (int i = 0; i < _intrinsic_duration; ++i) {
+               note (PROGRESS, "Comparing video frame " + lexical_cast<string> (i) + " of " + lexical_cast<string> (_intrinsic_duration));
                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,
+                           i, opt, note,
                            frame_A->j2k_data(), frame_A->j2k_size(),
                            frame_B->j2k_data(), frame_B->j2k_size()
                            )) {
@@ -273,9 +278,9 @@ MonoPictureAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, li
 }
 
 bool
-StereoPictureAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, list<string>& notes) const
+StereoPictureAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, string)> note) const
 {
-       if (!PictureAsset::equals (other, opt, notes)) {
+       if (!PictureAsset::equals (other, opt, note)) {
                return false;
        }
        
@@ -287,7 +292,7 @@ StereoPictureAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt,
                shared_ptr<const StereoPictureFrame> frame_B = other_picture->get_frame (i);
                
                if (!frame_buffer_equals (
-                           i, opt, notes,
+                           i, opt, note,
                            frame_A->left_j2k_data(), frame_A->left_j2k_size(),
                            frame_B->left_j2k_data(), frame_B->left_j2k_size()
                            )) {
@@ -295,7 +300,7 @@ StereoPictureAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt,
                }
                
                if (!frame_buffer_equals (
-                           i, opt, notes,
+                           i, opt, note,
                            frame_A->right_j2k_data(), frame_A->right_j2k_size(),
                            frame_B->right_j2k_data(), frame_B->right_j2k_size()
                            )) {
@@ -308,10 +313,12 @@ StereoPictureAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt,
 
 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;
        }
@@ -323,7 +330,7 @@ PictureAsset::frame_buffer_equals (
        /* Compare them */
        
        if (image_A->numcomps != image_B->numcomps) {
-               notes.push_back ("image component counts for frame " + lexical_cast<string>(frame) + " differ");
+               note (ERROR, "image component counts for frame " + lexical_cast<string>(frame) + " differ");
                return false;
        }
        
@@ -334,7 +341,7 @@ PictureAsset::frame_buffer_equals (
        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");
+                       note (ERROR, "image sizes for frame " + lexical_cast<string>(frame) + " differ");
                        return false;
                }
                
@@ -360,11 +367,18 @@ 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;
        }
-       
+
+       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;
+       }
+
        opj_image_destroy (image_A);
        opj_image_destroy (image_B);
 
@@ -377,12 +391,12 @@ StereoPictureAsset::StereoPictureAsset (string directory, string mxf_name, int f
 {
        ASDCP::JP2K::MXFSReader reader;
        if (ASDCP_FAILURE (reader.OpenRead (path().string().c_str()))) {
-               throw MXFFileError ("could not open MXF file for reading", path().string());
+               boost::throw_exception (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");
+               boost::throw_exception (DCPReadError ("could not read video MXF information"));
        }
 
        _size.width = desc.StoredWidth;
@@ -396,28 +410,21 @@ StereoPictureAsset::get_frame (int n) const
 }
 
 shared_ptr<MonoPictureAssetWriter>
-MonoPictureAsset::start_write ()
-{
-       /* XXX: can't we use a shared_ptr here? */
-       return shared_ptr<MonoPictureAssetWriter> (new MonoPictureAssetWriter (this, false));
-}
-
-shared_ptr<MonoPictureAssetWriter>
-MonoPictureAsset::start_overwrite ()
+MonoPictureAsset::start_write (bool overwrite, MXFMetadata const & metadata)
 {
-       /* XXX: can't we use shared_ptr here? */
-       return shared_ptr<MonoPictureAssetWriter> (new MonoPictureAssetWriter (this, true));
+       /* XXX: can't we use shared_ptr here? */
+       return shared_ptr<MonoPictureAssetWriter> (new MonoPictureAssetWriter (this, overwrite, metadata));
 }
 
 FrameInfo::FrameInfo (istream& s)
 {
-       s >> offset >> length >> hash;
+       s >> offset >> size >> hash;
 }
 
 void
 FrameInfo::write (ostream& s)
 {
-       s << offset << " " << length << " " << hash;
+       s << offset << " " << size << " " << hash;
 }
 
 struct MonoPictureAssetWriter::ASDCPState
@@ -437,42 +444,63 @@ struct MonoPictureAssetWriter::ASDCPState
 /** @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)
+MonoPictureAssetWriter::MonoPictureAssetWriter (MonoPictureAsset* a, bool overwrite, MXFMetadata const & m)
        : _state (new MonoPictureAssetWriter::ASDCPState)
        , _asset (a)
        , _frames_written (0)
+       , _started (false)
        , _finalized (false)
+       , _overwrite (overwrite)
+       , _metadata (m)
 {
 
 }
 
-FrameInfo
-MonoPictureAssetWriter::write (uint8_t* data, int size)
+
+void
+MonoPictureAssetWriter::start (uint8_t* data, int size)
 {
-       assert (!_finalized);
-       
        if (ASDCP_FAILURE (_state->j2k_parser.OpenReadFrame (data, size, _state->frame_buffer))) {
-               throw MiscError ("could not parse J2K frame");
+               boost::throw_exception (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);
+       _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(), _metadata);
        
-               MXFAsset::fill_writer_info (&_state->writer_info, _asset->uuid());
+       if (ASDCP_FAILURE (_state->mxf_writer.OpenWrite (
+                                  _asset->path().string().c_str(),
+                                  _state->writer_info,
+                                  _state->picture_descriptor,
+                                  16384,
+                                  _overwrite)
+                   )) {
+               
+               boost::throw_exception (MXFFileError ("could not open MXF file for writing", _asset->path().string()));
+       }
 
-               if (ASDCP_FAILURE (_state->mxf_writer.OpenWrite (_asset->path().string().c_str(), _state->writer_info, _state->picture_descriptor, 16384, false))) {
-                       throw MXFFileError ("could not open MXF file for writing", _asset->path().string());
-               }
+       _started = true;
+}
+
+FrameInfo
+MonoPictureAssetWriter::write (uint8_t* data, int size)
+{
+       assert (!_finalized);
+
+       if (!_started) {
+               start (data, size);
        }
 
+       if (ASDCP_FAILURE (_state->j2k_parser.OpenReadFrame (data, size, _state->frame_buffer))) {
+               boost::throw_exception (MiscError ("could not parse J2K frame"));
+       }
+
        uint64_t const before_offset = _state->mxf_writer.Tell ();
 
        string hash;
        if (ASDCP_FAILURE (_state->mxf_writer.WriteFrame (_state->frame_buffer, 0, 0, &hash))) {
-               throw MiscError ("error in writing video MXF");
+               boost::throw_exception (MXFFileError ("error in writing video MXF", _asset->path().string()));
        }
 
        ++_frames_written;
@@ -482,23 +510,11 @@ MonoPictureAssetWriter::write (uint8_t* data, int size)
 void
 MonoPictureAssetWriter::fake_write (int size)
 {
+       assert (_started);
        assert (!_finalized);
 
-       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().string().c_str(), _state->writer_info, _state->picture_descriptor, 16384, true))) {
-                       throw MXFFileError ("could not open MXF file for writing", _asset->path().string());
-               }
-       }
-
        if (ASDCP_FAILURE (_state->mxf_writer.FakeWriteFrame (size))) {
-               throw MiscError ("error in writing video MXF");
+               boost::throw_exception (MXFFileError ("error in writing video MXF", _asset->path().string()));
        }
 
        ++_frames_written;
@@ -507,16 +523,13 @@ MonoPictureAssetWriter::fake_write (int size)
 void
 MonoPictureAssetWriter::finalize ()
 {
+       assert (!_finalized);
+       
        if (ASDCP_FAILURE (_state->mxf_writer.Finalize())) {
-               throw MiscError ("error in finalizing video MXF");
+               boost::throw_exception (MXFFileError ("error in finalizing video MXF", _asset->path().string()));
        }
 
        _finalized = true;
        _asset->set_intrinsic_duration (_frames_written);
        _asset->set_duration (_frames_written);
 }
-
-MonoPictureAssetWriter::~MonoPictureAssetWriter ()
-{
-       assert (_finalized);
-}