Camera tracking integration
[blender.git] / source / blender / blenkernel / intern / movieclip.c
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * Contributor(s): Blender Foundation,
24  *                 Sergey Sharybin
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 /** \file blender/blenkernel/intern/movieclip.c
30  *  \ingroup bke
31  */
32
33
34 #include <stdio.h>
35 #include <string.h>
36 #include <fcntl.h>
37
38 #ifndef WIN32
39 #include <unistd.h>
40 #else
41 #include <io.h>
42 #endif
43
44 #include <time.h>
45
46 #ifdef _WIN32
47 #define open _open
48 #define close _close
49 #endif
50
51 #include "MEM_guardedalloc.h"
52
53 #include "DNA_screen_types.h"
54 #include "DNA_space_types.h"
55 #include "DNA_movieclip_types.h"
56 #include "DNA_object_types.h"   /* SELECT */
57
58 #include "BLI_utildefines.h"
59
60 #include "BLI_blenlib.h"
61 #include "BLI_ghash.h"
62 #include "BLI_math.h"
63 #include "BLI_mempool.h"
64 #include "BLI_threads.h"
65
66 #include "BKE_library.h"
67 #include "BKE_global.h"
68 #include "BKE_main.h"
69 #include "BKE_utildefines.h"
70 #include "BKE_movieclip.h"
71 #include "BKE_moviecache.h"
72 #include "BKE_image.h"  /* openanim */
73 #include "BKE_tracking.h"
74 #include "BKE_animsys.h"
75
76 #include "IMB_imbuf_types.h"
77 #include "IMB_imbuf.h"
78
79 /*********************** movieclip buffer loaders *************************/
80
81 static int sequence_guess_offset(const char *full_name, int head_len, int numlen)
82 {
83         char num[FILE_MAX]= {0};
84
85         strncpy(num, full_name+head_len, numlen);
86
87         return atoi(num);
88 }
89
90 static ImBuf *movieclip_load_sequence_file(MovieClip *clip, int framenr)
91 {
92         struct ImBuf *ibuf;
93         unsigned short numlen;
94         char name[FILE_MAX], head[FILE_MAX], tail[FILE_MAX];
95         int flag, offset;
96
97         BLI_strncpy(name, clip->name, sizeof(name));
98         BLI_stringdec(name, head, tail, &numlen);
99
100         /* movieclips always points to first image from sequence,
101            autoguess offset for now. could be something smarter in the future */
102         offset= sequence_guess_offset(clip->name, strlen(head), numlen);
103
104         if(numlen) BLI_stringenc(name, head, tail, numlen, offset+framenr-1);
105         else strncpy(name, clip->name, sizeof(name));
106
107         if(clip->id.lib)
108                 BLI_path_abs(name, clip->id.lib->filepath);
109         else
110                 BLI_path_abs(name, G.main->name);
111
112         flag= IB_rect|IB_multilayer;
113
114         /* read ibuf */
115         ibuf= IMB_loadiffname(name, flag);
116
117         return ibuf;
118 }
119
120 static ImBuf *movieclip_load_movie_file(MovieClip *clip, int framenr)
121 {
122         ImBuf *ibuf= NULL;
123         char str[FILE_MAX];
124
125         if(!clip->anim) {
126                 BLI_strncpy(str, clip->name, FILE_MAX);
127
128                 if(clip->id.lib)
129                         BLI_path_abs(str, clip->id.lib->filepath);
130                 else
131                         BLI_path_abs(str, G.main->name);
132
133                 clip->anim= openanim(str, IB_rect);
134         }
135
136         if(clip->anim) {
137                 int dur= IMB_anim_get_duration(clip->anim);
138                 int fra= framenr-1;
139
140                 if(fra<0)
141                         fra= 0;
142
143                 if(fra>(dur-1))
144                         fra= dur-1;
145
146                 ibuf= IMB_anim_absolute(clip->anim, fra);
147         }
148
149         return ibuf;
150 }
151
152 /*********************** image buffer cache *************************/
153
154 typedef struct MovieClipCache {
155         /* regular moive cache */
156         struct MovieCache *moviecache;
157
158         /* cache for stable shot */
159         int stable_framenr;
160         float stable_loc[2], stable_scale;
161         ImBuf *stableibuf;
162 } MovieClipCache;
163
164 typedef struct MovieClipImBufCacheKey {
165         int framenr;
166 } MovieClipImBufCacheKey;
167
168 static void moviecache_keydata(void *userkey, int *framenr)
169 {
170         MovieClipImBufCacheKey *key= (MovieClipImBufCacheKey*)userkey;
171
172         *framenr= key->framenr;
173 }
174
175 static unsigned int moviecache_hashhash(const void *keyv)
176 {
177         MovieClipImBufCacheKey *key= (MovieClipImBufCacheKey*)keyv;
178         int rval= key->framenr;
179
180         return rval;
181 }
182
183 static int moviecache_hashcmp(const void *av, const void *bv)
184 {
185         const MovieClipImBufCacheKey *a= (MovieClipImBufCacheKey*)av;
186         const MovieClipImBufCacheKey *b= (MovieClipImBufCacheKey*)bv;
187
188         if(a->framenr<b->framenr) return -1;
189         else if(a->framenr>b->framenr) return 1;
190
191         return 0;
192 }
193
194 static ImBuf *get_imbuf_cache(MovieClip *clip, MovieClipUser *user)
195 {
196         if(clip->cache) {
197                 MovieClipImBufCacheKey key;
198
199                 key.framenr= user?user->framenr:clip->lastframe;
200                 return BKE_moviecache_get(clip->cache->moviecache, &key);
201         }
202
203         return NULL;
204 }
205
206 static void put_imbuf_cache(MovieClip *clip, MovieClipUser *user, ImBuf *ibuf)
207 {
208         MovieClipImBufCacheKey key;
209
210         if(!clip->cache) {
211                 clip->cache= MEM_callocN(sizeof(MovieClipCache), "movieClipCache");
212
213                 clip->cache->moviecache= BKE_moviecache_create(sizeof(MovieClipImBufCacheKey), moviecache_hashhash,
214                                 moviecache_hashcmp, moviecache_keydata);
215         }
216
217         key.framenr= user?user->framenr:clip->lastframe;
218
219         BKE_moviecache_put(clip->cache->moviecache, &key, ibuf);
220 }
221
222 /*********************** common functions *************************/
223
224 /* only image block itself */
225 static MovieClip *movieclip_alloc(const char *name)
226 {
227         MovieClip *clip;
228
229         clip= alloc_libblock(&G.main->movieclip, ID_MC, name);
230
231         clip->aspx= clip->aspy= 1.0f;
232
233         clip->tracking.camera.sensor_width= 35.0f;
234         clip->tracking.camera.sensor_height= 18.0f;
235         clip->tracking.camera.units= CAMERA_UNITS_MM;
236
237         clip->tracking.settings.frames_limit= 20;
238         clip->tracking.settings.keyframe1= 1;
239         clip->tracking.settings.keyframe2= 30;
240
241         clip->tracking.stabilization.scaleinf= 1.f;
242         clip->tracking.stabilization.locinf= 1.f;
243
244         return clip;
245 }
246
247 /* checks if image was already loaded, then returns same image
248    otherwise creates new.
249    does not load ibuf itself
250    pass on optional frame for #name images */
251 MovieClip *BKE_add_movieclip_file(const char *name)
252 {
253         MovieClip *clip;
254         MovieClipUser user;
255         int file, len, width, height;
256         const char *libname;
257         char str[FILE_MAX], strtest[FILE_MAX];
258
259         BLI_strncpy(str, name, sizeof(str));
260         BLI_path_abs(str, G.main->name);
261
262         /* exists? */
263         file= open(str, O_BINARY|O_RDONLY);
264         if(file== -1) return NULL;
265         close(file);
266
267         /* ** first search an identical clip ** */
268         for(clip= G.main->movieclip.first; clip; clip= clip->id.next) {
269                 BLI_strncpy(strtest, clip->name, sizeof(clip->name));
270                 BLI_path_abs(strtest, G.main->name);
271
272                 if(strcmp(strtest, str)==0) {
273                         BLI_strncpy(clip->name, name, sizeof(clip->name));  /* for stringcode */
274                         clip->id.us++;  /* officially should not, it doesn't link here! */
275
276                         return clip;
277                 }
278         }
279
280         /* ** add new movieclip ** */
281
282         /* create a short library name */
283         len= strlen(name);
284
285         while (len > 0 && name[len - 1] != '/' && name[len - 1] != '\\') len--;
286         libname= name+len;
287
288         clip= movieclip_alloc(libname);
289         BLI_strncpy(clip->name, name, sizeof(clip->name));
290
291         if(BLI_testextensie_array(name, imb_ext_movie)) clip->source= MCLIP_SRC_MOVIE;
292         else clip->source= MCLIP_SRC_SEQUENCE;
293
294         user.framenr= 1;
295         BKE_movieclip_acquire_size(clip, &user, &width, &height);
296         if(width && height) {
297                 clip->tracking.camera.principal[0]= ((float)width)/2;
298                 clip->tracking.camera.principal[1]= ((float)height)/2;
299         }
300
301         return clip;
302 }
303
304 ImBuf *BKE_movieclip_acquire_ibuf(MovieClip *clip, MovieClipUser *user)
305 {
306         ImBuf *ibuf= NULL;
307         int framenr= user?user->framenr:clip->lastframe;
308
309         /* cache isn't threadsafe itself and also loading of movies
310            can't happen from concurent threads that's why we use lock here */
311         BLI_lock_thread(LOCK_MOVIECLIP);
312
313         /* cache is supposed to be threadsafe */
314         ibuf= get_imbuf_cache(clip, user);
315
316         if(!ibuf) {
317                 if(clip->source==MCLIP_SRC_SEQUENCE)
318                         ibuf= movieclip_load_sequence_file(clip, framenr);
319                 else {
320                         ibuf= movieclip_load_movie_file(clip, framenr);
321                 }
322
323                 if(ibuf)
324                         put_imbuf_cache(clip, user, ibuf);
325         }
326
327         if(ibuf) {
328                 clip->lastframe= framenr;
329
330                 clip->lastsize[0]= ibuf->x;
331                 clip->lastsize[1]= ibuf->y;
332         }
333
334         BLI_unlock_thread(LOCK_MOVIECLIP);
335
336         return ibuf;
337 }
338
339 ImBuf *BKE_movieclip_acquire_stable_ibuf(MovieClip *clip, MovieClipUser *user, float loc[2], float *scale)
340 {
341         ImBuf *ibuf, *stableibuf= NULL;
342         int framenr= user?user->framenr:clip->lastframe;
343
344         ibuf= BKE_movieclip_acquire_ibuf(clip, user);
345
346         if(clip->tracking.stabilization.flag&TRACKING_2D_STABILIZATION) {
347                 float tloc[2], tscale;
348
349                 if(clip->cache->stableibuf && clip->cache->stable_framenr==framenr) {
350                         stableibuf= clip->cache->stableibuf;
351
352                         BKE_tracking_stabilization_data(&clip->tracking, framenr, stableibuf->x, stableibuf->y, tloc, &tscale);
353
354                         if(!equals_v2v2(tloc, clip->cache->stable_loc) || tscale!=clip->cache->stable_scale) {
355                                 stableibuf= NULL;
356                         }
357                 }
358
359                 if(!stableibuf) {
360                         if(clip->cache->stableibuf)
361                                 IMB_freeImBuf(clip->cache->stableibuf);
362
363                         stableibuf= BKE_tracking_stabilize_shot(&clip->tracking, framenr, ibuf, tloc, &tscale);
364
365                         copy_v2_v2(clip->cache->stable_loc, tloc);
366                         clip->cache->stable_scale= tscale;
367                         clip->cache->stable_framenr= framenr;
368                         clip->cache->stableibuf= stableibuf;
369                 }
370
371                 IMB_refImBuf(stableibuf);
372
373                 if(loc)         copy_v2_v2(loc, tloc);
374                 if(scale)       *scale= tscale;
375         } else {
376                 if(loc)         zero_v2(loc);
377                 if(scale)       *scale= 1.f;
378
379                 stableibuf= ibuf;
380         }
381
382         if(stableibuf!=ibuf) {
383                 IMB_freeImBuf(ibuf);
384                 ibuf= stableibuf;
385         }
386
387         return ibuf;
388
389 }
390
391 int BKE_movieclip_has_frame(MovieClip *clip, MovieClipUser *user)
392 {
393         ImBuf *ibuf= BKE_movieclip_acquire_ibuf(clip, user);
394
395         if(ibuf) {
396                 IMB_freeImBuf(ibuf);
397                 return 1;
398         }
399
400         return 0;
401 }
402
403 void BKE_movieclip_acquire_size(MovieClip *clip, MovieClipUser *user, int *width, int *height)
404 {
405         if(!user || user->framenr==clip->lastframe) {
406                 *width= clip->lastsize[0];
407                 *height= clip->lastsize[1];
408         } else {
409                 ImBuf *ibuf= BKE_movieclip_acquire_ibuf(clip, user);
410
411                 if(ibuf && ibuf->x && ibuf->y) {
412                         *width= ibuf->x;
413                         *height= ibuf->y;
414                 } else {
415                         *width= 0;
416                         *height= 0;
417                 }
418
419                 if(ibuf)
420                         IMB_freeImBuf(ibuf);
421         }
422 }
423
424 void BKE_movieclip_aspect(MovieClip *clip, float *aspx, float *aspy)
425 {
426         *aspx= *aspy= 1.0;
427
428         /* x is always 1 */
429         *aspy = clip->aspy/clip->aspx;
430 }
431
432 /* get segments of cached frames. useful for debugging cache policies */
433 void BKE_movieclip_get_cache_segments(MovieClip *clip, int *totseg_r, int **points_r)
434 {
435         *totseg_r= 0;
436         *points_r= NULL;
437
438         if(clip->cache)
439                 BKE_moviecache_get_cache_segments(clip->cache->moviecache, totseg_r, points_r);
440 }
441
442 void BKE_movieclip_user_set_frame(MovieClipUser *iuser, int framenr)
443 {
444         /* TODO: clamp framenr here? */
445
446         iuser->framenr= framenr;
447 }
448
449 static void free_buffers(MovieClip *clip)
450 {
451         if(clip->cache) {
452                 BKE_moviecache_free(clip->cache->moviecache);
453
454                 if(clip->cache->stableibuf)
455                         IMB_freeImBuf(clip->cache->stableibuf);
456
457                 MEM_freeN(clip->cache);
458                 clip->cache= NULL;
459         }
460
461         if(clip->anim) {
462                 IMB_free_anim(clip->anim);
463                 clip->anim= FALSE;
464         }
465 }
466
467 void BKE_movieclip_reload(MovieClip *clip)
468 {
469         /* clear cache */
470         free_buffers(clip);
471
472         clip->tracking.stabilization.ok= 0;
473
474         /* update clip source */
475         if(BLI_testextensie_array(clip->name, imb_ext_movie)) clip->source= MCLIP_SRC_MOVIE;
476         else clip->source= MCLIP_SRC_SEQUENCE;
477 }
478
479 /* area - which part of marker should be selected. see TRACK_AREA_* constants */
480 void BKE_movieclip_select_track(MovieClip *clip, MovieTrackingTrack *track, int area, int extend)
481 {
482         if(extend) {
483                 BKE_tracking_track_flag(track, area, SELECT, 0);
484         } else {
485                 MovieTrackingTrack *cur= clip->tracking.tracks.first;
486
487                 while(cur) {
488                         if(cur==track) {
489                                 BKE_tracking_track_flag(cur, TRACK_AREA_ALL, SELECT, 1);
490                                 BKE_tracking_track_flag(cur, area, SELECT, 0);
491                         }
492                         else {
493                                 BKE_tracking_track_flag(cur, TRACK_AREA_ALL, SELECT, 1);
494                         }
495
496                         cur= cur->next;
497                 }
498         }
499
500         if(!TRACK_SELECTED(track))
501                 BKE_movieclip_set_selection(clip, MCLIP_SEL_NONE, NULL);
502 }
503
504 void BKE_movieclip_deselect_track(MovieClip *clip, MovieTrackingTrack *track, int area)
505 {
506         BKE_tracking_track_flag(track, area, SELECT, 1);
507
508         if(!TRACK_SELECTED(track))
509                 BKE_movieclip_set_selection(clip, MCLIP_SEL_NONE, NULL);
510 }
511
512 void BKE_movieclip_set_selection(MovieClip *clip, int type, void *sel)
513 {
514         clip->sel_type= type;
515
516         if(type == MCLIP_SEL_NONE) clip->last_sel= NULL;
517         else clip->last_sel= sel;
518 }
519
520 void BKE_movieclip_last_selection(MovieClip *clip, int *type, void **sel)
521 {
522         *type= clip->sel_type;
523
524         if(clip->sel_type == MCLIP_SEL_NONE) *sel= NULL;
525         else *sel= clip->last_sel;
526 }
527
528 void BKE_movieclip_update_scopes(MovieClip *clip, MovieClipUser *user, MovieClipScopes *scopes)
529 {
530         void *sel;
531         int sel_type;
532
533         if(scopes->ok) return;
534
535         if(scopes->track_preview) {
536                 IMB_freeImBuf(scopes->track_preview);
537                 scopes->track_preview= NULL;
538         }
539
540         scopes->marker= NULL;
541         scopes->track= NULL;
542
543         if(clip) {
544                 BKE_movieclip_last_selection(clip, &sel_type, &sel);
545
546                 if(sel_type==MCLIP_SEL_TRACK) {
547                         MovieTrackingTrack *track= (MovieTrackingTrack*)sel;
548                         MovieTrackingMarker *marker= BKE_tracking_get_marker(track, user->framenr);
549
550                         if(marker->flag&MARKER_DISABLED) {
551                                 scopes->track_disabled= 1;
552                         } else {
553                                 ImBuf *ibuf= BKE_movieclip_acquire_ibuf(clip, user);
554
555                                 scopes->track_disabled= 0;
556
557                                 if(ibuf && ibuf->rect) {
558                                         ImBuf *tmpibuf;
559
560                                         tmpibuf= BKE_tracking_acquire_pattern_imbuf(ibuf, track, marker, 1, scopes->track_pos, NULL);
561
562                                         if(tmpibuf->rect_float)
563                                                 IMB_rect_from_float(tmpibuf);
564
565                                         if(tmpibuf->rect)
566                                                 scopes->track_preview= tmpibuf;
567                                         else
568                                                 IMB_freeImBuf(tmpibuf);
569                                 }
570
571                                 IMB_freeImBuf(ibuf);
572                         }
573
574                         if((track->flag&TRACK_LOCKED)==0) {
575                                 scopes->marker= marker;
576                                 scopes->track= track;
577                                 scopes->slide_scale[0]= track->pat_max[0]-track->pat_min[0];
578                                 scopes->slide_scale[1]= track->pat_max[1]-track->pat_min[1];
579                         }
580                 }
581         }
582
583         scopes->framenr= user->framenr;
584         scopes->ok= 1;
585 }
586
587 void free_movieclip(MovieClip *clip)
588 {
589         free_buffers(clip);
590
591         BKE_tracking_free(&clip->tracking);
592 }
593
594 void unlink_movieclip(Main *bmain, MovieClip *clip)
595 {
596         bScreen *scr;
597         ScrArea *area;
598         SpaceLink *sl;
599
600         /* text space */
601         for(scr= bmain->screen.first; scr; scr= scr->id.next) {
602                 for(area= scr->areabase.first; area; area= area->next) {
603                         for(sl= area->spacedata.first; sl; sl= sl->next) {
604                                 if(sl->spacetype==SPACE_CLIP) {
605                                         SpaceClip *sc= (SpaceClip*) sl;
606
607                                         if(sc->clip==clip) {
608                                                 sc->clip= NULL;
609                                         }
610                                 }
611                         }
612                 }
613         }
614
615         clip->id.us= 0;
616 }