change clip utility function arguments to take space data and region rather then...
[blender.git] / source / blender / editors / space_clip / clip_buttons.c
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  *
22  * Contributor(s): Blender Foundation,
23  *                 Sergey Sharybin
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/editors/space_clip/clip_buttons.c
29  *  \ingroup spclip
30  */
31
32 #include <string.h>
33 #include <stdio.h>
34
35 #include "MEM_guardedalloc.h"
36
37 #include "DNA_scene_types.h"
38 #include "DNA_screen_types.h"
39 #include "DNA_space_types.h"
40
41 #include "BLI_math.h"
42 #include "BLI_utildefines.h"
43 #include "BLI_listbase.h"
44
45 #include "BKE_context.h"
46 #include "BKE_depsgraph.h"
47 #include "BKE_screen.h"
48 #include "BKE_movieclip.h"
49 #include "BKE_tracking.h"
50
51 #include "ED_clip.h"
52 #include "ED_gpencil.h"
53
54 #include "UI_interface.h"
55 #include "UI_resources.h"
56
57 #include "RNA_access.h"
58
59 #include "WM_api.h"
60 #include "WM_types.h"
61
62 #include "clip_intern.h"  /* own include */
63
64 /* Panels */
65
66 static int clip_grease_pencil_panel_poll(const bContext *C, PanelType *UNUSED(pt))
67 {
68         SpaceClip *sc = CTX_wm_space_clip(C);
69
70         return sc->view == SC_VIEW_CLIP;
71 }
72
73 void ED_clip_buttons_register(ARegionType *art)
74 {
75         PanelType *pt;
76
77         pt = MEM_callocN(sizeof(PanelType), "spacetype clip panel gpencil");
78         strcpy(pt->idname, "CLIP_PT_gpencil");
79         strcpy(pt->label, "Grease Pencil");
80         pt->draw = gpencil_panel_standard;
81         pt->flag |= PNL_DEFAULT_CLOSED;
82         pt->poll = clip_grease_pencil_panel_poll;
83         BLI_addtail(&art->paneltypes, pt);
84 }
85
86 /********************* MovieClip Template ************************/
87
88 void uiTemplateMovieClip(uiLayout *layout, bContext *C, PointerRNA *ptr, const char *propname, int compact)
89 {
90         PropertyRNA *prop;
91         PointerRNA clipptr;
92         MovieClip *clip;
93         uiLayout *row, *split;
94         uiBlock *block;
95
96         if (!ptr->data)
97                 return;
98
99         prop = RNA_struct_find_property(ptr, propname);
100         if (!prop) {
101                 printf("%s: property not found: %s.%s\n",
102                        __func__, RNA_struct_identifier(ptr->type), propname);
103                 return;
104         }
105
106         if (RNA_property_type(prop) != PROP_POINTER) {
107                 printf("%s: expected pointer property for %s.%s\n",
108                        __func__, RNA_struct_identifier(ptr->type), propname);
109                 return;
110         }
111
112         clipptr = RNA_property_pointer_get(ptr, prop);
113         clip = clipptr.data;
114
115         uiLayoutSetContextPointer(layout, "edit_movieclip", &clipptr);
116
117         if (!compact)
118                 uiTemplateID(layout, C, ptr, propname, NULL, "CLIP_OT_open", NULL);
119
120         if (clip) {
121                 row = uiLayoutRow(layout, FALSE);
122                 block = uiLayoutGetBlock(row);
123                 uiDefBut(block, LABEL, 0, "File Path:", 0, 19, 145, 19, NULL, 0, 0, 0, 0, "");
124
125                 row = uiLayoutRow(layout, FALSE);
126                 split = uiLayoutSplit(row, 0.0f, FALSE);
127                 row = uiLayoutRow(split, TRUE);
128
129                 uiItemR(row, &clipptr, "filepath", 0, "", ICON_NONE);
130                 uiItemO(row, "", ICON_FILE_REFRESH, "clip.reload");
131         }
132 }
133
134 /********************* Track Template ************************/
135
136 void uiTemplateTrack(uiLayout *layout, PointerRNA *ptr, const char *propname)
137 {
138         PropertyRNA *prop;
139         PointerRNA scopesptr;
140         uiBlock *block;
141         rctf rect;
142         MovieClipScopes *scopes;
143
144         if (!ptr->data)
145                 return;
146
147         prop = RNA_struct_find_property(ptr, propname);
148         if (!prop) {
149                 printf("%s: property not found: %s.%s\n",
150                        __func__, RNA_struct_identifier(ptr->type), propname);
151                 return;
152         }
153
154         if (RNA_property_type(prop) != PROP_POINTER) {
155                 printf("%s: expected pointer property for %s.%s\n",
156                        __func__, RNA_struct_identifier(ptr->type), propname);
157                 return;
158         }
159
160         scopesptr = RNA_property_pointer_get(ptr, prop);
161         scopes = (MovieClipScopes *)scopesptr.data;
162
163         rect.xmin = 0; rect.xmax = 200;
164         rect.ymin = 0; rect.ymax = 120;
165
166         block = uiLayoutAbsoluteBlock(layout);
167
168         scopes->track_preview_height =
169                 (scopes->track_preview_height <= UI_UNIT_Y) ? UI_UNIT_Y : scopes->track_preview_height;
170
171         uiDefBut(block, TRACKPREVIEW, 0, "", rect.xmin, rect.ymin, rect.xmax - rect.xmin,
172                  scopes->track_preview_height, scopes, 0, 0, 0, 0, "");
173 }
174
175 /********************* Marker Template ************************/
176
177 #define B_MARKER_POS            3
178 #define B_MARKER_OFFSET         4
179 #define B_MARKER_PAT_DIM        5
180 #define B_MARKER_SEARCH_POS     6
181 #define B_MARKER_SEARCH_DIM     7
182 #define B_MARKER_FLAG           8
183
184 typedef struct {
185         int compact;                                /* compact mode */
186
187         MovieClip *clip;
188         MovieClipUser *user;                        /* user of clip */
189         MovieTrackingTrack *track;
190         MovieTrackingMarker *marker;
191
192         int framenr;                                    /* current frame number */
193         float marker_pos[2];                            /* position of marker in pixel coords */
194         float marker_pat[2];                            /* position and dimensions of marker pattern in pixel coords */
195         float track_offset[2];                          /* offset of "parenting" point */
196         float marker_search_pos[2], marker_search[2];   /* position and dimensions of marker search in pixel coords */
197         int marker_flag;                                /* marker's flags */
198 } MarkerUpdateCb;
199
200 static void to_pixel_space(float r[2], float a[2], int width, int height)
201 {
202         copy_v2_v2(r, a);
203         r[0] *= width;
204         r[1] *= height;
205 }
206
207 static void marker_update_cb(bContext *C, void *arg_cb, void *UNUSED(arg))
208 {
209         MarkerUpdateCb *cb = (MarkerUpdateCb *) arg_cb;
210         MovieTrackingMarker *marker;
211
212         if (!cb->compact)
213                 return;
214
215         marker = BKE_tracking_marker_ensure(cb->track, cb->framenr);
216
217         marker->flag = cb->marker_flag;
218
219         WM_event_add_notifier(C, NC_MOVIECLIP | NA_EDITED, NULL);
220 }
221
222 static void marker_block_handler(bContext *C, void *arg_cb, int event)
223 {
224         MarkerUpdateCb *cb = (MarkerUpdateCb *) arg_cb;
225         MovieTrackingMarker *marker;
226         int width, height, ok = FALSE;
227
228         BKE_movieclip_get_size(cb->clip, cb->user, &width, &height);
229
230         marker = BKE_tracking_marker_ensure(cb->track, cb->framenr);
231
232         if (event == B_MARKER_POS) {
233                 marker->pos[0] = cb->marker_pos[0] / width;
234                 marker->pos[1] = cb->marker_pos[1] / height;
235
236                 /* to update position of "parented" objects */
237                 DAG_id_tag_update(&cb->clip->id, 0);
238                 WM_event_add_notifier(C, NC_SPACE | ND_SPACE_VIEW3D, NULL);
239
240                 ok = TRUE;
241         }
242         else if (event == B_MARKER_PAT_DIM) {
243                 float dim[2], pat_dim[2], pat_min[2], pat_max[2];
244                 float scale_x, scale_y;
245                 int a;
246
247                 BKE_tracking_marker_pattern_minmax(cb->marker, pat_min, pat_max);
248
249                 sub_v2_v2v2(pat_dim, pat_max, pat_min);
250
251                 dim[0] = cb->marker_pat[0] / width;
252                 dim[1] = cb->marker_pat[1] / height;
253
254                 scale_x = dim[0] / pat_dim[0];
255                 scale_y = dim[1] / pat_dim[1];
256
257                 for (a = 0; a < 4; a++) {
258                         cb->marker->pattern_corners[a][0] *= scale_x;
259                         cb->marker->pattern_corners[a][1] *= scale_y;
260                 }
261
262                 BKE_tracking_marker_clamp(cb->marker, CLAMP_PAT_DIM);
263
264                 ok = TRUE;
265         }
266         else if (event == B_MARKER_SEARCH_POS) {
267                 float delta[2], side[2];
268
269                 sub_v2_v2v2(side, cb->marker->search_max, cb->marker->search_min);
270                 mul_v2_fl(side, 0.5f);
271
272                 delta[0] = cb->marker_search_pos[0] / width;
273                 delta[1] = cb->marker_search_pos[1] / height;
274
275                 sub_v2_v2v2(cb->marker->search_min, delta, side);
276                 add_v2_v2v2(cb->marker->search_max, delta, side);
277
278                 BKE_tracking_marker_clamp(cb->marker, CLAMP_SEARCH_POS);
279
280                 ok = TRUE;
281         }
282         else if (event == B_MARKER_SEARCH_DIM) {
283                 float dim[2], search_dim[2];
284
285                 sub_v2_v2v2(search_dim, cb->marker->search_max, cb->marker->search_min);
286
287                 dim[0] = cb->marker_search[0] / width;
288                 dim[1] = cb->marker_search[1] / height;
289
290                 sub_v2_v2(dim, search_dim);
291                 mul_v2_fl(dim, 0.5f);
292
293                 cb->marker->search_min[0] -= dim[0];
294                 cb->marker->search_min[1] -= dim[1];
295
296                 cb->marker->search_max[0] += dim[0];
297                 cb->marker->search_max[1] += dim[1];
298
299                 BKE_tracking_marker_clamp(cb->marker, CLAMP_SEARCH_DIM);
300
301                 ok = TRUE;
302         }
303         else if (event == B_MARKER_FLAG) {
304                 marker->flag = cb->marker_flag;
305
306                 ok = TRUE;
307         }
308         else if (event == B_MARKER_OFFSET) {
309                 float offset[2], delta[2];
310                 int i;
311
312                 offset[0] = cb->track_offset[0] / width;
313                 offset[1] = cb->track_offset[1] / height;
314
315                 sub_v2_v2v2(delta, offset, cb->track->offset);
316                 copy_v2_v2(cb->track->offset, offset);
317
318                 for (i = 0; i < cb->track->markersnr; i++)
319                         sub_v2_v2(cb->track->markers[i].pos, delta);
320
321                 /* to update position of "parented" objects */
322                 DAG_id_tag_update(&cb->clip->id, 0);
323                 WM_event_add_notifier(C, NC_SPACE | ND_SPACE_VIEW3D, NULL);
324
325                 ok = TRUE;
326         }
327
328         if (ok)
329                 WM_event_add_notifier(C, NC_MOVIECLIP | NA_EDITED, cb->clip);
330 }
331
332 void uiTemplateMarker(uiLayout *layout, PointerRNA *ptr, const char *propname, PointerRNA *userptr,
333                       PointerRNA *trackptr, int compact)
334 {
335         PropertyRNA *prop;
336         uiBlock *block;
337         uiBut *bt;
338         PointerRNA clipptr;
339         MovieClip *clip;
340         MovieClipUser *user;
341         MovieTrackingTrack *track;
342         MovieTrackingMarker *marker;
343         MarkerUpdateCb *cb;
344         const char *tip;
345         float pat_min[2], pat_max[2];
346
347         if (!ptr->data)
348                 return;
349
350         prop = RNA_struct_find_property(ptr, propname);
351         if (!prop) {
352                 printf("%s: property not found: %s.%s\n",
353                        __func__, RNA_struct_identifier(ptr->type), propname);
354                 return;
355         }
356
357         if (RNA_property_type(prop) != PROP_POINTER) {
358                 printf("%s: expected pointer property for %s.%s\n",
359                        __func__, RNA_struct_identifier(ptr->type), propname);
360                 return;
361         }
362
363         clipptr = RNA_property_pointer_get(ptr, prop);
364         clip = (MovieClip *)clipptr.data;
365         user = userptr->data;
366         track = trackptr->data;
367
368         marker = BKE_tracking_marker_get(track, user->framenr);
369
370         cb = MEM_callocN(sizeof(MarkerUpdateCb), "uiTemplateMarker update_cb");
371         cb->compact = compact;
372         cb->clip = clip;
373         cb->user = user;
374         cb->track = track;
375         cb->marker = marker;
376         cb->marker_flag = marker->flag;
377         cb->framenr = user->framenr;
378
379         if (compact) {
380                 block = uiLayoutGetBlock(layout);
381
382                 if (cb->marker_flag & MARKER_DISABLED)
383                         tip = "Marker is disabled at current frame";
384                 else
385                         tip = "Marker is enabled at current frame";
386
387                 bt = uiDefIconButBitI(block, TOGN, MARKER_DISABLED, 0, ICON_RESTRICT_VIEW_OFF, 0, 0, 20, 20,
388                                       &cb->marker_flag, 0, 0, 1, 0, tip);
389                 uiButSetNFunc(bt, marker_update_cb, cb, NULL);
390         }
391         else {
392                 int width, height, step, digits;
393                 float pat_dim[2], search_dim[2], search_pos[2];
394                 uiLayout *col;
395
396                 BKE_movieclip_get_size(clip, user, &width, &height);
397
398                 if (track->flag & TRACK_LOCKED) {
399                         uiLayoutSetActive(layout, FALSE);
400                         block = uiLayoutAbsoluteBlock(layout);
401                         uiDefBut(block, LABEL, 0, "Track is locked", 0, 0, 300, 19, NULL, 0, 0, 0, 0, "");
402
403                         return;
404                 }
405
406                 step = 100;
407                 digits = 2;
408
409                 BKE_tracking_marker_pattern_minmax(marker, pat_min, pat_max);
410
411                 sub_v2_v2v2(pat_dim, pat_max, pat_min);
412                 sub_v2_v2v2(search_dim, marker->search_max, marker->search_min);
413
414                 add_v2_v2v2(search_pos, marker->search_max, marker->search_min);
415                 mul_v2_fl(search_pos, 0.5);
416
417                 to_pixel_space(cb->marker_pos, marker->pos, width, height);
418                 to_pixel_space(cb->marker_pat, pat_dim, width, height);
419                 to_pixel_space(cb->marker_search, search_dim, width, height);
420                 to_pixel_space(cb->marker_search_pos, search_pos, width, height);
421                 to_pixel_space(cb->track_offset, track->offset, width, height);
422
423                 cb->marker_flag = marker->flag;
424
425                 block = uiLayoutAbsoluteBlock(layout);
426                 uiBlockSetHandleFunc(block, marker_block_handler, cb);
427                 uiBlockSetNFunc(block, marker_update_cb, cb, NULL);
428
429                 if (cb->marker_flag & MARKER_DISABLED)
430                         tip = "Marker is disabled at current frame";
431                 else
432                         tip = "Marker is enabled at current frame";
433
434                 uiDefButBitI(block, OPTIONN, MARKER_DISABLED, B_MARKER_FLAG,  "Enabled", 10, 190, 145, 19, &cb->marker_flag,
435                              0, 0, 0, 0, tip);
436
437                 col = uiLayoutColumn(layout, TRUE);
438                 uiLayoutSetActive(col, (cb->marker_flag & MARKER_DISABLED) == 0);
439
440                 block = uiLayoutAbsoluteBlock(col);
441                 uiBlockBeginAlign(block);
442
443                 uiDefBut(block, LABEL, 0, "Position:", 0, 190, 300, 19, NULL, 0, 0, 0, 0, "");
444                 uiDefButF(block, NUM, B_MARKER_POS, "X:", 10, 171, 145, 19, &cb->marker_pos[0],
445                           -10 * width, 10.0 * width, step, digits, "X-position of marker at frame in screen coordinates");
446                 uiDefButF(block, NUM, B_MARKER_POS, "Y:", 165, 171, 145, 19, &cb->marker_pos[1],
447                           -10 * height, 10.0 * height, step, digits, "Y-position of marker at frame in screen coordinates");
448
449                 uiDefBut(block, LABEL, 0, "Offset:", 0, 152, 300, 19, NULL, 0, 0, 0, 0, "");
450                 uiDefButF(block, NUM, B_MARKER_OFFSET, "X:", 10, 133, 145, 19, &cb->track_offset[0],
451                           -10 * width, 10.0 * width, step, digits, "X-offset to parenting point");
452                 uiDefButF(block, NUM, B_MARKER_OFFSET, "Y:", 165, 133, 145, 19, &cb->track_offset[1],
453                           -10 * height, 10.0 * height, step, digits, "Y-offset to parenting point");
454
455                 uiDefBut(block, LABEL, 0, "Pattern Area:", 0, 114, 300, 19, NULL, 0, 0, 0, 0, "");
456                 uiDefButF(block, NUM, B_MARKER_PAT_DIM, "Width:", 10, 95, 300, 19, &cb->marker_pat[0], 3.0f,
457                           10.0 * width, step, digits, "Width of marker's pattern in screen coordinates");
458                 uiDefButF(block, NUM, B_MARKER_PAT_DIM, "Height:", 10, 76, 300, 19, &cb->marker_pat[1], 3.0f,
459                           10.0 * height, step, digits, "Height of marker's pattern in screen coordinates");
460
461                 uiDefBut(block, LABEL, 0, "Search Area:", 0, 57, 300, 19, NULL, 0, 0, 0, 0, "");
462                 uiDefButF(block, NUM, B_MARKER_SEARCH_POS, "X:", 10, 38, 145, 19, &cb->marker_search_pos[0],
463                           -width, width, step, digits, "X-position of search at frame relative to marker's position");
464                 uiDefButF(block, NUM, B_MARKER_SEARCH_POS, "Y:", 165, 38, 145, 19, &cb->marker_search_pos[1],
465                           -height, height, step, digits, "X-position of search at frame relative to marker's position");
466                 uiDefButF(block, NUM, B_MARKER_SEARCH_DIM, "Width:", 10, 19, 300, 19, &cb->marker_search[0], 3.0f,
467                           10.0 * width, step, digits, "Width of marker's search in screen soordinates");
468                 uiDefButF(block, NUM, B_MARKER_SEARCH_DIM, "Height:", 10, 0, 300, 19, &cb->marker_search[1], 3.0f,
469                           10.0 * height, step, digits, "Height of marker's search in screen soordinates");
470
471                 uiBlockEndAlign(block);
472         }
473 }