Merging r47572 through r47580 form trunk into soc-2011-tomato
[blender.git] / source / blender / blenkernel / intern / movieclip.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  * Contributor(s): Blender Foundation,
22  *                 Sergey Sharybin
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/blenkernel/intern/movieclip.c
28  *  \ingroup bke
29  */
30
31
32 #include <stdio.h>
33 #include <string.h>
34 #include <fcntl.h>
35
36 #ifndef WIN32
37 #include <unistd.h>
38 #else
39 #include <io.h>
40 #endif
41
42 #include <time.h>
43
44 #ifdef _WIN32
45 #define open _open
46 #define close _close
47 #endif
48
49 #include "MEM_guardedalloc.h"
50
51 #include "DNA_constraint_types.h"
52 #include "DNA_screen_types.h"
53 #include "DNA_space_types.h"
54 #include "DNA_movieclip_types.h"
55 #include "DNA_object_types.h"
56 #include "DNA_scene_types.h"
57 #include "DNA_view3d_types.h"
58
59 #include "BLI_utildefines.h"
60
61 #include "BLI_blenlib.h"
62 #include "BLI_ghash.h"
63 #include "BLI_math.h"
64 #include "BLI_mempool.h"
65 #include "BLI_threads.h"
66
67 #include "BKE_animsys.h"
68 #include "BKE_constraint.h"
69 #include "BKE_library.h"
70 #include "BKE_global.h"
71 #include "BKE_main.h"
72 #include "BKE_utildefines.h"
73 #include "BKE_movieclip.h"
74 #include "BKE_image.h"  /* openanim */
75 #include "BKE_tracking.h"
76
77 #include "IMB_imbuf_types.h"
78 #include "IMB_imbuf.h"
79 #include "IMB_moviecache.h"
80
81 /*********************** movieclip buffer loaders *************************/
82
83 static int sequence_guess_offset(const char *full_name, int head_len, unsigned short numlen)
84 {
85         char num[FILE_MAX] = {0};
86
87         BLI_strncpy(num, full_name + head_len, numlen + 1);
88
89         return atoi(num);
90 }
91
92 static int rendersize_to_proxy(MovieClipUser *user, int flag)
93 {
94         if ((flag & MCLIP_USE_PROXY) == 0)
95                 return IMB_PROXY_NONE;
96
97         switch (user->render_size) {
98                 case MCLIP_PROXY_RENDER_SIZE_25:
99                         return IMB_PROXY_25;
100
101                 case MCLIP_PROXY_RENDER_SIZE_50:
102                         return IMB_PROXY_50;
103
104                 case MCLIP_PROXY_RENDER_SIZE_75:
105                         return IMB_PROXY_75;
106
107                 case MCLIP_PROXY_RENDER_SIZE_100:
108                         return IMB_PROXY_100;
109
110                 case MCLIP_PROXY_RENDER_SIZE_FULL:
111                         return IMB_PROXY_NONE;
112         }
113
114         return IMB_PROXY_NONE;
115 }
116
117 static int rendersize_to_number(int render_size)
118 {
119         switch (render_size) {
120                 case MCLIP_PROXY_RENDER_SIZE_25:
121                         return 25;
122
123                 case MCLIP_PROXY_RENDER_SIZE_50:
124                         return 50;
125
126                 case MCLIP_PROXY_RENDER_SIZE_75:
127                         return 75;
128
129                 case MCLIP_PROXY_RENDER_SIZE_100:
130                         return 100;
131
132                 case MCLIP_PROXY_RENDER_SIZE_FULL:
133                         return 100;
134         }
135
136         return 100;
137 }
138
139 static int get_timecode(MovieClip *clip, int flag)
140 {
141         if ((flag & MCLIP_USE_PROXY) == 0)
142                 return IMB_TC_NONE;
143
144         return clip->proxy.tc;
145 }
146
147 static void get_sequence_fname(MovieClip *clip, int framenr, char *name)
148 {
149         unsigned short numlen;
150         char head[FILE_MAX], tail[FILE_MAX];
151         int offset;
152
153         BLI_strncpy(name, clip->name, sizeof(clip->name));
154         BLI_stringdec(name, head, tail, &numlen);
155
156         /* movieclips always points to first image from sequence,
157          * autoguess offset for now. could be something smarter in the future
158          */
159         offset = sequence_guess_offset(clip->name, strlen(head), numlen);
160
161         if (numlen)
162                 BLI_stringenc(name, head, tail, numlen, offset + framenr - clip->start_frame);
163         else
164                 BLI_strncpy(name, clip->name, sizeof(clip->name));
165
166         BLI_path_abs(name, ID_BLEND_PATH(G.main, &clip->id));
167 }
168
169 /* supposed to work with sequences only */
170 static void get_proxy_fname(MovieClip *clip, int proxy_render_size, int undistorted, int framenr, char *name)
171 {
172         int size = rendersize_to_number(proxy_render_size);
173         char dir[FILE_MAX], clipdir[FILE_MAX], clipfile[FILE_MAX];
174         int proxynr = framenr - clip->start_frame + 1;
175
176         BLI_split_dirfile(clip->name, clipdir, clipfile, FILE_MAX, FILE_MAX);
177
178         if (clip->flag & MCLIP_USE_PROXY_CUSTOM_DIR) {
179                 BLI_strncpy(dir, clip->proxy.dir, sizeof(dir));
180         }
181         else {
182                 BLI_snprintf(dir, FILE_MAX, "%s/BL_proxy", clipdir);
183         }
184
185         if (undistorted)
186                 BLI_snprintf(name, FILE_MAX, "%s/%s/proxy_%d_undistorted/%08d", dir, clipfile, size, proxynr);
187         else
188                 BLI_snprintf(name, FILE_MAX, "%s/%s/proxy_%d/%08d", dir, clipfile, size, proxynr);
189
190         BLI_path_abs(name, G.main->name);
191         BLI_path_frame(name, 1, 0);
192
193         strcat(name, ".jpg");
194 }
195
196 static ImBuf *movieclip_load_sequence_file(MovieClip *clip, MovieClipUser *user, int framenr, int flag)
197 {
198         struct ImBuf *ibuf;
199         char name[FILE_MAX];
200         int loadflag, use_proxy = FALSE;
201
202         use_proxy = (flag & MCLIP_USE_PROXY) && user->render_size != MCLIP_PROXY_RENDER_SIZE_FULL;
203         if (use_proxy) {
204                 int undistort = user->render_flag & MCLIP_PROXY_RENDER_UNDISTORT;
205                 get_proxy_fname(clip, user->render_size, undistort, framenr, name);
206         }
207         else
208                 get_sequence_fname(clip, framenr, name);
209
210         loadflag = IB_rect | IB_multilayer;
211
212         /* read ibuf */
213         ibuf = IMB_loadiffname(name, loadflag);
214
215         return ibuf;
216 }
217
218 static void movieclip_open_anim_file(MovieClip *clip)
219 {
220         char str[FILE_MAX];
221
222         if (!clip->anim) {
223                 BLI_strncpy(str, clip->name, FILE_MAX);
224                 BLI_path_abs(str, ID_BLEND_PATH(G.main, &clip->id));
225
226                 /* FIXME: make several stream accessible in image editor, too */
227                 clip->anim = openanim(str, IB_rect, 0);
228
229                 if (clip->anim) {
230                         if (clip->flag & MCLIP_USE_PROXY_CUSTOM_DIR) {
231                                 char dir[FILE_MAX];
232                                 BLI_strncpy(dir, clip->proxy.dir, sizeof(dir));
233                                 BLI_path_abs(dir, G.main->name);
234                                 IMB_anim_set_index_dir(clip->anim, dir);
235                         }
236                 }
237         }
238 }
239
240 static ImBuf *movieclip_load_movie_file(MovieClip *clip, MovieClipUser *user, int framenr, int flag)
241 {
242         ImBuf *ibuf = NULL;
243         int tc = get_timecode(clip, flag);
244         int proxy = rendersize_to_proxy(user, flag);
245
246         movieclip_open_anim_file(clip);
247
248         if (clip->anim) {
249                 int dur;
250                 int fra;
251
252                 dur = IMB_anim_get_duration(clip->anim, tc);
253                 fra = framenr - clip->start_frame;
254
255                 if (fra < 0)
256                         fra = 0;
257
258                 if (fra > (dur - 1))
259                         fra = dur - 1;
260
261                 ibuf = IMB_anim_absolute(clip->anim, fra, tc, proxy);
262         }
263
264         return ibuf;
265 }
266
267 static void movieclip_calc_length(MovieClip *clip)
268 {
269         if (clip->source == MCLIP_SRC_MOVIE) {
270                 movieclip_open_anim_file(clip);
271
272                 if (clip->anim) {
273                         clip->len = IMB_anim_get_duration(clip->anim, clip->proxy.tc);
274                 }
275         }
276         else if (clip->source == MCLIP_SRC_SEQUENCE) {
277                 int framenr = 1;
278                 unsigned short numlen;
279                 char name[FILE_MAX], head[FILE_MAX], tail[FILE_MAX];
280
281                 BLI_stringdec(clip->name, head, tail, &numlen);
282
283                 if (numlen == 0) {
284                         /* there's no number group in file name, assume it's single framed sequence */
285                         clip->len = framenr + 1;
286                 }
287                 else {
288                         for (;; ) {
289                                 get_sequence_fname(clip, framenr, name);
290
291                                 if (!BLI_exists(name)) {
292                                         clip->len = framenr + 1;
293                                         break;
294                                 }
295
296                                 framenr++;
297                         }
298                 }
299         }
300 }
301
302 /*********************** image buffer cache *************************/
303
304 typedef struct MovieClipCache {
305         /* regular movie cache */
306         struct MovieCache *moviecache;
307
308         /* cached postprocessed shot */
309         struct {
310                 ImBuf *ibuf;
311                 int framenr;
312                 int flag;
313
314                 /* cache for undistorted shot */
315                 float principal[2];
316                 float k1, k2, k3;
317                 short undistoriton_used;
318
319                 int proxy;
320                 short render_flag;
321         } postprocessed;
322
323         /* cache for stable shot */
324         struct {
325                 ImBuf *ibuf;
326                 int framenr;
327                 int postprocess_flag;
328
329                 float loc[2], scale, angle, aspect;
330                 int proxy, filter;
331                 short render_flag;
332         } stabilized;
333 } MovieClipCache;
334
335 typedef struct MovieClipImBufCacheKey {
336         int framenr;
337         int proxy;
338         short render_flag;
339 } MovieClipImBufCacheKey;
340
341 static void moviecache_keydata(void *userkey, int *framenr, int *proxy, int *render_flags)
342 {
343         MovieClipImBufCacheKey *key = (MovieClipImBufCacheKey *)userkey;
344
345         *framenr = key->framenr;
346         *proxy = key->proxy;
347         *render_flags = key->render_flag;
348 }
349
350 static unsigned int moviecache_hashhash(const void *keyv)
351 {
352         MovieClipImBufCacheKey *key = (MovieClipImBufCacheKey *)keyv;
353         int rval = key->framenr;
354
355         return rval;
356 }
357
358 static int moviecache_hashcmp(const void *av, const void *bv)
359 {
360         const MovieClipImBufCacheKey *a = (MovieClipImBufCacheKey *)av;
361         const MovieClipImBufCacheKey *b = (MovieClipImBufCacheKey *)bv;
362
363         if (a->framenr < b->framenr)
364                 return -1;
365         else if (a->framenr > b->framenr)
366                 return 1;
367
368         if (a->proxy < b->proxy)
369                 return -1;
370         else if (a->proxy > b->proxy)
371                 return 1;
372
373         if (a->render_flag < b->render_flag)
374                 return -1;
375         else if (a->render_flag > b->render_flag)
376                 return 1;
377
378         return 0;
379 }
380
381 static ImBuf *get_imbuf_cache(MovieClip *clip, MovieClipUser *user, int flag)
382 {
383         if (clip->cache) {
384                 MovieClipImBufCacheKey key;
385
386                 key.framenr = user->framenr;
387
388                 if (flag & MCLIP_USE_PROXY) {
389                         key.proxy = rendersize_to_proxy(user, flag);
390                         key.render_flag = user->render_flag;
391                 }
392                 else {
393                         key.proxy = IMB_PROXY_NONE;
394                         key.render_flag = 0;
395                 }
396
397                 return IMB_moviecache_get(clip->cache->moviecache, &key);
398         }
399
400         return NULL;
401 }
402
403 static void put_imbuf_cache(MovieClip *clip, MovieClipUser *user, ImBuf *ibuf, int flag)
404 {
405         MovieClipImBufCacheKey key;
406
407         if (!clip->cache) {
408                 clip->cache = MEM_callocN(sizeof(MovieClipCache), "movieClipCache");
409
410                 clip->cache->moviecache = IMB_moviecache_create(sizeof(MovieClipImBufCacheKey), moviecache_hashhash,
411                                                                 moviecache_hashcmp, moviecache_keydata);
412         }
413
414         key.framenr = user->framenr;
415
416         if (flag & MCLIP_USE_PROXY) {
417                 key.proxy = rendersize_to_proxy(user, flag);
418                 key.render_flag = user->render_flag;
419         }
420         else {
421                 key.proxy = IMB_PROXY_NONE;
422                 key.render_flag = 0;
423         }
424
425         IMB_moviecache_put(clip->cache->moviecache, &key, ibuf);
426 }
427
428 /*********************** common functions *************************/
429
430 /* only image block itself */
431 static MovieClip *movieclip_alloc(const char *name)
432 {
433         MovieClip *clip;
434
435         clip = BKE_libblock_alloc(&G.main->movieclip, ID_MC, name);
436
437         clip->aspx = clip->aspy = 1.0f;
438
439         BKE_tracking_init_settings(&clip->tracking);
440
441         clip->proxy.build_size_flag = IMB_PROXY_25;
442         clip->proxy.build_tc_flag = IMB_TC_RECORD_RUN |
443                                     IMB_TC_FREE_RUN |
444                                     IMB_TC_INTERPOLATED_REC_DATE_FREE_RUN |
445                                     IMB_TC_RECORD_RUN_NO_GAPS;
446         clip->proxy.quality = 90;
447
448         clip->start_frame = 1;
449
450         return clip;
451 }
452
453 /* checks if image was already loaded, then returns same image
454  * otherwise creates new.
455  * does not load ibuf itself
456  * pass on optional frame for #name images */
457 MovieClip *BKE_movieclip_file_add(const char *name)
458 {
459         MovieClip *clip;
460         MovieClipUser user = {0};
461         int file, len, width, height;
462         const char *libname;
463         char str[FILE_MAX], strtest[FILE_MAX];
464
465         BLI_strncpy(str, name, sizeof(str));
466         BLI_path_abs(str, G.main->name);
467
468         /* exists? */
469         file = BLI_open(str, O_BINARY | O_RDONLY, 0);
470         if (file == -1)
471                 return NULL;
472         close(file);
473
474         /* ** first search an identical clip ** */
475         for (clip = G.main->movieclip.first; clip; clip = clip->id.next) {
476                 BLI_strncpy(strtest, clip->name, sizeof(clip->name));
477                 BLI_path_abs(strtest, G.main->name);
478
479                 if (strcmp(strtest, str) == 0) {
480                         BLI_strncpy(clip->name, name, sizeof(clip->name));  /* for stringcode */
481                         clip->id.us++;  /* officially should not, it doesn't link here! */
482
483                         return clip;
484                 }
485         }
486
487         /* ** add new movieclip ** */
488
489         /* create a short library name */
490         len = strlen(name);
491
492         while (len > 0 && name[len - 1] != '/' && name[len - 1] != '\\')
493                 len--;
494         libname = name + len;
495
496         clip = movieclip_alloc(libname);
497         BLI_strncpy(clip->name, name, sizeof(clip->name));
498
499         if (BLI_testextensie_array(name, imb_ext_movie))
500                 clip->source = MCLIP_SRC_MOVIE;
501         else
502                 clip->source = MCLIP_SRC_SEQUENCE;
503
504         user.framenr = 1;
505         BKE_movieclip_get_size(clip, &user, &width, &height);
506         if (width && height) {
507                 clip->tracking.camera.principal[0] = ((float)width) / 2.0f;
508                 clip->tracking.camera.principal[1] = ((float)height) / 2.0f;
509
510                 clip->tracking.camera.focal = 24.0f * width / clip->tracking.camera.sensor_width;
511         }
512
513         movieclip_calc_length(clip);
514
515         return clip;
516 }
517
518 static void real_ibuf_size(MovieClip *clip, MovieClipUser *user, ImBuf *ibuf, int *width, int *height)
519 {
520         *width = ibuf->x;
521         *height = ibuf->y;
522
523         if (clip->flag & MCLIP_USE_PROXY) {
524                 switch (user->render_size) {
525                         case MCLIP_PROXY_RENDER_SIZE_25:
526                                 (*width) *= 4;
527                                 (*height) *= 4;
528                                 break;
529
530                         case MCLIP_PROXY_RENDER_SIZE_50:
531                                 (*width) *= 2.0f;
532                                 (*height) *= 2.0f;
533                                 break;
534
535                         case MCLIP_PROXY_RENDER_SIZE_75:
536                                 *width = ((float)*width) * 4.0f / 3.0f;
537                                 *height = ((float)*height) * 4.0f / 3.0f;
538                                 break;
539                 }
540         }
541 }
542
543 static ImBuf *get_undistorted_ibuf(MovieClip *clip, struct MovieDistortion *distortion, ImBuf *ibuf)
544 {
545         ImBuf *undistibuf;
546
547         if (distortion)
548                 undistibuf = BKE_tracking_distortion_exec(distortion, &clip->tracking, ibuf, ibuf->x, ibuf->y, 0.0f, 1);
549         else
550                 undistibuf = BKE_tracking_undistort(&clip->tracking, ibuf, ibuf->x, ibuf->y, 0.0f);
551
552         if (undistibuf->userflags & IB_RECT_INVALID) {
553                 ibuf->userflags &= ~IB_RECT_INVALID;
554                 IMB_rect_from_float(undistibuf);
555         }
556
557         IMB_scaleImBuf(undistibuf, ibuf->x, ibuf->y);
558
559         return undistibuf;
560 }
561
562 static int need_undistortion_postprocess(MovieClipUser *user, int flag)
563 {
564         int result = 0;
565
566         /* only full undistorted render can be used as on-fly undistorting image */
567         if (flag & MCLIP_USE_PROXY) {
568                 result |= (user->render_size == MCLIP_PROXY_RENDER_SIZE_FULL) &&
569                           (user->render_flag & MCLIP_PROXY_RENDER_UNDISTORT) != 0;
570         }
571
572         return result;
573 }
574
575 static int need_postprocessed_frame(MovieClipUser *user, int flag, int postprocess_flag)
576 {
577         int result = postprocess_flag;
578
579         result |= need_undistortion_postprocess(user, flag);
580
581         return result;
582 }
583
584 static int check_undistortion_cache_flags(MovieClip *clip)
585 {
586         MovieClipCache *cache = clip->cache;
587         MovieTrackingCamera *camera = &clip->tracking.camera;
588
589         /* check for distortion model changes */
590         if (!equals_v2v2(camera->principal, cache->postprocessed.principal))
591                 return FALSE;
592
593         if (!equals_v3v3(&camera->k1, &cache->postprocessed.k1))
594                 return FALSE;
595
596         return TRUE;
597 }
598
599 static ImBuf *get_postprocessed_cached_frame(MovieClip *clip, MovieClipUser *user, int flag, int postprocess_flag)
600 {
601         MovieClipCache *cache = clip->cache;
602         int framenr = user->framenr;
603         short proxy = IMB_PROXY_NONE;
604         int render_flag = 0;
605
606         if (flag & MCLIP_USE_PROXY) {
607                 proxy = rendersize_to_proxy(user, flag);
608                 render_flag = user->render_flag;
609         }
610
611         /* no cache or no cached postprocessed image */
612         if (!clip->cache || !clip->cache->postprocessed.ibuf)
613                 return NULL;
614
615         /* postprocessing happened for other frame */
616         if (cache->postprocessed.framenr != framenr)
617                 return NULL;
618
619         /* cached ibuf used different proxy settings */
620         if (cache->postprocessed.render_flag != render_flag || cache->postprocessed.proxy != proxy)
621                 return NULL;
622
623         if (cache->postprocessed.flag != postprocess_flag)
624                 return NULL;
625
626         if (need_undistortion_postprocess(user, flag)) {
627                 if (!check_undistortion_cache_flags(clip))
628                         return NULL;
629         }
630         else if (cache->postprocessed.undistoriton_used)
631                 return NULL;
632
633         IMB_refImBuf(cache->postprocessed.ibuf);
634
635         return cache->postprocessed.ibuf;
636 }
637
638 static ImBuf *put_postprocessed_frame_to_cache(MovieClip *clip, MovieClipUser *user, ImBuf *ibuf,
639                                                int flag, int postprocess_flag)
640 {
641         MovieClipCache *cache = clip->cache;
642         MovieTrackingCamera *camera = &clip->tracking.camera;
643         ImBuf *postproc_ibuf = NULL;
644
645         if (cache->postprocessed.ibuf)
646                 IMB_freeImBuf(cache->postprocessed.ibuf);
647
648         cache->postprocessed.framenr = user->framenr;
649         cache->postprocessed.flag = postprocess_flag;
650
651         if (flag & MCLIP_USE_PROXY) {
652                 cache->postprocessed.proxy = rendersize_to_proxy(user, flag);
653                 cache->postprocessed.render_flag = user->render_flag;
654         }
655         else {
656                 cache->postprocessed.proxy = IMB_PROXY_NONE;
657                 cache->postprocessed.render_flag = 0;
658         }
659
660         if (need_undistortion_postprocess(user, flag)) {
661                 copy_v2_v2(cache->postprocessed.principal, camera->principal);
662                 copy_v3_v3(&cache->postprocessed.k1, &camera->k1);
663                 cache->postprocessed.undistoriton_used = TRUE;
664                 postproc_ibuf = get_undistorted_ibuf(clip, NULL, ibuf);
665         }
666         else {
667                 cache->postprocessed.undistoriton_used = FALSE;
668         }
669
670         if (postprocess_flag) {
671                 int disable_red   = postprocess_flag & MOVIECLIP_DISABLE_RED,
672                     disable_green = postprocess_flag & MOVIECLIP_DISABLE_GREEN,
673                     disable_blue  = postprocess_flag & MOVIECLIP_DISABLE_BLUE,
674                     grayscale     = postprocess_flag & MOVIECLIP_PREVIEW_GRAYSCALE;
675
676                 if (!postproc_ibuf)
677                         postproc_ibuf = IMB_dupImBuf(ibuf);
678
679                 if (disable_red || disable_green || disable_blue || grayscale)
680                         BKE_tracking_disable_imbuf_channels(postproc_ibuf, disable_red, disable_green, disable_blue, 1);
681         }
682
683         IMB_refImBuf(postproc_ibuf);
684
685         cache->postprocessed.ibuf = postproc_ibuf;
686
687         if (cache->stabilized.ibuf) {
688                 /* force stable buffer be re-calculated */
689                 IMB_freeImBuf(cache->stabilized.ibuf);
690                 cache->stabilized.ibuf = NULL;
691         }
692
693         return postproc_ibuf;
694 }
695
696 static ImBuf *movieclip_get_postprocessed_ibuf(MovieClip *clip, MovieClipUser *user, int flag,
697                                                int postprocess_flag, int cache_flag)
698 {
699         ImBuf *ibuf = NULL;
700         int framenr = user->framenr, need_postprocess = FALSE;
701
702         /* cache isn't threadsafe itself and also loading of movies
703          * can't happen from concurent threads that's why we use lock here */
704         BLI_lock_thread(LOCK_MOVIECLIP);
705
706         /* try to obtain cached postprocessed frame first */
707         if (need_postprocessed_frame(user, flag, postprocess_flag)) {
708                 ibuf = get_postprocessed_cached_frame(clip, user, flag, postprocess_flag);
709
710                 if (!ibuf)
711                         need_postprocess = TRUE;
712         }
713
714         if (!ibuf)
715                 ibuf = get_imbuf_cache(clip, user, flag);
716
717         if (!ibuf) {
718                 int use_sequence = FALSE;
719
720                 /* undistorted proxies for movies should be read as image sequence */
721                 use_sequence = (user->render_flag & MCLIP_PROXY_RENDER_UNDISTORT) &&
722                                (user->render_size != MCLIP_PROXY_RENDER_SIZE_FULL);
723
724                 if (clip->source == MCLIP_SRC_SEQUENCE || use_sequence) {
725                         ibuf = movieclip_load_sequence_file(clip, user, framenr, flag);
726                 }
727                 else {
728                         ibuf = movieclip_load_movie_file(clip, user, framenr, flag);
729                 }
730
731                 if (ibuf && (cache_flag & MOVIECLIP_CACHE_SKIP) == 0)
732                         put_imbuf_cache(clip, user, ibuf, flag);
733         }
734
735         if (ibuf) {
736                 clip->lastframe = framenr;
737                 real_ibuf_size(clip, user, ibuf, &clip->lastsize[0], &clip->lastsize[1]);
738
739                 /* postprocess frame and put to cache */
740                 if (need_postprocess) {
741                         ImBuf *tmpibuf = ibuf;
742                         ibuf = put_postprocessed_frame_to_cache(clip, user, tmpibuf, flag, postprocess_flag);
743                         IMB_freeImBuf(tmpibuf);
744                 }
745         }
746
747         BLI_unlock_thread(LOCK_MOVIECLIP);
748
749         return ibuf;
750 }
751
752 ImBuf *BKE_movieclip_get_ibuf(MovieClip *clip, MovieClipUser *user)
753 {
754         return BKE_movieclip_get_ibuf_flag(clip, user, clip->flag, 0);
755 }
756
757 ImBuf *BKE_movieclip_get_ibuf_flag(MovieClip *clip, MovieClipUser *user, int flag, int cache_flag)
758 {
759         return movieclip_get_postprocessed_ibuf(clip, user, flag, 0, cache_flag);
760 }
761
762 ImBuf *BKE_movieclip_get_postprocessed_ibuf(MovieClip *clip, MovieClipUser *user, int postprocess_flag)
763 {
764         return movieclip_get_postprocessed_ibuf(clip, user, clip->flag, postprocess_flag, 0);
765 }
766
767 static ImBuf *get_stable_cached_frame(MovieClip *clip, MovieClipUser *user, int framenr, int postprocess_flag)
768 {
769         MovieClipCache *cache = clip->cache;
770         MovieTracking *tracking = &clip->tracking;
771         ImBuf *stableibuf;
772         float tloc[2], tscale, tangle;
773         short proxy = IMB_PROXY_NONE;
774         int render_flag = 0;
775
776         if (clip->flag & MCLIP_USE_PROXY) {
777                 proxy = rendersize_to_proxy(user, clip->flag);
778                 render_flag = user->render_flag;
779         }
780
781         /* there's no cached frame or it was calculated for another frame */
782         if (!cache->stabilized.ibuf || cache->stabilized.framenr != framenr)
783                 return NULL;
784
785         /* cached ibuf used different proxy settings */
786         if (cache->stabilized.render_flag != render_flag || cache->stabilized.proxy != proxy)
787                 return NULL;
788
789         if (cache->stabilized.postprocess_flag != postprocess_flag)
790                 return NULL;
791
792         /* stabilization also depends on pixel aspect ratio */
793         if (cache->stabilized.aspect != tracking->camera.pixel_aspect)
794                 return NULL;
795
796         if (cache->stabilized.filter != tracking->stabilization.filter)
797                 return NULL;
798
799         stableibuf = cache->stabilized.ibuf;
800
801         BKE_tracking_stabilization_data(&clip->tracking, framenr, stableibuf->x, stableibuf->y, tloc, &tscale, &tangle);
802
803         /* check for stabilization parameters */
804         if (tscale != cache->stabilized.scale ||
805             tangle != cache->stabilized.angle ||
806             !equals_v2v2(tloc, cache->stabilized.loc))
807         {
808                 return NULL;
809         }
810
811         IMB_refImBuf(stableibuf);
812
813         return stableibuf;
814 }
815
816 static ImBuf *put_stabilized_frame_to_cache(MovieClip *clip, MovieClipUser *user, ImBuf *ibuf,
817                                             int framenr, int postprocess_flag)
818 {
819         MovieClipCache *cache = clip->cache;
820         MovieTracking *tracking = &clip->tracking;
821         ImBuf *stableibuf;
822         float tloc[2], tscale, tangle;
823
824         if (cache->stabilized.ibuf)
825                 IMB_freeImBuf(cache->stabilized.ibuf);
826
827         stableibuf = BKE_tracking_stabilize(&clip->tracking, framenr, ibuf, tloc, &tscale, &tangle);
828
829         cache->stabilized.ibuf = stableibuf;
830
831         copy_v2_v2(cache->stabilized.loc, tloc);
832
833         cache->stabilized.scale = tscale;
834         cache->stabilized.angle = tangle;
835         cache->stabilized.framenr = framenr;
836         cache->stabilized.aspect = tracking->camera.pixel_aspect;
837         cache->stabilized.filter = tracking->stabilization.filter;
838
839         if (clip->flag & MCLIP_USE_PROXY) {
840                 cache->stabilized.proxy = rendersize_to_proxy(user, clip->flag);
841                 cache->stabilized.render_flag = user->render_flag;
842         }
843         else {
844                 cache->stabilized.proxy = IMB_PROXY_NONE;
845                 cache->stabilized.render_flag = 0;
846         }
847
848         cache->stabilized.postprocess_flag = postprocess_flag;
849
850         IMB_refImBuf(stableibuf);
851
852         return stableibuf;
853 }
854
855 ImBuf *BKE_movieclip_get_stable_ibuf(MovieClip *clip, MovieClipUser *user, float loc[2], float *scale, float *angle,
856                                      int postprocess_flag)
857 {
858         ImBuf *ibuf, *stableibuf = NULL;
859         int framenr = user->framenr;
860
861         ibuf = BKE_movieclip_get_postprocessed_ibuf(clip, user, postprocess_flag);
862
863         if (!ibuf)
864                 return NULL;
865
866         if (clip->tracking.stabilization.flag & TRACKING_2D_STABILIZATION) {
867                 MovieClipCache *cache = clip->cache;
868
869                 stableibuf = get_stable_cached_frame(clip, user, framenr, postprocess_flag);
870
871                 if (!stableibuf)
872                         stableibuf = put_stabilized_frame_to_cache(clip, user, ibuf, framenr, postprocess_flag);
873
874                 if (loc)
875                         copy_v2_v2(loc, cache->stabilized.loc);
876
877                 if (scale)
878                         *scale = cache->stabilized.scale;
879
880                 if (angle)
881                         *angle = cache->stabilized.angle;
882         }
883         else {
884                 if (loc)
885                         zero_v2(loc);
886
887                 if (scale)
888                         *scale = 1.0f;
889
890                 if (angle)
891                         *angle = 0.0f;
892
893                 stableibuf = ibuf;
894         }
895
896         if (stableibuf != ibuf) {
897                 IMB_freeImBuf(ibuf);
898                 ibuf = stableibuf;
899         }
900
901         return ibuf;
902
903 }
904
905 int BKE_movieclip_has_frame(MovieClip *clip, MovieClipUser *user)
906 {
907         ImBuf *ibuf = BKE_movieclip_get_ibuf(clip, user);
908
909         if (ibuf) {
910                 IMB_freeImBuf(ibuf);
911                 return TRUE;
912         }
913
914         return FALSE;
915 }
916
917 void BKE_movieclip_get_size(MovieClip *clip, MovieClipUser *user, int *width, int *height)
918 {
919 #if 0
920         /* originally was needed to support image sequences with different image dimensions,
921          * which might be useful for such things as reconstruction of unordered image sequence,
922          * or painting/rotoscoping of non-equal-sized images, but this ended up in unneeded
923          * cache lookups and even unwanted non-proxied files loading when doing mask parenting,
924          * so let's disable this for now and assume image sequence consists of images with
925          * equal sizes (sergey)
926          */
927         if (user->framenr == clip->lastframe) {
928 #endif
929         if (clip->lastsize[0] != 0 && clip->lastsize[1] != 0) {
930                 *width = clip->lastsize[0];
931                 *height = clip->lastsize[1];
932         }
933         else {
934                 ImBuf *ibuf = BKE_movieclip_get_ibuf(clip, user);
935
936                 if (ibuf && ibuf->x && ibuf->y) {
937                         real_ibuf_size(clip, user, ibuf, width, height);
938                 }
939                 else {
940                         *width = clip->lastsize[0];
941                         *height = clip->lastsize[1];
942                 }
943
944                 if (ibuf)
945                         IMB_freeImBuf(ibuf);
946         }
947 }
948
949 int BKE_movieclip_get_duration(MovieClip *clip)
950 {
951         if (!clip->len) {
952                 movieclip_calc_length(clip);
953         }
954
955         return clip->len;
956 }
957
958 void BKE_movieclip_aspect(MovieClip *clip, float *aspx, float *aspy)
959 {
960         *aspx = *aspy = 1.0;
961
962         /* x is always 1 */
963         *aspy = clip->aspy / clip->aspx / clip->tracking.camera.pixel_aspect;
964 }
965
966 /* get segments of cached frames. useful for debugging cache policies */
967 void BKE_movieclip_get_cache_segments(MovieClip *clip, MovieClipUser *user, int *totseg_r, int **points_r)
968 {
969         *totseg_r = 0;
970         *points_r = NULL;
971
972         if (clip->cache) {
973                 int proxy = rendersize_to_proxy(user, clip->flag);
974
975                 IMB_moviecache_get_cache_segments(clip->cache->moviecache, proxy, user->render_flag, totseg_r, points_r);
976         }
977 }
978
979 void BKE_movieclip_user_set_frame(MovieClipUser *iuser, int framenr)
980 {
981         /* TODO: clamp framenr here? */
982
983         iuser->framenr = framenr;
984 }
985
986 static void free_buffers(MovieClip *clip)
987 {
988         if (clip->cache) {
989                 IMB_moviecache_free(clip->cache->moviecache);
990
991                 if (clip->cache->postprocessed.ibuf)
992                         IMB_freeImBuf(clip->cache->postprocessed.ibuf);
993
994                 if (clip->cache->stabilized.ibuf)
995                         IMB_freeImBuf(clip->cache->stabilized.ibuf);
996
997                 MEM_freeN(clip->cache);
998                 clip->cache = NULL;
999         }
1000
1001         if (clip->anim) {
1002                 IMB_free_anim(clip->anim);
1003                 clip->anim = NULL;
1004         }
1005
1006         BKE_free_animdata((ID *) clip);
1007 }
1008
1009 void BKE_movieclip_reload(MovieClip *clip)
1010 {
1011         /* clear cache */
1012         free_buffers(clip);
1013
1014         clip->tracking.stabilization.ok = FALSE;
1015
1016         /* update clip source */
1017         if (BLI_testextensie_array(clip->name, imb_ext_movie))
1018                 clip->source = MCLIP_SRC_MOVIE;
1019         else
1020                 clip->source = MCLIP_SRC_SEQUENCE;
1021
1022         movieclip_calc_length(clip);
1023 }
1024
1025 void BKE_movieclip_update_scopes(MovieClip *clip, MovieClipUser *user, MovieClipScopes *scopes)
1026 {
1027         if (scopes->ok)
1028                 return;
1029
1030         if (scopes->track_preview) {
1031                 IMB_freeImBuf(scopes->track_preview);
1032                 scopes->track_preview = NULL;
1033         }
1034
1035         scopes->marker = NULL;
1036         scopes->track = NULL;
1037
1038         if (clip) {
1039                 MovieTrackingTrack *act_track = BKE_tracking_active_track(&clip->tracking);
1040
1041                 if (act_track) {
1042                         MovieTrackingTrack *track = act_track;
1043                         int framenr = BKE_movieclip_remap_scene_to_clip_frame(clip, user->framenr);
1044                         MovieTrackingMarker *marker = BKE_tracking_get_marker(track, framenr);
1045
1046                         if (marker->flag & MARKER_DISABLED) {
1047                                 scopes->track_disabled = TRUE;
1048                         }
1049                         else {
1050                                 ImBuf *ibuf = BKE_movieclip_get_ibuf(clip, user);
1051
1052                                 scopes->track_disabled = FALSE;
1053
1054                                 if (ibuf && (ibuf->rect || ibuf->rect_float)) {
1055                                         ImBuf *tmpibuf;
1056                                         MovieTrackingMarker undist_marker = *marker;
1057
1058                                         if (user->render_flag & MCLIP_PROXY_RENDER_UNDISTORT) {
1059                                                 int width, height;
1060                                                 float aspy = 1.0f / clip->tracking.camera.pixel_aspect;
1061
1062                                                 BKE_movieclip_get_size(clip, user, &width, &height);
1063
1064                                                 undist_marker.pos[0] *= width;
1065                                                 undist_marker.pos[1] *= height * aspy;
1066
1067                                                 BKE_tracking_invert_intrinsics(&clip->tracking, undist_marker.pos, undist_marker.pos);
1068
1069                                                 undist_marker.pos[0] /= width;
1070                                                 undist_marker.pos[1] /= height * aspy;
1071                                         }
1072
1073                                         /* NOTE: margin should be kept in sync with value from ui_draw_but_TRACKPREVIEW */
1074                                         tmpibuf = BKE_tracking_get_pattern_imbuf(ibuf, track, &undist_marker, 3 /* margin */,
1075                                                                                  1 /* anchor */, scopes->track_pos, NULL);
1076
1077                                         if (tmpibuf->rect_float)
1078                                                 IMB_rect_from_float(tmpibuf);
1079
1080                                         if (tmpibuf->rect)
1081                                                 scopes->track_preview = tmpibuf;
1082                                         else
1083                                                 IMB_freeImBuf(tmpibuf);
1084                                 }
1085
1086                                 IMB_freeImBuf(ibuf);
1087                         }
1088
1089                         if ((track->flag & TRACK_LOCKED) == 0) {
1090                                 float pat_min[2], pat_max[2];
1091
1092                                 scopes->marker = marker;
1093                                 scopes->track = track;
1094
1095                                 /* XXX: would work fine with non-transformed patterns, but would likely fail
1096                                  *      with transformed patterns, but that would be easier to debug when
1097                                  *      we'll have real pattern sampling (at least to test) */
1098                                 BKE_tracking_marker_pattern_minmax(marker, pat_min, pat_max);
1099
1100                                 scopes->slide_scale[0] = pat_max[0] - pat_min[0];
1101                                 scopes->slide_scale[1] = pat_max[1] - pat_min[1];
1102                         }
1103                 }
1104         }
1105
1106         scopes->framenr = user->framenr;
1107         scopes->ok = TRUE;
1108 }
1109
1110 static void movieclip_build_proxy_ibuf(MovieClip *clip, ImBuf *ibuf, int cfra, int proxy_render_size, int undistorted)
1111 {
1112         char name[FILE_MAX];
1113         int quality, rectx, recty;
1114         int size = rendersize_to_number(proxy_render_size);
1115         ImBuf *scaleibuf;
1116
1117         get_proxy_fname(clip, proxy_render_size, undistorted, cfra, name);
1118
1119         rectx = ibuf->x * size / 100.0f;
1120         recty = ibuf->y * size / 100.0f;
1121
1122         scaleibuf = IMB_dupImBuf(ibuf);
1123
1124         IMB_scaleImBuf(scaleibuf, (short)rectx, (short)recty);
1125
1126         quality = clip->proxy.quality;
1127         scaleibuf->ftype = JPG | quality;
1128
1129         /* unsupported feature only confuses other s/w */
1130         if (scaleibuf->planes == 32)
1131                 scaleibuf->planes = 24;
1132
1133         BLI_lock_thread(LOCK_MOVIECLIP);
1134
1135         BLI_make_existing_file(name);
1136         if (IMB_saveiff(scaleibuf, name, IB_rect) == 0)
1137                 perror(name);
1138
1139         BLI_unlock_thread(LOCK_MOVIECLIP);
1140
1141         IMB_freeImBuf(scaleibuf);
1142 }
1143
1144 void BKE_movieclip_build_proxy_frame(MovieClip *clip, int clip_flag, struct MovieDistortion *distortion,
1145                                      int cfra, int *build_sizes, int build_count, int undistorted)
1146 {
1147         ImBuf *ibuf;
1148         MovieClipUser user;
1149
1150         user.framenr = cfra;
1151         user.render_flag = 0;
1152         user.render_size = MCLIP_PROXY_RENDER_SIZE_FULL;
1153
1154         ibuf = BKE_movieclip_get_ibuf_flag(clip, &user, clip_flag, MOVIECLIP_CACHE_SKIP);
1155
1156         if (ibuf) {
1157                 ImBuf *tmpibuf = ibuf;
1158                 int i;
1159
1160                 if (undistorted)
1161                         tmpibuf = get_undistorted_ibuf(clip, distortion, ibuf);
1162
1163                 for (i = 0; i < build_count; i++)
1164                         movieclip_build_proxy_ibuf(clip, tmpibuf, cfra, build_sizes[i], undistorted);
1165
1166                 IMB_freeImBuf(ibuf);
1167
1168                 if (tmpibuf != ibuf)
1169                         IMB_freeImBuf(tmpibuf);
1170         }
1171 }
1172
1173 void BKE_movieclip_free(MovieClip *clip)
1174 {
1175         free_buffers(clip);
1176
1177         BKE_tracking_free(&clip->tracking);
1178 }
1179
1180 void BKE_movieclip_unlink(Main *bmain, MovieClip *clip)
1181 {
1182         bScreen *scr;
1183         ScrArea *area;
1184         SpaceLink *sl;
1185         Scene *sce;
1186         Object *ob;
1187
1188         for (scr = bmain->screen.first; scr; scr = scr->id.next) {
1189                 for (area = scr->areabase.first; area; area = area->next) {
1190                         for (sl = area->spacedata.first; sl; sl = sl->next) {
1191                                 if (sl->spacetype == SPACE_CLIP) {
1192                                         SpaceClip *sc = (SpaceClip *) sl;
1193
1194                                         if (sc->clip == clip)
1195                                                 sc->clip = NULL;
1196                                 }
1197                                 else if (sl->spacetype == SPACE_VIEW3D) {
1198                                         View3D *v3d = (View3D *) sl;
1199                                         BGpic *bgpic;
1200
1201                                         for (bgpic = v3d->bgpicbase.first; bgpic; bgpic = bgpic->next) {
1202                                                 if (bgpic->clip == clip)
1203                                                         bgpic->clip = NULL;
1204                                         }
1205                                 }
1206                         }
1207                 }
1208         }
1209
1210         for (sce = bmain->scene.first; sce; sce = sce->id.next) {
1211                 if (sce->clip == clip)
1212                         sce->clip = NULL;
1213         }
1214
1215         for (ob = bmain->object.first; ob; ob = ob->id.next) {
1216                 bConstraint *con;
1217
1218                 for (con = ob->constraints.first; con; con = con->next) {
1219                         bConstraintTypeInfo *cti = constraint_get_typeinfo(con);
1220
1221                         if (cti->type == CONSTRAINT_TYPE_FOLLOWTRACK) {
1222                                 bFollowTrackConstraint *data = (bFollowTrackConstraint *) con->data;
1223
1224                                 if (data->clip == clip)
1225                                         data->clip = NULL;
1226                         }
1227                         else if (cti->type == CONSTRAINT_TYPE_CAMERASOLVER) {
1228                                 bCameraSolverConstraint *data = (bCameraSolverConstraint *) con->data;
1229
1230                                 if (data->clip == clip)
1231                                         data->clip = NULL;
1232                         }
1233                         else if (cti->type == CONSTRAINT_TYPE_OBJECTSOLVER) {
1234                                 bObjectSolverConstraint *data = (bObjectSolverConstraint *) con->data;
1235
1236                                 if (data->clip == clip)
1237                                         data->clip = NULL;
1238                         }
1239                 }
1240         }
1241
1242         clip->id.us = 0;
1243 }
1244
1245 int BKE_movieclip_remap_scene_to_clip_frame(MovieClip *clip, int framenr)
1246 {
1247         return framenr - clip->start_frame + 1;
1248 }
1249
1250 int BKE_movieclip_remap_clip_to_scene_frame(MovieClip *clip, int framenr)
1251 {
1252         return framenr + clip->start_frame - 1;
1253 }