Merge branch 'master' into blender2.8
[blender.git] / source / blender / blenkernel / intern / anim_sys.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2009 Blender Foundation, Joshua Leung
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Joshua Leung (full recode)
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/blenkernel/intern/anim_sys.c
29  *  \ingroup bke
30  */
31
32
33 #include <stdio.h>
34 #include <string.h>
35 #include <stddef.h>
36 #include <float.h>
37 #include <math.h>
38
39 #include "MEM_guardedalloc.h"
40
41 #include "BLI_utildefines.h"
42 #include "BLI_blenlib.h"
43 #include "BLI_alloca.h"
44 #include "BLI_dynstr.h"
45 #include "BLI_listbase.h"
46 #include "BLI_string_utils.h"
47
48 #include "BLT_translation.h"
49
50 #include "DNA_anim_types.h"
51 #include "DNA_lamp_types.h"
52 #include "DNA_material_types.h"
53 #include "DNA_object_types.h"
54 #include "DNA_scene_types.h"
55 #include "DNA_screen_types.h"
56 #include "DNA_space_types.h"
57 #include "DNA_texture_types.h"
58 #include "DNA_world_types.h"
59
60 #include "BKE_animsys.h"
61 #include "BKE_action.h"
62 #include "BKE_context.h"
63 #include "BKE_fcurve.h"
64 #include "BKE_nla.h"
65 #include "BKE_global.h"
66 #include "BKE_main.h"
67 #include "BKE_material.h"
68 #include "BKE_library.h"
69 #include "BKE_report.h"
70 #include "BKE_texture.h"
71
72 #include "DEG_depsgraph.h"
73
74 #include "RNA_access.h"
75
76 #include "nla_private.h"
77
78 /* ***************************************** */
79 /* AnimData API */
80
81 /* Getter/Setter -------------------------------------------- */
82
83 /* Check if ID can have AnimData */
84 bool id_type_can_have_animdata(const short id_type)
85 {
86         /* Only some ID-blocks have this info for now */
87         /* TODO: finish adding this for the other blocktypes */
88         switch (id_type) {
89                 /* has AnimData */
90                 case ID_OB:
91                 case ID_ME: case ID_MB: case ID_CU: case ID_AR: case ID_LT:
92                 case ID_KE:
93                 case ID_PA:
94                 case ID_MA: case ID_TE: case ID_NT:
95                 case ID_LA: case ID_CA: case ID_WO:
96                 case ID_LS:
97                 case ID_LP:
98                 case ID_SPK:
99                 case ID_SCE:
100                 case ID_MC:
101                 case ID_MSK:
102                 case ID_GD:
103                 case ID_CF:
104                         return true;
105                 
106                 /* no AnimData */
107                 default:
108                         return false;
109         }
110 }
111
112 bool id_can_have_animdata(const ID *id)
113 {
114         /* sanity check */
115         if (id == NULL)
116                 return false;
117
118         return id_type_can_have_animdata(GS(id->name));
119 }
120
121 /* Get AnimData from the given ID-block. In order for this to work, we assume that 
122  * the AnimData pointer is stored immediately after the given ID-block in the struct,
123  * as per IdAdtTemplate.
124  */
125 AnimData *BKE_animdata_from_id(ID *id)
126 {
127         /* only some ID-blocks have this info for now, so we cast the 
128          * types that do to be of type IdAdtTemplate, and extract the
129          * AnimData that way
130          */
131         if (id_can_have_animdata(id)) {
132                 IdAdtTemplate *iat = (IdAdtTemplate *)id;
133                 return iat->adt;
134         }
135         else
136                 return NULL;
137 }
138
139 /* Add AnimData to the given ID-block. In order for this to work, we assume that 
140  * the AnimData pointer is stored immediately after the given ID-block in the struct,
141  * as per IdAdtTemplate. Also note that 
142  */
143 AnimData *BKE_animdata_add_id(ID *id)
144 {
145         /* Only some ID-blocks have this info for now, so we cast the 
146          * types that do to be of type IdAdtTemplate, and add the AnimData
147          * to it using the template
148          */
149         if (id_can_have_animdata(id)) {
150                 IdAdtTemplate *iat = (IdAdtTemplate *)id;
151                 
152                 /* check if there's already AnimData, in which case, don't add */
153                 if (iat->adt == NULL) {
154                         AnimData *adt;
155                         
156                         /* add animdata */
157                         adt = iat->adt = MEM_callocN(sizeof(AnimData), "AnimData");
158                         
159                         /* set default settings */
160                         adt->act_influence = 1.0f;
161                 }
162                 
163                 return iat->adt;
164         }
165         else 
166                 return NULL;
167 }
168
169 /* Action Setter --------------------------------------- */
170
171 /* Called when user tries to change the active action of an AnimData block (via RNA, Outliner, etc.) */
172 bool BKE_animdata_set_action(ReportList *reports, ID *id, bAction *act)
173 {
174         AnimData *adt = BKE_animdata_from_id(id);
175         bool ok = false;
176         
177         /* animdata validity check */
178         if (adt == NULL) {
179                 BKE_report(reports, RPT_WARNING, "No AnimData to set action on");
180                 return ok;
181         }
182         
183         /* active action is only editable when it is not a tweaking strip 
184          * see rna_AnimData_action_editable() in rna_animation.c
185          */
186         if ((adt->flag & ADT_NLA_EDIT_ON) || (adt->actstrip) || (adt->tmpact)) {
187                 /* cannot remove, otherwise things turn to custard */
188                 BKE_report(reports, RPT_ERROR, "Cannot change action, as it is still being edited in NLA");
189                 return ok;
190         }
191         
192         /* manage usercount for current action */
193         if (adt->action)
194                 id_us_min((ID *)adt->action);
195         
196         /* assume that AnimData's action can in fact be edited... */
197         if (act) {
198                 /* action must have same type as owner */
199                 if (ELEM(act->idroot, 0, GS(id->name))) {
200                         /* can set */
201                         adt->action = act;
202                         id_us_plus((ID *)adt->action);
203                         ok = true;
204                 }
205                 else {
206                         /* cannot set */
207                         BKE_reportf(reports, RPT_ERROR,
208                                     "Could not set action '%s' onto ID '%s', as it does not have suitably rooted paths "
209                                     "for this purpose", act->id.name + 2, id->name);
210                         /* ok = false; */
211                 }
212         }
213         else {
214                 /* just clearing the action... */
215                 adt->action = NULL;
216                 ok = true;
217         }
218         
219         return ok;
220 }
221
222 /* Freeing -------------------------------------------- */
223
224 /* Free AnimData used by the nominated ID-block, and clear ID-block's AnimData pointer */
225 void BKE_animdata_free(ID *id, const bool do_id_user)
226 {
227         /* Only some ID-blocks have this info for now, so we cast the 
228          * types that do to be of type IdAdtTemplate
229          */
230         if (id_can_have_animdata(id)) {
231                 IdAdtTemplate *iat = (IdAdtTemplate *)id;
232                 AnimData *adt = iat->adt;
233                 
234                 /* check if there's any AnimData to start with */
235                 if (adt) {
236                         if (do_id_user) {
237                                 /* unlink action (don't free, as it's in its own list) */
238                                 if (adt->action)
239                                         id_us_min(&adt->action->id);
240                                 /* same goes for the temporarily displaced action */
241                                 if (adt->tmpact)
242                                         id_us_min(&adt->tmpact->id);
243                         }
244                                 
245                         /* free nla data */
246                         free_nladata(&adt->nla_tracks);
247                         
248                         /* free drivers - stored as a list of F-Curves */
249                         free_fcurves(&adt->drivers);
250                         
251                         /* free overrides */
252                         /* TODO... */
253                         
254                         /* free animdata now */
255                         MEM_freeN(adt);
256                         iat->adt = NULL;
257                 }
258         }
259 }
260
261 /* Copying -------------------------------------------- */
262
263 /* Make a copy of the given AnimData - to be used when copying datablocks */
264 AnimData *BKE_animdata_copy(Main *bmain, AnimData *adt, const bool do_action)
265 {
266         AnimData *dadt;
267         
268         /* sanity check before duplicating struct */
269         if (adt == NULL)
270                 return NULL;
271         dadt = MEM_dupallocN(adt);
272         
273         /* make a copy of action - at worst, user has to delete copies... */
274         if (do_action) {
275                 BLI_assert(bmain != NULL);
276                 BKE_id_copy_ex(bmain, (ID *)dadt->action, (ID **)&dadt->action, 0, false);
277                 BKE_id_copy_ex(bmain, (ID *)dadt->tmpact, (ID **)&dadt->tmpact, 0, false);
278         }
279         else {
280                 id_us_plus((ID *)dadt->action);
281                 id_us_plus((ID *)dadt->tmpact);
282         }
283
284         /* duplicate NLA data */
285         copy_nladata(&dadt->nla_tracks, &adt->nla_tracks);
286         
287         /* duplicate drivers (F-Curves) */
288         copy_fcurves(&dadt->drivers, &adt->drivers);
289         
290         /* don't copy overrides */
291         BLI_listbase_clear(&dadt->overrides);
292         
293         /* return */
294         return dadt;
295 }
296
297 bool BKE_animdata_copy_id(Main *bmain, ID *id_to, ID *id_from, const bool do_action)
298 {
299         AnimData *adt;
300
301         if ((id_to && id_from) && (GS(id_to->name) != GS(id_from->name)))
302                 return false;
303
304         BKE_animdata_free(id_to, true);
305
306         adt = BKE_animdata_from_id(id_from);
307         if (adt) {
308                 IdAdtTemplate *iat = (IdAdtTemplate *)id_to;
309                 iat->adt = BKE_animdata_copy(bmain, adt, do_action);
310         }
311
312         return true;
313 }
314
315 void BKE_animdata_copy_id_action(ID *id, const bool set_newid)
316 {
317         AnimData *adt = BKE_animdata_from_id(id);
318         if (adt) {
319                 if (adt->action) {
320                         id_us_min((ID *)adt->action);
321                         adt->action = set_newid ? ID_NEW_SET(adt->action, BKE_action_copy(G.main, adt->action)) :
322                                                   BKE_action_copy(G.main, adt->action);
323                 }
324                 if (adt->tmpact) {
325                         id_us_min((ID *)adt->tmpact);
326                         adt->tmpact = set_newid ? ID_NEW_SET(adt->tmpact, BKE_action_copy(G.main, adt->tmpact)) :
327                                                   BKE_action_copy(G.main, adt->tmpact);
328                 }
329         }
330 }
331
332 /* Merge copies of the data from the src AnimData into the destination AnimData */
333 void BKE_animdata_merge_copy(ID *dst_id, ID *src_id, eAnimData_MergeCopy_Modes action_mode, bool fix_drivers)
334 {
335         AnimData *src = BKE_animdata_from_id(src_id);
336         AnimData *dst = BKE_animdata_from_id(dst_id);
337         
338         /* sanity checks */
339         if (ELEM(NULL, dst, src))
340                 return;
341                 
342         // TODO: we must unset all "tweakmode" flags
343         if ((src->flag & ADT_NLA_EDIT_ON) || (dst->flag & ADT_NLA_EDIT_ON)) {
344                 printf("ERROR: Merging AnimData blocks while editing NLA is dangerous as it may cause data corruption\n");
345                 return;
346         }
347         
348         /* handle actions... */
349         if (action_mode == ADT_MERGECOPY_SRC_COPY) {
350                 /* make a copy of the actions */
351                 dst->action = BKE_action_copy(G.main, src->action);
352                 dst->tmpact = BKE_action_copy(G.main, src->tmpact);
353         }
354         else if (action_mode == ADT_MERGECOPY_SRC_REF) {
355                 /* make a reference to it */
356                 dst->action = src->action;
357                 id_us_plus((ID *)dst->action);
358                 
359                 dst->tmpact = src->tmpact;
360                 id_us_plus((ID *)dst->tmpact);
361         }
362         
363         /* duplicate NLA data */
364         if (src->nla_tracks.first) {
365                 ListBase tracks = {NULL, NULL};
366                 
367                 copy_nladata(&tracks, &src->nla_tracks);
368                 BLI_movelisttolist(&dst->nla_tracks, &tracks);
369         }
370         
371         /* duplicate drivers (F-Curves) */
372         if (src->drivers.first) {
373                 ListBase drivers = {NULL, NULL};
374                 
375                 copy_fcurves(&drivers, &src->drivers);
376                 
377                 /* Fix up all driver targets using the old target id
378                  * - This assumes that the src ID is being merged into the dst ID
379                  */
380                 if (fix_drivers) {
381                         FCurve *fcu;
382                         
383                         for (fcu = drivers.first; fcu; fcu = fcu->next) {
384                                 ChannelDriver *driver = fcu->driver;
385                                 DriverVar *dvar;
386                                 
387                                 for (dvar = driver->variables.first; dvar; dvar = dvar->next) {
388                                         DRIVER_TARGETS_USED_LOOPER(dvar)
389                                         {
390                                                 if (dtar->id == src_id) {
391                                                         dtar->id = dst_id;
392                                                 }
393                                         }
394                                         DRIVER_TARGETS_LOOPER_END
395                                 }
396                         }
397                 }
398                 
399                 BLI_movelisttolist(&dst->drivers, &drivers);
400         }
401 }
402
403 /* Sub-ID Regrouping ------------------------------------------- */
404
405 /**
406  * Helper heuristic for determining if a path is compatible with the basepath
407  *
408  * \param path Full RNA-path from some data (usually an F-Curve) to compare
409  * \param basepath Shorter path fragment to look for
410  * \return Whether there is a match
411  */
412 static bool animpath_matches_basepath(const char path[], const char basepath[])
413 {
414         /* we need start of path to be basepath */
415         return (path && basepath) && STRPREFIX(path, basepath);
416 }
417
418 /* Move F-Curves in src action to dst action, setting up all the necessary groups 
419  * for this to happen, but only if the F-Curves being moved have the appropriate 
420  * "base path". 
421  *      - This is used when data moves from one datablock to another, causing the
422  *        F-Curves to need to be moved over too
423  */
424 void action_move_fcurves_by_basepath(bAction *srcAct, bAction *dstAct, const char basepath[])
425 {
426         FCurve *fcu, *fcn = NULL;
427         
428         /* sanity checks */
429         if (ELEM(NULL, srcAct, dstAct, basepath)) {
430                 if (G.debug & G_DEBUG) {
431                         printf("ERROR: action_partition_fcurves_by_basepath(%p, %p, %p) has insufficient info to work with\n",
432                                (void *)srcAct, (void *)dstAct, (void *)basepath);
433                 }
434                 return;
435         }
436                 
437         /* clear 'temp' flags on all groups in src, as we'll be needing them later 
438          * to identify groups that we've managed to empty out here
439          */
440         action_groups_clear_tempflags(srcAct);
441         
442         /* iterate over all src F-Curves, moving over the ones that need to be moved */
443         for (fcu = srcAct->curves.first; fcu; fcu = fcn) {
444                 /* store next pointer in case we move stuff */
445                 fcn = fcu->next;
446                 
447                 /* should F-Curve be moved over?
448                  *      - we only need the start of the path to match basepath
449                  */
450                 if (animpath_matches_basepath(fcu->rna_path, basepath)) {
451                         bActionGroup *agrp = NULL;
452                         
453                         /* if grouped... */
454                         if (fcu->grp) {
455                                 /* make sure there will be a matching group on the other side for the migrants */
456                                 agrp = BKE_action_group_find_name(dstAct, fcu->grp->name);
457                                 
458                                 if (agrp == NULL) {
459                                         /* add a new one with a similar name (usually will be the same though) */
460                                         agrp = action_groups_add_new(dstAct, fcu->grp->name);
461                                 }
462                                 
463                                 /* old groups should be tagged with 'temp' flags so they can be removed later
464                                  * if we remove everything from them
465                                  */
466                                 fcu->grp->flag |= AGRP_TEMP;
467                         }
468                         
469                         /* perform the migration now */
470                         action_groups_remove_channel(srcAct, fcu);
471                         
472                         if (agrp)
473                                 action_groups_add_channel(dstAct, agrp, fcu);
474                         else
475                                 BLI_addtail(&dstAct->curves, fcu);
476                 }
477         }
478         
479         /* cleanup groups (if present) */
480         if (srcAct->groups.first) {
481                 bActionGroup *agrp, *grp = NULL;
482                 
483                 for (agrp = srcAct->groups.first; agrp; agrp = grp) {
484                         grp = agrp->next;
485                         
486                         /* only tagged groups need to be considered - clearing these tags or removing them */
487                         if (agrp->flag & AGRP_TEMP) {
488                                 /* if group is empty and tagged, then we can remove as this operation
489                                  * moved out all the channels that were formerly here
490                                  */
491                                 if (BLI_listbase_is_empty(&agrp->channels))
492                                         BLI_freelinkN(&srcAct->groups, agrp);
493                                 else
494                                         agrp->flag &= ~AGRP_TEMP;
495                         }
496                 }
497         }
498 }
499
500 /* Transfer the animation data from srcID to dstID where the srcID
501  * animation data is based off "basepath", creating new AnimData and
502  * associated data as necessary
503  */
504 void BKE_animdata_separate_by_basepath(ID *srcID, ID *dstID, ListBase *basepaths)
505 {
506         AnimData *srcAdt = NULL, *dstAdt = NULL;
507         LinkData *ld;
508         
509         /* sanity checks */
510         if (ELEM(NULL, srcID, dstID)) {
511                 if (G.debug & G_DEBUG)
512                         printf("ERROR: no source or destination ID to separate AnimData with\n");
513                 return;
514         }
515         
516         /* get animdata from src, and create for destination (if needed) */
517         srcAdt = BKE_animdata_from_id(srcID);
518         dstAdt = BKE_animdata_add_id(dstID);
519         
520         if (ELEM(NULL, srcAdt, dstAdt)) {
521                 if (G.debug & G_DEBUG)
522                         printf("ERROR: no AnimData for this pair of ID's\n");
523                 return;
524         }
525         
526         /* active action */
527         if (srcAdt->action) {
528                 /* set up an action if necessary, and name it in a similar way so that it can be easily found again */
529                 if (dstAdt->action == NULL) {
530                         dstAdt->action = add_empty_action(G.main, srcAdt->action->id.name + 2);
531                 }
532                 else if (dstAdt->action == srcAdt->action) {
533                         printf("Argh! Source and Destination share animation! ('%s' and '%s' both use '%s') Making new empty action\n",
534                                srcID->name, dstID->name, srcAdt->action->id.name);
535                         
536                         /* TODO: review this... */
537                         id_us_min(&dstAdt->action->id);
538                         dstAdt->action = add_empty_action(G.main, dstAdt->action->id.name + 2);
539                 }
540                         
541                 /* loop over base paths, trying to fix for each one... */
542                 for (ld = basepaths->first; ld; ld = ld->next) {
543                         const char *basepath = (const char *)ld->data;
544                         action_move_fcurves_by_basepath(srcAdt->action, dstAdt->action, basepath);
545                 }
546         }
547         
548         /* drivers */
549         if (srcAdt->drivers.first) {
550                 FCurve *fcu, *fcn = NULL;
551                 
552                 /* check each driver against all the base paths to see if any should go */
553                 for (fcu = srcAdt->drivers.first; fcu; fcu = fcn) {
554                         fcn = fcu->next;
555                         
556                         /* try each basepath in turn, but stop on the first one which works */
557                         for (ld = basepaths->first; ld; ld = ld->next) {
558                                 const char *basepath = (const char *)ld->data;
559                                 
560                                 if (animpath_matches_basepath(fcu->rna_path, basepath)) {
561                                         /* just need to change lists */
562                                         BLI_remlink(&srcAdt->drivers, fcu);
563                                         BLI_addtail(&dstAdt->drivers, fcu);
564                                         
565                                         /* TODO: add depsgraph flushing calls? */
566                                         
567                                         /* can stop now, as moved already */
568                                         break;
569                                 }
570                         }
571                 }
572         }
573 }
574
575 /**
576  * Temporary wrapper for driver operators for buttons to make it easier to create
577  * such drivers by rerouting all paths through the active object instead so that
578  * they will get picked up by the dependency system.
579  *
580  * \param C Context pointer - for getting active data
581  * \param[in,out] ptr RNA pointer for property's datablock. May be modified as result of path remapping.
582  * \param prop RNA definition of property to add for
583  * \return MEM_alloc'd string representing the path to the property from the given #PointerRNA
584  */
585 char *BKE_animdata_driver_path_hack(bContext *C, PointerRNA *ptr, PropertyRNA *prop, char *base_path)
586 {
587         ID *id = (ID *)ptr->id.data;
588         ScrArea *sa = CTX_wm_area(C);
589
590         /* get standard path which may be extended */
591         char *basepath = base_path ? base_path : RNA_path_from_ID_to_property(ptr, prop);
592         char *path = basepath; /* in case no remapping is needed */
593
594         /* Remapping will only be performed in the Properties Editor, as only this
595          * restricts the subspace of options to the 'active' data (a manageable state)
596          */
597         /* TODO: watch out for pinned context? */
598         if ((sa) && (sa->spacetype == SPACE_BUTS)) {
599                 Object *ob = CTX_data_active_object(C);
600
601                 if (ob && id) {
602                         /* only id-types which can be remapped to go through objects should be considered */
603                         switch (GS(id->name)) {
604                                 case ID_TE: /* textures */
605                                 {
606                                         Material *ma = give_current_material(ob, ob->actcol);
607                                         Tex *tex = give_current_material_texture(ma);
608
609                                         /* assumes: texture will only be shown if it is active material's active texture it's ok */
610                                         if ((ID *)tex == id) {
611                                                 char name_esc_ma[(sizeof(ma->id.name) - 2) * 2];
612                                                 char name_esc_tex[(sizeof(tex->id.name) - 2) * 2];
613
614                                                 BLI_strescape(name_esc_ma, ma->id.name + 2, sizeof(name_esc_ma));
615                                                 BLI_strescape(name_esc_tex, tex->id.name + 2, sizeof(name_esc_tex));
616
617                                                 /* create new path */
618                                                 // TODO: use RNA path functions to construct step by step instead?
619                                                 // FIXME: maybe this isn't even needed anymore...
620                                                 path = BLI_sprintfN("material_slots[\"%s\"].material.texture_slots[\"%s\"].texture.%s",
621                                                                     name_esc_ma, name_esc_tex, basepath);
622
623                                                 /* free old one */
624                                                 if (basepath != base_path)
625                                                         MEM_freeN(basepath);
626                                         }
627                                         break;
628                                 }
629                                 default:
630                                         break;
631                         }
632
633                         /* fix RNA pointer, as we've now changed the ID root by changing the paths */
634                         if (basepath != path) {
635                                 /* rebase provided pointer so that it starts from object... */
636                                 RNA_pointer_create(&ob->id, ptr->type, ptr->data, ptr);
637                         }
638                 }
639         }
640
641         /* the path should now have been corrected for use */
642         return path;
643 }
644
645 /* Path Validation -------------------------------------------- */
646
647 /* Check if a given RNA Path is valid, by tracing it from the given ID, and seeing if we can resolve it */
648 static bool check_rna_path_is_valid(ID *owner_id, const char *path)
649 {
650         PointerRNA id_ptr, ptr;
651         PropertyRNA *prop = NULL;
652         
653         /* make initial RNA pointer to start resolving from */
654         RNA_id_pointer_create(owner_id, &id_ptr);
655         
656         /* try to resolve */
657         return RNA_path_resolve_property(&id_ptr, path, &ptr, &prop); 
658 }
659
660 /* Check if some given RNA Path needs fixing - free the given path and set a new one as appropriate 
661  * NOTE: we assume that oldName and newName have [" "] padding around them
662  */
663 static char *rna_path_rename_fix(ID *owner_id, const char *prefix, const char *oldName, const char *newName, char *oldpath, bool verify_paths)
664 {
665         char *prefixPtr = strstr(oldpath, prefix);
666         char *oldNamePtr = strstr(oldpath, oldName);
667         int prefixLen = strlen(prefix);
668         int oldNameLen = strlen(oldName);
669         
670         /* only start fixing the path if the prefix and oldName feature in the path,
671          * and prefix occurs immediately before oldName
672          */
673         if ( (prefixPtr && oldNamePtr) && (prefixPtr + prefixLen == oldNamePtr) ) {
674                 /* if we haven't aren't able to resolve the path now, try again after fixing it */
675                 if (!verify_paths || check_rna_path_is_valid(owner_id, oldpath) == 0) {
676                         DynStr *ds = BLI_dynstr_new();
677                         const char *postfixPtr = oldNamePtr + oldNameLen;
678                         char *newPath = NULL;
679
680                         /* add the part of the string that goes up to the start of the prefix */
681                         if (prefixPtr > oldpath) {
682                                 BLI_dynstr_nappend(ds, oldpath, prefixPtr - oldpath);
683                         }
684                         
685                         /* add the prefix */
686                         BLI_dynstr_append(ds, prefix);
687                         
688                         /* add the new name (complete with brackets) */
689                         BLI_dynstr_append(ds, newName);
690                         
691                         /* add the postfix */
692                         BLI_dynstr_append(ds, postfixPtr);
693                         
694                         /* create new path, and cleanup old data */
695                         newPath = BLI_dynstr_get_cstring(ds);
696                         BLI_dynstr_free(ds);
697                         
698                         /* check if the new path will solve our problems */
699                         /* TODO: will need to check whether this step really helps in practice */
700                         if (!verify_paths || check_rna_path_is_valid(owner_id, newPath)) {
701                                 /* free the old path, and return the new one, since we've solved the issues */
702                                 MEM_freeN(oldpath);
703                                 return newPath;
704                         }
705                         else {
706                                 /* still couldn't resolve the path... so, might as well just leave it alone */
707                                 MEM_freeN(newPath);
708                         }
709                 }
710         }
711         
712         /* the old path doesn't need to be changed */
713         return oldpath;
714 }
715
716 /* Check RNA-Paths for a list of F-Curves */
717 static void fcurves_path_rename_fix(ID *owner_id, const char *prefix, const char *oldName, const char *newName, 
718                                     const char *oldKey, const char *newKey, ListBase *curves, bool verify_paths)
719 {
720         FCurve *fcu;
721         
722         /* we need to check every curve... */
723         for (fcu = curves->first; fcu; fcu = fcu->next) {
724                 if (fcu->rna_path) {
725                         const char *old_path = fcu->rna_path;
726                         
727                         /* firstly, handle the F-Curve's own path */
728                         fcu->rna_path = rna_path_rename_fix(owner_id, prefix, oldKey, newKey, fcu->rna_path, verify_paths);
729                         
730                         /* if path changed and the F-Curve is grouped, check if its group also needs renaming
731                          * (i.e. F-Curve is first of a bone's F-Curves; hence renaming this should also trigger rename)
732                          */
733                         if (fcu->rna_path != old_path) {
734                                 bActionGroup *agrp = fcu->grp;
735                                 
736                                 if ((agrp) && STREQ(oldName, agrp->name)) {
737                                         BLI_strncpy(agrp->name, newName, sizeof(agrp->name));
738                                 }
739                         }
740                 }
741         }
742 }
743
744 /* Check RNA-Paths for a list of Drivers */
745 static void drivers_path_rename_fix(ID *owner_id, ID *ref_id, const char *prefix, const char *oldName, const char *newName,
746                                     const char *oldKey, const char *newKey, ListBase *curves, bool verify_paths)
747 {
748         FCurve *fcu;
749         
750         /* we need to check every curve - drivers are F-Curves too! */
751         for (fcu = curves->first; fcu; fcu = fcu->next) {
752                 /* firstly, handle the F-Curve's own path */
753                 if (fcu->rna_path)
754                         fcu->rna_path = rna_path_rename_fix(owner_id, prefix, oldKey, newKey, fcu->rna_path, verify_paths);
755                 
756                 /* driver? */
757                 if (fcu->driver) {
758                         ChannelDriver *driver = fcu->driver;
759                         DriverVar *dvar;
760                         
761                         /* driver variables */
762                         for (dvar = driver->variables.first; dvar; dvar = dvar->next) {
763                                 /* only change the used targets, since the others will need fixing manually anyway */
764                                 DRIVER_TARGETS_USED_LOOPER(dvar) 
765                                 {
766                                         /* rename RNA path */
767                                         if (dtar->rna_path && dtar->id)
768                                                 dtar->rna_path = rna_path_rename_fix(dtar->id, prefix, oldKey, newKey, dtar->rna_path, verify_paths);
769                                         
770                                         /* also fix the bone-name (if applicable) */
771                                         if (strstr(prefix, "bones")) {
772                                                 if ( ((dtar->id) && (GS(dtar->id->name) == ID_OB) && (!ref_id || ((Object *)(dtar->id))->data == ref_id)) &&
773                                                      (dtar->pchan_name[0]) && STREQ(oldName, dtar->pchan_name) )
774                                                 {
775                                                         BLI_strncpy(dtar->pchan_name, newName, sizeof(dtar->pchan_name));
776                                                 }
777                                         }
778                                 }
779                                 DRIVER_TARGETS_LOOPER_END
780                         }
781                 }
782         }
783 }
784
785 /* Fix all RNA-Paths for Actions linked to NLA Strips */
786 static void nlastrips_path_rename_fix(ID *owner_id, const char *prefix, const char *oldName, const char *newName, 
787                                       const char *oldKey, const char *newKey, ListBase *strips, bool verify_paths)
788 {
789         NlaStrip *strip;
790         
791         /* recursively check strips, fixing only actions... */
792         for (strip = strips->first; strip; strip = strip->next) {
793                 /* fix strip's action */
794                 if (strip->act)
795                         fcurves_path_rename_fix(owner_id, prefix, oldName, newName, oldKey, newKey, &strip->act->curves, verify_paths);
796                 /* ignore own F-Curves, since those are local...  */
797                 
798                 /* check sub-strips (if metas) */
799                 nlastrips_path_rename_fix(owner_id, prefix, oldName, newName, oldKey, newKey, &strip->strips, verify_paths);
800         }
801 }
802
803 /* ----------------------- */
804
805
806 /* Fix up the given RNA-Path
807  *
808  * This is just an external wrapper for the RNA-Path fixing function,
809  * with input validity checks on top of the basic method.
810  *
811  * NOTE: it is assumed that the structure we're replacing is <prefix><["><name><"]>
812  *       i.e. pose.bones["Bone"]
813  */
814 char *BKE_animsys_fix_rna_path_rename(ID *owner_id, char *old_path, const char *prefix, const char *oldName,
815                                       const char *newName, int oldSubscript, int newSubscript, bool verify_paths)
816 {
817         char *oldN, *newN;
818         char *result;
819         
820         /* if no action, no need to proceed */
821         if (ELEM(NULL, owner_id, old_path)) {
822                 printf("early abort\n");
823                 return old_path;
824         }
825         
826         /* Name sanitation logic - copied from BKE_animdata_fix_paths_rename() */
827         if ((oldName != NULL) && (newName != NULL)) {
828                 /* pad the names with [" "] so that only exact matches are made */
829                 const size_t name_old_len = strlen(oldName);
830                 const size_t name_new_len = strlen(newName);
831                 char *name_old_esc = BLI_array_alloca(name_old_esc, (name_old_len * 2) + 1);
832                 char *name_new_esc = BLI_array_alloca(name_new_esc, (name_new_len * 2) + 1);
833
834                 BLI_strescape(name_old_esc, oldName, (name_old_len * 2) + 1);
835                 BLI_strescape(name_new_esc, newName, (name_new_len * 2) + 1);
836                 oldN = BLI_sprintfN("[\"%s\"]", name_old_esc);
837                 newN = BLI_sprintfN("[\"%s\"]", name_new_esc);
838         }
839         else {
840                 oldN = BLI_sprintfN("[%d]", oldSubscript);
841                 newN = BLI_sprintfN("[%d]", newSubscript);
842         }
843         
844         /* fix given path */
845         printf("%s | %s  | oldpath = %p ", oldN, newN, old_path);
846         result = rna_path_rename_fix(owner_id, prefix, oldN, newN, old_path, verify_paths);
847         printf("result = %p\n", result);
848         
849         /* free the temp names */
850         MEM_freeN(oldN);
851         MEM_freeN(newN);
852         
853         /* return the resulting path - may be the same path again if nothing changed */
854         return result;
855 }
856
857 /* Fix all RNA_Paths in the given Action, relative to the given ID block 
858  *
859  * This is just an external wrapper for the F-Curve fixing function,
860  * with input validity checks on top of the basic method.
861  *
862  * NOTE: it is assumed that the structure we're replacing is <prefix><["><name><"]>
863  *       i.e. pose.bones["Bone"]
864  */
865 void BKE_action_fix_paths_rename(ID *owner_id, bAction *act, const char *prefix, const char *oldName,
866                                  const char *newName, int oldSubscript, int newSubscript, bool verify_paths)
867 {
868         char *oldN, *newN;
869         
870         /* if no action, no need to proceed */
871         if (ELEM(NULL, owner_id, act))
872                 return;
873         
874         /* Name sanitation logic - copied from BKE_animdata_fix_paths_rename() */
875         if ((oldName != NULL) && (newName != NULL)) {
876                 /* pad the names with [" "] so that only exact matches are made */
877                 const size_t name_old_len = strlen(oldName);
878                 const size_t name_new_len = strlen(newName);
879                 char *name_old_esc = BLI_array_alloca(name_old_esc, (name_old_len * 2) + 1);
880                 char *name_new_esc = BLI_array_alloca(name_new_esc, (name_new_len * 2) + 1);
881
882                 BLI_strescape(name_old_esc, oldName, (name_old_len * 2) + 1);
883                 BLI_strescape(name_new_esc, newName, (name_new_len * 2) + 1);
884                 oldN = BLI_sprintfN("[\"%s\"]", name_old_esc);
885                 newN = BLI_sprintfN("[\"%s\"]", name_new_esc);
886         }
887         else {
888                 oldN = BLI_sprintfN("[%d]", oldSubscript);
889                 newN = BLI_sprintfN("[%d]", newSubscript);
890         }
891         
892         /* fix paths in action */
893         fcurves_path_rename_fix(owner_id, prefix, oldName, newName, oldN, newN, &act->curves, verify_paths);
894         
895         /* free the temp names */
896         MEM_freeN(oldN);
897         MEM_freeN(newN);
898 }
899
900 /* Fix all RNA-Paths in the AnimData block used by the given ID block
901  * NOTE: it is assumed that the structure we're replacing is <prefix><["><name><"]>
902  *       i.e. pose.bones["Bone"]
903  */
904 void BKE_animdata_fix_paths_rename(ID *owner_id, AnimData *adt, ID *ref_id, const char *prefix, const char *oldName,
905                                    const char *newName, int oldSubscript, int newSubscript, bool verify_paths)
906 {
907         NlaTrack *nlt;
908         char *oldN, *newN;
909         
910         /* if no AnimData, no need to proceed */
911         if (ELEM(NULL, owner_id, adt))
912                 return;
913         
914         /* Name sanitation logic - shared with BKE_action_fix_paths_rename() */
915         if ((oldName != NULL) && (newName != NULL)) {
916                 /* pad the names with [" "] so that only exact matches are made */
917                 const size_t name_old_len = strlen(oldName);
918                 const size_t name_new_len = strlen(newName);
919                 char *name_old_esc = BLI_array_alloca(name_old_esc, (name_old_len * 2) + 1);
920                 char *name_new_esc = BLI_array_alloca(name_new_esc, (name_new_len * 2) + 1);
921
922                 BLI_strescape(name_old_esc, oldName, (name_old_len * 2) + 1);
923                 BLI_strescape(name_new_esc, newName, (name_new_len * 2) + 1);
924                 oldN = BLI_sprintfN("[\"%s\"]", name_old_esc);
925                 newN = BLI_sprintfN("[\"%s\"]", name_new_esc);
926         }
927         else {
928                 oldN = BLI_sprintfN("[%d]", oldSubscript);
929                 newN = BLI_sprintfN("[%d]", newSubscript);
930         }
931         
932         /* Active action and temp action */
933         if (adt->action)
934                 fcurves_path_rename_fix(owner_id, prefix, oldName, newName, oldN, newN, &adt->action->curves, verify_paths);
935         if (adt->tmpact)
936                 fcurves_path_rename_fix(owner_id, prefix, oldName, newName, oldN, newN, &adt->tmpact->curves, verify_paths);
937                 
938         /* Drivers - Drivers are really F-Curves */
939         drivers_path_rename_fix(owner_id, ref_id, prefix, oldName, newName, oldN, newN, &adt->drivers, verify_paths);
940         
941         /* NLA Data - Animation Data for Strips */
942         for (nlt = adt->nla_tracks.first; nlt; nlt = nlt->next)
943                 nlastrips_path_rename_fix(owner_id, prefix, oldName, newName, oldN, newN, &nlt->strips, verify_paths);
944
945         /* free the temp names */
946         MEM_freeN(oldN);
947         MEM_freeN(newN);
948 }
949
950 /* *************************** */
951 /* remove of individual paths */
952
953 /* Check RNA-Paths for a list of F-Curves */
954 static void fcurves_path_remove_fix(const char *prefix, ListBase *curves)
955 {
956         FCurve *fcu, *fcn;
957         if (!prefix) return;
958
959         /* we need to check every curve... */
960         for (fcu = curves->first; fcu; fcu = fcn) {
961                 fcn = fcu->next;
962
963                 if (fcu->rna_path) {
964                         if (STRPREFIX(fcu->rna_path, prefix)) {
965                                 BLI_remlink(curves, fcu);
966                                 free_fcurve(fcu);
967                         }
968                 }
969         }
970 }
971
972 /* Check RNA-Paths for a list of F-Curves */
973 static void nlastrips_path_remove_fix(const char *prefix, ListBase *strips)
974 {
975         NlaStrip *strip;
976
977         /* recursively check strips, fixing only actions... */
978         for (strip = strips->first; strip; strip = strip->next) {
979
980                 /* fix strip's action */
981                 if (strip->act)
982                         fcurves_path_remove_fix(prefix, &strip->act->curves);
983
984                 /* check sub-strips (if metas) */
985                 nlastrips_path_remove_fix(prefix, &strip->strips);
986         }
987 }
988
989 void BKE_animdata_fix_paths_remove(ID *id, const char *prefix)
990 {
991         /* Only some ID-blocks have this info for now, so we cast the
992          * types that do to be of type IdAdtTemplate
993          */
994         NlaTrack *nlt;
995
996         if (id_can_have_animdata(id)) {
997                 IdAdtTemplate *iat = (IdAdtTemplate *)id;
998                 AnimData *adt = iat->adt;
999
1000                 /* check if there's any AnimData to start with */
1001                 if (adt) {
1002
1003                         /* free fcurves */
1004                         if (adt->action)
1005                                 fcurves_path_remove_fix(prefix, &adt->action->curves);
1006
1007                         if (adt->tmpact)
1008                                 fcurves_path_remove_fix(prefix, &adt->tmpact->curves);
1009
1010                         /* free drivers - stored as a list of F-Curves */
1011                         fcurves_path_remove_fix(prefix, &adt->drivers);
1012
1013                         /* NLA Data - Animation Data for Strips */
1014                         for (nlt = adt->nla_tracks.first; nlt; nlt = nlt->next)
1015                                 nlastrips_path_remove_fix(prefix, &nlt->strips);
1016                 }
1017         }
1018 }
1019
1020 /* Whole Database Ops -------------------------------------------- */
1021
1022 /* apply the given callback function on all data in main database */
1023 void BKE_animdata_main_cb(Main *mainptr, ID_AnimData_Edit_Callback func, void *user_data)
1024 {
1025         ID *id;
1026
1027         /* standard data version */
1028 #define ANIMDATA_IDS_CB(first) \
1029         for (id = first; id; id = id->next) { \
1030                 AnimData *adt = BKE_animdata_from_id(id); \
1031                 if (adt) func(id, adt, user_data); \
1032         } (void)0
1033         
1034         /* "embedded" nodetree cases (i.e. scene/material/texture->nodetree) */
1035 #define ANIMDATA_NODETREE_IDS_CB(first, NtId_Type) \
1036         for (id = first; id; id = id->next) { \
1037                 AnimData *adt = BKE_animdata_from_id(id); \
1038                 NtId_Type *ntp = (NtId_Type *)id; \
1039                 if (ntp->nodetree) { \
1040                         AnimData *adt2 = BKE_animdata_from_id((ID *)ntp->nodetree); \
1041                         if (adt2) func(id, adt2, user_data); \
1042                 } \
1043                 if (adt) func(id, adt, user_data); \
1044         } (void)0
1045         
1046         /* nodes */
1047         ANIMDATA_IDS_CB(mainptr->nodetree.first);
1048         
1049         /* textures */
1050         ANIMDATA_NODETREE_IDS_CB(mainptr->tex.first, Tex);
1051         
1052         /* lamps */
1053         ANIMDATA_NODETREE_IDS_CB(mainptr->lamp.first, Lamp);
1054         
1055         /* materials */
1056         ANIMDATA_NODETREE_IDS_CB(mainptr->mat.first, Material);
1057         
1058         /* cameras */
1059         ANIMDATA_IDS_CB(mainptr->camera.first);
1060         
1061         /* shapekeys */
1062         ANIMDATA_IDS_CB(mainptr->key.first);
1063         
1064         /* metaballs */
1065         ANIMDATA_IDS_CB(mainptr->mball.first);
1066         
1067         /* curves */
1068         ANIMDATA_IDS_CB(mainptr->curve.first);
1069         
1070         /* armatures */
1071         ANIMDATA_IDS_CB(mainptr->armature.first);
1072         
1073         /* lattices */
1074         ANIMDATA_IDS_CB(mainptr->latt.first);
1075         
1076         /* meshes */
1077         ANIMDATA_IDS_CB(mainptr->mesh.first);
1078         
1079         /* particles */
1080         ANIMDATA_IDS_CB(mainptr->particle.first);
1081
1082         /* speakers */
1083         ANIMDATA_IDS_CB(mainptr->speaker.first);
1084
1085         /* movie clips */
1086         ANIMDATA_IDS_CB(mainptr->movieclip.first);
1087
1088         /* objects */
1089         ANIMDATA_IDS_CB(mainptr->object.first);
1090
1091         /* masks */
1092         ANIMDATA_IDS_CB(mainptr->mask.first);
1093         
1094         /* worlds */
1095         ANIMDATA_NODETREE_IDS_CB(mainptr->world.first, World);
1096
1097         /* scenes */
1098         ANIMDATA_NODETREE_IDS_CB(mainptr->scene.first, Scene);
1099
1100         /* line styles */
1101         ANIMDATA_IDS_CB(mainptr->linestyle.first);
1102         
1103         /* grease pencil */
1104         ANIMDATA_IDS_CB(mainptr->gpencil.first);
1105
1106         /* cache files */
1107         ANIMDATA_IDS_CB(mainptr->cachefiles.first);
1108 }
1109
1110 /* Fix all RNA-Paths throughout the database (directly access the Global.main version)
1111  * NOTE: it is assumed that the structure we're replacing is <prefix><["><name><"]>
1112  *      i.e. pose.bones["Bone"]
1113  */
1114 /* TODO: use BKE_animdata_main_cb for looping over all data  */
1115 void BKE_animdata_fix_paths_rename_all(ID *ref_id, const char *prefix, const char *oldName, const char *newName)
1116 {
1117         Main *mainptr = G.main;
1118         ID *id;
1119         
1120         /* macro for less typing 
1121          *      - whether animdata exists is checked for by the main renaming callback, though taking 
1122          *        this outside of the function may make things slightly faster?
1123          */
1124 #define RENAMEFIX_ANIM_IDS(first) \
1125         for (id = first; id; id = id->next) { \
1126                 AnimData *adt = BKE_animdata_from_id(id); \
1127                 BKE_animdata_fix_paths_rename(id, adt, ref_id, prefix, oldName, newName, 0, 0, 1); \
1128         } (void)0
1129         
1130         /* another version of this macro for nodetrees */
1131 #define RENAMEFIX_ANIM_NODETREE_IDS(first, NtId_Type) \
1132         for (id = first; id; id = id->next) { \
1133                 AnimData *adt = BKE_animdata_from_id(id); \
1134                 NtId_Type *ntp = (NtId_Type *)id; \
1135                 if (ntp->nodetree) { \
1136                         AnimData *adt2 = BKE_animdata_from_id((ID *)ntp->nodetree); \
1137                         BKE_animdata_fix_paths_rename((ID *)ntp->nodetree, adt2, ref_id, prefix, oldName, newName, 0, 0, 1); \
1138                 } \
1139                 BKE_animdata_fix_paths_rename(id, adt, ref_id, prefix, oldName, newName, 0, 0, 1); \
1140         } (void)0
1141         
1142         /* nodes */
1143         RENAMEFIX_ANIM_IDS(mainptr->nodetree.first);
1144         
1145         /* textures */
1146         RENAMEFIX_ANIM_NODETREE_IDS(mainptr->tex.first, Tex);
1147         
1148         /* lamps */
1149         RENAMEFIX_ANIM_NODETREE_IDS(mainptr->lamp.first, Lamp);
1150         
1151         /* materials */
1152         RENAMEFIX_ANIM_NODETREE_IDS(mainptr->mat.first, Material);
1153         
1154         /* cameras */
1155         RENAMEFIX_ANIM_IDS(mainptr->camera.first);
1156         
1157         /* shapekeys */
1158         RENAMEFIX_ANIM_IDS(mainptr->key.first);
1159         
1160         /* metaballs */
1161         RENAMEFIX_ANIM_IDS(mainptr->mball.first);
1162         
1163         /* curves */
1164         RENAMEFIX_ANIM_IDS(mainptr->curve.first);
1165         
1166         /* armatures */
1167         RENAMEFIX_ANIM_IDS(mainptr->armature.first);
1168         
1169         /* lattices */
1170         RENAMEFIX_ANIM_IDS(mainptr->latt.first);
1171         
1172         /* meshes */
1173         RENAMEFIX_ANIM_IDS(mainptr->mesh.first);
1174         
1175         /* particles */
1176         RENAMEFIX_ANIM_IDS(mainptr->particle.first);
1177
1178         /* speakers */
1179         RENAMEFIX_ANIM_IDS(mainptr->speaker.first);
1180
1181         /* movie clips */
1182         RENAMEFIX_ANIM_IDS(mainptr->movieclip.first);
1183
1184         /* objects */
1185         RENAMEFIX_ANIM_IDS(mainptr->object.first); 
1186
1187         /* masks */
1188         RENAMEFIX_ANIM_IDS(mainptr->mask.first);
1189         
1190         /* worlds */
1191         RENAMEFIX_ANIM_NODETREE_IDS(mainptr->world.first, World);
1192         
1193         /* linestyles */
1194         RENAMEFIX_ANIM_IDS(mainptr->linestyle.first);
1195         
1196         /* grease pencil */
1197         RENAMEFIX_ANIM_IDS(mainptr->gpencil.first);
1198
1199         /* cache files */
1200         RENAMEFIX_ANIM_IDS(mainptr->cachefiles.first);
1201         
1202         /* scenes */
1203         RENAMEFIX_ANIM_NODETREE_IDS(mainptr->scene.first, Scene);
1204 }
1205
1206 /* *********************************** */ 
1207 /* KeyingSet API */
1208
1209 /* Finding Tools --------------------------- */
1210
1211 /* Find the first path that matches the given criteria */
1212 /* TODO: do we want some method to perform partial matches too? */
1213 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))
1214 {
1215         KS_Path *ksp;
1216         
1217         /* sanity checks */
1218         if (ELEM(NULL, ks, rna_path, id))
1219                 return NULL;
1220         
1221         /* loop over paths in the current KeyingSet, finding the first one where all settings match 
1222          * (i.e. the first one where none of the checks fail and equal 0)
1223          */
1224         for (ksp = ks->paths.first; ksp; ksp = ksp->next) {
1225                 short eq_id = 1, eq_path = 1, eq_index = 1, eq_group = 1;
1226                 
1227                 /* id */
1228                 if (id != ksp->id)
1229                         eq_id = 0;
1230                 
1231                 /* path */
1232                 if ((ksp->rna_path == NULL) || !STREQ(rna_path, ksp->rna_path))
1233                         eq_path = 0;
1234                         
1235                 /* index - need to compare whole-array setting too... */
1236                 if (ksp->array_index != array_index)
1237                         eq_index = 0;
1238                         
1239                 /* group */
1240                 if (group_name) {
1241                         /* FIXME: these checks need to be coded... for now, it's not too important though */
1242                 }
1243                         
1244                 /* if all aspects are ok, return */
1245                 if (eq_id && eq_path && eq_index && eq_group)
1246                         return ksp;
1247         }
1248         
1249         /* none found */
1250         return NULL;
1251 }
1252  
1253 /* Defining Tools --------------------------- */
1254
1255 /* Used to create a new 'custom' KeyingSet for the user, that will be automatically added to the stack */
1256 KeyingSet *BKE_keyingset_add(ListBase *list, const char idname[], const char name[], short flag, short keyingflag)
1257 {
1258         KeyingSet *ks;
1259         
1260         /* allocate new KeyingSet */
1261         ks = MEM_callocN(sizeof(KeyingSet), "KeyingSet");
1262
1263         BLI_strncpy(ks->idname, (idname) ? idname : (name) ? name     : DATA_("KeyingSet"),  sizeof(ks->idname));
1264         BLI_strncpy(ks->name,   (name) ? name     : (idname) ? idname : DATA_("Keying Set"), sizeof(ks->name));
1265
1266         ks->flag = flag;
1267         ks->keyingflag = keyingflag;
1268         ks->keyingoverride = keyingflag; /* NOTE: assume that if one is set one way, the other should be too, so that it'll work */
1269         
1270         /* add KeyingSet to list */
1271         BLI_addtail(list, ks);
1272         
1273         /* Make sure KeyingSet has a unique idname */
1274         BLI_uniquename(list, ks, DATA_("KeyingSet"), '.', offsetof(KeyingSet, idname), sizeof(ks->idname));
1275         
1276         /* Make sure KeyingSet has a unique label (this helps with identification) */
1277         BLI_uniquename(list, ks, DATA_("Keying Set"), '.', offsetof(KeyingSet, name), sizeof(ks->name));
1278         
1279         /* return new KeyingSet for further editing */
1280         return ks;
1281 }
1282
1283 /* Add a path to a KeyingSet. Nothing is returned for now...
1284  * Checks are performed to ensure that destination is appropriate for the KeyingSet in question
1285  */
1286 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)
1287 {
1288         KS_Path *ksp;
1289         
1290         /* sanity checks */
1291         if (ELEM(NULL, ks, rna_path)) {
1292                 printf("ERROR: no Keying Set and/or RNA Path to add path with\n");
1293                 return NULL;
1294         }
1295         
1296         /* ID is required for all types of KeyingSets */
1297         if (id == NULL) {
1298                 printf("ERROR: No ID provided for Keying Set Path\n");
1299                 return NULL;
1300         }
1301         
1302         /* don't add if there is already a matching KS_Path in the KeyingSet */
1303         if (BKE_keyingset_find_path(ks, id, group_name, rna_path, array_index, groupmode)) {
1304                 if (G.debug & G_DEBUG)
1305                         printf("ERROR: destination already exists in Keying Set\n");
1306                 return NULL;
1307         }
1308         
1309         /* allocate a new KeyingSet Path */
1310         ksp = MEM_callocN(sizeof(KS_Path), "KeyingSet Path");
1311         
1312         /* just store absolute info */
1313         ksp->id = id;
1314         if (group_name)
1315                 BLI_strncpy(ksp->group, group_name, sizeof(ksp->group));
1316         else
1317                 ksp->group[0] = '\0';
1318         
1319         /* store additional info for relative paths (just in case user makes the set relative) */
1320         if (id)
1321                 ksp->idtype = GS(id->name);
1322         
1323         /* just copy path info */
1324         /* TODO: should array index be checked too? */
1325         ksp->rna_path = BLI_strdup(rna_path);
1326         ksp->array_index = array_index;
1327         
1328         /* store flags */
1329         ksp->flag = flag;
1330         ksp->groupmode = groupmode;
1331         
1332         /* add KeyingSet path to KeyingSet */
1333         BLI_addtail(&ks->paths, ksp);
1334         
1335         /* return this path */
1336         return ksp;
1337 }       
1338
1339 /* Free the given Keying Set path */
1340 void BKE_keyingset_free_path(KeyingSet *ks, KS_Path *ksp)
1341 {
1342         /* sanity check */
1343         if (ELEM(NULL, ks, ksp))
1344                 return;
1345
1346         /* free RNA-path info */
1347         if (ksp->rna_path)
1348                 MEM_freeN(ksp->rna_path);
1349
1350         /* free path itself */
1351         BLI_freelinkN(&ks->paths, ksp);
1352 }
1353
1354 /* Copy all KeyingSets in the given list */
1355 void BKE_keyingsets_copy(ListBase *newlist, const ListBase *list)
1356 {
1357         KeyingSet *ksn;
1358         KS_Path *kspn;
1359         
1360         BLI_duplicatelist(newlist, list);
1361
1362         for (ksn = newlist->first; ksn; ksn = ksn->next) {
1363                 BLI_duplicatelist(&ksn->paths, &ksn->paths);
1364                 
1365                 for (kspn = ksn->paths.first; kspn; kspn = kspn->next)
1366                         kspn->rna_path = MEM_dupallocN(kspn->rna_path);
1367         }
1368 }
1369
1370 /* Freeing Tools --------------------------- */
1371
1372 /* Free data for KeyingSet but not set itself */
1373 void BKE_keyingset_free(KeyingSet *ks)
1374 {
1375         KS_Path *ksp, *kspn;
1376         
1377         /* sanity check */
1378         if (ks == NULL)
1379                 return;
1380         
1381         /* free each path as we go to avoid looping twice */
1382         for (ksp = ks->paths.first; ksp; ksp = kspn) {
1383                 kspn = ksp->next;
1384                 BKE_keyingset_free_path(ks, ksp);
1385         }
1386 }
1387
1388 /* Free all the KeyingSets in the given list */
1389 void BKE_keyingsets_free(ListBase *list)
1390 {
1391         KeyingSet *ks, *ksn;
1392         
1393         /* sanity check */
1394         if (list == NULL)
1395                 return;
1396         
1397         /* loop over KeyingSets freeing them 
1398          *  - BKE_keyingset_free() doesn't free the set itself, but it frees its sub-data
1399          */
1400         for (ks = list->first; ks; ks = ksn) {
1401                 ksn = ks->next;
1402                 BKE_keyingset_free(ks);
1403                 BLI_freelinkN(list, ks);
1404         }
1405 }
1406
1407 /* ***************************************** */
1408 /* Evaluation Data-Setting Backend */
1409
1410 /* Retrieve string to act as RNA-path, adjusted using mapping-table if provided 
1411  * It returns whether the string needs to be freed (i.e. if it was a temp remapped one)
1412  * // 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
1413  *
1414  *      - remap: remapping table to use
1415  *      - path: original path string (as stored in F-Curve data)
1416  *      - dst: destination string to write data to
1417  */
1418 static bool animsys_remap_path(AnimMapper *UNUSED(remap), char *path, char **dst)
1419 {
1420         /* is there a valid remapping table to use? */
1421 #if 0
1422         if (remap) {
1423                 /* find a matching entry... to use to remap */
1424                 /* ...TODO... */
1425         }
1426 #endif
1427
1428         /* nothing suitable found, so just set dst to look at path (i.e. no alloc/free needed) */
1429         *dst = path;
1430         return false;
1431 }
1432
1433 static bool animsys_store_rna_setting(
1434         PointerRNA *ptr, AnimMapper *remap,
1435         /* typically 'fcu->rna_path', 'fcu->array_index' */
1436         const char *rna_path, const int array_index,
1437         PathResolvedRNA *r_result)
1438 {
1439         bool success = false;
1440
1441         char *path = NULL;
1442         bool free_path;
1443
1444         /* get path, remapped as appropriate to work in its new environment */
1445         free_path = animsys_remap_path(remap, (char *)rna_path, &path);
1446
1447         /* write value to setting */
1448         if (path) {
1449                 /* get property to write to */
1450                 if (RNA_path_resolve_property(ptr, path, &r_result->ptr, &r_result->prop)) {
1451                         if ((ptr->id.data == NULL) || RNA_property_animateable(&r_result->ptr, r_result->prop)) {
1452                                 int array_len = RNA_property_array_length(&r_result->ptr, r_result->prop);
1453
1454                                 if (array_len && array_index >= array_len) {
1455                                         if (G.debug & G_DEBUG) {
1456                                                 printf("Animato: Invalid array index. ID = '%s',  '%s[%d]', array length is %d\n",
1457                                                        (ptr->id.data) ? (((ID *)ptr->id.data)->name + 2) : "<No ID>",
1458                                                        path, array_index, array_len - 1);
1459                                         }
1460                                 }
1461                                 else {
1462                                         r_result->prop_index = array_len ? array_index : -1;
1463                                         success = true;
1464                                 }
1465                         }
1466                 }
1467                 else {
1468                         /* failed to get path */
1469                         /* XXX don't tag as failed yet though, as there are some legit situations (Action Constraint)
1470                          * where some channels will not exist, but shouldn't lock up Action */
1471                         if (G.debug & G_DEBUG) {
1472                                 printf("Animato: Invalid path. ID = '%s',  '%s[%d]'\n",
1473                                        (ptr->id.data) ? (((ID *)ptr->id.data)->name + 2) : "<No ID>",
1474                                        path, array_index);
1475                         }
1476                 }
1477         }
1478
1479         /* free temp path-info */
1480         if (free_path) {
1481                 MEM_freeN((void *)path);
1482         }
1483
1484         return success;
1485 }
1486
1487
1488 /* less than 1.0 evaluates to false, use epsilon to avoid float error */
1489 #define ANIMSYS_FLOAT_AS_BOOL(value) ((value) > ((1.0f - FLT_EPSILON)))
1490
1491 /* Write the given value to a setting using RNA, and return success */
1492 static bool animsys_write_rna_setting(PathResolvedRNA *anim_rna, const float value)
1493 {
1494         PropertyRNA *prop = anim_rna->prop;
1495         PointerRNA *ptr = &anim_rna->ptr;
1496         int array_index = anim_rna->prop_index;
1497         
1498         /* caller must ensure this is animatable */
1499         BLI_assert(RNA_property_animateable(ptr, prop) || ptr->id.data == NULL);
1500
1501         /* set value for animatable numerical values only
1502          * HACK: some local F-Curves (e.g. those on NLA Strips) are evaluated
1503          *       without an ID provided, which causes the animateable test to fail!
1504          */
1505         bool written = false;
1506
1507         switch (RNA_property_type(prop)) {
1508                 case PROP_BOOLEAN:
1509                 {
1510                         const int value_coerce = ANIMSYS_FLOAT_AS_BOOL(value);
1511                         if (array_index != -1) {
1512                                 if (RNA_property_boolean_get_index(ptr, prop, array_index) != value_coerce) {
1513                                         RNA_property_boolean_set_index(ptr, prop, array_index, value_coerce);
1514                                         written = true;
1515                                 }
1516                         }
1517                         else {
1518                                 if (RNA_property_boolean_get(ptr, prop) != value_coerce) {
1519                                         RNA_property_boolean_set(ptr, prop, value_coerce);
1520                                         written = true;
1521                                 }
1522                         }
1523                         break;
1524                 }
1525                 case PROP_INT:
1526                 {
1527                         int value_coerce = (int)value;
1528                         RNA_property_int_clamp(ptr, prop, &value_coerce);
1529                         if (array_index != -1) {
1530                                 if (RNA_property_int_get_index(ptr, prop, array_index) != value_coerce) {
1531                                         RNA_property_int_set_index(ptr, prop, array_index, value_coerce);
1532                                         written = true;
1533                                 }
1534                         }
1535                         else {
1536                                 if (RNA_property_int_get(ptr, prop) != value_coerce) {
1537                                         RNA_property_int_set(ptr, prop, value_coerce);
1538                                         written = true;
1539                                 }
1540                         }
1541                         break;
1542                 }
1543                 case PROP_FLOAT:
1544                 {
1545                         float value_coerce = value;
1546                         RNA_property_float_clamp(ptr, prop, &value_coerce);
1547                         if (array_index != -1) {
1548                                 if (RNA_property_float_get_index(ptr, prop, array_index) != value_coerce) {
1549                                         RNA_property_float_set_index(ptr, prop, array_index, value_coerce);
1550                                         written = true;
1551                                 }
1552                         }
1553                         else {
1554                                 if (RNA_property_float_get(ptr, prop) != value_coerce) {
1555                                         RNA_property_float_set(ptr, prop, value_coerce);
1556                                         written = true;
1557                                 }
1558                         }
1559                         break;
1560                 }
1561                 case PROP_ENUM:
1562                 {
1563                         const int value_coerce = (int)value;
1564                         if (RNA_property_enum_get(ptr, prop) != value_coerce) {
1565                                 RNA_property_enum_set(ptr, prop, value_coerce);
1566                                 written = true;
1567                         }
1568                         break;
1569                 }
1570                 default:
1571                         /* nothing can be done here... so it is unsuccessful? */
1572                         return false;
1573         }
1574
1575         /* RNA property update disabled for now - [#28525] [#28690] [#28774] [#28777] */
1576 #if 0
1577         /* buffer property update for later flushing */
1578         if (written && RNA_property_update_check(prop)) {
1579                 short skip_updates_hack = 0;
1580
1581                 /* optimization hacks: skip property updates for those properties
1582                  * for we know that which the updates in RNA were really just for
1583                  * flushing property editing via UI/Py
1584                  */
1585                 if (new_ptr.type == &RNA_PoseBone) {
1586                         /* bone transforms - update pose (i.e. tag depsgraph) */
1587                         skip_updates_hack = 1;
1588                 }
1589
1590                 if (skip_updates_hack == 0)
1591                         RNA_property_update_cache_add(ptr, prop);
1592         }
1593 #endif
1594
1595         /* as long as we don't do property update, we still tag datablock
1596          * as having been updated. this flag does not cause any updates to
1597          * be run, it's for e.g. render engines to synchronize data */
1598         if (written && ptr->id.data) {
1599                 ID *id = ptr->id.data;
1600
1601                 /* for cases like duplifarmes it's only a temporary so don't
1602                  * notify anyone of updates */
1603                 if (!(id->tag & LIB_TAG_ANIM_NO_RECALC)) {
1604                         BKE_id_tag_set_atomic(id, LIB_TAG_ID_RECALC);
1605                         DEG_id_type_tag(G.main, GS(id->name));
1606                 }
1607         }
1608
1609         /* successful */
1610         return true;
1611 }
1612
1613 /* Simple replacement based data-setting of the FCurve using RNA */
1614 bool BKE_animsys_execute_fcurve(PointerRNA *ptr, AnimMapper *remap, FCurve *fcu, float curval)
1615 {
1616         PathResolvedRNA anim_rna;
1617         bool ok = false;
1618
1619         if (animsys_store_rna_setting(ptr, remap, fcu->rna_path, fcu->array_index, &anim_rna)) {
1620                 ok = animsys_write_rna_setting(&anim_rna, curval);
1621         }
1622
1623         /* return whether we were successful */
1624         return ok;
1625 }
1626
1627 /* Evaluate all the F-Curves in the given list 
1628  * This performs a set of standard checks. If extra checks are required, separate code should be used
1629  */
1630 static void animsys_evaluate_fcurves(PointerRNA *ptr, ListBase *list, AnimMapper *remap, float ctime)
1631 {
1632         FCurve *fcu;
1633         
1634         /* calculate then execute each curve */
1635         for (fcu = list->first; fcu; fcu = fcu->next) {
1636                 /* check if this F-Curve doesn't belong to a muted group */
1637                 if ((fcu->grp == NULL) || (fcu->grp->flag & AGRP_MUTED) == 0) {
1638                         /* check if this curve should be skipped */
1639                         if ((fcu->flag & (FCURVE_MUTED | FCURVE_DISABLED)) == 0) {
1640                                 PathResolvedRNA anim_rna;
1641                                 if (animsys_store_rna_setting(ptr, remap, fcu->rna_path, fcu->array_index, &anim_rna)) {
1642                                         const float curval = calculate_fcurve(&anim_rna, fcu, ctime);
1643                                         animsys_write_rna_setting(&anim_rna, curval);
1644                                 }
1645                         }
1646                 }
1647         }
1648 }
1649
1650 /* ***************************************** */
1651 /* Driver Evaluation */
1652
1653 /* Evaluate Drivers */
1654 static void animsys_evaluate_drivers(PointerRNA *ptr, AnimData *adt, float ctime)
1655 {
1656         FCurve *fcu;
1657         
1658         /* drivers are stored as F-Curves, but we cannot use the standard code, as we need to check if
1659          * the depsgraph requested that this driver be evaluated...
1660          */
1661         for (fcu = adt->drivers.first; fcu; fcu = fcu->next) {
1662                 ChannelDriver *driver = fcu->driver;
1663                 bool ok = false;
1664                 
1665                 /* check if this driver's curve should be skipped */
1666                 if ((fcu->flag & (FCURVE_MUTED | FCURVE_DISABLED)) == 0) {
1667                         /* check if driver itself is tagged for recalculation */
1668                         /* XXX driver recalc flag is not set yet by depsgraph! */
1669                         if ((driver) && !(driver->flag & DRIVER_FLAG_INVALID) /*&& (driver->flag & DRIVER_FLAG_RECALC)*/) {
1670                                 /* evaluate this using values set already in other places
1671                                  * NOTE: for 'layering' option later on, we should check if we should remove old value before adding
1672                                  *       new to only be done when drivers only changed */
1673
1674                                 PathResolvedRNA anim_rna;
1675                                 if (animsys_store_rna_setting(ptr, NULL, fcu->rna_path, fcu->array_index, &anim_rna)) {
1676                                         const float curval = calculate_fcurve(&anim_rna, fcu, ctime);
1677                                         ok = animsys_write_rna_setting(&anim_rna, curval);
1678                                 }
1679                                 
1680                                 /* clear recalc flag */
1681                                 driver->flag &= ~DRIVER_FLAG_RECALC;
1682                                 
1683                                 /* set error-flag if evaluation failed */
1684                                 if (ok == 0)
1685                                         driver->flag |= DRIVER_FLAG_INVALID; 
1686                         }
1687                 }
1688         }
1689 }
1690
1691 /* ***************************************** */
1692 /* Actions Evaluation */
1693
1694 /* strictly not necessary for actual "evaluation", but it is a useful safety check
1695  * to reduce the amount of times that users end up having to "revive" wrongly-assigned
1696  * actions
1697  */
1698 static void action_idcode_patch_check(ID *id, bAction *act)
1699 {
1700         int idcode = 0;
1701         
1702         /* just in case */
1703         if (ELEM(NULL, id, act))
1704                 return;
1705         else
1706                 idcode = GS(id->name);
1707         
1708         /* the actual checks... hopefully not too much of a performance hit in the long run... */
1709         if (act->idroot == 0) {
1710                 /* use the current root if not set already (i.e. newly created actions and actions from 2.50-2.57 builds)
1711                  *  - this has problems if there are 2 users, and the first one encountered is the invalid one
1712                  *        in which case, the user will need to manually fix this (?)
1713                  */
1714                 act->idroot = idcode;
1715         }
1716         else if (act->idroot != idcode) {
1717                 /* only report this error if debug mode is enabled (to save performance everywhere else) */
1718                 if (G.debug & G_DEBUG) {
1719                         printf("AnimSys Safety Check Failed: Action '%s' is not meant to be used from ID-Blocks of type %d such as '%s'\n",
1720                                act->id.name + 2, idcode, id->name);
1721                 }
1722         }
1723 }
1724
1725 /* ----------------------------------------- */
1726
1727 /* Evaluate Action Group */
1728 void animsys_evaluate_action_group(PointerRNA *ptr, bAction *act, bActionGroup *agrp, AnimMapper *remap, float ctime)
1729 {
1730         FCurve *fcu;
1731         
1732         /* check if mapper is appropriate for use here (we set to NULL if it's inappropriate) */
1733         if (ELEM(NULL, act, agrp)) return;
1734         if ((remap) && (remap->target != act)) remap = NULL;
1735         
1736         action_idcode_patch_check(ptr->id.data, act);
1737         
1738         /* if group is muted, don't evaluated any of the F-Curve */
1739         if (agrp->flag & AGRP_MUTED)
1740                 return;
1741         
1742         /* calculate then execute each curve */
1743         for (fcu = agrp->channels.first; (fcu) && (fcu->grp == agrp); fcu = fcu->next) {
1744                 /* check if this curve should be skipped */
1745                 if ((fcu->flag & (FCURVE_MUTED | FCURVE_DISABLED)) == 0) {
1746                         PathResolvedRNA anim_rna;
1747                         if (animsys_store_rna_setting(ptr, remap, fcu->rna_path, fcu->array_index, &anim_rna)) {
1748                                 const float curval = calculate_fcurve(&anim_rna, fcu, ctime);
1749                                 animsys_write_rna_setting(&anim_rna, curval);
1750                         }
1751                 }
1752         }
1753 }
1754
1755 /* Evaluate Action (F-Curve Bag) */
1756 void animsys_evaluate_action(PointerRNA *ptr, bAction *act, AnimMapper *remap, float ctime)
1757 {
1758         /* check if mapper is appropriate for use here (we set to NULL if it's inappropriate) */
1759         if (act == NULL) return;
1760         if ((remap) && (remap->target != act)) remap = NULL;
1761         
1762         action_idcode_patch_check(ptr->id.data, act);
1763         
1764         /* calculate then execute each curve */
1765         animsys_evaluate_fcurves(ptr, &act->curves, remap, ctime);
1766 }
1767
1768 /* ***************************************** */
1769 /* NLA System - Evaluation */
1770
1771 /* calculate influence of strip based for given frame based on blendin/out values */
1772 static float nlastrip_get_influence(NlaStrip *strip, float cframe)
1773 {
1774         /* sanity checks - normalize the blendin/out values? */
1775         strip->blendin = fabsf(strip->blendin);
1776         strip->blendout = fabsf(strip->blendout);
1777         
1778         /* result depends on where frame is in respect to blendin/out values */
1779         if (IS_EQF(strip->blendin, 0.0f) == false && (cframe <= (strip->start + strip->blendin))) {
1780                 /* there is some blend-in */
1781                 return fabsf(cframe - strip->start) / (strip->blendin);
1782         }
1783         else if (IS_EQF(strip->blendout, 0.0f) == false && (cframe >= (strip->end - strip->blendout))) {
1784                 /* there is some blend-out */
1785                 return fabsf(strip->end - cframe) / (strip->blendout);
1786         }
1787         else {
1788                 /* in the middle of the strip, we should be full strength */
1789                 return 1.0f;
1790         }
1791 }
1792
1793 /* evaluate the evaluation time and influence for the strip, storing the results in the strip */
1794 static void nlastrip_evaluate_controls(NlaStrip *strip, float ctime)
1795 {
1796         /* now strip's evaluate F-Curves for these settings (if applicable) */
1797         if (strip->fcurves.first) {
1798                 PointerRNA strip_ptr;
1799                 
1800                 /* create RNA-pointer needed to set values */
1801                 RNA_pointer_create(NULL, &RNA_NlaStrip, strip, &strip_ptr);
1802                 
1803                 /* execute these settings as per normal */
1804                 animsys_evaluate_fcurves(&strip_ptr, &strip->fcurves, NULL, ctime);
1805         }
1806         
1807         /* analytically generate values for influence and time (if applicable)
1808          *  - we do this after the F-Curves have been evaluated to override the effects of those
1809          *    in case the override has been turned off.
1810          */
1811         if ((strip->flag & NLASTRIP_FLAG_USR_TIME) == 0)
1812                 strip->strip_time = nlastrip_get_frame(strip, ctime, NLATIME_CONVERT_EVAL);
1813         if ((strip->flag & NLASTRIP_FLAG_USR_INFLUENCE) == 0)
1814                 strip->influence = nlastrip_get_influence(strip, ctime);
1815
1816         /* if user can control the evaluation time (using F-Curves), consider the option which allows this time to be clamped
1817          * to lie within extents of the action-clip, so that a steady changing rate of progress through several cycles of the clip
1818          * can be achieved easily
1819          */
1820         /* NOTE: if we add any more of these special cases, we better group them up nicely... */
1821         if ((strip->flag & NLASTRIP_FLAG_USR_TIME) && (strip->flag & NLASTRIP_FLAG_USR_TIME_CYCLIC))
1822                 strip->strip_time = fmod(strip->strip_time - strip->actstart, strip->actend - strip->actstart);
1823 }
1824
1825 /* gets the strip active at the current time for a list of strips for evaluation purposes */
1826 NlaEvalStrip *nlastrips_ctime_get_strip(ListBase *list, ListBase *strips, short index, float ctime)
1827 {
1828         NlaStrip *strip, *estrip = NULL;
1829         NlaEvalStrip *nes;
1830         short side = 0;
1831         
1832         /* loop over strips, checking if they fall within the range */
1833         for (strip = strips->first; strip; strip = strip->next) {
1834                 /* check if current time occurs within this strip  */
1835                 if (IN_RANGE_INCL(ctime, strip->start, strip->end)) {
1836                         /* this strip is active, so try to use it */
1837                         estrip = strip;
1838                         side = NES_TIME_WITHIN;
1839                         break;
1840                 }
1841                 
1842                 /* if time occurred before current strip... */
1843                 if (ctime < strip->start) {
1844                         if (strip == strips->first) {
1845                                 /* before first strip - only try to use it if it extends backwards in time too */
1846                                 if (strip->extendmode == NLASTRIP_EXTEND_HOLD)
1847                                         estrip = strip;
1848                                         
1849                                 /* side is 'before' regardless of whether there's a useful strip */
1850                                 side = NES_TIME_BEFORE;
1851                         }
1852                         else {
1853                                 /* before next strip - previous strip has ended, but next hasn't begun, 
1854                                  * so blending mode depends on whether strip is being held or not...
1855                                  *  - only occurs when no transition strip added, otherwise the transition would have
1856                                  *    been picked up above...
1857                                  */
1858                                 strip = strip->prev;
1859                                 
1860                                 if (strip->extendmode != NLASTRIP_EXTEND_NOTHING)
1861                                         estrip = strip;
1862                                 side = NES_TIME_AFTER;
1863                         }
1864                         break;
1865                 }
1866                 
1867                 /* if time occurred after current strip... */
1868                 if (ctime > strip->end) {
1869                         /* only if this is the last strip should we do anything, and only if that is being held */
1870                         if (strip == strips->last) {
1871                                 if (strip->extendmode != NLASTRIP_EXTEND_NOTHING)
1872                                         estrip = strip;
1873                                         
1874                                 side = NES_TIME_AFTER;
1875                                 break;
1876                         }
1877                         
1878                         /* otherwise, skip... as the 'before' case will catch it more elegantly! */
1879                 }
1880         }
1881         
1882         /* check if a valid strip was found
1883          *      - must not be muted (i.e. will have contribution
1884          */
1885         if ((estrip == NULL) || (estrip->flag & NLASTRIP_FLAG_MUTED)) 
1886                 return NULL;
1887                 
1888         /* if ctime was not within the boundaries of the strip, clamp! */
1889         switch (side) {
1890                 case NES_TIME_BEFORE: /* extend first frame only */
1891                         ctime = estrip->start;
1892                         break;
1893                 case NES_TIME_AFTER: /* extend last frame only */
1894                         ctime = estrip->end;
1895                         break;
1896         }
1897         
1898         /* evaluate strip's evaluation controls  
1899          *  - skip if no influence (i.e. same effect as muting the strip)
1900          *      - negative influence is not supported yet... how would that be defined?
1901          */
1902         /* TODO: this sounds a bit hacky having a few isolated F-Curves stuck on some data it operates on... */
1903         nlastrip_evaluate_controls(estrip, ctime);
1904         if (estrip->influence <= 0.0f)
1905                 return NULL;
1906                 
1907         /* check if strip has valid data to evaluate,
1908          * and/or perform any additional type-specific actions
1909          */
1910         switch (estrip->type) {
1911                 case NLASTRIP_TYPE_CLIP: 
1912                         /* clip must have some action to evaluate */
1913                         if (estrip->act == NULL)
1914                                 return NULL;
1915                         break;
1916                 case NLASTRIP_TYPE_TRANSITION:
1917                         /* there must be strips to transition from and to (i.e. prev and next required) */
1918                         if (ELEM(NULL, estrip->prev, estrip->next))
1919                                 return NULL;
1920                                 
1921                         /* evaluate controls for the relevant extents of the bordering strips... */
1922                         nlastrip_evaluate_controls(estrip->prev, estrip->start);
1923                         nlastrip_evaluate_controls(estrip->next, estrip->end);
1924                         break;
1925         }
1926         
1927         /* add to list of strips we need to evaluate */
1928         nes = MEM_callocN(sizeof(NlaEvalStrip), "NlaEvalStrip");
1929         
1930         nes->strip = estrip;
1931         nes->strip_mode = side;
1932         nes->track_index = index;
1933         nes->strip_time = estrip->strip_time;
1934         
1935         if (list)
1936                 BLI_addtail(list, nes);
1937         
1938         return nes;
1939 }
1940
1941 /* ---------------------- */
1942
1943 /* find an NlaEvalChannel that matches the given criteria 
1944  *      - ptr and prop are the RNA data to find a match for
1945  */
1946 static NlaEvalChannel *nlaevalchan_find_match(ListBase *channels, PointerRNA *ptr, PropertyRNA *prop, int array_index)
1947 {
1948         NlaEvalChannel *nec;
1949         
1950         /* sanity check */
1951         if (channels == NULL)
1952                 return NULL;
1953         
1954         /* loop through existing channels, checking for a channel which affects the same property */
1955         for (nec = channels->first; nec; nec = nec->next) {
1956                 /* - comparing the PointerRNA's is done by comparing the pointers
1957                  *   to the actual struct the property resides in, since that all the
1958                  *   other data stored in PointerRNA cannot allow us to definitively 
1959                  *      identify the data 
1960                  */
1961                 if ((nec->ptr.data == ptr->data) && (nec->prop == prop) && (nec->index == array_index))
1962                         return nec;
1963         }
1964         
1965         /* not found */
1966         return NULL;
1967 }
1968
1969 /* initialise default value for NlaEvalChannel, so that it doesn't blend things wrong */
1970 static void nlaevalchan_value_init(NlaEvalChannel *nec)
1971 {
1972         PointerRNA *ptr = &nec->ptr;
1973         PropertyRNA *prop = nec->prop;
1974         int index = nec->index;
1975         
1976         /* NOTE: while this doesn't work for all RNA properties as default values aren't in fact 
1977          * set properly for most of them, at least the common ones (which also happen to get used 
1978          * in NLA strips a lot, e.g. scale) are set correctly.
1979          */
1980         switch (RNA_property_type(prop)) {
1981                 case PROP_BOOLEAN:
1982                         if (RNA_property_array_check(prop))
1983                                 nec->value = (float)RNA_property_boolean_get_default_index(ptr, prop, index);
1984                         else
1985                                 nec->value = (float)RNA_property_boolean_get_default(ptr, prop);
1986                         break;
1987                 case PROP_INT:
1988                         if (RNA_property_array_check(prop))
1989                                 nec->value = (float)RNA_property_int_get_default_index(ptr, prop, index);
1990                         else
1991                                 nec->value = (float)RNA_property_int_get_default(ptr, prop);
1992                         break;
1993                 case PROP_FLOAT:
1994                         if (RNA_property_array_check(prop))
1995                                 nec->value = RNA_property_float_get_default_index(ptr, prop, index);
1996                         else
1997                                 nec->value = RNA_property_float_get_default(ptr, prop);
1998                         break;
1999                 case PROP_ENUM:
2000                         nec->value = (float)RNA_property_enum_get_default(ptr, prop);
2001                         break;
2002                 default:
2003                         break;
2004         }
2005 }
2006
2007 /* verify that an appropriate NlaEvalChannel for this F-Curve exists */
2008 static NlaEvalChannel *nlaevalchan_verify(PointerRNA *ptr, ListBase *channels, NlaEvalStrip *nes, FCurve *fcu, bool *newChan)
2009 {
2010         NlaEvalChannel *nec;
2011         NlaStrip *strip = nes->strip;
2012         PropertyRNA *prop;
2013         PointerRNA new_ptr;
2014         char *path = NULL;
2015         /* short free_path = 0; */
2016         
2017         /* sanity checks */
2018         if (channels == NULL)
2019                 return NULL;
2020         
2021         /* get RNA pointer+property info from F-Curve for more convenient handling */
2022         /* get path, remapped as appropriate to work in its new environment */
2023         /* free_path = */ /* UNUSED */ animsys_remap_path(strip->remap, fcu->rna_path, &path);
2024         
2025         /* a valid property must be available, and it must be animatable */
2026         if (RNA_path_resolve_property(ptr, path, &new_ptr, &prop) == false) {
2027                 if (G.debug & G_DEBUG) printf("NLA Strip Eval: Cannot resolve path\n");
2028                 return NULL;
2029         }
2030         /* only ok if animatable */
2031         else if (RNA_property_animateable(&new_ptr, prop) == 0) {
2032                 if (G.debug & G_DEBUG) printf("NLA Strip Eval: Property not animatable\n");
2033                 return NULL;
2034         }
2035         
2036         /* try to find a match */
2037         nec = nlaevalchan_find_match(channels, &new_ptr, prop, fcu->array_index);
2038         
2039         /* allocate a new struct for this if none found */
2040         if (nec == NULL) {
2041                 nec = MEM_callocN(sizeof(NlaEvalChannel), "NlaEvalChannel");
2042                 BLI_addtail(channels, nec);
2043                 
2044                 /* store property links for writing to the property later */
2045                 nec->ptr = new_ptr;
2046                 nec->prop = prop;
2047                 nec->index = fcu->array_index;
2048                 
2049                 /* initialise value using default value of property [#35856] */
2050                 nlaevalchan_value_init(nec);
2051                 *newChan = true;
2052         }
2053         else
2054                 *newChan = false;
2055         
2056         /* we can now return */
2057         return nec;
2058 }
2059
2060 /* accumulate (i.e. blend) the given value on to the channel it affects */
2061 static void nlaevalchan_accumulate(NlaEvalChannel *nec, NlaEvalStrip *nes, float value, bool newChan)
2062 {
2063         NlaStrip *strip = nes->strip;
2064         short blendmode = strip->blendmode;
2065         float inf = strip->influence;
2066         
2067         /* for replace blend mode, and if this is the first strip,
2068          * just replace the value regardless of the influence */
2069         if (newChan && blendmode == NLASTRIP_MODE_REPLACE) {
2070                 nec->value = value;
2071                 return;
2072         }
2073
2074         /* if this is being performed as part of transition evaluation, incorporate
2075          * an additional weighting factor for the influence
2076          */
2077         if (nes->strip_mode == NES_TIME_TRANSITION_END) 
2078                 inf *= nes->strip_time;
2079         
2080         /* optimisation: no need to try applying if there is no influence */
2081         if (IS_EQF(inf, 0.0f)) return;
2082         
2083         /* perform blending */
2084         switch (blendmode) {
2085                 case NLASTRIP_MODE_ADD:
2086                         /* simply add the scaled value on to the stack */
2087                         nec->value += (value * inf);
2088                         break;
2089                         
2090                 case NLASTRIP_MODE_SUBTRACT:
2091                         /* simply subtract the scaled value from the stack */
2092                         nec->value -= (value * inf);
2093                         break;
2094                         
2095                 case NLASTRIP_MODE_MULTIPLY:
2096                         /* multiply the scaled value with the stack */
2097                         /* Formula Used: 
2098                          *     result = fac * (a * b) + (1 - fac) * a 
2099                          */
2100                         nec->value = inf * (nec->value * value)  +   (1 - inf) * nec->value;
2101                         break;
2102                 
2103                 case NLASTRIP_MODE_REPLACE:
2104                 default: /* TODO: do we really want to blend by default? it seems more uses might prefer add... */
2105                         /* do linear interpolation 
2106                          *      - the influence of the accumulated data (elsewhere, that is called dstweight) 
2107                          *        is 1 - influence, since the strip's influence is srcweight
2108                          */
2109                         nec->value = nec->value * (1.0f - inf)   +   (value * inf);
2110                         break;
2111         }
2112 }
2113
2114 /* accumulate the results of a temporary buffer with the results of the full-buffer */
2115 static void nlaevalchan_buffers_accumulate(ListBase *channels, ListBase *tmp_buffer, NlaEvalStrip *nes)
2116 {
2117         NlaEvalChannel *nec, *necn, *necd;
2118         
2119         /* optimize - abort if no channels */
2120         if (BLI_listbase_is_empty(tmp_buffer))
2121                 return;
2122         
2123         /* accumulate results in tmp_channels buffer to the accumulation buffer */
2124         for (nec = tmp_buffer->first; nec; nec = necn) {
2125                 /* get pointer to next channel in case we remove the current channel from the temp-buffer */
2126                 necn = nec->next;
2127                 
2128                 /* try to find an existing matching channel for this setting in the accumulation buffer */
2129                 necd = nlaevalchan_find_match(channels, &nec->ptr, nec->prop, nec->index);
2130                 
2131                 /* if there was a matching channel already in the buffer, accumulate to it,
2132                  * otherwise, add the current channel to the buffer for efficiency
2133                  */
2134                 if (necd)
2135                         nlaevalchan_accumulate(necd, nes, 0, nec->value);
2136                 else {
2137                         BLI_remlink(tmp_buffer, nec);
2138                         BLI_addtail(channels, nec);
2139                 }
2140         }
2141         
2142         /* free temp-channels that haven't been assimilated into the buffer */
2143         BLI_freelistN(tmp_buffer);
2144 }
2145
2146 /* ---------------------- */
2147 /* F-Modifier stack joining/separation utilities - should we generalise these for BLI_listbase.h interface? */
2148
2149 /* Temporarily join two lists of modifiers together, storing the result in a third list */
2150 static void nlaeval_fmodifiers_join_stacks(ListBase *result, ListBase *list1, ListBase *list2)
2151 {
2152         FModifier *fcm1, *fcm2;
2153         
2154         /* if list1 is invalid...  */
2155         if (ELEM(NULL, list1, list1->first)) {
2156                 if (list2 && list2->first) {
2157                         result->first = list2->first;
2158                         result->last = list2->last;
2159                 }
2160         }
2161         /* if list 2 is invalid... */
2162         else if (ELEM(NULL, list2, list2->first)) {
2163                 result->first = list1->first;
2164                 result->last = list1->last;
2165         }
2166         else {
2167                 /* list1 should be added first, and list2 second, with the endpoints of these being the endpoints for result 
2168                  *  - the original lists must be left unchanged though, as we need that fact for restoring
2169                  */
2170                 result->first = list1->first;
2171                 result->last = list2->last;
2172                 
2173                 fcm1 = list1->last;
2174                 fcm2 = list2->first;
2175                 
2176                 fcm1->next = fcm2;
2177                 fcm2->prev = fcm1;
2178         }
2179 }
2180
2181 /* Split two temporary lists of modifiers */
2182 static void nlaeval_fmodifiers_split_stacks(ListBase *list1, ListBase *list2)
2183 {
2184         FModifier *fcm1, *fcm2;
2185         
2186         /* if list1/2 is invalid... just skip */
2187         if (ELEM(NULL, list1, list2))
2188                 return;
2189         if (ELEM(NULL, list1->first, list2->first))
2190                 return;
2191                 
2192         /* get endpoints */
2193         fcm1 = list1->last;
2194         fcm2 = list2->first;
2195         
2196         /* clear their links */
2197         fcm1->next = NULL;
2198         fcm2->prev = NULL;
2199 }
2200
2201 /* ---------------------- */
2202
2203 /* evaluate action-clip strip */
2204 static void nlastrip_evaluate_actionclip(PointerRNA *ptr, ListBase *channels, ListBase *modifiers, NlaEvalStrip *nes)
2205 {
2206         FModifierStackStorage *storage;
2207         ListBase tmp_modifiers = {NULL, NULL};
2208         NlaStrip *strip = nes->strip;
2209         FCurve *fcu;
2210         float evaltime;
2211         
2212         /* sanity checks for action */
2213         if (strip == NULL)
2214                 return;
2215                 
2216         if (strip->act == NULL) {
2217                 printf("NLA-Strip Eval Error: Strip '%s' has no Action\n", strip->name);
2218                 return;
2219         }
2220         
2221         action_idcode_patch_check(ptr->id.data, strip->act);
2222         
2223         /* join this strip's modifiers to the parent's modifiers (own modifiers first) */
2224         nlaeval_fmodifiers_join_stacks(&tmp_modifiers, &strip->modifiers, modifiers);
2225         
2226         /* evaluate strip's modifiers which modify time to evaluate the base curves at */
2227         storage = evaluate_fmodifiers_storage_new(&tmp_modifiers);
2228         evaltime = evaluate_time_fmodifiers(storage, &tmp_modifiers, NULL, 0.0f, strip->strip_time);
2229         
2230         /* evaluate all the F-Curves in the action, saving the relevant pointers to data that will need to be used */
2231         for (fcu = strip->act->curves.first; fcu; fcu = fcu->next) {
2232                 NlaEvalChannel *nec;
2233                 float value = 0.0f;
2234                 bool newChan;
2235                 
2236                 /* check if this curve should be skipped */
2237                 if (fcu->flag & (FCURVE_MUTED | FCURVE_DISABLED))
2238                         continue;
2239                 if ((fcu->grp) && (fcu->grp->flag & AGRP_MUTED))
2240                         continue;
2241                         
2242                 /* evaluate the F-Curve's value for the time given in the strip 
2243                  * NOTE: we use the modified time here, since strip's F-Curve Modifiers are applied on top of this 
2244                  */
2245                 value = evaluate_fcurve(fcu, evaltime);
2246                 
2247                 /* apply strip's F-Curve Modifiers on this value 
2248                  * NOTE: we apply the strip's original evaluation time not the modified one (as per standard F-Curve eval)
2249                  */
2250                 evaluate_value_fmodifiers(storage, &tmp_modifiers, fcu, &value, strip->strip_time);
2251                 
2252                 
2253                 /* get an NLA evaluation channel to work with, and accumulate the evaluated value with the value(s)
2254                  * stored in this channel if it has been used already
2255                  */
2256                 nec = nlaevalchan_verify(ptr, channels, nes, fcu, &newChan);
2257                 if (nec)
2258                         nlaevalchan_accumulate(nec, nes, value, newChan);
2259         }
2260
2261         /* free temporary storage */
2262         evaluate_fmodifiers_storage_free(storage);
2263
2264         /* unlink this strip's modifiers from the parent's modifiers again */
2265         nlaeval_fmodifiers_split_stacks(&strip->modifiers, modifiers);
2266 }
2267
2268 /* evaluate transition strip */
2269 static void nlastrip_evaluate_transition(PointerRNA *ptr, ListBase *channels, ListBase *modifiers, NlaEvalStrip *nes)
2270 {
2271         ListBase tmp_channels = {NULL, NULL};
2272         ListBase tmp_modifiers = {NULL, NULL};
2273         NlaEvalStrip tmp_nes;
2274         NlaStrip *s1, *s2;
2275         
2276         /* join this strip's modifiers to the parent's modifiers (own modifiers first) */
2277         nlaeval_fmodifiers_join_stacks(&tmp_modifiers, &nes->strip->modifiers, modifiers);
2278         
2279         /* get the two strips to operate on 
2280          *      - we use the endpoints of the strips directly flanking our strip
2281          *        using these as the endpoints of the transition (destination and source)
2282          *      - these should have already been determined to be valid...
2283          *      - if this strip is being played in reverse, we need to swap these endpoints
2284          *        otherwise they will be interpolated wrong
2285          */
2286         if (nes->strip->flag & NLASTRIP_FLAG_REVERSE) {
2287                 s1 = nes->strip->next;
2288                 s2 = nes->strip->prev;
2289         }
2290         else {
2291                 s1 = nes->strip->prev;
2292                 s2 = nes->strip->next;
2293         }
2294         
2295         /* prepare template for 'evaluation strip' 
2296          *      - based on the transition strip's evaluation strip data
2297          *      - strip_mode is NES_TIME_TRANSITION_* based on which endpoint
2298          *      - strip_time is the 'normalized' (i.e. in-strip) time for evaluation,
2299          *        which doubles up as an additional weighting factor for the strip influences
2300          *        which allows us to appear to be 'interpolating' between the two extremes
2301          */
2302         tmp_nes = *nes;
2303         
2304         /* evaluate these strips into a temp-buffer (tmp_channels) */
2305         /* FIXME: modifier evaluation here needs some work... */
2306         /* first strip */
2307         tmp_nes.strip_mode = NES_TIME_TRANSITION_START;
2308         tmp_nes.strip = s1;
2309         nlastrip_evaluate(ptr, &tmp_channels, &tmp_modifiers, &tmp_nes);
2310         
2311         /* second strip */
2312         tmp_nes.strip_mode = NES_TIME_TRANSITION_END;
2313         tmp_nes.strip = s2;
2314         nlastrip_evaluate(ptr, &tmp_channels, &tmp_modifiers, &tmp_nes);
2315         
2316         
2317         /* accumulate temp-buffer and full-buffer, using the 'real' strip */
2318         nlaevalchan_buffers_accumulate(channels, &tmp_channels, nes);
2319         
2320         /* unlink this strip's modifiers from the parent's modifiers again */
2321         nlaeval_fmodifiers_split_stacks(&nes->strip->modifiers, modifiers);
2322 }
2323
2324 /* evaluate meta-strip */
2325 static void nlastrip_evaluate_meta(PointerRNA *ptr, ListBase *channels, ListBase *modifiers, NlaEvalStrip *nes)
2326 {
2327         ListBase tmp_modifiers = {NULL, NULL};
2328         NlaStrip *strip = nes->strip;
2329         NlaEvalStrip *tmp_nes;
2330         float evaltime;
2331         
2332         /* meta-strip was calculated normally to have some time to be evaluated at
2333          * and here we 'look inside' the meta strip, treating it as a decorated window to
2334          * it's child strips, which get evaluated as if they were some tracks on a strip 
2335          * (but with some extra modifiers to apply).
2336          *
2337          * NOTE: keep this in sync with animsys_evaluate_nla()
2338          */
2339         
2340         /* join this strip's modifiers to the parent's modifiers (own modifiers first) */
2341         nlaeval_fmodifiers_join_stacks(&tmp_modifiers, &strip->modifiers, modifiers); 
2342         
2343         /* find the child-strip to evaluate */
2344         evaltime = (nes->strip_time * (strip->end - strip->start)) + strip->start;
2345         tmp_nes = nlastrips_ctime_get_strip(NULL, &strip->strips, -1, evaltime);
2346         
2347         /* directly evaluate child strip into accumulation buffer... 
2348          * - there's no need to use a temporary buffer (as it causes issues [T40082])
2349          */
2350         if (tmp_nes) {
2351                 nlastrip_evaluate(ptr, channels, &tmp_modifiers, tmp_nes);
2352                 
2353                 /* free temp eval-strip */
2354                 MEM_freeN(tmp_nes);
2355         }
2356         
2357         /* unlink this strip's modifiers from the parent's modifiers again */
2358         nlaeval_fmodifiers_split_stacks(&strip->modifiers, modifiers);
2359 }
2360
2361 /* evaluates the given evaluation strip */
2362 void nlastrip_evaluate(PointerRNA *ptr, ListBase *channels, ListBase *modifiers, NlaEvalStrip *nes)
2363 {
2364         NlaStrip *strip = nes->strip;
2365         
2366         /* to prevent potential infinite recursion problems (i.e. transition strip, beside meta strip containing a transition
2367          * several levels deep inside it), we tag the current strip as being evaluated, and clear this when we leave
2368          */
2369         /* TODO: be careful with this flag, since some edit tools may be running and have set this while animplayback was running */
2370         if (strip->flag & NLASTRIP_FLAG_EDIT_TOUCHED)
2371                 return;
2372         strip->flag |= NLASTRIP_FLAG_EDIT_TOUCHED;
2373         
2374         /* actions to take depend on the type of strip */
2375         switch (strip->type) {
2376                 case NLASTRIP_TYPE_CLIP: /* action-clip */
2377                         nlastrip_evaluate_actionclip(ptr, channels, modifiers, nes);
2378                         break;
2379                 case NLASTRIP_TYPE_TRANSITION: /* transition */
2380                         nlastrip_evaluate_transition(ptr, channels, modifiers, nes);
2381                         break;
2382                 case NLASTRIP_TYPE_META: /* meta */
2383                         nlastrip_evaluate_meta(ptr, channels, modifiers, nes);
2384                         break;
2385                         
2386                 default: /* do nothing */
2387                         break;
2388         }
2389         
2390         /* clear temp recursion safe-check */
2391         strip->flag &= ~NLASTRIP_FLAG_EDIT_TOUCHED;
2392 }
2393
2394 /* write the accumulated settings to */
2395 void nladata_flush_channels(ListBase *channels)
2396 {
2397         NlaEvalChannel *nec;
2398         
2399         /* sanity checks */
2400         if (channels == NULL)
2401                 return;
2402         
2403         /* for each channel with accumulated values, write its value on the property it affects */
2404         for (nec = channels->first; nec; nec = nec->next) {
2405                 PointerRNA *ptr = &nec->ptr;
2406                 PropertyRNA *prop = nec->prop;
2407                 int array_index = nec->index;
2408                 float value = nec->value;
2409                 
2410                 /* write values - see animsys_write_rna_setting() to sync the code */
2411                 switch (RNA_property_type(prop)) {
2412                         case PROP_BOOLEAN:
2413                                 if (RNA_property_array_check(prop))
2414                                         RNA_property_boolean_set_index(ptr, prop, array_index, ANIMSYS_FLOAT_AS_BOOL(value));
2415                                 else
2416                                         RNA_property_boolean_set(ptr, prop, ANIMSYS_FLOAT_AS_BOOL(value));
2417                                 break;
2418                         case PROP_INT:
2419                                 if (RNA_property_array_check(prop))
2420                                         RNA_property_int_set_index(ptr, prop, array_index, (int)value);
2421                                 else
2422                                         RNA_property_int_set(ptr, prop, (int)value);
2423                                 break;
2424                         case PROP_FLOAT:
2425                                 if (RNA_property_array_check(prop))
2426                                         RNA_property_float_set_index(ptr, prop, array_index, value);
2427                                 else
2428                                         RNA_property_float_set(ptr, prop, value);
2429                                 break;
2430                         case PROP_ENUM:
2431                                 RNA_property_enum_set(ptr, prop, (int)value);
2432                                 break;
2433                         default:
2434                                 /* can't do anything with other types of property.... */
2435                                 break;
2436                 }
2437         }
2438 }
2439
2440 /* ---------------------- */
2441
2442 /**
2443  * NLA Evaluation function - values are calculated and stored in temporary "NlaEvalChannels"
2444  *
2445  * \note This is exported so that keyframing code can use this for make use of it for anim layers support
2446  *
2447  * \param[out] echannels Evaluation channels with calculated values
2448  */
2449 static void animsys_evaluate_nla(ListBase *echannels, PointerRNA *ptr, AnimData *adt, float ctime)
2450 {
2451         NlaTrack *nlt;
2452         short track_index = 0;
2453         bool has_strips = false;
2454         
2455         ListBase estrips = {NULL, NULL};
2456         NlaEvalStrip *nes;
2457         
2458         NlaStrip dummy_strip = {NULL}; /* dummy strip for active action */
2459         
2460         
2461         /* 1. get the stack of strips to evaluate at current time (influence calculated here) */
2462         for (nlt = adt->nla_tracks.first; nlt; nlt = nlt->next, track_index++) {
2463                 /* stop here if tweaking is on and this strip is the tweaking track (it will be the first one that's 'disabled')... */
2464                 if ((adt->flag & ADT_NLA_EDIT_ON) && (nlt->flag & NLATRACK_DISABLED))
2465                         break;
2466                         
2467                 /* solo and muting are mutually exclusive... */
2468                 if (adt->flag & ADT_NLA_SOLO_TRACK) {
2469                         /* skip if there is a solo track, but this isn't it */
2470                         if ((nlt->flag & NLATRACK_SOLO) == 0)
2471                                 continue;
2472                         /* else - mute doesn't matter */
2473                 }
2474                 else {
2475                         /* no solo tracks - skip track if muted */
2476                         if (nlt->flag & NLATRACK_MUTED) 
2477                                 continue;
2478                 }
2479                 
2480                 /* if this track has strips (but maybe they won't be suitable), set has_strips 
2481                  *      - used for mainly for still allowing normal action evaluation...
2482                  */
2483                 if (nlt->strips.first)
2484                         has_strips = true;
2485                         
2486                 /* otherwise, get strip to evaluate for this channel */
2487                 nes = nlastrips_ctime_get_strip(&estrips, &nlt->strips, track_index, ctime);
2488                 if (nes) nes->track = nlt;
2489         }
2490         
2491         /* add 'active' Action (may be tweaking track) as last strip to evaluate in NLA stack
2492          *      - only do this if we're not exclusively evaluating the 'solo' NLA-track
2493          *      - however, if the 'solo' track houses the current 'tweaking' strip, 
2494          *        then we should allow this to play, otherwise nothing happens
2495          */
2496         if ((adt->action) && ((adt->flag & ADT_NLA_SOLO_TRACK) == 0 || (adt->flag & ADT_NLA_EDIT_ON))) {
2497                 /* if there are strips, evaluate action as per NLA rules */
2498                 if ((has_strips) || (adt->actstrip)) {
2499                         /* make dummy NLA strip, and add that to the stack */
2500                         ListBase dummy_trackslist;
2501                         
2502                         dummy_trackslist.first = dummy_trackslist.last = &dummy_strip;
2503                         
2504                         if ((nlt) && !(adt->flag & ADT_NLA_EDIT_NOMAP)) {
2505                                 /* edit active action in-place according to its active strip, so copy the data  */
2506                                 memcpy(&dummy_strip, adt->actstrip, sizeof(NlaStrip));
2507                                 dummy_strip.next = dummy_strip.prev = NULL;
2508                         }
2509                         else {
2510                                 /* set settings of dummy NLA strip from AnimData settings */
2511                                 dummy_strip.act = adt->action;
2512                                 dummy_strip.remap = adt->remap;
2513                                 
2514                                 /* action range is calculated taking F-Modifiers into account (which making new strips doesn't do due to the troublesome nature of that) */
2515                                 calc_action_range(dummy_strip.act, &dummy_strip.actstart, &dummy_strip.actend, 1);
2516                                 dummy_strip.start = dummy_strip.actstart;
2517                                 dummy_strip.end = (IS_EQF(dummy_strip.actstart, dummy_strip.actend)) ?  (dummy_strip.actstart + 1.0f) : (dummy_strip.actend);
2518                                 
2519                                 dummy_strip.blendmode = adt->act_blendmode;
2520                                 dummy_strip.extendmode = adt->act_extendmode;
2521                                 dummy_strip.influence = adt->act_influence;
2522                                 
2523                                 /* NOTE: must set this, or else the default setting overrides, and this setting doesn't work */
2524                                 dummy_strip.flag |= NLASTRIP_FLAG_USR_INFLUENCE;
2525                         }
2526                         
2527                         /* add this to our list of evaluation strips */
2528                         nlastrips_ctime_get_strip(&estrips, &dummy_trackslist, -1, ctime);
2529                 }
2530                 else {
2531                         /* special case - evaluate as if there isn't any NLA data */
2532                         /* TODO: this is really just a stop-gap measure... */
2533                         if (G.debug & G_DEBUG) printf("NLA Eval: Stopgap for active action on NLA Stack - no strips case\n");
2534                         
2535                         animsys_evaluate_action(ptr, adt->action, adt->remap, ctime);
2536                         BLI_freelistN(&estrips);
2537                         return;
2538                 }
2539         }
2540         
2541         /* only continue if there are strips to evaluate */
2542         if (BLI_listbase_is_empty(&estrips))
2543                 return;
2544         
2545         
2546         /* 2. for each strip, evaluate then accumulate on top of existing channels, but don't set values yet */
2547         for (nes = estrips.first; nes; nes = nes->next)
2548                 nlastrip_evaluate(ptr, echannels, NULL, nes);
2549                 
2550         /* 3. free temporary evaluation data that's not used elsewhere */
2551         BLI_freelistN(&estrips);
2552
2553         /* Tag ID as updated so render engines will recognize changes in data
2554          * which is animated but doesn't have actions.
2555          */
2556         if (ptr->id.data != NULL) {
2557                 ID *id = ptr->id.data;
2558                 if (!(id->tag & LIB_TAG_ANIM_NO_RECALC)) {
2559                         id->tag |= LIB_TAG_ID_RECALC;
2560                         DEG_id_type_tag(G.main, GS(id->name));
2561                 }
2562         }
2563 }
2564
2565 /* NLA Evaluation function (mostly for use through do_animdata) 
2566  *      - All channels that will be affected are not cleared anymore. Instead, we just evaluate into 
2567  *              some temp channels, where values can be accumulated in one go.
2568  */
2569 static void animsys_calculate_nla(PointerRNA *ptr, AnimData *adt, float ctime)
2570 {
2571         ListBase echannels = {NULL, NULL};
2572
2573         /* TODO: need to zero out all channels used, otherwise we have problems with threadsafety
2574          * and also when the user jumps between different times instead of moving sequentially... */
2575
2576         /* evaluate the NLA stack, obtaining a set of values to flush */
2577         animsys_evaluate_nla(&echannels, ptr, adt, ctime);
2578         
2579         /* flush effects of accumulating channels in NLA to the actual data they affect */
2580         nladata_flush_channels(&echannels);
2581         
2582         /* free temp data */
2583         BLI_freelistN(&echannels);
2584 }
2585
2586 /* ***************************************** */ 
2587 /* Overrides System - Public API */
2588
2589 /* Clear all overrides */
2590
2591 /* Add or get existing Override for given setting */
2592 #if 0
2593 AnimOverride *BKE_animsys_validate_override(PointerRNA *UNUSED(ptr), char *UNUSED(path), int UNUSED(array_index))
2594 {
2595         /* FIXME: need to define how to get overrides */
2596         return NULL;
2597 }
2598 #endif
2599
2600 /* -------------------- */
2601
2602 /* Evaluate Overrides */
2603 static void animsys_evaluate_overrides(PointerRNA *ptr, AnimData *adt)
2604 {
2605         AnimOverride *aor;
2606         
2607         /* for each override, simply execute... */
2608         for (aor = adt->overrides.first; aor; aor = aor->next) {
2609                 PathResolvedRNA anim_rna;
2610                 if (animsys_store_rna_setting(ptr, NULL, aor->rna_path, aor->array_index, &anim_rna)) {
2611                         animsys_write_rna_setting(&anim_rna, aor->value);
2612                 }
2613         }
2614 }
2615
2616 /* ***************************************** */
2617 /* Evaluation System - Public API */
2618
2619 /* Overview of how this system works:
2620  *      1) Depsgraph sorts data as necessary, so that data is in an order that means 
2621  *              that all dependencies are resolved before dependents.
2622  *      2) All normal animation is evaluated, so that drivers have some basis values to
2623  *              work with
2624  *              a.      NLA stacks are done first, as the Active Actions act as 'tweaking' tracks
2625  *                      which modify the effects of the NLA-stacks
2626  *              b.      Active Action is evaluated as per normal, on top of the results of the NLA tracks
2627  *
2628  * --------------< often in a separate phase... >------------------ 
2629  *
2630  *      3) Drivers/expressions are evaluated on top of this, in an order where dependencies are
2631  *              resolved nicely. 
2632  *         Note: it may be necessary to have some tools to handle the cases where some higher-level
2633  *              drivers are added and cause some problematic dependencies that didn't exist in the local levels...
2634  *
2635  * --------------< always executed >------------------ 
2636  *
2637  * Maintenance of editability of settings (XXX):
2638  *      In order to ensure that settings that are animated can still be manipulated in the UI without requiring
2639  *      that keyframes are added to prevent these values from being overwritten, we use 'overrides'. 
2640  *
2641  * Unresolved things:
2642  *      - Handling of multi-user settings (i.e. time-offset, group-instancing) -> big cache grids or nodal system? but stored where?
2643  *      - Multiple-block dependencies (i.e. drivers for settings are in both local and higher levels) -> split into separate lists? 
2644  *
2645  * Current Status:
2646  *      - Currently (as of September 2009), overrides we haven't needed to (fully) implement overrides. 
2647  *    However, the code for this is relatively harmless, so is left in the code for now.
2648  */
2649
2650 /* Evaluation loop for evaluation animation data 
2651  *
2652  * This assumes that the animation-data provided belongs to the ID block in question,
2653  * and that the flags for which parts of the anim-data settings need to be recalculated 
2654  * have been set already by the depsgraph. Now, we use the recalc 
2655  */
2656 void BKE_animsys_evaluate_animdata(Scene *scene, ID *id, AnimData *adt, float ctime, short recalc)
2657 {
2658         PointerRNA id_ptr;
2659         
2660         /* sanity checks */
2661         if (ELEM(NULL, id, adt))
2662                 return;
2663         
2664         /* get pointer to ID-block for RNA to use */
2665         RNA_id_pointer_create(id, &id_ptr);
2666         
2667         /* recalculate keyframe data:
2668          *      - NLA before Active Action, as Active Action behaves as 'tweaking track'
2669          *        that overrides 'rough' work in NLA
2670          */
2671         /* TODO: need to double check that this all works correctly */
2672         if ((recalc & ADT_RECALC_ANIM) || (adt->recalc & ADT_RECALC_ANIM)) {
2673                 /* evaluate NLA data */
2674                 if ((adt->nla_tracks.first) && !(adt->flag & ADT_NLA_EVAL_OFF)) {
2675                         /* evaluate NLA-stack 
2676                          *      - active action is evaluated as part of the NLA stack as the last item
2677                          */
2678                         animsys_calculate_nla(&id_ptr, adt, ctime);
2679                 }
2680                 /* evaluate Active Action only */
2681                 else if (adt->action)
2682                         animsys_evaluate_action(&id_ptr, adt->action, adt->remap, ctime);
2683                 
2684                 /* reset tag */
2685                 adt->recalc &= ~ADT_RECALC_ANIM;
2686         }
2687         
2688         /* recalculate drivers 
2689          *      - Drivers need to be evaluated afterwards, as they can either override 
2690          *        or be layered on top of existing animation data.
2691          *      - Drivers should be in the appropriate order to be evaluated without problems...
2692          */
2693         if ((recalc & ADT_RECALC_DRIVERS)
2694             /* XXX for now, don't check yet, as depsgraph hasn't been updated */
2695             /* && (adt->recalc & ADT_RECALC_DRIVERS)*/)
2696         {
2697                 animsys_evaluate_drivers(&id_ptr, adt, ctime);
2698         }
2699         
2700         /* always execute 'overrides' 
2701          *      - Overrides allow editing, by overwriting the value(s) set from animation-data, with the
2702          *        value last set by the user (and not keyframed yet). 
2703          *      - Overrides are cleared upon frame change and/or keyframing
2704          *      - It is best that we execute this every time, so that no errors are likely to occur.
2705          */
2706         animsys_evaluate_overrides(&id_ptr, adt);
2707         
2708         /* execute and clear all cached property update functions */
2709         if (scene) {
2710                 Main *bmain = G.main; // xxx - to get passed in!
2711                 RNA_property_update_cache_flush(bmain, scene);
2712                 RNA_property_update_cache_free();
2713         }
2714         
2715         /* clear recalc flag now */
2716         adt->recalc = 0;
2717 }
2718
2719 /* Evaluation of all ID-blocks with Animation Data blocks - Animation Data Only
2720  *
2721  * This will evaluate only the animation info available in the animation data-blocks
2722  * encountered. In order to enforce the system by which some settings controlled by a
2723  * 'local' (i.e. belonging in the nearest ID-block that setting is related to, not a
2724  * standard 'root') block are overridden by a larger 'user'
2725  */
2726 void BKE_animsys_evaluate_all_animation(Main *main, Scene *scene, float ctime)
2727 {
2728         ID *id;
2729
2730         if (G.debug & G_DEBUG)
2731                 printf("Evaluate all animation - %f\n", ctime);
2732         
2733         /* macros for less typing 
2734          *      - only evaluate animation data for id if it has users (and not just fake ones)
2735          *      - whether animdata exists is checked for by the evaluation function, though taking 
2736          *        this outside of the function may make things slightly faster?
2737          */
2738 #define EVAL_ANIM_IDS(first, aflag) \
2739         for (id = first; id; id = id->next) { \
2740                 if (ID_REAL_USERS(id) > 0) { \
2741                         AnimData *adt = BKE_animdata_from_id(id); \
2742                         BKE_animsys_evaluate_animdata(scene, id, adt, ctime, aflag); \
2743                 } \
2744         } (void)0
2745
2746         /* another macro for the "embedded" nodetree cases 
2747          *      - this is like EVAL_ANIM_IDS, but this handles the case "embedded nodetrees" 
2748          *        (i.e. scene/material/texture->nodetree) which we need a special exception
2749          *    for, otherwise they'd get skipped
2750          *      - ntp = "node tree parent" = datablock where node tree stuff resides
2751          */
2752 #define EVAL_ANIM_NODETREE_IDS(first, NtId_Type, aflag) \
2753         for (id = first; id; id = id->next) { \
2754                 if (ID_REAL_USERS(id) > 0) { \
2755                         AnimData *adt = BKE_animdata_from_id(id); \
2756                         NtId_Type *ntp = (NtId_Type *)id; \
2757                         if (ntp->nodetree) { \
2758                                 AnimData *adt2 = BKE_animdata_from_id((ID *)ntp->nodetree); \
2759                                 BKE_animsys_evaluate_animdata(scene, (ID *)ntp->nodetree, adt2, ctime, ADT_RECALC_ANIM); \
2760                         } \
2761                         BKE_animsys_evaluate_animdata(scene, id, adt, ctime, aflag); \
2762                 } \
2763         } (void)0
2764         
2765         /* optimization: 
2766          * when there are no actions, don't go over database and loop over heaps of datablocks, 
2767          * which should ultimately be empty, since it is not possible for now to have any animation 
2768          * without some actions, and drivers wouldn't get affected by any state changes
2769          *
2770          * however, if there are some curves, we will need to make sure that their 'ctime' property gets
2771          * set correctly, so this optimization must be skipped in that case...
2772          */
2773         if (BLI_listbase_is_empty(&main->action) && BLI_listbase_is_empty(&main->curve)) {
2774                 if (G.debug & G_DEBUG)
2775                         printf("\tNo Actions, so no animation needs to be evaluated...\n");
2776                         
2777                 return;
2778         }
2779         
2780         /* nodes */
2781         EVAL_ANIM_IDS(main->nodetree.first, ADT_RECALC_ANIM);
2782         
2783         /* textures */
2784         EVAL_ANIM_NODETREE_IDS(main->tex.first, Tex, ADT_RECALC_ANIM);
2785         
2786         /* lamps */
2787         EVAL_ANIM_NODETREE_IDS(main->lamp.first, Lamp, ADT_RECALC_ANIM);
2788         
2789         /* materials */
2790         EVAL_ANIM_NODETREE_IDS(main->mat.first, Material, ADT_RECALC_ANIM);
2791         
2792         /* cameras */
2793         EVAL_ANIM_IDS(main->camera.first, ADT_RECALC_ANIM);
2794         
2795         /* shapekeys */
2796         EVAL_ANIM_IDS(main->key.first, ADT_RECALC_ANIM);
2797         
2798         /* metaballs */
2799         EVAL_ANIM_IDS(main->mball.first, ADT_RECALC_ANIM);
2800         
2801         /* curves */
2802         EVAL_ANIM_IDS(main->curve.first, ADT_RECALC_ANIM);
2803         
2804         /* armatures */
2805         EVAL_ANIM_IDS(main->armature.first, ADT_RECALC_ANIM);
2806         
2807         /* lattices */
2808         EVAL_ANIM_IDS(main->latt.first, ADT_RECALC_ANIM);
2809         
2810         /* meshes */
2811         EVAL_ANIM_IDS(main->mesh.first, ADT_RECALC_ANIM);
2812         
2813         /* particles */
2814         EVAL_ANIM_IDS(main->particle.first, ADT_RECALC_ANIM);
2815         
2816         /* speakers */
2817         EVAL_ANIM_IDS(main->speaker.first, ADT_RECALC_ANIM);
2818
2819         /* movie clips */
2820         EVAL_ANIM_IDS(main->movieclip.first, ADT_RECALC_ANIM);
2821
2822         /* linestyles */
2823         EVAL_ANIM_IDS(main->linestyle.first, ADT_RECALC_ANIM);
2824         
2825         /* grease pencil */
2826         EVAL_ANIM_IDS(main->gpencil.first, ADT_RECALC_ANIM);
2827
2828         /* cache files */
2829         EVAL_ANIM_IDS(main->cachefiles.first, ADT_RECALC_ANIM);
2830         
2831         /* objects */
2832         /* ADT_RECALC_ANIM doesn't need to be supplied here, since object AnimData gets
2833          * this tagged by Depsgraph on framechange. This optimization means that objects
2834          * linked from other (not-visible) scenes will not need their data calculated.
2835          */
2836         EVAL_ANIM_IDS(main->object.first, 0); 
2837
2838         /* masks */
2839         EVAL_ANIM_IDS(main->mask.first, ADT_RECALC_ANIM);
2840         
2841         /* worlds */
2842         EVAL_ANIM_NODETREE_IDS(main->world.first, World, ADT_RECALC_ANIM);
2843         
2844         /* scenes */
2845         EVAL_ANIM_NODETREE_IDS(main->scene.first, Scene, ADT_RECALC_ANIM);
2846 }
2847
2848 /* ***************************************** */ 
2849
2850 /* ************** */
2851 /* Evaluation API */
2852
2853 #define DEBUG_PRINT if (G.debug & G_DEBUG_DEPSGRAPH) printf
2854
2855 void BKE_animsys_eval_animdata(const EvaluationContext *eval_ctx, ID *id)
2856 {
2857         AnimData *adt = BKE_animdata_from_id(id);
2858         Scene *scene = NULL; /* XXX: this is only needed for flushing RNA updates,
2859                               * which should get handled as part of the graph instead...
2860                               */
2861         DEBUG_PRINT("%s on %s, time=%f\n\n", __func__, id->name, (double)eval_ctx->ctime);
2862         BKE_animsys_evaluate_animdata(scene, id, adt, eval_ctx->ctime, ADT_RECALC_ANIM);
2863 }
2864
2865 void BKE_animsys_eval_driver(const EvaluationContext *eval_ctx,
2866                              ID *id,
2867                              FCurve *fcu)
2868 {
2869         /* TODO(sergey): De-duplicate with BKE animsys. */
2870         ChannelDriver *driver = fcu->driver;
2871         PointerRNA id_ptr;
2872         bool ok = false;
2873
2874         DEBUG_PRINT("%s on %s (%s[%d])\n",
2875                     __func__,
2876                     id->name,
2877                     fcu->rna_path,
2878                     fcu->array_index);
2879
2880         RNA_id_pointer_create(id, &id_ptr);
2881
2882         /* check if this driver's curve should be skipped */
2883         if ((fcu->flag & (FCURVE_MUTED | FCURVE_DISABLED)) == 0) {
2884                 /* check if driver itself is tagged for recalculation */
2885                 /* XXX driver recalc flag is not set yet by depsgraph! */
2886                 if ((driver) && !(driver->flag & DRIVER_FLAG_INVALID) /*&& (driver->flag & DRIVER_FLAG_RECALC)*/) {
2887                         /* evaluate this using values set already in other places
2888                          * NOTE: for 'layering' option later on, we should check if we should remove old value before adding
2889                          *       new to only be done when drivers only changed */
2890                         //printf("\told val = %f\n", fcu->curval);
2891
2892                         PathResolvedRNA anim_rna;
2893                         if (animsys_store_rna_setting(&id_ptr, NULL, fcu->rna_path, fcu->array_index, &anim_rna)) {
2894                                 const float curval = calculate_fcurve(&anim_rna, fcu, eval_ctx->ctime);
2895                                 ok = animsys_write_rna_setting(&anim_rna, curval);
2896                         }
2897
2898                         //printf("\tnew val = %f\n", fcu->curval);
2899
2900                         /* clear recalc flag */
2901                         driver->flag &= ~DRIVER_FLAG_RECALC;
2902
2903                         /* set error-flag if evaluation failed */
2904                         if (ok == 0) {
2905                                 printf("invalid driver - %s[%d]\n", fcu->rna_path, fcu->array_index);
2906                                 driver->flag |= DRIVER_FLAG_INVALID;
2907                         }
2908                 }
2909         }
2910 }
2911
2912 #undef DEBUG_PRINT