Avoid unnecessary re-writes of video assets if they are staying the same (#1638).
[dcpomatic.git] / src / lib / j2k_image_proxy.cc
1 /*
2     Copyright (C) 2014-2015 Carl Hetherington <cth@carlh.net>
3
4     This file is part of DCP-o-matic.
5
6     DCP-o-matic is free software; you can redistribute it and/or modify
7     it under the terms of the GNU General Public License as published by
8     the Free Software Foundation; either version 2 of the License, or
9     (at your option) any later version.
10
11     DCP-o-matic is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14     GNU General Public License for more details.
15
16     You should have received a copy of the GNU General Public License
17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
18
19 */
20
21 #include "j2k_image_proxy.h"
22 #include "dcpomatic_socket.h"
23 #include "image.h"
24 #include "dcpomatic_assert.h"
25 #include <dcp/raw_convert.h>
26 #include <dcp/openjpeg_image.h>
27 #include <dcp/mono_picture_frame.h>
28 #include <dcp/stereo_picture_frame.h>
29 #include <dcp/colour_conversion.h>
30 #include <dcp/rgb_xyz.h>
31 #include <dcp/j2k.h>
32 #include <libcxml/cxml.h>
33 #include <libxml++/libxml++.h>
34 #include <iostream>
35
36 #include "i18n.h"
37
38 using std::string;
39 using std::cout;
40 using std::max;
41 using std::pair;
42 using std::make_pair;
43 using boost::shared_ptr;
44 using boost::optional;
45 using boost::dynamic_pointer_cast;
46 using dcp::Data;
47 using dcp::raw_convert;
48
49 /** Construct a J2KImageProxy from a JPEG2000 file */
50 J2KImageProxy::J2KImageProxy (boost::filesystem::path path, dcp::Size size, AVPixelFormat pixel_format)
51         : _data (path)
52         , _size (size)
53         , _pixel_format (pixel_format)
54 {
55         /* ::image assumes 16bpp */
56         DCPOMATIC_ASSERT (_pixel_format == AV_PIX_FMT_RGB48 || _pixel_format == AV_PIX_FMT_XYZ12LE);
57 }
58
59 J2KImageProxy::J2KImageProxy (
60         shared_ptr<const dcp::MonoPictureFrame> frame,
61         dcp::Size size,
62         AVPixelFormat pixel_format,
63         optional<int> forced_reduction
64         )
65         : _data (frame->j2k_size ())
66         , _size (size)
67         , _pixel_format (pixel_format)
68         , _forced_reduction (forced_reduction)
69 {
70         /* ::image assumes 16bpp */
71         DCPOMATIC_ASSERT (_pixel_format == AV_PIX_FMT_RGB48 || _pixel_format == AV_PIX_FMT_XYZ12LE);
72         memcpy (_data.data().get(), frame->j2k_data(), _data.size ());
73 }
74
75 J2KImageProxy::J2KImageProxy (
76         shared_ptr<const dcp::StereoPictureFrame> frame,
77         dcp::Size size,
78         dcp::Eye eye,
79         AVPixelFormat pixel_format,
80         optional<int> forced_reduction
81         )
82         : _size (size)
83         , _eye (eye)
84         , _pixel_format (pixel_format)
85         , _forced_reduction (forced_reduction)
86 {
87         /* ::image assumes 16bpp */
88         DCPOMATIC_ASSERT (_pixel_format == AV_PIX_FMT_RGB48 || _pixel_format == AV_PIX_FMT_XYZ12LE);
89         switch (eye) {
90         case dcp::EYE_LEFT:
91                 _data = Data (frame->left_j2k_size ());
92                 memcpy (_data.data().get(), frame->left_j2k_data(), _data.size ());
93                 break;
94         case dcp::EYE_RIGHT:
95                 _data = Data (frame->right_j2k_size ());
96                 memcpy (_data.data().get(), frame->right_j2k_data(), _data.size ());
97                 break;
98         }
99 }
100
101 J2KImageProxy::J2KImageProxy (shared_ptr<cxml::Node> xml, shared_ptr<Socket> socket)
102 {
103         _size = dcp::Size (xml->number_child<int> ("Width"), xml->number_child<int> ("Height"));
104         if (xml->optional_number_child<int> ("Eye")) {
105                 _eye = static_cast<dcp::Eye> (xml->number_child<int> ("Eye"));
106         }
107         _data = Data (xml->number_child<int> ("Size"));
108         /* This only matters when we are using J2KImageProxy for the preview, which
109            will never use this constructor (which is only used for passing data to
110            encode servers).  So we can put anything in here.  It's a bit of a hack.
111         */
112         _pixel_format = AV_PIX_FMT_XYZ12LE;
113         socket->read (_data.data().get (), _data.size ());
114 }
115
116 int
117 J2KImageProxy::prepare (optional<dcp::Size> target_size) const
118 {
119         boost::mutex::scoped_lock lm (_mutex);
120
121         if (_image && target_size == _target_size) {
122                 DCPOMATIC_ASSERT (_reduce);
123                 return *_reduce;
124         }
125
126         int reduce = 0;
127
128         if (_forced_reduction) {
129                 reduce = *_forced_reduction;
130         } else {
131                 while (target_size && (_size.width / pow(2, reduce)) > target_size->width && (_size.height / pow(2, reduce)) > target_size->height) {
132                         ++reduce;
133                 }
134
135                 --reduce;
136                 reduce = max (0, reduce);
137         }
138
139         shared_ptr<dcp::OpenJPEGImage> decompressed = dcp::decompress_j2k (const_cast<uint8_t*> (_data.data().get()), _data.size (), reduce);
140
141         _image.reset (new Image (_pixel_format, decompressed->size(), true));
142
143         int const shift = 16 - decompressed->precision (0);
144
145         /* Copy data in whatever format (sRGB or XYZ) into our Image; I'm assuming
146            the data is 12-bit either way.
147         */
148
149         int const width = decompressed->size().width;
150
151         int p = 0;
152         int* decomp_0 = decompressed->data (0);
153         int* decomp_1 = decompressed->data (1);
154         int* decomp_2 = decompressed->data (2);
155         for (int y = 0; y < decompressed->size().height; ++y) {
156                 uint16_t* q = (uint16_t *) (_image->data()[0] + y * _image->stride()[0]);
157                 for (int x = 0; x < width; ++x) {
158                         *q++ = decomp_0[p] << shift;
159                         *q++ = decomp_1[p] << shift;
160                         *q++ = decomp_2[p] << shift;
161                         ++p;
162                 }
163         }
164
165         _target_size = target_size;
166         _reduce = reduce;
167
168         return reduce;
169 }
170
171 pair<shared_ptr<Image>, int>
172 J2KImageProxy::image (optional<dcp::Size> target_size) const
173 {
174         int const r = prepare (target_size);
175         /* I think this is safe without a lock on mutex.  _image is guaranteed to be
176            set up when prepare() has happened.
177         */
178         return make_pair (_image, r);
179 }
180
181 void
182 J2KImageProxy::add_metadata (xmlpp::Node* node) const
183 {
184         node->add_child("Type")->add_child_text (N_("J2K"));
185         node->add_child("Width")->add_child_text (raw_convert<string> (_size.width));
186         node->add_child("Height")->add_child_text (raw_convert<string> (_size.height));
187         if (_eye) {
188                 node->add_child("Eye")->add_child_text (raw_convert<string> (static_cast<int> (_eye.get ())));
189         }
190         node->add_child("Size")->add_child_text (raw_convert<string> (_data.size ()));
191 }
192
193 void
194 J2KImageProxy::send_binary (shared_ptr<Socket> socket) const
195 {
196         socket->write (_data.data().get(), _data.size());
197 }
198
199 bool
200 J2KImageProxy::same (shared_ptr<const ImageProxy> other) const
201 {
202         shared_ptr<const J2KImageProxy> jp = dynamic_pointer_cast<const J2KImageProxy> (other);
203         if (!jp) {
204                 return false;
205         }
206
207         if (_data.size() != jp->_data.size()) {
208                 return false;
209         }
210
211         return memcmp (_data.data().get(), jp->_data.data().get(), _data.size()) == 0;
212 }
213
214 J2KImageProxy::J2KImageProxy (Data data, dcp::Size size, AVPixelFormat pixel_format)
215         : _data (data)
216         , _size (size)
217         , _pixel_format (pixel_format)
218 {
219         /* ::image assumes 16bpp */
220         DCPOMATIC_ASSERT (_pixel_format == AV_PIX_FMT_RGB48 || _pixel_format == AV_PIX_FMT_XYZ12LE);
221 }
222
223 size_t
224 J2KImageProxy::memory_used () const
225 {
226         size_t m = _data.size();
227         if (_image) {
228                 /* 3 components, 16-bits per pixel */
229                 m += 3 * 2 * _image->size().width * _image->size().height;
230         }
231         return m;
232 }