svn merge ^/trunk/blender -r43436:43443
[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 struct MovieTrackingMarker *BKE_tracking_insert_marker(struct MovieTrackingTrack *track,
57                         struct MovieTrackingMarker *marker);
58 void BKE_tracking_delete_marker(struct MovieTrackingTrack *track, int framenr);
59
60 struct MovieTrackingMarker *BKE_tracking_get_marker(struct MovieTrackingTrack *track, int framenr);
61 struct MovieTrackingMarker *BKE_tracking_ensure_marker(struct MovieTrackingTrack *track, int framenr);
62 struct MovieTrackingMarker *BKE_tracking_exact_marker(struct MovieTrackingTrack *track, int framenr);
63 int BKE_tracking_has_marker(struct MovieTrackingTrack *track, int framenr);
64
65 void BKE_tracking_free_track(struct MovieTrackingTrack *track);
66
67 void BKE_tracking_clear_path(struct MovieTrackingTrack *track, int ref_frame, int action);
68
69 int BKE_tracking_test_join_tracks(struct MovieTrackingTrack *dst_track, struct MovieTrackingTrack *src_track);
70 void BKE_tracking_join_tracks(struct MovieTrackingTrack *dst_track, struct MovieTrackingTrack *src_track);
71 void BKE_tracking_free(struct MovieTracking *tracking);
72
73 struct ImBuf *BKE_tracking_get_pattern_imbuf(struct ImBuf *ibuf, struct MovieTrackingTrack *track,
74                         struct MovieTrackingMarker *marker, int margin, int anchored, float pos[2], int origin[2]);
75 struct ImBuf *BKE_tracking_get_search_imbuf(struct ImBuf *ibuf, struct MovieTrackingTrack *track,
76                         struct MovieTrackingMarker *marker, int margin, int anchored, float pos[2], int origin[2]);
77
78 void BKE_track_unique_name(struct ListBase *tracksbase, struct MovieTrackingTrack *track);
79
80 struct MovieTrackingTrack *BKE_tracking_named_track(struct MovieTracking *tracking, struct MovieTrackingObject *object, const char *name);
81 struct MovieTrackingTrack *BKE_tracking_indexed_track(struct MovieTracking *tracking, int tracknr, struct ListBase **tracksbase_r);
82
83 void BKE_tracking_camera_shift(struct MovieTracking *tracking, int winx, int winy, float *shiftx, float *shifty);
84 void BKE_tracking_camera_to_blender(struct MovieTracking *tracking, struct Scene *scene, struct Camera *camera, int width, int height);
85
86 void BKE_get_tracking_mat(struct Scene *scene, struct Object *ob, float mat[4][4]);
87 void BKE_tracking_projection_matrix(struct MovieTracking *tracking, struct MovieTrackingObject *object,
88                         int framenr, int winx, int winy, float mat[4][4]);
89
90 struct ListBase *BKE_tracking_get_tracks(struct MovieTracking *tracking);
91 struct MovieTrackingReconstruction *BKE_tracking_get_reconstruction(struct MovieTracking *tracking);
92
93 struct MovieTrackingTrack *BKE_tracking_active_track(struct MovieTracking *tracking);
94 struct MovieTrackingObject *BKE_tracking_active_object(struct MovieTracking *tracking);
95 struct MovieTrackingObject *BKE_tracking_get_camera_object(struct MovieTracking *tracking);
96 struct ListBase *BKE_tracking_object_tracks(struct MovieTracking *tracking, struct MovieTrackingObject *object);
97 struct MovieTrackingReconstruction *BKE_tracking_object_reconstruction(struct MovieTracking *tracking,
98                         struct MovieTrackingObject *object);
99
100 void BKE_tracking_disable_imbuf_channels(struct ImBuf *ibuf, int disable_red, int disable_green, int disable_blue, int grayscale);
101
102 /* clipboard */
103 void BKE_tracking_free_clipboard(void);
104 void BKE_tracking_clipboard_copy_tracks(struct MovieTracking *tracking, struct MovieTrackingObject *object);
105 int BKE_tracking_clipboard_has_tracks(void);
106 void BKE_tracking_clipboard_paste_tracks(struct MovieTracking *tracking, struct MovieTrackingObject *object);
107
108 /* 2D tracking */
109 struct MovieTrackingContext *BKE_tracking_context_new(struct MovieClip *clip, struct MovieClipUser *user,
110                         short backwards, short sequence);
111 void BKE_tracking_context_free(struct MovieTrackingContext *context);
112 void BKE_tracking_sync(struct MovieTrackingContext *context);
113 void BKE_tracking_sync_user(struct MovieClipUser *user, struct MovieTrackingContext *context);
114 int BKE_tracking_next(struct MovieTrackingContext *context);
115
116 /* Camera solving */
117 int BKE_tracking_can_reconstruct(struct MovieTracking *tracking, struct MovieTrackingObject *object,
118                         char *error_msg, int error_size);
119
120 struct MovieReconstructContext* BKE_tracking_reconstruction_context_new(struct MovieTracking *tracking,
121                         struct MovieTrackingObject *object, int keyframe1, int keyframe2, int width, int height);
122 void BKE_tracking_reconstruction_context_free(struct MovieReconstructContext *context);
123 void BKE_tracking_solve_reconstruction(struct MovieReconstructContext *context,
124                         short *stop, short *do_update, float *progress, char *stats_message, int message_size);
125 int BKE_tracking_finish_reconstruction(struct MovieReconstructContext *context, struct MovieTracking *tracking);
126
127 struct MovieReconstructedCamera *BKE_tracking_get_reconstructed_camera(struct MovieTracking *tracking,
128                         struct MovieTrackingObject *object, int framenr);
129 void BKE_tracking_get_interpolated_camera(struct MovieTracking *tracking,
130                         struct MovieTrackingObject *object, int framenr, float mat[4][4]);
131
132 /* Feature detection */
133 void BKE_tracking_detect_fast(struct MovieTracking *tracking, struct ListBase *tracksbase, struct ImBuf *imbuf,
134                         int framenr, int margin, int min_trackness, int min_distance, struct bGPDlayer *layer,
135                         int place_outside_layer);
136
137 /* 2D stabilization */
138 void BKE_tracking_stabilization_data(struct MovieTracking *tracking, int framenr, int width, int height, float loc[2], float *scale, float *angle);
139 struct ImBuf *BKE_tracking_stabilize(struct MovieTracking *tracking, int framenr, struct ImBuf *ibuf, float loc[2], float *scale, float *angle);
140 void BKE_tracking_stabdata_to_mat4(int width, int height, float loc[2], float scale, float angle, float mat[4][4]);
141
142 /* Distortion/Undistortion */
143 void BKE_tracking_apply_intrinsics(struct MovieTracking *tracking, float co[2], float nco[2]);
144 void BKE_tracking_invert_intrinsics(struct MovieTracking *tracking, float co[2], float nco[2]);
145
146 struct MovieDistortion *BKE_tracking_distortion_create(void);
147 struct MovieDistortion *BKE_tracking_distortion_copy(struct MovieDistortion *distortion);
148 struct ImBuf *BKE_tracking_distortion_exec(struct MovieDistortion *distortion, struct MovieTracking *tracking,
149                         struct ImBuf *ibuf, int width, int height, float overscan, int undistort);
150 void BKE_tracking_distortion_destroy(struct MovieDistortion *distortion);
151
152 struct ImBuf *BKE_tracking_undistort(struct MovieTracking *tracking, struct ImBuf *ibuf, int width, int height, float overscan);
153 struct ImBuf *BKE_tracking_distort(struct MovieTracking *tracking, struct ImBuf *ibuf, int width, int height, float overscan);
154
155 /* Object tracking */
156 struct MovieTrackingObject *BKE_tracking_new_object(struct MovieTracking *tracking, const char *name);
157 void BKE_tracking_remove_object(struct MovieTracking *tracking, struct MovieTrackingObject *object);
158 void BKE_tracking_object_unique_name(struct MovieTracking *tracking, struct MovieTrackingObject *object);
159 struct MovieTrackingObject *BKE_tracking_named_object(struct MovieTracking *tracking, const char *name);
160
161 /* Select */
162 void BKE_tracking_select_track(struct ListBase *tracksbase, struct MovieTrackingTrack *track, int area, int extend);
163 void BKE_tracking_deselect_track(struct MovieTrackingTrack *track, int area);
164
165 #define TRACK_SELECTED(track)                           ((((track)->flag&TRACK_HIDDEN)==0) && ((track)->flag&SELECT || (track)->pat_flag&SELECT || (track)->search_flag&SELECT))
166 #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)))
167 #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)))))
168
169 #define MARKER_VISIBLE(sc, marker)                      (((marker)->flag&MARKER_DISABLED)==0 || ((sc)->flag&SC_HIDE_DISABLED)==0)
170
171 #define TRACK_CLEAR_UPTO                0
172 #define TRACK_CLEAR_REMAINED    1
173 #define TRACK_CLEAR_ALL                 2
174
175 #define CLAMP_PAT_DIM           1
176 #define CLAMP_PAT_POS           2
177 #define CLAMP_SEARCH_DIM        3
178 #define CLAMP_SEARCH_POS        4
179 #define CLAMP_PYRAMID_LEVELS    5
180
181 #define TRACK_AREA_NONE         -1
182 #define TRACK_AREA_POINT        1
183 #define TRACK_AREA_PAT          2
184 #define TRACK_AREA_SEARCH       4
185
186 #define TRACK_AREA_ALL          (TRACK_AREA_POINT|TRACK_AREA_PAT|TRACK_AREA_SEARCH)
187
188 #endif