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