destruction of previous slot api. if it returns, it'll
[blender.git] / source / blender / blenkernel / intern / anim_sys.c
1 /* Testing code for new animation system in 2.5 
2  * Copyright 2009, Joshua Leung
3  */
4
5 #include <stdio.h>
6 #include <string.h>
7
8 #include "MEM_guardedalloc.h"
9
10 #include "BLI_blenlib.h"
11 #include "BLI_arithb.h"
12 #include "BLI_dynstr.h"
13
14 #include "BKE_animsys.h"
15 #include "BKE_action.h"
16 #include "BKE_fcurve.h"
17 #include "BKE_main.h"
18 #include "BKE_utildefines.h"
19
20 #include "RNA_access.h"
21 #include "RNA_types.h"
22
23 #include "DNA_anim_types.h"
24
25 /* ***************************************** */
26 /* AnimData API */
27
28 /* Getter/Setter -------------------------------------------- */
29
30 /* Internal utility to check if ID can have AnimData */
31 static short id_has_animdata (ID *id)
32 {
33         /* sanity check */
34         if (id == NULL)
35                 return 0;
36                 
37         /* Only some ID-blocks have this info for now */
38         // TODO: finish adding this for the other blocktypes
39         switch (GS(id->name)) {
40                         /* has AnimData */
41                 case ID_OB:
42                 case ID_CU:
43                 case ID_KE:
44                 case ID_MA: case ID_TE: case ID_NT:
45                 case ID_LA: case ID_CA: case ID_WO:
46                 case ID_SCE:
47                 {
48                         return 1;
49                 }
50                 
51                         /* no AnimData */
52                 default:
53                         return 0;
54         }
55 }
56
57
58 /* Get AnimData from the given ID-block. In order for this to work, we assume that 
59  * the AnimData pointer is stored immediately after the given ID-block in the struct,
60  * as per IdAdtTemplate.
61  */
62 AnimData *BKE_animdata_from_id (ID *id)
63 {
64         /* only some ID-blocks have this info for now, so we cast the 
65          * types that do to be of type IdAdtTemplate, and extract the
66          * AnimData that way
67          */
68         if (id_has_animdata(id)) {
69                 IdAdtTemplate *iat= (IdAdtTemplate *)id;
70                 return iat->adt;
71         }
72         else
73                 return NULL;
74 }
75
76 /* Add AnimData to the given ID-block. In order for this to work, we assume that 
77  * the AnimData pointer is stored immediately after the given ID-block in the struct,
78  * as per IdAdtTemplate. Also note that 
79  */
80 AnimData *BKE_id_add_animdata (ID *id)
81 {
82         /* Only some ID-blocks have this info for now, so we cast the 
83          * types that do to be of type IdAdtTemplate, and add the AnimData
84          * to it using the template
85          */
86         if (id_has_animdata(id)) {
87                 IdAdtTemplate *iat= (IdAdtTemplate *)id;
88                 
89                 iat->adt= MEM_callocN(sizeof(AnimData), "AnimData");
90                 return iat->adt;
91         }
92         else 
93                 return NULL;
94 }
95
96 /* Freeing -------------------------------------------- */
97
98 /* Free AnimData used by the nominated ID-block, and clear ID-block's AnimData pointer */
99 void BKE_free_animdata (ID *id)
100 {
101         /* Only some ID-blocks have this info for now, so we cast the 
102          * types that do to be of type IdAdtTemplate
103          */
104         if (id_has_animdata(id)) {
105                 IdAdtTemplate *iat= (IdAdtTemplate *)id;
106                 AnimData *adt= iat->adt;
107                 
108                 /* check if there's any AnimData to start with */
109                 if (adt) {
110                         /* unlink action (don't free, as it's in its own list) */
111                         if (adt->action)
112                                 adt->action->id.us--;
113                                 
114                         /* free drivers - stored as a list of F-Curves */
115                         free_fcurves(&adt->drivers);
116                         
117                         /* free overrides */
118                         // TODO...
119                         
120                         /* free animdata now */
121                         MEM_freeN(adt);
122                         iat->adt= NULL;
123                 }
124         }
125 }
126
127 /* Freeing -------------------------------------------- */
128
129 /* Make a copy of the given AnimData - to be used when copying datablocks */
130 AnimData *BKE_copy_animdata (AnimData *adt)
131 {
132         AnimData *dadt;
133         
134         /* sanity check before duplicating struct */
135         if (adt == NULL)
136                 return NULL;
137         dadt= MEM_dupallocN(adt);
138         
139         /* make a copy of action - at worst, user has to delete copies... */
140         // XXX review this... it might not be optimal behaviour yet...
141         //id_us_plus((ID *)dadt->action);
142         dadt->action= copy_action(adt->action);
143         
144         /* duplicate NLA data */
145         // XXX todo...
146         
147         /* duplicate drivers (F-Curves) */
148         copy_fcurves(&dadt->drivers, &adt->drivers);
149         
150         /* don't copy overrides */
151         dadt->overrides.first= dadt->overrides.last= NULL;
152         
153         /* return */
154         return dadt;
155 }
156
157
158 /* ***************************************** */
159 /* Evaluation Data-Setting Backend */
160
161 /* Retrieve string to act as RNA-path, adjusted using mapping-table if provided 
162  * It returns whether the string needs to be freed (i.e. if it was a temp remapped one)
163  * // FIXME: maybe it would be faster if we didn't have to alloc/free strings like this all the time, but for now it's safer
164  *
165  *      - remap: remapping table to use
166  *      - path: original path string (as stored in F-Curve data)
167  *      - dst: destination string to write data to
168  */
169 short animsys_remap_path (AnimMapper *remap, char *path, char **dst)
170 {
171         /* is there a valid remapping table to use? */
172         if (remap) {
173                 /* find a matching entry... to use to remap */
174                 // ...TODO...
175         }
176         
177         /* nothing suitable found, so just set dst to look at path (i.e. no alloc/free needed) */
178         *dst= path;
179         return 0;
180 }
181
182
183 /* Write the given value to a setting using RNA */
184 static void animsys_write_rna_setting (PointerRNA *ptr, char *path, int array_index, float value)
185 {
186         PropertyRNA *prop;
187         PointerRNA new_ptr;
188         
189         /* get property to write to */
190         if (RNA_path_resolve(ptr, path, &new_ptr, &prop)) 
191         {
192                 /* set value - only for animatable numerical values */
193                 if (RNA_property_animateable(&new_ptr, prop)) 
194                 {
195                         switch (RNA_property_type(&new_ptr, prop)) 
196                         {
197                                 case PROP_BOOLEAN:
198                                         if (RNA_property_array_length(&new_ptr, prop))
199                                                 RNA_property_boolean_set_array(&new_ptr, prop, array_index, (int)value);
200                                         else
201                                                 RNA_property_boolean_set(&new_ptr, prop, (int)value);
202                                         break;
203                                 case PROP_INT:
204                                         if (RNA_property_array_length(&new_ptr, prop))
205                                                 RNA_property_int_set_array(&new_ptr, prop, array_index, (int)value);
206                                         else
207                                                 RNA_property_int_set(&new_ptr, prop, (int)value);
208                                         break;
209                                 case PROP_FLOAT:
210                                         if (RNA_property_array_length(&new_ptr, prop))
211                                                 RNA_property_float_set_array(&new_ptr, prop, array_index, value);
212                                         else
213                                                 RNA_property_float_set(&new_ptr, prop, value);
214                                         break;
215                                 case PROP_ENUM:
216                                         RNA_property_enum_set(&new_ptr, prop, (int)value);
217                                         break;
218                                 default:
219                                         break;
220                         }
221                 }
222         }
223 }
224
225 /* Simple replacement based data-setting of the FCurve using RNA */
226 static void animsys_execute_fcurve (PointerRNA *ptr, AnimMapper *remap, FCurve *fcu)
227 {
228         char *path = NULL;
229         short free_path=0;
230         
231         /* get path, remapped as appropriate to work in its new environment */
232         free_path= animsys_remap_path(remap, fcu->rna_path, &path);
233         
234         /* write value to setting */
235         animsys_write_rna_setting(ptr, path, fcu->array_index, fcu->curval);
236         
237         /* free temp path-info */
238         if (free_path)
239                 MEM_freeN(path);
240 }
241
242 /* Evaluate all the F-Curves in the given list 
243  * This performs a set of standard checks. If extra checks are required, separate code should be used
244  */
245 static void animsys_evaluate_fcurves (PointerRNA *ptr, ListBase *list, AnimMapper *remap, float ctime)
246 {
247         FCurve *fcu;
248         
249         /* calculate then execute each curve */
250         for (fcu= list->first; fcu; fcu= fcu->next) 
251         {
252                 /* check if this curve should be skipped */
253                 if ((fcu->flag & (FCURVE_MUTED|FCURVE_DISABLED)) == 0) 
254                 {
255                         calculate_fcurve(fcu, ctime);
256                         animsys_execute_fcurve(ptr, remap, fcu); 
257                 }
258         }
259 }
260
261 /* ***************************************** */
262 /* Driver Evaluation */
263
264 /* Evaluate Drivers */
265 static void animsys_evaluate_drivers (PointerRNA *ptr, AnimData *adt, float ctime)
266 {
267         FCurve *fcu;
268         
269         /* drivers are stored as F-Curves, but we cannot use the standard code, as we need to check if
270          * the depsgraph requested that this driver be evaluated...
271          */
272         for (fcu= adt->drivers.first; fcu; fcu= fcu->next) 
273         {
274                 ChannelDriver *driver= fcu->driver;
275                 
276                 /* check if this driver's curve should be skipped */
277                 // FIXME: maybe we shouldn't check for muted, though that would make things more confusing, as there's already too many ways to disable?
278                 if ((fcu->flag & (FCURVE_MUTED|FCURVE_DISABLED)) == 0) 
279                 {
280                         /* check if driver itself is tagged for recalculation */
281                         if ((driver) && (driver->flag & DRIVER_FLAG_RECALC)) {
282                                 /* evaluate this using values set already in other places */
283                                 // NOTE: for 'layering' option later on, we should check if we should remove old value before adding new to only be done when drivers only changed
284                                 calculate_fcurve(fcu, ctime);
285                                 animsys_execute_fcurve(ptr, NULL, fcu);
286                                 
287                                 /* clear recalc flag */
288                                 driver->flag &= ~DRIVER_FLAG_RECALC;
289                         }
290                 }
291         }
292 }
293
294 /* ***************************************** */
295 /* Actions Evaluation */
296
297 /* Evaluate Action (F-Curve Bag) */
298 static void animsys_evaluate_action (PointerRNA *ptr, bAction *act, AnimMapper *remap, float ctime)
299 {
300         /* check if mapper is appropriate for use here (we set to NULL if it's inappropriate) */
301         if (act == NULL) return;
302         if ((remap) && (remap->target != act)) remap= NULL;
303         
304         /* calculate then execute each curve */
305         animsys_evaluate_fcurves(ptr, &act->curves, remap, ctime);
306 }
307
308 /* ***************************************** */
309 /* NLA System - Evaluation */
310
311 /* used for list of strips to accumulate at current time */
312 typedef struct NlaEvalStrip {
313         struct NlaEvalStrip *next, *prev;
314         
315         NlaTrack *track;                        /* track that this strip belongs to */
316         NlaStrip *strip;                /* strip that's being used */
317         NlaStrip *sblend;               /* strip that's being blended towards (if applicable) */
318         
319         short track_index;                      /* the index of the track within the list */
320         short strip_mode;                       /* which end of the strip are we looking at */
321 } NlaEvalStrip;
322
323 /* bNlaEvalStrip->strip_mode */
324 enum {
325         NES_TIME_BEFORE = -1,
326         NES_TIME_WITHIN,
327         NES_TIME_AFTER,
328         NES_TIME_AFTER_BLEND
329 } eNlaEvalStrip_StripMode;
330
331
332 /* temp channel for accumulating data from NLA (avoids needing to clear all values first) */
333 // TODO: maybe this will be used as the 'cache' stuff needed for editable values too?
334 typedef struct NlaEvalChannel {
335         struct NlaEvalChannel *next, *prev;
336         
337         char *path;                             /* ready-to-use path (i.e. remapped already) */
338         int array_index;                /* if applicable... */
339         
340         float value;                    /* value of this channel */
341 } NlaEvalChannel;
342
343
344 /* ---------------------- */
345
346 /* evaluate the F-Curves controlling settings for the NLA-strips (currently, not relinkable) */
347 static void nlastrip_evaluate_fcurves (NlaStrip *strip, float ctime)
348 {
349         //PointerRNA actstrip_ptr;
350         //FCurve *fcu;
351         
352         /* create RNA-pointer needed to set values */
353         //RNA_pointer_create(NULL, &RNA_NlaStrip, strip, &actstrip_ptr);
354         
355         /* execute these settings as per normal */
356         //animsys_evaluate_fcurves(&actstrip_ptr, &strip->fcurves, NULL, ctime);
357 }
358
359
360 /* gets the strip active at the current time for a track */
361 static void nlatrack_ctime_get_strip (ListBase *list, NlaTrack *nlt, short index, float ctime)
362 {
363         NlaStrip *strip, *astrip=NULL, *bstrip=NULL;
364         NlaEvalStrip *nes;
365         short side= 0;
366         
367         /* skip if track is muted */
368         if (nlt->flag & NLATRACK_MUTED) 
369                 return;
370         
371         /* loop over strips, checking if they fall within the range */
372         for (strip= nlt->strips.first; strip; strip= strip->next) {
373                 /* only consider if:
374                  *      - current time occurs within strip's extents
375                  *      - current time occurs before strip (if it is the first)
376                  *      - current time occurs after strip (if hold is on)
377                  *      - current time occurs between strips (1st of those isn't holding) - blend!
378                  */
379                 if (IN_RANGE(ctime, strip->start, strip->end)) {
380                         astrip= strip;
381                         side= NES_TIME_WITHIN;
382                         break;
383                 }
384                 else if (ctime < strip->start) {
385                         if (strip == nlt->strips.first) {
386                                 astrip= strip;
387                                 side= NES_TIME_BEFORE;
388                                 break;
389                         }
390                         else {
391                                 astrip= strip->prev;
392                                 
393                                 if (astrip->flag & NLASTRIP_HOLDLASTFRAME) {
394                                         side= NES_TIME_AFTER;
395                                         break;
396                                 }
397                                 else {
398                                         bstrip= strip;
399                                         side= NES_TIME_AFTER_BLEND;
400                                         break;
401                                 }
402                         }
403                 }
404         }
405         
406         /* check if strip has been found (and whether it has data worth considering) */
407         if (ELEM(NULL, astrip, astrip->act)) 
408                 return;
409         if (astrip->flag & NLASTRIP_MUTE) 
410                 return;
411         
412         /* check if blending between strips */
413         if (side == NES_TIME_AFTER_BLEND) {
414                 /* blending between strips... so calculate influence+act_time of both */
415                 nlastrip_evaluate_fcurves(astrip, ctime);
416                 nlastrip_evaluate_fcurves(bstrip, ctime);
417                 
418                 if ((astrip->influence <= 0.0f) && (bstrip->influence <= 0.0f))
419                         return;
420         }
421         else {
422                 /* calculate/set the influence+act_time of this strip - don't consider if 0 influence */
423                 nlastrip_evaluate_fcurves(astrip, ctime);
424                 
425                 if (astrip->influence <= 0.0f) 
426                         return;
427         }
428         
429         
430         /* allocate new eval-strip for this strip + add to stack */
431         nes= MEM_callocN(sizeof(NlaEvalStrip), "bNlaEvalStrip");
432         
433         nes->track= nlt;
434         nes->strip= astrip;
435         nes->sblend= bstrip;
436         nes->track_index= index;
437         nes->strip_mode= side;
438         
439         BLI_addtail(list, nes);
440 }
441
442 /* ---------------------- */
443
444 /* evaluates the given evaluation strip */
445 // FIXME: will we need the evaluation cache table set up to blend stuff in?
446 // TODO: only evaluate here, but flush in one go using the accumulated channels at end...
447 static void nlastrip_ctime_evaluate (ListBase *channels, NlaEvalStrip *nes, float ctime)
448 {
449         // 1. (in old code) was to extract 'IPO-channels' from actions
450         // 2. blend between the 'accumulated' data, and the new data
451 }
452
453 /* write the accumulated settings to */
454 static void nladata_flush_channels (PointerRNA *ptr, ListBase *channels)
455 {
456
457 }
458
459 /* ---------------------- */
460
461 /* NLA Evaluation function (mostly for use through do_animdata) 
462  *      - All channels that will be affected are not cleared anymore. Instead, we just evaluate into 
463  *              some temp channels, where values can be accumulated in one go.
464  */
465 static void animsys_evaluate_nla (PointerRNA *ptr, AnimData *adt, float ctime)
466 {
467         NlaTrack *nlt;
468         short track_index=0;
469         
470         ListBase estrips= {NULL, NULL};
471         ListBase echannels= {NULL, NULL};
472         NlaEvalStrip *nes;
473         
474         /* 1. get the stack of strips to evaluate at current time (influence calculated here) */
475         for (nlt=adt->nla_tracks.first; nlt; nlt=nlt->next, track_index++) 
476                 nlatrack_ctime_get_strip(&estrips, nlt, track_index, ctime);
477         
478         /* only continue if there are strips to evaluate */
479         if (estrips.first == NULL)
480                 return;
481         
482         
483         /* 2. for each strip, evaluate then accumulate on top of existing channels, but don't set values yet */
484         for (nes= estrips.first; nes; nes= nes->next) 
485                 nlastrip_ctime_evaluate(&echannels, nes, ctime);
486         
487         /* 3. flush effects of accumulating channels in NLA to the actual data they affect */
488         nladata_flush_channels(ptr, &echannels);
489         
490         /* 4. free temporary evaluation data */
491         BLI_freelistN(&estrips);
492         BLI_freelistN(&echannels);
493 }
494
495 /* ***************************************** */ 
496 /* Overrides System - Public API */
497
498 /* Clear all overides */
499
500 /* Add or get existing Override for given setting */
501 AnimOverride *BKE_animsys_validate_override (PointerRNA *ptr, char *path, int array_index)
502 {
503         // FIXME: need to define how to get overrides
504         return NULL;
505
506
507 /* -------------------- */
508
509 /* Evaluate Overrides */
510 static void animsys_evaluate_overrides (PointerRNA *ptr, AnimData *adt, float ctime)
511 {
512         AnimOverride *aor;
513         
514         /* for each override, simply execute... */
515         for (aor= adt->overrides.first; aor; aor= aor->next)
516                 animsys_write_rna_setting(ptr, aor->rna_path, aor->array_index, aor->value);
517 }
518
519 /* ***************************************** */
520 /* Evaluation System - Public API */
521
522 /* Overview of how this system works:
523  *      1) Depsgraph sorts data as necessary, so that data is in an order that means 
524  *              that all dependences are resolved before dependants.
525  *      2) All normal animation is evaluated, so that drivers have some basis values to
526  *              work with
527  *              a.      NLA stacks are done first, as the Active Actions act as 'tweaking' tracks
528  *                      which modify the effects of the NLA-stacks
529  *              b.      Active Action is evaluated as per normal, on top of the results of the NLA tracks
530  *
531  * --------------< often in a separate phase... >------------------ 
532  *
533  *      3) Drivers/expressions are evaluated on top of this, in an order where dependences are
534  *              resolved nicely. 
535  *         Note: it may be necessary to have some tools to handle the cases where some higher-level
536  *              drivers are added and cause some problematic dependencies that didn't exist in the local levels...
537  *
538  * --------------< always executed >------------------ 
539  *
540  * Maintainance of editability of settings (XXX):
541  *      In order to ensure that settings that are animated can still be manipulated in the UI without requiring
542  *      that keyframes are added to prevent these values from being overwritten, we use 'overrides'. 
543  *
544  * Unresolved things:
545  *      - Handling of multi-user settings (i.e. time-offset, group-instancing) -> big cache grids or nodal system? but stored where?
546  *      - Multiple-block dependencies (i.e. drivers for settings are in both local and higher levels) -> split into separate lists?  
547  */
548
549 /* Evaluation loop for evaluation animation data 
550  *
551  * This assumes that the animation-data provided belongs to the ID block in question,
552  * and that the flags for which parts of the anim-data settings need to be recalculated 
553  * have been set already by the depsgraph. Now, we use the recalc 
554  */
555 void BKE_animsys_evaluate_animdata (ID *id, AnimData *adt, float ctime, short recalc)
556 {
557         PointerRNA id_ptr;
558         
559         /* sanity checks */
560         if ELEM(NULL, id, adt)
561                 return;
562         
563         /* get pointer to ID-block for RNA to use */
564         RNA_id_pointer_create(id, &id_ptr);
565         
566         /* recalculate keyframe data:
567          *      - NLA before Active Action, as Active Action behaves as 'tweaking track'
568          *        that overrides 'rough' work in NLA
569          */
570         if ((recalc & ADT_RECALC_ANIM) /*|| (adt->recalc & ADT_RECALC_ANIM)*/) // XXX for now,don't check yet, as depsgraph doesn't know this yet
571         {
572                 /* evaluate NLA data */
573                 if ((adt->nla_tracks.first) && !(adt->flag & ADT_NLA_EVAL_OFF))
574                 {
575                         animsys_evaluate_nla(&id_ptr, adt, ctime);
576                 }
577                 
578                 /* evaluate Action data */
579                 // FIXME: what if the solo track was not tweaking one, then nla-solo should be checked too?
580                 if (adt->action) 
581                         animsys_evaluate_action(&id_ptr, adt->action, adt->remap, ctime);
582         }
583         
584         /* recalculate drivers 
585          *      - Drivers need to be evaluated afterwards, as they can either override 
586          *        or be layered on top of existing animation data.
587          *      - Drivers should be in the appropriate order to be evaluated without problems...
588          */
589         if ((recalc & ADT_RECALC_DRIVERS) && (adt->recalc & ADT_RECALC_DRIVERS))
590         {
591                 animsys_evaluate_drivers(&id_ptr, adt, ctime);
592         }
593         
594         /* always execute 'overrides' 
595          *      - Overrides allow editing, by overwriting the value(s) set from animation-data, with the
596          *        value last set by the user (and not keyframed yet). 
597          *      - Overrides are cleared upon frame change and/or keyframing
598          *      - It is best that we execute this everytime, so that no errors are likely to occur.
599          */
600         animsys_evaluate_overrides(&id_ptr, adt, ctime);
601         
602         /* clear recalc flag now */
603         adt->recalc= 0;
604 }
605
606 /* Evaluation of all ID-blocks with Animation Data blocks - Animation Data Only
607  *
608  * This will evaluate only the animation info available in the animation data-blocks
609  * encountered. In order to enforce the system by which some settings controlled by a
610  * 'local' (i.e. belonging in the nearest ID-block that setting is related to, not a
611  * standard 'root') block are overridden by a larger 'user'
612  */
613 // TODO: we currently go over entire 'main' database...
614 void BKE_animsys_evaluate_all_animation (Main *main, float ctime)
615 {
616         ID *id;
617         
618         //printf("Evaluate all animation - %f \n", ctime);
619
620         /* macro for less typing */
621 #define EVAL_ANIM_IDS(first) \
622         for (id= first; id; id= id->next) { \
623                 AnimData *adt= BKE_animdata_from_id(id); \
624                 BKE_animsys_evaluate_animdata(id, adt, ctime, ADT_RECALC_ANIM); \
625         }
626         
627         /* nodes */
628         // TODO...
629         
630         /* textures */
631         EVAL_ANIM_IDS(main->tex.first);
632         
633         /* lamps */
634         EVAL_ANIM_IDS(main->lamp.first);
635         
636         /* materials */
637         EVAL_ANIM_IDS(main->mat.first);
638         
639         /* cameras */
640         EVAL_ANIM_IDS(main->camera.first);
641         
642         /* shapekeys */
643         // TODO...
644         
645         /* curves */
646         // TODO...
647         
648         /* meshes */
649         // TODO...
650         
651         /* objects */
652         EVAL_ANIM_IDS(main->object.first);
653         
654         /* worlds */
655         EVAL_ANIM_IDS(main->world.first);
656         
657         /* scenes */
658         EVAL_ANIM_IDS(main->scene.first);
659 }
660
661 /* ***************************************** */