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