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