libopenraw
raffile.cpp
1 /* -*- mode:c++; tab-width:4; c-basic-offset:4 -*- */
2 /*
3  * libopenraw - raffile.cpp
4  *
5  * Copyright (C) 2011-2017 Hubert Figuière
6  *
7  * This library is free software: you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public License
9  * as published by the Free Software Foundation, either version 3 of
10  * the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this library. If not, see
19  * <http://www.gnu.org/licenses/>.
20  */
21 
22 #include <stddef.h>
23 #include <sys/types.h>
24 #include <algorithm>
25 #include <cstdint>
26 
27 #include <memory>
28 
29 #include <libopenraw/cameraids.h>
30 #include <libopenraw/debug.h>
31 #include <libopenraw/metadata.h>
32 
33 #include "rawdata.hpp"
34 #include "rawfile.hpp"
35 #include "metavalue.hpp"
36 
37 #include "ifd.hpp"
38 #include "ifddir.hpp"
39 #include "ifdentry.hpp"
40 #include "rawfile_private.hpp"
41 #include "raffile.hpp"
42 #include "rafcontainer.hpp"
43 #include "rafmetacontainer.hpp"
44 #include "jfifcontainer.hpp"
45 #include "unpack.hpp"
46 #include "trace.hpp"
47 #include "io/streamclone.hpp"
48 #include "xtranspattern.hpp"
49 
50 namespace OpenRaw {
51 namespace Internals {
52 
53 #define OR_MAKE_FUJIFILM_TYPEID(camid) \
54  OR_MAKE_FILE_TYPEID(OR_TYPEID_VENDOR_FUJIFILM, camid)
55 
56 /* taken from dcraw, by default */
57 static const BuiltinColourMatrix s_matrices[] = {
58  { OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_F700),
59  0,
60  0,
61  { 10004, -3219, -1201, -7036, 15047, 2107, -1863, 2565, 7736 } },
62  { OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_F810),
63  0,
64  0,
65  { 11044, -3888, -1120, -7248, 15168, 2208, -1531, 2277, 8069 } },
66  { OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_E900),
67  0,
68  0,
69  { 9183, -2526, -1078, -7461, 15071, 2574, -2022, 2440, 8639 } },
70  { OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_S2PRO),
71  128,
72  0,
73  { 12492, -4690, -1402, -7033, 15423, 1647, -1507, 2111, 7697 } },
74  { OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_S3PRO),
75  0,
76  0,
77  { 11807, -4612, -1294, -8927, 16968, 1988, -2120, 2741, 8006 } },
78  { OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_S5PRO),
79  0,
80  0,
81  { 12300, -5110, -1304, -9117, 17143, 1998, -1947, 2448, 8100 } },
82  { OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_S5600),
83  0,
84  0,
85  { 9636, -2804, -988, -7442, 15040, 2589, -1803, 2311, 8621 } },
86  { OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_S9500),
87  0,
88  0,
89  { 10491, -3423, -1145, -7385, 15027, 2538, -1809, 2275, 8692 } },
90  { OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_S6500FD),
91  0,
92  0,
93  { 12628, -4887, -1401, -6861, 14996, 1962, -2198, 2782, 7091 } },
94  { OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_HS10),
95  0,
96  0xf68,
97  { 12440, -3954, -1183, -1123, 9674, 1708, -83, 1614, 4086 } },
98  { OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_X100),
99  0,
100  0,
101  { 12161, -4457, -1069, -5034, 12874, 2400, -795, 1724, 6904 } },
102  // From DNG Convert 7.4
103  { OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_X100S),
104  0,
105  0,
106  { 10592, -4262, -1008, -3514, 11355, 2465, -870, 2025, 6386 } },
107  { OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_X100T),
108  0,
109  0,
110  { 10592, -4262, -1008, -3514, 11355, 2465, -870, 2025, 6386 } },
111  { OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_X10),
112  0,
113  0,
114  { 13509, -6199, -1254, -4430, 12733, 1865, -331, 1441, 5022 } },
115  // From DNG Convert 7.4
116  { OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_X20),
117  0,
118  0,
119  { 11768, -4971, -1133, -4904, 12927, 2183, -480, 1723, 4605 } },
120  // From DNG Convert 8.7-rc
121  { OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_X30),
122  0,
123  0,
124  { 12328, -5256, -1144, -4469, 12927, 1675, -87, 1291, 4351 } },
125  { OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_X70),
126  0,
127  0,
128  { 10450, -4329, -878, -3217, 11105, 2421, -752, 1758, 6519 } },
129  { OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XPRO1),
130  0,
131  0,
132  { 10413, -3996, -993, -3721, 11640, 2361, -733, 1540, 6011 } },
133  { OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XPRO2),
134  0,
135  0,
136  { 11434, -4948, -1210, -3746, 12042, 1903, -666, 1479, 5235 } },
137  { OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XA1),
138  0,
139  0,
140  { 11086, -4555, -839, -3512, 11310, 2517, -815, 1341, 5940 } },
141  { OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XA2),
142  0,
143  0,
144  { 10763, -4560, -917, -3346, 11311, 2322, -475, 1135, 5843 } },
145  { OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XE1),
146  0,
147  0,
148  { 10413, -3996, -993, -3721, 11640, 2361, -733, 1540, 6011 } },
149  { OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XE2),
150  0,
151  0,
152  { 8458, -2451, -855, -4597, 12447, 2407, -1475, 2482, 6526 } },
153  { OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XE2S),
154  0,
155  0,
156  { 11562, -5118, -961, -3022, 11007, 2311, -525, 1569, 6097 } },
157  { OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XM1),
158  0,
159  0,
160  { 10413, -3996, -993, -3721, 11640, 2361, -733, 1540, 6011 } },
161  { OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XT1),
162  0,
163  0,
164  { 8458, -2451, -855, -4597, 12447, 2407, -1475, 2482, 6526 } },
165  // From DNG Converter 7.1-rc
166  { OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XS1),
167  0,
168  0,
169  { 13509, -6199, -1254, -4430, 12733, 1865, -331, 1441, 5022 } },
170  { OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XF1),
171  0,
172  0,
173  { 13509, -6199, -1254, -4430, 12733, 1865, -331, 1441, 5022 } },
174  { OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_S200EXR),
175  512,
176  0x3fff,
177  { 11401, -4498, -1312, -5088, 12751, 2613, -838, 1568, 5941 } },
178 
179  { 0, 0, 0, { 0, 0, 0, 0, 0, 0, 0, 0, 0 } }
180 };
181 
182 const RawFile::camera_ids_t RafFile::s_def[] = {
183  { "GFX 50S", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_GFX50S) },
184  { "FinePix F700 ", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_F700) },
185  { "FinePix F810 ", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_F810) },
186  { "FinePix E900 ", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_E900) },
187  { "FinePixS2Pro", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_S2PRO) },
188  { "FinePix S3Pro ", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_S3PRO) },
189  { "FinePix S5Pro ", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_S5PRO) },
190  { "FinePix S5600 ", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_S5600) },
191  { "FinePix S9500 ", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_S9500) },
192  { "FinePix S6500fd", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_S6500FD) },
193  { "FinePix HS10 HS11", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_HS10) },
194  { "FinePix X100", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_X100) },
195  { "X10", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_X10) },
196  { "X20", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_X20) },
197  { "X30", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_X30) },
198  { "X70", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_X70) },
199  { "X-Pro1", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XPRO1) },
200  { "X-Pro2", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XPRO2) },
201  { "X-S1", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XS1) },
202  { "FinePix S200EXR", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_S200EXR) },
203  { "X-A1", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XA1) },
204  { "X-A2", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XA2) },
205  { "X-A3", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XA3) },
206  { "XQ1", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XQ1) },
207  { "X-E1 ", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XE1) },
208  { "X-E2", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XE2) },
209  { "X-E2S", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XE2S) },
210  { "X-M1", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XM1) },
211  { "X-T1", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XT1) },
212  { "X-T10", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XT10) },
213  { "X-T2", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XT2) },
214  { "X-T20", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XT20) },
215  { "XF1", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XF1) },
216  { "X100S", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_X100S) },
217  { "X100T", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_X100T) },
218  { "X100F", OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_X100F) },
219 
220  { nullptr, 0 }
221 };
222 
223 RawFile *RafFile::factory(const IO::Stream::Ptr &s)
224 {
225  return new RafFile(s);
226 }
227 
228 RafFile::RafFile(const IO::Stream::Ptr &s)
229  : RawFile(OR_RAWFILE_TYPE_RAF), m_io(s), m_container(new RafContainer(s))
230 {
231  _setIdMap(s_def);
232  _setMatrices(s_matrices);
233 }
234 
235 RafFile::~RafFile()
236 {
237  delete m_container;
238 }
239 
240 ::or_error RafFile::_enumThumbnailSizes(std::vector<uint32_t> &list)
241 {
242  or_error ret = OR_ERROR_NOT_FOUND;
243 
244  JfifContainer *jpegPreview = m_container->getJpegPreview();
245  if (!jpegPreview) {
246  return OR_ERROR_NOT_FOUND;
247  }
248 
249  uint32_t x, y;
250  if (jpegPreview->getDimensions(x, y)) {
251  uint32_t size = std::max(x, y);
252 
253  list.push_back(size);
254  _addThumbnail(size, ThumbDesc(x, y, OR_DATA_TYPE_JPEG,
255  m_container->getJpegOffset(),
256  m_container->getJpegLength()));
257  ret = OR_ERROR_NONE;
258  }
259  IfdDir::Ref dir = jpegPreview->getIfdDirAt(1);
260  if (!dir) {
261  return ret;
262  }
263 
264  auto result = dir->getIntegerValue(IFD::EXIF_TAG_IMAGE_WIDTH);
265  if (result.ok()) {
266  x = result.unwrap();
267  result = dir->getIntegerValue(IFD::EXIF_TAG_IMAGE_LENGTH);
268  y = result.unwrap_or(0);
269  }
270 
271  if (result.empty()) {
272  result =
273  dir->getValue<uint32_t>(IFD::EXIF_TAG_JPEG_INTERCHANGE_FORMAT);
274  if (result.empty()) {
275  return ret;
276  }
277  uint32_t jpeg_offset = result.unwrap();
278 
279  jpeg_offset += 12; // XXX magic number. eh?
280  // I need to re-read the Exif spec.
281  result = dir->getValue<uint32_t>(IFD::EXIF_TAG_JPEG_INTERCHANGE_FORMAT_LENGTH);
282  if (result.empty()) {
283  return ret;
284  }
285  uint32_t jpeg_size = result.unwrap();
286 
287  IO::Stream::Ptr s(std::make_shared<IO::StreamClone>(jpegPreview->file(),
288  jpeg_offset));
289  std::unique_ptr<JfifContainer> thumb(new JfifContainer(s, 0));
290 
291  if (thumb->getDimensions(x, y)) {
292  uint32_t size = std::max(x, y);
293 
294  list.push_back(size);
295  _addThumbnail(size,
296  ThumbDesc(x, y, OR_DATA_TYPE_JPEG,
297  jpeg_offset + m_container->getJpegOffset(),
298  jpeg_size));
299  ret = OR_ERROR_NONE;
300  }
301  }
302 
303  return ret;
304 }
305 
307 {
308  return m_container;
309 }
310 
311 bool
312 RafFile::isXTrans(RawFile::TypeId type) const
313 {
314  switch (type) {
315  case OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XPRO1):
316  case OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XPRO2):
317  case OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XE1):
318  case OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XE2):
319  case OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XE2S):
320  case OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XM1):
321  case OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XQ1):
322  case OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XT1):
323  case OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XT10):
324  case OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XT2):
325  case OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_XT20):
326  case OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_X100S):
327  case OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_X100T):
328  case OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_X100F):
329  case OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_X20):
330  case OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_X30):
331  case OR_MAKE_FUJIFILM_TYPEID(OR_TYPEID_FUJIFILM_X70):
332  return true;
333 
334  default:
335  return false;
336  }
337 }
338 
339 ::or_error RafFile::_getRawData(RawData &data, uint32_t /*options*/)
340 {
341  ::or_error ret = OR_ERROR_NOT_FOUND;
342 
343  RafMetaContainer *meta = m_container->getMetaContainer();
344  if (!meta) {
345  LOGERR("RAF: Can't get meta container\n");
346  return ret;
347  }
348 
349  RafMetaValue::Ref value = meta->getValue(RAF_TAG_SENSOR_DIMENSION);
350  if (!value) {
351  // use this tag if the other is missing
352  value = meta->getValue(RAF_TAG_IMG_HEIGHT_WIDTH);
353  }
354  uint32_t dims = value->get().getInteger(0);
355  uint16_t h = (dims & 0xFFFF0000) >> 16;
356  uint16_t w = (dims & 0x0000FFFF);
357 
358  value = meta->getValue(RAF_TAG_RAW_INFO);
359  uint32_t rawProps = value->get().getInteger(0);
360  // TODO re-enable if needed.
361  // uint8_t layout = (rawProps & 0xFF000000) >> 24 >> 7; // MSBit in byte.
362  uint8_t compressed = ((rawProps & 0xFF0000) >> 16) & 8; // 8 == compressed
363 
364  // printf("layout %x - compressed %x\n", layout, compressed);
365 
366  data.setDataType(OR_DATA_TYPE_RAW);
367  data.setDimensions(w, h);
368  if (isXTrans(typeId())) {
369  data.setCfaPattern(XTransPattern::xtransPattern());
370  } else {
371  data.setCfaPatternType(OR_CFA_PATTERN_GBRG);
372  }
373  // TODO actually read the 2048.
374  // TODO make sure this work for the other file formats...
375  size_t byte_size = m_container->getCfaLength() - 2048;
376  size_t fetched = 0;
377  off_t offset = m_container->getCfaOffset() + 2048;
378 
379  uint32_t finaldatalen = 2 * h * w;
380  bool is_compressed = byte_size < finaldatalen; //(compressed == 8);
381  uint32_t datalen = (is_compressed ? byte_size : finaldatalen);
382  void *buf = data.allocData(finaldatalen);
383 
384  LOGDBG2("byte_size = %lu finaldatalen = %u compressed = %u", byte_size,
385  finaldatalen, compressed);
386 
387  ret = OR_ERROR_NONE;
388 
389  if (is_compressed) {
390  Unpack unpack(w, IFD::COMPRESS_NONE);
391  size_t blocksize = unpack.block_size();
392  std::unique_ptr<uint8_t[]> block(new uint8_t[blocksize]);
393  uint8_t *outdata = (uint8_t *)data.data();
394  size_t outsize = finaldatalen;
395  size_t got;
396  do {
397  got = m_container->fetchData(block.get(), offset, blocksize);
398  fetched += got;
399  offset += got;
400 
401  if (got) {
402  size_t out;
403  or_error err = unpack.unpack_be12to16(outdata, outsize,
404  block.get(), got, out);
405  outdata += out;
406  outsize -= out;
407  if (err != OR_ERROR_NONE) {
408  LOGDBG2("error is %d\n", static_cast<int>(err));
409  ret = err;
410  break;
411  }
412  }
413  } while ((got != 0) && (fetched < datalen));
414  } else {
415  m_container->fetchData(buf, offset, datalen);
416  }
417 
418  return ret;
419 }
420 
421 MetaValue *RafFile::_getMetaValue(int32_t meta_index)
422 {
423  if (META_INDEX_MASKOUT(meta_index) == META_NS_EXIF ||
424  META_INDEX_MASKOUT(meta_index) == META_NS_TIFF) {
425 
426  JfifContainer *jpegPreview = m_container->getJpegPreview();
427  if (!jpegPreview) {
428  LOGERR("RAF: Can't get JPEG preview\n");
429  return nullptr;
430  }
431 
432  IfdDir::Ref dir = jpegPreview->mainIfd();
433  IfdEntry::Ref e = dir->getEntry(META_NS_MASKOUT(meta_index));
434  if (e) {
435  return e->make_meta_value();
436  }
437  }
438 
439  return nullptr;
440 }
441 
442 void RafFile::_identifyId()
443 {
444  _setTypeId(_typeIdFromModel("FujiFilm", m_container->getModel()));
445 }
446 }
447 }
CIFF is the container for CRW files. It is an attempt from Canon to make this a standard. I guess it failed.
Definition: arwfile.cpp:30
or_error unpack_be12to16(uint8_t *dest, size_t destsize, const uint8_t *src, size_t size, size_t &outsize)
Definition: unpack.cpp:58
virtual ::or_error _getRawData(RawData &data, uint32_t options) override
Definition: raffile.cpp:339
std::shared_ptr< IfdEntry > Ref
Definition: ifdentry.hpp:165
virtual RawContainer * getContainer() const override
Definition: raffile.cpp:306
void setDataType(DataType _type)
Definition: bitmapdata.cpp:100
virtual ::or_error _enumThumbnailSizes(std::vector< uint32_t > &list) override
Definition: raffile.cpp:240
virtual void setDimensions(uint32_t x, uint32_t y) override
Definition: rawdata.cpp:260