b5891a03f0a448f6e5f91442a5ab65d99547c2b6
[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   {
1315     /* special filter so that we can get just the F-Curves within the active group */
1316     if (!(filter_mode & ANIMFILTER_ACTGROUPED) || (agrp->flag & AGRP_ACTIVE)) {
1317       /* for the Graph Editor, curves may be set to not be visible in the view to lessen
1318        * clutter, but to do this, we need to check that the group doesn't have it's
1319        * not-visible flag set preventing all its sub-curves to be shown
1320        */
1321       if (!(filter_mode & ANIMFILTER_CURVE_VISIBLE) || !(agrp->flag & AGRP_NOTVISIBLE)) {
1322         /* group must be editable for its children to be editable (if we care about this) */
1323         if (!(filter_mode & ANIMFILTER_FOREDIT) || EDITABLE_AGRP(agrp)) {
1324           /* get first F-Curve which can be used here */
1325           FCurve *first_fcu = animfilter_fcurve_next(
1326               ads, agrp->channels.first, ANIMTYPE_FCURVE, filter_mode, agrp, owner_id);
1327
1328           /* filter list, starting from this F-Curve */
1329           tmp_items += animfilter_fcurves(
1330               &tmp_data, ads, first_fcu, ANIMTYPE_FCURVE, filter_mode, agrp, owner_id, &act->id);
1331         }
1332       }
1333     }
1334   }
1335   END_ANIMFILTER_SUBCHANNELS;
1336
1337   /* did we find anything? */
1338   if (tmp_items) {
1339     /* add this group as a channel first */
1340     if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1341       /* restore original filter mode so that this next step works ok... */
1342       //filter_mode = ofilter;
1343
1344       /* filter selection of channel specially here again,
1345        * since may be open and not subject to previous test */
1346       if (ANIMCHANNEL_SELOK(SEL_AGRP(agrp))) {
1347         ANIMCHANNEL_NEW_CHANNEL(agrp, ANIMTYPE_GROUP, owner_id, &act->id);
1348       }
1349     }
1350
1351     /* now add the list of collected channels */
1352     BLI_movelisttolist(anim_data, &tmp_data);
1353     BLI_assert(BLI_listbase_is_empty(&tmp_data));
1354     items += tmp_items;
1355   }
1356
1357   /* return the number of items added to the list */
1358   return items;
1359 }
1360
1361 static size_t animfilter_action(bAnimContext *ac,
1362                                 ListBase *anim_data,
1363                                 bDopeSheet *ads,
1364                                 bAction *act,
1365                                 int filter_mode,
1366                                 ID *owner_id)
1367 {
1368   bActionGroup *agrp;
1369   FCurve *lastchan = NULL;
1370   size_t items = 0;
1371
1372   /* don't include anything from this action if it is linked in from another file,
1373    * and we're getting stuff for editing...
1374    */
1375   if ((filter_mode & ANIMFILTER_FOREDIT) && ID_IS_LINKED(act))
1376     return 0;
1377
1378   /* do groups */
1379   // TODO: do nested groups?
1380   for (agrp = act->groups.first; agrp; agrp = agrp->next) {
1381     /* store reference to last channel of group */
1382     if (agrp->channels.last)
1383       lastchan = agrp->channels.last;
1384
1385     /* action group's channels */
1386     items += animfilter_act_group(ac, anim_data, ads, act, agrp, filter_mode, owner_id);
1387   }
1388
1389   /* un-grouped F-Curves (only if we're not only considering those channels in the active group) */
1390   if (!(filter_mode & ANIMFILTER_ACTGROUPED)) {
1391     FCurve *firstfcu = (lastchan) ? (lastchan->next) : (act->curves.first);
1392     items += animfilter_fcurves(
1393         anim_data, ads, firstfcu, ANIMTYPE_FCURVE, filter_mode, NULL, owner_id, &act->id);
1394   }
1395
1396   /* return the number of items added to the list */
1397   return items;
1398 }
1399
1400 /* Include NLA-Data for NLA-Editor:
1401  * - when ANIMFILTER_LIST_CHANNELS is used, that means we should be filtering the list for display
1402  *   Although the evaluation order is from the first track to the last and then apply the Action on top,
1403  *   we present this in the UI as the Active Action followed by the last track to the first so that we
1404  *   get the evaluation order presented as per a stack.
1405  * - for normal filtering (i.e. for editing), we only need the NLA-tracks but they can be in 'normal' evaluation
1406  *   order, i.e. first to last. Otherwise, some tools may get screwed up.
1407  */
1408 static size_t animfilter_nla(bAnimContext *UNUSED(ac),
1409                              ListBase *anim_data,
1410                              bDopeSheet *ads,
1411                              AnimData *adt,
1412                              int filter_mode,
1413                              ID *owner_id)
1414 {
1415   NlaTrack *nlt;
1416   NlaTrack *first = NULL, *next = NULL;
1417   size_t items = 0;
1418
1419   /* if showing channels, include active action */
1420   if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1421     /* if NLA action-line filtering is off, don't show unless there are keyframes,
1422      * in order to keep things more compact for doing transforms
1423      */
1424     if (!(ads->filterflag & ADS_FILTER_NLA_NOACT) || (adt->action)) {
1425       /* there isn't really anything editable here, so skip if need editable */
1426       if ((filter_mode & ANIMFILTER_FOREDIT) == 0) {
1427         /* just add the action track now (this MUST appear for drawing)
1428          * - as AnimData may not have an action, we pass a dummy pointer just to get the list elem created, then
1429          *   overwrite this with the real value - REVIEW THIS...
1430          */
1431         ANIMCHANNEL_NEW_CHANNEL_FULL((void *)(&adt->action), ANIMTYPE_NLAACTION, owner_id, NULL, {
1432           ale->data = adt->action ? adt->action : NULL;
1433         });
1434       }
1435     }
1436
1437     /* first track to include will be the last one if we're filtering by channels */
1438     first = adt->nla_tracks.last;
1439   }
1440   else {
1441     /* first track to include will the first one (as per normal) */
1442     first = adt->nla_tracks.first;
1443   }
1444
1445   /* loop over NLA Tracks - assume that the caller of this has already checked that these should be included */
1446   for (nlt = first; nlt; nlt = next) {
1447     /* 'next' NLA-Track to use depends on whether we're filtering for drawing or not */
1448     if (filter_mode & ANIMFILTER_LIST_CHANNELS)
1449       next = nlt->prev;
1450     else
1451       next = nlt->next;
1452
1453     /* if we're in NLA-tweakmode, don't show this track if it was disabled (due to tweaking) for now
1454      * - active track should still get shown though (even though it has disabled flag set)
1455      */
1456     // FIXME: the channels after should still get drawn, just 'differently', and after an active-action channel
1457     if ((adt->flag & ADT_NLA_EDIT_ON) && (nlt->flag & NLATRACK_DISABLED) &&
1458         (adt->act_track != nlt))
1459       continue;
1460
1461     /* only work with this channel and its subchannels if it is editable */
1462     if (!(filter_mode & ANIMFILTER_FOREDIT) || EDITABLE_NLT(nlt)) {
1463       /* only include this track if selected in a way consistent with the filtering requirements */
1464       if (ANIMCHANNEL_SELOK(SEL_NLT(nlt))) {
1465         /* only include if this track is active */
1466         if (!(filter_mode & ANIMFILTER_ACTIVE) || (nlt->flag & NLATRACK_ACTIVE)) {
1467           /* name based filtering... */
1468           if (((ads) && (ads->searchstr[0] != '\0')) && (owner_id)) {
1469             bool track_ok = false, strip_ok = false;
1470
1471             /* check if the name of the track, or the strips it has are ok... */
1472             track_ok = name_matches_dopesheet_filter(ads, nlt->name);
1473
1474             if (track_ok == false) {
1475               NlaStrip *strip;
1476               for (strip = nlt->strips.first; strip; strip = strip->next) {
1477                 if (name_matches_dopesheet_filter(ads, strip->name)) {
1478                   strip_ok = true;
1479                   break;
1480                 }
1481               }
1482             }
1483
1484             /* skip if both fail this test... */
1485             if (!track_ok && !strip_ok) {
1486               continue;
1487             }
1488           }
1489
1490           /* add the track now that it has passed all our tests */
1491           ANIMCHANNEL_NEW_CHANNEL(nlt, ANIMTYPE_NLATRACK, owner_id, NULL);
1492         }
1493       }
1494     }
1495   }
1496
1497   /* return the number of items added to the list */
1498   return items;
1499 }
1500
1501 /* Include the control FCurves per NLA Strip in the channel list
1502  * NOTE: This is includes the expander too...
1503  */
1504 static size_t animfilter_nla_controls(
1505     ListBase *anim_data, bDopeSheet *ads, AnimData *adt, int filter_mode, ID *owner_id)
1506 {
1507   ListBase tmp_data = {NULL, NULL};
1508   size_t tmp_items = 0;
1509   size_t items = 0;
1510
1511   /* add control curves from each NLA strip... */
1512   /* NOTE: ANIMTYPE_FCURVES are created here, to avoid duplicating the code needed */
1513   BEGIN_ANIMFILTER_SUBCHANNELS(((adt->flag & ADT_NLA_SKEYS_COLLAPSED) == 0))
1514   {
1515     NlaTrack *nlt;
1516     NlaStrip *strip;
1517
1518     /* for now, we only go one level deep - so controls on grouped FCurves are not handled */
1519     for (nlt = adt->nla_tracks.first; nlt; nlt = nlt->next) {
1520       for (strip = nlt->strips.first; strip; strip = strip->next) {
1521         /* pass strip as the "owner", so that the name lookups (used while filtering) will resolve */
1522         /* NLA tracks are coming from AnimData, so owner of f-curves
1523          * is the same as owner of animation data. */
1524         tmp_items += animfilter_fcurves(&tmp_data,
1525                                         ads,
1526                                         strip->fcurves.first,
1527                                         ANIMTYPE_NLACURVE,
1528                                         filter_mode,
1529                                         strip,
1530                                         owner_id,
1531                                         owner_id);
1532       }
1533     }
1534   }
1535   END_ANIMFILTER_SUBCHANNELS;
1536
1537   /* did we find anything? */
1538   if (tmp_items) {
1539     /* add the expander as a channel first */
1540     if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1541       /* currently these channels cannot be selected, so they should be skipped */
1542       if ((filter_mode & (ANIMFILTER_SEL | ANIMFILTER_UNSEL)) == 0) {
1543         ANIMCHANNEL_NEW_CHANNEL(adt, ANIMTYPE_NLACONTROLS, owner_id, NULL);
1544       }
1545     }
1546
1547     /* now add the list of collected channels */
1548     BLI_movelisttolist(anim_data, &tmp_data);
1549     BLI_assert(BLI_listbase_is_empty(&tmp_data));
1550     items += tmp_items;
1551   }
1552
1553   /* return the number of items added to the list */
1554   return items;
1555 }
1556
1557 /* determine what animation data from AnimData block should get displayed */
1558 static size_t animfilter_block_data(
1559     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, ID *id, int filter_mode)
1560 {
1561   AnimData *adt = BKE_animdata_from_id(id);
1562   size_t items = 0;
1563
1564   /* image object datablocks have no anim-data so check for NULL */
1565   if (adt) {
1566     IdAdtTemplate *iat = (IdAdtTemplate *)id;
1567
1568     /* NOTE: this macro is used instead of inlining the logic here, since this sort of filtering is still needed
1569      * in a few places in the rest of the code still - notably for the few cases where special mode-based
1570      * different types of data expanders are required.
1571      */
1572     ANIMDATA_FILTER_CASES(
1573         iat,
1574         { /* AnimData */
1575           /* specifically filter animdata block */
1576           if (ANIMCHANNEL_SELOK(SEL_ANIMDATA(adt))) {
1577             ANIMCHANNEL_NEW_CHANNEL(adt, ANIMTYPE_ANIMDATA, id, NULL);
1578           }
1579         },
1580         { /* NLA */
1581           items += animfilter_nla(ac, anim_data, ads, adt, filter_mode, id);
1582         },
1583         { /* Drivers */
1584           items += animfilter_fcurves(
1585               anim_data, ads, adt->drivers.first, ANIMTYPE_FCURVE, filter_mode, NULL, id, id);
1586         },
1587         { /* NLA Control Keyframes */
1588           items += animfilter_nla_controls(anim_data, ads, adt, filter_mode, id);
1589         },
1590         { /* Keyframes */
1591           items += animfilter_action(ac, anim_data, ads, adt->action, filter_mode, id);
1592         });
1593   }
1594
1595   return items;
1596 }
1597
1598 /* Include ShapeKey Data for ShapeKey Editor */
1599 static size_t animdata_filter_shapekey(bAnimContext *ac,
1600                                        ListBase *anim_data,
1601                                        Key *key,
1602                                        int filter_mode)
1603 {
1604   size_t items = 0;
1605
1606   /* check if channels or only F-Curves */
1607   if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1608     KeyBlock *kb;
1609
1610     /* loop through the channels adding ShapeKeys as appropriate */
1611     for (kb = key->block.first; kb; kb = kb->next) {
1612       /* skip the first one, since that's the non-animatable basis */
1613       if (kb == key->block.first)
1614         continue;
1615
1616       /* only work with this channel and its subchannels if it is editable */
1617       if (!(filter_mode & ANIMFILTER_FOREDIT) || EDITABLE_SHAPEKEY(kb)) {
1618         /* only include this track if selected in a way consistent with the filtering requirements */
1619         if (ANIMCHANNEL_SELOK(SEL_SHAPEKEY(kb))) {
1620           // TODO: consider 'active' too?
1621
1622           /* owner-id here must be key so that the F-Curve can be resolved... */
1623           ANIMCHANNEL_NEW_CHANNEL(kb, ANIMTYPE_SHAPEKEY, key, NULL);
1624         }
1625       }
1626     }
1627   }
1628   else {
1629     /* just use the action associated with the shapekey */
1630     // TODO: somehow manage to pass dopesheet info down here too?
1631     if (key->adt) {
1632       if (filter_mode & ANIMFILTER_ANIMDATA) {
1633         if (ANIMCHANNEL_SELOK(SEL_ANIMDATA(key->adt))) {
1634           ANIMCHANNEL_NEW_CHANNEL(key->adt, ANIMTYPE_ANIMDATA, key, NULL);
1635         }
1636       }
1637       else if (key->adt->action) {
1638         items = animfilter_action(ac, anim_data, NULL, key->adt->action, filter_mode, (ID *)key);
1639       }
1640     }
1641   }
1642
1643   /* return the number of items added to the list */
1644   return items;
1645 }
1646
1647 /* Helper for Grease Pencil - layers within a datablock */
1648 static size_t animdata_filter_gpencil_layers_data(ListBase *anim_data,
1649                                                   bDopeSheet *ads,
1650                                                   bGPdata *gpd,
1651                                                   int filter_mode)
1652 {
1653   bGPDlayer *gpl;
1654   size_t items = 0;
1655
1656   /* loop over layers as the conditions are acceptable (top-Down order) */
1657   for (gpl = gpd->layers.last; gpl; gpl = gpl->prev) {
1658     /* only if selected */
1659     if (ANIMCHANNEL_SELOK(SEL_GPL(gpl))) {
1660       /* only if editable */
1661       if (!(filter_mode & ANIMFILTER_FOREDIT) || EDITABLE_GPL(gpl)) {
1662         /* active... */
1663         if (!(filter_mode & ANIMFILTER_ACTIVE) || (gpl->flag & GP_LAYER_ACTIVE)) {
1664           /* skip layer if the name doesn't match the filter string */
1665           if ((ads) && (ads->searchstr[0] != '\0')) {
1666             if (name_matches_dopesheet_filter(ads, gpl->info) == false)
1667               continue;
1668           }
1669           /* add to list */
1670           ANIMCHANNEL_NEW_CHANNEL(gpl, ANIMTYPE_GPLAYER, gpd, NULL);
1671         }
1672       }
1673     }
1674   }
1675
1676   return items;
1677 }
1678
1679 /* Helper for Grease Pencil - Grease Pencil datablock - GP Frames */
1680 static size_t animdata_filter_gpencil_data(ListBase *anim_data,
1681                                            bDopeSheet *ads,
1682                                            bGPdata *gpd,
1683                                            int filter_mode)
1684 {
1685   size_t items = 0;
1686
1687   /* When asked from "AnimData" blocks (i.e. the top-level containers for normal animation),
1688    * for convenience, this will return GP Datablocks instead. This may cause issues down
1689    * the track, but for now, this will do...
1690    */
1691   if (filter_mode & ANIMFILTER_ANIMDATA) {
1692     /* just add GPD as a channel - this will add everything needed */
1693     ANIMCHANNEL_NEW_CHANNEL(gpd, ANIMTYPE_GPDATABLOCK, gpd, NULL);
1694   }
1695   else {
1696     ListBase tmp_data = {NULL, NULL};
1697     size_t tmp_items = 0;
1698
1699     /* add gpencil animation channels */
1700     BEGIN_ANIMFILTER_SUBCHANNELS(EXPANDED_GPD(gpd))
1701     {
1702       tmp_items += animdata_filter_gpencil_layers_data(&tmp_data, ads, gpd, filter_mode);
1703     }
1704     END_ANIMFILTER_SUBCHANNELS;
1705
1706     /* did we find anything? */
1707     if (tmp_items) {
1708       /* include data-expand widget first */
1709       if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1710         /* add gpd as channel too (if for drawing, and it has layers) */
1711         ANIMCHANNEL_NEW_CHANNEL(gpd, ANIMTYPE_GPDATABLOCK, NULL, NULL);
1712       }
1713
1714       /* now add the list of collected channels */
1715       BLI_movelisttolist(anim_data, &tmp_data);
1716       BLI_assert(BLI_listbase_is_empty(&tmp_data));
1717       items += tmp_items;
1718     }
1719   }
1720
1721   return items;
1722 }
1723
1724 /* Grab all Grease Pencil datablocks in file */
1725 // TODO: should this be amalgamated with the dopesheet filtering code?
1726 static size_t animdata_filter_gpencil(bAnimContext *ac,
1727                                       ListBase *anim_data,
1728                                       void *UNUSED(data),
1729                                       int filter_mode)
1730 {
1731   bDopeSheet *ads = ac->ads;
1732   size_t items = 0;
1733
1734   if (ads->filterflag & ADS_FILTER_GP_3DONLY) {
1735     Scene *scene = (Scene *)ads->source;
1736     ViewLayer *view_layer = (ViewLayer *)ac->view_layer;
1737     Base *base;
1738
1739     /* Active scene's GPencil block first - No parent item needed... */
1740     if (scene->gpd) {
1741       items += animdata_filter_gpencil_data(anim_data, ads, scene->gpd, filter_mode);
1742     }
1743
1744     /* Objects in the scene */
1745     for (base = view_layer->object_bases.first; base; base = base->next) {
1746       /* Only consider this object if it has got some GP data (saving on all the other tests) */
1747       if (base->object && (base->object->type == OB_GPENCIL)) {
1748         Object *ob = base->object;
1749
1750         /* firstly, check if object can be included, by the following factors:
1751          * - if only visible, must check for layer and also viewport visibility
1752          *   --> while tools may demand only visible, user setting takes priority
1753          *       as user option controls whether sets of channels get included while
1754          *       tool-flag takes into account collapsed/open channels too
1755          * - if only selected, must check if object is selected
1756          * - there must be animation data to edit (this is done recursively as we
1757          *   try to add the channels)
1758          */
1759         if ((filter_mode & ANIMFILTER_DATA_VISIBLE) &&
1760             !(ads->filterflag & ADS_FILTER_INCL_HIDDEN)) {
1761           /* layer visibility - we check both object and base, since these may not be in sync yet */
1762           if ((base->flag & BASE_VISIBLE) == 0)
1763             continue;
1764
1765           /* outliner restrict-flag */
1766           if (ob->restrictflag & OB_RESTRICT_VIEW)
1767             continue;
1768         }
1769
1770         /* check selection and object type filters */
1771         if ((ads->filterflag & ADS_FILTER_ONLYSEL) &&
1772             !((base->flag & BASE_SELECTED) /*|| (base == scene->basact)*/)) {
1773           /* only selected should be shown */
1774           continue;
1775         }
1776
1777         /* check if object belongs to the filtering group if option to filter
1778          * objects by the grouped status is on
1779          * - used to ease the process of doing multiple-character choreographies
1780          */
1781         if (ads->filter_grp != NULL) {
1782           if (BKE_collection_has_object_recursive(ads->filter_grp, ob) == 0)
1783             continue;
1784         }
1785
1786         /* finally, include this object's grease pencil datablock */
1787         /* XXX: Should we store these under expanders per item? */
1788         items += animdata_filter_gpencil_data(anim_data, ads, ob->data, filter_mode);
1789       }
1790     }
1791   }
1792   else {
1793     bGPdata *gpd;
1794
1795     /* Grab all Grease Pencil datablocks directly from main,
1796      * but only those that seem to be useful somewhere */
1797     for (gpd = ac->bmain->gpencils.first; gpd; gpd = gpd->id.next) {
1798       /* only show if gpd is used by something... */
1799       if (ID_REAL_USERS(gpd) < 1)
1800         continue;
1801
1802       /* add GP frames from this datablock */
1803       items += animdata_filter_gpencil_data(anim_data, ads, gpd, filter_mode);
1804     }
1805   }
1806
1807   /* return the number of items added to the list */
1808   return items;
1809 }
1810
1811 /* Helper for Grease Pencil data integrated with main DopeSheet */
1812 static size_t animdata_filter_ds_gpencil(
1813     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, bGPdata *gpd, int filter_mode)
1814 {
1815   ListBase tmp_data = {NULL, NULL};
1816   size_t tmp_items = 0;
1817   size_t items = 0;
1818
1819   /* add relevant animation channels for Grease Pencil */
1820   BEGIN_ANIMFILTER_SUBCHANNELS(EXPANDED_GPD(gpd))
1821   {
1822     /* add animation channels */
1823     tmp_items += animfilter_block_data(ac, &tmp_data, ads, &gpd->id, filter_mode);
1824
1825     /* add Grease Pencil layers */
1826     // TODO: do these need a separate expander?
1827     // XXX:  what order should these go in?
1828   }
1829   END_ANIMFILTER_SUBCHANNELS;
1830
1831   /* did we find anything? */
1832   if (tmp_items) {
1833     /* include data-expand widget first */
1834     if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1835       /* check if filtering by active status */
1836       // XXX: active check here needs checking
1837       if (ANIMCHANNEL_ACTIVEOK(gpd)) {
1838         ANIMCHANNEL_NEW_CHANNEL(gpd, ANIMTYPE_DSGPENCIL, gpd, NULL);
1839       }
1840     }
1841
1842     /* now add the list of collected channels */
1843     BLI_movelisttolist(anim_data, &tmp_data);
1844     BLI_assert(BLI_listbase_is_empty(&tmp_data));
1845     items += tmp_items;
1846   }
1847
1848   /* return the number of items added to the list */
1849   return items;
1850 }
1851
1852 /* Helper for Cache File data integrated with main DopeSheet */
1853 static size_t animdata_filter_ds_cachefile(
1854     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, CacheFile *cache_file, int filter_mode)
1855 {
1856   ListBase tmp_data = {NULL, NULL};
1857   size_t tmp_items = 0;
1858   size_t items = 0;
1859
1860   /* add relevant animation channels for Cache File */
1861   BEGIN_ANIMFILTER_SUBCHANNELS(FILTER_CACHEFILE_OBJD(cache_file))
1862   {
1863     /* add animation channels */
1864     tmp_items += animfilter_block_data(ac, &tmp_data, ads, &cache_file->id, filter_mode);
1865   }
1866   END_ANIMFILTER_SUBCHANNELS;
1867
1868   /* did we find anything? */
1869   if (tmp_items) {
1870     /* include data-expand widget first */
1871     if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1872       /* check if filtering by active status */
1873       // XXX: active check here needs checking
1874       if (ANIMCHANNEL_ACTIVEOK(cache_file)) {
1875         ANIMCHANNEL_NEW_CHANNEL(cache_file, ANIMTYPE_DSCACHEFILE, cache_file, NULL);
1876       }
1877     }
1878
1879     /* now add the list of collected channels */
1880     BLI_movelisttolist(anim_data, &tmp_data);
1881     BLI_assert(BLI_listbase_is_empty(&tmp_data));
1882     items += tmp_items;
1883   }
1884
1885   /* return the number of items added to the list */
1886   return items;
1887 }
1888
1889 /* Helper for Mask Editing - mask layers */
1890 static size_t animdata_filter_mask_data(ListBase *anim_data, Mask *mask, const int filter_mode)
1891 {
1892   MaskLayer *masklay_act = BKE_mask_layer_active(mask);
1893   MaskLayer *masklay;
1894   size_t items = 0;
1895
1896   /* loop over layers as the conditions are acceptable */
1897   for (masklay = mask->masklayers.first; masklay; masklay = masklay->next) {
1898     /* only if selected */
1899     if (ANIMCHANNEL_SELOK(SEL_MASKLAY(masklay))) {
1900       /* only if editable */
1901       if (!(filter_mode & ANIMFILTER_FOREDIT) || EDITABLE_MASK(masklay)) {
1902         /* active... */
1903         if (!(filter_mode & ANIMFILTER_ACTIVE) || (masklay_act == masklay)) {
1904           /* add to list */
1905           ANIMCHANNEL_NEW_CHANNEL(masklay, ANIMTYPE_MASKLAYER, mask, NULL);
1906         }
1907       }
1908     }
1909   }
1910
1911   return items;
1912 }
1913
1914 /* Grab all mask data */
1915 static size_t animdata_filter_mask(Main *bmain,
1916                                    ListBase *anim_data,
1917                                    void *UNUSED(data),
1918                                    int filter_mode)
1919 {
1920   Mask *mask;
1921   size_t items = 0;
1922
1923   /* for now, grab mask datablocks directly from main */
1924   // XXX: this is not good...
1925   for (mask = bmain->masks.first; mask; mask = mask->id.next) {
1926     ListBase tmp_data = {NULL, NULL};
1927     size_t tmp_items = 0;
1928
1929     /* only show if mask is used by something... */
1930     if (ID_REAL_USERS(mask) < 1)
1931       continue;
1932
1933     /* add mask animation channels */
1934     BEGIN_ANIMFILTER_SUBCHANNELS(EXPANDED_MASK(mask))
1935     {
1936       tmp_items += animdata_filter_mask_data(&tmp_data, mask, filter_mode);
1937     }
1938     END_ANIMFILTER_SUBCHANNELS;
1939
1940     /* did we find anything? */
1941     if (tmp_items) {
1942       /* include data-expand widget first */
1943       if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1944         /* add mask datablock as channel too (if for drawing, and it has layers) */
1945         ANIMCHANNEL_NEW_CHANNEL(mask, ANIMTYPE_MASKDATABLOCK, NULL, NULL);
1946       }
1947
1948       /* now add the list of collected channels */
1949       BLI_movelisttolist(anim_data, &tmp_data);
1950       BLI_assert(BLI_listbase_is_empty(&tmp_data));
1951       items += tmp_items;
1952     }
1953   }
1954
1955   /* return the number of items added to the list */
1956   return items;
1957 }
1958
1959 /* NOTE: owner_id is scene, material, or texture block, which is the direct owner of the node tree in question */
1960 static size_t animdata_filter_ds_nodetree_group(bAnimContext *ac,
1961                                                 ListBase *anim_data,
1962                                                 bDopeSheet *ads,
1963                                                 ID *owner_id,
1964                                                 bNodeTree *ntree,
1965                                                 int filter_mode)
1966 {
1967   ListBase tmp_data = {NULL, NULL};
1968   size_t tmp_items = 0;
1969   size_t items = 0;
1970
1971   /* add nodetree animation channels */
1972   BEGIN_ANIMFILTER_SUBCHANNELS(FILTER_NTREE_DATA(ntree))
1973   {
1974     /* animation data filtering */
1975     tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)ntree, filter_mode);
1976   }
1977   END_ANIMFILTER_SUBCHANNELS;
1978
1979   /* did we find anything? */
1980   if (tmp_items) {
1981     /* include data-expand widget first */
1982     if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1983       /* check if filtering by active status */
1984       if (ANIMCHANNEL_ACTIVEOK(ntree)) {
1985         ANIMCHANNEL_NEW_CHANNEL(ntree, ANIMTYPE_DSNTREE, owner_id, NULL);
1986       }
1987     }
1988
1989     /* now add the list of collected channels */
1990     BLI_movelisttolist(anim_data, &tmp_data);
1991     BLI_assert(BLI_listbase_is_empty(&tmp_data));
1992     items += tmp_items;
1993   }
1994
1995   /* return the number of items added to the list */
1996   return items;
1997 }
1998
1999 static size_t animdata_filter_ds_nodetree(bAnimContext *ac,
2000                                           ListBase *anim_data,
2001                                           bDopeSheet *ads,
2002                                           ID *owner_id,
2003                                           bNodeTree *ntree,
2004                                           int filter_mode)
2005 {
2006   bNode *node;
2007   size_t items = 0;
2008
2009   items += animdata_filter_ds_nodetree_group(ac, anim_data, ads, owner_id, ntree, filter_mode);
2010
2011   for (node = ntree->nodes.first; node; node = node->next) {
2012     if (node->type == NODE_GROUP) {
2013       if (node->id) {
2014         if ((ads->filterflag & ADS_FILTER_ONLYSEL) && (node->flag & NODE_SELECT) == 0) {
2015           continue;
2016         }
2017         /* Recurse into the node group */
2018         items += animdata_filter_ds_nodetree(ac,
2019                                              anim_data,
2020                                              ads,
2021                                              owner_id,
2022                                              (bNodeTree *)node->id,
2023                                              filter_mode | ANIMFILTER_TMP_IGNORE_ONLYSEL);
2024       }
2025     }
2026   }
2027
2028   return items;
2029 }
2030
2031 static size_t animdata_filter_ds_linestyle(
2032     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Scene *sce, int filter_mode)
2033 {
2034   ViewLayer *view_layer;
2035   FreestyleLineSet *lineset;
2036   size_t items = 0;
2037
2038   for (view_layer = sce->view_layers.first; view_layer; view_layer = view_layer->next) {
2039     for (lineset = view_layer->freestyle_config.linesets.first; lineset; lineset = lineset->next) {
2040       if (lineset->linestyle) {
2041         lineset->linestyle->id.tag |= LIB_TAG_DOIT;
2042       }
2043     }
2044   }
2045
2046   for (view_layer = sce->view_layers.first; view_layer; view_layer = view_layer->next) {
2047     /* skip render layers without Freestyle enabled */
2048     if ((view_layer->flag & VIEW_LAYER_FREESTYLE) == 0) {
2049       continue;
2050     }
2051
2052     /* loop over linesets defined in the render layer */
2053     for (lineset = view_layer->freestyle_config.linesets.first; lineset; lineset = lineset->next) {
2054       FreestyleLineStyle *linestyle = lineset->linestyle;
2055       ListBase tmp_data = {NULL, NULL};
2056       size_t tmp_items = 0;
2057
2058       if ((linestyle == NULL) || !(linestyle->id.tag & LIB_TAG_DOIT)) {
2059         continue;
2060       }
2061       linestyle->id.tag &= ~LIB_TAG_DOIT;
2062
2063       /* add scene-level animation channels */
2064       BEGIN_ANIMFILTER_SUBCHANNELS(FILTER_LS_SCED(linestyle))
2065       {
2066         /* animation data filtering */
2067         tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)linestyle, filter_mode);
2068       }
2069       END_ANIMFILTER_SUBCHANNELS;
2070
2071       /* did we find anything? */
2072       if (tmp_items) {
2073         /* include anim-expand widget first */
2074         if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
2075           /* check if filtering by active status */
2076           if (ANIMCHANNEL_ACTIVEOK(linestyle)) {
2077             ANIMCHANNEL_NEW_CHANNEL(linestyle, ANIMTYPE_DSLINESTYLE, sce, NULL);
2078           }
2079         }
2080
2081         /* now add the list of collected channels */
2082         BLI_movelisttolist(anim_data, &tmp_data);
2083         BLI_assert(BLI_listbase_is_empty(&tmp_data));
2084         items += tmp_items;
2085       }
2086     }
2087   }
2088
2089   /* return the number of items added to the list */
2090   return items;
2091 }
2092
2093 static size_t animdata_filter_ds_texture(bAnimContext *ac,
2094                                          ListBase *anim_data,
2095                                          bDopeSheet *ads,
2096                                          Tex *tex,
2097                                          ID *owner_id,
2098                                          int filter_mode)
2099 {
2100   ListBase tmp_data = {NULL, NULL};
2101   size_t tmp_items = 0;
2102   size_t items = 0;
2103
2104   /* add texture's animation data to temp collection */
2105   BEGIN_ANIMFILTER_SUBCHANNELS(FILTER_TEX_DATA(tex))
2106   {
2107     /* texture animdata */
2108     tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)tex, filter_mode);
2109
2110     /* nodes */
2111     if ((tex->nodetree) && !(ads->filterflag & ADS_FILTER_NONTREE)) {
2112       /* owner_id as id instead of texture, since it'll otherwise be impossible to track the depth */
2113       // FIXME: perhaps as a result, textures should NOT be included under materials, but under their own section instead
2114       // so that free-floating textures can also be animated
2115       tmp_items += animdata_filter_ds_nodetree(
2116           ac, &tmp_data, ads, (ID *)tex, tex->nodetree, filter_mode);
2117     }
2118   }
2119   END_ANIMFILTER_SUBCHANNELS;
2120
2121   /* did we find anything? */
2122   if (tmp_items) {
2123     /* include texture-expand widget? */
2124     if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
2125       /* check if filtering by active status */
2126       if (ANIMCHANNEL_ACTIVEOK(tex)) {
2127         ANIMCHANNEL_NEW_CHANNEL(tex, ANIMTYPE_DSTEX, owner_id, NULL);
2128       }
2129     }
2130
2131     /* now add the list of collected channels */
2132     BLI_movelisttolist(anim_data, &tmp_data);
2133     BLI_assert(BLI_listbase_is_empty(&tmp_data));
2134     items += tmp_items;
2135   }
2136
2137   /* return the number of items added to the list */
2138   return items;
2139 }
2140
2141 /* NOTE: owner_id is the direct owner of the texture stack in question
2142  *       It used to be Material/Light/World before the Blender Internal removal for 2.8
2143  */
2144 static size_t animdata_filter_ds_textures(
2145     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, ID *owner_id, int filter_mode)
2146 {
2147   MTex **mtex = NULL;
2148   size_t items = 0;
2149   int a = 0;
2150
2151   /* get datatype specific data first */
2152   if (owner_id == NULL)
2153     return 0;
2154
2155   switch (GS(owner_id->name)) {
2156     case ID_PA: {
2157       ParticleSettings *part = (ParticleSettings *)owner_id;
2158       mtex = (MTex **)(&part->mtex);
2159       break;
2160     }
2161     default: {
2162       /* invalid/unsupported option */
2163       if (G.debug & G_DEBUG)
2164         printf("ERROR: Unsupported owner_id (i.e. texture stack) for filter textures - %s\n",
2165                owner_id->name);
2166       return 0;
2167     }
2168   }
2169
2170   /* firstly check that we actuallly have some textures, by gathering all textures in a temp list */
2171   for (a = 0; a < MAX_MTEX; a++) {
2172     Tex *tex = (mtex[a]) ? mtex[a]->tex : NULL;
2173
2174     /* for now, if no texture returned, skip (this shouldn't confuse the user I hope) */
2175     if (tex == NULL)
2176       continue;
2177
2178     /* add texture's anim channels */
2179     items += animdata_filter_ds_texture(ac, anim_data, ads, tex, owner_id, filter_mode);
2180   }
2181
2182   /* return the number of items added to the list */
2183   return items;
2184 }
2185
2186 static size_t animdata_filter_ds_material(
2187     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Material *ma, int filter_mode)
2188 {
2189   ListBase tmp_data = {NULL, NULL};
2190   size_t tmp_items = 0;
2191   size_t items = 0;
2192
2193   /* add material's animation data to temp collection */
2194   BEGIN_ANIMFILTER_SUBCHANNELS(FILTER_MAT_OBJD(ma))
2195   {
2196     /* material's animation data */
2197     tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)ma, filter_mode);
2198
2199     /* nodes */
2200     if ((ma->nodetree) && !(ads->filterflag & ADS_FILTER_NONTREE))
2201       tmp_items += animdata_filter_ds_nodetree(
2202           ac, &tmp_data, ads, (ID *)ma, ma->nodetree, filter_mode);
2203   }
2204   END_ANIMFILTER_SUBCHANNELS;
2205
2206   /* did we find anything? */
2207   if (tmp_items) {
2208     /* include material-expand widget first */
2209     if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
2210       /* check if filtering by active status */
2211       if (ANIMCHANNEL_ACTIVEOK(ma)) {
2212         ANIMCHANNEL_NEW_CHANNEL(ma, ANIMTYPE_DSMAT, ma, NULL);
2213       }
2214     }
2215
2216     /* now add the list of collected channels */
2217     BLI_movelisttolist(anim_data, &tmp_data);
2218     BLI_assert(BLI_listbase_is_empty(&tmp_data));
2219     items += tmp_items;
2220   }
2221
2222   return items;
2223 }
2224
2225 static size_t animdata_filter_ds_materials(
2226     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Object *ob, int filter_mode)
2227 {
2228   bool has_nested = false;
2229   size_t items = 0;
2230   int a = 0;
2231
2232   /* first pass: take the materials referenced via the Material slots of the object */
2233   for (a = 1; a <= ob->totcol; a++) {
2234     Material *ma = give_current_material(ob, a);
2235
2236     /* if material is valid, try to add relevant contents from here */
2237     if (ma) {
2238       /* add channels */
2239       items += animdata_filter_ds_material(ac, anim_data, ads, ma, filter_mode);
2240
2241       /* for optimising second pass - check if there's a nested material here to come back for */
2242       if (has_nested == false) {
2243         has_nested = (give_node_material(ma) != NULL);
2244       }
2245     }
2246   }
2247
2248   /* second pass: go through a second time looking for "nested" materials (material.material references)
2249    *
2250    * NOTE: here we ignore the expanded status of the parent, as it could be too confusing as to why these are
2251    *       disappearing/not available, since the relationships between these is not that clear
2252    */
2253   if (has_nested) {
2254     for (a = 1; a <= ob->totcol; a++) {
2255       Material *base = give_current_material(ob, a);
2256       Material *ma = give_node_material(base);
2257
2258       /* add channels from the nested material if it exists
2259        *   - skip if the same material is referenced in its node tree
2260        *     (which is common for BI materials) as that results in
2261        *     confusing duplicates
2262        */
2263       if ((ma) && (ma != base)) {
2264         items += animdata_filter_ds_material(ac, anim_data, ads, ma, filter_mode);
2265       }
2266     }
2267   }
2268
2269   /* return the number of items added to the list */
2270   return items;
2271 }
2272
2273 /* ............ */
2274
2275 /* Temporary context for modifier linked-data channel extraction */
2276 typedef struct tAnimFilterModifiersContext {
2277   bAnimContext *ac; /* anim editor context */
2278   bDopeSheet *ads;  /* dopesheet filtering settings */
2279
2280   ListBase tmp_data; /* list of channels created (but not yet added to the main list) */
2281   size_t items;      /* number of channels created */
2282
2283   int filter_mode; /* flags for stuff we want to filter */
2284 } tAnimFilterModifiersContext;
2285
2286 /* dependency walker callback for modifier dependencies */
2287 static void animfilter_modifier_idpoin_cb(void *afm_ptr,
2288                                           Object *ob,
2289                                           ID **idpoin,
2290                                           int UNUSED(cb_flag))
2291 {
2292   tAnimFilterModifiersContext *afm = (tAnimFilterModifiersContext *)afm_ptr;
2293   ID *owner_id = &ob->id;
2294   ID *id = *idpoin;
2295
2296   /* NOTE: the walker only guarantees to give us all the ID-ptr *slots*,
2297    * not just the ones which are actually used, so be careful!
2298    */
2299   if (id == NULL)
2300     return;
2301
2302   /* check if this is something we're interested in... */
2303   switch (GS(id->name)) {
2304     case ID_TE: /* Textures */
2305     {
2306       Tex *tex = (Tex *)id;
2307       if (!(afm->ads->filterflag & ADS_FILTER_NOTEX)) {
2308         afm->items += animdata_filter_ds_texture(
2309             afm->ac, &afm->tmp_data, afm->ads, tex, owner_id, afm->filter_mode);
2310       }
2311       break;
2312     }
2313
2314     /* TODO: images? */
2315     default:
2316       break;
2317   }
2318 }
2319
2320 /* animation linked to data used by modifiers
2321  * NOTE: strictly speaking, modifier animation is already included under Object level
2322  *       but for some modifiers (e.g. Displace), there can be linked data that has settings
2323  *       which would be nice to animate (i.e. texture parameters) but which are not actually
2324  *       attached to any other objects/materials/etc. in the scene
2325  */
2326 // TODO: do we want an expander for this?
2327 static size_t animdata_filter_ds_modifiers(
2328     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Object *ob, int filter_mode)
2329 {
2330   tAnimFilterModifiersContext afm = {NULL};
2331   size_t items = 0;
2332
2333   /* 1) create a temporary "context" containing all the info we have here to pass to the callback
2334    *    use to walk through the dependencies of the modifiers
2335    *
2336    * ! Assumes that all other unspecified values (i.e. accumulation buffers) are zero'd out properly
2337    */
2338   afm.ac = ac;
2339   afm.ads = ads;
2340   afm.filter_mode = filter_mode;
2341
2342   /* 2) walk over dependencies */
2343   modifiers_foreachIDLink(ob, animfilter_modifier_idpoin_cb, &afm);
2344
2345   /* 3) extract data from the context, merging it back into the standard list */
2346   if (afm.items) {
2347     /* now add the list of collected channels */
2348     BLI_movelisttolist(anim_data, &afm.tmp_data);
2349     BLI_assert(BLI_listbase_is_empty(&afm.tmp_data));
2350     items += afm.items;
2351   }
2352
2353   return items;
2354 }
2355
2356 /* ............ */
2357
2358 static size_t animdata_filter_ds_particles(
2359     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Object *ob, int filter_mode)
2360 {
2361   ParticleSystem *psys;
2362   size_t items = 0;
2363
2364   for (psys = ob->particlesystem.first; psys; psys = psys->next) {
2365     ListBase tmp_data = {NULL, NULL};
2366     size_t tmp_items = 0;
2367
2368     /* if no material returned, skip - so that we don't get weird blank entries... */
2369     if (ELEM(NULL, psys->part, psys->part->adt))
2370       continue;
2371
2372     /* add particle-system's animation data to temp collection */
2373     BEGIN_ANIMFILTER_SUBCHANNELS(FILTER_PART_OBJD(psys->part))
2374     {
2375       /* particle system's animation data */
2376       tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)psys->part, filter_mode);
2377
2378       /* textures */
2379       if (!(ads->filterflag & ADS_FILTER_NOTEX))
2380         tmp_items += animdata_filter_ds_textures(
2381             ac, &tmp_data, ads, (ID *)psys->part, filter_mode);
2382     }
2383     END_ANIMFILTER_SUBCHANNELS;
2384
2385     /* did we find anything? */
2386     if (tmp_items) {
2387       /* include particle-expand widget first */
2388       if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
2389         /* check if filtering by active status */
2390         if (ANIMCHANNEL_ACTIVEOK(psys->part)) {
2391           ANIMCHANNEL_NEW_CHANNEL(psys->part, ANIMTYPE_DSPART, psys->part, NULL);
2392         }
2393       }
2394
2395       /* now add the list of collected channels */
2396       BLI_movelisttolist(anim_data, &tmp_data);
2397       BLI_assert(BLI_listbase_is_empty(&tmp_data));
2398       items += tmp_items;
2399     }
2400   }
2401
2402   /* return the number of items added to the list */
2403   return items;
2404 }
2405
2406 static size_t animdata_filter_ds_obdata(
2407     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Object *ob, int filter_mode)
2408 {
2409   ListBase tmp_data = {NULL, NULL};
2410   size_t tmp_items = 0;
2411   size_t items = 0;
2412
2413   IdAdtTemplate *iat = ob->data;
2414   short type = 0, expanded = 0;
2415
2416   /* get settings based on data type */
2417   switch (ob->type) {
2418     case OB_CAMERA: /* ------- Camera ------------ */
2419     {
2420       Camera *ca = (Camera *)ob->data;
2421
2422       if (ads->filterflag & ADS_FILTER_NOCAM)
2423         return 0;
2424
2425       type = ANIMTYPE_DSCAM;
2426       expanded = FILTER_CAM_OBJD(ca);
2427       break;
2428     }
2429     case OB_LAMP: /* ---------- Light ----------- */
2430     {
2431       Light *la = (Light *)ob->data;
2432
2433       if (ads->filterflag & ADS_FILTER_NOLAM)
2434         return 0;
2435
2436       type = ANIMTYPE_DSLAM;
2437       expanded = FILTER_LAM_OBJD(la);
2438       break;
2439     }
2440     case OB_CURVE: /* ------- Curve ---------- */
2441     case OB_SURF:  /* ------- Nurbs Surface ---------- */
2442     case OB_FONT:  /* ------- Text Curve ---------- */
2443     {
2444       Curve *cu = (Curve *)ob->data;
2445
2446       if (ads->filterflag & ADS_FILTER_NOCUR)
2447         return 0;
2448
2449       type = ANIMTYPE_DSCUR;
2450       expanded = FILTER_CUR_OBJD(cu);
2451       break;
2452     }
2453     case OB_MBALL: /* ------- MetaBall ---------- */
2454     {
2455       MetaBall *mb = (MetaBall *)ob->data;
2456
2457       if (ads->filterflag & ADS_FILTER_NOMBA)
2458         return 0;
2459
2460       type = ANIMTYPE_DSMBALL;
2461       expanded = FILTER_MBALL_OBJD(mb);
2462       break;
2463     }
2464     case OB_ARMATURE: /* ------- Armature ---------- */
2465     {
2466       bArmature *arm = (bArmature *)ob->data;
2467
2468       if (ads->filterflag & ADS_FILTER_NOARM)
2469         return 0;
2470
2471       type = ANIMTYPE_DSARM;
2472       expanded = FILTER_ARM_OBJD(arm);
2473       break;
2474     }
2475     case OB_MESH: /* ------- Mesh ---------- */
2476     {
2477       Mesh *me = (Mesh *)ob->data;
2478
2479       if (ads->filterflag & ADS_FILTER_NOMESH)
2480         return 0;
2481
2482       type = ANIMTYPE_DSMESH;
2483       expanded = FILTER_MESH_OBJD(me);
2484       break;
2485     }
2486     case OB_LATTICE: /* ---- Lattice ---- */
2487     {
2488       Lattice *lt = (Lattice *)ob->data;
2489
2490       if (ads->filterflag & ADS_FILTER_NOLAT)
2491         return 0;
2492
2493       type = ANIMTYPE_DSLAT;
2494       expanded = FILTER_LATTICE_OBJD(lt);
2495       break;
2496     }
2497     case OB_SPEAKER: /* ---------- Speaker ----------- */
2498     {
2499       Speaker *spk = (Speaker *)ob->data;
2500
2501       type = ANIMTYPE_DSSPK;
2502       expanded = FILTER_SPK_OBJD(spk);
2503       break;
2504     }
2505   }
2506
2507   /* add object data animation channels */
2508   BEGIN_ANIMFILTER_SUBCHANNELS(expanded)
2509   {
2510     /* animation data filtering */
2511     tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)iat, filter_mode);
2512
2513     /* sub-data filtering... */
2514     switch (ob->type) {
2515       case OB_LAMP: /* light - textures + nodetree */
2516       {
2517         Light *la = ob->data;
2518         bNodeTree *ntree = la->nodetree;
2519
2520         /* nodetree */
2521         if ((ntree) && !(ads->filterflag & ADS_FILTER_NONTREE))
2522           tmp_items += animdata_filter_ds_nodetree(
2523               ac, &tmp_data, ads, &la->id, ntree, filter_mode);
2524         break;
2525       }
2526     }
2527   }
2528   END_ANIMFILTER_SUBCHANNELS;
2529
2530   /* did we find anything? */
2531   if (tmp_items) {
2532     /* include data-expand widget first */
2533     if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
2534       /* check if filtering by active status */
2535       if (ANIMCHANNEL_ACTIVEOK(iat)) {
2536         ANIMCHANNEL_NEW_CHANNEL(iat, type, iat, NULL);
2537       }
2538     }
2539
2540     /* now add the list of collected channels */
2541     BLI_movelisttolist(anim_data, &tmp_data);
2542     BLI_assert(BLI_listbase_is_empty(&tmp_data));
2543     items += tmp_items;
2544   }
2545
2546   /* return the number of items added to the list */
2547   return items;
2548 }
2549
2550 /* shapekey-level animation */
2551 static size_t animdata_filter_ds_keyanim(
2552     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Object *ob, Key *key, int filter_mode)
2553 {
2554   ListBase tmp_data = {NULL, NULL};
2555   size_t tmp_items = 0;
2556   size_t items = 0;
2557
2558   /* add shapekey-level animation channels */
2559   BEGIN_ANIMFILTER_SUBCHANNELS(FILTER_SKE_OBJD(key))
2560   {
2561     /* animation data filtering */
2562     tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)key, filter_mode);
2563   }
2564   END_ANIMFILTER_SUBCHANNELS;
2565
2566   /* did we find anything? */
2567   if (tmp_items) {
2568     /* include key-expand widget first */
2569     if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
2570       if (ANIMCHANNEL_ACTIVEOK(key)) {
2571         ANIMCHANNEL_NEW_CHANNEL(key, ANIMTYPE_DSSKEY, ob, NULL);
2572       }
2573     }
2574
2575     /* now add the list of collected channels */
2576     BLI_movelisttolist(anim_data, &tmp_data);
2577     BLI_assert(BLI_listbase_is_empty(&tmp_data));
2578     items += tmp_items;
2579   }
2580
2581   /* return the number of items added to the list */
2582   return items;
2583 }
2584
2585 /* object-level animation */
2586 static size_t animdata_filter_ds_obanim(
2587     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Object *ob, int filter_mode)
2588 {
2589   ListBase tmp_data = {NULL, NULL};
2590   size_t tmp_items = 0;
2591   size_t items = 0;
2592
2593   AnimData *adt = ob->adt;
2594   short type = 0, expanded = 1;
2595   void *cdata = NULL;
2596
2597   /* determine the type of expander channels to use */
2598   /* this is the best way to do this for now... */
2599   ANIMDATA_FILTER_CASES(
2600       ob, /* Some useless long comment to prevent wrapping by old clang-format versions... */
2601       {/* AnimData - no channel, but consider data */},
2602       {/* NLA - no channel, but consider data */},
2603       { /* Drivers */
2604         type = ANIMTYPE_FILLDRIVERS;
2605         cdata = adt;
2606         expanded = EXPANDED_DRVD(adt);
2607       },
2608       {/* NLA Strip Controls - no dedicated channel for now (XXX) */},
2609       { /* Keyframes */
2610         type = ANIMTYPE_FILLACTD;
2611         cdata = adt->action;
2612         expanded = EXPANDED_ACTC(adt->action);
2613       });
2614
2615   /* add object-level animation channels */
2616   BEGIN_ANIMFILTER_SUBCHANNELS(expanded)
2617   {
2618     /* animation data filtering */
2619     tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)ob, filter_mode);
2620   }
2621   END_ANIMFILTER_SUBCHANNELS;
2622
2623   /* did we find anything? */
2624   if (tmp_items) {
2625     /* include anim-expand widget first */
2626     if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
2627       if (type != ANIMTYPE_NONE) {
2628         /* NOTE: active-status (and the associated checks) don't apply here... */
2629         ANIMCHANNEL_NEW_CHANNEL(cdata, type, ob, NULL);
2630       }
2631     }
2632
2633     /* now add the list of collected channels */
2634     BLI_movelisttolist(anim_data, &tmp_data);
2635     BLI_assert(BLI_listbase_is_empty(&tmp_data));
2636     items += tmp_items;
2637   }
2638
2639   /* return the number of items added to the list */
2640   return items;
2641 }
2642
2643 /* get animation channels from object2 */
2644 static size_t animdata_filter_dopesheet_ob(
2645     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Base *base, int filter_mode)
2646 {
2647   ListBase tmp_data = {NULL, NULL};
2648   Object *ob = base->object;
2649   size_t tmp_items = 0;
2650   size_t items = 0;
2651
2652   /* filter data contained under object first */
2653   BEGIN_ANIMFILTER_SUBCHANNELS(EXPANDED_OBJC(ob))
2654   {
2655     Key *key = BKE_key_from_object(ob);
2656
2657     /* object-level animation */
2658     if ((ob->adt) && !(ads->filterflag & ADS_FILTER_NOOBJ)) {
2659       tmp_items += animdata_filter_ds_obanim(ac, &tmp_data, ads, ob, filter_mode);
2660     }
2661
2662     /* shape-key */
2663     if ((key && key->adt) && !(ads->filterflag & ADS_FILTER_NOSHAPEKEYS)) {
2664       tmp_items += animdata_filter_ds_keyanim(ac, &tmp_data, ads, ob, key, filter_mode);
2665     }
2666
2667     /* modifiers */
2668     if ((ob->modifiers.first) && !(ads->filterflag & ADS_FILTER_NOMODIFIERS)) {
2669       tmp_items += animdata_filter_ds_modifiers(ac, &tmp_data, ads, ob, filter_mode);
2670     }
2671
2672     /* materials */
2673     if ((ob->totcol) && !(ads->filterflag & ADS_FILTER_NOMAT)) {
2674       tmp_items += animdata_filter_ds_materials(ac, &tmp_data, ads, ob, filter_mode);
2675     }
2676
2677     /* object data */
2678     if (ob->data) {
2679       tmp_items += animdata_filter_ds_obdata(ac, &tmp_data, ads, ob, filter_mode);
2680     }
2681
2682     /* particles */
2683     if ((ob->particlesystem.first) && !(ads->filterflag & ADS_FILTER_NOPART)) {
2684       tmp_items += animdata_filter_ds_particles(ac, &tmp_data, ads, ob, filter_mode);
2685     }
2686
2687     /* grease pencil */
2688     if ((ob->type == OB_GPENCIL) && (ob->data) && !(ads->filterflag & ADS_FILTER_NOGPENCIL)) {
2689       tmp_items += animdata_filter_ds_gpencil(ac, &tmp_data, ads, ob->data, filter_mode);
2690     }
2691   }
2692   END_ANIMFILTER_SUBCHANNELS;
2693
2694   /* if we collected some channels, add these to the new list... */
2695   if (tmp_items) {
2696     /* firstly add object expander if required */
2697     if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
2698       /* check if filtering by selection */
2699       // XXX: double-check on this - most of the time, a lot of tools need to filter out these channels!
2700       if (ANIMCHANNEL_SELOK((base->flag & BASE_SELECTED))) {
2701         /* check if filtering by active status */
2702         if (ANIMCHANNEL_ACTIVEOK(ob)) {
2703           ANIMCHANNEL_NEW_CHANNEL(base, ANIMTYPE_OBJECT, ob, NULL);
2704         }
2705       }
2706     }
2707
2708     /* now add the list of collected channels */
2709     BLI_movelisttolist(anim_data, &tmp_data);
2710     BLI_assert(BLI_listbase_is_empty(&tmp_data));
2711     items += tmp_items;
2712   }
2713
2714   /* return the number of items added */
2715   return items;
2716 }
2717
2718 static size_t animdata_filter_ds_world(
2719     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Scene *sce, World *wo, int filter_mode)
2720 {
2721   ListBase tmp_data = {NULL, NULL};
2722   size_t tmp_items = 0;
2723   size_t items = 0;
2724
2725   /* add world animation channels */
2726   BEGIN_ANIMFILTER_SUBCHANNELS(FILTER_WOR_SCED(wo))
2727   {
2728     /* animation data filtering */
2729     tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)wo, filter_mode);
2730
2731     /* nodes */
2732     if ((wo->nodetree) && !(ads->filterflag & ADS_FILTER_NONTREE))
2733       tmp_items += animdata_filter_ds_nodetree(
2734           ac, &tmp_data, ads, (ID *)wo, wo->nodetree, filter_mode);
2735   }
2736   END_ANIMFILTER_SUBCHANNELS;
2737
2738   /* did we find anything? */
2739   if (tmp_items) {
2740     /* include data-expand widget first */
2741     if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
2742       /* check if filtering by active status */
2743       if (ANIMCHANNEL_ACTIVEOK(wo)) {
2744         ANIMCHANNEL_NEW_CHANNEL(wo, ANIMTYPE_DSWOR, sce, NULL);
2745       }
2746     }
2747
2748     /* now add the list of collected channels */
2749     BLI_movelisttolist(anim_data, &tmp_data);
2750     BLI_assert(BLI_listbase_is_empty(&tmp_data));
2751     items += tmp_items;
2752   }
2753
2754   /* return the number of items added to the list */
2755   return items;
2756 }
2757
2758 static size_t animdata_filter_ds_scene(
2759     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Scene *sce, int filter_mode)
2760 {
2761   ListBase tmp_data = {NULL, NULL};
2762   size_t tmp_items = 0;
2763   size_t items = 0;
2764
2765   AnimData *adt = sce->adt;
2766   short type = 0, expanded = 1;
2767   void *cdata = NULL;
2768
2769   /* determine the type of expander channels to use */
2770   // this is the best way to do this for now...
2771   ANIMDATA_FILTER_CASES(
2772       sce, /* Some useless long comment to prevent wrapping by old clang-format versions... */
2773       {/* AnimData - no channel, but consider data */},
2774       {/* NLA - no channel, but consider data */},
2775       { /* Drivers */
2776         type = ANIMTYPE_FILLDRIVERS;
2777         cdata = adt;
2778         expanded = EXPANDED_DRVD(adt);
2779       },
2780       {/* NLA Strip Controls - no dedicated channel for now (XXX) */},
2781       { /* Keyframes */
2782         type = ANIMTYPE_FILLACTD;
2783         cdata = adt->action;
2784         expanded = EXPANDED_ACTC(adt->action);
2785       });
2786
2787   /* add scene-level animation channels */
2788   BEGIN_ANIMFILTER_SUBCHANNELS(expanded)
2789   {
2790     /* animation data filtering */
2791     tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)sce, filter_mode);
2792   }
2793   END_ANIMFILTER_SUBCHANNELS;
2794
2795   /* did we find anything? */
2796   if (tmp_items) {
2797     /* include anim-expand widget first */
2798     if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
2799       if (type != ANIMTYPE_NONE) {
2800         /* NOTE: active-status (and the associated checks) don't apply here... */
2801         ANIMCHANNEL_NEW_CHANNEL(cdata, type, sce, NULL);
2802       }
2803     }
2804
2805     /* now add the list of collected channels */
2806     BLI_movelisttolist(anim_data, &tmp_data);
2807     BLI_assert(BLI_listbase_is_empty(&tmp_data));
2808     items += tmp_items;
2809   }
2810
2811   /* return the number of items added to the list */
2812   return items;
2813 }
2814
2815 static size_t animdata_filter_dopesheet_scene(
2816     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Scene *sce, int filter_mode)
2817 {
2818   ListBase tmp_data = {NULL, NULL};
2819   size_t tmp_items = 0;
2820   size_t items = 0;
2821
2822   /* filter data contained under object first */
2823   BEGIN_ANIMFILTER_SUBCHANNELS(EXPANDED_SCEC(sce))
2824   {
2825     bNodeTree *ntree = sce->nodetree;
2826     bGPdata *gpd = sce->gpd;
2827     World *wo = sce->world;
2828
2829     /* Action, Drivers, or NLA for Scene */
2830     if ((ads->filterflag & ADS_FILTER_NOSCE) == 0) {
2831       tmp_items += animdata_filter_ds_scene(ac, &tmp_data, ads, sce, filter_mode);
2832     }
2833
2834     /* world */
2835     if ((wo) && !(ads->filterflag & ADS_FILTER_NOWOR)) {
2836       tmp_items += animdata_filter_ds_world(ac, &tmp_data, ads, sce, wo, filter_mode);
2837     }
2838
2839     /* nodetree */
2840     if ((ntree) && !(ads->filterflag & ADS_FILTER_NONTREE)) {
2841       tmp_items += animdata_filter_ds_nodetree(ac, &tmp_data, ads, (ID *)sce, ntree, filter_mode);
2842     }
2843
2844     /* line styles */
2845     if ((ads->filterflag & ADS_FILTER_NOLINESTYLE) == 0) {
2846       tmp_items += animdata_filter_ds_linestyle(ac, &tmp_data, ads, sce, filter_mode);
2847     }
2848
2849     /* grease pencil */
2850     if ((gpd) && !(ads->filterflag & ADS_FILTER_NOGPENCIL)) {
2851       tmp_items += animdata_filter_ds_gpencil(ac, &tmp_data, ads, gpd, filter_mode);
2852     }
2853
2854     /* TODO: one day, when sequencer becomes its own datatype, perhaps it should be included here */
2855   }
2856   END_ANIMFILTER_SUBCHANNELS;
2857
2858   /* if we collected some channels, add these to the new list... */
2859   if (tmp_items) {
2860     /* firstly add object expander if required */
2861     if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
2862       /* check if filtering by selection */
2863       if (ANIMCHANNEL_SELOK((sce->flag & SCE_DS_SELECTED))) {
2864         /* NOTE: active-status doesn't matter for this! */
2865         ANIMCHANNEL_NEW_CHANNEL(sce, ANIMTYPE_SCENE, sce, NULL);
2866       }
2867     }
2868
2869     /* now add the list of collected channels */
2870     BLI_movelisttolist(anim_data, &tmp_data);
2871     BLI_assert(BLI_listbase_is_empty(&tmp_data));
2872     items += tmp_items;
2873   }
2874
2875   /* return the number of items added */
2876   return items;
2877 }
2878
2879 static size_t animdata_filter_ds_movieclip(
2880     bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, MovieClip *clip, int filter_mode)
2881 {
2882   ListBase tmp_data = {NULL, NULL};
2883   size_t tmp_items = 0;
2884   size_t items = 0;
2885   /* add world animation channels */
2886   BEGIN_ANIMFILTER_SUBCHANNELS(EXPANDED_MCLIP(clip))
2887   {
2888     /* animation data filtering */
2889     tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)clip, filter_mode);
2890   }
2891   END_ANIMFILTER_SUBCHANNELS;
2892   /* did we find anything? */
2893   if (tmp_items) {
2894     /* include data-expand widget first */
2895     if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
2896       /* check if filtering by active status */
2897       if (ANIMCHANNEL_ACTIVEOK(clip)) {
2898         ANIMCHANNEL_NEW_CHANNEL(clip, ANIMTYPE_DSMCLIP, clip, NULL);
2899       }
2900     }
2901     /* now add the list of collected channels */
2902     BLI_movelisttolist(anim_data, &tmp_data);
2903     BLI_assert(BLI_listbase_is_empty(&tmp_data));
2904     items += tmp_items;
2905   }
2906   /* return the number of items added to the list */
2907   return items;
2908 }
2909
2910 static size_t animdata_filter_dopesheet_movieclips(bAnimContext *ac,
2911                                                    ListBase *anim_data,
2912                                                    bDopeSheet *ads,
2913                                                    int filter_mode)
2914 {
2915   size_t items = 0;
2916   MovieClip *clip;
2917   for (clip = ac->bmain->movieclips.first; clip != NULL; clip = clip->id.next) {
2918     /* only show if gpd is used by something... */
2919     if (ID_REAL_USERS(clip) < 1) {
2920       continue;
2921     }
2922     items += animdata_filter_ds_movieclip(ac, anim_data, ads, clip, filter_mode);
2923   }
2924   /* return the number of items added to the list */
2925   return items;
2926 }
2927
2928 /* Helper for animdata_filter_dopesheet() - For checking if an object should be included or not */
2929 static bool animdata_filter_base_is_ok(bDopeSheet *ads, Base *base, int filter_mode)
2930 {
2931   Object *ob = base->object;
2932
2933   if (base->object == NULL)
2934     return false;
2935
2936   /* firstly, check if object can be included, by the following factors:
2937    * - if only visible, must check for layer and also viewport visibility
2938    *   --> while tools may demand only visible, user setting takes priority
2939    *       as user option controls whether sets of channels get included while
2940    *       tool-flag takes into account collapsed/open channels too
2941    * - if only selected, must check if object is selected
2942    * - there must be animation data to edit (this is done recursively as we
2943    *   try to add the channels)
2944    */
2945   if ((filter_mode & ANIMFILTER_DATA_VISIBLE) && !(ads->filterflag & ADS_FILTER_INCL_HIDDEN)) {
2946     /* layer visibility - we check both object and base, since these may not be in sync yet */
2947     if ((base->flag & BASE_VISIBLE) == 0)
2948       return false;
2949
2950     /* outliner restrict-flag */
2951     if (ob->restrictflag & OB_RESTRICT_VIEW)
2952       return false;
2953   }
2954
2955   /* if only F-Curves with visible flags set can be shown, check that
2956    * datablock hasn't been set to invisible
2957    */
2958   if (filter_mode & ANIMFILTER_CURVE_VISIBLE) {
2959     if ((ob->adt) && (ob->adt->flag & ADT_CURVES_NOT_VISIBLE))
2960       return false;
2961   }
2962
2963   /* Pinned curves are visible regardless of selection flags. */
2964   if ((ob->adt) && (ob->adt->flag & ADT_CURVES_ALWAYS_VISIBLE)) {
2965     return true;
2966   }
2967
2968   /* Special case.
2969    * We don't do recursive checks for pin, but we need to deal with tricky
2970    * setup like animated camera lens without animated camera location.
2971    * Without such special handle here we wouldn't be able to bin such
2972    * camera data only animation to the editor.
2973    */
2974   if (ob->adt == NULL && ob->data != NULL) {
2975     AnimData *data_adt = BKE_animdata_from_id(ob->data);
2976     if (data_adt != NULL && (data_adt->flag & ADT_CURVES_ALWAYS_VISIBLE)) {
2977       return true;
2978     }
2979   }
2980
2981   /* check selection and object type filters */
2982   if ((ads->filterflag & ADS_FILTER_ONLYSEL) &&
2983       !((base->flag & BASE_SELECTED) /*|| (base == sce->basact)*/)) {
2984     /* only selected should be shown */
2985     return false;
2986   }
2987
2988   /* check if object belongs to the filtering group if option to filter
2989    * objects by the grouped status is on
2990    * - used to ease the process of doing multiple-character choreographies
2991    */
2992   if (ads->filter_grp != NULL) {
2993     if (BKE_collection_has_object_recursive(ads->filter_grp, ob) == 0)
2994       return false;
2995   }
2996
2997   /* no reason to exclude this object... */
2998   return true;
2999 }
3000
3001 /* Helper for animdata_filter_ds_sorted_bases() - Comparison callback for two Base pointers... */
3002 static int ds_base_sorting_cmp(const void *base1_ptr, const void *base2_ptr)
3003 {
3004   const Base *b1 = *((const Base **)base1_ptr);
3005   const Base *b2 = *((const Base **)base2_ptr);
3006
3007   return strcmp(b1->object->id.name + 2, b2->object->id.name + 2);
3008 }
3009
3010 /* Get a sorted list of all the bases - for inclusion in dopesheet (when drawing channels) */
3011 static Base **animdata_filter_ds_sorted_bases(bDopeSheet *ads,
3012                                               ViewLayer *view_layer,
3013                                               int filter_mode,
3014                                               size_t *r_usable_bases)
3015 {
3016   /* Create an array with space for all the bases, but only containing the usable ones */
3017   size_t tot_bases = BLI_listbase_count(&view_layer->object_bases);
3018   size_t num_bases = 0;
3019
3020   Base **sorted_bases = MEM_mallocN(sizeof(Base *) * tot_bases, "Dopesheet Usable Sorted Bases");
3021   for (Base *base = view_layer->object_bases.first; base; base = base->next) {
3022     if (animdata_filter_base_is_ok(ads, base, filter_mode)) {
3023       sorted_bases[num_bases++] = base;
3024     }
3025   }
3026
3027   /* Sort this list of pointers (based on the names) */
3028   qsort(sorted_bases, num_bases, sizeof(Base *), ds_base_sorting_cmp);
3029
3030   /* Return list of sorted bases */
3031   *r_usable_bases = num_bases;
3032   return sorted_bases;
3033 }
3034
3035 // 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)
3036 static size_t animdata_filter_dopesheet(bAnimContext *ac,
3037                                         ListBase *anim_data,
3038                                         bDopeSheet *ads,
3039                                         int filter_mode)
3040 {
3041   Scene *scene = (Scene *)ads->source;
3042   ViewLayer *view_layer = (ViewLayer *)ac->view_layer;
3043   size_t items = 0;
3044
3045   /* check that we do indeed have a scene */
3046   if ((ads->source == NULL) || (GS(ads->source->name) != ID_SCE)) {
3047     printf("Dope Sheet Error: No scene!\n");
3048     if (G.debug & G_DEBUG)
3049       printf("\tPointer = %p, Name = '%s'\n",
3050              (void *)ads->source,
3051              (ads->source) ? ads->source->name : NULL);
3052     return 0;
3053   }
3054
3055   /* augment the filter-flags with settings based on the dopesheet filterflags
3056    * so that some temp settings can get added automagically...
3057    */
3058   if (ads->filterflag & ADS_FILTER_SELEDIT) {
3059     /* only selected F-Curves should get their keyframes considered for editability */
3060     filter_mode |= ANIMFILTER_SELEDIT;
3061   }
3062
3063   /* Cache files level animations (frame duration and such). */
3064   if (!(ads->filterflag2 & ADS_FILTER_NOCACHEFILES) && !(ads->filterflag & ADS_FILTER_ONLYSEL)) {
3065     CacheFile *cache_file = ac->bmain->cachefiles.first;
3066     for (; cache_file; cache_file = cache_file->id.next) {
3067       items += animdata_filter_ds_cachefile(ac, anim_data, ads, cache_file, filter_mode);
3068     }
3069   }
3070
3071   /* movie clip's animation */
3072   items += animdata_filter_dopesheet_movieclips(ac, anim_data, ads, filter_mode);
3073
3074   /* scene-linked animation - e.g. world, compositing nodes, scene anim (including sequencer currently) */
3075   items += animdata_filter_dopesheet_scene(ac, anim_data, ads, scene, filter_mode);
3076
3077   /* If filtering for channel drawing, we want the objects in alphabetical order,
3078    * to make it easier to predict where items are in the hierarchy
3079    * - This order only really matters if we need to show all channels in the list (e.g. for drawing)
3080    *   (XXX: What about lingering "active" flags? The order may now become unpredictable)
3081    * - Don't do this if this behavior has been turned off (i.e. due to it being too slow)
3082    * - Don't do this if there's just a single object
3083    */
3084   if ((filter_mode & ANIMFILTER_LIST_CHANNELS) && !(ads->flag & ADS_FLAG_NO_DB_SORT) &&
3085       (view_layer->object_bases.first != view_layer->object_bases.last)) {
3086     /* Filter list of bases (i.e. objects), sort them, then add their contents normally... */
3087     // TODO: Cache the old sorted order - if the set of bases hasn't changed, don't re-sort...
3088     Base **sorted_bases;
3089     size_t num_bases;
3090
3091     sorted_bases = animdata_filter_ds_sorted_bases(ads, view_layer, filter_mode, &num_bases);
3092     if (sorted_bases) {
3093       /* Add the necessary channels for these bases... */
3094       for (size_t i = 0; i < num_bases; i++) {
3095         items += animdata_filter_dopesheet_ob(ac, anim_data, ads, sorted_bases[i], filter_mode);
3096       }
3097
3098       // TODO: store something to validate whether any changes are needed?
3099
3100       /* free temporary data */
3101       MEM_freeN(sorted_bases);
3102     }
3103   }
3104   else {
3105     /* Filter and add contents of each base (i.e. object) without them sorting first
3106      * NOTE: This saves performance in cases where order doesn't matter
3107      */
3108     for (Base *base = view_layer->object_bases.first; base; base = base->next) {
3109       if (animdata_filter_base_is_ok(ads, base, filter_mode)) {
3110         /* since we're still here, this object should be usable */
3111         items += animdata_filter_dopesheet_ob(ac, anim_data, ads, base, filter_mode);
3112       }
3113     }
3114   }
3115
3116   /* return the number of items in the list */
3117   return items;
3118 }
3119
3120 /* Summary track for DopeSheet/Action Editor
3121  * - return code is whether the summary lets the other channels get drawn
3122  */
3123 static short animdata_filter_dopesheet_summary(bAnimContext *ac,
3124                                                ListBase *anim_data,
3125                                                int filter_mode,
3126                                                size_t *items)
3127 {
3128   bDopeSheet *ads = NULL;
3129
3130   /* get the DopeSheet information to use
3131    * - we should only need to deal with the DopeSheet/Action Editor,
3132    *   since all the other Animation Editors won't have this concept
3133    *   being applicable.
3134    */
3135   if ((ac && ac->sl) && (ac->spacetype == SPACE_ACTION)) {
3136     SpaceAction *saction = (SpaceAction *)ac->sl;
3137     ads = &saction->ads;
3138   }
3139   else {
3140     /* invalid space type - skip this summary channels */
3141     return 1;
3142   }
3143
3144   /* dopesheet summary
3145    * - only for drawing and/or selecting keyframes in channels, but not for real editing
3146    * - only useful for DopeSheet/Action/etc. editors where it is actually useful
3147    */
3148   if ((filter_mode & ANIMFILTER_LIST_CHANNELS) && (ads->filterflag & ADS_FILTER_SUMMARY)) {
3149     bAnimListElem *ale = make_new_animlistelem(ac, ANIMTYPE_SUMMARY, NULL, NULL);
3150     if (ale) {
3151       BLI_addtail(anim_data, ale);
3152       (*items)++;
3153     }
3154
3155     /* if summary is collapsed, don't show other channels beneath this
3156      * - this check is put inside the summary check so that it doesn't interfere with normal operation
3157      */
3158     if (ads->flag & ADS_FLAG_SUMMARY_COLLAPSED)
3159       return 0;
3160   }
3161
3162   /* the other channels beneath this can be shown */
3163   return 1;
3164 }
3165
3166 /* ......................... */
3167
3168 /* filter data associated with a channel - usually for handling summary-channels in DopeSheet */
3169 static size_t animdata_filter_animchan(bAnimContext *ac,
3170                                        ListBase *anim_data,
3171                                        bDopeSheet *ads,
3172                                        bAnimListElem *channel,
3173                                        int filter_mode)
3174 {
3175   size_t items = 0;
3176
3177   /* data to filter depends on channel type */
3178   /* NOTE: only common channel-types have been handled for now. More can be added as necessary */
3179   switch (channel->type) {
3180     case ANIMTYPE_SUMMARY:
3181       items += animdata_filter_dopesheet(ac, anim_data, ads, filter_mode);
3182       break;
3183
3184     case ANIMTYPE_SCENE:
3185       items += animdata_filter_dopesheet_scene(ac, anim_data, ads, channel->data, filter_mode);
3186       break;
3187
3188     case ANIMTYPE_OBJECT:
3189       items += animdata_filter_dopesheet_ob(ac, anim_data, ads, channel->data, filter_mode);
3190       break;
3191
3192     case ANIMTYPE_DSCACHEFILE:
3193       items += animdata_filter_ds_cachefile(ac, anim_data, ads, channel->data, filter_mode);
3194       break;
3195
3196     case ANIMTYPE_ANIMDATA:
3197       items += animfilter_block_data(ac, anim_data, ads, channel->id, filter_mode);
3198       break;
3199
3200     default:
3201       printf("ERROR: Unsupported channel type (%d) in animdata_filter_animchan()\n",
3202              channel->type);
3203       break;
3204   }
3205
3206   return items;
3207 }
3208
3209 /* ----------- Cleanup API --------------- */
3210
3211 /* Remove entries with invalid types in animation channel list */
3212 static size_t animdata_filter_remove_invalid(ListBase *anim_data)
3213 {
3214   bAnimListElem *ale, *next;
3215   size_t items = 0;
3216
3217   /* only keep entries with valid types */
3218   for (ale = anim_data->first; ale; ale = next) {
3219     next = ale->next;
3220
3221     if (ale->type == ANIMTYPE_NONE)
3222       BLI_freelinkN(anim_data, ale);
3223     else
3224       items++;
3225   }
3226
3227   return items;
3228 }
3229
3230 /* Remove duplicate entries in animation channel list */
3231 static size_t animdata_filter_remove_duplis(ListBase *anim_data)
3232 {
3233   bAnimListElem *ale, *next;
3234   GSet *gs;
3235   size_t items = 0;
3236
3237   /* build new hashtable to efficiently store and retrieve which entries have been
3238    * encountered already while searching
3239    */
3240   gs = BLI_gset_ptr_new(__func__);
3241
3242   /* loop through items, removing them from the list if a similar item occurs already */
3243   for (ale = anim_data->first; ale; ale = next) {
3244     next = ale->next;
3245
3246     /* check if hash has any record of an entry like this
3247      * - just use ale->data for now, though it would be nicer to involve
3248      *   ale->type in combination too to capture corner cases (where same data performs differently)
3249      */
3250     if (BLI_gset_add(gs, ale->data)) {
3251       /* this entry is 'unique' and can be kept */
3252       items++;
3253     }
3254     else {
3255       /* this entry isn't needed anymore */
3256       BLI_freelinkN(anim_data, ale);
3257     }
3258   }
3259
3260   /* free the hash... */
3261   BLI_gset_free(gs, NULL);
3262
3263   /* return the number of items still in the list */
3264   return items;
3265 }
3266
3267 /* ----------- Public API --------------- */
3268
3269 /* This function filters the active data source to leave only animation channels suitable for
3270  * usage by the caller. It will return the length of the list
3271  *
3272  * *anim_data: is a pointer to a ListBase, to which the filtered animation channels
3273  * will be placed for use.
3274  * filter_mode: how should the data be filtered - bitmapping accessed flags
3275  */
3276 size_t ANIM_animdata_filter(bAnimContext *ac,
3277                             ListBase *anim_data,
3278                             eAnimFilter_Flags filter_mode,
3279                             void *data,
3280                             eAnimCont_Types datatype)
3281 {
3282   size_t items = 0;
3283
3284   /* only filter data if there's somewhere to put it */
3285   if (data && anim_data) {
3286     /* firstly filter the data */
3287     switch (datatype) {
3288       /* Action-Editing Modes */
3289       case ANIMCONT_ACTION: /* 'Action Editor' */
3290       {
3291         Object *obact = ac->obact;
3292         SpaceAction *saction = (SpaceAction *)ac->sl;
3293         bDopeSheet *ads = (saction) ? &saction->ads : NULL;
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(obact->adt)) {
3299             ANIMCHANNEL_NEW_CHANNEL(obact->adt, ANIMTYPE_ANIMDATA, (ID *)obact, 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 += animfilter_action(ac, anim_data, ads, data, filter_mode, (ID *)obact);
3306         }
3307
3308         break;
3309       }
3310       case ANIMCONT_SHAPEKEY: /* 'ShapeKey Editor' */
3311       {
3312         Key *key = (Key *)data;
3313
3314         /* specially check for AnimData filter... [#36687] */
3315         if (UNLIKELY(filter_mode & ANIMFILTER_ANIMDATA)) {
3316           /* all channels here are within the same AnimData block, hence this special case */
3317           if (LIKELY(key->adt)) {
3318             ANIMCHANNEL_NEW_CHANNEL(key->adt, ANIMTYPE_ANIMDATA, (ID *)key, NULL);
3319           }
3320         }
3321         else {
3322           /* the check for the DopeSheet summary is included here since the summary works here too */
3323           if (animdata_filter_dopesheet_summary(ac, anim_data, filter_mode, &items))
3324             items = animdata_filter_shapekey(ac, anim_data, key, filter_mode);
3325         }
3326
3327         break;
3328       }
3329
3330       /* Modes for Specialty Data Types (i.e. not keyframes) */
3331       case ANIMCONT_GPENCIL: {
3332         if (animdata_filter_dopesheet_summary(ac, anim_data, filter_mode, &items))
3333           items = animdata_filter_gpencil(ac, anim_data, data, filter_mode);
3334         break;
3335       }
3336       case ANIMCONT_MASK: {
3337         if (animdata_filter_dopesheet_summary(ac, anim_data, filter_mode, &items))
3338           items = animdata_filter_mask(ac->bmain, anim_data, data, filter_mode);
3339         break;
3340       }
3341
3342       /* DopeSheet Based Modes */
3343       case ANIMCONT_DOPESHEET: /* 'DopeSheet Editor' */
3344       {
3345         /* the DopeSheet editor is the primary place where the DopeSheet summaries are useful */
3346         if (animdata_filter_dopesheet_summary(ac, anim_data, filter_mode, &items))
3347           items += animdata_filter_dopesheet(ac, anim_data, data, filter_mode);
3348         break;
3349       }
3350       case ANIMCONT_FCURVES: /* Graph Editor -> F-Curves/Animation Editing */
3351       case ANIMCONT_DRIVERS: /* Graph Editor -> Drivers Editing */
3352       case ANIMCONT_NLA:     /* NLA Editor */
3353       {
3354         /* all of these editors use the basic DopeSheet data for filtering options,
3355          * but don't have all the same features */
3356         items = animdata_filter_dopesheet(ac, anim_data, data, filter_mode);
3357         break;
3358       }
3359
3360       /* Timeline Mode - Basically the same as dopesheet, except we only have the summary for now */
3361       case ANIMCONT_TIMELINE: {
3362         /* the DopeSheet editor is the primary place where the DopeSheet summaries are useful */
3363         if (animdata_filter_dopesheet_summary(ac, anim_data, filter_mode, &items))
3364           items += animdata_filter_dopesheet(ac, anim_data, data, filter_mode);
3365         break;
3366       }
3367
3368       /* Special/Internal Use */
3369       case ANIMCONT_CHANNEL: /* animation channel */
3370       {
3371         bDopeSheet *ads = ac->ads;
3372
3373         /* based on the channel type, filter relevant data for this */
3374         items = animdata_filter_animchan(ac, anim_data, ads, data, filter_mode);
3375         break;
3376       }
3377
3378       /* unhandled */
3379       default: {
3380         printf("ANIM_animdata_filter() - Invalid datatype argument %u\n", datatype);
3381         break;
3382       }
3383     }
3384
3385     /* remove any 'weedy' entries */
3386     items = animdata_filter_remove_invalid(anim_data);
3387
3388     /* remove duplicates (if required) */
3389     if (filter_mode & ANIMFILTER_NODUPLIS)
3390       items = animdata_filter_remove_duplis(anim_data);
3391   }
3392
3393   /* return the number of items in the list */
3394   return items;
3395 }
3396
3397 /* ************************************************************ */