remove unused includes
[blender-staging.git] / source / blender / editors / animation / keyframes_general.c
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2008 Blender Foundation
21  * All rights reserved.
22  *
23  * Contributor(s): Joshua Leung
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #include <stdlib.h>
29 #include <string.h>
30 #include <math.h>
31 #include <float.h>
32
33 #include "MEM_guardedalloc.h"
34
35 #include "BLI_blenlib.h"
36 #include "BLI_math.h"
37
38 #include "DNA_anim_types.h"
39 #include "DNA_object_types.h"
40 #include "DNA_scene_types.h"
41
42
43 #include "BKE_fcurve.h"
44 #include "BKE_utildefines.h"
45
46 #include "ED_anim_api.h"
47 #include "ED_keyframing.h"
48 #include "ED_keyframes_edit.h"
49
50 /* This file contains code for various keyframe-editing tools which are 'destructive'
51  * (i.e. they will modify the order of the keyframes, and change the size of the array).
52  * While some of these tools may eventually be moved out into blenkernel, for now, it is
53  * fine to have these calls here.
54  * 
55  * There are also a few tools here which cannot be easily coded for in the other system (yet).
56  * These may also be moved around at some point, but for now, they are best added here.
57  *
58  * - Joshua Leung, Dec 2008
59  */
60  
61 /* **************************************************** */
62
63 /* Only delete the nominated keyframe from provided F-Curve. 
64  * Not recommended to be used many times successively. For that
65  * there is delete_fcurve_keys(). 
66  */
67 void delete_fcurve_key(FCurve *fcu, int index, short do_recalc)
68 {
69         /* sanity check */
70         if (fcu == NULL) 
71                 return;
72                 
73         /* verify the index:
74          *      1) cannot be greater than the number of available keyframes
75          *      2) negative indices are for specifying a value from the end of the array
76          */
77         if (abs(index) >= fcu->totvert)
78                 return;
79         else if (index < 0)
80                 index += fcu->totvert;
81         
82         /* Delete this keyframe */
83         memmove(&fcu->bezt[index], &fcu->bezt[index+1], sizeof(BezTriple)*(fcu->totvert-index-1));
84         fcu->totvert--;
85         
86         /* recalc handles - only if it won't cause problems */
87         if (do_recalc)
88                 calchandles_fcurve(fcu);
89 }
90
91 /* Delete selected keyframes in given F-Curve */
92 void delete_fcurve_keys(FCurve *fcu)
93 {
94         int i;
95         
96         if(fcu->bezt==NULL) /* ignore baked curves */
97                 return;
98     
99         /* Delete selected BezTriples */
100         for (i=0; i < fcu->totvert; i++) {
101                 if (fcu->bezt[i].f2 & SELECT) {
102                         memmove(&fcu->bezt[i], &fcu->bezt[i+1], sizeof(BezTriple)*(fcu->totvert-i-1));
103                         fcu->totvert--;
104                         i--;
105                 }
106         }
107         
108         /* Free the array of BezTriples if there are not keyframes */
109         if (fcu->totvert == 0) {
110                 if (fcu->bezt) 
111                         MEM_freeN(fcu->bezt);
112                 fcu->bezt= NULL;
113         }
114 }
115
116 /* ---------------- */
117
118 /* duplicate selected keyframes for the given F-Curve */
119 void duplicate_fcurve_keys(FCurve *fcu)
120 {
121         BezTriple *newbezt;
122         int i;
123         
124         /* this can only work when there is an F-Curve, and also when there are some BezTriples */
125         if ELEM(NULL, fcu, fcu->bezt)
126                 return;
127         
128         for (i=0; i < fcu->totvert; i++) {
129                 /* If a key is selected */
130                 if (fcu->bezt[i].f2 & SELECT) {
131                         /* Expand the list */
132                         newbezt = MEM_callocN(sizeof(BezTriple) * (fcu->totvert+1), "beztriple");
133                         
134                         memcpy(newbezt, fcu->bezt, sizeof(BezTriple) * (i+1));
135                         memcpy(newbezt+i+1, fcu->bezt+i, sizeof(BezTriple));
136                         memcpy(newbezt+i+2, fcu->bezt+i+1, sizeof (BezTriple) *(fcu->totvert-(i+1)));
137                         fcu->totvert++;
138                         
139                         /* reassign pointers... (free old, and add new) */
140                         MEM_freeN(fcu->bezt);
141                         fcu->bezt=newbezt;
142                         
143                         /* Unselect the current key */
144                         BEZ_DESEL(&fcu->bezt[i]);
145                         i++;
146                         
147                         /* Select the copied key */
148                         BEZ_SEL(&fcu->bezt[i]);
149                 }
150         }
151 }
152
153 /* **************************************************** */
154 /* Various Tools */
155
156 /* Basic F-Curve 'cleanup' function that removes 'double points' and unnecessary keyframes on linear-segments only */
157 void clean_fcurve(FCurve *fcu, float thresh)
158 {
159         BezTriple *old_bezts, *bezt, *beztn;
160         BezTriple *lastb;
161         int totCount, i;
162         
163         /* check if any points  */
164         if ((fcu == NULL) || (fcu->totvert <= 1)) 
165                 return;
166         
167         /* make a copy of the old BezTriples, and clear IPO curve */
168         old_bezts = fcu->bezt;
169         totCount = fcu->totvert;        
170         fcu->bezt = NULL;
171         fcu->totvert = 0;
172         
173         /* now insert first keyframe, as it should be ok */
174         bezt = old_bezts;
175         insert_vert_fcurve(fcu, bezt->vec[1][0], bezt->vec[1][1], 0);
176         
177         /* Loop through BezTriples, comparing them. Skip any that do 
178          * not fit the criteria for "ok" points.
179          */
180         for (i=1; i<totCount; i++) {    
181                 float prev[2], cur[2], next[2];
182                 
183                 /* get BezTriples and their values */
184                 if (i < (totCount - 1)) {
185                         beztn = (old_bezts + (i+1));
186                         next[0]= beztn->vec[1][0]; next[1]= beztn->vec[1][1];
187                 }
188                 else {
189                         beztn = NULL;
190                         next[0] = next[1] = 0.0f;
191                 }
192                 lastb= (fcu->bezt + (fcu->totvert - 1));
193                 bezt= (old_bezts + i);
194                 
195                 /* get references for quicker access */
196                 prev[0] = lastb->vec[1][0]; prev[1] = lastb->vec[1][1];
197                 cur[0] = bezt->vec[1][0]; cur[1] = bezt->vec[1][1];
198                 
199                 /* check if current bezt occurs at same time as last ok */
200                 if (IS_EQT(cur[0], prev[0], thresh)) {
201                         /* If there is a next beztriple, and if occurs at the same time, only insert 
202                          * if there is a considerable distance between the points, and also if the 
203                          * current is further away than the next one is to the previous.
204                          */
205                         if (beztn && (IS_EQT(cur[0], next[0], thresh)) && 
206                                 (IS_EQT(next[1], prev[1], thresh)==0)) 
207                         {
208                                 /* only add if current is further away from previous */
209                                 if (cur[1] > next[1]) {
210                                         if (IS_EQT(cur[1], prev[1], thresh) == 0) {
211                                                 /* add new keyframe */
212                                                 insert_vert_fcurve(fcu, cur[0], cur[1], 0);
213                                         }
214                                 }
215                         }
216                         else {
217                                 /* only add if values are a considerable distance apart */
218                                 if (IS_EQT(cur[1], prev[1], thresh) == 0) {
219                                         /* add new keyframe */
220                                         insert_vert_fcurve(fcu, cur[0], cur[1], 0);
221                                 }
222                         }
223                 }
224                 else {
225                         /* checks required are dependent on whether this is last keyframe or not */
226                         if (beztn) {
227                                 /* does current have same value as previous and next? */
228                                 if (IS_EQT(cur[1], prev[1], thresh) == 0) {
229                                         /* add new keyframe*/
230                                         insert_vert_fcurve(fcu, cur[0], cur[1], 0);
231                                 }
232                                 else if (IS_EQT(cur[1], next[1], thresh) == 0) {
233                                         /* add new keyframe */
234                                         insert_vert_fcurve(fcu, cur[0], cur[1], 0);
235                                 }
236                         }
237                         else {  
238                                 /* add if value doesn't equal that of previous */
239                                 if (IS_EQT(cur[1], prev[1], thresh) == 0) {
240                                         /* add new keyframe */
241                                         insert_vert_fcurve(fcu, cur[0], cur[1], 0);
242                                 }
243                         }
244                 }
245         }
246         
247         /* now free the memory used by the old BezTriples */
248         if (old_bezts)
249                 MEM_freeN(old_bezts);
250 }
251
252 /* ---------------- */
253
254 /* temp struct used for smooth_fcurve */
255 typedef struct tSmooth_Bezt {
256         float *h1, *h2, *h3;    /* bezt->vec[0,1,2][1] */
257 } tSmooth_Bezt;
258
259 /* Use a weighted moving-means method to reduce intensity of fluctuations */
260 void smooth_fcurve (FCurve *fcu)
261 {
262         BezTriple *bezt;
263         int i, x, totSel = 0;
264         
265         /* first loop through - count how many verts are selected, and fix up handles 
266          *      this is done for both modes
267          */
268         bezt= fcu->bezt;
269         for (i=0; i < fcu->totvert; i++, bezt++) {                                              
270                 if (BEZSELECTED(bezt)) {                                                        
271                         /* line point's handles up with point's vertical position */
272                         bezt->vec[0][1]= bezt->vec[2][1]= bezt->vec[1][1];
273                         if ((bezt->h1==HD_AUTO) || (bezt->h1==HD_VECT)) bezt->h1= HD_ALIGN;
274                         if ((bezt->h2==HD_AUTO) || (bezt->h2==HD_VECT)) bezt->h2= HD_ALIGN;
275                         
276                         /* add value to total */
277                         totSel++;
278                 }
279         }
280         
281         /* if any points were selected, allocate tSmooth_Bezt points to work on */
282         if (totSel >= 3) {
283                 tSmooth_Bezt *tarray, *tsb;
284                 
285                 /* allocate memory in one go */
286                 tsb= tarray= MEM_callocN(totSel*sizeof(tSmooth_Bezt), "tSmooth_Bezt Array");
287                 
288                 /* populate tarray with data of selected points */
289                 bezt= fcu->bezt;
290                 for (i=0, x=0; (i < fcu->totvert) && (x < totSel); i++, bezt++) {
291                         if (BEZSELECTED(bezt)) {
292                                 /* tsb simply needs pointer to vec, and index */
293                                 tsb->h1 = &bezt->vec[0][1];
294                                 tsb->h2 = &bezt->vec[1][1];
295                                 tsb->h3 = &bezt->vec[2][1];
296                                 
297                                 /* advance to the next tsb to populate */
298                                 if (x < totSel- 1) 
299                                         tsb++;
300                                 else
301                                         break;
302                         }
303                 }
304                         
305                 /* calculate the new smoothed F-Curve's with weighted averages:
306                  *      - this is done with two passes
307                  *      - uses 5 points for each operation (which stores in the relevant handles)
308                  *      -       previous: w/a ratio = 3:5:2:1:1
309                  *      -       next: w/a ratio = 1:1:2:5:3
310                  */
311                 
312                 /* round 1: calculate previous and next */ 
313                 tsb= tarray;
314                 for (i=0; i < totSel; i++, tsb++) {
315                         /* don't touch end points (otherwise, curves slowly explode) */
316                         if (ELEM(i, 0, (totSel-1)) == 0) {
317                                 const tSmooth_Bezt *tP1 = tsb - 1;
318                                 const tSmooth_Bezt *tP2 = (i-2 > 0) ? (tsb - 2) : (NULL);
319                                 const tSmooth_Bezt *tN1 = tsb + 1;
320                                 const tSmooth_Bezt *tN2 = (i+2 < totSel) ? (tsb + 2) : (NULL);
321                                 
322                                 const float p1 = *tP1->h2;
323                                 const float p2 = (tP2) ? (*tP2->h2) : (*tP1->h2);
324                                 const float c1 = *tsb->h2;
325                                 const float n1 = *tN1->h2;
326                                 const float n2 = (tN2) ? (*tN2->h2) : (*tN1->h2);
327                                 
328                                 /* calculate previous and next */
329                                 *tsb->h1= (3*p2 + 5*p1 + 2*c1 + n1 + n2) / 12;
330                                 *tsb->h3= (p2 + p1 + 2*c1 + 5*n1 + 3*n2) / 12;
331                         }
332                 }
333                 
334                 /* round 2: calculate new values and reset handles */
335                 tsb= tarray;
336                 for (i=0; i < totSel; i++, tsb++) {
337                         /* calculate new position by averaging handles */
338                         *tsb->h2 = (*tsb->h1 + *tsb->h3) / 2;
339                         
340                         /* reset handles now */
341                         *tsb->h1 = *tsb->h2;
342                         *tsb->h3 = *tsb->h2;
343                 }
344                 
345                 /* free memory required for tarray */
346                 MEM_freeN(tarray);
347         }
348         
349         /* recalculate handles */
350         calchandles_fcurve(fcu);
351 }
352
353 /* ---------------- */
354
355 /* little cache for values... */
356 typedef struct tempFrameValCache {
357         float frame, val;
358 } tempFrameValCache;
359
360
361 /* Evaluates the curves between each selected keyframe on each frame, and keys the value  */
362 void sample_fcurve (FCurve *fcu)
363 {
364         BezTriple *bezt, *start=NULL, *end=NULL;
365         tempFrameValCache *value_cache, *fp;
366         int sfra, range;
367         int i, n, nIndex;
368
369         if(fcu->bezt==NULL) /* ignore baked */
370                 return;
371         
372         /* find selected keyframes... once pair has been found, add keyframes  */
373         for (i=0, bezt=fcu->bezt; i < fcu->totvert; i++, bezt++) {
374                 /* check if selected, and which end this is */
375                 if (BEZSELECTED(bezt)) {
376                         if (start) {
377                                 /* set end */
378                                 end= bezt;
379                                 
380                                 /* cache values then add keyframes using these values, as adding
381                                  * keyframes while sampling will affect the outcome...
382                                  *      - only start sampling+adding from index=1, so that we don't overwrite original keyframe
383                                  */
384                                 range= (int)( ceil(end->vec[1][0] - start->vec[1][0]) );
385                                 sfra= (int)( floor(start->vec[1][0]) );
386                                 
387                                 if (range) {
388                                         value_cache= MEM_callocN(sizeof(tempFrameValCache)*range, "IcuFrameValCache");
389                                         
390                                         /*      sample values   */
391                                         for (n=1, fp=value_cache; n<range && fp; n++, fp++) {
392                                                 fp->frame= (float)(sfra + n);
393                                                 fp->val= evaluate_fcurve(fcu, fp->frame);
394                                         }
395                                         
396                                         /*      add keyframes with these, tagging as 'breakdowns'       */
397                                         for (n=1, fp=value_cache; n<range && fp; n++, fp++) {
398                                                 nIndex= insert_vert_fcurve(fcu, fp->frame, fp->val, 1);
399                                                 BEZKEYTYPE(fcu->bezt + nIndex)= BEZT_KEYTYPE_BREAKDOWN;
400                                         }
401                                         
402                                         /* free temp cache */
403                                         MEM_freeN(value_cache);
404                                         
405                                         /* as we added keyframes, we need to compensate so that bezt is at the right place */
406                                         bezt = fcu->bezt + i + range - 1;
407                                         i += (range - 1);
408                                 }
409                                 
410                                 /* bezt was selected, so it now marks the start of a whole new chain to search */
411                                 start= bezt;
412                                 end= NULL;
413                         }
414                         else {
415                                 /* just set start keyframe */
416                                 start= bezt;
417                                 end= NULL;
418                         }
419                 }
420         }
421         
422         /* recalculate channel's handles? */
423         calchandles_fcurve(fcu);
424 }
425
426 /* **************************************************** */
427 /* Copy/Paste Tools */
428 /* - The copy/paste buffer currently stores a set of temporary F-Curves containing only the keyframes 
429  *   that were selected in each of the original F-Curves
430  * - All pasted frames are offset by the same amount. This is calculated as the difference in the times of
431  *      the current frame and the 'first keyframe' (i.e. the earliest one in all channels).
432  * - The earliest frame is calculated per copy operation.
433  */
434
435 /* globals for copy/paste data (like for other copy/paste buffers) */
436 ListBase animcopybuf = {NULL, NULL};
437 static float animcopy_firstframe= 999999999.0f;
438
439 /* datatype for use in copy/paste buffer */
440 typedef struct tAnimCopybufItem {
441         struct tAnimCopybufItem *next, *prev;
442         
443         ID *id;                         /* ID which owns the curve */
444         bActionGroup *grp;      /* Action Group */
445         char *rna_path;         /* RNA-Path */
446         int array_index;        /* array index */
447         
448         int totvert;            /* number of keyframes stored for this channel */
449         BezTriple *bezt;        /* keyframes in buffer */
450 } tAnimCopybufItem;
451
452
453 /* This function frees any MEM_calloc'ed copy/paste buffer data */
454 // XXX find some header to put this in!
455 void free_anim_copybuf (void)
456 {
457         tAnimCopybufItem *aci, *acn;
458         
459         /* free each buffer element */
460         for (aci= animcopybuf.first; aci; aci= acn) {
461                 acn= aci->next;
462                 
463                 /* free keyframes */
464                 if (aci->bezt) 
465                         MEM_freeN(aci->bezt);
466                         
467                 /* free RNA-path */
468                 if (aci->rna_path)
469                         MEM_freeN(aci->rna_path);
470                         
471                 /* free ourself */
472                 BLI_freelinkN(&animcopybuf, aci);
473         }
474         
475         /* restore initial state */
476         animcopybuf.first= animcopybuf.last= NULL;
477         animcopy_firstframe= 999999999.0f;
478 }
479
480 /* ------------------- */
481
482 /* This function adds data to the keyframes copy/paste buffer, freeing existing data first */
483 short copy_animedit_keys (bAnimContext *ac, ListBase *anim_data)
484 {       
485         bAnimListElem *ale;
486         
487         /* clear buffer first */
488         free_anim_copybuf();
489         
490         /* assume that each of these is an F-Curve */
491         for (ale= anim_data->first; ale; ale= ale->next) {
492                 FCurve *fcu= (FCurve *)ale->key_data;
493                 tAnimCopybufItem *aci;
494                 BezTriple *bezt, *newbuf;
495                 int i;
496                 
497                 /* firstly, check if F-Curve has any selected keyframes
498                  *      - skip if no selected keyframes found (so no need to create unnecessary copy-buffer data)
499                  *      - this check should also eliminate any problems associated with using sample-data
500                  */
501                 if (ANIM_fcurve_keyframes_loop(NULL, fcu, NULL, ANIM_editkeyframes_ok(BEZT_OK_SELECTED), NULL) == 0)
502                         continue;
503                 
504                 /* init copybuf item info */
505                 aci= MEM_callocN(sizeof(tAnimCopybufItem), "AnimCopybufItem");
506                 aci->id= ale->id;
507                 aci->grp= fcu->grp;
508                 aci->rna_path= MEM_dupallocN(fcu->rna_path);
509                 aci->array_index= fcu->array_index;
510                 BLI_addtail(&animcopybuf, aci);
511                 
512                 /* add selected keyframes to buffer */
513                 // TODO: currently, we resize array everytime we add a new vert - this works ok as long as it is assumed only a few keys are copied
514                 for (i=0, bezt=fcu->bezt; i < fcu->totvert; i++, bezt++) {
515                         if (BEZSELECTED(bezt)) {
516                                 /* add to buffer */
517                                 newbuf= MEM_callocN(sizeof(BezTriple)*(aci->totvert+1), "copybuf beztriple");
518                                 
519                                 /* assume that since we are just resizing the array, just copy all existing data across */
520                                 if (aci->bezt)
521                                         memcpy(newbuf, aci->bezt, sizeof(BezTriple)*(aci->totvert));
522                                 
523                                 /* copy current beztriple across too */
524                                 *(newbuf + aci->totvert)= *bezt; 
525                                 
526                                 /* free old array and set the new */
527                                 if (aci->bezt) MEM_freeN(aci->bezt);
528                                 aci->bezt= newbuf;
529                                 aci->totvert++;
530                                 
531                                 /* check if this is the earliest frame encountered so far */
532                                 if (bezt->vec[1][0] < animcopy_firstframe)
533                                         animcopy_firstframe= bezt->vec[1][0];
534                         }
535                 }
536                 
537         }
538         
539         /* check if anything ended up in the buffer */
540         if (ELEM(NULL, animcopybuf.first, animcopybuf.last))
541                 return -1;
542         
543         /* everything went fine */
544         return 0;
545 }
546
547 /* This function pastes data from the keyframes copy/paste buffer */
548 short paste_animedit_keys (bAnimContext *ac, ListBase *anim_data)
549 {
550         bAnimListElem *ale;
551         const Scene *scene= (ac->scene);
552         const float offset = (float)(CFRA - animcopy_firstframe);
553         short no_name= 0;
554         
555         /* check if buffer is empty */
556         if (ELEM(NULL, animcopybuf.first, animcopybuf.last)) {
557                 //error("No data in buffer to paste");
558                 return -1;
559         }
560         /* check if single channel in buffer (disregard names if so)  */
561         if (animcopybuf.first == animcopybuf.last)
562                 no_name= 1;
563         
564         /* from selected channels */
565         for (ale= anim_data->first; ale; ale= ale->next) {
566                 FCurve *fcu = (FCurve *)ale->data;              /* destination F-Curve */
567                 tAnimCopybufItem *aci= NULL;
568                 BezTriple *bezt;
569                 int i;
570                 
571                 /* find buffer item to paste from 
572                  *      - if names don't matter (i.e. only 1 channel in buffer), don't check id/group
573                  *      - if names do matter, only check if id-type is ok for now (group check is not that important)
574                  *      - most importantly, rna-paths should match (array indices are unimportant for now)
575                  */
576                 // TODO: the matching algorithm here is pathetic!
577                 for (aci= animcopybuf.first; aci; aci= aci->next) {
578                         /* check that paths exist */
579                         if (aci->rna_path && fcu->rna_path) {
580                                 // FIXME: this breaks for bone names!
581                                 if (strcmp(aci->rna_path, fcu->rna_path) == 0) {
582                                         /* should be a match unless there's more than one of these */
583                                         if ((no_name) || (aci->array_index == fcu->array_index)) 
584                                                 break;
585                                 }
586                         }
587                 }
588                 
589                 
590                 /* copy the relevant data from the matching buffer curve */
591                 if (aci) {
592                         /* just start pasting, with the the first keyframe on the current frame, and so on */
593                         for (i=0, bezt=aci->bezt; i < aci->totvert; i++, bezt++) {                                              
594                                 /* temporarily apply offset to src beztriple while copying */
595                                 bezt->vec[0][0] += offset;
596                                 bezt->vec[1][0] += offset;
597                                 bezt->vec[2][0] += offset;
598                                 
599                                 /* insert the keyframe
600                                  * NOTE: no special flags here for now
601                                  */
602                                 insert_bezt_fcurve(fcu, bezt, 0); 
603                                 
604                                 /* un-apply offset from src beztriple after copying */
605                                 bezt->vec[0][0] -= offset;
606                                 bezt->vec[1][0] -= offset;
607                                 bezt->vec[2][0] -= offset;
608                         }
609                         
610                         /* recalculate F-Curve's handles? */
611                         calchandles_fcurve(fcu);
612                 }
613         }
614         
615         return 0;
616 }
617
618 /* **************************************************** */