Merging trunk up to r39447.
[blender-staging.git] / source / blender / blenkernel / intern / nla.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/nla.c
29  *  \ingroup bke
30  */
31
32
33 #include <stdlib.h>
34 #include <stddef.h>
35 #include <stdio.h>
36 #include <string.h>
37 #include <math.h>
38 #include <float.h>
39
40 #include "MEM_guardedalloc.h"
41
42 #include "BLI_utildefines.h"
43 #include "BLI_ghash.h"
44
45 #include "DNA_anim_types.h"
46 #include "DNA_scene_types.h"
47 #include "DNA_sound_types.h"
48 #include "DNA_speaker_types.h"
49
50 #include "BKE_action.h"
51 #include "BKE_fcurve.h"
52 #include "BKE_nla.h"
53 #include "BKE_global.h"
54 #include "BKE_library.h"
55
56 #ifdef WITH_AUDASPACE
57 #  include "AUD_C-API.h"
58 #endif
59
60 #include "RNA_access.h"
61 #include "nla_private.h"
62
63
64
65 /* *************************************************** */
66 /* Data Management */
67
68 /* Freeing ------------------------------------------- */
69
70 /* Remove the given NLA strip from the NLA track it occupies, free the strip's data,
71  * and the strip itself. 
72  */
73 void free_nlastrip (ListBase *strips, NlaStrip *strip)
74 {
75         NlaStrip *cs, *csn;
76         
77         /* sanity checks */
78         if (strip == NULL)
79                 return;
80                 
81         /* free child-strips */
82         for (cs= strip->strips.first; cs; cs= csn) {
83                 csn= cs->next;
84                 free_nlastrip(&strip->strips, cs);
85         }
86                 
87         /* remove reference to action */
88         if (strip->act)
89                 id_us_min(&strip->act->id);
90                 
91         /* free remapping info */
92         //if (strip->remap)
93         //      BKE_animremap_free();
94         
95         /* free own F-Curves */
96         free_fcurves(&strip->fcurves);
97         
98         /* free own F-Modifiers */
99         free_fmodifiers(&strip->modifiers);
100         
101         /* free the strip itself */
102         if (strips)
103                 BLI_freelinkN(strips, strip);
104         else
105                 MEM_freeN(strip);
106 }
107
108 /* Remove the given NLA track from the set of NLA tracks, free the track's data,
109  * and the track itself.
110  */
111 void free_nlatrack (ListBase *tracks, NlaTrack *nlt)
112 {
113         NlaStrip *strip, *stripn;
114         
115         /* sanity checks */
116         if (nlt == NULL)
117                 return;
118                 
119         /* free strips */
120         for (strip= nlt->strips.first; strip; strip= stripn) {
121                 stripn= strip->next;
122                 free_nlastrip(&nlt->strips, strip);
123         }
124         
125         /* free NLA track itself now */
126         if (tracks)
127                 BLI_freelinkN(tracks, nlt);
128         else
129                 MEM_freeN(nlt);
130 }
131
132 /* Free the elements of type NLA Tracks provided in the given list, but do not free
133  * the list itself since that is not free-standing
134  */
135 void free_nladata (ListBase *tracks)
136 {
137         NlaTrack *nlt, *nltn;
138         
139         /* sanity checks */
140         if ELEM(NULL, tracks, tracks->first)
141                 return;
142                 
143         /* free tracks one by one */
144         for (nlt= tracks->first; nlt; nlt= nltn) {
145                 nltn= nlt->next;
146                 free_nlatrack(tracks, nlt);
147         }
148         
149         /* clear the list's pointers to be safe */
150         tracks->first= tracks->last= NULL;
151 }
152
153 /* Copying ------------------------------------------- */
154
155 /* Copy NLA strip */
156 NlaStrip *copy_nlastrip (NlaStrip *strip)
157 {
158         NlaStrip *strip_d;
159         NlaStrip *cs, *cs_d;
160         
161         /* sanity check */
162         if (strip == NULL)
163                 return NULL;
164                 
165         /* make a copy */
166         strip_d= MEM_dupallocN(strip);
167         strip_d->next= strip_d->prev= NULL;
168         
169         /* increase user-count of action */
170         if (strip_d->act)
171                 id_us_plus(&strip_d->act->id);
172                 
173         /* copy F-Curves and modifiers */
174         copy_fcurves(&strip_d->fcurves, &strip->fcurves);
175         copy_fmodifiers(&strip_d->modifiers, &strip->modifiers);
176         
177         /* make a copy of all the child-strips, one at a time */
178         strip_d->strips.first= strip_d->strips.last= NULL;
179         
180         for (cs= strip->strips.first; cs; cs= cs->next) {
181                 cs_d= copy_nlastrip(cs);
182                 BLI_addtail(&strip_d->strips, cs_d);
183         }
184         
185         /* return the strip */
186         return strip_d;
187 }
188
189 /* Copy NLA Track */
190 NlaTrack *copy_nlatrack (NlaTrack *nlt)
191 {
192         NlaStrip *strip, *strip_d;
193         NlaTrack *nlt_d;
194         
195         /* sanity check */
196         if (nlt == NULL)
197                 return NULL;
198                 
199         /* make a copy */
200         nlt_d= MEM_dupallocN(nlt);
201         nlt_d->next= nlt_d->prev= NULL;
202         
203         /* make a copy of all the strips, one at a time */
204         nlt_d->strips.first= nlt_d->strips.last= NULL;
205         
206         for (strip= nlt->strips.first; strip; strip= strip->next) {
207                 strip_d= copy_nlastrip(strip);
208                 BLI_addtail(&nlt_d->strips, strip_d);
209         }
210         
211         /* return the copy */
212         return nlt_d;
213 }
214
215 /* Copy all NLA data */
216 void copy_nladata (ListBase *dst, ListBase *src)
217 {
218         NlaTrack *nlt, *nlt_d;
219         
220         /* sanity checks */
221         if ELEM(NULL, dst, src)
222                 return;
223                 
224         /* clear out the destination list first for precautions... */
225         dst->first= dst->last= NULL;
226                 
227         /* copy each NLA-track, one at a time */
228         for (nlt= src->first; nlt; nlt= nlt->next) {
229                 /* make a copy, and add the copy to the destination list */
230                 nlt_d= copy_nlatrack(nlt);
231                 BLI_addtail(dst, nlt_d);
232         }
233 }
234
235 /* Adding ------------------------------------------- */
236
237 /* Add a NLA Track to the given AnimData 
238  *      - prev: NLA-Track to add the new one after
239  */
240 NlaTrack *add_nlatrack (AnimData *adt, NlaTrack *prev)
241 {
242         NlaTrack *nlt;
243         
244         /* sanity checks */
245         if (adt == NULL)
246                 return NULL;
247                 
248         /* allocate new track */
249         nlt= MEM_callocN(sizeof(NlaTrack), "NlaTrack");
250         
251         /* set settings requiring the track to not be part of the stack yet */
252         nlt->flag = NLATRACK_SELECTED;
253         nlt->index= BLI_countlist(&adt->nla_tracks);
254         
255         /* add track to stack, and make it the active one */
256         if (prev)
257                 BLI_insertlinkafter(&adt->nla_tracks, prev, nlt);
258         else
259                 BLI_addtail(&adt->nla_tracks, nlt);
260         BKE_nlatrack_set_active(&adt->nla_tracks, nlt);
261         
262         /* must have unique name, but we need to seed this */
263         strcpy(nlt->name, "NlaTrack");
264         BLI_uniquename(&adt->nla_tracks, nlt, "NlaTrack", '.', offsetof(NlaTrack, name), sizeof(nlt->name));
265         
266         /* return the new track */
267         return nlt;
268 }
269
270 /* Add a NLA Strip referencing the given Action */
271 NlaStrip *add_nlastrip (bAction *act)
272 {
273         NlaStrip *strip;
274         
275         /* sanity checks */
276         if (act == NULL)
277                 return NULL;
278                 
279         /* allocate new strip */
280         strip= MEM_callocN(sizeof(NlaStrip), "NlaStrip");
281         
282         /* generic settings 
283          *      - selected flag to highlight this to the user
284          *      - auto-blends to ensure that blend in/out values are automatically 
285          *        determined by overlaps of strips
286          *      - (XXX) synchronisation of strip-length in accordance with changes to action-length
287          *        is not done though, since this should only really happens in editmode for strips now
288          *        though this decision is still subject to further review...
289          */
290         strip->flag = NLASTRIP_FLAG_SELECT|NLASTRIP_FLAG_AUTO_BLENDS;
291         
292         /* assign the action reference */
293         strip->act= act;
294         id_us_plus(&act->id);
295         
296         /* determine initial range 
297          *      - strip length cannot be 0... ever...
298          */
299         calc_action_range(strip->act, &strip->actstart, &strip->actend, 0);
300         
301         strip->start = strip->actstart;
302         strip->end = (IS_EQF(strip->actstart, strip->actend)) ?  (strip->actstart + 1.0f): (strip->actend);
303         
304         /* strip should be referenced as-is */
305         strip->scale= 1.0f;
306         strip->repeat = 1.0f;
307         
308         /* return the new strip */
309         return strip;
310 }
311
312 /* Add new NLA-strip to the top of the NLA stack - i.e. into the last track if space, or a new one otherwise */
313 NlaStrip *add_nlastrip_to_stack (AnimData *adt, bAction *act)
314 {
315         NlaStrip *strip;
316         NlaTrack *nlt;
317         
318         /* sanity checks */
319         if ELEM(NULL, adt, act)
320                 return NULL;
321         
322         /* create a new NLA strip */
323         strip= add_nlastrip(act);
324         if (strip == NULL)
325                 return NULL;
326         
327         /* firstly try adding strip to last track, but if that fails, add to a new track */
328         if (BKE_nlatrack_add_strip(adt->nla_tracks.last, strip) == 0) {
329                 /* trying to add to the last track failed (no track or no space), 
330                  * so add a new track to the stack, and add to that...
331                  */
332                 nlt= add_nlatrack(adt, NULL);
333                 BKE_nlatrack_add_strip(nlt, strip);
334         }
335         
336         /* automatically name it too */
337         BKE_nlastrip_validate_name(adt, strip);
338         
339         /* returns the strip added */
340         return strip;
341 }
342
343 /* Add a NLA Strip referencing the given speaker's sound */
344 NlaStrip *add_nla_soundstrip (Scene *scene, Speaker *speaker)
345 {
346         NlaStrip *strip = MEM_callocN(sizeof(NlaStrip), "NlaSoundStrip");
347         
348         /* if speaker has a sound, set the strip length to the length of the sound,
349          * otherwise default to length of 10 frames
350          */
351 #ifdef WITH_AUDASPACE
352         if (speaker->sound) 
353         {
354                 AUD_SoundInfo info = AUD_getInfo(speaker->sound->playback_handle);
355                 
356                 strip->end = ceil(info.length * FPS);
357         }
358         else 
359 #endif
360         {
361                 strip->end = 10.0f;
362         }
363         
364         /* general settings */
365         strip->type = NLASTRIP_TYPE_SOUND;
366         
367         strip->flag = NLASTRIP_FLAG_SELECT;
368         strip->extendmode = NLASTRIP_EXTEND_NOTHING; /* nothing to extend... */
369         
370         /* strip should be referenced as-is */
371         strip->scale= 1.0f;
372         strip->repeat = 1.0f;
373         
374         /* return this strip */
375         return strip;
376 }
377
378 /* *************************************************** */
379 /* NLA Evaluation <-> Editing Stuff */
380
381 /* Strip Mapping ------------------------------------- */
382
383 /* non clipped mapping for strip-time <-> global time (for Action-Clips)
384  *      invert = convert action-strip time to global time 
385  */
386 static float nlastrip_get_frame_actionclip (NlaStrip *strip, float cframe, short mode)
387 {
388         float actlength, scale;
389         // float repeat; // UNUSED
390         
391         /* get number of repeats */
392         if (IS_EQF(strip->repeat, 0.0f)) strip->repeat = 1.0f;
393         // repeat = strip->repeat; // UNUSED
394         
395         /* scaling */
396         if (IS_EQF(strip->scale, 0.0f)) strip->scale= 1.0f;
397         scale = (float)fabs(strip->scale); /* scale must be positive - we've got a special flag for reversing */
398         
399         /* length of referenced action */
400         actlength = strip->actend - strip->actstart;
401         if (IS_EQF(actlength, 0.0f)) actlength = 1.0f;
402         
403         /* reversed = play strip backwards */
404         if (strip->flag & NLASTRIP_FLAG_REVERSE) {
405                 // FIXME: this won't work right with Graph Editor?
406                 if (mode == NLATIME_CONVERT_MAP) {
407                         return strip->end - scale*(cframe - strip->actstart);
408                 }
409                 else if (mode == NLATIME_CONVERT_UNMAP) {
410                         return (strip->end + (strip->actstart * scale - cframe)) / scale;
411                 }
412                 else /* if (mode == NLATIME_CONVERT_EVAL) */{
413                         if (IS_EQF(cframe, strip->end) && IS_EQF(strip->repeat, ((int)strip->repeat))) {
414                                 /* this case prevents the motion snapping back to the first frame at the end of the strip 
415                                  * by catching the case where repeats is a whole number, which means that the end of the strip
416                                  * could also be interpreted as the end of the start of a repeat
417                                  */
418                                 return strip->actstart;
419                         }
420                         else {
421                                 /* - the 'fmod(..., actlength*scale)' is needed to get the repeats working
422                                  * - the '/ scale' is needed to ensure that scaling influences the timing within the repeat
423                                  */
424                                 return strip->actend - fmodf(cframe - strip->start, actlength*scale) / scale;
425                         }
426                 }
427         }
428         else {
429                 if (mode == NLATIME_CONVERT_MAP) {
430                         return strip->start + scale*(cframe - strip->actstart);
431                 }
432                 else if (mode == NLATIME_CONVERT_UNMAP) {
433                         return strip->actstart + (cframe - strip->start) / scale;
434                 }
435                 else /* if (mode == NLATIME_CONVERT_EVAL) */{
436                         if (IS_EQF(cframe, strip->end) && IS_EQF(strip->repeat, ((int)strip->repeat))) {
437                                 /* this case prevents the motion snapping back to the first frame at the end of the strip 
438                                  * by catching the case where repeats is a whole number, which means that the end of the strip
439                                  * could also be interpreted as the end of the start of a repeat
440                                  */
441                                 return strip->actend;
442                         }
443                         else {
444                                 /* - the 'fmod(..., actlength*scale)' is needed to get the repeats working
445                                  * - the '/ scale' is needed to ensure that scaling influences the timing within the repeat
446                                  */
447                                 return strip->actstart + fmodf(cframe - strip->start, actlength*scale) / scale;
448                         }
449                 }
450         }
451 }
452
453 /* non clipped mapping for strip-time <-> global time (for Transitions)
454  *      invert = convert action-strip time to global time 
455  */
456 static float nlastrip_get_frame_transition (NlaStrip *strip, float cframe, short mode)
457 {
458         float length;
459         
460         /* length of strip */
461         length= strip->end - strip->start;
462         
463         /* reversed = play strip backwards */
464         if (strip->flag & NLASTRIP_FLAG_REVERSE) {
465                 if (mode == NLATIME_CONVERT_MAP)
466                         return strip->end - (length * cframe);
467                 else
468                         return (strip->end - cframe) / length;
469         }
470         else {
471                 if (mode == NLATIME_CONVERT_MAP)
472                         return (length * cframe) + strip->start;
473                 else
474                         return (cframe - strip->start) / length;
475         }
476 }
477
478 /* non clipped mapping for strip-time <-> global time
479  *      mode = eNlaTime_ConvertModes[] -> NLATIME_CONVERT_*
480  *
481  * only secure for 'internal' (i.e. within AnimSys evaluation) operations,
482  * but should not be directly relied on for stuff which interacts with editors
483  */
484 float nlastrip_get_frame (NlaStrip *strip, float cframe, short mode)
485 {
486         switch (strip->type) {
487                 case NLASTRIP_TYPE_META: /* meta - for now, does the same as transition (is really just an empty container) */
488                 case NLASTRIP_TYPE_TRANSITION: /* transition */
489                         return nlastrip_get_frame_transition(strip, cframe, mode);
490                 
491                 case NLASTRIP_TYPE_CLIP: /* action-clip (default) */
492                 default:
493                         return nlastrip_get_frame_actionclip(strip, cframe, mode);
494         }       
495 }
496
497
498 /* Non clipped mapping for strip-time <-> global time
499  *      mode = eNlaTime_ConvertModesp[] -> NLATIME_CONVERT_*
500  *
501  * Public API method - perform this mapping using the given AnimData block
502  * and perform any necessary sanity checks on the value
503  */
504 float BKE_nla_tweakedit_remap (AnimData *adt, float cframe, short mode)
505 {
506         NlaStrip *strip;
507         
508         /* sanity checks 
509          *      - obviously we've got to have some starting data
510          *      - when not in tweakmode, the active Action does not have any scaling applied :)
511          *      - when in tweakmode, if the no-mapping flag is set, do not map
512          */
513         if ((adt == NULL) || (adt->flag & ADT_NLA_EDIT_ON)==0 || (adt->flag & ADT_NLA_EDIT_NOMAP))
514                 return cframe;
515                 
516         /* if the active-strip info has been stored already, access this, otherwise look this up
517          * and store for (very probable) future usage
518          */
519         if (adt->actstrip == NULL) {
520                 NlaTrack *nlt= BKE_nlatrack_find_active(&adt->nla_tracks);
521                 adt->actstrip= BKE_nlastrip_find_active(nlt);
522         }
523         strip= adt->actstrip;
524         
525         /* sanity checks 
526          *      - in rare cases, we may not be able to find this strip for some reason (internal error)
527          *      - for now, if the user has defined a curve to control the time, this correction cannot be performed
528          *        reliably...
529          */
530         if ((strip == NULL) || (strip->flag & NLASTRIP_FLAG_USR_TIME))
531                 return cframe;
532                 
533         /* perform the correction now... */
534         return nlastrip_get_frame(strip, cframe, mode);
535 }
536
537 /* *************************************************** */
538 /* NLA API */
539
540 /* List of Strips ------------------------------------ */
541 /* (these functions are used for NLA-Tracks and also for nested/meta-strips) */
542
543 /* Check if there is any space in the given list to add the given strip */
544 short BKE_nlastrips_has_space (ListBase *strips, float start, float end)
545 {
546         NlaStrip *strip;
547         
548         /* sanity checks */
549         if ((strips == NULL) || IS_EQF(start, end))
550                 return 0;
551         if (start > end) {
552                 puts("BKE_nlastrips_has_space() error... start and end arguments swapped");
553                 SWAP(float, start, end);
554         }
555         
556         /* loop over NLA strips checking for any overlaps with this area... */
557         for (strip= strips->first; strip; strip= strip->next) {
558                 /* if start frame of strip is past the target end-frame, that means that
559                  * we've gone past the window we need to check for, so things are fine
560                  */
561                 if (strip->start >= end)
562                         return 1;
563                 
564                 /* if the end of the strip is greater than either of the boundaries, the range
565                  * must fall within the extents of the strip
566                  */
567                 if ((strip->end > start) || (strip->end > end))
568                         return 0;
569         }
570         
571         /* if we are still here, we haven't encountered any overlapping strips */
572         return 1;
573 }
574
575 /* Rearrange the strips in the track so that they are always in order 
576  * (usually only needed after a strip has been moved) 
577  */
578 void BKE_nlastrips_sort_strips (ListBase *strips)
579 {
580         ListBase tmp = {NULL, NULL};
581         NlaStrip *strip, *sstrip, *stripn;
582         
583         /* sanity checks */
584         if ELEM(NULL, strips, strips->first)
585                 return;
586         
587         /* we simply perform insertion sort on this list, since it is assumed that per track,
588          * there are only likely to be at most 5-10 strips
589          */
590         for (strip= strips->first; strip; strip= stripn) {
591                 short not_added = 1;
592                 
593                 stripn= strip->next;
594                 
595                 /* remove this strip from the list, and add it to the new list, searching from the end of 
596                  * the list, assuming that the lists are in order 
597                  */
598                 BLI_remlink(strips, strip);
599                 
600                 for (sstrip= tmp.last; sstrip; sstrip= sstrip->prev) {
601                         /* check if add after */
602                         if (sstrip->end <= strip->start) {
603                                 BLI_insertlinkafter(&tmp, sstrip, strip);
604                                 not_added= 0;
605                                 break;
606                         }
607                 }
608                 
609                 /* add before first? */
610                 if (not_added)
611                         BLI_addhead(&tmp, strip);
612         }
613         
614         /* reassign the start and end points of the strips */
615         strips->first= tmp.first;
616         strips->last= tmp.last;
617 }
618
619 /* Add the given NLA-Strip to the given list of strips, assuming that it 
620  * isn't currently a member of another list
621  */
622 short BKE_nlastrips_add_strip (ListBase *strips, NlaStrip *strip)
623 {
624         NlaStrip *ns;
625         short not_added = 1;
626         
627         /* sanity checks */
628         if ELEM(NULL, strips, strip)
629                 return 0;
630                 
631         /* check if any space to add */
632         if (BKE_nlastrips_has_space(strips, strip->start, strip->end)==0)
633                 return 0;
634         
635         /* find the right place to add the strip to the nominated track */
636         for (ns= strips->first; ns; ns= ns->next) {
637                 /* if current strip occurs after the new strip, add it before */
638                 if (ns->start >= strip->end) {
639                         BLI_insertlinkbefore(strips, ns, strip);
640                         not_added= 0;
641                         break;
642                 }
643         }
644         if (not_added) {
645                 /* just add to the end of the list of the strips then... */
646                 BLI_addtail(strips, strip);
647         }
648         
649         /* added... */
650         return 1;
651 }
652
653
654 /* Meta-Strips ------------------------------------ */
655
656 /* Convert 'islands' (i.e. continuous string of) selected strips to be
657  * contained within 'Meta-Strips' which act as strips which contain strips.
658  *      temp: are the meta-strips to be created 'temporary' ones used for transforms?
659  */
660 void BKE_nlastrips_make_metas (ListBase *strips, short temp)
661 {
662         NlaStrip *mstrip = NULL;
663         NlaStrip *strip, *stripn;
664         
665         /* sanity checks */
666         if ELEM(NULL, strips, strips->first)
667                 return;
668         
669         /* group all continuous chains of selected strips into meta-strips */
670         for (strip= strips->first; strip; strip= stripn) {
671                 stripn= strip->next;
672                 
673                 if (strip->flag & NLASTRIP_FLAG_SELECT) {
674                         /* if there is an existing meta-strip, add this strip to it, otherwise, create a new one */
675                         if (mstrip == NULL) {
676                                 /* add a new meta-strip, and add it before the current strip that it will replace... */
677                                 mstrip= MEM_callocN(sizeof(NlaStrip), "Meta-NlaStrip");
678                                 mstrip->type = NLASTRIP_TYPE_META;
679                                 BLI_insertlinkbefore(strips, strip, mstrip);
680                                 
681                                 /* set flags */
682                                 mstrip->flag = NLASTRIP_FLAG_SELECT;
683                                 
684                                 /* set temp flag if appropriate (i.e. for transform-type editing) */
685                                 if (temp)
686                                         mstrip->flag |= NLASTRIP_FLAG_TEMP_META;
687                                         
688                                 /* set default repeat/scale values to prevent warnings */
689                                 mstrip->repeat= mstrip->scale= 1.0f;
690                                 
691                                 /* make its start frame be set to the start frame of the current strip */
692                                 mstrip->start= strip->start;
693                         }
694                         
695                         /* remove the selected strips from the track, and add to the meta */
696                         BLI_remlink(strips, strip);
697                         BLI_addtail(&mstrip->strips, strip);
698                         
699                         /* expand the meta's dimensions to include the newly added strip- i.e. its last frame */
700                         mstrip->end= strip->end;
701                 }
702                 else {
703                         /* current strip wasn't selected, so the end of 'island' of selected strips has been reached,
704                          * so stop adding strips to the current meta
705                          */
706                         mstrip= NULL;
707                 }
708         }
709 }
710
711 /* Split a meta-strip into a set of normal strips */
712 void BKE_nlastrips_clear_metastrip (ListBase *strips, NlaStrip *strip)
713 {
714         NlaStrip *cs, *csn;
715         
716         /* sanity check */
717         if ELEM(NULL, strips, strip)
718                 return;
719         
720         /* move each one of the meta-strip's children before the meta-strip
721          * in the list of strips after unlinking them from the meta-strip
722          */
723         for (cs= strip->strips.first; cs; cs= csn) {
724                 csn= cs->next;
725                 BLI_remlink(&strip->strips, cs);
726                 BLI_insertlinkbefore(strips, strip, cs);
727         }
728         
729         /* free the meta-strip now */
730         free_nlastrip(strips, strip);
731 }
732
733 /* Remove meta-strips (i.e. flatten the list of strips) from the top-level of the list of strips
734  *      sel: only consider selected meta-strips, otherwise all meta-strips are removed
735  *      onlyTemp: only remove the 'temporary' meta-strips used for transforms
736  */
737 void BKE_nlastrips_clear_metas (ListBase *strips, short onlySel, short onlyTemp)
738 {
739         NlaStrip *strip, *stripn;
740         
741         /* sanity checks */
742         if ELEM(NULL, strips, strips->first)
743                 return;
744         
745         /* remove meta-strips fitting the criteria of the arguments */
746         for (strip= strips->first; strip; strip= stripn) {
747                 stripn= strip->next;
748                 
749                 /* check if strip is a meta-strip */
750                 if (strip->type == NLASTRIP_TYPE_META) {
751                         /* if check if selection and 'temporary-only' considerations are met */
752                         if ((onlySel==0) || (strip->flag & NLASTRIP_FLAG_SELECT)) {
753                                 if ((!onlyTemp) || (strip->flag & NLASTRIP_FLAG_TEMP_META)) {
754                                         BKE_nlastrips_clear_metastrip(strips, strip);
755                                 }
756                         }
757                 }
758         }
759 }
760
761 /* Add the given NLA-Strip to the given Meta-Strip, assuming that the
762  * strip isn't attached to anyy list of strips 
763  */
764 short BKE_nlameta_add_strip (NlaStrip *mstrip, NlaStrip *strip)
765 {
766         /* sanity checks */
767         if ELEM(NULL, mstrip, strip)
768                 return 0;
769                 
770         /* firstly, check if the meta-strip has space for this */
771         if (BKE_nlastrips_has_space(&mstrip->strips, strip->start, strip->end) == 0)
772                 return 0;
773                 
774         /* check if this would need to be added to the ends of the meta,
775          * and subsequently, if the neighbouring strips allow us enough room
776          */
777         if (strip->start < mstrip->start) {
778                 /* check if strip to the left (if it exists) ends before the 
779                  * start of the strip we're trying to add 
780                  */
781                 if ((mstrip->prev == NULL) || (mstrip->prev->end <= strip->start)) {
782                         /* add strip to start of meta's list, and expand dimensions */
783                         BLI_addhead(&mstrip->strips, strip);
784                         mstrip->start= strip->start;
785                         
786                         return 1;
787                 }
788                 else /* failed... no room before */
789                         return 0;
790         }
791         else if (strip->end > mstrip->end) {
792                 /* check if strip to the right (if it exists) starts before the 
793                  * end of the strip we're trying to add 
794                  */
795                 if ((mstrip->next == NULL) || (mstrip->next->start >= strip->end)) {
796                         /* add strip to end of meta's list, and expand dimensions */
797                         BLI_addtail(&mstrip->strips, strip);
798                         mstrip->end= strip->end;
799                         
800                         return 1;
801                 }
802                 else /* failed... no room after */
803                         return 0;
804         }
805         else {
806                 /* just try to add to the meta-strip (no dimension changes needed) */
807                 return BKE_nlastrips_add_strip(&mstrip->strips, strip);
808         }
809 }
810
811 /* Adjust the settings of NLA-Strips contained within a Meta-Strip (recursively), 
812  * until the Meta-Strips children all fit within the Meta-Strip's new dimensions
813  */
814 void BKE_nlameta_flush_transforms (NlaStrip *mstrip) 
815 {
816         NlaStrip *strip;
817         float oStart, oEnd, offset;
818         float oLen, nLen;
819         short scaleChanged= 0;
820         
821         /* sanity checks 
822          *      - strip must exist
823          *      - strip must be a meta-strip with some contents
824          */
825         if ELEM(NULL, mstrip, mstrip->strips.first)
826                 return;
827         if (mstrip->type != NLASTRIP_TYPE_META)
828                 return;
829                 
830         /* get the original start/end points, and calculate the start-frame offset
831          *      - these are simply the start/end frames of the child strips, 
832          *        since we assume they weren't transformed yet
833          */
834         oStart= ((NlaStrip *)mstrip->strips.first)->start;
835         oEnd= ((NlaStrip *)mstrip->strips.last)->end;
836         offset= mstrip->start - oStart;
837         
838         /* optimisation:
839          * don't flush if nothing changed yet
840          *      TODO: maybe we need a flag to say always flush?
841          */
842         if (IS_EQF(oStart, mstrip->start) && IS_EQF(oEnd, mstrip->end))
843                 return;
844         
845         /* check if scale changed */
846         oLen = oEnd - oStart;
847         nLen = mstrip->end - mstrip->start;
848         if (IS_EQF(nLen, oLen) == 0)
849                 scaleChanged= 1;
850         
851         /* for each child-strip, calculate new start/end points based on this new info */
852         for (strip= mstrip->strips.first; strip; strip= strip->next) {
853                 if (scaleChanged) {
854                         PointerRNA ptr;
855                         float p1, p2, nStart, nEnd;
856                         
857                         /* compute positions of endpoints relative to old extents of strip */
858                         p1= (strip->start - oStart) / oLen;
859                         p2= (strip->end - oStart) / oLen;
860                         
861                         /* compute the new strip endpoints using the proportions */
862                         nStart= (p1 * nLen) + mstrip->start;
863                         nEnd= (p2 * nLen) + mstrip->start;
864                         
865                         /* firstly, apply the new positions manually, then apply using RNA 
866                          *      - first time is to make sure no truncation errors from one endpoint not being 
867                          *        set yet occur
868                          *      - second time is to make sure scale is computed properly...
869                          */
870                         strip->start= nStart;
871                         strip->end= nEnd;
872                         
873                         RNA_pointer_create(NULL, &RNA_NlaStrip, strip, &ptr);
874                         RNA_float_set(&ptr, "frame_start", nStart);
875                         RNA_float_set(&ptr, "frame_end", nEnd);
876                 }
877                 else {
878                         /* just apply the changes in offset to both ends of the strip */
879                         strip->start += offset;
880                         strip->end += offset;
881                 }
882                 
883                 /* finally, make sure the strip's children (if it is a meta-itself), get updated */
884                 BKE_nlameta_flush_transforms(strip);
885         }
886 }
887
888 /* NLA-Tracks ---------------------------------------- */
889
890 /* Find the active NLA-track for the given stack */
891 NlaTrack *BKE_nlatrack_find_active (ListBase *tracks)
892 {
893         NlaTrack *nlt;
894         
895         /* sanity check */
896         if ELEM(NULL, tracks, tracks->first)
897                 return NULL;
898                 
899         /* try to find the first active track */
900         for (nlt= tracks->first; nlt; nlt= nlt->next) {
901                 if (nlt->flag & NLATRACK_ACTIVE)
902                         return nlt;
903         }
904         
905         /* none found */
906         return NULL;
907 }
908
909 /* Toggle the 'solo' setting for the given NLA-track, making sure that it is the only one
910  * that has this status in its AnimData block.
911  */
912 void BKE_nlatrack_solo_toggle (AnimData *adt, NlaTrack *nlt)
913 {
914         NlaTrack *nt;
915         
916         /* sanity check */
917         if ELEM(NULL, adt, adt->nla_tracks.first)
918                 return;
919                 
920         /* firstly, make sure 'solo' flag for all tracks is disabled */
921         for (nt= adt->nla_tracks.first; nt; nt= nt->next) {
922                 if (nt != nlt)
923                         nt->flag &= ~NLATRACK_SOLO;
924         }
925                 
926         /* now, enable 'solo' for the given track if appropriate */
927         if (nlt) {
928                 /* toggle solo status */
929                 nlt->flag ^= NLATRACK_SOLO;
930                 
931                 /* set or clear solo-status on AnimData */
932                 if (nlt->flag & NLATRACK_SOLO)
933                         adt->flag |= ADT_NLA_SOLO_TRACK;
934                 else
935                         adt->flag &= ~ADT_NLA_SOLO_TRACK;
936         }
937         else
938                 adt->flag &= ~ADT_NLA_SOLO_TRACK;
939 }
940
941 /* Make the given NLA-track the active one for the given stack. If no track is provided, 
942  * this function can be used to simply deactivate all the NLA tracks in the given stack too.
943  */
944 void BKE_nlatrack_set_active (ListBase *tracks, NlaTrack *nlt_a)
945 {
946         NlaTrack *nlt;
947         
948         /* sanity check */
949         if ELEM(NULL, tracks, tracks->first)
950                 return;
951         
952         /* deactive all the rest */
953         for (nlt= tracks->first; nlt; nlt= nlt->next) 
954                 nlt->flag &= ~NLATRACK_ACTIVE;
955                 
956         /* set the given one as the active one */
957         if (nlt_a)
958                 nlt_a->flag |= NLATRACK_ACTIVE;
959 }
960
961 /* Check if there is any space in the given track to add a strip of the given length */
962 short BKE_nlatrack_has_space (NlaTrack *nlt, float start, float end)
963 {
964         /* sanity checks 
965          *      - track must exist
966          *      - track must be editable
967          *      - bounds cannot be equal (0-length is nasty) 
968          */
969         if ((nlt == NULL) || (nlt->flag & NLATRACK_PROTECTED) || IS_EQF(start, end))
970                 return 0;
971         
972         if (start > end) {
973                 puts("BKE_nlatrack_has_space() error... start and end arguments swapped");
974                 SWAP(float, start, end);
975         }
976         
977         /* check if there's any space left in the track for a strip of the given length */
978         return BKE_nlastrips_has_space(&nlt->strips, start, end);
979 }
980
981 /* Rearrange the strips in the track so that they are always in order 
982  * (usually only needed after a strip has been moved) 
983  */
984 void BKE_nlatrack_sort_strips (NlaTrack *nlt)
985 {
986         /* sanity checks */
987         if ELEM(NULL, nlt, nlt->strips.first)
988                 return;
989         
990         /* sort the strips with a more generic function */
991         BKE_nlastrips_sort_strips(&nlt->strips);
992 }
993
994 /* Add the given NLA-Strip to the given NLA-Track, assuming that it 
995  * isn't currently attached to another one 
996  */
997 short BKE_nlatrack_add_strip (NlaTrack *nlt, NlaStrip *strip)
998 {
999         /* sanity checks */
1000         if ELEM(NULL, nlt, strip)
1001                 return 0;
1002                 
1003         /* try to add the strip to the track using a more generic function */
1004         return BKE_nlastrips_add_strip(&nlt->strips, strip);
1005 }
1006
1007 /* Get the extents of the given NLA-Track including gaps between strips,
1008  * returning whether this succeeded or not
1009  */
1010 short BKE_nlatrack_get_bounds (NlaTrack *nlt, float bounds[2])
1011 {
1012         NlaStrip *strip;
1013         
1014         /* initialise bounds */
1015         if (bounds)
1016                 bounds[0] = bounds[1] = 0.0f;
1017         else
1018                 return 0;
1019         
1020         /* sanity checks */
1021         if ELEM(NULL, nlt, nlt->strips.first)
1022                 return 0;
1023                 
1024         /* lower bound is first strip's start frame */
1025         strip = nlt->strips.first;
1026         bounds[0] = strip->start;
1027         
1028         /* upper bound is last strip's end frame */
1029         strip = nlt->strips.last;
1030         bounds[1] = strip->end;
1031         
1032         /* done */
1033         return 1;
1034 }
1035
1036 /* NLA Strips -------------------------------------- */
1037
1038 /* Find the active NLA-strip within the given track */
1039 NlaStrip *BKE_nlastrip_find_active (NlaTrack *nlt)
1040 {
1041         NlaStrip *strip;
1042         
1043         /* sanity check */
1044         if ELEM(NULL, nlt, nlt->strips.first)
1045                 return NULL;
1046                 
1047         /* try to find the first active strip */
1048         for (strip= nlt->strips.first; strip; strip= strip->next) {
1049                 if (strip->flag & NLASTRIP_FLAG_ACTIVE)
1050                         return strip;
1051         }
1052         
1053         /* none found */
1054         return NULL;
1055 }
1056
1057 /* Make the given NLA-Strip the active one within the given block */
1058 void BKE_nlastrip_set_active (AnimData *adt, NlaStrip *strip)
1059 {
1060         NlaTrack *nlt;
1061         NlaStrip *nls;
1062         
1063         /* sanity checks */
1064         if (adt == NULL)
1065                 return;
1066         
1067         /* loop over tracks, deactivating*/
1068         for (nlt= adt->nla_tracks.first; nlt; nlt= nlt->next) {
1069                 for (nls= nlt->strips.first; nls; nls= nls->next)  {
1070                         if (nls != strip)
1071                                 nls->flag &= ~NLASTRIP_FLAG_ACTIVE;
1072                         else
1073                                 nls->flag |= NLASTRIP_FLAG_ACTIVE;
1074                 }
1075         }
1076 }
1077
1078
1079 /* Does the given NLA-strip fall within the given bounds (times)? */
1080 short BKE_nlastrip_within_bounds (NlaStrip *strip, float min, float max)
1081 {
1082         const float stripLen= (strip) ? strip->end - strip->start : 0.0f;
1083         const float boundsLen= (float)fabs(max - min);
1084         
1085         /* sanity checks */
1086         if ((strip == NULL) || IS_EQF(stripLen, 0.0f) || IS_EQF(boundsLen, 0.0f))
1087                 return 0;
1088         
1089         /* only ok if at least part of the strip is within the bounding window
1090          *      - first 2 cases cover when the strip length is less than the bounding area
1091          *      - second 2 cases cover when the strip length is greater than the bounding area
1092          */
1093         if ( (stripLen < boundsLen) && 
1094                  !(IN_RANGE(strip->start, min, max) ||
1095                    IN_RANGE(strip->end, min, max)) )
1096         {
1097                 return 0;
1098         }
1099         if ( (stripLen > boundsLen) && 
1100                  !(IN_RANGE(min, strip->start, strip->end) ||
1101                    IN_RANGE(max, strip->start, strip->end)) )
1102         {
1103                 return 0;
1104         }
1105         
1106         /* should be ok! */
1107         return 1;
1108 }
1109
1110 /* Recalculate the start and end frames for the current strip, after changing
1111  * the extents of the action or the mapping (repeats or scale factor) info
1112  */
1113 void BKE_nlastrip_recalculate_bounds (NlaStrip *strip)
1114 {
1115         float actlen, mapping;
1116         
1117         /* sanity checks
1118          *      - must have a strip
1119          *      - can only be done for action clips
1120          */
1121         if ((strip == NULL) || (strip->type != NLASTRIP_TYPE_CLIP))
1122                 return;
1123                 
1124         /* calculate new length factors */
1125         actlen= strip->actend - strip->actstart;
1126         if (IS_EQF(actlen, 0.0f)) actlen= 1.0f;
1127         
1128         mapping= strip->scale * strip->repeat;
1129         
1130         /* adjust endpoint of strip in response to this */
1131         if (IS_EQF(mapping, 0.0f) == 0)
1132                 strip->end = (actlen * mapping) + strip->start;
1133 }
1134
1135 /* Is the given NLA-strip the first one to occur for the given AnimData block */
1136 // TODO: make this an api method if necesary, but need to add prefix first
1137 static short nlastrip_is_first (AnimData *adt, NlaStrip *strip)
1138 {
1139         NlaTrack *nlt;
1140         NlaStrip *ns;
1141         
1142         /* sanity checks */
1143         if ELEM(NULL, adt, strip)
1144                 return 0;
1145                 
1146         /* check if strip has any strips before it */
1147         if (strip->prev)
1148                 return 0;
1149                 
1150         /* check other tracks to see if they have a strip that's earlier */
1151         // TODO: or should we check that the strip's track is also the first?
1152         for (nlt= adt->nla_tracks.first; nlt; nlt= nlt->next) {
1153                 /* only check the first strip, assuming that they're all in order */
1154                 ns= nlt->strips.first;
1155                 if (ns) {
1156                         if (ns->start < strip->start)
1157                                 return 0;
1158                 }
1159         }       
1160         
1161         /* should be first now */
1162         return 1;
1163 }
1164
1165 /* Animated Strips ------------------------------------------- */
1166
1167 /* Check if the given NLA-Track has any strips with own F-Curves */
1168 short BKE_nlatrack_has_animated_strips (NlaTrack *nlt)
1169 {
1170         NlaStrip *strip;
1171         
1172         /* sanity checks */
1173         if ELEM(NULL, nlt, nlt->strips.first)
1174                 return 0;
1175                 
1176         /* check each strip for F-Curves only (don't care about whether the flags are set) */
1177         for (strip= nlt->strips.first; strip; strip= strip->next) {
1178                 if (strip->fcurves.first)
1179                         return 1;
1180         }
1181         
1182         /* none found */
1183         return 0;
1184 }
1185
1186 /* Check if given NLA-Tracks have any strips with own F-Curves */
1187 short BKE_nlatracks_have_animated_strips (ListBase *tracks)
1188 {
1189         NlaTrack *nlt;
1190         
1191         /* sanity checks */
1192         if ELEM(NULL, tracks, tracks->first)
1193                 return 0;
1194                 
1195         /* check each track, stopping on the first hit */
1196         for (nlt= tracks->first; nlt; nlt= nlt->next) {
1197                 if (BKE_nlatrack_has_animated_strips(nlt))
1198                         return 1;
1199         }
1200         
1201         /* none found */
1202         return 0;
1203 }
1204
1205 /* Validate the NLA-Strips 'control' F-Curves based on the flags set*/
1206 void BKE_nlastrip_validate_fcurves (NlaStrip *strip) 
1207 {
1208         FCurve *fcu;
1209         
1210         /* sanity checks */
1211         if (strip == NULL)
1212                 return;
1213         
1214         /* if controlling influence... */
1215         if (strip->flag & NLASTRIP_FLAG_USR_INFLUENCE) {
1216                 /* try to get F-Curve */
1217                 fcu= list_find_fcurve(&strip->fcurves, "influence", 0);
1218                 
1219                 /* add one if not found */
1220                 if (fcu == NULL) {
1221                         /* make new F-Curve */
1222                         fcu= MEM_callocN(sizeof(FCurve), "NlaStrip FCurve");
1223                         BLI_addtail(&strip->fcurves, fcu);
1224                         
1225                         /* set default flags */
1226                         fcu->flag = (FCURVE_VISIBLE|FCURVE_SELECTED);
1227                         
1228                         /* store path - make copy, and store that */
1229                         fcu->rna_path= BLI_strdupn("influence", 9);
1230                         
1231                         // TODO: insert a few keyframes to ensure default behaviour?
1232                 }
1233         }
1234         
1235         /* if controlling time... */
1236         if (strip->flag & NLASTRIP_FLAG_USR_TIME) {
1237                 /* try to get F-Curve */
1238                 fcu= list_find_fcurve(&strip->fcurves, "strip_time", 0);
1239                 
1240                 /* add one if not found */
1241                 if (fcu == NULL) {
1242                         /* make new F-Curve */
1243                         fcu= MEM_callocN(sizeof(FCurve), "NlaStrip FCurve");
1244                         BLI_addtail(&strip->fcurves, fcu);
1245                         
1246                         /* set default flags */
1247                         fcu->flag = (FCURVE_VISIBLE|FCURVE_SELECTED);
1248                         
1249                         /* store path - make copy, and store that */
1250                         fcu->rna_path= BLI_strdupn("strip_time", 10);
1251                         
1252                         // TODO: insert a few keyframes to ensure default behaviour?
1253                 }
1254         }
1255 }
1256
1257 /* Sanity Validation ------------------------------------ */
1258
1259 static int nla_editbone_name_check(void *arg, const char *name)
1260 {
1261         return BLI_ghash_haskey((GHash *)arg, (void *)name);
1262 }
1263
1264 /* Find (and set) a unique name for a strip from the whole AnimData block 
1265  * Uses a similar method to the BLI method, but is implemented differently
1266  * as we need to ensure that the name is unique over several lists of tracks,
1267  * not just a single track.
1268  */
1269 void BKE_nlastrip_validate_name (AnimData *adt, NlaStrip *strip)
1270 {
1271         GHash *gh;
1272         NlaStrip *tstrip;
1273         NlaTrack *nlt;
1274         
1275         /* sanity checks */
1276         if ELEM(NULL, adt, strip)
1277                 return;
1278                 
1279         /* give strip a default name if none already */
1280         if (strip->name[0]==0) {
1281                 switch (strip->type) {
1282                         case NLASTRIP_TYPE_CLIP: /* act-clip */
1283                                 sprintf(strip->name, "%s", (strip->act)?(strip->act->id.name+2):("<No Action>"));
1284                                 break;
1285                         case NLASTRIP_TYPE_TRANSITION: /* transition */
1286                                 sprintf(strip->name, "Transition");
1287                                 break;
1288                         case NLASTRIP_TYPE_META: /* meta */
1289                                 sprintf(strip->name, "Meta");
1290                                 break;
1291                         default:
1292                                 sprintf(strip->name, "NLA Strip");
1293                                 break;
1294                 }
1295         }
1296         
1297         /* build a hash-table of all the strips in the tracks 
1298          *      - this is easier than iterating over all the tracks+strips hierarchy everytime
1299          *        (and probably faster)
1300          */
1301         gh= BLI_ghash_new(BLI_ghashutil_strhash, BLI_ghashutil_strcmp, "nlastrip_validate_name gh");
1302         
1303         for (nlt= adt->nla_tracks.first; nlt; nlt= nlt->next) {
1304                 for (tstrip= nlt->strips.first; tstrip; tstrip= tstrip->next) {
1305                         /* don't add the strip of interest */
1306                         if (tstrip == strip) 
1307                                 continue;
1308                         
1309                         /* use the name of the strip as the key, and the strip as the value, since we're mostly interested in the keys */
1310                         BLI_ghash_insert(gh, tstrip->name, tstrip);
1311                 }
1312         }
1313         
1314         /* if the hash-table has a match for this name, try other names... 
1315          *      - in an extreme case, it might not be able to find a name, but then everything else in Blender would fail too :)
1316          */
1317         BLI_uniquename_cb(nla_editbone_name_check, (void *)gh, "NlaStrip", '.', strip->name, sizeof(strip->name));
1318
1319         /* free the hash... */
1320         BLI_ghash_free(gh, NULL, NULL);
1321 }
1322
1323 /* ---- */
1324
1325 /* Get strips which overlap the given one at the start/end of its range 
1326  *      - strip: strip that we're finding overlaps for
1327  *      - track: nla-track that the overlapping strips should be found from
1328  *      - start, end: frames for the offending endpoints
1329  */
1330 static void nlastrip_get_endpoint_overlaps (NlaStrip *strip, NlaTrack *track, float **start, float **end)
1331 {
1332         NlaStrip *nls;
1333         
1334         /* find strips that overlap over the start/end of the given strip,
1335          * but which don't cover the entire length 
1336          */
1337         // TODO: this scheme could get quite slow for doing this on many strips...
1338         for (nls= track->strips.first; nls; nls= nls->next) {
1339                 /* check if strip overlaps (extends over or exactly on) the entire range of the strip we're validating */
1340                 if ((nls->start <= strip->start) && (nls->end >= strip->end)) {
1341                         *start= NULL;
1342                         *end= NULL;
1343                         return;
1344                 }
1345                 
1346                 /* check if strip doesn't even occur anywhere near... */
1347                 if (nls->end < strip->start)
1348                         continue; /* skip checking this strip... not worthy of mention */
1349                 if (nls->start > strip->end)
1350                         return; /* the range we're after has already passed */
1351                         
1352                 /* if this strip is not part of an island of continuous strips, it can be used
1353                  *      - this check needs to be done for each end of the strip we try and use...
1354                  */
1355                 if ((nls->next == NULL) || IS_EQF(nls->next->start, nls->end)==0) {
1356                         if ((nls->end > strip->start) && (nls->end < strip->end))
1357                                 *start= &nls->end;
1358                 }
1359                 if ((nls->prev == NULL) || IS_EQF(nls->prev->end, nls->start)==0) {
1360                         if ((nls->start < strip->end) && (nls->start > strip->start))
1361                                 *end= &nls->start;
1362                 }
1363         }
1364 }
1365
1366 /* Determine auto-blending for the given strip */
1367 static void BKE_nlastrip_validate_autoblends (NlaTrack *nlt, NlaStrip *nls)
1368 {
1369         float *ps=NULL, *pe=NULL;
1370         float *ns=NULL, *ne=NULL;
1371         
1372         /* sanity checks */
1373         if ELEM(NULL, nls, nlt)
1374                 return;
1375         if ((nlt->prev == NULL) && (nlt->next == NULL))
1376                 return;
1377         if ((nls->flag & NLASTRIP_FLAG_AUTO_BLENDS)==0)
1378                 return;
1379         
1380         /* get test ranges */
1381         if (nlt->prev)
1382                 nlastrip_get_endpoint_overlaps(nls, nlt->prev, &ps, &pe);
1383         if (nlt->next)
1384                 nlastrip_get_endpoint_overlaps(nls, nlt->next, &ns, &ne);
1385                 
1386         /* set overlaps for this strip 
1387          *      - don't use the values obtained though if the end in question 
1388          *        is directly followed/preceeded by another strip, forming an 
1389          *        'island' of continuous strips
1390          */
1391         if ( (ps || ns) && ((nls->prev == NULL) || IS_EQF(nls->prev->end, nls->start)==0) )
1392         {
1393                 /* start overlaps - pick the largest overlap */
1394                 if ( ((ps && ns) && (*ps > *ns)) || (ps) )
1395                         nls->blendin= *ps - nls->start;
1396                 else
1397                         nls->blendin= *ns - nls->start;
1398         }
1399         else /* no overlap allowed/needed */
1400                 nls->blendin= 0.0f;
1401                 
1402         if ( (pe || ne) && ((nls->next == NULL) || IS_EQF(nls->next->start, nls->end)==0) )
1403         {
1404                 /* end overlaps - pick the largest overlap */
1405                 if ( ((pe && ne) && (*pe > *ne)) || (pe) )
1406                         nls->blendout= nls->end - *pe;
1407                 else
1408                         nls->blendout= nls->end - *ne;
1409         }
1410         else /* no overlap allowed/needed */
1411                 nls->blendout= 0.0f;
1412 }
1413
1414 /* Ensure that auto-blending and other settings are set correctly */
1415 void BKE_nla_validate_state (AnimData *adt)
1416 {
1417         NlaStrip *strip, *fstrip=NULL;
1418         NlaTrack *nlt;
1419         
1420         /* sanity checks */
1421         if ELEM(NULL, adt, adt->nla_tracks.first)
1422                 return;
1423                 
1424         /* adjust blending values for auto-blending, and also do an initial pass to find the earliest strip */
1425         for (nlt= adt->nla_tracks.first; nlt; nlt= nlt->next) {
1426                 for (strip= nlt->strips.first; strip; strip= strip->next) {
1427                         /* auto-blending first */
1428                         BKE_nlastrip_validate_autoblends(nlt, strip);
1429                         
1430                         /* extend mode - find first strip */
1431                         if ((fstrip == NULL) || (strip->start < fstrip->start))
1432                                 fstrip= strip;
1433                 }
1434         }
1435         
1436         /* second pass over the strips to adjust the extend-mode to fix any problems */
1437         for (nlt= adt->nla_tracks.first; nlt; nlt= nlt->next) {
1438                 for (strip= nlt->strips.first; strip; strip= strip->next) {
1439                         /* apart from 'nothing' option which user has to explicitly choose, we don't really know if 
1440                          * we should be overwriting the extend setting (but assume that's what the user wanted)
1441                          */
1442                         // TODO: 1 solution is to tie this in with auto-blending...
1443                         if (strip->extendmode != NLASTRIP_EXTEND_NOTHING) {
1444                                 if (strip == fstrip)
1445                                         strip->extendmode= NLASTRIP_EXTEND_HOLD;
1446                                 else
1447                                         strip->extendmode= NLASTRIP_EXTEND_HOLD_FORWARD;
1448                         }
1449                 }
1450         }
1451 }
1452
1453 /* Core Tools ------------------------------------------- */
1454
1455 /* For the given AnimData block, add the active action to the NLA
1456  * stack (i.e. 'push-down' action). The UI should only allow this 
1457  * for normal editing only (i.e. not in editmode for some strip's action),
1458  * so no checks for this are performed.
1459  */
1460 // TODO: maybe we should have checks for this too...
1461 void BKE_nla_action_pushdown (AnimData *adt)
1462 {
1463         NlaStrip *strip;
1464         
1465         /* sanity checks */
1466         // TODO: need to report the error for this
1467         if ELEM(NULL, adt, adt->action) 
1468                 return;
1469                 
1470         /* if the action is empty, we also shouldn't try to add to stack, 
1471          * as that will cause us grief down the track
1472          */
1473         // TODO: what about modifiers?
1474         if (action_has_motion(adt->action) == 0) {
1475                 printf("BKE_nla_action_pushdown(): action has no data \n");
1476                 return;
1477         }
1478         
1479         /* add a new NLA strip to the track, which references the active action */
1480         strip= add_nlastrip_to_stack(adt, adt->action);
1481         
1482         /* do other necessary work on strip */  
1483         if (strip) {
1484                 /* clear reference to action now that we've pushed it onto the stack */
1485                 id_us_min(&adt->action->id);
1486                 adt->action= NULL;
1487                 
1488                 /* if the strip is the first one in the track it lives in, check if there
1489                  * are strips in any other tracks that may be before this, and set the extend
1490                  * mode accordingly
1491                  */
1492                 if (nlastrip_is_first(adt, strip) == 0) {
1493                         /* not first, so extend mode can only be NLASTRIP_EXTEND_HOLD_FORWARD not NLASTRIP_EXTEND_HOLD,
1494                          * so that it doesn't override strips in previous tracks
1495                          */
1496                         // FIXME: this needs to be more automated, since user can rearrange strips
1497                         strip->extendmode= NLASTRIP_EXTEND_HOLD_FORWARD;
1498                 }
1499                 
1500                 /* make strip the active one... */
1501                 BKE_nlastrip_set_active(adt, strip);
1502         }
1503 }
1504
1505
1506 /* Find the active strip + track combo, and set them up as the tweaking track,
1507  * and return if successful or not.
1508  */
1509 short BKE_nla_tweakmode_enter (AnimData *adt)
1510 {
1511         NlaTrack *nlt, *activeTrack=NULL;
1512         NlaStrip *strip, *activeStrip=NULL;
1513         
1514         /* verify that data is valid */
1515         if ELEM(NULL, adt, adt->nla_tracks.first)
1516                 return 0;
1517                 
1518         /* if block is already in tweakmode, just leave, but we should report 
1519          * that this block is in tweakmode (as our returncode)
1520          */
1521         if (adt->flag & ADT_NLA_EDIT_ON)
1522                 return 1;
1523                 
1524         /* go over the tracks, finding the active one, and its active strip
1525          *      - if we cannot find both, then there's nothing to do
1526          */
1527         for (nlt= adt->nla_tracks.first; nlt; nlt= nlt->next) {
1528                 /* check if active */
1529                 if (nlt->flag & NLATRACK_ACTIVE) {
1530                         /* store reference to this active track */
1531                         activeTrack= nlt;
1532                         
1533                         /* now try to find active strip */
1534                         activeStrip= BKE_nlastrip_find_active(nlt);
1535                         break;
1536                 }       
1537         }
1538         if ELEM3(NULL, activeTrack, activeStrip, activeStrip->act) {
1539                 if (G.f & G_DEBUG) {
1540                         printf("NLA tweakmode enter - neither active requirement found \n");
1541                         printf("\tactiveTrack = %p, activeStrip = %p \n", (void *)activeTrack, (void *)activeStrip);
1542                 }
1543                 return 0;
1544         }
1545                 
1546         /* go over all the tracks up to the active one, tagging each strip that uses the same 
1547          * action as the active strip, but leaving everything else alone
1548          */
1549         for (nlt= activeTrack->prev; nlt; nlt= nlt->prev) {
1550                 for (strip= nlt->strips.first; strip; strip= strip->next) {
1551                         if (strip->act == activeStrip->act)
1552                                 strip->flag |= NLASTRIP_FLAG_TWEAKUSER;
1553                         else
1554                                 strip->flag &= ~NLASTRIP_FLAG_TWEAKUSER;
1555                 }
1556         }
1557         
1558         
1559         /* go over all the tracks after AND INCLUDING the active one, tagging them as being disabled 
1560          *      - the active track needs to also be tagged, otherwise, it'll overlap with the tweaks going on
1561          */
1562         for (nlt= activeTrack; nlt; nlt= nlt->next)
1563                 nlt->flag |= NLATRACK_DISABLED;
1564         
1565         /* handle AnimData level changes:
1566          *      - 'real' active action to temp storage (no need to change user-counts)
1567          *      - action of active strip set to be the 'active action', and have its usercount incremented
1568          *      - editing-flag for this AnimData block should also get turned on (for more efficient restoring)
1569          *      - take note of the active strip for mapping-correction of keyframes in the action being edited
1570          */
1571         adt->tmpact= adt->action;
1572         adt->action= activeStrip->act;
1573         adt->actstrip= activeStrip;
1574         id_us_plus(&activeStrip->act->id);
1575         adt->flag |= ADT_NLA_EDIT_ON;
1576         
1577         /* done! */
1578         return 1;
1579 }
1580
1581 /* Exit tweakmode for this AnimData block */
1582 void BKE_nla_tweakmode_exit (AnimData *adt)
1583 {
1584         NlaStrip *strip;
1585         NlaTrack *nlt;
1586         
1587         /* verify that data is valid */
1588         if ELEM(NULL, adt, adt->nla_tracks.first)
1589                 return;
1590                 
1591         /* hopefully the flag is correct - skip if not on */
1592         if ((adt->flag & ADT_NLA_EDIT_ON) == 0)
1593                 return;
1594                 
1595         // TODO: need to sync the user-strip with the new state of the action!
1596                 
1597         /* for all Tracks, clear the 'disabled' flag
1598          * for all Strips, clear the 'tweak-user' flag
1599          */
1600         for (nlt= adt->nla_tracks.first; nlt; nlt= nlt->next) {
1601                 nlt->flag &= ~NLATRACK_DISABLED;
1602                 
1603                 for (strip= nlt->strips.first; strip; strip= strip->next) 
1604                         strip->flag &= ~NLASTRIP_FLAG_TWEAKUSER;
1605         }
1606         
1607         /* handle AnimData level changes:
1608          *      - 'temporary' active action needs its usercount decreased, since we're removing this reference
1609          *      - 'real' active action is restored from storage
1610          *      - storage pointer gets cleared (to avoid having bad notes hanging around)
1611          *      - editing-flag for this AnimData block should also get turned off
1612          *      - clear pointer to active strip
1613          */
1614         if (adt->action) adt->action->id.us--;
1615         adt->action= adt->tmpact;
1616         adt->tmpact= NULL;
1617         adt->actstrip= NULL;
1618         adt->flag &= ~ADT_NLA_EDIT_ON;
1619 }
1620
1621 /* Baking Tools ------------------------------------------- */
1622
1623 static void UNUSED_FUNCTION(BKE_nla_bake) (Scene *scene, ID *UNUSED(id), AnimData *adt, int UNUSED(flag))
1624 {
1625
1626         /* verify that data is valid 
1627          *      1) Scene and AnimData must be provided 
1628          *      2) there must be tracks to merge...
1629          */
1630         if ELEM3(NULL, scene, adt, adt->nla_tracks.first)
1631                 return;
1632         
1633         /* if animdata currently has an action, 'push down' this onto the stack first */
1634         if (adt->action)
1635                 BKE_nla_action_pushdown(adt);
1636         
1637         /* get range of motion to bake, and the channels involved... */
1638         
1639         /* temporarily mute the action, and start keying to it */
1640         
1641         /* start keying... */
1642         
1643         /* unmute the action */
1644 }
1645
1646 /* *************************************************** */