Motion Tracking: move keyframe settings to per-tracking object settings
[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         /* positions of left-bottom and right-top corners of search area (in unified 0..1 units,
90          * relative to marker->pos
91          */
92         float search_min[2], search_max[2];
93
94         int framenr;    /* number of frame marker is associated with */
95         int flag;       /* Marker's flag (alive, ...) */
96 } MovieTrackingMarker;
97
98 typedef struct MovieTrackingTrack {
99         struct MovieTrackingTrack *next, *prev;
100
101         char name[64];  /* MAX_NAME */
102
103         /* ** setings ** */
104
105         /* positions of left-bottom and right-top corners of pattern (in unified 0..1 units,
106          * relative to marker->pos)
107          * moved to marker's corners since planar tracking implementation
108          */
109         float pat_min[2] DNA_DEPRECATED, pat_max[2] DNA_DEPRECATED;
110
111         /* positions of left-bottom and right-top corners of search area (in unified 0..1 units,
112          * relative to marker->pos
113          * moved to marker since affine tracking implementation
114          */
115         float search_min[2] DNA_DEPRECATED, search_max[2] DNA_DEPRECATED;
116
117         float offset[2];                    /* offset to "parenting" point */
118
119         /* ** track ** */
120         int markersnr;                  /* count of markers in track */
121         int last_marker;                /* most recently used marker */
122         MovieTrackingMarker *markers;   /* markers in track */
123
124         /* ** reconstruction data ** */
125         float bundle_pos[3];            /* reconstructed position */
126         float error;                    /* average track reprojection error */
127
128         /* ** UI editing ** */
129         int flag, pat_flag, search_flag;    /* flags (selection, ...) */
130         float color[3];                     /* custom color for track */
131
132         /* ** control how tracking happens */
133         short frames_limit;     /* number of frames to be tarcked during single tracking session (if TRACKING_FRAMES_LIMIT is set) */
134         short margin;           /* margin from frame boundaries */
135         short pattern_match;    /* re-adjust every N frames */
136
137         /* tracking parameters */
138         short motion_model;     /* model of the motion for this track */
139         int algorithm_flag;    /* flags for the tracking algorithm (use brute, use esm, use pyramid, etc */
140         float minimum_correlation;          /* minimal correlation which is still treated as successful tracking */
141
142         struct bGPdata *gpd;        /* grease-pencil data */
143 } MovieTrackingTrack;
144
145 typedef struct MovieTrackingSettings {
146         int flag;
147
148         /* ** default tracker settings */
149         short default_motion_model;         /* model of the motion for this track */
150         short default_algorithm_flag;       /* flags for the tracking algorithm (use brute, use esm, use pyramid, etc */
151         float default_minimum_correlation;  /* minimal correlation which is still treated as successful tracking */
152         short default_pattern_size;         /* size of pattern area for new tracks */
153         short default_search_size;          /* size of search area for new tracks */
154         short default_frames_limit;         /* number of frames to be tarcked during single tracking session (if TRACKING_FRAMES_LIMIT is set) */
155         short default_margin;               /* margin from frame boundaries */
156         short default_pattern_match;        /* re-adjust every N frames */
157         short default_flag;                 /* default flags like color channels used by default */
158
159         short motion_flag;      /* flags describes motion type */
160
161         /* ** common tracker settings ** */
162         short speed;            /* speed of tracking */
163
164         /* ** reconstruction settings ** */
165         int keyframe1 DNA_DEPRECATED,
166                 keyframe2 DNA_DEPRECATED;   /* two keyframes for reconstrution initialization
167                                              * were moved to per-tracking object settings
168                                              */
169
170         /* which camera intrinsics to refine. uses on the REFINE_* flags */
171         short refine_camera_intrinsics, pad2;
172
173         /* ** tool settings ** */
174
175         /* set scale */
176         float dist;                 /* distance between two bundles used for scene scaling */
177
178         /* cleanup */
179         int clean_frames, clean_action;
180         float clean_error;
181
182         /* set object scale */
183         float object_distance;      /* distance between two bundles used for object scaling */
184
185         int pad3;
186 } MovieTrackingSettings;
187
188 typedef struct MovieTrackingStabilization {
189         int flag;
190         int tot_track, act_track;       /* total number and index of active track in list */
191
192         /* 2d stabilization */
193         float maxscale;         /* max auto-scale factor */
194         MovieTrackingTrack *rot_track;  /* track used to stabilize rotation */
195
196         float locinf, scaleinf, rotinf; /* influence on location, scale and rotation */
197
198         int filter;     /* filter used for pixel interpolation */
199
200         /* some pre-computing run-time variables */
201         int ok;                     /* are precomputed values and scaled buf relevant? */
202         float scale;                /* autoscale factor */
203
204         struct ImBuf *scaleibuf;    /* currently scaled ibuf */
205 } MovieTrackingStabilization;
206
207 typedef struct MovieTrackingReconstruction {
208         int flag;
209
210         float error;        /* average error of reconstruction */
211
212         int last_camera;        /* most recently used camera */
213         int camnr;              /* number of reconstructed cameras */
214         struct MovieReconstructedCamera *cameras;   /* reconstructed cameras */
215 } MovieTrackingReconstruction;
216
217 typedef struct MovieTrackingObject {
218         struct MovieTrackingObject *next, *prev;
219
220         char name[64];          /* Name of tracking object, MAX_NAME */
221         int flag;
222         float scale;            /* scale of object solution in amera space */
223
224         ListBase tracks;        /* list of tracks use to tracking this object */
225         MovieTrackingReconstruction reconstruction; /* reconstruction data for this object */
226
227         int keyframe1, keyframe2;   /* two keyframes for reconstrution initialization */
228 } MovieTrackingObject;
229
230 typedef struct MovieTrackingStats {
231         char message[256];
232 } MovieTrackingStats;
233
234 typedef struct MovieTrackingDopesheetChannel {
235         struct MovieTrackingDopesheetChannel *next, *prev;
236
237         MovieTrackingTrack *track;  /* motion track for which channel is created */
238         int pad;
239
240         char name[64];          /* name of channel */
241
242         int tot_segment;        /* total number of segments */
243         int *segments;          /* tracked segments */
244         int max_segment, total_frames;  /* longest segment length and total number of tracked frames */
245 } MovieTrackingDopesheetChannel;
246
247 typedef struct MovieTrackingDopesheet {
248         int ok;                     /* flag if dopesheet information is still relevant */
249
250         short sort_method;          /* method to be used to sort tracks */
251         short flag;                 /* dopesheet building flag such as inverted order of sort */
252
253         /* runtime stuff */
254         ListBase channels;
255         int tot_channel;
256
257         int pad;
258 } MovieTrackingDopesheet;
259
260 typedef struct MovieTracking {
261         MovieTrackingSettings settings; /* different tracking-related settings */
262         MovieTrackingCamera camera;     /* camera intrinsics */
263         ListBase tracks;                /* list of tracks used for camera object */
264         MovieTrackingReconstruction reconstruction; /* reconstruction data for camera object */
265         MovieTrackingStabilization stabilization;   /* stabilization data */
266         MovieTrackingTrack *act_track;      /* active track */
267
268         ListBase objects;
269         int objectnr, tot_object;       /* index of active object and total number of objects */
270
271         MovieTrackingStats *stats;      /* statistics displaying in clip editor */
272
273         MovieTrackingDopesheet dopesheet;   /* dopesheet data */
274 } MovieTracking;
275
276 /* MovieTrackingCamera->units */
277 enum {
278         CAMERA_UNITS_PX = 0,
279         CAMERA_UNITS_MM = 1
280 };
281
282 /* MovieTrackingMarker->flag */
283 #define MARKER_DISABLED (1 << 0)
284 #define MARKER_TRACKED  (1 << 1)
285 #define MARKER_GRAPH_SEL_X (1 << 2)
286 #define MARKER_GRAPH_SEL_Y (1 << 3)
287 #define MARKER_GRAPH_SEL    (MARKER_GRAPH_SEL_X | MARKER_GRAPH_SEL_Y)
288
289 /* MovieTrackingTrack->flag */
290 #define TRACK_HAS_BUNDLE    (1 << 1)
291 #define TRACK_DISABLE_RED   (1 << 2)
292 #define TRACK_DISABLE_GREEN (1 << 3)
293 #define TRACK_DISABLE_BLUE  (1 << 4)
294 #define TRACK_HIDDEN        (1 << 5)
295 #define TRACK_LOCKED        (1 << 6)
296 #define TRACK_CUSTOMCOLOR   (1 << 7)
297 #define TRACK_USE_2D_STAB   (1 << 8)
298 #define TRACK_PREVIEW_GRAYSCALE (1 << 9)
299 #define TRACK_DOPE_SEL      (1 << 10)
300 #define TRACK_PREVIEW_ALPHA (1 << 11)
301
302 /* MovieTrackingTrack->motion_model */
303 #define TRACK_MOTION_MODEL_TRANSLATION                 0
304 #define TRACK_MOTION_MODEL_TRANSLATION_ROTATION        1
305 #define TRACK_MOTION_MODEL_TRANSLATION_SCALE           2
306 #define TRACK_MOTION_MODEL_TRANSLATION_ROTATION_SCALE  3
307 #define TRACK_MOTION_MODEL_AFFINE                      4
308 #define TRACK_MOTION_MODEL_HOMOGRAPHY                  5
309
310 /* MovieTrackingTrack->algorithm_flag */
311 #define TRACK_ALGORITHM_FLAG_USE_BRUTE                  (1 << 0)
312 #define TRACK_ALGORITHM_FLAG_USE_NORMALIZATION  (1 << 2)
313 #define TRACK_ALGORITHM_FLAG_USE_MASK                   (1 << 3)
314
315 /* MovieTrackingTrack->adjframes */
316 #define TRACK_MATCH_KEYFRAME        0
317 #define TRACK_MATCH_PREVFRAME       1
318
319 /* MovieTrackingSettings->flag */
320 #define TRACKING_SETTINGS_SHOW_DEFAULT_EXPANDED (1 << 0)
321
322 /* MovieTrackingSettings->motion_flag */
323 #define TRACKING_MOTION_TRIPOD      (1 << 0)
324
325 #define TRACKING_MOTION_MODAL       (TRACKING_MOTION_TRIPOD)
326
327 /* MovieTrackingSettings->speed */
328 #define TRACKING_SPEED_FASTEST      0
329 #define TRACKING_SPEED_REALTIME     1
330 #define TRACKING_SPEED_HALF         2
331 #define TRACKING_SPEED_QUARTER      4
332 #define TRACKING_SPEED_DOUBLE       5
333
334 /* MovieTrackingSettings->refine_camera_intrinsics */
335 #define REFINE_FOCAL_LENGTH         (1 << 0)
336 #define REFINE_PRINCIPAL_POINT      (1 << 1)
337 #define REFINE_RADIAL_DISTORTION_K1 (1 << 2)
338 #define REFINE_RADIAL_DISTORTION_K2 (1 << 4)
339
340 /* MovieTrackingStrabilization->flag */
341 #define TRACKING_2D_STABILIZATION   (1 << 0)
342 #define TRACKING_AUTOSCALE          (1 << 1)
343 #define TRACKING_STABILIZE_ROTATION (1 << 2)
344
345 /* MovieTrackingStrabilization->filter */
346 #define TRACKING_FILTER_NEAREAST    0
347 #define TRACKING_FILTER_BILINEAR    1
348 #define TRACKING_FILTER_BICUBIC     2
349
350 /* MovieTrackingReconstruction->flag */
351 #define TRACKING_RECONSTRUCTED  (1 << 0)
352
353 /* MovieTrackingObject->flag */
354 #define TRACKING_OBJECT_CAMERA      (1 << 0)
355
356 #define TRACKING_CLEAN_SELECT           0
357 #define TRACKING_CLEAN_DELETE_TRACK     1
358 #define TRACKING_CLEAN_DELETE_SEGMENT   2
359
360 /* MovieTrackingDopesheet->sort_method */
361 #define TRACKING_DOPE_SORT_NAME          0
362 #define TRACKING_DOPE_SORT_LONGEST       1
363 #define TRACKING_DOPE_SORT_TOTAL         2
364 #define TRACKING_DOPE_SORT_AVERAGE_ERROR 3
365
366 /* MovieTrackingDopesheet->flag */
367 #define TRACKING_DOPE_SORT_INVERSE    (1 << 0)
368 #define TRACKING_DOPE_SELECTED_ONLY   (1 << 1)
369 #define TRACKING_DOPE_SHOW_HIDDEN     (1 << 2)
370
371 #endif