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