rsDefines.h revision f5029803ae6ce9d92d70b76e7a7cdd8d484f31ca 
1/*
2 * Copyright (C) 2013 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef RENDER_SCRIPT_DEFINES_H
18#define RENDER_SCRIPT_DEFINES_H
19
20#include <stdint.h>
21#include <sys/types.h>
22
23#ifdef __cplusplus
24extern "C" {
25#endif
26
27//////////////////////////////////////////////////////
28//
29
30typedef void * RsAsyncVoidPtr;
31
32typedef void * RsAllocation;
33typedef void * RsAnimation;
34typedef void * RsClosure;
35typedef void * RsContext;
36typedef void * RsDevice;
37typedef void * RsElement;
38typedef void * RsFile;
39typedef void * RsFont;
40typedef void * RsSampler;
41typedef void * RsScript;
42typedef void * RsScriptKernelID;
43typedef void * RsScriptInvokeID;
44typedef void * RsScriptFieldID;
45typedef void * RsScriptMethodID;
46typedef void * RsScriptGroup;
47typedef void * RsScriptGroup2;
48typedef void * RsMesh;
49typedef void * RsPath;
50typedef void * RsType;
51typedef void * RsObjectBase;
52
53typedef void * RsProgram;
54typedef void * RsProgramVertex;
55typedef void * RsProgramFragment;
56typedef void * RsProgramStore;
57typedef void * RsProgramRaster;
58
59typedef void * RsNativeWindow;
60
61typedef void (* RsBitmapCallback_t)(void *);
62
63typedef struct {
64    float m[16];
65} rs_matrix4x4;
66
67typedef struct {
68    float m[9];
69} rs_matrix3x3;
70
71typedef struct {
72    float m[4];
73} rs_matrix2x2;
74
75enum RsDeviceParam {
76    RS_DEVICE_PARAM_FORCE_SOFTWARE_GL,
77    RS_DEVICE_PARAM_COUNT
78};
79
80enum RsContextType {
81    RS_CONTEXT_TYPE_NORMAL,
82    RS_CONTEXT_TYPE_DEBUG,
83    RS_CONTEXT_TYPE_PROFILE
84};
85
86
87enum RsAllocationUsageType {
88    RS_ALLOCATION_USAGE_SCRIPT = 0x0001,
89    RS_ALLOCATION_USAGE_GRAPHICS_TEXTURE = 0x0002,
90    RS_ALLOCATION_USAGE_GRAPHICS_VERTEX = 0x0004,
91    RS_ALLOCATION_USAGE_GRAPHICS_CONSTANTS = 0x0008,
92    RS_ALLOCATION_USAGE_GRAPHICS_RENDER_TARGET = 0x0010,
93    RS_ALLOCATION_USAGE_IO_INPUT = 0x0020,
94    RS_ALLOCATION_USAGE_IO_OUTPUT = 0x0040,
95    RS_ALLOCATION_USAGE_SHARED = 0x0080,
96
97    RS_ALLOCATION_USAGE_OEM = 0x8000,
98    RS_ALLOCATION_USAGE_ALL = 0x80FF
99};
100
101enum RsAllocationMipmapControl {
102    RS_ALLOCATION_MIPMAP_NONE = 0,
103    RS_ALLOCATION_MIPMAP_FULL = 1,
104    RS_ALLOCATION_MIPMAP_ON_SYNC_TO_TEXTURE = 2
105};
106
107enum RsAllocationCubemapFace {
108    RS_ALLOCATION_CUBEMAP_FACE_POSITIVE_X = 0,
109    RS_ALLOCATION_CUBEMAP_FACE_NEGATIVE_X = 1,
110    RS_ALLOCATION_CUBEMAP_FACE_POSITIVE_Y = 2,
111    RS_ALLOCATION_CUBEMAP_FACE_NEGATIVE_Y = 3,
112    RS_ALLOCATION_CUBEMAP_FACE_POSITIVE_Z = 4,
113    RS_ALLOCATION_CUBEMAP_FACE_NEGATIVE_Z = 5
114};
115
116enum RsDataType {
117    RS_TYPE_NONE = 0,
118    RS_TYPE_FLOAT_16,
119    RS_TYPE_FLOAT_32,
120    RS_TYPE_FLOAT_64,
121    RS_TYPE_SIGNED_8,
122    RS_TYPE_SIGNED_16,
123    RS_TYPE_SIGNED_32,
124    RS_TYPE_SIGNED_64,
125    RS_TYPE_UNSIGNED_8,
126    RS_TYPE_UNSIGNED_16,
127    RS_TYPE_UNSIGNED_32,
128    RS_TYPE_UNSIGNED_64,
129
130    RS_TYPE_BOOLEAN,
131
132    RS_TYPE_UNSIGNED_5_6_5,
133    RS_TYPE_UNSIGNED_5_5_5_1,
134    RS_TYPE_UNSIGNED_4_4_4_4,
135
136    RS_TYPE_MATRIX_4X4,
137    RS_TYPE_MATRIX_3X3,
138    RS_TYPE_MATRIX_2X2,
139
140    RS_TYPE_ELEMENT = 1000,
141    RS_TYPE_TYPE,
142    RS_TYPE_ALLOCATION,
143    RS_TYPE_SAMPLER,
144    RS_TYPE_SCRIPT,
145    RS_TYPE_MESH,
146    RS_TYPE_PROGRAM_FRAGMENT,
147    RS_TYPE_PROGRAM_VERTEX,
148    RS_TYPE_PROGRAM_RASTER,
149    RS_TYPE_PROGRAM_STORE,
150    RS_TYPE_FONT,
151
152    RS_TYPE_INVALID = 10000,
153};
154
155enum RsDataKind {
156    RS_KIND_USER,
157
158    RS_KIND_PIXEL_L = 7,
159    RS_KIND_PIXEL_A,
160    RS_KIND_PIXEL_LA,
161    RS_KIND_PIXEL_RGB,
162    RS_KIND_PIXEL_RGBA,
163    RS_KIND_PIXEL_DEPTH,
164    RS_KIND_PIXEL_YUV,
165
166    RS_KIND_INVALID = 100,
167};
168
169enum RsSamplerParam {
170    RS_SAMPLER_MIN_FILTER,
171    RS_SAMPLER_MAG_FILTER,
172    RS_SAMPLER_WRAP_S,
173    RS_SAMPLER_WRAP_T,
174    RS_SAMPLER_WRAP_R,
175    RS_SAMPLER_ANISO
176};
177
178enum RsSamplerValue {
179    RS_SAMPLER_NEAREST,
180    RS_SAMPLER_LINEAR,
181    RS_SAMPLER_LINEAR_MIP_LINEAR,
182    RS_SAMPLER_WRAP,
183    RS_SAMPLER_CLAMP,
184    RS_SAMPLER_LINEAR_MIP_NEAREST,
185    RS_SAMPLER_MIRRORED_REPEAT,
186
187    RS_SAMPLER_INVALID = 100,
188};
189
190enum RsDimension {
191    RS_DIMENSION_X,
192    RS_DIMENSION_Y,
193    RS_DIMENSION_Z,
194    RS_DIMENSION_LOD,
195    RS_DIMENSION_FACE,
196
197    RS_DIMENSION_ARRAY_0 = 100,
198    RS_DIMENSION_ARRAY_1,
199    RS_DIMENSION_ARRAY_2,
200    RS_DIMENSION_ARRAY_3,
201    RS_DIMENSION_MAX = RS_DIMENSION_ARRAY_3
202};
203
204
205enum RsError {
206    RS_ERROR_NONE = 0,
207    RS_ERROR_BAD_SHADER = 1,
208    RS_ERROR_BAD_SCRIPT = 2,
209    RS_ERROR_BAD_VALUE = 3,
210    RS_ERROR_OUT_OF_MEMORY = 4,
211    RS_ERROR_DRIVER = 5,
212
213    // Errors that only occur in the debug context.
214    RS_ERROR_FATAL_DEBUG = 0x0800,
215
216    RS_ERROR_FATAL_UNKNOWN = 0x1000,
217    RS_ERROR_FATAL_DRIVER = 0x1001,
218    RS_ERROR_FATAL_PROGRAM_LINK = 0x1002
219};
220
221enum RsForEachStrategy {
222    RS_FOR_EACH_STRATEGY_SERIAL = 0,
223    RS_FOR_EACH_STRATEGY_DONT_CARE = 1,
224    RS_FOR_EACH_STRATEGY_DST_LINEAR = 2,
225    RS_FOR_EACH_STRATEGY_TILE_SMALL = 3,
226    RS_FOR_EACH_STRATEGY_TILE_MEDIUM = 4,
227    RS_FOR_EACH_STRATEGY_TILE_LARGE = 5
228};
229
230// Script to Script
231typedef struct {
232    enum RsForEachStrategy strategy;
233    uint32_t xStart;
234    uint32_t xEnd;
235    uint32_t yStart;
236    uint32_t yEnd;
237    uint32_t zStart;
238    uint32_t zEnd;
239    uint32_t arrayStart;
240    uint32_t arrayEnd;
241    uint32_t array2Start;
242    uint32_t array2End;
243    uint32_t array3Start;
244    uint32_t array3End;
245    uint32_t array4Start;
246    uint32_t array4End;
247
248} RsScriptCall;
249
250enum RsContextFlags {
251    RS_CONTEXT_SYNCHRONOUS      = 0x0001,
252    RS_CONTEXT_LOW_LATENCY      = 0x0002,
253    RS_CONTEXT_LOW_POWER        = 0x0004,
254    RS_CONTEXT_WAIT_FOR_ATTACH  = 0x0008,
255    RS_CONTEXT_OPT_LEVEL_0      = 0x0010
256};
257
258enum RsBlasTranspose {
259    RsBlasNoTrans=111,
260    RsBlasTrans=112,
261    RsBlasConjTrans=113
262};
263
264enum RsBlasUplo {
265    RsBlasUpper=121,
266    RsBlasLower=122
267};
268
269enum RsBlasDiag {
270    RsBlasNonUnit=131,
271    RsBlasUnit=132
272};
273
274enum RsBlasSide {
275    RsBlasLeft=141,
276    RsBlasRight=142
277};
278
279enum RsBlasFunction {
280    RsBlas_nop = 0,
281    RsBlas_sdsdot = 1,
282    RsBlas_dsdot = 2,
283    RsBlas_sdot = 3,
284    RsBlas_ddot = 4,
285    RsBlas_cdotu_sub = 5,
286    RsBlas_cdotc_sub = 6,
287    RsBlas_zdotu_sub = 7,
288    RsBlas_zdotc_sub = 8,
289    RsBlas_snrm2 = 9,
290    RsBlas_sasum = 10,
291    RsBlas_dnrm2 = 11,
292    RsBlas_dasum = 12,
293    RsBlas_scnrm2 = 13,
294    RsBlas_scasum = 14,
295    RsBlas_dznrm2 = 15,
296    RsBlas_dzasum = 16,
297    RsBlas_isamax = 17,
298    RsBlas_idamax = 18,
299    RsBlas_icamax = 19,
300    RsBlas_izamax = 20,
301    RsBlas_sswap = 21,
302    RsBlas_scopy = 22,
303    RsBlas_saxpy = 23,
304    RsBlas_dswap = 24,
305    RsBlas_dcopy = 25,
306    RsBlas_daxpy = 26,
307    RsBlas_cswap = 27,
308    RsBlas_ccopy = 28,
309    RsBlas_caxpy = 29,
310    RsBlas_zswap = 30,
311    RsBlas_zcopy = 31,
312    RsBlas_zaxpy = 32,
313    RsBlas_srotg = 33,
314    RsBlas_srotmg = 34,
315    RsBlas_srot = 35,
316    RsBlas_srotm = 36,
317    RsBlas_drotg = 37,
318    RsBlas_drotmg = 38,
319    RsBlas_drot = 39,
320    RsBlas_drotm = 40,
321    RsBlas_sscal = 41,
322    RsBlas_dscal = 42,
323    RsBlas_cscal = 43,
324    RsBlas_zscal = 44,
325    RsBlas_csscal = 45,
326    RsBlas_zdscal = 46,
327    RsBlas_sgemv = 47,
328    RsBlas_sgbmv = 48,
329    RsBlas_strmv = 49,
330    RsBlas_stbmv = 50,
331    RsBlas_stpmv = 51,
332    RsBlas_strsv = 52,
333    RsBlas_stbsv = 53,
334    RsBlas_stpsv = 54,
335    RsBlas_dgemv = 55,
336    RsBlas_dgbmv = 56,
337    RsBlas_dtrmv = 57,
338    RsBlas_dtbmv = 58,
339    RsBlas_dtpmv = 59,
340    RsBlas_dtrsv = 60,
341    RsBlas_dtbsv = 61,
342    RsBlas_dtpsv = 62,
343    RsBlas_cgemv = 63,
344    RsBlas_cgbmv = 64,
345    RsBlas_ctrmv = 65,
346    RsBlas_ctbmv = 66,
347    RsBlas_ctpmv = 67,
348    RsBlas_ctrsv = 68,
349    RsBlas_ctbsv = 69,
350    RsBlas_ctpsv = 70,
351    RsBlas_zgemv = 71,
352    RsBlas_zgbmv = 72,
353    RsBlas_ztrmv = 73,
354    RsBlas_ztbmv = 74,
355    RsBlas_ztpmv = 75,
356    RsBlas_ztrsv = 76,
357    RsBlas_ztbsv = 77,
358    RsBlas_ztpsv = 78,
359    RsBlas_ssymv = 79,
360    RsBlas_ssbmv = 80,
361    RsBlas_sspmv = 81,
362    RsBlas_sger = 82,
363    RsBlas_ssyr = 83,
364    RsBlas_sspr = 84,
365    RsBlas_ssyr2 = 85,
366    RsBlas_sspr2 = 86,
367    RsBlas_dsymv = 87,
368    RsBlas_dsbmv = 88,
369    RsBlas_dspmv = 89,
370    RsBlas_dger = 90,
371    RsBlas_dsyr = 91,
372    RsBlas_dspr = 92,
373    RsBlas_dsyr2 = 93,
374    RsBlas_dspr2 = 94,
375    RsBlas_chemv = 95,
376    RsBlas_chbmv = 96,
377    RsBlas_chpmv = 97,
378    RsBlas_cgeru = 98,
379    RsBlas_cgerc = 99,
380    RsBlas_cher = 100,
381    RsBlas_chpr = 101,
382    RsBlas_cher2 = 102,
383    RsBlas_chpr2 = 103,
384    RsBlas_zhemv = 104,
385    RsBlas_zhbmv = 105,
386    RsBlas_zhpmv = 106,
387    RsBlas_zgeru = 107,
388    RsBlas_zgerc = 108,
389    RsBlas_zher = 109,
390    RsBlas_zhpr = 110,
391    RsBlas_zher2 = 111,
392    RsBlas_zhpr2 = 112,
393    RsBlas_sgemm = 113,
394    RsBlas_ssymm = 114,
395    RsBlas_ssyrk = 115,
396    RsBlas_ssyr2k = 116,
397    RsBlas_strmm = 117,
398    RsBlas_strsm = 118,
399    RsBlas_dgemm = 119,
400    RsBlas_dsymm = 120,
401    RsBlas_dsyrk = 121,
402    RsBlas_dsyr2k = 122,
403    RsBlas_dtrmm = 123,
404    RsBlas_dtrsm = 124,
405    RsBlas_cgemm = 125,
406    RsBlas_csymm = 126,
407    RsBlas_csyrk = 127,
408    RsBlas_csyr2k = 128,
409    RsBlas_ctrmm = 129,
410    RsBlas_ctrsm = 130,
411    RsBlas_zgemm = 131,
412    RsBlas_zsymm = 132,
413    RsBlas_zsyrk = 133,
414    RsBlas_zsyr2k = 134,
415    RsBlas_ztrmm = 135,
416    RsBlas_ztrsm = 136,
417    RsBlas_chemm = 137,
418    RsBlas_cherk = 138,
419    RsBlas_cher2k = 139,
420    RsBlas_zhemm = 140,
421    RsBlas_zherk = 141,
422    RsBlas_zher2k = 142,
423
424    // BLAS extensions start here
425    RsBlas_bnnm = 1000,
426};
427
428// custom complex types because of NDK support
429typedef struct {
430    float r;
431    float i;
432} RsFloatComplex;
433
434typedef struct {
435    double r;
436    double i;
437} RsDoubleComplex;
438
439typedef union {
440    float f;
441    RsFloatComplex c;
442    double d;
443    RsDoubleComplex z;
444} RsBlasScalar;
445
446typedef struct {
447    RsBlasFunction func;
448    RsBlasTranspose transA;
449    RsBlasTranspose transB;
450    RsBlasUplo uplo;
451    RsBlasDiag diag;
452    RsBlasSide side;
453    int M;
454    int N;
455    int K;
456    RsBlasScalar alpha;
457    RsBlasScalar beta;
458    int incX;
459    int incY;
460    int KL;
461    int KU;
462    uint8_t a_offset;
463    uint8_t b_offset;
464    int32_t c_offset;
465    int32_t c_mult_int;
466} RsBlasCall;
467
468enum RsGlobalProperty {
469    RS_GLOBAL_TYPE     = 0x0000FFFF,
470    RS_GLOBAL_CONSTANT = 0x00010000,
471    RS_GLOBAL_STATIC   = 0x00020000,
472    RS_GLOBAL_POINTER  = 0x00040000
473};
474
475// Special symbols embedded into a shared object compiled by bcc.
476static const char kRoot[] = "root";
477static const char kInit[] = "init";
478static const char kRsDtor[] = ".rs.dtor";
479static const char kRsInfo[] = ".rs.info";
480static const char kRsGlobalEntries[] = ".rs.global_entries";
481static const char kRsGlobalNames[] = ".rs.global_names";
482static const char kRsGlobalAddresses[] = ".rs.global_addresses";
483static const char kRsGlobalSizes[] = ".rs.global_sizes";
484static const char kRsGlobalProperties[] = ".rs.global_properties";
485
486static inline uint32_t getGlobalRsType(uint32_t properties) {
487    return properties & RS_GLOBAL_TYPE;
488}
489static inline bool isGlobalConstant(uint32_t properties) {
490    return properties & RS_GLOBAL_CONSTANT;
491}
492static inline bool isGlobalStatic(uint32_t properties) {
493    return properties & RS_GLOBAL_STATIC;
494}
495static inline bool isGlobalPointer(uint32_t properties) {
496    return properties & RS_GLOBAL_POINTER;
497}
498
499#ifdef __cplusplus
500};
501#endif
502
503#endif // RENDER_SCRIPT_DEFINES_H
504