movieclip.c

Go to the documentation of this file.

/*
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2011 Blender Foundation.
 * All rights reserved.
 *
 * Contributor(s): Blender Foundation,
 *                 Sergey Sharybin
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#include <stdio.h>
#include <string.h>
#include <fcntl.h>

#ifndef WIN32
#include <unistd.h>
#else
#include <io.h>
#endif

#include <time.h>

#ifdef _WIN32
#define open _open
#define close _close
#endif

#include "MEM_guardedalloc.h"

#include "DNA_constraint_types.h"
#include "DNA_screen_types.h"
#include "DNA_space_types.h"
#include "DNA_movieclip_types.h"
#include "DNA_object_types.h"
#include "DNA_scene_types.h"
#include "DNA_view3d_types.h"

#include "BLI_utildefines.h"

#include "BLI_blenlib.h"
#include "BLI_ghash.h"
#include "BLI_math.h"
#include "BLI_mempool.h"
#include "BLI_threads.h"

#include "BKE_constraint.h"
#include "BKE_library.h"
#include "BKE_global.h"
#include "BKE_main.h"
#include "BKE_utildefines.h"
#include "BKE_movieclip.h"
#include "BKE_image.h"  /* openanim */
#include "BKE_tracking.h"

#include "IMB_imbuf_types.h"
#include "IMB_imbuf.h"
#include "IMB_moviecache.h"

/*********************** movieclip buffer loaders *************************/

static int sequence_guess_offset(const char *full_name, int head_len, int numlen)
{
    char num[FILE_MAX]= {0};

    BLI_strncpy(num, full_name+head_len, numlen+1);

    return atoi(num);
}

static int rendersize_to_proxy(MovieClipUser *user, int flag)
{
    if((flag&MCLIP_USE_PROXY)==0)
        return IMB_PROXY_NONE;

    switch(user->render_size) {
        case MCLIP_PROXY_RENDER_SIZE_25:
            return IMB_PROXY_25;

        case MCLIP_PROXY_RENDER_SIZE_50:
            return IMB_PROXY_50;

        case MCLIP_PROXY_RENDER_SIZE_75:
            return IMB_PROXY_75;

        case MCLIP_PROXY_RENDER_SIZE_100:
            return IMB_PROXY_100;

        case MCLIP_PROXY_RENDER_SIZE_FULL:
            return IMB_PROXY_NONE;
    }

    return IMB_PROXY_NONE;
}

static int rendersize_to_number(int render_size)
{
    switch(render_size) {
        case MCLIP_PROXY_RENDER_SIZE_25:
            return 25;

        case MCLIP_PROXY_RENDER_SIZE_50:
            return 50;

        case MCLIP_PROXY_RENDER_SIZE_75:
            return 75;

        case MCLIP_PROXY_RENDER_SIZE_100:
            return 100;

        case MCLIP_PROXY_RENDER_SIZE_FULL:
            return 100;
    }

    return 100;
}

static int get_timecode(MovieClip *clip, int flag)
{
    if((flag&MCLIP_USE_PROXY)==0)
        return IMB_TC_NONE;

    return clip->proxy.tc;
}

static void get_sequence_fname(MovieClip *clip, int framenr, char *name)
{
    unsigned short numlen;
    char head[FILE_MAX], tail[FILE_MAX];
    int offset;

    BLI_strncpy(name, clip->name, sizeof(clip->name));
    BLI_stringdec(name, head, tail, &numlen);

    /* movieclips always points to first image from sequence,
       autoguess offset for now. could be something smarter in the future */
    offset= sequence_guess_offset(clip->name, strlen(head), numlen);

    if (numlen) BLI_stringenc(name, head, tail, numlen, offset+framenr-1);
    else        BLI_strncpy(name, clip->name, sizeof(clip->name));

    BLI_path_abs(name, ID_BLEND_PATH(G.main, &clip->id));
}

/* supposed to work with sequences only */
static void get_proxy_fname(MovieClip *clip, int proxy_render_size, int undistorted, int framenr, char *name)
{
    int size= rendersize_to_number(proxy_render_size);
    char dir[FILE_MAX], clipdir[FILE_MAX], clipfile[FILE_MAX];

    BLI_split_dirfile(clip->name, clipdir, clipfile, FILE_MAX, FILE_MAX);

    if(clip->flag&MCLIP_USE_PROXY_CUSTOM_DIR) {
        BLI_strncpy(dir, clip->proxy.dir, sizeof(dir));
    } else {
        BLI_snprintf(dir, FILE_MAX, "%s/BL_proxy", clipdir);
    }

    if(undistorted)
        BLI_snprintf(name, FILE_MAX, "%s/%s/proxy_%d_undistorted/%08d", dir, clipfile, size, framenr);
    else
        BLI_snprintf(name, FILE_MAX, "%s/%s/proxy_%d/%08d", dir, clipfile, size, framenr);

    BLI_path_abs(name, G.main->name);
    BLI_path_frame(name, 1, 0);

    strcat(name, ".jpg");
}

static ImBuf *movieclip_load_sequence_file(MovieClip *clip, MovieClipUser *user, int framenr, int flag)
{
    struct ImBuf *ibuf;
    char name[FILE_MAX];
    int loadflag, use_proxy= 0;

    use_proxy= (flag&MCLIP_USE_PROXY) && user->render_size != MCLIP_PROXY_RENDER_SIZE_FULL;
    if(use_proxy) {
        int undistort= user->render_flag&MCLIP_PROXY_RENDER_UNDISTORT;
        get_proxy_fname(clip, user->render_size, undistort, framenr, name);
    } else
        get_sequence_fname(clip, framenr, name);

    loadflag= IB_rect|IB_multilayer;

    /* read ibuf */
    ibuf= IMB_loadiffname(name, loadflag);

    return ibuf;
}

static ImBuf *movieclip_load_movie_file(MovieClip *clip, MovieClipUser *user, int framenr, int flag)
{
    ImBuf *ibuf= NULL;
    int tc= get_timecode(clip, flag);
    int proxy= rendersize_to_proxy(user, flag);
    char str[FILE_MAX];

    if(!clip->anim) {
        BLI_strncpy(str, clip->name, FILE_MAX);
        BLI_path_abs(str, ID_BLEND_PATH(G.main, &clip->id));

        /* FIXME: make several stream accessible in image editor, too */
        clip->anim= openanim(str, IB_rect, 0);

        if(clip->anim) {
            if(clip->flag&MCLIP_USE_PROXY_CUSTOM_DIR) {
                char dir[FILE_MAX];
                BLI_strncpy(dir, clip->proxy.dir, sizeof(dir));
                BLI_path_abs(dir, G.main->name);
                IMB_anim_set_index_dir(clip->anim, dir);
            }
        }
    }

    if(clip->anim) {
        int dur;
        int fra;

        dur= IMB_anim_get_duration(clip->anim, tc);
        fra= framenr-1;

        if(fra<0)
            fra= 0;

        if(fra>(dur-1))
            fra= dur-1;

        ibuf= IMB_anim_absolute(clip->anim, fra, tc, proxy);
    }

    return ibuf;
}

/*********************** image buffer cache *************************/

typedef struct MovieClipCache {
    /* regular movie cache */
    struct MovieCache *moviecache;

    /* cached postprocessed shot */
    struct {
        ImBuf *ibuf;
        int framenr;
        int flag;

        /* cache for undistorted shot */
        float principal[2];
        float k1, k2, k3;
        short undistoriton_used;

        int proxy;
        short render_flag;
    } postprocessed;

    /* cache for stable shot */
    struct {
        ImBuf *ibuf;
        int framenr;

        float loc[2], scale, angle;
        int proxy;
        short render_flag;
    } stabilized;
} MovieClipCache;

typedef struct MovieClipImBufCacheKey {
    int framenr;
    int proxy;
    short render_flag;
} MovieClipImBufCacheKey;

static void moviecache_keydata(void *userkey, int *framenr, int *proxy, int *render_flags)
{
    MovieClipImBufCacheKey *key= (MovieClipImBufCacheKey*)userkey;

    *framenr= key->framenr;
    *proxy= key->proxy;
    *render_flags= key->render_flag;
}

static unsigned int moviecache_hashhash(const void *keyv)
{
    MovieClipImBufCacheKey *key= (MovieClipImBufCacheKey*)keyv;
    int rval= key->framenr;

    return rval;
}

static int moviecache_hashcmp(const void *av, const void *bv)
{
    const MovieClipImBufCacheKey *a= (MovieClipImBufCacheKey*)av;
    const MovieClipImBufCacheKey *b= (MovieClipImBufCacheKey*)bv;

    if(a->framenr<b->framenr) return -1;
    else if(a->framenr>b->framenr) return 1;

    if(a->proxy<b->proxy) return -1;
    else if(a->proxy>b->proxy) return 1;

    if(a->render_flag<b->render_flag) return -1;
    else if(a->render_flag>b->render_flag) return 1;

    return 0;
}

static ImBuf *get_imbuf_cache(MovieClip *clip, MovieClipUser *user, int flag)
{
    if(clip->cache) {
        MovieClipImBufCacheKey key;

        key.framenr= user->framenr;

        if(flag&MCLIP_USE_PROXY) {
            key.proxy= rendersize_to_proxy(user, flag);
            key.render_flag= user->render_flag;
        }
        else {
            key.proxy= IMB_PROXY_NONE;
            key.render_flag= 0;
        }

        return IMB_moviecache_get(clip->cache->moviecache, &key);
    }

    return NULL;
}

static void put_imbuf_cache(MovieClip *clip, MovieClipUser *user, ImBuf *ibuf, int flag)
{
    MovieClipImBufCacheKey key;

    if(!clip->cache) {
        clip->cache= MEM_callocN(sizeof(MovieClipCache), "movieClipCache");

        clip->cache->moviecache= IMB_moviecache_create(sizeof(MovieClipImBufCacheKey), moviecache_hashhash,
                moviecache_hashcmp, moviecache_keydata);
    }

    key.framenr= user->framenr;

    if(flag&MCLIP_USE_PROXY) {
        key.proxy= rendersize_to_proxy(user, flag);
        key.render_flag= user->render_flag;
    }
    else {
        key.proxy= IMB_PROXY_NONE;
        key.render_flag= 0;
    }

    IMB_moviecache_put(clip->cache->moviecache, &key, ibuf);
}

/*********************** common functions *************************/

/* only image block itself */
static MovieClip *movieclip_alloc(const char *name)
{
    MovieClip *clip;

    clip= alloc_libblock(&G.main->movieclip, ID_MC, name);

    clip->aspx= clip->aspy= 1.0f;

    BKE_tracking_init_settings(&clip->tracking);

    clip->proxy.build_size_flag= IMB_PROXY_25;
    clip->proxy.build_tc_flag= IMB_TC_RECORD_RUN |
                               IMB_TC_FREE_RUN |
                               IMB_TC_INTERPOLATED_REC_DATE_FREE_RUN |
                               IMB_TC_RECORD_RUN_NO_GAPS;
    clip->proxy.quality= 90;

    return clip;
}

/* checks if image was already loaded, then returns same image
   otherwise creates new.
   does not load ibuf itself
   pass on optional frame for #name images */
MovieClip *BKE_add_movieclip_file(const char *name)
{
    MovieClip *clip;
    MovieClipUser user;
    int file, len, width, height;
    const char *libname;
    char str[FILE_MAX], strtest[FILE_MAX];

    BLI_strncpy(str, name, sizeof(str));
    BLI_path_abs(str, G.main->name);

    /* exists? */
    file= open(str, O_BINARY|O_RDONLY);
    if(file== -1) return NULL;
    close(file);

    /* ** first search an identical clip ** */
    for(clip= G.main->movieclip.first; clip; clip= clip->id.next) {
        BLI_strncpy(strtest, clip->name, sizeof(clip->name));
        BLI_path_abs(strtest, G.main->name);

        if(strcmp(strtest, str)==0) {
            BLI_strncpy(clip->name, name, sizeof(clip->name));  /* for stringcode */
            clip->id.us++;  /* officially should not, it doesn't link here! */

            return clip;
        }
    }

    /* ** add new movieclip ** */

    /* create a short library name */
    len= strlen(name);

    while (len > 0 && name[len - 1] != '/' && name[len - 1] != '\\') len--;
    libname= name+len;

    clip= movieclip_alloc(libname);
    BLI_strncpy(clip->name, name, sizeof(clip->name));

    if(BLI_testextensie_array(name, imb_ext_movie)) clip->source= MCLIP_SRC_MOVIE;
    else clip->source= MCLIP_SRC_SEQUENCE;

    user.framenr= 1;
    BKE_movieclip_get_size(clip, &user, &width, &height);
    if(width && height) {
        clip->tracking.camera.principal[0]= ((float)width)/2;
        clip->tracking.camera.principal[1]= ((float)height)/2;

        clip->tracking.camera.focal= 24.0f*width/clip->tracking.camera.sensor_width;
    }

    return clip;
}

static void real_ibuf_size(MovieClip *clip, MovieClipUser *user, ImBuf *ibuf, int *width, int *height)
{
    *width= ibuf->x;
    *height= ibuf->y;

    if(clip->flag&MCLIP_USE_PROXY) {
        switch(user->render_size) {
            case MCLIP_PROXY_RENDER_SIZE_25:
                (*width)*= 4;
                (*height)*= 4;
                break;

            case MCLIP_PROXY_RENDER_SIZE_50:
                (*width)*= 2.0f;
                (*height)*= 2.0f;
                break;

            case MCLIP_PROXY_RENDER_SIZE_75:
                *width= ((float)*width)*4.0f/3.0f;
                *height= ((float)*height)*4.0f/3.0f;
                break;
        }
    }
}

static ImBuf *get_undistorted_ibuf(MovieClip *clip, struct MovieDistortion *distortion, ImBuf *ibuf)
{
    ImBuf *undistibuf;

    /* XXX: because of #27997 do not use float buffers to undistort,
            otherwise, undistorted proxy can be darker than it should */
    imb_freerectfloatImBuf(ibuf);

    if(distortion)
        undistibuf= BKE_tracking_distortion_exec(distortion, &clip->tracking, ibuf, ibuf->x, ibuf->y, 0.0f, 1);
    else
        undistibuf= BKE_tracking_undistort(&clip->tracking, ibuf, ibuf->x, ibuf->y, 0.0f);

    if(undistibuf->userflags&IB_RECT_INVALID) {
        ibuf->userflags&= ~IB_RECT_INVALID;
        IMB_rect_from_float(undistibuf);
    }

    IMB_scaleImBuf(undistibuf, ibuf->x, ibuf->y);

    return undistibuf;
}

static int need_undistortion_postprocess(MovieClipUser *user, int flag)
{
    int result = 0;

    /* only full undistorted render can be used as on-fly undistorting image */
    if(flag & MCLIP_USE_PROXY) {
        result |= (user->render_size == MCLIP_PROXY_RENDER_SIZE_FULL) &&
                  (user->render_flag & MCLIP_PROXY_RENDER_UNDISTORT) != 0;
    }

    return result;
}

static int need_postprocessed_frame(MovieClipUser *user, int flag, int postprocess_flag)
{
    int result = postprocess_flag;

    result |= need_undistortion_postprocess(user, flag);

    return result;
}

static int check_undistortion_cache_flags(MovieClip *clip)
{
    MovieClipCache *cache= clip->cache;
    MovieTrackingCamera *camera= &clip->tracking.camera;

    /* check for distortion model changes */
    if(!equals_v2v2(camera->principal, cache->postprocessed.principal))
        return 0;

    if(!equals_v3v3(&camera->k1, &cache->postprocessed.k1))
        return 0;

    return 1;
}

static ImBuf *get_postprocessed_cached_frame(MovieClip *clip, MovieClipUser *user, int flag, int postprocess_flag)
{
    MovieClipCache *cache= clip->cache;
    int framenr= user->framenr;
    short proxy= IMB_PROXY_NONE;
    int render_flag= 0;

    if(flag&MCLIP_USE_PROXY) {
        proxy= rendersize_to_proxy(user, flag);
        render_flag= user->render_flag;
    }

    /* no cache or no cached postprocessed image */
    if(!clip->cache || !clip->cache->postprocessed.ibuf)
        return NULL;

    /* postprocessing happened for other frame */
    if(cache->postprocessed.framenr != framenr)
        return NULL;

    /* cached ibuf used different proxy settings */
    if(cache->postprocessed.render_flag != render_flag || cache->postprocessed.proxy != proxy)
        return NULL;

    if(cache->postprocessed.flag != postprocess_flag)
        return NULL;

    if(need_undistortion_postprocess(user, flag)) {
        if(!check_undistortion_cache_flags(clip))
            return NULL;
    }
    else if(cache->postprocessed.undistoriton_used)
        return NULL;

    IMB_refImBuf(cache->postprocessed.ibuf);

    return cache->postprocessed.ibuf;
}

static ImBuf *put_postprocessed_frame_to_cache(MovieClip *clip, MovieClipUser *user, ImBuf *ibuf, int flag, int postprocess_flag)
{
    MovieClipCache *cache= clip->cache;
    MovieTrackingCamera *camera= &clip->tracking.camera;
    ImBuf *postproc_ibuf = NULL;

    if(cache->postprocessed.ibuf)
        IMB_freeImBuf(cache->postprocessed.ibuf);

    cache->postprocessed.framenr= user->framenr;
    cache->postprocessed.flag = postprocess_flag;

    if(flag&MCLIP_USE_PROXY) {
        cache->postprocessed.proxy= rendersize_to_proxy(user, flag);
        cache->postprocessed.render_flag= user->render_flag;
    }
    else {
        cache->postprocessed.proxy = IMB_PROXY_NONE;
        cache->postprocessed.render_flag = 0;
    }

    if(need_undistortion_postprocess(user, flag)) {
        copy_v2_v2(cache->postprocessed.principal, camera->principal);
        copy_v3_v3(&cache->postprocessed.k1, &camera->k1);
        cache->postprocessed.undistoriton_used = 1;
        postproc_ibuf= get_undistorted_ibuf(clip, NULL, ibuf);
    }
    else cache->postprocessed.undistoriton_used = 0;

    if(postprocess_flag) {
        int disable_red   = postprocess_flag & MOVIECLIP_DISABLE_RED,
            disable_green = postprocess_flag & MOVIECLIP_DISABLE_GREEN,
            disable_blue  = postprocess_flag & MOVIECLIP_DISABLE_BLUE,
            grayscale     = postprocess_flag & MOVIECLIP_PREVIEW_GRAYSCALE;

        if(!postproc_ibuf)
            postproc_ibuf = IMB_dupImBuf(ibuf);

        if(disable_red || disable_green || disable_blue || grayscale)
            BKE_tracking_disable_imbuf_channels(postproc_ibuf, disable_red, disable_green, disable_blue, 1);
    }

    IMB_refImBuf(postproc_ibuf);

    cache->postprocessed.ibuf= postproc_ibuf;

    if(cache->stabilized.ibuf) {
        /* force stable buffer be re-calculated */
        IMB_freeImBuf(cache->stabilized.ibuf);
        cache->stabilized.ibuf= NULL;
    }

    return postproc_ibuf;
}

static ImBuf *movieclip_get_postprocessed_ibuf(MovieClip *clip, MovieClipUser *user, int flag, int postprocess_flag)
{
    ImBuf *ibuf= NULL;
    int framenr= user->framenr, need_postprocess= 0;

    /* cache isn't threadsafe itself and also loading of movies
       can't happen from concurent threads that's why we use lock here */
    BLI_lock_thread(LOCK_MOVIECLIP);

    /* try to obtain cached postprocessed frame first */
    if(need_postprocessed_frame(user, flag, postprocess_flag)) {
        ibuf= get_postprocessed_cached_frame(clip, user, flag, postprocess_flag);

        if(!ibuf)
            need_postprocess= 1;
    }

    if(!ibuf)
        ibuf= get_imbuf_cache(clip, user, flag);

    if(!ibuf) {
        int use_sequence= 0;

        /* undistorted proxies for movies should be read as image sequence */
        use_sequence= (user->render_flag&MCLIP_PROXY_RENDER_UNDISTORT) &&
            (user->render_size!=MCLIP_PROXY_RENDER_SIZE_FULL);

        if(clip->source==MCLIP_SRC_SEQUENCE || use_sequence)
            ibuf= movieclip_load_sequence_file(clip, user, framenr, flag);
        else {
            ibuf= movieclip_load_movie_file(clip, user, framenr, flag);
        }

        if(ibuf)
            put_imbuf_cache(clip, user, ibuf, flag);
    }

    if(ibuf) {
        clip->lastframe= framenr;
        real_ibuf_size(clip, user, ibuf, &clip->lastsize[0], &clip->lastsize[1]);

        /* postprocess frame and put to cache */
        if(need_postprocess) {
            ImBuf *tmpibuf= ibuf;
            ibuf= put_postprocessed_frame_to_cache(clip, user, tmpibuf, flag, postprocess_flag);
            IMB_freeImBuf(tmpibuf);
        }
    }

    BLI_unlock_thread(LOCK_MOVIECLIP);

    return ibuf;
}

ImBuf *BKE_movieclip_get_ibuf(MovieClip *clip, MovieClipUser *user)
{
    return BKE_movieclip_get_ibuf_flag(clip, user, clip->flag);
}

ImBuf *BKE_movieclip_get_ibuf_flag(MovieClip *clip, MovieClipUser *user, int flag)
{
    return movieclip_get_postprocessed_ibuf(clip, user, flag, 0);
}

ImBuf *BKE_movieclip_get_postprocessed_ibuf(MovieClip *clip, MovieClipUser *user, int postprocess_flag)
{
    return movieclip_get_postprocessed_ibuf(clip, user, clip->flag, postprocess_flag);
}

static ImBuf *get_stable_cached_frame(MovieClip *clip, MovieClipUser *user, int framenr)
{
    MovieClipCache *cache = clip->cache;
    ImBuf *stableibuf;
    float tloc[2], tscale, tangle;
    short proxy = IMB_PROXY_NONE;
    int render_flag = 0;

    if(clip->flag&MCLIP_USE_PROXY) {
        proxy = rendersize_to_proxy(user, clip->flag);
        render_flag = user->render_flag;
    }

    /* there's no cached frame or it was calculated for another frame */
    if(!cache->stabilized.ibuf || cache->stabilized.framenr != framenr)
        return NULL;

    /* cached ibuf used different proxy settings */
    if(cache->stabilized.render_flag!=render_flag || cache->stabilized.proxy!=proxy)
        return NULL;

    stableibuf = cache->stabilized.ibuf;

    BKE_tracking_stabilization_data(&clip->tracking, framenr, stableibuf->x, stableibuf->y, tloc, &tscale, &tangle);

    /* check for stabilization parameters */
    if(tscale != cache->stabilized.scale ||
       tangle != cache->stabilized.angle ||
       !equals_v2v2(tloc, cache->stabilized.loc))
    {
        return NULL;
    }

    IMB_refImBuf(stableibuf);

    return stableibuf;
}

static ImBuf *put_stabilized_frame_to_cache(MovieClip *clip, MovieClipUser *user, ImBuf *ibuf, int framenr)
{
    MovieClipCache *cache = clip->cache;
    ImBuf *stableibuf;
    float tloc[2], tscale, tangle;

    if(cache->stabilized.ibuf)
        IMB_freeImBuf(cache->stabilized.ibuf);

    stableibuf = BKE_tracking_stabilize(&clip->tracking, framenr, ibuf, tloc, &tscale, &tangle);

    cache->stabilized.ibuf= stableibuf;

    copy_v2_v2(cache->stabilized.loc, tloc);

    cache->stabilized.scale = tscale;
    cache->stabilized.angle = tangle;
    cache->stabilized.framenr = framenr;

    if(clip->flag&MCLIP_USE_PROXY) {
        cache->stabilized.proxy= rendersize_to_proxy(user, clip->flag);
        cache->stabilized.render_flag= user->render_flag;
    }
    else {
        cache->stabilized.proxy = IMB_PROXY_NONE;
        cache->stabilized.render_flag = 0;
    }

    IMB_refImBuf(stableibuf);

    return stableibuf;
}

ImBuf *BKE_movieclip_get_stable_ibuf(MovieClip *clip, MovieClipUser *user, float loc[2], float *scale, float *angle, int postprocess_flag)
{
    ImBuf *ibuf, *stableibuf= NULL;
    int framenr= user->framenr;

    ibuf= BKE_movieclip_get_postprocessed_ibuf(clip, user, postprocess_flag);

    if(!ibuf)
        return NULL;

    if(clip->tracking.stabilization.flag&TRACKING_2D_STABILIZATION) {
        MovieClipCache *cache= clip->cache;

        stableibuf= get_stable_cached_frame(clip, user, framenr);

        if(!stableibuf)
            stableibuf= put_stabilized_frame_to_cache(clip, user, ibuf, framenr);

        if(loc)     copy_v2_v2(loc, cache->stabilized.loc);
        if(scale)   *scale= cache->stabilized.scale;
        if(angle)   *angle= cache->stabilized.angle;
    } else {
        if(loc)     zero_v2(loc);
        if(scale)   *scale= 1.0f;
        if(angle)   *angle= 0.0f;

        stableibuf= ibuf;
    }

    if(stableibuf!=ibuf) {
        IMB_freeImBuf(ibuf);
        ibuf= stableibuf;
    }

    return ibuf;

}

int BKE_movieclip_has_frame(MovieClip *clip, MovieClipUser *user)
{
    ImBuf *ibuf= BKE_movieclip_get_ibuf(clip, user);

    if(ibuf) {
        IMB_freeImBuf(ibuf);
        return 1;
    }

    return 0;
}

void BKE_movieclip_get_size(MovieClip *clip, MovieClipUser *user, int *width, int *height)
{
    if(user->framenr==clip->lastframe) {
        *width= clip->lastsize[0];
        *height= clip->lastsize[1];
    } else {
        ImBuf *ibuf= BKE_movieclip_get_ibuf(clip, user);

        if(ibuf && ibuf->x && ibuf->y) {
            real_ibuf_size(clip, user, ibuf, width, height);
        } else {
            *width= 0;
            *height= 0;
        }

        if(ibuf)
            IMB_freeImBuf(ibuf);
    }
}

void BKE_movieclip_aspect(MovieClip *clip, float *aspx, float *aspy)
{
    *aspx= *aspy= 1.0;

    /* x is always 1 */
    *aspy = clip->aspy/clip->aspx/clip->tracking.camera.pixel_aspect;
}

/* get segments of cached frames. useful for debugging cache policies */
void BKE_movieclip_get_cache_segments(MovieClip *clip, MovieClipUser *user, int *totseg_r, int **points_r)
{
    *totseg_r= 0;
    *points_r= NULL;

    if(clip->cache) {
        int proxy= rendersize_to_proxy(user, clip->flag);

        IMB_moviecache_get_cache_segments(clip->cache->moviecache, proxy, user->render_flag, totseg_r, points_r);
    }
}

void BKE_movieclip_user_set_frame(MovieClipUser *iuser, int framenr)
{
    /* TODO: clamp framenr here? */

    iuser->framenr= framenr;
}

static void free_buffers(MovieClip *clip)
{
    if(clip->cache) {
        IMB_moviecache_free(clip->cache->moviecache);

        if(clip->cache->postprocessed.ibuf)
            IMB_freeImBuf(clip->cache->postprocessed.ibuf);

        if(clip->cache->stabilized.ibuf)
            IMB_freeImBuf(clip->cache->stabilized.ibuf);

        MEM_freeN(clip->cache);
        clip->cache= NULL;
    }

    if(clip->anim) {
        IMB_free_anim(clip->anim);
        clip->anim= FALSE;
    }
}

void BKE_movieclip_reload(MovieClip *clip)
{
    /* clear cache */
    free_buffers(clip);

    clip->tracking.stabilization.ok= 0;

    /* update clip source */
    if(BLI_testextensie_array(clip->name, imb_ext_movie)) clip->source= MCLIP_SRC_MOVIE;
    else clip->source= MCLIP_SRC_SEQUENCE;
}

void BKE_movieclip_update_scopes(MovieClip *clip, MovieClipUser *user, MovieClipScopes *scopes)
{
    if(scopes->ok)
        return;

    if(scopes->track_preview) {
        IMB_freeImBuf(scopes->track_preview);
        scopes->track_preview= NULL;
    }

    scopes->marker= NULL;
    scopes->track= NULL;

    if(clip) {
        MovieTrackingTrack *act_track= BKE_tracking_active_track(&clip->tracking);

        if(act_track) {
            MovieTrackingTrack *track= act_track;
            MovieTrackingMarker *marker= BKE_tracking_get_marker(track, user->framenr);

            if(marker->flag&MARKER_DISABLED) {
                scopes->track_disabled= 1;
            } else {
                ImBuf *ibuf= BKE_movieclip_get_ibuf(clip, user);

                scopes->track_disabled= 0;

                if(ibuf && ibuf->rect) {
                    ImBuf *tmpibuf;
                    MovieTrackingMarker undist_marker= *marker;

                    if(user->render_flag&MCLIP_PROXY_RENDER_UNDISTORT) {
                        int width, height;
                        float aspy= 1.0f/clip->tracking.camera.pixel_aspect;;

                        BKE_movieclip_get_size(clip, user, &width, &height);

                        undist_marker.pos[0]*= width;
                        undist_marker.pos[1]*= height*aspy;

                        BKE_tracking_invert_intrinsics(&clip->tracking, undist_marker.pos, undist_marker.pos);

                        undist_marker.pos[0]/= width;
                        undist_marker.pos[1]/= height*aspy;
                    }

                    /* NOTE: margin should be kept in sync with value from ui_draw_but_TRACKPREVIEW */
                    tmpibuf= BKE_tracking_get_pattern_imbuf(ibuf, track, &undist_marker, 3 /* margin */,
                            1 /* anchor */, scopes->track_pos, NULL);

                    if(tmpibuf->rect_float)
                        IMB_rect_from_float(tmpibuf);

                    if(tmpibuf->rect)
                        scopes->track_preview= tmpibuf;
                    else
                        IMB_freeImBuf(tmpibuf);
                }

                IMB_freeImBuf(ibuf);
            }

            if((track->flag&TRACK_LOCKED)==0) {
                scopes->marker= marker;
                scopes->track= track;
                scopes->slide_scale[0]= track->pat_max[0]-track->pat_min[0];
                scopes->slide_scale[1]= track->pat_max[1]-track->pat_min[1];
            }
        }
    }

    scopes->framenr= user->framenr;
    scopes->ok= 1;
}

static void movieclip_build_proxy_ibuf(MovieClip *clip, ImBuf *ibuf, int cfra, int proxy_render_size, int undistorted)
{
    char name[FILE_MAX];
    int quality, rectx, recty;
    int size= size= rendersize_to_number(proxy_render_size);
    ImBuf *scaleibuf;

    get_proxy_fname(clip, proxy_render_size, undistorted, cfra, name);

    rectx= ibuf->x*size/100.0f;
    recty= ibuf->y*size/100.0f;

    scaleibuf= IMB_dupImBuf(ibuf);

    IMB_scaleImBuf(scaleibuf, (short)rectx, (short)recty);

    quality= clip->proxy.quality;
    scaleibuf->ftype= JPG | quality;

    /* unsupported feature only confuses other s/w */
    if(scaleibuf->planes==32)
        scaleibuf->planes= 24;

    BLI_lock_thread(LOCK_MOVIECLIP);

    BLI_make_existing_file(name);
    if(IMB_saveiff(scaleibuf, name, IB_rect)==0)
        perror(name);

    BLI_unlock_thread(LOCK_MOVIECLIP);

    IMB_freeImBuf(scaleibuf);
}

void BKE_movieclip_build_proxy_frame(MovieClip *clip, int clip_flag, struct MovieDistortion *distortion,
            int cfra, int *build_sizes, int build_count, int undistorted)
{
    ImBuf *ibuf;
    MovieClipUser user;

    user.framenr= cfra;
    user.render_flag= 0;
    user.render_size= MCLIP_PROXY_RENDER_SIZE_FULL;

    ibuf= BKE_movieclip_get_ibuf_flag(clip, &user, clip_flag);

    if(ibuf) {
        ImBuf *tmpibuf= ibuf;
        int i;

        if(undistorted)
            tmpibuf= get_undistorted_ibuf(clip, distortion, ibuf);

        for(i= 0; i<build_count; i++)
            movieclip_build_proxy_ibuf(clip, tmpibuf, cfra, build_sizes[i], undistorted);

        IMB_freeImBuf(ibuf);

        if(tmpibuf!=ibuf)
            IMB_freeImBuf(tmpibuf);
    }
}

void free_movieclip(MovieClip *clip)
{
    free_buffers(clip);

    BKE_tracking_free(&clip->tracking);
}

void unlink_movieclip(Main *bmain, MovieClip *clip)
{
    bScreen *scr;
    ScrArea *area;
    SpaceLink *sl;
    Scene *sce;
    Object *ob;

    for(scr= bmain->screen.first; scr; scr= scr->id.next) {
        for(area= scr->areabase.first; area; area= area->next) {
            for(sl= area->spacedata.first; sl; sl= sl->next) {
                if(sl->spacetype==SPACE_CLIP) {
                    SpaceClip *sc= (SpaceClip *) sl;

                    if(sc->clip==clip)
                        sc->clip= NULL;
                }
                else if(sl->spacetype==SPACE_VIEW3D) {
                    View3D *v3d= (View3D *) sl;
                    BGpic *bgpic;

                    for(bgpic= v3d->bgpicbase.first; bgpic; bgpic= bgpic->next) {
                        if(bgpic->clip==clip)
                            bgpic->clip= NULL;
                    }
                }
            }
        }
    }

    for(sce= bmain->scene.first; sce; sce= sce->id.next) {
        if(sce->clip==clip)
            sce->clip= NULL;
    }

    for(ob= bmain->object.first; ob; ob= ob->id.next) {
        bConstraint *con;

        for(con= ob->constraints.first; con; con= con->next) {
            bConstraintTypeInfo *cti= constraint_get_typeinfo(con);

            if(cti->type==CONSTRAINT_TYPE_FOLLOWTRACK) {
                bFollowTrackConstraint *data= (bFollowTrackConstraint *) con->data;

                if(data->clip==clip)
                    data->clip= NULL;
            }
            else if(cti->type==CONSTRAINT_TYPE_CAMERASOLVER) {
                bCameraSolverConstraint *data= (bCameraSolverConstraint *) con->data;

                if(data->clip==clip)
                    data->clip= NULL;
            }
        }
    }

    clip->id.us= 0;
}