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