lensfun  0.2.7.0
lensfun.h
Go to the documentation of this file.
1 /*
2  LensFun - a library for maintaining a database of photographical lenses,
3  and providing the means to correct some of the typical lens distortions.
4  Copyright (C) 2007 by Andrew Zabolotny
5 
6  This library is free software; you can redistribute it and/or
7  modify it under the terms of the GNU Library General Public
8  License as published by the Free Software Foundation; either
9  version 2 of the License, or (at your option) any later version.
10 
11  This library 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 GNU
14  Library General Public License for more details.
15 
16  You should have received a copy of the GNU Library General Public
17  License along with this library; if not, write to the Free
18  Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 */
20 
21 #ifndef __LENSFUN_H__
22 #define __LENSFUN_H__
23 
24 #include <stddef.h>
25 
26 #ifdef __cplusplus
27 extern "C" {
29 # define C_TYPEDEF(t,c)
30 #else
31 # define C_TYPEDEF(t,c) typedef t c c;
32 #endif
33 
39 /*----------------------------------------------------------------------------*/
40 
47 
48 #define LF_VERSION_MAJOR 0
49 
50 #define LF_VERSION_MINOR 2
51 
52 #define LF_VERSION_MICRO 7
53 
54 #define LF_VERSION_BUGFIX 0
55 
56 #define LF_VERSION ((LF_VERSION_MAJOR << 24) | (LF_VERSION_MINOR << 16) | (LF_VERSION_MICRO << 8) | LF_VERSION_BUGFIX)
57 
58 #if defined CONF_LENSFUN_STATIC
59 
60 # define LF_EXPORT
61 #else
62 # ifdef CONF_SYMBOL_VISIBILITY
63 # if defined PLATFORM_WINDOWS
64 # define LF_EXPORT __declspec(dllexport)
65 # elif defined CONF_COMPILER_GCC
66 # define LF_EXPORT __attribute__((visibility("default")))
67 # else
68 # error "I don't know how to change symbol visibility for your compiler"
69 # endif
70 # else
71 # if defined PLATFORM_WINDOWS || defined _MSC_VER
72 # define LF_EXPORT __declspec(dllimport)
73 # else
74 # define LF_EXPORT
75 # endif
76 # endif
77 #endif
78 
80 #define cbool int
81 
90 typedef char *lfMLstr;
91 
93 enum lfError
94 {
99 };
100 
101 C_TYPEDEF (enum, lfError)
102 
103 
111 LF_EXPORT void lf_free (void *data);
112 
119 LF_EXPORT const char *lf_mlstr_get (const lfMLstr str);
120 
136 LF_EXPORT lfMLstr lf_mlstr_add (lfMLstr str, const char *lang, const char *trstr);
137 
145 LF_EXPORT lfMLstr lf_mlstr_dup (const lfMLstr str);
146 
149 /*----------------------------------------------------------------------------*/
150 
167 {
169  lfMLstr Name;
171  char **Compat;
172 
173 #ifdef __cplusplus
174 
177  lfMount ();
178 
182  lfMount &operator = (const lfMount &other);
183 
187  ~lfMount ();
188 
197  void SetName (const char *val, const char *lang = NULL);
198 
204  void AddCompat (const char *val);
205 
211  bool Check ();
212 #endif
213 };
214 
215 C_TYPEDEF (struct, lfMount)
216 
217 
225 
234 LF_EXPORT void lf_mount_destroy (lfMount *mount);
235 
245 LF_EXPORT void lf_mount_copy (lfMount *dest, const lfMount *source);
246 
249 
252 /*----------------------------------------------------------------------------*/
253 
273 {
275  lfMLstr Maker;
277  lfMLstr Model;
279  lfMLstr Variant;
281  char *Mount;
283  float CropFactor;
285  int Score;
286 
287 #ifdef __cplusplus
288 
291  lfCamera ();
292 
296  lfCamera (const lfCamera &other);
297 
301  ~lfCamera ();
302 
306  lfCamera &operator = (const lfCamera &other);
307 
316  void SetMaker (const char *val, const char *lang = NULL);
317 
326  void SetModel (const char *val, const char *lang = NULL);
327 
336  void SetVariant (const char *val, const char *lang = NULL);
337 
343  void SetMount (const char *val);
344 
350  bool Check ();
351 #endif
352 };
353 
354 C_TYPEDEF (struct, lfCamera)
355 
356 
364 
373 LF_EXPORT void lf_camera_destroy (lfCamera *camera);
374 
384 LF_EXPORT void lf_camera_copy (lfCamera *dest, const lfCamera *source);
385 
388 
391 /*----------------------------------------------------------------------------*/
392 
409 {
434 };
435 
437 
438 
444 {
448  float Focal;
450  float Terms [3];
451 };
452 
454 
455 
465 {
475 
483 };
484 
485 C_TYPEDEF (enum, lfTCAModel)
486 
487 
494 {
498  float Focal;
500  float Terms [6];
501 };
502 
503 C_TYPEDEF (struct, lfLensCalibTCA)
504 
505 
517 {
527 };
528 
530 
531 
539 {
543  float Focal;
545  float Aperture;
547  float Distance;
549  float Terms [3];
550 };
551 
553 
554 
558 {
565 };
566 
567 C_TYPEDEF(enum, lfCropMode)
568 
569 
573 {
575  float Focal;
586  float Crop [4];
587 };
588 
589 C_TYPEDEF (struct, lfLensCalibCrop)
590 
591 
595 {
597  float Focal;
604  float FieldOfView;
605 };
606 
607 C_TYPEDEF (struct, lfLensCalibFov)
608 
609 
613 {
615  const char *Name;
617  float Min;
619  float Max;
621  float Default;
622 };
623 
624 C_TYPEDEF (struct, lfParameter)
625 
626 
630 {
655 };
656 
657 C_TYPEDEF (enum, lfLensType)
658 
659 
670 {
672  lfMLstr Maker;
674  lfMLstr Model;
676  float MinFocal;
678  float MaxFocal;
680  float MinAperture;
682  float MaxAperture;
684  char **Mounts;
694  float CenterX;
696  float CenterY;
698  float RedCCI;
700  float GreenCCI;
702  float BlueCCI;
704  float CropFactor;
718  int Score;
719 
720 #ifdef __cplusplus
721 
724  lfLens ();
725 
729  lfLens (const lfLens &other);
730 
734  ~lfLens ();
735 
739  lfLens &operator = (const lfLens &other);
740 
749  void SetMaker (const char *val, const char *lang = NULL);
750 
759  void SetModel (const char *val, const char *lang = NULL);
760 
767  void AddMount (const char *val);
768 
776  void AddCalibDistortion (const lfLensCalibDistortion *dc);
777 
783  bool RemoveCalibDistortion (int idx);
784 
792  void AddCalibTCA (const lfLensCalibTCA *tcac);
793 
799  bool RemoveCalibTCA (int idx);
800 
808  void AddCalibVignetting (const lfLensCalibVignetting *vc);
809 
815  bool RemoveCalibVignetting (int idx);
816 
824  void AddCalibCrop (const lfLensCalibCrop *cc);
825 
831  bool RemoveCalibCrop (int idx);
832 
840  void AddCalibFov (const lfLensCalibFov *cf);
841 
847  bool RemoveCalibFov (int idx);
848 
856  void GuessParameters ();
857 
863  bool Check ();
864 
880  static const char *GetDistortionModelDesc (
881  lfDistortionModel model, const char **details, const lfParameter ***params);
897  static const char *GetTCAModelDesc (
898  lfTCAModel model, const char **details, const lfParameter ***params);
899 
915  static const char *GetVignettingModelDesc (
916  lfVignettingModel model, const char **details, const lfParameter ***params);
917 
933  static const char *GetCropDesc (
934  lfCropMode mode, const char **details, const lfParameter ***params);
935 
947  static const char *GetLensTypeDesc (lfLensType type, const char **details);
948 
956  bool InterpolateDistortion (float focal, lfLensCalibDistortion &res) const;
957 
965  bool InterpolateTCA (float focal, lfLensCalibTCA &res) const;
966 
979  bool InterpolateVignetting (
980  float focal, float aperture, float distance, lfLensCalibVignetting &res) const;
981 
989  bool InterpolateCrop (float focal, lfLensCalibCrop &res) const;
990 
998  bool InterpolateFov (float focal, lfLensCalibFov &res) const;
999 #endif
1000 };
1001 
1002 C_TYPEDEF (struct, lfLens)
1003 
1004 
1012 
1021 LF_EXPORT void lf_lens_destroy (lfLens *lens);
1022 
1032 LF_EXPORT void lf_lens_copy (lfLens *dest, const lfLens *source);
1033 
1036 
1039 
1042  enum lfDistortionModel model, const char **details, const lfParameter ***params);
1043 
1045 LF_EXPORT const char *lf_get_tca_model_desc (
1046  enum lfTCAModel model, const char **details, const lfParameter ***params);
1047 
1050  enum lfVignettingModel model, const char **details, const lfParameter ***params);
1051 
1053 LF_EXPORT const char *lf_get_crop_desc (
1054  enum lfCropMode mode, const char **details, const lfParameter ***params);
1055 
1057 LF_EXPORT const char *lf_get_lens_type_desc (
1058  enum lfLensType type, const char **details);
1059 
1061 LF_EXPORT cbool lf_lens_interpolate_distortion (const lfLens *lens, float focal,
1062  lfLensCalibDistortion *res);
1063 
1065 LF_EXPORT cbool lf_lens_interpolate_tca (const lfLens *lens, float focal, lfLensCalibTCA *res);
1066 
1068 LF_EXPORT cbool lf_lens_interpolate_vignetting (const lfLens *lens, float focal, float aperture,
1069  float distance, lfLensCalibVignetting *res);
1070 
1072 LF_EXPORT cbool lf_lens_interpolate_crop (const lfLens *lens, float focal,
1073  lfLensCalibCrop *res);
1074 
1076 LF_EXPORT cbool lf_lens_interpolate_fov (const lfLens *lens, float focal,
1077  lfLensCalibFov *res);
1078 
1081 
1084 
1086 LF_EXPORT void lf_lens_add_calib_tca (lfLens *lens, const lfLensCalibTCA *tcac);
1087 
1090 
1093 
1096 
1098 LF_EXPORT void lf_lens_add_calib_crop (lfLens *lens, const lfLensCalibCrop *cc);
1099 
1102 
1104 LF_EXPORT void lf_lens_add_calib_fov (lfLens *lens, const lfLensCalibFov *cf);
1105 
1108 
1111 /*----------------------------------------------------------------------------*/
1112 
1122 enum
1123 {
1130 };
1131 
1155 {
1158 
1159 #ifdef __cplusplus
1160 
1163  static lfDatabase *Create ();
1164 
1168  void Destroy ();
1169 
1178  lfError Load ();
1179 
1191  lfError Load (const char *filename);
1192 
1206  lfError Load (const char *errcontext, const char *data, size_t data_size);
1207 
1215  lfError Save (const char *filename) const;
1216 
1230  lfError Save (const char *filename,
1231  const lfMount *const *mounts,
1232  const lfCamera *const *cameras,
1233  const lfLens *const *lenses) const;
1234 
1247  static char *Save (const lfMount *const *mounts,
1248  const lfCamera *const *cameras,
1249  const lfLens *const *lenses);
1250 
1274  const lfCamera **FindCameras (const char *maker, const char *model) const;
1275 
1295  const lfCamera **FindCamerasExt (const char *maker, const char *model,
1296  int sflags = 0) const;
1297 
1305  const lfCamera *const *GetCameras () const;
1306 
1343  const lfLens **FindLenses (const lfCamera *camera, const char *maker,
1344  const char *model, int sflags = 0) const;
1345 
1363  const lfLens **FindLenses (const lfLens *lens, int sflags = 0) const;
1364 
1372  const lfLens *const *GetLenses () const;
1373 
1381  const lfMount *FindMount (const char *mount) const;
1382 
1390  const char *MountName (const char *mount) const;
1391 
1399  const lfMount *const *GetMounts () const;
1400 
1401 protected:
1402  /* Prevent user from creating and destroying such objects */
1403  lfDatabase () {}
1404  ~lfDatabase () {}
1405 #endif
1406 };
1407 
1408 C_TYPEDEF (struct, lfDatabase)
1409 
1410 
1420 
1430 
1433 
1435 LF_EXPORT lfError lf_db_load_file (lfDatabase *db, const char *filename);
1436 
1438 LF_EXPORT lfError lf_db_load_data (lfDatabase *db, const char *errcontext,
1439  const char *data, size_t data_size);
1440 
1442 LF_EXPORT lfError lf_db_save_all (const lfDatabase *db, const char *filename);
1443 
1445 LF_EXPORT lfError lf_db_save_file (const lfDatabase *db, const char *filename,
1446  const lfMount *const *mounts,
1447  const lfCamera *const *cameras,
1448  const lfLens *const *lenses);
1449 
1451 LF_EXPORT char *lf_db_save (const lfMount *const *mounts,
1452  const lfCamera *const *cameras,
1453  const lfLens *const *lenses);
1454 
1457  const lfDatabase *db, const char *maker, const char *model);
1458 
1461  const lfDatabase *db, const char *maker, const char *model, int sflags);
1462 
1464 LF_EXPORT const lfCamera *const *lf_db_get_cameras (const lfDatabase *db);
1465 
1468  const lfDatabase *db, const lfCamera *camera, const char *maker,
1469  const char *lens, int sflags);
1470 
1473  const lfDatabase *db, const lfLens *lens, int sflags);
1474 
1476 LF_EXPORT const lfLens *const *lf_db_get_lenses (const lfDatabase *db);
1477 
1479 LF_EXPORT const lfMount *lf_db_find_mount (const lfDatabase *db, const char *mount);
1480 
1482 LF_EXPORT const char *lf_db_mount_name (const lfDatabase *db, const char *mount);
1483 
1485 LF_EXPORT const lfMount *const *lf_db_get_mounts (const lfDatabase *db);
1486 
1489 /*----------------------------------------------------------------------------*/
1490 
1499 enum
1500 {
1502  LF_MODIFY_TCA = 0x00000001,
1504  LF_MODIFY_VIGNETTING = 0x00000002,
1506  LF_MODIFY_CCI = 0x00000004,
1508  LF_MODIFY_DISTORTION = 0x00000008,
1510  LF_MODIFY_GEOMETRY = 0x00000010,
1512  LF_MODIFY_SCALE = 0x00000020,
1515 };
1516 
1519 {
1530 };
1531 
1532 C_TYPEDEF (enum, lfPixelFormat)
1533 
1534 
1536 {
1559 };
1560 
1561 C_TYPEDEF (enum, lfComponentRole)
1562 
1563 
1564 #define LF_CR_1(a) (LF_CR_ ## a)
1565 
1566 #define LF_CR_2(a,b) ((LF_CR_ ## a) | ((LF_CR_ ## b) << 4))
1567 
1568 #define LF_CR_3(a,b,c) ((LF_CR_ ## a) | ((LF_CR_ ## b) << 4) | \
1569  ((LF_CR_ ## c) << 8))
1570 
1571 #define LF_CR_4(a,b,c,d) ((LF_CR_ ## a) | ((LF_CR_ ## b) << 4) | \
1572  ((LF_CR_ ## c) << 8) | ((LF_CR_ ## d) << 12))
1573 
1574 #define LF_CR_5(a,b,c,d,e) ((LF_CR_ ## a) | ((LF_CR_ ## b) << 4) | \
1575  ((LF_CR_ ## c) << 8) | ((LF_CR_ ## d) << 12) | \
1576  ((LF_CR_ ## e) << 16))
1577 
1578 #define LF_CR_6(a,b,c,d,e,f) ((LF_CR_ ## a) | ((LF_CR_ ## b) << 4) | \
1579  ((LF_CR_ ## c) << 8) | ((LF_CR_ ## d) << 12) | \
1580  ((LF_CR_ ## e) << 16) | ((LF_CR_ ## f) << 20))
1581 
1582 #define LF_CR_7(a,b,c,d,e,f,g) ((LF_CR_ ## a) | ((LF_CR_ ## b) << 4) | \
1583  ((LF_CR_ ## c) << 8) | ((LF_CR_ ## d) << 12) | \
1584  ((LF_CR_ ## e) << 16) | ((LF_CR_ ## f) << 20) | \
1585  ((LF_CR_ ## g) << 24))
1586 
1587 #define LF_CR_8(a,b,c,d,e,f,g,h) ((LF_CR_ ## a) | ((LF_CR_ ## b) << 4) | \
1588  ((LF_CR_ ## c) << 8) | ((LF_CR_ ## d) << 12) | \
1589  ((LF_CR_ ## e) << 16) | ((LF_CR_ ## f) << 20) | \
1590  ((LF_CR_ ## g) << 24) | ((LF_CR_ ## h) << 28))
1591 
1606 typedef void (*lfSubpixelCoordFunc) (void *data, float *iocoord, int count);
1607 
1631 typedef void (*lfModifyColorFunc) (void *data, float x, float y,
1632  void *pixels, int comp_role, int count);
1633 
1645 typedef void (*lfModifyCoordFunc) (void *data, float *iocoord, int count);
1646 
1707 {
1708 #ifdef __cplusplus
1709 
1729  static lfModifier *Create (const lfLens *lens, float crop, int width, int height);
1730 
1771  int Initialize (
1772  const lfLens *lens, lfPixelFormat format, float focal, float aperture,
1773  float distance, float scale, lfLensType targeom, int flags, bool reverse);
1774 
1779  void Destroy ();
1780 
1797  void AddCoordCallback (lfModifyCoordFunc callback, int priority,
1798  void *data, size_t data_size);
1799 
1817  void AddSubpixelCallback (lfSubpixelCoordFunc callback, int priority,
1818  void *data, size_t data_size);
1819 
1836  void AddColorCallback (lfModifyColorFunc callback, int priority,
1837  void *data, size_t data_size);
1838 
1852  bool AddSubpixelCallbackTCA (lfLensCalibTCA &model, bool reverse = false);
1853 
1868  bool AddColorCallbackVignetting (lfLensCalibVignetting &model, lfPixelFormat format,
1869  bool reverse = false);
1870 
1885  bool AddColorCallbackCCI (const lfLens *lens, lfPixelFormat format,
1886  bool reverse = false);
1887 
1900  bool AddCoordCallbackDistortion (lfLensCalibDistortion &model, bool reverse = false);
1901 
1914  bool AddCoordCallbackGeometry (lfLensType from, lfLensType to, float focal);
1915 
1931  bool AddCoordCallbackScale (float scale, bool reverse = false);
1932 
1945  float GetAutoScale (bool reverse);
1946 
1975  bool ApplySubpixelDistortion (float xu, float yu, int width, int height,
1976  float *res) const;
1977 
2006  bool ApplyColorModification (void *pixels, float x, float y, int width, int height,
2007  int comp_role, int row_stride) const;
2008 
2035  bool ApplyGeometryDistortion (float xu, float yu, int width, int height,
2036  float *res) const;
2037 
2065  bool ApplySubpixelGeometryDistortion (float xu, float yu, int width, int height,
2066  float *res) const;
2067 
2068 protected:
2069  /* Prevent user from creating and destroying such objects */
2070  lfModifier () {}
2071  ~lfModifier () {}
2072 #elif defined _MSC_VER
2073  /* Sucks, like always */
2074  void *dummy;
2075 #endif
2076 };
2077 
2078 C_TYPEDEF (struct, lfModifier)
2079 
2080 
2082  const lfLens *lens, float crop, int width, int height);
2083 
2085 LF_EXPORT void lf_modifier_destroy (lfModifier *modifier);
2086 
2089  lfModifier *modifier, const lfLens *lens, lfPixelFormat format,
2090  float focal, float aperture, float distance, float scale,
2091  lfLensType targeom, int flags, cbool reverse);
2092 
2095  lfModifier *modifier, lfModifyCoordFunc callback, int priority,
2096  void *data, size_t data_size);
2097 
2100  lfModifier *modifier, lfSubpixelCoordFunc callback, int priority,
2101  void *data, size_t data_size);
2102 
2105  lfModifier *modifier, lfModifyColorFunc callback, int priority,
2106  void *data, size_t data_size);
2107 
2110  lfModifier *modifier, lfLensCalibTCA *model, cbool reverse);
2111 
2114  lfModifier *modifier, lfLensCalibVignetting *model,
2115  lfPixelFormat format, cbool reverse);
2116 
2119  lfModifier *modifier, const lfLens *lens,
2120  lfPixelFormat format, cbool reverse);
2121 
2124  lfModifier *modifier, lfLensCalibDistortion *model, cbool reverse);
2125 
2128  lfModifier *modifier, lfLensType from, lfLensType to, float focal);
2129 
2132  lfModifier *modifier, float scale, cbool reverse);
2133 
2136  lfModifier *modifier, cbool reverse);
2137 
2140  lfModifier *modifier, float xu, float yu, int width, int height, float *res);
2141 
2144  lfModifier *modifier, void *pixels, float x, float y, int width, int height,
2145  int comp_role, int row_stride);
2146 
2149  lfModifier *modifier, float xu, float yu, int width, int height, float *res);
2150 
2153  lfModifier *modifier, float xu, float yu, int width, int height, float *res);
2154 
2157 #undef cbool
2158 
2159 #ifdef __cplusplus
2160 }
2161 #endif
2162 
2163 #endif /* __LENSFUN_H__ */