svn merge ^/trunk/blender -r48489:48527
[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         if (!sc->clip) {
181                 *aspx = 1.0f;
182                 *aspy = 1.0f;
183
184                 return;
185         }
186
187         ED_space_clip_get_aspect(sc, aspx, aspy);
188         BKE_movieclip_get_size(sc->clip, &sc->user, &w, &h);
189
190         *aspx *= (float) w;
191         *aspy *= (float) h;
192
193         if (*aspx < *aspy) {
194                 *aspy = *aspy / *aspx;
195                 *aspx = 1.0f;
196         }
197         else {
198                 *aspx = *aspx / *aspy;
199                 *aspy = 1.0f;
200         }
201 }
202
203 /* return current frame number in clip space */
204 int ED_space_clip_get_clip_frame_number(SpaceClip *sc)
205 {
206         MovieClip *clip = ED_space_clip_get_clip(sc);
207
208         return BKE_movieclip_remap_scene_to_clip_frame(clip, sc->user.framenr);
209 }
210
211 ImBuf *ED_space_clip_get_buffer(SpaceClip *sc)
212 {
213         if (sc->clip) {
214                 ImBuf *ibuf;
215
216                 ibuf = BKE_movieclip_get_postprocessed_ibuf(sc->clip, &sc->user, sc->postproc_flag);
217
218                 if (ibuf && (ibuf->rect || ibuf->rect_float))
219                         return ibuf;
220
221                 if (ibuf)
222                         IMB_freeImBuf(ibuf);
223         }
224
225         return NULL;
226 }
227
228 ImBuf *ED_space_clip_get_stable_buffer(SpaceClip *sc, float loc[2], float *scale, float *angle)
229 {
230         if (sc->clip) {
231                 ImBuf *ibuf;
232
233                 ibuf = BKE_movieclip_get_stable_ibuf(sc->clip, &sc->user, loc, scale, angle, sc->postproc_flag);
234
235                 if (ibuf && (ibuf->rect || ibuf->rect_float))
236                         return ibuf;
237
238                 if (ibuf)
239                         IMB_freeImBuf(ibuf);
240         }
241
242         return NULL;
243 }
244
245 void ED_clip_update_frame(const Main *mainp, int cfra)
246 {
247         wmWindowManager *wm;
248         wmWindow *win;
249
250         /* image window, compo node users */
251         for (wm = mainp->wm.first; wm; wm = wm->id.next) { /* only 1 wm */
252                 for (win = wm->windows.first; win; win = win->next) {
253                         ScrArea *sa;
254
255                         for (sa = win->screen->areabase.first; sa; sa = sa->next) {
256                                 if (sa->spacetype == SPACE_CLIP) {
257                                         SpaceClip *sc = sa->spacedata.first;
258
259                                         sc->scopes.ok = FALSE;
260
261                                         BKE_movieclip_user_set_frame(&sc->user, cfra);
262                                 }
263                         }
264                 }
265         }
266 }
267
268 static int selected_boundbox(const bContext *C, float min[2], float max[2])
269 {
270         SpaceClip *sc = CTX_wm_space_clip(C);
271         MovieClip *clip = ED_space_clip_get_clip(sc);
272         MovieTrackingTrack *track;
273         int width, height, ok = FALSE;
274         ListBase *tracksbase = BKE_tracking_get_active_tracks(&clip->tracking);
275         int framenr = ED_space_clip_get_clip_frame_number(sc);
276
277         INIT_MINMAX2(min, max);
278
279         ED_space_clip_get_size(C, &width, &height);
280
281         track = tracksbase->first;
282         while (track) {
283                 if (TRACK_VIEW_SELECTED(sc, track)) {
284                         MovieTrackingMarker *marker = BKE_tracking_marker_get(track, framenr);
285
286                         if (marker) {
287                                 float pos[3];
288
289                                 pos[0] = marker->pos[0] + track->offset[0];
290                                 pos[1] = marker->pos[1] + track->offset[1];
291                                 pos[2] = 0.0f;
292
293                                 /* undistortion happens for normalized coords */
294                                 if (sc->user.render_flag & MCLIP_PROXY_RENDER_UNDISTORT) {
295                                         /* undistortion happens for normalized coords */
296                                         ED_clip_point_undistorted_pos(sc, pos, pos);
297                                 }
298
299                                 pos[0] *= width;
300                                 pos[1] *= height;
301
302                                 mul_v3_m4v3(pos, sc->stabmat, pos);
303
304                                 DO_MINMAX2(pos, min, max);
305
306                                 ok = TRUE;
307                         }
308                 }
309
310                 track = track->next;
311         }
312
313         return ok;
314 }
315
316 int ED_clip_view_selection(const bContext *C, ARegion *ar, int fit)
317 {
318         SpaceClip *sc = CTX_wm_space_clip(C);
319         int w, h, frame_width, frame_height;
320         float min[2], max[2];
321
322         ED_space_clip_get_size(C, &frame_width, &frame_height);
323
324         if (frame_width == 0 || frame_height == 0)
325                 return FALSE;
326
327         if (!selected_boundbox(C, min, max))
328                 return FALSE;
329
330         /* center view */
331         clip_view_center_to_point(C, (max[0] + min[0]) / (2 * frame_width),
332                                      (max[1] + min[1]) / (2 * frame_height));
333
334         w = max[0] - min[0];
335         h = max[1] - min[1];
336
337         /* set zoom to see all selection */
338         if (w > 0 && h > 0) {
339                 int width, height;
340                 float zoomx, zoomy, newzoom, aspx, aspy;
341
342                 ED_space_clip_get_aspect(sc, &aspx, &aspy);
343
344                 width = ar->winrct.xmax - ar->winrct.xmin + 1;
345                 height = ar->winrct.ymax - ar->winrct.ymin + 1;
346
347                 zoomx = (float)width / w / aspx;
348                 zoomy = (float)height / h / aspy;
349
350                 newzoom = 1.0f / power_of_2(1.0f / MIN2(zoomx, zoomy));
351
352                 if (fit || sc->zoom > newzoom)
353                         sc->zoom = newzoom;
354         }
355
356         return TRUE;
357 }
358
359 void ED_clip_point_undistorted_pos(SpaceClip *sc, const float co[2], float r_co[2])
360 {
361         copy_v2_v2(r_co, co);
362
363         if (sc->user.render_flag & MCLIP_PROXY_RENDER_UNDISTORT) {
364                 MovieClip *clip = ED_space_clip_get_clip(sc);
365                 float aspy = 1.0f / clip->tracking.camera.pixel_aspect;
366                 int width, height;
367
368                 BKE_movieclip_get_size(sc->clip, &sc->user, &width, &height);
369
370                 r_co[0] *= width;
371                 r_co[1] *= height * aspy;
372
373                 BKE_tracking_undistort_v2(&clip->tracking, r_co, r_co);
374
375                 r_co[0] /= width;
376                 r_co[1] /= height * aspy;
377         }
378 }
379
380 void ED_clip_point_stable_pos(const bContext *C, float x, float y, float *xr, float *yr)
381 {
382         ARegion *ar = CTX_wm_region(C);
383         SpaceClip *sc = CTX_wm_space_clip(C);
384         int sx, sy, width, height;
385         float zoomx, zoomy, pos[3], imat[4][4];
386
387         ED_space_clip_get_zoom(C, &zoomx, &zoomy);
388         ED_space_clip_get_size(C, &width, &height);
389
390         UI_view2d_to_region_no_clip(&ar->v2d, 0.0f, 0.0f, &sx, &sy);
391
392         pos[0] = (x - sx) / zoomx;
393         pos[1] = (y - sy) / zoomy;
394         pos[2] = 0.0f;
395
396         invert_m4_m4(imat, sc->stabmat);
397         mul_v3_m4v3(pos, imat, pos);
398
399         *xr = pos[0] / width;
400         *yr = pos[1] / height;
401
402         if (sc->user.render_flag & MCLIP_PROXY_RENDER_UNDISTORT) {
403                 MovieClip *clip = ED_space_clip_get_clip(sc);
404                 MovieTracking *tracking = &clip->tracking;
405                 float aspy = 1.0f / tracking->camera.pixel_aspect;
406                 float tmp[2] = {*xr * width, *yr * height * aspy};
407
408                 BKE_tracking_distort_v2(tracking, tmp, tmp);
409
410                 *xr = tmp[0] / width;
411                 *yr = tmp[1] / (height * aspy);
412         }
413 }
414
415 /**
416  * \brief the reverse of ED_clip_point_stable_pos(), gets the marker region coords.
417  * better name here? view_to_track / track_to_view or so?
418  */
419 void ED_clip_point_stable_pos__reverse(const bContext *C, const float co[2], float r_co[2])
420 {
421         SpaceClip *sc = CTX_wm_space_clip(C);
422         ARegion *ar = CTX_wm_region(C);
423         float zoomx, zoomy;
424         float pos[3];
425         int width, height;
426         int sx, sy;
427
428         UI_view2d_to_region_no_clip(&ar->v2d, 0.0f, 0.0f, &sx, &sy);
429         ED_space_clip_get_size(C, &width, &height);
430         ED_space_clip_get_zoom(C, &zoomx, &zoomy);
431
432         ED_clip_point_undistorted_pos(sc, co, pos);
433         pos[2] = 0.0f;
434
435         /* untested */
436         mul_v3_m4v3(pos, sc->stabmat, pos);
437
438         r_co[0] = (pos[0] * width  * zoomx) + (float)sx;
439         r_co[1] = (pos[1] * height * zoomy) + (float)sy;
440 }
441
442 void ED_clip_mouse_pos(const bContext *C, wmEvent *event, float co[2])
443 {
444         ED_clip_point_stable_pos(C, event->mval[0], event->mval[1], &co[0], &co[1]);
445 }
446
447 int ED_space_clip_check_show_trackedit(SpaceClip *sc)
448 {
449         if (sc) {
450                 return ELEM3(sc->mode, SC_MODE_TRACKING, SC_MODE_RECONSTRUCTION, SC_MODE_DISTORTION);
451         }
452
453         return FALSE;
454 }
455
456 int ED_space_clip_check_show_maskedit(SpaceClip *sc)
457 {
458         if (sc) {
459                 return sc->mode == SC_MODE_MASKEDIT;
460         }
461
462         return FALSE;
463 }
464
465 /* ******** clip editing functions ******** */
466
467 MovieClip *ED_space_clip_get_clip(SpaceClip *sc)
468 {
469         return sc->clip;
470 }
471
472 void ED_space_clip_set_clip(bContext *C, bScreen *screen, SpaceClip *sc, MovieClip *clip)
473 {
474         MovieClip *old_clip;
475
476         if (!screen && C)
477                 screen = CTX_wm_screen(C);
478
479         old_clip = sc->clip;
480         sc->clip = clip;
481
482         if (sc->clip && sc->clip->id.us == 0)
483                 sc->clip->id.us = 1;
484
485         if (screen && sc->view == SC_VIEW_CLIP) {
486                 ScrArea *area;
487                 SpaceLink *sl;
488
489                 for (area = screen->areabase.first; area; area = area->next) {
490                         for (sl = area->spacedata.first; sl; sl = sl->next) {
491                                 if (sl->spacetype == SPACE_CLIP) {
492                                         SpaceClip *cur_sc = (SpaceClip *) sl;
493
494                                         if (cur_sc != sc && cur_sc->view != SC_VIEW_CLIP) {
495                                                 if (cur_sc->clip == old_clip || cur_sc->clip == NULL) {
496                                                         cur_sc->clip = clip;
497                                                 }
498                                         }
499                                 }
500                         }
501                 }
502         }
503
504         if (C)
505                 WM_event_add_notifier(C, NC_MOVIECLIP | NA_SELECTED, sc->clip);
506 }
507
508 /* ******** masking editing functions ******** */
509
510 Mask *ED_space_clip_get_mask(SpaceClip *sc)
511 {
512         return sc->mask;
513 }
514
515 void ED_space_clip_set_mask(bContext *C, SpaceClip *sc, Mask *mask)
516 {
517         sc->mask = mask;
518
519         if (sc->mask && sc->mask->id.us == 0) {
520                 sc->clip->id.us = 1;
521         }
522
523         if (C) {
524                 WM_event_add_notifier(C, NC_MASK | NA_SELECTED, mask);
525         }
526 }
527
528 /* OpenGL draw context */
529
530 typedef struct SpaceClipDrawContext {
531         int support_checked, buffers_supported;
532
533         GLuint texture;                 /* OGL texture ID */
534         short texture_allocated;        /* flag if texture was allocated by glGenTextures */
535         struct ImBuf *texture_ibuf;     /* image buffer for which texture was created */
536         const unsigned char *display_buffer; /* display buffer for which texture was created */
537         int image_width, image_height;  /* image width and height for which texture was created */
538         unsigned last_texture;          /* ID of previously used texture, so it'll be restored after clip drawing */
539
540         /* fields to check if cache is still valid */
541         int framenr, start_frame, frame_offset;
542         short render_size, render_flag;
543 } SpaceClipDrawContext;
544
545 int ED_space_clip_texture_buffer_supported(SpaceClip *sc)
546 {
547         SpaceClipDrawContext *context = sc->draw_context;
548
549         if (!context) {
550                 context = MEM_callocN(sizeof(SpaceClipDrawContext), "SpaceClipDrawContext");
551                 sc->draw_context = context;
552         }
553
554         if (!context->support_checked) {
555                 context->support_checked = TRUE;
556                 if (GPU_type_matches(GPU_DEVICE_INTEL, GPU_OS_ANY, GPU_DRIVER_ANY)) {
557                         context->buffers_supported = FALSE;
558                 }
559                 else {
560                         context->buffers_supported = GPU_non_power_of_two_support();
561                 }
562         }
563
564         return context->buffers_supported;
565 }
566
567 int ED_space_clip_load_movieclip_buffer(SpaceClip *sc, ImBuf *ibuf, const unsigned char *display_buffer)
568 {
569         SpaceClipDrawContext *context = sc->draw_context;
570         MovieClip *clip = ED_space_clip_get_clip(sc);
571         int need_rebind = 0;
572
573         context->last_texture = glaGetOneInteger(GL_TEXTURE_2D);
574
575         /* image texture need to be rebinded if displaying another image buffer
576          * assuming displaying happens of footage frames only on which painting doesn't heppen.
577          * so not changed image buffer pointer means unchanged image content */
578         need_rebind |= context->texture_ibuf != ibuf;
579         need_rebind |= context->display_buffer != display_buffer;
580         need_rebind |= context->framenr != sc->user.framenr;
581         need_rebind |= context->render_size != sc->user.render_size;
582         need_rebind |= context->render_flag != sc->user.render_flag;
583         need_rebind |= context->start_frame != clip->start_frame;
584         need_rebind |= context->frame_offset != clip->frame_offset;
585
586         if (need_rebind) {
587                 int width = ibuf->x, height = ibuf->y;
588                 int need_recreate = 0;
589
590                 if (width > GL_MAX_TEXTURE_SIZE || height > GL_MAX_TEXTURE_SIZE)
591                         return 0;
592
593                 /* if image resolution changed (e.g. switched to proxy display) texture need to be recreated */
594                 need_recreate = context->image_width != ibuf->x || context->image_height != ibuf->y;
595
596                 if (context->texture_ibuf && need_recreate) {
597                         glDeleteTextures(1, &context->texture);
598                         context->texture_allocated = 0;
599                 }
600
601                 if (need_recreate || !context->texture_allocated) {
602                         /* texture doesn't exist yet or need to be re-allocated because of changed dimensions */
603                         int filter = GL_LINEAR;
604
605                         /* non-scaled proxy shouldn;t use diltering */
606                         if ((clip->flag & MCLIP_USE_PROXY) == 0 ||
607                             ELEM(sc->user.render_size, MCLIP_PROXY_RENDER_SIZE_FULL, MCLIP_PROXY_RENDER_SIZE_100))
608                         {
609                                 filter = GL_NEAREST;
610                         }
611
612                         glGenTextures(1, &context->texture);
613                         glBindTexture(GL_TEXTURE_2D, context->texture);
614                         glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, filter);
615                         glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, filter);
616                         glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP);
617                         glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP);
618                 }
619                 else {
620                         /* if texture doesn't need to be reallocated itself, just bind it so
621                          * loading of image will happen to a proper texture */
622                         glBindTexture(GL_TEXTURE_2D, context->texture);
623                 }
624
625                 if (display_buffer)
626                         glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA8, width, height, 0, GL_RGBA, GL_UNSIGNED_BYTE, display_buffer);
627
628                 /* store settings */
629                 context->texture_allocated = 1;
630                 context->display_buffer = display_buffer;
631                 context->texture_ibuf = ibuf;
632                 context->image_width = ibuf->x;
633                 context->image_height = ibuf->y;
634                 context->framenr = sc->user.framenr;
635                 context->render_size = sc->user.render_size;
636                 context->render_flag = sc->user.render_flag;
637                 context->start_frame = clip->start_frame;
638                 context->frame_offset = clip->frame_offset;
639         }
640         else {
641                 /* displaying exactly the same image which was loaded t oa texture,
642                  * just bint texture in this case */
643                 glBindTexture(GL_TEXTURE_2D, context->texture);
644         }
645
646         glEnable(GL_TEXTURE_2D);
647
648         return TRUE;
649 }
650
651 void ED_space_clip_unload_movieclip_buffer(SpaceClip *sc)
652 {
653         SpaceClipDrawContext *context = sc->draw_context;
654
655         glBindTexture(GL_TEXTURE_2D, context->last_texture);
656         glDisable(GL_TEXTURE_2D);
657 }
658
659 void ED_space_clip_free_texture_buffer(SpaceClip *sc)
660 {
661         SpaceClipDrawContext *context = sc->draw_context;
662
663         if (context) {
664                 glDeleteTextures(1, &context->texture);
665
666                 MEM_freeN(context);
667         }
668 }