cleanup: style
[blender-staging.git] / source / blender / editors / animation / keyframes_general.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2008 Blender Foundation
19  * All rights reserved.
20  *
21  * Contributor(s): Joshua Leung
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file blender/editors/animation/keyframes_general.c
27  *  \ingroup edanimation
28  */
29
30
31 #include <stdlib.h>
32 #include <string.h>
33 #include <math.h>
34 #include <float.h>
35
36 #include "MEM_guardedalloc.h"
37
38 #include "BLI_blenlib.h"
39 #include "BLI_utildefines.h"
40
41 #include "DNA_anim_types.h"
42 #include "DNA_object_types.h"
43 #include "DNA_scene_types.h"
44
45
46 #include "BKE_action.h"
47 #include "BKE_fcurve.h"
48 #include "BKE_report.h"
49 #include "BKE_library.h"
50 #include "BKE_global.h"
51 #include "BKE_deform.h"
52
53 #include "RNA_access.h"
54
55 #include "ED_anim_api.h"
56 #include "ED_keyframing.h"
57 #include "ED_keyframes_edit.h"
58
59 /* This file contains code for various keyframe-editing tools which are 'destructive'
60  * (i.e. they will modify the order of the keyframes, and change the size of the array).
61  * While some of these tools may eventually be moved out into blenkernel, for now, it is
62  * fine to have these calls here.
63  * 
64  * There are also a few tools here which cannot be easily coded for in the other system (yet).
65  * These may also be moved around at some point, but for now, they are best added here.
66  *
67  * - Joshua Leung, Dec 2008
68  */
69  
70 /* **************************************************** */
71
72 /* Only delete the nominated keyframe from provided F-Curve. 
73  * Not recommended to be used many times successively. For that
74  * there is delete_fcurve_keys(). 
75  */
76 void delete_fcurve_key(FCurve *fcu, int index, bool do_recalc)
77 {
78         /* sanity check */
79         if (fcu == NULL) 
80                 return;
81                 
82         /* verify the index:
83          *      1) cannot be greater than the number of available keyframes
84          *      2) negative indices are for specifying a value from the end of the array
85          */
86         if (abs(index) >= fcu->totvert)
87                 return;
88         else if (index < 0)
89                 index += fcu->totvert;
90         
91         /* Delete this keyframe */
92         memmove(&fcu->bezt[index], &fcu->bezt[index + 1], sizeof(BezTriple) * (fcu->totvert - index - 1));
93         fcu->totvert--;
94
95         if (fcu->totvert == 0) {
96                 if (fcu->bezt)
97                         MEM_freeN(fcu->bezt);
98                 fcu->bezt = NULL;
99         }
100         
101         /* recalc handles - only if it won't cause problems */
102         if (do_recalc)
103                 calchandles_fcurve(fcu);
104 }
105
106 /* Delete selected keyframes in given F-Curve */
107 bool delete_fcurve_keys(FCurve *fcu)
108 {
109         int i;
110         bool changed = false;
111         
112         if (fcu->bezt == NULL) /* ignore baked curves */
113                 return false;
114
115         /* Delete selected BezTriples */
116         for (i = 0; i < fcu->totvert; i++) {
117                 if (fcu->bezt[i].f2 & SELECT) {
118                         memmove(&fcu->bezt[i], &fcu->bezt[i + 1], sizeof(BezTriple) * (fcu->totvert - i - 1));
119                         fcu->totvert--;
120                         i--;
121                         changed = true;
122                 }
123         }
124         
125         /* Free the array of BezTriples if there are not keyframes */
126         if (fcu->totvert == 0)
127                 clear_fcurve_keys(fcu);
128
129         return changed;
130 }
131
132
133 void clear_fcurve_keys(FCurve *fcu)
134 {
135         if (fcu->bezt)
136                 MEM_freeN(fcu->bezt);
137         fcu->bezt = NULL;
138
139         fcu->totvert = 0;
140 }
141
142 /* ---------------- */
143
144 /* duplicate selected keyframes for the given F-Curve */
145 void duplicate_fcurve_keys(FCurve *fcu)
146 {
147         BezTriple *newbezt;
148         int i;
149         
150         /* this can only work when there is an F-Curve, and also when there are some BezTriples */
151         if (ELEM(NULL, fcu, fcu->bezt))
152                 return;
153         
154         for (i = 0; i < fcu->totvert; i++) {
155                 /* If a key is selected */
156                 if (fcu->bezt[i].f2 & SELECT) {
157                         /* Expand the list */
158                         newbezt = MEM_callocN(sizeof(BezTriple) * (fcu->totvert + 1), "beztriple");
159                         
160                         memcpy(newbezt, fcu->bezt, sizeof(BezTriple) * (i + 1));
161                         memcpy(newbezt + i + 1, fcu->bezt + i, sizeof(BezTriple));
162                         memcpy(newbezt + i + 2, fcu->bezt + i + 1, sizeof(BezTriple) * (fcu->totvert - (i + 1)));
163                         fcu->totvert++;
164                         
165                         /* reassign pointers... (free old, and add new) */
166                         MEM_freeN(fcu->bezt);
167                         fcu->bezt = newbezt;
168                         
169                         /* Unselect the current key */
170                         BEZ_DESEL(&fcu->bezt[i]);
171                         i++;
172                         
173                         /* Select the copied key */
174                         BEZ_SEL(&fcu->bezt[i]);
175                 }
176         }
177 }
178
179 /* **************************************************** */
180 /* Various Tools */
181
182 /* Basic F-Curve 'cleanup' function that removes 'double points' and unnecessary keyframes on linear-segments only */
183 void clean_fcurve(FCurve *fcu, float thresh)
184 {
185         BezTriple *old_bezts, *bezt, *beztn;
186         BezTriple *lastb;
187         int totCount, i;
188         
189         /* check if any points  */
190         if ((fcu == NULL) || (fcu->bezt == NULL) || (fcu->totvert <= 1))
191                 return;
192         
193         /* make a copy of the old BezTriples, and clear F-Curve */
194         old_bezts = fcu->bezt;
195         totCount = fcu->totvert;
196         fcu->bezt = NULL;
197         fcu->totvert = 0;
198         
199         /* now insert first keyframe, as it should be ok */
200         bezt = old_bezts;
201         insert_vert_fcurve(fcu, bezt->vec[1][0], bezt->vec[1][1], 0);
202         
203         /* Loop through BezTriples, comparing them. Skip any that do 
204          * not fit the criteria for "ok" points.
205          */
206         for (i = 1; i < totCount; i++) {
207                 float prev[2], cur[2], next[2];
208                 
209                 /* get BezTriples and their values */
210                 if (i < (totCount - 1)) {
211                         beztn = (old_bezts + (i + 1));
212                         next[0] = beztn->vec[1][0]; next[1] = beztn->vec[1][1];
213                 }
214                 else {
215                         beztn = NULL;
216                         next[0] = next[1] = 0.0f;
217                 }
218                 lastb = (fcu->bezt + (fcu->totvert - 1));
219                 bezt = (old_bezts + i);
220                 
221                 /* get references for quicker access */
222                 prev[0] = lastb->vec[1][0]; prev[1] = lastb->vec[1][1];
223                 cur[0] = bezt->vec[1][0]; cur[1] = bezt->vec[1][1];
224                 
225                 /* check if current bezt occurs at same time as last ok */
226                 if (IS_EQT(cur[0], prev[0], thresh)) {
227                         /* If there is a next beztriple, and if occurs at the same time, only insert 
228                          * if there is a considerable distance between the points, and also if the 
229                          * current is further away than the next one is to the previous.
230                          */
231                         if (beztn && (IS_EQT(cur[0], next[0], thresh)) && 
232                             (IS_EQT(next[1], prev[1], thresh) == 0))
233                         {
234                                 /* only add if current is further away from previous */
235                                 if (cur[1] > next[1]) {
236                                         if (IS_EQT(cur[1], prev[1], thresh) == 0) {
237                                                 /* add new keyframe */
238                                                 insert_vert_fcurve(fcu, cur[0], cur[1], 0);
239                                         }
240                                 }
241                         }
242                         else {
243                                 /* only add if values are a considerable distance apart */
244                                 if (IS_EQT(cur[1], prev[1], thresh) == 0) {
245                                         /* add new keyframe */
246                                         insert_vert_fcurve(fcu, cur[0], cur[1], 0);
247                                 }
248                         }
249                 }
250                 else {
251                         /* checks required are dependent on whether this is last keyframe or not */
252                         if (beztn) {
253                                 /* does current have same value as previous and next? */
254                                 if (IS_EQT(cur[1], prev[1], thresh) == 0) {
255                                         /* add new keyframe*/
256                                         insert_vert_fcurve(fcu, cur[0], cur[1], 0);
257                                 }
258                                 else if (IS_EQT(cur[1], next[1], thresh) == 0) {
259                                         /* add new keyframe */
260                                         insert_vert_fcurve(fcu, cur[0], cur[1], 0);
261                                 }
262                         }
263                         else {
264                                 /* add if value doesn't equal that of previous */
265                                 if (IS_EQT(cur[1], prev[1], thresh) == 0) {
266                                         /* add new keyframe */
267                                         insert_vert_fcurve(fcu, cur[0], cur[1], 0);
268                                 }
269                         }
270                 }
271         }
272         
273         /* now free the memory used by the old BezTriples */
274         if (old_bezts)
275                 MEM_freeN(old_bezts);
276 }
277
278 /* ---------------- */
279
280 /* temp struct used for smooth_fcurve */
281 typedef struct tSmooth_Bezt {
282         float *h1, *h2, *h3;    /* bezt->vec[0,1,2][1] */
283         float y1, y2, y3;       /* averaged before/new/after y-values */
284 } tSmooth_Bezt;
285
286 /* Use a weighted moving-means method to reduce intensity of fluctuations */
287 // TODO: introduce scaling factor for weighting falloff
288 void smooth_fcurve(FCurve *fcu)
289 {
290         BezTriple *bezt;
291         int i, x, totSel = 0;
292
293         if (fcu->bezt == NULL) {
294                 return;
295         }
296
297         /* first loop through - count how many verts are selected */
298         bezt = fcu->bezt;
299         for (i = 0; i < fcu->totvert; i++, bezt++) {
300                 if (BEZSELECTED(bezt))
301                         totSel++;
302         }
303         
304         /* if any points were selected, allocate tSmooth_Bezt points to work on */
305         if (totSel >= 3) {
306                 tSmooth_Bezt *tarray, *tsb;
307                 
308                 /* allocate memory in one go */
309                 tsb = tarray = MEM_callocN(totSel * sizeof(tSmooth_Bezt), "tSmooth_Bezt Array");
310                 
311                 /* populate tarray with data of selected points */
312                 bezt = fcu->bezt;
313                 for (i = 0, x = 0; (i < fcu->totvert) && (x < totSel); i++, bezt++) {
314                         if (BEZSELECTED(bezt)) {
315                                 /* tsb simply needs pointer to vec, and index */
316                                 tsb->h1 = &bezt->vec[0][1];
317                                 tsb->h2 = &bezt->vec[1][1];
318                                 tsb->h3 = &bezt->vec[2][1];
319                                 
320                                 /* advance to the next tsb to populate */
321                                 if (x < totSel - 1)
322                                         tsb++;
323                                 else
324                                         break;
325                         }
326                 }
327                         
328                 /* calculate the new smoothed F-Curve's with weighted averages:
329                  *      - this is done with two passes to avoid progressive corruption errors
330                  *      - uses 5 points for each operation (which stores in the relevant handles)
331                  *      -   previous: w/a ratio = 3:5:2:1:1
332                  *      -   next: w/a ratio = 1:1:2:5:3
333                  */
334                 
335                 /* round 1: calculate smoothing deltas and new values */ 
336                 tsb = tarray;
337                 for (i = 0; i < totSel; i++, tsb++) {
338                         /* don't touch end points (otherwise, curves slowly explode, as we don't have enough data there) */
339                         if (ELEM(i, 0, (totSel - 1)) == 0) {
340                                 const tSmooth_Bezt *tP1 = tsb - 1;
341                                 const tSmooth_Bezt *tP2 = (i - 2 > 0) ? (tsb - 2) : (NULL);
342                                 const tSmooth_Bezt *tN1 = tsb + 1;
343                                 const tSmooth_Bezt *tN2 = (i + 2 < totSel) ? (tsb + 2) : (NULL);
344                                 
345                                 const float p1 = *tP1->h2;
346                                 const float p2 = (tP2) ? (*tP2->h2) : (*tP1->h2);
347                                 const float c1 = *tsb->h2;
348                                 const float n1 = *tN1->h2;
349                                 const float n2 = (tN2) ? (*tN2->h2) : (*tN1->h2);
350                                 
351                                 /* calculate previous and next, then new position by averaging these */
352                                 tsb->y1 = (3 * p2 + 5 * p1 + 2 * c1 + n1 + n2) / 12;
353                                 tsb->y3 = (p2 + p1 + 2 * c1 + 5 * n1 + 3 * n2) / 12;
354                                 
355                                 tsb->y2 = (tsb->y1 + tsb->y3) / 2;
356                         }
357                 }
358                 
359                 /* round 2: apply new values */
360                 tsb = tarray;
361                 for (i = 0; i < totSel; i++, tsb++) {
362                         /* don't touch end points, as their values weren't touched above */
363                         if (ELEM(i, 0, (totSel - 1)) == 0) {
364                                 /* y2 takes the average of the 2 points */
365                                 *tsb->h2 = tsb->y2;
366                                 
367                                 /* handles are weighted between their original values and the averaged values */
368                                 *tsb->h1 = ((*tsb->h1) * 0.7f) + (tsb->y1 * 0.3f); 
369                                 *tsb->h3 = ((*tsb->h3) * 0.7f) + (tsb->y3 * 0.3f);
370                         }
371                 }
372                 
373                 /* free memory required for tarray */
374                 MEM_freeN(tarray);
375         }
376         
377         /* recalculate handles */
378         calchandles_fcurve(fcu);
379 }
380
381 /* ---------------- */
382
383 /* little cache for values... */
384 typedef struct TempFrameValCache {
385         float frame, val;
386 } TempFrameValCache;
387
388
389 /* Evaluates the curves between each selected keyframe on each frame, and keys the value  */
390 void sample_fcurve(FCurve *fcu)
391 {
392         BezTriple *bezt, *start = NULL, *end = NULL;
393         TempFrameValCache *value_cache, *fp;
394         int sfra, range;
395         int i, n, nIndex;
396
397         if (fcu->bezt == NULL) /* ignore baked */
398                 return;
399         
400         /* find selected keyframes... once pair has been found, add keyframes  */
401         for (i = 0, bezt = fcu->bezt; i < fcu->totvert; i++, bezt++) {
402                 /* check if selected, and which end this is */
403                 if (BEZSELECTED(bezt)) {
404                         if (start) {
405                                 /* set end */
406                                 end = bezt;
407                                 
408                                 /* cache values then add keyframes using these values, as adding
409                                  * keyframes while sampling will affect the outcome...
410                                  *      - only start sampling+adding from index=1, so that we don't overwrite original keyframe
411                                  */
412                                 range = (int)(ceil(end->vec[1][0] - start->vec[1][0]));
413                                 sfra = (int)(floor(start->vec[1][0]));
414                                 
415                                 if (range) {
416                                         value_cache = MEM_callocN(sizeof(TempFrameValCache) * range, "IcuFrameValCache");
417                                         
418                                         /* sample values */
419                                         for (n = 1, fp = value_cache; n < range && fp; n++, fp++) {
420                                                 fp->frame = (float)(sfra + n);
421                                                 fp->val = evaluate_fcurve(fcu, fp->frame);
422                                         }
423                                         
424                                         /* add keyframes with these, tagging as 'breakdowns' */
425                                         for (n = 1, fp = value_cache; n < range && fp; n++, fp++) {
426                                                 nIndex = insert_vert_fcurve(fcu, fp->frame, fp->val, 1);
427                                                 BEZKEYTYPE(fcu->bezt + nIndex) = BEZT_KEYTYPE_BREAKDOWN;
428                                         }
429                                         
430                                         /* free temp cache */
431                                         MEM_freeN(value_cache);
432                                         
433                                         /* as we added keyframes, we need to compensate so that bezt is at the right place */
434                                         bezt = fcu->bezt + i + range - 1;
435                                         i += (range - 1);
436                                 }
437                                 
438                                 /* bezt was selected, so it now marks the start of a whole new chain to search */
439                                 start = bezt;
440                                 end = NULL;
441                         }
442                         else {
443                                 /* just set start keyframe */
444                                 start = bezt;
445                                 end = NULL;
446                         }
447                 }
448         }
449         
450         /* recalculate channel's handles? */
451         calchandles_fcurve(fcu);
452 }
453
454 /* **************************************************** */
455 /* Copy/Paste Tools */
456 /* - The copy/paste buffer currently stores a set of temporary F-Curves containing only the keyframes 
457  *   that were selected in each of the original F-Curves
458  * - All pasted frames are offset by the same amount. This is calculated as the difference in the times of
459  *      the current frame and the 'first keyframe' (i.e. the earliest one in all channels).
460  * - The earliest frame is calculated per copy operation.
461  */
462
463 /* globals for copy/paste data (like for other copy/paste buffers) */
464 static ListBase animcopybuf = {NULL, NULL};
465 static float animcopy_firstframe = 999999999.0f;
466 static float animcopy_lastframe = -999999999.0f;
467 static float animcopy_cfra = 0.0;
468
469 /* datatype for use in copy/paste buffer */
470 typedef struct tAnimCopybufItem {
471         struct tAnimCopybufItem *next, *prev;
472         
473         ID *id;             /* ID which owns the curve */
474         bActionGroup *grp;  /* Action Group */
475         char *rna_path;     /* RNA-Path */
476         int array_index;    /* array index */
477         
478         int totvert;        /* number of keyframes stored for this channel */
479         BezTriple *bezt;    /* keyframes in buffer */
480
481         short id_type;      /* Result of GS(id->name)*/
482         bool  is_bone;      /* special flag for armature bones */
483 } tAnimCopybufItem;
484
485
486 /* This function frees any MEM_calloc'ed copy/paste buffer data */
487 // XXX find some header to put this in!
488 void free_anim_copybuf(void)
489 {
490         tAnimCopybufItem *aci, *acn;
491         
492         /* free each buffer element */
493         for (aci = animcopybuf.first; aci; aci = acn) {
494                 acn = aci->next;
495                 
496                 /* free keyframes */
497                 if (aci->bezt) 
498                         MEM_freeN(aci->bezt);
499                         
500                 /* free RNA-path */
501                 if (aci->rna_path)
502                         MEM_freeN(aci->rna_path);
503                         
504                 /* free ourself */
505                 BLI_freelinkN(&animcopybuf, aci);
506         }
507         
508         /* restore initial state */
509         BLI_listbase_clear(&animcopybuf);
510         animcopy_firstframe = 999999999.0f;
511         animcopy_lastframe = -999999999.0f;
512 }
513
514 /* ------------------- */
515
516 /* This function adds data to the keyframes copy/paste buffer, freeing existing data first */
517 short copy_animedit_keys(bAnimContext *ac, ListBase *anim_data)
518 {       
519         bAnimListElem *ale;
520         Scene *scene = ac->scene;
521         
522         /* clear buffer first */
523         free_anim_copybuf();
524         
525         /* assume that each of these is an F-Curve */
526         for (ale = anim_data->first; ale; ale = ale->next) {
527                 FCurve *fcu = (FCurve *)ale->key_data;
528                 tAnimCopybufItem *aci;
529                 BezTriple *bezt, *nbezt, *newbuf;
530                 int i;
531                 
532                 /* firstly, check if F-Curve has any selected keyframes
533                  *      - skip if no selected keyframes found (so no need to create unnecessary copy-buffer data)
534                  *      - this check should also eliminate any problems associated with using sample-data
535                  */
536                 if (ANIM_fcurve_keyframes_loop(NULL, fcu, NULL, ANIM_editkeyframes_ok(BEZT_OK_SELECTED), NULL) == 0)
537                         continue;
538                 
539                 /* init copybuf item info */
540                 aci = MEM_callocN(sizeof(tAnimCopybufItem), "AnimCopybufItem");
541                 aci->id = ale->id;
542                 aci->id_type = GS(ale->id->name);
543                 aci->grp = fcu->grp;
544                 aci->rna_path = MEM_dupallocN(fcu->rna_path);
545                 aci->array_index = fcu->array_index;
546                 
547                 /* detect if this is a bone. We do that here rather than during pasting because ID pointers will get invalidated if we undo.
548                  * storing the relevant information here helps avoiding crashes if we undo-repaste */
549                 if ((aci->id_type == ID_OB) && (((Object *)aci->id)->type == OB_ARMATURE) && aci->rna_path) {
550                         Object *ob = (Object *)aci->id;
551                         char *str_start;
552                         
553                         if ((str_start = strstr(aci->rna_path, "pose.bones["))) {
554                                 bPoseChannel *pchan;
555                                 int length = 0;
556                                 char *str_end;
557                                 
558                                 str_start += 12;
559                                 str_end = strchr(str_start, '\"');
560                                 length = str_end - str_start;
561                                 str_start[length] = 0;
562                                 pchan = BKE_pose_channel_find_name(ob->pose, str_start);
563                                 str_start[length] = '\"';
564                 
565                                 if (pchan) {
566                                         aci->is_bone = true;
567                                 }
568                         }
569                 }
570                 
571                 BLI_addtail(&animcopybuf, aci);
572                 
573                 /* add selected keyframes to buffer */
574                 /* TODO: currently, we resize array every time we add a new vert -
575                  * this works ok as long as it is assumed only a few keys are copied */
576                 for (i = 0, bezt = fcu->bezt; i < fcu->totvert; i++, bezt++) {
577                         if (BEZSELECTED(bezt)) {
578                                 /* add to buffer */
579                                 newbuf = MEM_callocN(sizeof(BezTriple) * (aci->totvert + 1), "copybuf beztriple");
580                                 
581                                 /* assume that since we are just re-sizing the array, just copy all existing data across */
582                                 if (aci->bezt)
583                                         memcpy(newbuf, aci->bezt, sizeof(BezTriple) * (aci->totvert));
584                                 
585                                 /* copy current beztriple across too */
586                                 nbezt = &newbuf[aci->totvert];
587                                 *nbezt = *bezt;
588                                 
589                                 /* ensure copy buffer is selected so pasted keys are selected */
590                                 BEZ_SEL(nbezt);
591                                 
592                                 /* free old array and set the new */
593                                 if (aci->bezt) MEM_freeN(aci->bezt);
594                                 aci->bezt = newbuf;
595                                 aci->totvert++;
596                                 
597                                 /* check if this is the earliest frame encountered so far */
598                                 if (bezt->vec[1][0] < animcopy_firstframe)
599                                         animcopy_firstframe = bezt->vec[1][0];
600                                 if (bezt->vec[1][0] > animcopy_lastframe)
601                                         animcopy_lastframe = bezt->vec[1][0];
602                         }
603                 }
604                 
605         }
606         
607         /* check if anything ended up in the buffer */
608         if (ELEM(NULL, animcopybuf.first, animcopybuf.last))
609                 return -1;
610
611         /* in case 'relative' paste method is used */
612         animcopy_cfra = CFRA;
613
614         /* everything went fine */
615         return 0;
616 }
617
618 static void flip_names(tAnimCopybufItem *aci, char **name)
619 {
620         if (aci->is_bone) {
621                 char *str_start;
622                 if ((str_start = strstr(aci->rna_path, "pose.bones["))) {
623                         /* ninja coding, try to change the name */
624                         char bname_new[MAX_VGROUP_NAME];
625                         char *str_iter, *str_end;
626                         int length, prefix_l, postfix_l;
627                         
628                         str_start += 12;
629                         prefix_l = str_start - aci->rna_path;
630                         
631                         str_end = strchr(str_start, '\"');
632                         
633                         length = str_end - str_start;
634                         postfix_l = strlen(str_end);
635                         
636                         /* more ninja stuff, temporary substitute with NULL terminator */
637                         str_start[length] = 0;
638                         BKE_deform_flip_side_name(bname_new, str_start, false);
639                         str_start[length] = '\"';
640                         
641                         str_iter = *name = MEM_mallocN(sizeof(char) * (prefix_l + postfix_l + length + 1), "flipped_path");
642                         
643                         BLI_strncpy(str_iter, aci->rna_path, prefix_l + 1);
644                         str_iter += prefix_l;
645                         BLI_strncpy(str_iter, bname_new, length + 1);
646                         str_iter += length;
647                         BLI_strncpy(str_iter, str_end, postfix_l + 1);
648                         str_iter[postfix_l] = '\0';
649                 }
650         }
651 }
652
653 /* ------------------- */
654
655 /* most strict method: exact matches only */
656 static tAnimCopybufItem *pastebuf_match_path_full(FCurve *fcu, const short from_single, const short to_simple, bool flip)
657 {
658         tAnimCopybufItem *aci;
659
660         for (aci = animcopybuf.first; aci; aci = aci->next) {
661                 if (to_simple || (aci->rna_path && fcu->rna_path)) {
662                         if (!to_simple && flip && aci->is_bone && fcu->rna_path) {
663                                 if ((from_single) || (aci->array_index == fcu->array_index)) {
664                                         char *name = NULL;
665                                         flip_names(aci, &name);
666                                         if (STREQ(name, fcu->rna_path)) {
667                                                 MEM_freeN(name);
668                                                 break;
669                                         }
670                                         MEM_freeN(name);
671                                 }
672                         }
673                         else if (to_simple || STREQ(aci->rna_path, fcu->rna_path)) {
674                                 if ((from_single) || (aci->array_index == fcu->array_index)) {
675                                         break;
676                                 }
677                         }
678                 }
679         }
680
681         return aci;
682 }
683
684 /* medium match strictness: path match only (i.e. ignore ID) */
685 static tAnimCopybufItem *pastebuf_match_path_property(FCurve *fcu, const short from_single, const short UNUSED(to_simple))
686 {
687         tAnimCopybufItem *aci;
688
689         for (aci = animcopybuf.first; aci; aci = aci->next) {
690                 /* check that paths exist */
691                 if (aci->rna_path && fcu->rna_path) {
692                         /* find the property of the fcurve and compare against the end of the tAnimCopybufItem
693                          * more involved since it needs to to path lookups.
694                          * This is not 100% reliable since the user could be editing the curves on a path that wont
695                          * resolve, or a bone could be renamed after copying for eg. but in normal copy & paste
696                          * this should work out ok. 
697                          */
698                         if (BLI_findindex(which_libbase(G.main, aci->id_type), aci->id) == -1) {
699                                 /* pedantic but the ID could have been removed, and beats crashing! */
700                                 printf("paste_animedit_keys: error ID has been removed!\n");
701                         }
702                         else {
703                                 PointerRNA id_ptr, rptr;
704                                 PropertyRNA *prop;
705                                 
706                                 RNA_id_pointer_create(aci->id, &id_ptr);
707                                 
708                                 if (RNA_path_resolve_property(&id_ptr, aci->rna_path, &rptr, &prop)) {
709                                         const char *identifier = RNA_property_identifier(prop);
710                                         int len_id = strlen(identifier);
711                                         int len_path = strlen(fcu->rna_path);
712                                         if (len_id <= len_path) {
713                                                 /* note, paths which end with "] will fail with this test - Animated ID Props */
714                                                 if (STREQ(identifier, fcu->rna_path + (len_path - len_id))) {
715                                                         if ((from_single) || (aci->array_index == fcu->array_index))
716                                                                 break;
717                                                 }
718                                         }
719                                 }
720                                 else {
721                                         printf("paste_animedit_keys: failed to resolve path id:%s, '%s'!\n", aci->id->name, aci->rna_path);
722                                 }
723                         }
724                 }
725         }
726
727         return aci;
728 }
729
730 /* least strict matching heuristic: indices only */
731 static tAnimCopybufItem *pastebuf_match_index_only(FCurve *fcu, const short from_single, const short UNUSED(to_simple))
732 {
733         tAnimCopybufItem *aci;
734
735         for (aci = animcopybuf.first; aci; aci = aci->next) {
736                 /* check that paths exist */
737                 if ((from_single) || (aci->array_index == fcu->array_index)) {
738                         break;
739                 }
740         }
741
742         return aci;
743 }
744
745 /* ................ */
746
747 static void do_curve_mirror_flippping(tAnimCopybufItem *aci, BezTriple *bezt)
748 {
749         if (aci->is_bone) {
750                 const size_t slength = strlen(aci->rna_path);
751                 bool flip = false;
752                 if (BLI_strn_endswith(aci->rna_path, "location", slength) && aci->array_index == 0)
753                         flip = true;
754                 else if (BLI_strn_endswith(aci->rna_path, "rotation_quaternion", slength) && ELEM(aci->array_index, 2, 3))
755                         flip = true;
756                 else if (BLI_strn_endswith(aci->rna_path, "rotation_euler", slength) && ELEM(aci->array_index, 1, 2))
757                         flip = true;
758                 else if (BLI_strn_endswith(aci->rna_path, "rotation_axis_angle", slength) && ELEM(aci->array_index, 2, 3))
759                         flip = true;
760                 
761                 if (flip) {
762                         bezt->vec[0][1] = -bezt->vec[0][1];
763                         bezt->vec[1][1] = -bezt->vec[1][1];
764                         bezt->vec[2][1] = -bezt->vec[2][1];
765                 }
766         }
767 }
768
769 /* helper for paste_animedit_keys() - performs the actual pasting */
770 static void paste_animedit_keys_fcurve(FCurve *fcu, tAnimCopybufItem *aci, float offset, const eKeyMergeMode merge_mode, bool flip)
771 {
772         BezTriple *bezt;
773         int i;
774
775         /* First de-select existing FCurve's keyframes */
776         for (i = 0, bezt = fcu->bezt; i < fcu->totvert; i++, bezt++) {
777                 bezt->f2 &= ~SELECT;
778         }
779
780         /* mix mode with existing data */
781         switch (merge_mode) {
782                 case KEYFRAME_PASTE_MERGE_MIX:
783                         /* do-nothing */
784                         break;
785                         
786                 case KEYFRAME_PASTE_MERGE_OVER:
787                         /* remove all keys */
788                         clear_fcurve_keys(fcu);
789                         break;
790                         
791                 case KEYFRAME_PASTE_MERGE_OVER_RANGE:
792                 case KEYFRAME_PASTE_MERGE_OVER_RANGE_ALL:
793                 {
794                         float f_min;
795                         float f_max;
796                         
797                         if (merge_mode == KEYFRAME_PASTE_MERGE_OVER_RANGE) {
798                                 f_min = aci->bezt[0].vec[1][0] + offset;
799                                 f_max = aci->bezt[aci->totvert - 1].vec[1][0] + offset;
800                         }
801                         else { /* Entire Range */
802                                 f_min = animcopy_firstframe + offset;
803                                 f_max = animcopy_lastframe + offset;
804                         }
805                         
806                         /* remove keys in range */
807                         if (f_min < f_max) {
808                                 /* select verts in range for removal */
809                                 for (i = 0, bezt = fcu->bezt; i < fcu->totvert; i++, bezt++) {
810                                         if ((f_min < bezt[0].vec[1][0]) && (bezt[0].vec[1][0] < f_max)) {
811                                                 bezt->f2 |= SELECT;
812                                         }
813                                 }
814                                 
815                                 /* remove frames in the range */
816                                 delete_fcurve_keys(fcu);
817                         }
818                         break;
819                 }
820         }
821         
822         /* just start pasting, with the first keyframe on the current frame, and so on */
823         for (i = 0, bezt = aci->bezt; i < aci->totvert; i++, bezt++) {
824                 /* temporarily apply offset to src beztriple while copying */
825                 if (flip)
826                         do_curve_mirror_flippping(aci, bezt);
827                 
828                 bezt->vec[0][0] += offset;
829                 bezt->vec[1][0] += offset;
830                 bezt->vec[2][0] += offset;
831                 
832                 /* insert the keyframe
833                  * NOTE: we do not want to inherit handles from existing keyframes in this case!
834                  */
835                 
836                 insert_bezt_fcurve(fcu, bezt, INSERTKEY_OVERWRITE_FULL);
837
838                 /* un-apply offset from src beztriple after copying */
839                 bezt->vec[0][0] -= offset;
840                 bezt->vec[1][0] -= offset;
841                 bezt->vec[2][0] -= offset;
842                 
843                 if (flip)
844                         do_curve_mirror_flippping(aci, bezt);
845         }
846         
847         /* recalculate F-Curve's handles? */
848         calchandles_fcurve(fcu);
849 }
850
851 /* ------------------- */
852
853 EnumPropertyItem keyframe_paste_offset_items[] = {
854         {KEYFRAME_PASTE_OFFSET_CFRA_START, "START", 0, "Frame Start", "Paste keys starting at current frame"},
855         {KEYFRAME_PASTE_OFFSET_CFRA_END, "END", 0, "Frame End", "Paste keys ending at current frame"},
856         {KEYFRAME_PASTE_OFFSET_CFRA_RELATIVE, "RELATIVE", 0, "Frame Relative", "Paste keys relative to the current frame when copying"},
857         {KEYFRAME_PASTE_OFFSET_NONE, "NONE", 0, "No Offset", "Paste keys from original time"},
858         {0, NULL, 0, NULL, NULL}};
859
860 EnumPropertyItem keyframe_paste_merge_items[] = {
861         {KEYFRAME_PASTE_MERGE_MIX, "MIX", 0, "Mix", "Overlay existing with new keys"},
862         {KEYFRAME_PASTE_MERGE_OVER, "OVER_ALL", 0, "Overwrite All", "Replace all keys"},
863         {KEYFRAME_PASTE_MERGE_OVER_RANGE, "OVER_RANGE", 0, "Overwrite Range", "Overwrite keys in pasted range"},
864         {KEYFRAME_PASTE_MERGE_OVER_RANGE_ALL, "OVER_RANGE_ALL", 0, "Overwrite Entire Range", "Overwrite keys in pasted range, using the range of all copied keys"},
865         {0, NULL, 0, NULL, NULL}};
866
867
868 /**
869  * This function pastes data from the keyframes copy/paste buffer
870  *
871  * \return Status code is whether the method FAILED to do anything
872  */
873 short paste_animedit_keys(bAnimContext *ac, ListBase *anim_data,
874                           const eKeyPasteOffset offset_mode, const eKeyMergeMode merge_mode, bool flip)
875 {
876         bAnimListElem *ale;
877         
878         const Scene *scene = (ac->scene);
879         
880         const bool from_single = BLI_listbase_is_single(&animcopybuf);
881         const bool to_simple = BLI_listbase_is_single(anim_data);
882         
883         float offset = 0.0f;
884         int pass;
885
886         /* check if buffer is empty */
887         if (BLI_listbase_is_empty(&animcopybuf)) {
888                 BKE_report(ac->reports, RPT_ERROR, "No animation data in buffer to paste");
889                 return -1;
890         }
891
892         if (BLI_listbase_is_empty(anim_data)) {
893                 BKE_report(ac->reports, RPT_ERROR, "No selected F-Curves to paste into");
894                 return -1;
895         }
896         
897         /* mathods of offset */
898         switch (offset_mode) {
899                 case KEYFRAME_PASTE_OFFSET_CFRA_START:
900                         offset = (float)(CFRA - animcopy_firstframe);
901                         break;
902                 case KEYFRAME_PASTE_OFFSET_CFRA_END:
903                         offset = (float)(CFRA - animcopy_lastframe);
904                         break;
905                 case KEYFRAME_PASTE_OFFSET_CFRA_RELATIVE:
906                         offset = (float)(CFRA - animcopy_cfra);
907                         break;
908                 case KEYFRAME_PASTE_OFFSET_NONE:
909                         offset = 0.0f;
910                         break;
911         }
912
913         if (from_single && to_simple) {
914                 /* 1:1 match, no tricky checking, just paste */
915                 FCurve *fcu;
916                 tAnimCopybufItem *aci;
917                 
918                 ale = anim_data->first;
919                 fcu = (FCurve *)ale->data;  /* destination F-Curve */
920                 aci = animcopybuf.first;
921                 
922                 paste_animedit_keys_fcurve(fcu, aci, offset, merge_mode, false);
923         }
924         else {
925                 /* from selected channels 
926                  *  This "passes" system aims to try to find "matching" channels to paste keyframes
927                  *  into with increasingly loose matching heuristics. The process finishes when at least
928                  *  one F-Curve has been pasted into.
929                  */
930                 for (pass = 0; pass < 3; pass++) {
931                         unsigned int totmatch = 0;
932                         
933                         for (ale = anim_data->first; ale; ale = ale->next) {
934                                 /* find buffer item to paste from 
935                                  *      - if names don't matter (i.e. only 1 channel in buffer), don't check id/group
936                                  *      - if names do matter, only check if id-type is ok for now (group check is not that important)
937                                  *      - most importantly, rna-paths should match (array indices are unimportant for now)
938                                  */
939                                 FCurve *fcu = (FCurve *)ale->data;  /* destination F-Curve */
940                                 tAnimCopybufItem *aci = NULL;
941                                 
942                                 switch (pass) {
943                                         case 0:
944                                                 /* most strict, must be exact path match data_path & index */
945                                                 aci = pastebuf_match_path_full(fcu, from_single, to_simple, flip);
946                                                 break;
947                                         
948                                         case 1:
949                                                 /* less strict, just compare property names */
950                                                 aci = pastebuf_match_path_property(fcu, from_single, to_simple);
951                                                 break;
952                                         
953                                         case 2:
954                                                 /* Comparing properties gave no results, so just do index comparisons */
955                                                 aci = pastebuf_match_index_only(fcu, from_single, to_simple);
956                                                 break;
957                                 }
958                                 
959                                 /* copy the relevant data from the matching buffer curve */
960                                 if (aci) {
961                                         totmatch++;
962                                         paste_animedit_keys_fcurve(fcu, aci, offset, merge_mode, flip);
963                                 }
964
965                                 ale->update |= ANIM_UPDATE_DEFAULT;
966                         }
967                         
968                         /* don't continue if some fcurves were pasted */
969                         if (totmatch)
970                                 break;
971                 }
972         }
973         
974         ANIM_animdata_update(ac, anim_data);
975
976         return 0;
977 }
978
979 /* **************************************************** */