commit before doing some hefty shapekey change, will break compilation
[blender-staging.git] / source / blender / blenkernel / intern / anim_sys.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) 2009 Blender Foundation, Joshua Leung
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): Joshua Leung (full recode)
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 #include <stdio.h>
31 #include <string.h>
32 #include <stddef.h>
33 #include <float.h>
34 #include <math.h>
35
36 #include "MEM_guardedalloc.h"
37
38 #include "BLI_blenlib.h"
39 #include "BLI_arithb.h"
40 #include "BLI_dynstr.h"
41
42 #include "DNA_anim_types.h"
43 #include "DNA_scene_types.h"
44
45 #include "BKE_animsys.h"
46 #include "BKE_action.h"
47 #include "BKE_fcurve.h"
48 #include "BKE_nla.h"
49 #include "BKE_global.h"
50 #include "BKE_main.h"
51 #include "BKE_utildefines.h"
52
53 #include "RNA_access.h"
54 #include "RNA_types.h"
55
56 #include "nla_private.h"
57
58 /* ***************************************** */
59 /* AnimData API */
60
61 /* Getter/Setter -------------------------------------------- */
62
63 /* Internal utility to check if ID can have AnimData */
64 static short id_has_animdata (ID *id)
65 {
66         /* sanity check */
67         if (id == NULL)
68                 return 0;
69                 
70         /* Only some ID-blocks have this info for now */
71         // TODO: finish adding this for the other blocktypes
72         switch (GS(id->name)) {
73                         /* has AnimData */
74                 case ID_OB:
75                 case ID_MB: case ID_CU: case ID_AR:
76                 case ID_KE:
77                 case ID_PA:
78                 case ID_MA: case ID_TE: case ID_NT:
79                 case ID_LA: case ID_CA: case ID_WO:
80                 case ID_SCE:
81                 {
82                         return 1;
83                 }
84                 
85                         /* no AnimData */
86                 default:
87                         return 0;
88         }
89 }
90
91
92 /* Get AnimData from the given ID-block. In order for this to work, we assume that 
93  * the AnimData pointer is stored immediately after the given ID-block in the struct,
94  * as per IdAdtTemplate.
95  */
96 AnimData *BKE_animdata_from_id (ID *id)
97 {
98         /* only some ID-blocks have this info for now, so we cast the 
99          * types that do to be of type IdAdtTemplate, and extract the
100          * AnimData that way
101          */
102         if (id_has_animdata(id)) {
103                 IdAdtTemplate *iat= (IdAdtTemplate *)id;
104                 return iat->adt;
105         }
106         else
107                 return NULL;
108 }
109
110 /* Add AnimData to the given ID-block. In order for this to work, we assume that 
111  * the AnimData pointer is stored immediately after the given ID-block in the struct,
112  * as per IdAdtTemplate. Also note that 
113  */
114 AnimData *BKE_id_add_animdata (ID *id)
115 {
116         /* Only some ID-blocks have this info for now, so we cast the 
117          * types that do to be of type IdAdtTemplate, and add the AnimData
118          * to it using the template
119          */
120         if (id_has_animdata(id)) {
121                 IdAdtTemplate *iat= (IdAdtTemplate *)id;
122                 
123                 /* check if there's already AnimData, in which case, don't add */
124                 if (iat->adt == NULL) {
125                         AnimData *adt;
126                         
127                         /* add animdata */
128                         adt= iat->adt= MEM_callocN(sizeof(AnimData), "AnimData");
129                         
130                         /* set default settings */
131                         adt->act_influence= 1.0f;
132                 }
133                 
134                 return iat->adt;
135         }
136         else 
137                 return NULL;
138 }
139
140 /* Freeing -------------------------------------------- */
141
142 /* Free AnimData used by the nominated ID-block, and clear ID-block's AnimData pointer */
143 void BKE_free_animdata (ID *id)
144 {
145         /* Only some ID-blocks have this info for now, so we cast the 
146          * types that do to be of type IdAdtTemplate
147          */
148         if (id_has_animdata(id)) {
149                 IdAdtTemplate *iat= (IdAdtTemplate *)id;
150                 AnimData *adt= iat->adt;
151                 
152                 /* check if there's any AnimData to start with */
153                 if (adt) {
154                         /* unlink action (don't free, as it's in its own list) */
155                         if (adt->action)
156                                 adt->action->id.us--;
157                         /* same goes for the temporarily displaced action */
158                         if (adt->tmpact)
159                                 adt->tmpact->id.us--;
160                                 
161                         /* free nla data */
162                         free_nladata(&adt->nla_tracks);
163                         
164                         /* free drivers - stored as a list of F-Curves */
165                         free_fcurves(&adt->drivers);
166                         
167                         /* free overrides */
168                         // TODO...
169                         
170                         /* free animdata now */
171                         MEM_freeN(adt);
172                         iat->adt= NULL;
173                 }
174         }
175 }
176
177 /* Freeing -------------------------------------------- */
178
179 /* Make a copy of the given AnimData - to be used when copying datablocks */
180 AnimData *BKE_copy_animdata (AnimData *adt)
181 {
182         AnimData *dadt;
183         
184         /* sanity check before duplicating struct */
185         if (adt == NULL)
186                 return NULL;
187         dadt= MEM_dupallocN(adt);
188         
189         /* make a copy of action - at worst, user has to delete copies... */
190         dadt->action= copy_action(adt->action);
191         dadt->tmpact= copy_action(adt->tmpact);
192         
193         /* duplicate NLA data */
194         copy_nladata(&dadt->nla_tracks, &adt->nla_tracks);
195         
196         /* duplicate drivers (F-Curves) */
197         copy_fcurves(&dadt->drivers, &adt->drivers);
198         
199         /* don't copy overrides */
200         dadt->overrides.first= dadt->overrides.last= NULL;
201         
202         /* return */
203         return dadt;
204 }
205
206 /* Make Local -------------------------------------------- */
207
208 static void make_local_strips(ListBase *strips)
209 {
210         NlaStrip *strip;
211
212         for (strip=strips->first; strip; strip=strip->next) {
213                 if (strip->act) make_local_action(strip->act);
214                 if (strip->remap && strip->remap->target) make_local_action(strip->remap->target);
215                 
216                 make_local_strips(&strip->strips);
217         }
218 }
219
220 /* Use local copy instead of linked copy of various ID-blocks */
221 void BKE_animdata_make_local(AnimData *adt)
222 {
223         NlaTrack *nlt;
224         
225         /* Actions - Active and Temp */
226         if (adt->action) make_local_action(adt->action);
227         if (adt->tmpact) make_local_action(adt->tmpact);
228         /* Remaps */
229         if (adt->remap && adt->remap->target) make_local_action(adt->remap->target);
230         
231         /* Drivers */
232         // TODO: need to remap the ID-targets too?
233         
234         /* NLA Data */
235         for (nlt=adt->nla_tracks.first; nlt; nlt=nlt->next) 
236                 make_local_strips(&nlt->strips);
237 }
238
239 /* Path Validation -------------------------------------------- */
240
241 /* Check if a given RNA Path is valid, by tracing it from the given ID, and seeing if we can resolve it */
242 static short check_rna_path_is_valid (ID *owner_id, char *path)
243 {
244         PointerRNA id_ptr, ptr;
245         PropertyRNA *prop=NULL;
246         
247         /* make initial RNA pointer to start resolving from */
248         RNA_id_pointer_create(owner_id, &id_ptr);
249         
250         /* try to resolve */
251         return RNA_path_resolve(&id_ptr, path, &ptr, &prop); 
252 }
253
254 /* Check if some given RNA Path needs fixing - free the given path and set a new one as appropriate 
255  * NOTE: we assume that oldName and newName have [" "] padding around them
256  */
257 static char *rna_path_rename_fix (ID *owner_id, char *prefix, char *oldName, char *newName, char *oldpath)
258 {
259         char *prefixPtr= strstr(oldpath, prefix);
260         char *oldNamePtr= strstr(oldpath, oldName);
261         int prefixLen= strlen(prefix);
262         int oldNameLen= strlen(oldName);
263         
264         /* only start fixing the path if the prefix and oldName feature in the path,
265          * and prefix occurs immediately before oldName
266          */
267         if ( (prefixPtr && oldNamePtr) && (prefixPtr+prefixLen == oldNamePtr) ) {
268                 /* if we haven't aren't able to resolve the path now, try again after fixing it */
269                 if (check_rna_path_is_valid(owner_id, oldpath) == 0) {          
270                         DynStr *ds= BLI_dynstr_new();
271                         char *postfixPtr= oldNamePtr+oldNameLen;
272                         char *newPath = NULL;
273                         char oldChar;
274                         
275                         /* add the part of the string that goes up to the start of the prefix */
276                         if (prefixPtr > oldpath) {
277                                 oldChar= prefixPtr[0]; 
278                                 prefixPtr[0]= 0;
279                                 BLI_dynstr_append(ds, oldpath);
280                                 prefixPtr[0]= oldChar;
281                         }
282                         
283                         /* add the prefix */
284                         BLI_dynstr_append(ds, prefix);
285                         
286                         /* add the new name (complete with brackets) */
287                         BLI_dynstr_append(ds, newName);
288                         
289                         /* add the postfix */
290                         BLI_dynstr_append(ds, postfixPtr);
291                         
292                         /* create new path, and cleanup old data */
293                         newPath= BLI_dynstr_get_cstring(ds);
294                         BLI_dynstr_free(ds);
295                         
296                         /* check if the new path will solve our problems */
297                         // TODO: will need to check whether this step really helps in practice
298                         if (check_rna_path_is_valid(owner_id, newPath)) {
299                                 /* free the old path, and return the new one, since we've solved the issues */
300                                 MEM_freeN(oldpath);
301                                 return newPath;
302                         }
303                         else {
304                                 /* still couldn't resolve the path... so, might as well just leave it alone */
305                                 MEM_freeN(newPath);
306                         }
307                 }
308         }
309         
310         /* the old path doesn't need to be changed */
311         return oldpath;
312 }
313
314 /* Check RNA-Paths for a list of F-Curves */
315 static void fcurves_path_rename_fix (ID *owner_id, char *prefix, char *oldName, char *newName, ListBase *curves)
316 {
317         FCurve *fcu;
318         
319         /* we need to check every curve... */
320         for (fcu= curves->first; fcu; fcu= fcu->next) {
321                 /* firstly, handle the F-Curve's own path */
322                 fcu->rna_path= rna_path_rename_fix(owner_id, prefix, oldName, newName, fcu->rna_path);
323                 
324                 /* driver? */
325                 if (fcu->driver) {
326                         ChannelDriver *driver= fcu->driver;
327                         DriverTarget *dtar;
328                         
329                         /* driver targets */
330                         for (dtar= driver->targets.first; dtar; dtar=dtar->next) {
331                                 dtar->rna_path= rna_path_rename_fix(dtar->id, prefix, oldName, newName, dtar->rna_path);
332                         }
333                 }
334         }
335 }
336
337 /* Fix all RNA-Paths for Actions linked to NLA Strips */
338 static void nlastrips_path_rename_fix (ID *owner_id, char *prefix, char *oldName, char *newName, ListBase *strips)
339 {
340         NlaStrip *strip;
341         
342         /* recursively check strips, fixing only actions... */
343         for (strip= strips->first; strip; strip= strip->next) {
344                 /* fix strip's action */
345                 if (strip->act)
346                         fcurves_path_rename_fix(owner_id, prefix, oldName, newName, &strip->act->curves);
347                 /* ignore own F-Curves, since those are local...  */
348                 
349                 /* check sub-strips (if metas) */
350                 nlastrips_path_rename_fix(owner_id, prefix, oldName, newName, &strip->strips);
351         }
352 }
353
354 /* Fix all RNA-Paths in the AnimData block used by the given ID block
355  * NOTE: it is assumed that the structure we're replacing is <prefix><["><name><"]>
356  *              i.e. pose.pose_channels["Bone"]
357  */
358 void BKE_animdata_fix_paths_rename (ID *owner_id, AnimData *adt, char *prefix, char *oldName, char *newName)
359 {
360         NlaTrack *nlt;
361         char *oldN, *newN;
362         
363         /* if no AnimData, no need to proceed */
364         if (ELEM4(NULL, owner_id, adt, oldName, newName))
365                 return;
366         
367         /* pad the names with [" "] so that only exact matches are made */
368         oldN= BLI_sprintfN("[\"%s\"]", oldName);
369         newN= BLI_sprintfN("[\"%s\"]", newName);
370         
371         /* Active action and temp action */
372         if (adt->action)
373                 fcurves_path_rename_fix(owner_id, prefix, oldN, newN, &adt->action->curves);
374         if (adt->tmpact)
375                 fcurves_path_rename_fix(owner_id, prefix, oldN, newN, &adt->tmpact->curves);
376                 
377         /* Drivers - Drivers are really F-Curves */
378         fcurves_path_rename_fix(owner_id, prefix, oldN, newN, &adt->drivers);
379         
380         /* NLA Data - Animation Data for Strips */
381         for (nlt= adt->nla_tracks.first; nlt; nlt= nlt->next)
382                 nlastrips_path_rename_fix(owner_id, prefix, oldN, newN, &nlt->strips);
383                 
384         /* free the temp names */
385         MEM_freeN(oldN);
386         MEM_freeN(newN);
387 }
388
389 /* Fix all RNA-Paths throughout the database (directly access the Global.main version)
390  * NOTE: it is assumed that the structure we're replacing is <prefix><["><name><"]>
391  *              i.e. pose.pose_channels["Bone"]
392  */
393 void BKE_all_animdata_fix_paths_rename (char *prefix, char *oldName, char *newName)
394 {
395         Main *mainptr= G.main;
396         ID *id;
397         
398         /* macro for less typing 
399          *      - whether animdata exists is checked for by the main renaming callback, though taking 
400          *        this outside of the function may make things slightly faster?
401          */
402 #define RENAMEFIX_ANIM_IDS(first) \
403         for (id= first; id; id= id->next) { \
404                 AnimData *adt= BKE_animdata_from_id(id); \
405                 BKE_animdata_fix_paths_rename(id, adt, prefix, oldName, newName);\
406         }
407         
408         /* nodes */
409         RENAMEFIX_ANIM_IDS(mainptr->nodetree.first);
410         
411         /* textures */
412         RENAMEFIX_ANIM_IDS(mainptr->tex.first);
413         
414         /* lamps */
415         RENAMEFIX_ANIM_IDS(mainptr->lamp.first);
416         
417         /* materials */
418         RENAMEFIX_ANIM_IDS(mainptr->mat.first);
419         
420         /* cameras */
421         RENAMEFIX_ANIM_IDS(mainptr->camera.first);
422         
423         /* shapekeys */
424         RENAMEFIX_ANIM_IDS(mainptr->key.first);
425         
426         /* metaballs */
427         RENAMEFIX_ANIM_IDS(mainptr->mball.first);
428         
429         /* curves */
430         RENAMEFIX_ANIM_IDS(mainptr->curve.first);
431         
432         /* armatures */
433         RENAMEFIX_ANIM_IDS(mainptr->armature.first);
434         
435         /* meshes */
436         // TODO...
437         
438         /* particles */
439         RENAMEFIX_ANIM_IDS(mainptr->particle.first);
440         
441         /* objects */
442         RENAMEFIX_ANIM_IDS(mainptr->object.first); 
443         
444         /* worlds */
445         RENAMEFIX_ANIM_IDS(mainptr->world.first);
446         
447         /* scenes */
448         for (id= mainptr->scene.first; id; id= id->next) {
449                 AnimData *adt= BKE_animdata_from_id(id);
450                 Scene *scene= (Scene *)id;
451                 
452                 /* do compositing nodes first (since these aren't included in main tree) */
453                 if (scene->nodetree) {
454                         AnimData *adt2= BKE_animdata_from_id((ID *)scene->nodetree);
455                         BKE_animdata_fix_paths_rename((ID *)scene->nodetree, adt2, prefix, oldName, newName);
456                 }
457                 
458                 /* now fix scene animation data as per normal */
459                 BKE_animdata_fix_paths_rename((ID *)id, adt, prefix, oldName, newName);
460         }
461 }
462
463 /* *********************************** */ 
464 /* KeyingSet API */
465
466 /* Finding Tools --------------------------- */
467
468 /* Find the first path that matches the given criteria */
469 // TODO: do we want some method to perform partial matches too?
470 KS_Path *BKE_keyingset_find_destination (KeyingSet *ks, ID *id, const char group_name[], const char rna_path[], int array_index, int group_mode)
471 {
472         KS_Path *ksp;
473         
474         /* sanity checks */
475         if ELEM(NULL, ks, rna_path)
476                 return NULL;
477         
478         /* ID is optional for relative KeyingSets, but is necessary for absolute KeyingSets */
479         if (id == NULL) {
480                 if (ks->flag & KEYINGSET_ABSOLUTE)
481                         return NULL;
482         }
483         
484         /* loop over paths in the current KeyingSet, finding the first one where all settings match 
485          * (i.e. the first one where none of the checks fail and equal 0)
486          */
487         for (ksp= ks->paths.first; ksp; ksp= ksp->next) {
488                 short eq_id=1, eq_path=1, eq_index=1, eq_group=1;
489                 
490                 /* id */
491                 if ((ks->flag & KEYINGSET_ABSOLUTE) && (id != ksp->id))
492                         eq_id= 0;
493                 
494                 /* path */
495                 if ((ksp->rna_path==0) || strcmp(rna_path, ksp->rna_path))
496                         eq_path= 0;
497                         
498                 /* index - need to compare whole-array setting too... */
499                 if (ksp->array_index != array_index)
500                         eq_index= 0;
501                         
502                 /* group */
503                 if (group_name) {
504                         // FIXME: these checks need to be coded... for now, it's not too important though
505                 }
506                         
507                 /* if all aspects are ok, return */
508                 if (eq_id && eq_path && eq_index && eq_group)
509                         return ksp;
510         }
511         
512         /* none found */
513         return NULL;
514 }
515  
516 /* Defining Tools --------------------------- */
517
518 /* Used to create a new 'custom' KeyingSet for the user, that will be automatically added to the stack */
519 KeyingSet *BKE_keyingset_add (ListBase *list, const char name[], short flag, short keyingflag)
520 {
521         KeyingSet *ks;
522         
523         /* allocate new KeyingSet */
524         ks= MEM_callocN(sizeof(KeyingSet), "KeyingSet");
525         
526         if (name)
527                 BLI_snprintf(ks->name, 64, name);
528         else
529                 strcpy(ks->name, "KeyingSet");
530         
531         ks->flag= flag;
532         ks->keyingflag= keyingflag;
533         
534         /* add KeyingSet to list */
535         BLI_addtail(list, ks);
536         
537         /* make sure KeyingSet has a unique name (this helps with identification) */
538         BLI_uniquename(list, ks, "KeyingSet", '.', offsetof(KeyingSet, name), 64);
539         
540         /* return new KeyingSet for further editing */
541         return ks;
542 }
543
544 /* Add a destination to a KeyingSet. Nothing is returned for now...
545  * Checks are performed to ensure that destination is appropriate for the KeyingSet in question
546  */
547 void BKE_keyingset_add_destination (KeyingSet *ks, ID *id, const char group_name[], const char rna_path[], int array_index, short flag, short groupmode)
548 {
549         KS_Path *ksp;
550         
551         /* sanity checks */
552         if ELEM(NULL, ks, rna_path) {
553                 printf("ERROR: no Keying Set and/or RNA Path to add destination with \n");
554                 return;
555         }
556         
557         /* ID is optional for relative KeyingSets, but is necessary for absolute KeyingSets */
558         if (id == NULL) {
559                 if (ks->flag & KEYINGSET_ABSOLUTE) {
560                         printf("ERROR: No ID provided for absolute destination. \n");
561                         return;
562                 }
563         }
564         
565         /* don't add if there is already a matching KS_Path in the KeyingSet */
566         if (BKE_keyingset_find_destination(ks, id, group_name, rna_path, array_index, groupmode)) {
567                 if (G.f & G_DEBUG)
568                         printf("ERROR: destination already exists in Keying Set \n");
569                 return;
570         }
571         
572         /* allocate a new KeyingSet Path */
573         ksp= MEM_callocN(sizeof(KS_Path), "KeyingSet Path");
574         
575         /* just store absolute info */
576         if (ks->flag & KEYINGSET_ABSOLUTE) {
577                 ksp->id= id;
578                 if (group_name)
579                         BLI_snprintf(ksp->group, 64, group_name);
580                 else
581                         strcpy(ksp->group, "");
582         }
583         
584         /* store additional info for relative paths (just in case user makes the set relative) */
585         if (id)
586                 ksp->idtype= GS(id->name);
587         
588         /* just copy path info */
589         // XXX no checks are performed for templates yet
590         // should array index be checked too?
591         ksp->rna_path= BLI_strdupn(rna_path, strlen(rna_path));
592         ksp->array_index= array_index;
593         
594         /* store flags */
595         ksp->flag= flag;
596         ksp->groupmode= groupmode;
597         
598         /* add KeyingSet path to KeyingSet */
599         BLI_addtail(&ks->paths, ksp);
600 }       
601
602 /* Copy all KeyingSets in the given list */
603 void BKE_keyingsets_copy(ListBase *newlist, ListBase *list)
604 {
605         KeyingSet *ksn;
606         KS_Path *kspn;
607
608         BLI_duplicatelist(newlist, list);
609
610         for(ksn=newlist->first; ksn; ksn=ksn->next) {
611                 BLI_duplicatelist(&ksn->paths, &ksn->paths);
612
613                 for(kspn=ksn->paths.first; kspn; kspn=kspn->next)
614                         kspn->rna_path= MEM_dupallocN(kspn->rna_path);
615         }
616 }
617
618 /* Freeing Tools --------------------------- */
619
620 /* Free data for KeyingSet but not set itself */
621 void BKE_keyingset_free (KeyingSet *ks)
622 {
623         KS_Path *ksp, *kspn;
624         
625         /* sanity check */
626         if (ks == NULL)
627                 return;
628         
629         /* free each path as we go to avoid looping twice */
630         for (ksp= ks->paths.first; ksp; ksp= kspn) {
631                 kspn= ksp->next;
632                 
633                 /* free RNA-path info */
634                 MEM_freeN(ksp->rna_path);
635                 
636                 /* free path itself */
637                 BLI_freelinkN(&ks->paths, ksp);
638         }
639 }
640
641 /* Free all the KeyingSets in the given list */
642 void BKE_keyingsets_free (ListBase *list)
643 {
644         KeyingSet *ks, *ksn;
645         
646         /* sanity check */
647         if (list == NULL)
648                 return;
649         
650         /* loop over KeyingSets freeing them 
651          *      - BKE_keyingset_free() doesn't free the set itself, but it frees its sub-data
652          */
653         for (ks= list->first; ks; ks= ksn) {
654                 ksn= ks->next;
655                 BKE_keyingset_free(ks);
656                 BLI_freelinkN(list, ks);
657         }
658 }
659
660 /* ***************************************** */
661 /* Evaluation Data-Setting Backend */
662
663 /* Retrieve string to act as RNA-path, adjusted using mapping-table if provided 
664  * It returns whether the string needs to be freed (i.e. if it was a temp remapped one)
665  * // 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
666  *
667  *      - remap: remapping table to use
668  *      - path: original path string (as stored in F-Curve data)
669  *      - dst: destination string to write data to
670  */
671 static short animsys_remap_path (AnimMapper *remap, char *path, char **dst)
672 {
673         /* is there a valid remapping table to use? */
674         //if (remap) {
675                 /* find a matching entry... to use to remap */
676                 // ...TODO...
677         //}
678         
679         /* nothing suitable found, so just set dst to look at path (i.e. no alloc/free needed) */
680         *dst= path;
681         return 0;
682 }
683
684
685 /* Write the given value to a setting using RNA, and return success */
686 static short animsys_write_rna_setting (PointerRNA *ptr, char *path, int array_index, float value)
687 {
688         PropertyRNA *prop;
689         PointerRNA new_ptr;
690         
691         /* get property to write to */
692         if (RNA_path_resolve(ptr, path, &new_ptr, &prop)) 
693         {
694                 /* set value - only for animatable numerical values */
695                 if (RNA_property_animateable(&new_ptr, prop)) 
696                 {
697                         switch (RNA_property_type(prop)) 
698                         {
699                                 case PROP_BOOLEAN:
700                                         if (RNA_property_array_length(&new_ptr, prop))
701                                                 RNA_property_boolean_set_index(&new_ptr, prop, array_index, (int)value);
702                                         else
703                                                 RNA_property_boolean_set(&new_ptr, prop, (int)value);
704                                         break;
705                                 case PROP_INT:
706                                         if (RNA_property_array_length(&new_ptr, prop))
707                                                 RNA_property_int_set_index(&new_ptr, prop, array_index, (int)value);
708                                         else
709                                                 RNA_property_int_set(&new_ptr, prop, (int)value);
710                                         break;
711                                 case PROP_FLOAT:
712                                         if (RNA_property_array_length(&new_ptr, prop))
713                                                 RNA_property_float_set_index(&new_ptr, prop, array_index, value);
714                                         else
715                                                 RNA_property_float_set(&new_ptr, prop, value);
716                                         break;
717                                 case PROP_ENUM:
718                                         RNA_property_enum_set(&new_ptr, prop, (int)value);
719                                         break;
720                                 default:
721                                         /* nothing can be done here... so it is unsuccessful? */
722                                         return 0;
723                         }
724                 }
725                 
726                 /* successful */
727                 return 1;
728         }
729         else {
730                 /* failed to get path */
731                 // XXX don't tag as failed yet though, as there are some legit situations (Action Constraint) 
732                 // where some channels will not exist, but shouldn't lock up Action
733                 if (G.f & G_DEBUG) {
734                         printf("Animato: Invalid path. ID = '%s',  '%s [%d]' \n", 
735                                 (ptr && ptr->id.data) ? (((ID *)ptr->id.data)->name+2) : "<No ID>", 
736                                 path, array_index);
737                 }
738                 return 0;
739         }
740 }
741
742 /* Simple replacement based data-setting of the FCurve using RNA */
743 static short animsys_execute_fcurve (PointerRNA *ptr, AnimMapper *remap, FCurve *fcu)
744 {
745         char *path = NULL;
746         short free_path=0;
747         short ok= 0;
748         
749         /* get path, remapped as appropriate to work in its new environment */
750         free_path= animsys_remap_path(remap, fcu->rna_path, &path);
751         
752         /* write value to setting */
753         if (path)
754                 ok= animsys_write_rna_setting(ptr, path, fcu->array_index, fcu->curval);
755         
756         /* free temp path-info */
757         if (free_path)
758                 MEM_freeN(path);
759                 
760         /* return whether we were successful */
761         return ok;
762 }
763
764 /* Evaluate all the F-Curves in the given list 
765  * This performs a set of standard checks. If extra checks are required, separate code should be used
766  */
767 static void animsys_evaluate_fcurves (PointerRNA *ptr, ListBase *list, AnimMapper *remap, float ctime)
768 {
769         FCurve *fcu;
770         
771         /* calculate then execute each curve */
772         for (fcu= list->first; fcu; fcu= fcu->next) 
773         {
774                 /* check if this F-Curve doesn't belong to a muted group */
775                 if ((fcu->grp == NULL) || (fcu->grp->flag & AGRP_MUTED)==0) {
776                         /* check if this curve should be skipped */
777                         if ((fcu->flag & (FCURVE_MUTED|FCURVE_DISABLED)) == 0) 
778                         {
779                                 calculate_fcurve(fcu, ctime);
780                                 animsys_execute_fcurve(ptr, remap, fcu); 
781                         }
782                 }
783         }
784 }
785
786 /* ***************************************** */
787 /* Driver Evaluation */
788
789 /* Evaluate Drivers */
790 static void animsys_evaluate_drivers (PointerRNA *ptr, AnimData *adt, float ctime)
791 {
792         FCurve *fcu;
793         
794         /* drivers are stored as F-Curves, but we cannot use the standard code, as we need to check if
795          * the depsgraph requested that this driver be evaluated...
796          */
797         for (fcu= adt->drivers.first; fcu; fcu= fcu->next) 
798         {
799                 ChannelDriver *driver= fcu->driver;
800                 short ok= 0;
801                 
802                 /* check if this driver's curve should be skipped */
803                 if ((fcu->flag & (FCURVE_MUTED|FCURVE_DISABLED)) == 0) 
804                 {
805                         /* check if driver itself is tagged for recalculation */
806                         if ((driver) && !(driver->flag & DRIVER_FLAG_INVALID)/*&& (driver->flag & DRIVER_FLAG_RECALC)*/) {      // XXX driver recalc flag is not set yet by depsgraph!
807                                 /* evaluate this using values set already in other places */
808                                 // 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
809                                 calculate_fcurve(fcu, ctime);
810                                 ok= animsys_execute_fcurve(ptr, NULL, fcu);
811                                 
812                                 /* clear recalc flag */
813                                 driver->flag &= ~DRIVER_FLAG_RECALC;
814                                 
815                                 /* set error-flag if evaluation failed */
816                                 if (ok == 0)
817                                         driver->flag |= DRIVER_FLAG_INVALID; 
818                         }
819                 }
820         }
821 }
822
823 /* ***************************************** */
824 /* Actions Evaluation */
825
826 /* Evaluate Action Group */
827 void animsys_evaluate_action_group (PointerRNA *ptr, bAction *act, bActionGroup *agrp, AnimMapper *remap, float ctime)
828 {
829         FCurve *fcu;
830         
831         /* check if mapper is appropriate for use here (we set to NULL if it's inappropriate) */
832         if ELEM(NULL, act, agrp) return;
833         if ((remap) && (remap->target != act)) remap= NULL;
834         
835         /* if group is muted, don't evaluated any of the F-Curve */
836         if (agrp->flag & AGRP_MUTED)
837                 return;
838         
839         /* calculate then execute each curve */
840         for (fcu= agrp->channels.first; (fcu) && (fcu->grp == agrp); fcu= fcu->next) 
841         {
842                 /* check if this curve should be skipped */
843                 if ((fcu->flag & (FCURVE_MUTED|FCURVE_DISABLED)) == 0) 
844                 {
845                         calculate_fcurve(fcu, ctime);
846                         animsys_execute_fcurve(ptr, remap, fcu); 
847                 }
848         }
849 }
850
851 /* Evaluate Action (F-Curve Bag) */
852 void animsys_evaluate_action (PointerRNA *ptr, bAction *act, AnimMapper *remap, float ctime)
853 {
854         /* check if mapper is appropriate for use here (we set to NULL if it's inappropriate) */
855         if (act == NULL) return;
856         if ((remap) && (remap->target != act)) remap= NULL;
857         
858         /* calculate then execute each curve */
859         animsys_evaluate_fcurves(ptr, &act->curves, remap, ctime);
860 }
861
862 /* ***************************************** */
863 /* NLA System - Evaluation */
864
865 /* calculate influence of strip based for given frame based on blendin/out values */
866 static float nlastrip_get_influence (NlaStrip *strip, float cframe)
867 {
868         /* sanity checks - normalise the blendin/out values? */
869         strip->blendin= (float)fabs(strip->blendin);
870         strip->blendout= (float)fabs(strip->blendout);
871         
872         /* result depends on where frame is in respect to blendin/out values */
873         if (IS_EQ(strip->blendin, 0)==0 && (cframe <= (strip->start + strip->blendin))) {
874                 /* there is some blend-in */
875                 return (float)fabs(cframe - strip->start) / (strip->blendin);
876         }
877         else if (IS_EQ(strip->blendout, 0)==0 && (cframe >= (strip->end - strip->blendout))) {
878                 /* there is some blend-out */
879                 return (float)fabs(strip->end - cframe) / (strip->blendout);
880         }
881         else {
882                 /* in the middle of the strip, we should be full strength */
883                 return 1.0f;
884         }
885 }
886
887 /* evaluate the evaluation time and influence for the strip, storing the results in the strip */
888 static void nlastrip_evaluate_controls (NlaStrip *strip, float ctime)
889 {
890         /* firstly, analytically generate values for influence and time (if applicable) */
891         if ((strip->flag & NLASTRIP_FLAG_USR_TIME) == 0)
892                 strip->strip_time= nlastrip_get_frame(strip, ctime, NLATIME_CONVERT_EVAL);
893         if ((strip->flag & NLASTRIP_FLAG_USR_INFLUENCE) == 0)
894                 strip->influence= nlastrip_get_influence(strip, ctime);
895         
896         /* now strip's evaluate F-Curves for these settings (if applicable) */
897         if (strip->fcurves.first) {
898                 PointerRNA strip_ptr;
899                 
900                 /* create RNA-pointer needed to set values */
901                 RNA_pointer_create(NULL, &RNA_NlaStrip, strip, &strip_ptr);
902                 
903                 /* execute these settings as per normal */
904                 animsys_evaluate_fcurves(&strip_ptr, &strip->fcurves, NULL, ctime);
905         }
906 }
907
908 /* gets the strip active at the current time for a list of strips for evaluation purposes */
909 NlaEvalStrip *nlastrips_ctime_get_strip (ListBase *list, ListBase *strips, short index, float ctime)
910 {
911         NlaStrip *strip, *estrip=NULL;
912         NlaEvalStrip *nes;
913         short side= 0;
914         
915         /* loop over strips, checking if they fall within the range */
916         for (strip= strips->first; strip; strip= strip->next) {
917                 /* check if current time occurs within this strip  */
918                 if (IN_RANGE_INCL(ctime, strip->start, strip->end)) {
919                         /* this strip is active, so try to use it */
920                         estrip= strip;
921                         side= NES_TIME_WITHIN;
922                         break;
923                 }
924                 
925                 /* if time occurred before current strip... */
926                 if (ctime < strip->start) {
927                         if (strip == strips->first) {
928                                 /* before first strip - only try to use it if it extends backwards in time too */
929                                 if (strip->extendmode == NLASTRIP_EXTEND_HOLD)
930                                         estrip= strip;
931                                         
932                                 /* side is 'before' regardless of whether there's a useful strip */
933                                 side= NES_TIME_BEFORE;
934                         }
935                         else {
936                                 /* before next strip - previous strip has ended, but next hasn't begun, 
937                                  * so blending mode depends on whether strip is being held or not...
938                                  *      - only occurs when no transition strip added, otherwise the transition would have
939                                  *        been picked up above...
940                                  */
941                                 strip= strip->prev;
942                                 
943                                 if (strip->extendmode != NLASTRIP_EXTEND_NOTHING)
944                                         estrip= strip;
945                                 side= NES_TIME_AFTER;
946                         }
947                         break;
948                 }
949                 
950                 /* if time occurred after current strip... */
951                 if (ctime > strip->end) {
952                         /* only if this is the last strip should we do anything, and only if that is being held */
953                         if (strip == strips->last) {
954                                 if (strip->extendmode != NLASTRIP_EXTEND_NOTHING)
955                                         estrip= strip;
956                                         
957                                 side= NES_TIME_AFTER;
958                                 break;
959                         }
960                         
961                         /* otherwise, skip... as the 'before' case will catch it more elegantly! */
962                 }
963         }
964         
965         /* check if a valid strip was found
966          *      - must not be muted (i.e. will have contribution
967          */
968         if ((estrip == NULL) || (estrip->flag & NLASTRIP_FLAG_MUTED)) 
969                 return NULL;
970                 
971         /* if ctime was not within the boundaries of the strip, clamp! */
972         switch (side) {
973                 case NES_TIME_BEFORE: /* extend first frame only */
974                         ctime= estrip->start;
975                         break;
976                 case NES_TIME_AFTER: /* extend last frame only */
977                         ctime= estrip->end;
978                         break;
979         }
980         
981         /* evaluate strip's evaluation controls  
982          *      - skip if no influence (i.e. same effect as muting the strip)
983          *      - negative influence is not supported yet... how would that be defined?
984          */
985         // TODO: this sounds a bit hacky having a few isolated F-Curves stuck on some data it operates on...
986         nlastrip_evaluate_controls(estrip, ctime);
987         if (estrip->influence <= 0.0f)
988                 return NULL;
989                 
990         /* check if strip has valid data to evaluate,
991          * and/or perform any additional type-specific actions
992          */
993         switch (estrip->type) {
994                 case NLASTRIP_TYPE_CLIP: 
995                         /* clip must have some action to evaluate */
996                         if (estrip->act == NULL)
997                                 return NULL;
998                         break;
999                 case NLASTRIP_TYPE_TRANSITION:
1000                         /* there must be strips to transition from and to (i.e. prev and next required) */
1001                         if (ELEM(NULL, estrip->prev, estrip->next))
1002                                 return NULL;
1003                                 
1004                         /* evaluate controls for the relevant extents of the bordering strips... */
1005                         nlastrip_evaluate_controls(estrip->prev, estrip->start);
1006                         nlastrip_evaluate_controls(estrip->next, estrip->end);
1007                         break;
1008         }
1009         
1010         /* add to list of strips we need to evaluate */
1011         nes= MEM_callocN(sizeof(NlaEvalStrip), "NlaEvalStrip");
1012         
1013         nes->strip= estrip;
1014         nes->strip_mode= side;
1015         nes->track_index= index;
1016         nes->strip_time= estrip->strip_time;
1017         
1018         if (list)
1019                 BLI_addtail(list, nes);
1020         
1021         return nes;
1022 }
1023
1024 /* ---------------------- */
1025
1026 /* find an NlaEvalChannel that matches the given criteria 
1027  *      - ptr and prop are the RNA data to find a match for
1028  */
1029 static NlaEvalChannel *nlaevalchan_find_match (ListBase *channels, PointerRNA *ptr, PropertyRNA *prop, int array_index)
1030 {
1031         NlaEvalChannel *nec;
1032         
1033         /* sanity check */
1034         if (channels == NULL)
1035                 return NULL;
1036         
1037         /* loop through existing channels, checking for a channel which affects the same property */
1038         for (nec= channels->first; nec; nec= nec->next) {
1039                 /* - comparing the PointerRNA's is done by comparing the pointers
1040                  *   to the actual struct the property resides in, since that all the
1041                  *   other data stored in PointerRNA cannot allow us to definitively 
1042                  *      identify the data 
1043                  */
1044                 if ((nec->ptr.data == ptr->data) && (nec->prop == prop) && (nec->index == array_index))
1045                         return nec;
1046         }
1047         
1048         /* not found */
1049         return NULL;
1050 }
1051
1052 /* verify that an appropriate NlaEvalChannel for this F-Curve exists */
1053 static NlaEvalChannel *nlaevalchan_verify (PointerRNA *ptr, ListBase *channels, NlaEvalStrip *nes, FCurve *fcu, short *newChan)
1054 {
1055         NlaEvalChannel *nec;
1056         NlaStrip *strip= nes->strip;
1057         PropertyRNA *prop;
1058         PointerRNA new_ptr;
1059         char *path = NULL;
1060         short free_path=0;
1061         
1062         /* sanity checks */
1063         if (channels == NULL)
1064                 return NULL;
1065         
1066         /* get RNA pointer+property info from F-Curve for more convenient handling */
1067                 /* get path, remapped as appropriate to work in its new environment */
1068         free_path= animsys_remap_path(strip->remap, fcu->rna_path, &path);
1069         
1070                 /* a valid property must be available, and it must be animateable */
1071         if (RNA_path_resolve(ptr, path, &new_ptr, &prop) == 0) {
1072                 if (G.f & G_DEBUG) printf("NLA Strip Eval: Cannot resolve path \n");
1073                 return NULL;
1074         }
1075                 /* only ok if animateable */
1076         else if (RNA_property_animateable(&new_ptr, prop) == 0) {
1077                 if (G.f & G_DEBUG) printf("NLA Strip Eval: Property not animateable \n");
1078                 return NULL;
1079         }
1080         
1081         /* try to find a match */
1082         nec= nlaevalchan_find_match(channels, &new_ptr, prop, fcu->array_index);
1083         
1084         /* allocate a new struct for this if none found */
1085         if (nec == NULL) {
1086                 nec= MEM_callocN(sizeof(NlaEvalChannel), "NlaEvalChannel");
1087                 *newChan= 1;
1088                 BLI_addtail(channels, nec);
1089                 
1090                 nec->ptr= new_ptr; 
1091                 nec->prop= prop;
1092                 nec->index= fcu->array_index;
1093         }
1094         else
1095                 *newChan= 0;
1096         
1097         /* we can now return */
1098         return nec;
1099 }
1100
1101 /* accumulate (i.e. blend) the given value on to the channel it affects */
1102 static void nlaevalchan_accumulate (NlaEvalChannel *nec, NlaEvalStrip *nes, short newChan, float value)
1103 {
1104         NlaStrip *strip= nes->strip;
1105         short blendmode= strip->blendmode;
1106         float inf= strip->influence;
1107         
1108         /* if channel is new, just store value regardless of blending factors, etc. */
1109         if (newChan) {
1110                 nec->value= value;
1111                 return;
1112         }
1113                 
1114         /* if this is being performed as part of transition evaluation, incorporate
1115          * an additional weighting factor for the influence
1116          */
1117         if (nes->strip_mode == NES_TIME_TRANSITION_END) 
1118                 inf *= nes->strip_time;
1119         
1120         /* premultiply the value by the weighting factor */
1121         if (IS_EQ(inf, 0)) return;
1122         value *= inf;
1123         
1124         /* perform blending */
1125         switch (blendmode) {
1126                 case NLASTRIP_MODE_ADD:
1127                         /* simply add the scaled value on to the stack */
1128                         nec->value += value;
1129                         break;
1130                         
1131                 case NLASTRIP_MODE_SUBTRACT:
1132                         /* simply subtract the scaled value from the stack */
1133                         nec->value -= value;
1134                         break;
1135                         
1136                 case NLASTRIP_MODE_MULTIPLY:
1137                         /* multiply the scaled value with the stack */
1138                         nec->value *= value;
1139                         break;
1140                 
1141                 case NLASTRIP_MODE_REPLACE:
1142                 default: // TODO: do we really want to blend by default? it seems more uses might prefer add...
1143                         /* do linear interpolation 
1144                          *      - the influence of the accumulated data (elsewhere, that is called dstweight) 
1145                          *        is 1 - influence, since the strip's influence is srcweight
1146                          */
1147                         nec->value= nec->value * (1.0f - inf)   +   value;
1148                         break;
1149         }
1150 }
1151
1152 /* accumulate the results of a temporary buffer with the results of the full-buffer */
1153 static void nlaevalchan_buffers_accumulate (ListBase *channels, ListBase *tmp_buffer, NlaEvalStrip *nes)
1154 {
1155         NlaEvalChannel *nec, *necn, *necd;
1156         
1157         /* optimise - abort if no channels */
1158         if (tmp_buffer->first == NULL)
1159                 return;
1160         
1161         /* accumulate results in tmp_channels buffer to the accumulation buffer */
1162         for (nec= tmp_buffer->first; nec; nec= necn) {
1163                 /* get pointer to next channel in case we remove the current channel from the temp-buffer */
1164                 necn= nec->next;
1165                 
1166                 /* try to find an existing matching channel for this setting in the accumulation buffer */
1167                 necd= nlaevalchan_find_match(channels, &nec->ptr, nec->prop, nec->index);
1168                 
1169                 /* if there was a matching channel already in the buffer, accumulate to it,
1170                  * otherwise, add the current channel to the buffer for efficiency
1171                  */
1172                 if (necd)
1173                         nlaevalchan_accumulate(necd, nes, 0, nec->value);
1174                 else {
1175                         BLI_remlink(tmp_buffer, nec);
1176                         BLI_addtail(channels, nec);
1177                 }
1178         }
1179         
1180         /* free temp-channels that haven't been assimilated into the buffer */
1181         BLI_freelistN(tmp_buffer);
1182 }
1183
1184 /* ---------------------- */
1185 /* F-Modifier stack joining/separation utilities - should we generalise these for BLI_listbase.h interface? */
1186
1187 /* Temporarily join two lists of modifiers together, storing the result in a third list */
1188 static void nlaeval_fmodifiers_join_stacks (ListBase *result, ListBase *list1, ListBase *list2)
1189 {
1190         FModifier *fcm1, *fcm2;
1191         
1192         /* if list1 is invalid...  */
1193         if ELEM(NULL, list1, list1->first) {
1194                 if (list2 && list2->first) {
1195                         result->first= list2->first;
1196                         result->last= list2->last;
1197                 }
1198         }
1199         /* if list 2 is invalid... */
1200         else if ELEM(NULL, list2, list2->first) {
1201                 result->first= list1->first;
1202                 result->last= list1->last;
1203         }
1204         else {
1205                 /* list1 should be added first, and list2 second, with the endpoints of these being the endpoints for result 
1206                  *      - the original lists must be left unchanged though, as we need that fact for restoring
1207                  */
1208                 result->first= list1->first;
1209                 result->last= list2->last;
1210                 
1211                 fcm1= list1->last;
1212                 fcm2= list2->first;
1213                 
1214                 fcm1->next= fcm2;
1215                 fcm2->prev= fcm1;
1216         }
1217 }
1218
1219 /* Split two temporary lists of modifiers */
1220 static void nlaeval_fmodifiers_split_stacks (ListBase *list1, ListBase *list2)
1221 {
1222         FModifier *fcm1, *fcm2;
1223         
1224         /* if list1/2 is invalid... just skip */
1225         if ELEM(NULL, list1, list2)
1226                 return;
1227         if ELEM(NULL, list1->first, list2->first)
1228                 return;
1229                 
1230         /* get endpoints */
1231         fcm1= list1->last;
1232         fcm2= list2->first;
1233         
1234         /* clear their links */
1235         fcm1->next= NULL;
1236         fcm2->prev= NULL;
1237 }
1238
1239 /* ---------------------- */
1240
1241 /* evaluate action-clip strip */
1242 static void nlastrip_evaluate_actionclip (PointerRNA *ptr, ListBase *channels, ListBase *modifiers, NlaEvalStrip *nes)
1243 {
1244         ListBase tmp_modifiers = {NULL, NULL};
1245         NlaStrip *strip= nes->strip;
1246         FCurve *fcu;
1247         float evaltime;
1248         
1249         /* join this strip's modifiers to the parent's modifiers (own modifiers first) */
1250         nlaeval_fmodifiers_join_stacks(&tmp_modifiers, &strip->modifiers, modifiers);
1251         
1252         /* evaluate strip's modifiers which modify time to evaluate the base curves at */
1253         evaltime= evaluate_time_fmodifiers(&tmp_modifiers, NULL, 0.0f, strip->strip_time);
1254         
1255         /* evaluate all the F-Curves in the action, saving the relevant pointers to data that will need to be used */
1256         for (fcu= strip->act->curves.first; fcu; fcu= fcu->next) {
1257                 NlaEvalChannel *nec;
1258                 float value = 0.0f;
1259                 short newChan = -1;
1260                 
1261                 /* check if this curve should be skipped */
1262                 if (fcu->flag & (FCURVE_MUTED|FCURVE_DISABLED)) 
1263                         continue;
1264                 if ((fcu->grp) && (fcu->grp->flag & AGRP_MUTED))
1265                         continue;
1266                         
1267                 /* evaluate the F-Curve's value for the time given in the strip 
1268                  * NOTE: we use the modified time here, since strip's F-Curve Modifiers are applied on top of this 
1269                  */
1270                 value= evaluate_fcurve(fcu, evaltime);
1271                 
1272                 /* apply strip's F-Curve Modifiers on this value 
1273                  * NOTE: we apply the strip's original evaluation time not the modified one (as per standard F-Curve eval)
1274                  */
1275                 evaluate_value_fmodifiers(&tmp_modifiers, fcu, &value, strip->strip_time);
1276                 
1277                 
1278                 /* get an NLA evaluation channel to work with, and accumulate the evaluated value with the value(s)
1279                  * stored in this channel if it has been used already
1280                  */
1281                 nec= nlaevalchan_verify(ptr, channels, nes, fcu, &newChan);
1282                 if (nec)
1283                         nlaevalchan_accumulate(nec, nes, newChan, value);
1284         }
1285         
1286         /* unlink this strip's modifiers from the parent's modifiers again */
1287         nlaeval_fmodifiers_split_stacks(&strip->modifiers, modifiers);
1288 }
1289
1290 /* evaluate transition strip */
1291 static void nlastrip_evaluate_transition (PointerRNA *ptr, ListBase *channels, ListBase *modifiers, NlaEvalStrip *nes)
1292 {
1293         ListBase tmp_channels = {NULL, NULL};
1294         ListBase tmp_modifiers = {NULL, NULL};
1295         NlaEvalStrip tmp_nes;
1296         NlaStrip *s1, *s2;
1297         
1298         /* join this strip's modifiers to the parent's modifiers (own modifiers first) */
1299         nlaeval_fmodifiers_join_stacks(&tmp_modifiers, &nes->strip->modifiers, modifiers);
1300         
1301         /* get the two strips to operate on 
1302          *      - we use the endpoints of the strips directly flanking our strip
1303          *        using these as the endpoints of the transition (destination and source)
1304          *      - these should have already been determined to be valid...
1305          *      - if this strip is being played in reverse, we need to swap these endpoints
1306          *        otherwise they will be interpolated wrong
1307          */
1308         if (nes->strip->flag & NLASTRIP_FLAG_REVERSE) {
1309                 s1= nes->strip->next;
1310                 s2= nes->strip->prev;
1311         }
1312         else {
1313                 s1= nes->strip->prev;
1314                 s2= nes->strip->next;
1315         }
1316         
1317         /* prepare template for 'evaluation strip' 
1318          *      - based on the transition strip's evaluation strip data
1319          *      - strip_mode is NES_TIME_TRANSITION_* based on which endpoint
1320          *      - strip_time is the 'normalised' (i.e. in-strip) time for evaluation,
1321          *        which doubles up as an additional weighting factor for the strip influences
1322          *        which allows us to appear to be 'interpolating' between the two extremes
1323          */
1324         tmp_nes= *nes;
1325         
1326         /* evaluate these strips into a temp-buffer (tmp_channels) */
1327         // FIXME: modifier evalation here needs some work...
1328                 /* first strip */
1329         tmp_nes.strip_mode= NES_TIME_TRANSITION_START;
1330         tmp_nes.strip= s1;
1331         nlastrip_evaluate(ptr, &tmp_channels, &tmp_modifiers, &tmp_nes);
1332         
1333                 /* second strip */
1334         tmp_nes.strip_mode= NES_TIME_TRANSITION_END;
1335         tmp_nes.strip= s2;
1336         nlastrip_evaluate(ptr, &tmp_channels, &tmp_modifiers, &tmp_nes);
1337         
1338         
1339         /* assumulate temp-buffer and full-buffer, using the 'real' strip */
1340         nlaevalchan_buffers_accumulate(channels, &tmp_channels, nes);
1341         
1342         /* unlink this strip's modifiers from the parent's modifiers again */
1343         nlaeval_fmodifiers_split_stacks(&nes->strip->modifiers, modifiers);
1344 }
1345
1346 /* evaluate meta-strip */
1347 static void nlastrip_evaluate_meta (PointerRNA *ptr, ListBase *channels, ListBase *modifiers, NlaEvalStrip *nes)
1348 {
1349         ListBase tmp_channels = {NULL, NULL};
1350         ListBase tmp_modifiers = {NULL, NULL};
1351         NlaStrip *strip= nes->strip;
1352         NlaEvalStrip *tmp_nes;
1353         float evaltime;
1354         
1355         /* meta-strip was calculated normally to have some time to be evaluated at
1356          * and here we 'look inside' the meta strip, treating it as a decorated window to
1357          * it's child strips, which get evaluated as if they were some tracks on a strip 
1358          * (but with some extra modifiers to apply).
1359          *
1360          * NOTE: keep this in sync with animsys_evaluate_nla()
1361          */
1362          
1363         /* join this strip's modifiers to the parent's modifiers (own modifiers first) */
1364         nlaeval_fmodifiers_join_stacks(&tmp_modifiers, &strip->modifiers, modifiers); 
1365         
1366         /* find the child-strip to evaluate */
1367         evaltime= (nes->strip_time * (strip->end - strip->start)) + strip->start;
1368         tmp_nes= nlastrips_ctime_get_strip(NULL, &strip->strips, -1, evaltime);
1369         if (tmp_nes == NULL)
1370                 return;
1371                 
1372         /* evaluate child-strip into tmp_channels buffer before accumulating 
1373          * in the accumulation buffer
1374          */
1375         nlastrip_evaluate(ptr, &tmp_channels, &tmp_modifiers, tmp_nes);
1376         
1377         /* assumulate temp-buffer and full-buffer, using the 'real' strip */
1378         nlaevalchan_buffers_accumulate(channels, &tmp_channels, nes);
1379         
1380         /* free temp eval-strip */
1381         MEM_freeN(tmp_nes);
1382         
1383         /* unlink this strip's modifiers from the parent's modifiers again */
1384         nlaeval_fmodifiers_split_stacks(&strip->modifiers, modifiers);
1385 }
1386
1387 /* evaluates the given evaluation strip */
1388 void nlastrip_evaluate (PointerRNA *ptr, ListBase *channels, ListBase *modifiers, NlaEvalStrip *nes)
1389 {
1390         NlaStrip *strip= nes->strip;
1391         
1392         /* to prevent potential infinite recursion problems (i.e. transition strip, beside meta strip containing a transition
1393          * several levels deep inside it), we tag the current strip as being evaluated, and clear this when we leave
1394          */
1395         // TODO: be careful with this flag, since some edit tools may be running and have set this while animplayback was running
1396         if (strip->flag & NLASTRIP_FLAG_EDIT_TOUCHED)
1397                 return;
1398         strip->flag |= NLASTRIP_FLAG_EDIT_TOUCHED;
1399         
1400         /* actions to take depend on the type of strip */
1401         switch (strip->type) {
1402                 case NLASTRIP_TYPE_CLIP: /* action-clip */
1403                         nlastrip_evaluate_actionclip(ptr, channels, modifiers, nes);
1404                         break;
1405                 case NLASTRIP_TYPE_TRANSITION: /* transition */
1406                         nlastrip_evaluate_transition(ptr, channels, modifiers, nes);
1407                         break;
1408                 case NLASTRIP_TYPE_META: /* meta */
1409                         nlastrip_evaluate_meta(ptr, channels, modifiers, nes);
1410                         break;
1411         }
1412         
1413         /* clear temp recursion safe-check */
1414         strip->flag &= ~NLASTRIP_FLAG_EDIT_TOUCHED;
1415 }
1416
1417 /* write the accumulated settings to */
1418 void nladata_flush_channels (ListBase *channels)
1419 {
1420         NlaEvalChannel *nec;
1421         
1422         /* sanity checks */
1423         if (channels == NULL)
1424                 return;
1425         
1426         /* for each channel with accumulated values, write its value on the property it affects */
1427         for (nec= channels->first; nec; nec= nec->next) {
1428                 PointerRNA *ptr= &nec->ptr;
1429                 PropertyRNA *prop= nec->prop;
1430                 int array_index= nec->index;
1431                 float value= nec->value;
1432                 
1433                 /* write values - see animsys_write_rna_setting() to sync the code */
1434                 switch (RNA_property_type(prop)) 
1435                 {
1436                         case PROP_BOOLEAN:
1437                                 if (RNA_property_array_length(ptr, prop))
1438                                         RNA_property_boolean_set_index(ptr, prop, array_index, (int)value);
1439                                 else
1440                                         RNA_property_boolean_set(ptr, prop, (int)value);
1441                                 break;
1442                         case PROP_INT:
1443                                 if (RNA_property_array_length(ptr, prop))
1444                                         RNA_property_int_set_index(ptr, prop, array_index, (int)value);
1445                                 else
1446                                         RNA_property_int_set(ptr, prop, (int)value);
1447                                 break;
1448                         case PROP_FLOAT:
1449                                 if (RNA_property_array_length(ptr, prop))
1450                                         RNA_property_float_set_index(ptr, prop, array_index, value);
1451                                 else
1452                                         RNA_property_float_set(ptr, prop, value);
1453                                 break;
1454                         case PROP_ENUM:
1455                                 RNA_property_enum_set(ptr, prop, (int)value);
1456                                 break;
1457                         default:
1458                                 // can't do anything with other types of property....
1459                                 break;
1460                 }
1461         }
1462 }
1463
1464 /* ---------------------- */
1465
1466 /* NLA Evaluation function (mostly for use through do_animdata) 
1467  *      - All channels that will be affected are not cleared anymore. Instead, we just evaluate into 
1468  *              some temp channels, where values can be accumulated in one go.
1469  */
1470 static void animsys_evaluate_nla (PointerRNA *ptr, AnimData *adt, float ctime)
1471 {
1472         ListBase dummy_trackslist = {NULL, NULL};
1473         NlaStrip dummy_strip;
1474         
1475         NlaTrack *nlt;
1476         short track_index=0;
1477         short has_strips = 0;
1478         
1479         ListBase estrips= {NULL, NULL};
1480         ListBase echannels= {NULL, NULL};
1481         NlaEvalStrip *nes;
1482         
1483         // TODO: need to zero out all channels used, otherwise we have problems with threadsafety
1484         // and also when the user jumps between different times instead of moving sequentially...
1485         
1486         /* 1. get the stack of strips to evaluate at current time (influence calculated here) */
1487         for (nlt=adt->nla_tracks.first; nlt; nlt=nlt->next, track_index++) { 
1488                 /* if tweaking is on and this strip is the tweaking track, stop on this one */
1489                 if ((adt->flag & ADT_NLA_EDIT_ON) && (nlt->flag & NLATRACK_DISABLED))
1490                         break;
1491                         
1492                 /* skip if we're only considering a track tagged 'solo' */
1493                 if ((adt->flag & ADT_NLA_SOLO_TRACK) && (nlt->flag & NLATRACK_SOLO)==0)
1494                         continue;
1495                 /* skip if track is muted */
1496                 if (nlt->flag & NLATRACK_MUTED) 
1497                         continue;
1498                         
1499                 /* if this track has strips (but maybe they won't be suitable), set has_strips 
1500                  *      - used for mainly for still allowing normal action evaluation...
1501                  */
1502                 if (nlt->strips.first)
1503                         has_strips= 1;
1504                         
1505                 /* otherwise, get strip to evaluate for this channel */
1506                 nes= nlastrips_ctime_get_strip(&estrips, &nlt->strips, track_index, ctime);
1507                 if (nes) nes->track= nlt;
1508         }
1509         
1510         /* add 'active' Action (may be tweaking track) as last strip to evaluate in NLA stack
1511          *      - only do this if we're not exclusively evaluating the 'solo' NLA-track
1512          */
1513         if ((adt->action) && !(adt->flag & ADT_NLA_SOLO_TRACK)) {
1514                 /* if there are strips, evaluate action as per NLA rules */
1515                 if (has_strips) {
1516                         /* make dummy NLA strip, and add that to the stack */
1517                         memset(&dummy_strip, 0, sizeof(NlaStrip));
1518                         dummy_trackslist.first= dummy_trackslist.last= &dummy_strip;
1519                         
1520                         dummy_strip.act= adt->action;
1521                         dummy_strip.remap= adt->remap;
1522                         
1523                         /* action range is calculated taking F-Modifiers into account (which making new strips doesn't do due to the troublesome nature of that) */
1524                         calc_action_range(dummy_strip.act, &dummy_strip.actstart, &dummy_strip.actend, 1);
1525                         dummy_strip.start = dummy_strip.actstart;
1526                         dummy_strip.end = (IS_EQ(dummy_strip.actstart, dummy_strip.actend)) ?  (dummy_strip.actstart + 1.0f): (dummy_strip.actend);
1527                         
1528                         dummy_strip.blendmode= adt->act_blendmode;
1529                         dummy_strip.extendmode= adt->act_extendmode;
1530                         dummy_strip.influence= adt->act_influence;
1531                         
1532                         /* add this to our list of evaluation strips */
1533                         nlastrips_ctime_get_strip(&estrips, &dummy_trackslist, -1, ctime);
1534                 }
1535                 else {
1536                         /* special case - evaluate as if there isn't any NLA data */
1537                         // TODO: this is really just a stop-gap measure...
1538                         animsys_evaluate_action(ptr, adt->action, adt->remap, ctime);
1539                         return;
1540                 }
1541         }
1542         
1543         /* only continue if there are strips to evaluate */
1544         if (estrips.first == NULL)
1545                 return;
1546         
1547         
1548         /* 2. for each strip, evaluate then accumulate on top of existing channels, but don't set values yet */
1549         for (nes= estrips.first; nes; nes= nes->next) 
1550                 nlastrip_evaluate(ptr, &echannels, NULL, nes);
1551         
1552         /* 3. flush effects of accumulating channels in NLA to the actual data they affect */
1553         nladata_flush_channels(&echannels);
1554         
1555         /* 4. free temporary evaluation data */
1556         BLI_freelistN(&estrips);
1557         BLI_freelistN(&echannels);
1558 }
1559
1560 /* ***************************************** */ 
1561 /* Overrides System - Public API */
1562
1563 /* Clear all overides */
1564
1565 /* Add or get existing Override for given setting */
1566 AnimOverride *BKE_animsys_validate_override (PointerRNA *ptr, char *path, int array_index)
1567 {
1568         // FIXME: need to define how to get overrides
1569         return NULL;
1570
1571
1572 /* -------------------- */
1573
1574 /* Evaluate Overrides */
1575 static void animsys_evaluate_overrides (PointerRNA *ptr, AnimData *adt, float ctime)
1576 {
1577         AnimOverride *aor;
1578         
1579         /* for each override, simply execute... */
1580         for (aor= adt->overrides.first; aor; aor= aor->next)
1581                 animsys_write_rna_setting(ptr, aor->rna_path, aor->array_index, aor->value);
1582 }
1583
1584 /* ***************************************** */
1585 /* Evaluation System - Public API */
1586
1587 /* Overview of how this system works:
1588  *      1) Depsgraph sorts data as necessary, so that data is in an order that means 
1589  *              that all dependences are resolved before dependants.
1590  *      2) All normal animation is evaluated, so that drivers have some basis values to
1591  *              work with
1592  *              a.      NLA stacks are done first, as the Active Actions act as 'tweaking' tracks
1593  *                      which modify the effects of the NLA-stacks
1594  *              b.      Active Action is evaluated as per normal, on top of the results of the NLA tracks
1595  *
1596  * --------------< often in a separate phase... >------------------ 
1597  *
1598  *      3) Drivers/expressions are evaluated on top of this, in an order where dependences are
1599  *              resolved nicely. 
1600  *         Note: it may be necessary to have some tools to handle the cases where some higher-level
1601  *              drivers are added and cause some problematic dependencies that didn't exist in the local levels...
1602  *
1603  * --------------< always executed >------------------ 
1604  *
1605  * Maintainance of editability of settings (XXX):
1606  *      In order to ensure that settings that are animated can still be manipulated in the UI without requiring
1607  *      that keyframes are added to prevent these values from being overwritten, we use 'overrides'. 
1608  *
1609  * Unresolved things:
1610  *      - Handling of multi-user settings (i.e. time-offset, group-instancing) -> big cache grids or nodal system? but stored where?
1611  *      - Multiple-block dependencies (i.e. drivers for settings are in both local and higher levels) -> split into separate lists? 
1612  *
1613  * Current Status:
1614  *      - Currently (as of September 2009), overrides we haven't needed to (fully) implement overrides. 
1615  *        However, the code fo this is relatively harmless, so is left in the code for now.
1616  */
1617
1618 /* Evaluation loop for evaluation animation data 
1619  *
1620  * This assumes that the animation-data provided belongs to the ID block in question,
1621  * and that the flags for which parts of the anim-data settings need to be recalculated 
1622  * have been set already by the depsgraph. Now, we use the recalc 
1623  */
1624 void BKE_animsys_evaluate_animdata (ID *id, AnimData *adt, float ctime, short recalc)
1625 {
1626         PointerRNA id_ptr;
1627         
1628         /* sanity checks */
1629         if ELEM(NULL, id, adt)
1630                 return;
1631         
1632         /* get pointer to ID-block for RNA to use */
1633         RNA_id_pointer_create(id, &id_ptr);
1634         
1635         /* recalculate keyframe data:
1636          *      - NLA before Active Action, as Active Action behaves as 'tweaking track'
1637          *        that overrides 'rough' work in NLA
1638          */
1639         // TODO: need to double check that this all works correctly
1640         if ((recalc & ADT_RECALC_ANIM) || (adt->recalc & ADT_RECALC_ANIM))
1641         {
1642                 /* evaluate NLA data */
1643                 if ((adt->nla_tracks.first) && !(adt->flag & ADT_NLA_EVAL_OFF))
1644                 {
1645                         /* evaluate NLA-stack 
1646                          *      - active action is evaluated as part of the NLA stack as the last item
1647                          */
1648                         animsys_evaluate_nla(&id_ptr, adt, ctime);
1649                 }
1650                 /* evaluate Active Action only */
1651                 else if (adt->action)
1652                         animsys_evaluate_action(&id_ptr, adt->action, adt->remap, ctime);
1653                 
1654                 /* reset tag */
1655                 adt->recalc &= ~ADT_RECALC_ANIM;
1656         }
1657         
1658         /* recalculate drivers 
1659          *      - Drivers need to be evaluated afterwards, as they can either override 
1660          *        or be layered on top of existing animation data.
1661          *      - Drivers should be in the appropriate order to be evaluated without problems...
1662          */
1663         if ((recalc & ADT_RECALC_DRIVERS) /*&& (adt->recalc & ADT_RECALC_DRIVERS)*/) // XXX for now, don't check yet, as depsgraph hasn't been updated
1664         {
1665                 animsys_evaluate_drivers(&id_ptr, adt, ctime);
1666         }
1667         
1668         /* always execute 'overrides' 
1669          *      - Overrides allow editing, by overwriting the value(s) set from animation-data, with the
1670          *        value last set by the user (and not keyframed yet). 
1671          *      - Overrides are cleared upon frame change and/or keyframing
1672          *      - It is best that we execute this everytime, so that no errors are likely to occur.
1673          */
1674         animsys_evaluate_overrides(&id_ptr, adt, ctime);
1675         
1676         /* clear recalc flag now */
1677         adt->recalc= 0;
1678 }
1679
1680 /* Evaluation of all ID-blocks with Animation Data blocks - Animation Data Only
1681  *
1682  * This will evaluate only the animation info available in the animation data-blocks
1683  * encountered. In order to enforce the system by which some settings controlled by a
1684  * 'local' (i.e. belonging in the nearest ID-block that setting is related to, not a
1685  * standard 'root') block are overridden by a larger 'user'
1686  */
1687 void BKE_animsys_evaluate_all_animation (Main *main, float ctime)
1688 {
1689         ID *id;
1690         
1691         if (G.f & G_DEBUG)
1692                 printf("Evaluate all animation - %f \n", ctime);
1693         
1694         /* macro for less typing 
1695          *      - only evaluate animation data for id if it has users (and not just fake ones)
1696          *      - whether animdata exists is checked for by the evaluation function, though taking 
1697          *        this outside of the function may make things slightly faster?
1698          */
1699 #define EVAL_ANIM_IDS(first, aflag) \
1700         for (id= first; id; id= id->next) { \
1701                 AnimData *adt= BKE_animdata_from_id(id); \
1702                 if ( (id->us > 1) || (id->us && !(id->flag & LIB_FAKEUSER)) ) \
1703                         BKE_animsys_evaluate_animdata(id, adt, ctime, aflag); \
1704         }
1705         
1706         /* optimisation: 
1707          * when there are no actions, don't go over database and loop over heaps of datablocks, 
1708          * which should ultimately be empty, since it is not possible for now to have any animation 
1709          * without some actions, and drivers wouldn't get affected by any state changes
1710          *
1711          * however, if there are some curves, we will need to make sure that their 'ctime' property gets
1712          * set correctly, so this optimisation must be skipped in that case...
1713          */
1714         if ((main->action.first == NULL) && (main->curve.first == NULL)) {
1715                 if (G.f & G_DEBUG)
1716                         printf("\tNo Actions, so no animation needs to be evaluated...\n");
1717                         
1718                 return;
1719         }
1720         
1721         /* nodes */
1722         EVAL_ANIM_IDS(main->nodetree.first, ADT_RECALC_ANIM);
1723         
1724         /* textures */
1725         EVAL_ANIM_IDS(main->tex.first, ADT_RECALC_ANIM);
1726         
1727         /* lamps */
1728         EVAL_ANIM_IDS(main->lamp.first, ADT_RECALC_ANIM);
1729         
1730         /* materials */
1731         EVAL_ANIM_IDS(main->mat.first, ADT_RECALC_ANIM);
1732         
1733         /* cameras */
1734         EVAL_ANIM_IDS(main->camera.first, ADT_RECALC_ANIM);
1735         
1736         /* shapekeys */
1737                 // TODO: we probably need the same hack as for curves (ctime-hack)
1738         EVAL_ANIM_IDS(main->key.first, ADT_RECALC_ANIM);
1739         
1740         /* metaballs */
1741         EVAL_ANIM_IDS(main->mball.first, ADT_RECALC_ANIM);
1742         
1743         /* curves */
1744                 /* we need to perform a special hack here to ensure that the ctime 
1745                  * value of the curve gets set in case there's no animation for that
1746                  *      - it needs to be set before animation is evaluated just so that 
1747                  *        animation can successfully override...
1748                  *      - it shouldn't get set when calculating drivers...
1749                  */
1750         for (id= main->curve.first; id; id= id->next) {
1751                 AnimData *adt= BKE_animdata_from_id(id);
1752                 Curve *cu= (Curve *)id;
1753                 
1754                 /* set ctime variable for curve */
1755                 cu->ctime= ctime;
1756                 
1757                 /* now execute animation data on top of this as per normal */
1758                 BKE_animsys_evaluate_animdata(id, adt, ctime, ADT_RECALC_ANIM);
1759         }
1760         
1761         /* armatures */
1762         EVAL_ANIM_IDS(main->armature.first, ADT_RECALC_ANIM);
1763         
1764         /* meshes */
1765         // TODO...
1766         
1767         /* particles */
1768         EVAL_ANIM_IDS(main->particle.first, ADT_RECALC_ANIM);
1769         
1770         /* objects */
1771                 /* ADT_RECALC_ANIM doesn't need to be supplied here, since object AnimData gets 
1772                  * this tagged by Depsgraph on framechange. This optimisation means that objects
1773                  * linked from other (not-visible) scenes will not need their data calculated.
1774                  */
1775         EVAL_ANIM_IDS(main->object.first, 0); 
1776         
1777         /* worlds */
1778         EVAL_ANIM_IDS(main->world.first, ADT_RECALC_ANIM);
1779         
1780         /* scenes */
1781         for (id= main->scene.first; id; id= id->next) {
1782                 AnimData *adt= BKE_animdata_from_id(id);
1783                 Scene *scene= (Scene *)id;
1784                 
1785                 /* do compositing nodes first (since these aren't included in main tree) */
1786                 if (scene->nodetree) {
1787                         AnimData *adt2= BKE_animdata_from_id((ID *)scene->nodetree);
1788                         BKE_animsys_evaluate_animdata((ID *)scene->nodetree, adt2, ctime, ADT_RECALC_ANIM);
1789                 }
1790                 
1791                 /* now execute scene animation data as per normal */
1792                 BKE_animsys_evaluate_animdata(id, adt, ctime, ADT_RECALC_ANIM);
1793         }
1794 }
1795
1796 /* ***************************************** */