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