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