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