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