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