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