Update Ceres to latest upstream version
[blender.git] / extern / libmv / libmv-capi.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (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 Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2011 Blender Foundation.
19  * All rights reserved.
20  *
21  * Contributor(s): Blender Foundation,
22  *                 Sergey Sharybin
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 #ifndef LIBMV_C_API_H
28 #define LIBMV_C_API_H
29
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33
34 struct libmv_Tracks;
35 struct libmv_Reconstruction;
36 struct libmv_Features;
37 struct libmv_CameraIntrinsics;
38
39 /* Logging */
40 void libmv_initLogging(const char *argv0);
41 void libmv_startDebugLogging(void);
42 void libmv_setLoggingVerbosity(int verbosity);
43
44 /* Planar tracker */
45 typedef struct libmv_TrackRegionOptions {
46         int motion_model;
47         int num_iterations;
48         int use_brute;
49         int use_normalization;
50         double minimum_correlation;
51         double sigma;
52         float *image1_mask;
53 } libmv_TrackRegionOptions;
54
55 typedef struct libmv_TrackRegionResult {
56         int termination;
57         const char *termination_reason;
58         double correlation;
59 } libmv_TrackRegionResult;
60
61 int libmv_trackRegion(const libmv_TrackRegionOptions *options,
62                       const float *image1, int image1_width, int image1_height,
63                       const float *image2, int image2_width, int image2_height,
64                       const double *x1, const double *y1,
65                       libmv_TrackRegionResult *result,
66                       double *x2, double *y2);
67 void libmv_samplePlanarPatch(const float *image, int width, int height,
68                              int channels, const double *xs, const double *ys,
69                              int num_samples_x, int num_samples_y,
70                              const float *mask, float *patch,
71                              double *warped_position_x, double *warped_position_y);
72
73 /* Tracks */
74 struct libmv_Tracks *libmv_tracksNew(void);
75 void libmv_tracksDestroy(struct libmv_Tracks *libmv_tracks);
76 void libmv_tracksInsert(struct libmv_Tracks *libmv_tracks, int image, int track, double x, double y, double weight);
77
78 /* Reconstruction */
79 #define LIBMV_REFINE_FOCAL_LENGTH          (1 << 0)
80 #define LIBMV_REFINE_PRINCIPAL_POINT       (1 << 1)
81 #define LIBMV_REFINE_RADIAL_DISTORTION_K1  (1 << 2)
82 #define LIBMV_REFINE_RADIAL_DISTORTION_K2  (1 << 4)
83
84 typedef struct libmv_CameraIntrinsicsOptions {
85         double focal_length;
86         double principal_point_x, principal_point_y;
87         double k1, k2, k3;
88         double p1, p2;
89         int image_width, image_height;
90 } libmv_CameraIntrinsicsOptions;
91
92 typedef struct libmv_ReconstructionOptions {
93         int select_keyframes;
94         int keyframe1, keyframe2;
95
96         int refine_intrinsics;
97 } libmv_ReconstructionOptions;
98
99 typedef void (*reconstruct_progress_update_cb) (void *customdata, double progress, const char *message);
100
101 struct libmv_Reconstruction *libmv_solveReconstruction(const struct libmv_Tracks *libmv_tracks,
102                 const libmv_CameraIntrinsicsOptions *libmv_camera_intrinsics_options,
103                 libmv_ReconstructionOptions *libmv_reconstruction_options,
104                 reconstruct_progress_update_cb progress_update_callback,
105                 void *callback_customdata);
106 struct libmv_Reconstruction *libmv_solveModal(const struct libmv_Tracks *libmv_tracks,
107                 const libmv_CameraIntrinsicsOptions *libmv_camera_intrinsics_options,
108                 const libmv_ReconstructionOptions *libmv_reconstruction_options,
109                 reconstruct_progress_update_cb progress_update_callback,
110                 void *callback_customdata);
111 void libmv_reconstructionDestroy(struct libmv_Reconstruction *libmv_reconstruction);
112 int libmv_reprojectionPointForTrack(const struct libmv_Reconstruction *libmv_reconstruction, int track, double pos[3]);
113 double libmv_reprojectionErrorForTrack(const struct libmv_Reconstruction *libmv_reconstruction, int track);
114 double libmv_reprojectionErrorForImage(const struct libmv_Reconstruction *libmv_reconstruction, int image);
115 int libmv_reprojectionCameraForImage(const struct libmv_Reconstruction *libmv_reconstruction,
116                                      int image, double mat[4][4]);
117 double libmv_reprojectionError(const struct libmv_Reconstruction *libmv_reconstruction);
118 struct libmv_CameraIntrinsics *libmv_reconstructionExtractIntrinsics(struct libmv_Reconstruction *libmv_Reconstruction);
119
120 /* Feature detector */
121 struct libmv_Features *libmv_detectFeaturesFAST(const unsigned char *data, int width, int height, int stride,
122                                                 int margin, int min_trackness, int min_distance);
123 struct libmv_Features *libmv_detectFeaturesMORAVEC(const unsigned char *data, int width, int height, int stride,
124                                                    int margin, int count, int min_distance);
125 void libmv_featuresDestroy(struct libmv_Features *libmv_features);
126 int libmv_countFeatures(const struct libmv_Features *libmv_features);
127 void libmv_getFeature(const struct libmv_Features *libmv_features, int number, double *x, double *y, double *score,
128                       double *size);
129
130 /* Camera intrinsics */
131 struct libmv_CameraIntrinsics *libmv_cameraIntrinsicsNewEmpty(void);
132 struct libmv_CameraIntrinsics *libmv_cameraIntrinsicsNew(
133                 const libmv_CameraIntrinsicsOptions *libmv_camera_intrinsics_options);
134 struct libmv_CameraIntrinsics *libmv_cameraIntrinsicsCopy(const struct libmv_CameraIntrinsics *libmv_intrinsics);
135 void libmv_cameraIntrinsicsDestroy(struct libmv_CameraIntrinsics *libmv_intrinsics);
136 void libmv_cameraIntrinsicsUpdate(const libmv_CameraIntrinsicsOptions *libmv_camera_intrinsics_options,
137                                   struct libmv_CameraIntrinsics *libmv_intrinsics);
138 void libmv_cameraIntrinsicsSetThreads(struct libmv_CameraIntrinsics *libmv_intrinsics, int threads);
139 void libmv_cameraIntrinsicsExtract(const struct libmv_CameraIntrinsics *libmv_intrinsics, double *focal_length,
140                                    double *principal_x, double *principal_y, double *k1, double *k2, double *k3,
141                                    int *width, int *height);
142 void libmv_cameraIntrinsicsUndistortByte(const struct libmv_CameraIntrinsics *libmv_intrinsics,
143                                          unsigned char *src, unsigned char *dst, int width, int height,
144                                          float overscan, int channels);
145 void libmv_cameraIntrinsicsUndistortFloat(const struct libmv_CameraIntrinsics *libmv_intrinsics,
146                                           float *src, float *dst, int width, int height,
147                                           float overscan, int channels);
148 void libmv_cameraIntrinsicsDistortByte(const struct libmv_CameraIntrinsics *libmv_intrinsics,
149                                        unsigned char *src, unsigned char *dst, int width, int height,
150                                        float overscan, int channels);
151 void libmv_cameraIntrinsicsDistortFloat(const struct libmv_CameraIntrinsics *libmv_intrinsics,
152                                         float *src, float *dst, int width, int height,
153                                         float overscan, int channels);
154 void libmv_cameraIntrinsicsApply(const libmv_CameraIntrinsicsOptions *libmv_camera_intrinsics_options,
155                                  double x, double y, double *x1, double *y1);
156 void libmv_cameraIntrinsicsInvert(const libmv_CameraIntrinsicsOptions *libmv_camera_intrinsics_options,
157                                   double x, double y, double *x1, double *y1);
158
159 void libmv_homography2DFromCorrespondencesEuc(double (*x1)[2], double (*x2)[2], int num_points, double H[3][3]);
160
161 #ifdef __cplusplus
162 }
163 #endif
164
165 #endif // LIBMV_C_API_H