2 Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 /** @file src/picture_asset.cc
21 * @brief An asset made up of JPEG2000 files
29 #include <boost/filesystem.hpp>
30 #include <boost/lexical_cast.hpp>
33 #include "KM_fileio.h"
34 #include "picture_asset.h"
36 #include "exceptions.h"
37 #include "picture_frame.h"
47 using boost::shared_ptr;
48 using boost::dynamic_pointer_cast;
49 using boost::lexical_cast;
50 using namespace libdcp;
52 PictureAsset::PictureAsset (string directory, string mxf_name, boost::signals2::signal<void (float)>* progress, int fps, int intrinsic_duration, Size size)
53 : MXFAsset (directory, mxf_name, progress, fps, intrinsic_duration)
59 PictureAsset::PictureAsset (string directory, string mxf_name)
60 : MXFAsset (directory, mxf_name)
66 PictureAsset::write_to_cpl (ostream& s) const
68 s << " <MainPicture>\n"
69 << " <Id>urn:uuid:" << _uuid << "</Id>\n"
70 << " <AnnotationText>" << _file_name << "</AnnotationText>\n"
71 << " <EditRate>" << _edit_rate << " 1</EditRate>\n"
72 << " <IntrinsicDuration>" << _intrinsic_duration << "</IntrinsicDuration>\n"
73 << " <EntryPoint>" << _entry_point << "</EntryPoint>\n"
74 << " <Duration>" << _duration << "</Duration>\n"
75 << " <FrameRate>" << _edit_rate << " 1</FrameRate>\n"
76 << " <ScreenAspectRatio>" << _size.width << " " << _size.height << "</ScreenAspectRatio>\n"
77 << " </MainPicture>\n";
81 PictureAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, list<string>& notes) const
83 if (!MXFAsset::equals (other, opt, notes)) {
87 ASDCP::JP2K::MXFReader reader_A;
88 if (ASDCP_FAILURE (reader_A.OpenRead (path().string().c_str()))) {
89 throw MXFFileError ("could not open MXF file for reading", path().string());
92 ASDCP::JP2K::MXFReader reader_B;
93 if (ASDCP_FAILURE (reader_B.OpenRead (other->path().string().c_str()))) {
94 throw MXFFileError ("could not open MXF file for reading", path().string());
97 ASDCP::JP2K::PictureDescriptor desc_A;
98 if (ASDCP_FAILURE (reader_A.FillPictureDescriptor (desc_A))) {
99 throw DCPReadError ("could not read video MXF information");
101 ASDCP::JP2K::PictureDescriptor desc_B;
102 if (ASDCP_FAILURE (reader_B.FillPictureDescriptor (desc_B))) {
103 throw DCPReadError ("could not read video MXF information");
107 desc_A.EditRate != desc_B.EditRate ||
108 desc_A.ContainerDuration != desc_B.ContainerDuration ||
109 desc_A.SampleRate != desc_B.SampleRate ||
110 desc_A.StoredWidth != desc_B.StoredWidth ||
111 desc_A.StoredHeight != desc_B.StoredHeight ||
112 desc_A.AspectRatio != desc_B.AspectRatio ||
113 desc_A.Rsize != desc_B.Rsize ||
114 desc_A.Xsize != desc_B.Xsize ||
115 desc_A.Ysize != desc_B.Ysize ||
116 desc_A.XOsize != desc_B.XOsize ||
117 desc_A.YOsize != desc_B.YOsize ||
118 desc_A.XTsize != desc_B.XTsize ||
119 desc_A.YTsize != desc_B.YTsize ||
120 desc_A.XTOsize != desc_B.XTOsize ||
121 desc_A.YTOsize != desc_B.YTOsize ||
122 desc_A.Csize != desc_B.Csize
123 // desc_A.CodingStyleDefault != desc_B.CodingStyleDefault ||
124 // desc_A.QuantizationDefault != desc_B.QuantizationDefault
127 notes.push_back ("video MXF picture descriptors differ");
131 // for (unsigned int j = 0; j < ASDCP::JP2K::MaxComponents; ++j) {
132 // if (desc_A.ImageComponents[j] != desc_B.ImageComponents[j]) {
133 // notes.pack_start ("video MXF picture descriptors differ");
141 MonoPictureAsset::MonoPictureAsset (
142 boost::function<string (int)> get_path,
145 boost::signals2::signal<void (float)>* progress,
147 int intrinsic_duration,
149 : PictureAsset (directory, mxf_name, progress, fps, intrinsic_duration, size)
151 construct (get_path);
154 MonoPictureAsset::MonoPictureAsset (
155 vector<string> const & files,
158 boost::signals2::signal<void (float)>* progress,
160 int intrinsic_duration,
162 : PictureAsset (directory, mxf_name, progress, fps, intrinsic_duration, size)
164 construct (boost::bind (&MonoPictureAsset::path_from_list, this, _1, files));
167 MonoPictureAsset::MonoPictureAsset (string directory, string mxf_name, int fps, Size size)
168 : PictureAsset (directory, mxf_name, 0, fps, 0, size)
173 MonoPictureAsset::MonoPictureAsset (string directory, string mxf_name)
174 : PictureAsset (directory, mxf_name)
176 ASDCP::JP2K::MXFReader reader;
177 if (ASDCP_FAILURE (reader.OpenRead (path().string().c_str()))) {
178 throw MXFFileError ("could not open MXF file for reading", path().string());
181 ASDCP::JP2K::PictureDescriptor desc;
182 if (ASDCP_FAILURE (reader.FillPictureDescriptor (desc))) {
183 throw DCPReadError ("could not read video MXF information");
186 _size.width = desc.StoredWidth;
187 _size.height = desc.StoredHeight;
188 _edit_rate = desc.EditRate.Numerator;
189 assert (desc.EditRate.Denominator == 1);
190 _intrinsic_duration = desc.ContainerDuration;
194 MonoPictureAsset::construct (boost::function<string (int)> get_path)
196 ASDCP::JP2K::CodestreamParser j2k_parser;
197 ASDCP::JP2K::FrameBuffer frame_buffer (4 * Kumu::Megabyte);
198 if (ASDCP_FAILURE (j2k_parser.OpenReadFrame (get_path(0).c_str(), frame_buffer))) {
199 throw FileError ("could not open JPEG2000 file for reading", get_path (0));
202 ASDCP::JP2K::PictureDescriptor picture_desc;
203 j2k_parser.FillPictureDescriptor (picture_desc);
204 picture_desc.EditRate = ASDCP::Rational (_edit_rate, 1);
206 ASDCP::WriterInfo writer_info;
207 fill_writer_info (&writer_info, _uuid);
209 ASDCP::JP2K::MXFWriter mxf_writer;
210 if (ASDCP_FAILURE (mxf_writer.OpenWrite (path().string().c_str(), writer_info, picture_desc, 16384, false))) {
211 throw MXFFileError ("could not open MXF file for writing", path().string());
214 for (int i = 0; i < _intrinsic_duration; ++i) {
216 string const path = get_path (i);
218 if (ASDCP_FAILURE (j2k_parser.OpenReadFrame (path.c_str(), frame_buffer))) {
219 throw FileError ("could not open JPEG2000 file for reading", path);
222 if (ASDCP_FAILURE (mxf_writer.WriteFrame (frame_buffer, 0, 0))) {
223 throw MiscError ("error in writing video MXF");
227 (*_progress) (0.5 * float (i) / _intrinsic_duration);
231 if (ASDCP_FAILURE (mxf_writer.Finalize())) {
232 throw MiscError ("error in finalising video MXF");
237 MonoPictureAsset::path_from_list (int f, vector<string> const & files) const
242 shared_ptr<const MonoPictureFrame>
243 MonoPictureAsset::get_frame (int n) const
245 return shared_ptr<const MonoPictureFrame> (new MonoPictureFrame (path().string(), n));
250 MonoPictureAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, list<string>& notes) const
252 if (!PictureAsset::equals (other, opt, notes)) {
256 shared_ptr<const MonoPictureAsset> other_picture = dynamic_pointer_cast<const MonoPictureAsset> (other);
257 assert (other_picture);
259 for (int i = 0; i < _intrinsic_duration; ++i) {
260 shared_ptr<const MonoPictureFrame> frame_A = get_frame (i);
261 shared_ptr<const MonoPictureFrame> frame_B = other_picture->get_frame (i);
263 if (!frame_buffer_equals (
265 frame_A->j2k_data(), frame_A->j2k_size(),
266 frame_B->j2k_data(), frame_B->j2k_size()
276 StereoPictureAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, list<string>& notes) const
278 if (!PictureAsset::equals (other, opt, notes)) {
282 shared_ptr<const StereoPictureAsset> other_picture = dynamic_pointer_cast<const StereoPictureAsset> (other);
283 assert (other_picture);
285 for (int i = 0; i < _intrinsic_duration; ++i) {
286 shared_ptr<const StereoPictureFrame> frame_A = get_frame (i);
287 shared_ptr<const StereoPictureFrame> frame_B = other_picture->get_frame (i);
289 if (!frame_buffer_equals (
291 frame_A->left_j2k_data(), frame_A->left_j2k_size(),
292 frame_B->left_j2k_data(), frame_B->left_j2k_size()
297 if (!frame_buffer_equals (
299 frame_A->right_j2k_data(), frame_A->right_j2k_size(),
300 frame_B->right_j2k_data(), frame_B->right_j2k_size()
310 PictureAsset::frame_buffer_equals (
311 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
314 if (size_A == size_B && memcmp (data_A, data_B, size_A) == 0) {
315 /* Easy result; the J2K data is identical */
319 /* Decompress the images to bitmaps */
320 opj_image_t* image_A = decompress_j2k (const_cast<uint8_t*> (data_A), size_A, 0);
321 opj_image_t* image_B = decompress_j2k (const_cast<uint8_t*> (data_B), size_B, 0);
325 if (image_A->numcomps != image_B->numcomps) {
326 notes.push_back ("image component counts for frame " + lexical_cast<string>(frame) + " differ");
330 vector<int> abs_diffs (image_A->comps[0].w * image_A->comps[0].h * image_A->numcomps);
334 for (int c = 0; c < image_A->numcomps; ++c) {
336 if (image_A->comps[c].w != image_B->comps[c].w || image_A->comps[c].h != image_B->comps[c].h) {
337 notes.push_back ("image sizes for frame " + lexical_cast<string>(frame) + " differ");
341 int const pixels = image_A->comps[c].w * image_A->comps[c].h;
342 for (int j = 0; j < pixels; ++j) {
343 int const t = abs (image_A->comps[c].data[j] - image_B->comps[c].data[j]);
345 max_diff = max (max_diff, t);
350 for (vector<int>::iterator j = abs_diffs.begin(); j != abs_diffs.end(); ++j) {
354 double const mean = double (total) / abs_diffs.size ();
356 uint64_t total_squared_deviation = 0;
357 for (vector<int>::iterator j = abs_diffs.begin(); j != abs_diffs.end(); ++j) {
358 total_squared_deviation += pow (*j - mean, 2);
361 double const std_dev = sqrt (double (total_squared_deviation) / abs_diffs.size());
363 if (mean > opt.max_mean_pixel_error || std_dev > opt.max_std_dev_pixel_error) {
364 notes.push_back ("mean or standard deviation out of range for " + lexical_cast<string>(frame));
368 opj_image_destroy (image_A);
369 opj_image_destroy (image_B);
375 StereoPictureAsset::StereoPictureAsset (string directory, string mxf_name, int fps, int intrinsic_duration)
376 : PictureAsset (directory, mxf_name, 0, fps, intrinsic_duration, Size (0, 0))
378 ASDCP::JP2K::MXFSReader reader;
379 if (ASDCP_FAILURE (reader.OpenRead (path().string().c_str()))) {
380 throw MXFFileError ("could not open MXF file for reading", path().string());
383 ASDCP::JP2K::PictureDescriptor desc;
384 if (ASDCP_FAILURE (reader.FillPictureDescriptor (desc))) {
385 throw DCPReadError ("could not read video MXF information");
388 _size.width = desc.StoredWidth;
389 _size.height = desc.StoredHeight;
392 shared_ptr<const StereoPictureFrame>
393 StereoPictureAsset::get_frame (int n) const
395 return shared_ptr<const StereoPictureFrame> (new StereoPictureFrame (path().string(), n));
398 shared_ptr<MonoPictureAssetWriter>
399 MonoPictureAsset::start_write ()
401 /* XXX: can't we use a shared_ptr here? */
402 return shared_ptr<MonoPictureAssetWriter> (new MonoPictureAssetWriter (this, false));
405 shared_ptr<MonoPictureAssetWriter>
406 MonoPictureAsset::start_overwrite ()
408 /* XXX: can't we use a shared_ptr here? */
409 return shared_ptr<MonoPictureAssetWriter> (new MonoPictureAssetWriter (this, true));
412 FrameInfo::FrameInfo (istream& s)
414 s >> offset >> length >> hash;
418 FrameInfo::write (ostream& s)
420 s << offset << " " << length << " " << hash;
423 struct MonoPictureAssetWriter::ASDCPState
426 : frame_buffer (4 * Kumu::Megabyte)
429 ASDCP::JP2K::CodestreamParser j2k_parser;
430 ASDCP::JP2K::FrameBuffer frame_buffer;
431 ASDCP::JP2K::MXFWriter mxf_writer;
432 ASDCP::WriterInfo writer_info;
433 ASDCP::JP2K::PictureDescriptor picture_descriptor;
437 /** @param a Asset to write to. `a' must not be deleted while
438 * this writer class still exists, or bad things will happen.
440 MonoPictureAssetWriter::MonoPictureAssetWriter (MonoPictureAsset* a)
441 : _state (new MonoPictureAssetWriter::ASDCPState)
443 , _frames_written (0)
450 MonoPictureAssetWriter::write (uint8_t* data, int size)
452 assert (!_finalized);
454 if (ASDCP_FAILURE (_state->j2k_parser.OpenReadFrame (data, size, _state->frame_buffer))) {
455 throw MiscError ("could not parse J2K frame");
458 if (_frames_written == 0) {
459 /* This is our first frame; set up the writer */
461 _state->j2k_parser.FillPictureDescriptor (_state->picture_descriptor);
462 _state->picture_descriptor.EditRate = ASDCP::Rational (_asset->edit_rate(), 1);
464 MXFAsset::fill_writer_info (&_state->writer_info, _asset->uuid());
466 if (ASDCP_FAILURE (_state->mxf_writer.OpenWrite (_asset->path().string().c_str(), _state->writer_info, _state->picture_descriptor, 16384, false))) {
467 throw MXFFileError ("could not open MXF file for writing", _asset->path().string());
471 uint64_t const before_offset = _state->mxf_writer.Tell ();
474 if (ASDCP_FAILURE (_state->mxf_writer.WriteFrame (_state->frame_buffer, 0, 0, &hash))) {
475 throw MiscError ("error in writing video MXF");
479 return FrameInfo (before_offset, _state->mxf_writer.Tell() - before_offset, hash);
483 MonoPictureAssetWriter::fake_write (int size)
485 assert (!_finalized);
487 if (_frames_written == 0) {
488 /* This is our first frame; set up the writer */
490 _state->j2k_parser.FillPictureDescriptor (_state->picture_descriptor);
491 _state->picture_descriptor.EditRate = ASDCP::Rational (_asset->edit_rate(), 1);
493 MXFAsset::fill_writer_info (&_state->writer_info, _asset->uuid());
495 if (ASDCP_FAILURE (_state->mxf_writer.OpenWrite (_asset->path().string().c_str(), _state->writer_info, _state->picture_descriptor, 16384, true))) {
496 throw MXFFileError ("could not open MXF file for writing", _asset->path().string());
500 if (ASDCP_FAILURE (_state->mxf_writer.FakeWriteFrame (size))) {
501 throw MiscError ("error in writing video MXF");
508 MonoPictureAssetWriter::finalize ()
510 if (ASDCP_FAILURE (_state->mxf_writer.Finalize())) {
511 throw MiscError ("error in finalizing video MXF");
515 _asset->set_intrinsic_duration (_frames_written);
516 _asset->set_duration (_frames_written);
519 MonoPictureAssetWriter::~MonoPictureAssetWriter ()