keyframes_draw.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) 2009 Blender Foundation, Joshua Leung
 * All rights reserved.
 *
 * The Original Code is: all of this file.
 *
 * Contributor(s): Joshua Leung (full recode)
 *
 * ***** END GPL LICENSE BLOCK *****
 */

/* System includes ----------------------------------------------------- */

#include <math.h>
#include <stdlib.h>
#include <string.h>
#include <float.h>

#include "MEM_guardedalloc.h"

#include "BLI_blenlib.h"
#include "BLI_math.h"
#include "BLI_dlrbTree.h"
#include "BLI_utildefines.h"

#include "DNA_anim_types.h"
#include "DNA_armature_types.h"
#include "DNA_camera_types.h"
#include "DNA_object_types.h"
#include "DNA_scene_types.h"
#include "DNA_key_types.h"
#include "DNA_lamp_types.h"
#include "DNA_lattice_types.h"
#include "DNA_mesh_types.h"
#include "DNA_material_types.h"
#include "DNA_meta_types.h"
#include "DNA_node_types.h"
#include "DNA_particle_types.h"
#include "DNA_speaker_types.h"
#include "DNA_world_types.h"
#include "DNA_gpencil_types.h"

#include "BKE_key.h"
#include "BKE_material.h"
#include "BKE_global.h"     // XXX remove me!


#include "BIF_gl.h"

#include "UI_resources.h"
#include "UI_view2d.h"

#include "ED_anim_api.h"
#include "ED_keyframes_draw.h"

/* *************************** Keyframe Processing *************************** */

/* ActKeyColumns (Keyframe Columns) ------------------------------------------ */

/* Comparator callback used for ActKeyColumns and cframe float-value pointer */
/* NOTE: this is exported to other modules that use the ActKeyColumns for finding keyframes */
short compare_ak_cfraPtr (void *node, void *data)
{
    ActKeyColumn *ak= (ActKeyColumn *)node;
    float *cframe= data;
    
    if (*cframe < ak->cfra)
        return -1;
    else if (*cframe > ak->cfra)
        return 1;
    else
        return 0;
}

/* --------------- */

/* Comparator callback used for ActKeyColumns and BezTriple */
static short compare_ak_bezt (void *node, void *data)
{
    ActKeyColumn *ak= (ActKeyColumn *)node;
    BezTriple *bezt= (BezTriple *)data;
    
    if (bezt->vec[1][0] < ak->cfra)
        return -1;
    else if (bezt->vec[1][0] > ak->cfra)
        return 1;
    else
        return 0;
}

/* New node callback used for building ActKeyColumns from BezTriples */
static DLRBT_Node *nalloc_ak_bezt (void *data)
{
    ActKeyColumn *ak= MEM_callocN(sizeof(ActKeyColumn), "ActKeyColumn");
    BezTriple *bezt= (BezTriple *)data;
    
    /* store settings based on state of BezTriple */
    ak->cfra= bezt->vec[1][0];
    ak->sel= BEZSELECTED(bezt) ? SELECT : 0;
    ak->key_type= BEZKEYTYPE(bezt); 
    
    /* set 'modified', since this is used to identify long keyframes */
    ak->modified = 1;
    
    return (DLRBT_Node *)ak;
}

/* Node updater callback used for building ActKeyColumns from BezTriples */
static void nupdate_ak_bezt (void *node, void *data)
{
    ActKeyColumn *ak= (ActKeyColumn *)node;
    BezTriple *bezt= (BezTriple *)data;
    
    /* set selection status and 'touched' status */
    if (BEZSELECTED(bezt)) ak->sel = SELECT;
    ak->modified += 1;
    
    /* for keyframe type, 'proper' keyframes have priority over breakdowns (and other types for now) */
    if (BEZKEYTYPE(bezt) == BEZT_KEYTYPE_KEYFRAME)
        ak->key_type= BEZT_KEYTYPE_KEYFRAME;
}

/* ......... */

/* Comparator callback used for ActKeyColumns and GPencil frame */
static short compare_ak_gpframe (void *node, void *data)
{
    ActKeyColumn *ak= (ActKeyColumn *)node;
    bGPDframe *gpf= (bGPDframe *)data;
    
    if (gpf->framenum < ak->cfra)
        return -1;
    else if (gpf->framenum > ak->cfra)
        return 1;
    else
        return 0;
}

/* New node callback used for building ActKeyColumns from GPencil frames */
static DLRBT_Node *nalloc_ak_gpframe (void *data)
{
    ActKeyColumn *ak= MEM_callocN(sizeof(ActKeyColumn), "ActKeyColumnGPF");
    bGPDframe *gpf= (bGPDframe *)data;
    
    /* store settings based on state of BezTriple */
    ak->cfra= gpf->framenum;
    ak->sel= (gpf->flag & GP_FRAME_SELECT) ? SELECT : 0;
    
    /* set 'modified', since this is used to identify long keyframes */
    ak->modified = 1;
    
    return (DLRBT_Node *)ak;
}

/* Node updater callback used for building ActKeyColumns from GPencil frames */
static void nupdate_ak_gpframe (void *node, void *data)
{
    ActKeyColumn *ak= (ActKeyColumn *)node;
    bGPDframe *gpf= (bGPDframe *)data;
    
    /* set selection status and 'touched' status */
    if (gpf->flag & GP_FRAME_SELECT) ak->sel = SELECT;
    ak->modified += 1;
}

/* --------------- */

/* Add the given BezTriple to the given 'list' of Keyframes */
static void add_bezt_to_keycolumns_list(DLRBT_Tree *keys, BezTriple *bezt)
{
    if ELEM(NULL, keys, bezt) 
        return;
    else
        BLI_dlrbTree_add(keys, compare_ak_bezt, nalloc_ak_bezt, nupdate_ak_bezt, bezt);
}

/* Add the given GPencil Frame to the given 'list' of Keyframes */
static void add_gpframe_to_keycolumns_list(DLRBT_Tree *keys, bGPDframe *gpf)
{
    if ELEM(NULL, keys, gpf) 
        return;
    else
        BLI_dlrbTree_add(keys, compare_ak_gpframe, nalloc_ak_gpframe, nupdate_ak_gpframe, gpf);
}

/* ActBeztColumns (Helpers for Long Keyframes) ------------------------------ */

/* maximum size of default buffer for BezTriple columns */
#define MAX_ABK_BUFSIZE     4

/* BezTriple Container Node */
// NOTE: only used internally while building Long Keyframes for now, but may be useful externally?
typedef struct ActBeztColumn {
    /* Tree Node interface ---------------- */
        /* ListBase linkage */
    struct ActBeztColumn *next, *prev;
    
        /* sorting-tree linkage */
    struct ActBeztColumn *left, *right; /* 'children' of this node, less than and greater than it (respectively) */
    struct ActBeztColumn *parent;       /* parent of this node in the tree */
    char tree_col;                      /* DLRB_BLACK or DLRB_RED */
    char pad;
    
    /* BezTriple Store -------------------- */
    short numBezts;                     /* number of BezTriples on this frame */
    float cfra;                         /* frame that the BezTriples occur on */
    
    BezTriple *bezts[MAX_ABK_BUFSIZE];  /* buffer of pointers to BezTriples on the same frame */
    //BezTriple **bezts_extra;          /* secondary buffer of pointers if need be */
} ActBeztColumn;

/* --------------- */

/* Comparator callback used for ActBeztColumns and BezTriple */
static short compare_abk_bezt (void *node, void *data)
{
    ActBeztColumn *abk= (ActBeztColumn *)node;
    BezTriple *bezt= (BezTriple *)data;
    
    if (bezt->vec[1][0] < abk->cfra)
        return -1;
    else if (bezt->vec[1][0] > abk->cfra)
        return 1;
    else
        return 0;
}

/* New node callback used for building ActBeztColumns from BezTriples */
static DLRBT_Node *nalloc_abk_bezt (void *data)
{
    ActBeztColumn *abk= MEM_callocN(sizeof(ActBeztColumn), "ActKeyColumn");
    BezTriple *bezt= (BezTriple *)data;
    
    /* store the BeztTriple in the buffer, and keep track of its frame number */
    abk->cfra= bezt->vec[1][0];
    abk->bezts[abk->numBezts++]= bezt;
    
    return (DLRBT_Node *)abk;
}

/* Node updater callback used for building ActBeztColumns from BezTriples */
static void nupdate_abk_bezt (void *node, void *data)
{
    ActBeztColumn *abk= (ActBeztColumn *)node;
    BezTriple *bezt= (BezTriple *)data;
    
    /* just add the BezTriple to the buffer if there's space, or allocate a new one */
    if (abk->numBezts >= MAX_ABK_BUFSIZE) {
        // TODO: need to allocate new array to cater...
        //bezts_extra= MEM_callocN(...);
        if(G.f & G_DEBUG)
            printf("FIXME: nupdate_abk_bezt() missing case for too many overlapping BezTriples \n");
    }
    else {
        /* just store an extra one */
        abk->bezts[abk->numBezts++]= bezt;
    }
}

/* --------------- */

/* Return the BezTriple in the given ActBeztColumn that matches the requested value */
static BezTriple *abk_get_bezt_with_value (ActBeztColumn *abk, float value)
{
    BezTriple *bezt;
    int i;
    
    /* sanity checks */
    if (abk == NULL)
        return NULL;
    
    /* look over each BezTriple in this container */
    for (i = 0; i < abk->numBezts; i++) {       
        /* only do exact match for now... */
        if (/*i >= MAX_ABK_BUFSIZE*/0) {
            // TODO: this case needs special handling
        }
        else {
            /* just use the default buffer */
            bezt= abk->bezts[i];
            
            if (bezt->vec[1][1] == value)
                return bezt;
        }
    }
    
    return NULL;
}

/* ActKeyBlocks (Long Keyframes) ------------------------------------------ */

/* Comparator callback used for ActKeyBlock and cframe float-value pointer */
/* NOTE: this is exported to other modules that use the ActKeyBlocks for finding long-keyframes */
short compare_ab_cfraPtr (void *node, void *data)
{
    ActKeyBlock *ab= (ActKeyBlock *)node;
    float *cframe= data;
    
    if (*cframe < ab->start)
        return -1;
    else if (*cframe > ab->start)
        return 1;
    else
        return 0;
}

/* --------------- */

/* Create a ActKeyColumn for a pair of BezTriples */
static ActKeyBlock *bezts_to_new_actkeyblock(BezTriple *prev, BezTriple *beztn)
{
    ActKeyBlock *ab= MEM_callocN(sizeof(ActKeyBlock), "ActKeyBlock");
    
    ab->start= prev->vec[1][0];
    ab->end= beztn->vec[1][0];
    ab->val= beztn->vec[1][1];
    
    ab->sel= (BEZSELECTED(prev) || BEZSELECTED(beztn)) ? SELECT : 0;
    ab->modified = 1;
    
    return ab;
}

static void add_bezt_to_keyblocks_list(DLRBT_Tree *blocks, DLRBT_Tree *beztTree, BezTriple *beztn)
{
    ActKeyBlock *new_ab= NULL;
    ActBeztColumn *abk;
    BezTriple *prev;
    
    /* get the BezTriple immediately before the given one which has the same value */
        /* the keyframes immediately before the ones containing the specified keyframe */
    abk= (ActBeztColumn *)BLI_dlrbTree_search_prev(beztTree, compare_abk_bezt, beztn);
        /* if applicable, the BezTriple with the same value */
    prev= (abk) ? abk_get_bezt_with_value(abk, beztn->vec[1][1]) : NULL;
    
    /* check if block needed - same value(s)?
     *  -> firstly, handles must have same central value as each other
     *  -> secondly, handles which control that section of the curve must be constant
     */
    if ((!prev) || (!beztn)) return;
    if (IS_EQF(beztn->vec[1][1], prev->vec[1][1])==0) return;
    if (IS_EQF(beztn->vec[1][1], beztn->vec[0][1])==0) return;
    if (IS_EQF(prev->vec[1][1], prev->vec[2][1])==0) return;
    
    
    /* if there are no blocks already, just add as root */
    if (blocks->root == NULL) {
        /* just add this as the root, then call the tree-balancing functions to validate */
        new_ab= bezts_to_new_actkeyblock(prev, beztn);
        blocks->root= (DLRBT_Node *)new_ab;
    }
    else {
        ActKeyBlock *ab, *abn=NULL;
        
        /* try to find a keyblock that starts on the previous beztriple, and add a new one if none start there
         * Note: we can't search from end to try to optimise this as it causes errors there's
         *      an A ___ B |---| B situation
         */
        // FIXME: here there is a bug where we are trying to get the summary for the following channels
        //      A|--------------|A ______________ B|--------------|B
        //      A|------------------------------------------------|A
        //      A|----|A|---|A|-----------------------------------|A
        for (ab= blocks->root; ab; ab= abn) {
            /* check if this is a match, or whether we go left or right */
            if (ab->start == prev->vec[1][0]) {
                /* set selection status and 'touched' status */
                if (BEZSELECTED(beztn)) ab->sel = SELECT;
                ab->modified += 1;
                
                /* done... no need to insert */
                return;
            }
            else {
                ActKeyBlock **abnp= NULL; 
                
                /* check if go left or right, but if not available, add new node */
                if (ab->start < prev->vec[1][0]) 
                    abnp= &ab->right;
                else
                    abnp= &ab->left;
                    
                /* if this does not exist, add a new node, otherwise continue... */
                if (*abnp == NULL) {
                    /* add a new node representing this, and attach it to the relevant place */
                    new_ab= bezts_to_new_actkeyblock(prev, beztn);
                    new_ab->parent= ab;
                    *abnp= new_ab;
                    break;
                }
                else
                    abn= *abnp;
            }
        }
    }
    
    /* now, balance the tree taking into account this newly added node */
    BLI_dlrbTree_insert(blocks, (DLRBT_Node *)new_ab);
}

/* --------- */

/* Handle the 'touched' status of ActKeyColumn tree nodes */
static void set_touched_actkeycolumn (ActKeyColumn *ak)
{
    /* sanity check */
    if (ak == NULL)
        return;
        
    /* deal with self first */
    if (ak->modified) {
        ak->modified= 0;
        ak->totcurve++;
    }
    
    /* children */
    set_touched_actkeycolumn(ak->left);
    set_touched_actkeycolumn(ak->right);
}

/* Handle the 'touched' status of ActKeyBlock tree nodes */
static void set_touched_actkeyblock (ActKeyBlock *ab)
{
    /* sanity check */
    if (ab == NULL)
        return;
        
    /* deal with self first */
    if (ab->modified) {
        ab->modified= 0;
        ab->totcurve++;
    }
    
    /* children */
    set_touched_actkeyblock(ab->left);
    set_touched_actkeyblock(ab->right);
}

/* --------- */

/* Checks if ActKeyBlock should exist... */
short actkeyblock_is_valid (ActKeyBlock *ab, DLRBT_Tree *keys)
{
    ActKeyColumn *ak;
    short startCurves, endCurves, totCurves;
    
    /* check that block is valid */
    if (ab == NULL)
        return 0;
    
    /* find out how many curves occur at each keyframe */
    ak= (ActKeyColumn *)BLI_dlrbTree_search_exact(keys, compare_ak_cfraPtr, &ab->start);
    startCurves = (ak)? ak->totcurve: 0;
    
    ak= (ActKeyColumn *)BLI_dlrbTree_search_exact(keys, compare_ak_cfraPtr, &ab->end);
    endCurves = (ak)? ak->totcurve: 0;
    
    /* only draw keyblock if it appears in at all of the keyframes at lowest end */
    if (!startCurves && !endCurves) 
        return 0;
    
    totCurves = (startCurves>endCurves)? endCurves: startCurves;
    return (ab->totcurve >= totCurves);
}

/* *************************** Keyframe Drawing *************************** */

/* coordinates for diamond shape */
static const float _unit_diamond_shape[4][2] = {
    {0.0f, 1.0f},   /* top vert */
    {1.0f, 0.0f},   /* mid-right */
    {0.0f, -1.0f},  /* bottom vert */
    {-1.0f, 0.0f}   /* mid-left */
}; 

/* draw a simple diamond shape with OpenGL */
void draw_keyframe_shape (float x, float y, float xscale, float hsize, short sel, short key_type, short mode, float alpha)
{
    static GLuint displist1=0;
    static GLuint displist2=0;
    
    /* initialise 2 display lists for diamond shape - one empty, one filled */
    if (displist1 == 0) {
        displist1= glGenLists(1);
            glNewList(displist1, GL_COMPILE);
            
            glBegin(GL_LINE_LOOP);
                glVertex2fv(_unit_diamond_shape[0]);
                glVertex2fv(_unit_diamond_shape[1]);
                glVertex2fv(_unit_diamond_shape[2]);
                glVertex2fv(_unit_diamond_shape[3]);
            glEnd();
        glEndList();
    }
    if (displist2 == 0) {
        displist2= glGenLists(1);
            glNewList(displist2, GL_COMPILE);
            
            glBegin(GL_QUADS);
                glVertex2fv(_unit_diamond_shape[0]);
                glVertex2fv(_unit_diamond_shape[1]);
                glVertex2fv(_unit_diamond_shape[2]);
                glVertex2fv(_unit_diamond_shape[3]);
            glEnd();
        glEndList();
    }
    
    /* tweak size of keyframe shape according to type of keyframe 
     *  - 'proper' keyframes have key_type=0, so get drawn at full size
     */
    hsize -= 0.5f*key_type;
    
    /* adjust view transform before starting */
    glTranslatef(x, y, 0.0f);
    glScalef(1.0f/xscale*hsize, hsize, 1.0f);
    
    /* anti-aliased lines for more consistent appearance */
    glEnable(GL_LINE_SMOOTH);
    
    /* draw! */
    if ELEM(mode, KEYFRAME_SHAPE_INSIDE, KEYFRAME_SHAPE_BOTH) {
        /* interior - hardcoded colors (for selected and unselected only) */
        switch (key_type) {
            case BEZT_KEYTYPE_BREAKDOWN: /* bluish frames for now */
            {
                if (sel) glColor4f(0.33f, 0.75f, 0.93f, alpha);
                else glColor4f(0.70f, 0.86f, 0.91f, alpha);
            }
                break;
                
            case BEZT_KEYTYPE_EXTREME: /* redish frames for now */
            {
                if (sel) glColor4f(0.95f, 0.5f, 0.5f, alpha);
                else glColor4f(0.91f, 0.70f, 0.80f, alpha);
            }
                break;
                
            case BEZT_KEYTYPE_JITTER: /* greenish frames for now? */
            {
                if (sel) glColor4f(0.38f, 0.75f, 0.26f, alpha);
                else glColor4f(0.58f, 0.90f, 0.46f, alpha);
            }
                break;
                
            case BEZT_KEYTYPE_KEYFRAME: /* traditional yellowish frames for now */
            default:
            {
                if (sel) UI_ThemeColorShadeAlpha(TH_STRIP_SELECT, 50, -255*(1.0f-alpha));
                else glColor4f(0.91f, 0.91f, 0.91f, alpha);
            }
                break;
        }
        
        glCallList(displist2);
    }
    
    if ELEM(mode, KEYFRAME_SHAPE_FRAME, KEYFRAME_SHAPE_BOTH) {
        /* exterior - black frame */
        glColor4f(0.0f, 0.0f, 0.0f, alpha);
        
        glCallList(displist1);
    }
    
    glDisable(GL_LINE_SMOOTH);
    
    /* restore view transform */
    glScalef(xscale/hsize, 1.0f/hsize, 1.0);
    glTranslatef(-x, -y, 0.0f);
}

static void draw_keylist(View2D *v2d, DLRBT_Tree *keys, DLRBT_Tree *blocks, float ypos, short channelLocked)
{
    ActKeyColumn *ak;
    ActKeyBlock *ab;
    float xscale;
    
    glEnable(GL_BLEND);
    
    /* get View2D scaling factor */
    UI_view2d_getscale(v2d, &xscale, NULL);
    
    /* draw keyblocks */
    if (blocks) {
        for (ab= blocks->first; ab; ab= ab->next) {
            if (actkeyblock_is_valid(ab, keys)) {
                /* draw block */
                if (ab->sel)
                    UI_ThemeColor4(TH_STRIP_SELECT);
                else
                    UI_ThemeColor4(TH_STRIP);
                
                glRectf(ab->start, ypos-5, ab->end, ypos+5);
            }
        }
    }
    
    /* draw keys */
    if (keys) {
        /* locked channels are less strongly shown, as feedback for locked channels in DopeSheet */
        // TODO: allow this opacity factor to be themed?
        float kalpha = (channelLocked)? 0.35f : 1.0f;
        
        for (ak= keys->first; ak; ak= ak->next) {
            /* optimisation: if keyframe doesn't appear within 5 units (screenspace) in visible area, don't draw 
             *  - this might give some improvements, since we current have to flip between view/region matrices
             */
            if (IN_RANGE_INCL(ak->cfra, v2d->cur.xmin, v2d->cur.xmax) == 0)
                continue;
            
            /* draw using OpenGL - uglier but faster */
            // NOTE1: a previous version of this didn't work nice for some intel cards
            // NOTE2: if we wanted to go back to icons, these are  icon = (ak->sel & SELECT) ? ICON_SPACE2 : ICON_SPACE3;
            draw_keyframe_shape(ak->cfra, ypos, xscale, 5.0f, (ak->sel & SELECT), ak->key_type, KEYFRAME_SHAPE_BOTH, kalpha);
        }   
    }
    
    glDisable(GL_BLEND);
}

/* *************************** Channel Drawing Funcs *************************** */

void draw_summary_channel(View2D *v2d, bAnimContext *ac, float ypos)
{
    DLRBT_Tree keys, blocks;
    
    BLI_dlrbTree_init(&keys);
    BLI_dlrbTree_init(&blocks);
    
        summary_to_keylist(ac, &keys, &blocks);
    
    BLI_dlrbTree_linkedlist_sync(&keys);
    BLI_dlrbTree_linkedlist_sync(&blocks);
    
        draw_keylist(v2d, &keys, &blocks, ypos, 0);
    
    BLI_dlrbTree_free(&keys);
    BLI_dlrbTree_free(&blocks);
}

void draw_scene_channel(View2D *v2d, bDopeSheet *ads, Scene *sce, float ypos)
{
    DLRBT_Tree keys, blocks;
    
    BLI_dlrbTree_init(&keys);
    BLI_dlrbTree_init(&blocks);
    
        scene_to_keylist(ads, sce, &keys, &blocks);
    
    BLI_dlrbTree_linkedlist_sync(&keys);
    BLI_dlrbTree_linkedlist_sync(&blocks);
    
        draw_keylist(v2d, &keys, &blocks, ypos, 0);
    
    BLI_dlrbTree_free(&keys);
    BLI_dlrbTree_free(&blocks);
}

void draw_object_channel(View2D *v2d, bDopeSheet *ads, Object *ob, float ypos)
{
    DLRBT_Tree keys, blocks;
    
    BLI_dlrbTree_init(&keys);
    BLI_dlrbTree_init(&blocks);
    
        ob_to_keylist(ads, ob, &keys, &blocks);
    
    BLI_dlrbTree_linkedlist_sync(&keys);
    BLI_dlrbTree_linkedlist_sync(&blocks);
    
        draw_keylist(v2d, &keys, &blocks, ypos, 0);
    
    BLI_dlrbTree_free(&keys);
    BLI_dlrbTree_free(&blocks);
}

void draw_fcurve_channel(View2D *v2d, AnimData *adt, FCurve *fcu, float ypos)
{
    DLRBT_Tree keys, blocks;
    
    BLI_dlrbTree_init(&keys);
    BLI_dlrbTree_init(&blocks);
    
        fcurve_to_keylist(adt, fcu, &keys, &blocks);
    
    BLI_dlrbTree_linkedlist_sync(&keys);
    BLI_dlrbTree_linkedlist_sync(&blocks);
    
        draw_keylist(v2d, &keys, &blocks, ypos, (fcu->flag & FCURVE_PROTECTED));
    
    BLI_dlrbTree_free(&keys);
    BLI_dlrbTree_free(&blocks);
}

void draw_agroup_channel(View2D *v2d, AnimData *adt, bActionGroup *agrp, float ypos)
{
    DLRBT_Tree keys, blocks;
    
    BLI_dlrbTree_init(&keys);
    BLI_dlrbTree_init(&blocks);
    
        agroup_to_keylist(adt, agrp, &keys, &blocks);
    
    BLI_dlrbTree_linkedlist_sync(&keys);
    BLI_dlrbTree_linkedlist_sync(&blocks);
    
        draw_keylist(v2d, &keys, &blocks, ypos, (agrp->flag & AGRP_PROTECTED));
    
    BLI_dlrbTree_free(&keys);
    BLI_dlrbTree_free(&blocks);
}

void draw_action_channel(View2D *v2d, AnimData *adt, bAction *act, float ypos)
{
    DLRBT_Tree keys, blocks;
    
    BLI_dlrbTree_init(&keys);
    BLI_dlrbTree_init(&blocks);
    
        action_to_keylist(adt, act, &keys, &blocks);
    
    BLI_dlrbTree_linkedlist_sync(&keys);
    BLI_dlrbTree_linkedlist_sync(&blocks);
    
        draw_keylist(v2d, &keys, &blocks, ypos, 0);
    
    BLI_dlrbTree_free(&keys);
    BLI_dlrbTree_free(&blocks);
}

void draw_gpl_channel(View2D *v2d, bDopeSheet *ads, bGPDlayer *gpl, float ypos)
{
    DLRBT_Tree keys;
    
    BLI_dlrbTree_init(&keys);
    
        gpl_to_keylist(ads, gpl, &keys);
    
    BLI_dlrbTree_linkedlist_sync(&keys);
    
        draw_keylist(v2d, &keys, NULL, ypos, (gpl->flag & GP_LAYER_LOCKED));
    
    BLI_dlrbTree_free(&keys);
}

/* *************************** Keyframe List Conversions *************************** */

void summary_to_keylist(bAnimContext *ac, DLRBT_Tree *keys, DLRBT_Tree *blocks)
{
    if (ac) {
        ListBase anim_data = {NULL, NULL};
        bAnimListElem *ale;
        int filter;
        
        /* get F-Curves to take keyframes from */
        filter= ANIMFILTER_DATA_VISIBLE; // curves only
        ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
        
        /* loop through each F-Curve, grabbing the keyframes */
        for (ale= anim_data.first; ale; ale= ale->next)
            fcurve_to_keylist(ale->adt, ale->data, keys, blocks);
        
        BLI_freelistN(&anim_data);
    }
}

void scene_to_keylist(bDopeSheet *ads, Scene *sce, DLRBT_Tree *keys, DLRBT_Tree *blocks)
{
    bAnimContext ac = {NULL};
    ListBase anim_data = {NULL, NULL};
    bAnimListElem *ale;
    int filter;
    
    bAnimListElem dummychan = {0};
    
    if (sce == NULL)
        return;
    
    /* create a dummy wrapper data to work with */
    dummychan.type = ANIMTYPE_SCENE;
    dummychan.data = sce;
    dummychan.id = &sce->id;
    dummychan.adt = sce->adt;
    
    ac.ads = ads;
    ac.data = &dummychan;
    ac.datatype = ANIMCONT_CHANNEL;
    
    /* get F-Curves to take keyframes from */
    filter= ANIMFILTER_DATA_VISIBLE; // curves only
    ANIM_animdata_filter(&ac, &anim_data, filter, ac.data, ac.datatype);
    
    /* loop through each F-Curve, grabbing the keyframes */
    for (ale= anim_data.first; ale; ale= ale->next)
        fcurve_to_keylist(ale->adt, ale->data, keys, blocks);
    
    BLI_freelistN(&anim_data);
}

void ob_to_keylist(bDopeSheet *ads, Object *ob, DLRBT_Tree *keys, DLRBT_Tree *blocks)
{   
    bAnimContext ac = {NULL};
    ListBase anim_data = {NULL, NULL};
    bAnimListElem *ale;
    int filter;
    
    bAnimListElem dummychan = {0};
    Base dummybase = {0};
    
    if (ob == NULL)
        return;
    
    /* create a dummy wrapper data to work with */
    dummybase.object = ob;
    
    dummychan.type = ANIMTYPE_OBJECT;
    dummychan.data = &dummybase;
    dummychan.id = &ob->id;
    dummychan.adt = ob->adt;
    
    ac.ads = ads;
    ac.data = &dummychan;
    ac.datatype = ANIMCONT_CHANNEL;
    
    /* get F-Curves to take keyframes from */
    filter= ANIMFILTER_DATA_VISIBLE; // curves only
    ANIM_animdata_filter(&ac, &anim_data, filter, ac.data, ac.datatype);
    
    /* loop through each F-Curve, grabbing the keyframes */
    for (ale= anim_data.first; ale; ale= ale->next)
        fcurve_to_keylist(ale->adt, ale->data, keys, blocks);
    
    BLI_freelistN(&anim_data);
}

void fcurve_to_keylist(AnimData *adt, FCurve *fcu, DLRBT_Tree *keys, DLRBT_Tree *blocks)
{
    DLRBT_Tree *beztTree = NULL;
    BezTriple *bezt;
    unsigned int v;

    if (fcu && fcu->totvert && fcu->bezt) {
        /* apply NLA-mapping (if applicable) */
        if (adt)    
            ANIM_nla_mapping_apply_fcurve(adt, fcu, 0, 0);
        
        /* if getting long keyframes too, grab the BezTriples in a BST for 
         * accelerated searching...
         */
        if (blocks) {
            /* init new tree */
            beztTree= BLI_dlrbTree_new();
            
            /* populate tree with the BezTriples */
            for (v=0, bezt=fcu->bezt; v < fcu->totvert; v++, bezt++)
                BLI_dlrbTree_add(beztTree, compare_abk_bezt, nalloc_abk_bezt, nupdate_abk_bezt, bezt);
            
            /* make sure that it is suitable for linked-list searching too */
            BLI_dlrbTree_linkedlist_sync(beztTree);
        }
        
        /* loop through beztriples, making ActKeysColumns and ActKeyBlocks */
        for (v=0, bezt=fcu->bezt; v < fcu->totvert; v++, bezt++) {
            add_bezt_to_keycolumns_list(keys, bezt);
            if (blocks) add_bezt_to_keyblocks_list(blocks, beztTree, bezt);
        }
        
        /* update the number of curves that elements have appeared in  */
        if (keys)
            set_touched_actkeycolumn(keys->root);
        if (blocks)
            set_touched_actkeyblock(blocks->root);
            
        /* free temp data for building long keyframes */
        if (blocks && beztTree) {
            BLI_dlrbTree_free(beztTree);
            MEM_freeN(beztTree);
        }
        
        /* unapply NLA-mapping if applicable */
        if (adt)
            ANIM_nla_mapping_apply_fcurve(adt, fcu, 1, 0);
    }
}

void agroup_to_keylist(AnimData *adt, bActionGroup *agrp, DLRBT_Tree *keys, DLRBT_Tree *blocks)
{
    FCurve *fcu;

    if (agrp) {
        /* loop through F-Curves */
        for (fcu= agrp->channels.first; fcu && fcu->grp==agrp; fcu= fcu->next) {
            fcurve_to_keylist(adt, fcu, keys, blocks);
        }
    }
}

void action_to_keylist(AnimData *adt, bAction *act, DLRBT_Tree *keys, DLRBT_Tree *blocks)
{
    FCurve *fcu;

    if (act) {
        /* loop through F-Curves */
        for (fcu= act->curves.first; fcu; fcu= fcu->next) {
            fcurve_to_keylist(adt, fcu, keys, blocks);
        }
    }
}


void gpl_to_keylist(bDopeSheet *UNUSED(ads), bGPDlayer *gpl, DLRBT_Tree *keys)
{
    bGPDframe *gpf;
    
    if (gpl && keys) {
        /* although the frames should already be in an ordered list, they are not suitable for displaying yet */
        for (gpf= gpl->frames.first; gpf; gpf= gpf->next)
            add_gpframe_to_keycolumns_list(keys, gpf);
    }
}