Merge.
[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 std::string;
40 using std::ostream;
41 using std::list;
42 using std::vector;
43 using std::max;
44 using boost::shared_ptr;
45 using boost::dynamic_pointer_cast;
46 using boost::lexical_cast;
47 using namespace libdcp;
48
49 PictureAsset::PictureAsset (string directory, string mxf_name, boost::signals2::signal<void (float)>* progress, int fps, int entry_point, int length)
50         : MXFAsset (directory, mxf_name, progress, fps, entry_point, length)
51         , _width (0)
52         , _height (0)
53 {
54
55 }
56
57 void
58 PictureAsset::write_to_cpl (ostream& s) const
59 {
60         s << "        <MainPicture>\n"
61           << "          <Id>urn:uuid:" << _uuid << "</Id>\n"
62           << "          <AnnotationText>" << _file_name << "</AnnotationText>\n"
63           << "          <EditRate>" << _fps << " 1</EditRate>\n"
64           << "          <IntrinsicDuration>" << _length << "</IntrinsicDuration>\n"
65           << "          <EntryPoint>0</EntryPoint>\n"
66           << "          <Duration>" << _length << "</Duration>\n"
67           << "          <FrameRate>" << _fps << " 1</FrameRate>\n"
68           << "          <ScreenAspectRatio>" << _width << " " << _height << "</ScreenAspectRatio>\n"
69           << "        </MainPicture>\n";
70 }
71
72 bool
73 PictureAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, list<string>& notes) const
74 {
75         if (!MXFAsset::equals (other, opt, notes)) {
76                 return false;
77         }
78                      
79         ASDCP::JP2K::MXFReader reader_A;
80         if (ASDCP_FAILURE (reader_A.OpenRead (path().string().c_str()))) {
81                 throw MXFFileError ("could not open MXF file for reading", path().string());
82         }
83         
84         ASDCP::JP2K::MXFReader reader_B;
85         if (ASDCP_FAILURE (reader_B.OpenRead (other->path().string().c_str()))) {
86                 throw MXFFileError ("could not open MXF file for reading", path().string());
87         }
88         
89         ASDCP::JP2K::PictureDescriptor desc_A;
90         if (ASDCP_FAILURE (reader_A.FillPictureDescriptor (desc_A))) {
91                 throw DCPReadError ("could not read video MXF information");
92         }
93         ASDCP::JP2K::PictureDescriptor desc_B;
94         if (ASDCP_FAILURE (reader_B.FillPictureDescriptor (desc_B))) {
95                 throw DCPReadError ("could not read video MXF information");
96         }
97         
98         if (
99                 desc_A.EditRate != desc_B.EditRate ||
100                 desc_A.ContainerDuration != desc_B.ContainerDuration ||
101                 desc_A.SampleRate != desc_B.SampleRate ||
102                 desc_A.StoredWidth != desc_B.StoredWidth ||
103                 desc_A.StoredHeight != desc_B.StoredHeight ||
104                 desc_A.AspectRatio != desc_B.AspectRatio ||
105                 desc_A.Rsize != desc_B.Rsize ||
106                 desc_A.Xsize != desc_B.Xsize ||
107                 desc_A.Ysize != desc_B.Ysize ||
108                 desc_A.XOsize != desc_B.XOsize ||
109                 desc_A.YOsize != desc_B.YOsize ||
110                 desc_A.XTsize != desc_B.XTsize ||
111                 desc_A.YTsize != desc_B.YTsize ||
112                 desc_A.XTOsize != desc_B.XTOsize ||
113                 desc_A.YTOsize != desc_B.YTOsize ||
114                 desc_A.Csize != desc_B.Csize
115 //              desc_A.CodingStyleDefault != desc_B.CodingStyleDefault ||
116 //              desc_A.QuantizationDefault != desc_B.QuantizationDefault
117                 ) {
118                 
119                 notes.push_back ("video MXF picture descriptors differ");
120                 return false;
121         }
122
123 //              for (unsigned int j = 0; j < ASDCP::JP2K::MaxComponents; ++j) {
124 //                      if (desc_A.ImageComponents[j] != desc_B.ImageComponents[j]) {
125 //                              notes.pack_start ("video MXF picture descriptors differ");
126 //                      }
127 //              }
128
129         return true;
130 }
131
132
133 MonoPictureAsset::MonoPictureAsset (
134         boost::function<string (int)> get_path,
135         string directory,
136         string mxf_name,
137         boost::signals2::signal<void (float)>* progress,
138         int fps,
139         int length,
140         int width,
141         int height)
142         : PictureAsset (directory, mxf_name, progress, fps, 0, length)
143 {
144         _width = width;
145         _height = height;
146         construct (get_path);
147 }
148
149 MonoPictureAsset::MonoPictureAsset (
150         vector<string> const & files,
151         string directory,
152         string mxf_name,
153         boost::signals2::signal<void (float)>* progress,
154         int fps,
155         int length,
156         int width,
157         int height)
158         : PictureAsset (directory, mxf_name, progress, fps, 0, length)
159 {
160         _width = width;
161         _height = height;
162         construct (boost::bind (&MonoPictureAsset::path_from_list, this, _1, files));
163 }
164
165 MonoPictureAsset::MonoPictureAsset (string directory, string mxf_name, int fps, int entry_point, int length)
166         : PictureAsset (directory, mxf_name, 0, fps, entry_point, length)
167 {
168         ASDCP::JP2K::MXFReader reader;
169         if (ASDCP_FAILURE (reader.OpenRead (path().string().c_str()))) {
170                 throw MXFFileError ("could not open MXF file for reading", path().string());
171         }
172         
173         ASDCP::JP2K::PictureDescriptor desc;
174         if (ASDCP_FAILURE (reader.FillPictureDescriptor (desc))) {
175                 throw DCPReadError ("could not read video MXF information");
176         }
177
178         _width = desc.StoredWidth;
179         _height = desc.StoredHeight;
180 }
181
182 void
183 MonoPictureAsset::construct (boost::function<string (int)> get_path)
184 {
185         ASDCP::JP2K::CodestreamParser j2k_parser;
186         ASDCP::JP2K::FrameBuffer frame_buffer (4 * Kumu::Megabyte);
187         if (ASDCP_FAILURE (j2k_parser.OpenReadFrame (get_path(0).c_str(), frame_buffer))) {
188                 throw FileError ("could not open JPEG2000 file for reading", get_path (0));
189         }
190         
191         ASDCP::JP2K::PictureDescriptor picture_desc;
192         j2k_parser.FillPictureDescriptor (picture_desc);
193         picture_desc.EditRate = ASDCP::Rational (_fps, 1);
194         
195         ASDCP::WriterInfo writer_info;
196         fill_writer_info (&writer_info);
197         
198         ASDCP::JP2K::MXFWriter mxf_writer;
199         if (ASDCP_FAILURE (mxf_writer.OpenWrite (path().string().c_str(), writer_info, picture_desc))) {
200                 throw MXFFileError ("could not open MXF file for writing", path().string());
201         }
202
203         for (int i = 0; i < _length; ++i) {
204
205                 string const path = get_path (i);
206
207                 if (ASDCP_FAILURE (j2k_parser.OpenReadFrame (path.c_str(), frame_buffer))) {
208                         throw FileError ("could not open JPEG2000 file for reading", path);
209                 }
210
211                 /* XXX: passing 0 to WriteFrame ok? */
212                 if (ASDCP_FAILURE (mxf_writer.WriteFrame (frame_buffer, 0, 0))) {
213                         throw MiscError ("error in writing video MXF");
214                 }
215
216                 if (_progress) {
217                         (*_progress) (0.5 * float (i) / _length);
218                 }
219         }
220         
221         if (ASDCP_FAILURE (mxf_writer.Finalize())) {
222                 throw MiscError ("error in finalising video MXF");
223         }
224 }
225
226 string
227 MonoPictureAsset::path_from_list (int f, vector<string> const & files) const
228 {
229         return files[f];
230 }
231
232 shared_ptr<const MonoPictureFrame>
233 MonoPictureAsset::get_frame (int n) const
234 {
235         return shared_ptr<const MonoPictureFrame> (new MonoPictureFrame (path().string(), n + _entry_point));
236 }
237
238
239 bool
240 MonoPictureAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, list<string>& notes) const
241 {
242         if (!PictureAsset::equals (other, opt, notes)) {
243                 return false;
244         }
245
246         shared_ptr<const MonoPictureAsset> other_picture = dynamic_pointer_cast<const MonoPictureAsset> (other);
247         assert (other_picture);
248
249         for (int i = 0; i < _length; ++i) {
250                 shared_ptr<const MonoPictureFrame> frame_A = get_frame (i);
251                 shared_ptr<const MonoPictureFrame> frame_B = other_picture->get_frame (i);
252                 
253                 if (!frame_buffer_equals (
254                             i, opt, notes,
255                             frame_A->j2k_frame()->RoData(), frame_A->j2k_frame()->Size(),
256                             frame_B->j2k_frame()->RoData(), frame_B->j2k_frame()->Size()
257                             )) {
258                         return false;
259                 }
260         }
261
262         return true;
263 }
264
265 bool
266 StereoPictureAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, list<string>& notes) const
267 {
268         if (!PictureAsset::equals (other, opt, notes)) {
269                 return false;
270         }
271         
272         shared_ptr<const StereoPictureAsset> other_picture = dynamic_pointer_cast<const StereoPictureAsset> (other);
273         assert (other_picture);
274
275         for (int i = 0; i < _length; ++i) {
276                 shared_ptr<const StereoPictureFrame> frame_A = get_frame (i);
277                 shared_ptr<const StereoPictureFrame> frame_B = other_picture->get_frame (i);
278                 
279                 if (!frame_buffer_equals (
280                             i, opt, notes,
281                             frame_A->j2k_frame()->Left.RoData(), frame_A->j2k_frame()->Left.Size(),
282                             frame_B->j2k_frame()->Left.RoData(), frame_B->j2k_frame()->Left.Size()
283                             )) {
284                         return false;
285                 }
286                 
287                 if (!frame_buffer_equals (
288                             i, opt, notes,
289                             frame_A->j2k_frame()->Right.RoData(), frame_A->j2k_frame()->Right.Size(),
290                             frame_B->j2k_frame()->Right.RoData(), frame_B->j2k_frame()->Right.Size()
291                             )) {
292                         return false;
293                 }
294         }
295
296         return true;
297 }
298
299 bool
300 PictureAsset::frame_buffer_equals (
301         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
302         ) const
303 {
304         if (size_A == size_B && memcmp (data_A, data_B, size_A) == 0) {
305                 /* Easy result; the J2K data is identical */
306                 return true;
307         }
308                 
309         /* Decompress the images to bitmaps */
310         opj_image_t* image_A = decompress_j2k (const_cast<uint8_t*> (data_A), size_A, 0);
311         opj_image_t* image_B = decompress_j2k (const_cast<uint8_t*> (data_B), size_B, 0);
312         
313         /* Compare them */
314         
315         if (image_A->numcomps != image_B->numcomps) {
316                 notes.push_back ("image component counts for frame " + lexical_cast<string>(frame) + " differ");
317                 return false;
318         }
319         
320         vector<int> abs_diffs (image_A->comps[0].w * image_A->comps[0].h * image_A->numcomps);
321         int d = 0;
322         int max_diff = 0;
323         
324         for (int c = 0; c < image_A->numcomps; ++c) {
325                 
326                 if (image_A->comps[c].w != image_B->comps[c].w || image_A->comps[c].h != image_B->comps[c].h) {
327                         notes.push_back ("image sizes for frame " + lexical_cast<string>(frame) + " differ");
328                         return false;
329                 }
330                 
331                 int const pixels = image_A->comps[c].w * image_A->comps[c].h;
332                 for (int j = 0; j < pixels; ++j) {
333                         int const t = abs (image_A->comps[c].data[j] - image_B->comps[c].data[j]);
334                         abs_diffs[d++] = t;
335                         max_diff = max (max_diff, t);
336                 }
337         }
338                 
339         uint64_t total = 0;
340         for (vector<int>::iterator j = abs_diffs.begin(); j != abs_diffs.end(); ++j) {
341                 total += *j;
342         }
343         
344         double const mean = double (total) / abs_diffs.size ();
345         
346         uint64_t total_squared_deviation = 0;
347         for (vector<int>::iterator j = abs_diffs.begin(); j != abs_diffs.end(); ++j) {
348                 total_squared_deviation += pow (*j - mean, 2);
349         }
350         
351         double const std_dev = sqrt (double (total_squared_deviation) / abs_diffs.size());
352         
353         if (mean > opt.max_mean_pixel_error || std_dev > opt.max_std_dev_pixel_error) {
354                 notes.push_back ("mean or standard deviation out of range for " + lexical_cast<string>(frame));
355                 return false;
356         }
357         
358         opj_image_destroy (image_A);
359         opj_image_destroy (image_B);
360
361         return true;
362 }
363
364
365 StereoPictureAsset::StereoPictureAsset (string directory, string mxf_name, int fps, int entry_point, int length)
366         : PictureAsset (directory, mxf_name, 0, fps, entry_point, length)
367 {
368         ASDCP::JP2K::MXFSReader reader;
369         if (ASDCP_FAILURE (reader.OpenRead (path().string().c_str()))) {
370                 throw MXFFileError ("could not open MXF file for reading", path().string());
371         }
372         
373         ASDCP::JP2K::PictureDescriptor desc;
374         if (ASDCP_FAILURE (reader.FillPictureDescriptor (desc))) {
375                 throw DCPReadError ("could not read video MXF information");
376         }
377
378         _width = desc.StoredWidth;
379         _height = desc.StoredHeight;
380 }
381
382 shared_ptr<const StereoPictureFrame>
383 StereoPictureAsset::get_frame (int n) const
384 {
385         return shared_ptr<const StereoPictureFrame> (new StereoPictureFrame (path().string(), n + _entry_point));
386 }