40b193f501e5d2c8a49515d7c4842e4c63d35821
[blender.git] / source / blender / editors / animation / keyframing.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2009 Blender Foundation, Joshua Leung
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup edanimation
22  */
23
24 #include <stdio.h>
25 #include <stddef.h>
26 #include <string.h>
27 #include <math.h>
28 #include <float.h>
29
30 #include "MEM_guardedalloc.h"
31
32 #include "BLI_blenlib.h"
33 #include "BLI_math.h"
34 #include "BLI_utildefines.h"
35
36 #include "BLT_translation.h"
37
38 #include "DNA_anim_types.h"
39 #include "DNA_armature_types.h"
40 #include "DNA_constraint_types.h"
41 #include "DNA_key_types.h"
42 #include "DNA_material_types.h"
43 #include "DNA_scene_types.h"
44 #include "DNA_object_types.h"
45 #include "DNA_rigidbody_types.h"
46
47 #include "BKE_action.h"
48 #include "BKE_animsys.h"
49 #include "BKE_armature.h"
50 #include "BKE_context.h"
51 #include "BKE_fcurve.h"
52 #include "BKE_global.h"
53 #include "BKE_idcode.h"
54 #include "BKE_key.h"
55 #include "BKE_main.h"
56 #include "BKE_material.h"
57 #include "BKE_nla.h"
58 #include "BKE_report.h"
59
60 #include "DEG_depsgraph.h"
61 #include "DEG_depsgraph_build.h"
62 #include "DEG_depsgraph_query.h"
63
64 #include "ED_anim_api.h"
65 #include "ED_keyframing.h"
66 #include "ED_keyframes_edit.h"
67 #include "ED_screen.h"
68 #include "ED_object.h"
69
70 #include "UI_interface.h"
71 #include "UI_resources.h"
72
73 #include "WM_api.h"
74 #include "WM_types.h"
75
76 #include "RNA_access.h"
77 #include "RNA_define.h"
78 #include "RNA_enum_types.h"
79
80 #include "anim_intern.h"
81
82 static KeyingSet *keyingset_get_from_op_with_error(wmOperator *op,
83                                                    PropertyRNA *prop,
84                                                    Scene *scene);
85
86 /* ************************************************** */
87 /* Keyframing Setting Wrangling */
88
89 /* Get the active settings for keyframing settings from context (specifically the given scene) */
90 short ANIM_get_keyframing_flags(Scene *scene, short incl_mode)
91 {
92   eInsertKeyFlags flag = INSERTKEY_NOFLAGS;
93
94   /* standard flags */
95   {
96     /* visual keying */
97     if (IS_AUTOKEY_FLAG(scene, AUTOMATKEY)) {
98       flag |= INSERTKEY_MATRIX;
99     }
100
101     /* only needed */
102     if (IS_AUTOKEY_FLAG(scene, INSERTNEEDED)) {
103       flag |= INSERTKEY_NEEDED;
104     }
105
106     /* default F-Curve color mode - RGB from XYZ indices */
107     if (IS_AUTOKEY_FLAG(scene, XYZ2RGB)) {
108       flag |= INSERTKEY_XYZ2RGB;
109     }
110   }
111
112   /* only if including settings from the autokeying mode... */
113   if (incl_mode) {
114     /* keyframing mode - only replace existing keyframes */
115     if (IS_AUTOKEY_MODE(scene, EDITKEYS)) {
116       flag |= INSERTKEY_REPLACE;
117     }
118
119     /* cycle-aware keyframe insertion - preserve cycle period and flow */
120     if (IS_AUTOKEY_FLAG(scene, CYCLEAWARE)) {
121       flag |= INSERTKEY_CYCLE_AWARE;
122     }
123   }
124
125   return flag;
126 }
127
128 /* ******************************************* */
129 /* Animation Data Validation */
130
131 /* Get (or add relevant data to be able to do so) the Active Action for the given
132  * Animation Data block, given an ID block where the Animation Data should reside.
133  */
134 bAction *verify_adt_action(Main *bmain, ID *id, short add)
135 {
136   AnimData *adt;
137
138   /* init animdata if none available yet */
139   adt = BKE_animdata_from_id(id);
140   if ((adt == NULL) && (add)) {
141     adt = BKE_animdata_add_id(id);
142   }
143   if (adt == NULL) {
144     /* if still none (as not allowed to add, or ID doesn't have animdata for some reason) */
145     printf("ERROR: Couldn't add AnimData (ID = %s)\n", (id) ? (id->name) : "<None>");
146     return NULL;
147   }
148
149   /* init action if none available yet */
150   /* TODO: need some wizardry to handle NLA stuff correct */
151   if ((adt->action == NULL) && (add)) {
152     /* init action name from name of ID block */
153     char actname[sizeof(id->name) - 2];
154     BLI_snprintf(actname, sizeof(actname), "%sAction", id->name + 2);
155
156     /* create action */
157     adt->action = BKE_action_add(bmain, actname);
158
159     /* set ID-type from ID-block that this is going to be assigned to
160      * so that users can't accidentally break actions by assigning them
161      * to the wrong places
162      */
163     adt->action->idroot = GS(id->name);
164
165     /* Tag depsgraph to be rebuilt to include time dependency. */
166     DEG_relations_tag_update(bmain);
167   }
168
169   DEG_id_tag_update(&adt->action->id, ID_RECALC_ANIMATION_NO_FLUSH);
170
171   /* return the action */
172   return adt->action;
173 }
174
175 /* Get (or add relevant data to be able to do so) F-Curve from the Active Action,
176  * for the given Animation Data block. This assumes that all the destinations are valid.
177  */
178 FCurve *verify_fcurve(Main *bmain,
179                       bAction *act,
180                       const char group[],
181                       PointerRNA *ptr,
182                       const char rna_path[],
183                       const int array_index,
184                       short add)
185 {
186   bActionGroup *agrp;
187   FCurve *fcu;
188
189   /* sanity checks */
190   if (ELEM(NULL, act, rna_path)) {
191     return NULL;
192   }
193
194   /* try to find f-curve matching for this setting
195    * - add if not found and allowed to add one
196    *   TODO: add auto-grouping support? how this works will need to be resolved
197    */
198   fcu = list_find_fcurve(&act->curves, rna_path, array_index);
199
200   if ((fcu == NULL) && (add)) {
201     /* use default settings to make a F-Curve */
202     fcu = MEM_callocN(sizeof(FCurve), "FCurve");
203
204     fcu->flag = (FCURVE_VISIBLE | FCURVE_SELECTED);
205     fcu->auto_smoothing = FCURVE_SMOOTH_CONT_ACCEL;
206     if (BLI_listbase_is_empty(&act->curves)) {
207       fcu->flag |= FCURVE_ACTIVE; /* first one added active */
208     }
209
210     /* store path - make copy, and store that */
211     fcu->rna_path = BLI_strdup(rna_path);
212     fcu->array_index = array_index;
213
214     /* if a group name has been provided, try to add or find a group, then add F-Curve to it */
215     if (group) {
216       /* try to find group */
217       agrp = BKE_action_group_find_name(act, group);
218
219       /* no matching groups, so add one */
220       if (agrp == NULL) {
221         agrp = action_groups_add_new(act, group);
222
223         /* sync bone group colors if applicable */
224         if (ptr && (ptr->type == &RNA_PoseBone)) {
225           Object *ob = (Object *)ptr->id.data;
226           bPoseChannel *pchan = (bPoseChannel *)ptr->data;
227           bPose *pose = ob->pose;
228           bActionGroup *grp;
229
230           /* find bone group (if present), and use the color from that */
231           grp = (bActionGroup *)BLI_findlink(&pose->agroups, (pchan->agrp_index - 1));
232           if (grp) {
233             agrp->customCol = grp->customCol;
234             action_group_colors_sync(agrp, grp);
235           }
236         }
237       }
238
239       /* add F-Curve to group */
240       action_groups_add_channel(act, agrp, fcu);
241     }
242     else {
243       /* just add F-Curve to end of Action's list */
244       BLI_addtail(&act->curves, fcu);
245     }
246
247     /* New f-curve was added, meaning it's possible that it affects
248      * dependency graph component which wasn't previously animated.
249      */
250     DEG_relations_tag_update(bmain);
251   }
252
253   /* return the F-Curve */
254   return fcu;
255 }
256
257 /* Helper for update_autoflags_fcurve() */
258 static void update_autoflags_fcurve_direct(FCurve *fcu, PropertyRNA *prop)
259 {
260   /* set additional flags for the F-Curve (i.e. only integer values) */
261   fcu->flag &= ~(FCURVE_INT_VALUES | FCURVE_DISCRETE_VALUES);
262   switch (RNA_property_type(prop)) {
263     case PROP_FLOAT:
264       /* do nothing */
265       break;
266     case PROP_INT:
267       /* do integer (only 'whole' numbers) interpolation between all points */
268       fcu->flag |= FCURVE_INT_VALUES;
269       break;
270     default:
271       /* do 'discrete' (i.e. enum, boolean values which cannot take any intermediate
272        * values at all) interpolation between all points
273        *    - however, we must also ensure that evaluated values are only integers still
274        */
275       fcu->flag |= (FCURVE_DISCRETE_VALUES | FCURVE_INT_VALUES);
276       break;
277   }
278 }
279
280 /* Update integer/discrete flags of the FCurve (used when creating/inserting keyframes,
281  * but also through RNA when editing an ID prop, see T37103).
282  */
283 void update_autoflags_fcurve(FCurve *fcu, bContext *C, ReportList *reports, PointerRNA *ptr)
284 {
285   PointerRNA tmp_ptr;
286   PropertyRNA *prop;
287   int old_flag = fcu->flag;
288
289   if ((ptr->id.data == NULL) && (ptr->data == NULL)) {
290     BKE_report(reports, RPT_ERROR, "No RNA pointer available to retrieve values for this fcurve");
291     return;
292   }
293
294   /* try to get property we should be affecting */
295   if (RNA_path_resolve_property(ptr, fcu->rna_path, &tmp_ptr, &prop) == false) {
296     /* property not found... */
297     const char *idname = (ptr->id.data) ? ((ID *)ptr->id.data)->name : TIP_("<No ID pointer>");
298
299     BKE_reportf(reports,
300                 RPT_ERROR,
301                 "Could not update flags for this fcurve, as RNA path is invalid for the given ID "
302                 "(ID = %s, path = %s)",
303                 idname,
304                 fcu->rna_path);
305     return;
306   }
307
308   /* update F-Curve flags */
309   update_autoflags_fcurve_direct(fcu, prop);
310
311   if (old_flag != fcu->flag) {
312     /* Same as if keyframes had been changed */
313     WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
314   }
315 }
316
317 /* ************************************************** */
318 /* KEYFRAME INSERTION */
319
320 /* Move the point where a key is about to be inserted to be inside the main cycle range.
321  * Returns the type of the cycle if it is enabled and valid.
322  */
323 static eFCU_Cycle_Type remap_cyclic_keyframe_location(FCurve *fcu, float *px, float *py)
324 {
325   if (fcu->totvert < 2 || !fcu->bezt) {
326     return FCU_CYCLE_NONE;
327   }
328
329   eFCU_Cycle_Type type = BKE_fcurve_get_cycle_type(fcu);
330
331   if (type == FCU_CYCLE_NONE) {
332     return FCU_CYCLE_NONE;
333   }
334
335   BezTriple *first = &fcu->bezt[0], *last = &fcu->bezt[fcu->totvert - 1];
336   float start = first->vec[1][0], end = last->vec[1][0];
337
338   if (start >= end) {
339     return FCU_CYCLE_NONE;
340   }
341
342   if (*px < start || *px > end) {
343     float period = end - start;
344     float step = floorf((*px - start) / period);
345     *px -= step * period;
346
347     if (type == FCU_CYCLE_OFFSET) {
348       /* Nasty check to handle the case when the modes are different better. */
349       FMod_Cycles *data = ((FModifier *)fcu->modifiers.first)->data;
350       short mode = (step >= 0) ? data->after_mode : data->before_mode;
351
352       if (mode == FCM_EXTRAPOLATE_CYCLIC_OFFSET) {
353         *py -= step * (last->vec[1][1] - first->vec[1][1]);
354       }
355     }
356   }
357
358   return type;
359 }
360
361 /* -------------- BezTriple Insertion -------------------- */
362
363 /* Change the Y position of a keyframe to match the input, adjusting handles. */
364 static void replace_bezt_keyframe_ypos(BezTriple *dst, const BezTriple *bezt)
365 {
366   /* just change the values when replacing, so as to not overwrite handles */
367   float dy = bezt->vec[1][1] - dst->vec[1][1];
368
369   /* just apply delta value change to the handle values */
370   dst->vec[0][1] += dy;
371   dst->vec[1][1] += dy;
372   dst->vec[2][1] += dy;
373
374   dst->f1 = bezt->f1;
375   dst->f2 = bezt->f2;
376   dst->f3 = bezt->f3;
377
378   /* TODO: perform some other operations? */
379 }
380
381 /* This function adds a given BezTriple to an F-Curve. It will allocate
382  * memory for the array if needed, and will insert the BezTriple into a
383  * suitable place in chronological order.
384  *
385  * NOTE: any recalculate of the F-Curve that needs to be done will need to
386  *      be done by the caller.
387  */
388 int insert_bezt_fcurve(FCurve *fcu, const BezTriple *bezt, eInsertKeyFlags flag)
389 {
390   int i = 0;
391
392   /* are there already keyframes? */
393   if (fcu->bezt) {
394     bool replace;
395     i = binarysearch_bezt_index(fcu->bezt, bezt->vec[1][0], fcu->totvert, &replace);
396
397     /* replace an existing keyframe? */
398     if (replace) {
399       /* sanity check: 'i' may in rare cases exceed arraylen */
400       if ((i >= 0) && (i < fcu->totvert)) {
401         if (flag & INSERTKEY_OVERWRITE_FULL) {
402           fcu->bezt[i] = *bezt;
403         }
404         else {
405           replace_bezt_keyframe_ypos(&fcu->bezt[i], bezt);
406         }
407
408         if (flag & INSERTKEY_CYCLE_AWARE) {
409           /* If replacing an end point of a cyclic curve without offset,
410            * modify the other end too. */
411           if ((i == 0 || i == fcu->totvert - 1) &&
412               BKE_fcurve_get_cycle_type(fcu) == FCU_CYCLE_PERFECT) {
413             replace_bezt_keyframe_ypos(&fcu->bezt[i == 0 ? fcu->totvert - 1 : 0], bezt);
414           }
415         }
416       }
417     }
418     /* keyframing modes allow to not replace keyframe */
419     else if ((flag & INSERTKEY_REPLACE) == 0) {
420       /* insert new - if we're not restricted to replacing keyframes only */
421       BezTriple *newb = MEM_callocN((fcu->totvert + 1) * sizeof(BezTriple), "beztriple");
422
423       /* Add the beztriples that should occur before the beztriple to be pasted
424        * (originally in fcu). */
425       if (i > 0) {
426         memcpy(newb, fcu->bezt, i * sizeof(BezTriple));
427       }
428
429       /* add beztriple to paste at index i */
430       *(newb + i) = *bezt;
431
432       /* add the beztriples that occur after the beztriple to be pasted (originally in fcu) */
433       if (i < fcu->totvert) {
434         memcpy(newb + i + 1, fcu->bezt + i, (fcu->totvert - i) * sizeof(BezTriple));
435       }
436
437       /* replace (+ free) old with new, only if necessary to do so */
438       MEM_freeN(fcu->bezt);
439       fcu->bezt = newb;
440
441       fcu->totvert++;
442     }
443     else {
444       return -1;
445     }
446   }
447   /* no keyframes already, but can only add if...
448    * 1) keyframing modes say that keyframes can only be replaced, so adding new ones won't know
449    * 2) there are no samples on the curve
450    *    // NOTE: maybe we may want to allow this later when doing samples -> bezt conversions,
451    *    // but for now, having both is asking for trouble
452    */
453   else if ((flag & INSERTKEY_REPLACE) == 0 && (fcu->fpt == NULL)) {
454     /* create new keyframes array */
455     fcu->bezt = MEM_callocN(sizeof(BezTriple), "beztriple");
456     *(fcu->bezt) = *bezt;
457     fcu->totvert = 1;
458   }
459   /* cannot add anything */
460   else {
461     /* return error code -1 to prevent any misunderstandings */
462     return -1;
463   }
464
465   /* we need to return the index, so that some tools which do post-processing can
466    * detect where we added the BezTriple in the array
467    */
468   return i;
469 }
470
471 /**
472  * This function is a wrapper for #insert_bezt_fcurve(), and should be used when
473  * adding a new keyframe to a curve, when the keyframe doesn't exist anywhere else yet.
474  * It returns the index at which the keyframe was added.
475  *
476  * \param keyframe_type: The type of keyframe (#eBezTriple_KeyframeType).
477  * \param flag: Optional flags (eInsertKeyFlags) for controlling how keys get added
478  * and/or whether updates get done.
479  */
480 int insert_vert_fcurve(
481     FCurve *fcu, float x, float y, eBezTriple_KeyframeType keyframe_type, eInsertKeyFlags flag)
482 {
483   BezTriple beztr = {{{0}}};
484   unsigned int oldTot = fcu->totvert;
485   int a;
486
487   /* set all three points, for nicer start position
488    * NOTE: +/- 1 on vec.x for left and right handles is so that 'free' handles work ok...
489    */
490   beztr.vec[0][0] = x - 1.0f;
491   beztr.vec[0][1] = y;
492   beztr.vec[1][0] = x;
493   beztr.vec[1][1] = y;
494   beztr.vec[2][0] = x + 1.0f;
495   beztr.vec[2][1] = y;
496   beztr.f1 = beztr.f2 = beztr.f3 = SELECT;
497
498   /* set default handle types and interpolation mode */
499   if (flag & INSERTKEY_NO_USERPREF) {
500     /* for Py-API, we want scripts to have predictable behavior,
501      * hence the option to not depend on the userpref defaults
502      */
503     beztr.h1 = beztr.h2 = HD_AUTO_ANIM;
504     beztr.ipo = BEZT_IPO_BEZ;
505   }
506   else {
507     /* for UI usage - defaults should come from the userprefs and/or toolsettings */
508     beztr.h1 = beztr.h2 = U.keyhandles_new; /* use default handle type here */
509
510     /* use default interpolation mode, with exceptions for int/discrete values */
511     beztr.ipo = U.ipo_new;
512   }
513
514   /* interpolation type used is constrained by the type of values the curve can take */
515   if (fcu->flag & FCURVE_DISCRETE_VALUES) {
516     beztr.ipo = BEZT_IPO_CONST;
517   }
518   else if ((beztr.ipo == BEZT_IPO_BEZ) && (fcu->flag & FCURVE_INT_VALUES)) {
519     beztr.ipo = BEZT_IPO_LIN;
520   }
521
522   /* set keyframe type value (supplied), which should come from the scene settings in most cases */
523   BEZKEYTYPE(&beztr) = keyframe_type;
524
525   /* set default values for "easing" interpolation mode settings
526    * NOTE: Even if these modes aren't currently used, if users switch
527    *       to these later, we want these to work in a sane way out of
528    *       the box.
529    */
530
531   /* "back" easing - this value used to be used when overshoot=0, but that
532    *                 introduced discontinuities in how the param worked. */
533   beztr.back = 1.70158f;
534
535   /* "elastic" easing - values here were hand-optimized for a default duration of
536    *                    ~10 frames (typical mograph motion length) */
537   beztr.amplitude = 0.8f;
538   beztr.period = 4.1f;
539
540   /* add temp beztriple to keyframes */
541   a = insert_bezt_fcurve(fcu, &beztr, flag);
542
543   /* what if 'a' is a negative index?
544    * for now, just exit to prevent any segfaults
545    */
546   if (a < 0) {
547     return -1;
548   }
549
550   /* don't recalculate handles if fast is set
551    * - this is a hack to make importers faster
552    * - we may calculate twice (due to autohandle needing to be calculated twice)
553    */
554   if ((flag & INSERTKEY_FAST) == 0) {
555     calchandles_fcurve(fcu);
556   }
557
558   /* set handletype and interpolation */
559   if ((fcu->totvert > 2) && (flag & INSERTKEY_REPLACE) == 0) {
560     BezTriple *bezt = (fcu->bezt + a);
561
562     /* Set interpolation from previous (if available),
563      * but only if we didn't just replace some keyframe:
564      * - Replacement is indicated by no-change in number of verts.
565      * - When replacing, the user may have specified some interpolation that should be kept.
566      */
567     if (fcu->totvert > oldTot) {
568       if (a > 0) {
569         bezt->ipo = (bezt - 1)->ipo;
570       }
571       else if (a < fcu->totvert - 1) {
572         bezt->ipo = (bezt + 1)->ipo;
573       }
574     }
575
576     /* don't recalculate handles if fast is set
577      * - this is a hack to make importers faster
578      * - we may calculate twice (due to autohandle needing to be calculated twice)
579      */
580     if ((flag & INSERTKEY_FAST) == 0) {
581       calchandles_fcurve(fcu);
582     }
583   }
584
585   /* return the index at which the keyframe was added */
586   return a;
587 }
588
589 /* -------------- 'Smarter' Keyframing Functions -------------------- */
590 /* return codes for new_key_needed */
591 enum {
592   KEYNEEDED_DONTADD = 0,
593   KEYNEEDED_JUSTADD,
594   KEYNEEDED_DELPREV,
595   KEYNEEDED_DELNEXT,
596 } /*eKeyNeededStatus*/;
597
598 /* This helper function determines whether a new keyframe is needed */
599 /* Cases where keyframes should not be added:
600  * 1. Keyframe to be added between two keyframes with similar values
601  * 2. Keyframe to be added on frame where two keyframes are already situated
602  * 3. Keyframe lies at point that intersects the linear line between two keyframes
603  */
604 static short new_key_needed(FCurve *fcu, float cFrame, float nValue)
605 {
606   BezTriple *bezt = NULL, *prev = NULL;
607   int totCount, i;
608   float valA = 0.0f, valB = 0.0f;
609
610   /* safety checking */
611   if (fcu == NULL) {
612     return KEYNEEDED_JUSTADD;
613   }
614   totCount = fcu->totvert;
615   if (totCount == 0) {
616     return KEYNEEDED_JUSTADD;
617   }
618
619   /* loop through checking if any are the same */
620   bezt = fcu->bezt;
621   for (i = 0; i < totCount; i++) {
622     float prevPosi = 0.0f, prevVal = 0.0f;
623     float beztPosi = 0.0f, beztVal = 0.0f;
624
625     /* get current time+value */
626     beztPosi = bezt->vec[1][0];
627     beztVal = bezt->vec[1][1];
628
629     if (prev) {
630       /* there is a keyframe before the one currently being examined */
631
632       /* get previous time+value */
633       prevPosi = prev->vec[1][0];
634       prevVal = prev->vec[1][1];
635
636       /* keyframe to be added at point where there are already two similar points? */
637       if (IS_EQF(prevPosi, cFrame) && IS_EQF(beztPosi, cFrame) && IS_EQF(beztPosi, prevPosi)) {
638         return KEYNEEDED_DONTADD;
639       }
640
641       /* keyframe between prev+current points ? */
642       if ((prevPosi <= cFrame) && (cFrame <= beztPosi)) {
643         /* is the value of keyframe to be added the same as keyframes on either side ? */
644         if (IS_EQF(prevVal, nValue) && IS_EQF(beztVal, nValue) && IS_EQF(prevVal, beztVal)) {
645           return KEYNEEDED_DONTADD;
646         }
647         else {
648           float realVal;
649
650           /* get real value of curve at that point */
651           realVal = evaluate_fcurve(fcu, cFrame);
652
653           /* compare whether it's the same as proposed */
654           if (IS_EQF(realVal, nValue)) {
655             return KEYNEEDED_DONTADD;
656           }
657           else {
658             return KEYNEEDED_JUSTADD;
659           }
660         }
661       }
662
663       /* new keyframe before prev beztriple? */
664       if (cFrame < prevPosi) {
665         /* A new keyframe will be added. However, whether the previous beztriple
666          * stays around or not depends on whether the values of previous/current
667          * beztriples and new keyframe are the same.
668          */
669         if (IS_EQF(prevVal, nValue) && IS_EQF(beztVal, nValue) && IS_EQF(prevVal, beztVal)) {
670           return KEYNEEDED_DELNEXT;
671         }
672         else {
673           return KEYNEEDED_JUSTADD;
674         }
675       }
676     }
677     else {
678       /* just add a keyframe if there's only one keyframe
679        * and the new one occurs before the existing one does.
680        */
681       if ((cFrame < beztPosi) && (totCount == 1)) {
682         return KEYNEEDED_JUSTADD;
683       }
684     }
685
686     /* continue. frame to do not yet passed (or other conditions not met) */
687     if (i < (totCount - 1)) {
688       prev = bezt;
689       bezt++;
690     }
691     else {
692       break;
693     }
694   }
695
696   /* Frame in which to add a new-keyframe occurs after all other keys
697    * -> If there are at least two existing keyframes, then if the values of the
698    *    last two keyframes and the new-keyframe match, the last existing keyframe
699    *    gets deleted as it is no longer required.
700    * -> Otherwise, a keyframe is just added. 1.0 is added so that fake-2nd-to-last
701    *    keyframe is not equal to last keyframe.
702    */
703   bezt = (fcu->bezt + (fcu->totvert - 1));
704   valA = bezt->vec[1][1];
705
706   if (prev) {
707     valB = prev->vec[1][1];
708   }
709   else {
710     valB = bezt->vec[1][1] + 1.0f;
711   }
712
713   if (IS_EQF(valA, nValue) && IS_EQF(valA, valB)) {
714     return KEYNEEDED_DELPREV;
715   }
716   else {
717     return KEYNEEDED_JUSTADD;
718   }
719 }
720
721 /* ------------------ RNA Data-Access Functions ------------------ */
722
723 /* Try to read value using RNA-properties obtained already */
724 static float *setting_get_rna_values(
725     PointerRNA *ptr, PropertyRNA *prop, float *buffer, int buffer_size, int *r_count)
726 {
727   BLI_assert(buffer_size >= 1);
728
729   float *values = buffer;
730
731   if (RNA_property_array_check(prop)) {
732     int length = *r_count = RNA_property_array_length(ptr, prop);
733     bool *tmp_bool;
734     int *tmp_int;
735
736     if (length > buffer_size) {
737       values = MEM_malloc_arrayN(sizeof(float), length, __func__);
738     }
739
740     switch (RNA_property_type(prop)) {
741       case PROP_BOOLEAN:
742         tmp_bool = MEM_malloc_arrayN(sizeof(*tmp_bool), length, __func__);
743         RNA_property_boolean_get_array(ptr, prop, tmp_bool);
744         for (int i = 0; i < length; i++) {
745           values[i] = (float)tmp_bool[i];
746         }
747         MEM_freeN(tmp_bool);
748         break;
749       case PROP_INT:
750         tmp_int = MEM_malloc_arrayN(sizeof(*tmp_int), length, __func__);
751         RNA_property_int_get_array(ptr, prop, tmp_int);
752         for (int i = 0; i < length; i++) {
753           values[i] = (float)tmp_int[i];
754         }
755         MEM_freeN(tmp_int);
756         break;
757       case PROP_FLOAT:
758         RNA_property_float_get_array(ptr, prop, values);
759         break;
760       default:
761         memset(values, 0, sizeof(float) * length);
762     }
763   }
764   else {
765     *r_count = 1;
766
767     switch (RNA_property_type(prop)) {
768       case PROP_BOOLEAN:
769         *values = (float)RNA_property_boolean_get(ptr, prop);
770         break;
771       case PROP_INT:
772         *values = (float)RNA_property_int_get(ptr, prop);
773         break;
774       case PROP_FLOAT:
775         *values = RNA_property_float_get(ptr, prop);
776         break;
777       case PROP_ENUM:
778         *values = (float)RNA_property_enum_get(ptr, prop);
779         break;
780       default:
781         *values = 0.0f;
782     }
783   }
784
785   return values;
786 }
787
788 /* ------------------ 'Visual' Keyframing Functions ------------------ */
789
790 /* internal status codes for visualkey_can_use */
791 enum {
792   VISUALKEY_NONE = 0,
793   VISUALKEY_LOC,
794   VISUALKEY_ROT,
795   VISUALKEY_SCA,
796 };
797
798 /* This helper function determines if visual-keyframing should be used when
799  * inserting keyframes for the given channel. As visual-keyframing only works
800  * on Object and Pose-Channel blocks, this should only get called for those
801  * blocktypes, when using "standard" keying but 'Visual Keying' option in Auto-Keying
802  * settings is on.
803  */
804 static bool visualkey_can_use(PointerRNA *ptr, PropertyRNA *prop)
805 {
806   bConstraint *con = NULL;
807   short searchtype = VISUALKEY_NONE;
808   bool has_rigidbody = false;
809   bool has_parent = false;
810   const char *identifier = NULL;
811
812   /* validate data */
813   if (ELEM(NULL, ptr, ptr->data, prop)) {
814     return false;
815   }
816
817   /* get first constraint and determine type of keyframe constraints to check for
818    * - constraints can be on either Objects or PoseChannels, so we only check if the
819    *   ptr->type is RNA_Object or RNA_PoseBone, which are the RNA wrapping-info for
820    *   those structs, allowing us to identify the owner of the data
821    */
822   if (ptr->type == &RNA_Object) {
823     /* Object */
824     Object *ob = (Object *)ptr->data;
825     RigidBodyOb *rbo = ob->rigidbody_object;
826
827     con = ob->constraints.first;
828     identifier = RNA_property_identifier(prop);
829     has_parent = (ob->parent != NULL);
830
831     /* active rigidbody objects only, as only those are affected by sim */
832     has_rigidbody = ((rbo) && (rbo->type == RBO_TYPE_ACTIVE));
833   }
834   else if (ptr->type == &RNA_PoseBone) {
835     /* Pose Channel */
836     bPoseChannel *pchan = (bPoseChannel *)ptr->data;
837
838     con = pchan->constraints.first;
839     identifier = RNA_property_identifier(prop);
840     has_parent = (pchan->parent != NULL);
841   }
842
843   /* check if any data to search using */
844   if (ELEM(NULL, con, identifier) && (has_parent == false) && (has_rigidbody == false)) {
845     return false;
846   }
847
848   /* location or rotation identifiers only... */
849   if (identifier == NULL) {
850     printf("%s failed: NULL identifier\n", __func__);
851     return false;
852   }
853   else if (strstr(identifier, "location")) {
854     searchtype = VISUALKEY_LOC;
855   }
856   else if (strstr(identifier, "rotation")) {
857     searchtype = VISUALKEY_ROT;
858   }
859   else if (strstr(identifier, "scale")) {
860     searchtype = VISUALKEY_SCA;
861   }
862   else {
863     printf("%s failed: identifier - '%s'\n", __func__, identifier);
864     return false;
865   }
866
867   /* only search if a searchtype and initial constraint are available */
868   if (searchtype) {
869     /* parent or rigidbody are always matching */
870     if (has_parent || has_rigidbody) {
871       return true;
872     }
873
874     /* constraints */
875     for (; con; con = con->next) {
876       /* only consider constraint if it is not disabled, and has influence */
877       if (con->flag & CONSTRAINT_DISABLE) {
878         continue;
879       }
880       if (con->enforce == 0.0f) {
881         continue;
882       }
883
884       /* some constraints may alter these transforms */
885       switch (con->type) {
886         /* multi-transform constraints */
887         case CONSTRAINT_TYPE_CHILDOF:
888         case CONSTRAINT_TYPE_ARMATURE:
889           return true;
890         case CONSTRAINT_TYPE_TRANSFORM:
891         case CONSTRAINT_TYPE_TRANSLIKE:
892           return true;
893         case CONSTRAINT_TYPE_FOLLOWPATH:
894           return true;
895         case CONSTRAINT_TYPE_KINEMATIC:
896           return true;
897
898         /* single-transform constraints  */
899         case CONSTRAINT_TYPE_TRACKTO:
900           if (searchtype == VISUALKEY_ROT) {
901             return true;
902           }
903           break;
904         case CONSTRAINT_TYPE_DAMPTRACK:
905           if (searchtype == VISUALKEY_ROT) {
906             return true;
907           }
908           break;
909         case CONSTRAINT_TYPE_ROTLIMIT:
910           if (searchtype == VISUALKEY_ROT) {
911             return true;
912           }
913           break;
914         case CONSTRAINT_TYPE_LOCLIMIT:
915           if (searchtype == VISUALKEY_LOC) {
916             return true;
917           }
918           break;
919         case CONSTRAINT_TYPE_SIZELIMIT:
920           if (searchtype == VISUALKEY_SCA) {
921             return true;
922           }
923           break;
924         case CONSTRAINT_TYPE_DISTLIMIT:
925           if (searchtype == VISUALKEY_LOC) {
926             return true;
927           }
928           break;
929         case CONSTRAINT_TYPE_ROTLIKE:
930           if (searchtype == VISUALKEY_ROT) {
931             return true;
932           }
933           break;
934         case CONSTRAINT_TYPE_LOCLIKE:
935           if (searchtype == VISUALKEY_LOC) {
936             return true;
937           }
938           break;
939         case CONSTRAINT_TYPE_SIZELIKE:
940           if (searchtype == VISUALKEY_SCA) {
941             return true;
942           }
943           break;
944         case CONSTRAINT_TYPE_LOCKTRACK:
945           if (searchtype == VISUALKEY_ROT) {
946             return true;
947           }
948           break;
949         case CONSTRAINT_TYPE_MINMAX:
950           if (searchtype == VISUALKEY_LOC) {
951             return true;
952           }
953           break;
954
955         default:
956           break;
957       }
958     }
959   }
960
961   /* when some condition is met, this function returns, so that means we've got nothing */
962   return false;
963 }
964
965 /* This helper function extracts the value to use for visual-keyframing
966  * In the event that it is not possible to perform visual keying, try to fall-back
967  * to using the default method. Assumes that all data it has been passed is valid.
968  */
969 static float *visualkey_get_values(
970     PointerRNA *ptr, PropertyRNA *prop, float *buffer, int buffer_size, int *r_count)
971 {
972   BLI_assert(buffer_size >= 4);
973
974   const char *identifier = RNA_property_identifier(prop);
975   float tmat[4][4];
976   int rotmode;
977
978   /* handle for Objects or PoseChannels only
979    * - only Location, Rotation or Scale keyframes are supported currently
980    * - constraints can be on either Objects or PoseChannels, so we only check if the
981    *   ptr->type is RNA_Object or RNA_PoseBone, which are the RNA wrapping-info for
982    *       those structs, allowing us to identify the owner of the data
983    * - assume that array_index will be sane
984    */
985   if (ptr->type == &RNA_Object) {
986     Object *ob = (Object *)ptr->data;
987     /* Loc code is specific... */
988     if (strstr(identifier, "location")) {
989       copy_v3_v3(buffer, ob->obmat[3]);
990       *r_count = 3;
991       return buffer;
992     }
993
994     copy_m4_m4(tmat, ob->obmat);
995     rotmode = ob->rotmode;
996   }
997   else if (ptr->type == &RNA_PoseBone) {
998     bPoseChannel *pchan = (bPoseChannel *)ptr->data;
999
1000     BKE_armature_mat_pose_to_bone(pchan, pchan->pose_mat, tmat);
1001     rotmode = pchan->rotmode;
1002
1003     /* Loc code is specific... */
1004     if (strstr(identifier, "location")) {
1005       /* only use for non-connected bones */
1006       if ((pchan->bone->parent == NULL) || !(pchan->bone->flag & BONE_CONNECTED)) {
1007         copy_v3_v3(buffer, tmat[3]);
1008         *r_count = 3;
1009         return buffer;
1010       }
1011     }
1012   }
1013   else {
1014     return setting_get_rna_values(ptr, prop, buffer, buffer_size, r_count);
1015   }
1016
1017   /* Rot/Scale code are common! */
1018   if (strstr(identifier, "rotation_euler")) {
1019     mat4_to_eulO(buffer, rotmode, tmat);
1020
1021     *r_count = 3;
1022     return buffer;
1023   }
1024   else if (strstr(identifier, "rotation_quaternion")) {
1025     float mat3[3][3];
1026
1027     copy_m3_m4(mat3, tmat);
1028     mat3_to_quat_is_ok(buffer, mat3);
1029
1030     *r_count = 4;
1031     return buffer;
1032   }
1033   else if (strstr(identifier, "rotation_axis_angle")) {
1034     /* w = 0, x,y,z = 1,2,3 */
1035     mat4_to_axis_angle(buffer + 1, buffer, tmat);
1036
1037     *r_count = 4;
1038     return buffer;
1039   }
1040   else if (strstr(identifier, "scale")) {
1041     mat4_to_size(buffer, tmat);
1042
1043     *r_count = 3;
1044     return buffer;
1045   }
1046
1047   /* as the function hasn't returned yet, read value from system in the default way */
1048   return setting_get_rna_values(ptr, prop, buffer, buffer_size, r_count);
1049 }
1050
1051 /* ------------------------- Insert Key API ------------------------- */
1052
1053 /**
1054  * Retrieve current property values to keyframe,
1055  * possibly applying NLA correction when necessary.
1056  */
1057 static float *get_keyframe_values(ReportList *reports,
1058                                   PointerRNA ptr,
1059                                   PropertyRNA *prop,
1060                                   int index,
1061                                   struct NlaKeyframingContext *nla_context,
1062                                   eInsertKeyFlags flag,
1063                                   float *buffer,
1064                                   int buffer_size,
1065                                   int *r_count,
1066                                   bool *r_force_all)
1067 {
1068   float *values;
1069
1070   if ((flag & INSERTKEY_MATRIX) && (visualkey_can_use(&ptr, prop))) {
1071     /* visual-keying is only available for object and pchan datablocks, as
1072      * it works by keyframing using a value extracted from the final matrix
1073      * instead of using the kt system to extract a value.
1074      */
1075     values = visualkey_get_values(&ptr, prop, buffer, buffer_size, r_count);
1076   }
1077   else {
1078     /* read value from system */
1079     values = setting_get_rna_values(&ptr, prop, buffer, buffer_size, r_count);
1080   }
1081
1082   /* adjust the value for NLA factors */
1083   if (!BKE_animsys_nla_remap_keyframe_values(
1084           nla_context, &ptr, prop, values, *r_count, index, r_force_all)) {
1085     BKE_report(
1086         reports, RPT_ERROR, "Could not insert keyframe due to zero NLA influence or base value");
1087
1088     if (values != buffer) {
1089       MEM_freeN(values);
1090     }
1091     return NULL;
1092   }
1093
1094   return values;
1095 }
1096
1097 /* Insert the specified keyframe value into a single F-Curve. */
1098 static bool insert_keyframe_value(ReportList *reports,
1099                                   PointerRNA *ptr,
1100                                   PropertyRNA *prop,
1101                                   FCurve *fcu,
1102                                   float cfra,
1103                                   float curval,
1104                                   eBezTriple_KeyframeType keytype,
1105                                   eInsertKeyFlags flag)
1106 {
1107   /* F-Curve not editable? */
1108   if (fcurve_is_keyframable(fcu) == 0) {
1109     BKE_reportf(
1110         reports,
1111         RPT_ERROR,
1112         "F-Curve with path '%s[%d]' cannot be keyframed, ensure that it is not locked or sampled, "
1113         "and try removing F-Modifiers",
1114         fcu->rna_path,
1115         fcu->array_index);
1116     return false;
1117   }
1118
1119   /* adjust frame on which to add keyframe */
1120   if ((flag & INSERTKEY_DRIVER) && (fcu->driver)) {
1121     PathResolvedRNA anim_rna;
1122
1123     if (RNA_path_resolved_create(ptr, prop, fcu->array_index, &anim_rna)) {
1124       /* for making it easier to add corrective drivers... */
1125       cfra = evaluate_driver(&anim_rna, fcu->driver, fcu->driver, cfra);
1126     }
1127     else {
1128       cfra = 0.0f;
1129     }
1130   }
1131
1132   /* adjust coordinates for cycle aware insertion */
1133   if (flag & INSERTKEY_CYCLE_AWARE) {
1134     if (remap_cyclic_keyframe_location(fcu, &cfra, &curval) != FCU_CYCLE_PERFECT) {
1135       /* inhibit action from insert_vert_fcurve unless it's a perfect cycle */
1136       flag &= ~INSERTKEY_CYCLE_AWARE;
1137     }
1138   }
1139
1140   /* only insert keyframes where they are needed */
1141   if (flag & INSERTKEY_NEEDED) {
1142     short insert_mode;
1143
1144     /* check whether this curve really needs a new keyframe */
1145     insert_mode = new_key_needed(fcu, cfra, curval);
1146
1147     /* only return success if keyframe added */
1148     if (insert_mode == KEYNEEDED_DONTADD) {
1149       return false;
1150     }
1151
1152     /* insert new keyframe at current frame */
1153     if (insert_vert_fcurve(fcu, cfra, curval, keytype, flag) < 0) {
1154       return false;
1155     }
1156
1157     /* delete keyframe immediately before/after newly added */
1158     switch (insert_mode) {
1159       case KEYNEEDED_DELPREV:
1160         delete_fcurve_key(fcu, fcu->totvert - 2, 1);
1161         break;
1162       case KEYNEEDED_DELNEXT:
1163         delete_fcurve_key(fcu, 1, 1);
1164         break;
1165     }
1166
1167     return true;
1168   }
1169   else {
1170     /* just insert keyframe */
1171     return insert_vert_fcurve(fcu, cfra, curval, keytype, flag) >= 0;
1172   }
1173 }
1174
1175 /* Secondary Keyframing API call:
1176  * Use this when validation of necessary animation data is not necessary,
1177  * since an RNA-pointer to the necessary data being keyframed,
1178  * and a pointer to the F-Curve to use have both been provided.
1179  *
1180  * This function can't keyframe quaternion channels on some NLA strip types.
1181  *
1182  * keytype is the "keyframe type" (eBezTriple_KeyframeType), as shown in the Dope Sheet.
1183  *
1184  * The flag argument is used for special settings that alter the behavior of
1185  * the keyframe insertion. These include the 'visual' keyframing modes, quick refresh,
1186  * and extra keyframe filtering.
1187  */
1188 bool insert_keyframe_direct(ReportList *reports,
1189                             PointerRNA ptr,
1190                             PropertyRNA *prop,
1191                             FCurve *fcu,
1192                             float cfra,
1193                             eBezTriple_KeyframeType keytype,
1194                             struct NlaKeyframingContext *nla_context,
1195                             eInsertKeyFlags flag)
1196 {
1197   float curval = 0.0f;
1198
1199   /* no F-Curve to add keyframe to? */
1200   if (fcu == NULL) {
1201     BKE_report(reports, RPT_ERROR, "No F-Curve to add keyframes to");
1202     return false;
1203   }
1204
1205   /* if no property given yet, try to validate from F-Curve info */
1206   if ((ptr.id.data == NULL) && (ptr.data == NULL)) {
1207     BKE_report(
1208         reports, RPT_ERROR, "No RNA pointer available to retrieve values for keyframing from");
1209     return false;
1210   }
1211   if (prop == NULL) {
1212     PointerRNA tmp_ptr;
1213
1214     /* try to get property we should be affecting */
1215     if (RNA_path_resolve_property(&ptr, fcu->rna_path, &tmp_ptr, &prop) == false) {
1216       /* property not found... */
1217       const char *idname = (ptr.id.data) ? ((ID *)ptr.id.data)->name : TIP_("<No ID pointer>");
1218
1219       BKE_reportf(reports,
1220                   RPT_ERROR,
1221                   "Could not insert keyframe, as RNA path is invalid for the given ID (ID = %s, "
1222                   "path = %s)",
1223                   idname,
1224                   fcu->rna_path);
1225       return false;
1226     }
1227     else {
1228       /* property found, so overwrite 'ptr' to make later code easier */
1229       ptr = tmp_ptr;
1230     }
1231   }
1232
1233   /* update F-Curve flags to ensure proper behavior for property type */
1234   update_autoflags_fcurve_direct(fcu, prop);
1235
1236   /* Obtain the value to insert. */
1237   float value_buffer[RNA_MAX_ARRAY_LENGTH];
1238   int value_count;
1239   int index = fcu->array_index;
1240
1241   float *values = get_keyframe_values(reports,
1242                                       ptr,
1243                                       prop,
1244                                       index,
1245                                       nla_context,
1246                                       flag,
1247                                       value_buffer,
1248                                       RNA_MAX_ARRAY_LENGTH,
1249                                       &value_count,
1250                                       NULL);
1251
1252   if (values == NULL) {
1253     /* This happens if NLA rejects this insertion. */
1254     return false;
1255   }
1256
1257   if (index >= 0 && index < value_count) {
1258     curval = values[index];
1259   }
1260
1261   if (values != value_buffer) {
1262     MEM_freeN(values);
1263   }
1264
1265   return insert_keyframe_value(reports, &ptr, prop, fcu, cfra, curval, keytype, flag);
1266 }
1267
1268 /* Find or create the FCurve based on the given path, and insert the specified value into it. */
1269 static bool insert_keyframe_fcurve_value(Main *bmain,
1270                                          ReportList *reports,
1271                                          PointerRNA *ptr,
1272                                          PropertyRNA *prop,
1273                                          bAction *act,
1274                                          const char group[],
1275                                          const char rna_path[],
1276                                          int array_index,
1277                                          float cfra,
1278                                          float curval,
1279                                          eBezTriple_KeyframeType keytype,
1280                                          eInsertKeyFlags flag)
1281 {
1282   /* make sure the F-Curve exists
1283    * - if we're replacing keyframes only, DO NOT create new F-Curves if they do not exist yet
1284    *   but still try to get the F-Curve if it exists...
1285    */
1286   bool can_create_curve = (flag & (INSERTKEY_REPLACE | INSERTKEY_AVAILABLE)) == 0;
1287   FCurve *fcu = verify_fcurve(bmain, act, group, ptr, rna_path, array_index, can_create_curve);
1288
1289   /* we may not have a F-Curve when we're replacing only... */
1290   if (fcu) {
1291     /* set color mode if the F-Curve is new (i.e. without any keyframes) */
1292     if ((fcu->totvert == 0) && (flag & INSERTKEY_XYZ2RGB)) {
1293       /* for Loc/Rot/Scale and also Color F-Curves, the color of the F-Curve in the Graph Editor,
1294        * is determined by the array index for the F-Curve
1295        */
1296       PropertySubType prop_subtype = RNA_property_subtype(prop);
1297       if (ELEM(prop_subtype, PROP_TRANSLATION, PROP_XYZ, PROP_EULER, PROP_COLOR, PROP_COORDS)) {
1298         fcu->color_mode = FCURVE_COLOR_AUTO_RGB;
1299       }
1300       else if (ELEM(prop_subtype, PROP_QUATERNION)) {
1301         fcu->color_mode = FCURVE_COLOR_AUTO_YRGB;
1302       }
1303     }
1304
1305     /* update F-Curve flags to ensure proper behavior for property type */
1306     update_autoflags_fcurve_direct(fcu, prop);
1307
1308     /* insert keyframe */
1309     return insert_keyframe_value(reports, ptr, prop, fcu, cfra, curval, keytype, flag);
1310   }
1311   else {
1312     return false;
1313   }
1314 }
1315
1316 /* Main Keyframing API call:
1317  * Use this when validation of necessary animation data is necessary, since it may not exist yet.
1318  *
1319  * The flag argument is used for special settings that alter the behavior of
1320  * the keyframe insertion. These include the 'visual' keyframing modes, quick refresh,
1321  * and extra keyframe filtering.
1322  *
1323  * index of -1 keys all array indices
1324  */
1325 short insert_keyframe(Main *bmain,
1326                       Depsgraph *depsgraph,
1327                       ReportList *reports,
1328                       ID *id,
1329                       bAction *act,
1330                       const char group[],
1331                       const char rna_path[],
1332                       int array_index,
1333                       float cfra,
1334                       eBezTriple_KeyframeType keytype,
1335                       ListBase *nla_cache,
1336                       eInsertKeyFlags flag)
1337 {
1338   PointerRNA id_ptr, ptr;
1339   PropertyRNA *prop = NULL;
1340   AnimData *adt;
1341   ListBase tmp_nla_cache = {NULL, NULL};
1342   NlaKeyframingContext *nla_context = NULL;
1343   int ret = 0;
1344
1345   /* validate pointer first - exit if failure */
1346   if (id == NULL) {
1347     BKE_reportf(reports, RPT_ERROR, "No ID block to insert keyframe in (path = %s)", rna_path);
1348     return 0;
1349   }
1350
1351   RNA_id_pointer_create(id, &id_ptr);
1352   if (RNA_path_resolve_property(&id_ptr, rna_path, &ptr, &prop) == false) {
1353     BKE_reportf(
1354         reports,
1355         RPT_ERROR,
1356         "Could not insert keyframe, as RNA path is invalid for the given ID (ID = %s, path = %s)",
1357         (id) ? id->name : TIP_("<Missing ID block>"),
1358         rna_path);
1359     return 0;
1360   }
1361
1362   /* if no action is provided, keyframe to the default one attached to this ID-block */
1363   if (act == NULL) {
1364     /* get action to add F-Curve+keyframe to */
1365     act = verify_adt_action(bmain, id, 1);
1366
1367     if (act == NULL) {
1368       BKE_reportf(reports,
1369                   RPT_ERROR,
1370                   "Could not insert keyframe, as this type does not support animation data (ID = "
1371                   "%s, path = %s)",
1372                   id->name,
1373                   rna_path);
1374       return 0;
1375     }
1376   }
1377
1378   /* apply NLA-mapping to frame to use (if applicable) */
1379   adt = BKE_animdata_from_id(id);
1380
1381   if (adt && adt->action == act) {
1382     /* Get NLA context for value remapping. */
1383     nla_context = BKE_animsys_get_nla_keyframing_context(
1384         nla_cache ? nla_cache : &tmp_nla_cache, depsgraph, &id_ptr, adt, cfra);
1385
1386     /* Apply NLA-mapping to frame. */
1387     cfra = BKE_nla_tweakedit_remap(adt, cfra, NLATIME_CONVERT_UNMAP);
1388   }
1389
1390   /* Obtain values to insert. */
1391   float value_buffer[RNA_MAX_ARRAY_LENGTH];
1392   int value_count;
1393   bool force_all;
1394
1395   float *values = get_keyframe_values(reports,
1396                                       ptr,
1397                                       prop,
1398                                       array_index,
1399                                       nla_context,
1400                                       flag,
1401                                       value_buffer,
1402                                       RNA_MAX_ARRAY_LENGTH,
1403                                       &value_count,
1404                                       &force_all);
1405
1406   if (values != NULL) {
1407     /* Key the entire array. */
1408     if (array_index == -1 || force_all) {
1409       /* In force mode, if any of the curves succeeds, drop the replace mode and restart. */
1410       if (force_all && (flag & (INSERTKEY_REPLACE | INSERTKEY_AVAILABLE)) != 0) {
1411         int exclude = -1;
1412
1413         for (array_index = 0; array_index < value_count; array_index++) {
1414           if (insert_keyframe_fcurve_value(bmain,
1415                                            reports,
1416                                            &ptr,
1417                                            prop,
1418                                            act,
1419                                            group,
1420                                            rna_path,
1421                                            array_index,
1422                                            cfra,
1423                                            values[array_index],
1424                                            keytype,
1425                                            flag)) {
1426             ret++;
1427             exclude = array_index;
1428             break;
1429           }
1430         }
1431
1432         if (exclude != -1) {
1433           flag &= ~(INSERTKEY_REPLACE | INSERTKEY_AVAILABLE);
1434
1435           for (array_index = 0; array_index < value_count; array_index++) {
1436             if (array_index != exclude) {
1437               ret += insert_keyframe_fcurve_value(bmain,
1438                                                   reports,
1439                                                   &ptr,
1440                                                   prop,
1441                                                   act,
1442                                                   group,
1443                                                   rna_path,
1444                                                   array_index,
1445                                                   cfra,
1446                                                   values[array_index],
1447                                                   keytype,
1448                                                   flag);
1449             }
1450           }
1451         }
1452       }
1453       /* Simply insert all channels. */
1454       else {
1455         for (array_index = 0; array_index < value_count; array_index++) {
1456           ret += insert_keyframe_fcurve_value(bmain,
1457                                               reports,
1458                                               &ptr,
1459                                               prop,
1460                                               act,
1461                                               group,
1462                                               rna_path,
1463                                               array_index,
1464                                               cfra,
1465                                               values[array_index],
1466                                               keytype,
1467                                               flag);
1468         }
1469       }
1470     }
1471     /* Key a single index. */
1472     else {
1473       if (array_index >= 0 && array_index < value_count) {
1474         ret += insert_keyframe_fcurve_value(bmain,
1475                                             reports,
1476                                             &ptr,
1477                                             prop,
1478                                             act,
1479                                             group,
1480                                             rna_path,
1481                                             array_index,
1482                                             cfra,
1483                                             values[array_index],
1484                                             keytype,
1485                                             flag);
1486       }
1487     }
1488   }
1489
1490   if (values != value_buffer) {
1491     MEM_freeN(values);
1492   }
1493
1494   BKE_animsys_free_nla_keyframing_context_cache(&tmp_nla_cache);
1495
1496   if (ret) {
1497     if (act != NULL) {
1498       DEG_id_tag_update(&act->id, ID_RECALC_ANIMATION_NO_FLUSH);
1499     }
1500     if (adt != NULL && adt->action != NULL && adt->action != act) {
1501       DEG_id_tag_update(&adt->action->id, ID_RECALC_ANIMATION_NO_FLUSH);
1502     }
1503   }
1504
1505   return ret;
1506 }
1507
1508 /* ************************************************** */
1509 /* KEYFRAME DELETION */
1510
1511 /* Main Keyframing API call:
1512  * Use this when validation of necessary animation data isn't necessary as it
1513  * already exists. It will delete a keyframe at the current frame.
1514  *
1515  * The flag argument is used for special settings that alter the behavior of
1516  * the keyframe deletion. These include the quick refresh options.
1517  */
1518
1519 /**
1520  * \note caller needs to run #BKE_nla_tweakedit_remap to get NLA relative frame.
1521  *       caller should also check #BKE_fcurve_is_protected before keying.
1522  */
1523 static bool delete_keyframe_fcurve(AnimData *adt, FCurve *fcu, float cfra)
1524 {
1525   bool found;
1526   int i;
1527
1528   /* try to find index of beztriple to get rid of */
1529   i = binarysearch_bezt_index(fcu->bezt, cfra, fcu->totvert, &found);
1530   if (found) {
1531     /* delete the key at the index (will sanity check + do recalc afterwards) */
1532     delete_fcurve_key(fcu, i, 1);
1533
1534     /* Only delete curve too if it won't be doing anything anymore */
1535     if (BKE_fcurve_is_empty(fcu)) {
1536       ANIM_fcurve_delete_from_animdata(NULL, adt, fcu);
1537     }
1538
1539     /* return success */
1540     return true;
1541   }
1542   return false;
1543 }
1544
1545 static void deg_tag_after_keyframe_delete(Main *bmain, ID *id, AnimData *adt)
1546 {
1547   if (adt->action == NULL) {
1548     /* In the case last f-curve wes removed need to inform dependency graph
1549      * about relations update, since it needs to get rid of animation operation
1550      * for this datablock. */
1551     DEG_id_tag_update_ex(bmain, id, ID_RECALC_ANIMATION_NO_FLUSH);
1552     DEG_relations_tag_update(bmain);
1553   }
1554   else {
1555     DEG_id_tag_update_ex(bmain, &adt->action->id, ID_RECALC_ANIMATION_NO_FLUSH);
1556   }
1557 }
1558
1559 short delete_keyframe(Main *bmain,
1560                       ReportList *reports,
1561                       ID *id,
1562                       bAction *act,
1563                       const char group[],
1564                       const char rna_path[],
1565                       int array_index,
1566                       float cfra,
1567                       eInsertKeyFlags UNUSED(flag))
1568 {
1569   AnimData *adt = BKE_animdata_from_id(id);
1570   PointerRNA id_ptr, ptr;
1571   PropertyRNA *prop;
1572   int array_index_max = array_index + 1;
1573   int ret = 0;
1574
1575   /* sanity checks */
1576   if (ELEM(NULL, id, adt)) {
1577     BKE_report(reports, RPT_ERROR, "No ID block and/or AnimData to delete keyframe from");
1578     return 0;
1579   }
1580
1581   /* validate pointer first - exit if failure */
1582   RNA_id_pointer_create(id, &id_ptr);
1583   if (RNA_path_resolve_property(&id_ptr, rna_path, &ptr, &prop) == false) {
1584     BKE_reportf(
1585         reports,
1586         RPT_ERROR,
1587         "Could not delete keyframe, as RNA path is invalid for the given ID (ID = %s, path = %s)",
1588         id->name,
1589         rna_path);
1590     return 0;
1591   }
1592
1593   /* get F-Curve
1594    * Note: here is one of the places where we don't want new Action + F-Curve added!
1595    *      so 'add' var must be 0
1596    */
1597   if (act == NULL) {
1598     /* if no action is provided, use the default one attached to this ID-block
1599      * - if it doesn't exist, then we're out of options...
1600      */
1601     if (adt->action) {
1602       act = adt->action;
1603
1604       /* apply NLA-mapping to frame to use (if applicable) */
1605       cfra = BKE_nla_tweakedit_remap(adt, cfra, NLATIME_CONVERT_UNMAP);
1606     }
1607     else {
1608       BKE_reportf(reports, RPT_ERROR, "No action to delete keyframes from for ID = %s", id->name);
1609       return 0;
1610     }
1611   }
1612
1613   /* key entire array convenience method */
1614   if (array_index == -1) {
1615     array_index = 0;
1616     array_index_max = RNA_property_array_length(&ptr, prop);
1617
1618     /* for single properties, increase max_index so that the property itself gets included,
1619      * but don't do this for standard arrays since that can cause corruption issues
1620      * (extra unused curves)
1621      */
1622     if (array_index_max == array_index) {
1623       array_index_max++;
1624     }
1625   }
1626
1627   /* will only loop once unless the array index was -1 */
1628   for (; array_index < array_index_max; array_index++) {
1629     FCurve *fcu = verify_fcurve(bmain, act, group, &ptr, rna_path, array_index, 0);
1630
1631     /* check if F-Curve exists and/or whether it can be edited */
1632     if (fcu == NULL) {
1633       continue;
1634     }
1635
1636     if (BKE_fcurve_is_protected(fcu)) {
1637       BKE_reportf(reports,
1638                   RPT_WARNING,
1639                   "Not deleting keyframe for locked F-Curve '%s' for %s '%s'",
1640                   fcu->rna_path,
1641                   BKE_idcode_to_name(GS(id->name)),
1642                   id->name + 2);
1643       continue;
1644     }
1645
1646     ret += delete_keyframe_fcurve(adt, fcu, cfra);
1647   }
1648   if (ret) {
1649     deg_tag_after_keyframe_delete(bmain, id, adt);
1650   }
1651   /* return success/failure */
1652   return ret;
1653 }
1654
1655 /* ************************************************** */
1656 /* KEYFRAME CLEAR */
1657
1658 /* Main Keyframing API call:
1659  * Use this when validation of necessary animation data isn't necessary as it
1660  * already exists. It will clear the current buttons fcurve(s).
1661  *
1662  * The flag argument is used for special settings that alter the behavior of
1663  * the keyframe deletion. These include the quick refresh options.
1664  */
1665 static short clear_keyframe(Main *bmain,
1666                             ReportList *reports,
1667                             ID *id,
1668                             bAction *act,
1669                             const char group[],
1670                             const char rna_path[],
1671                             int array_index,
1672                             eInsertKeyFlags UNUSED(flag))
1673 {
1674   AnimData *adt = BKE_animdata_from_id(id);
1675   PointerRNA id_ptr, ptr;
1676   PropertyRNA *prop;
1677   int array_index_max = array_index + 1;
1678   int ret = 0;
1679
1680   /* sanity checks */
1681   if (ELEM(NULL, id, adt)) {
1682     BKE_report(reports, RPT_ERROR, "No ID block and/or AnimData to delete keyframe from");
1683     return 0;
1684   }
1685
1686   /* validate pointer first - exit if failure */
1687   RNA_id_pointer_create(id, &id_ptr);
1688   if (RNA_path_resolve_property(&id_ptr, rna_path, &ptr, &prop) == false) {
1689     BKE_reportf(
1690         reports,
1691         RPT_ERROR,
1692         "Could not clear keyframe, as RNA path is invalid for the given ID (ID = %s, path = %s)",
1693         id->name,
1694         rna_path);
1695     return 0;
1696   }
1697
1698   /* get F-Curve
1699    * Note: here is one of the places where we don't want new Action + F-Curve added!
1700    *      so 'add' var must be 0
1701    */
1702   if (act == NULL) {
1703     /* if no action is provided, use the default one attached to this ID-block
1704      * - if it doesn't exist, then we're out of options...
1705      */
1706     if (adt->action) {
1707       act = adt->action;
1708     }
1709     else {
1710       BKE_reportf(reports, RPT_ERROR, "No action to delete keyframes from for ID = %s", id->name);
1711       return 0;
1712     }
1713   }
1714
1715   /* key entire array convenience method */
1716   if (array_index == -1) {
1717     array_index = 0;
1718     array_index_max = RNA_property_array_length(&ptr, prop);
1719
1720     /* for single properties, increase max_index so that the property itself gets included,
1721      * but don't do this for standard arrays since that can cause corruption issues
1722      * (extra unused curves)
1723      */
1724     if (array_index_max == array_index) {
1725       array_index_max++;
1726     }
1727   }
1728
1729   /* will only loop once unless the array index was -1 */
1730   for (; array_index < array_index_max; array_index++) {
1731     FCurve *fcu = verify_fcurve(bmain, act, group, &ptr, rna_path, array_index, 0);
1732
1733     /* check if F-Curve exists and/or whether it can be edited */
1734     if (fcu == NULL) {
1735       continue;
1736     }
1737
1738     if (BKE_fcurve_is_protected(fcu)) {
1739       BKE_reportf(reports,
1740                   RPT_WARNING,
1741                   "Not clearing all keyframes from locked F-Curve '%s' for %s '%s'",
1742                   fcu->rna_path,
1743                   BKE_idcode_to_name(GS(id->name)),
1744                   id->name + 2);
1745       continue;
1746     }
1747
1748     ANIM_fcurve_delete_from_animdata(NULL, adt, fcu);
1749
1750     /* return success */
1751     ret++;
1752   }
1753   if (ret) {
1754     deg_tag_after_keyframe_delete(bmain, id, adt);
1755   }
1756   /* return success/failure */
1757   return ret;
1758 }
1759
1760 /* ******************************************* */
1761 /* KEYFRAME MODIFICATION */
1762
1763 /* mode for commonkey_modifykey */
1764 enum {
1765   COMMONKEY_MODE_INSERT = 0,
1766   COMMONKEY_MODE_DELETE,
1767 } /*eCommonModifyKey_Modes*/;
1768
1769 /* Polling callback for use with ANIM_*_keyframe() operators
1770  * This is based on the standard ED_operator_areaactive callback,
1771  * except that it does special checks for a few spacetypes too...
1772  */
1773 static bool modify_key_op_poll(bContext *C)
1774 {
1775   ScrArea *sa = CTX_wm_area(C);
1776   Scene *scene = CTX_data_scene(C);
1777
1778   /* if no area or active scene */
1779   if (ELEM(NULL, sa, scene)) {
1780     return false;
1781   }
1782
1783   /* should be fine */
1784   return true;
1785 }
1786
1787 /* Insert Key Operator ------------------------ */
1788
1789 static int insert_key_exec(bContext *C, wmOperator *op)
1790 {
1791   Scene *scene = CTX_data_scene(C);
1792   Object *obedit = CTX_data_edit_object(C);
1793   bool ob_edit_mode = false;
1794
1795   float cfra = (float)CFRA;  // XXX for now, don't bother about all the yucky offset crap
1796   short success;
1797
1798   KeyingSet *ks = keyingset_get_from_op_with_error(op, op->type->prop, scene);
1799   if (ks == NULL) {
1800     return OPERATOR_CANCELLED;
1801   }
1802
1803   /* exit the edit mode to make sure that those object data properties that have been
1804    * updated since the last switching to the edit mode will be keyframed correctly
1805    */
1806   if (obedit && ANIM_keyingset_find_id(ks, (ID *)obedit->data)) {
1807     ED_object_mode_toggle(C, OB_MODE_EDIT);
1808     ob_edit_mode = true;
1809   }
1810
1811   /* try to insert keyframes for the channels specified by KeyingSet */
1812   success = ANIM_apply_keyingset(C, NULL, NULL, ks, MODIFYKEY_MODE_INSERT, cfra);
1813   if (G.debug & G_DEBUG) {
1814     BKE_reportf(op->reports,
1815                 RPT_INFO,
1816                 "Keying set '%s' - successfully added %d keyframes",
1817                 ks->name,
1818                 success);
1819   }
1820
1821   /* restore the edit mode if necessary */
1822   if (ob_edit_mode) {
1823     ED_object_mode_toggle(C, OB_MODE_EDIT);
1824   }
1825
1826   /* report failure or do updates? */
1827   if (success == MODIFYKEY_INVALID_CONTEXT) {
1828     BKE_report(op->reports, RPT_ERROR, "No suitable context info for active keying set");
1829     return OPERATOR_CANCELLED;
1830   }
1831   else if (success) {
1832     /* if the appropriate properties have been set, make a note that we've inserted something */
1833     if (RNA_boolean_get(op->ptr, "confirm_success")) {
1834       BKE_reportf(op->reports,
1835                   RPT_INFO,
1836                   "Successfully added %d keyframes for keying set '%s'",
1837                   success,
1838                   ks->name);
1839     }
1840
1841     /* send notifiers that keyframes have been changed */
1842     WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME | NA_ADDED, NULL);
1843   }
1844   else {
1845     BKE_report(op->reports, RPT_WARNING, "Keying set failed to insert any keyframes");
1846   }
1847
1848   return OPERATOR_FINISHED;
1849 }
1850
1851 void ANIM_OT_keyframe_insert(wmOperatorType *ot)
1852 {
1853   PropertyRNA *prop;
1854
1855   /* identifiers */
1856   ot->name = "Insert Keyframe";
1857   ot->idname = "ANIM_OT_keyframe_insert";
1858   ot->description =
1859       "Insert keyframes on the current frame for all properties in the specified Keying Set";
1860
1861   /* callbacks */
1862   ot->exec = insert_key_exec;
1863   ot->poll = modify_key_op_poll;
1864
1865   /* flags */
1866   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
1867
1868   /* keyingset to use (dynamic enum) */
1869   prop = RNA_def_enum(
1870       ot->srna, "type", DummyRNA_DEFAULT_items, 0, "Keying Set", "The Keying Set to use");
1871   RNA_def_enum_funcs(prop, ANIM_keying_sets_enum_itemf);
1872   RNA_def_property_flag(prop, PROP_HIDDEN);
1873   ot->prop = prop;
1874
1875   /* confirm whether a keyframe was added by showing a popup
1876    * - by default, this is enabled, since this operator is assumed to be called independently
1877    */
1878   prop = RNA_def_boolean(ot->srna,
1879                          "confirm_success",
1880                          1,
1881                          "Confirm Successful Insert",
1882                          "Show a popup when the keyframes get successfully added");
1883   RNA_def_property_flag(prop, PROP_HIDDEN);
1884 }
1885
1886 /* Clone of 'ANIM_OT_keyframe_insert' which uses a name for the keying set instead of an enum. */
1887 void ANIM_OT_keyframe_insert_by_name(wmOperatorType *ot)
1888 {
1889   PropertyRNA *prop;
1890
1891   /* identifiers */
1892   ot->name = "Insert Keyframe (by name)";
1893   ot->idname = "ANIM_OT_keyframe_insert_by_name";
1894   ot->description = "Alternate access to 'Insert Keyframe' for keymaps to use";
1895
1896   /* callbacks */
1897   ot->exec = insert_key_exec;
1898   ot->poll = modify_key_op_poll;
1899
1900   /* flags */
1901   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
1902
1903   /* keyingset to use (idname) */
1904   prop = RNA_def_string_file_path(ot->srna, "type", "Type", MAX_ID_NAME - 2, "", "");
1905   RNA_def_property_flag(prop, PROP_HIDDEN);
1906   ot->prop = prop;
1907
1908   /* confirm whether a keyframe was added by showing a popup
1909    * - by default, this is enabled, since this operator is assumed to be called independently
1910    */
1911   prop = RNA_def_boolean(ot->srna,
1912                          "confirm_success",
1913                          1,
1914                          "Confirm Successful Insert",
1915                          "Show a popup when the keyframes get successfully added");
1916   RNA_def_property_flag(prop, PROP_HIDDEN);
1917 }
1918
1919 /* Insert Key Operator (With Menu) ------------------------ */
1920 /* This operator checks if a menu should be shown for choosing the KeyingSet to use,
1921  * then calls the menu if necessary before
1922  */
1923
1924 static int insert_key_menu_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
1925 {
1926   Scene *scene = CTX_data_scene(C);
1927
1928   /* if prompting or no active Keying Set, show the menu */
1929   if ((scene->active_keyingset == 0) || RNA_boolean_get(op->ptr, "always_prompt")) {
1930     uiPopupMenu *pup;
1931     uiLayout *layout;
1932
1933     /* call the menu, which will call this operator again, hence the canceled */
1934     pup = UI_popup_menu_begin(C, WM_operatortype_name(op->type, op->ptr), ICON_NONE);
1935     layout = UI_popup_menu_layout(pup);
1936     uiItemsEnumO(layout, "ANIM_OT_keyframe_insert_menu", "type");
1937     UI_popup_menu_end(C, pup);
1938
1939     return OPERATOR_INTERFACE;
1940   }
1941   else {
1942     /* just call the exec() on the active keyingset */
1943     RNA_enum_set(op->ptr, "type", 0);
1944     RNA_boolean_set(op->ptr, "confirm_success", true);
1945
1946     return op->type->exec(C, op);
1947   }
1948 }
1949
1950 void ANIM_OT_keyframe_insert_menu(wmOperatorType *ot)
1951 {
1952   PropertyRNA *prop;
1953
1954   /* identifiers */
1955   ot->name = "Insert Keyframe Menu";
1956   ot->idname = "ANIM_OT_keyframe_insert_menu";
1957   ot->description =
1958       "Insert Keyframes for specified Keying Set, with menu of available Keying Sets if undefined";
1959
1960   /* callbacks */
1961   ot->invoke = insert_key_menu_invoke;
1962   ot->exec = insert_key_exec;
1963   ot->poll = ED_operator_areaactive;
1964
1965   /* flags */
1966   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
1967
1968   /* keyingset to use (dynamic enum) */
1969   prop = RNA_def_enum(
1970       ot->srna, "type", DummyRNA_DEFAULT_items, 0, "Keying Set", "The Keying Set to use");
1971   RNA_def_enum_funcs(prop, ANIM_keying_sets_enum_itemf);
1972   RNA_def_property_flag(prop, PROP_HIDDEN);
1973   ot->prop = prop;
1974
1975   /* confirm whether a keyframe was added by showing a popup
1976    * - by default, this is disabled so that if a menu is shown, this doesn't come up too
1977    */
1978   // XXX should this just be always on?
1979   prop = RNA_def_boolean(ot->srna,
1980                          "confirm_success",
1981                          0,
1982                          "Confirm Successful Insert",
1983                          "Show a popup when the keyframes get successfully added");
1984   RNA_def_property_flag(prop, PROP_HIDDEN);
1985
1986   /* whether the menu should always be shown
1987    * - by default, the menu should only be shown when there is no active Keying Set (2.5 behavior),
1988    *   although in some cases it might be useful to always shown (pre 2.5 behavior)
1989    */
1990   prop = RNA_def_boolean(ot->srna, "always_prompt", 0, "Always Show Menu", "");
1991   RNA_def_property_flag(prop, PROP_HIDDEN);
1992 }
1993
1994 /* Delete Key Operator ------------------------ */
1995
1996 static int delete_key_exec(bContext *C, wmOperator *op)
1997 {
1998   Scene *scene = CTX_data_scene(C);
1999   float cfra = (float)CFRA;  // XXX for now, don't bother about all the yucky offset crap
2000   short success;
2001
2002   KeyingSet *ks = keyingset_get_from_op_with_error(op, op->type->prop, scene);
2003   if (ks == NULL) {
2004     return OPERATOR_CANCELLED;
2005   }
2006
2007   const int prop_type = RNA_property_type(op->type->prop);
2008   if (prop_type == PROP_ENUM) {
2009     int type = RNA_property_enum_get(op->ptr, op->type->prop);
2010     ks = ANIM_keyingset_get_from_enum_type(scene, type);
2011     if (ks == NULL) {
2012       BKE_report(op->reports, RPT_ERROR, "No active Keying Set");
2013       return OPERATOR_CANCELLED;
2014     }
2015   }
2016   else if (prop_type == PROP_STRING) {
2017     char type_id[MAX_ID_NAME - 2];
2018     RNA_property_string_get(op->ptr, op->type->prop, type_id);
2019     ks = ANIM_keyingset_get_from_idname(scene, type_id);
2020
2021     if (ks == NULL) {
2022       BKE_reportf(op->reports, RPT_ERROR, "Active Keying Set '%s' not found", type_id);
2023       return OPERATOR_CANCELLED;
2024     }
2025   }
2026   else {
2027     BLI_assert(0);
2028   }
2029
2030   /* report failure */
2031   if (ks == NULL) {
2032     BKE_report(op->reports, RPT_ERROR, "No active Keying Set");
2033     return OPERATOR_CANCELLED;
2034   }
2035
2036   /* try to delete keyframes for the channels specified by KeyingSet */
2037   success = ANIM_apply_keyingset(C, NULL, NULL, ks, MODIFYKEY_MODE_DELETE, cfra);
2038   if (G.debug & G_DEBUG) {
2039     printf("KeyingSet '%s' - Successfully removed %d Keyframes\n", ks->name, success);
2040   }
2041
2042   /* report failure or do updates? */
2043   if (success == MODIFYKEY_INVALID_CONTEXT) {
2044     BKE_report(op->reports, RPT_ERROR, "No suitable context info for active keying set");
2045     return OPERATOR_CANCELLED;
2046   }
2047   else if (success) {
2048     /* if the appropriate properties have been set, make a note that we've inserted something */
2049     if (RNA_boolean_get(op->ptr, "confirm_success")) {
2050       BKE_reportf(op->reports,
2051                   RPT_INFO,
2052                   "Successfully removed %d keyframes for keying set '%s'",
2053                   success,
2054                   ks->name);
2055     }
2056
2057     /* send notifiers that keyframes have been changed */
2058     WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME | NA_REMOVED, NULL);
2059   }
2060   else {
2061     BKE_report(op->reports, RPT_WARNING, "Keying set failed to remove any keyframes");
2062   }
2063
2064   return OPERATOR_FINISHED;
2065 }
2066
2067 void ANIM_OT_keyframe_delete(wmOperatorType *ot)
2068 {
2069   PropertyRNA *prop;
2070
2071   /* identifiers */
2072   ot->name = "Delete Keying-Set Keyframe";
2073   ot->idname = "ANIM_OT_keyframe_delete";
2074   ot->description =
2075       "Delete keyframes on the current frame for all properties in the specified Keying Set";
2076
2077   /* callbacks */
2078   ot->exec = delete_key_exec;
2079   ot->poll = modify_key_op_poll;
2080
2081   /* flags */
2082   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
2083
2084   /* keyingset to use (dynamic enum) */
2085   prop = RNA_def_enum(
2086       ot->srna, "type", DummyRNA_DEFAULT_items, 0, "Keying Set", "The Keying Set to use");
2087   RNA_def_enum_funcs(prop, ANIM_keying_sets_enum_itemf);
2088   RNA_def_property_flag(prop, PROP_HIDDEN);
2089   ot->prop = prop;
2090
2091   /* confirm whether a keyframe was added by showing a popup
2092    * - by default, this is enabled, since this operator is assumed to be called independently
2093    */
2094   RNA_def_boolean(ot->srna,
2095                   "confirm_success",
2096                   1,
2097                   "Confirm Successful Delete",
2098                   "Show a popup when the keyframes get successfully removed");
2099 }
2100
2101 void ANIM_OT_keyframe_delete_by_name(wmOperatorType *ot)
2102 {
2103   PropertyRNA *prop;
2104
2105   /* identifiers */
2106   ot->name = "Delete Keying-Set Keyframe (by name)";
2107   ot->idname = "ANIM_OT_keyframe_delete_by_name";
2108   ot->description = "Alternate access to 'Delete Keyframe' for keymaps to use";
2109
2110   /* callbacks */
2111   ot->exec = delete_key_exec;
2112   ot->poll = modify_key_op_poll;
2113
2114   /* flags */
2115   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
2116
2117   /* keyingset to use (idname) */
2118   prop = RNA_def_string_file_path(ot->srna, "type", "Type", MAX_ID_NAME - 2, "", "");
2119   RNA_def_property_flag(prop, PROP_HIDDEN);
2120   ot->prop = prop;
2121
2122   /* confirm whether a keyframe was added by showing a popup
2123    * - by default, this is enabled, since this operator is assumed to be called independently
2124    */
2125   RNA_def_boolean(ot->srna,
2126                   "confirm_success",
2127                   1,
2128                   "Confirm Successful Delete",
2129                   "Show a popup when the keyframes get successfully removed");
2130 }
2131
2132 /* Delete Key Operator ------------------------ */
2133 /* NOTE: Although this version is simpler than the more generic version for KeyingSets,
2134  * it is more useful for animators working in the 3D view.
2135  */
2136
2137 static int clear_anim_v3d_exec(bContext *C, wmOperator *UNUSED(op))
2138 {
2139   bool changed = false;
2140
2141   CTX_DATA_BEGIN (C, Object *, ob, selected_objects) {
2142     /* just those in active action... */
2143     if ((ob->adt) && (ob->adt->action)) {
2144       AnimData *adt = ob->adt;
2145       bAction *act = adt->action;
2146       FCurve *fcu, *fcn;
2147
2148       for (fcu = act->curves.first; fcu; fcu = fcn) {
2149         bool can_delete = false;
2150
2151         fcn = fcu->next;
2152
2153         /* in pose mode, only delete the F-Curve if it belongs to a selected bone */
2154         if (ob->mode & OB_MODE_POSE) {
2155           if ((fcu->rna_path) && strstr(fcu->rna_path, "pose.bones[")) {
2156             bPoseChannel *pchan;
2157             char *bone_name;
2158
2159             /* get bone-name, and check if this bone is selected */
2160             bone_name = BLI_str_quoted_substrN(fcu->rna_path, "pose.bones[");
2161             pchan = BKE_pose_channel_find_name(ob->pose, bone_name);
2162             if (bone_name) {
2163               MEM_freeN(bone_name);
2164             }
2165
2166             /* delete if bone is selected*/
2167             if ((pchan) && (pchan->bone)) {
2168               if (pchan->bone->flag & BONE_SELECTED) {
2169                 can_delete = true;
2170               }
2171             }
2172           }
2173         }
2174         else {
2175           /* object mode - all of Object's F-Curves are affected */
2176           can_delete = true;
2177         }
2178
2179         /* delete F-Curve completely */
2180         if (can_delete) {
2181           ANIM_fcurve_delete_from_animdata(NULL, adt, fcu);
2182           DEG_id_tag_update(&ob->id, ID_RECALC_TRANSFORM);
2183           changed = true;
2184         }
2185       }
2186
2187       /* Delete the action itself if it is empty. */
2188       if (ANIM_remove_empty_action_from_animdata(adt)) {
2189         changed = true;
2190       }
2191     }
2192   }
2193   CTX_DATA_END;
2194
2195   if (!changed) {
2196     return OPERATOR_CANCELLED;
2197   }
2198
2199   /* send updates */
2200   WM_event_add_notifier(C, NC_OBJECT | ND_KEYS, NULL);
2201
2202   return OPERATOR_FINISHED;
2203 }
2204
2205 void ANIM_OT_keyframe_clear_v3d(wmOperatorType *ot)
2206 {
2207   /* identifiers */
2208   ot->name = "Remove Animation";
2209   ot->description = "Remove all keyframe animation for selected objects";
2210   ot->idname = "ANIM_OT_keyframe_clear_v3d";
2211
2212   /* callbacks */
2213   ot->invoke = WM_operator_confirm;
2214   ot->exec = clear_anim_v3d_exec;
2215
2216   ot->poll = ED_operator_areaactive;
2217
2218   /* flags */
2219   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
2220 }
2221
2222 static int delete_key_v3d_exec(bContext *C, wmOperator *op)
2223 {
2224   Scene *scene = CTX_data_scene(C);
2225   float cfra = (float)CFRA;
2226
2227   int selected_objects_len = 0;
2228   int selected_objects_success_len = 0;
2229   int success_multi = 0;
2230
2231   CTX_DATA_BEGIN (C, Object *, ob, selected_objects) {
2232     ID *id = &ob->id;
2233     int success = 0;
2234
2235     selected_objects_len += 1;
2236
2237     /* just those in active action... */
2238     if ((ob->adt) && (ob->adt->action)) {
2239       AnimData *adt = ob->adt;
2240       bAction *act = adt->action;
2241       FCurve *fcu, *fcn;
2242       const float cfra_unmap = BKE_nla_tweakedit_remap(adt, cfra, NLATIME_CONVERT_UNMAP);
2243
2244       for (fcu = act->curves.first; fcu; fcu = fcn) {
2245         fcn = fcu->next;
2246
2247         /* don't touch protected F-Curves */
2248         if (BKE_fcurve_is_protected(fcu)) {
2249           BKE_reportf(op->reports,
2250                       RPT_WARNING,
2251                       "Not deleting keyframe for locked F-Curve '%s', object '%s'",
2252                       fcu->rna_path,
2253                       id->name + 2);
2254           continue;
2255         }
2256
2257         /* Special exception for bones, as this makes this operator more convenient to use
2258          * NOTE: This is only done in pose mode.
2259          * In object mode, we're dealing with the entire object.
2260          */
2261         if ((ob->mode & OB_MODE_POSE) && strstr(fcu->rna_path, "pose.bones[\"")) {
2262           bPoseChannel *pchan;
2263           char *bone_name;
2264
2265           /* get bone-name, and check if this bone is selected */
2266           bone_name = BLI_str_quoted_substrN(fcu->rna_path, "pose.bones[");
2267           pchan = BKE_pose_channel_find_name(ob->pose, bone_name);
2268           if (bone_name) {
2269             MEM_freeN(bone_name);
2270           }
2271
2272           /* skip if bone is not selected */
2273           if ((pchan) && (pchan->bone)) {
2274             /* bones are only selected/editable if visible... */
2275             bArmature *arm = (bArmature *)ob->data;
2276
2277             /* skipping - not visible on currently visible layers */
2278             if ((arm->layer & pchan->bone->layer) == 0) {
2279               continue;
2280             }
2281             /* skipping - is currently hidden */
2282             if (pchan->bone->flag & BONE_HIDDEN_P) {
2283               continue;
2284             }
2285
2286             /* selection flag... */
2287             if ((pchan->bone->flag & BONE_SELECTED) == 0) {
2288               continue;
2289             }
2290           }
2291         }
2292
2293         /* delete keyframes on current frame
2294          * WARNING: this can delete the next F-Curve, hence the "fcn" copying
2295          */
2296         success += delete_keyframe_fcurve(adt, fcu, cfra_unmap);
2297       }
2298       DEG_id_tag_update(&ob->adt->action->id, ID_RECALC_ANIMATION_NO_FLUSH);
2299     }
2300
2301     /* Only for reporting. */
2302     if (success) {
2303       selected_objects_success_len += 1;
2304       success_multi += success;
2305     }
2306
2307     DEG_id_tag_update(&ob->id, ID_RECALC_TRANSFORM);
2308   }
2309   CTX_DATA_END;
2310
2311   /* report success (or failure) */
2312   if (selected_objects_success_len) {
2313     BKE_reportf(op->reports,
2314                 RPT_INFO,
2315                 "%d object(s) successfully had %d keyframes removed",
2316                 selected_objects_success_len,
2317                 success_multi);
2318   }
2319   else {
2320     BKE_reportf(
2321         op->reports, RPT_ERROR, "No keyframes removed from %d object(s)", selected_objects_len);
2322   }
2323
2324   /* send updates */
2325   WM_event_add_notifier(C, NC_OBJECT | ND_KEYS, NULL);
2326
2327   return OPERATOR_FINISHED;
2328 }
2329
2330 void ANIM_OT_keyframe_delete_v3d(wmOperatorType *ot)
2331 {
2332   /* identifiers */
2333   ot->name = "Delete Keyframe";
2334   ot->description = "Remove keyframes on current frame for selected objects and bones";
2335   ot->idname = "ANIM_OT_keyframe_delete_v3d";
2336
2337   /* callbacks */
2338   ot->invoke = WM_operator_confirm;
2339   ot->exec = delete_key_v3d_exec;
2340
2341   ot->poll = ED_operator_areaactive;
2342
2343   /* flags */
2344   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
2345 }
2346
2347 /* Insert Key Button Operator ------------------------ */
2348
2349 static int insert_key_button_exec(bContext *C, wmOperator *op)
2350 {
2351   Depsgraph *depsgraph = CTX_data_depsgraph(C);
2352   Main *bmain = CTX_data_main(C);
2353   Scene *scene = CTX_data_scene(C);
2354   ToolSettings *ts = scene->toolsettings;
2355   PointerRNA ptr = {{NULL}};
2356   PropertyRNA *prop = NULL;
2357   char *path;
2358   uiBut *but;
2359   float cfra = (float)CFRA;
2360   short success = 0;
2361   int index;
2362   const bool all = RNA_boolean_get(op->ptr, "all");
2363   eInsertKeyFlags flag = INSERTKEY_NOFLAGS;
2364
2365   /* flags for inserting keyframes */
2366   flag = ANIM_get_keyframing_flags(scene, 1);
2367
2368   /* try to insert keyframe using property retrieved from UI */
2369   if (!(but = UI_context_active_but_prop_get(C, &ptr, &prop, &index))) {
2370     /* pass event on if no active button found */
2371     return (OPERATOR_CANCELLED | OPERATOR_PASS_THROUGH);
2372   }
2373
2374   if ((ptr.id.data && ptr.data && prop) && RNA_property_animateable(&ptr, prop)) {
2375     if (ptr.type == &RNA_NlaStrip) {
2376       /* Handle special properties for NLA Strips, whose F-Curves are stored on the
2377        * strips themselves. These are stored separately or else the properties will
2378        * not have any effect.
2379        */
2380       NlaStrip *strip = (NlaStrip *)ptr.data;
2381       FCurve *fcu = list_find_fcurve(&strip->fcurves, RNA_property_identifier(prop), index);
2382
2383       if (fcu) {
2384         success = insert_keyframe_direct(
2385             op->reports, ptr, prop, fcu, cfra, ts->keyframe_type, NULL, 0);
2386       }
2387       else {
2388         BKE_report(op->reports,
2389                    RPT_ERROR,
2390                    "This property cannot be animated as it will not get updated correctly");
2391       }
2392     }
2393     else if (UI_but_flag_is_set(but, UI_BUT_DRIVEN)) {
2394       /* Driven property - Find driver */
2395       FCurve *fcu;
2396       bool driven, special;
2397
2398       fcu = rna_get_fcurve_context_ui(C, &ptr, prop, index, NULL, NULL, &driven, &special);
2399
2400       if (fcu && driven) {
2401         success = insert_keyframe_direct(
2402             op->reports, ptr, prop, fcu, cfra, ts->keyframe_type, NULL, INSERTKEY_DRIVER);
2403       }
2404     }
2405     else {
2406       /* standard properties */
2407       path = RNA_path_from_ID_to_property(&ptr, prop);
2408
2409       if (path) {
2410         const char *identifier = RNA_property_identifier(prop);
2411         const char *group = NULL;
2412
2413         /* Special exception for keyframing transforms:
2414          * Set "group" for this manually, instead of having them appearing at the bottom
2415          * (ungrouped) part of the channels list.
2416          * Leaving these ungrouped is not a nice user behavior in this case.
2417          *
2418          * TODO: Perhaps we can extend this behavior in future for other properties...
2419          */
2420         if (ptr.type == &RNA_PoseBone) {
2421           bPoseChannel *pchan = (bPoseChannel *)ptr.data;
2422           group = pchan->name;
2423         }
2424         else if ((ptr.type == &RNA_Object) &&
2425                  (strstr(identifier, "location") || strstr(identifier, "rotation") ||
2426                   strstr(identifier, "scale"))) {
2427           /* NOTE: Keep this label in sync with the "ID" case in
2428            * keyingsets_utils.py :: get_transform_generators_base_info()
2429            */
2430           group = "Object Transforms";
2431         }
2432
2433         if (all) {
2434           /* -1 indicates operating on the entire array (or the property itself otherwise) */
2435           index = -1;
2436         }
2437
2438         success = insert_keyframe(bmain,
2439                                   depsgraph,
2440                                   op->reports,
2441                                   ptr.id.data,
2442                                   NULL,
2443                                   group,
2444                                   path,
2445                                   index,
2446                                   cfra,
2447                                   ts->keyframe_type,
2448                                   NULL,
2449                                   flag);
2450
2451         MEM_freeN(path);
2452       }
2453       else {
2454         BKE_report(op->reports,
2455                    RPT_WARNING,
2456                    "Failed to resolve path to property, "
2457                    "try manually specifying this using a Keying Set instead");
2458       }
2459     }
2460   }
2461   else {
2462     if (prop && !RNA_property_animateable(&ptr, prop)) {
2463       BKE_reportf(op->reports,
2464                   RPT_WARNING,
2465                   "\"%s\" property cannot be animated",
2466                   RNA_property_identifier(prop));
2467     }
2468     else {
2469       BKE_reportf(op->reports,
2470                   RPT_WARNING,
2471                   "Button doesn't appear to have any property information attached (ptr.data = "
2472                   "%p, prop = %p)",
2473                   (void *)ptr.data,
2474                   (void *)prop);
2475     }
2476   }
2477
2478   if (success) {
2479     ID *id = ptr.id.data;
2480     AnimData *adt = BKE_animdata_from_id(id);
2481     if (adt->action != NULL) {
2482       DEG_id_tag_update(&adt->action->id, ID_RECALC_ANIMATION_NO_FLUSH);
2483     }
2484     DEG_id_tag_update(id, ID_RECALC_ANIMATION_NO_FLUSH);
2485
2486     /* send updates */
2487     UI_context_update_anim_flag(C);
2488
2489     /* send notifiers that keyframes have been changed */
2490     WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME | NA_ADDED, NULL);
2491   }
2492
2493   return (success) ? OPERATOR_FINISHED : OPERATOR_CANCELLED;
2494 }
2495
2496 void ANIM_OT_keyframe_insert_button(wmOperatorType *ot)
2497 {
2498   /* identifiers */
2499   ot->name = "Insert Keyframe (Buttons)";
2500   ot->idname = "ANIM_OT_keyframe_insert_button";
2501   ot->description = "Insert a keyframe for current UI-active property";
2502
2503   /* callbacks */
2504   ot->exec = insert_key_button_exec;
2505   ot->poll = modify_key_op_poll;
2506
2507   /* flags */
2508   ot->flag = OPTYPE_UNDO | OPTYPE_INTERNAL;
2509
2510   /* properties */
2511   RNA_def_boolean(ot->srna, "all", 1, "All", "Insert a keyframe for all element of the array");
2512 }
2513
2514 /* Delete Key Button Operator ------------------------ */
2515
2516 static int delete_key_button_exec(bContext *C, wmOperator *op)
2517 {
2518   Scene *scene = CTX_data_scene(C);
2519   PointerRNA ptr = {{NULL}};
2520   PropertyRNA *prop = NULL;
2521   Main *bmain = CTX_data_main(C);
2522   char *path;
2523   float cfra = (float)CFRA;  // XXX for now, don't bother about all the yucky offset crap
2524   short success = 0;
2525   int index;
2526   const bool all = RNA_boolean_get(op->ptr, "all");
2527
2528   /* try to insert keyframe using property retrieved from UI */
2529   if (!UI_context_active_but_prop_get(C, &ptr, &prop, &index)) {
2530     /* pass event on if no active button found */
2531     return (OPERATOR_CANCELLED | OPERATOR_PASS_THROUGH);
2532   }
2533
2534   if (ptr.id.data && ptr.data && prop) {
2535     if (BKE_nlastrip_has_curves_for_property(&ptr, prop)) {
2536       /* Handle special properties for NLA Strips, whose F-Curves are stored on the
2537        * strips themselves. These are stored separately or else the properties will
2538        * not have any effect.
2539        */
2540       ID *id = ptr.id.data;
2541       NlaStrip *strip = (NlaStrip *)ptr.data;
2542       FCurve *fcu = list_find_fcurve(&strip->fcurves, RNA_property_identifier(prop), 0);
2543
2544       if (fcu) {
2545         if (BKE_fcurve_is_protected(fcu)) {
2546           BKE_reportf(
2547               op->reports,
2548               RPT_WARNING,
2549               "Not deleting keyframe for locked F-Curve for NLA Strip influence on %s - %s '%s'",
2550               strip->name,
2551               BKE_idcode_to_name(GS(id->name)),
2552               id->name + 2);
2553         }
2554         else {
2555           /* remove the keyframe directly
2556            * NOTE: cannot use delete_keyframe_fcurve(), as that will free the curve,
2557            *       and delete_keyframe() expects the FCurve to be part of an action
2558            */
2559           bool found = false;
2560           int i;
2561
2562           /* try to find index of beztriple to get rid of */
2563           i = binarysearch_bezt_index(fcu->bezt, cfra, fcu->totvert, &found);
2564           if (found) {
2565             /* delete the key at the index (will sanity check + do recalc afterwards) */
2566             delete_fcurve_key(fcu, i, 1);
2567             success = true;
2568           }
2569         }
2570       }
2571     }
2572     else {
2573       /* standard properties */
2574       path = RNA_path_from_ID_to_property(&ptr, prop);
2575
2576       if (path) {
2577         if (all) {
2578           /* -1 indicates operating on the entire array (or the property itself otherwise) */
2579           index = -1;
2580         }
2581
2582         success = delete_keyframe(
2583             bmain, op->reports, ptr.id.data, NULL, NULL, path, index, cfra, 0);
2584         MEM_freeN(path);
2585       }
2586       else if (G.debug & G_DEBUG) {
2587         printf("Button Delete-Key: no path to property\n");
2588       }
2589     }
2590   }
2591   else if (G.debug & G_DEBUG) {
2592     printf("ptr.data = %p, prop = %p\n", (void *)ptr.data, (void *)prop);
2593   }
2594
2595   if (success) {
2596     /* send updates */
2597     UI_context_update_anim_flag(C);
2598
2599     /* send notifiers that keyframes have been changed */
2600     WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME | NA_REMOVED, NULL);
2601   }
2602
2603   return (success) ? OPERATOR_FINISHED : OPERATOR_CANCELLED;
2604 }
2605
2606 void ANIM_OT_keyframe_delete_button(wmOperatorType *ot)
2607 {
2608   /* identifiers */
2609   ot->name = "Delete Keyframe (Buttons)";
2610   ot->idname = "ANIM_OT_keyframe_delete_button";
2611   ot->description = "Delete current keyframe of current UI-active property";
2612
2613   /* callbacks */
2614   ot->exec = delete_key_button_exec;
2615   ot->poll = modify_key_op_poll;
2616
2617   /* flags */
2618   ot->flag = OPTYPE_UNDO | OPTYPE_INTERNAL;
2619
2620   /* properties */
2621   RNA_def_boolean(ot->srna, "all", 1, "All", "Delete keyframes from all elements of the array");
2622 }
2623
2624 /* Clear Key Button Operator ------------------------ */
2625
2626 static int clear_key_button_exec(bContext *C, wmOperator *op)
2627 {
2628   PointerRNA ptr = {{NULL}};
2629   PropertyRNA *prop = NULL;
2630   Main *bmain = CTX_data_main(C);
2631   char *path;
2632   short success = 0;
2633   int index;
2634   const bool all = RNA_boolean_get(op->ptr, "all");
2635
2636   /* try to insert keyframe using property retrieved from UI */
2637   if (!UI_context_active_but_prop_get(C, &ptr, &prop, &index)) {
2638     /* pass event on if no active button found */
2639     return (OPERATOR_CANCELLED | OPERATOR_PASS_THROUGH);
2640   }
2641
2642   if (ptr.id.data && ptr.data && prop) {
2643     path = RNA_path_from_ID_to_property(&ptr, prop);
2644
2645     if (path) {
2646       if (all) {
2647         /* -1 indicates operating on the entire array (or the property itself otherwise) */
2648         index = -1;
2649       }
2650
2651       success += clear_keyframe(bmain, op->reports, ptr.id.data, NULL, NULL, path, index, 0);
2652       MEM_freeN(path);
2653     }
2654     else if (G.debug & G_DEBUG) {
2655       printf("Button Clear-Key: no path to property\n");
2656     }
2657   }
2658   else if (G.debug & G_DEBUG) {
2659     printf("ptr.data = %p, prop = %p\n", (void *)ptr.data, (void *)prop);
2660   }
2661
2662   if (success) {
2663     /* send updates */
2664     UI_context_update_anim_flag(C);
2665
2666     /* send notifiers that keyframes have been changed */
2667     WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME | NA_REMOVED, NULL);
2668   }
2669
2670   return (success) ? OPERATOR_FINISHED : OPERATOR_CANCELLED;
2671 }
2672
2673 void ANIM_OT_keyframe_clear_button(wmOperatorType *ot)
2674 {
2675   /* identifiers */
2676   ot->name = "Clear Keyframe (Buttons)";
2677   ot->idname = "ANIM_OT_keyframe_clear_button";
2678   ot->description = "Clear all keyframes on the currently active property";
2679
2680   /* callbacks */
2681   ot->exec = clear_key_button_exec;
2682   ot->poll = modify_key_op_poll;
2683
2684   /* flags */
2685   ot->flag = OPTYPE_UNDO | OPTYPE_INTERNAL;
2686
2687   /* properties */
2688   RNA_def_boolean(ot->srna, "all", 1, "All", "Clear keyframes from all elements of the array");
2689 }
2690
2691 /* ******************************************* */
2692 /* AUTO KEYFRAME */
2693
2694 bool autokeyframe_cfra_can_key(Scene *scene, ID *id)
2695 {
2696   float cfra = (float)CFRA;  // XXX for now, this will do
2697
2698   /* only filter if auto-key mode requires this */
2699   if (IS_AUTOKEY_ON(scene) == 0) {
2700     return false;
2701   }
2702
2703   if (IS_AUTOKEY_MODE(scene, EDITKEYS)) {
2704     /* Replace Mode:
2705      * For whole block, only key if there's a keyframe on that frame already
2706      * This is a valid assumption when we're blocking + tweaking
2707      */
2708     return id_frame_has_keyframe(id, cfra, ANIMFILTER_KEYS_LOCAL);
2709   }
2710   else {
2711     /* Normal Mode (or treat as being normal mode):
2712      *
2713      * Just in case the flags aren't set properly (i.e. only on/off is set, without a mode)
2714      * let's set the "normal" flag too, so that it will all be sane everywhere...
2715      */
2716     scene->toolsettings->autokey_mode = AUTOKEY_MODE_NORMAL;
2717
2718     /* Can insert anytime we like... */
2719     return true;
2720   }
2721 }
2722
2723 /* ******************************************* */
2724 /* KEYFRAME DETECTION */
2725
2726 /* --------------- API/Per-Datablock Handling ------------------- */
2727
2728 /* Checks if some F-Curve has a keyframe for a given frame */
2729 bool fcurve_frame_has_keyframe(FCurve *fcu, float frame, short filter)
2730 {
2731   /* quick sanity check */
2732   if (ELEM(NULL, fcu, fcu->bezt)) {
2733     return false;
2734   }
2735
2736   /* we either include all regardless of muting, or only non-muted  */
2737   if ((filter & ANIMFILTER_KEYS_MUTED) || (fcu->flag & FCURVE_MUTED) == 0) {
2738     bool replace;
2739     int i = binarysearch_bezt_index(fcu->bezt, frame, fcu->totvert, &replace);
2740
2741     /* binarysearch_bezt_index will set replace to be 0 or 1
2742      * - obviously, 1 represents a match
2743      */
2744     if (replace) {
2745       /* sanity check: 'i' may in rare cases exceed arraylen */
2746       if ((i >= 0) && (i < fcu->totvert)) {
2747         return true;
2748       }
2749     }
2750   }
2751
2752   return false;
2753 }
2754
2755 /* Returns whether the current value of a given property differs from the interpolated value. */
2756 bool fcurve_is_changed(PointerRNA ptr, PropertyRNA *prop, FCurve *fcu, float frame)
2757 {
2758   PathResolvedRNA anim_rna;
2759   anim_rna.ptr = ptr;
2760   anim_rna.prop = prop;
2761   anim_rna.prop_index = fcu->array_index;
2762
2763   float buffer[RNA_MAX_ARRAY_LENGTH];
2764   int count, index = fcu->array_index;
2765   float *values = setting_get_rna_values(&ptr, prop, buffer, RNA_MAX_ARRAY_LENGTH, &count);
2766
2767   float fcurve_val = calculate_fcurve(&anim_rna, fcu, frame);
2768   float cur_val = (index >= 0 && index < count) ? values[index] : 0.0f;
2769
2770   if (values != buffer) {
2771     MEM_freeN(values);
2772   }
2773
2774   return !compare_ff_relative(fcurve_val, cur_val, FLT_EPSILON, 64);
2775 }
2776
2777 /**
2778  * Checks whether an Action has a keyframe for a given frame
2779  * Since we're only concerned whether a keyframe exists,
2780  * we can simply loop until a match is found.
2781  */
2782 static bool action_frame_has_keyframe(bAction *act, float frame, short filter)
2783 {
2784   FCurve *fcu;
2785
2786   /* can only find if there is data */
2787   if (act == NULL) {
2788     return false;
2789   }
2790
2791   /* if only check non-muted, check if muted */
2792   if ((filter & ANIMFILTER_KEYS_MUTED) || (act->flag & ACT_MUTED)) {
2793     return false;
2794   }
2795
2796   /* loop over F-Curves, using binary-search to try to find matches
2797    * - this assumes that keyframes are only beztriples
2798    */
2799   for (fcu = act->curves.first; fcu; fcu = fcu->next) {
2800     /* only check if there are keyframes (currently only of type BezTriple) */
2801     if (fcu->bezt && fcu->totvert) {
2802       if (fcurve_frame_has_keyframe(fcu, frame, filter)) {
2803         return true;
2804       }
2805     }
2806   }
2807
2808   /* nothing found */
2809   return false;
2810 }
2811
2812 /* Checks whether an Object has a keyframe for a given frame */
2813 static bool object_frame_has_keyframe(Object *ob, float frame, short filter)
2814 {
2815   /* error checking */
2816   if (ob == NULL) {
2817     return false;
2818   }
2819
2820   /* check own animation data - specifically, the action it contains */
2821   if ((ob->adt) && (ob->adt->action)) {
2822     /* T41525 - When the active action is a NLA strip being edited,
2823      * we need to correct the frame number to "look inside" the
2824      * remapped action
2825      */
2826     float ob_frame = BKE_nla_tweakedit_remap(ob->adt, frame, NLATIME_CONVERT_UNMAP);
2827
2828     if (action_frame_has_keyframe(ob->adt->action, ob_frame, filter)) {
2829       return true;
2830     }
2831   }
2832
2833   /* try shapekey keyframes (if available, and allowed by filter) */
2834   if (!(filter & ANIMFILTER_KEYS_LOCAL) && !(filter & ANIMFILTER_KEYS_NOSKEY)) {
2835     Key *key = BKE_key_from_object(ob);
2836
2837     /* shapekeys can have keyframes ('Relative Shape Keys')
2838      * or depend on time (old 'Absolute Shape Keys')
2839      */
2840
2841     /* 1. test for relative (with keyframes) */
2842     if (id_frame_has_keyframe((ID *)key, frame, filter)) {
2843       return true;
2844     }
2845
2846     /* 2. test for time */
2847     /* TODO... yet to be implemented (this feature may evolve before then anyway) */
2848   }
2849
2850   /* try materials */
2851   if (!(filter & ANIMFILTER_KEYS_LOCAL) && !(filter & ANIMFILTER_KEYS_NOMAT)) {
2852     /* if only active, then we can skip a lot of looping */
2853     if (filter & ANIMFILTER_KEYS_ACTIVE) {
2854       Material *ma = give_current_material(ob, (ob->actcol + 1));
2855
2856       /* we only retrieve the active material... */
2857       if (id_frame_has_keyframe((ID *)ma, frame, filter)) {
2858         return true;
2859       }
2860     }
2861     else {
2862       int a;
2863
2864       /* loop over materials */
2865       for (a = 0; a < ob->totcol; a++) {
2866         Material *ma = give_current_material(ob, a + 1);
2867
2868         if (id_frame_has_keyframe((ID *)ma, frame, filter)) {
2869           return true;
2870         }
2871       }
2872     }
2873   }
2874
2875   /* nothing found */
2876   return false;
2877 }
2878
2879 /* --------------- API ------------------- */
2880
2881 /* Checks whether a keyframe exists for the given ID-block one the given frame */
2882 bool id_frame_has_keyframe(ID *id, float frame, short filter)
2883 {
2884   /* sanity checks */
2885   if (id == NULL) {
2886     return false;
2887   }
2888
2889   /* perform special checks for 'macro' types */
2890   switch (GS(id->name)) {
2891     case ID_OB: /* object */
2892       return object_frame_has_keyframe((Object *)id, frame, filter);
2893 #if 0
2894     // XXX TODO... for now, just use 'normal' behavior
2895     case ID_SCE: /* scene */
2896       break;
2897 #endif
2898     default: /* 'normal type' */
2899     {
2900       AnimData *adt = BKE_animdata_from_id(id);
2901
2902       /* only check keyframes in active action */
2903       if (adt) {
2904         return action_frame_has_keyframe(adt->action, frame, filter);
2905       }
2906       break;
2907     }
2908   }
2909
2910   /* no keyframe found */
2911   return false;
2912 }
2913
2914 /* ************************************************** */
2915
2916 bool ED_autokeyframe_object(bContext *C, Scene *scene, Object *ob, KeyingSet *ks)
2917 {
2918   /* auto keyframing */
2919   if (autokeyframe_cfra_can_key(scene, &ob->id)) {
2920     ListBase dsources = {NULL, NULL};
2921
2922     /* now insert the keyframe(s) using the Keying Set
2923      * 1) add datasource override for the Object
2924      * 2) insert keyframes
2925      * 3) free the extra info
2926      */
2927     ANIM_relative_keyingset_add_source(&dsources, &ob->id, NULL, NULL);
2928     ANIM_apply_keyingset(C, &dsources, NULL, ks, MODIFYKEY_MODE_INSERT, (float)CFRA);
2929     BLI_freelistN(&dsources);
2930
2931     return true;
2932   }
2933   else {
2934     return false;
2935   }
2936 }
2937
2938 bool ED_autokeyframe_pchan(
2939     bContext *C, Scene *scene, Object *ob, bPoseChannel *pchan, KeyingSet *ks)
2940 {
2941   if (autokeyframe_cfra_can_key(scene, &ob->id)) {
2942     ListBase dsources = {NULL, NULL};
2943
2944     /* now insert the keyframe(s) using the Keying Set
2945      * 1) add datasource override for the PoseChannel
2946      * 2) insert keyframes
2947      * 3) free the extra info
2948      */
2949     ANIM_relative_keyingset_add_source(&dsources, &ob->id, &RNA_PoseBone, pchan);
2950     ANIM_apply_keyingset(C, &dsources, NULL, ks, MODIFYKEY_MODE_INSERT, (float)CFRA);
2951     BLI_freelistN(&dsources);
2952
2953     /* clear any unkeyed tags */
2954     if (pchan->bone) {
2955       pchan->bone->flag &= ~BONE_UNKEYED;
2956     }
2957
2958     return true;
2959   }
2960   else {
2961     /* add unkeyed tags */
2962     if (pchan->bone) {
2963       pchan->bone->flag |= BONE_UNKEYED;
2964     }
2965
2966     return false;
2967   }
2968 }
2969
2970 /* -------------------------------------------------------------------- */
2971 /** \name Internal Utilities
2972  * \{ */
2973
2974 /** Use for insert/delete key-frame. */
2975 static KeyingSet *keyingset_get_from_op_with_error(wmOperator *op, PropertyRNA *prop, Scene *scene)
2976 {
2977   KeyingSet *ks = NULL;
2978   const int prop_type = RNA_property_type(prop);
2979   if (prop_type == PROP_ENUM) {
2980     int type = RNA_property_enum_get(op->ptr, prop);
2981     ks = ANIM_keyingset_get_from_enum_type(scene, type);
2982     if (ks == NULL) {
2983       BKE_report(op->reports, RPT_ERROR, "No active Keying Set");
2984     }
2985   }
2986   else if (prop_type == PROP_STRING) {
2987     char type_id[MAX_ID_NAME - 2];
2988     RNA_property_string_get(op->ptr, prop, type_id);
2989     ks = ANIM_keyingset_get_from_idname(scene, type_id);
2990
2991     if (ks == NULL) {
2992       BKE_reportf(op->reports, RPT_ERROR, "Keying set '%s' not found", type_id);
2993     }
2994   }
2995   else {
2996     BLI_assert(0);
2997   }
2998   return ks;
2999 }
3000
3001 /** \} */