Merging r42621 through r42647 from trunk into soc-2011-tomato
[blender.git] / source / blender / blenkernel / BKE_tracking.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 BKE_TRACKING_H
28 #define BKE_TRACKING_H
29
30 /** \file BKE_trackingp.h
31  *  \ingroup bke
32  *  \author Sergey Sharybin
33  */
34
35 struct bGPDlayer;
36 struct ImBuf;
37 struct ListBase;
38 struct MovieReconstructContext;
39 struct MovieTrackingTrack;
40 struct MovieTrackingMarker;
41 struct MovieTracking;
42 struct MovieTrackingContext;
43 struct MovieTrackingObject;
44 struct MovieClipUser;
45 struct MovieDistortion;
46 struct Camera;
47 struct Object;
48 struct Scene;
49
50 void BKE_tracking_init_settings(struct MovieTracking *tracking);
51 void BKE_tracking_clamp_track(struct MovieTrackingTrack *track, int event);
52 void BKE_tracking_track_flag(struct MovieTrackingTrack *track, int area, int flag, int clear);
53
54 struct MovieTrackingTrack *BKE_tracking_add_track(struct MovieTracking *tracking, struct ListBase *tracksbase,
55                         float x, float y, int framenr, int width, int height);
56 void BKE_tracking_insert_marker(struct MovieTrackingTrack *track, struct MovieTrackingMarker *marker);
57 void BKE_tracking_delete_marker(struct MovieTrackingTrack *track, int framenr);
58
59 struct MovieTrackingMarker *BKE_tracking_get_marker(struct MovieTrackingTrack *track, int framenr);
60 struct MovieTrackingMarker *BKE_tracking_ensure_marker(struct MovieTrackingTrack *track, int framenr);
61 struct MovieTrackingMarker *BKE_tracking_exact_marker(struct MovieTrackingTrack *track, int framenr);
62 int BKE_tracking_has_marker(struct MovieTrackingTrack *track, int framenr);
63
64 void BKE_tracking_free_track(struct MovieTrackingTrack *track);
65
66 void BKE_tracking_clear_path(struct MovieTrackingTrack *track, int ref_frame, int action);
67
68 int BKE_tracking_test_join_tracks(struct MovieTrackingTrack *dst_track, struct MovieTrackingTrack *src_track);
69 void BKE_tracking_join_tracks(struct MovieTrackingTrack *dst_track, struct MovieTrackingTrack *src_track);
70 void BKE_tracking_free(struct MovieTracking *tracking);
71
72 struct ImBuf *BKE_tracking_get_pattern_imbuf(struct ImBuf *ibuf, struct MovieTrackingTrack *track,
73                         struct MovieTrackingMarker *marker, int margin, int anchored, float pos[2], int origin[2]);
74 struct ImBuf *BKE_tracking_get_search_imbuf(struct ImBuf *ibuf, struct MovieTrackingTrack *track,
75                         struct MovieTrackingMarker *marker, int margin, int anchored, float pos[2], int origin[2]);
76
77 void BKE_track_unique_name(struct ListBase *tracksbase, struct MovieTrackingTrack *track);
78
79 struct MovieTrackingTrack *BKE_tracking_named_track(struct MovieTracking *tracking, struct MovieTrackingObject *object, const char *name);
80 struct MovieTrackingTrack *BKE_tracking_indexed_track(struct MovieTracking *tracking, int tracknr);
81
82 void BKE_tracking_camera_shift(struct MovieTracking *tracking, int winx, int winy, float *shiftx, float *shifty);
83 void BKE_tracking_camera_to_blender(struct MovieTracking *tracking, struct Scene *scene, struct Camera *camera, int width, int height);
84
85 void BKE_get_tracking_mat(struct Scene *scene, struct Object *ob, float mat[4][4]);
86 void BKE_tracking_projection_matrix(struct MovieTracking *tracking, struct MovieTrackingObject *object,
87                         int framenr, int winx, int winy, float mat[4][4]);
88
89 struct ListBase *BKE_tracking_get_tracks(struct MovieTracking *tracking);
90 struct MovieTrackingReconstruction *BKE_tracking_get_reconstruction(struct MovieTracking *tracking);
91
92 struct MovieTrackingTrack *BKE_tracking_active_track(struct MovieTracking *tracking);
93 struct MovieTrackingObject *BKE_tracking_active_object(struct MovieTracking *tracking);
94 struct MovieTrackingObject *BKE_tracking_get_camera_object(struct MovieTracking *tracking);
95 struct ListBase *BKE_tracking_object_tracks(struct MovieTracking *tracking, struct MovieTrackingObject *object);
96 struct MovieTrackingReconstruction *BKE_tracking_object_reconstruction(struct MovieTracking *tracking,
97                         struct MovieTrackingObject *object);
98
99 /* 2D tracking */
100 struct MovieTrackingContext *BKE_tracking_context_new(struct MovieClip *clip, struct MovieClipUser *user,
101                         short backwards, short sequence);
102 void BKE_tracking_context_free(struct MovieTrackingContext *context);
103 void BKE_tracking_sync(struct MovieTrackingContext *context);
104 void BKE_tracking_sync_user(struct MovieClipUser *user, struct MovieTrackingContext *context);
105 int BKE_tracking_next(struct MovieTrackingContext *context);
106
107 /* Camera solving */
108 int BKE_tracking_can_reconstruct(struct MovieTracking *tracking, struct MovieTrackingObject *object,
109                         char *error_msg, int error_size);
110
111 struct MovieReconstructContext* BKE_tracking_reconstruction_context_new(struct MovieTracking *tracking,
112                         struct MovieTrackingObject *object, int keyframe1, int keyframe2, int width, int height);
113 void BKE_tracking_reconstruction_context_free(struct MovieReconstructContext *context);
114 void BKE_tracking_solve_reconstruction(struct MovieReconstructContext *context,
115                         short *stop, short *do_update, float *progress, char *stats_message, int message_size);
116 int BKE_tracking_finish_reconstruction(struct MovieReconstructContext *context, struct MovieTracking *tracking);
117
118 struct MovieReconstructedCamera *BKE_tracking_get_reconstructed_camera(struct MovieTracking *tracking,
119                         struct MovieTrackingObject *object, int framenr);
120 void BKE_tracking_get_interpolated_camera(struct MovieTracking *tracking,
121                         struct MovieTrackingObject *object, int framenr, float mat[4][4]);
122
123 /* Feature detection */
124 void BKE_tracking_detect_fast(struct MovieTracking *tracking, struct ListBase *tracksbase, struct ImBuf *imbuf,
125                         int framenr, int margin, int min_trackness, int min_distance, struct bGPDlayer *layer,
126                         int place_outside_layer);
127
128 /* 2D stabilization */
129 void BKE_tracking_stabilization_data(struct MovieTracking *tracking, int framenr, int width, int height, float loc[2], float *scale, float *angle);
130 struct ImBuf *BKE_tracking_stabilize(struct MovieTracking *tracking, int framenr, struct ImBuf *ibuf, float loc[2], float *scale, float *angle);
131 void BKE_tracking_stabdata_to_mat4(int width, int height, float loc[2], float scale, float angle, float mat[4][4]);
132
133 /* Distortion/Undistortion */
134 void BKE_tracking_apply_intrinsics(struct MovieTracking *tracking, float co[2], float nco[2]);
135 void BKE_tracking_invert_intrinsics(struct MovieTracking *tracking, float co[2], float nco[2]);
136
137 struct MovieDistortion *BKE_tracking_distortion_create(void);
138 struct MovieDistortion *BKE_tracking_distortion_copy(struct MovieDistortion *distortion);
139 struct ImBuf *BKE_tracking_distortion_exec(struct MovieDistortion *distortion, struct MovieTracking *tracking,
140                         struct ImBuf *ibuf, int width, int height, float overscan, int undistort);
141 void BKE_tracking_distortion_destroy(struct MovieDistortion *distortion);
142
143 struct ImBuf *BKE_tracking_undistort(struct MovieTracking *tracking, struct ImBuf *ibuf, int width, int height, float overscan);
144 struct ImBuf *BKE_tracking_distort(struct MovieTracking *tracking, struct ImBuf *ibuf, int width, int height, float overscan);
145
146 /* Object tracking */
147 struct MovieTrackingObject *BKE_tracking_new_object(struct MovieTracking *tracking, const char *name);
148 void BKE_tracking_remove_object(struct MovieTracking *tracking, struct MovieTrackingObject *object);
149 void BKE_tracking_object_unique_name(struct MovieTracking *tracking, struct MovieTrackingObject *object);
150 struct MovieTrackingObject *BKE_tracking_named_object(struct MovieTracking *tracking, const char *name);
151
152 /* Select */
153 void BKE_tracking_select_track(struct ListBase *tracksbase, struct MovieTrackingTrack *track, int area, int extend);
154 void BKE_tracking_deselect_track(struct MovieTrackingTrack *track, int area);
155
156 #define TRACK_SELECTED(track)                           ((((track)->flag&TRACK_HIDDEN)==0) && ((track)->flag&SELECT || (track)->pat_flag&SELECT || (track)->search_flag&SELECT))
157 #define TRACK_AREA_SELECTED(track, area)        ((((track)->flag&TRACK_HIDDEN)==0) && ((area)==TRACK_AREA_POINT?(track)->flag&SELECT : ((area)==TRACK_AREA_PAT?(track)->pat_flag&SELECT:(track)->search_flag&SELECT)))
158 #define TRACK_VIEW_SELECTED(sc, track)          ((TRACK_AREA_SELECTED(track, TRACK_AREA_POINT) || (((sc)->flag&SC_SHOW_MARKER_PATTERN && TRACK_AREA_SELECTED(track, TRACK_AREA_PAT))) || (((sc)->flag&SC_SHOW_MARKER_SEARCH && TRACK_AREA_SELECTED(track, TRACK_AREA_SEARCH)))))
159
160 #define MARKER_VISIBLE(sc, marker)                      (((marker)->flag&MARKER_DISABLED)==0 || ((sc)->flag&SC_HIDE_DISABLED)==0)
161
162 #define CLAMP_PAT_DIM           1
163 #define CLAMP_PAT_POS           2
164 #define CLAMP_SEARCH_DIM        3
165 #define CLAMP_SEARCH_POS        4
166 #define CLAMP_PYRAMID_LEVELS    5
167
168 #define TRACK_AREA_NONE         -1
169 #define TRACK_AREA_POINT        1
170 #define TRACK_AREA_PAT          2
171 #define TRACK_AREA_SEARCH       4
172
173 #define TRACK_AREA_ALL          (TRACK_AREA_POINT|TRACK_AREA_PAT|TRACK_AREA_SEARCH)
174
175 #endif