Merged changes in the trunk up to revision 42116.
[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 MovieTrackingTrack;
38 struct MovieTrackingMarker;
39 struct MovieTracking;
40 struct MovieTrackingContext;
41 struct MovieClipUser;
42 struct MovieDistortion;
43 struct Camera;
44 struct Object;
45 struct Scene;
46
47 void BKE_tracking_clamp_track(struct MovieTrackingTrack *track, int event);
48 void BKE_tracking_track_flag(struct MovieTrackingTrack *track, int area, int flag, int clear);
49
50 struct MovieTrackingTrack *BKE_tracking_add_track(struct MovieTracking *tracking, float x, float y,
51                         int framenr, int width, int height);
52 void BKE_tracking_insert_marker(struct MovieTrackingTrack *track, struct MovieTrackingMarker *marker);
53 void BKE_tracking_delete_marker(struct MovieTrackingTrack *track, int framenr);
54
55 struct MovieTrackingMarker *BKE_tracking_get_marker(struct MovieTrackingTrack *track, int framenr);
56 struct MovieTrackingMarker *BKE_tracking_ensure_marker(struct MovieTrackingTrack *track, int framenr);
57 struct MovieTrackingMarker *BKE_tracking_exact_marker(struct MovieTrackingTrack *track, int framenr);
58 int BKE_tracking_has_marker(struct MovieTrackingTrack *track, int framenr);
59
60 void BKE_tracking_free_track(struct MovieTrackingTrack *track);
61 struct MovieTrackingTrack *BKE_tracking_copy_track(struct MovieTrackingTrack *track);
62
63 void BKE_tracking_clear_path(struct MovieTrackingTrack *track, int ref_frame, int action);
64
65 int BKE_tracking_test_join_tracks(struct MovieTrackingTrack *dst_track, struct MovieTrackingTrack *src_track);
66 void BKE_tracking_join_tracks(struct MovieTrackingTrack *dst_track, struct MovieTrackingTrack *src_track);
67 void BKE_tracking_free(struct MovieTracking *tracking);
68
69 struct ImBuf *BKE_tracking_get_pattern_imbuf(struct ImBuf *ibuf, struct MovieTrackingTrack *track,
70                         struct MovieTrackingMarker *marker, int margin, int anchored, float pos[2], int origin[2]);
71 struct ImBuf *BKE_tracking_get_search_imbuf(struct ImBuf *ibuf, struct MovieTrackingTrack *track,
72                         struct MovieTrackingMarker *marker, int margin, int anchored, float pos[2], int origin[2]);
73
74 void BKE_track_unique_name(struct MovieTracking *tracking, struct MovieTrackingTrack *track);
75
76 struct MovieTrackingTrack *BKE_tracking_named_track(struct MovieTracking *tracking, const char *name);
77 struct MovieTrackingTrack *BKE_tracking_indexed_track(struct MovieTracking *tracking, int tracknr);
78
79 void BKE_tracking_camera_shift(struct MovieTracking *tracking, int winx, int winy, float *shiftx, float *shifty);
80 void BKE_tracking_camera_to_blender(struct MovieTracking *tracking, struct Scene *scene, struct Camera *camera, int width, int height);
81
82 void BKE_get_tracking_mat(struct Scene *scene, struct Object *ob, float mat[4][4]);
83 void BKE_tracking_projection_matrix(struct MovieTracking *tracking, int framenr, int winx, int winy, float mat[4][4]);
84
85 /* 2D tracking */
86 struct MovieTrackingContext *BKE_tracking_context_new(struct MovieClip *clip, struct MovieClipUser *user,
87                         short backwards, short disable_failed);
88 void BKE_tracking_context_free(struct MovieTrackingContext *context);
89 void BKE_tracking_sync(struct MovieTrackingContext *context);
90 void BKE_tracking_sync_user(struct MovieClipUser *user, struct MovieTrackingContext *context);
91 int BKE_tracking_next(struct MovieTrackingContext *context);
92
93 /* Camera solving */
94 int BKE_tracking_can_solve(struct MovieTracking *tracking, char *error_msg, int error_size);
95
96 float BKE_tracking_solve_reconstruction(struct MovieTracking *tracking, int width, int height);
97
98 struct MovieReconstructedCamera *BKE_tracking_get_reconstructed_camera(struct MovieTracking *tracking, int framenr);
99 void BKE_tracking_get_interpolated_camera(struct MovieTracking *tracking, int framenr, float mat[4][4]);
100
101 /* Feature detection */
102 void BKE_tracking_detect_fast(struct MovieTracking *tracking, struct ImBuf *imbuf,
103                         int framenr, int margin, int min_trackness, int min_distance, struct bGPDlayer *layer,
104                         int place_outside_layer);
105
106 /* 2D stabilization */
107 void BKE_tracking_stabilization_data(struct MovieTracking *tracking, int framenr, int width, int height, float loc[2], float *scale, float *angle);
108 struct ImBuf *BKE_tracking_stabilize(struct MovieTracking *tracking, int framenr, struct ImBuf *ibuf, float loc[2], float *scale, float *angle);
109 void BKE_tracking_stabdata_to_mat4(int width, int height, float loc[2], float scale, float angle, float mat[4][4]);
110
111 /* Distortion/Undistortion */
112 void BKE_tracking_apply_intrinsics(struct MovieTracking *tracking, float co[2], float nco[2]);
113 void BKE_tracking_invert_intrinsics(struct MovieTracking *tracking, float co[2], float nco[2]);
114
115 struct MovieDistortion *BKE_tracking_distortion_create(void);
116 struct MovieDistortion *BKE_tracking_distortion_copy(struct MovieDistortion *distortion);
117 struct ImBuf *BKE_tracking_distortion_exec(struct MovieDistortion *distortion, struct MovieTracking *tracking,
118                         struct ImBuf *ibuf, int width, int height, float overscan, int undistort);
119 void BKE_tracking_distortion_destroy(struct MovieDistortion *distortion);
120
121 struct ImBuf *BKE_tracking_undistort(struct MovieTracking *tracking, struct ImBuf *ibuf, int width, int height, float overscan);
122 struct ImBuf *BKE_tracking_distort(struct MovieTracking *tracking, struct ImBuf *ibuf, int width, int height, float overscan);
123
124 /* Select */
125 void BKE_tracking_select_track(struct MovieTracking *tracking, struct MovieTrackingTrack *track, int area, int extend);
126 void BKE_tracking_deselect_track(struct MovieTrackingTrack *track, int area);
127
128 #define TRACK_SELECTED(track)                           ((((track)->flag&TRACK_HIDDEN)==0) && ((track)->flag&SELECT || (track)->pat_flag&SELECT || (track)->search_flag&SELECT))
129 #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)))
130 #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)))))
131
132 #define MARKER_VISIBLE(sc, marker)                      (((marker)->flag&MARKER_DISABLED)==0 || ((sc)->flag&SC_HIDE_DISABLED)==0)
133
134 #define CLAMP_PAT_DIM           1
135 #define CLAMP_PAT_POS           2
136 #define CLAMP_SEARCH_DIM        3
137 #define CLAMP_SEARCH_POS        4
138 #define CLAMP_PYRAMID_LEVELS    5
139
140 #define TRACK_AREA_NONE         -1
141 #define TRACK_AREA_POINT        1
142 #define TRACK_AREA_PAT          2
143 #define TRACK_AREA_SEARCH       4
144
145 #define TRACK_AREA_ALL          (TRACK_AREA_POINT|TRACK_AREA_PAT|TRACK_AREA_SEARCH)
146
147 #endif