d04b950c0434a3064c0b755ed2d73787350fa0da
[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 "BLT_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(const short id_type)
83 {
84         /* Only some ID-blocks have this info for now */
85         /* TODO: finish adding this for the other blocktypes */
86         switch (id_type) {
87                 /* has AnimData */
88                 case ID_OB:
89                 case ID_ME: case ID_MB: case ID_CU: case ID_AR: case ID_LT:
90                 case ID_KE:
91                 case ID_PA:
92                 case ID_MA: case ID_TE: case ID_NT:
93                 case ID_LA: case ID_CA: case ID_WO:
94                 case ID_LS:
95                 case ID_SPK:
96                 case ID_SCE:
97                 case ID_MC:
98                 case ID_MSK:
99                 case ID_GD:
100                         return true;
101                 
102                 /* no AnimData */
103                 default:
104                         return false;
105         }
106 }
107
108 bool id_can_have_animdata(const ID *id)
109 {
110         /* sanity check */
111         if (id == NULL)
112                 return false;
113
114         return id_type_can_have_animdata(GS(id->name));
115 }
116
117 /* Get AnimData from the given ID-block. In order for this to work, we assume that 
118  * the AnimData pointer is stored immediately after the given ID-block in the struct,
119  * as per IdAdtTemplate.
120  */
121 AnimData *BKE_animdata_from_id(ID *id)
122 {
123         /* only some ID-blocks have this info for now, so we cast the 
124          * types that do to be of type IdAdtTemplate, and extract the
125          * AnimData that way
126          */
127         if (id_can_have_animdata(id)) {
128                 IdAdtTemplate *iat = (IdAdtTemplate *)id;
129                 return iat->adt;
130         }
131         else
132                 return NULL;
133 }
134
135 /* Add AnimData to the given ID-block. In order for this to work, we assume that 
136  * the AnimData pointer is stored immediately after the given ID-block in the struct,
137  * as per IdAdtTemplate. Also note that 
138  */
139 AnimData *BKE_animdata_add_id(ID *id)
140 {
141         /* Only some ID-blocks have this info for now, so we cast the 
142          * types that do to be of type IdAdtTemplate, and add the AnimData
143          * to it using the template
144          */
145         if (id_can_have_animdata(id)) {
146                 IdAdtTemplate *iat = (IdAdtTemplate *)id;
147                 
148                 /* check if there's already AnimData, in which case, don't add */
149                 if (iat->adt == NULL) {
150                         AnimData *adt;
151                         
152                         /* add animdata */
153                         adt = iat->adt = MEM_callocN(sizeof(AnimData), "AnimData");
154                         
155                         /* set default settings */
156                         adt->act_influence = 1.0f;
157                 }
158                 
159                 return iat->adt;
160         }
161         else 
162                 return NULL;
163 }
164
165 /* Action Setter --------------------------------------- */
166
167 /* Called when user tries to change the active action of an AnimData block (via RNA, Outliner, etc.) */
168 bool BKE_animdata_set_action(ReportList *reports, ID *id, bAction *act)
169 {
170         AnimData *adt = BKE_animdata_from_id(id);
171         bool ok = false;
172         
173         /* animdata validity check */
174         if (adt == NULL) {
175                 BKE_report(reports, RPT_WARNING, "No AnimData to set action on");
176                 return ok;
177         }
178         
179         /* active action is only editable when it is not a tweaking strip 
180          * see rna_AnimData_action_editable() in rna_animation.c
181          */
182         if ((adt->flag & ADT_NLA_EDIT_ON) || (adt->actstrip) || (adt->tmpact)) {
183                 /* cannot remove, otherwise things turn to custard */
184                 BKE_report(reports, RPT_ERROR, "Cannot change action, as it is still being edited in NLA");
185                 return ok;
186         }
187         
188         /* manage usercount for current action */
189         if (adt->action)
190                 id_us_min((ID *)adt->action);
191         
192         /* assume that AnimData's action can in fact be edited... */
193         if (act) {
194                 /* action must have same type as owner */
195                 if (ELEM(act->idroot, 0, GS(id->name))) {
196                         /* can set */
197                         adt->action = act;
198                         id_us_plus((ID *)adt->action);
199                         ok = true;
200                 }
201                 else {
202                         /* cannot set */
203                         BKE_reportf(reports, RPT_ERROR,
204                                     "Could not set action '%s' onto ID '%s', as it does not have suitably rooted paths "
205                                     "for this purpose", act->id.name + 2, id->name);
206                         /* ok = false; */
207                 }
208         }
209         else {
210                 /* just clearing the action... */
211                 adt->action = NULL;
212                 ok = true;
213         }
214         
215         return ok;
216 }
217
218 /* Freeing -------------------------------------------- */
219
220 /* Free AnimData used by the nominated ID-block, and clear ID-block's AnimData pointer */
221 void BKE_animdata_free(ID *id, const bool do_id_user)
222 {
223         /* Only some ID-blocks have this info for now, so we cast the 
224          * types that do to be of type IdAdtTemplate
225          */
226         if (id_can_have_animdata(id)) {
227                 IdAdtTemplate *iat = (IdAdtTemplate *)id;
228                 AnimData *adt = iat->adt;
229                 
230                 /* check if there's any AnimData to start with */
231                 if (adt) {
232                         if (do_id_user) {
233                                 /* unlink action (don't free, as it's in its own list) */
234                                 if (adt->action)
235                                         id_us_min(&adt->action->id);
236                                 /* same goes for the temporarily displaced action */
237                                 if (adt->tmpact)
238                                         id_us_min(&adt->tmpact->id);
239                         }
240                                 
241                         /* free nla data */
242                         free_nladata(&adt->nla_tracks);
243                         
244                         /* free drivers - stored as a list of F-Curves */
245                         free_fcurves(&adt->drivers);
246                         
247                         /* free overrides */
248                         /* TODO... */
249                         
250                         /* free animdata now */
251                         MEM_freeN(adt);
252                         iat->adt = NULL;
253                 }
254         }
255 }
256
257 /* Copying -------------------------------------------- */
258
259 /* Make a copy of the given AnimData - to be used when copying datablocks */
260 AnimData *BKE_animdata_copy(AnimData *adt, const bool do_action)
261 {
262         AnimData *dadt;
263         
264         /* sanity check before duplicating struct */
265         if (adt == NULL)
266                 return NULL;
267         dadt = MEM_dupallocN(adt);
268         
269         /* make a copy of action - at worst, user has to delete copies... */
270         if (do_action) {
271                 dadt->action = BKE_action_copy(G.main, adt->action);
272                 dadt->tmpact = BKE_action_copy(G.main, adt->tmpact);
273         }
274         else {
275                 id_us_plus((ID *)dadt->action);
276                 id_us_plus((ID *)dadt->tmpact);
277         }
278
279         /* duplicate NLA data */
280         copy_nladata(&dadt->nla_tracks, &adt->nla_tracks);
281         
282         /* duplicate drivers (F-Curves) */
283         copy_fcurves(&dadt->drivers, &adt->drivers);
284         
285         /* don't copy overrides */
286         BLI_listbase_clear(&dadt->overrides);
287         
288         /* return */
289         return dadt;
290 }
291
292 bool BKE_animdata_copy_id(ID *id_to, ID *id_from, const bool do_action)
293 {
294         AnimData *adt;
295
296         if ((id_to && id_from) && (GS(id_to->name) != GS(id_from->name)))
297                 return false;
298
299         BKE_animdata_free(id_to, true);
300
301         adt = BKE_animdata_from_id(id_from);
302         if (adt) {
303                 IdAdtTemplate *iat = (IdAdtTemplate *)id_to;
304                 iat->adt = BKE_animdata_copy(adt, do_action);
305         }
306
307         return true;
308 }
309
310 void BKE_animdata_copy_id_action(ID *id)
311 {
312         AnimData *adt = BKE_animdata_from_id(id);
313         if (adt) {
314                 if (adt->action) {
315                         id_us_min((ID *)adt->action);
316                         adt->action = BKE_action_copy(G.main, adt->action);
317                 }
318                 if (adt->tmpact) {
319                         id_us_min((ID *)adt->tmpact);
320                         adt->tmpact = BKE_action_copy(G.main, adt->tmpact);
321                 }
322         }
323 }
324
325 /* Merge copies of the data from the src AnimData into the destination AnimData */
326 void BKE_animdata_merge_copy(ID *dst_id, ID *src_id, eAnimData_MergeCopy_Modes action_mode, bool fix_drivers)
327 {
328         AnimData *src = BKE_animdata_from_id(src_id);
329         AnimData *dst = BKE_animdata_from_id(dst_id);
330         
331         /* sanity checks */
332         if (ELEM(NULL, dst, src))
333                 return;
334                 
335         // TODO: we must unset all "tweakmode" flags
336         if ((src->flag & ADT_NLA_EDIT_ON) || (dst->flag & ADT_NLA_EDIT_ON)) {
337                 printf("ERROR: Merging AnimData blocks while editing NLA is dangerous as it may cause data corruption\n");
338                 return;
339         }
340         
341         /* handle actions... */
342         if (action_mode == ADT_MERGECOPY_SRC_COPY) {
343                 /* make a copy of the actions */
344                 dst->action = BKE_action_copy(G.main, src->action);
345                 dst->tmpact = BKE_action_copy(G.main, src->tmpact);
346         }
347         else if (action_mode == ADT_MERGECOPY_SRC_REF) {
348                 /* make a reference to it */
349                 dst->action = src->action;
350                 id_us_plus((ID *)dst->action);
351                 
352                 dst->tmpact = src->tmpact;
353                 id_us_plus((ID *)dst->tmpact);
354         }
355         
356         /* duplicate NLA data */
357         if (src->nla_tracks.first) {
358                 ListBase tracks = {NULL, NULL};
359                 
360                 copy_nladata(&tracks, &src->nla_tracks);
361                 BLI_movelisttolist(&dst->nla_tracks, &tracks);
362         }
363         
364         /* duplicate drivers (F-Curves) */
365         if (src->drivers.first) {
366                 ListBase drivers = {NULL, NULL};
367                 
368                 copy_fcurves(&drivers, &src->drivers);
369                 
370                 /* Fix up all driver targets using the old target id
371                  * - This assumes that the src ID is being merged into the dst ID
372                  */
373                 if (fix_drivers) {
374                         FCurve *fcu;
375                         
376                         for (fcu = drivers.first; fcu; fcu = fcu->next) {
377                                 ChannelDriver *driver = fcu->driver;
378                                 DriverVar *dvar;
379                                 
380                                 for (dvar = driver->variables.first; dvar; dvar = dvar->next) {
381                                         DRIVER_TARGETS_USED_LOOPER(dvar)
382                                         {
383                                                 if (dtar->id == src_id) {
384                                                         dtar->id = dst_id;
385                                                 }
386                                         }
387                                         DRIVER_TARGETS_LOOPER_END
388                                 }
389                         }
390                 }
391                 
392                 BLI_movelisttolist(&dst->drivers, &drivers);
393         }
394 }
395
396 /* Make Local -------------------------------------------- */
397
398 static void make_local_strips(ListBase *strips)
399 {
400         NlaStrip *strip;
401
402         for (strip = strips->first; strip; strip = strip->next) {
403                 if (strip->act) BKE_action_make_local(G.main, strip->act, false);
404                 if (strip->remap && strip->remap->target) BKE_action_make_local(G.main, strip->remap->target, false);
405                 
406                 make_local_strips(&strip->strips);
407         }
408 }
409
410 /* Use local copy instead of linked copy of various ID-blocks */
411 void BKE_animdata_make_local(AnimData *adt)
412 {
413         NlaTrack *nlt;
414         
415         /* Actions - Active and Temp */
416         if (adt->action) BKE_action_make_local(G.main, adt->action, false);
417         if (adt->tmpact) BKE_action_make_local(G.main, adt->tmpact, false);
418         /* Remaps */
419         if (adt->remap && adt->remap->target) BKE_action_make_local(G.main, adt->remap->target, false);
420         
421         /* Drivers */
422         /* TODO: need to remap the ID-targets too? */
423         
424         /* NLA Data */
425         for (nlt = adt->nla_tracks.first; nlt; nlt = nlt->next)
426                 make_local_strips(&nlt->strips);
427 }
428
429
430 /* When duplicating data (i.e. objects), drivers referring to the original data will 
431  * get updated to point to the duplicated data (if drivers belong to the new data)
432  */
433 void BKE_animdata_relink(AnimData *adt)
434 {
435         /* sanity check */
436         if (adt == NULL)
437                 return;
438         
439         /* drivers */
440         if (adt->drivers.first) {
441                 FCurve *fcu;
442                 
443                 /* check each driver against all the base paths to see if any should go */
444                 for (fcu = adt->drivers.first; fcu; fcu = fcu->next) {
445                         ChannelDriver *driver = fcu->driver;
446                         DriverVar *dvar;
447                         
448                         /* driver variables */
449                         for (dvar = driver->variables.first; dvar; dvar = dvar->next) {
450                                 /* only change the used targets, since the others will need fixing manually anyway */
451                                 DRIVER_TARGETS_USED_LOOPER(dvar)
452                                 {
453                                         if (dtar->id && dtar->id->newid) {
454                                                 dtar->id = dtar->id->newid;
455                                         }
456                                 }
457                                 DRIVER_TARGETS_LOOPER_END
458                         }
459                 }
460         }
461 }
462
463 /* Sub-ID Regrouping ------------------------------------------- */
464
465 /**
466  * Helper heuristic for determining if a path is compatible with the basepath
467  *
468  * \param path Full RNA-path from some data (usually an F-Curve) to compare
469  * \param basepath Shorter path fragment to look for
470  * \return Whether there is a match
471  */
472 static bool animpath_matches_basepath(const char path[], const char basepath[])
473 {
474         /* we need start of path to be basepath */
475         return (path && basepath) && STRPREFIX(path, basepath);
476 }
477
478 /* Move F-Curves in src action to dst action, setting up all the necessary groups 
479  * for this to happen, but only if the F-Curves being moved have the appropriate 
480  * "base path". 
481  *      - This is used when data moves from one datablock to another, causing the
482  *        F-Curves to need to be moved over too
483  */
484 void action_move_fcurves_by_basepath(bAction *srcAct, bAction *dstAct, const char basepath[])
485 {
486         FCurve *fcu, *fcn = NULL;
487         
488         /* sanity checks */
489         if (ELEM(NULL, srcAct, dstAct, basepath)) {
490                 if (G.debug & G_DEBUG) {
491                         printf("ERROR: action_partition_fcurves_by_basepath(%p, %p, %p) has insufficient info to work with\n",
492                                (void *)srcAct, (void *)dstAct, (void *)basepath);
493                 }
494                 return;
495         }
496                 
497         /* clear 'temp' flags on all groups in src, as we'll be needing them later 
498          * to identify groups that we've managed to empty out here
499          */
500         action_groups_clear_tempflags(srcAct);
501         
502         /* iterate over all src F-Curves, moving over the ones that need to be moved */
503         for (fcu = srcAct->curves.first; fcu; fcu = fcn) {
504                 /* store next pointer in case we move stuff */
505                 fcn = fcu->next;
506                 
507                 /* should F-Curve be moved over?
508                  *      - we only need the start of the path to match basepath
509                  */
510                 if (animpath_matches_basepath(fcu->rna_path, basepath)) {
511                         bActionGroup *agrp = NULL;
512                         
513                         /* if grouped... */
514                         if (fcu->grp) {
515                                 /* make sure there will be a matching group on the other side for the migrants */
516                                 agrp = BKE_action_group_find_name(dstAct, fcu->grp->name);
517                                 
518                                 if (agrp == NULL) {
519                                         /* add a new one with a similar name (usually will be the same though) */
520                                         agrp = action_groups_add_new(dstAct, fcu->grp->name);
521                                 }
522                                 
523                                 /* old groups should be tagged with 'temp' flags so they can be removed later
524                                  * if we remove everything from them
525                                  */
526                                 fcu->grp->flag |= AGRP_TEMP;
527                         }
528                         
529                         /* perform the migration now */
530                         action_groups_remove_channel(srcAct, fcu);
531                         
532                         if (agrp)
533                                 action_groups_add_channel(dstAct, agrp, fcu);
534                         else
535                                 BLI_addtail(&dstAct->curves, fcu);
536                 }
537         }
538         
539         /* cleanup groups (if present) */
540         if (srcAct->groups.first) {
541                 bActionGroup *agrp, *grp = NULL;
542                 
543                 for (agrp = srcAct->groups.first; agrp; agrp = grp) {
544                         grp = agrp->next;
545                         
546                         /* only tagged groups need to be considered - clearing these tags or removing them */
547                         if (agrp->flag & AGRP_TEMP) {
548                                 /* if group is empty and tagged, then we can remove as this operation
549                                  * moved out all the channels that were formerly here
550                                  */
551                                 if (BLI_listbase_is_empty(&agrp->channels))
552                                         BLI_freelinkN(&srcAct->groups, agrp);
553                                 else
554                                         agrp->flag &= ~AGRP_TEMP;
555                         }
556                 }
557         }
558 }
559
560 /* Transfer the animation data from srcID to dstID where the srcID
561  * animation data is based off "basepath", creating new AnimData and
562  * associated data as necessary
563  */
564 void BKE_animdata_separate_by_basepath(ID *srcID, ID *dstID, ListBase *basepaths)
565 {
566         AnimData *srcAdt = NULL, *dstAdt = NULL;
567         LinkData *ld;
568         
569         /* sanity checks */
570         if (ELEM(NULL, srcID, dstID)) {
571                 if (G.debug & G_DEBUG)
572                         printf("ERROR: no source or destination ID to separate AnimData with\n");
573                 return;
574         }
575         
576         /* get animdata from src, and create for destination (if needed) */
577         srcAdt = BKE_animdata_from_id(srcID);
578         dstAdt = BKE_animdata_add_id(dstID);
579         
580         if (ELEM(NULL, srcAdt, dstAdt)) {
581                 if (G.debug & G_DEBUG)
582                         printf("ERROR: no AnimData for this pair of ID's\n");
583                 return;
584         }
585         
586         /* active action */
587         if (srcAdt->action) {
588                 /* set up an action if necessary, and name it in a similar way so that it can be easily found again */
589                 if (dstAdt->action == NULL) {
590                         dstAdt->action = add_empty_action(G.main, srcAdt->action->id.name + 2);
591                 }
592                 else if (dstAdt->action == srcAdt->action) {
593                         printf("Argh! Source and Destination share animation! ('%s' and '%s' both use '%s') Making new empty action\n",
594                                srcID->name, dstID->name, srcAdt->action->id.name);
595                         
596                         /* TODO: review this... */
597                         id_us_min(&dstAdt->action->id);
598                         dstAdt->action = add_empty_action(G.main, dstAdt->action->id.name + 2);
599                 }
600                         
601                 /* loop over base paths, trying to fix for each one... */
602                 for (ld = basepaths->first; ld; ld = ld->next) {
603                         const char *basepath = (const char *)ld->data;
604                         action_move_fcurves_by_basepath(srcAdt->action, dstAdt->action, basepath);
605                 }
606         }
607         
608         /* drivers */
609         if (srcAdt->drivers.first) {
610                 FCurve *fcu, *fcn = NULL;
611                 
612                 /* check each driver against all the base paths to see if any should go */
613                 for (fcu = srcAdt->drivers.first; fcu; fcu = fcn) {
614                         fcn = fcu->next;
615                         
616                         /* try each basepath in turn, but stop on the first one which works */
617                         for (ld = basepaths->first; ld; ld = ld->next) {
618                                 const char *basepath = (const char *)ld->data;
619                                 
620                                 if (animpath_matches_basepath(fcu->rna_path, basepath)) {
621                                         /* just need to change lists */
622                                         BLI_remlink(&srcAdt->drivers, fcu);
623                                         BLI_addtail(&dstAdt->drivers, fcu);
624                                         
625                                         /* TODO: add depsgraph flushing calls? */
626                                         
627                                         /* can stop now, as moved already */
628                                         break;
629                                 }
630                         }
631                 }
632         }
633 }
634
635 /**
636  * Temporary wrapper for driver operators for buttons to make it easier to create
637  * such drivers by rerouting all paths through the active object instead so that
638  * they will get picked up by the dependency system.
639  *
640  * \param C Context pointer - for getting active data
641  * \param[in,out] ptr RNA pointer for property's datablock. May be modified as result of path remapping.
642  * \param prop RNA definition of property to add for
643  * \return MEM_alloc'd string representing the path to the property from the given #PointerRNA
644  */
645 char *BKE_animdata_driver_path_hack(bContext *C, PointerRNA *ptr, PropertyRNA *prop, char *base_path)
646 {
647         ID *id = (ID *)ptr->id.data;
648         ScrArea *sa = CTX_wm_area(C);
649
650         /* get standard path which may be extended */
651         char *basepath = base_path ? base_path : RNA_path_from_ID_to_property(ptr, prop);
652         char *path = basepath; /* in case no remapping is needed */
653
654         /* Remapping will only be performed in the Properties Editor, as only this
655          * restricts the subspace of options to the 'active' data (a manageable state)
656          */
657         /* TODO: watch out for pinned context? */
658         if ((sa) && (sa->spacetype == SPACE_BUTS)) {
659                 Object *ob = CTX_data_active_object(C);
660
661                 if (ob && id) {
662                         /* only id-types which can be remapped to go through objects should be considered */
663                         switch (GS(id->name)) {
664                                 case ID_TE: /* textures */
665                                 {
666                                         Material *ma = give_current_material(ob, ob->actcol);
667                                         Tex *tex = give_current_material_texture(ma);
668
669                                         /* assumes: texture will only be shown if it is active material's active texture it's ok */
670                                         if ((ID *)tex == id) {
671                                                 char name_esc_ma[(sizeof(ma->id.name) - 2) * 2];
672                                                 char name_esc_tex[(sizeof(tex->id.name) - 2) * 2];
673
674                                                 BLI_strescape(name_esc_ma, ma->id.name + 2, sizeof(name_esc_ma));
675                                                 BLI_strescape(name_esc_tex, tex->id.name + 2, sizeof(name_esc_tex));
676
677                                                 /* create new path */
678                                                 // TODO: use RNA path functions to construct step by step instead?
679                                                 // FIXME: maybe this isn't even needed anymore...
680                                                 path = BLI_sprintfN("material_slots[\"%s\"].material.texture_slots[\"%s\"].texture.%s",
681                                                                     name_esc_ma, name_esc_tex, basepath);
682
683                                                 /* free old one */
684                                                 if (basepath != base_path)
685                                                         MEM_freeN(basepath);
686                                         }
687                                         break;
688                                 }
689                         }
690
691                         /* fix RNA pointer, as we've now changed the ID root by changing the paths */
692                         if (basepath != path) {
693                                 /* rebase provided pointer so that it starts from object... */
694                                 RNA_pointer_create(&ob->id, ptr->type, ptr->data, ptr);
695                         }
696                 }
697         }
698
699         /* the path should now have been corrected for use */
700         return path;
701 }
702
703 /* Path Validation -------------------------------------------- */
704
705 /* Check if a given RNA Path is valid, by tracing it from the given ID, and seeing if we can resolve it */
706 static bool check_rna_path_is_valid(ID *owner_id, const char *path)
707 {
708         PointerRNA id_ptr, ptr;
709         PropertyRNA *prop = NULL;
710         
711         /* make initial RNA pointer to start resolving from */
712         RNA_id_pointer_create(owner_id, &id_ptr);
713         
714         /* try to resolve */
715         return RNA_path_resolve_property(&id_ptr, path, &ptr, &prop); 
716 }
717
718 /* Check if some given RNA Path needs fixing - free the given path and set a new one as appropriate 
719  * NOTE: we assume that oldName and newName have [" "] padding around them
720  */
721 static char *rna_path_rename_fix(ID *owner_id, const char *prefix, const char *oldName, const char *newName, char *oldpath, bool verify_paths)
722 {
723         char *prefixPtr = strstr(oldpath, prefix);
724         char *oldNamePtr = strstr(oldpath, oldName);
725         int prefixLen = strlen(prefix);
726         int oldNameLen = strlen(oldName);
727         
728         /* only start fixing the path if the prefix and oldName feature in the path,
729          * and prefix occurs immediately before oldName
730          */
731         if ( (prefixPtr && oldNamePtr) && (prefixPtr + prefixLen == oldNamePtr) ) {
732                 /* if we haven't aren't able to resolve the path now, try again after fixing it */
733                 if (!verify_paths || check_rna_path_is_valid(owner_id, oldpath) == 0) {
734                         DynStr *ds = BLI_dynstr_new();
735                         const char *postfixPtr = oldNamePtr + oldNameLen;
736                         char *newPath = NULL;
737
738                         /* add the part of the string that goes up to the start of the prefix */
739                         if (prefixPtr > oldpath) {
740                                 BLI_dynstr_nappend(ds, oldpath, prefixPtr - oldpath);
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) && STREQ(oldName, agrp->name)) {
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]) && STREQ(oldName, dtar->pchan_name) )
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_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_animdata_fix_paths_rename_all(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) || !STREQ(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 for animatable numerical values only
1500                  * HACK: some local F-Curves (e.g. those on NLA Strips) are evaluated
1501                  *       without an ID provided, which causes the animateable test to fail!
1502                  */
1503                 if (RNA_property_animateable(&new_ptr, prop) || (ptr->id.data == NULL)) {
1504                         int array_len = RNA_property_array_length(&new_ptr, prop);
1505                         bool written = false;
1506                         
1507                         if (array_len && array_index >= array_len) {
1508                                 if (G.debug & G_DEBUG) {
1509                                         printf("Animato: Invalid array index. ID = '%s',  '%s[%d]', array length is %d\n",
1510                                                (ptr && ptr->id.data) ? (((ID *)ptr->id.data)->name + 2) : "<No ID>",
1511                                                path, array_index, array_len - 1);
1512                                 }
1513                                 
1514                                 return false;
1515                         }
1516                         
1517                         switch (RNA_property_type(prop)) {
1518                                 case PROP_BOOLEAN:
1519                                         if (array_len) {
1520                                                 if (RNA_property_boolean_get_index(&new_ptr, prop, array_index) != ANIMSYS_FLOAT_AS_BOOL(value)) {
1521                                                         RNA_property_boolean_set_index(&new_ptr, prop, array_index, ANIMSYS_FLOAT_AS_BOOL(value));
1522                                                         written = true;
1523                                                 }
1524                                         }
1525                                         else {
1526                                                 if (RNA_property_boolean_get(&new_ptr, prop) != ANIMSYS_FLOAT_AS_BOOL(value)) {
1527                                                         RNA_property_boolean_set(&new_ptr, prop, ANIMSYS_FLOAT_AS_BOOL(value));
1528                                                         written = true;
1529                                                 }
1530                                         }
1531                                         break;
1532                                 case PROP_INT:
1533                                         if (array_len) {
1534                                                 if (RNA_property_int_get_index(&new_ptr, prop, array_index) != (int)value) {
1535                                                         RNA_property_int_set_index(&new_ptr, prop, array_index, (int)value);
1536                                                         written = true;
1537                                                 }
1538                                         }
1539                                         else {
1540                                                 if (RNA_property_int_get(&new_ptr, prop) != (int)value) {
1541                                                         RNA_property_int_set(&new_ptr, prop, (int)value);
1542                                                         written = true;
1543                                                 }
1544                                         }
1545                                         break;
1546                                 case PROP_FLOAT:
1547                                         if (array_len) {
1548                                                 if (RNA_property_float_get_index(&new_ptr, prop, array_index) != value) {
1549                                                         RNA_property_float_set_index(&new_ptr, prop, array_index, value);
1550                                                         written = true;
1551                                                 }
1552                                         }
1553                                         else {
1554                                                 if (RNA_property_float_get(&new_ptr, prop) != value) {
1555                                                         RNA_property_float_set(&new_ptr, prop, value);
1556                                                         written = true;
1557                                                 }
1558                                         }
1559                                         break;
1560                                 case PROP_ENUM:
1561                                         if (RNA_property_enum_get(&new_ptr, prop) != (int)value) {
1562                                                 RNA_property_enum_set(&new_ptr, prop, (int)value);
1563                                                 written = true;
1564                                         }
1565                                         break;
1566                                 default:
1567                                         /* nothing can be done here... so it is unsuccessful? */
1568                                         return false;
1569                         }
1570                         
1571                         /* RNA property update disabled for now - [#28525] [#28690] [#28774] [#28777] */
1572 #if 0
1573                         /* buffer property update for later flushing */
1574                         if (written && RNA_property_update_check(prop)) {
1575                                 short skip_updates_hack = 0;
1576                                 
1577                                 /* optimization hacks: skip property updates for those properties
1578                                  * for we know that which the updates in RNA were really just for
1579                                  * flushing property editing via UI/Py
1580                                  */
1581                                 if (new_ptr.type == &RNA_PoseBone) {
1582                                         /* bone transforms - update pose (i.e. tag depsgraph) */
1583                                         skip_updates_hack = 1;
1584                                 }
1585                                 
1586                                 if (skip_updates_hack == 0)
1587                                         RNA_property_update_cache_add(&new_ptr, prop);
1588                         }
1589 #endif
1590
1591                         /* as long as we don't do property update, we still tag datablock
1592                          * as having been updated. this flag does not cause any updates to
1593                          * be run, it's for e.g. render engines to synchronize data */
1594                         if (written && new_ptr.id.data) {
1595                                 ID *id = new_ptr.id.data;
1596
1597                                 /* for cases like duplifarmes it's only a temporary so don't
1598                                  * notify anyone of updates */
1599                                 if (!(id->tag & LIB_TAG_ANIM_NO_RECALC)) {
1600                                         id->tag |= LIB_TAG_ID_RECALC;
1601                                         DAG_id_type_tag(G.main, GS(id->name));
1602                                 }
1603                         }
1604                 }
1605                 
1606                 /* successful */
1607                 return true;
1608         }
1609         else {
1610                 /* failed to get path */
1611                 /* XXX don't tag as failed yet though, as there are some legit situations (Action Constraint)
1612                  * where some channels will not exist, but shouldn't lock up Action */
1613                 if (G.debug & G_DEBUG) {
1614                         printf("Animato: Invalid path. ID = '%s',  '%s[%d]'\n",
1615                                (ptr->id.data) ? (((ID *)ptr->id.data)->name + 2) : "<No ID>",
1616                                path, array_index);
1617                 }
1618                 return false;
1619         }
1620 }
1621
1622 /* Simple replacement based data-setting of the FCurve using RNA */
1623 bool BKE_animsys_execute_fcurve(PointerRNA *ptr, AnimMapper *remap, FCurve *fcu, float curval)
1624 {
1625         char *path = NULL;
1626         bool free_path = false;
1627         bool ok = false;
1628         
1629         /* get path, remapped as appropriate to work in its new environment */
1630         free_path = animsys_remap_path(remap, fcu->rna_path, &path);
1631         
1632         /* write value to setting */
1633         if (path)
1634                 ok = animsys_write_rna_setting(ptr, path, fcu->array_index, curval);
1635         
1636         /* free temp path-info */
1637         if (free_path)
1638                 MEM_freeN(path);
1639                 
1640         /* return whether we were successful */
1641         return ok;
1642 }
1643
1644 /* Evaluate all the F-Curves in the given list 
1645  * This performs a set of standard checks. If extra checks are required, separate code should be used
1646  */
1647 static void animsys_evaluate_fcurves(PointerRNA *ptr, ListBase *list, AnimMapper *remap, float ctime)
1648 {
1649         FCurve *fcu;
1650         
1651         /* calculate then execute each curve */
1652         for (fcu = list->first; fcu; fcu = fcu->next) {
1653                 /* check if this F-Curve doesn't belong to a muted group */
1654                 if ((fcu->grp == NULL) || (fcu->grp->flag & AGRP_MUTED) == 0) {
1655                         /* check if this curve should be skipped */
1656                         if ((fcu->flag & (FCURVE_MUTED | FCURVE_DISABLED)) == 0) {
1657                                 const float curval = calculate_fcurve(fcu, ctime);
1658                                 BKE_animsys_execute_fcurve(ptr, remap, fcu, curval);
1659                         }
1660                 }
1661         }
1662 }
1663
1664 /* ***************************************** */
1665 /* Driver Evaluation */
1666
1667 /* Evaluate Drivers */
1668 static void animsys_evaluate_drivers(PointerRNA *ptr, AnimData *adt, float ctime)
1669 {
1670         FCurve *fcu;
1671         
1672         /* drivers are stored as F-Curves, but we cannot use the standard code, as we need to check if
1673          * the depsgraph requested that this driver be evaluated...
1674          */
1675         for (fcu = adt->drivers.first; fcu; fcu = fcu->next) {
1676                 ChannelDriver *driver = fcu->driver;
1677                 bool ok = false;
1678                 
1679                 /* check if this driver's curve should be skipped */
1680                 if ((fcu->flag & (FCURVE_MUTED | FCURVE_DISABLED)) == 0) {
1681                         /* check if driver itself is tagged for recalculation */
1682                         /* XXX driver recalc flag is not set yet by depsgraph! */
1683                         if ((driver) && !(driver->flag & DRIVER_FLAG_INVALID) /*&& (driver->flag & DRIVER_FLAG_RECALC)*/) {
1684                                 /* evaluate this using values set already in other places
1685                                  * NOTE: for 'layering' option later on, we should check if we should remove old value before adding
1686                                  *       new to only be done when drivers only changed */
1687                                 const float curval = calculate_fcurve(fcu, ctime);
1688                                 ok = BKE_animsys_execute_fcurve(ptr, NULL, fcu, curval);
1689                                 
1690                                 /* clear recalc flag */
1691                                 driver->flag &= ~DRIVER_FLAG_RECALC;
1692                                 
1693                                 /* set error-flag if evaluation failed */
1694                                 if (ok == 0)
1695                                         driver->flag |= DRIVER_FLAG_INVALID; 
1696                         }
1697                 }
1698         }
1699 }
1700
1701 /* ***************************************** */
1702 /* Actions Evaluation */
1703
1704 /* strictly not necessary for actual "evaluation", but it is a useful safety check
1705  * to reduce the amount of times that users end up having to "revive" wrongly-assigned
1706  * actions
1707  */
1708 static void action_idcode_patch_check(ID *id, bAction *act)
1709 {
1710         int idcode = 0;
1711         
1712         /* just in case */
1713         if (ELEM(NULL, id, act))
1714                 return;
1715         else
1716                 idcode = GS(id->name);
1717         
1718         /* the actual checks... hopefully not too much of a performance hit in the long run... */
1719         if (act->idroot == 0) {
1720                 /* use the current root if not set already (i.e. newly created actions and actions from 2.50-2.57 builds)
1721                  *  - this has problems if there are 2 users, and the first one encountered is the invalid one
1722                  *        in which case, the user will need to manually fix this (?)
1723                  */
1724                 act->idroot = idcode;
1725         }
1726         else if (act->idroot != idcode) {
1727                 /* only report this error if debug mode is enabled (to save performance everywhere else) */
1728                 if (G.debug & G_DEBUG) {
1729                         printf("AnimSys Safety Check Failed: Action '%s' is not meant to be used from ID-Blocks of type %d such as '%s'\n",
1730                                act->id.name + 2, idcode, id->name);
1731                 }
1732         }
1733 }
1734
1735 /* ----------------------------------------- */
1736
1737 /* Evaluate Action Group */
1738 void animsys_evaluate_action_group(PointerRNA *ptr, bAction *act, bActionGroup *agrp, AnimMapper *remap, float ctime)
1739 {
1740         FCurve *fcu;
1741         
1742         /* check if mapper is appropriate for use here (we set to NULL if it's inappropriate) */
1743         if (ELEM(NULL, act, agrp)) return;
1744         if ((remap) && (remap->target != act)) remap = NULL;
1745         
1746         action_idcode_patch_check(ptr->id.data, act);
1747         
1748         /* if group is muted, don't evaluated any of the F-Curve */
1749         if (agrp->flag & AGRP_MUTED)
1750                 return;
1751         
1752         /* calculate then execute each curve */
1753         for (fcu = agrp->channels.first; (fcu) && (fcu->grp == agrp); fcu = fcu->next) {
1754                 /* check if this curve should be skipped */
1755                 if ((fcu->flag & (FCURVE_MUTED | FCURVE_DISABLED)) == 0) {
1756                         const float curval = calculate_fcurve(fcu, ctime);
1757                         BKE_animsys_execute_fcurve(ptr, remap, fcu, curval);
1758                 }
1759         }
1760 }
1761
1762 /* Evaluate Action (F-Curve Bag) */
1763 void animsys_evaluate_action(PointerRNA *ptr, bAction *act, AnimMapper *remap, float ctime)
1764 {
1765         /* check if mapper is appropriate for use here (we set to NULL if it's inappropriate) */
1766         if (act == NULL) return;
1767         if ((remap) && (remap->target != act)) remap = NULL;
1768         
1769         action_idcode_patch_check(ptr->id.data, act);
1770         
1771         /* calculate then execute each curve */
1772         animsys_evaluate_fcurves(ptr, &act->curves, remap, ctime);
1773 }
1774
1775 /* ***************************************** */
1776 /* NLA System - Evaluation */
1777
1778 /* calculate influence of strip based for given frame based on blendin/out values */
1779 static float nlastrip_get_influence(NlaStrip *strip, float cframe)
1780 {
1781         /* sanity checks - normalize the blendin/out values? */
1782         strip->blendin = fabsf(strip->blendin);
1783         strip->blendout = fabsf(strip->blendout);
1784         
1785         /* result depends on where frame is in respect to blendin/out values */
1786         if (IS_EQF(strip->blendin, 0.0f) == false && (cframe <= (strip->start + strip->blendin))) {
1787                 /* there is some blend-in */
1788                 return fabsf(cframe - strip->start) / (strip->blendin);
1789         }
1790         else if (IS_EQF(strip->blendout, 0.0f) == false && (cframe >= (strip->end - strip->blendout))) {
1791                 /* there is some blend-out */
1792                 return fabsf(strip->end - cframe) / (strip->blendout);
1793         }
1794         else {
1795                 /* in the middle of the strip, we should be full strength */
1796                 return 1.0f;
1797         }
1798 }
1799
1800 /* evaluate the evaluation time and influence for the strip, storing the results in the strip */
1801 static void nlastrip_evaluate_controls(NlaStrip *strip, float ctime)
1802 {
1803         /* now strip's evaluate F-Curves for these settings (if applicable) */
1804         if (strip->fcurves.first) {
1805                 PointerRNA strip_ptr;
1806                 
1807                 /* create RNA-pointer needed to set values */
1808                 RNA_pointer_create(NULL, &RNA_NlaStrip, strip, &strip_ptr);
1809                 
1810                 /* execute these settings as per normal */
1811                 animsys_evaluate_fcurves(&strip_ptr, &strip->fcurves, NULL, ctime);
1812         }
1813         
1814         /* analytically generate values for influence and time (if applicable)
1815          *  - we do this after the F-Curves have been evaluated to override the effects of those
1816          *    in case the override has been turned off.
1817          */
1818         if ((strip->flag & NLASTRIP_FLAG_USR_TIME) == 0)
1819                 strip->strip_time = nlastrip_get_frame(strip, ctime, NLATIME_CONVERT_EVAL);
1820         if ((strip->flag & NLASTRIP_FLAG_USR_INFLUENCE) == 0)
1821                 strip->influence = nlastrip_get_influence(strip, ctime);
1822
1823         /* if user can control the evaluation time (using F-Curves), consider the option which allows this time to be clamped
1824          * to lie within extents of the action-clip, so that a steady changing rate of progress through several cycles of the clip
1825          * can be achieved easily
1826          */
1827         /* NOTE: if we add any more of these special cases, we better group them up nicely... */
1828         if ((strip->flag & NLASTRIP_FLAG_USR_TIME) && (strip->flag & NLASTRIP_FLAG_USR_TIME_CYCLIC))
1829                 strip->strip_time = fmod(strip->strip_time - strip->actstart, strip->actend - strip->actstart);
1830 }
1831
1832 /* gets the strip active at the current time for a list of strips for evaluation purposes */
1833 NlaEvalStrip *nlastrips_ctime_get_strip(ListBase *list, ListBase *strips, short index, float ctime)
1834 {
1835         NlaStrip *strip, *estrip = NULL;
1836         NlaEvalStrip *nes;
1837         short side = 0;
1838         
1839         /* loop over strips, checking if they fall within the range */
1840         for (strip = strips->first; strip; strip = strip->next) {
1841                 /* check if current time occurs within this strip  */
1842                 if (IN_RANGE_INCL(ctime, strip->start, strip->end)) {
1843                         /* this strip is active, so try to use it */
1844                         estrip = strip;
1845                         side = NES_TIME_WITHIN;
1846                         break;
1847                 }
1848                 
1849                 /* if time occurred before current strip... */
1850                 if (ctime < strip->start) {
1851                         if (strip == strips->first) {
1852                                 /* before first strip - only try to use it if it extends backwards in time too */
1853                                 if (strip->extendmode == NLASTRIP_EXTEND_HOLD)
1854                                         estrip = strip;
1855                                         
1856                                 /* side is 'before' regardless of whether there's a useful strip */
1857                                 side = NES_TIME_BEFORE;
1858                         }
1859                         else {
1860                                 /* before next strip - previous strip has ended, but next hasn't begun, 
1861                                  * so blending mode depends on whether strip is being held or not...
1862                                  *  - only occurs when no transition strip added, otherwise the transition would have
1863                                  *    been picked up above...
1864                                  */
1865                                 strip = strip->prev;
1866                                 
1867                                 if (strip->extendmode != NLASTRIP_EXTEND_NOTHING)
1868                                         estrip = strip;
1869                                 side = NES_TIME_AFTER;
1870                         }
1871                         break;
1872                 }
1873                 
1874                 /* if time occurred after current strip... */
1875                 if (ctime > strip->end) {
1876                         /* only if this is the last strip should we do anything, and only if that is being held */
1877                         if (strip == strips->last) {
1878                                 if (strip->extendmode != NLASTRIP_EXTEND_NOTHING)
1879                                         estrip = strip;
1880                                         
1881                                 side = NES_TIME_AFTER;
1882                                 break;
1883                         }
1884                         
1885                         /* otherwise, skip... as the 'before' case will catch it more elegantly! */
1886                 }
1887         }
1888         
1889         /* check if a valid strip was found
1890          *      - must not be muted (i.e. will have contribution
1891          */
1892         if ((estrip == NULL) || (estrip->flag & NLASTRIP_FLAG_MUTED)) 
1893                 return NULL;
1894                 
1895         /* if ctime was not within the boundaries of the strip, clamp! */
1896         switch (side) {
1897                 case NES_TIME_BEFORE: /* extend first frame only */
1898                         ctime = estrip->start;
1899                         break;
1900                 case NES_TIME_AFTER: /* extend last frame only */
1901                         ctime = estrip->end;
1902                         break;
1903         }
1904         
1905         /* evaluate strip's evaluation controls  
1906          *  - skip if no influence (i.e. same effect as muting the strip)
1907          *      - negative influence is not supported yet... how would that be defined?
1908          */
1909         /* TODO: this sounds a bit hacky having a few isolated F-Curves stuck on some data it operates on... */
1910         nlastrip_evaluate_controls(estrip, ctime);
1911         if (estrip->influence <= 0.0f)
1912                 return NULL;
1913                 
1914         /* check if strip has valid data to evaluate,
1915          * and/or perform any additional type-specific actions
1916          */
1917         switch (estrip->type) {
1918                 case NLASTRIP_TYPE_CLIP: 
1919                         /* clip must have some action to evaluate */
1920                         if (estrip->act == NULL)
1921                                 return NULL;
1922                         break;
1923                 case NLASTRIP_TYPE_TRANSITION:
1924                         /* there must be strips to transition from and to (i.e. prev and next required) */
1925                         if (ELEM(NULL, estrip->prev, estrip->next))
1926                                 return NULL;
1927                                 
1928                         /* evaluate controls for the relevant extents of the bordering strips... */
1929                         nlastrip_evaluate_controls(estrip->prev, estrip->start);
1930                         nlastrip_evaluate_controls(estrip->next, estrip->end);
1931                         break;
1932         }
1933         
1934         /* add to list of strips we need to evaluate */
1935         nes = MEM_callocN(sizeof(NlaEvalStrip), "NlaEvalStrip");
1936         
1937         nes->strip = estrip;
1938         nes->strip_mode = side;
1939         nes->track_index = index;
1940         nes->strip_time = estrip->strip_time;
1941         
1942         if (list)
1943                 BLI_addtail(list, nes);
1944         
1945         return nes;
1946 }
1947
1948 /* ---------------------- */
1949
1950 /* find an NlaEvalChannel that matches the given criteria 
1951  *      - ptr and prop are the RNA data to find a match for
1952  */
1953 static NlaEvalChannel *nlaevalchan_find_match(ListBase *channels, PointerRNA *ptr, PropertyRNA *prop, int array_index)
1954 {
1955         NlaEvalChannel *nec;
1956         
1957         /* sanity check */
1958         if (channels == NULL)
1959                 return NULL;
1960         
1961         /* loop through existing channels, checking for a channel which affects the same property */
1962         for (nec = channels->first; nec; nec = nec->next) {
1963                 /* - comparing the PointerRNA's is done by comparing the pointers
1964                  *   to the actual struct the property resides in, since that all the
1965                  *   other data stored in PointerRNA cannot allow us to definitively 
1966                  *      identify the data 
1967                  */
1968                 if ((nec->ptr.data == ptr->data) && (nec->prop == prop) && (nec->index == array_index))
1969                         return nec;
1970         }
1971         
1972         /* not found */
1973         return NULL;
1974 }
1975
1976 /* initialise default value for NlaEvalChannel, so that it doesn't blend things wrong */
1977 static void nlaevalchan_value_init(NlaEvalChannel *nec)
1978 {
1979         PointerRNA *ptr = &nec->ptr;
1980         PropertyRNA *prop = nec->prop;
1981         int index = nec->index;
1982         
1983         /* NOTE: while this doesn't work for all RNA properties as default values aren't in fact 
1984          * set properly for most of them, at least the common ones (which also happen to get used 
1985          * in NLA strips a lot, e.g. scale) are set correctly.
1986          */
1987         switch (RNA_property_type(prop)) {
1988                 case PROP_BOOLEAN:
1989                         if (RNA_property_array_check(prop))
1990                                 nec->value = (float)RNA_property_boolean_get_default_index(ptr, prop, index);
1991                         else
1992                                 nec->value = (float)RNA_property_boolean_get_default(ptr, prop);
1993                         break;
1994                 case PROP_INT:
1995                         if (RNA_property_array_check(prop))
1996                                 nec->value = (float)RNA_property_int_get_default_index(ptr, prop, index);
1997                         else
1998                                 nec->value = (float)RNA_property_int_get_default(ptr, prop);
1999                         break;
2000                 case PROP_FLOAT:
2001                         if (RNA_property_array_check(prop))
2002                                 nec->value = RNA_property_float_get_default_index(ptr, prop, index);
2003                         else
2004                                 nec->value = RNA_property_float_get_default(ptr, prop);
2005                         break;
2006                 case PROP_ENUM:
2007                         nec->value = (float)RNA_property_enum_get_default(ptr, prop);
2008                         break;
2009                 default:
2010                         break;
2011         }
2012 }
2013
2014 /* verify that an appropriate NlaEvalChannel for this F-Curve exists */
2015 static NlaEvalChannel *nlaevalchan_verify(PointerRNA *ptr, ListBase *channels, NlaEvalStrip *nes, FCurve *fcu, bool *newChan)
2016 {
2017         NlaEvalChannel *nec;
2018         NlaStrip *strip = nes->strip;
2019         PropertyRNA *prop;
2020         PointerRNA new_ptr;
2021         char *path = NULL;
2022         /* short free_path = 0; */
2023         
2024         /* sanity checks */
2025         if (channels == NULL)
2026                 return NULL;
2027         
2028         /* get RNA pointer+property info from F-Curve for more convenient handling */
2029         /* get path, remapped as appropriate to work in its new environment */
2030         /* free_path = */ /* UNUSED */ animsys_remap_path(strip->remap, fcu->rna_path, &path);
2031         
2032         /* a valid property must be available, and it must be animatable */
2033         if (RNA_path_resolve_property(ptr, path, &new_ptr, &prop) == false) {
2034                 if (G.debug & G_DEBUG) printf("NLA Strip Eval: Cannot resolve path\n");
2035                 return NULL;
2036         }
2037         /* only ok if animatable */
2038         else if (RNA_property_animateable(&new_ptr, prop) == 0) {
2039                 if (G.debug & G_DEBUG) printf("NLA Strip Eval: Property not animatable\n");
2040                 return NULL;
2041         }
2042         
2043         /* try to find a match */
2044         nec = nlaevalchan_find_match(channels, &new_ptr, prop, fcu->array_index);
2045         
2046         /* allocate a new struct for this if none found */
2047         if (nec == NULL) {
2048                 nec = MEM_callocN(sizeof(NlaEvalChannel), "NlaEvalChannel");
2049                 BLI_addtail(channels, nec);
2050                 
2051                 /* store property links for writing to the property later */
2052                 nec->ptr = new_ptr;
2053                 nec->prop = prop;
2054                 nec->index = fcu->array_index;
2055                 
2056                 /* initialise value using default value of property [#35856] */
2057                 nlaevalchan_value_init(nec);
2058                 *newChan = true;
2059         }
2060         else
2061                 *newChan = false;
2062         
2063         /* we can now return */
2064         return nec;
2065 }
2066
2067 /* accumulate (i.e. blend) the given value on to the channel it affects */
2068 static void nlaevalchan_accumulate(NlaEvalChannel *nec, NlaEvalStrip *nes, float value, bool newChan)
2069 {
2070         NlaStrip *strip = nes->strip;
2071         short blendmode = strip->blendmode;
2072         float inf = strip->influence;
2073         
2074         /* for replace blend mode, and if this is the first strip,
2075          * just replace the value regardless of the influence */
2076         if (newChan && blendmode == NLASTRIP_MODE_REPLACE) {
2077                 nec->value = value;
2078                 return;
2079         }
2080
2081         /* if this is being performed as part of transition evaluation, incorporate
2082          * an additional weighting factor for the influence
2083          */
2084         if (nes->strip_mode == NES_TIME_TRANSITION_END) 
2085                 inf *= nes->strip_time;
2086         
2087         /* optimisation: no need to try applying if there is no influence */
2088         if (IS_EQF(inf, 0.0f)) return;
2089         
2090         /* perform blending */
2091         switch (blendmode) {
2092                 case NLASTRIP_MODE_ADD:
2093                         /* simply add the scaled value on to the stack */
2094                         nec->value += (value * inf);
2095                         break;
2096                         
2097                 case NLASTRIP_MODE_SUBTRACT:
2098                         /* simply subtract the scaled value from the stack */
2099                         nec->value -= (value * inf);
2100                         break;
2101                         
2102                 case NLASTRIP_MODE_MULTIPLY:
2103                         /* multiply the scaled value with the stack */
2104                         /* Formula Used: 
2105                          *     result = fac * (a * b) + (1 - fac) * a 
2106                          */
2107                         nec->value = inf * (nec->value * value)  +   (1 - inf) * nec->value;
2108                         break;
2109                 
2110                 case NLASTRIP_MODE_REPLACE:
2111                 default: /* TODO: do we really want to blend by default? it seems more uses might prefer add... */
2112                         /* do linear interpolation 
2113                          *      - the influence of the accumulated data (elsewhere, that is called dstweight) 
2114                          *        is 1 - influence, since the strip's influence is srcweight
2115                          */
2116                         nec->value = nec->value * (1.0f - inf)   +   (value * inf);
2117                         break;
2118         }
2119 }
2120
2121 /* accumulate the results of a temporary buffer with the results of the full-buffer */
2122 static void nlaevalchan_buffers_accumulate(ListBase *channels, ListBase *tmp_buffer, NlaEvalStrip *nes)
2123 {
2124         NlaEvalChannel *nec, *necn, *necd;
2125         
2126         /* optimize - abort if no channels */
2127         if (BLI_listbase_is_empty(tmp_buffer))
2128                 return;
2129         
2130         /* accumulate results in tmp_channels buffer to the accumulation buffer */
2131         for (nec = tmp_buffer->first; nec; nec = necn) {
2132                 /* get pointer to next channel in case we remove the current channel from the temp-buffer */
2133                 necn = nec->next;
2134                 
2135                 /* try to find an existing matching channel for this setting in the accumulation buffer */
2136                 necd = nlaevalchan_find_match(channels, &nec->ptr, nec->prop, nec->index);
2137                 
2138                 /* if there was a matching channel already in the buffer, accumulate to it,
2139                  * otherwise, add the current channel to the buffer for efficiency
2140                  */
2141                 if (necd)
2142                         nlaevalchan_accumulate(necd, nes, 0, nec->value);
2143                 else {
2144                         BLI_remlink(tmp_buffer, nec);
2145                         BLI_addtail(channels, nec);
2146                 }
2147         }
2148         
2149         /* free temp-channels that haven't been assimilated into the buffer */
2150         BLI_freelistN(tmp_buffer);
2151 }
2152
2153 /* ---------------------- */
2154 /* F-Modifier stack joining/separation utilities - should we generalise these for BLI_listbase.h interface? */
2155
2156 /* Temporarily join two lists of modifiers together, storing the result in a third list */
2157 static void nlaeval_fmodifiers_join_stacks(ListBase *result, ListBase *list1, ListBase *list2)
2158 {
2159         FModifier *fcm1, *fcm2;
2160         
2161         /* if list1 is invalid...  */
2162         if (ELEM(NULL, list1, list1->first)) {
2163                 if (list2 && list2->first) {
2164                         result->first = list2->first;
2165                         result->last = list2->last;
2166                 }
2167         }
2168         /* if list 2 is invalid... */
2169         else if (ELEM(NULL, list2, list2->first)) {
2170                 result->first = list1->first;
2171                 result->last = list1->last;
2172         }
2173         else {
2174                 /* list1 should be added first, and list2 second, with the endpoints of these being the endpoints for result 
2175                  *  - the original lists must be left unchanged though, as we need that fact for restoring
2176                  */
2177                 result->first = list1->first;
2178                 result->last = list2->last;
2179                 
2180                 fcm1 = list1->last;
2181                 fcm2 = list2->first;
2182                 
2183                 fcm1->next = fcm2;
2184                 fcm2->prev = fcm1;
2185         }
2186 }
2187
2188 /* Split two temporary lists of modifiers */
2189 static void nlaeval_fmodifiers_split_stacks(ListBase *list1, ListBase *list2)
2190 {
2191         FModifier *fcm1, *fcm2;
2192         
2193         /* if list1/2 is invalid... just skip */
2194         if (ELEM(NULL, list1, list2))
2195                 return;
2196         if (ELEM(NULL, list1->first, list2->first))
2197                 return;
2198                 
2199         /* get endpoints */
2200         fcm1 = list1->last;
2201         fcm2 = list2->first;
2202         
2203         /* clear their links */
2204         fcm1->next = NULL;
2205         fcm2->prev = NULL;
2206 }
2207
2208 /* ---------------------- */
2209
2210 /* evaluate action-clip strip */
2211 static void nlastrip_evaluate_actionclip(PointerRNA *ptr, ListBase *channels, ListBase *modifiers, NlaEvalStrip *nes)
2212 {
2213         FModifierStackStorage *storage;
2214         ListBase tmp_modifiers = {NULL, NULL};
2215         NlaStrip *strip = nes->strip;
2216         FCurve *fcu;
2217         float evaltime;
2218         
2219         /* sanity checks for action */
2220         if (strip == NULL)
2221                 return;
2222                 
2223         if (strip->act == NULL) {
2224                 printf("NLA-Strip Eval Error: Strip '%s' has no Action\n", strip->name);
2225                 return;
2226         }
2227         
2228         action_idcode_patch_check(ptr->id.data, strip->act);
2229         
2230         /* join this strip's modifiers to the parent's modifiers (own modifiers first) */
2231         nlaeval_fmodifiers_join_stacks(&tmp_modifiers, &strip->modifiers, modifiers);
2232         
2233         /* evaluate strip's modifiers which modify time to evaluate the base curves at */
2234         storage = evaluate_fmodifiers_storage_new(&tmp_modifiers);
2235         evaltime = evaluate_time_fmodifiers(storage, &tmp_modifiers, NULL, 0.0f, strip->strip_time);
2236         
2237         /* evaluate all the F-Curves in the action, saving the relevant pointers to data that will need to be used */
2238         for (fcu = strip->act->curves.first; fcu; fcu = fcu->next) {
2239                 NlaEvalChannel *nec;
2240                 float value = 0.0f;
2241                 bool newChan;
2242                 
2243                 /* check if this curve should be skipped */
2244                 if (fcu->flag & (FCURVE_MUTED | FCURVE_DISABLED))
2245                         continue;
2246                 if ((fcu->grp) && (fcu->grp->flag & AGRP_MUTED))
2247                         continue;
2248                         
2249                 /* evaluate the F-Curve's value for the time given in the strip 
2250                  * NOTE: we use the modified time here, since strip's F-Curve Modifiers are applied on top of this 
2251                  */
2252                 value = evaluate_fcurve(fcu, evaltime);
2253                 
2254                 /* apply strip's F-Curve Modifiers on this value 
2255                  * NOTE: we apply the strip's original evaluation time not the modified one (as per standard F-Curve eval)
2256                  */
2257                 evaluate_value_fmodifiers(storage, &tmp_modifiers, fcu, &value, strip->strip_time);
2258                 
2259                 
2260                 /* get an NLA evaluation channel to work with, and accumulate the evaluated value with the value(s)
2261                  * stored in this channel if it has been used already
2262                  */
2263                 nec = nlaevalchan_verify(ptr, channels, nes, fcu, &newChan);
2264                 if (nec)
2265                         nlaevalchan_accumulate(nec, nes, value, newChan);
2266         }
2267
2268         /* free temporary storage */
2269         evaluate_fmodifiers_storage_free(storage);
2270
2271         /* unlink this strip's modifiers from the parent's modifiers again */
2272         nlaeval_fmodifiers_split_stacks(&strip->modifiers, modifiers);
2273 }
2274
2275 /* evaluate transition strip */
2276 static void nlastrip_evaluate_transition(PointerRNA *ptr, ListBase *channels, ListBase *modifiers, NlaEvalStrip *nes)
2277 {
2278         ListBase tmp_channels = {NULL, NULL};
2279         ListBase tmp_modifiers = {NULL, NULL};
2280         NlaEvalStrip tmp_nes;
2281         NlaStrip *s1, *s2;
2282         
2283         /* join this strip's modifiers to the parent's modifiers (own modifiers first) */
2284         nlaeval_fmodifiers_join_stacks(&tmp_modifiers, &nes->strip->modifiers, modifiers);
2285         
2286         /* get the two strips to operate on 
2287          *      - we use the endpoints of the strips directly flanking our strip
2288          *        using these as the endpoints of the transition (destination and source)
2289          *      - these should have already been determined to be valid...
2290          *      - if this strip is being played in reverse, we need to swap these endpoints
2291          *        otherwise they will be interpolated wrong
2292          */
2293         if (nes->strip->flag & NLASTRIP_FLAG_REVERSE) {
2294                 s1 = nes->strip->next;
2295                 s2 = nes->strip->prev;
2296         }
2297         else {
2298                 s1 = nes->strip->prev;
2299                 s2 = nes->strip->next;
2300         }
2301         
2302         /* prepare template for 'evaluation strip' 
2303          *      - based on the transition strip's evaluation strip data
2304          *      - strip_mode is NES_TIME_TRANSITION_* based on which endpoint
2305          *      - strip_time is the 'normalized' (i.e. in-strip) time for evaluation,
2306          *        which doubles up as an additional weighting factor for the strip influences
2307          *        which allows us to appear to be 'interpolating' between the two extremes
2308          */
2309         tmp_nes = *nes;
2310         
2311         /* evaluate these strips into a temp-buffer (tmp_channels) */
2312         /* FIXME: modifier evaluation here needs some work... */
2313         /* first strip */
2314         tmp_nes.strip_mode = NES_TIME_TRANSITION_START;
2315         tmp_nes.strip = s1;
2316         nlastrip_evaluate(ptr, &tmp_channels, &tmp_modifiers, &tmp_nes);
2317         
2318         /* second strip */
2319         tmp_nes.strip_mode = NES_TIME_TRANSITION_END;
2320         tmp_nes.strip = s2;
2321         nlastrip_evaluate(ptr, &tmp_channels, &tmp_modifiers, &tmp_nes);
2322         
2323         
2324         /* accumulate temp-buffer and full-buffer, using the 'real' strip */
2325         nlaevalchan_buffers_accumulate(channels, &tmp_channels, nes);
2326         
2327         /* unlink this strip's modifiers from the parent's modifiers again */
2328         nlaeval_fmodifiers_split_stacks(&nes->strip->modifiers, modifiers);
2329 }
2330
2331 /* evaluate meta-strip */
2332 static void nlastrip_evaluate_meta(PointerRNA *ptr, ListBase *channels, ListBase *modifiers, NlaEvalStrip *nes)
2333 {
2334         ListBase tmp_modifiers = {NULL, NULL};
2335         NlaStrip *strip = nes->strip;
2336         NlaEvalStrip *tmp_nes;
2337         float evaltime;
2338         
2339         /* meta-strip was calculated normally to have some time to be evaluated at
2340          * and here we 'look inside' the meta strip, treating it as a decorated window to
2341          * it's child strips, which get evaluated as if they were some tracks on a strip 
2342          * (but with some extra modifiers to apply).
2343          *
2344          * NOTE: keep this in sync with animsys_evaluate_nla()
2345          */
2346         
2347         /* join this strip's modifiers to the parent's modifiers (own modifiers first) */
2348         nlaeval_fmodifiers_join_stacks(&tmp_modifiers, &strip->modifiers, modifiers); 
2349         
2350         /* find the child-strip to evaluate */
2351         evaltime = (nes->strip_time * (strip->end - strip->start)) + strip->start;
2352         tmp_nes = nlastrips_ctime_get_strip(NULL, &strip->strips, -1, evaltime);
2353         
2354         /* directly evaluate child strip into accumulation buffer... 
2355          * - there's no need to use a temporary buffer (as it causes issues [T40082])
2356          */
2357         if (tmp_nes) {
2358                 nlastrip_evaluate(ptr, channels, &tmp_modifiers, tmp_nes);
2359                 
2360                 /* free temp eval-strip */
2361                 MEM_freeN(tmp_nes);
2362         }
2363         
2364         /* unlink this strip's modifiers from the parent's modifiers again */
2365         nlaeval_fmodifiers_split_stacks(&strip->modifiers, modifiers);
2366 }
2367
2368 /* evaluates the given evaluation strip */
2369 void nlastrip_evaluate(PointerRNA *ptr, ListBase *channels, ListBase *modifiers, NlaEvalStrip *nes)
2370 {
2371         NlaStrip *strip = nes->strip;
2372         
2373         /* to prevent potential infinite recursion problems (i.e. transition strip, beside meta strip containing a transition
2374          * several levels deep inside it), we tag the current strip as being evaluated, and clear this when we leave
2375          */
2376         /* TODO: be careful with this flag, since some edit tools may be running and have set this while animplayback was running */
2377         if (strip->flag & NLASTRIP_FLAG_EDIT_TOUCHED)
2378                 return;
2379         strip->flag |= NLASTRIP_FLAG_EDIT_TOUCHED;
2380         
2381         /* actions to take depend on the type of strip */
2382         switch (strip->type) {
2383                 case NLASTRIP_TYPE_CLIP: /* action-clip */
2384                         nlastrip_evaluate_actionclip(ptr, channels, modifiers, nes);
2385                         break;
2386                 case NLASTRIP_TYPE_TRANSITION: /* transition */
2387                         nlastrip_evaluate_transition(ptr, channels, modifiers, nes);
2388                         break;
2389                 case NLASTRIP_TYPE_META: /* meta */
2390                         nlastrip_evaluate_meta(ptr, channels, modifiers, nes);
2391                         break;
2392                         
2393                 default: /* do nothing */
2394                         break;
2395         }
2396         
2397         /* clear temp recursion safe-check */
2398         strip->flag &= ~NLASTRIP_FLAG_EDIT_TOUCHED;
2399 }
2400
2401 /* write the accumulated settings to */
2402 void nladata_flush_channels(ListBase *channels)
2403 {
2404         NlaEvalChannel *nec;
2405         
2406         /* sanity checks */
2407         if (channels == NULL)
2408                 return;
2409         
2410         /* for each channel with accumulated values, write its value on the property it affects */
2411         for (nec = channels->first; nec; nec = nec->next) {
2412                 PointerRNA *ptr = &nec->ptr;
2413                 PropertyRNA *prop = nec->prop;
2414                 int array_index = nec->index;
2415                 float value = nec->value;
2416                 
2417                 /* write values - see animsys_write_rna_setting() to sync the code */
2418                 switch (RNA_property_type(prop)) {
2419                         case PROP_BOOLEAN:
2420                                 if (RNA_property_array_check(prop))
2421                                         RNA_property_boolean_set_index(ptr, prop, array_index, ANIMSYS_FLOAT_AS_BOOL(value));
2422                                 else
2423                                         RNA_property_boolean_set(ptr, prop, ANIMSYS_FLOAT_AS_BOOL(value));
2424                                 break;
2425                         case PROP_INT:
2426                                 if (RNA_property_array_check(prop))
2427                                         RNA_property_int_set_index(ptr, prop, array_index, (int)value);
2428                                 else
2429                                         RNA_property_int_set(ptr, prop, (int)value);
2430                                 break;
2431                         case PROP_FLOAT:
2432                                 if (RNA_property_array_check(prop))
2433                                         RNA_property_float_set_index(ptr, prop, array_index, value);
2434                                 else
2435                                         RNA_property_float_set(ptr, prop, value);
2436                                 break;
2437                         case PROP_ENUM:
2438                                 RNA_property_enum_set(ptr, prop, (int)value);
2439                                 break;
2440                         default:
2441                                 /* can't do anything with other types of property.... */
2442                                 break;
2443                 }
2444         }
2445 }
2446
2447 /* ---------------------- */
2448
2449 /**
2450  * NLA Evaluation function - values are calculated and stored in temporary "NlaEvalChannels"
2451  *
2452  * \note This is exported so that keyframing code can use this for make use of it for anim layers support
2453  *
2454  * \param[out] echannels Evaluation channels with calculated values
2455  */
2456 static void animsys_evaluate_nla(ListBase *echannels, PointerRNA *ptr, AnimData *adt, float ctime)
2457 {
2458         NlaTrack *nlt;
2459         short track_index = 0;
2460         bool has_strips = false;
2461         
2462         ListBase estrips = {NULL, NULL};
2463         NlaEvalStrip *nes;
2464         
2465         NlaStrip dummy_strip = {NULL}; /* dummy strip for active action */
2466         
2467         
2468         /* 1. get the stack of strips to evaluate at current time (influence calculated here) */
2469         for (nlt = adt->nla_tracks.first; nlt; nlt = nlt->next, track_index++) {
2470                 /* stop here if tweaking is on and this strip is the tweaking track (it will be the first one that's 'disabled')... */
2471                 if ((adt->flag & ADT_NLA_EDIT_ON) && (nlt->flag & NLATRACK_DISABLED))
2472                         break;
2473                         
2474                 /* solo and muting are mutually exclusive... */
2475                 if (adt->flag & ADT_NLA_SOLO_TRACK) {
2476                         /* skip if there is a solo track, but this isn't it */
2477                         if ((nlt->flag & NLATRACK_SOLO) == 0)
2478                                 continue;
2479                         /* else - mute doesn't matter */
2480                 }
2481                 else {
2482                         /* no solo tracks - skip track if muted */
2483                         if (nlt->flag & NLATRACK_MUTED) 
2484                                 continue;
2485                 }
2486                 
2487                 /* if this track has strips (but maybe they won't be suitable), set has_strips 
2488                  *      - used for mainly for still allowing normal action evaluation...
2489                  */
2490                 if (nlt->strips.first)
2491                         has_strips = true;
2492                         
2493                 /* otherwise, get strip to evaluate for this channel */
2494                 nes = nlastrips_ctime_get_strip(&estrips, &nlt->strips, track_index, ctime);
2495                 if (nes) nes->track = nlt;
2496         }
2497         
2498         /* add 'active' Action (may be tweaking track) as last strip to evaluate in NLA stack
2499          *      - only do this if we're not exclusively evaluating the 'solo' NLA-track
2500          *      - however, if the 'solo' track houses the current 'tweaking' strip, 
2501          *        then we should allow this to play, otherwise nothing happens
2502          */
2503         if ((adt->action) && ((adt->flag & ADT_NLA_SOLO_TRACK) == 0 || (adt->flag & ADT_NLA_EDIT_ON))) {
2504                 /* if there are strips, evaluate action as per NLA rules */
2505                 if ((has_strips) || (adt->actstrip)) {
2506                         /* make dummy NLA strip, and add that to the stack */
2507                         ListBase dummy_trackslist;
2508                         
2509                         dummy_trackslist.first = dummy_trackslist.last = &dummy_strip;
2510                         
2511                         if ((nlt) && !(adt->flag & ADT_NLA_EDIT_NOMAP)) {
2512                                 /* edit active action in-place according to its active strip, so copy the data  */
2513                                 memcpy(&dummy_strip, adt->actstrip, sizeof(NlaStrip));
2514                                 dummy_strip.next = dummy_strip.prev = NULL;
2515                         }
2516                         else {
2517                                 /* set settings of dummy NLA strip from AnimData settings */
2518                                 dummy_strip.act = adt->action;
2519                                 dummy_strip.remap = adt->remap;
2520                                 
2521                                 /* action range is calculated taking F-Modifiers into account (which making new strips doesn't do due to the troublesome nature of that) */
2522                                 calc_action_range(dummy_strip.act, &dummy_strip.actstart, &dummy_strip.actend, 1);
2523                                 dummy_strip.start = dummy_strip.actstart;
2524                                 dummy_strip.end = (IS_EQF(dummy_strip.actstart, dummy_strip.actend)) ?  (dummy_strip.actstart + 1.0f) : (dummy_strip.actend);
2525                                 
2526                                 dummy_strip.blendmode = adt->act_blendmode;
2527                                 dummy_strip.extendmode = adt->act_extendmode;
2528                                 dummy_strip.influence = adt->act_influence;
2529                                 
2530                                 /* NOTE: must set this, or else the default setting overrides, and this setting doesn't work */
2531                                 dummy_strip.flag |= NLASTRIP_FLAG_USR_INFLUENCE;
2532                         }
2533                         
2534                         /* add this to our list of evaluation strips */
2535                         nlastrips_ctime_get_strip(&estrips, &dummy_trackslist, -1, ctime);
2536                 }
2537                 else {
2538                         /* special case - evaluate as if there isn't any NLA data */
2539                         /* TODO: this is really just a stop-gap measure... */
2540                         if (G.debug & G_DEBUG) printf("NLA Eval: Stopgap for active action on NLA Stack - no strips case\n");
2541                         
2542                         animsys_evaluate_action(ptr, adt->action, adt->remap, ctime);
2543                         BLI_freelistN(&estrips);
2544                         return;
2545                 }
2546         }
2547         
2548         /* only continue if there are strips to evaluate */
2549         if (BLI_listbase_is_empty(&estrips))
2550                 return;
2551         
2552         
2553         /* 2. for each strip, evaluate then accumulate on top of existing channels, but don't set values yet */
2554         for (nes = estrips.first; nes; nes = nes->next)
2555                 nlastrip_evaluate(ptr, echannels, NULL, nes);
2556                 
2557         /* 3. free temporary evaluation data that's not used elsewhere */
2558         BLI_freelistN(&estrips);
2559
2560         /* Tag ID as updated so render engines will recognize changes in data
2561          * which is animated but doesn't have actions.
2562          */
2563         if (ptr->id.data != NULL) {
2564                 ID *id = ptr->id.data;
2565                 if (!(id->tag & LIB_TAG_ANIM_NO_RECALC)) {
2566                         id->tag |= LIB_TAG_ID_RECALC;
2567                         DAG_id_type_tag(G.main, GS(id->name));
2568                 }
2569         }
2570 }
2571
2572 /* NLA Evaluation function (mostly for use through do_animdata) 
2573  *      - All channels that will be affected are not cleared anymore. Instead, we just evaluate into 
2574  *              some temp channels, where values can be accumulated in one go.
2575  */
2576 static void animsys_calculate_nla(PointerRNA *ptr, AnimData *adt, float ctime)
2577 {
2578         ListBase echannels = {NULL, NULL};
2579
2580         /* TODO: need to zero out all channels used, otherwise we have problems with threadsafety
2581          * and also when the user jumps between different times instead of moving sequentially... */
2582
2583         /* evaluate the NLA stack, obtaining a set of values to flush */
2584         animsys_evaluate_nla(&echannels, ptr, adt, ctime);
2585         
2586         /* flush effects of accumulating channels in NLA to the actual data they affect */
2587         nladata_flush_channels(&echannels);
2588         
2589         /* free temp data */
2590         BLI_freelistN(&echannels);
2591 }
2592
2593 /* ***************************************** */ 
2594 /* Overrides System - Public API */
2595
2596 /* Clear all overrides */
2597
2598 /* Add or get existing Override for given setting */
2599 #if 0
2600 AnimOverride *BKE_animsys_validate_override(PointerRNA *UNUSED(ptr), char *UNUSED(path), int UNUSED(array_index))
2601 {
2602         /* FIXME: need to define how to get overrides */
2603         return NULL;
2604 }
2605 #endif
2606
2607 /* -------------------- */
2608
2609 /* Evaluate Overrides */
2610 static void animsys_evaluate_overrides(PointerRNA *ptr, AnimData *adt)
2611 {
2612         AnimOverride *aor;
2613         
2614         /* for each override, simply execute... */
2615         for (aor = adt->overrides.first; aor; aor = aor->next)
2616                 animsys_write_rna_setting(ptr, aor->rna_path, aor->array_index, aor->value);
2617 }
2618
2619 /* ***************************************** */
2620 /* Evaluation System - Public API */
2621
2622 /* Overview of how this system works:
2623  *      1) Depsgraph sorts data as necessary, so that data is in an order that means 
2624  *              that all dependencies are resolved before dependents.
2625  *      2) All normal animation is evaluated, so that drivers have some basis values to
2626  *              work with
2627  *              a.      NLA stacks are done first, as the Active Actions act as 'tweaking' tracks
2628  *                      which modify the effects of the NLA-stacks
2629  *              b.      Active Action is evaluated as per normal, on top of the results of the NLA tracks
2630  *
2631  * --------------< often in a separate phase... >------------------ 
2632  *
2633  *      3) Drivers/expressions are evaluated on top of this, in an order where dependencies are
2634  *              resolved nicely. 
2635  *         Note: it may be necessary to have some tools to handle the cases where some higher-level
2636  *              drivers are added and cause some problematic dependencies that didn't exist in the local levels...
2637  *
2638  * --------------< always executed >------------------ 
2639  *
2640  * Maintenance of editability of settings (XXX):
2641  *      In order to ensure that settings that are animated can still be manipulated in the UI without requiring
2642  *      that keyframes are added to prevent these values from being overwritten, we use 'overrides'. 
2643  *
2644  * Unresolved things:
2645  *      - Handling of multi-user settings (i.e. time-offset, group-instancing) -> big cache grids or nodal system? but stored where?
2646  *      - Multiple-block dependencies (i.e. drivers for settings are in both local and higher levels) -> split into separate lists? 
2647  *
2648  * Current Status:
2649  *      - Currently (as of September 2009), overrides we haven't needed to (fully) implement overrides. 
2650  *    However, the code for this is relatively harmless, so is left in the code for now.
2651  */
2652
2653 /* Evaluation loop for evaluation animation data 
2654  *
2655  * This assumes that the animation-data provided belongs to the ID block in question,
2656  * and that the flags for which parts of the anim-data settings need to be recalculated 
2657  * have been set already by the depsgraph. Now, we use the recalc 
2658  */
2659 void BKE_animsys_evaluate_animdata(Scene *scene, ID *id, AnimData *adt, float ctime, short recalc)
2660 {
2661         PointerRNA id_ptr;
2662         
2663         /* sanity checks */
2664         if (ELEM(NULL, id, adt))
2665                 return;
2666         
2667         /* get pointer to ID-block for RNA to use */
2668         RNA_id_pointer_create(id, &id_ptr);
2669         
2670         /* recalculate keyframe data:
2671          *      - NLA before Active Action, as Active Action behaves as 'tweaking track'
2672          *        that overrides 'rough' work in NLA
2673          */
2674         /* TODO: need to double check that this all works correctly */
2675         if ((recalc & ADT_RECALC_ANIM) || (adt->recalc & ADT_RECALC_ANIM)) {
2676                 /* evaluate NLA data */
2677                 if ((adt->nla_tracks.first) && !(adt->flag & ADT_NLA_EVAL_OFF)) {
2678                         /* evaluate NLA-stack 
2679                          *      - active action is evaluated as part of the NLA stack as the last item
2680                          */
2681                         animsys_calculate_nla(&id_ptr, adt, ctime);
2682                 }
2683                 /* evaluate Active Action only */
2684                 else if (adt->action)
2685                         animsys_evaluate_action(&id_ptr, adt->action, adt->remap, ctime);
2686                 
2687                 /* reset tag */
2688                 adt->recalc &= ~ADT_RECALC_ANIM;
2689         }
2690         
2691         /* recalculate drivers 
2692          *      - Drivers need to be evaluated afterwards, as they can either override 
2693          *        or be layered on top of existing animation data.
2694          *      - Drivers should be in the appropriate order to be evaluated without problems...
2695          */
2696         if ((recalc & ADT_RECALC_DRIVERS)
2697             /* XXX for now, don't check yet, as depsgraph hasn't been updated */
2698             /* && (adt->recalc & ADT_RECALC_DRIVERS)*/)
2699         {
2700                 animsys_evaluate_drivers(&id_ptr, adt, ctime);
2701         }
2702         
2703         /* always execute 'overrides' 
2704          *      - Overrides allow editing, by overwriting the value(s) set from animation-data, with the
2705          *        value last set by the user (and not keyframed yet). 
2706          *      - Overrides are cleared upon frame change and/or keyframing
2707          *      - It is best that we execute this every time, so that no errors are likely to occur.
2708          */
2709         animsys_evaluate_overrides(&id_ptr, adt);
2710         
2711         /* execute and clear all cached property update functions */
2712         if (scene) {
2713                 Main *bmain = G.main; // xxx - to get passed in!
2714                 RNA_property_update_cache_flush(bmain, scene);
2715                 RNA_property_update_cache_free();
2716         }
2717         
2718         /* clear recalc flag now */
2719         adt->recalc = 0;
2720 }
2721
2722 /* Evaluation of all ID-blocks with Animation Data blocks - Animation Data Only
2723  *
2724  * This will evaluate only the animation info available in the animation data-blocks
2725  * encountered. In order to enforce the system by which some settings controlled by a
2726  * 'local' (i.e. belonging in the nearest ID-block that setting is related to, not a
2727  * standard 'root') block are overridden by a larger 'user'
2728  */
2729 void BKE_animsys_evaluate_all_animation(Main *main, Scene *scene, float ctime)
2730 {
2731         ID *id;
2732
2733         if (G.debug & G_DEBUG)
2734                 printf("Evaluate all animation - %f\n", ctime);
2735         
2736         /* macros for less typing 
2737          *      - only evaluate animation data for id if it has users (and not just fake ones)
2738          *      - whether animdata exists is checked for by the evaluation function, though taking 
2739          *        this outside of the function may make things slightly faster?
2740          */
2741 #define EVAL_ANIM_IDS(first, aflag) \
2742         for (id = first; id; id = id->next) { \
2743                 if (ID_REAL_USERS(id) > 0) { \
2744                         AnimData *adt = BKE_animdata_from_id(id); \
2745                         BKE_animsys_evaluate_animdata(scene, id, adt, ctime, aflag); \
2746                 } \
2747         } (void)0
2748
2749         /* another macro for the "embedded" nodetree cases 
2750          *      - this is like EVAL_ANIM_IDS, but this handles the case "embedded nodetrees" 
2751          *        (i.e. scene/material/texture->nodetree) which we need a special exception
2752          *    for, otherwise they'd get skipped
2753          *      - ntp = "node tree parent" = datablock where node tree stuff resides
2754          */
2755 #define EVAL_ANIM_NODETREE_IDS(first, NtId_Type, aflag) \
2756         for (id = first; id; id = id->next) { \
2757                 if (ID_REAL_USERS(id) > 0) { \
2758                         AnimData *adt = BKE_animdata_from_id(id); \
2759                         NtId_Type *ntp = (NtId_Type *)id; \
2760                         if (ntp->nodetree) { \
2761                                 AnimData *adt2 = BKE_animdata_from_id((ID *)ntp->nodetree); \
2762                                 BKE_animsys_evaluate_animdata(scene, (ID *)ntp->nodetree, adt2, ctime, ADT_RECALC_ANIM); \
2763                         } \
2764                         BKE_animsys_evaluate_animdata(scene, id, adt, ctime, aflag); \
2765                 } \
2766         } (void)0
2767         
2768         /* optimization: 
2769          * when there are no actions, don't go over database and loop over heaps of datablocks, 
2770          * which should ultimately be empty, since it is not possible for now to have any animation 
2771          * without some actions, and drivers wouldn't get affected by any state changes
2772          *
2773          * however, if there are some curves, we will need to make sure that their 'ctime' property gets
2774          * set correctly, so this optimization must be skipped in that case...
2775          */
2776         if (BLI_listbase_is_empty(&main->action) && BLI_listbase_is_empty(&main->curve)) {
2777                 if (G.debug & G_DEBUG)
2778                         printf("\tNo Actions, so no animation needs to be evaluated...\n");
2779                         
2780                 return;
2781         }
2782         
2783         /* nodes */
2784         EVAL_ANIM_IDS(main->nodetree.first, ADT_RECALC_ANIM);
2785         
2786         /* textures */
2787         EVAL_ANIM_NODETREE_IDS(main->tex.first, Tex, ADT_RECALC_ANIM);
2788         
2789         /* lamps */
2790         EVAL_ANIM_NODETREE_IDS(main->lamp.first, Lamp, ADT_RECALC_ANIM);
2791         
2792         /* materials */
2793         EVAL_ANIM_NODETREE_IDS(main->mat.first, Material, ADT_RECALC_ANIM);
2794         
2795         /* cameras */
2796         EVAL_ANIM_IDS(main->camera.first, ADT_RECALC_ANIM);
2797         
2798         /* shapekeys */
2799         EVAL_ANIM_IDS(main->key.first, ADT_RECALC_ANIM);
2800         
2801         /* metaballs */
2802         EVAL_ANIM_IDS(main->mball.first, ADT_RECALC_ANIM);
2803         
2804         /* curves */
2805         EVAL_ANIM_IDS(main->curve.first, ADT_RECALC_ANIM);
2806         
2807         /* armatures */
2808         EVAL_ANIM_IDS(main->armature.first, ADT_RECALC_ANIM);
2809         
2810         /* lattices */
2811         EVAL_ANIM_IDS(main->latt.first, ADT_RECALC_ANIM);
2812         
2813         /* meshes */
2814         EVAL_ANIM_IDS(main->mesh.first, ADT_RECALC_ANIM);
2815         
2816         /* particles */
2817         EVAL_ANIM_IDS(main->particle.first, ADT_RECALC_ANIM);
2818         
2819         /* speakers */
2820         EVAL_ANIM_IDS(main->speaker.first, ADT_RECALC_ANIM);
2821
2822         /* movie clips */
2823         EVAL_ANIM_IDS(main->movieclip.first, ADT_RECALC_ANIM);
2824
2825         /* linestyles */
2826         EVAL_ANIM_IDS(main->linestyle.first, ADT_RECALC_ANIM);
2827         
2828         /* grease pencil */
2829         EVAL_ANIM_IDS(main->gpencil.first, ADT_RECALC_ANIM);
2830         
2831         /* objects */
2832         /* ADT_RECALC_ANIM doesn't need to be supplied here, since object AnimData gets
2833          * this tagged by Depsgraph on framechange. This optimization means that objects
2834          * linked from other (not-visible) scenes will not need their data calculated.
2835          */
2836         EVAL_ANIM_IDS(main->object.first, 0); 
2837
2838         /* masks */
2839         EVAL_ANIM_IDS(main->mask.first, ADT_RECALC_ANIM);
2840         
2841         /* worlds */
2842         EVAL_ANIM_NODETREE_IDS(main->world.first, World, ADT_RECALC_ANIM);
2843         
2844         /* scenes */
2845         EVAL_ANIM_NODETREE_IDS(main->scene.first, Scene, ADT_RECALC_ANIM);
2846 }
2847
2848 /* ***************************************** */ 
2849
2850 /* ************** */
2851 /* Evaluation API */
2852
2853 #define DEBUG_PRINT if (G.debug & G_DEBUG_DEPSGRAPH) printf
2854
2855 void BKE_animsys_eval_animdata(EvaluationContext *eval_ctx, ID *id)
2856 {
2857         AnimData *adt = BKE_animdata_from_id(id);
2858         Scene *scene = NULL; /* XXX: this is only needed for flushing RNA updates,
2859                               * which should get handled as part of the graph instead...
2860                               */
2861         DEBUG_PRINT("%s on %s, time=%f\n\n", __func__, id->name, (double)eval_ctx->ctime);
2862         BKE_animsys_evaluate_animdata(scene, id, adt, eval_ctx->ctime, ADT_RECALC_ANIM);
2863 }
2864
2865 void BKE_animsys_eval_driver(EvaluationContext *eval_ctx,
2866                              ID *id,
2867                              FCurve *fcu)
2868 {
2869         /* TODO(sergey): De-duplicate with BKE animsys. */
2870         ChannelDriver *driver = fcu->driver;
2871         PointerRNA id_ptr;
2872         bool ok = false;
2873
2874         DEBUG_PRINT("%s on %s (%s[%d])\n",
2875                     __func__,
2876                     id->name,
2877                     fcu->rna_path,
2878                     fcu->array_index);
2879
2880         RNA_id_pointer_create(id, &id_ptr);
2881
2882         /* check if this driver's curve should be skipped */
2883         if ((fcu->flag & (FCURVE_MUTED | FCURVE_DISABLED)) == 0) {
2884                 /* check if driver itself is tagged for recalculation */
2885                 /* XXX driver recalc flag is not set yet by depsgraph! */
2886                 if ((driver) && !(driver->flag & DRIVER_FLAG_INVALID) /*&& (driver->flag & DRIVER_FLAG_RECALC)*/) {
2887                         /* evaluate this using values set already in other places
2888                          * NOTE: for 'layering' option later on, we should check if we should remove old value before adding
2889                          *       new to only be done when drivers only changed */
2890                         //printf("\told val = %f\n", fcu->curval);
2891                         const float curval = calculate_fcurve(fcu, eval_ctx->ctime);
2892                         ok = BKE_animsys_execute_fcurve(&id_ptr, NULL, fcu, curval);
2893                         //printf("\tnew val = %f\n", fcu->curval);
2894
2895                         /* clear recalc flag */
2896                         driver->flag &= ~DRIVER_FLAG_RECALC;
2897
2898                         /* set error-flag if evaluation failed */
2899                         if (ok == 0) {
2900                                 printf("invalid driver - %s[%d]\n", fcu->rna_path, fcu->array_index);
2901                                 driver->flag |= DRIVER_FLAG_INVALID;
2902                         }
2903                 }
2904         }
2905 }
2906
2907 #undef DEBUG_PRINT