code cleanup: remove unused and unsupported functions from libmv-capi
[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 /* TrackRegion (new planar tracker) */
45 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 };
54
55 struct libmv_trackRegionResult {
56         int termination;
57         const char *termination_reason;
58         double correlation;
59 };
60
61 int libmv_trackRegion(const struct 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                       struct libmv_trackRegionResult *result,
66                       double *x2, double *y2);
67
68 void libmv_samplePlanarPatch(const float *image, int width, int height,
69                              int channels, const double *xs, const double *ys,
70                              int num_samples_x, int num_samples_y,
71                              const float *mask, float *patch,
72                              double *warped_position_x, double *warped_position_y);
73
74 /* Tracks */
75 struct libmv_Tracks *libmv_tracksNew(void);
76 void libmv_tracksInsert(struct libmv_Tracks *libmv_tracks, int image, int track, double x, double y);
77 void libmv_tracksDestroy(struct libmv_Tracks *libmv_tracks);
78
79 /* Reconstruction solver */
80
81 #define LIBMV_REFINE_FOCAL_LENGTH          (1 << 0)
82 #define LIBMV_REFINE_PRINCIPAL_POINT       (1 << 1)
83 #define LIBMV_REFINE_RADIAL_DISTORTION_K1  (1 << 2)
84 #define LIBMV_REFINE_RADIAL_DISTORTION_K2  (1 << 4)
85
86 typedef struct libmv_cameraIntrinsicsOptions {
87         double focal_length;
88         double principal_point_x, principal_point_y;
89         double k1, k2, k3;
90         double p1, p2;
91         int image_width, image_height;
92 } libmv_cameraIntrinsicsOptions;
93
94 typedef struct libmv_reconstructionOptions {
95         int keyframe1, keyframe2;
96         int refine_intrinsics;
97
98         double success_threshold;
99         int use_fallback_reconstruction;
100 } libmv_reconstructionOptions;
101
102 typedef void (*reconstruct_progress_update_cb) (void *customdata, double progress, const char *message);
103
104 int libmv_refineParametersAreValid(int parameters);
105
106 struct libmv_Reconstruction *libmv_solveReconstruction(struct libmv_Tracks *libmv_tracks,
107                         libmv_cameraIntrinsicsOptions *libmv_camera_intrinsics_options,
108                         libmv_reconstructionOptions *libmv_reconstruction_options,
109                         reconstruct_progress_update_cb progress_update_callback,
110                         void *callback_customdata);
111 struct libmv_Reconstruction *libmv_solveModal(struct libmv_Tracks *libmv_tracks,
112                         libmv_cameraIntrinsicsOptions *libmv_camera_intrinsics_options,
113                         reconstruct_progress_update_cb progress_update_callback,
114                         void *callback_customdata);
115 int libmv_reporojectionPointForTrack(struct libmv_Reconstruction *libmv_reconstruction, int track, double pos[3]);
116 double libmv_reporojectionErrorForTrack(struct libmv_Reconstruction *libmv_reconstruction, int track);
117 double libmv_reporojectionErrorForImage(struct libmv_Reconstruction *libmv_reconstruction, int image);
118 int libmv_reporojectionCameraForImage(struct libmv_Reconstruction *libmv_reconstruction, int image, double mat[4][4]);
119 double libmv_reprojectionError(struct libmv_Reconstruction *libmv_reconstruction);
120 void libmv_destroyReconstruction(struct libmv_Reconstruction *libmv_reconstruction);
121
122 /* feature detector */
123 struct libmv_Features *libmv_detectFeaturesFAST(unsigned char *data, int width, int height, int stride,
124                         int margin, int min_trackness, int min_distance);
125 struct libmv_Features *libmv_detectFeaturesMORAVEC(unsigned char *data, int width, int height, int stride,
126                         int margin, int count, int min_distance);
127 int libmv_countFeatures(struct libmv_Features *libmv_features);
128 void libmv_getFeature(struct libmv_Features *libmv_features, int number, double *x, double *y, double *score, double *size);
129 void libmv_destroyFeatures(struct libmv_Features *libmv_features);
130
131 /* camera intrinsics */
132 struct libmv_CameraIntrinsics *libmv_ReconstructionExtractIntrinsics(struct libmv_Reconstruction *libmv_Reconstruction);
133
134 struct libmv_CameraIntrinsics *libmv_CameraIntrinsicsNew(libmv_cameraIntrinsicsOptions *libmv_camera_intrinsics_options);
135
136 struct libmv_CameraIntrinsics *libmv_CameraIntrinsicsCopy(struct libmv_CameraIntrinsics *libmv_intrinsics);
137
138 void libmv_CameraIntrinsicsDestroy(struct libmv_CameraIntrinsics *libmv_intrinsics);
139
140 void libmv_CameraIntrinsicsUpdate(struct libmv_CameraIntrinsics *libmv_intrinsics,
141                                   libmv_cameraIntrinsicsOptions *libmv_camera_intrinsics_options);
142
143 void libmv_CameraIntrinsicsExtract(struct libmv_CameraIntrinsics *libmv_intrinsics, double *focal_length,
144                         double *principal_x, double *principal_y, double *k1, double *k2, double *k3, int *width, int *height);
145
146 void libmv_CameraIntrinsicsUndistortByte(struct libmv_CameraIntrinsics *libmv_intrinsics,
147                         unsigned char *src, unsigned char *dst, int width, int height, float overscan, int channels);
148
149 void libmv_CameraIntrinsicsUndistortFloat(struct libmv_CameraIntrinsics *libmv_intrinsics,
150                         float *src, float *dst, int width, int height, float overscan, int channels);
151
152 void libmv_CameraIntrinsicsDistortByte(struct libmv_CameraIntrinsics *libmv_intrinsics,
153                         unsigned char *src, unsigned char *dst, int width, int height, float overscan, int channels);
154
155 void libmv_CameraIntrinsicsDistortFloat(struct libmv_CameraIntrinsics *libmv_intrinsics,
156                         float *src, float *dst, int width, int height, float overscan, int channels);
157
158 /* utils */
159 void libmv_applyCameraIntrinsics(libmv_cameraIntrinsicsOptions *libmv_camera_intrinsics_options,
160                         double x, double y, double *x1, double *y1);
161 void libmv_InvertIntrinsics(libmv_cameraIntrinsicsOptions *libmv_camera_intrinsics_options,
162                         double x, double y, double *x1, double *y1);
163
164 /* point clouds */
165 void libmv_rigidRegistration(float (*reference_points)[3], float (*points)[3], int total_points,
166                              int use_scale, int use_translation, double M[4][4]);
167
168 #ifdef __cplusplus
169 }
170 #endif
171
172 #endif // LIBMV_C_API_H