Add comment.
[libdcp.git] / src / picture_asset.cc
1 /*
2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
3
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.
8
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.
13
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.
17
18 */
19
20 /** @file  src/picture_asset.cc
21  *  @brief An asset made up of JPEG2000 files
22  */
23
24 #include <list>
25 #include <stdexcept>
26 #include <iostream>
27 #include <sstream>
28 #include <fstream>
29 #include <boost/filesystem.hpp>
30 #include <boost/lexical_cast.hpp>
31 #include <openjpeg.h>
32 #include "AS_DCP.h"
33 #include "KM_fileio.h"
34 #include "picture_asset.h"
35 #include "util.h"
36 #include "exceptions.h"
37 #include "picture_frame.h"
38
39 using namespace std;
40 using namespace boost;
41 using namespace libdcp;
42
43 PictureAsset::PictureAsset (
44         sigc::slot<string, int> get_path,
45         string directory,
46         string mxf_name,
47         sigc::signal1<void, float>* progress,
48         int fps,
49         int length,
50         int width,
51         int height)
52         : Asset (directory, mxf_name, progress, fps, length)
53         , _width (width)
54         , _height (height)
55 {
56         construct (get_path);
57 }
58
59 PictureAsset::PictureAsset (
60         vector<string> const & files,
61         string directory,
62         string mxf_name,
63         sigc::signal1<void, float>* progress,
64         int fps,
65         int length,
66         int width,
67         int height)
68         : Asset (directory, mxf_name, progress, fps, length)
69         , _width (width)
70         , _height (height)
71 {
72         construct (sigc::bind (sigc::mem_fun (*this, &PictureAsset::path_from_list), files));
73 }
74
75 PictureAsset::PictureAsset (string directory, string mxf_name, int fps, int length, int width, int height)
76         : Asset (directory, mxf_name, 0, fps, length)
77         , _width (width)
78         , _height (height)
79 {
80
81 }
82
83 string
84 PictureAsset::path_from_list (int f, vector<string> const & files) const
85 {
86         return files[f];
87 }
88
89 void
90 PictureAsset::construct (sigc::slot<string, int> get_path)
91 {
92         ASDCP::JP2K::CodestreamParser j2k_parser;
93         ASDCP::JP2K::FrameBuffer frame_buffer (4 * Kumu::Megabyte);
94         if (ASDCP_FAILURE (j2k_parser.OpenReadFrame (get_path(0).c_str(), frame_buffer))) {
95                 throw FileError ("could not open JPEG2000 file for reading", get_path (0));
96         }
97         
98         ASDCP::JP2K::PictureDescriptor picture_desc;
99         j2k_parser.FillPictureDescriptor (picture_desc);
100         picture_desc.EditRate = ASDCP::Rational (_fps, 1);
101         
102         ASDCP::WriterInfo writer_info;
103         fill_writer_info (&writer_info);
104         
105         ASDCP::JP2K::MXFWriter mxf_writer;
106         if (ASDCP_FAILURE (mxf_writer.OpenWrite (mxf_path().string().c_str(), writer_info, picture_desc))) {
107                 throw FileError ("could not open MXF file for writing", mxf_path().string());
108         }
109
110         for (int i = 0; i < _length; ++i) {
111
112                 string const path = get_path (i);
113                 
114                 if (ASDCP_FAILURE (j2k_parser.OpenReadFrame (path.c_str(), frame_buffer))) {
115                         throw FileError ("could not open JPEG2000 file for reading", path);
116                 }
117
118                 /* XXX: passing 0 to WriteFrame ok? */
119                 if (ASDCP_FAILURE (mxf_writer.WriteFrame (frame_buffer, 0, 0))) {
120                         throw MiscError ("error in writing video MXF");
121                 }
122                 
123                 (*_progress) (0.5 * float (i) / _length);
124         }
125         
126         if (ASDCP_FAILURE (mxf_writer.Finalize())) {
127                 throw MiscError ("error in finalising video MXF");
128         }
129 }
130
131 void
132 PictureAsset::write_to_cpl (ostream& s) const
133 {
134         s << "        <MainPicture>\n"
135           << "          <Id>urn:uuid:" << _uuid << "</Id>\n"
136           << "          <AnnotationText>" << _mxf_name << "</AnnotationText>\n"
137           << "          <EditRate>" << _fps << " 1</EditRate>\n"
138           << "          <IntrinsicDuration>" << _length << "</IntrinsicDuration>\n"
139           << "          <EntryPoint>0</EntryPoint>\n"
140           << "          <Duration>" << _length << "</Duration>\n"
141           << "          <FrameRate>" << _fps << " 1</FrameRate>\n"
142           << "          <ScreenAspectRatio>" << _width << " " << _height << "</ScreenAspectRatio>\n"
143           << "        </MainPicture>\n";
144 }
145
146 /* XXX: could use get_frame()? */
147 list<string>
148 PictureAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt) const
149 {
150         list<string> notes = Asset::equals (other, opt);
151                      
152         if (opt.flags & MXF_INSPECT) {
153                 ASDCP::JP2K::MXFReader reader_A;
154                 if (ASDCP_FAILURE (reader_A.OpenRead (mxf_path().string().c_str()))) {
155                         throw FileError ("could not open MXF file for reading", mxf_path().string());
156                 }
157
158                 ASDCP::JP2K::MXFReader reader_B;
159                 if (ASDCP_FAILURE (reader_B.OpenRead (other->mxf_path().string().c_str()))) {
160                         throw FileError ("could not open MXF file for reading", mxf_path().string());
161                 }
162
163                 ASDCP::JP2K::PictureDescriptor desc_A;
164                 if (ASDCP_FAILURE (reader_A.FillPictureDescriptor (desc_A))) {
165                         throw DCPReadError ("could not read video MXF information");
166                 }
167                 ASDCP::JP2K::PictureDescriptor desc_B;
168                 if (ASDCP_FAILURE (reader_B.FillPictureDescriptor (desc_B))) {
169                         throw DCPReadError ("could not read video MXF information");
170                 }
171
172                 if (
173                         desc_A.EditRate != desc_B.EditRate ||
174                         desc_A.ContainerDuration != desc_B.ContainerDuration ||
175                         desc_A.SampleRate != desc_B.SampleRate ||
176                         desc_A.StoredWidth != desc_B.StoredWidth ||
177                         desc_A.StoredHeight != desc_B.StoredHeight ||
178                         desc_A.AspectRatio != desc_B.AspectRatio ||
179                         desc_A.Rsize != desc_B.Rsize ||
180                         desc_A.Xsize != desc_B.Xsize ||
181                         desc_A.Ysize != desc_B.Ysize ||
182                         desc_A.XOsize != desc_B.XOsize ||
183                         desc_A.YOsize != desc_B.YOsize ||
184                         desc_A.XTsize != desc_B.XTsize ||
185                         desc_A.YTsize != desc_B.YTsize ||
186                         desc_A.XTOsize != desc_B.XTOsize ||
187                         desc_A.YTOsize != desc_B.YTOsize ||
188                         desc_A.Csize != desc_B.Csize
189 //                      desc_A.CodingStyleDefault != desc_B.CodingStyleDefault ||
190 //                      desc_A.QuantizationDefault != desc_B.QuantizationDefault
191                         ) {
192                 
193                         notes.push_back ("video MXF picture descriptors differ");
194                 }
195
196 //              for (unsigned int j = 0; j < ASDCP::JP2K::MaxComponents; ++j) {
197 //                      if (desc_A.ImageComponents[j] != desc_B.ImageComponents[j]) {
198 //                              notes.pack_start ("video MXF picture descriptors differ");
199 //                      }
200 //              }
201                                 
202
203                 ASDCP::JP2K::FrameBuffer buffer_A (4 * Kumu::Megabyte);
204                 ASDCP::JP2K::FrameBuffer buffer_B (4 * Kumu::Megabyte);
205
206                 for (int i = 0; i < _length; ++i) {
207                         if (ASDCP_FAILURE (reader_A.ReadFrame (i, buffer_A))) {
208                                 throw DCPReadError ("could not read video frame");
209                         }
210
211                         if (ASDCP_FAILURE (reader_B.ReadFrame (i, buffer_B))) {
212                                 throw DCPReadError ("could not read video frame");
213                         }
214
215                         bool j2k_same = true;
216
217                         if (buffer_A.Size() != buffer_B.Size()) {
218                                 notes.push_back ("sizes of video data for frame " + lexical_cast<string>(i) + " differ");
219                                 j2k_same = false;
220                         } else if (memcmp (buffer_A.RoData(), buffer_B.RoData(), buffer_A.Size()) != 0) {
221                                 notes.push_back ("J2K data for frame " + lexical_cast<string>(i) + " differ");
222                                 j2k_same = false;
223                         }
224
225                         if (!j2k_same) {
226
227                                 if (opt.verbose) {
228                                         cout << "J2K images for " << i << " differ; checking by pixel\n";
229                                 }
230                                 
231                                 /* Decompress the images to bitmaps */
232                                 opj_image_t* image_A = decompress_j2k (const_cast<uint8_t*> (buffer_A.RoData()), buffer_A.Size ());
233                                 opj_image_t* image_B = decompress_j2k (const_cast<uint8_t*> (buffer_B.RoData()), buffer_B.Size ());
234
235                                 /* Compare them */
236                                 
237                                 if (image_A->numcomps != image_B->numcomps) {
238                                         notes.push_back ("image component counts for frame " + lexical_cast<string>(i) + " differ");
239                                 }
240
241                                 vector<int> abs_diffs (image_A->comps[0].w * image_A->comps[0].h * image_A->numcomps);
242                                 int d = 0;
243                                 int max_diff = 0;
244
245                                 for (int c = 0; c < image_A->numcomps; ++c) {
246
247                                         if (image_A->comps[c].w != image_B->comps[c].w || image_A->comps[c].h != image_B->comps[c].h) {
248                                                 notes.push_back ("image sizes for frame " + lexical_cast<string>(i) + " differ");
249                                         }
250
251                                         int const pixels = image_A->comps[c].w * image_A->comps[c].h;
252                                         for (int j = 0; j < pixels; ++j) {
253                                                 int const t = abs (image_A->comps[c].data[j] - image_B->comps[c].data[j]);
254                                                 abs_diffs[d++] = t;
255                                                 max_diff = max (max_diff, t);
256                                         }
257                                 }
258
259                                 uint64_t total = 0;
260                                 for (vector<int>::iterator j = abs_diffs.begin(); j != abs_diffs.end(); ++j) {
261                                         total += *j;
262                                 }
263
264                                 double const mean = double (total) / abs_diffs.size ();
265
266                                 uint64_t total_squared_deviation = 0;
267                                 for (vector<int>::iterator j = abs_diffs.begin(); j != abs_diffs.end(); ++j) {
268                                         total_squared_deviation += pow (*j - mean, 2);
269                                 }
270
271                                 double const std_dev = sqrt (double (total_squared_deviation) / abs_diffs.size());
272
273                                 if (mean > opt.max_mean_pixel_error || std_dev > opt.max_std_dev_pixel_error) {
274                                         notes.push_back ("mean or standard deviation out of range for " + lexical_cast<string>(i));
275                                 }
276
277                                 if (opt.verbose) {
278                                         cout << "\tmax pixel error " << max_diff << ", mean pixel error " << mean << ", standard deviation " << std_dev << "\n";
279                                 }
280
281                                 opj_image_destroy (image_A);
282                                 opj_image_destroy (image_B);
283                         }
284                 }
285         }
286
287         return notes;
288 }
289
290 opj_image_t *
291 PictureAsset::decompress_j2k (uint8_t* data, int64_t size) const
292 {
293         opj_dinfo_t* decoder = opj_create_decompress (CODEC_J2K);
294         opj_dparameters_t parameters;
295         opj_set_default_decoder_parameters (&parameters);
296         opj_setup_decoder (decoder, &parameters);
297         opj_cio_t* cio = opj_cio_open ((opj_common_ptr) decoder, data, size);
298         opj_image_t* image = opj_decode (decoder, cio);
299         if (!image) {
300                 opj_destroy_decompress (decoder);
301                 opj_cio_close (cio);
302                 throw DCPReadError ("could not decode JPEG2000 codestream");
303         }
304
305         opj_cio_close (cio);
306         return image;
307 }
308
309 shared_ptr<const PictureFrame>
310 PictureAsset::get_frame (int n) const
311 {
312         return shared_ptr<const PictureFrame> (new PictureFrame (mxf_path().string(), n));
313 }