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