action_select.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) 2008 Blender Foundation
 *
 * Contributor(s): Joshua Leung
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#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_gpencil_types.h"
#include "DNA_object_types.h"
#include "DNA_scene_types.h"

#include "RNA_access.h"
#include "RNA_define.h"

#include "BKE_fcurve.h"
#include "BKE_nla.h"
#include "BKE_context.h"

#include "UI_view2d.h"

#include "ED_anim_api.h"
#include "ED_gpencil.h"
#include "ED_keyframes_draw.h"
#include "ED_keyframes_edit.h"
#include "ED_markers.h"
#include "ED_screen.h"

#include "WM_api.h"
#include "WM_types.h"

#include "action_intern.h"


/* ************************************************************************** */
/* KEYFRAMES STUFF */

/* ******************** Deselect All Operator ***************************** */
/* This operator works in one of three ways:
 *  1) (de)select all (AKEY) - test if select all or deselect all
 *  2) invert all (CTRL-IKEY) - invert selection of all keyframes
 *  3) (de)select all - no testing is done; only for use internal tools as normal function...
 */

/* Deselects keyframes in the action editor
 *  - This is called by the deselect all operator, as well as other ones!
 *
 *  - test: check if select or deselect all
 *  - sel: how to select keyframes (SELECT_*)
 */
static void deselect_action_keys (bAnimContext *ac, short test, short sel)
{
    ListBase anim_data = {NULL, NULL};
    bAnimListElem *ale;
    int filter;
    
    KeyframeEditData ked= {{NULL}};
    KeyframeEditFunc test_cb, sel_cb;
    
    /* determine type-based settings */
    if (ac->datatype == ANIMCONT_GPENCIL)
        filter= (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_LIST_VISIBLE | ANIMFILTER_NODUPLIS);
    else
        filter= (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_LIST_VISIBLE /*| ANIMFILTER_CURVESONLY*/ | ANIMFILTER_NODUPLIS);
    
    /* filter data */
    ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
    
    /* init BezTriple looping data */
    test_cb= ANIM_editkeyframes_ok(BEZT_OK_SELECTED);
    
    /* See if we should be selecting or deselecting */
    if (test) {
        for (ale= anim_data.first; ale; ale= ale->next) {
            if (ale->type == ANIMTYPE_GPLAYER) {
                if (is_gplayer_frame_selected(ale->data)) {
                    sel= SELECT_SUBTRACT;
                    break;
                }
            }
            else {
                if (ANIM_fcurve_keyframes_loop(&ked, ale->key_data, NULL, test_cb, NULL)) {
                    sel= SELECT_SUBTRACT;
                    break;
                }
            }
        }
    }
    
    /* convert sel to selectmode, and use that to get editor */
    sel_cb= ANIM_editkeyframes_select(sel);
    
    /* Now set the flags */
    for (ale= anim_data.first; ale; ale= ale->next) {
        if (ale->type == ANIMTYPE_GPLAYER)
            set_gplayer_frame_selection(ale->data, sel);
        else
            ANIM_fcurve_keyframes_loop(&ked, ale->key_data, NULL, sel_cb, NULL); 
    }
    
    /* Cleanup */
    BLI_freelistN(&anim_data);
}

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

static int actkeys_deselectall_exec(bContext *C, wmOperator *op)
{
    bAnimContext ac;
    
    /* get editor data */
    if (ANIM_animdata_get_context(C, &ac) == 0)
        return OPERATOR_CANCELLED;
        
    /* 'standard' behaviour - check if selected, then apply relevant selection */
    if (RNA_boolean_get(op->ptr, "invert"))
        deselect_action_keys(&ac, 0, SELECT_INVERT);
    else
        deselect_action_keys(&ac, 1, SELECT_ADD);
    
    /* set notifier that keyframe selection have changed */
    WM_event_add_notifier(C, NC_ANIMATION|ND_KEYFRAME|NA_SELECTED, NULL);
    
    return OPERATOR_FINISHED;
}
 
void ACTION_OT_select_all_toggle (wmOperatorType *ot)
{
    /* identifiers */
    ot->name= "Select All";
    ot->idname= "ACTION_OT_select_all_toggle";
    ot->description= "Toggle selection of all keyframes";
    
    /* api callbacks */
    ot->exec= actkeys_deselectall_exec;
    ot->poll= ED_operator_action_active;
    
    /* flags */
    ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
    
    /* props */
    ot->prop= RNA_def_boolean(ot->srna, "invert", 0, "Invert", "");
}

/* ******************** Border Select Operator **************************** */
/* This operator currently works in one of three ways:
 *  -> BKEY     - 1) all keyframes within region are selected (ACTKEYS_BORDERSEL_ALLKEYS)
 *  -> ALT-BKEY - depending on which axis of the region was larger...
 *      -> 2) x-axis, so select all frames within frame range (ACTKEYS_BORDERSEL_FRAMERANGE)
 *      -> 3) y-axis, so select all frames within channels that region included (ACTKEYS_BORDERSEL_CHANNELS)
 */

/* defines for borderselect mode */
enum {
    ACTKEYS_BORDERSEL_ALLKEYS   = 0,
    ACTKEYS_BORDERSEL_FRAMERANGE,
    ACTKEYS_BORDERSEL_CHANNELS,
} /*eActKeys_BorderSelect_Mode*/;


static void borderselect_action (bAnimContext *ac, rcti rect, short mode, short selectmode)
{
    ListBase anim_data = {NULL, NULL};
    bAnimListElem *ale;
    int filter;
    
    KeyframeEditData ked;
    KeyframeEditFunc ok_cb, select_cb;
    View2D *v2d= &ac->ar->v2d;
    rctf rectf;
    float ymin=0, ymax=(float)(-ACHANNEL_HEIGHT_HALF);
    
    /* convert mouse coordinates to frame ranges and channel coordinates corrected for view pan/zoom */
    UI_view2d_region_to_view(v2d, rect.xmin, rect.ymin+2, &rectf.xmin, &rectf.ymin);
    UI_view2d_region_to_view(v2d, rect.xmax, rect.ymax-2, &rectf.xmax, &rectf.ymax);
    
    /* filter data */
    filter= (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_LIST_VISIBLE | ANIMFILTER_LIST_CHANNELS | ANIMFILTER_NODUPLIS);
    ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
    
    /* get beztriple editing/validation funcs  */
    select_cb= ANIM_editkeyframes_select(selectmode);
    
    if (ELEM(mode, ACTKEYS_BORDERSEL_FRAMERANGE, ACTKEYS_BORDERSEL_ALLKEYS))
        ok_cb= ANIM_editkeyframes_ok(BEZT_OK_FRAMERANGE);
    else
        ok_cb= NULL;
        
    /* init editing data */
    memset(&ked, 0, sizeof(KeyframeEditData));
    
    /* loop over data, doing border select */
    for (ale= anim_data.first; ale; ale= ale->next) {
        AnimData *adt= ANIM_nla_mapping_get(ac, ale);
        
        /* get new vertical minimum extent of channel */
        ymin= ymax - ACHANNEL_STEP;
        
        /* set horizontal range (if applicable) */
        if (ELEM(mode, ACTKEYS_BORDERSEL_FRAMERANGE, ACTKEYS_BORDERSEL_ALLKEYS)) {
            /* if channel is mapped in NLA, apply correction */
            if (adt) {
                ked.f1= BKE_nla_tweakedit_remap(adt, rectf.xmin, NLATIME_CONVERT_UNMAP);
                ked.f2= BKE_nla_tweakedit_remap(adt, rectf.xmax, NLATIME_CONVERT_UNMAP);
            }
            else {
                ked.f1= rectf.xmin;
                ked.f2= rectf.xmax;
            }
        }
        
        /* perform vertical suitability check (if applicable) */
        if ( (mode == ACTKEYS_BORDERSEL_FRAMERANGE) || 
            !((ymax < rectf.ymin) || (ymin > rectf.ymax)) )
        {
            /* loop over data selecting */
            if (ale->type == ANIMTYPE_GPLAYER)
                borderselect_gplayer_frames(ale->data, rectf.xmin, rectf.xmax, selectmode);
            else
                ANIM_animchannel_keyframes_loop(&ked, ac->ads, ale, ok_cb, select_cb, NULL);
        }
        
        /* set minimum extent to be the maximum of the next channel */
        ymax=ymin;
    }
    
    /* cleanup */
    BLI_freelistN(&anim_data);
}

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

static int actkeys_borderselect_exec(bContext *C, wmOperator *op)
{
    bAnimContext ac;
    rcti rect;
    short mode=0, selectmode=0;
    int gesture_mode, extend;
    
    /* get editor data */
    if (ANIM_animdata_get_context(C, &ac) == 0)
        return OPERATOR_CANCELLED;

    /* clear all selection if not extending selection */
    extend= RNA_boolean_get(op->ptr, "extend");
    if (!extend)
        deselect_action_keys(&ac, 1, SELECT_SUBTRACT);
    
    /* get settings from operator */
    rect.xmin= RNA_int_get(op->ptr, "xmin");
    rect.ymin= RNA_int_get(op->ptr, "ymin");
    rect.xmax= RNA_int_get(op->ptr, "xmax");
    rect.ymax= RNA_int_get(op->ptr, "ymax");
        
    gesture_mode= RNA_int_get(op->ptr, "gesture_mode");
    if (gesture_mode == GESTURE_MODAL_SELECT)
        selectmode = SELECT_ADD;
    else
        selectmode = SELECT_SUBTRACT;
    
    /* selection 'mode' depends on whether borderselect region only matters on one axis */
    if (RNA_boolean_get(op->ptr, "axis_range")) {
        /* mode depends on which axis of the range is larger to determine which axis to use 
         *  - checking this in region-space is fine, as it's fundamentally still going to be a different rect size
         *  - the frame-range select option is favoured over the channel one (x over y), as frame-range one is often
         *    used for tweaking timing when "blocking", while channels is not that useful...
         */
        if ((rect.xmax - rect.xmin) >= (rect.ymax - rect.ymin))
            mode= ACTKEYS_BORDERSEL_FRAMERANGE;
        else
            mode= ACTKEYS_BORDERSEL_CHANNELS;
    }
    else 
        mode= ACTKEYS_BORDERSEL_ALLKEYS;
    
    /* apply borderselect action */
    borderselect_action(&ac, rect, mode, selectmode);
    
    /* set notifier that keyframe selection have changed */
    WM_event_add_notifier(C, NC_ANIMATION|ND_KEYFRAME|NA_SELECTED, NULL);
    
    return OPERATOR_FINISHED;
} 

void ACTION_OT_select_border(wmOperatorType *ot)
{
    /* identifiers */
    ot->name= "Border Select";
    ot->idname= "ACTION_OT_select_border";
    ot->description= "Select all keyframes within the specified region";
    
    /* api callbacks */
    ot->invoke= WM_border_select_invoke;
    ot->exec= actkeys_borderselect_exec;
    ot->modal= WM_border_select_modal;
    ot->cancel= WM_border_select_cancel;
    
    ot->poll= ED_operator_action_active;
    
    /* flags */
    ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
    
    /* rna */
    WM_operator_properties_gesture_border(ot, TRUE);
    
    ot->prop= RNA_def_boolean(ot->srna, "axis_range", 0, "Axis Range", "");
}

/* ******************** Column Select Operator **************************** */
/* This operator works in one of four ways:
 *  - 1) select all keyframes in the same frame as a selected one  (KKEY)
 *  - 2) select all keyframes in the same frame as the current frame marker (CTRL-KKEY)
 *  - 3) select all keyframes in the same frame as a selected markers (SHIFT-KKEY)
 *  - 4) select all keyframes that occur between selected markers (ALT-KKEY)
 */

/* defines for column-select mode */
static EnumPropertyItem prop_column_select_types[] = {
    {ACTKEYS_COLUMNSEL_KEYS, "KEYS", 0, "On Selected Keyframes", ""},
    {ACTKEYS_COLUMNSEL_CFRA, "CFRA", 0, "On Current Frame", ""},
    {ACTKEYS_COLUMNSEL_MARKERS_COLUMN, "MARKERS_COLUMN", 0, "On Selected Markers", ""},
    {ACTKEYS_COLUMNSEL_MARKERS_BETWEEN, "MARKERS_BETWEEN", 0, "Between Min/Max Selected Markers", ""},
    {0, NULL, 0, NULL, NULL}
};

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

/* Selects all visible keyframes between the specified markers */
/* TODO, this is almost an _exact_ duplicate of a function of the same name in graph_select.c
 * should de-duplicate - campbell */
static void markers_selectkeys_between (bAnimContext *ac)
{
    ListBase anim_data = {NULL, NULL};
    bAnimListElem *ale;
    int filter;
    
    KeyframeEditFunc ok_cb, select_cb;
    KeyframeEditData ked= {{NULL}};
    float min, max;
    
    /* get extreme markers */
    ED_markers_get_minmax(ac->markers, 1, &min, &max);
    min -= 0.5f;
    max += 0.5f;
    
    /* get editing funcs + data */
    ok_cb= ANIM_editkeyframes_ok(BEZT_OK_FRAMERANGE);
    select_cb= ANIM_editkeyframes_select(SELECT_ADD);

    ked.f1= min; 
    ked.f2= max;
    
    /* filter data */
    filter= (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_LIST_VISIBLE /*| ANIMFILTER_CURVESONLY */ | ANIMFILTER_NODUPLIS);
    ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
    
    /* select keys in-between */
    for (ale= anim_data.first; ale; ale= ale->next) {
        AnimData *adt= ANIM_nla_mapping_get(ac, ale);
        
        if (adt) {
            ANIM_nla_mapping_apply_fcurve(adt, ale->key_data, 0, 1);
            ANIM_fcurve_keyframes_loop(&ked, ale->key_data, ok_cb, select_cb, NULL);
            ANIM_nla_mapping_apply_fcurve(adt, ale->key_data, 1, 1);
        }
        else if (ale->type == ANIMTYPE_GPLAYER) {
            borderselect_gplayer_frames(ale->data, min, max, SELECT_ADD);
        }
        else {
            ANIM_fcurve_keyframes_loop(&ked, ale->key_data, ok_cb, select_cb, NULL);
        }
    }
    
    /* Cleanup */
    BLI_freelistN(&anim_data);
}


/* Selects all visible keyframes in the same frames as the specified elements */
static void columnselect_action_keys (bAnimContext *ac, short mode)
{
    ListBase anim_data= {NULL, NULL};
    bAnimListElem *ale;
    int filter;
    
    Scene *scene= ac->scene;
    CfraElem *ce;
    KeyframeEditFunc select_cb, ok_cb;
    KeyframeEditData ked= {{NULL}};
    
    /* initialise keyframe editing data */
    
    /* build list of columns */
    switch (mode) {
        case ACTKEYS_COLUMNSEL_KEYS: /* list of selected keys */
            if (ac->datatype == ANIMCONT_GPENCIL) {
                filter= (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_LIST_VISIBLE);
                ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
                
                for (ale= anim_data.first; ale; ale= ale->next)
                    gplayer_make_cfra_list(ale->data, &ked.list, 1);
            }
            else {
                filter= (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_LIST_VISIBLE /*| ANIMFILTER_CURVESONLY*/);
                ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
                
                for (ale= anim_data.first; ale; ale= ale->next)
                    ANIM_fcurve_keyframes_loop(&ked, ale->key_data, NULL, bezt_to_cfraelem, NULL);
            }
            BLI_freelistN(&anim_data);
            break;
            
        case ACTKEYS_COLUMNSEL_CFRA: /* current frame */
            /* make a single CfraElem for storing this */
            ce= MEM_callocN(sizeof(CfraElem), "cfraElem");
            BLI_addtail(&ked.list, ce);
            
            ce->cfra= (float)CFRA;
            break;
            
        case ACTKEYS_COLUMNSEL_MARKERS_COLUMN: /* list of selected markers */
            ED_markers_make_cfra_list(ac->markers, &ked.list, SELECT);
            break;
            
        default: /* invalid option */
            return;
    }
    
    /* set up BezTriple edit callbacks */
    select_cb= ANIM_editkeyframes_select(SELECT_ADD);
    ok_cb= ANIM_editkeyframes_ok(BEZT_OK_FRAME);
    
    /* loop through all of the keys and select additional keyframes
     * based on the keys found to be selected above
     */
    if (ac->datatype == ANIMCONT_GPENCIL)
        filter= (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_LIST_VISIBLE);
    else
        filter= (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_LIST_VISIBLE /*| ANIMFILTER_CURVESONLY*/);
    ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
    
    for (ale= anim_data.first; ale; ale= ale->next) {
        AnimData *adt= ANIM_nla_mapping_get(ac, ale);
        
        /* loop over cfraelems (stored in the KeyframeEditData->list)
         *  - we need to do this here, as we can apply fewer NLA-mapping conversions
         */
        for (ce= ked.list.first; ce; ce= ce->next) {
            /* set frame for validation callback to refer to */
            if (adt)
                ked.f1= BKE_nla_tweakedit_remap(adt, ce->cfra, NLATIME_CONVERT_UNMAP);
            else
                ked.f1= ce->cfra;
            
            /* select elements with frame number matching cfraelem */
            if (ale->type == ANIMTYPE_GPLAYER)
                select_gpencil_frame(ale->data, ce->cfra, SELECT_ADD);
            else
                ANIM_fcurve_keyframes_loop(&ked, ale->key_data, ok_cb, select_cb, NULL);
        }
    }
    
    /* free elements */
    BLI_freelistN(&ked.list);
    BLI_freelistN(&anim_data);
}

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

static int actkeys_columnselect_exec(bContext *C, wmOperator *op)
{
    bAnimContext ac;
    short mode;
    
    /* get editor data */
    if (ANIM_animdata_get_context(C, &ac) == 0)
        return OPERATOR_CANCELLED;
        
    /* action to take depends on the mode */
    mode= RNA_enum_get(op->ptr, "mode");
    
    if (mode == ACTKEYS_COLUMNSEL_MARKERS_BETWEEN)
        markers_selectkeys_between(&ac);
    else
        columnselect_action_keys(&ac, mode);
    
    /* set notifier that keyframe selection have changed */
    WM_event_add_notifier(C, NC_ANIMATION|ND_KEYFRAME|NA_SELECTED, NULL);
    
    return OPERATOR_FINISHED;
}
 
void ACTION_OT_select_column (wmOperatorType *ot)
{
    /* identifiers */
    ot->name= "Select All";
    ot->idname= "ACTION_OT_select_column";
    ot->description= "Select all keyframes on the specified frame(s)";
    
    /* api callbacks */
    ot->exec= actkeys_columnselect_exec;
    ot->poll= ED_operator_action_active;
    
    /* flags */
    ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
    
    /* props */
    ot->prop= RNA_def_enum(ot->srna, "mode", prop_column_select_types, 0, "Mode", "");
}

/* ******************** Select Linked Operator *********************** */

static int actkeys_select_linked_exec (bContext *C, wmOperator *UNUSED(op))
{
    bAnimContext ac;
    
    ListBase anim_data= {NULL, NULL};
    bAnimListElem *ale;
    int filter;
    
    KeyframeEditFunc ok_cb = ANIM_editkeyframes_ok(BEZT_OK_SELECTED);
    KeyframeEditFunc sel_cb = ANIM_editkeyframes_select(SELECT_ADD);
    
    /* get editor data */
    if (ANIM_animdata_get_context(C, &ac) == 0)
        return OPERATOR_CANCELLED;
    
    /* loop through all of the keys and select additional keyframes based on these */
    filter= (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_LIST_VISIBLE /*| ANIMFILTER_CURVESONLY*/ | ANIMFILTER_NODUPLIS);
    ANIM_animdata_filter(&ac, &anim_data, filter, ac.data, ac.datatype);
    
    for (ale= anim_data.first; ale; ale= ale->next) {
        FCurve *fcu= (FCurve *)ale->key_data;
        
        /* check if anything selected? */
        if (ANIM_fcurve_keyframes_loop(NULL, fcu, NULL, ok_cb, NULL)) {
            /* select every keyframe in this curve then */
            ANIM_fcurve_keyframes_loop(NULL, fcu, NULL, sel_cb, NULL);
        }
    }
    
    /* Cleanup */
    BLI_freelistN(&anim_data);
    
    /* set notifier that keyframe selection has changed */
    WM_event_add_notifier(C, NC_ANIMATION|ND_KEYFRAME|NA_SELECTED, NULL);
    
    return OPERATOR_FINISHED;
}

void ACTION_OT_select_linked (wmOperatorType *ot)
{
    /* identifiers */
    ot->name = "Select Linked";
    ot->idname= "ACTION_OT_select_linked";
    ot->description = "Select keyframes occurring in the same F-Curves as selected ones";
    
    /* api callbacks */
    ot->exec= actkeys_select_linked_exec;
    ot->poll= ED_operator_action_active;
    
    /* flags */
    ot->flag= OPTYPE_REGISTER/*|OPTYPE_UNDO*/;
}

/* ******************** Select More/Less Operators *********************** */

/* Common code to perform selection */
static void select_moreless_action_keys (bAnimContext *ac, short mode)
{
    ListBase anim_data= {NULL, NULL};
    bAnimListElem *ale;
    int filter;
    
    KeyframeEditData ked= {{NULL}};
    KeyframeEditFunc build_cb;
    
    
    /* init selmap building data */
    build_cb= ANIM_editkeyframes_buildselmap(mode);
    
    /* loop through all of the keys and select additional keyframes based on these */
    filter= (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_LIST_VISIBLE /*| ANIMFILTER_CURVESONLY*/ | ANIMFILTER_NODUPLIS);
    ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
    
    for (ale= anim_data.first; ale; ale= ale->next) {
        FCurve *fcu= (FCurve *)ale->key_data;
        
        /* only continue if F-Curve has keyframes */
        if (fcu->bezt == NULL)
            continue;
        
        /* build up map of whether F-Curve's keyframes should be selected or not */
        ked.data= MEM_callocN(fcu->totvert, "selmap actEdit more");
        ANIM_fcurve_keyframes_loop(&ked, fcu, NULL, build_cb, NULL);
        
        /* based on this map, adjust the selection status of the keyframes */
        ANIM_fcurve_keyframes_loop(&ked, fcu, NULL, bezt_selmap_flush, NULL);
        
        /* free the selmap used here */
        MEM_freeN(ked.data);
        ked.data= NULL;
    }
    
    /* Cleanup */
    BLI_freelistN(&anim_data);
}

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

static int actkeys_select_more_exec (bContext *C, wmOperator *UNUSED(op))
{
    bAnimContext ac;
    
    /* get editor data */
    if (ANIM_animdata_get_context(C, &ac) == 0)
        return OPERATOR_CANCELLED;
    
    /* perform select changes */
    select_moreless_action_keys(&ac, SELMAP_MORE);
    
    /* set notifier that keyframe selection has changed */
    WM_event_add_notifier(C, NC_ANIMATION|ND_KEYFRAME|NA_SELECTED, NULL);
    
    return OPERATOR_FINISHED;
}

void ACTION_OT_select_more (wmOperatorType *ot)
{
    /* identifiers */
    ot->name = "Select More";
    ot->idname= "ACTION_OT_select_more";
    ot->description = "Select keyframes beside already selected ones";
    
    /* api callbacks */
    ot->exec= actkeys_select_more_exec;
    ot->poll= ED_operator_action_active;
    
    /* flags */
    ot->flag= OPTYPE_REGISTER/*|OPTYPE_UNDO*/;
}

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

static int actkeys_select_less_exec (bContext *C, wmOperator *UNUSED(op))
{
    bAnimContext ac;
    
    /* get editor data */
    if (ANIM_animdata_get_context(C, &ac) == 0)
        return OPERATOR_CANCELLED;
    
    /* perform select changes */
    select_moreless_action_keys(&ac, SELMAP_LESS);
    
    /* set notifier that keyframe selection has changed */
    WM_event_add_notifier(C, NC_ANIMATION|ND_KEYFRAME|NA_SELECTED, NULL);
    
    return OPERATOR_FINISHED;
}

void ACTION_OT_select_less (wmOperatorType *ot)
{
    /* identifiers */
    ot->name = "Select Less";
    ot->idname= "ACTION_OT_select_less";
    ot->description = "Deselect keyframes on ends of selection islands";
    
    /* api callbacks */
    ot->exec= actkeys_select_less_exec;
    ot->poll= ED_operator_action_active;
    
    /* flags */
    ot->flag= OPTYPE_REGISTER/*|OPTYPE_UNDO*/;
}

/* ******************** Select Left/Right Operator ************************* */
/* Select keyframes left/right of the current frame indicator */

/* defines for left-right select tool */
static EnumPropertyItem prop_actkeys_leftright_select_types[] = {
    {ACTKEYS_LRSEL_TEST, "CHECK", 0, "Check if Select Left or Right", ""},
    {ACTKEYS_LRSEL_LEFT, "LEFT", 0, "Before current frame", ""},
    {ACTKEYS_LRSEL_RIGHT, "RIGHT", 0, "After current frame", ""},
    {0, NULL, 0, NULL, NULL}
};

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

static void actkeys_select_leftright (bAnimContext *ac, short leftright, short select_mode)
{
    ListBase anim_data = {NULL, NULL};
    bAnimListElem *ale;
    int filter;
    
    KeyframeEditFunc ok_cb, select_cb;
    KeyframeEditData ked= {{NULL}};
    Scene *scene= ac->scene;
    
    /* if select mode is replace, deselect all keyframes (and channels) first */
    if (select_mode==SELECT_REPLACE) {
        select_mode= SELECT_ADD;
        
        /* - deselect all other keyframes, so that just the newly selected remain
         * - channels aren't deselected, since we don't re-select any as a consequence
         */
        deselect_action_keys(ac, 0, SELECT_SUBTRACT);
    }
    
    /* set callbacks and editing data */
    ok_cb= ANIM_editkeyframes_ok(BEZT_OK_FRAMERANGE);
    select_cb= ANIM_editkeyframes_select(select_mode);
    
    if (leftright == ACTKEYS_LRSEL_LEFT) {
        ked.f1 = MINAFRAMEF;
        ked.f2 = (float)(CFRA + 0.1f);
    } 
    else {
        ked.f1 = (float)(CFRA - 0.1f);
        ked.f2 = MAXFRAMEF;
    }
    
    /* filter data */
    if (ac->datatype == ANIMCONT_GPENCIL)
        filter= (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_LIST_VISIBLE | ANIMFILTER_NODUPLIS);
    else
        filter= (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_LIST_VISIBLE /*| ANIMFILTER_CURVESONLY*/ | ANIMFILTER_NODUPLIS);
    ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
        
    /* select keys */
    for (ale= anim_data.first; ale; ale= ale->next) {
        AnimData *adt= ANIM_nla_mapping_get(ac, ale);
        
        if (adt) {
            ANIM_nla_mapping_apply_fcurve(adt, ale->key_data, 0, 1);
            ANIM_fcurve_keyframes_loop(&ked, ale->key_data, ok_cb, select_cb, NULL);
            ANIM_nla_mapping_apply_fcurve(adt, ale->key_data, 1, 1);
        }
        else if (ale->type == ANIMTYPE_GPLAYER) 
            borderselect_gplayer_frames(ale->data, ked.f1, ked.f2, select_mode);
        else
            ANIM_fcurve_keyframes_loop(&ked, ale->key_data, ok_cb, select_cb, NULL);
    }
    
    /* Sync marker support */
    if (select_mode==SELECT_ADD) {
        SpaceAction *saction= (SpaceAction *)ac->sl;
        
        if ((saction) && (saction->flag & SACTION_MARKERS_MOVE)) {
            ListBase *markers = ED_animcontext_get_markers(ac);
            TimeMarker *marker;
            
            for (marker= markers->first; marker; marker= marker->next) {
                if( ((leftright == ACTKEYS_LRSEL_LEFT) && (marker->frame < CFRA)) ||
                    ((leftright == ACTKEYS_LRSEL_RIGHT) && (marker->frame >= CFRA)) ) 
                {
                    marker->flag |= SELECT;
                }
                else {
                    marker->flag &= ~SELECT;
                }
            }
        }
    }

    /* Cleanup */
    BLI_freelistN(&anim_data);
}

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

static int actkeys_select_leftright_exec (bContext *C, wmOperator *op)
{
    bAnimContext ac;
    short leftright = RNA_enum_get(op->ptr, "mode");
    short selectmode;
    
    /* get editor data */
    if (ANIM_animdata_get_context(C, &ac) == 0)
        return OPERATOR_CANCELLED;
    
    /* select mode is either replace (deselect all, then add) or add/extend */
    if (RNA_boolean_get(op->ptr, "extend"))
        selectmode= SELECT_INVERT;
    else
        selectmode= SELECT_REPLACE;
        
    /* if "test" mode is set, we don't have any info to set this with */
    if (leftright == ACTKEYS_LRSEL_TEST)
        return OPERATOR_CANCELLED;
    
    /* do the selecting now */
    actkeys_select_leftright(&ac, leftright, selectmode);
    
    /* set notifier that keyframe selection (and channels too) have changed */
    WM_event_add_notifier(C, NC_ANIMATION|ND_KEYFRAME|ND_ANIMCHAN|NA_SELECTED, NULL);
    
    return OPERATOR_FINISHED;
}

static int actkeys_select_leftright_invoke (bContext *C, wmOperator *op, wmEvent *event)
{
    bAnimContext ac;
    short leftright = RNA_enum_get(op->ptr, "mode");
    
    /* get editor data */
    if (ANIM_animdata_get_context(C, &ac) == 0)
        return OPERATOR_CANCELLED;
        
    /* handle mode-based testing */
    if (leftright == ACTKEYS_LRSEL_TEST) {
        Scene *scene= ac.scene;
        ARegion *ar= ac.ar;
        View2D *v2d= &ar->v2d;
        float x;

        /* determine which side of the current frame mouse is on */
        UI_view2d_region_to_view(v2d, event->mval[0], event->mval[1], &x, NULL);
        if (x < CFRA)
            RNA_enum_set(op->ptr, "mode", ACTKEYS_LRSEL_LEFT);
        else    
            RNA_enum_set(op->ptr, "mode", ACTKEYS_LRSEL_RIGHT);
    }
    
    /* perform selection */
    return actkeys_select_leftright_exec(C, op);
}

void ACTION_OT_select_leftright (wmOperatorType *ot)
{
    /* identifiers */
    ot->name= "Select Left/Right";
    ot->idname= "ACTION_OT_select_leftright";
    ot->description= "Select keyframes to the left or the right of the current frame";
    
    /* api callbacks  */
    ot->invoke= actkeys_select_leftright_invoke;
    ot->exec= actkeys_select_leftright_exec;
    ot->poll= ED_operator_action_active;
    
    /* flags */
    ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
    
    /* id-props */
    ot->prop= RNA_def_enum(ot->srna, "mode", prop_actkeys_leftright_select_types, ACTKEYS_LRSEL_TEST, "Mode", "");
    RNA_def_boolean(ot->srna, "extend", 0, "Extend Select", "");
}

/* ******************** Mouse-Click Select Operator *********************** */
/* This operator works in one of three ways:
 *  - 1) keyframe under mouse - no special modifiers
 *  - 2) all keyframes on the same side of current frame indicator as mouse - ALT modifier
 *  - 3) column select all keyframes in frame under mouse - CTRL modifier
 *
 * In addition to these basic options, the SHIFT modifier can be used to toggle the 
 * selection mode between replacing the selection (without) and inverting the selection (with).
 */

/* sensitivity factor for frame-selections */
#define FRAME_CLICK_THRESH      0.1f

/* ------------------- */
 
/* option 1) select keyframe directly under mouse */
static void actkeys_mselect_single (bAnimContext *ac, bAnimListElem *ale, short select_mode, float selx)
{
    KeyframeEditData ked= {{NULL}};
    KeyframeEditFunc select_cb, ok_cb;
    
    /* get functions for selecting keyframes */
    select_cb= ANIM_editkeyframes_select(select_mode);
    ok_cb= ANIM_editkeyframes_ok(BEZT_OK_FRAME);
    ked.f1= selx;
    
    /* select the nominated keyframe on the given frame */
    if (ale->type == ANIMTYPE_GPLAYER)
        select_gpencil_frame(ale->data, selx, select_mode);
    else
        ANIM_animchannel_keyframes_loop(&ked, ac->ads, ale, ok_cb, select_cb, NULL);
}

/* Option 2) Selects all the keyframes on either side of the current frame (depends on which side the mouse is on) */
/* (see actkeys_select_leftright) */

/* Option 3) Selects all visible keyframes in the same frame as the mouse click */
static void actkeys_mselect_column(bAnimContext *ac, short select_mode, float selx)
{
    ListBase anim_data= {NULL, NULL};
    bAnimListElem *ale;
    int filter;
    
    KeyframeEditFunc select_cb, ok_cb;
    KeyframeEditData ked= {{NULL}};
    
    /* set up BezTriple edit callbacks */
    select_cb= ANIM_editkeyframes_select(select_mode);
    ok_cb= ANIM_editkeyframes_ok(BEZT_OK_FRAME);
    
    /* loop through all of the keys and select additional keyframes
     * based on the keys found to be selected above
     */
    if (ac->datatype == ANIMCONT_GPENCIL)
        filter= (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_LIST_VISIBLE /*| ANIMFILTER_CURVESONLY */ | ANIMFILTER_NODUPLIS);
    else
        filter= (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_LIST_VISIBLE | ANIMFILTER_NODUPLIS);
    ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
    
    for (ale= anim_data.first; ale; ale= ale->next) {
        AnimData *adt= ANIM_nla_mapping_get(ac, ale);
        
        /* set frame for validation callback to refer to */
        if (adt)
            ked.f1= BKE_nla_tweakedit_remap(adt, selx, NLATIME_CONVERT_UNMAP);
        else
            ked.f1= selx;
        
        /* select elements with frame number matching cfra */
        if (ale->type == ANIMTYPE_GPLAYER)
            select_gpencil_frame(ale->key_data, selx, select_mode);
        else 
            ANIM_fcurve_keyframes_loop(&ked, ale->key_data, ok_cb, select_cb, NULL);
    }
    
    /* free elements */
    BLI_freelistN(&ked.list);
    BLI_freelistN(&anim_data);
}
 
/* ------------------- */

static void mouse_action_keys (bAnimContext *ac, const int mval[2], short select_mode, short column)
{
    ListBase anim_data = {NULL, NULL};
    DLRBT_Tree anim_keys;
    bAnimListElem *ale;
    int filter;
    
    View2D *v2d= &ac->ar->v2d;
    bDopeSheet *ads = NULL;
    int channel_index;
    short found = 0;
    float selx = 0.0f;
    float x, y;
    rctf rectf;
    
    /* get dopesheet info */
    if (ac->datatype == ANIMCONT_DOPESHEET)
        ads= ac->data;
    
    /* use View2D to determine the index of the channel (i.e a row in the list) where keyframe was */
    UI_view2d_region_to_view(v2d, mval[0], mval[1], &x, &y);
    UI_view2d_listview_view_to_cell(v2d, 0, ACHANNEL_STEP, 0, (float)ACHANNEL_HEIGHT_HALF, x, y, NULL, &channel_index);
    
    /* x-range to check is +/- 7 (in screen/region-space) on either side of mouse click (size of keyframe icon) */
    UI_view2d_region_to_view(v2d, mval[0]-7, mval[1], &rectf.xmin, &rectf.ymin);
    UI_view2d_region_to_view(v2d, mval[0]+7, mval[1], &rectf.xmax, &rectf.ymax);
    
    /* filter data */
    filter= (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_LIST_VISIBLE | ANIMFILTER_LIST_CHANNELS);
    ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
    
    /* try to get channel */
    ale= BLI_findlink(&anim_data, channel_index);
    if (ale == NULL) {
        /* channel not found */
        printf("Error: animation channel (index = %d) not found in mouse_action_keys() \n", channel_index);
        BLI_freelistN(&anim_data);
        return;
    }
    else {
        /* found match - must return here... */
        AnimData *adt= ANIM_nla_mapping_get(ac, ale);
        ActKeyColumn *ak, *akn=NULL;
        
        /* make list of keyframes */
        BLI_dlrbTree_init(&anim_keys);
        
        if (ale->key_data) {
            switch (ale->datatype) {
                case ALE_SCE:
                {
                    Scene *scene= (Scene *)ale->key_data;
                    scene_to_keylist(ads, scene, &anim_keys, NULL);
                }
                    break;
                case ALE_OB:
                {
                    Object *ob= (Object *)ale->key_data;
                    ob_to_keylist(ads, ob, &anim_keys, NULL);
                }
                    break;
                case ALE_ACT:
                {
                    bAction *act= (bAction *)ale->key_data;
                    action_to_keylist(adt, act, &anim_keys, NULL);
                }
                    break;
                case ALE_FCURVE:
                {
                    FCurve *fcu= (FCurve *)ale->key_data;
                    fcurve_to_keylist(adt, fcu, &anim_keys, NULL);
                }
                    break;
            }
        }
        else if (ale->type == ANIMTYPE_SUMMARY) {
            /* dopesheet summary covers everything */
            summary_to_keylist(ac, &anim_keys, NULL);
        }
        else if (ale->type == ANIMTYPE_GROUP) { 
            // TODO: why don't we just give groups key_data too?
            bActionGroup *agrp= (bActionGroup *)ale->data;
            agroup_to_keylist(adt, agrp, &anim_keys, NULL);
        }
        else if (ale->type == ANIMTYPE_GPLAYER) {
            // TODO: why don't we just give gplayers key_data too?
            bGPDlayer *gpl = (bGPDlayer *)ale->data;
            gpl_to_keylist(ads, gpl, &anim_keys);
        }
        
        /* start from keyframe at root of BST, traversing until we find one within the range that was clicked on */
        for (ak= anim_keys.root; ak; ak= akn) {
            if (IN_RANGE(ak->cfra, rectf.xmin, rectf.xmax)) {
                /* set the frame to use, and apply inverse-correction for NLA-mapping 
                 * so that the frame will get selected by the selection functions without
                 * requiring to map each frame once again...
                 */
                selx= BKE_nla_tweakedit_remap(adt, ak->cfra, NLATIME_CONVERT_UNMAP);
                found= 1;
                break;
            }
            else if (ak->cfra < rectf.xmin)
                akn= ak->right;
            else
                akn= ak->left;
        }
        
        /* remove active channel from list of channels for separate treatment (since it's needed later on) */
        BLI_remlink(&anim_data, ale);
        
        /* cleanup temporary lists */
        BLI_dlrbTree_free(&anim_keys);
        
        /* free list of channels, since it's not used anymore */
        BLI_freelistN(&anim_data);
    }
    
    /* for replacing selection, firstly need to clear existing selection */
    if (select_mode == SELECT_REPLACE) {
        /* reset selection mode for next steps */
        select_mode = SELECT_ADD;
        
        /* deselect all keyframes */
        deselect_action_keys(ac, 0, SELECT_SUBTRACT);
        
        /* highlight channel clicked on */
        if (ELEM(ac->datatype, ANIMCONT_ACTION, ANIMCONT_DOPESHEET)) {
            /* deselect all other channels first */
            ANIM_deselect_anim_channels(ac, ac->data, ac->datatype, 0, ACHANNEL_SETFLAG_CLEAR);
            
            /* Highlight Action-Group or F-Curve? */
            if (ale && ale->data) {
                if (ale->type == ANIMTYPE_GROUP) {
                    bActionGroup *agrp= ale->data;
                    
                    agrp->flag |= AGRP_SELECTED;
                    ANIM_set_active_channel(ac, ac->data, ac->datatype, filter, agrp, ANIMTYPE_GROUP);
                }   
                else if (ale->type == ANIMTYPE_FCURVE) {
                    FCurve *fcu= ale->data;
                    
                    fcu->flag |= FCURVE_SELECTED;
                    ANIM_set_active_channel(ac, ac->data, ac->datatype, filter, fcu, ANIMTYPE_FCURVE);
                }
            }
        }
        else if (ac->datatype == ANIMCONT_GPENCIL) {
            /* deselect all other channels first */
            ANIM_deselect_anim_channels(ac, ac->data, ac->datatype, 0, ACHANNEL_SETFLAG_CLEAR);
            
            /* Highlight GPencil Layer */
            if ((ale && ale->data) && (ale->type == ANIMTYPE_GPLAYER)) {
                bGPDlayer *gpl = ale->data;
                
                gpl->flag |= GP_LAYER_SELECT;
                //gpencil_layer_setactive(gpd, gpl);
            }
        }
    }
    
    /* only select keyframes if we clicked on a valid channel and hit something */
    if (ale) {
        if (found) {
            /* apply selection to keyframes */
            if (column) {
                /* select all keyframes in the same frame as the one we hit on the active channel */
                actkeys_mselect_column(ac, select_mode, selx);
            }
            else {
                /* select the nominated keyframe on the given frame */
                actkeys_mselect_single(ac, ale, select_mode, selx);
            }
        }
        
        /* free this channel */
        MEM_freeN(ale);
    }
}

/* handle clicking */
static int actkeys_clickselect_invoke(bContext *C, wmOperator *op, wmEvent *event)
{
    bAnimContext ac;
    /* ARegion *ar; */ /* UNUSED */
    short selectmode, column;
    
    /* get editor data */
    if (ANIM_animdata_get_context(C, &ac) == 0)
        return OPERATOR_CANCELLED;
        
    /* get useful pointers from animation context data */
    /* ar= ac.ar; */ /* UNUSED */

    /* select mode is either replace (deselect all, then add) or add/extend */
    if (RNA_boolean_get(op->ptr, "extend"))
        selectmode= SELECT_INVERT;
    else
        selectmode= SELECT_REPLACE;
        
    /* column selection */
    column= RNA_boolean_get(op->ptr, "column");
    
    /* select keyframe(s) based upon mouse position*/
    mouse_action_keys(&ac, event->mval, selectmode, column);
    
    /* set notifier that keyframe selection (and channels too) have changed */
    WM_event_add_notifier(C, NC_ANIMATION|ND_KEYFRAME|ND_ANIMCHAN|NA_SELECTED, NULL);
    
    /* for tweak grab to work */
    return OPERATOR_FINISHED|OPERATOR_PASS_THROUGH;
}
 
void ACTION_OT_clickselect (wmOperatorType *ot)
{
    /* identifiers */
    ot->name= "Mouse Select Keys";
    ot->idname= "ACTION_OT_clickselect";
    ot->description= "Select keyframes by clicking on them";
    
    /* api callbacks - absolutely no exec() this yet... */
    ot->invoke= actkeys_clickselect_invoke;
    ot->poll= ED_operator_action_active;
    
    /* flags */
    ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
    
    /* id-props */
    RNA_def_boolean(ot->srna, "extend", 0, "Extend Select", ""); // SHIFTKEY
    RNA_def_boolean(ot->srna, "column", 0, "Column Select", ""); // ALTKEY
}

/* ************************************************************************** */