2.5 - Warning cleanups (for mingw+scons)
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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_arithb.h"
37
38 #include "DNA_anim_types.h"
39 #include "DNA_action_types.h"
40 #include "DNA_curve_types.h"
41 #include "DNA_key_types.h"
42 #include "DNA_object_types.h"
43 #include "DNA_space_types.h"
44 #include "DNA_scene_types.h"
45
46 #include "RNA_access.h"
47
48 #include "BKE_action.h"
49 #include "BKE_fcurve.h"
50 #include "BKE_key.h"
51 #include "BKE_utildefines.h"
52
53 #include "ED_anim_api.h"
54 #include "ED_keyframing.h"
55 #include "ED_keyframes_edit.h"
56
57 /* This file contains code for various keyframe-editing tools which are 'destructive'
58  * (i.e. they will modify the order of the keyframes, and change the size of the array).
59  * While some of these tools may eventually be moved out into blenkernel, for now, it is
60  * fine to have these calls here.
61  * 
62  * There are also a few tools here which cannot be easily coded for in the other system (yet).
63  * These may also be moved around at some point, but for now, they 
64  *
65  * - Joshua Leung, Dec 2008
66  */
67  
68 /* **************************************************** */
69
70 /* Only delete the nominated keyframe from provided ipo-curve. 
71  * Not recommended to be used many times successively. For that
72  * there is delete_ipo_keys(). 
73  */
74 void delete_fcurve_key(FCurve *fcu, int index, short do_recalc)
75 {
76         /* firstly check that index is valid */
77         if (index < 0) 
78                 index *= -1;
79         if (fcu == NULL) 
80                 return;
81         if (index >= fcu->totvert)
82                 return;
83         
84         /*      Delete this key */
85         memmove(&fcu->bezt[index], &fcu->bezt[index+1], sizeof(BezTriple)*(fcu->totvert-index-1));
86         fcu->totvert--;
87         
88         /* recalc handles - only if it won't cause problems */
89         if (do_recalc)
90                 calchandles_fcurve(fcu);
91 }
92
93 /* Delete selected keyframes in given F-Curve */
94 void delete_fcurve_keys(FCurve *fcu)
95 {
96         int i;
97         
98         /* Delete selected BezTriples */
99         for (i=0; i < fcu->totvert; i++) {
100                 if (fcu->bezt[i].f2 & SELECT) {
101                         memmove(&fcu->bezt[i], &fcu->bezt[i+1], sizeof(BezTriple)*(fcu->totvert-i-1));
102                         fcu->totvert--;
103                         i--;
104                 }
105         }
106         
107         /* Free the array of BezTriples if there are not keyframes */
108         if (fcu->totvert == 0) {
109                 if (fcu->bezt) 
110                         MEM_freeN(fcu->bezt);
111                 fcu->bezt= NULL;
112         }
113         
114 #if 0 // XXX for now, we don't get rid of empty curves...
115         /* Only delete if there isn't an ipo-driver still hanging around on an empty curve */
116         if ((icu->totvert==0) && (icu->driver==NULL)) {
117                 BLI_remlink(&ipo->curve, icu);
118                 free_ipo_curve(icu);
119         }
120 #endif 
121 }
122
123 /* ---------------- */
124
125 /* duplicate selected keyframes for the given F-Curve */
126 void duplicate_fcurve_keys(FCurve *fcu)
127 {
128         BezTriple *newbezt;
129         int i;
130         
131         /* this can only work when there is an F-Curve, and also when there are some BezTriples */
132         if ELEM(NULL, fcu, fcu->bezt)
133                 return;
134         
135         for (i=0; i < fcu->totvert; i++) {
136                 /* If a key is selected */
137                 if (fcu->bezt[i].f2 & SELECT) {
138                         /* Expand the list */
139                         newbezt = MEM_callocN(sizeof(BezTriple) * (fcu->totvert+1), "beztriple");
140                         
141                         memcpy(newbezt, fcu->bezt, sizeof(BezTriple) * (i+1));
142                         memcpy(newbezt+i+1, fcu->bezt+i, sizeof(BezTriple));
143                         memcpy(newbezt+i+2, fcu->bezt+i+1, sizeof (BezTriple) *(fcu->totvert-(i+1)));
144                         fcu->totvert++;
145                         
146                         /* reassign pointers... (free old, and add new) */
147                         MEM_freeN(fcu->bezt);
148                         fcu->bezt=newbezt;
149                         
150                         /* Unselect the current key */
151                         BEZ_DESEL(&fcu->bezt[i]);
152                         i++;
153                         
154                         /* Select the copied key */
155                         BEZ_SEL(&fcu->bezt[i]);
156                 }
157         }
158 }
159
160 /* **************************************************** */
161 /* Various Tools */
162
163 /* Basic F-Curve 'cleanup' function that removes 'double points' and unnecessary keyframes on linear-segments only */
164 void clean_fcurve(FCurve *fcu, float thresh)
165 {
166         BezTriple *old_bezts, *bezt, *beztn;
167         BezTriple *lastb;
168         int totCount, i;
169         
170         /* check if any points  */
171         if ((fcu == NULL) || (fcu->totvert <= 1)) 
172                 return;
173         
174         /* make a copy of the old BezTriples, and clear IPO curve */
175         old_bezts = fcu->bezt;
176         totCount = fcu->totvert;        
177         fcu->bezt = NULL;
178         fcu->totvert = 0;
179         
180         /* now insert first keyframe, as it should be ok */
181         bezt = old_bezts;
182         insert_vert_fcurve(fcu, bezt->vec[1][0], bezt->vec[1][1], 0);
183         
184         /* Loop through BezTriples, comparing them. Skip any that do 
185          * not fit the criteria for "ok" points.
186          */
187         for (i=1; i<totCount; i++) {    
188                 float prev[2], cur[2], next[2];
189                 
190                 /* get BezTriples and their values */
191                 if (i < (totCount - 1)) {
192                         beztn = (old_bezts + (i+1));
193                         next[0]= beztn->vec[1][0]; next[1]= beztn->vec[1][1];
194                 }
195                 else {
196                         beztn = NULL;
197                         next[0] = next[1] = 0.0f;
198                 }
199                 lastb= (fcu->bezt + (fcu->totvert - 1));
200                 bezt= (old_bezts + i);
201                 
202                 /* get references for quicker access */
203                 prev[0] = lastb->vec[1][0]; prev[1] = lastb->vec[1][1];
204                 cur[0] = bezt->vec[1][0]; cur[1] = bezt->vec[1][1];
205                 
206                 /* check if current bezt occurs at same time as last ok */
207                 if (IS_EQT(cur[0], prev[0], thresh)) {
208                         /* If there is a next beztriple, and if occurs at the same time, only insert 
209                          * if there is a considerable distance between the points, and also if the 
210                          * current is further away than the next one is to the previous.
211                          */
212                         if (beztn && (IS_EQT(cur[0], next[0], thresh)) && 
213                                 (IS_EQT(next[1], prev[1], thresh)==0)) 
214                         {
215                                 /* only add if current is further away from previous */
216                                 if (cur[1] > next[1]) {
217                                         if (IS_EQT(cur[1], prev[1], thresh) == 0) {
218                                                 /* add new keyframe */
219                                                 insert_vert_fcurve(fcu, cur[0], cur[1], 0);
220                                         }
221                                 }
222                         }
223                         else {
224                                 /* only add if values are a considerable distance apart */
225                                 if (IS_EQT(cur[1], prev[1], thresh) == 0) {
226                                         /* add new keyframe */
227                                         insert_vert_fcurve(fcu, cur[0], cur[1], 0);
228                                 }
229                         }
230                 }
231                 else {
232                         /* checks required are dependent on whether this is last keyframe or not */
233                         if (beztn) {
234                                 /* does current have same value as previous and next? */
235                                 if (IS_EQT(cur[1], prev[1], thresh) == 0) {
236                                         /* add new keyframe*/
237                                         insert_vert_fcurve(fcu, cur[0], cur[1], 0);
238                                 }
239                                 else if (IS_EQT(cur[1], next[1], thresh) == 0) {
240                                         /* add new keyframe */
241                                         insert_vert_fcurve(fcu, cur[0], cur[1], 0);
242                                 }
243                         }
244                         else {  
245                                 /* add if value doesn't equal that of previous */
246                                 if (IS_EQT(cur[1], prev[1], thresh) == 0) {
247                                         /* add new keyframe */
248                                         insert_vert_fcurve(fcu, cur[0], cur[1], 0);
249                                 }
250                         }
251                 }
252         }
253         
254         /* now free the memory used by the old BezTriples */
255         if (old_bezts)
256                 MEM_freeN(old_bezts);
257 }
258
259 /* ---------------- */
260
261 /* temp struct used for smooth_ipo */
262 typedef struct tSmooth_Bezt {
263         float *h1, *h2, *h3;    /* bezt->vec[0,1,2][1] */
264 } tSmooth_Bezt;
265
266 /* Use a weighted moving-means method to reduce intensity of fluctuations */
267 void smooth_fcurve (FCurve *fcu)
268 {
269         BezTriple *bezt;
270         int i, x, totSel = 0;
271         
272         /* first loop through - count how many verts are selected, and fix up handles 
273          *      this is done for both modes
274          */
275         bezt= fcu->bezt;
276         for (i=0; i < fcu->totvert; i++, bezt++) {                                              
277                 if (BEZSELECTED(bezt)) {                                                        
278                         /* line point's handles up with point's vertical position */
279                         bezt->vec[0][1]= bezt->vec[2][1]= bezt->vec[1][1];
280                         if ((bezt->h1==HD_AUTO) || (bezt->h1==HD_VECT)) bezt->h1= HD_ALIGN;
281                         if ((bezt->h2==HD_AUTO) || (bezt->h2==HD_VECT)) bezt->h2= HD_ALIGN;
282                         
283                         /* add value to total */
284                         totSel++;
285                 }
286         }
287         
288         /* if any points were selected, allocate tSmooth_Bezt points to work on */
289         if (totSel >= 3) {
290                 tSmooth_Bezt *tarray, *tsb;
291                 
292                 /* allocate memory in one go */
293                 tsb= tarray= MEM_callocN(totSel*sizeof(tSmooth_Bezt), "tSmooth_Bezt Array");
294                 
295                 /* populate tarray with data of selected points */
296                 bezt= fcu->bezt;
297                 for (i=0, x=0; (i < fcu->totvert) && (x < totSel); i++, bezt++) {
298                         if (BEZSELECTED(bezt)) {
299                                 /* tsb simply needs pointer to vec, and index */
300                                 tsb->h1 = &bezt->vec[0][1];
301                                 tsb->h2 = &bezt->vec[1][1];
302                                 tsb->h3 = &bezt->vec[2][1];
303                                 
304                                 /* advance to the next tsb to populate */
305                                 if (x < totSel- 1) 
306                                         tsb++;
307                                 else
308                                         break;
309                         }
310                 }
311                         
312                 /* calculate the new smoothed F-Curve's with weighted averages:
313                  *      - this is done with two passes
314                  *      - uses 5 points for each operation (which stores in the relevant handles)
315                  *      -       previous: w/a ratio = 3:5:2:1:1
316                  *      -       next: w/a ratio = 1:1:2:5:3
317                  */
318                 
319                 /* round 1: calculate previous and next */ 
320                 tsb= tarray;
321                 for (i=0; i < totSel; i++, tsb++) {
322                         /* don't touch end points (otherwise, curves slowly explode) */
323                         if (ELEM(i, 0, (totSel-1)) == 0) {
324                                 const tSmooth_Bezt *tP1 = tsb - 1;
325                                 const tSmooth_Bezt *tP2 = (i-2 > 0) ? (tsb - 2) : (NULL);
326                                 const tSmooth_Bezt *tN1 = tsb + 1;
327                                 const tSmooth_Bezt *tN2 = (i+2 < totSel) ? (tsb + 2) : (NULL);
328                                 
329                                 const float p1 = *tP1->h2;
330                                 const float p2 = (tP2) ? (*tP2->h2) : (*tP1->h2);
331                                 const float c1 = *tsb->h2;
332                                 const float n1 = *tN1->h2;
333                                 const float n2 = (tN2) ? (*tN2->h2) : (*tN1->h2);
334                                 
335                                 /* calculate previous and next */
336                                 *tsb->h1= (3*p2 + 5*p1 + 2*c1 + n1 + n2) / 12;
337                                 *tsb->h3= (p2 + p1 + 2*c1 + 5*n1 + 3*n2) / 12;
338                         }
339                 }
340                 
341                 /* round 2: calculate new values and reset handles */
342                 tsb= tarray;
343                 for (i=0; i < totSel; i++, tsb++) {
344                         /* calculate new position by averaging handles */
345                         *tsb->h2 = (*tsb->h1 + *tsb->h3) / 2;
346                         
347                         /* reset handles now */
348                         *tsb->h1 = *tsb->h2;
349                         *tsb->h3 = *tsb->h2;
350                 }
351                 
352                 /* free memory required for tarray */
353                 MEM_freeN(tarray);
354         }
355         
356         /* recalculate handles */
357         calchandles_fcurve(fcu);
358 }
359
360 /* **************************************************** */
361 /* Copy/Paste Tools */
362 /* - The copy/paste buffer currently stores a set of temporary F-Curves containing only the keyframes 
363  *   that were selected in each of the original F-Curves
364  * - All pasted frames are offset by the same amount. This is calculated as the difference in the times of
365  *      the current frame and the 'first keyframe' (i.e. the earliest one in all channels).
366  * - The earliest frame is calculated per copy operation.
367  */
368
369 /* globals for copy/paste data (like for other copy/paste buffers) */
370 ListBase animcopybuf = {NULL, NULL};
371 static float animcopy_firstframe= 999999999.0f;
372
373 /* datatype for use in copy/paste buffer */
374 typedef struct tAnimCopybufItem {
375         struct tAnimCopybufItem *next, *prev;
376         
377         ID *id;                         /* ID which owns the curve */
378         bActionGroup *grp;      /* Action Group */
379         char *rna_path;         /* RNA-Path */
380         int array_index;        /* array index */
381         
382         int totvert;            /* number of keyframes stored for this channel */
383         BezTriple *bezt;        /* keyframes in buffer */
384 } tAnimCopybufItem;
385
386
387 /* This function frees any MEM_calloc'ed copy/paste buffer data */
388 // XXX find some header to put this in!
389 void free_anim_copybuf (void)
390 {
391         tAnimCopybufItem *aci, *acn;
392         
393         /* free each buffer element */
394         for (aci= animcopybuf.first; aci; aci= acn) {
395                 acn= aci->next;
396                 
397                 /* free keyframes */
398                 if (aci->bezt) 
399                         MEM_freeN(aci->bezt);
400                         
401                 /* free RNA-path */
402                 if (aci->rna_path)
403                         MEM_freeN(aci->rna_path);
404                         
405                 /* free ourself */
406                 BLI_freelinkN(&animcopybuf, aci);
407         }
408         
409         /* restore initial state */
410         animcopybuf.first= animcopybuf.last= NULL;
411         animcopy_firstframe= 999999999.0f;
412 }
413
414 /* ------------------- */
415
416 /* This function adds data to the keyframes copy/paste buffer, freeing existing data first */
417 short copy_animedit_keys (bAnimContext *ac, ListBase *anim_data)
418 {       
419         bAnimListElem *ale;
420         
421         /* clear buffer first */
422         free_anim_copybuf();
423         
424         /* assume that each of these is an F-Curve */
425         for (ale= anim_data->first; ale; ale= ale->next) {
426                 FCurve *fcu= (FCurve *)ale->key_data;
427                 tAnimCopybufItem *aci;
428                 BezTriple *bezt, *newbuf;
429                 int i;
430                 
431                 /* firstly, check if F-Curve has any selected keyframes
432                  *      - skip if no selected keyframes found (so no need to create unnecessary copy-buffer data)
433                  *      - this check should also eliminate any problems associated with using sample-data
434                  */
435                 if (ANIM_fcurve_keys_bezier_loop(NULL, fcu, NULL, ANIM_editkeyframes_ok(BEZT_OK_SELECTED), NULL) == 0)
436                         continue;
437                 
438                 /* init copybuf item info */
439                 aci= MEM_callocN(sizeof(tAnimCopybufItem), "AnimCopybufItem");
440                 aci->id= ale->id;
441                 aci->grp= fcu->grp;
442                 aci->rna_path= MEM_dupallocN(fcu->rna_path);
443                 aci->array_index= fcu->array_index;
444                 BLI_addtail(&animcopybuf, aci);
445                 
446                 /* add selected keyframes to buffer */
447                 // 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
448                 for (i=0, bezt=fcu->bezt; i < fcu->totvert; i++, bezt++) {
449                         if (BEZSELECTED(bezt)) {
450                                 /* add to buffer */
451                                 newbuf= MEM_callocN(sizeof(BezTriple)*(aci->totvert+1), "copybuf beztriple");
452                                 
453                                 /* assume that since we are just resizing the array, just copy all existing data across */
454                                 if (aci->bezt)
455                                         memcpy(newbuf, aci->bezt, sizeof(BezTriple)*(aci->totvert));
456                                 
457                                 /* copy current beztriple across too */
458                                 *(newbuf + aci->totvert)= *bezt; 
459                                 
460                                 /* free old array and set the new */
461                                 if (aci->bezt) MEM_freeN(aci->bezt);
462                                 aci->bezt= newbuf;
463                                 aci->totvert++;
464                                 
465                                 /* check if this is the earliest frame encountered so far */
466                                 if (bezt->vec[1][0] < animcopy_firstframe)
467                                         animcopy_firstframe= bezt->vec[1][0];
468                         }
469                 }
470                 
471         }
472         
473         /* check if anything ended up in the buffer */
474         if (ELEM(NULL, animcopybuf.first, animcopybuf.last))
475                 return -1;
476         
477         /* everything went fine */
478         return 0;
479 }
480
481 /* This function pastes data from the keyframes copy/paste buffer */
482 short paste_animedit_keys (bAnimContext *ac, ListBase *anim_data)
483 {
484         bAnimListElem *ale;
485         const Scene *scene= (ac->scene);
486         const float offset = (float)(CFRA - animcopy_firstframe);
487         short no_name= 0;
488         
489         /* check if buffer is empty */
490         if (ELEM(NULL, animcopybuf.first, animcopybuf.last)) {
491                 //error("No data in buffer to paste");
492                 return -1;
493         }
494         /* check if single channel in buffer (disregard names if so)  */
495         if (animcopybuf.first == animcopybuf.last)
496                 no_name= 1;
497         
498         /* from selected channels */
499         for (ale= anim_data->first; ale; ale= ale->next) {
500                 FCurve *fcu = (FCurve *)ale->data;              /* destination F-Curve */
501                 tAnimCopybufItem *aci= NULL;
502                 BezTriple *bezt;
503                 int i;
504                 
505                 /* find buffer item to paste from 
506                  *      - if names don't matter (i.e. only 1 channel in buffer), don't check id/group
507                  *      - if names do matter, only check if id-type is ok for now (group check is not that important)
508                  *      - most importantly, rna-paths should match (array indices are unimportant for now)
509                  */
510                 // TODO: the matching algorithm here is pathetic!
511                 for (aci= animcopybuf.first; aci; aci= aci->next) {
512                         /* check that paths exist */
513                         if (aci->rna_path && fcu->rna_path) {
514                                 if (strcmp(aci->rna_path, fcu->rna_path) == 0) {
515                                         /* should be a match unless there's more than one of these */
516                                         if ((no_name) || (aci->array_index == fcu->array_index)) 
517                                                 break;
518                                 }
519                         }
520                 }
521                 
522                 
523                 /* copy the relevant data from the matching buffer curve */
524                 if (aci) {
525                         /* just start pasting, with the the first keyframe on the current frame, and so on */
526                         for (i=0, bezt=aci->bezt; i < aci->totvert; i++, bezt++) {                                              
527                                 /* temporarily apply offset to src beztriple while copying */
528                                 bezt->vec[0][0] += offset;
529                                 bezt->vec[1][0] += offset;
530                                 bezt->vec[2][0] += offset;
531                                 
532                                 /* insert the keyframe */
533                                 insert_bezt_fcurve(fcu, bezt);
534                                 
535                                 /* un-apply offset from src beztriple after copying */
536                                 bezt->vec[0][0] -= offset;
537                                 bezt->vec[1][0] -= offset;
538                                 bezt->vec[2][0] -= offset;
539                         }
540                         
541                         /* recalculate F-Curve's handles? */
542                         calchandles_fcurve(fcu);
543                 }
544         }
545         
546         return 0;
547 }
548
549 /* **************************************************** */