Merge branch 'master' into blender2.8
[blender.git] / source / blender / makesdna / DNA_ID.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file DNA_ID.h
29  *  \ingroup DNA
30  *  \brief ID and Library types, which are fundamental for sdna.
31  */
32
33 #ifndef __DNA_ID_H__
34 #define __DNA_ID_H__
35
36 #include "DNA_listBase.h"
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41
42 struct Library;
43 struct FileData;
44 struct ID;
45 struct PackedFile;
46 struct GPUTexture;
47
48 typedef struct IDPropertyData {
49         void *pointer;
50         ListBase group;
51         int val, val2;  /* note, we actually fit a double into these two ints */
52 } IDPropertyData;
53
54 typedef struct IDProperty {
55         struct IDProperty *next, *prev;
56         char type, subtype;
57         short flag;
58         char name[64];  /* MAX_IDPROP_NAME */
59
60         /* saved is used to indicate if this struct has been saved yet.
61          * seemed like a good idea as a pad var was needed anyway :) */
62         int saved;
63         IDPropertyData data;  /* note, alignment for 64 bits */
64
65         /* array length, also (this is important!) string length + 1.
66          * the idea is to be able to reuse array realloc functions on strings.*/
67         int len;
68
69         /* Strings and arrays are both buffered, though the buffer isn't saved. */
70         /* totallen is total length of allocated array/string, including a buffer.
71          * Note that the buffering is mild; the code comes from python's list implementation. */
72         int totallen;
73 } IDProperty;
74
75 #define MAX_IDPROP_NAME 64
76 #define DEFAULT_ALLOC_FOR_NULL_STRINGS  64
77
78 /*->type*/
79 enum {
80         IDP_STRING           = 0,
81         IDP_INT              = 1,
82         IDP_FLOAT            = 2,
83         IDP_ARRAY            = 5,
84         IDP_GROUP            = 6,
85         IDP_ID               = 7,
86         IDP_DOUBLE           = 8,
87         IDP_IDPARRAY         = 9,
88         IDP_NUMTYPES         = 10,
89 };
90
91 /*->subtype */
92
93 /* IDP_STRING */
94 enum {
95         IDP_STRING_SUB_UTF8  = 0,  /* default */
96         IDP_STRING_SUB_BYTE  = 1,  /* arbitrary byte array, _not_ null terminated */
97 };
98
99 /* IDP_GROUP */
100 enum {
101         IDP_GROUP_SUB_NONE              = 0,  /* default */
102         IDP_GROUP_SUB_MODE_OBJECT       = 1,  /* object mode settings */
103         IDP_GROUP_SUB_MODE_EDIT         = 2,  /* mesh edit mode settings */
104         IDP_GROUP_SUB_ENGINE_RENDER     = 3,  /* render engine settings */
105         IDP_GROUP_SUB_OVERRIDE          = 4,  /* data override */
106         IDP_GROUP_SUB_MODE_PAINT_WEIGHT = 5,  /* weight paint mode settings */
107         IDP_GROUP_SUB_MODE_PAINT_VERTEX = 6,  /* vertex paint mode settings */
108 };
109
110 /*->flag*/
111 enum {
112         /* This IDProp may be statically overridden. Should only be used/be relevant for custom properties. */
113         IDP_FLAG_OVERRIDABLE_STATIC = 1 << 0,
114
115         IDP_FLAG_GHOST       = 1 << 7,  /* this means the property is set but RNA will return false when checking
116                                          * 'RNA_property_is_set', currently this is a runtime flag */
117 };
118
119 /* add any future new id property types here.*/
120
121
122 /* Static ID override structs. */
123
124 typedef struct IDOverrideStaticPropertyOperation {
125         struct IDOverrideStaticPropertyOperation *next, *prev;
126
127         /* Type of override. */
128         short operation;
129         short flag;
130         short pad_s1[2];
131
132         /* Sub-item references, if needed (for arrays or collections only).
133          * We need both reference and local values to allow e.g. insertion into collections (constraints, modifiers...).
134          * In collection case, if names are defined, they are used in priority.
135          * Names are pointers (instead of char[64]) to save some space, NULL when unset.
136          * Indices are -1 when unset. */
137         char *subitem_reference_name;
138         char *subitem_local_name;
139         int subitem_reference_index;
140         int subitem_local_index;
141 } IDOverrideStaticPropertyOperation;
142
143 /* IDOverridePropertyOperation->operation. */
144 enum {
145         /* Basic operations. */
146         IDOVERRIDESTATIC_OP_NOOP          =   0,  /* Special value, forbids any overriding. */
147
148         IDOVERRIDESTATIC_OP_REPLACE       =   1,  /* Fully replace local value by reference one. */
149
150         /* Numeric-only operations. */
151         IDOVERRIDESTATIC_OP_ADD           = 101,  /* Add local value to reference one. */
152         /* Subtract local value from reference one (needed due to unsigned values etc.). */
153         IDOVERRIDESTATIC_OP_SUBTRACT      = 102,
154         /* Multiply reference value by local one (more useful than diff for scales and the like). */
155         IDOVERRIDESTATIC_OP_MULTIPLY      = 103,
156
157         /* Collection-only operations. */
158         IDOVERRIDESTATIC_OP_INSERT_AFTER  = 201,  /* Insert after given reference's subitem. */
159         IDOVERRIDESTATIC_OP_INSERT_BEFORE = 202,  /* Insert before given reference's subitem. */
160         /* We can add more if needed (move, delete, ...). */
161 };
162
163 /* IDOverridePropertyOperation->flag. */
164 enum {
165         IDOVERRIDESTATIC_FLAG_MANDATORY     =   1 << 0,  /* User cannot remove that override operation. */
166         IDOVERRIDESTATIC_FLAG_LOCKED        =   1 << 1,  /* User cannot change that override operation. */
167 };
168
169 /* A single overriden property, contain all operations on this one. */
170 typedef struct IDOverrideStaticProperty {
171         struct IDOverrideStaticProperty *next, *prev;
172
173         /* Path from ID to overridden property. *Does not* include indices/names for final arrays/collections items. */
174         char *rna_path;
175
176         ListBase operations;  /* List of overriding operations (IDOverridePropertyOperation) applied to this property. */
177 } IDOverrideStaticProperty;
178
179 /* Main container for all overriding data info of a data-block. */
180 typedef struct IDOverrideStatic {
181         struct ID *reference;  /* Reference linked ID which this one overrides. */
182         ListBase properties;  /* List of IDOverrideProperty structs. */
183
184         short flag;
185         short pad[3];
186
187         /* Read/write data. */
188         /* Temp ID storing extra override data (used for differential operations only currently).
189          * Always NULL outside of read/write context. */
190         struct ID *storage;
191 } IDOverrideStatic;
192
193 enum eStaticOverride_Flag {
194         STATICOVERRIDE_AUTO    = 1 << 0,  /* Allow automatic generation of overriding rules. */
195 };
196
197 /* watch it: Sequence has identical beginning. */
198 /**
199  * ID is the first thing included in all serializable types. It
200  * provides a common handle to place all data in double-linked lists.
201  * */
202
203 /* 2 characters for ID code and 64 for actual name */
204 #define MAX_ID_NAME  66
205
206 /* There's a nasty circular dependency here.... 'void *' to the rescue! I
207  * really wonder why this is needed. */
208 typedef struct ID {
209         void *next, *prev;
210         struct ID *newid;
211         struct Library *lib;
212         char name[66]; /* MAX_ID_NAME */
213         /**
214          * LIB_... flags report on status of the datablock this ID belongs to (persistent, saved to and read from .blend).
215          */
216         short flag;
217         /**
218          * LIB_TAG_... tags (runtime only, cleared at read time).
219          */
220         int tag;
221         int us;
222         int icon_id;
223         int recalc;
224         int pad;
225         IDProperty *properties;
226
227         IDOverrideStatic *override_static;  /* Reference linked ID which this one overrides. */
228
229         /* Only set for datablocks which are coming from copy-on-write, points to
230          * the original version of it.
231          */
232         struct ID *orig_id;
233
234         void *py_instance;
235 } ID;
236
237 /**
238  * For each library file used, a Library struct is added to Main
239  * WARNING: readfile.c, expand_doit() reads this struct without DNA check!
240  */
241 typedef struct Library {
242         ID id;
243         struct FileData *filedata;
244         char name[1024];  /* path name used for reading, can be relative and edited in the outliner */
245
246         /* absolute filepath, this is only for convenience, 'name' is the real path used on file read but in
247          * some cases its useful to access the absolute one.
248          * This is set on file read.
249          * Use BKE_library_filepath_set() rather than setting 'name' directly and it will be kept in sync - campbell */
250         char filepath[1024];
251
252         struct Library *parent; /* set for indirectly linked libs, used in the outliner and while reading */
253         
254         struct PackedFile *packedfile;
255
256         /* Temp data needed by read/write code. */
257         int temp_index;
258         short versionfile, subversionfile;  /* see BLENDER_VERSION, BLENDER_SUBVERSION, needed for do_versions */
259 } Library;
260
261 enum eIconSizes {
262         ICON_SIZE_ICON = 0,
263         ICON_SIZE_PREVIEW = 1,
264
265         NUM_ICON_SIZES
266 };
267
268 /* for PreviewImage->flag */
269 enum ePreviewImage_Flag {
270         PRV_CHANGED          = (1 << 0),
271         PRV_USER_EDITED      = (1 << 1),  /* if user-edited, do not auto-update this anymore! */
272 };
273
274 /* for PreviewImage->tag */
275 enum  {
276         PRV_TAG_DEFFERED           = (1 << 0),  /* Actual loading of preview is deffered. */
277         PRV_TAG_DEFFERED_RENDERING = (1 << 1),  /* Deffered preview is being loaded. */
278         PRV_TAG_DEFFERED_DELETE    = (1 << 2),  /* Deffered preview should be deleted asap. */
279 };
280
281 typedef struct PreviewImage {
282         /* All values of 2 are really NUM_ICON_SIZES */
283         unsigned int w[2];
284         unsigned int h[2];
285         short flag[2];
286         short changed_timestamp[2];
287         unsigned int *rect[2];
288
289         /* Runtime-only data. */
290         struct GPUTexture *gputexture[2];
291         int icon_id;  /* Used by previews outside of ID context. */
292
293         short tag;  /* Runtime data. */
294         char pad[2];
295 } PreviewImage;
296
297 #define PRV_DEFERRED_DATA(prv) \
298         (CHECK_TYPE_INLINE(prv, PreviewImage *), BLI_assert((prv)->tag & PRV_TAG_DEFFERED), (void *)((prv) + 1))
299
300 /**
301  * Defines for working with IDs.
302  *
303  * The tags represent types! This is a dirty way of enabling RTTI. The
304  * sig_byte end endian defines aren't really used much.
305  *
306  **/
307
308 #ifdef __BIG_ENDIAN__
309    /* big endian */
310 #  define MAKE_ID2(c, d)  ((c) << 8 | (d))
311 #else
312    /* little endian  */
313 #  define MAKE_ID2(c, d)  ((d) << 8 | (c))
314 #endif
315
316 /**
317  * ID from database.
318  *
319  * Written to #BHead.code (for file IO)
320  * and the first 2 bytes of #ID.name (for runtime checks, see #GS macro).
321  */
322 typedef enum ID_Type {
323         ID_SCE  = MAKE_ID2('S', 'C'), /* Scene */
324         ID_LI   = MAKE_ID2('L', 'I'), /* Library */
325         ID_OB   = MAKE_ID2('O', 'B'), /* Object */
326         ID_ME   = MAKE_ID2('M', 'E'), /* Mesh */
327         ID_CU   = MAKE_ID2('C', 'U'), /* Curve */
328         ID_MB   = MAKE_ID2('M', 'B'), /* MetaBall */
329         ID_MA   = MAKE_ID2('M', 'A'), /* Material */
330         ID_TE   = MAKE_ID2('T', 'E'), /* Tex (Texture) */
331         ID_IM   = MAKE_ID2('I', 'M'), /* Image */
332         ID_LT   = MAKE_ID2('L', 'T'), /* Lattice */
333         ID_LA   = MAKE_ID2('L', 'A'), /* Lamp */
334         ID_CA   = MAKE_ID2('C', 'A'), /* Camera */
335         ID_IP   = MAKE_ID2('I', 'P'), /* Ipo (depreciated, replaced by FCurves) */
336         ID_KE   = MAKE_ID2('K', 'E'), /* Key (shape key) */
337         ID_WO   = MAKE_ID2('W', 'O'), /* World */
338         ID_SCR  = MAKE_ID2('S', 'R'), /* Screen */
339         ID_VF   = MAKE_ID2('V', 'F'), /* VFont (Vector Font) */
340         ID_TXT  = MAKE_ID2('T', 'X'), /* Text */
341         ID_SPK  = MAKE_ID2('S', 'K'), /* Speaker */
342         ID_SO   = MAKE_ID2('S', 'O'), /* Sound */
343         ID_GR   = MAKE_ID2('G', 'R'), /* Group */
344         ID_AR   = MAKE_ID2('A', 'R'), /* bArmature */
345         ID_AC   = MAKE_ID2('A', 'C'), /* bAction */
346         ID_NT   = MAKE_ID2('N', 'T'), /* bNodeTree */
347         ID_BR   = MAKE_ID2('B', 'R'), /* Brush */
348         ID_PA   = MAKE_ID2('P', 'A'), /* ParticleSettings */
349         ID_GD   = MAKE_ID2('G', 'D'), /* bGPdata, (Grease Pencil) */
350         ID_WM   = MAKE_ID2('W', 'M'), /* WindowManager */
351         ID_MC   = MAKE_ID2('M', 'C'), /* MovieClip */
352         ID_MSK  = MAKE_ID2('M', 'S'), /* Mask */
353         ID_LS   = MAKE_ID2('L', 'S'), /* FreestyleLineStyle */
354         ID_PAL  = MAKE_ID2('P', 'L'), /* Palette */
355         ID_PC   = MAKE_ID2('P', 'C'), /* PaintCurve  */
356         ID_CF   = MAKE_ID2('C', 'F'), /* CacheFile */
357         ID_WS   = MAKE_ID2('W', 'S'), /* WorkSpace */
358         ID_LP   = MAKE_ID2('L', 'P'), /* LightProbe */
359 } ID_Type;
360
361 /* Only used as 'placeholder' in .blend files for directly linked datablocks. */
362 #define ID_ID       MAKE_ID2('I', 'D') /* (internal use only) */
363
364 /* Deprecated. */
365 #define ID_SCRN     MAKE_ID2('S', 'N')
366
367 /* NOTE! Fake IDs, needed for g.sipo->blocktype or outliner */
368 #define ID_SEQ          MAKE_ID2('S', 'Q')
369                         /* constraint */
370 #define ID_CO           MAKE_ID2('C', 'O')
371                         /* pose (action channel, used to be ID_AC in code, so we keep code for backwards compat) */
372 #define ID_PO           MAKE_ID2('A', 'C')
373                         /* used in outliner... */
374 #define ID_NLA          MAKE_ID2('N', 'L')
375                         /* fluidsim Ipo */
376 #define ID_FLUIDSIM     MAKE_ID2('F', 'S')
377
378 #define ID_FAKE_USERS(id) ((((ID *)id)->flag & LIB_FAKEUSER) ? 1 : 0)
379 #define ID_REAL_USERS(id) (((ID *)id)->us - ID_FAKE_USERS(id))
380 #define ID_EXTRA_USERS(id) (((ID *)id)->tag & LIB_TAG_EXTRAUSER ? 1 : 0)
381
382 #define ID_CHECK_UNDO(id) ((GS((id)->name) != ID_SCR) && (GS((id)->name) != ID_WM) && (GS((id)->name) != ID_WS))
383
384 #define ID_BLEND_PATH(_bmain, _id) ((_id)->lib ? (_id)->lib->filepath : BKE_main_blendfile_path((_bmain)))
385
386 #define ID_MISSING(_id) (((_id)->tag & LIB_TAG_MISSING) != 0)
387
388 #define ID_IS_LINKED(_id) (((ID *)(_id))->lib != NULL)
389
390 #define ID_IS_STATIC_OVERRIDE(_id) (((ID *)(_id))->override_static != NULL && \
391                                     ((ID *)(_id))->override_static->reference != NULL)
392
393 #define ID_IS_STATIC_OVERRIDE_TEMPLATE(_id) (((ID *)(_id))->override_static != NULL && \
394                                              ((ID *)(_id))->override_static->reference == NULL)
395
396 #define ID_IS_STATIC_OVERRIDE_AUTO(_id) (!ID_IS_LINKED((_id)) && \
397                                          ID_IS_STATIC_OVERRIDE((_id)) && \
398                                          (((ID *)(_id))->override_static->flag & STATICOVERRIDE_AUTO))
399
400 /* No copy-on-write for these types. */
401 #define ID_TYPE_IS_COW(_id_type) \
402         (!ELEM(_id_type, ID_WM, ID_SCR, ID_SCRN, ID_IM, ID_MC, ID_LI))
403
404 #ifdef GS
405 #  undef GS
406 #endif
407 #define GS(a)   (CHECK_TYPE_ANY(a, char *, const char *, char [66], const char[66]), (ID_Type)(*((const short *)(a))))
408
409 #define ID_NEW_SET(_id, _idn) \
410         (((ID *)(_id))->newid = (ID *)(_idn), ((ID *)(_id))->newid->tag |= LIB_TAG_NEW, (void *)((ID *)(_id))->newid)
411 #define ID_NEW_REMAP(a) if ((a) && (a)->id.newid) (a) = (void *)(a)->id.newid
412
413 /* id->flag (persitent). */
414 enum {
415         LIB_FAKEUSER                = 1 << 9,
416 };
417
418 /**
419  * id->tag (runtime-only).
420  *
421  * Those flags belong to three different categories, which have different expected handling in code:
422  *
423  *   - RESET_BEFORE_USE: piece of code that wants to use such flag has to ensure they are properly 'reset' first.
424  *   - RESET_AFTER_USE: piece of code that wants to use such flag has to ensure they are properly 'reset' after usage
425  *                      (though 'lifetime' of those flags is a bit fuzzy, e.g. _RECALC ones are reset on depsgraph
426  *                       evaluation...).
427  *   - RESET_NEVER: those flags are 'status' one, and never actually need any reset (except on initialization
428  *                  during .blend file reading).
429  */
430 enum {
431         /* RESET_NEVER Datablock is from current .blend file. */
432         LIB_TAG_LOCAL           = 0,
433         /* RESET_NEVER Datablock is from a library, but is used (linked) directly by current .blend file. */
434         LIB_TAG_EXTERN          = 1 << 0,
435         /* RESET_NEVER Datablock is from a library, and is only used (linked) inderectly through other libraries. */
436         LIB_TAG_INDIRECT        = 1 << 1,
437
438         /* RESET_AFTER_USE Three flags used internally in readfile.c, to mark IDs needing to be read (only done once). */
439         LIB_TAG_NEED_EXPAND     = 1 << 3,
440         LIB_TAG_TESTEXT         = (LIB_TAG_NEED_EXPAND | LIB_TAG_EXTERN),
441         LIB_TAG_TESTIND         = (LIB_TAG_NEED_EXPAND | LIB_TAG_INDIRECT),
442         /* RESET_AFTER_USE Flag used internally in readfile.c, to mark IDs needing to be linked from a library. */
443         LIB_TAG_READ            = 1 << 4,
444         /* RESET_AFTER_USE */
445         LIB_TAG_NEED_LINK       = 1 << 5,
446
447         /* RESET_NEVER tag datablock as a place-holder (because the real one could not be linked from its library e.g.). */
448         LIB_TAG_MISSING         = 1 << 6,
449
450         /* RESET_NEVER tag datablock as being up-to-date regarding its reference. */
451         LIB_TAG_OVERRIDESTATIC_REFOK = 1 << 9,
452         /* RESET_NEVER tag datablock as needing an auto-override execution, if enabled. */
453         LIB_TAG_OVERRIDESTATIC_AUTOREFRESH = 1 << 17,
454
455         /* tag datablock has having an extra user. */
456         LIB_TAG_EXTRAUSER       = 1 << 2,
457         /* tag datablock has having actually increased usercount for the extra virtual user. */
458         LIB_TAG_EXTRAUSER_SET   = 1 << 7,
459
460         /* RESET_AFTER_USE tag newly duplicated/copied IDs.
461          * Also used internally in readfile.c to mark datablocks needing do_versions. */
462         LIB_TAG_NEW             = 1 << 8,
463         /* RESET_BEFORE_USE free test flag.
464          * TODO make it a RESET_AFTER_USE too. */
465         LIB_TAG_DOIT            = 1 << 10,
466         /* RESET_AFTER_USE tag existing data before linking so we know what is new. */
467         LIB_TAG_PRE_EXISTING    = 1 << 11,
468
469         /* The datablock is a copy-on-write/localized version. */
470         LIB_TAG_COPIED_ON_WRITE               = 1 << 12,
471         LIB_TAG_COPIED_ON_WRITE_EVAL_RESULT   = 1 << 13,
472         LIB_TAG_LOCALIZED = 1 << 14,
473
474         /* RESET_NEVER tag datablock for freeing etc. behavior (usually set when copying real one into temp/runtime one). */
475         LIB_TAG_NO_MAIN          = 1 << 15,  /* Datablock is not listed in Main database. */
476         LIB_TAG_NO_USER_REFCOUNT = 1 << 16,  /* Datablock does not refcount usages of other IDs. */
477         /* Datablock was not allocated by standard system (BKE_libblock_alloc), do not free its memory
478          * (usual type-specific freeing is called though). */
479         LIB_TAG_NOT_ALLOCATED     = 1 << 17,
480 };
481
482 /* WARNING - when adding flags check on PSYS_RECALC */
483 enum {
484         /* RESET_AFTER_USE, used by update code (depsgraph). */
485         ID_RECALC_NONE  = 0,
486         /* Generic recalc flag, when nothing else matches. */
487         ID_RECALC       = 1 << 0,
488         /* Per-component update flags. */
489         ID_RECALC_ANIMATION   = 1 << 1,
490         ID_RECALC_DRAW        = 1 << 2,
491         ID_RECALC_DRAW_CACHE  = 1 << 3,
492         ID_RECALC_GEOMETRY    = 1 << 4,
493         ID_RECALC_TRANSFORM   = 1 << 5,
494         ID_RECALC_COPY_ON_WRITE = 1 << 6,
495         /* Special flag to check if SOMETHING was changed. */
496         ID_RECALC_ALL   = (~(int)0),
497 };
498
499 /* To filter ID types (filter_id) */
500 /* XXX We cannot put all needed IDs inside an enum...
501  *     We'll have to see whether we can fit all needed ones inside 32 values,
502  *     or if we need to fallback to longlong defines :/
503  */
504 enum {
505         FILTER_ID_AC        = (1 << 0),
506         FILTER_ID_AR        = (1 << 1),
507         FILTER_ID_BR        = (1 << 2),
508         FILTER_ID_CA        = (1 << 3),
509         FILTER_ID_CU        = (1 << 4),
510         FILTER_ID_GD        = (1 << 5),
511         FILTER_ID_GR        = (1 << 6),
512         FILTER_ID_IM        = (1 << 7),
513         FILTER_ID_LA        = (1 << 8),
514         FILTER_ID_LS        = (1 << 9),
515         FILTER_ID_LT        = (1 << 10),
516         FILTER_ID_MA        = (1 << 11),
517         FILTER_ID_MB        = (1 << 12),
518         FILTER_ID_MC        = (1 << 13),
519         FILTER_ID_ME        = (1 << 14),
520         FILTER_ID_MSK       = (1 << 15),
521         FILTER_ID_NT        = (1 << 16),
522         FILTER_ID_OB        = (1 << 17),
523         FILTER_ID_PAL       = (1 << 18),
524         FILTER_ID_PC        = (1 << 19),
525         FILTER_ID_SCE       = (1 << 20),
526         FILTER_ID_SPK       = (1 << 21),
527         FILTER_ID_SO        = (1 << 22),
528         FILTER_ID_TE        = (1 << 23),
529         FILTER_ID_TXT       = (1 << 24),
530         FILTER_ID_VF        = (1 << 25),
531         FILTER_ID_WO        = (1 << 26),
532         FILTER_ID_PA        = (1 << 27),
533         FILTER_ID_CF        = (1 << 28),
534         FILTER_ID_WS        = (1 << 29),
535         FILTER_ID_LP        = (1u << 31),
536 };
537
538 /* IMPORTANT: this enum matches the order currently use in set_listbasepointers,
539  * keep them in sync! */
540 enum {
541         INDEX_ID_LI = 0,
542         INDEX_ID_IP,
543         INDEX_ID_AC,
544         INDEX_ID_KE,
545         INDEX_ID_GD,
546         INDEX_ID_NT,
547         INDEX_ID_IM,
548         INDEX_ID_TE,
549         INDEX_ID_MA,
550         INDEX_ID_VF,
551         INDEX_ID_AR,
552         INDEX_ID_CF,
553         INDEX_ID_ME,
554         INDEX_ID_CU,
555         INDEX_ID_MB,
556         INDEX_ID_LT,
557         INDEX_ID_LA,
558         INDEX_ID_CA,
559         INDEX_ID_TXT,
560         INDEX_ID_SO,
561         INDEX_ID_GR,
562         INDEX_ID_PAL,
563         INDEX_ID_PC,
564         INDEX_ID_BR,
565         INDEX_ID_PA,
566         INDEX_ID_SPK,
567         INDEX_ID_LP,
568         INDEX_ID_WO,
569         INDEX_ID_MC,
570         INDEX_ID_SCR,
571         INDEX_ID_OB,
572         INDEX_ID_LS,
573         INDEX_ID_SCE,
574         INDEX_ID_WS,
575         INDEX_ID_WM,
576         INDEX_ID_MSK,
577         INDEX_ID_NULL,
578 };
579
580 #ifdef __cplusplus
581 }
582 #endif
583
584 #endif