Cleanup up space clip API:
[blender.git] / source / blender / editors / space_clip / clip_editor.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_editor.c
29  *  \ingroup spclip
30  */
31
32 #include <stddef.h>
33
34 #include "MEM_guardedalloc.h"
35
36 #include "BKE_main.h"
37 #include "BKE_mask.h"
38 #include "BKE_movieclip.h"
39 #include "BKE_context.h"
40 #include "BKE_tracking.h"
41
42 #include "DNA_mask_types.h"
43 #include "DNA_object_types.h"   /* SELECT */
44
45 #include "BLI_utildefines.h"
46 #include "BLI_math.h"
47
48 #include "GPU_extensions.h"
49
50 #include "IMB_imbuf_types.h"
51 #include "IMB_imbuf.h"
52
53 #include "ED_screen.h"
54 #include "ED_clip.h"
55
56 #include "BIF_gl.h"
57 #include "BIF_glutil.h"
58
59 #include "WM_api.h"
60 #include "WM_types.h"
61
62 #include "UI_view2d.h"
63
64 #include "clip_intern.h"        // own include
65
66 /* ******** operactor poll functions ******** */
67
68 int ED_space_clip_poll(bContext *C)
69 {
70         SpaceClip *sc = CTX_wm_space_clip(C);
71
72         if (sc && sc->clip)
73                 return TRUE;
74
75         return FALSE;
76 }
77
78 int ED_space_clip_view_clip_poll(bContext *C)
79 {
80         SpaceClip *sc = CTX_wm_space_clip(C);
81
82         if (sc && sc->clip) {
83                 return sc->view == SC_VIEW_CLIP;
84         }
85
86         return FALSE;
87 }
88
89 int ED_space_clip_tracking_poll(bContext *C)
90 {
91         SpaceClip *sc = CTX_wm_space_clip(C);
92
93         if (sc && sc->clip)
94                 return ED_space_clip_check_show_trackedit(sc);
95
96         return FALSE;
97 }
98
99 int ED_space_clip_maskedit_poll(bContext *C)
100 {
101         SpaceClip *sc = CTX_wm_space_clip(C);
102
103         if (sc && sc->clip) {
104                 return ED_space_clip_check_show_maskedit(sc);
105         }
106
107         return FALSE;
108 }
109
110 int ED_space_clip_maskedit_mask_poll(bContext *C)
111 {
112         if (ED_space_clip_maskedit_poll(C)) {
113                 MovieClip *clip = CTX_data_edit_movieclip(C);
114
115                 if (clip) {
116                         SpaceClip *sc = CTX_wm_space_clip(C);
117
118                         return sc->mask != NULL;
119                 }
120         }
121
122         return FALSE;
123 }
124
125 /* ******** common editing functions ******** */
126
127 void ED_space_clip_get_size(const bContext *C, int *width, int *height)
128 {
129         SpaceClip *sc = CTX_wm_space_clip(C);
130
131         if (!sc->clip) {
132                 *width = *height = 0;
133         }
134         else {
135                 BKE_movieclip_get_size(sc->clip, &sc->user, width, height);
136         }
137 }
138
139 void ED_space_clip_get_zoom(const bContext *C, float *zoomx, float *zoomy)
140 {
141         ARegion *ar = CTX_wm_region(C);
142         int width, height;
143
144         ED_space_clip_get_size(C, &width, &height);
145
146         *zoomx = (float)(ar->winrct.xmax - ar->winrct.xmin + 1) / (float)((ar->v2d.cur.xmax - ar->v2d.cur.xmin) * width);
147         *zoomy = (float)(ar->winrct.ymax - ar->winrct.ymin + 1) / (float)((ar->v2d.cur.ymax - ar->v2d.cur.ymin) * height);
148 }
149
150 void ED_space_clip_get_aspect(SpaceClip *sc, float *aspx, float *aspy)
151 {
152         MovieClip *clip = ED_space_clip_get_clip(sc);
153
154         if (clip)
155                 BKE_movieclip_aspect(clip, aspx, aspy);
156         else
157                 *aspx = *aspy = 1.0f;
158
159         if (*aspx < *aspy) {
160                 *aspy = *aspy / *aspx;
161                 *aspx = 1.0f;
162         }
163         else {
164                 *aspx = *aspx / *aspy;
165                 *aspy = 1.0f;
166         }
167 }
168
169 void ED_space_clip_get_aspect_dimension_aware(SpaceClip *sc, float *aspx, float *aspy)
170 {
171         int w, h;
172
173         /* most of tools does not require aspect to be returned with dimensions correction
174          * due to they're invariant to this stuff, but some transformation tools like rotation
175          * should be aware of aspect correction caused by different resolution in different
176          * directions.
177          * mainly this is sued for transformation stuff
178          */
179
180         ED_space_clip_get_aspect(sc, aspx, aspy);
181         BKE_movieclip_get_size(sc->clip, &sc->user, &w, &h);
182
183         *aspx *= (float) w;
184         *aspy *= (float) h;
185
186         if (*aspx < *aspy) {
187                 *aspy = *aspy / *aspx;
188                 *aspx = 1.0f;
189         }
190         else {
191                 *aspx = *aspx / *aspy;
192                 *aspy = 1.0f;
193         }
194 }
195
196 /* return current frame number in clip space */
197 int ED_space_clip_get_clip_frame_number(SpaceClip *sc)
198 {
199         MovieClip *clip = ED_space_clip_get_clip(sc);
200
201         return BKE_movieclip_remap_scene_to_clip_frame(clip, sc->user.framenr);
202 }
203
204 ImBuf *ED_space_clip_get_buffer(SpaceClip *sc)
205 {
206         if (sc->clip) {
207                 ImBuf *ibuf;
208
209                 ibuf = BKE_movieclip_get_postprocessed_ibuf(sc->clip, &sc->user, sc->postproc_flag);
210
211                 if (ibuf && (ibuf->rect || ibuf->rect_float))
212                         return ibuf;
213
214                 if (ibuf)
215                         IMB_freeImBuf(ibuf);
216         }
217
218         return NULL;
219 }
220
221 ImBuf *ED_space_clip_get_stable_buffer(SpaceClip *sc, float loc[2], float *scale, float *angle)
222 {
223         if (sc->clip) {
224                 ImBuf *ibuf;
225
226                 ibuf = BKE_movieclip_get_stable_ibuf(sc->clip, &sc->user, loc, scale, angle, sc->postproc_flag);
227
228                 if (ibuf && (ibuf->rect || ibuf->rect_float))
229                         return ibuf;
230
231                 if (ibuf)
232                         IMB_freeImBuf(ibuf);
233         }
234
235         return NULL;
236 }
237
238 void ED_clip_update_frame(const Main *mainp, int cfra)
239 {
240         wmWindowManager *wm;
241         wmWindow *win;
242
243         /* image window, compo node users */
244         for (wm = mainp->wm.first; wm; wm = wm->id.next) { /* only 1 wm */
245                 for (win = wm->windows.first; win; win = win->next) {
246                         ScrArea *sa;
247
248                         for (sa = win->screen->areabase.first; sa; sa = sa->next) {
249                                 if (sa->spacetype == SPACE_CLIP) {
250                                         SpaceClip *sc = sa->spacedata.first;
251
252                                         sc->scopes.ok = FALSE;
253
254                                         BKE_movieclip_user_set_frame(&sc->user, cfra);
255                                 }
256                         }
257                 }
258         }
259 }
260
261 static int selected_boundbox(const bContext *C, float min[2], float max[2])
262 {
263         SpaceClip *sc = CTX_wm_space_clip(C);
264         MovieClip *clip = ED_space_clip_get_clip(sc);
265         MovieTrackingTrack *track;
266         int width, height, ok = FALSE;
267         ListBase *tracksbase = BKE_tracking_get_active_tracks(&clip->tracking);
268
269         INIT_MINMAX2(min, max);
270
271         ED_space_clip_get_size(C, &width, &height);
272
273         track = tracksbase->first;
274         while (track) {
275                 if (TRACK_VIEW_SELECTED(sc, track)) {
276                         MovieTrackingMarker *marker = BKE_tracking_marker_get(track, sc->user.framenr);
277
278                         if (marker) {
279                                 float pos[3];
280
281                                 pos[0] = marker->pos[0] + track->offset[0];
282                                 pos[1] = marker->pos[1] + track->offset[1];
283                                 pos[2] = 0.0f;
284
285                                 /* undistortion happens for normalized coords */
286                                 if (sc->user.render_flag & MCLIP_PROXY_RENDER_UNDISTORT) {
287                                         /* undistortion happens for normalized coords */
288                                         ED_clip_point_undistorted_pos(sc, pos, pos);
289                                 }
290
291                                 pos[0] *= width;
292                                 pos[1] *= height;
293
294                                 mul_v3_m4v3(pos, sc->stabmat, pos);
295
296                                 DO_MINMAX2(pos, min, max);
297
298                                 ok = TRUE;
299                         }
300                 }
301
302                 track = track->next;
303         }
304
305         return ok;
306 }
307
308 int ED_clip_view_selection(const bContext *C, ARegion *ar, int fit)
309 {
310         SpaceClip *sc = CTX_wm_space_clip(C);
311         int w, h, frame_width, frame_height;
312         float min[2], max[2];
313
314         ED_space_clip_get_size(C, &frame_width, &frame_height);
315
316         if (frame_width == 0 || frame_height == 0)
317                 return FALSE;
318
319         if (!selected_boundbox(C, min, max))
320                 return FALSE;
321
322         /* center view */
323         clip_view_center_to_point(C, (max[0] + min[0]) / (2 * frame_width),
324                                      (max[1] + min[1]) / (2 * frame_height));
325
326         w = max[0] - min[0];
327         h = max[1] - min[1];
328
329         /* set zoom to see all selection */
330         if (w > 0 && h > 0) {
331                 int width, height;
332                 float zoomx, zoomy, newzoom, aspx, aspy;
333
334                 ED_space_clip_get_aspect(sc, &aspx, &aspy);
335
336                 width = ar->winrct.xmax - ar->winrct.xmin + 1;
337                 height = ar->winrct.ymax - ar->winrct.ymin + 1;
338
339                 zoomx = (float)width / w / aspx;
340                 zoomy = (float)height / h / aspy;
341
342                 newzoom = 1.0f / power_of_2(1.0f / MIN2(zoomx, zoomy));
343
344                 if (fit || sc->zoom > newzoom)
345                         sc->zoom = newzoom;
346         }
347
348         return TRUE;
349 }
350
351 void ED_clip_point_undistorted_pos(SpaceClip *sc, const float co[2], float r_co[2])
352 {
353         copy_v2_v2(r_co, co);
354
355         if (sc->user.render_flag & MCLIP_PROXY_RENDER_UNDISTORT) {
356                 MovieClip *clip = ED_space_clip_get_clip(sc);
357                 float aspy = 1.0f / clip->tracking.camera.pixel_aspect;
358                 int width, height;
359
360                 BKE_movieclip_get_size(sc->clip, &sc->user, &width, &height);
361
362                 r_co[0] *= width;
363                 r_co[1] *= height * aspy;
364
365                 BKE_tracking_undistort_v2(&clip->tracking, r_co, r_co);
366
367                 r_co[0] /= width;
368                 r_co[1] /= height * aspy;
369         }
370 }
371
372 void ED_clip_point_stable_pos(const bContext *C, float x, float y, float *xr, float *yr)
373 {
374         ARegion *ar = CTX_wm_region(C);
375         SpaceClip *sc = CTX_wm_space_clip(C);
376         int sx, sy, width, height;
377         float zoomx, zoomy, pos[3], imat[4][4];
378
379         ED_space_clip_get_zoom(C, &zoomx, &zoomy);
380         ED_space_clip_get_size(C, &width, &height);
381
382         UI_view2d_to_region_no_clip(&ar->v2d, 0.0f, 0.0f, &sx, &sy);
383
384         pos[0] = (x - sx) / zoomx;
385         pos[1] = (y - sy) / zoomy;
386         pos[2] = 0.0f;
387
388         invert_m4_m4(imat, sc->stabmat);
389         mul_v3_m4v3(pos, imat, pos);
390
391         *xr = pos[0] / width;
392         *yr = pos[1] / height;
393
394         if (sc->user.render_flag & MCLIP_PROXY_RENDER_UNDISTORT) {
395                 MovieClip *clip = ED_space_clip_get_clip(sc);
396                 MovieTracking *tracking = &clip->tracking;
397                 float aspy = 1.0f / tracking->camera.pixel_aspect;
398                 float tmp[2] = {*xr * width, *yr * height * aspy};
399
400                 BKE_tracking_distort_v2(tracking, tmp, tmp);
401
402                 *xr = tmp[0] / width;
403                 *yr = tmp[1] / (height * aspy);
404         }
405 }
406
407 /**
408  * \brief the reverse of ED_clip_point_stable_pos(), gets the marker region coords.
409  * better name here? view_to_track / track_to_view or so?
410  */
411 void ED_clip_point_stable_pos__reverse(const bContext *C, const float co[2], float r_co[2])
412 {
413         SpaceClip *sc = CTX_wm_space_clip(C);
414         ARegion *ar = CTX_wm_region(C);
415         float zoomx, zoomy;
416         float pos[3];
417         int width, height;
418         int sx, sy;
419
420         UI_view2d_to_region_no_clip(&ar->v2d, 0.0f, 0.0f, &sx, &sy);
421         ED_space_clip_get_size(C, &width, &height);
422         ED_space_clip_get_zoom(C, &zoomx, &zoomy);
423
424         ED_clip_point_undistorted_pos(sc, co, pos);
425         pos[2] = 0.0f;
426
427         /* untested */
428         mul_v3_m4v3(pos, sc->stabmat, pos);
429
430         r_co[0] = (pos[0] * width  * zoomx) + (float)sx;
431         r_co[1] = (pos[1] * height * zoomy) + (float)sy;
432 }
433
434 void ED_clip_mouse_pos(const bContext *C, wmEvent *event, float co[2])
435 {
436         ED_clip_point_stable_pos(C, event->mval[0], event->mval[1], &co[0], &co[1]);
437 }
438
439 int ED_space_clip_check_show_trackedit(SpaceClip *sc)
440 {
441         if (sc) {
442                 return ELEM3(sc->mode, SC_MODE_TRACKING, SC_MODE_RECONSTRUCTION, SC_MODE_DISTORTION);
443         }
444
445         return FALSE;
446 }
447
448 int ED_space_clip_check_show_maskedit(SpaceClip *sc)
449 {
450         if (sc) {
451                 return sc->mode == SC_MODE_MASKEDIT;
452         }
453
454         return FALSE;
455 }
456
457 /* ******** clip editing functions ******** */
458
459 MovieClip *ED_space_clip_get_clip(SpaceClip *sc)
460 {
461         return sc->clip;
462 }
463
464 void ED_space_clip_set_clip(bContext *C, bScreen *screen, SpaceClip *sc, MovieClip *clip)
465 {
466         MovieClip *old_clip;
467
468         if (!screen && C)
469                 screen = CTX_wm_screen(C);
470
471         old_clip = sc->clip;
472         sc->clip = clip;
473
474         if (sc->clip && sc->clip->id.us == 0)
475                 sc->clip->id.us = 1;
476
477         if (screen && sc->view == SC_VIEW_CLIP) {
478                 ScrArea *area;
479                 SpaceLink *sl;
480
481                 for (area = screen->areabase.first; area; area = area->next) {
482                         for (sl = area->spacedata.first; sl; sl = sl->next) {
483                                 if (sl->spacetype == SPACE_CLIP) {
484                                         SpaceClip *cur_sc = (SpaceClip *) sl;
485
486                                         if (cur_sc != sc && cur_sc->view != SC_VIEW_CLIP) {
487                                                 if (cur_sc->clip == old_clip || cur_sc->clip == NULL) {
488                                                         cur_sc->clip = clip;
489                                                 }
490                                         }
491                                 }
492                         }
493                 }
494         }
495
496         if (C)
497                 WM_event_add_notifier(C, NC_MOVIECLIP | NA_SELECTED, sc->clip);
498 }
499
500 /* ******** masking editing functions ******** */
501
502 Mask *ED_space_clip_get_mask(SpaceClip *sc)
503 {
504         return sc->mask;
505 }
506
507 void ED_space_clip_set_mask(bContext *C, SpaceClip *sc, Mask *mask)
508 {
509         sc->mask = mask;
510
511         if (sc->mask && sc->mask->id.us == 0) {
512                 sc->clip->id.us = 1;
513         }
514
515         if (C) {
516                 WM_event_add_notifier(C, NC_MASK | NA_SELECTED, mask);
517         }
518 }
519
520 /* OpenGL draw context */
521
522 typedef struct SpaceClipDrawContext {
523         int support_checked, buffers_supported;
524
525         GLuint texture;                 /* OGL texture ID */
526         short texture_allocated;        /* flag if texture was allocated by glGenTextures */
527         struct ImBuf *texture_ibuf;     /* image buffer for which texture was created */
528         int image_width, image_height;  /* image width and height for which texture was created */
529         unsigned last_texture;          /* ID of previously used texture, so it'll be restored after clip drawing */
530
531         /* fields to check if cache is still valid */
532         int framenr, start_frame, frame_offset;
533         short render_size, render_flag;
534 } SpaceClipDrawContext;
535
536 int ED_space_clip_texture_buffer_supported(SpaceClip *sc)
537 {
538         SpaceClipDrawContext *context = sc->draw_context;
539
540         if (!context) {
541                 context = MEM_callocN(sizeof(SpaceClipDrawContext), "SpaceClipDrawContext");
542                 sc->draw_context = context;
543         }
544
545         if (!context->support_checked) {
546                 context->support_checked = TRUE;
547                 if (GPU_type_matches(GPU_DEVICE_INTEL, GPU_OS_ANY, GPU_DRIVER_ANY)) {
548                         context->buffers_supported = FALSE;
549                 }
550                 else {
551                         context->buffers_supported = GPU_non_power_of_two_support();
552                 }
553         }
554
555         return context->buffers_supported;
556 }
557
558 int ED_space_clip_load_movieclip_buffer(SpaceClip *sc, ImBuf *ibuf)
559 {
560         SpaceClipDrawContext *context = sc->draw_context;
561         MovieClip *clip = ED_space_clip_get_clip(sc);
562         int need_rebind = 0;
563
564         context->last_texture = glaGetOneInteger(GL_TEXTURE_2D);
565
566         /* image texture need to be rebinded if displaying another image buffer
567          * assuming displaying happens of footage frames only on which painting doesn't heppen.
568          * so not changed image buffer pointer means unchanged image content */
569         need_rebind |= context->texture_ibuf != ibuf;
570         need_rebind |= context->framenr != sc->user.framenr;
571         need_rebind |= context->render_size != sc->user.render_size;
572         need_rebind |= context->render_flag != sc->user.render_flag;
573         need_rebind |= context->start_frame != clip->start_frame;
574         need_rebind |= context->frame_offset != clip->frame_offset;
575
576         if (need_rebind) {
577                 int width = ibuf->x, height = ibuf->y;
578                 int need_recreate = 0;
579
580                 if (width > GL_MAX_TEXTURE_SIZE || height > GL_MAX_TEXTURE_SIZE)
581                         return 0;
582
583                 /* if image resolution changed (e.g. switched to proxy display) texture need to be recreated */
584                 need_recreate = context->image_width != ibuf->x || context->image_height != ibuf->y;
585
586                 if (context->texture_ibuf && need_recreate) {
587                         glDeleteTextures(1, &context->texture);
588                         context->texture_allocated = 0;
589                 }
590
591                 if (need_recreate || !context->texture_allocated) {
592                         /* texture doesn't exist yet or need to be re-allocated because of changed dimensions */
593                         int filter = GL_LINEAR;
594
595                         /* non-scaled proxy shouldn;t use diltering */
596                         if ((clip->flag & MCLIP_USE_PROXY) == 0 ||
597                             ELEM(sc->user.render_size, MCLIP_PROXY_RENDER_SIZE_FULL, MCLIP_PROXY_RENDER_SIZE_100))
598                         {
599                                 filter = GL_NEAREST;
600                         }
601
602                         glGenTextures(1, &context->texture);
603                         glBindTexture(GL_TEXTURE_2D, context->texture);
604                         glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, filter);
605                         glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, filter);
606                         glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP);
607                         glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP);
608                 }
609                 else {
610                         /* if texture doesn't need to be reallocated itself, just bind it so
611                          * loading of image will happen to a proper texture */
612                         glBindTexture(GL_TEXTURE_2D, context->texture);
613                 }
614
615                 if (ibuf->rect_float) {
616                         if (ibuf->rect == NULL)
617                                 IMB_rect_from_float(ibuf);
618                 }
619
620                 if (ibuf->rect)
621                         glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA8, width, height, 0, GL_RGBA, GL_UNSIGNED_BYTE, ibuf->rect);
622
623                 /* store settings */
624                 context->texture_allocated = 1;
625                 context->texture_ibuf = ibuf;
626                 context->image_width = ibuf->x;
627                 context->image_height = ibuf->y;
628                 context->framenr = sc->user.framenr;
629                 context->render_size = sc->user.render_size;
630                 context->render_flag = sc->user.render_flag;
631                 context->start_frame = clip->start_frame;
632                 context->frame_offset = clip->frame_offset;
633         }
634         else {
635                 /* displaying exactly the same image which was loaded t oa texture,
636                  * just bint texture in this case */
637                 glBindTexture(GL_TEXTURE_2D, context->texture);
638         }
639
640         glEnable(GL_TEXTURE_2D);
641
642         return TRUE;
643 }
644
645 void ED_space_clip_unload_movieclip_buffer(SpaceClip *sc)
646 {
647         SpaceClipDrawContext *context = sc->draw_context;
648
649         glBindTexture(GL_TEXTURE_2D, context->last_texture);
650         glDisable(GL_TEXTURE_2D);
651 }
652
653 void ED_space_clip_free_texture_buffer(SpaceClip *sc)
654 {
655         SpaceClipDrawContext *context = sc->draw_context;
656
657         if (context) {
658                 glDeleteTextures(1, &context->texture);
659
660                 MEM_freeN(context);
661         }
662 }