Merged changes in the trunk up to revision 54992.
[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  * Structs used for camera tracking and the movie-clip editor.
35  */
36
37 #ifndef __DNA_TRACKING_TYPES_H__
38 #define __DNA_TRACKING_TYPES_H__
39
40 #include "DNA_defs.h"
41 #include "DNA_listBase.h"
42
43 /* match-moving data */
44
45 struct bGPdata;
46 struct ImBuf;
47 struct MovieReconstructedCamera;
48 struct MovieTrackingCamera;
49 struct MovieTrackingBundle;
50 struct MovieTrackingMarker;
51 struct MovieTrackingTrack;
52 struct MovieTracking;
53
54 typedef struct MovieReconstructedCamera {
55         int framenr;
56         float error;
57         float mat[4][4];
58 } MovieReconstructedCamera;
59
60 typedef struct MovieTrackingCamera {
61         void *intrinsics;   /* intrinsics handle */
62
63         float sensor_width; /* width of CCD sensor */
64         float pixel_aspect; /* pixel aspect ratio */
65         float pad;
66         float focal;        /* focal length */
67         short units;        /* units of focal length user is working with */
68         short pad1;
69         float principal[2]; /* principal point */
70         float k1, k2, k3;   /* radial distortion */
71 } MovieTrackingCamera;
72
73 typedef struct MovieTrackingMarker {
74         float pos[2];   /* 2d position of marker on frame (in unified 0..1 space) */
75
76         /* corners of pattern in the following order:
77          *
78          *       Y
79          *       ^
80          *       | (3) --- (2)
81          *       |  |       |
82          *       |  |       |
83          *       |  |       |
84          *       | (0) --- (1)
85          *       +-------------> X
86          *
87          * the coordinates are stored relative to pos.
88          */
89         float pattern_corners[4][2];
90
91         /* positions of left-bottom and right-top corners of search area (in unified 0..1 units,
92          * relative to marker->pos
93          */
94         float search_min[2], search_max[2];
95
96         int framenr;    /* number of frame marker is associated with */
97         int flag;       /* Marker's flag (alive, ...) */
98 } MovieTrackingMarker;
99
100 typedef struct MovieTrackingTrack {
101         struct MovieTrackingTrack *next, *prev;
102
103         char name[64];  /* MAX_NAME */
104
105         /* ** setings ** */
106
107         /* positions of left-bottom and right-top corners of pattern (in unified 0..1 units,
108          * relative to marker->pos)
109          * moved to marker's corners since planar tracking implementation
110          */
111         float pat_min[2] DNA_DEPRECATED, pat_max[2] DNA_DEPRECATED;
112
113         /* positions of left-bottom and right-top corners of search area (in unified 0..1 units,
114          * relative to marker->pos
115          * moved to marker since affine tracking implementation
116          */
117         float search_min[2] DNA_DEPRECATED, search_max[2] DNA_DEPRECATED;
118
119         float offset[2];                    /* offset to "parenting" point */
120
121         /* ** track ** */
122         int markersnr;                  /* count of markers in track */
123         int last_marker;                /* most recently used marker */
124         MovieTrackingMarker *markers;   /* markers in track */
125
126         /* ** reconstruction data ** */
127         float bundle_pos[3];            /* reconstructed position */
128         float error;                    /* average track reprojection error */
129
130         /* ** UI editing ** */
131         int flag, pat_flag, search_flag;    /* flags (selection, ...) */
132         float color[3];                     /* custom color for track */
133
134         /* ** control how tracking happens */
135         short frames_limit;     /* number of frames to be tarcked during single tracking session (if TRACKING_FRAMES_LIMIT is set) */
136         short margin;           /* margin from frame boundaries */
137         short pattern_match;    /* re-adjust every N frames */
138
139         /* tracking parameters */
140         short motion_model;     /* model of the motion for this track */
141         int algorithm_flag;    /* flags for the tracking algorithm (use brute, use esm, use pyramid, etc */
142         float minimum_correlation;          /* minimal correlation which is still treated as successful tracking */
143
144         struct bGPdata *gpd;        /* grease-pencil data */
145 } MovieTrackingTrack;
146
147 typedef struct MovieTrackingSettings {
148         int flag;
149
150         /* ** default tracker settings */
151         short default_motion_model;         /* model of the motion for this track */
152         short default_algorithm_flag;       /* flags for the tracking algorithm (use brute, use esm, use pyramid, etc */
153         float default_minimum_correlation;  /* minimal correlation which is still treated as successful tracking */
154         short default_pattern_size;         /* size of pattern area for new tracks */
155         short default_search_size;          /* size of search area for new tracks */
156         short default_frames_limit;         /* number of frames to be tarcked during single tracking session (if TRACKING_FRAMES_LIMIT is set) */
157         short default_margin;               /* margin from frame boundaries */
158         short default_pattern_match;        /* re-adjust every N frames */
159         short default_flag;                 /* default flags like color channels used by default */
160
161         short motion_flag;      /* flags describes motion type */
162
163         /* ** common tracker settings ** */
164         short speed;            /* speed of tracking */
165
166         /* ** reconstruction settings ** */
167         int keyframe1 DNA_DEPRECATED,
168                 keyframe2 DNA_DEPRECATED;   /* two keyframes for reconstruction initialization
169                                              * were moved to per-tracking object settings
170                                              */
171
172         float reconstruction_success_threshold;
173         int reconstruction_flag;
174
175         /* which camera intrinsics to refine. uses on the REFINE_* flags */
176         short refine_camera_intrinsics, pad2;
177
178         /* ** tool settings ** */
179
180         /* set scale */
181         float dist;                 /* distance between two bundles used for scene scaling */
182
183         /* cleanup */
184         int clean_frames, clean_action;
185         float clean_error;
186
187         /* set object scale */
188         float object_distance;      /* distance between two bundles used for object scaling */
189
190         int pad3;
191 } MovieTrackingSettings;
192
193 typedef struct MovieTrackingStabilization {
194         int flag;
195         int tot_track, act_track;       /* total number and index of active track in list */
196
197         /* 2d stabilization */
198         float maxscale;         /* max auto-scale factor */
199         MovieTrackingTrack *rot_track;  /* track used to stabilize rotation */
200
201         float locinf, scaleinf, rotinf; /* influence on location, scale and rotation */
202
203         int filter;     /* filter used for pixel interpolation */
204
205         /* some pre-computing run-time variables */
206         int ok;                     /* are precomputed values and scaled buf relevant? */
207         float scale;                /* autoscale factor */
208
209         struct ImBuf *scaleibuf;    /* currently scaled ibuf */
210 } MovieTrackingStabilization;
211
212 typedef struct MovieTrackingReconstruction {
213         int flag;
214
215         float error;        /* average error of reconstruction */
216
217         int last_camera;        /* most recently used camera */
218         int camnr;              /* number of reconstructed cameras */
219         struct MovieReconstructedCamera *cameras;   /* reconstructed cameras */
220 } MovieTrackingReconstruction;
221
222 typedef struct MovieTrackingObject {
223         struct MovieTrackingObject *next, *prev;
224
225         char name[64];          /* Name of tracking object, MAX_NAME */
226         int flag;
227         float scale;            /* scale of object solution in amera space */
228
229         ListBase tracks;        /* list of tracks use to tracking this object */
230         MovieTrackingReconstruction reconstruction; /* reconstruction data for this object */
231
232         /* reconstruction options */
233         int keyframe1, keyframe2;   /* two keyframes for reconstruction initialization */
234 } MovieTrackingObject;
235
236 typedef struct MovieTrackingStats {
237         char message[256];
238 } MovieTrackingStats;
239
240 typedef struct MovieTrackingDopesheetChannel {
241         struct MovieTrackingDopesheetChannel *next, *prev;
242
243         MovieTrackingTrack *track;  /* motion track for which channel is created */
244         int pad;
245
246         char name[64];          /* name of channel */
247
248         int tot_segment;        /* total number of segments */
249         int *segments;          /* tracked segments */
250         int max_segment, total_frames;  /* longest segment length and total number of tracked frames */
251 } MovieTrackingDopesheetChannel;
252
253 typedef struct MovieTrackingDopesheetCoverageSegment {
254         struct MovieTrackingDopesheetCoverageSegment *next, *prev;
255
256         int coverage;
257         int start_frame;
258         int end_frame;
259
260         int pad;
261 } MovieTrackingDopesheetCoverageSegment;
262
263 typedef struct MovieTrackingDopesheet {
264         int ok;                     /* flag if dopesheet information is still relevant */
265
266         short sort_method;          /* method to be used to sort tracks */
267         short flag;                 /* dopesheet building flag such as inverted order of sort */
268
269         /* ** runtime stuff ** */
270
271         /* summary */
272         ListBase coverage_segments;
273
274         /* detailed */
275         ListBase channels;
276         int tot_channel;
277
278         int pad;
279 } MovieTrackingDopesheet;
280
281 typedef struct MovieTracking {
282         MovieTrackingSettings settings; /* different tracking-related settings */
283         MovieTrackingCamera camera;     /* camera intrinsics */
284         ListBase tracks;                /* list of tracks used for camera object */
285         MovieTrackingReconstruction reconstruction; /* reconstruction data for camera object */
286         MovieTrackingStabilization stabilization;   /* stabilization data */
287         MovieTrackingTrack *act_track;      /* active track */
288
289         ListBase objects;
290         int objectnr, tot_object;       /* index of active object and total number of objects */
291
292         MovieTrackingStats *stats;      /* statistics displaying in clip editor */
293
294         MovieTrackingDopesheet dopesheet;   /* dopesheet data */
295 } MovieTracking;
296
297 /* MovieTrackingCamera->units */
298 enum {
299         CAMERA_UNITS_PX = 0,
300         CAMERA_UNITS_MM = 1
301 };
302
303 /* MovieTrackingMarker->flag */
304 enum {
305         MARKER_DISABLED    = (1 << 0),
306         MARKER_TRACKED     = (1 << 1),
307         MARKER_GRAPH_SEL_X = (1 << 2),
308         MARKER_GRAPH_SEL_Y = (1 << 3),
309         MARKER_GRAPH_SEL   = (MARKER_GRAPH_SEL_X | MARKER_GRAPH_SEL_Y)
310 };
311
312 /* MovieTrackingTrack->flag */
313 enum {
314         TRACK_HAS_BUNDLE        = (1 << 1),
315         TRACK_DISABLE_RED       = (1 << 2),
316         TRACK_DISABLE_GREEN     = (1 << 3),
317         TRACK_DISABLE_BLUE      = (1 << 4),
318         TRACK_HIDDEN            = (1 << 5),
319         TRACK_LOCKED            = (1 << 6),
320         TRACK_CUSTOMCOLOR       = (1 << 7),
321         TRACK_USE_2D_STAB       = (1 << 8),
322         TRACK_PREVIEW_GRAYSCALE = (1 << 9),
323         TRACK_DOPE_SEL          = (1 << 10),
324         TRACK_PREVIEW_ALPHA     = (1 << 11)
325 };
326
327 /* MovieTrackingTrack->motion_model */
328 enum {
329         TRACK_MOTION_MODEL_TRANSLATION                 = 0,
330         TRACK_MOTION_MODEL_TRANSLATION_ROTATION        = 1,
331         TRACK_MOTION_MODEL_TRANSLATION_SCALE           = 2,
332         TRACK_MOTION_MODEL_TRANSLATION_ROTATION_SCALE  = 3,
333         TRACK_MOTION_MODEL_AFFINE                      = 4,
334         TRACK_MOTION_MODEL_HOMOGRAPHY                  = 5
335 };
336
337 /* MovieTrackingTrack->algorithm_flag */
338 enum {
339         TRACK_ALGORITHM_FLAG_USE_BRUTE                  = (1 << 0),
340         TRACK_ALGORITHM_FLAG_USE_NORMALIZATION  = (1 << 2),
341         TRACK_ALGORITHM_FLAG_USE_MASK                   = (1 << 3)
342 };
343
344 /* MovieTrackingTrack->adjframes */
345 enum {
346         TRACK_MATCH_KEYFRAME  = 0,
347         TRACK_MATCH_PREVFRAME = 1
348 };
349
350 /* MovieTrackingSettings->flag */
351 enum {
352         TRACKING_SETTINGS_SHOW_DEFAULT_EXPANDED = (1 << 0)
353 };
354
355 /* MovieTrackingSettings->motion_flag */
356 enum {
357         TRACKING_MOTION_TRIPOD = (1 << 0),
358
359         TRACKING_MOTION_MODAL  = (TRACKING_MOTION_TRIPOD)
360 };
361
362 /* MovieTrackingSettings->speed */
363 enum {
364         TRACKING_SPEED_FASTEST  = 0,
365         TRACKING_SPEED_REALTIME = 1,
366         TRACKING_SPEED_HALF     = 2,
367         TRACKING_SPEED_QUARTER  = 4,
368         TRACKING_SPEED_DOUBLE   = 5
369 };
370
371 /* MovieTrackingObject->reconstruction_flag */
372 enum {
373         TRACKING_USE_FALLBACK_RECONSTRUCTION = (1 << 0)
374 };
375
376 /* MovieTrackingSettings->refine_camera_intrinsics */
377 enum {
378         REFINE_FOCAL_LENGTH         = (1 << 0),
379         REFINE_PRINCIPAL_POINT      = (1 << 1),
380         REFINE_RADIAL_DISTORTION_K1 = (1 << 2),
381         REFINE_RADIAL_DISTORTION_K2 = (1 << 4)
382 };
383
384 /* MovieTrackingStrabilization->flag */
385 enum {
386         TRACKING_2D_STABILIZATION   = (1 << 0),
387         TRACKING_AUTOSCALE          = (1 << 1),
388         TRACKING_STABILIZE_ROTATION = (1 << 2)
389 };
390
391 /* MovieTrackingStrabilization->filter */
392 enum {
393         TRACKING_FILTER_NEAREST  = 0,
394         TRACKING_FILTER_BILINEAR = 1,
395         TRACKING_FILTER_BICUBIC  = 2
396 };
397
398 /* MovieTrackingReconstruction->flag */
399 enum {
400         TRACKING_RECONSTRUCTED = (1 << 0)
401 };
402
403 /* MovieTrackingObject->flag */
404 enum {
405         TRACKING_OBJECT_CAMERA = (1 << 0)
406 };
407
408 enum {
409         TRACKING_CLEAN_SELECT         = 0,
410         TRACKING_CLEAN_DELETE_TRACK   = 1,
411         TRACKING_CLEAN_DELETE_SEGMENT = 2
412 };
413
414 /* MovieTrackingDopesheet->sort_method */
415 enum {
416         TRACKING_DOPE_SORT_NAME          = 0,
417         TRACKING_DOPE_SORT_LONGEST       = 1,
418         TRACKING_DOPE_SORT_TOTAL         = 2,
419         TRACKING_DOPE_SORT_AVERAGE_ERROR = 3
420 };
421
422 /* MovieTrackingDopesheet->flag */
423 enum {
424         TRACKING_DOPE_SORT_INVERSE  = (1 << 0),
425         TRACKING_DOPE_SELECTED_ONLY = (1 << 1),
426         TRACKING_DOPE_SHOW_HIDDEN   = (1 << 2)
427 };
428
429 /* MovieTrackingDopesheetCoverageSegment->trackness */
430 enum {
431         TRACKING_COVERAGE_BAD        = 0,
432         TRACKING_COVERAGE_ACCEPTABLE = 1,
433         TRACKING_COVERAGE_OK         = 2
434 };
435
436 #endif  /* __DNA_TRACKING_TYPES_H__ */