d3f02f99e517ad0328147ac3e03607534a22b30b
[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_RegionTracker;
35 struct libmv_Tracks;
36 struct libmv_Reconstruction;
37 struct libmv_Features;
38 struct libmv_CameraIntrinsics;
39
40 /* Logging */
41 void libmv_initLogging(const char *argv0);
42 void libmv_startDebugLogging(void);
43 void libmv_setLoggingVerbosity(int verbosity);
44
45 /* RegionTracker */
46 struct libmv_RegionTracker *libmv_pyramidRegionTrackerNew(int max_iterations, int pyramid_level, int half_window_size, double minimum_correlation);
47 struct libmv_RegionTracker *libmv_hybridRegionTrackerNew(int max_iterations, int half_window_size, double minimum_correlation);
48 struct libmv_RegionTracker *libmv_bruteRegionTrackerNew(int half_window_size, double minimum_correlation);
49 int libmv_regionTrackerTrack(struct libmv_RegionTracker *libmv_tracker, const float *ima1, const float *ima2,
50                         int width, int height, double  x1, double  y1, double *x2, double *y2);
51 void libmv_regionTrackerDestroy(struct libmv_RegionTracker *libmv_tracker);
52
53 /* TrackRegion (new planar tracker) */
54 struct libmv_trackRegionOptions {
55   int motion_model;
56   int num_iterations;
57   double minimum_correlation;
58   double sigma;
59 };
60 struct libmv_trackRegionResult {
61   int termination;
62   const char *termination_reason;
63   double correlation;
64 };
65 int libmv_trackRegion(const struct libmv_trackRegionOptions *options,
66                       const float *image1, const float *image2,
67                       int width, int height, 
68                       const double *x1, const double *y1,
69                       struct libmv_trackRegionResult *result,
70                       double *x2, double *y2);
71
72 /* Tracks */
73 struct libmv_Tracks *libmv_tracksNew(void);
74 void libmv_tracksInsert(struct libmv_Tracks *libmv_tracks, int image, int track, double x, double y);
75 void libmv_tracksDestroy(struct libmv_Tracks *libmv_tracks);
76
77 /* Reconstruction solver */
78 #define LIBMV_REFINE_FOCAL_LENGTH       (1<<0)
79 #define LIBMV_REFINE_PRINCIPAL_POINT    (1<<1)
80 #define LIBMV_REFINE_RADIAL_DISTORTION_K1 (1<<2)
81 #define LIBMV_REFINE_RADIAL_DISTORTION_K2 (1<<4)
82
83 typedef void (*reconstruct_progress_update_cb) (void *customdata, double progress, const char *message);
84
85 int libmv_refineParametersAreValid(int parameters);
86
87 struct libmv_Reconstruction *libmv_solveReconstruction(struct libmv_Tracks *tracks, int keyframe1, int keyframe2,
88                         int refine_intrinsics, double focal_length, double principal_x, double principal_y, double k1, double k2, double k3,
89                         reconstruct_progress_update_cb progress_update_callback, void *callback_customdata);
90 struct libmv_Reconstruction *libmv_solveModal(struct libmv_Tracks *tracks, double focal_length,
91                         double principal_x, double principal_y, double k1, double k2, double k3,
92                         reconstruct_progress_update_cb progress_update_callback, void *callback_customdata);
93 int libmv_reporojectionPointForTrack(struct libmv_Reconstruction *libmv_reconstruction, int track, double pos[3]);
94 double libmv_reporojectionErrorForTrack(struct libmv_Reconstruction *libmv_reconstruction, int track);
95 double libmv_reporojectionErrorForImage(struct libmv_Reconstruction *libmv_reconstruction, int image);
96 int libmv_reporojectionCameraForImage(struct libmv_Reconstruction *libmv_reconstruction, int image, double mat[4][4]);
97 double libmv_reprojectionError(struct libmv_Reconstruction *libmv_reconstruction);
98 void libmv_destroyReconstruction(struct libmv_Reconstruction *libmv_reconstruction);
99
100 /* feature detector */
101 struct libmv_Features *libmv_detectFeaturesFAST(unsigned char *data, int width, int height, int stride,
102                         int margin, int min_trackness, int min_distance);
103 struct libmv_Features *libmv_detectFeaturesMORAVEC(unsigned char *data, int width, int height, int stride,
104                         int margin, int count, int min_distance);
105 int libmv_countFeatures(struct libmv_Features *libmv_features);
106 void libmv_getFeature(struct libmv_Features *libmv_features, int number, double *x, double *y, double *score, double *size);
107 void libmv_destroyFeatures(struct libmv_Features *libmv_features);
108
109 /* camera intrinsics */
110 struct libmv_CameraIntrinsics *libmv_ReconstructionExtractIntrinsics(struct libmv_Reconstruction *libmv_Reconstruction);
111
112 struct libmv_CameraIntrinsics *libmv_CameraIntrinsicsNew(double focal_length, double principal_x, double principal_y,
113                         double k1, double k2, double k3, int width, int height);
114
115 struct libmv_CameraIntrinsics *libmv_CameraIntrinsicsCopy(struct libmv_CameraIntrinsics *libmvIntrinsics);
116
117 void libmv_CameraIntrinsicsDestroy(struct libmv_CameraIntrinsics *libmvIntrinsics);
118
119 void libmv_CameraIntrinsicsUpdate(struct libmv_CameraIntrinsics *libmvIntrinsics, double focal_length,
120                         double principal_x, double principal_y, double k1, double k2, double k3, int width, int height);
121
122 void libmv_CameraIntrinsicsExtract(struct libmv_CameraIntrinsics *libmvIntrinsics, double *focal_length,
123                         double *principal_x, double *principal_y, double *k1, double *k2, double *k3, int *width, int *height);
124
125 void libmv_CameraIntrinsicsUndistortByte(struct libmv_CameraIntrinsics *libmvIntrinsics,
126                         unsigned char *src, unsigned char *dst, int width, int height, float overscan, int channels);
127
128 void libmv_CameraIntrinsicsUndistortFloat(struct libmv_CameraIntrinsics *libmvIntrinsics,
129                         float *src, float *dst, int width, int height, float overscan, int channels);
130
131 void libmv_CameraIntrinsicsDistortByte(struct libmv_CameraIntrinsics *libmvIntrinsics,
132                         unsigned char *src, unsigned char *dst, int width, int height, float overscan, int channels);
133
134 void libmv_CameraIntrinsicsDistortFloat(struct libmv_CameraIntrinsics *libmvIntrinsics,
135                         float *src, float *dst, int width, int height, float overscan, int channels);
136
137 /* dsitortion */
138 void libmv_undistortByte(double focal_length, double principal_x, double principal_y, double k1, double k2, double k3,
139                         unsigned char *src, unsigned char *dst, int width, int height, int channels);
140 void libmv_undistortFloat(double focal_length, double principal_x, double principal_y, double k1, double k2, double k3,
141                         float *src, float *dst, int width, int height, int channels);
142
143 void libmv_distortByte(double focal_length, double principal_x, double principal_y, double k1, double k2, double k3,
144                         unsigned char *src, unsigned char *dst, int width, int height, int channels);
145 void libmv_distortFloat(double focal_length, double principal_x, double principal_y, double k1, double k2, double k3,
146                         float *src, float *dst, int width, int height, int channels);
147
148 /* utils */
149 void libmv_applyCameraIntrinsics(double focal_length, double principal_x, double principal_y, double k1, double k2, double k3,
150                         double x, double y, double *x1, double *y1);
151 void libmv_InvertIntrinsics(double focal_length, double principal_x, double principal_y, double k1, double k2, double k3,
152                         double x, double y, double *x1, double *y1);
153
154 /* point clouds */
155 void libmv_rigidRegistration(float (*reference_points)[3], float (*points)[3], int total_points,
156                              int use_scale, int use_translation, double M[4][4]);
157
158 #ifdef __cplusplus
159 }
160 #endif
161
162 #endif // LIBMV_C_API_H