6f2e017b1f11367eeef4641bed05ae2bbf839369
[blender.git] / source / blender / makesdna / DNA_tracking_types.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  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Blender Foundation,
24  *                 Sergey Sharybin
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 /** \file DNA_tracking_types.h
30  *  \ingroup DNA
31  *  \since may-2011
32  *  \author Sergey Sharybin
33  */
34
35 #ifndef __DNA_TRACKING_TYPES_H__
36 #define __DNA_TRACKING_TYPES_H__
37
38 #include "DNA_defs.h"
39 #include "DNA_listBase.h"
40
41 /* match-moving data */
42
43 struct bGPdata;
44 struct ImBuf;
45 struct MovieReconstructedCamera;
46 struct MovieTrackingCamera;
47 struct MovieTrackingBundle;
48 struct MovieTrackingMarker;
49 struct MovieTrackingTrack;
50 struct MovieTracking;
51
52 typedef struct MovieReconstructedCamera {
53         int framenr;
54         float error;
55         float mat[4][4];
56 } MovieReconstructedCamera;
57
58 typedef struct MovieTrackingCamera {
59         void *intrinsics;       /* intrinsics handle */
60
61         float sensor_width;     /* width of CCD sensor */
62         float pixel_aspect;     /* pixel aspect ratio */
63         float pad;
64         float focal;            /* focal length */
65         short units;            /* units of focal length user is working with */
66         short pad1;
67         float principal[2];     /* principal point */
68         float k1, k2, k3;       /* radial distortion */
69 } MovieTrackingCamera;
70
71 typedef struct MovieTrackingMarker {
72         float pos[2];   /* 2d position of marker on frame (in unified 0..1 space) */
73
74         /* corners of pattern in the following order:
75          *
76          *       Y
77          *       ^
78          *       | (3) --- (2)
79          *       |  |       |
80          *       |  |       |
81          *       |  |       |
82          *       | (0) --- (1)
83          *       +-------------> X
84      *
85      * the coordinates are stored relative to pos.
86          */
87         float pattern_corners[4][2];
88
89         int framenr;    /* number of frame marker is associated with */
90         int flag;               /* Marker's flag (alive, ...) */
91 } MovieTrackingMarker;
92
93 typedef struct MovieTrackingTrack {
94         struct MovieTrackingTrack *next, *prev;
95
96         char name[64];  /* MAX_NAME */
97
98         /* ** setings ** */
99
100         /* positions of left-bottom and right-top corners of pattern (in unified 0..1 units, relative to marker->pos) */
101         float pat_min[2], pat_max[2]            DNA_DEPRECATED;
102
103         /* positions of left-bottom and right-top corners of search area (in unified 0..1 units, relative to marker->pos */
104         float search_min[2], search_max[2];
105
106         float offset[2];                                        /* offset to "parenting" point */
107
108         /* ** track ** */
109         int markersnr;                                  /* count of markers in track */
110         int last_marker;                                /* most recently used marker */
111         MovieTrackingMarker *markers;   /* markers in track */
112
113         /* ** reconstruction data ** */
114         float bundle_pos[3];                    /* reconstructed position */
115         float error;                                    /* average track reprojection error */
116
117         /* ** UI editing ** */
118         int flag, pat_flag, search_flag;        /* flags (selection, ...) */
119         float color[3];                                         /* custom color for track */
120
121         /* tracking algorithm to use; can be KLT or SAD */
122         short frames_limit;             /* number of frames to be tarcked during single tracking session (if TRACKING_FRAMES_LIMIT is set) */
123         short margin;                   /* margin from frame boundaries */
124         short pattern_match;    /* re-adjust every N frames */
125
126         short tracker;                  /* tracking algorithm used for this track */
127
128         /* ** KLT tracker settings ** */
129         short pyramid_levels, pad2;             /* number of pyramid levels to use for KLT tracking */
130
131         /* ** SAD tracker settings ** */
132         float minimum_correlation;                      /* minimal correlation which is still treated as successful tracking */
133
134         struct bGPdata *gpd;            /* grease-pencil data */
135 } MovieTrackingTrack;
136
137 typedef struct MovieTrackingSettings {
138         int flag;
139
140         /* ** default tracker settings */
141         short default_tracker;                          /* tracking algorithm used by default */
142         short default_pyramid_levels;           /* number of pyramid levels to use for KLT tracking */
143         float default_minimum_correlation;      /* minimal correlation which is still treated as successful tracking */
144         short default_pattern_size;                     /* size of pattern area for new tracks */
145         short default_search_size;                      /* size of search area for new tracks */
146         short default_frames_limit;                     /* number of frames to be tarcked during single tracking session (if TRACKING_FRAMES_LIMIT is set) */
147         short default_margin;                           /* margin from frame boundaries */
148         short default_pattern_match;            /* re-adjust every N frames */
149         short default_flag;                                     /* default flags like color channels used by default */
150
151         short motion_flag;              /* flags describes motion type */
152
153         /* ** common tracker settings ** */
154         short speed;                    /* speed of tracking */
155
156         /* ** reconstruction settings ** */
157         int keyframe1, keyframe2;       /* two keyframes for reconstrution initialization */
158
159         /* which camera intrinsics to refine. uses on the REFINE_* flags */
160         short refine_camera_intrinsics, pad2;
161
162         /* ** tool settings ** */
163
164         /* set scale */
165         float dist;                                     /* distance between two bundles used for scene scaling */
166
167         /* cleanup */
168         int clean_frames, clean_action;
169         float clean_error;
170
171         /* set object scale */
172         float object_distance;          /* distance between two bundles used for object scaling */
173
174         int pad3;
175 } MovieTrackingSettings;
176
177 typedef struct MovieTrackingStabilization {
178         int flag;
179         int tot_track, act_track;               /* total number and index of active track in list */
180
181         /* 2d stabilization */
182         float maxscale;                 /* max auto-scale factor */
183         MovieTrackingTrack *rot_track;  /* track used to stabilize rotation */
184
185         float locinf, scaleinf, rotinf; /* influence on location, scale and rotation */
186
187         int filter;             /* filter used for pixel interpolation */
188
189         /* some pre-computing run-time variables */
190         int ok;                                         /* are precomputed values and scaled buf relevant? */
191         float scale;                            /* autoscale factor */
192
193         struct ImBuf *scaleibuf;        /* currently scaled ibuf */
194 } MovieTrackingStabilization;
195
196 typedef struct MovieTrackingReconstruction {
197         int flag;
198
199         float error;            /* average error of reconstruction */
200
201         int last_camera;                /* most recently used camera */
202         int camnr;                              /* number of reconstructed cameras */
203         struct MovieReconstructedCamera *cameras;       /* reconstructed cameras */
204 } MovieTrackingReconstruction;
205
206 typedef struct MovieTrackingObject {
207         struct MovieTrackingObject *next, *prev;
208
209         char name[64];                  /* Name of tracking object, MAX_NAME */
210         int flag;
211         float scale;                    /* scale of object solution in amera space */
212
213         ListBase tracks;                /* list of tracks use to tracking this object */
214         MovieTrackingReconstruction reconstruction;     /* reconstruction data for this object */
215 } MovieTrackingObject;
216
217 typedef struct MovieTrackingStats {
218         char message[256];
219 } MovieTrackingStats;
220
221 typedef struct MovieTrackingDopesheetChannel {
222         struct MovieTrackingDopesheetChannel *next, *prev;
223
224         MovieTrackingTrack *track;      /* motion track for which channel is created */
225         int pad;
226
227         int tot_segment;                /* total number of segments */
228         int *segments;                  /* tracked segments */
229         int max_segment, total_frames;  /* longest segment length and total number of tracked frames */
230 } MovieTrackingDopesheetChannel;
231
232 typedef struct MovieTrackingDopesheet {
233         int ok, pad;                            /* flag if dopesheet information is still relevant */
234
235         ListBase channels;
236         int tot_channel;
237
238         short sort_method;                      /* method to be used to sort tracks */
239         short sort_inverse;                     /* order of tracks is inverted */
240 } MovieTrackingDopesheet;
241
242 typedef struct MovieTracking {
243         MovieTrackingSettings settings; /* different tracking-related settings */
244         MovieTrackingCamera camera;             /* camera intrinsics */
245         ListBase tracks;                                /* list of tracks used for camera object */
246         MovieTrackingReconstruction reconstruction;     /* reconstruction data for camera object */
247         MovieTrackingStabilization stabilization;       /* stabilization data */
248         MovieTrackingTrack *act_track;          /* active track */
249
250         ListBase objects;
251         int objectnr, tot_object;               /* index of active object and total number of objects */
252
253         MovieTrackingStats *stats;              /* statistics displaying in clip editor */
254
255         MovieTrackingDopesheet dopesheet;       /* dopesheet data */
256 } MovieTracking;
257
258 /* MovieTrackingCamera->units */
259 enum {
260         CAMERA_UNITS_PX = 0,
261         CAMERA_UNITS_MM
262 };
263
264 /* MovieTrackingMarker->flag */
265 #define MARKER_DISABLED (1<<0)
266 #define MARKER_TRACKED  (1<<1)
267 #define MARKER_GRAPH_SEL_X (1<<2)
268 #define MARKER_GRAPH_SEL_Y (1<<3)
269 #define MARKER_GRAPH_SEL        (MARKER_GRAPH_SEL_X|MARKER_GRAPH_SEL_Y)
270
271 /* MovieTrackingTrack->flag */
272 #define TRACK_HAS_BUNDLE        (1<<1)
273 #define TRACK_DISABLE_RED       (1<<2)
274 #define TRACK_DISABLE_GREEN     (1<<3)
275 #define TRACK_DISABLE_BLUE      (1<<4)
276 #define TRACK_HIDDEN            (1<<5)
277 #define TRACK_LOCKED            (1<<6)
278 #define TRACK_CUSTOMCOLOR       (1<<7)
279 #define TRACK_USE_2D_STAB       (1<<8)
280 #define TRACK_PREVIEW_GRAYSCALE (1<<9)
281 #define TRACK_DOPE_SEL          (1<<10)
282
283 /* MovieTrackingTrack->tracker */
284 #define TRACKER_KLT             0
285 #define TRACKER_SAD             1
286 #define TRACKER_HYBRID          2
287
288 /* MovieTrackingTrack->adjframes */
289 #define TRACK_MATCH_KEYFRAME            0
290 #define TRACK_MATCH_PREVFRAME           1
291
292 /* MovieTrackingSettings->flag */
293 #define TRACKING_SETTINGS_SHOW_DEFAULT_EXPANDED (1<<0)
294
295 /* MovieTrackingSettings->motion_flag */
296 #define TRACKING_MOTION_TRIPOD          (1<<0)
297
298 #define TRACKING_MOTION_MODAL           (TRACKING_MOTION_TRIPOD)
299
300 /* MovieTrackingSettings->speed */
301 #define TRACKING_SPEED_FASTEST          0
302 #define TRACKING_SPEED_REALTIME         1
303 #define TRACKING_SPEED_HALF                     2
304 #define TRACKING_SPEED_QUARTER          4
305 #define TRACKING_SPEED_DOUBLE           5
306
307 /* MovieTrackingSettings->refine_camera_intrinsics */
308 #define REFINE_FOCAL_LENGTH                     (1<<0)
309 #define REFINE_PRINCIPAL_POINT          (1<<1)
310 #define REFINE_RADIAL_DISTORTION_K1     (1<<2)
311 #define REFINE_RADIAL_DISTORTION_K2     (1<<4)
312
313 /* MovieTrackingStrabilization->flag */
314 #define TRACKING_2D_STABILIZATION       (1<<0)
315 #define TRACKING_AUTOSCALE                      (1<<1)
316 #define TRACKING_STABILIZE_ROTATION     (1<<2)
317
318 /* MovieTrackingStrabilization->filter */
319 #define TRACKING_FILTER_NEAREAST        0
320 #define TRACKING_FILTER_BILINEAR        1
321 #define TRACKING_FILTER_BICUBIC         2
322
323 /* MovieTrackingReconstruction->flag */
324 #define TRACKING_RECONSTRUCTED  (1<<0)
325
326 /* MovieTrackingObject->flag */
327 #define TRACKING_OBJECT_CAMERA          (1<<0)
328
329 #define TRACKING_CLEAN_SELECT                   0
330 #define TRACKING_CLEAN_DELETE_TRACK             1
331 #define TRACKING_CLEAN_DELETE_SEGMENT   2
332
333 #endif