Color management: refactor of cache to deal better with movie clip cache
[blender-staging.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 + clip->frame_offset);
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 + clip->frame_offset;
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 + clip->frame_offset;
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 undistortion_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 typedef struct MovieClipCachePriorityData {
342         int framenr;
343 } MovieClipCachePriorityData;
344
345 static void moviecache_keydata(void *userkey, int *framenr, int *proxy, int *render_flags)
346 {
347         MovieClipImBufCacheKey *key = (MovieClipImBufCacheKey *)userkey;
348
349         *framenr = key->framenr;
350         *proxy = key->proxy;
351         *render_flags = key->render_flag;
352 }
353
354 static unsigned int moviecache_hashhash(const void *keyv)
355 {
356         MovieClipImBufCacheKey *key = (MovieClipImBufCacheKey *)keyv;
357         int rval = key->framenr;
358
359         return rval;
360 }
361
362 static int moviecache_hashcmp(const void *av, const void *bv)
363 {
364         const MovieClipImBufCacheKey *a = (MovieClipImBufCacheKey *)av;
365         const MovieClipImBufCacheKey *b = (MovieClipImBufCacheKey *)bv;
366
367         if (a->framenr < b->framenr)
368                 return -1;
369         else if (a->framenr > b->framenr)
370                 return 1;
371
372         if (a->proxy < b->proxy)
373                 return -1;
374         else if (a->proxy > b->proxy)
375                 return 1;
376
377         if (a->render_flag < b->render_flag)
378                 return -1;
379         else if (a->render_flag > b->render_flag)
380                 return 1;
381
382         return 0;
383 }
384
385 void *moviecache_getprioritydata(void *key_v)
386 {
387         MovieClipImBufCacheKey *key = (MovieClipImBufCacheKey *) key_v;
388         MovieClipCachePriorityData *priority_data;
389
390         priority_data = MEM_callocN(sizeof(priority_data), "movie cache clip priority data");
391         priority_data->framenr = key->framenr;
392
393         return priority_data;
394 }
395
396 int moviecache_getitempriority(void *last_userkey_v, void *priority_data_v)
397 {
398         MovieClipImBufCacheKey *last_userkey = (MovieClipImBufCacheKey *) last_userkey_v;
399         MovieClipCachePriorityData *priority_data = (MovieClipCachePriorityData *) priority_data_v;
400
401         return -abs(last_userkey->framenr - priority_data->framenr);
402 }
403
404 void moviecache_prioritydeleter(void *priority_data_v)
405 {
406         MovieClipCachePriorityData *priority_data = (MovieClipCachePriorityData *) priority_data_v;
407
408         MEM_freeN(priority_data);
409 }
410
411 static ImBuf *get_imbuf_cache(MovieClip *clip, MovieClipUser *user, int flag)
412 {
413         if (clip->cache) {
414                 MovieClipImBufCacheKey key;
415
416                 key.framenr = user->framenr;
417
418                 if (flag & MCLIP_USE_PROXY) {
419                         key.proxy = rendersize_to_proxy(user, flag);
420                         key.render_flag = user->render_flag;
421                 }
422                 else {
423                         key.proxy = IMB_PROXY_NONE;
424                         key.render_flag = 0;
425                 }
426
427                 return IMB_moviecache_get(clip->cache->moviecache, &key);
428         }
429
430         return NULL;
431 }
432
433 static void put_imbuf_cache(MovieClip *clip, MovieClipUser *user, ImBuf *ibuf, int flag)
434 {
435         MovieClipImBufCacheKey key;
436
437         if (!clip->cache) {
438                 struct MovieCache *moviecache;
439
440                 // char cache_name[64];
441                 // BLI_snprintf(cache_name, sizeof(cache_name), "movie %s", clip->id.name);
442
443                 clip->cache = MEM_callocN(sizeof(MovieClipCache), "movieClipCache");
444
445                 moviecache = IMB_moviecache_create("movieclip", sizeof(MovieClipImBufCacheKey), moviecache_hashhash, moviecache_hashcmp);
446
447                 IMB_moviecache_set_getdata_callback(moviecache, moviecache_keydata);
448                 IMB_moviecache_set_priority_callback(moviecache, moviecache_getprioritydata, moviecache_getitempriority,
449                                                      moviecache_prioritydeleter);
450
451                 clip->cache->moviecache = moviecache;
452         }
453
454         key.framenr = user->framenr;
455
456         if (flag & MCLIP_USE_PROXY) {
457                 key.proxy = rendersize_to_proxy(user, flag);
458                 key.render_flag = user->render_flag;
459         }
460         else {
461                 key.proxy = IMB_PROXY_NONE;
462                 key.render_flag = 0;
463         }
464
465         IMB_moviecache_put(clip->cache->moviecache, &key, ibuf);
466 }
467
468 /*********************** common functions *************************/
469
470 /* only image block itself */
471 static MovieClip *movieclip_alloc(const char *name)
472 {
473         MovieClip *clip;
474
475         clip = BKE_libblock_alloc(&G.main->movieclip, ID_MC, name);
476
477         clip->aspx = clip->aspy = 1.0f;
478
479         BKE_tracking_settings_init(&clip->tracking);
480
481         clip->proxy.build_size_flag = IMB_PROXY_25;
482         clip->proxy.build_tc_flag = IMB_TC_RECORD_RUN |
483                                     IMB_TC_FREE_RUN |
484                                     IMB_TC_INTERPOLATED_REC_DATE_FREE_RUN |
485                                     IMB_TC_RECORD_RUN_NO_GAPS;
486         clip->proxy.quality = 90;
487
488         clip->start_frame = 1;
489         clip->frame_offset = 0;
490
491         return clip;
492 }
493
494 static void movieclip_load_get_szie(MovieClip *clip)
495 {
496         int width, height;
497         MovieClipUser user = {0};
498
499         user.framenr = 1;
500         BKE_movieclip_get_size(clip, &user, &width, &height);
501
502         if (width && height) {
503                 clip->tracking.camera.principal[0] = ((float)width) / 2.0f;
504                 clip->tracking.camera.principal[1] = ((float)height) / 2.0f;
505
506         }
507 }
508
509 /* checks if image was already loaded, then returns same image
510  * otherwise creates new.
511  * does not load ibuf itself
512  * pass on optional frame for #name images */
513 MovieClip *BKE_movieclip_file_add(const char *name)
514 {
515         MovieClip *clip;
516         int file, len;
517         const char *libname;
518         char str[FILE_MAX], strtest[FILE_MAX];
519
520         BLI_strncpy(str, name, sizeof(str));
521         BLI_path_abs(str, G.main->name);
522
523         /* exists? */
524         file = BLI_open(str, O_BINARY | O_RDONLY, 0);
525         if (file == -1)
526                 return NULL;
527         close(file);
528
529         /* ** first search an identical clip ** */
530         for (clip = G.main->movieclip.first; clip; clip = clip->id.next) {
531                 BLI_strncpy(strtest, clip->name, sizeof(clip->name));
532                 BLI_path_abs(strtest, G.main->name);
533
534                 if (strcmp(strtest, str) == 0) {
535                         BLI_strncpy(clip->name, name, sizeof(clip->name));  /* for stringcode */
536                         clip->id.us++;  /* officially should not, it doesn't link here! */
537
538                         return clip;
539                 }
540         }
541
542         /* ** add new movieclip ** */
543
544         /* create a short library name */
545         len = strlen(name);
546
547         while (len > 0 && name[len - 1] != '/' && name[len - 1] != '\\')
548                 len--;
549         libname = name + len;
550
551         clip = movieclip_alloc(libname);
552         BLI_strncpy(clip->name, name, sizeof(clip->name));
553
554         if (BLI_testextensie_array(name, imb_ext_movie))
555                 clip->source = MCLIP_SRC_MOVIE;
556         else
557                 clip->source = MCLIP_SRC_SEQUENCE;
558
559         movieclip_load_get_szie(clip);
560         if (clip->lastsize[0]) {
561                 int width = clip->lastsize[0];
562
563                 clip->tracking.camera.focal = 24.0f * width / clip->tracking.camera.sensor_width;
564         }
565
566         movieclip_calc_length(clip);
567
568         return clip;
569 }
570
571 static void real_ibuf_size(MovieClip *clip, MovieClipUser *user, ImBuf *ibuf, int *width, int *height)
572 {
573         *width = ibuf->x;
574         *height = ibuf->y;
575
576         if (clip->flag & MCLIP_USE_PROXY) {
577                 switch (user->render_size) {
578                         case MCLIP_PROXY_RENDER_SIZE_25:
579                                 (*width) *= 4;
580                                 (*height) *= 4;
581                                 break;
582
583                         case MCLIP_PROXY_RENDER_SIZE_50:
584                                 (*width) *= 2.0f;
585                                 (*height) *= 2.0f;
586                                 break;
587
588                         case MCLIP_PROXY_RENDER_SIZE_75:
589                                 *width = ((float)*width) * 4.0f / 3.0f;
590                                 *height = ((float)*height) * 4.0f / 3.0f;
591                                 break;
592                 }
593         }
594 }
595
596 static ImBuf *get_undistorted_ibuf(MovieClip *clip, struct MovieDistortion *distortion, ImBuf *ibuf)
597 {
598         ImBuf *undistibuf;
599
600         if (distortion)
601                 undistibuf = BKE_tracking_distortion_exec(distortion, &clip->tracking, ibuf, ibuf->x, ibuf->y, 0.0f, 1);
602         else
603                 undistibuf = BKE_tracking_undistort_frame(&clip->tracking, ibuf, ibuf->x, ibuf->y, 0.0f);
604
605         if (undistibuf->userflags & IB_RECT_INVALID) {
606                 ibuf->userflags &= ~IB_RECT_INVALID;
607                 IMB_rect_from_float(undistibuf);
608         }
609
610         IMB_scaleImBuf(undistibuf, ibuf->x, ibuf->y);
611
612         return undistibuf;
613 }
614
615 static int need_undistortion_postprocess(MovieClipUser *user, int flag)
616 {
617         int result = 0;
618
619         /* only full undistorted render can be used as on-fly undistorting image */
620         if (flag & MCLIP_USE_PROXY) {
621                 result |= (user->render_size == MCLIP_PROXY_RENDER_SIZE_FULL) &&
622                           (user->render_flag & MCLIP_PROXY_RENDER_UNDISTORT) != 0;
623         }
624
625         return result;
626 }
627
628 static int need_postprocessed_frame(MovieClipUser *user, int flag, int postprocess_flag)
629 {
630         int result = postprocess_flag;
631
632         result |= need_undistortion_postprocess(user, flag);
633
634         return result;
635 }
636
637 static int check_undistortion_cache_flags(MovieClip *clip)
638 {
639         MovieClipCache *cache = clip->cache;
640         MovieTrackingCamera *camera = &clip->tracking.camera;
641
642         /* check for distortion model changes */
643         if (!equals_v2v2(camera->principal, cache->postprocessed.principal))
644                 return FALSE;
645
646         if (!equals_v3v3(&camera->k1, &cache->postprocessed.k1))
647                 return FALSE;
648
649         return TRUE;
650 }
651
652 static ImBuf *get_postprocessed_cached_frame(MovieClip *clip, MovieClipUser *user, int flag, int postprocess_flag)
653 {
654         MovieClipCache *cache = clip->cache;
655         int framenr = user->framenr;
656         short proxy = IMB_PROXY_NONE;
657         int render_flag = 0;
658
659         if (flag & MCLIP_USE_PROXY) {
660                 proxy = rendersize_to_proxy(user, flag);
661                 render_flag = user->render_flag;
662         }
663
664         /* no cache or no cached postprocessed image */
665         if (!clip->cache || !clip->cache->postprocessed.ibuf)
666                 return NULL;
667
668         /* postprocessing happened for other frame */
669         if (cache->postprocessed.framenr != framenr)
670                 return NULL;
671
672         /* cached ibuf used different proxy settings */
673         if (cache->postprocessed.render_flag != render_flag || cache->postprocessed.proxy != proxy)
674                 return NULL;
675
676         if (cache->postprocessed.flag != postprocess_flag)
677                 return NULL;
678
679         if (need_undistortion_postprocess(user, flag)) {
680                 if (!check_undistortion_cache_flags(clip))
681                         return NULL;
682         }
683         else if (cache->postprocessed.undistortion_used)
684                 return NULL;
685
686         IMB_refImBuf(cache->postprocessed.ibuf);
687
688         return cache->postprocessed.ibuf;
689 }
690
691 static ImBuf *put_postprocessed_frame_to_cache(MovieClip *clip, MovieClipUser *user, ImBuf *ibuf,
692                                                int flag, int postprocess_flag)
693 {
694         MovieClipCache *cache = clip->cache;
695         MovieTrackingCamera *camera = &clip->tracking.camera;
696         ImBuf *postproc_ibuf = NULL;
697
698         if (cache->postprocessed.ibuf)
699                 IMB_freeImBuf(cache->postprocessed.ibuf);
700
701         cache->postprocessed.framenr = user->framenr;
702         cache->postprocessed.flag = postprocess_flag;
703
704         if (flag & MCLIP_USE_PROXY) {
705                 cache->postprocessed.proxy = rendersize_to_proxy(user, flag);
706                 cache->postprocessed.render_flag = user->render_flag;
707         }
708         else {
709                 cache->postprocessed.proxy = IMB_PROXY_NONE;
710                 cache->postprocessed.render_flag = 0;
711         }
712
713         if (need_undistortion_postprocess(user, flag)) {
714                 copy_v2_v2(cache->postprocessed.principal, camera->principal);
715                 copy_v3_v3(&cache->postprocessed.k1, &camera->k1);
716                 cache->postprocessed.undistortion_used = TRUE;
717                 postproc_ibuf = get_undistorted_ibuf(clip, NULL, ibuf);
718         }
719         else {
720                 cache->postprocessed.undistortion_used = FALSE;
721         }
722
723         if (postprocess_flag) {
724                 int disable_red   = postprocess_flag & MOVIECLIP_DISABLE_RED,
725                     disable_green = postprocess_flag & MOVIECLIP_DISABLE_GREEN,
726                     disable_blue  = postprocess_flag & MOVIECLIP_DISABLE_BLUE,
727                     grayscale     = postprocess_flag & MOVIECLIP_PREVIEW_GRAYSCALE;
728
729                 if (!postproc_ibuf)
730                         postproc_ibuf = IMB_dupImBuf(ibuf);
731
732                 if (disable_red || disable_green || disable_blue || grayscale)
733                         BKE_tracking_disable_channels(postproc_ibuf, disable_red, disable_green, disable_blue, 1);
734         }
735
736         IMB_refImBuf(postproc_ibuf);
737
738         cache->postprocessed.ibuf = postproc_ibuf;
739
740         if (cache->stabilized.ibuf) {
741                 /* force stable buffer be re-calculated */
742                 IMB_freeImBuf(cache->stabilized.ibuf);
743                 cache->stabilized.ibuf = NULL;
744         }
745
746         return postproc_ibuf;
747 }
748
749 static ImBuf *movieclip_get_postprocessed_ibuf(MovieClip *clip, MovieClipUser *user, int flag,
750                                                int postprocess_flag, int cache_flag)
751 {
752         ImBuf *ibuf = NULL;
753         int framenr = user->framenr, need_postprocess = FALSE;
754
755         /* cache isn't threadsafe itself and also loading of movies
756          * can't happen from concurent threads that's why we use lock here */
757         BLI_lock_thread(LOCK_MOVIECLIP);
758
759         /* try to obtain cached postprocessed frame first */
760         if (need_postprocessed_frame(user, flag, postprocess_flag)) {
761                 ibuf = get_postprocessed_cached_frame(clip, user, flag, postprocess_flag);
762
763                 if (!ibuf)
764                         need_postprocess = TRUE;
765         }
766
767         if (!ibuf)
768                 ibuf = get_imbuf_cache(clip, user, flag);
769
770         if (!ibuf) {
771                 int use_sequence = FALSE;
772
773                 /* undistorted proxies for movies should be read as image sequence */
774                 use_sequence = (user->render_flag & MCLIP_PROXY_RENDER_UNDISTORT) &&
775                                (user->render_size != MCLIP_PROXY_RENDER_SIZE_FULL);
776
777                 if (clip->source == MCLIP_SRC_SEQUENCE || use_sequence) {
778                         ibuf = movieclip_load_sequence_file(clip, user, framenr, flag);
779                 }
780                 else {
781                         ibuf = movieclip_load_movie_file(clip, user, framenr, flag);
782                 }
783
784                 if (ibuf && (cache_flag & MOVIECLIP_CACHE_SKIP) == 0)
785                         put_imbuf_cache(clip, user, ibuf, flag);
786         }
787
788         if (ibuf) {
789                 clip->lastframe = framenr;
790                 real_ibuf_size(clip, user, ibuf, &clip->lastsize[0], &clip->lastsize[1]);
791
792                 /* postprocess frame and put to cache */
793                 if (need_postprocess) {
794                         ImBuf *tmpibuf = ibuf;
795                         ibuf = put_postprocessed_frame_to_cache(clip, user, tmpibuf, flag, postprocess_flag);
796                         IMB_freeImBuf(tmpibuf);
797                 }
798         }
799
800         BLI_unlock_thread(LOCK_MOVIECLIP);
801
802         return ibuf;
803 }
804
805 ImBuf *BKE_movieclip_get_ibuf(MovieClip *clip, MovieClipUser *user)
806 {
807         return BKE_movieclip_get_ibuf_flag(clip, user, clip->flag, 0);
808 }
809
810 ImBuf *BKE_movieclip_get_ibuf_flag(MovieClip *clip, MovieClipUser *user, int flag, int cache_flag)
811 {
812         return movieclip_get_postprocessed_ibuf(clip, user, flag, 0, cache_flag);
813 }
814
815 ImBuf *BKE_movieclip_get_postprocessed_ibuf(MovieClip *clip, MovieClipUser *user, int postprocess_flag)
816 {
817         return movieclip_get_postprocessed_ibuf(clip, user, clip->flag, postprocess_flag, 0);
818 }
819
820 static ImBuf *get_stable_cached_frame(MovieClip *clip, MovieClipUser *user, int framenr, int postprocess_flag)
821 {
822         MovieClipCache *cache = clip->cache;
823         MovieTracking *tracking = &clip->tracking;
824         ImBuf *stableibuf;
825         float tloc[2], tscale, tangle;
826         short proxy = IMB_PROXY_NONE;
827         int render_flag = 0;
828         int clip_framenr = BKE_movieclip_remap_scene_to_clip_frame(clip, framenr);
829
830         if (clip->flag & MCLIP_USE_PROXY) {
831                 proxy = rendersize_to_proxy(user, clip->flag);
832                 render_flag = user->render_flag;
833         }
834
835         /* there's no cached frame or it was calculated for another frame */
836         if (!cache->stabilized.ibuf || cache->stabilized.framenr != framenr)
837                 return NULL;
838
839         /* cached ibuf used different proxy settings */
840         if (cache->stabilized.render_flag != render_flag || cache->stabilized.proxy != proxy)
841                 return NULL;
842
843         if (cache->stabilized.postprocess_flag != postprocess_flag)
844                 return NULL;
845
846         /* stabilization also depends on pixel aspect ratio */
847         if (cache->stabilized.aspect != tracking->camera.pixel_aspect)
848                 return NULL;
849
850         if (cache->stabilized.filter != tracking->stabilization.filter)
851                 return NULL;
852
853         stableibuf = cache->stabilized.ibuf;
854
855         BKE_tracking_stabilization_data_get(&clip->tracking, clip_framenr, stableibuf->x, stableibuf->y, tloc, &tscale, &tangle);
856
857         /* check for stabilization parameters */
858         if (tscale != cache->stabilized.scale ||
859             tangle != cache->stabilized.angle ||
860             !equals_v2v2(tloc, cache->stabilized.loc))
861         {
862                 return NULL;
863         }
864
865         IMB_refImBuf(stableibuf);
866
867         return stableibuf;
868 }
869
870 static ImBuf *put_stabilized_frame_to_cache(MovieClip *clip, MovieClipUser *user, ImBuf *ibuf,
871                                             int framenr, int postprocess_flag)
872 {
873         MovieClipCache *cache = clip->cache;
874         MovieTracking *tracking = &clip->tracking;
875         ImBuf *stableibuf;
876         float tloc[2], tscale, tangle;
877         int clip_framenr = BKE_movieclip_remap_scene_to_clip_frame(clip, framenr);
878
879         if (cache->stabilized.ibuf)
880                 IMB_freeImBuf(cache->stabilized.ibuf);
881
882         stableibuf = BKE_tracking_stabilize_frame(&clip->tracking, clip_framenr, ibuf, tloc, &tscale, &tangle);
883
884         cache->stabilized.ibuf = stableibuf;
885
886         copy_v2_v2(cache->stabilized.loc, tloc);
887
888         cache->stabilized.scale = tscale;
889         cache->stabilized.angle = tangle;
890         cache->stabilized.framenr = framenr;
891         cache->stabilized.aspect = tracking->camera.pixel_aspect;
892         cache->stabilized.filter = tracking->stabilization.filter;
893
894         if (clip->flag & MCLIP_USE_PROXY) {
895                 cache->stabilized.proxy = rendersize_to_proxy(user, clip->flag);
896                 cache->stabilized.render_flag = user->render_flag;
897         }
898         else {
899                 cache->stabilized.proxy = IMB_PROXY_NONE;
900                 cache->stabilized.render_flag = 0;
901         }
902
903         cache->stabilized.postprocess_flag = postprocess_flag;
904
905         IMB_refImBuf(stableibuf);
906
907         return stableibuf;
908 }
909
910 ImBuf *BKE_movieclip_get_stable_ibuf(MovieClip *clip, MovieClipUser *user, float loc[2], float *scale, float *angle,
911                                      int postprocess_flag)
912 {
913         ImBuf *ibuf, *stableibuf = NULL;
914         int framenr = user->framenr;
915
916         ibuf = BKE_movieclip_get_postprocessed_ibuf(clip, user, postprocess_flag);
917
918         if (!ibuf)
919                 return NULL;
920
921         if (clip->tracking.stabilization.flag & TRACKING_2D_STABILIZATION) {
922                 MovieClipCache *cache = clip->cache;
923
924                 stableibuf = get_stable_cached_frame(clip, user, framenr, postprocess_flag);
925
926                 if (!stableibuf)
927                         stableibuf = put_stabilized_frame_to_cache(clip, user, ibuf, framenr, postprocess_flag);
928
929                 if (loc)
930                         copy_v2_v2(loc, cache->stabilized.loc);
931
932                 if (scale)
933                         *scale = cache->stabilized.scale;
934
935                 if (angle)
936                         *angle = cache->stabilized.angle;
937         }
938         else {
939                 if (loc)
940                         zero_v2(loc);
941
942                 if (scale)
943                         *scale = 1.0f;
944
945                 if (angle)
946                         *angle = 0.0f;
947
948                 stableibuf = ibuf;
949         }
950
951         if (stableibuf != ibuf) {
952                 IMB_freeImBuf(ibuf);
953                 ibuf = stableibuf;
954         }
955
956         return ibuf;
957
958 }
959
960 int BKE_movieclip_has_frame(MovieClip *clip, MovieClipUser *user)
961 {
962         ImBuf *ibuf = BKE_movieclip_get_ibuf(clip, user);
963
964         if (ibuf) {
965                 IMB_freeImBuf(ibuf);
966                 return TRUE;
967         }
968
969         return FALSE;
970 }
971
972 void BKE_movieclip_get_size(MovieClip *clip, MovieClipUser *user, int *width, int *height)
973 {
974 #if 0
975         /* originally was needed to support image sequences with different image dimensions,
976          * which might be useful for such things as reconstruction of unordered image sequence,
977          * or painting/rotoscoping of non-equal-sized images, but this ended up in unneeded
978          * cache lookups and even unwanted non-proxied files loading when doing mask parenting,
979          * so let's disable this for now and assume image sequence consists of images with
980          * equal sizes (sergey)
981          */
982         if (user->framenr == clip->lastframe) {
983 #endif
984         if (clip->lastsize[0] != 0 && clip->lastsize[1] != 0) {
985                 *width = clip->lastsize[0];
986                 *height = clip->lastsize[1];
987         }
988         else {
989                 ImBuf *ibuf = BKE_movieclip_get_ibuf(clip, user);
990
991                 if (ibuf && ibuf->x && ibuf->y) {
992                         real_ibuf_size(clip, user, ibuf, width, height);
993                 }
994                 else {
995                         *width = clip->lastsize[0];
996                         *height = clip->lastsize[1];
997                 }
998
999                 if (ibuf)
1000                         IMB_freeImBuf(ibuf);
1001         }
1002 }
1003
1004 int BKE_movieclip_get_duration(MovieClip *clip)
1005 {
1006         if (!clip->len) {
1007                 movieclip_calc_length(clip);
1008         }
1009
1010         return clip->len;
1011 }
1012
1013 void BKE_movieclip_aspect(MovieClip *clip, float *aspx, float *aspy)
1014 {
1015         *aspx = *aspy = 1.0;
1016
1017         /* x is always 1 */
1018         *aspy = clip->aspy / clip->aspx / clip->tracking.camera.pixel_aspect;
1019 }
1020
1021 /* get segments of cached frames. useful for debugging cache policies */
1022 void BKE_movieclip_get_cache_segments(MovieClip *clip, MovieClipUser *user, int *totseg_r, int **points_r)
1023 {
1024         *totseg_r = 0;
1025         *points_r = NULL;
1026
1027         if (clip->cache) {
1028                 int proxy = rendersize_to_proxy(user, clip->flag);
1029
1030                 IMB_moviecache_get_cache_segments(clip->cache->moviecache, proxy, user->render_flag, totseg_r, points_r);
1031         }
1032 }
1033
1034 void BKE_movieclip_user_set_frame(MovieClipUser *iuser, int framenr)
1035 {
1036         /* TODO: clamp framenr here? */
1037
1038         iuser->framenr = framenr;
1039 }
1040
1041 static void free_buffers(MovieClip *clip)
1042 {
1043         if (clip->cache) {
1044                 IMB_moviecache_free(clip->cache->moviecache);
1045
1046                 if (clip->cache->postprocessed.ibuf)
1047                         IMB_freeImBuf(clip->cache->postprocessed.ibuf);
1048
1049                 if (clip->cache->stabilized.ibuf)
1050                         IMB_freeImBuf(clip->cache->stabilized.ibuf);
1051
1052                 MEM_freeN(clip->cache);
1053                 clip->cache = NULL;
1054         }
1055
1056         if (clip->anim) {
1057                 IMB_free_anim(clip->anim);
1058                 clip->anim = NULL;
1059         }
1060
1061         BKE_free_animdata((ID *) clip);
1062 }
1063
1064 void BKE_movieclip_reload(MovieClip *clip)
1065 {
1066         /* clear cache */
1067         free_buffers(clip);
1068
1069         clip->tracking.stabilization.ok = FALSE;
1070
1071         /* update clip source */
1072         if (BLI_testextensie_array(clip->name, imb_ext_movie))
1073                 clip->source = MCLIP_SRC_MOVIE;
1074         else
1075                 clip->source = MCLIP_SRC_SEQUENCE;
1076
1077         clip->lastsize[0] = clip->lastsize[1] = 0;
1078         movieclip_load_get_szie(clip);
1079
1080         movieclip_calc_length(clip);
1081 }
1082
1083 void BKE_movieclip_update_scopes(MovieClip *clip, MovieClipUser *user, MovieClipScopes *scopes)
1084 {
1085         if (scopes->ok)
1086                 return;
1087
1088         if (scopes->track_preview) {
1089                 IMB_freeImBuf(scopes->track_preview);
1090                 scopes->track_preview = NULL;
1091         }
1092
1093         if (scopes->track_search) {
1094                 IMB_freeImBuf(scopes->track_search);
1095                 scopes->track_search = NULL;
1096         }
1097
1098         scopes->marker = NULL;
1099         scopes->track = NULL;
1100         scopes->track_locked = TRUE;
1101
1102         if (clip) {
1103                 MovieTrackingTrack *act_track = BKE_tracking_track_get_active(&clip->tracking);
1104
1105                 if (act_track) {
1106                         MovieTrackingTrack *track = act_track;
1107                         int framenr = BKE_movieclip_remap_scene_to_clip_frame(clip, user->framenr);
1108                         MovieTrackingMarker *marker = BKE_tracking_marker_get(track, framenr);
1109
1110                         scopes->marker = marker;
1111                         scopes->track = track;
1112
1113                         if (marker->flag & MARKER_DISABLED) {
1114                                 scopes->track_disabled = TRUE;
1115                         }
1116                         else {
1117                                 ImBuf *ibuf = BKE_movieclip_get_ibuf(clip, user);
1118
1119                                 scopes->track_disabled = FALSE;
1120
1121                                 if (ibuf && (ibuf->rect || ibuf->rect_float)) {
1122                                         ImBuf *search_ibuf;
1123                                         MovieTrackingMarker undist_marker = *marker;
1124
1125                                         if (user->render_flag & MCLIP_PROXY_RENDER_UNDISTORT) {
1126                                                 int width, height;
1127                                                 float aspy = 1.0f / clip->tracking.camera.pixel_aspect;
1128
1129                                                 BKE_movieclip_get_size(clip, user, &width, &height);
1130
1131                                                 undist_marker.pos[0] *= width;
1132                                                 undist_marker.pos[1] *= height * aspy;
1133
1134                                                 BKE_tracking_undistort_v2(&clip->tracking, undist_marker.pos, undist_marker.pos);
1135
1136                                                 undist_marker.pos[0] /= width;
1137                                                 undist_marker.pos[1] /= height * aspy;
1138                                         }
1139
1140                                         search_ibuf = BKE_tracking_get_search_imbuf(ibuf, track, &undist_marker, TRUE, TRUE);
1141
1142                                         if (!search_ibuf->rect_float) {
1143                                                 /* sampling happens in float buffer */
1144                                                 IMB_float_from_rect(search_ibuf);
1145                                         }
1146
1147                                         scopes->undist_marker = undist_marker;
1148                                         scopes->track_search = search_ibuf;
1149
1150                                         scopes->frame_width = ibuf->x;
1151                                         scopes->frame_height = ibuf->y;
1152
1153                                         scopes->use_track_mask = track->flag & TRACK_PREVIEW_ALPHA;
1154                                 }
1155
1156                                 IMB_freeImBuf(ibuf);
1157                         }
1158
1159                         if ((track->flag & TRACK_LOCKED) == 0) {
1160                                 float pat_min[2], pat_max[2];
1161
1162                                 scopes->track_locked = FALSE;
1163
1164                                 /* XXX: would work fine with non-transformed patterns, but would likely fail
1165                                  *      with transformed patterns, but that would be easier to debug when
1166                                  *      we'll have real pattern sampling (at least to test) */
1167                                 BKE_tracking_marker_pattern_minmax(marker, pat_min, pat_max);
1168
1169                                 scopes->slide_scale[0] = pat_max[0] - pat_min[0];
1170                                 scopes->slide_scale[1] = pat_max[1] - pat_min[1];
1171                         }
1172                 }
1173         }
1174
1175         scopes->framenr = user->framenr;
1176         scopes->ok = TRUE;
1177 }
1178
1179 static void movieclip_build_proxy_ibuf(MovieClip *clip, ImBuf *ibuf, int cfra, int proxy_render_size, int undistorted)
1180 {
1181         char name[FILE_MAX];
1182         int quality, rectx, recty;
1183         int size = rendersize_to_number(proxy_render_size);
1184         ImBuf *scaleibuf;
1185
1186         get_proxy_fname(clip, proxy_render_size, undistorted, cfra, name);
1187
1188         rectx = ibuf->x * size / 100.0f;
1189         recty = ibuf->y * size / 100.0f;
1190
1191         scaleibuf = IMB_dupImBuf(ibuf);
1192
1193         IMB_scaleImBuf(scaleibuf, (short)rectx, (short)recty);
1194
1195         quality = clip->proxy.quality;
1196         scaleibuf->ftype = JPG | quality;
1197
1198         /* unsupported feature only confuses other s/w */
1199         if (scaleibuf->planes == 32)
1200                 scaleibuf->planes = 24;
1201
1202         BLI_lock_thread(LOCK_MOVIECLIP);
1203
1204         BLI_make_existing_file(name);
1205         if (IMB_saveiff(scaleibuf, name, IB_rect) == 0)
1206                 perror(name);
1207
1208         BLI_unlock_thread(LOCK_MOVIECLIP);
1209
1210         IMB_freeImBuf(scaleibuf);
1211 }
1212
1213 void BKE_movieclip_build_proxy_frame(MovieClip *clip, int clip_flag, struct MovieDistortion *distortion,
1214                                      int cfra, int *build_sizes, int build_count, int undistorted)
1215 {
1216         ImBuf *ibuf;
1217         MovieClipUser user;
1218
1219         user.framenr = cfra;
1220         user.render_flag = 0;
1221         user.render_size = MCLIP_PROXY_RENDER_SIZE_FULL;
1222
1223         ibuf = BKE_movieclip_get_ibuf_flag(clip, &user, clip_flag, MOVIECLIP_CACHE_SKIP);
1224
1225         if (ibuf) {
1226                 ImBuf *tmpibuf = ibuf;
1227                 int i;
1228
1229                 if (undistorted)
1230                         tmpibuf = get_undistorted_ibuf(clip, distortion, ibuf);
1231
1232                 for (i = 0; i < build_count; i++)
1233                         movieclip_build_proxy_ibuf(clip, tmpibuf, cfra, build_sizes[i], undistorted);
1234
1235                 IMB_freeImBuf(ibuf);
1236
1237                 if (tmpibuf != ibuf)
1238                         IMB_freeImBuf(tmpibuf);
1239         }
1240 }
1241
1242 void BKE_movieclip_free(MovieClip *clip)
1243 {
1244         free_buffers(clip);
1245
1246         BKE_tracking_free(&clip->tracking);
1247 }
1248
1249 void BKE_movieclip_unlink(Main *bmain, MovieClip *clip)
1250 {
1251         bScreen *scr;
1252         ScrArea *area;
1253         SpaceLink *sl;
1254         Scene *sce;
1255         Object *ob;
1256
1257         for (scr = bmain->screen.first; scr; scr = scr->id.next) {
1258                 for (area = scr->areabase.first; area; area = area->next) {
1259                         for (sl = area->spacedata.first; sl; sl = sl->next) {
1260                                 if (sl->spacetype == SPACE_CLIP) {
1261                                         SpaceClip *sc = (SpaceClip *) sl;
1262
1263                                         if (sc->clip == clip)
1264                                                 sc->clip = NULL;
1265                                 }
1266                                 else if (sl->spacetype == SPACE_VIEW3D) {
1267                                         View3D *v3d = (View3D *) sl;
1268                                         BGpic *bgpic;
1269
1270                                         for (bgpic = v3d->bgpicbase.first; bgpic; bgpic = bgpic->next) {
1271                                                 if (bgpic->clip == clip)
1272                                                         bgpic->clip = NULL;
1273                                         }
1274                                 }
1275                         }
1276                 }
1277         }
1278
1279         for (sce = bmain->scene.first; sce; sce = sce->id.next) {
1280                 if (sce->clip == clip)
1281                         sce->clip = NULL;
1282         }
1283
1284         for (ob = bmain->object.first; ob; ob = ob->id.next) {
1285                 bConstraint *con;
1286
1287                 for (con = ob->constraints.first; con; con = con->next) {
1288                         bConstraintTypeInfo *cti = constraint_get_typeinfo(con);
1289
1290                         if (cti->type == CONSTRAINT_TYPE_FOLLOWTRACK) {
1291                                 bFollowTrackConstraint *data = (bFollowTrackConstraint *) con->data;
1292
1293                                 if (data->clip == clip)
1294                                         data->clip = NULL;
1295                         }
1296                         else if (cti->type == CONSTRAINT_TYPE_CAMERASOLVER) {
1297                                 bCameraSolverConstraint *data = (bCameraSolverConstraint *) con->data;
1298
1299                                 if (data->clip == clip)
1300                                         data->clip = NULL;
1301                         }
1302                         else if (cti->type == CONSTRAINT_TYPE_OBJECTSOLVER) {
1303                                 bObjectSolverConstraint *data = (bObjectSolverConstraint *) con->data;
1304
1305                                 if (data->clip == clip)
1306                                         data->clip = NULL;
1307                         }
1308                 }
1309         }
1310
1311         clip->id.us = 0;
1312 }
1313
1314 float BKE_movieclip_remap_scene_to_clip_frame(MovieClip *clip, float framenr)
1315 {
1316         return framenr - (float) clip->start_frame + 1.0f;
1317 }
1318
1319 float BKE_movieclip_remap_clip_to_scene_frame(MovieClip *clip, float framenr)
1320 {
1321         return framenr + (float) clip->start_frame - 1.0f;
1322 }