bb0db9cf8a1f931403eaa13bdc667da7da7ce77d
[blender.git] / source / blender / editors / animation / anim_filter.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2008 Blender Foundation, Joshua Leung
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup edanimation
22  */
23
24 /* This file contains a system used to provide a layer of abstraction between sources
25  * of animation data and tools in Animation Editors. The method used here involves
26  * generating a list of edit structures which enable tools to naively perform the actions
27  * they require without all the boiler-plate associated with loops within loops and checking
28  * for cases to ignore.
29  *
30  * While this is primarily used for the Action/Dopesheet Editor (and its accessory modes),
31  * the Graph Editor also uses this for its channel list and for determining which curves
32  * are being edited. Likewise, the NLA Editor also uses this for its channel list and in
33  * its operators.
34  *
35  * Note: much of the original system this was based on was built before the creation of the RNA
36  * system. In future, it would be interesting to replace some parts of this code with RNA queries,
37  * however, RNA does not eliminate some of the boiler-plate reduction benefits presented by this
38  * system, so if any such work does occur, it should only be used for the internals used here...
39  *
40  * -- Joshua Leung, Dec 2008 (Last revision July 2009)
41  */
42
43 #include <string.h>
44
45 #include "DNA_anim_types.h"
46 #include "DNA_armature_types.h"
47 #include "DNA_camera_types.h"
48 #include "DNA_cachefile_types.h"
49 #include "DNA_light_types.h"
50 #include "DNA_lattice_types.h"
51 #include "DNA_linestyle_types.h"
52 #include "DNA_key_types.h"
53 #include "DNA_mask_types.h"
54 #include "DNA_material_types.h"
55 #include "DNA_mesh_types.h"
56 #include "DNA_meta_types.h"
57 #include "DNA_movieclip_types.h"
58 #include "DNA_node_types.h"
59 #include "DNA_particle_types.h"
60 #include "DNA_space_types.h"
61 #include "DNA_sequence_types.h"
62 #include "DNA_scene_types.h"
63 #include "DNA_screen_types.h"
64 #include "DNA_speaker_types.h"
65 #include "DNA_world_types.h"
66 #include "DNA_gpencil_types.h"
67 #include "DNA_brush_types.h"
68 #include "DNA_object_types.h"
69 #include "DNA_userdef_types.h"
70 #include "DNA_layer_types.h"
71
72 #include "MEM_guardedalloc.h"
73
74 #include "BLI_blenlib.h"
75 #include "BLI_utildefines.h"
76 #include "BLI_alloca.h"
77 #include "BLI_ghash.h"
78 #include "BLI_string.h"
79
80 #include "BKE_action.h"
81 #include "BKE_animsys.h"
82 #include "BKE_collection.h"
83 #include "BKE_context.h"
84 #include "BKE_fcurve.h"
85 #include "BKE_global.h"
86 #include "BKE_key.h"
87 #include "BKE_layer.h"
88 #include "BKE_main.h"
89 #include "BKE_material.h"
90 #include "BKE_modifier.h"
91 #include "BKE_node.h"
92 #include "BKE_mask.h"
93 #include "BKE_sequencer.h"
94
95 #include "ED_anim_api.h"
96 #include "ED_markers.h"
97
98 #include "UI_resources.h" /* for TH_KEYFRAME_SCALE lookup */
99
100 /* ************************************************************ */
101 /* Blender Context <-> Animation Context mapping */
102
103 /* ----------- Private Stuff - General -------------------- */
104
105 /* Get vertical scaling factor (i.e. typically used for keyframe size) */
106 static void animedit_get_yscale_factor(bAnimContext *ac)
107 {
108   bTheme *btheme = UI_GetTheme();
109
110   /* grab scale factor directly from action editor setting
111    * NOTE: This theme setting doesn't have an ID, as it cannot be accessed normally
112    *       since it is a float, and the theme settings methods can only handle chars.
113    */
114   ac->yscale_fac = btheme->space_action.keyframe_scale_fac;
115
116   /* clamp to avoid problems with uninitialised values... */
117   if (ac->yscale_fac < 0.1f)
118     ac->yscale_fac = 1.0f;
119   //printf("yscale_fac = %f\n", ac->yscale_fac);
120 }
121
122 /* ----------- Private Stuff - Action Editor ------------- */
123
124 /* Get shapekey data being edited (for Action Editor -> ShapeKey mode) */
125 /* Note: there's a similar function in key.c (BKE_key_from_object) */
126 static Key *actedit_get_shapekeys(bAnimContext *ac)
127 {
128   ViewLayer *view_layer = ac->view_layer;
129   Object *ob;
130   Key *key;
131
132   ob = OBACT(view_layer);
133   if (ob == NULL)
134     return NULL;
135
136   /* XXX pinning is not available in 'ShapeKey' mode... */
137   //if (saction->pin) return NULL;
138
139   /* shapekey data is stored with geometry data */
140   key = BKE_key_from_object(ob);
141
142   if (key) {
143     if (key->type == KEY_RELATIVE)
144       return key;
145   }
146
147   return NULL;
148 }
149
150 /* Get data being edited in Action Editor (depending on current 'mode') */
151 static bool actedit_get_context(bAnimContext *ac, SpaceAction *saction)
152 {
153   /* get dopesheet */
154   ac->ads = &saction->ads;
155
156   /* sync settings with current view status, then return appropriate data */
157   switch (saction->mode) {
158     case SACTCONT_ACTION: /* 'Action Editor' */
159       /* if not pinned, sync with active object */
160       if (/*saction->pin == 0*/ true) {
161         if (ac->obact && ac->obact->adt)
162           saction->action = ac->obact->adt->action;
163         else
164           saction->action = NULL;
165       }
166
167       ac->datatype = ANIMCONT_ACTION;
168       ac->data = saction->action;
169
170       ac->mode = saction->mode;
171       return true;
172
173     case SACTCONT_SHAPEKEY: /* 'ShapeKey Editor' */
174       ac->datatype = ANIMCONT_SHAPEKEY;
175       ac->data = actedit_get_shapekeys(ac);
176
177       /* if not pinned, sync with active object */
178       if (/*saction->pin == 0*/ true) {
179         Key *key = (Key *)ac->data;
180
181         if (key && key->adt)
182           saction->action = key->adt->action;
183         else
184           saction->action = NULL;
185       }
186
187       ac->mode = saction->mode;
188       return true;
189
190     case SACTCONT_GPENCIL: /* Grease Pencil */ /* XXX review how this mode is handled... */
191       /* update scene-pointer (no need to check for pinning yet, as not implemented) */
192       saction->ads.source = (ID *)ac->scene;
193
194       ac->datatype = ANIMCONT_GPENCIL;
195       ac->data = &saction->ads;
196
197       ac->mode = saction->mode;
198       return true;
199
200     case SACTCONT_CACHEFILE: /* Cache File */ /* XXX review how this mode is handled... */
201       /* update scene-pointer (no need to check for pinning yet, as not implemented) */
202       saction->ads.source = (ID *)ac->scene;
203
204       ac->datatype = ANIMCONT_CHANNEL;
205       ac->data = &saction->ads;
206
207       ac->mode = saction->mode;
208       return true;
209
210     case SACTCONT_MASK: /* Mask */ /* XXX review how this mode is handled... */
211     {
212       /* TODO, other methods to get the mask */
213       // Sequence *seq = BKE_sequencer_active_get(ac->scene);
214       //MovieClip *clip = ac->scene->clip;
215       //          struct Mask *mask = seq ? seq->mask : NULL;
216
217       /* update scene-pointer (no need to check for pinning yet, as not implemented) */
218       saction->ads.source = (ID *)ac->scene;
219
220       ac->datatype = ANIMCONT_MASK;
221       ac->data = &saction->ads;
222
223       ac->mode = saction->mode;
224       return true;
225     }
226
227     case SACTCONT_DOPESHEET: /* DopeSheet */
228       /* update scene-pointer (no need to check for pinning yet, as not implemented) */
229       saction->ads.source = (ID *)ac->scene;
230
231       ac->datatype = ANIMCONT_DOPESHEET;
232       ac->data = &saction->ads;
233
234       ac->mode = saction->mode;
235       return true;
236
237     case SACTCONT_TIMELINE: /* Timeline */
238       /* update scene-pointer (no need to check for pinning yet, as not implemented) */
239       saction->ads.source = (ID *)ac->scene;
240
241       /* sync scene's "selected keys only" flag with our "only selected" flag
242        * XXX: This is a workaround for T55525. We shouldn't really be syncing the flags like this,
243        *      but it's a simpler fix for now than also figuring out how the next/prev keyframe tools
244        *      should work in the 3D View if we allowed full access to the timeline's dopesheet filters
245        *      (i.e. we'd have to figure out where to host those settings, to be on a scene level like
246        *      this flag currently is, along with several other unknowns)
247        */
248       if (ac->scene->flag & SCE_KEYS_NO_SELONLY)
249         saction->ads.filterflag &= ~ADS_FILTER_ONLYSEL;
250       else
251         saction->ads.filterflag |= ADS_FILTER_ONLYSEL;
252
253       ac->datatype = ANIMCONT_TIMELINE;
254       ac->data = &saction->ads;
255
256       ac->mode = saction->mode;
257       return true;
258
259     default: /* unhandled yet */
260       ac->datatype = ANIMCONT_NONE;
261       ac->data = NULL;
262
263       ac->mode = -1;
264       return false;
265   }
266 }
267
268 /* ----------- Private Stuff - Graph Editor ------------- */
269
270 /* Get data being edited in Graph Editor (depending on current 'mode') */
271 static bool graphedit_get_context(bAnimContext *ac, SpaceGraph *sipo)
272 {
273   /* init dopesheet data if non-existent (i.e. for old files) */
274   if (sipo->ads == NULL) {
275     sipo->ads = MEM_callocN(sizeof(bDopeSheet), "GraphEdit DopeSheet");
276     sipo->ads->source = (ID *)ac->scene;
277   }
278   ac->ads = sipo->ads;
279
280   /* set settings for Graph Editor - "Selected = Editable" */
281   if (sipo->flag & SIPO_SELCUVERTSONLY)
282     sipo->ads->filterflag |= ADS_FILTER_SELEDIT;
283   else
284     sipo->ads->filterflag &= ~ADS_FILTER_SELEDIT;
285
286   /* sync settings with current view status, then return appropriate data */
287   switch (sipo->mode) {
288     case SIPO_MODE_ANIMATION: /* Animation F-Curve Editor */
289       /* update scene-pointer (no need to check for pinning yet, as not implemented) */
290       sipo->ads->source = (ID *)ac->scene;
291       sipo->ads->filterflag &= ~ADS_FILTER_ONLYDRIVERS;
292
293       ac->datatype = ANIMCONT_FCURVES;
294       ac->data = sipo->ads;
295
296       ac->mode = sipo->mode;
297       return true;
298
299     case SIPO_MODE_DRIVERS: /* Driver F-Curve Editor */
300       /* update scene-pointer (no need to check for pinning yet, as not implemented) */
301       sipo->ads->source = (ID *)ac->scene;
302       sipo->ads->filterflag |= ADS_FILTER_ONLYDRIVERS;
303
304       ac->datatype = ANIMCONT_DRIVERS;
305       ac->data = sipo->ads;
306
307       ac->mode = sipo->mode;
308       return true;
309
310     default: /* unhandled yet */
311       ac->datatype = ANIMCONT_NONE;
312       ac->data = NULL;
313
314       ac->mode = -1;
315       return false;
316   }
317 }
318
319 /* ----------- Private Stuff - NLA Editor ------------- */
320
321 /* Get data being edited in Graph Editor (depending on current 'mode') */
322 static bool nlaedit_get_context(bAnimContext *ac, SpaceNla *snla)
323 {
324   /* init dopesheet data if non-existent (i.e. for old files) */
325   if (snla->ads == NULL)
326     snla->ads = MEM_callocN(sizeof(bDopeSheet), "NlaEdit DopeSheet");
327   ac->ads = snla->ads;
328
329   /* sync settings with current view status, then return appropriate data */
330   /* update scene-pointer (no need to check for pinning yet, as not implemented) */
331   snla->ads->source = (ID *)ac->scene;
332   snla->ads->filterflag |= ADS_FILTER_ONLYNLA;
333
334   ac->datatype = ANIMCONT_NLA;
335   ac->data = snla->ads;
336
337   return true;
338 }
339
340 /* ----------- Public API --------------- */
341
342 /* Obtain current anim-data context, given that context info from Blender context has already been set
343  * - AnimContext to write to is provided as pointer to var on stack so that we don't have
344  *   allocation/freeing costs (which are not that avoidable with channels).
345  */
346 bool ANIM_animdata_context_getdata(bAnimContext *ac)
347 {
348   SpaceLink *sl = ac->sl;
349   bool ok = false;
350
351   /* context depends on editor we are currently in */
352   if (sl) {
353     switch (ac->spacetype) {
354       case SPACE_ACTION: {
355         SpaceAction *saction = (SpaceAction *)sl;
356         ok = actedit_get_context(ac, saction);
357         break;
358       }
359       case SPACE_GRAPH: {
360         SpaceGraph *sipo = (SpaceGraph *)sl;
361         ok = graphedit_get_context(ac, sipo);
362         break;
363       }
364       case SPACE_NLA: {
365         SpaceNla *snla = (SpaceNla *)sl;
366         ok = nlaedit_get_context(ac, snla);
367         break;
368       }
369     }
370   }
371
372   /* check if there's any valid data */
373   return (ok && ac->data);
374 }
375
376 /* Obtain current anim-data context from Blender Context info
377  * - AnimContext to write to is provided as pointer to var on stack so that we don't have
378  *   allocation/freeing costs (which are not that avoidable with channels).
379  * - Clears data and sets the information from Blender Context which is useful
380  */
381 bool ANIM_animdata_get_context(const bContext *C, bAnimContext *ac)
382 {
383   Main *bmain = CTX_data_main(C);
384   ScrArea *sa = CTX_wm_area(C);
385   ARegion *ar = CTX_wm_region(C);
386   SpaceLink *sl = CTX_wm_space_data(C);
387   Scene *scene = CTX_data_scene(C);
388
389   /* clear old context info */
390   if (ac == NULL)
391     return false;
392   memset(ac, 0, sizeof(bAnimContext));
393
394   /* get useful default context settings from context */
395   ac->bmain = bmain;
396   ac->scene = scene;
397   if (scene) {
398     ac->markers = ED_context_get_markers(C);
399   }
400   ac->depsgraph = CTX_data_depsgraph(C);
401   ac->view_layer = CTX_data_view_layer(C);
402   ac->obact = (ac->view_layer->basact) ? ac->view_layer->basact->object : NULL;
403   ac->sa = sa;
404   ac->ar = ar;
405   ac->sl = sl;
406   ac->spacetype = (sa) ? sa->spacetype : 0;
407   ac->regiontype = (ar) ? ar->regiontype : 0;
408
409   /* initialise default y-scale factor */
410   animedit_get_yscale_factor(ac);
411
412   /* get data context info */
413   // XXX: if the below fails, try to grab this info from context instead... (to allow for scripting)
414   return ANIM_animdata_context_getdata(ac);
415 }
416
417 /* ************************************************************ */
418 /* Blender Data <-- Filter --> Channels to be operated on */
419
420 /* macros to use before/after getting the sub-channels of some channel,
421  * to abstract away some of the tricky logic involved
422  *
423  * cases:
424  * 1) Graph Edit main area (just data) OR channels visible in Channel List
425  * 2) If not showing channels, we're only interested in the data (Action Editor's editing)
426  * 3) We don't care what data, we just care there is some (so that a collapsed
427  *    channel can be kept around). No need to clear channels-flag in order to
428  *    keep expander channels with no sub-data out, as those cases should get
429  *    dealt with by the recursive detection idiom in place.
430  *
431  * Implementation Note:
432  *  YES the _doSubChannels variable is NOT read anywhere. BUT, this is NOT an excuse
433  *  to go steamrolling the logic into a single-line expression as from experience,
434  *  those are notoriously difficult to read + debug when extending later on. The code
435  *  below is purposefully laid out so that each case noted above corresponds clearly to
436  *  one case below.
437  */
438 #define BEGIN_ANIMFILTER_SUBCHANNELS(expanded_check) \
439   { \
440     int _filter = filter_mode; \
441     short _doSubChannels = 0; \
442     if (!(filter_mode & ANIMFILTER_LIST_VISIBLE) || (expanded_check)) \
443       _doSubChannels = 1; \
444     else if (!(filter_mode & ANIMFILTER_LIST_CHANNELS)) \
445       _doSubChannels = 2; \
446     else { \
447       filter_mode |= ANIMFILTER_TMP_PEEK; \
448     } \
449 \
450     { \
451       (void)_doSubChannels; \
452     }
453 /* ... standard sub-channel filtering can go on here now ... */
454 #define END_ANIMFILTER_SUBCHANNELS \
455   filter_mode = _filter; \
456   } \
457   (void)0
458
459 /* ............................... */
460
461 /* quick macro to test if AnimData is usable */
462 #define ANIMDATA_HAS_KEYS(id) ((id)->adt && (id)->adt->action)
463
464 /* quick macro to test if AnimData is usable for drivers */
465 #define ANIMDATA_HAS_DRIVERS(id) ((id)->adt && (id)->adt->drivers.first)
466
467 /* quick macro to test if AnimData is usable for NLA */
468 #define ANIMDATA_HAS_NLA(id) ((id)->adt && (id)->adt->nla_tracks.first)
469
470 /* Quick macro to test for all three above usability tests, performing the appropriate provided
471  * action for each when the AnimData context is appropriate.
472  *
473  * Priority order for this goes (most important, to least): AnimData blocks, NLA, Drivers, Keyframes.
474  *
475  * For this to work correctly, a standard set of data needs to be available within the scope that this
476  * gets called in:
477  * - ListBase anim_data;
478  * - bDopeSheet *ads;
479  * - bAnimListElem *ale;
480  * - size_t items;
481  *
482  * - id: ID block which should have an AnimData pointer following it immediately, to use
483  * - adtOk: line or block of code to execute for AnimData-blocks case (usually ANIMDATA_ADD_ANIMDATA)
484  * - nlaOk: line or block of code to execute for NLA tracks+strips case
485  * - driversOk: line or block of code to execute for Drivers case
486  * - nlaKeysOk: line or block of code for NLA Strip Keyframes case
487  * - keysOk: line or block of code for Keyframes case
488  *
489  * The checks for the various cases are as follows:
490  * 0) top level: checks for animdata and also that all the F-Curves for the block will be visible
491  * 1) animdata check: for filtering animdata blocks only
492  * 2A) nla tracks: include animdata block's data as there are NLA tracks+strips there
493  * 2B) actions to convert to nla: include animdata block's data as there is an action that can be
494  *     converted to a new NLA strip, and the filtering options allow this
495  * 2C) allow non-animated datablocks to be included so that datablocks can be added
496  * 3) drivers: include drivers from animdata block (for Drivers mode in Graph Editor)
497  * 4A) nla strip keyframes: these are the per-strip controls for time and influence
498  * 4B) normal keyframes: only when there is an active action
499  */
500 #define ANIMDATA_FILTER_CASES(id, adtOk, nlaOk, driversOk, nlaKeysOk, keysOk) \
501   { \
502     if ((id)->adt) { \
503       if (!(filter_mode & ANIMFILTER_CURVE_VISIBLE) || \
504           !((id)->adt->flag & ADT_CURVES_NOT_VISIBLE)) { \
505         if (filter_mode & ANIMFILTER_ANIMDATA) { \
506           adtOk \
507         } \
508         else if (ads->filterflag & ADS_FILTER_ONLYNLA) { \
509           if (ANIMDATA_HAS_NLA(id)) { \
510             nlaOk \
511           } \
512           else if (!(ads->filterflag & ADS_FILTER_NLA_NOACT) || ANIMDATA_HAS_KEYS(id)) { \
513             nlaOk \
514           } \
515         } \
516         else if (ads->filterflag & ADS_FILTER_ONLYDRIVERS) { \
517           if (ANIMDATA_HAS_DRIVERS(id)) { \
518             driversOk \
519           } \
520         } \
521         else { \
522           if (ANIMDATA_HAS_NLA(id)) { \
523             nlaKeysOk \
524           } \
525           if (ANIMDATA_HAS_KEYS(id)) { \
526             keysOk \
527           } \
528         } \
529       } \
530     } \
531   } \
532   (void)0
533
534 /* ............................... */
535
536 /* Add a new animation channel, taking into account the "peek" flag, which is used to just check
537  * whether any channels will be added (but without needing them to actually get created).
538  *
539  * ! This causes the calling function to return early if we're only "peeking" for channels
540  */
541 // XXX: ale_statement stuff is really a hack for one special case. It shouldn't really be needed...
542 #define ANIMCHANNEL_NEW_CHANNEL_FULL( \
543     channel_data, channel_type, owner_id, fcurve_owner_id, ale_statement) \
544   if (filter_mode & ANIMFILTER_TMP_PEEK) \
545     return 1; \
546   else { \
547     bAnimListElem *ale = make_new_animlistelem( \
548         channel_data, channel_type, (ID *)owner_id, fcurve_owner_id); \
549     if (ale) { \
550       BLI_addtail(anim_data, ale); \
551       items++; \
552       ale_statement \
553     } \
554   } \
555   (void)0
556
557 #define ANIMCHANNEL_NEW_CHANNEL(channel_data, channel_type, owner_id, fcurve_owner_id) \
558   ANIMCHANNEL_NEW_CHANNEL_FULL(channel_data, channel_type, owner_id, fcurve_owner_id, {})
559
560 /* ............................... */
561
562 /* quick macro to test if an anim-channel representing an AnimData block is suitably active */
563 #define ANIMCHANNEL_ACTIVEOK(ale) \
564   (!(filter_mode & ANIMFILTER_ACTIVE) || !(ale->adt) || (ale->adt->flag & ADT_UI_ACTIVE))
565
566 /* quick macro to test if an anim-channel (F-Curve, Group, etc.) is selected in an acceptable way */
567 #define ANIMCHANNEL_SELOK(test_func) \
568   (!(filter_mode & (ANIMFILTER_SEL | ANIMFILTER_UNSEL)) || \
569    ((filter_mode & ANIMFILTER_SEL) && test_func) || \
570    ((filter_mode & ANIMFILTER_UNSEL) && test_func == 0))
571
572 /* quick macro to test if an anim-channel (F-Curve) is selected ok for editing purposes
573  * - _SELEDIT means that only selected curves will have visible+editable keyframes
574  *
575  * checks here work as follows:
576  * 1) seledit off - don't need to consider the implications of this option
577  * 2) foredit off - we're not considering editing, so channel is ok still
578  * 3) test_func (i.e. selection test) - only if selected, this test will pass
579  */
580 #define ANIMCHANNEL_SELEDITOK(test_func) \
581   (!(filter_mode & ANIMFILTER_SELEDIT) || !(filter_mode & ANIMFILTER_FOREDIT) || (test_func))
582
583 /* ----------- 'Private' Stuff --------------- */
584
585 /* this function allocates memory for a new bAnimListElem struct for the
586  * provided animation channel-data.
587  */
588 static bAnimListElem *make_new_animlistelem(void *data,
589                                             short datatype,
590                                             ID *owner_id,
591                                             ID *fcurve_owner_id)
592 {
593   bAnimListElem *ale = NULL;
594
595   /* only allocate memory if there is data to convert */
596   if (data) {
597     /* allocate and set generic data */
598     ale = MEM_callocN(sizeof(bAnimListElem), "bAnimListElem");
599
600     ale->data = data;
601     ale->type = datatype;
602
603     ale->id = owner_id;
604     ale->adt = BKE_animdata_from_id(owner_id);
605     ale->fcurve_owner_id = fcurve_owner_id;
606
607     /* do specifics */
608     switch (datatype) {
609       case ANIMTYPE_SUMMARY: {
610         /* nothing to include for now... this is just a dummy wrappy around all the other channels
611          * in the DopeSheet, and gets included at the start of the list
612          */
613         ale->key_data = NULL;
614         ale->datatype = ALE_ALL;
615         break;
616       }
617       case ANIMTYPE_SCENE: {
618         Scene *sce = (Scene *)data;
619
620         ale->flag = sce->flag;
621
622         ale->key_data = sce;
623         ale->datatype = ALE_SCE;
624
625         ale->adt = BKE_animdata_from_id(data);
626         break;
627       }
628       case ANIMTYPE_OBJECT: {
629         Base *base = (Base *)data;
630         Object *ob = base->object;
631
632         ale->flag = ob->flag;
633
634         ale->key_data = ob;
635         ale->datatype = ALE_OB;
636
637         ale->adt = BKE_animdata_from_id(&ob->id);
638         break;
639       }
640       case ANIMTYPE_FILLACTD: {
641         bAction *act = (bAction *)data;
642
643         ale->flag = act->flag;
644
645         ale->key_data = act;
646         ale->datatype = ALE_ACT;
647         break;
648       }
649       case ANIMTYPE_FILLDRIVERS: {
650         AnimData *adt = (AnimData *)data;
651
652         ale->flag = adt->flag;
653
654         // XXX... drivers don't show summary for now
655         ale->key_data = NULL;
656         ale->datatype = ALE_NONE;
657         break;
658       }
659       case ANIMTYPE_DSMAT: {
660         Material *ma = (Material *)data;
661         AnimData *adt = ma->adt;
662
663         ale->flag = FILTER_MAT_OBJD(ma);
664
665         ale->key_data = (adt) ? adt->action : NULL;
666         ale->datatype = ALE_ACT;
667
668         ale->adt = BKE_animdata_from_id(data);
669         break;
670       }
671       case ANIMTYPE_DSLAM: {
672         Light *la = (Light *)data;
673         AnimData *adt = la->adt;
674
675         ale->flag = FILTER_LAM_OBJD(la);
676
677         ale->key_data = (adt) ? adt->action : NULL;
678         ale->datatype = ALE_ACT;
679
680         ale->adt = BKE_animdata_from_id(data);
681         break;
682       }
683       case ANIMTYPE_DSCAM: {
684         Camera *ca = (Camera *)data;
685         AnimData *adt = ca->adt;
686
687         ale->flag = FILTER_CAM_OBJD(ca);
688
689         ale->key_data = (adt) ? adt->action : NULL;
690         ale->datatype = ALE_ACT;
691
692         ale->adt = BKE_animdata_from_id(data);
693         break;
694       }
695       case ANIMTYPE_DSCACHEFILE: {
696         CacheFile *cache_file = (CacheFile *)data;
697         AnimData *adt = cache_file->adt;
698
699         ale->flag = FILTER_CACHEFILE_OBJD(cache_file);
700
701         ale->key_data = (adt) ? adt->action : NULL;
702         ale->datatype = ALE_ACT;
703
704         ale->adt = BKE_animdata_from_id(data);
705         break;
706       }
707       case ANIMTYPE_DSCUR: {
708         Curve *cu = (Curve *)data;
709         AnimData *adt = cu->adt;
710
711         ale->flag = FILTER_CUR_OBJD(cu);
712
713         ale->key_data = (adt) ? adt->action : NULL;
714         ale->datatype = ALE_ACT;
715
716         ale->adt = BKE_animdata_from_id(data);
717         break;
718       }
719       case ANIMTYPE_DSARM: {
720         bArmature *arm = (bArmature *)data;
721         AnimData *adt = arm->adt;
722
723         ale->flag = FILTER_ARM_OBJD(arm);
724
725         ale->key_data = (adt) ? adt->action : NULL;
726         ale->datatype = ALE_ACT;
727
728         ale->adt = BKE_animdata_from_id(data);
729         break;
730       }
731       case ANIMTYPE_DSMESH: {
732         Mesh *me = (Mesh *)data;
733         AnimData *adt = me->adt;
734
735         ale->flag = FILTER_MESH_OBJD(me);
736
737         ale->key_data = (adt) ? adt->action : NULL;
738         ale->datatype = ALE_ACT;
739
740         ale->adt = BKE_animdata_from_id(data);
741         break;
742       }
743       case ANIMTYPE_DSLAT: {
744         Lattice *lt = (Lattice *)data;
745         AnimData *adt = lt->adt;
746
747         ale->flag = FILTER_LATTICE_OBJD(lt);
748
749         ale->key_data = (adt) ? adt->action : NULL;
750         ale->datatype = ALE_ACT;
751
752         ale->adt = BKE_animdata_from_id(data);
753         break;
754       }
755       case ANIMTYPE_DSSPK: {
756         Speaker *spk = (Speaker *)data;
757         AnimData *adt = spk->adt;
758
759         ale->flag = FILTER_SPK_OBJD(spk);
760
761         ale->key_data = (adt) ? adt->action : NULL;
762         ale->datatype = ALE_ACT;
763
764         ale->adt = BKE_animdata_from_id(data);
765         break;
766       }
767       case ANIMTYPE_DSSKEY: {
768         Key *key = (Key *)data;
769         AnimData *adt = key->adt;
770
771         ale->flag = FILTER_SKE_OBJD(key);
772
773         ale->key_data = (adt) ? adt->action : NULL;
774         ale->datatype = ALE_ACT;
775
776         ale->adt = BKE_animdata_from_id(data);
777         break;
778       }
779       case ANIMTYPE_DSWOR: {
780         World *wo = (World *)data;
781         AnimData *adt = wo->adt;
782
783         ale->flag = FILTER_WOR_SCED(wo);
784
785         ale->key_data = (adt) ? adt->action : NULL;
786         ale->datatype = ALE_ACT;
787
788         ale->adt = BKE_animdata_from_id(data);
789         break;
790       }
791       case ANIMTYPE_DSNTREE: {
792         bNodeTree *ntree = (bNodeTree *)data;
793         AnimData *adt = ntree->adt;
794
795         ale->flag = FILTER_NTREE_DATA(ntree);
796
797         ale->key_data = (adt) ? adt->action : NULL;
798         ale->datatype = ALE_ACT;
799
800         ale->adt = BKE_animdata_from_id(data);
801         break;
802       }
803       case ANIMTYPE_DSLINESTYLE: {
804         FreestyleLineStyle *linestyle = (FreestyleLineStyle *)data;
805         AnimData *adt = linestyle->adt;
806
807         ale->flag = FILTER_LS_SCED(linestyle);
808
809         ale->key_data = (adt) ? adt->action : NULL;
810         ale->datatype = ALE_ACT;
811
812         ale->adt = BKE_animdata_from_id(data);
813         break;
814       }
815       case ANIMTYPE_DSPART: {
816         ParticleSettings *part = (ParticleSettings *)ale->data;
817         AnimData *adt = part->adt;
818
819         ale->flag = FILTER_PART_OBJD(part);
820
821         ale->key_data = (adt) ? adt->action : NULL;
822         ale->datatype = ALE_ACT;
823
824         ale->adt = BKE_animdata_from_id(data);
825         break;
826       }
827       case ANIMTYPE_DSTEX: {
828         Tex *tex = (Tex *)data;
829         AnimData *adt = tex->adt;
830
831         ale->flag = FILTER_TEX_DATA(tex);
832
833         ale->key_data = (adt) ? adt->action : NULL;
834         ale->datatype = ALE_ACT;
835
836         ale->adt = BKE_animdata_from_id(data);
837         break;
838       }
839       case ANIMTYPE_DSGPENCIL: {
840         bGPdata *gpd = (bGPdata *)data;
841         AnimData *adt = gpd->adt;
842
843         /* NOTE: we just reuse the same expand filter for this case */
844         ale->flag = EXPANDED_GPD(gpd);
845
846         // XXX: currently, this is only used for access to its animation data
847         ale->key_data = (adt) ? adt->action : NULL;
848         ale->datatype = ALE_ACT;
849
850         ale->adt = BKE_animdata_from_id(data);
851         break;
852       }
853       case ANIMTYPE_DSMCLIP: {
854         MovieClip *clip = (MovieClip *)data;
855         AnimData *adt = clip->adt;
856
857         ale->flag = EXPANDED_MCLIP(clip);
858
859         ale->key_data = (adt) ? adt->action : NULL;
860         ale->datatype = ALE_ACT;
861
862         ale->adt = BKE_animdata_from_id(data);
863         break;
864       }
865       case ANIMTYPE_NLACONTROLS: {
866         AnimData *adt = (AnimData *)data;
867
868         ale->flag = adt->flag;
869
870         ale->key_data = NULL;
871         ale->datatype = ALE_NONE;
872         break;
873       }
874       case ANIMTYPE_GROUP: {
875         bActionGroup *agrp = (bActionGroup *)data;
876
877         ale->flag = agrp->flag;
878
879         ale->key_data = NULL;
880         ale->datatype = ALE_GROUP;
881         break;
882       }
883       case ANIMTYPE_FCURVE:
884       case ANIMTYPE_NLACURVE: /* practically the same as ANIMTYPE_FCURVE.
885                                * Differences are applied post-creation */
886       {
887         FCurve *fcu = (FCurve *)data;
888
889         ale->flag = fcu->flag;
890
891         ale->key_data = fcu;
892         ale->datatype = ALE_FCURVE;
893         break;
894       }
895       case ANIMTYPE_SHAPEKEY: {
896         KeyBlock *kb = (KeyBlock *)data;
897         Key *key = (Key *)ale->id;
898
899         ale->flag = kb->flag;
900
901         /* whether we have keyframes depends on whether there is a Key block to find it from */
902         if (key) {
903           /* index of shapekey is defined by place in key's list */
904           ale->index = BLI_findindex(&key->block, kb);
905
906           /* the corresponding keyframes are from the animdata */
907           if (ale->adt && ale->adt->action) {
908             bAction *act = ale->adt->action;
909             char *rna_path = BKE_keyblock_curval_rnapath_get(key, kb);
910
911             /* try to find the F-Curve which corresponds to this exactly,
912              * then free the MEM_alloc'd string
913              */
914             if (rna_path) {
915               ale->key_data = (void *)list_find_fcurve(&act->curves, rna_path, 0);
916               MEM_freeN(rna_path);
917             }
918           }
919           ale->datatype = (ale->key_data) ? ALE_FCURVE : ALE_NONE;
920         }
921         break;
922       }
923       case ANIMTYPE_GPLAYER: {
924         bGPDlayer *gpl = (bGPDlayer *)data;
925
926         ale->flag = gpl->flag;
927
928         ale->key_data = NULL;
929         ale->datatype = ALE_GPFRAME;
930         break;
931       }
932       case ANIMTYPE_MASKLAYER: {
933         MaskLayer *masklay = (MaskLayer *)data;
934
935         ale->flag = masklay->flag;
936
937         ale->key_data = NULL;
938         ale->datatype = ALE_MASKLAY;
939         break;
940       }
941       case ANIMTYPE_NLATRACK: {
942         NlaTrack *nlt = (NlaTrack *)data;
943
944         ale->flag = nlt->flag;
945
946         ale->key_data = &nlt->strips;
947         ale->datatype = ALE_NLASTRIP;
948         break;
949       }
950       case ANIMTYPE_NLAACTION: {
951         /* nothing to include for now... nothing editable from NLA-perspective here */
952         ale->key_data = NULL;
953         ale->datatype = ALE_NONE;
954         break;
955       }
956     }
957   }
958
959   /* return created datatype */
960   return ale;
961 }
962
963 /* ----------------------------------------- */
964
965 /* 'Only Selected' selected data and/or 'Include Hidden' filtering
966  * NOTE: when this function returns true, the F-Curve is to be skipped
967  */
968 static bool skip_fcurve_selected_data(bDopeSheet *ads, FCurve *fcu, ID *owner_id, int filter_mode)
969 {
970   if (fcu->grp != NULL && fcu->grp->flag & ADT_CURVES_ALWAYS_VISIBLE) {
971     return false;
972   }
973   /* hidden items should be skipped if we only care about visible data,
974    * but we aren't interested in hidden stuff */
975   const bool skip_hidden = (filter_mode & ANIMFILTER_DATA_VISIBLE) &&
976                            !(ads->filterflag & ADS_FILTER_INCL_HIDDEN);
977
978   if (GS(owner_id->name) == ID_OB) {
979     Object *ob = (Object *)owner_id;
980
981     /* only consider if F-Curve involves pose.bones */
982     if ((fcu->rna_path) && strstr(fcu->rna_path, "pose.bones")) {
983       bPoseChannel *pchan;
984       char *bone_name;
985
986       /* get bone-name, and check if this bone is selected */
987       bone_name = BLI_str_quoted_substrN(fcu->rna_path, "pose.bones[");
988       pchan = BKE_pose_channel_find_name(ob->pose, bone_name);
989       if (bone_name)
990         MEM_freeN(bone_name);
991
992       /* check whether to continue or skip */
993       if ((pchan) && (pchan->bone)) {
994         /* if only visible channels, skip if bone not visible unless user wants channels from hidden data too */
995         if (skip_hidden) {
996           bArmature *arm = (bArmature *)ob->data;
997
998           /* skipping - not visible on currently visible layers */
999           if ((arm->layer & pchan->bone->layer) == 0)
1000             return true;
1001           /* skipping - is currently hidden */
1002           if (pchan->bone->flag & BONE_HIDDEN_P)
1003             return true;
1004         }
1005
1006         /* can only add this F-Curve if it is selected */
1007         if (ads->filterflag & ADS_FILTER_ONLYSEL) {
1008           if ((pchan->bone->flag & BONE_SELECTED) == 0)
1009             return true;
1010         }
1011       }
1012     }
1013   }
1014   else if (GS(owner_id->name) == ID_SCE) {
1015     Scene *scene = (Scene *)owner_id;
1016
1017     /* only consider if F-Curve involves sequence_editor.sequences */
1018     if ((fcu->rna_path) && strstr(fcu->rna_path, "sequences_all")) {
1019       Editing *ed = BKE_sequencer_editing_get(scene, false);
1020       Sequence *seq = NULL;
1021       char *seq_name;
1022
1023       if (ed) {
1024         /* get strip name, and check if this strip is selected */
1025         seq_name = BLI_str_quoted_substrN(fcu->rna_path, "sequences_all[");
1026         seq = BKE_sequence_get_by_name(ed->seqbasep, seq_name, false);
1027         if (seq_name)
1028           MEM_freeN(seq_name);
1029       }
1030
1031       /* can only add this F-Curve if it is selected */
1032       if (ads->filterflag & ADS_FILTER_ONLYSEL) {
1033         if ((seq == NULL) || (seq->flag & SELECT) == 0)
1034           return true;
1035       }
1036     }
1037   }
1038   else if (GS(owner_id->name) == ID_NT) {
1039     bNodeTree *ntree = (bNodeTree *)owner_id;
1040
1041     /* check for selected nodes */
1042     if ((fcu->rna_path) && strstr(fcu->rna_path, "nodes")) {
1043       bNode *node;
1044       char *node_name;
1045
1046       /* get strip name, and check if this strip is selected */
1047       node_name = BLI_str_quoted_substrN(fcu->rna_path, "nodes[");
1048       node = nodeFindNodebyName(ntree, node_name);
1049       if (node_name)
1050         MEM_freeN(node_name);
1051
1052       /* can only add this F-Curve if it is selected */
1053       if (ads->filterflag & ADS_FILTER_ONLYSEL) {
1054         if ((node) && (node->flag & NODE_SELECT) == 0)
1055           return true;
1056       }
1057     }
1058   }
1059
1060   return false;
1061 }
1062
1063 /* Helper for name-based filtering - Perform "partial/fuzzy matches" (as in 80a7efd) */
1064 static bool name_matches_dopesheet_filter(bDopeSheet *ads, char *name)
1065 {
1066   if (ads->flag & ADS_FLAG_FUZZY_NAMES) {
1067     /* full fuzzy, multi-word, case insensitive matches */
1068     const size_t str_len = strlen(ads->searchstr);
1069     const int words_max = (str_len / 2) + 1;
1070
1071     int(*words)[2] = BLI_array_alloca(words, words_max);
1072     const int words_len = BLI_string_find_split_words(
1073         ads->searchstr, str_len, ' ', words, words_max);
1074     bool found = false;
1075
1076     /* match name against all search words */
1077     for (int index = 0; index < words_len; index++) {
1078       if (BLI_strncasestr(name, ads->searchstr + words[index][0], words[index][1])) {
1079         found = true;
1080         break;
1081       }
1082     }
1083
1084     /* if we have a match somewhere, this returns true */
1085     return found;
1086   }
1087   else {
1088     /* fallback/default - just case insensitive, but starts from start of word */
1089     return BLI_strcasestr(name, ads->searchstr) != NULL;
1090   }
1091 }
1092
1093 /* (Display-)Name-based F-Curve filtering
1094  * NOTE: when this function returns true, the F-Curve is to be skipped
1095  */
1096 static bool skip_fcurve_with_name(
1097     bDopeSheet *ads, FCurve *fcu, eAnim_ChannelType channel_type, void *owner, ID *owner_id)
1098 {
1099   bAnimListElem ale_dummy = {NULL};
1100   const bAnimChannelType *acf;
1101
1102   /* create a dummy wrapper for the F-Curve, so we can get typeinfo for it */
1103   ale_dummy.type = channel_type;
1104   ale_dummy.owner = owner;
1105   ale_dummy.id = owner_id;
1106   ale_dummy.data = fcu;
1107
1108   /* get type info for channel */
1109   acf = ANIM_channel_get_typeinfo(&ale_dummy);
1110   if (acf && acf->name) {
1111     char name[256]; /* hopefully this will be enough! */
1112
1113     /* get name */
1114     acf->name(&ale_dummy, name);
1115
1116     /* check for partial match with the match string, assuming case insensitive filtering
1117      * if match, this channel shouldn't be ignored!
1118      */
1119     return !name_matches_dopesheet_filter(ads, name);
1120   }
1121
1122   /* just let this go... */
1123   return true;
1124 }
1125
1126 /**
1127  * Check if F-Curve has errors and/or is disabled
1128  *
1129  * \return true if F-Curve has errors/is disabled
1130  */
1131 static bool fcurve_has_errors(FCurve *fcu)
1132 {
1133   /* F-Curve disabled - path eval error */
1134   if (fcu->flag & FCURVE_DISABLED) {
1135     return true;
1136   }
1137
1138   /* driver? */
1139   if (fcu->driver) {
1140     ChannelDriver *driver = fcu->driver;
1141     DriverVar *dvar;
1142
1143     /* error flag on driver usually means that there is an error
1144      * BUT this may not hold with PyDrivers as this flag gets cleared
1145      *     if no critical errors prevent the driver from working...
1146      */
1147     if (driver->flag & DRIVER_FLAG_INVALID)
1148       return true;
1149
1150     /* check variables for other things that need linting... */
1151     // TODO: maybe it would be more efficient just to have a quick flag for this?
1152     for (dvar = driver->variables.first; dvar; dvar = dvar->next) {
1153       DRIVER_TARGETS_USED_LOOPER_BEGIN (dvar) {
1154         if (dtar->flag & DTAR_FLAG_INVALID)
1155           return true;
1156       }
1157       DRIVER_TARGETS_LOOPER_END;
1158     }
1159   }
1160
1161   /* no errors found */
1162   return false;
1163 }
1164
1165 /* find the next F-Curve that is usable for inclusion */
1166 static FCurve *animfilter_fcurve_next(bDopeSheet *ads,
1167                                       FCurve *first,
1168                                       eAnim_ChannelType channel_type,
1169                                       int filter_mode,
1170                                       void *owner,
1171                                       ID *owner_id)
1172 {
1173   bActionGroup *grp = (channel_type == ANIMTYPE_FCURVE) ? owner : NULL;
1174   FCurve *fcu = NULL;
1175
1176   /* loop over F-Curves - assume that the caller of this has already checked that these should be included
1177    * NOTE: we need to check if the F-Curves belong to the same group, as this gets called for groups too...
1178    */
1179   for (fcu = first; ((fcu) && (fcu->grp == grp)); fcu = fcu->next) {
1180     /* special exception for Pose-Channel/Sequence-Strip/Node Based F-Curves:
1181      * - the 'Only Selected' and 'Include Hidden' data filters should be applied to sub-ID data which
1182      *   can be independently selected/hidden, such as Pose-Channels, Sequence Strips, and Nodes.
1183      *   Since these checks were traditionally done as first check for objects, we do the same here
1184      * - we currently use an 'approximate' method for getting these F-Curves that doesn't require
1185      *   carefully checking the entire path
1186      * - this will also affect things like Drivers, and also works for Bone Constraints
1187      */
1188     if (ads && owner_id) {
1189       if ((filter_mode & ANIMFILTER_TMP_IGNORE_ONLYSEL) == 0) {
1190         if ((ads->filterflag & ADS_FILTER_ONLYSEL) ||
1191             (ads->filterflag & ADS_FILTER_INCL_HIDDEN) == 0) {
1192           if (skip_fcurve_selected_data(ads, fcu, owner_id, filter_mode))
1193             continue;
1194         }
1195       }
1196     }
1197
1198     /* only include if visible (Graph Editor check, not channels check) */
1199     if (!(filter_mode & ANIMFILTER_CURVE_VISIBLE) || (fcu->flag & FCURVE_VISIBLE)) {
1200       /* only work with this channel and its subchannels if it is editable */
1201       if (!(filter_mode & ANIMFILTER_FOREDIT) || EDITABLE_FCU(fcu)) {
1202         /* only include this curve if selected in a way consistent with the filtering requirements */
1203         if (ANIMCHANNEL_SELOK(SEL_FCU(fcu)) && ANIMCHANNEL_SELEDITOK(SEL_FCU(fcu))) {
1204           /* only include if this curve is active */
1205           if (!(filter_mode & ANIMFILTER_ACTIVE) || (fcu->flag & FCURVE_ACTIVE)) {
1206             /* name based filtering... */
1207             if (((ads) && (ads->searchstr[0] != '\0')) && (owner_id)) {
1208               if (skip_fcurve_with_name(ads, fcu, channel_type, owner, owner_id))
1209                 continue;
1210             }
1211
1212             /* error-based filtering... */
1213             if ((ads) && (ads->filterflag & ADS_FILTER_ONLY_ERRORS)) {
1214               /* skip if no errors... */
1215               if (fcurve_has_errors(fcu) == false)
1216                 continue;
1217             }
1218
1219             /* this F-Curve can be used, so return it */
1220             return fcu;
1221           }
1222         }
1223       }
1224     }
1225   }
1226
1227   /* no (more) F-Curves from the list are suitable... */
1228   return NULL;
1229 }
1230
1231 static size_t animfilter_fcurves(ListBase *anim_data,
1232                                  bDopeSheet *ads,
1233                                  FCurve *first,
1234                                  eAnim_ChannelType fcurve_type,
1235                                  int filter_mode,
1236                                  void *owner,
1237                                  ID *owner_id,
1238                                  ID *fcurve_owner_id)
1239 {
1240   FCurve *fcu;
1241   size_t items = 0;
1242
1243   /* loop over every F-Curve able to be included
1244    * - this for-loop works like this:
1245    *   1) the starting F-Curve is assigned to the fcu pointer so that we have a starting point to search from
1246    *   2) the first valid F-Curve to start from (which may include the one given as 'first') in the remaining
1247    *      list of F-Curves is found, and verified to be non-null
1248    *   3) the F-Curve referenced by fcu pointer is added to the list
1249    *   4) the fcu pointer is set to the F-Curve after the one we just added, so that we can keep going through
1250    *      the rest of the F-Curve list without an eternal loop. Back to step 2 :)
1251    */
1252   for (fcu = first;
1253        ((fcu = animfilter_fcurve_next(ads, fcu, fcurve_type, filter_mode, owner, owner_id)));
1254        fcu = fcu->next) {
1255     if (UNLIKELY(fcurve_type == ANIMTYPE_NLACURVE)) {
1256       /* NLA Control Curve - Basically the same as normal F-Curves,
1257        * except we need to set some stuff differently */
1258       ANIMCHANNEL_NEW_CHANNEL_FULL(fcu, ANIMTYPE_NLACURVE, owner_id, fcurve_owner_id, {
1259         ale->owner = owner; /* strip */
1260         ale->adt = NULL;    /* to prevent time mapping from causing problems */
1261       });
1262     }
1263     else {
1264       /* Normal FCurve */
1265       ANIMCHANNEL_NEW_CHANNEL(fcu, ANIMTYPE_FCURVE, owner_id, fcurve_owner_id);
1266     }
1267   }
1268
1269   /* return the number of items added to the list */
1270   return items;
1271 }
1272
1273 static size_t animfilter_act_group(bAnimContext *ac,
1274                                    ListBase *anim_data,
1275                                    bDopeSheet *ads,
1276                                    bAction *act,
1277                                    bActionGroup *agrp,
1278                                    int filter_mode,
1279                                    ID *owner_id)
1280 {
1281   ListBase tmp_data = {NULL, NULL};
1282   size_t tmp_items = 0;
1283   size_t items = 0;
1284   //int ofilter = filter_mode;
1285
1286   /* if we care about the selection status of the channels,
1287    * but the group isn't expanded (1)...
1288    * (1) this only matters if we actually care about the hierarchy though.
1289    *     - Hierarchy matters: this hack should be applied
1290    *     - Hierarchy ignored: cases like [#21276] won't work properly, unless we skip this hack
1291    */
1292   if (
1293       /* care about hierarchy but group isn't expanded */
1294       ((filter_mode & ANIMFILTER_LIST_VISIBLE) && EXPANDED_AGRP(ac, agrp) == 0) &&
1295       /* care about selection status */
1296       (filter_mode & (ANIMFILTER_SEL | ANIMFILTER_UNSEL))) {
1297     /* if the group itself isn't selected appropriately, we shouldn't consider it's children either */
1298     if (ANIMCHANNEL_SELOK(SEL_AGRP(agrp)) == 0)
1299       return 0;
1300
1301     /* if we're still here, then the selection status of the curves within this group should not matter,
1302      * since this creates too much overhead for animators (i.e. making a slow workflow)
1303      *
1304      * Tools affected by this at time of coding (2010 Feb 09):
1305      * - inserting keyframes on selected channels only
1306      * - pasting keyframes
1307      * - creating ghost curves in Graph Editor
1308      */
1309     filter_mode &= ~(ANIMFILTER_SEL | ANIMFILTER_UNSEL | ANIMFILTER_LIST_VISIBLE);
1310   }
1311
1312   /* add grouped F-Curves */
1313   BEGIN_ANIMFILTER_SUBCHANNELS (EXPANDED_AGRP(ac, agrp)) {
1314     /* special filter so that we can get just the F-Curves within the active group */
1315     if (!(filter_mode & ANIMFILTER_ACTGROUPED) || (agrp->flag & AGRP_ACTIVE)) {
1316       /* for the Graph Editor, curves may be set to not be visible in the view to lessen
1317        * clutter, but to do this, we need to check that the group doesn't have it's
1318        * not-visible flag set preventing all its sub-curves to be shown
1319        */
1320       if (!(filter_mode & ANIMFILTER_CURVE_VISIBLE) || !(agrp->flag & AGRP_NOTVISIBLE)) {
1321         /* group must be editable for its children to be editable (if we care about this) */
1322         if (!(filter_mode & ANIMFILTER_FOREDIT) || EDITABLE_AGRP(agrp)) {
1323           /* get first F-Curve which can be used here */
1324           FCurve *first_fcu = animfilter_fcurve_next(
1325               ads, agrp->channels.first, ANIMTYPE_FCURVE, filter_mode, agrp, owner_id);
1326
1327           /* filter list, starting from this F-Curve */
1328           tmp_items += animfilter_fcurves(
1329               &tmp_data, ads, first_fcu, ANIMTYPE_FCURVE, filter_mode, agrp, owner_id, &act->id);
1330         }
1331       }
1332     }
1333   }
1334   END_ANIMFILTER_SUBCHANNELS;
1335
1336   /* did we find anything? */
1337   if (tmp_items) {
1338     /* add this group as a channel first */
1339     if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1340       /* restore original filter mode so that this next step works ok... */
1341       //filter_mode = ofilter;
1342
1343       /* filter selection of channel specially here again,
1344        * since may be open and not subject to previous test */
1345       if (ANIMCHANNEL_SELOK(SEL_AGRP(agrp))) {
1346         ANIMCHANNEL_NEW_CHANNEL(agrp, ANIMTYPE_GROUP, owner_id, &act->id);
1347       }
1348     }
1349
1350     /* now add the list of collected channels */
1351     BLI_movelisttolist(anim_data, &tmp_data);
1352     BLI_assert(BLI_listbase_is_empty(&tmp_data));
1353     items += tmp_items;
1354   }
1355
1356   /* return the number of items added to the list */
1357   return items;
1358 }
1359
1360 static size_t animfilter_action(bAnimContext *ac,
1361                                 ListBase *anim_data,
1362                                 bDopeSheet *ads,
1363                                 bAction *act,
1364                                 int filter_mode,
1365                                 ID *owner_id)
1366 {
1367   bActionGroup *agrp;
1368   FCurve *lastchan = NULL;
1369   size_t items = 0;
1370
1371   /* don't include anything from this action if it is linked in from another file,
1372    * and we're getting stuff for editing...
1373    */
1374   if ((filter_mode & ANIMFILTER_FOREDIT) && ID_IS_LINKED(act))
1375     return 0;
1376
1377   /* do groups */
1378   // TODO: do nested groups?
1379   for (agrp = act->groups.first; agrp; agrp = agrp->next) {
1380     /* store reference to last channel of group */
1381     if (agrp->channels.last)
1382       lastchan = agrp->channels.last;
1383
1384     /* action group's channels */
1385     items += animfilter_act_group(ac, anim_data, ads, act, agrp, filter_mode, owner_id);
1386   }
1387
1388   /* un-grouped F-Curves (only if we're not only considering those channels in the active group) */
1389   if (!(filter_mode & ANIMFILTER_ACTGROUPED)) {
1390     FCurve *firstfcu = (lastchan) ? (lastchan->next) : (act->curves.first);
1391     items += animfilter_fcurves(
1392         anim_data, ads, firstfcu, ANIMTYPE_FCURVE, filter_mode, NULL, owner_id, &act->id);
1393   }
1394
1395   /* return the number of items added to the list */
1396   return items;
1397 }
1398
1399 /* Include NLA-Data for NLA-Editor:
1400  * - when ANIMFILTER_LIST_CHANNELS is used, that means we should be filtering the list for display
1401  *   Although the evaluation order is from the first track to the last and then apply the Action on top,
1402  *   we present this in the UI as the Active Action followed by the last track to the first so that we
1403  *   get the evaluation order presented as per a stack.
1404  * - for normal filtering (i.e. for editing), we only need the NLA-tracks but they can be in 'normal' evaluation
1405  *   order, i.e. first to last. Otherwise, some tools may get screwed up.
1406  */
1407 static size_t animfilter_nla(bAnimContext *UNUSED(ac),
1408                              ListBase *anim_data,
1409                              bDopeSheet *ads,
1410                              AnimData *adt,
1411                              int filter_mode,
1412                              ID *owner_id)
1413 {
1414   NlaTrack *nlt;
1415   NlaTrack *first = NULL, *next = NULL;
1416   size_t items = 0;
1417
1418   /* if showing channels, include active action */
1419   if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1420     /* if NLA action-line filtering is off, don't show unless there are keyframes,
1421      * in order to keep things more compact for doing transforms
1422      */
1423     if (!(ads->filterflag & ADS_FILTER_NLA_NOACT) || (adt->action)) {
1424       /* there isn't really anything editable here, so skip if need editable */
1425       if ((filter_mode & ANIMFILTER_FOREDIT) == 0) {
1426         /* just add the action track now (this MUST appear for drawing)
1427          * - as AnimData may not have an action, we pass a dummy pointer just to get the list elem created, then
1428          *   overwrite this with the real value - REVIEW THIS...
1429          */
1430         ANIMCHANNEL_NEW_CHANNEL_FULL((void *)(&adt->action), ANIMTYPE_NLAACTION, owner_id, NULL, {
1431           ale->data = adt->action ? adt->action : NULL;
1432         });
1433       }
1434     }
1435
1436     /* first track to include will be the last one if we're filtering by channels */
1437     first = adt->nla_tracks.last;
1438   }
1439   else {
1440     /* first track to include will the first one (as per normal) */
1441     first = adt->nla_tracks.first;
1442   }
1443
1444   /* loop over NLA Tracks - assume that the caller of this has already checked that these should be included */
1445   for (nlt = first; nlt; nlt = next) {
1446     /* 'next' NLA-Track to use depends on whether we're filtering for drawing or not */
1447     if (filter_mode & ANIMFILTER_LIST_CHANNELS)
1448       next = nlt->prev;
1449     else
1450       next = nlt->next;
1451
1452     /* if we're in NLA-tweakmode, don't show this track if it was disabled (due to tweaking) for now
1453      * - active track should still get shown though (even though it has disabled flag set)
1454      */
1455     // FIXME: the channels after should still get drawn, just 'differently', and after an active-action channel
1456     if ((adt->flag & ADT_NLA_EDIT_ON) && (nlt->flag & NLATRACK_DISABLED) &&
1457         (adt->act_track != nlt))
1458       continue;
1459
1460     /* only work with this channel and its subchannels if it is editable */
1461     if (!(filter_mode & ANIMFILTER_FOREDIT) || EDITABLE_NLT(nlt)) {
1462       /* only include this track if selected in a way consistent with the filtering requirements */
1463       if (ANIMCHANNEL_SELOK(SEL_NLT(nlt))) {
1464         /* only include if this track is active */
1465         if (!(filter_mode & ANIMFILTER_ACTIVE) || (nlt->flag & NLATRACK_ACTIVE)) {
1466           /* name based filtering... */
1467           if (((ads) && (ads->searchstr[0] != '\0')) && (owner_id)) {
1468             bool track_ok = false, strip_ok = false;
1469
1470             /* check if the name of the track, or the strips it has are ok... */
1471             track_ok = name_matches_dopesheet_filter(ads, nlt->name);
1472
1473             if (track_ok == false) {
1474               NlaStrip *strip;
1475               for (strip = nlt->strips.first; strip; strip = strip->next) {
1476                 if (name_matches_dopesheet_filter(ads, strip->name)) {
1477                   strip_ok = true;
1478                   break;
1479                 }
1480               }
1481             }
1482
1483             /* skip if both fail this test... */
1484             if (!track_ok && !strip_ok) {
1485               continue;
1486             }
1487           }
1488
1489           /* add the track now that it has passed all our tests */
1490           ANIMCHANNEL_NEW_CHANNEL(nlt, ANIMTYPE_NLATRACK, owner_id, NULL);
1491         }
1492       }
1493     }
1494   }
1495
1496   /* return the number of items added to the list */
1497   return items;
1498 }
1499
1500 /* Include the control FCurves per NLA Strip in the channel list
1501  * NOTE: This is includes the expander too...
1502  */
1503 static size_t animfilter_nla_controls(
1504     ListBase *anim_data, bDopeSheet *ads, AnimData *adt, int filter_mode, ID *owner_id)
1505 {
1506   ListBase tmp_data = {NULL, NULL};
1507   size_t tmp_items = 0;
1508   size_t items = 0;
1509
1510   /* add control curves from each NLA strip... */
1511   /* NOTE: ANIMTYPE_FCURVES are created here, to avoid duplicating the code needed */
1512   BEGIN_ANIMFILTER_SUBCHANNELS (((adt->flag & ADT_NLA_SKEYS_COLLAPSED) == 0)) {
1513     NlaTrack *nlt;
1514     NlaStrip *strip;
1515
1516     /* for now, we only go one level deep - so controls on grouped FCurves are not handled */
1517     for (nlt = adt->nla_tracks.first; nlt; nlt = nlt->next) {
1518       for (strip = nlt->strips.first; strip; strip = strip->next) {
1519         /* pass strip as the "owner", so that the name lookups (used while filtering) will resolve */
1520         /* NLA tracks are coming from AnimData, so owner of f-curves
1521          * is the same as owner of animation data. */
1522         tmp_items += animfilter_fcurves(&tmp_data,
1523                                         ads,
1524                                         strip->fcurves.first,
1525                                         ANIMTYPE_NLACURVE,
1526                                         filter_mode,
1527                                         strip,
1528                                         owner_id,
1529                                         owner_id);
1530       }
1531     }
1532   }
1533   END_ANIMFILTER_SUBCHANNELS;
1534
1535   /* did we find anything? */
1536   if (tmp_items) {
1537     /* add the expander as a channel first */
1538     if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1539       /* currently these channels cannot be selected, so they should be skipped */
1540       if ((filter_mode & (ANIMFILTER_SEL | ANIMFILTER_UNSEL)) == 0) {
1541         ANIMCHANNEL_NEW_CHANNEL(adt, ANIMTYPE_NLACONTROLS, owner_id, NULL);
1542       }
1543     }
1544
1545     /* now add the list of collected channels */
1546     BLI_movelisttolist(anim_data, &tmp_data);
1547     BLI_assert(BLI_listbase_is_empty(&tmp_data));
1548     items += tmp_items;
1549   }
1550
1551   /* return the number of items added to the list */
1552   return items;
1553 }
1554
1555 /* determine what animation data from AnimData block should get displayed */
1556 static size_t animfilter_block_data(
1557     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, ID *id, int filter_mode)
1558 {
1559   AnimData *adt = BKE_animdata_from_id(id);
1560   size_t items = 0;
1561
1562   /* image object datablocks have no anim-data so check for NULL */
1563   if (adt) {
1564     IdAdtTemplate *iat = (IdAdtTemplate *)id;
1565
1566     /* NOTE: this macro is used instead of inlining the logic here, since this sort of filtering is still needed
1567      * in a few places in the rest of the code still - notably for the few cases where special mode-based
1568      * different types of data expanders are required.
1569      */
1570     ANIMDATA_FILTER_CASES(
1571         iat,
1572         { /* AnimData */
1573           /* specifically filter animdata block */
1574           if (ANIMCHANNEL_SELOK(SEL_ANIMDATA(adt))) {
1575             ANIMCHANNEL_NEW_CHANNEL(adt, ANIMTYPE_ANIMDATA, id, NULL);
1576           }
1577         },
1578         { /* NLA */
1579           items += animfilter_nla(ac, anim_data, ads, adt, filter_mode, id);
1580         },
1581         { /* Drivers */
1582           items += animfilter_fcurves(
1583               anim_data, ads, adt->drivers.first, ANIMTYPE_FCURVE, filter_mode, NULL, id, id);
1584         },
1585         { /* NLA Control Keyframes */
1586           items += animfilter_nla_controls(anim_data, ads, adt, filter_mode, id);
1587         },
1588         { /* Keyframes */
1589           items += animfilter_action(ac, anim_data, ads, adt->action, filter_mode, id);
1590         });
1591   }
1592
1593   return items;
1594 }
1595
1596 /* Include ShapeKey Data for ShapeKey Editor */
1597 static size_t animdata_filter_shapekey(bAnimContext *ac,
1598                                        ListBase *anim_data,
1599                                        Key *key,
1600                                        int filter_mode)
1601 {
1602   size_t items = 0;
1603
1604   /* check if channels or only F-Curves */
1605   if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1606     KeyBlock *kb;
1607
1608     /* loop through the channels adding ShapeKeys as appropriate */
1609     for (kb = key->block.first; kb; kb = kb->next) {
1610       /* skip the first one, since that's the non-animatable basis */
1611       if (kb == key->block.first)
1612         continue;
1613
1614       /* only work with this channel and its subchannels if it is editable */
1615       if (!(filter_mode & ANIMFILTER_FOREDIT) || EDITABLE_SHAPEKEY(kb)) {
1616         /* only include this track if selected in a way consistent with the filtering requirements */
1617         if (ANIMCHANNEL_SELOK(SEL_SHAPEKEY(kb))) {
1618           // TODO: consider 'active' too?
1619
1620           /* owner-id here must be key so that the F-Curve can be resolved... */
1621           ANIMCHANNEL_NEW_CHANNEL(kb, ANIMTYPE_SHAPEKEY, key, NULL);
1622         }
1623       }
1624     }
1625   }
1626   else {
1627     /* just use the action associated with the shapekey */
1628     // TODO: somehow manage to pass dopesheet info down here too?
1629     if (key->adt) {
1630       if (filter_mode & ANIMFILTER_ANIMDATA) {
1631         if (ANIMCHANNEL_SELOK(SEL_ANIMDATA(key->adt))) {
1632           ANIMCHANNEL_NEW_CHANNEL(key->adt, ANIMTYPE_ANIMDATA, key, NULL);
1633         }
1634       }
1635       else if (key->adt->action) {
1636         items = animfilter_action(ac, anim_data, NULL, key->adt->action, filter_mode, (ID *)key);
1637       }
1638     }
1639   }
1640
1641   /* return the number of items added to the list */
1642   return items;
1643 }
1644
1645 /* Helper for Grease Pencil - layers within a datablock */
1646 static size_t animdata_filter_gpencil_layers_data(ListBase *anim_data,
1647                                                   bDopeSheet *ads,
1648                                                   bGPdata *gpd,
1649                                                   int filter_mode)
1650 {
1651   bGPDlayer *gpl;
1652   size_t items = 0;
1653
1654   /* loop over layers as the conditions are acceptable (top-Down order) */
1655   for (gpl = gpd->layers.last; gpl; gpl = gpl->prev) {
1656     /* only if selected */
1657     if (ANIMCHANNEL_SELOK(SEL_GPL(gpl))) {
1658       /* only if editable */
1659       if (!(filter_mode & ANIMFILTER_FOREDIT) || EDITABLE_GPL(gpl)) {
1660         /* active... */
1661         if (!(filter_mode & ANIMFILTER_ACTIVE) || (gpl->flag & GP_LAYER_ACTIVE)) {
1662           /* skip layer if the name doesn't match the filter string */
1663           if ((ads) && (ads->searchstr[0] != '\0')) {
1664             if (name_matches_dopesheet_filter(ads, gpl->info) == false)
1665               continue;
1666           }
1667           /* add to list */
1668           ANIMCHANNEL_NEW_CHANNEL(gpl, ANIMTYPE_GPLAYER, gpd, NULL);
1669         }
1670       }
1671     }
1672   }
1673
1674   return items;
1675 }
1676
1677 /* Helper for Grease Pencil - Grease Pencil datablock - GP Frames */
1678 static size_t animdata_filter_gpencil_data(ListBase *anim_data,
1679                                            bDopeSheet *ads,
1680                                            bGPdata *gpd,
1681                                            int filter_mode)
1682 {
1683   size_t items = 0;
1684
1685   /* When asked from "AnimData" blocks (i.e. the top-level containers for normal animation),
1686    * for convenience, this will return GP Datablocks instead. This may cause issues down
1687    * the track, but for now, this will do...
1688    */
1689   if (filter_mode & ANIMFILTER_ANIMDATA) {
1690     /* just add GPD as a channel - this will add everything needed */
1691     ANIMCHANNEL_NEW_CHANNEL(gpd, ANIMTYPE_GPDATABLOCK, gpd, NULL);
1692   }
1693   else {
1694     ListBase tmp_data = {NULL, NULL};
1695     size_t tmp_items = 0;
1696
1697     /* add gpencil animation channels */
1698     BEGIN_ANIMFILTER_SUBCHANNELS (EXPANDED_GPD(gpd)) {
1699       tmp_items += animdata_filter_gpencil_layers_data(&tmp_data, ads, gpd, filter_mode);
1700     }
1701     END_ANIMFILTER_SUBCHANNELS;
1702
1703     /* did we find anything? */
1704     if (tmp_items) {
1705       /* include data-expand widget first */
1706       if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1707         /* add gpd as channel too (if for drawing, and it has layers) */
1708         ANIMCHANNEL_NEW_CHANNEL(gpd, ANIMTYPE_GPDATABLOCK, NULL, NULL);
1709       }
1710
1711       /* now add the list of collected channels */
1712       BLI_movelisttolist(anim_data, &tmp_data);
1713       BLI_assert(BLI_listbase_is_empty(&tmp_data));
1714       items += tmp_items;
1715     }
1716   }
1717
1718   return items;
1719 }
1720
1721 /* Grab all Grease Pencil datablocks in file */
1722 // TODO: should this be amalgamated with the dopesheet filtering code?
1723 static size_t animdata_filter_gpencil(bAnimContext *ac,
1724                                       ListBase *anim_data,
1725                                       void *UNUSED(data),
1726                                       int filter_mode)
1727 {
1728   bDopeSheet *ads = ac->ads;
1729   size_t items = 0;
1730
1731   if (ads->filterflag & ADS_FILTER_GP_3DONLY) {
1732     Scene *scene = (Scene *)ads->source;
1733     ViewLayer *view_layer = (ViewLayer *)ac->view_layer;
1734     Base *base;
1735
1736     /* Active scene's GPencil block first - No parent item needed... */
1737     if (scene->gpd) {
1738       items += animdata_filter_gpencil_data(anim_data, ads, scene->gpd, filter_mode);
1739     }
1740
1741     /* Objects in the scene */
1742     for (base = view_layer->object_bases.first; base; base = base->next) {
1743       /* Only consider this object if it has got some GP data (saving on all the other tests) */
1744       if (base->object && (base->object->type == OB_GPENCIL)) {
1745         Object *ob = base->object;
1746
1747         /* firstly, check if object can be included, by the following factors:
1748          * - if only visible, must check for layer and also viewport visibility
1749          *   --> while tools may demand only visible, user setting takes priority
1750          *       as user option controls whether sets of channels get included while
1751          *       tool-flag takes into account collapsed/open channels too
1752          * - if only selected, must check if object is selected
1753          * - there must be animation data to edit (this is done recursively as we
1754          *   try to add the channels)
1755          */
1756         if ((filter_mode & ANIMFILTER_DATA_VISIBLE) &&
1757             !(ads->filterflag & ADS_FILTER_INCL_HIDDEN)) {
1758           /* layer visibility - we check both object and base, since these may not be in sync yet */
1759           if ((base->flag & BASE_VISIBLE) == 0)
1760             continue;
1761
1762           /* outliner restrict-flag */
1763           if (ob->restrictflag & OB_RESTRICT_VIEW)
1764             continue;
1765         }
1766
1767         /* check selection and object type filters */
1768         if ((ads->filterflag & ADS_FILTER_ONLYSEL) &&
1769             !((base->flag & BASE_SELECTED) /*|| (base == scene->basact)*/)) {
1770           /* only selected should be shown */
1771           continue;
1772         }
1773
1774         /* check if object belongs to the filtering group if option to filter
1775          * objects by the grouped status is on
1776          * - used to ease the process of doing multiple-character choreographies
1777          */
1778         if (ads->filter_grp != NULL) {
1779           if (BKE_collection_has_object_recursive(ads->filter_grp, ob) == 0)
1780             continue;
1781         }
1782
1783         /* finally, include this object's grease pencil datablock */
1784         /* XXX: Should we store these under expanders per item? */
1785         items += animdata_filter_gpencil_data(anim_data, ads, ob->data, filter_mode);
1786       }
1787     }
1788   }
1789   else {
1790     bGPdata *gpd;
1791
1792     /* Grab all Grease Pencil datablocks directly from main,
1793      * but only those that seem to be useful somewhere */
1794     for (gpd = ac->bmain->gpencils.first; gpd; gpd = gpd->id.next) {
1795       /* only show if gpd is used by something... */
1796       if (ID_REAL_USERS(gpd) < 1)
1797         continue;
1798
1799       /* add GP frames from this datablock */
1800       items += animdata_filter_gpencil_data(anim_data, ads, gpd, filter_mode);
1801     }
1802   }
1803
1804   /* return the number of items added to the list */
1805   return items;
1806 }
1807
1808 /* Helper for Grease Pencil data integrated with main DopeSheet */
1809 static size_t animdata_filter_ds_gpencil(
1810     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, bGPdata *gpd, int filter_mode)
1811 {
1812   ListBase tmp_data = {NULL, NULL};
1813   size_t tmp_items = 0;
1814   size_t items = 0;
1815
1816   /* add relevant animation channels for Grease Pencil */
1817   BEGIN_ANIMFILTER_SUBCHANNELS (EXPANDED_GPD(gpd)) {
1818     /* add animation channels */
1819     tmp_items += animfilter_block_data(ac, &tmp_data, ads, &gpd->id, filter_mode);
1820
1821     /* add Grease Pencil layers */
1822     // TODO: do these need a separate expander?
1823     // XXX:  what order should these go in?
1824   }
1825   END_ANIMFILTER_SUBCHANNELS;
1826
1827   /* did we find anything? */
1828   if (tmp_items) {
1829     /* include data-expand widget first */
1830     if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1831       /* check if filtering by active status */
1832       // XXX: active check here needs checking
1833       if (ANIMCHANNEL_ACTIVEOK(gpd)) {
1834         ANIMCHANNEL_NEW_CHANNEL(gpd, ANIMTYPE_DSGPENCIL, gpd, NULL);
1835       }
1836     }
1837
1838     /* now add the list of collected channels */
1839     BLI_movelisttolist(anim_data, &tmp_data);
1840     BLI_assert(BLI_listbase_is_empty(&tmp_data));
1841     items += tmp_items;
1842   }
1843
1844   /* return the number of items added to the list */
1845   return items;
1846 }
1847
1848 /* Helper for Cache File data integrated with main DopeSheet */
1849 static size_t animdata_filter_ds_cachefile(
1850     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, CacheFile *cache_file, int filter_mode)
1851 {
1852   ListBase tmp_data = {NULL, NULL};
1853   size_t tmp_items = 0;
1854   size_t items = 0;
1855
1856   /* add relevant animation channels for Cache File */
1857   BEGIN_ANIMFILTER_SUBCHANNELS (FILTER_CACHEFILE_OBJD(cache_file)) {
1858     /* add animation channels */
1859     tmp_items += animfilter_block_data(ac, &tmp_data, ads, &cache_file->id, filter_mode);
1860   }
1861   END_ANIMFILTER_SUBCHANNELS;
1862
1863   /* did we find anything? */
1864   if (tmp_items) {
1865     /* include data-expand widget first */
1866     if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1867       /* check if filtering by active status */
1868       // XXX: active check here needs checking
1869       if (ANIMCHANNEL_ACTIVEOK(cache_file)) {
1870         ANIMCHANNEL_NEW_CHANNEL(cache_file, ANIMTYPE_DSCACHEFILE, cache_file, NULL);
1871       }
1872     }
1873
1874     /* now add the list of collected channels */
1875     BLI_movelisttolist(anim_data, &tmp_data);
1876     BLI_assert(BLI_listbase_is_empty(&tmp_data));
1877     items += tmp_items;
1878   }
1879
1880   /* return the number of items added to the list */
1881   return items;
1882 }
1883
1884 /* Helper for Mask Editing - mask layers */
1885 static size_t animdata_filter_mask_data(ListBase *anim_data, Mask *mask, const int filter_mode)
1886 {
1887   MaskLayer *masklay_act = BKE_mask_layer_active(mask);
1888   MaskLayer *masklay;
1889   size_t items = 0;
1890
1891   /* loop over layers as the conditions are acceptable */
1892   for (masklay = mask->masklayers.first; masklay; masklay = masklay->next) {
1893     /* only if selected */
1894     if (ANIMCHANNEL_SELOK(SEL_MASKLAY(masklay))) {
1895       /* only if editable */
1896       if (!(filter_mode & ANIMFILTER_FOREDIT) || EDITABLE_MASK(masklay)) {
1897         /* active... */
1898         if (!(filter_mode & ANIMFILTER_ACTIVE) || (masklay_act == masklay)) {
1899           /* add to list */
1900           ANIMCHANNEL_NEW_CHANNEL(masklay, ANIMTYPE_MASKLAYER, mask, NULL);
1901         }
1902       }
1903     }
1904   }
1905
1906   return items;
1907 }
1908
1909 /* Grab all mask data */
1910 static size_t animdata_filter_mask(Main *bmain,
1911                                    ListBase *anim_data,
1912                                    void *UNUSED(data),
1913                                    int filter_mode)
1914 {
1915   Mask *mask;
1916   size_t items = 0;
1917
1918   /* for now, grab mask datablocks directly from main */
1919   // XXX: this is not good...
1920   for (mask = bmain->masks.first; mask; mask = mask->id.next) {
1921     ListBase tmp_data = {NULL, NULL};
1922     size_t tmp_items = 0;
1923
1924     /* only show if mask is used by something... */
1925     if (ID_REAL_USERS(mask) < 1)
1926       continue;
1927
1928     /* add mask animation channels */
1929     BEGIN_ANIMFILTER_SUBCHANNELS (EXPANDED_MASK(mask)) {
1930       tmp_items += animdata_filter_mask_data(&tmp_data, mask, filter_mode);
1931     }
1932     END_ANIMFILTER_SUBCHANNELS;
1933
1934     /* did we find anything? */
1935     if (tmp_items) {
1936       /* include data-expand widget first */
1937       if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1938         /* add mask datablock as channel too (if for drawing, and it has layers) */
1939         ANIMCHANNEL_NEW_CHANNEL(mask, ANIMTYPE_MASKDATABLOCK, NULL, NULL);
1940       }
1941
1942       /* now add the list of collected channels */
1943       BLI_movelisttolist(anim_data, &tmp_data);
1944       BLI_assert(BLI_listbase_is_empty(&tmp_data));
1945       items += tmp_items;
1946     }
1947   }
1948
1949   /* return the number of items added to the list */
1950   return items;
1951 }
1952
1953 /* NOTE: owner_id is scene, material, or texture block, which is the direct owner of the node tree in question */
1954 static size_t animdata_filter_ds_nodetree_group(bAnimContext *ac,
1955                                                 ListBase *anim_data,
1956                                                 bDopeSheet *ads,
1957                                                 ID *owner_id,
1958                                                 bNodeTree *ntree,
1959                                                 int filter_mode)
1960 {
1961   ListBase tmp_data = {NULL, NULL};
1962   size_t tmp_items = 0;
1963   size_t items = 0;
1964
1965   /* add nodetree animation channels */
1966   BEGIN_ANIMFILTER_SUBCHANNELS (FILTER_NTREE_DATA(ntree)) {
1967     /* animation data filtering */
1968     tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)ntree, filter_mode);
1969   }
1970   END_ANIMFILTER_SUBCHANNELS;
1971
1972   /* did we find anything? */
1973   if (tmp_items) {
1974     /* include data-expand widget first */
1975     if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1976       /* check if filtering by active status */
1977       if (ANIMCHANNEL_ACTIVEOK(ntree)) {
1978         ANIMCHANNEL_NEW_CHANNEL(ntree, ANIMTYPE_DSNTREE, owner_id, NULL);
1979       }
1980     }
1981
1982     /* now add the list of collected channels */
1983     BLI_movelisttolist(anim_data, &tmp_data);
1984     BLI_assert(BLI_listbase_is_empty(&tmp_data));
1985     items += tmp_items;
1986   }
1987
1988   /* return the number of items added to the list */
1989   return items;
1990 }
1991
1992 static size_t animdata_filter_ds_nodetree(bAnimContext *ac,
1993                                           ListBase *anim_data,
1994                                           bDopeSheet *ads,
1995                                           ID *owner_id,
1996                                           bNodeTree *ntree,
1997                                           int filter_mode)
1998 {
1999   bNode *node;
2000   size_t items = 0;
2001
2002   items += animdata_filter_ds_nodetree_group(ac, anim_data, ads, owner_id, ntree, filter_mode);
2003
2004   for (node = ntree->nodes.first; node; node = node->next) {
2005     if (node->type == NODE_GROUP) {
2006       if (node->id) {
2007         if ((ads->filterflag & ADS_FILTER_ONLYSEL) && (node->flag & NODE_SELECT) == 0) {
2008           continue;
2009         }
2010         /* Recurse into the node group */
2011         items += animdata_filter_ds_nodetree(ac,
2012                                              anim_data,
2013                                              ads,
2014                                              owner_id,
2015                                              (bNodeTree *)node->id,
2016                                              filter_mode | ANIMFILTER_TMP_IGNORE_ONLYSEL);
2017       }
2018     }
2019   }
2020
2021   return items;
2022 }
2023
2024 static size_t animdata_filter_ds_linestyle(
2025     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Scene *sce, int filter_mode)
2026 {
2027   ViewLayer *view_layer;
2028   FreestyleLineSet *lineset;
2029   size_t items = 0;
2030
2031   for (view_layer = sce->view_layers.first; view_layer; view_layer = view_layer->next) {
2032     for (lineset = view_layer->freestyle_config.linesets.first; lineset; lineset = lineset->next) {
2033       if (lineset->linestyle) {
2034         lineset->linestyle->id.tag |= LIB_TAG_DOIT;
2035       }
2036     }
2037   }
2038
2039   for (view_layer = sce->view_layers.first; view_layer; view_layer = view_layer->next) {
2040     /* skip render layers without Freestyle enabled */
2041     if ((view_layer->flag & VIEW_LAYER_FREESTYLE) == 0) {
2042       continue;
2043     }
2044
2045     /* loop over linesets defined in the render layer */
2046     for (lineset = view_layer->freestyle_config.linesets.first; lineset; lineset = lineset->next) {
2047       FreestyleLineStyle *linestyle = lineset->linestyle;
2048       ListBase tmp_data = {NULL, NULL};
2049       size_t tmp_items = 0;
2050
2051       if ((linestyle == NULL) || !(linestyle->id.tag & LIB_TAG_DOIT)) {
2052         continue;
2053       }
2054       linestyle->id.tag &= ~LIB_TAG_DOIT;
2055
2056       /* add scene-level animation channels */
2057       BEGIN_ANIMFILTER_SUBCHANNELS (FILTER_LS_SCED(linestyle)) {
2058         /* animation data filtering */
2059         tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)linestyle, filter_mode);
2060       }
2061       END_ANIMFILTER_SUBCHANNELS;
2062
2063       /* did we find anything? */
2064       if (tmp_items) {
2065         /* include anim-expand widget first */
2066         if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
2067           /* check if filtering by active status */
2068           if (ANIMCHANNEL_ACTIVEOK(linestyle)) {
2069             ANIMCHANNEL_NEW_CHANNEL(linestyle, ANIMTYPE_DSLINESTYLE, sce, NULL);
2070           }
2071         }
2072
2073         /* now add the list of collected channels */
2074         BLI_movelisttolist(anim_data, &tmp_data);
2075         BLI_assert(BLI_listbase_is_empty(&tmp_data));
2076         items += tmp_items;
2077       }
2078     }
2079   }
2080
2081   /* return the number of items added to the list */
2082   return items;
2083 }
2084
2085 static size_t animdata_filter_ds_texture(bAnimContext *ac,
2086                                          ListBase *anim_data,
2087                                          bDopeSheet *ads,
2088                                          Tex *tex,
2089                                          ID *owner_id,
2090                                          int filter_mode)
2091 {
2092   ListBase tmp_data = {NULL, NULL};
2093   size_t tmp_items = 0;
2094   size_t items = 0;
2095
2096   /* add texture's animation data to temp collection */
2097   BEGIN_ANIMFILTER_SUBCHANNELS (FILTER_TEX_DATA(tex)) {
2098     /* texture animdata */
2099     tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)tex, filter_mode);
2100
2101     /* nodes */
2102     if ((tex->nodetree) && !(ads->filterflag & ADS_FILTER_NONTREE)) {
2103       /* owner_id as id instead of texture, since it'll otherwise be impossible to track the depth */
2104       // FIXME: perhaps as a result, textures should NOT be included under materials, but under their own section instead
2105       // so that free-floating textures can also be animated
2106       tmp_items += animdata_filter_ds_nodetree(
2107           ac, &tmp_data, ads, (ID *)tex, tex->nodetree, filter_mode);
2108     }
2109   }
2110   END_ANIMFILTER_SUBCHANNELS;
2111
2112   /* did we find anything? */
2113   if (tmp_items) {
2114     /* include texture-expand widget? */
2115     if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
2116       /* check if filtering by active status */
2117       if (ANIMCHANNEL_ACTIVEOK(tex)) {
2118         ANIMCHANNEL_NEW_CHANNEL(tex, ANIMTYPE_DSTEX, owner_id, NULL);
2119       }
2120     }
2121
2122     /* now add the list of collected channels */
2123     BLI_movelisttolist(anim_data, &tmp_data);
2124     BLI_assert(BLI_listbase_is_empty(&tmp_data));
2125     items += tmp_items;
2126   }
2127
2128   /* return the number of items added to the list */
2129   return items;
2130 }
2131
2132 /* NOTE: owner_id is the direct owner of the texture stack in question
2133  *       It used to be Material/Light/World before the Blender Internal removal for 2.8
2134  */
2135 static size_t animdata_filter_ds_textures(
2136     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, ID *owner_id, int filter_mode)
2137 {
2138   MTex **mtex = NULL;
2139   size_t items = 0;
2140   int a = 0;
2141
2142   /* get datatype specific data first */
2143   if (owner_id == NULL)
2144     return 0;
2145
2146   switch (GS(owner_id->name)) {
2147     case ID_PA: {
2148       ParticleSettings *part = (ParticleSettings *)owner_id;
2149       mtex = (MTex **)(&part->mtex);
2150       break;
2151     }
2152     default: {
2153       /* invalid/unsupported option */
2154       if (G.debug & G_DEBUG)
2155         printf("ERROR: Unsupported owner_id (i.e. texture stack) for filter textures - %s\n",
2156                owner_id->name);
2157       return 0;
2158     }
2159   }
2160
2161   /* firstly check that we actuallly have some textures, by gathering all textures in a temp list */
2162   for (a = 0; a < MAX_MTEX; a++) {
2163     Tex *tex = (mtex[a]) ? mtex[a]->tex : NULL;
2164
2165     /* for now, if no texture returned, skip (this shouldn't confuse the user I hope) */
2166     if (tex == NULL)
2167       continue;
2168
2169     /* add texture's anim channels */
2170     items += animdata_filter_ds_texture(ac, anim_data, ads, tex, owner_id, filter_mode);
2171   }
2172
2173   /* return the number of items added to the list */
2174   return items;
2175 }
2176
2177 static size_t animdata_filter_ds_material(
2178     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Material *ma, int filter_mode)
2179 {
2180   ListBase tmp_data = {NULL, NULL};
2181   size_t tmp_items = 0;
2182   size_t items = 0;
2183
2184   /* add material's animation data to temp collection */
2185   BEGIN_ANIMFILTER_SUBCHANNELS (FILTER_MAT_OBJD(ma)) {
2186     /* material's animation data */
2187     tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)ma, filter_mode);
2188
2189     /* nodes */
2190     if ((ma->nodetree) && !(ads->filterflag & ADS_FILTER_NONTREE))
2191       tmp_items += animdata_filter_ds_nodetree(
2192           ac, &tmp_data, ads, (ID *)ma, ma->nodetree, filter_mode);
2193   }
2194   END_ANIMFILTER_SUBCHANNELS;
2195
2196   /* did we find anything? */
2197   if (tmp_items) {
2198     /* include material-expand widget first */
2199     if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
2200       /* check if filtering by active status */
2201       if (ANIMCHANNEL_ACTIVEOK(ma)) {
2202         ANIMCHANNEL_NEW_CHANNEL(ma, ANIMTYPE_DSMAT, ma, NULL);
2203       }
2204     }
2205
2206     /* now add the list of collected channels */
2207     BLI_movelisttolist(anim_data, &tmp_data);
2208     BLI_assert(BLI_listbase_is_empty(&tmp_data));
2209     items += tmp_items;
2210   }
2211
2212   return items;
2213 }
2214
2215 static size_t animdata_filter_ds_materials(
2216     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Object *ob, int filter_mode)
2217 {
2218   bool has_nested = false;
2219   size_t items = 0;
2220   int a = 0;
2221
2222   /* first pass: take the materials referenced via the Material slots of the object */
2223   for (a = 1; a <= ob->totcol; a++) {
2224     Material *ma = give_current_material(ob, a);
2225
2226     /* if material is valid, try to add relevant contents from here */
2227     if (ma) {
2228       /* add channels */
2229       items += animdata_filter_ds_material(ac, anim_data, ads, ma, filter_mode);
2230
2231       /* for optimising second pass - check if there's a nested material here to come back for */
2232       if (has_nested == false) {
2233         has_nested = (give_node_material(ma) != NULL);
2234       }
2235     }
2236   }
2237
2238   /* second pass: go through a second time looking for "nested" materials (material.material references)
2239    *
2240    * NOTE: here we ignore the expanded status of the parent, as it could be too confusing as to why these are
2241    *       disappearing/not available, since the relationships between these is not that clear
2242    */
2243   if (has_nested) {
2244     for (a = 1; a <= ob->totcol; a++) {
2245       Material *base = give_current_material(ob, a);
2246       Material *ma = give_node_material(base);
2247
2248       /* add channels from the nested material if it exists
2249        *   - skip if the same material is referenced in its node tree
2250        *     (which is common for BI materials) as that results in
2251        *     confusing duplicates
2252        */
2253       if ((ma) && (ma != base)) {
2254         items += animdata_filter_ds_material(ac, anim_data, ads, ma, filter_mode);
2255       }
2256     }
2257   }
2258
2259   /* return the number of items added to the list */
2260   return items;
2261 }
2262
2263 /* ............ */
2264
2265 /* Temporary context for modifier linked-data channel extraction */
2266 typedef struct tAnimFilterModifiersContext {
2267   bAnimContext *ac; /* anim editor context */
2268   bDopeSheet *ads;  /* dopesheet filtering settings */
2269
2270   ListBase tmp_data; /* list of channels created (but not yet added to the main list) */
2271   size_t items;      /* number of channels created */
2272
2273   int filter_mode; /* flags for stuff we want to filter */
2274 } tAnimFilterModifiersContext;
2275
2276 /* dependency walker callback for modifier dependencies */
2277 static void animfilter_modifier_idpoin_cb(void *afm_ptr,
2278                                           Object *ob,
2279                                           ID **idpoin,
2280                                           int UNUSED(cb_flag))
2281 {
2282   tAnimFilterModifiersContext *afm = (tAnimFilterModifiersContext *)afm_ptr;
2283   ID *owner_id = &ob->id;
2284   ID *id = *idpoin;
2285
2286   /* NOTE: the walker only guarantees to give us all the ID-ptr *slots*,
2287    * not just the ones which are actually used, so be careful!
2288    */
2289   if (id == NULL)
2290     return;
2291
2292   /* check if this is something we're interested in... */
2293   switch (GS(id->name)) {
2294     case ID_TE: /* Textures */
2295     {
2296       Tex *tex = (Tex *)id;
2297       if (!(afm->ads->filterflag & ADS_FILTER_NOTEX)) {
2298         afm->items += animdata_filter_ds_texture(
2299             afm->ac, &afm->tmp_data, afm->ads, tex, owner_id, afm->filter_mode);
2300       }
2301       break;
2302     }
2303
2304     /* TODO: images? */
2305     default:
2306       break;
2307   }
2308 }
2309
2310 /* animation linked to data used by modifiers
2311  * NOTE: strictly speaking, modifier animation is already included under Object level
2312  *       but for some modifiers (e.g. Displace), there can be linked data that has settings
2313  *       which would be nice to animate (i.e. texture parameters) but which are not actually
2314  *       attached to any other objects/materials/etc. in the scene
2315  */
2316 // TODO: do we want an expander for this?
2317 static size_t animdata_filter_ds_modifiers(
2318     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Object *ob, int filter_mode)
2319 {
2320   tAnimFilterModifiersContext afm = {NULL};
2321   size_t items = 0;
2322
2323   /* 1) create a temporary "context" containing all the info we have here to pass to the callback
2324    *    use to walk through the dependencies of the modifiers
2325    *
2326    * ! Assumes that all other unspecified values (i.e. accumulation buffers) are zero'd out properly
2327    */
2328   afm.ac = ac;
2329   afm.ads = ads;
2330   afm.filter_mode = filter_mode;
2331
2332   /* 2) walk over dependencies */
2333   modifiers_foreachIDLink(ob, animfilter_modifier_idpoin_cb, &afm);
2334
2335   /* 3) extract data from the context, merging it back into the standard list */
2336   if (afm.items) {
2337     /* now add the list of collected channels */
2338     BLI_movelisttolist(anim_data, &afm.tmp_data);
2339     BLI_assert(BLI_listbase_is_empty(&afm.tmp_data));
2340     items += afm.items;
2341   }
2342
2343   return items;
2344 }
2345
2346 /* ............ */
2347
2348 static size_t animdata_filter_ds_particles(
2349     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Object *ob, int filter_mode)
2350 {
2351   ParticleSystem *psys;
2352   size_t items = 0;
2353
2354   for (psys = ob->particlesystem.first; psys; psys = psys->next) {
2355     ListBase tmp_data = {NULL, NULL};
2356     size_t tmp_items = 0;
2357
2358     /* if no material returned, skip - so that we don't get weird blank entries... */
2359     if (ELEM(NULL, psys->part, psys->part->adt))
2360       continue;
2361
2362     /* add particle-system's animation data to temp collection */
2363     BEGIN_ANIMFILTER_SUBCHANNELS (FILTER_PART_OBJD(psys->part)) {
2364       /* particle system's animation data */
2365       tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)psys->part, filter_mode);
2366
2367       /* textures */
2368       if (!(ads->filterflag & ADS_FILTER_NOTEX))
2369         tmp_items += animdata_filter_ds_textures(
2370             ac, &tmp_data, ads, (ID *)psys->part, filter_mode);
2371     }
2372     END_ANIMFILTER_SUBCHANNELS;
2373
2374     /* did we find anything? */
2375     if (tmp_items) {
2376       /* include particle-expand widget first */
2377       if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
2378         /* check if filtering by active status */
2379         if (ANIMCHANNEL_ACTIVEOK(psys->part)) {
2380           ANIMCHANNEL_NEW_CHANNEL(psys->part, ANIMTYPE_DSPART, psys->part, NULL);
2381         }
2382       }
2383
2384       /* now add the list of collected channels */
2385       BLI_movelisttolist(anim_data, &tmp_data);
2386       BLI_assert(BLI_listbase_is_empty(&tmp_data));
2387       items += tmp_items;
2388     }
2389   }
2390
2391   /* return the number of items added to the list */
2392   return items;
2393 }
2394
2395 static size_t animdata_filter_ds_obdata(
2396     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Object *ob, int filter_mode)
2397 {
2398   ListBase tmp_data = {NULL, NULL};
2399   size_t tmp_items = 0;
2400   size_t items = 0;
2401
2402   IdAdtTemplate *iat = ob->data;
2403   short type = 0, expanded = 0;
2404
2405   /* get settings based on data type */
2406   switch (ob->type) {
2407     case OB_CAMERA: /* ------- Camera ------------ */
2408     {
2409       Camera *ca = (Camera *)ob->data;
2410
2411       if (ads->filterflag & ADS_FILTER_NOCAM)
2412         return 0;
2413
2414       type = ANIMTYPE_DSCAM;
2415       expanded = FILTER_CAM_OBJD(ca);
2416       break;
2417     }
2418     case OB_LAMP: /* ---------- Light ----------- */
2419     {
2420       Light *la = (Light *)ob->data;
2421
2422       if (ads->filterflag & ADS_FILTER_NOLAM)
2423         return 0;
2424
2425       type = ANIMTYPE_DSLAM;
2426       expanded = FILTER_LAM_OBJD(la);
2427       break;
2428     }
2429     case OB_CURVE: /* ------- Curve ---------- */
2430     case OB_SURF:  /* ------- Nurbs Surface ---------- */
2431     case OB_FONT:  /* ------- Text Curve ---------- */
2432     {
2433       Curve *cu = (Curve *)ob->data;
2434
2435       if (ads->filterflag & ADS_FILTER_NOCUR)
2436         return 0;
2437
2438       type = ANIMTYPE_DSCUR;
2439       expanded = FILTER_CUR_OBJD(cu);
2440       break;
2441     }
2442     case OB_MBALL: /* ------- MetaBall ---------- */
2443     {
2444       MetaBall *mb = (MetaBall *)ob->data;
2445
2446       if (ads->filterflag & ADS_FILTER_NOMBA)
2447         return 0;
2448
2449       type = ANIMTYPE_DSMBALL;
2450       expanded = FILTER_MBALL_OBJD(mb);
2451       break;
2452     }
2453     case OB_ARMATURE: /* ------- Armature ---------- */
2454     {
2455       bArmature *arm = (bArmature *)ob->data;
2456
2457       if (ads->filterflag & ADS_FILTER_NOARM)
2458         return 0;
2459
2460       type = ANIMTYPE_DSARM;
2461       expanded = FILTER_ARM_OBJD(arm);
2462       break;
2463     }
2464     case OB_MESH: /* ------- Mesh ---------- */
2465     {
2466       Mesh *me = (Mesh *)ob->data;
2467
2468       if (ads->filterflag & ADS_FILTER_NOMESH)
2469         return 0;
2470
2471       type = ANIMTYPE_DSMESH;
2472       expanded = FILTER_MESH_OBJD(me);
2473       break;
2474     }
2475     case OB_LATTICE: /* ---- Lattice ---- */
2476     {
2477       Lattice *lt = (Lattice *)ob->data;
2478
2479       if (ads->filterflag & ADS_FILTER_NOLAT)
2480         return 0;
2481
2482       type = ANIMTYPE_DSLAT;
2483       expanded = FILTER_LATTICE_OBJD(lt);
2484       break;
2485     }
2486     case OB_SPEAKER: /* ---------- Speaker ----------- */
2487     {
2488       Speaker *spk = (Speaker *)ob->data;
2489
2490       type = ANIMTYPE_DSSPK;
2491       expanded = FILTER_SPK_OBJD(spk);
2492       break;
2493     }
2494   }
2495
2496   /* add object data animation channels */
2497   BEGIN_ANIMFILTER_SUBCHANNELS (expanded) {
2498     /* animation data filtering */
2499     tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)iat, filter_mode);
2500
2501     /* sub-data filtering... */
2502     switch (ob->type) {
2503       case OB_LAMP: /* light - textures + nodetree */
2504       {
2505         Light *la = ob->data;
2506         bNodeTree *ntree = la->nodetree;
2507
2508         /* nodetree */
2509         if ((ntree) && !(ads->filterflag & ADS_FILTER_NONTREE))
2510           tmp_items += animdata_filter_ds_nodetree(
2511               ac, &tmp_data, ads, &la->id, ntree, filter_mode);
2512         break;
2513       }
2514     }
2515   }
2516   END_ANIMFILTER_SUBCHANNELS;
2517
2518   /* did we find anything? */
2519   if (tmp_items) {
2520     /* include data-expand widget first */
2521     if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
2522       /* check if filtering by active status */
2523       if (ANIMCHANNEL_ACTIVEOK(iat)) {
2524         ANIMCHANNEL_NEW_CHANNEL(iat, type, iat, NULL);
2525       }
2526     }
2527
2528     /* now add the list of collected channels */
2529     BLI_movelisttolist(anim_data, &tmp_data);
2530     BLI_assert(BLI_listbase_is_empty(&tmp_data));
2531     items += tmp_items;
2532   }
2533
2534   /* return the number of items added to the list */
2535   return items;
2536 }
2537
2538 /* shapekey-level animation */
2539 static size_t animdata_filter_ds_keyanim(
2540     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Object *ob, Key *key, int filter_mode)
2541 {
2542   ListBase tmp_data = {NULL, NULL};
2543   size_t tmp_items = 0;
2544   size_t items = 0;
2545
2546   /* add shapekey-level animation channels */
2547   BEGIN_ANIMFILTER_SUBCHANNELS (FILTER_SKE_OBJD(key)) {
2548     /* animation data filtering */
2549     tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)key, filter_mode);
2550   }
2551   END_ANIMFILTER_SUBCHANNELS;
2552
2553   /* did we find anything? */
2554   if (tmp_items) {
2555     /* include key-expand widget first */
2556     if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
2557       if (ANIMCHANNEL_ACTIVEOK(key)) {
2558         ANIMCHANNEL_NEW_CHANNEL(key, ANIMTYPE_DSSKEY, ob, NULL);
2559       }
2560     }
2561
2562     /* now add the list of collected channels */
2563     BLI_movelisttolist(anim_data, &tmp_data);
2564     BLI_assert(BLI_listbase_is_empty(&tmp_data));
2565     items += tmp_items;
2566   }
2567
2568   /* return the number of items added to the list */
2569   return items;
2570 }
2571
2572 /* object-level animation */
2573 static size_t animdata_filter_ds_obanim(
2574     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Object *ob, int filter_mode)
2575 {
2576   ListBase tmp_data = {NULL, NULL};
2577   size_t tmp_items = 0;
2578   size_t items = 0;
2579
2580   AnimData *adt = ob->adt;
2581   short type = 0, expanded = 1;
2582   void *cdata = NULL;
2583
2584   /* determine the type of expander channels to use */
2585   /* this is the best way to do this for now... */
2586   ANIMDATA_FILTER_CASES(
2587       ob, /* Some useless long comment to prevent wrapping by old clang-format versions... */
2588       {/* AnimData - no channel, but consider data */},
2589       {/* NLA - no channel, but consider data */},
2590       { /* Drivers */
2591         type = ANIMTYPE_FILLDRIVERS;
2592         cdata = adt;
2593         expanded = EXPANDED_DRVD(adt);
2594       },
2595       {/* NLA Strip Controls - no dedicated channel for now (XXX) */},
2596       { /* Keyframes */
2597         type = ANIMTYPE_FILLACTD;
2598         cdata = adt->action;
2599         expanded = EXPANDED_ACTC(adt->action);
2600       });
2601
2602   /* add object-level animation channels */
2603   BEGIN_ANIMFILTER_SUBCHANNELS (expanded) {
2604     /* animation data filtering */
2605     tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)ob, filter_mode);
2606   }
2607   END_ANIMFILTER_SUBCHANNELS;
2608
2609   /* did we find anything? */
2610   if (tmp_items) {
2611     /* include anim-expand widget first */
2612     if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
2613       if (type != ANIMTYPE_NONE) {
2614         /* NOTE: active-status (and the associated checks) don't apply here... */
2615         ANIMCHANNEL_NEW_CHANNEL(cdata, type, ob, NULL);
2616       }
2617     }
2618
2619     /* now add the list of collected channels */
2620     BLI_movelisttolist(anim_data, &tmp_data);
2621     BLI_assert(BLI_listbase_is_empty(&tmp_data));
2622     items += tmp_items;
2623   }
2624
2625   /* return the number of items added to the list */
2626   return items;
2627 }
2628
2629 /* get animation channels from object2 */
2630 static size_t animdata_filter_dopesheet_ob(
2631     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Base *base, int filter_mode)
2632 {
2633   ListBase tmp_data = {NULL, NULL};
2634   Object *ob = base->object;
2635   size_t tmp_items = 0;
2636   size_t items = 0;
2637
2638   /* filter data contained under object first */
2639   BEGIN_ANIMFILTER_SUBCHANNELS (EXPANDED_OBJC(ob)) {
2640     Key *key = BKE_key_from_object(ob);
2641
2642     /* object-level animation */
2643     if ((ob->adt) && !(ads->filterflag & ADS_FILTER_NOOBJ)) {
2644       tmp_items += animdata_filter_ds_obanim(ac, &tmp_data, ads, ob, filter_mode);
2645     }
2646
2647     /* shape-key */
2648     if ((key && key->adt) && !(ads->filterflag & ADS_FILTER_NOSHAPEKEYS)) {
2649       tmp_items += animdata_filter_ds_keyanim(ac, &tmp_data, ads, ob, key, filter_mode);
2650     }
2651
2652     /* modifiers */
2653     if ((ob->modifiers.first) && !(ads->filterflag & ADS_FILTER_NOMODIFIERS)) {
2654       tmp_items += animdata_filter_ds_modifiers(ac, &tmp_data, ads, ob, filter_mode);
2655     }
2656
2657     /* materials */
2658     if ((ob->totcol) && !(ads->filterflag & ADS_FILTER_NOMAT)) {
2659       tmp_items += animdata_filter_ds_materials(ac, &tmp_data, ads, ob, filter_mode);
2660     }
2661
2662     /* object data */
2663     if (ob->data) {
2664       tmp_items += animdata_filter_ds_obdata(ac, &tmp_data, ads, ob, filter_mode);
2665     }
2666
2667     /* particles */
2668     if ((ob->particlesystem.first) && !(ads->filterflag & ADS_FILTER_NOPART)) {
2669       tmp_items += animdata_filter_ds_particles(ac, &tmp_data, ads, ob, filter_mode);
2670     }
2671
2672     /* grease pencil */
2673     if ((ob->type == OB_GPENCIL) && (ob->data) && !(ads->filterflag & ADS_FILTER_NOGPENCIL)) {
2674       tmp_items += animdata_filter_ds_gpencil(ac, &tmp_data, ads, ob->data, filter_mode);
2675     }
2676   }
2677   END_ANIMFILTER_SUBCHANNELS;
2678
2679   /* if we collected some channels, add these to the new list... */
2680   if (tmp_items) {
2681     /* firstly add object expander if required */
2682     if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
2683       /* check if filtering by selection */
2684       // XXX: double-check on this - most of the time, a lot of tools need to filter out these channels!
2685       if (ANIMCHANNEL_SELOK((base->flag & BASE_SELECTED))) {
2686         /* check if filtering by active status */
2687         if (ANIMCHANNEL_ACTIVEOK(ob)) {
2688           ANIMCHANNEL_NEW_CHANNEL(base, ANIMTYPE_OBJECT, ob, NULL);
2689         }
2690       }
2691     }
2692
2693     /* now add the list of collected channels */
2694     BLI_movelisttolist(anim_data, &tmp_data);
2695     BLI_assert(BLI_listbase_is_empty(&tmp_data));
2696     items += tmp_items;
2697   }
2698
2699   /* return the number of items added */
2700   return items;
2701 }
2702
2703 static size_t animdata_filter_ds_world(
2704     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Scene *sce, World *wo, int filter_mode)
2705 {
2706   ListBase tmp_data = {NULL, NULL};
2707   size_t tmp_items = 0;
2708   size_t items = 0;
2709
2710   /* add world animation channels */
2711   BEGIN_ANIMFILTER_SUBCHANNELS (FILTER_WOR_SCED(wo)) {
2712     /* animation data filtering */
2713     tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)wo, filter_mode);
2714
2715     /* nodes */
2716     if ((wo->nodetree) && !(ads->filterflag & ADS_FILTER_NONTREE))
2717       tmp_items += animdata_filter_ds_nodetree(
2718           ac, &tmp_data, ads, (ID *)wo, wo->nodetree, filter_mode);
2719   }
2720   END_ANIMFILTER_SUBCHANNELS;
2721
2722   /* did we find anything? */
2723   if (tmp_items) {
2724     /* include data-expand widget first */
2725     if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
2726       /* check if filtering by active status */
2727       if (ANIMCHANNEL_ACTIVEOK(wo)) {
2728         ANIMCHANNEL_NEW_CHANNEL(wo, ANIMTYPE_DSWOR, sce, NULL);
2729       }
2730     }
2731
2732     /* now add the list of collected channels */
2733     BLI_movelisttolist(anim_data, &tmp_data);
2734     BLI_assert(BLI_listbase_is_empty(&tmp_data));
2735     items += tmp_items;
2736   }
2737
2738   /* return the number of items added to the list */
2739   return items;
2740 }
2741
2742 static size_t animdata_filter_ds_scene(
2743     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Scene *sce, int filter_mode)
2744 {
2745   ListBase tmp_data = {NULL, NULL};
2746   size_t tmp_items = 0;
2747   size_t items = 0;
2748
2749   AnimData *adt = sce->adt;
2750   short type = 0, expanded = 1;
2751   void *cdata = NULL;
2752
2753   /* determine the type of expander channels to use */
2754   // this is the best way to do this for now...
2755   ANIMDATA_FILTER_CASES(
2756       sce, /* Some useless long comment to prevent wrapping by old clang-format versions... */
2757       {/* AnimData - no channel, but consider data */},
2758       {/* NLA - no channel, but consider data */},
2759       { /* Drivers */
2760         type = ANIMTYPE_FILLDRIVERS;
2761         cdata = adt;
2762         expanded = EXPANDED_DRVD(adt);
2763       },
2764       {/* NLA Strip Controls - no dedicated channel for now (XXX) */},
2765       { /* Keyframes */
2766         type = ANIMTYPE_FILLACTD;
2767         cdata = adt->action;
2768         expanded = EXPANDED_ACTC(adt->action);
2769       });
2770
2771   /* add scene-level animation channels */
2772   BEGIN_ANIMFILTER_SUBCHANNELS (expanded) {
2773     /* animation data filtering */
2774     tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)sce, filter_mode);
2775   }
2776   END_ANIMFILTER_SUBCHANNELS;
2777
2778   /* did we find anything? */
2779   if (tmp_items) {
2780     /* include anim-expand widget first */
2781     if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
2782       if (type != ANIMTYPE_NONE) {
2783         /* NOTE: active-status (and the associated checks) don't apply here... */
2784         ANIMCHANNEL_NEW_CHANNEL(cdata, type, sce, NULL);
2785       }
2786     }
2787
2788     /* now add the list of collected channels */
2789     BLI_movelisttolist(anim_data, &tmp_data);
2790     BLI_assert(BLI_listbase_is_empty(&tmp_data));
2791     items += tmp_items;
2792   }
2793
2794   /* return the number of items added to the list */
2795   return items;
2796 }
2797
2798 static size_t animdata_filter_dopesheet_scene(
2799     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Scene *sce, int filter_mode)
2800 {
2801   ListBase tmp_data = {NULL, NULL};
2802   size_t tmp_items = 0;
2803   size_t items = 0;
2804
2805   /* filter data contained under object first */
2806   BEGIN_ANIMFILTER_SUBCHANNELS (EXPANDED_SCEC(sce)) {
2807     bNodeTree *ntree = sce->nodetree;
2808     bGPdata *gpd = sce->gpd;
2809     World *wo = sce->world;
2810
2811     /* Action, Drivers, or NLA for Scene */
2812     if ((ads->filterflag & ADS_FILTER_NOSCE) == 0) {
2813       tmp_items += animdata_filter_ds_scene(ac, &tmp_data, ads, sce, filter_mode);
2814     }
2815
2816     /* world */
2817     if ((wo) && !(ads->filterflag & ADS_FILTER_NOWOR)) {
2818       tmp_items += animdata_filter_ds_world(ac, &tmp_data, ads, sce, wo, filter_mode);
2819     }
2820
2821     /* nodetree */
2822     if ((ntree) && !(ads->filterflag & ADS_FILTER_NONTREE)) {
2823       tmp_items += animdata_filter_ds_nodetree(ac, &tmp_data, ads, (ID *)sce, ntree, filter_mode);
2824     }
2825
2826     /* line styles */
2827     if ((ads->filterflag & ADS_FILTER_NOLINESTYLE) == 0) {
2828       tmp_items += animdata_filter_ds_linestyle(ac, &tmp_data, ads, sce, filter_mode);
2829     }
2830
2831     /* grease pencil */
2832     if ((gpd) && !(ads->filterflag & ADS_FILTER_NOGPENCIL)) {
2833       tmp_items += animdata_filter_ds_gpencil(ac, &tmp_data, ads, gpd, filter_mode);
2834     }
2835
2836     /* TODO: one day, when sequencer becomes its own datatype, perhaps it should be included here */
2837   }
2838   END_ANIMFILTER_SUBCHANNELS;
2839
2840   /* if we collected some channels, add these to the new list... */
2841   if (tmp_items) {
2842     /* firstly add object expander if required */
2843     if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
2844       /* check if filtering by selection */
2845       if (ANIMCHANNEL_SELOK((sce->flag & SCE_DS_SELECTED))) {
2846         /* NOTE: active-status doesn't matter for this! */
2847         ANIMCHANNEL_NEW_CHANNEL(sce, ANIMTYPE_SCENE, sce, NULL);
2848       }
2849     }
2850
2851     /* now add the list of collected channels */
2852     BLI_movelisttolist(anim_data, &tmp_data);
2853     BLI_assert(BLI_listbase_is_empty(&tmp_data));
2854     items += tmp_items;
2855   }
2856
2857   /* return the number of items added */
2858   return items;
2859 }
2860
2861 static size_t animdata_filter_ds_movieclip(
2862     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, MovieClip *clip, int filter_mode)
2863 {
2864   ListBase tmp_data = {NULL, NULL};
2865   size_t tmp_items = 0;
2866   size_t items = 0;
2867   /* add world animation channels */
2868   BEGIN_ANIMFILTER_SUBCHANNELS (EXPANDED_MCLIP(clip)) {
2869     /* animation data filtering */
2870     tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)clip, filter_mode);
2871   }
2872   END_ANIMFILTER_SUBCHANNELS;
2873   /* did we find anything? */
2874   if (tmp_items) {
2875     /* include data-expand widget first */
2876     if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
2877       /* check if filtering by active status */
2878       if (ANIMCHANNEL_ACTIVEOK(clip)) {
2879         ANIMCHANNEL_NEW_CHANNEL(clip, ANIMTYPE_DSMCLIP, clip, NULL);
2880       }
2881     }
2882     /* now add the list of collected channels */
2883     BLI_movelisttolist(anim_data, &tmp_data);
2884     BLI_assert(BLI_listbase_is_empty(&tmp_data));
2885     items += tmp_items;
2886   }
2887   /* return the number of items added to the list */
2888   return items;
2889 }
2890
2891 static size_t animdata_filter_dopesheet_movieclips(bAnimContext *ac,
2892                                                    ListBase *anim_data,
2893                                                    bDopeSheet *ads,
2894                                                    int filter_mode)
2895 {
2896   size_t items = 0;
2897   MovieClip *clip;
2898   for (clip = ac->bmain->movieclips.first; clip != NULL; clip = clip->id.next) {
2899     /* only show if gpd is used by something... */
2900     if (ID_REAL_USERS(clip) < 1) {
2901       continue;
2902     }
2903     items += animdata_filter_ds_movieclip(ac, anim_data, ads, clip, filter_mode);
2904   }
2905   /* return the number of items added to the list */
2906   return items;
2907 }
2908
2909 /* Helper for animdata_filter_dopesheet() - For checking if an object should be included or not */
2910 static bool animdata_filter_base_is_ok(bDopeSheet *ads, Base *base, int filter_mode)
2911 {
2912   Object *ob = base->object;
2913
2914   if (base->object == NULL)
2915     return false;
2916
2917   /* firstly, check if object can be included, by the following factors:
2918    * - if only visible, must check for layer and also viewport visibility
2919    *   --> while tools may demand only visible, user setting takes priority
2920    *       as user option controls whether sets of channels get included while
2921    *       tool-flag takes into account collapsed/open channels too
2922    * - if only selected, must check if object is selected
2923    * - there must be animation data to edit (this is done recursively as we
2924    *   try to add the channels)
2925    */
2926   if ((filter_mode & ANIMFILTER_DATA_VISIBLE) && !(ads->filterflag & ADS_FILTER_INCL_HIDDEN)) {
2927     /* layer visibility - we check both object and base, since these may not be in sync yet */
2928     if ((base->flag & BASE_VISIBLE) == 0)
2929       return false;
2930
2931     /* outliner restrict-flag */
2932     if (ob->restrictflag & OB_RESTRICT_VIEW)
2933       return false;
2934   }
2935
2936   /* if only F-Curves with visible flags set can be shown, check that
2937    * datablock hasn't been set to invisible
2938    */
2939   if (filter_mode & ANIMFILTER_CURVE_VISIBLE) {
2940     if ((ob->adt) && (ob->adt->flag & ADT_CURVES_NOT_VISIBLE))
2941       return false;
2942   }
2943
2944   /* Pinned curves are visible regardless of selection flags. */
2945   if ((ob->adt) && (ob->adt->flag & ADT_CURVES_ALWAYS_VISIBLE)) {
2946     return true;
2947   }
2948
2949   /* Special case.
2950    * We don't do recursive checks for pin, but we need to deal with tricky
2951    * setup like animated camera lens without animated camera location.
2952    * Without such special handle here we wouldn't be able to bin such
2953    * camera data only animation to the editor.
2954    */
2955   if (ob->adt == NULL && ob->data != NULL) {
2956     AnimData *data_adt = BKE_animdata_from_id(ob->data);
2957     if (data_adt != NULL && (data_adt->flag & ADT_CURVES_ALWAYS_VISIBLE)) {
2958       return true;
2959     }
2960   }
2961
2962   /* check selection and object type filters */
2963   if ((ads->filterflag & ADS_FILTER_ONLYSEL) &&
2964       !((base->flag & BASE_SELECTED) /*|| (base == sce->basact)*/)) {
2965     /* only selected should be shown */
2966     return false;
2967   }
2968
2969   /* check if object belongs to the filtering group if option to filter
2970    * objects by the grouped status is on
2971    * - used to ease the process of doing multiple-character choreographies
2972    */
2973   if (ads->filter_grp != NULL) {
2974     if (BKE_collection_has_object_recursive(ads->filter_grp, ob) == 0)
2975       return false;
2976   }
2977
2978   /* no reason to exclude this object... */
2979   return true;
2980 }
2981
2982 /* Helper for animdata_filter_ds_sorted_bases() - Comparison callback for two Base pointers... */
2983 static int ds_base_sorting_cmp(const void *base1_ptr, const void *base2_ptr)
2984 {
2985   const Base *b1 = *((const Base **)base1_ptr);
2986   const Base *b2 = *((const Base **)base2_ptr);
2987
2988   return strcmp(b1->object->id.name + 2, b2->object->id.name + 2);
2989 }
2990
2991 /* Get a sorted list of all the bases - for inclusion in dopesheet (when drawing channels) */
2992 static Base **animdata_filter_ds_sorted_bases(bDopeSheet *ads,
2993                                               ViewLayer *view_layer,
2994                                               int filter_mode,
2995                                               size_t *r_usable_bases)
2996 {
2997   /* Create an array with space for all the bases, but only containing the usable ones */
2998   size_t tot_bases = BLI_listbase_count(&view_layer->object_bases);
2999   size_t num_bases = 0;
3000
3001   Base **sorted_bases = MEM_mallocN(sizeof(Base *) * tot_bases, "Dopesheet Usable Sorted Bases");
3002   for (Base *base = view_layer->object_bases.first; base; base = base->next) {
3003     if (animdata_filter_base_is_ok(ads, base, filter_mode)) {
3004       sorted_bases[num_bases++] = base;
3005     }
3006   }
3007
3008   /* Sort this list of pointers (based on the names) */
3009   qsort(sorted_bases, num_bases, sizeof(Base *), ds_base_sorting_cmp);
3010
3011   /* Return list of sorted bases */
3012   *r_usable_bases = num_bases;
3013   return sorted_bases;
3014 }
3015
3016 // 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)
3017 static size_t animdata_filter_dopesheet(bAnimContext *ac,
3018                                         ListBase *anim_data,
3019                                         bDopeSheet *ads,
3020                                         int filter_mode)
3021 {
3022   Scene *scene = (Scene *)ads->source;
3023   ViewLayer *view_layer = (ViewLayer *)ac->view_layer;
3024   size_t items = 0;
3025
3026   /* check that we do indeed have a scene */
3027   if ((ads->source == NULL) || (GS(ads->source->name) != ID_SCE)) {
3028     printf("Dope Sheet Error: No scene!\n");
3029     if (G.debug & G_DEBUG)
3030       printf("\tPointer = %p, Name = '%s'\n",
3031              (void *)ads->source,
3032              (ads->source) ? ads->source->name : NULL);
3033     return 0;
3034   }
3035
3036   /* augment the filter-flags with settings based on the dopesheet filterflags
3037    * so that some temp settings can get added automagically...
3038    */
3039   if (ads->filterflag & ADS_FILTER_SELEDIT) {
3040     /* only selected F-Curves should get their keyframes considered for editability */
3041     filter_mode |= ANIMFILTER_SELEDIT;
3042   }
3043
3044   /* Cache files level animations (frame duration and such). */
3045   if (!(ads->filterflag2 & ADS_FILTER_NOCACHEFILES) && !(ads->filterflag & ADS_FILTER_ONLYSEL)) {
3046     CacheFile *cache_file = ac->bmain->cachefiles.first;
3047     for (; cache_file; cache_file = cache_file->id.next) {
3048       items += animdata_filter_ds_cachefile(ac, anim_data, ads, cache_file, filter_mode);
3049     }
3050   }
3051
3052   /* movie clip's animation */
3053   items += animdata_filter_dopesheet_movieclips(ac, anim_data, ads, filter_mode);
3054
3055   /* scene-linked animation - e.g. world, compositing nodes, scene anim (including sequencer currently) */
3056   items += animdata_filter_dopesheet_scene(ac, anim_data, ads, scene, filter_mode);
3057
3058   /* If filtering for channel drawing, we want the objects in alphabetical order,
3059    * to make it easier to predict where items are in the hierarchy
3060    * - This order only really matters if we need to show all channels in the list (e.g. for drawing)
3061    *   (XXX: What about lingering "active" flags? The order may now become unpredictable)
3062    * - Don't do this if this behavior has been turned off (i.e. due to it being too slow)
3063    * - Don't do this if there's just a single object
3064    */
3065   if ((filter_mode & ANIMFILTER_LIST_CHANNELS) && !(ads->flag & ADS_FLAG_NO_DB_SORT) &&
3066       (view_layer->object_bases.first != view_layer->object_bases.last)) {
3067     /* Filter list of bases (i.e. objects), sort them, then add their contents normally... */
3068     // TODO: Cache the old sorted order - if the set of bases hasn't changed, don't re-sort...
3069     Base **sorted_bases;
3070     size_t num_bases;
3071
3072     sorted_bases = animdata_filter_ds_sorted_bases(ads, view_layer, filter_mode, &num_bases);
3073     if (sorted_bases) {
3074       /* Add the necessary channels for these bases... */
3075       for (size_t i = 0; i < num_bases; i++) {
3076         items += animdata_filter_dopesheet_ob(ac, anim_data, ads, sorted_bases[i], filter_mode);
3077       }
3078
3079       // TODO: store something to validate whether any changes are needed?
3080
3081       /* free temporary data */
3082       MEM_freeN(sorted_bases);
3083     }
3084   }
3085   else {
3086     /* Filter and add contents of each base (i.e. object) without them sorting first
3087      * NOTE: This saves performance in cases where order doesn't matter
3088      */
3089     for (Base *base = view_layer->object_bases.first; base; base = base->next) {
3090       if (animdata_filter_base_is_ok(ads, base, filter_mode)) {
3091         /* since we're still here, this object should be usable */
3092         items += animdata_filter_dopesheet_ob(ac, anim_data, ads, base, filter_mode);
3093       }
3094     }
3095   }
3096
3097   /* return the number of items in the list */
3098   return items;
3099 }
3100
3101 /* Summary track for DopeSheet/Action Editor
3102  * - return code is whether the summary lets the other channels get drawn
3103  */
3104 static short animdata_filter_dopesheet_summary(bAnimContext *ac,
3105                                                ListBase *anim_data,
3106                                                int filter_mode,
3107                                                size_t *items)
3108 {
3109   bDopeSheet *ads = NULL;
3110
3111   /* get the DopeSheet information to use
3112    * - we should only need to deal with the DopeSheet/Action Editor,
3113    *   since all the other Animation Editors won't have this concept
3114    *   being applicable.
3115    */
3116   if ((ac && ac->sl) && (ac->spacetype == SPACE_ACTION)) {
3117     SpaceAction *saction = (SpaceAction *)ac->sl;
3118     ads = &saction->ads;
3119   }
3120   else {
3121     /* invalid space type - skip this summary channels */
3122     return 1;
3123   }
3124
3125   /* dopesheet summary
3126    * - only for drawing and/or selecting keyframes in channels, but not for real editing
3127    * - only useful for DopeSheet/Action/etc. editors where it is actually useful
3128    */
3129   if ((filter_mode & ANIMFILTER_LIST_CHANNELS) && (ads->filterflag & ADS_FILTER_SUMMARY)) {
3130     bAnimListElem *ale = make_new_animlistelem(ac, ANIMTYPE_SUMMARY, NULL, NULL);
3131     if (ale) {
3132       BLI_addtail(anim_data, ale);
3133       (*items)++;
3134     }
3135
3136     /* if summary is collapsed, don't show other channels beneath this
3137      * - this check is put inside the summary check so that it doesn't interfere with normal operation
3138      */
3139     if (ads->flag & ADS_FLAG_SUMMARY_COLLAPSED)
3140       return 0;
3141   }
3142
3143   /* the other channels beneath this can be shown */
3144   return 1;
3145 }
3146
3147 /* ......................... */
3148
3149 /* filter data associated with a channel - usually for handling summary-channels in DopeSheet */
3150 static size_t animdata_filter_animchan(bAnimContext *ac,
3151                                        ListBase *anim_data,
3152                                        bDopeSheet *ads,
3153                                        bAnimListElem *channel,
3154                                        int filter_mode)
3155 {
3156   size_t items = 0;
3157
3158   /* data to filter depends on channel type */
3159   /* NOTE: only common channel-types have been handled for now. More can be added as necessary */
3160   switch (channel->type) {
3161     case ANIMTYPE_SUMMARY:
3162       items += animdata_filter_dopesheet(ac, anim_data, ads, filter_mode);
3163       break;
3164
3165     case ANIMTYPE_SCENE:
3166       items += animdata_filter_dopesheet_scene(ac, anim_data, ads, channel->data, filter_mode);
3167       break;
3168
3169     case ANIMTYPE_OBJECT:
3170       items += animdata_filter_dopesheet_ob(ac, anim_data, ads, channel->data, filter_mode);
3171       break;
3172
3173     case ANIMTYPE_DSCACHEFILE:
3174       items += animdata_filter_ds_cachefile(ac, anim_data, ads, channel->data, filter_mode);
3175       break;
3176
3177     case ANIMTYPE_ANIMDATA:
3178       items += animfilter_block_data(ac, anim_data, ads, channel->id, filter_mode);
3179       break;
3180
3181     default:
3182       printf("ERROR: Unsupported channel type (%d) in animdata_filter_animchan()\n",
3183              channel->type);
3184       break;
3185   }
3186
3187   return items;
3188 }
3189
3190 /* ----------- Cleanup API --------------- */
3191
3192 /* Remove entries with invalid types in animation channel list */
3193 static size_t animdata_filter_remove_invalid(ListBase *anim_data)
3194 {
3195   bAnimListElem *ale, *next;
3196   size_t items = 0;
3197
3198   /* only keep entries with valid types */
3199   for (ale = anim_data->first; ale; ale = next) {
3200     next = ale->next;
3201
3202     if (ale->type == ANIMTYPE_NONE)
3203       BLI_freelinkN(anim_data, ale);
3204     else
3205       items++;
3206   }
3207
3208   return items;
3209 }
3210
3211 /* Remove duplicate entries in animation channel list */
3212 static size_t animdata_filter_remove_duplis(ListBase *anim_data)
3213 {
3214   bAnimListElem *ale, *next;
3215   GSet *gs;
3216   size_t items = 0;
3217
3218   /* build new hashtable to efficiently store and retrieve which entries have been
3219    * encountered already while searching
3220    */
3221   gs = BLI_gset_ptr_new(__func__);
3222
3223   /* loop through items, removing them from the list if a similar item occurs already */
3224   for (ale = anim_data->first; ale; ale = next) {
3225     next = ale->next;
3226
3227     /* check if hash has any record of an entry like this
3228      * - just use ale->data for now, though it would be nicer to involve
3229      *   ale->type in combination too to capture corner cases (where same data performs differently)
3230      */
3231     if (BLI_gset_add(gs, ale->data)) {
3232       /* this entry is 'unique' and can be kept */
3233       items++;
3234     }
3235     else {
3236       /* this entry isn't needed anymore */
3237       BLI_freelinkN(anim_data, ale);
3238     }
3239   }
3240
3241   /* free the hash... */
3242   BLI_gset_free(gs, NULL);
3243
3244   /* return the number of items still in the list */
3245   return items;
3246 }
3247
3248 /* ----------- Public API --------------- */
3249
3250 /* This function filters the active data source to leave only animation channels suitable for
3251  * usage by the caller. It will return the length of the list
3252  *
3253  * *anim_data: is a pointer to a ListBase, to which the filtered animation channels
3254  * will be placed for use.
3255  * filter_mode: how should the data be filtered - bitmapping accessed flags
3256  */
3257 size_t ANIM_animdata_filter(bAnimContext *ac,
3258                             ListBase *anim_data,
3259                             eAnimFilter_Flags filter_mode,
3260                             void *data,
3261                             eAnimCont_Types datatype)
3262 {
3263   size_t items = 0;
3264
3265   /* only filter data if there's somewhere to put it */
3266   if (data && anim_data) {
3267     /* firstly filter the data */
3268     switch (datatype) {
3269       /* Action-Editing Modes */
3270       case ANIMCONT_ACTION: /* 'Action Editor' */
3271       {
3272         Object *obact = ac->obact;
3273         SpaceAction *saction = (SpaceAction *)ac->sl;
3274         bDopeSheet *ads = (saction) ? &saction->ads : NULL;
3275
3276         /* specially check for AnimData filter... [#36687] */
3277         if (UNLIKELY(filter_mode & ANIMFILTER_ANIMDATA)) {
3278           /* all channels here are within the same AnimData block, hence this special case */
3279           if (LIKELY(obact->adt)) {
3280             ANIMCHANNEL_NEW_CHANNEL(obact->adt, ANIMTYPE_ANIMDATA, (ID *)obact, NULL);
3281           }
3282         }
3283         else {
3284           /* the check for the DopeSheet summary is included here since the summary works here too */
3285           if (animdata_filter_dopesheet_summary(ac, anim_data, filter_mode, &items))
3286             items += animfilter_action(ac, anim_data, ads, data, filter_mode, (ID *)obact);
3287         }
3288
3289         break;
3290       }
3291       case ANIMCONT_SHAPEKEY: /* 'ShapeKey Editor' */
3292       {
3293         Key *key = (Key *)data;
3294
3295         /* specially check for AnimData filter... [#36687] */
3296         if (UNLIKELY(filter_mode & ANIMFILTER_ANIMDATA)) {
3297           /* all channels here are within the same AnimData block, hence this special case */
3298           if (LIKELY(key->adt)) {
3299             ANIMCHANNEL_NEW_CHANNEL(key->adt, ANIMTYPE_ANIMDATA, (ID *)key, NULL);
3300           }
3301         }
3302         else {
3303           /* the check for the DopeSheet summary is included here since the summary works here too */
3304           if (animdata_filter_dopesheet_summary(ac, anim_data, filter_mode, &items))
3305             items = animdata_filter_shapekey(ac, anim_data, key, filter_mode);
3306         }
3307
3308         break;
3309       }
3310
3311       /* Modes for Specialty Data Types (i.e. not keyframes) */
3312       case ANIMCONT_GPENCIL: {
3313         if (animdata_filter_dopesheet_summary(ac, anim_data, filter_mode, &items))
3314           items = animdata_filter_gpencil(ac, anim_data, data, filter_mode);
3315         break;
3316       }
3317       case ANIMCONT_MASK: {
3318         if (animdata_filter_dopesheet_summary(ac, anim_data, filter_mode, &items))
3319           items = animdata_filter_mask(ac->bmain, anim_data, data, filter_mode);
3320         break;
3321       }
3322
3323       /* DopeSheet Based Modes */
3324       case ANIMCONT_DOPESHEET: /* 'DopeSheet Editor' */
3325       {
3326         /* the DopeSheet editor is the primary place where the DopeSheet summaries are useful */
3327         if (animdata_filter_dopesheet_summary(ac, anim_data, filter_mode, &items))
3328           items += animdata_filter_dopesheet(ac, anim_data, data, filter_mode);
3329         break;
3330       }
3331       case ANIMCONT_FCURVES: /* Graph Editor -> F-Curves/Animation Editing */
3332       case ANIMCONT_DRIVERS: /* Graph Editor -> Drivers Editing */
3333       case ANIMCONT_NLA:     /* NLA Editor */
3334       {
3335         /* all of these editors use the basic DopeSheet data for filtering options,
3336          * but don't have all the same features */
3337         items = animdata_filter_dopesheet(ac, anim_data, data, filter_mode);
3338         break;
3339       }
3340
3341       /* Timeline Mode - Basically the same as dopesheet, except we only have the summary for now */
3342       case ANIMCONT_TIMELINE: {
3343         /* the DopeSheet editor is the primary place where the DopeSheet summaries are useful */
3344         if (animdata_filter_dopesheet_summary(ac, anim_data, filter_mode, &items))
3345           items += animdata_filter_dopesheet(ac, anim_data, data, filter_mode);
3346         break;
3347       }
3348
3349       /* Special/Internal Use */
3350       case ANIMCONT_CHANNEL: /* animation channel */
3351       {
3352         bDopeSheet *ads = ac->ads;
3353
3354         /* based on the channel type, filter relevant data for this */
3355         items = animdata_filter_animchan(ac, anim_data, ads, data, filter_mode);
3356         break;
3357       }
3358
3359       /* unhandled */
3360       default: {
3361         printf("ANIM_animdata_filter() - Invalid datatype argument %u\n", datatype);
3362         break;
3363       }
3364     }
3365
3366     /* remove any 'weedy' entries */
3367     items = animdata_filter_remove_invalid(anim_data);
3368
3369     /* remove duplicates (if required) */
3370     if (filter_mode & ANIMFILTER_NODUPLIS)
3371       items = animdata_filter_remove_duplis(anim_data);
3372   }
3373
3374   /* return the number of items in the list */
3375   return items;
3376 }
3377
3378 /* ************************************************************ */