Merged changes in the trunk up to revision 40911.
[blender.git] / source / blender / editors / animation / anim_filter.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) 2008 Blender Foundation, Joshua Leung
19  * All rights reserved.
20  *
21  * 
22  * Contributor(s): Joshua Leung (original author)
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/editors/animation/anim_filter.c
28  *  \ingroup edanimation
29  */
30
31
32 /* This file contains a system used to provide a layer of abstraction between sources
33  * of animation data and tools in Animation Editors. The method used here involves 
34  * generating a list of edit structures which enable tools to naively perform the actions 
35  * they require without all the boiler-plate associated with loops within loops and checking 
36  * for cases to ignore. 
37  *
38  * While this is primarily used for the Action/Dopesheet Editor (and its accessory modes),
39  * the Graph Editor also uses this for its channel list and for determining which curves
40  * are being edited. Likewise, the NLA Editor also uses this for its channel list and in
41  * its operators.
42  *
43  * Note: much of the original system this was based on was built before the creation of the RNA
44  * system. In future, it would be interesting to replace some parts of this code with RNA queries,
45  * however, RNA does not eliminate some of the boiler-plate reduction benefits presented by this 
46  * system, so if any such work does occur, it should only be used for the internals used here...
47  *
48  * -- Joshua Leung, Dec 2008 (Last revision July 2009)
49  */
50
51 #include <string.h>
52
53 #include "DNA_anim_types.h"
54 #include "DNA_armature_types.h"
55 #include "DNA_camera_types.h"
56 #include "DNA_lamp_types.h"
57 #include "DNA_lattice_types.h"
58 #include "DNA_linestyle_types.h"
59 #include "DNA_key_types.h"
60 #include "DNA_material_types.h"
61 #include "DNA_mesh_types.h"
62 #include "DNA_meta_types.h"
63 #include "DNA_node_types.h"
64 #include "DNA_particle_types.h"
65 #include "DNA_space_types.h"
66 #include "DNA_sequence_types.h"
67 #include "DNA_scene_types.h"
68 #include "DNA_screen_types.h"
69 #include "DNA_speaker_types.h"
70 #include "DNA_world_types.h"
71 #include "DNA_gpencil_types.h"
72 #include "DNA_object_types.h"
73
74 #include "MEM_guardedalloc.h"
75
76 #include "BLI_blenlib.h"
77 #include "BLI_utildefines.h"
78 #include "BLI_ghash.h"
79
80 #include "BKE_animsys.h"
81 #include "BKE_action.h"
82 #include "BKE_fcurve.h"
83 #include "BKE_context.h"
84 #include "BKE_global.h"
85 #include "BKE_group.h"
86 #include "BKE_key.h"
87 #include "BKE_main.h"
88 #include "BKE_material.h"
89 #include "BKE_node.h"
90 #include "BKE_sequencer.h"
91 #include "BKE_utildefines.h"
92
93 #include "ED_anim_api.h"
94 #include "ED_markers.h"
95
96 /* ************************************************************ */
97 /* Blender Context <-> Animation Context mapping */
98
99 /* ----------- Private Stuff - Action Editor ------------- */
100
101 /* Get shapekey data being edited (for Action Editor -> ShapeKey mode) */
102 /* Note: there's a similar function in key.c (ob_get_key) */
103 static Key *actedit_get_shapekeys (bAnimContext *ac) 
104 {
105         Scene *scene= ac->scene;
106         Object *ob;
107         Key *key;
108         
109         ob = OBACT;
110         if (ob == NULL) 
111                 return NULL;
112         
113         /* XXX pinning is not available in 'ShapeKey' mode... */
114         //if (saction->pin) return NULL;
115         
116         /* shapekey data is stored with geometry data */
117         key= ob_get_key(ob);
118         
119         if (key) {
120                 if (key->type == KEY_RELATIVE)
121                         return key;
122         }
123         
124         return NULL;
125 }
126
127 /* Get data being edited in Action Editor (depending on current 'mode') */
128 static short actedit_get_context (bAnimContext *ac, SpaceAction *saction)
129 {
130         /* get dopesheet */
131         ac->ads = &saction->ads;
132         
133         /* sync settings with current view status, then return appropriate data */
134         switch (saction->mode) {
135                 case SACTCONT_ACTION: /* 'Action Editor' */
136                         /* if not pinned, sync with active object */
137                         if (/*saction->pin == 0*/1) {
138                                 if (ac->obact && ac->obact->adt)
139                                         saction->action = ac->obact->adt->action;
140                                 else
141                                         saction->action= NULL;
142                         }
143                         
144                         ac->datatype= ANIMCONT_ACTION;
145                         ac->data= saction->action;
146                         
147                         ac->mode= saction->mode;
148                         return 1;
149                         
150                 case SACTCONT_SHAPEKEY: /* 'ShapeKey Editor' */
151                         ac->datatype= ANIMCONT_SHAPEKEY;
152                         ac->data= actedit_get_shapekeys(ac);
153                         
154                         ac->mode= saction->mode;
155                         return 1;
156                         
157                 case SACTCONT_GPENCIL: /* Grease Pencil */ // XXX review how this mode is handled...
158                         /* update scene-pointer (no need to check for pinning yet, as not implemented) */
159                         saction->ads.source= (ID *)ac->scene;
160                         
161                         ac->datatype= ANIMCONT_GPENCIL;
162                         ac->data= &saction->ads;
163                         
164                         ac->mode= saction->mode;
165                         return 1;
166                         
167                 case SACTCONT_DOPESHEET: /* DopeSheet */
168                         /* update scene-pointer (no need to check for pinning yet, as not implemented) */
169                         saction->ads.source= (ID *)ac->scene;
170                         
171                         ac->datatype= ANIMCONT_DOPESHEET;
172                         ac->data= &saction->ads;
173                         
174                         ac->mode= saction->mode;
175                         return 1;
176                 
177                 default: /* unhandled yet */
178                         ac->datatype= ANIMCONT_NONE;
179                         ac->data= NULL;
180                         
181                         ac->mode= -1;
182                         return 0;
183         }
184 }
185
186 /* ----------- Private Stuff - Graph Editor ------------- */
187
188 /* Get data being edited in Graph Editor (depending on current 'mode') */
189 static short graphedit_get_context (bAnimContext *ac, SpaceIpo *sipo)
190 {
191         /* init dopesheet data if non-existant (i.e. for old files) */
192         if (sipo->ads == NULL) {
193                 sipo->ads= MEM_callocN(sizeof(bDopeSheet), "GraphEdit DopeSheet");
194                 sipo->ads->source= (ID *)ac->scene;
195         }
196         ac->ads = sipo->ads;
197         
198         /* set settings for Graph Editor - "Selected = Editable" */
199         if (sipo->flag & SIPO_SELCUVERTSONLY)
200                 sipo->ads->filterflag |= ADS_FILTER_SELEDIT;
201         else
202                 sipo->ads->filterflag &= ~ADS_FILTER_SELEDIT;
203         
204         /* sync settings with current view status, then return appropriate data */
205         switch (sipo->mode) {
206                 case SIPO_MODE_ANIMATION:       /* Animation F-Curve Editor */
207                         /* update scene-pointer (no need to check for pinning yet, as not implemented) */
208                         sipo->ads->source= (ID *)ac->scene;
209                         sipo->ads->filterflag &= ~ADS_FILTER_ONLYDRIVERS;
210                         
211                         ac->datatype= ANIMCONT_FCURVES;
212                         ac->data= sipo->ads;
213                         
214                         ac->mode= sipo->mode;
215                         return 1;
216                 
217                 case SIPO_MODE_DRIVERS:         /* Driver F-Curve Editor */
218                         /* update scene-pointer (no need to check for pinning yet, as not implemented) */
219                         sipo->ads->source= (ID *)ac->scene;
220                         sipo->ads->filterflag |= ADS_FILTER_ONLYDRIVERS;
221                         
222                         ac->datatype= ANIMCONT_DRIVERS;
223                         ac->data= sipo->ads;
224                         
225                         ac->mode= sipo->mode;
226                         return 1;
227                 
228                 default: /* unhandled yet */
229                         ac->datatype= ANIMCONT_NONE;
230                         ac->data= NULL;
231                         
232                         ac->mode= -1;
233                         return 0;
234         }
235 }
236
237 /* ----------- Private Stuff - NLA Editor ------------- */
238
239 /* Get data being edited in Graph Editor (depending on current 'mode') */
240 static short nlaedit_get_context (bAnimContext *ac, SpaceNla *snla)
241 {
242         /* init dopesheet data if non-existant (i.e. for old files) */
243         if (snla->ads == NULL)
244                 snla->ads= MEM_callocN(sizeof(bDopeSheet), "NlaEdit DopeSheet");
245         ac->ads = snla->ads;
246         
247         /* sync settings with current view status, then return appropriate data */
248         /* update scene-pointer (no need to check for pinning yet, as not implemented) */
249         snla->ads->source= (ID *)ac->scene;
250         snla->ads->filterflag |= ADS_FILTER_ONLYNLA;
251         
252         ac->datatype= ANIMCONT_NLA;
253         ac->data= snla->ads;
254         
255         return 1;
256 }
257
258 /* ----------- Public API --------------- */
259
260 /* Obtain current anim-data context, given that context info from Blender context has already been set 
261  *      - AnimContext to write to is provided as pointer to var on stack so that we don't have
262  *        allocation/freeing costs (which are not that avoidable with channels).
263  */
264 short ANIM_animdata_context_getdata (bAnimContext *ac)
265 {
266         SpaceLink *sl = ac->sl;
267         short ok= 0;
268         
269         /* context depends on editor we are currently in */
270         if (sl) {
271                 switch (ac->spacetype) {
272                         case SPACE_ACTION:
273                         {
274                                 SpaceAction *saction= (SpaceAction *)sl;
275                                 ok= actedit_get_context(ac, saction);
276                         }
277                                 break;
278                                 
279                         case SPACE_IPO:
280                         {
281                                 SpaceIpo *sipo= (SpaceIpo *)sl;
282                                 ok= graphedit_get_context(ac, sipo);
283                         }
284                                 break;
285                                 
286                         case SPACE_NLA:
287                         {
288                                 SpaceNla *snla= (SpaceNla *)sl;
289                                 ok= nlaedit_get_context(ac, snla);
290                         }
291                                 break;
292                 }
293         }
294         
295         /* check if there's any valid data */
296         if (ok && ac->data)
297                 return 1;
298         else
299                 return 0;
300 }
301
302 /* Obtain current anim-data context from Blender Context info 
303  *      - AnimContext to write to is provided as pointer to var on stack so that we don't have
304  *        allocation/freeing costs (which are not that avoidable with channels).
305  *      - Clears data and sets the information from Blender Context which is useful
306  */
307 short ANIM_animdata_get_context (const bContext *C, bAnimContext *ac)
308 {
309         ScrArea *sa= CTX_wm_area(C);
310         ARegion *ar= CTX_wm_region(C);
311         SpaceLink *sl= CTX_wm_space_data(C);
312         Scene *scene= CTX_data_scene(C);
313         
314         /* clear old context info */
315         if (ac == NULL) return 0;
316         memset(ac, 0, sizeof(bAnimContext));
317         
318         /* get useful default context settings from context */
319         ac->scene= scene;
320         if (scene) {
321                 ac->markers= ED_context_get_markers(C);         
322                 ac->obact= (scene->basact)?  scene->basact->object : NULL;
323         }
324         ac->sa= sa;
325         ac->ar= ar;
326         ac->sl= sl;
327         ac->spacetype= (sa) ? sa->spacetype : 0;
328         ac->regiontype= (ar) ? ar->regiontype : 0;
329         
330         /* get data context info */
331         return ANIM_animdata_context_getdata(ac);
332 }
333
334 /* ************************************************************ */
335 /* Blender Data <-- Filter --> Channels to be operated on */
336
337 /* macros to use before/after getting the sub-channels of some channel,
338  * to abstract away some of the tricky logic involved
339  *
340  * cases:
341  *      1) Graph Edit main area (just data) OR channels visible in Channel List
342  *      2) If not showing channels, we're only interested in the data (Action Editor's editing)
343  *      3) We don't care what data, we just care there is some (so that a collapsed 
344  *         channel can be kept around). No need to clear channels-flag in order to 
345  *         keep expander channels with no sub-data out, as those cases should get
346  *         dealt with by the recursive detection idiom in place.
347  *
348  * Implementation Note:
349  *      YES the _doSubChannels variable is NOT read anywhere. BUT, this is NOT an excuse
350  *      to go steamrolling the logic into a single-line expression as from experience,
351  *      those are notoriously difficult to read + debug when extending later on. The code
352  *      below is purposefully laid out so that each case noted above corresponds clearly to
353  *      one case below.
354  */
355 #define BEGIN_ANIMFILTER_SUBCHANNELS(expanded_check) \
356         { \
357                 int _filter = filter_mode; \
358                 short _doSubChannels = 0; \
359                 if (!(filter_mode & ANIMFILTER_LIST_VISIBLE) || (expanded_check)) \
360                         _doSubChannels=1; \
361                 else if (!(filter_mode & ANIMFILTER_LIST_CHANNELS)) \
362                         _doSubChannels=2; \
363                 else {\
364                         filter_mode |= ANIMFILTER_TMP_PEEK; \
365                 }
366                 /* ... standard sub-channel filtering can go on here now ... */
367 #define END_ANIMFILTER_SUBCHANNELS \
368                 filter_mode = _filter; \
369         }
370
371 /* ............................... */
372
373 /* quick macro to test if AnimData is usable */
374 #define ANIMDATA_HAS_KEYS(id) ((id)->adt && (id)->adt->action)
375
376 /* quick macro to test if AnimData is usable for drivers */
377 #define ANIMDATA_HAS_DRIVERS(id) ((id)->adt && (id)->adt->drivers.first)
378
379 /* quick macro to test if AnimData is usable for NLA */
380 #define ANIMDATA_HAS_NLA(id) ((id)->adt && (id)->adt->nla_tracks.first)
381
382 /* Quick macro to test for all three above usability tests, performing the appropriate provided 
383  * action for each when the AnimData context is appropriate. 
384  *
385  * Priority order for this goes (most important, to least): AnimData blocks, NLA, Drivers, Keyframes.
386  *
387  * For this to work correctly, a standard set of data needs to be available within the scope that this
388  * gets called in: 
389  *      - ListBase anim_data;
390  *      - bDopeSheet *ads;
391  *      - bAnimListElem *ale;
392  *      - size_t items;
393  *
394  *      - id: ID block which should have an AnimData pointer following it immediately, to use
395  *      - adtOk: line or block of code to execute for AnimData-blocks case (usually ANIMDATA_ADD_ANIMDATA)
396  *      - nlaOk: line or block of code to execute for NLA tracks+strips case
397  *      - driversOk: line or block of code to execute for Drivers case
398  *      - keysOk: line or block of code for Keyframes case
399  *
400  * The checks for the various cases are as follows:
401  *      0) top level: checks for animdata and also that all the F-Curves for the block will be visible
402  *      1) animdata check: for filtering animdata blocks only
403  *      2A) nla tracks: include animdata block's data as there are NLA tracks+strips there
404  *      2B) actions to convert to nla: include animdata block's data as there is an action that can be 
405  *              converted to a new NLA strip, and the filtering options allow this
406  *      2C) allow non-animated datablocks to be included so that datablocks can be added
407  *      3) drivers: include drivers from animdata block (for Drivers mode in Graph Editor)
408  *      4) normal keyframes: only when there is an active action
409  */
410 #define ANIMDATA_FILTER_CASES(id, adtOk, nlaOk, driversOk, keysOk) \
411         {\
412                 if ((id)->adt) {\
413                         if (!(filter_mode & ANIMFILTER_CURVE_VISIBLE) || !((id)->adt->flag & ADT_CURVES_NOT_VISIBLE)) {\
414                                 if (filter_mode & ANIMFILTER_ANIMDATA) {\
415                                         adtOk\
416                                 }\
417                                 else if (ads->filterflag & ADS_FILTER_ONLYNLA) {\
418                                         if (ANIMDATA_HAS_NLA(id)) {\
419                                                 nlaOk\
420                                         }\
421                                         else if (!(ads->filterflag & ADS_FILTER_NLA_NOACT) && ANIMDATA_HAS_KEYS(id)) {\
422                                                 nlaOk\
423                                         }\
424                                 }\
425                                 else if (ads->filterflag & ADS_FILTER_ONLYDRIVERS) {\
426                                         if (ANIMDATA_HAS_DRIVERS(id)) {\
427                                                 driversOk\
428                                         }\
429                                 }\
430                                 else {\
431                                         if (ANIMDATA_HAS_KEYS(id)) {\
432                                                 keysOk\
433                                         }\
434                                 }\
435                         }\
436                 }\
437         }
438
439 /* ............................... */
440
441 /* Add a new animation channel, taking into account the "peek" flag, which is used to just check 
442  * whether any channels will be added (but without needing them to actually get created).
443  *
444  * ! This causes the calling function to return early if we're only "peeking" for channels
445  */
446 // XXX: ale_statement stuff is really a hack for one special case. It shouldn't really be needed...
447 #define ANIMCHANNEL_NEW_CHANNEL_FULL(channel_data, channel_type, owner_id, ale_statement) \
448         if (filter_mode & ANIMFILTER_TMP_PEEK) \
449                 return 1; \
450         else { \
451                 bAnimListElem *ale= make_new_animlistelem(channel_data, channel_type, (ID *)owner_id); \
452                 if (ale) {\
453                         BLI_addtail(anim_data, ale); \
454                         items++; \
455                         ale_statement \
456                 } \
457         }
458         
459 #define ANIMCHANNEL_NEW_CHANNEL(channel_data, channel_type, owner_id) \
460         ANIMCHANNEL_NEW_CHANNEL_FULL(channel_data, channel_type, owner_id, {})
461         
462 /* ............................... */
463         
464 /* quick macro to test if an anim-channel representing an AnimData block is suitably active */
465 #define ANIMCHANNEL_ACTIVEOK(ale) \
466         ( !(filter_mode & ANIMFILTER_ACTIVE) || !(ale->adt) || (ale->adt->flag & ADT_UI_ACTIVE) )
467
468 /* quick macro to test if an anim-channel (F-Curve, Group, etc.) is selected in an acceptable way */
469 #define ANIMCHANNEL_SELOK(test_func) \
470                 ( !(filter_mode & (ANIMFILTER_SEL|ANIMFILTER_UNSEL)) || \
471                   ((filter_mode & ANIMFILTER_SEL) && test_func) || \
472                   ((filter_mode & ANIMFILTER_UNSEL) && test_func==0) ) 
473                   
474 /* quick macro to test if an anim-channel (F-Curve) is selected ok for editing purposes 
475  *      - _SELEDIT means that only selected curves will have visible+editable keyframes
476  *
477  * checks here work as follows:
478  *      1) seledit off - don't need to consider the implications of this option
479  *      2) foredit off - we're not considering editing, so channel is ok still
480  *      3) test_func (i.e. selection test) - only if selected, this test will pass
481  */
482 #define ANIMCHANNEL_SELEDITOK(test_func) \
483                 ( !(filter_mode & ANIMFILTER_SELEDIT) || \
484                   !(filter_mode & ANIMFILTER_FOREDIT) || \
485                   (test_func) )
486
487 /* ----------- 'Private' Stuff --------------- */
488
489 /* this function allocates memory for a new bAnimListElem struct for the 
490  * provided animation channel-data. 
491  */
492 static bAnimListElem *make_new_animlistelem (void *data, short datatype, ID *owner_id)
493 {
494         bAnimListElem *ale= NULL;
495         
496         /* only allocate memory if there is data to convert */
497         if (data) {
498                 /* allocate and set generic data */
499                 ale= MEM_callocN(sizeof(bAnimListElem), "bAnimListElem");
500                 
501                 ale->data= data;
502                 ale->type= datatype;
503                 
504                 ale->id= owner_id;
505                 ale->adt= BKE_animdata_from_id(owner_id);
506                 
507                 /* do specifics */
508                 switch (datatype) {
509                         case ANIMTYPE_SUMMARY:
510                         {
511                                 /* nothing to include for now... this is just a dummy wrappy around all the other channels 
512                                  * in the DopeSheet, and gets included at the start of the list
513                                  */
514                                 ale->key_data= NULL;
515                                 ale->datatype= ALE_ALL;
516                         }
517                                 break;
518                         
519                         case ANIMTYPE_SCENE:
520                         {
521                                 Scene *sce= (Scene *)data;
522                                 
523                                 ale->flag= sce->flag;
524                                 
525                                 ale->key_data= sce;
526                                 ale->datatype= ALE_SCE;
527                                 
528                                 ale->adt= BKE_animdata_from_id(data);
529                         }
530                                 break;
531                         case ANIMTYPE_OBJECT:
532                         {
533                                 Base *base= (Base *)data;
534                                 Object *ob= base->object;
535                                 
536                                 ale->flag= ob->flag;
537                                 
538                                 ale->key_data= ob;
539                                 ale->datatype= ALE_OB;
540                                 
541                                 ale->adt= BKE_animdata_from_id(&ob->id);
542                         }
543                                 break;
544                         case ANIMTYPE_FILLACTD:
545                         {
546                                 bAction *act= (bAction *)data;
547                                 
548                                 ale->flag= act->flag;
549                                 
550                                 ale->key_data= act;
551                                 ale->datatype= ALE_ACT;
552                         }
553                                 break;
554                         case ANIMTYPE_FILLDRIVERS:
555                         {
556                                 AnimData *adt= (AnimData *)data;
557                                 
558                                 ale->flag= adt->flag;
559                                 
560                                         // XXX... drivers don't show summary for now
561                                 ale->key_data= NULL;
562                                 ale->datatype= ALE_NONE;
563                         }
564                                 break;
565                         
566                         case ANIMTYPE_DSMAT:
567                         {
568                                 Material *ma= (Material *)data;
569                                 AnimData *adt= ma->adt;
570                                 
571                                 ale->flag= FILTER_MAT_OBJD(ma);
572                                 
573                                 ale->key_data= (adt) ? adt->action : NULL;
574                                 ale->datatype= ALE_ACT;
575                                 
576                                 ale->adt= BKE_animdata_from_id(data);
577                         }
578                                 break;
579                         case ANIMTYPE_DSLAM:
580                         {
581                                 Lamp *la= (Lamp *)data;
582                                 AnimData *adt= la->adt;
583                                 
584                                 ale->flag= FILTER_LAM_OBJD(la);
585                                 
586                                 ale->key_data= (adt) ? adt->action : NULL;
587                                 ale->datatype= ALE_ACT;
588                                 
589                                 ale->adt= BKE_animdata_from_id(data);
590                         }
591                                 break;
592                         case ANIMTYPE_DSCAM:
593                         {
594                                 Camera *ca= (Camera *)data;
595                                 AnimData *adt= ca->adt;
596                                 
597                                 ale->flag= FILTER_CAM_OBJD(ca);
598                                 
599                                 ale->key_data= (adt) ? adt->action : NULL;
600                                 ale->datatype= ALE_ACT;
601                                 
602                                 ale->adt= BKE_animdata_from_id(data);
603                         }
604                                 break;
605                         case ANIMTYPE_DSCUR:
606                         {
607                                 Curve *cu= (Curve *)data;
608                                 AnimData *adt= cu->adt;
609                                 
610                                 ale->flag= FILTER_CUR_OBJD(cu);
611                                 
612                                 ale->key_data= (adt) ? adt->action : NULL;
613                                 ale->datatype= ALE_ACT;
614                                 
615                                 ale->adt= BKE_animdata_from_id(data);
616                         }
617                                 break;
618                         case ANIMTYPE_DSARM:
619                         {
620                                 bArmature *arm= (bArmature *)data;
621                                 AnimData *adt= arm->adt;
622                                 
623                                 ale->flag= FILTER_ARM_OBJD(arm);
624                                 
625                                 ale->key_data= (adt) ? adt->action : NULL;
626                                 ale->datatype= ALE_ACT;
627                                 
628                                 ale->adt= BKE_animdata_from_id(data);
629                         }
630                                 break;
631                         case ANIMTYPE_DSMESH:
632                         {
633                                 Mesh *me= (Mesh *)data;
634                                 AnimData *adt= me->adt;
635                                 
636                                 ale->flag= FILTER_MESH_OBJD(me);
637                                 
638                                 ale->key_data= (adt) ? adt->action : NULL;
639                                 ale->datatype= ALE_ACT;
640                                 
641                                 ale->adt= BKE_animdata_from_id(data);
642                         }
643                                 break;
644                         case ANIMTYPE_DSLAT:
645                         {
646                                 Lattice *lt= (Lattice *)data;
647                                 AnimData *adt= lt->adt;
648                                 
649                                 ale->flag= FILTER_LATTICE_OBJD(lt);
650                                 
651                                 ale->key_data= (adt) ? adt->action : NULL;
652                                 ale->datatype= ALE_ACT;
653                                 
654                                 ale->adt= BKE_animdata_from_id(data);
655                         }       
656                                 break;
657                         case ANIMTYPE_DSSPK:
658                         {
659                                 Speaker *spk= (Speaker *)data;
660                                 AnimData *adt= spk->adt;
661
662                                 ale->flag= FILTER_SPK_OBJD(spk);
663
664                                 ale->key_data= (adt) ? adt->action : NULL;
665                                 ale->datatype= ALE_ACT;
666
667                                 ale->adt= BKE_animdata_from_id(data);
668                         }
669                                 break;
670                         case ANIMTYPE_DSSKEY:
671                         {
672                                 Key *key= (Key *)data;
673                                 AnimData *adt= key->adt;
674                                 
675                                 ale->flag= FILTER_SKE_OBJD(key); 
676                                 
677                                 ale->key_data= (adt) ? adt->action : NULL;
678                                 ale->datatype= ALE_ACT;
679                                 
680                                 ale->adt= BKE_animdata_from_id(data);
681                         }
682                                 break;
683                         case ANIMTYPE_DSWOR:
684                         {
685                                 World *wo= (World *)data;
686                                 AnimData *adt= wo->adt;
687                                 
688                                 ale->flag= FILTER_WOR_SCED(wo); 
689                                 
690                                 ale->key_data= (adt) ? adt->action : NULL;
691                                 ale->datatype= ALE_ACT;
692                                 
693                                 ale->adt= BKE_animdata_from_id(data);
694                         }
695                                 break;
696                         case ANIMTYPE_DSNTREE:
697                         {
698                                 bNodeTree *ntree= (bNodeTree *)data;
699                                 AnimData *adt= ntree->adt;
700                                 
701                                 ale->flag= FILTER_NTREE_DATA(ntree); 
702                                 
703                                 ale->key_data= (adt) ? adt->action : NULL;
704                                 ale->datatype= ALE_ACT;
705                                 
706                                 ale->adt= BKE_animdata_from_id(data);
707                         }
708                                 break;
709                         case ANIMTYPE_DSLINESTYLE:
710                         {
711                                 FreestyleLineStyle *linestyle= (FreestyleLineStyle *)data;
712                                 AnimData *adt= linestyle->adt;
713                                 
714                                 ale->flag= FILTER_LS_SCED(linestyle); 
715                                 
716                                 ale->key_data= (adt) ? adt->action : NULL;
717                                 ale->datatype= ALE_ACT;
718                                 
719                                 ale->adt= BKE_animdata_from_id(data);
720                         }
721                                 break;
722                         case ANIMTYPE_DSPART:
723                         {
724                                 ParticleSettings *part= (ParticleSettings*)ale->data;
725                                 AnimData *adt= part->adt;
726                                 
727                                 ale->flag= FILTER_PART_OBJD(part); 
728                                 
729                                 ale->key_data= (adt) ? adt->action : NULL;
730                                 ale->datatype= ALE_ACT;
731                                 
732                                 ale->adt= BKE_animdata_from_id(data);
733                         }
734                                 break;
735                         case ANIMTYPE_DSTEX:
736                         {
737                                 Tex *tex= (Tex *)data;
738                                 AnimData *adt= tex->adt;
739                                 
740                                 ale->flag= FILTER_TEX_DATA(tex); 
741                                 
742                                 ale->key_data= (adt) ? adt->action : NULL;
743                                 ale->datatype= ALE_ACT;
744                                 
745                                 ale->adt= BKE_animdata_from_id(data);
746                         }
747                                 break;
748                                 
749                         case ANIMTYPE_GROUP:
750                         {
751                                 bActionGroup *agrp= (bActionGroup *)data;
752                                 
753                                 ale->flag= agrp->flag;
754                                 
755                                 ale->key_data= NULL;
756                                 ale->datatype= ALE_GROUP;
757                         }
758                                 break;
759                         case ANIMTYPE_FCURVE:
760                         {
761                                 FCurve *fcu= (FCurve *)data;
762                                 
763                                 ale->flag= fcu->flag;
764                                 
765                                 ale->key_data= fcu;
766                                 ale->datatype= ALE_FCURVE;
767                         }
768                                 break;
769                                 
770                         case ANIMTYPE_SHAPEKEY:
771                         {
772                                 KeyBlock *kb= (KeyBlock *)data;
773                                 Key *key= (Key *)ale->id;
774                                 
775                                 ale->flag= kb->flag;
776                                 
777                                 /* whether we have keyframes depends on whether there is a Key block to find it from */
778                                 if (key) {
779                                         /* index of shapekey is defined by place in key's list */
780                                         ale->index= BLI_findindex(&key->block, kb);
781                                         
782                                         /* the corresponding keyframes are from the animdata */
783                                         if (ale->adt && ale->adt->action) {
784                                                 bAction *act= ale->adt->action;
785                                                 char *rna_path = key_get_curValue_rnaPath(key, kb);
786                                                 
787                                                 /* try to find the F-Curve which corresponds to this exactly,
788                                                  * then free the MEM_alloc'd string
789                                                  */
790                                                 if (rna_path) {
791                                                         ale->key_data= (void *)list_find_fcurve(&act->curves, rna_path, 0);
792                                                         MEM_freeN(rna_path);
793                                                 }
794                                         }
795                                         ale->datatype= (ale->key_data)? ALE_FCURVE : ALE_NONE;
796                                 }
797                         }       
798                                 break;
799                         
800                         case ANIMTYPE_GPLAYER:
801                         {
802                                 bGPDlayer *gpl= (bGPDlayer *)data;
803                                 
804                                 ale->flag= gpl->flag;
805                                 
806                                 ale->key_data= NULL;
807                                 ale->datatype= ALE_GPFRAME;
808                         }
809                                 break;
810                                 
811                         case ANIMTYPE_NLATRACK:
812                         {
813                                 NlaTrack *nlt= (NlaTrack *)data;
814                                 
815                                 ale->flag= nlt->flag;
816                                 
817                                 ale->key_data= &nlt->strips;
818                                 ale->datatype= ALE_NLASTRIP;
819                         }
820                                 break;
821                         case ANIMTYPE_NLAACTION:
822                         {
823                                 /* nothing to include for now... nothing editable from NLA-perspective here */
824                                 ale->key_data= NULL;
825                                 ale->datatype= ALE_NONE;
826                         }
827                                 break;
828                 }
829         }
830         
831         /* return created datatype */
832         return ale;
833 }
834  
835 /* ----------------------------------------- */
836
837 /* 'Only Selected' selected data filtering
838  * NOTE: when this function returns true, the F-Curve is to be skipped 
839  */
840 static size_t skip_fcurve_selected_data (bDopeSheet *ads, FCurve *fcu, ID *owner_id, int filter_mode)
841 {
842         if (GS(owner_id->name) == ID_OB) {
843                 Object *ob= (Object *)owner_id;
844                 
845                 /* only consider if F-Curve involves pose.bones */
846                 if ((fcu->rna_path) && strstr(fcu->rna_path, "pose.bones")) {
847                         bPoseChannel *pchan;
848                         char *bone_name;
849                         
850                         /* get bone-name, and check if this bone is selected */
851                         bone_name= BLI_getQuotedStr(fcu->rna_path, "pose.bones[");
852                         pchan= get_pose_channel(ob->pose, bone_name);
853                         if (bone_name) MEM_freeN(bone_name);
854                         
855                         /* check whether to continue or skip */
856                         if ((pchan) && (pchan->bone)) {
857                                 /* if only visible channels, skip if bone not visible unless user wants channels from hidden data too */
858                                 if ((filter_mode & ANIMFILTER_DATA_VISIBLE) && !(ads->filterflag & ADS_FILTER_INCL_HIDDEN)) {
859                                         bArmature *arm= (bArmature *)ob->data;
860                                         
861                                         if ((arm->layer & pchan->bone->layer) == 0)
862                                                 return 1;
863                                         // TODO: manually hidden using flags
864                                 }
865                                 
866                                 /* can only add this F-Curve if it is selected */
867                                 if ((pchan->bone->flag & BONE_SELECTED) == 0)
868                                         return 1;
869                         }
870                 }
871         }
872         else if (GS(owner_id->name) == ID_SCE) {
873                 Scene *scene = (Scene *)owner_id;
874                 
875                 /* only consider if F-Curve involves sequence_editor.sequences */
876                 if ((fcu->rna_path) && strstr(fcu->rna_path, "sequences_all")) {
877                         Editing *ed= seq_give_editing(scene, FALSE);
878                         Sequence *seq;
879                         char *seq_name;
880                         
881                         /* get strip name, and check if this strip is selected */
882                         seq_name= BLI_getQuotedStr(fcu->rna_path, "sequences_all[");
883                         seq = get_seq_by_name(ed->seqbasep, seq_name, FALSE);
884                         if (seq_name) MEM_freeN(seq_name);
885                         
886                         /* can only add this F-Curve if it is selected */
887                         if (seq==NULL || (seq->flag & SELECT)==0)
888                                 return 1;
889                 }
890         }
891         else if (GS(owner_id->name) == ID_NT) {
892                 bNodeTree *ntree = (bNodeTree *)owner_id;
893                 
894                 /* check for selected  nodes */
895                 if ((fcu->rna_path) && strstr(fcu->rna_path, "nodes")) {
896                         bNode *node;
897                         char *node_name;
898                         
899                         /* get strip name, and check if this strip is selected */
900                         node_name= BLI_getQuotedStr(fcu->rna_path, "nodes[");
901                         node = nodeFindNodebyName(ntree, node_name);
902                         if (node_name) MEM_freeN(node_name);
903                         
904                         /* can only add this F-Curve if it is selected */
905                         if ((node) && (node->flag & NODE_SELECT)==0)
906                                 return 1;
907                 }
908         }
909         return 0;
910 }
911
912 /* (Display-)Name-based F-Curve filtering
913  * NOTE: when this function returns true, the F-Curve is to be skipped 
914  */
915 static short skip_fcurve_with_name (bDopeSheet *ads, FCurve *fcu, ID *owner_id)
916 {
917         bAnimListElem ale_dummy = {NULL};
918         bAnimChannelType *acf;
919         
920         /* create a dummy wrapper for the F-Curve */
921         ale_dummy.type = ANIMTYPE_FCURVE;
922         ale_dummy.id = owner_id;
923         ale_dummy.data = fcu;
924         
925         /* get type info for channel */
926         acf = ANIM_channel_get_typeinfo(&ale_dummy);
927         if (acf && acf->name) {
928                 char name[256]; /* hopefully this will be enough! */
929                 
930                 /* get name */
931                 acf->name(&ale_dummy, name);
932                 
933                 /* check for partial match with the match string, assuming case insensitive filtering 
934                  * if match, this channel shouldn't be ignored!
935                  */
936                 return BLI_strcasestr(name, ads->searchstr) == NULL;
937         }
938         
939         /* just let this go... */
940         return 1;
941 }
942
943 /* find the next F-Curve that is usable for inclusion */
944 static FCurve *animfilter_fcurve_next (bDopeSheet *ads, FCurve *first, bActionGroup *grp, int filter_mode, ID *owner_id)
945 {
946         FCurve *fcu = NULL;
947         
948         /* loop over F-Curves - assume that the caller of this has already checked that these should be included 
949          * NOTE: we need to check if the F-Curves belong to the same group, as this gets called for groups too...
950          */
951         for (fcu= first; ((fcu) && (fcu->grp==grp)); fcu= fcu->next) {
952                 /* special exception for Pose-Channel/Sequence-Strip/Node Based F-Curves:
953                  *      - the 'Only Selected' data filter should be applied to Pose-Channel data too, but those are
954                  *        represented as F-Curves. The way the filter for objects worked was to be the first check
955                  *        after 'normal' visibility, so this is done first here too...
956                  *      - we currently use an 'approximate' method for getting these F-Curves that doesn't require
957                  *        carefully checking the entire path
958                  *      - this will also affect things like Drivers, and also works for Bone Constraints
959                  */
960                 if ( ((ads) && (ads->filterflag & ADS_FILTER_ONLYSEL)) && (owner_id) ) {
961                         if (skip_fcurve_selected_data(ads, fcu, owner_id, filter_mode))
962                                 continue;
963                 }
964                 
965                 /* only include if visible (Graph Editor check, not channels check) */
966                 if (!(filter_mode & ANIMFILTER_CURVE_VISIBLE) || (fcu->flag & FCURVE_VISIBLE)) {
967                         /* only work with this channel and its subchannels if it is editable */
968                         if (!(filter_mode & ANIMFILTER_FOREDIT) || EDITABLE_FCU(fcu)) {
969                                 /* only include this curve if selected in a way consistent with the filtering requirements */
970                                 if ( ANIMCHANNEL_SELOK(SEL_FCU(fcu)) && ANIMCHANNEL_SELEDITOK(SEL_FCU(fcu)) ) {
971                                         /* only include if this curve is active */
972                                         if (!(filter_mode & ANIMFILTER_ACTIVE) || (fcu->flag & FCURVE_ACTIVE)) {
973                                                 /* name based filtering... */
974                                                 if ( ((ads) && (ads->filterflag & ADS_FILTER_BY_FCU_NAME)) && (owner_id) ) {
975                                                         if (skip_fcurve_with_name(ads, fcu, owner_id))
976                                                                 continue;
977                                                 }
978                                                 
979                                                 /* this F-Curve can be used, so return it */
980                                                 return fcu;
981                                         }
982                                 }
983                         }
984                 }
985         }
986         
987         /* no (more) F-Curves from the list are suitable... */
988         return NULL;
989 }
990
991 static size_t animfilter_fcurves (ListBase *anim_data, bDopeSheet *ads, FCurve *first, bActionGroup *grp, int filter_mode, ID *owner_id)
992 {
993         FCurve *fcu;
994         size_t items = 0;
995         
996         /* loop over every F-Curve able to be included 
997          *      - this for-loop works like this: 
998          *              1) the starting F-Curve is assigned to the fcu pointer so that we have a starting point to search from
999          *              2) the first valid F-Curve to start from (which may include the one given as 'first') in the remaining 
1000          *                 list of F-Curves is found, and verified to be non-null
1001          *              3) the F-Curve referenced by fcu pointer is added to the list
1002          *              4) the fcu pointer is set to the F-Curve after the one we just added, so that we can keep going through 
1003          *                 the rest of the F-Curve list without an eternal loop. Back to step 2 :)
1004          */
1005         for (fcu=first; ( (fcu = animfilter_fcurve_next(ads, fcu, grp, filter_mode, owner_id)) ); fcu=fcu->next)
1006         {
1007                 ANIMCHANNEL_NEW_CHANNEL(fcu, ANIMTYPE_FCURVE, owner_id);
1008         }
1009         
1010         /* return the number of items added to the list */
1011         return items;
1012 }
1013
1014 static size_t animfilter_act_group (bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, bAction *UNUSED(act), bActionGroup *agrp, int filter_mode, ID *owner_id)
1015 {
1016         ListBase tmp_data = {NULL, NULL};
1017         size_t tmp_items = 0;
1018         size_t items = 0;
1019         //int ofilter = filter_mode;
1020         
1021         /* if we care about the selection status of the channels, 
1022          * but the group isn't expanded (1)...
1023          *      (1) this only matters if we actually care about the hierarchy though.
1024          *              - Hierarchy matters: this hack should be applied
1025          *              - Hierarchy ignored: cases like [#21276] won't work properly, unless we skip this hack
1026          */
1027         if ( ((filter_mode & ANIMFILTER_LIST_VISIBLE) && EXPANDED_AGRP(ac, agrp)==0) &&         /* care about hierarchy but group isn't expanded */
1028                   (filter_mode & (ANIMFILTER_SEL|ANIMFILTER_UNSEL)) )                                                   /* care about selection status */        
1029         {
1030                 /* if the group itself isn't selected appropriately, we shouldn't consider it's children either */
1031                 if (ANIMCHANNEL_SELOK(SEL_AGRP(agrp)) == 0)
1032                         return 0;
1033                 
1034                 /* if we're still here, then the selection status of the curves within this group should not matter,
1035                  * since this creates too much overhead for animators (i.e. making a slow workflow)
1036                  *
1037                  * Tools affected by this at time of coding (2010 Feb 09):
1038                  *      - inserting keyframes on selected channels only
1039                  *      - pasting keyframes
1040                  *      - creating ghost curves in Graph Editor
1041                  */
1042                 filter_mode &= ~(ANIMFILTER_SEL|ANIMFILTER_UNSEL|ANIMFILTER_LIST_VISIBLE);
1043         }
1044         
1045         /* add grouped F-Curves */
1046         BEGIN_ANIMFILTER_SUBCHANNELS(EXPANDED_AGRP(ac, agrp))
1047         {
1048                 /* special filter so that we can get just the F-Curves within the active group */
1049                 if (!(filter_mode & ANIMFILTER_ACTGROUPED) || (agrp->flag & AGRP_ACTIVE)) {
1050                         /* for the Graph Editor, curves may be set to not be visible in the view to lessen clutter,
1051                          * but to do this, we need to check that the group doesn't have it's not-visible flag set preventing 
1052                          * all its sub-curves to be shown
1053                          */
1054                         if ( !(filter_mode & ANIMFILTER_CURVE_VISIBLE) || !(agrp->flag & AGRP_NOTVISIBLE) )
1055                         {
1056                                 /* group must be editable for its children to be editable (if we care about this) */
1057                                 if (!(filter_mode & ANIMFILTER_FOREDIT) || EDITABLE_AGRP(agrp)) {
1058                                         /* get first F-Curve which can be used here */
1059                                         FCurve *first_fcu = animfilter_fcurve_next(ads, agrp->channels.first, agrp, filter_mode, owner_id);
1060                                         
1061                                         /* filter list, starting from this F-Curve */
1062                                         tmp_items += animfilter_fcurves(&tmp_data, ads, first_fcu, agrp, filter_mode, owner_id);
1063                                 }
1064                         }
1065                 }
1066         }
1067         END_ANIMFILTER_SUBCHANNELS;
1068         
1069         /* did we find anything? */
1070         if (tmp_items) {
1071                 /* add this group as a channel first */
1072                 if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1073                         /* restore original filter mode so that this next step works ok... */
1074                         //filter_mode = ofilter;
1075                         
1076                         /* filter selection of channel specially here again, since may be open and not subject to previous test */
1077                         if ( ANIMCHANNEL_SELOK(SEL_AGRP(agrp)) ) {
1078                                 ANIMCHANNEL_NEW_CHANNEL(agrp, ANIMTYPE_GROUP, owner_id);
1079                         }
1080                 }
1081                 
1082                 /* now add the list of collected channels */
1083                 BLI_movelisttolist(anim_data, &tmp_data);
1084                 BLI_assert((tmp_data.first == tmp_data.last) && (tmp_data.first == NULL));
1085                 items += tmp_items;
1086         }
1087         
1088         /* return the number of items added to the list */
1089         return items;
1090 }
1091
1092 static size_t animfilter_action (bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, bAction *act, int filter_mode, ID *owner_id)
1093 {
1094         bActionGroup *agrp;
1095         FCurve *lastchan = NULL;
1096         size_t items = 0;
1097         
1098         /* don't include anything from this action if it is linked in from another file,
1099          * and we're getting stuff for editing...
1100          */
1101         // TODO: need a way of tagging other channels that may also be affected...
1102         if ((filter_mode & ANIMFILTER_FOREDIT) && (act->id.lib))
1103                 return 0;
1104                 
1105         /* do groups */
1106         // TODO: do nested groups?
1107         for (agrp = act->groups.first; agrp; agrp = agrp->next) {
1108                 /* store reference to last channel of group */
1109                 if (agrp->channels.last) 
1110                         lastchan= agrp->channels.last;
1111                         
1112                 /* action group's channels */
1113                 items += animfilter_act_group(ac, anim_data, ads, act, agrp, filter_mode, owner_id);
1114         }
1115         
1116         /* un-grouped F-Curves (only if we're not only considering those channels in the active group) */
1117         if (!(filter_mode & ANIMFILTER_ACTGROUPED))  {
1118                 FCurve *firstfcu = (lastchan)? (lastchan->next) : (act->curves.first);
1119                 items += animfilter_fcurves(anim_data, ads, firstfcu, NULL, filter_mode, owner_id);
1120         }
1121         
1122         /* return the number of items added to the list */
1123         return items;
1124 }
1125
1126 /* Include NLA-Data for NLA-Editor:
1127  *      - when ANIMFILTER_LIST_CHANNELS is used, that means we should be filtering the list for display
1128  *        Although the evaluation order is from the first track to the last and then apply the Action on top,
1129  *        we present this in the UI as the Active Action followed by the last track to the first so that we 
1130  *        get the evaluation order presented as per a stack.
1131  *      - for normal filtering (i.e. for editing), we only need the NLA-tracks but they can be in 'normal' evaluation
1132  *        order, i.e. first to last. Otherwise, some tools may get screwed up.
1133  */
1134 static size_t animfilter_nla (bAnimContext *UNUSED(ac), ListBase *anim_data, bDopeSheet *ads, AnimData *adt, int filter_mode, ID *owner_id)
1135 {
1136         NlaTrack *nlt;
1137         NlaTrack *first=NULL, *next=NULL;
1138         size_t items = 0;
1139         
1140         /* if showing channels, include active action */
1141         if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1142                 /* if NLA action-line filtering is off, don't show unless there are keyframes, 
1143                  * in order to keep things more compact for doing transforms
1144                  */
1145                 if (!(ads->filterflag & ADS_FILTER_NLA_NOACT) || (adt->action)) {
1146                         /* there isn't really anything editable here, so skip if need editable */
1147                         if ((filter_mode & ANIMFILTER_FOREDIT) == 0) { 
1148                                 /* just add the action track now (this MUST appear for drawing)
1149                                  *      - as AnimData may not have an action, we pass a dummy pointer just to get the list elem created, then
1150                                  *        overwrite this with the real value - REVIEW THIS...
1151                                  */
1152                                 ANIMCHANNEL_NEW_CHANNEL_FULL((void *)(&adt->action), ANIMTYPE_NLAACTION, owner_id, 
1153                                         {
1154                                                 ale->data= adt->action ? adt->action : NULL; 
1155                                         });
1156                         }
1157                 }
1158                 
1159                 /* first track to include will be the last one if we're filtering by channels */
1160                 first= adt->nla_tracks.last;
1161         }
1162         else {
1163                 /* first track to include will the the first one (as per normal) */
1164                 first= adt->nla_tracks.first;
1165         }
1166         
1167         /* loop over NLA Tracks - assume that the caller of this has already checked that these should be included */
1168         for (nlt= first; nlt; nlt= next) {
1169                 /* 'next' NLA-Track to use depends on whether we're filtering for drawing or not */
1170                 if (filter_mode & ANIMFILTER_LIST_CHANNELS) 
1171                         next= nlt->prev;
1172                 else
1173                         next= nlt->next;
1174                 
1175                 /* if we're in NLA-tweakmode, don't show this track if it was disabled (due to tweaking) for now 
1176                  *      - active track should still get shown though (even though it has disabled flag set)
1177                  */
1178                 // FIXME: the channels after should still get drawn, just 'differently', and after an active-action channel
1179                 if ((adt->flag & ADT_NLA_EDIT_ON) && (nlt->flag & NLATRACK_DISABLED) && !(nlt->flag & NLATRACK_ACTIVE))
1180                         continue;
1181                 
1182                 /* only work with this channel and its subchannels if it is editable */
1183                 if (!(filter_mode & ANIMFILTER_FOREDIT) || EDITABLE_NLT(nlt)) {
1184                         /* only include this track if selected in a way consistent with the filtering requirements */
1185                         if ( ANIMCHANNEL_SELOK(SEL_NLT(nlt)) ) {
1186                                 /* only include if this track is active */
1187                                 if (!(filter_mode & ANIMFILTER_ACTIVE) || (nlt->flag & NLATRACK_ACTIVE)) {
1188                                         ANIMCHANNEL_NEW_CHANNEL(nlt, ANIMTYPE_NLATRACK, owner_id);
1189                                 }
1190                         }
1191                 }
1192         }
1193         
1194         /* return the number of items added to the list */
1195         return items;
1196 }
1197
1198 /* determine what animation data from AnimData block should get displayed */
1199 static size_t animfilter_block_data (bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, ID *id, int filter_mode)
1200 {
1201         AnimData *adt = BKE_animdata_from_id(id);
1202         size_t items = 0;
1203
1204         /* image object datablocks have no anim-data so check for NULL */
1205         if(adt) {
1206                 IdAdtTemplate *iat = (IdAdtTemplate*)id;
1207
1208                 /* NOTE: this macro is used instead of inlining the logic here, since this sort of filtering is still needed
1209                  * in a few places in he rest of the code still - notably for the few cases where special mode-based
1210                  * different types of data expanders are required.
1211                  */
1212                 ANIMDATA_FILTER_CASES(iat,
1213                         { /* AnimData */
1214                                 /* specifically filter animdata block */
1215                                 ANIMCHANNEL_NEW_CHANNEL(adt, ANIMTYPE_ANIMDATA, id);
1216                         },
1217                         { /* NLA */
1218                                 items += animfilter_nla(ac, anim_data, ads, adt, filter_mode, id);
1219                         },
1220                         { /* Drivers */
1221                                 items += animfilter_fcurves(anim_data, ads, adt->drivers.first, NULL, filter_mode, id);
1222                         },
1223                         { /* Keyframes */
1224                                 items += animfilter_action(ac, anim_data, ads, adt->action, filter_mode, id);
1225                         }
1226                 );
1227         }
1228
1229         return items;
1230 }
1231
1232
1233
1234 /* Include ShapeKey Data for ShapeKey Editor */
1235 static size_t animdata_filter_shapekey (bAnimContext *ac, ListBase *anim_data, Key *key, int filter_mode)
1236 {
1237         size_t items = 0;
1238         
1239         /* check if channels or only F-Curves */
1240         if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1241                 KeyBlock *kb;
1242                 
1243                 /* loop through the channels adding ShapeKeys as appropriate */
1244                 for (kb= key->block.first; kb; kb= kb->next) {
1245                         /* skip the first one, since that's the non-animateable basis */
1246                         // XXX maybe in future this may become handy?
1247                         if (kb == key->block.first) continue;
1248                         
1249                         /* only work with this channel and its subchannels if it is editable */
1250                         if (!(filter_mode & ANIMFILTER_FOREDIT) || EDITABLE_SHAPEKEY(kb)) {
1251                                 /* only include this track if selected in a way consistent with the filtering requirements */
1252                                 if ( ANIMCHANNEL_SELOK(SEL_SHAPEKEY(kb)) ) {
1253                                         // TODO: consider 'active' too?
1254                                         
1255                                         /* owner-id here must be key so that the F-Curve can be resolved... */
1256                                         ANIMCHANNEL_NEW_CHANNEL(kb, ANIMTYPE_SHAPEKEY, key);
1257                                 }
1258                         }
1259                 }
1260         }
1261         else {
1262                 /* just use the action associated with the shapekey */
1263                 // TODO: somehow manage to pass dopesheet info down here too?
1264                 if (key->adt) {
1265                         if (filter_mode & ANIMFILTER_ANIMDATA) {
1266                                 ANIMCHANNEL_NEW_CHANNEL(key->adt, ANIMTYPE_ANIMDATA, key);
1267                         }
1268                         else if (key->adt->action) {
1269                                 items= animfilter_action(ac, anim_data, NULL, key->adt->action, filter_mode, (ID *)key);
1270                         }
1271                 }
1272         }
1273         
1274         /* return the number of items added to the list */
1275         return items;
1276 }
1277
1278 static size_t animdata_filter_gpencil_data (ListBase *anim_data, bGPdata *gpd, int filter_mode)
1279 {
1280         bGPDlayer *gpl;
1281         size_t items = 0;
1282         
1283         /* loop over layers as the conditions are acceptable */
1284         for (gpl= gpd->layers.first; gpl; gpl= gpl->next) {
1285                 /* only if selected */
1286                 if ( ANIMCHANNEL_SELOK(SEL_GPL(gpl)) ) {
1287                         /* only if editable */
1288                         if (!(filter_mode & ANIMFILTER_FOREDIT) || EDITABLE_GPL(gpl)) {
1289                                 /* active... */
1290                                 if (!(filter_mode & ANIMFILTER_ACTIVE) || (gpl->flag & GP_LAYER_ACTIVE)) {
1291                                         /* add to list */
1292                                         ANIMCHANNEL_NEW_CHANNEL(gpl, ANIMTYPE_GPLAYER, gpd);
1293                                 }
1294                         }
1295                 }
1296         }
1297         
1298         return items;
1299 }
1300
1301 /* Grab all Grase Pencil datablocks in file */
1302 // TODO: should this be amalgamated with the dopesheet filtering code?
1303 static size_t animdata_filter_gpencil (ListBase *anim_data, void *UNUSED(data), int filter_mode)
1304 {
1305         bGPdata *gpd;
1306         size_t items = 0;
1307         
1308         /* for now, grab grease pencil datablocks directly from main */
1309         // XXX: this is not good...
1310         for (gpd = G.main->gpencil.first; gpd; gpd = gpd->id.next) {
1311                 ListBase tmp_data = {NULL, NULL};
1312                 size_t tmp_items = 0;
1313                 
1314                 /* only show if gpd is used by something... */
1315                 if (ID_REAL_USERS(gpd) < 1)
1316                         continue;
1317                         
1318                 /* add gpencil animation channels */
1319                 BEGIN_ANIMFILTER_SUBCHANNELS(EXPANDED_GPD(gpd))
1320                 {
1321                         tmp_items += animdata_filter_gpencil_data(&tmp_data, gpd, filter_mode);
1322                 }
1323                 END_ANIMFILTER_SUBCHANNELS;
1324                 
1325                 /* did we find anything? */
1326                 if (tmp_items) {
1327                         /* include data-expand widget first */
1328                         if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1329                                 /* add gpd as channel too (if for drawing, and it has layers) */
1330                                 ANIMCHANNEL_NEW_CHANNEL(gpd, ANIMTYPE_GPDATABLOCK, NULL);
1331                         }
1332                         
1333                         /* now add the list of collected channels */
1334                         BLI_movelisttolist(anim_data, &tmp_data);
1335                         BLI_assert((tmp_data.first == tmp_data.last) && (tmp_data.first == NULL));
1336                         items += tmp_items;
1337                 }
1338         }
1339         
1340         /* return the number of items added to the list */
1341         return items;
1342 }
1343
1344 /* NOTE: owner_id is scene, material, or texture block, which is the direct owner of the node tree in question */
1345 // TODO: how to handle group nodes is still unclear...
1346 static size_t animdata_filter_ds_nodetree (bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, ID *owner_id, bNodeTree *ntree, int filter_mode)
1347 {
1348         ListBase tmp_data = {NULL, NULL};
1349         size_t tmp_items = 0;
1350         size_t items = 0;
1351         
1352         /* add nodetree animation channels */
1353         BEGIN_ANIMFILTER_SUBCHANNELS(FILTER_NTREE_DATA(ntree))
1354         {
1355                 /* animation data filtering */
1356                 tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)ntree, filter_mode);
1357         }
1358         END_ANIMFILTER_SUBCHANNELS;
1359         
1360         /* did we find anything? */
1361         if (tmp_items) {
1362                 /* include data-expand widget first */
1363                 if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1364                         /* check if filtering by active status */
1365                         if ANIMCHANNEL_ACTIVEOK(ntree) {
1366                                 ANIMCHANNEL_NEW_CHANNEL(ntree, ANIMTYPE_DSNTREE, owner_id);
1367                         }
1368                 }
1369                 
1370                 /* now add the list of collected channels */
1371                 BLI_movelisttolist(anim_data, &tmp_data);
1372                 BLI_assert((tmp_data.first == tmp_data.last) && (tmp_data.first == NULL));
1373                 items += tmp_items;
1374         }
1375         
1376         /* return the number of items added to the list */
1377         return items;
1378 }
1379
1380 static size_t animdata_filter_ds_linestyle (bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Scene *sce, int filter_mode)
1381 {
1382         SceneRenderLayer *srl;
1383         size_t items = 0;
1384
1385         for (srl= sce->r.layers.first; srl; srl= srl->next) {
1386                 FreestyleLineSet *lineset;
1387
1388                 /* skip render layers without Freestyle enabled */
1389                 if (!(srl->layflag & SCE_LAY_FRS))
1390                         continue;
1391
1392                 /* loop over linesets defined in the render layer */
1393                 for (lineset= srl->freestyleConfig.linesets.first; lineset; lineset= lineset->next) {
1394                         FreestyleLineStyle *linestyle = lineset->linestyle;
1395                         ListBase tmp_data = {NULL, NULL};
1396                         size_t tmp_items = 0;
1397
1398                         /* add scene-level animation channels */
1399                         BEGIN_ANIMFILTER_SUBCHANNELS(FILTER_LS_SCED(linestyle))
1400                         {
1401                                 /* animation data filtering */
1402                                 tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)linestyle, filter_mode);
1403                         }
1404                         END_ANIMFILTER_SUBCHANNELS;
1405
1406                         /* did we find anything? */
1407                         if (tmp_items) {
1408                                 /* include anim-expand widget first */
1409                                 if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1410                                         /* check if filtering by active status */
1411                                         if ANIMCHANNEL_ACTIVEOK(linestyle) {
1412                                                 ANIMCHANNEL_NEW_CHANNEL(linestyle, ANIMTYPE_DSLINESTYLE, sce);
1413                                         }
1414                                 }
1415                                 
1416                                 /* now add the list of collected channels */
1417                                 BLI_movelisttolist(anim_data, &tmp_data);
1418                                 BLI_assert((tmp_data.first == tmp_data.last) && (tmp_data.first == NULL));
1419                                 items += tmp_items;
1420                         }
1421                 }
1422         }
1423         
1424         /* return the number of items added to the list */
1425         return items;
1426 }
1427
1428 /* NOTE: owner_id is either material, lamp, or world block, which is the direct owner of the texture stack in question */
1429 static size_t animdata_filter_ds_textures (bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, ID *owner_id, int filter_mode)
1430 {
1431         MTex **mtex = NULL;
1432         size_t items=0;
1433         int a=0;
1434         
1435         /* get datatype specific data first */
1436         if (owner_id == NULL)
1437                 return 0;
1438         
1439         switch (GS(owner_id->name)) {
1440                 case ID_MA:
1441                 {
1442                         Material *ma= (Material *)owner_id;
1443                         mtex= (MTex**)(&ma->mtex);
1444                 }
1445                         break;
1446                 case ID_LA:
1447                 {
1448                         Lamp *la= (Lamp *)owner_id;
1449                         mtex= (MTex**)(&la->mtex);
1450                 }
1451                         break;
1452                 case ID_WO:
1453                 {
1454                         World *wo= (World *)owner_id;
1455                         mtex= (MTex**)(&wo->mtex);
1456                 }
1457                         break;
1458                 default: 
1459                 {
1460                         /* invalid/unsupported option */
1461                         if (G.f & G_DEBUG)
1462                                 printf("ERROR: unsupported owner_id (i.e. texture stack) for filter textures - %s \n", owner_id->name);
1463                         return 0;
1464                 }
1465         }
1466         
1467         /* firstly check that we actuallly have some textures, by gathering all textures in a temp list */
1468         for (a=0; a < MAX_MTEX; a++) {
1469                 Tex *tex= (mtex[a]) ? mtex[a]->tex : NULL;
1470                 ListBase tmp_data = {NULL, NULL};
1471                 size_t tmp_items = 0;
1472                 
1473                 /* for now, if no texture returned, skip (this shouldn't confuse the user I hope) */
1474                 if (tex == NULL) 
1475                         continue;
1476                 
1477                 /* add texture's animation data to temp collection */
1478                 BEGIN_ANIMFILTER_SUBCHANNELS(FILTER_TEX_DATA(tex)) 
1479                 {
1480                         /* texture animdata */
1481                         tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)tex, filter_mode);
1482                         
1483                         /* nodes */
1484                         if ((tex->nodetree) && !(ads->filterflag & ADS_FILTER_NONTREE)) {
1485                                 /* owner_id as id instead of texture, since it'll otherwise be impossible to track the depth */
1486                                 // FIXME: perhaps as a result, textures should NOT be included under materials, but under their own section instead
1487                                 // so that free-floating textures can also be animated
1488                                 tmp_items += animdata_filter_ds_nodetree(ac, &tmp_data, ads, (ID *)tex, tex->nodetree, filter_mode);
1489                         }
1490                 }
1491                 END_ANIMFILTER_SUBCHANNELS;
1492                 
1493                 /* did we find anything? */
1494                 if (tmp_items) {
1495                         /* include texture-expand widget? */
1496                         if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1497                                 /* check if filtering by active status */
1498                                 if ANIMCHANNEL_ACTIVEOK(tex) {
1499                                         ANIMCHANNEL_NEW_CHANNEL(tex, ANIMTYPE_DSTEX, owner_id);
1500                                 }
1501                         }
1502                         
1503                         /* now add the list of collected channels */
1504                         BLI_movelisttolist(anim_data, &tmp_data);
1505                         BLI_assert((tmp_data.first == tmp_data.last) && (tmp_data.first == NULL));
1506                         items += tmp_items;
1507                 }
1508         }
1509         
1510         /* return the number of items added to the list */
1511         return items;
1512 }
1513
1514 static size_t animdata_filter_ds_materials (bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Object *ob, int filter_mode)
1515 {
1516         size_t items=0;
1517         int a=0;
1518         
1519         /* firstly check that we actuallly have some materials, by gathering all materials in a temp list */
1520         for (a=1; a <= ob->totcol; a++) {
1521                 Material *ma= give_current_material(ob, a);
1522                 ListBase tmp_data = {NULL, NULL};
1523                 size_t tmp_items = 0;
1524                 
1525                 /* if no material returned, skip - so that we don't get weird blank entries... */
1526                 if (ma == NULL) continue;
1527                 
1528                 /* add material's animation data to temp collection */
1529                 BEGIN_ANIMFILTER_SUBCHANNELS(FILTER_MAT_OBJD(ma))
1530                 {
1531                         /* material's animation data */
1532                         tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)ma, filter_mode);
1533                                 
1534                         /* textures */
1535                         if (!(ads->filterflag & ADS_FILTER_NOTEX))
1536                                 tmp_items += animdata_filter_ds_textures(ac, &tmp_data, ads, (ID *)ma, filter_mode);
1537                                 
1538                         /* nodes */
1539                         if ((ma->nodetree) && !(ads->filterflag & ADS_FILTER_NONTREE)) 
1540                                 tmp_items += animdata_filter_ds_nodetree(ac, &tmp_data, ads, (ID *)ma, ma->nodetree, filter_mode);
1541                 }
1542                 END_ANIMFILTER_SUBCHANNELS;
1543                 
1544                 /* did we find anything? */
1545                 if (tmp_items) {
1546                         /* include material-expand widget first */
1547                         // hmm... do we need to store the index of this material in the array anywhere?
1548                         if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1549                                 /* check if filtering by active status */
1550                                 if ANIMCHANNEL_ACTIVEOK(ma) {
1551                                         ANIMCHANNEL_NEW_CHANNEL(ma, ANIMTYPE_DSMAT, ma);
1552                                 }
1553                         }
1554                         
1555                         /* now add the list of collected channels */
1556                         BLI_movelisttolist(anim_data, &tmp_data);
1557                         BLI_assert((tmp_data.first == tmp_data.last) && (tmp_data.first == NULL));
1558                         items += tmp_items;
1559                 }
1560         }
1561         
1562         /* return the number of items added to the list */
1563         return items;
1564 }
1565
1566 static size_t animdata_filter_ds_particles (bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Object *ob, int filter_mode)
1567 {
1568         ParticleSystem *psys;
1569         size_t items= 0;
1570
1571         for (psys = ob->particlesystem.first; psys; psys=psys->next) {
1572                 ListBase tmp_data = {NULL, NULL};
1573                 size_t tmp_items = 0;
1574                 
1575                 /* if no material returned, skip - so that we don't get weird blank entries... */
1576                 if (ELEM(NULL, psys->part, psys->part->adt))
1577                         continue;
1578                 
1579                 /* add particle-system's animation data to temp collection */
1580                 BEGIN_ANIMFILTER_SUBCHANNELS(FILTER_PART_OBJD(psys->part))
1581                 {
1582                         /* material's animation data */
1583                         tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)psys->part, filter_mode);
1584                 }
1585                 END_ANIMFILTER_SUBCHANNELS;
1586                 
1587                 /* did we find anything? */
1588                 if (tmp_items) {
1589                         /* include particle-expand widget first */
1590                         if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1591                                 /* check if filtering by active status */
1592                                 if ANIMCHANNEL_ACTIVEOK(psys->part) {
1593                                         ANIMCHANNEL_NEW_CHANNEL(psys->part, ANIMTYPE_DSPART, psys->part);
1594                                 }
1595                         }
1596                         
1597                         /* now add the list of collected channels */
1598                         BLI_movelisttolist(anim_data, &tmp_data);
1599                         BLI_assert((tmp_data.first == tmp_data.last) && (tmp_data.first == NULL));
1600                         items += tmp_items;
1601                 }
1602         }
1603         
1604         /* return the number of items added to the list */
1605         return items;
1606 }
1607
1608 static size_t animdata_filter_ds_obdata (bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Object *ob, int filter_mode)
1609 {
1610         ListBase tmp_data = {NULL, NULL};
1611         size_t tmp_items = 0;
1612         size_t items= 0;
1613         
1614         IdAdtTemplate *iat= ob->data;
1615         short type=0, expanded=0;
1616         
1617         /* get settings based on data type */
1618         switch (ob->type) {
1619                 case OB_CAMERA: /* ------- Camera ------------ */
1620                 {
1621                         Camera *ca= (Camera *)ob->data;
1622                         
1623                         if (ads->filterflag & ADS_FILTER_NOCAM)
1624                                 return 0;
1625                         
1626                         type= ANIMTYPE_DSCAM;
1627                         expanded= FILTER_CAM_OBJD(ca);
1628                 }
1629                         break;
1630                 case OB_LAMP: /* ---------- Lamp ----------- */
1631                 {
1632                         Lamp *la= (Lamp *)ob->data;
1633                         
1634                         if (ads->filterflag & ADS_FILTER_NOLAM)
1635                                 return 0;
1636                         
1637                         type= ANIMTYPE_DSLAM;
1638                         expanded= FILTER_LAM_OBJD(la);
1639                 }
1640                         break;
1641                 case OB_CURVE: /* ------- Curve ---------- */
1642                 case OB_SURF: /* ------- Nurbs Surface ---------- */
1643                 case OB_FONT: /* ------- Text Curve ---------- */
1644                 {
1645                         Curve *cu= (Curve *)ob->data;
1646                         
1647                         if (ads->filterflag & ADS_FILTER_NOCUR)
1648                                 return 0;
1649                         
1650                         type= ANIMTYPE_DSCUR;
1651                         expanded= FILTER_CUR_OBJD(cu);
1652                 }
1653                         break;
1654                 case OB_MBALL: /* ------- MetaBall ---------- */
1655                 {
1656                         MetaBall *mb= (MetaBall *)ob->data;
1657                         
1658                         if (ads->filterflag & ADS_FILTER_NOMBA)
1659                                 return 0;
1660                         
1661                         type= ANIMTYPE_DSMBALL;
1662                         expanded= FILTER_MBALL_OBJD(mb);
1663                 }
1664                         break;
1665                 case OB_ARMATURE: /* ------- Armature ---------- */
1666                 {
1667                         bArmature *arm= (bArmature *)ob->data;
1668                         
1669                         if (ads->filterflag & ADS_FILTER_NOARM)
1670                                 return 0;
1671                         
1672                         type= ANIMTYPE_DSARM;
1673                         expanded= FILTER_ARM_OBJD(arm);
1674                 }
1675                         break;
1676                 case OB_MESH: /* ------- Mesh ---------- */
1677                 {
1678                         Mesh *me= (Mesh *)ob->data;
1679                         
1680                         if (ads->filterflag & ADS_FILTER_NOMESH)
1681                                 return 0;
1682                         
1683                         type= ANIMTYPE_DSMESH;
1684                         expanded= FILTER_MESH_OBJD(me);
1685                 }
1686                         break;
1687                 case OB_LATTICE: /* ---- Lattice ---- */
1688                 {
1689                         Lattice *lt = (Lattice *)ob->data;
1690                         
1691                         if (ads->filterflag & ADS_FILTER_NOLAT)
1692                                 return 0;
1693                         
1694                         type= ANIMTYPE_DSLAT;
1695                         expanded= FILTER_LATTICE_OBJD(lt);
1696                 }
1697                         break;
1698                 case OB_SPEAKER: /* ---------- Speaker ----------- */
1699                 {
1700                         Speaker *spk= (Speaker *)ob->data;
1701                         
1702                         type= ANIMTYPE_DSSPK;
1703                         expanded= FILTER_SPK_OBJD(spk);
1704                 }
1705                         break;
1706         }
1707         
1708         /* add object data animation channels */
1709         BEGIN_ANIMFILTER_SUBCHANNELS(expanded)
1710         {
1711                 /* animation data filtering */
1712                 tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)iat, filter_mode);
1713                 
1714                 /* sub-data filtering... */
1715                 switch (ob->type) {
1716                         case OB_LAMP:   /* lamp - textures */
1717                         {
1718                                 /* textures */
1719                                 if (!(ads->filterflag & ADS_FILTER_NOTEX))
1720                                         tmp_items += animdata_filter_ds_textures(ac, &tmp_data, ads, ob->data, filter_mode);
1721                         }
1722                                 break;
1723                 }
1724         }
1725         END_ANIMFILTER_SUBCHANNELS;
1726         
1727         /* did we find anything? */
1728         if (tmp_items) {
1729                 /* include data-expand widget first */
1730                 if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1731                         /* check if filtering by active status */
1732                         if ANIMCHANNEL_ACTIVEOK(iat) {
1733                                 ANIMCHANNEL_NEW_CHANNEL(iat, type, iat);
1734                         }
1735                 }
1736                 
1737                 /* now add the list of collected channels */
1738                 BLI_movelisttolist(anim_data, &tmp_data);
1739                 BLI_assert((tmp_data.first == tmp_data.last) && (tmp_data.first == NULL));
1740                 items += tmp_items;
1741         }
1742         
1743         /* return the number of items added to the list */
1744         return items;
1745 }
1746
1747 /* shapekey-level animation */
1748 static size_t animdata_filter_ds_keyanim (bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Object *ob, Key *key, int filter_mode)
1749 {
1750         ListBase tmp_data = {NULL, NULL};
1751         size_t tmp_items = 0;
1752         size_t items = 0;
1753         
1754         /* add shapekey-level animation channels */
1755         BEGIN_ANIMFILTER_SUBCHANNELS(FILTER_SKE_OBJD(key))
1756         {
1757                 /* animation data filtering */
1758                 tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)key, filter_mode);
1759         }
1760         END_ANIMFILTER_SUBCHANNELS;
1761         
1762         /* did we find anything? */
1763         if (tmp_items) {
1764                 /* include key-expand widget first */
1765                 if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1766                         if ANIMCHANNEL_ACTIVEOK(key) {
1767                                 ANIMCHANNEL_NEW_CHANNEL(key, ANIMTYPE_DSSKEY, ob);
1768                         }
1769                 }
1770                 
1771                 /* now add the list of collected channels */
1772                 BLI_movelisttolist(anim_data, &tmp_data);
1773                 BLI_assert((tmp_data.first == tmp_data.last) && (tmp_data.first == NULL));
1774                 items += tmp_items;
1775         }
1776         
1777         /* return the number of items added to the list */
1778         return items;
1779 }
1780
1781 /* object-level animation */
1782 static size_t animdata_filter_ds_obanim (bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Object *ob, int filter_mode)
1783 {
1784         ListBase tmp_data = {NULL, NULL};
1785         size_t tmp_items = 0;
1786         size_t items = 0;
1787         
1788         AnimData *adt = ob->adt;
1789         short type=0, expanded=1;
1790         void *cdata = NULL;
1791         
1792         /* determine the type of expander channels to use */
1793         // this is the best way to do this for now...
1794         ANIMDATA_FILTER_CASES(ob,
1795                 {/* AnimData - no channel, but consider data */},
1796                 {/* NLA - no channel, but consider data */},
1797                 {/* Drivers */
1798                         type = ANIMTYPE_FILLDRIVERS;
1799                         cdata = adt;
1800                         expanded = EXPANDED_DRVD(adt);
1801                 },
1802                 {/* Keyframes */
1803                         type = ANIMTYPE_FILLACTD;
1804                         cdata = adt->action;
1805                         expanded = EXPANDED_ACTC(adt->action);
1806                 });
1807                 
1808         /* add object-level animation channels */
1809         BEGIN_ANIMFILTER_SUBCHANNELS(expanded)
1810         {
1811                 /* animation data filtering */
1812                 tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)ob, filter_mode);
1813         }
1814         END_ANIMFILTER_SUBCHANNELS;
1815         
1816         /* did we find anything? */
1817         if (tmp_items) {
1818                 /* include anim-expand widget first */
1819                 if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1820                         if (type != ANIMTYPE_NONE) {
1821                                 /* NOTE: active-status (and the associated checks) don't apply here... */
1822                                 ANIMCHANNEL_NEW_CHANNEL(cdata, type, ob);
1823                         }
1824                 }
1825                 
1826                 /* now add the list of collected channels */
1827                 BLI_movelisttolist(anim_data, &tmp_data);
1828                 BLI_assert((tmp_data.first == tmp_data.last) && (tmp_data.first == NULL));
1829                 items += tmp_items;
1830         }
1831         
1832         /* return the number of items added to the list */
1833         return items;
1834 }
1835
1836 /* get animation channels from object2 */
1837 static size_t animdata_filter_dopesheet_ob (bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Base *base, int filter_mode)
1838 {
1839         ListBase tmp_data = {NULL, NULL};
1840         Object *ob= base->object;
1841         size_t tmp_items = 0;
1842         size_t items = 0;
1843         
1844         /* filter data contained under object first */
1845         BEGIN_ANIMFILTER_SUBCHANNELS(EXPANDED_OBJC(ob))
1846         {
1847                 Key *key= ob_get_key(ob);
1848                 
1849                 /* object-level animation */
1850                 if ((ob->adt) && !(ads->filterflag & ADS_FILTER_NOOBJ)) {
1851                         tmp_items += animdata_filter_ds_obanim(ac, &tmp_data, ads, ob, filter_mode);
1852                 }
1853                 
1854                 /* shape-key */
1855                 if ((key && key->adt) && !(ads->filterflag & ADS_FILTER_NOSHAPEKEYS)) {
1856                         tmp_items += animdata_filter_ds_keyanim(ac, &tmp_data, ads, ob, key, filter_mode);
1857                 }
1858                 
1859                 /* materials */
1860                 if ((ob->totcol) && !(ads->filterflag & ADS_FILTER_NOMAT)) {
1861                         tmp_items += animdata_filter_ds_materials(ac, &tmp_data, ads, ob, filter_mode);
1862                 }
1863                 
1864                 /* object data */
1865                 if (ob->data) {
1866                         tmp_items += animdata_filter_ds_obdata(ac, &tmp_data, ads, ob, filter_mode);
1867                 }
1868                 
1869                 /* particles */
1870                 if ((ob->particlesystem.first) && !(ads->filterflag & ADS_FILTER_NOPART)) {
1871                         tmp_items += animdata_filter_ds_particles(ac, &tmp_data, ads, ob, filter_mode);
1872                 }
1873         }
1874         END_ANIMFILTER_SUBCHANNELS;
1875         
1876         
1877         /* if we collected some channels, add these to the new list... */
1878         if (tmp_items) {
1879                 /* firstly add object expander if required */
1880                 if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1881                         /* check if filtering by selection */
1882                         // XXX: double-check on this - most of the time, a lot of tools need to filter out these channels!
1883                         if ANIMCHANNEL_SELOK((base->flag & SELECT)) {
1884                                 /* check if filtering by active status */
1885                                 if (ANIMCHANNEL_ACTIVEOK(ob)) {
1886                                         ANIMCHANNEL_NEW_CHANNEL(base, ANIMTYPE_OBJECT, ob);
1887                                 }
1888                         }
1889                 }
1890                 
1891                 /* now add the list of collected channels */
1892                 BLI_movelisttolist(anim_data, &tmp_data);
1893                 BLI_assert((tmp_data.first == tmp_data.last) && (tmp_data.first == NULL));
1894                 items += tmp_items;
1895         }
1896         
1897         /* return the number of items added */
1898         return items;
1899 }
1900
1901 static size_t animdata_filter_ds_world (bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Scene *sce, World *wo, int filter_mode)
1902 {
1903         ListBase tmp_data = {NULL, NULL};
1904         size_t tmp_items = 0;
1905         size_t items = 0;
1906         
1907         /* add world animation channels */
1908         BEGIN_ANIMFILTER_SUBCHANNELS(FILTER_WOR_SCED(wo))
1909         {
1910                 /* animation data filtering */
1911                 tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)wo, filter_mode);
1912                 
1913                 /* textures for world */
1914                 if (!(ads->filterflag & ADS_FILTER_NOTEX))
1915                         items += animdata_filter_ds_textures(ac, &tmp_data, ads, (ID *)wo, filter_mode);
1916         }
1917         END_ANIMFILTER_SUBCHANNELS;
1918         
1919         /* did we find anything? */
1920         if (tmp_items) {
1921                 /* include data-expand widget first */
1922                 if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1923                         /* check if filtering by active status */
1924                         if ANIMCHANNEL_ACTIVEOK(wo) {
1925                                 ANIMCHANNEL_NEW_CHANNEL(wo, ANIMTYPE_DSWOR, sce);
1926                         }
1927                 }
1928                 
1929                 /* now add the list of collected channels */
1930                 BLI_movelisttolist(anim_data, &tmp_data);
1931                 BLI_assert((tmp_data.first == tmp_data.last) && (tmp_data.first == NULL));
1932                 items += tmp_items;
1933         }
1934         
1935         /* return the number of items added to the list */
1936         return items;
1937 }
1938
1939 static size_t animdata_filter_ds_scene (bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Scene *sce, int filter_mode)
1940 {
1941         ListBase tmp_data = {NULL, NULL};
1942         size_t tmp_items = 0;
1943         size_t items = 0;
1944         
1945         AnimData *adt = sce->adt;
1946         short type=0, expanded=1;
1947         void *cdata = NULL;
1948         
1949         /* determine the type of expander channels to use */
1950         // this is the best way to do this for now...
1951         ANIMDATA_FILTER_CASES(sce,
1952                 {/* AnimData - no channel, but consider data */},
1953                 {/* NLA - no channel, but consider data */},
1954                 {/* Drivers */
1955                         type = ANIMTYPE_FILLDRIVERS;
1956                         cdata = adt;
1957                         expanded = EXPANDED_DRVD(adt);
1958                 },
1959                 {/* Keyframes */
1960                         type = ANIMTYPE_FILLACTD;
1961                         cdata = adt->action;
1962                         expanded = EXPANDED_ACTC(adt->action);
1963                 });
1964                 
1965         /* add scene-level animation channels */
1966         BEGIN_ANIMFILTER_SUBCHANNELS(expanded)
1967         {
1968                 /* animation data filtering */
1969                 tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)sce, filter_mode);
1970         }
1971         END_ANIMFILTER_SUBCHANNELS;
1972         
1973         /* did we find anything? */
1974         if (tmp_items) {
1975                 /* include anim-expand widget first */
1976                 if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1977                         if (type != ANIMTYPE_NONE) {
1978                                 /* NOTE: active-status (and the associated checks) don't apply here... */
1979                                 ANIMCHANNEL_NEW_CHANNEL(cdata, type, sce);
1980                         }
1981                 }
1982                 
1983                 /* now add the list of collected channels */
1984                 BLI_movelisttolist(anim_data, &tmp_data);
1985                 BLI_assert((tmp_data.first == tmp_data.last) && (tmp_data.first == NULL));
1986                 items += tmp_items;
1987         }
1988         
1989         /* return the number of items added to the list */
1990         return items;
1991 }
1992
1993 static size_t animdata_filter_dopesheet_scene (bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Scene *sce, int filter_mode)
1994 {
1995         ListBase tmp_data = {NULL, NULL};
1996         size_t tmp_items = 0;
1997         size_t items = 0;
1998         
1999         /* filter data contained under object first */
2000         BEGIN_ANIMFILTER_SUBCHANNELS(EXPANDED_SCEC(sce))
2001         {
2002                 bNodeTree *ntree= sce->nodetree;
2003                 World *wo= sce->world;
2004                 
2005                 /* Action, Drivers, or NLA for Scene */
2006                 if ((ads->filterflag & ADS_FILTER_NOSCE) == 0) {
2007                         tmp_items += animdata_filter_ds_scene(ac, &tmp_data, ads, sce, filter_mode);
2008                 }
2009                 
2010                 /* world */
2011                 if ((wo && wo->adt) && !(ads->filterflag & ADS_FILTER_NOWOR)) {
2012                         tmp_items += animdata_filter_ds_world(ac, &tmp_data, ads, sce, wo, filter_mode);
2013                 }
2014                 
2015                 /* nodetree */
2016                 if ((ntree && ntree->adt) && !(ads->filterflag & ADS_FILTER_NONTREE)) {
2017                         tmp_items += animdata_filter_ds_nodetree(ac, &tmp_data, ads, (ID *)sce, ntree, filter_mode);
2018                 }
2019
2020                 /* line styles */
2021                 if ((ads->filterflag & ADS_FILTER_NOLINESTYLE) == 0) {
2022                         tmp_items += animdata_filter_ds_linestyle(ac, &tmp_data, ads, sce, filter_mode);
2023                 }
2024                 
2025                 // TODO: one day, when sequencer becomes its own datatype, perhaps it should be included here
2026         }
2027         END_ANIMFILTER_SUBCHANNELS;
2028         
2029         /* if we collected some channels, add these to the new list... */
2030         if (tmp_items) {
2031                 /* firstly add object expander if required */
2032                 if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
2033                         /* check if filtering by selection */
2034                         if ANIMCHANNEL_SELOK((sce->flag & SCE_DS_SELECTED)) {
2035                                 /* NOTE: active-status doesn't matter for this! */
2036                                 ANIMCHANNEL_NEW_CHANNEL(sce, ANIMTYPE_SCENE, sce);
2037                         }
2038                 }
2039                 
2040                 /* now add the list of collected channels */
2041                 BLI_movelisttolist(anim_data, &tmp_data);
2042                 BLI_assert((tmp_data.first == tmp_data.last) && (tmp_data.first == NULL));
2043                 items += tmp_items;
2044         }
2045         
2046         /* return the number of items added */
2047         return items;
2048 }
2049
2050 // TODO: implement pinning... (if and when pinning is done, what we need to do is to provide freeing mechanisms - to protect against data that was deleted)
2051 static size_t animdata_filter_dopesheet (bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, int filter_mode)
2052 {
2053         Scene *sce= (Scene *)ads->source;
2054         Base *base;
2055         size_t items = 0;
2056         
2057         /* check that we do indeed have a scene */
2058         if ((ads->source == NULL) || (GS(ads->source->name)!=ID_SCE)) {
2059                 printf("DopeSheet Error: Not scene!\n");
2060                 if (G.f & G_DEBUG)
2061                         printf("\tPointer = %p, Name = '%s' \n", (void *)ads->source, (ads->source)?ads->source->name:NULL);
2062                 return 0;
2063         }
2064         
2065         /* augment the filter-flags with settings based on the dopesheet filterflags 
2066          * so that some temp settings can get added automagically...
2067          */
2068         if (ads->filterflag & ADS_FILTER_SELEDIT) {
2069                 /* only selected F-Curves should get their keyframes considered for editability */
2070                 filter_mode |= ANIMFILTER_SELEDIT;
2071         }
2072         
2073         /* scene-linked animation - e.g. world, compositing nodes, scene anim (including sequencer currently) */
2074         items += animdata_filter_dopesheet_scene(ac, anim_data, ads, sce, filter_mode);
2075         
2076         /* loop over all bases (i.e.objects) in the scene */
2077         for (base= sce->base.first; base; base= base->next) {
2078                 /* check if there's an object (all the relevant checks are done in the ob-function) */
2079                 if (base->object) {
2080                         Object *ob= base->object;
2081                         
2082                         /* firstly, check if object can be included, by the following factors:
2083                          *      - if only visible, must check for layer and also viewport visibility
2084                          *              --> while tools may demand only visible, user setting takes priority
2085                          *                      as user option controls whether sets of channels get included while
2086                          *                      tool-flag takes into account collapsed/open channels too
2087                          *      - if only selected, must check if object is selected 
2088                          *      - there must be animation data to edit (this is done recursively as we 
2089                          *        try to add the channels)
2090                          */
2091                         if ((filter_mode & ANIMFILTER_DATA_VISIBLE) && !(ads->filterflag & ADS_FILTER_INCL_HIDDEN)) {
2092                                 /* layer visibility - we check both object and base, since these may not be in sync yet */
2093                                 if ((sce->lay & (ob->lay|base->lay))==0) continue;
2094                                 
2095                                 /* outliner restrict-flag */
2096                                 if (ob->restrictflag & OB_RESTRICT_VIEW) continue;
2097                         }
2098                         
2099                         /* if only F-Curves with visible flags set can be shown, check that 
2100                          * datablock hasn't been set to invisible 
2101                          */
2102                         if (filter_mode & ANIMFILTER_CURVE_VISIBLE) {
2103                                 if ((ob->adt) && (ob->adt->flag & ADT_CURVES_NOT_VISIBLE))
2104                                         continue;
2105                         }
2106                         
2107                         /* check selection and object type filters */
2108                         if ( (ads->filterflag & ADS_FILTER_ONLYSEL) && !((base->flag & SELECT) /*|| (base == sce->basact)*/) )  {
2109                                 /* only selected should be shown */
2110                                 continue;
2111                         }
2112                         
2113                         /* check if object belongs to the filtering group if option to filter 
2114                          * objects by the grouped status is on
2115                          *      - used to ease the process of doing multiple-character choreographies
2116                          */
2117                         if (ads->filterflag & ADS_FILTER_ONLYOBGROUP) {
2118                                 if (object_in_group(ob, ads->filter_grp) == 0)
2119                                         continue;
2120                         }
2121                                 
2122                         /* since we're still here, this object should be usable */
2123                         items += animdata_filter_dopesheet_ob(ac, anim_data, ads, base, filter_mode);
2124                 }
2125         }
2126         
2127         /* return the number of items in the list */
2128         return items;
2129 }
2130
2131 /* Summary track for DopeSheet/Action Editor 
2132  *      - return code is whether the summary lets the other channels get drawn
2133  */
2134 static short animdata_filter_dopesheet_summary (bAnimContext *ac, ListBase *anim_data, int filter_mode, size_t *items)
2135 {
2136         bDopeSheet *ads = NULL;
2137         
2138         /* get the DopeSheet information to use 
2139          *      - we should only need to deal with the DopeSheet/Action Editor, 
2140          *        since all the other Animation Editors won't have this concept
2141          *        being applicable.
2142          */
2143         if ((ac && ac->sl) && (ac->spacetype == SPACE_ACTION)) {
2144                 SpaceAction *saction= (SpaceAction *)ac->sl;
2145                 ads= &saction->ads;
2146         }
2147         else {
2148                 /* invalid space type - skip this summary channels */
2149                 return 1;
2150         }
2151         
2152         /* dopesheet summary 
2153          *      - only for drawing and/or selecting keyframes in channels, but not for real editing 
2154          *      - only useful for DopeSheet/Action/etc. editors where it is actually useful
2155          */
2156         if ((filter_mode & ANIMFILTER_LIST_CHANNELS) && (ads->filterflag & ADS_FILTER_SUMMARY)) {
2157                 bAnimListElem *ale= make_new_animlistelem(ac, ANIMTYPE_SUMMARY, NULL);
2158                 if (ale) {
2159                         BLI_addtail(anim_data, ale);
2160                         (*items)++;
2161                 }
2162                 
2163                 /* if summary is collapsed, don't show other channels beneath this 
2164                  *      - this check is put inside the summary check so that it doesn't interfere with normal operation
2165                  */ 
2166                 if (ads->flag & ADS_FLAG_SUMMARY_COLLAPSED)
2167                         return 0;
2168         }
2169         
2170         /* the other channels beneath this can be shown */
2171         return 1;
2172 }  
2173
2174 /* ......................... */
2175
2176 /* filter data associated with a channel - usually for handling summary-channels in DopeSheet */
2177 static size_t animdata_filter_animchan (bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, bAnimListElem *channel, int filter_mode)
2178 {
2179         size_t items = 0;
2180         
2181         /* data to filter depends on channel type */
2182         // XXX: only common channel-types have been handled for now
2183         switch (channel->type) {
2184                 case ANIMTYPE_SUMMARY:
2185                         items += animdata_filter_dopesheet(ac, anim_data, ads, filter_mode);
2186                         break;
2187                         
2188                 case ANIMTYPE_SCENE:
2189                         items += animdata_filter_dopesheet_scene(ac, anim_data, ads, channel->data, filter_mode);
2190                         break;
2191                 
2192                 case ANIMTYPE_OBJECT:
2193                         items += animdata_filter_dopesheet_ob(ac, anim_data, ads, channel->data, filter_mode);
2194                         break;
2195         }
2196         
2197         return items;
2198 }
2199
2200 /* ----------- Cleanup API --------------- */
2201
2202 /* Remove entries with invalid types in animation channel list */
2203 static size_t animdata_filter_remove_invalid (ListBase *anim_data)
2204 {
2205         bAnimListElem *ale, *next;
2206         size_t items = 0;
2207         
2208         /* only keep entries with valid types */
2209         for (ale= anim_data->first; ale; ale= next) {
2210                 next= ale->next;
2211                 
2212                 if (ale->type == ANIMTYPE_NONE)
2213                         BLI_freelinkN(anim_data, ale);
2214                 else
2215                         items++;
2216         }
2217         
2218         return items;
2219 }
2220
2221 /* Remove duplicate entries in animation channel list */
2222 static size_t animdata_filter_remove_duplis (ListBase *anim_data)
2223 {
2224         bAnimListElem *ale, *next;
2225         GHash *gh;
2226         size_t items = 0;
2227         
2228         /* build new hashtable to efficiently store and retrieve which entries have been 
2229          * encountered already while searching
2230          */
2231         gh= BLI_ghash_new(BLI_ghashutil_ptrhash, BLI_ghashutil_ptrcmp, "animdata_filter_duplis_remove gh");
2232         
2233         /* loop through items, removing them from the list if a similar item occurs already */
2234         for (ale = anim_data->first; ale; ale = next) {
2235                 next = ale->next;
2236                 
2237                 /* check if hash has any record of an entry like this 
2238                  *      - just use ale->data for now, though it would be nicer to involve 
2239                  *        ale->type in combination too to capture corner cases (where same data performs differently)
2240                  */
2241                 if (BLI_ghash_haskey(gh, ale->data) == 0) {
2242                         /* this entry is 'unique' and can be kept */
2243                         BLI_ghash_insert(gh, ale->data, NULL);
2244                         items++;
2245                 }
2246                 else {
2247                         /* this entry isn't needed anymore */
2248                         BLI_freelinkN(anim_data, ale);
2249                 }
2250         }
2251         
2252         /* free the hash... */
2253         BLI_ghash_free(gh, NULL, NULL);
2254         
2255         /* return the number of items still in the list */
2256         return items;
2257 }
2258
2259 /* ----------- Public API --------------- */
2260
2261 /* This function filters the active data source to leave only animation channels suitable for
2262  * usage by the caller. It will return the length of the list 
2263  * 
2264  *      *anim_data: is a pointer to a ListBase, to which the filtered animation channels
2265  *              will be placed for use.
2266  *      filter_mode: how should the data be filtered - bitmapping accessed flags
2267  */
2268 size_t ANIM_animdata_filter (bAnimContext *ac, ListBase *anim_data, int filter_mode, void *data, short datatype)
2269 {
2270         size_t items = 0;
2271         
2272         /* only filter data if there's somewhere to put it */
2273         if (data && anim_data) {
2274                 Object *obact= (ac) ? ac->obact : NULL;
2275                 
2276                 /* firstly filter the data */
2277                 switch (datatype) {
2278                         case ANIMCONT_ACTION:   /* 'Action Editor' */
2279                         {
2280                                 SpaceAction *saction = (SpaceAction *)ac->sl;
2281                                 bDopeSheet *ads = (saction)? &saction->ads : NULL;
2282                                 
2283                                 /* the check for the DopeSheet summary is included here since the summary works here too */
2284                                 if (animdata_filter_dopesheet_summary(ac, anim_data, filter_mode, &items))
2285                                         items += animfilter_action(ac, anim_data, ads, data, filter_mode, (ID *)obact);
2286                         }
2287                                 break;
2288                                 
2289                         case ANIMCONT_SHAPEKEY: /* 'ShapeKey Editor' */
2290                         {
2291                                 /* the check for the DopeSheet summary is included here since the summary works here too */
2292                                 if (animdata_filter_dopesheet_summary(ac, anim_data, filter_mode, &items))
2293                                         items= animdata_filter_shapekey(ac, anim_data, data, filter_mode);
2294                         }
2295                                 break;
2296                                 
2297                         case ANIMCONT_GPENCIL:
2298                         {
2299                                 items= animdata_filter_gpencil(anim_data, data, filter_mode);
2300                         }
2301                                 break;
2302                                 
2303                         case ANIMCONT_DOPESHEET: /* 'DopeSheet Editor' */
2304                         {
2305                                 /* the DopeSheet editor is the primary place where the DopeSheet summaries are useful */
2306                                 if (animdata_filter_dopesheet_summary(ac, anim_data, filter_mode, &items))
2307                                         items += animdata_filter_dopesheet(ac, anim_data, data, filter_mode);
2308                         }
2309                                 break;
2310                                 
2311                         case ANIMCONT_FCURVES: /* Graph Editor -> FCurves/Animation Editing */
2312                         case ANIMCONT_DRIVERS: /* Graph Editor -> Drivers Editing */
2313                         case ANIMCONT_NLA: /* NLA Editor */
2314                         {
2315                                 /* all of these editors use the basic DopeSheet data for filtering options, but don't have all the same features */
2316                                 items = animdata_filter_dopesheet(ac, anim_data, data, filter_mode);
2317                         }
2318                                 break;
2319                         
2320                         case ANIMCONT_CHANNEL: /* animation channel */
2321                         {
2322                                 bDopeSheet *ads = ac->ads;
2323                                 
2324                                 /* based on the channel type, filter relevant data for this */
2325                                 items = animdata_filter_animchan(ac, anim_data, ads, data, filter_mode);
2326                         }
2327                                 break;
2328                 }
2329                         
2330                 /* remove any 'weedy' entries */
2331                 items = animdata_filter_remove_invalid(anim_data);
2332                 
2333                 /* remove duplicates (if required) */
2334                 if (filter_mode & ANIMFILTER_NODUPLIS)
2335                         items = animdata_filter_remove_duplis(anim_data);
2336         }
2337         
2338         /* return the number of items in the list */
2339         return items;
2340 }
2341
2342 /* ************************************************************ */