graphics/java/android/renderscript/Element.java

/*
 * Copyright (C) 2008 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package android.renderscript;

import java.lang.reflect.Field;

/**
 * @hide
 *
 **/
public class Element extends BaseObj {
    int mSize;
    Element[] mElements;
    String[] mElementNames;

    DataType mType;
    DataKind mKind;
    boolean mNormalized;
    int mVectorSize;

    int getSizeBytes() {return mSize;}

    public enum DataType {
        //FLOAT_16 (1, 2),
        FLOAT_32 (2, 4),
        //FLOAT_64 (3, 8),
        SIGNED_8 (4, 1),
        SIGNED_16 (5, 2),
        SIGNED_32 (6, 4),
        //SIGNED_64 (7, 8),
        UNSIGNED_8 (8, 1),
        UNSIGNED_16 (9, 2),
        UNSIGNED_32 (10, 4),
        //UNSIGNED_64 (11, 8),

        UNSIGNED_5_6_5 (12, 2),
        UNSIGNED_5_5_5_1 (13, 2),
        UNSIGNED_4_4_4_4 (14, 2),

        RS_ELEMENT (15, 4),
        RS_TYPE (16, 4),
        RS_ALLOCATION (17, 4),
        RS_SAMPLER (18, 4),
        RS_SCRIPT (19, 4),
        RS_MESH (20, 4),
        RS_PROGRAM_FRAGMENT (21, 4),
        RS_PROGRAM_VERTEX (22, 4),
        RS_PROGRAM_RASTER (23, 4),
        RS_PROGRAM_STORE (24, 4);

        int mID;
        int mSize;
        DataType(int id, int size) {
            mID = id;
            mSize = size;
        }
    }

    public enum DataKind {
        USER (0),
        COLOR (1),
        POSITION (2),
        TEXTURE (3),
        NORMAL (4),
        INDEX (5),
        POINT_SIZE(6),

        PIXEL_L (7),
        PIXEL_A (8),
        PIXEL_LA (9),
        PIXEL_RGB (10),
        PIXEL_RGBA (11);

        int mID;
        DataKind(int id) {
            mID = id;
        }
    }

    public static Element USER_U8(RenderScript rs) {
        if(rs.mElement_USER_U8 == null) {
            rs.mElement_USER_U8 = createUser(rs, DataType.UNSIGNED_8);
        }
        return rs.mElement_USER_U8;
    }

    public static Element USER_I8(RenderScript rs) {
        if(rs.mElement_USER_I8 == null) {
            rs.mElement_USER_I8 = createUser(rs, DataType.SIGNED_8);
        }
        return rs.mElement_USER_I8;
    }

    public static Element USER_U32(RenderScript rs) {
        if(rs.mElement_USER_U32 == null) {
            rs.mElement_USER_U32 = createUser(rs, DataType.UNSIGNED_32);
        }
        return rs.mElement_USER_U32;
    }

    public static Element USER_I32(RenderScript rs) {
        if(rs.mElement_USER_I32 == null) {
            rs.mElement_USER_I32 = createUser(rs, DataType.SIGNED_32);
        }
        return rs.mElement_USER_I32;
    }

    public static Element USER_F32(RenderScript rs) {
        if(rs.mElement_USER_F32 == null) {
            rs.mElement_USER_F32 = createUser(rs, DataType.FLOAT_32);
        }
        return rs.mElement_USER_F32;
    }

    public static Element USER_ELEMENT(RenderScript rs) {
        if(rs.mElement_USER_ELEMENT == null) {
            rs.mElement_USER_ELEMENT = createUser(rs, DataType.RS_ELEMENT);
        }
        return rs.mElement_USER_ELEMENT;
    }

    public static Element USER_TYPE(RenderScript rs) {
        if(rs.mElement_USER_TYPE == null) {
            rs.mElement_USER_TYPE = createUser(rs, DataType.RS_TYPE);
        }
        return rs.mElement_USER_TYPE;
    }

    public static Element USER_ALLOCATION(RenderScript rs) {
        if(rs.mElement_USER_ALLOCATION == null) {
            rs.mElement_USER_ALLOCATION = createUser(rs, DataType.RS_ALLOCATION);
        }
        return rs.mElement_USER_ALLOCATION;
    }

    public static Element USER_SAMPLER(RenderScript rs) {
        if(rs.mElement_USER_SAMPLER == null) {
            rs.mElement_USER_SAMPLER = createUser(rs, DataType.RS_SAMPLER);
        }
        return rs.mElement_USER_SAMPLER;
    }

    public static Element USER_SCRIPT(RenderScript rs) {
        if(rs.mElement_USER_SCRIPT == null) {
            rs.mElement_USER_SCRIPT = createUser(rs, DataType.RS_SCRIPT);
        }
        return rs.mElement_USER_SCRIPT;
    }

    public static Element USER_MESH(RenderScript rs) {
        if(rs.mElement_USER_MESH == null) {
            rs.mElement_USER_MESH = createUser(rs, DataType.RS_MESH);
        }
        return rs.mElement_USER_MESH;
    }

    public static Element USER_PROGRAM_FRAGMENT(RenderScript rs) {
        if(rs.mElement_USER_PROGRAM_FRAGMENT == null) {
            rs.mElement_USER_PROGRAM_FRAGMENT = createUser(rs, DataType.RS_PROGRAM_FRAGMENT);
        }
        return rs.mElement_USER_PROGRAM_FRAGMENT;
    }

    public static Element USER_PROGRAM_VERTEX(RenderScript rs) {
        if(rs.mElement_USER_PROGRAM_VERTEX == null) {
            rs.mElement_USER_PROGRAM_VERTEX = createUser(rs, DataType.RS_PROGRAM_VERTEX);
        }
        return rs.mElement_USER_PROGRAM_VERTEX;
    }

    public static Element USER_PROGRAM_RASTER(RenderScript rs) {
        if(rs.mElement_USER_PROGRAM_RASTER == null) {
            rs.mElement_USER_PROGRAM_RASTER = createUser(rs, DataType.RS_PROGRAM_RASTER);
        }
        return rs.mElement_USER_PROGRAM_RASTER;
    }

    public static Element USER_PROGRAM_STORE(RenderScript rs) {
        if(rs.mElement_USER_PROGRAM_STORE == null) {
            rs.mElement_USER_PROGRAM_STORE = createUser(rs, DataType.RS_PROGRAM_STORE);
        }
        return rs.mElement_USER_PROGRAM_STORE;
    }


    public static Element A_8(RenderScript rs) {
        if(rs.mElement_A_8 == null) {
            rs.mElement_A_8 = createPixel(rs, DataType.UNSIGNED_8, DataKind.PIXEL_A);
        }
        return rs.mElement_A_8;
    }

    public static Element RGB_565(RenderScript rs) {
        if(rs.mElement_RGB_565 == null) {
            rs.mElement_RGB_565 = createPixel(rs, DataType.UNSIGNED_5_6_5, DataKind.PIXEL_RGB);
        }
        return rs.mElement_RGB_565;
    }

    public static Element RGB_888(RenderScript rs) {
        if(rs.mElement_RGB_888 == null) {
            rs.mElement_RGB_888 = createPixel(rs, DataType.UNSIGNED_8, DataKind.PIXEL_RGB);
        }
        return rs.mElement_RGB_888;
    }

    public static Element RGBA_5551(RenderScript rs) {
        if(rs.mElement_RGBA_5551 == null) {
            rs.mElement_RGBA_5551 = createPixel(rs, DataType.UNSIGNED_5_5_5_1, DataKind.PIXEL_RGBA);
        }
        return rs.mElement_RGBA_5551;
    }

    public static Element RGBA_4444(RenderScript rs) {
        if(rs.mElement_RGBA_4444 == null) {
            rs.mElement_RGBA_4444 = createPixel(rs, DataType.UNSIGNED_4_4_4_4, DataKind.PIXEL_RGBA);
        }
        return rs.mElement_RGBA_4444;
    }

    public static Element RGBA_8888(RenderScript rs) {
        if(rs.mElement_RGBA_8888 == null) {
            rs.mElement_RGBA_8888 = createPixel(rs, DataType.UNSIGNED_8, DataKind.PIXEL_RGBA);
        }
        return rs.mElement_RGBA_8888;
    }

    public static Element INDEX_16(RenderScript rs) {
        if(rs.mElement_INDEX_16 == null) {
            rs.mElement_INDEX_16 = createIndex(rs);
        }
        return rs.mElement_INDEX_16;
    }

    public static Element ATTRIB_POSITION_2(RenderScript rs) {
        if(rs.mElement_POSITION_2 == null) {
            rs.mElement_POSITION_2 = createAttrib(rs, DataType.FLOAT_32, DataKind.POSITION, 2);
        }
        return rs.mElement_POSITION_2;
    }

    public static Element ATTRIB_POSITION_3(RenderScript rs) {
        if(rs.mElement_POSITION_3 == null) {
            rs.mElement_POSITION_3 = createAttrib(rs, DataType.FLOAT_32, DataKind.POSITION, 3);
        }
        return rs.mElement_POSITION_3;
    }

    public static Element ATTRIB_TEXTURE_2(RenderScript rs) {
        if(rs.mElement_TEXTURE_2 == null) {
            rs.mElement_TEXTURE_2 = createAttrib(rs, DataType.FLOAT_32, DataKind.TEXTURE, 2);
        }
        return rs.mElement_TEXTURE_2;
    }

    public static Element ATTRIB_NORMAL_3(RenderScript rs) {
        if(rs.mElement_NORMAL_3 == null) {
            rs.mElement_NORMAL_3 = createAttrib(rs, DataType.FLOAT_32, DataKind.NORMAL, 3);
        }
        return rs.mElement_NORMAL_3;
    }

    public static Element ATTRIB_COLOR_U8_4(RenderScript rs) {
        if(rs.mElement_COLOR_U8_4 == null) {
            rs.mElement_COLOR_U8_4 = createAttrib(rs, DataType.UNSIGNED_8, DataKind.COLOR, 4);
        }
        return rs.mElement_COLOR_U8_4;
    }

    public static Element ATTRIB_COLOR_F32_4(RenderScript rs) {
        if(rs.mElement_COLOR_F32_4 == null) {
            rs.mElement_COLOR_F32_4 = createAttrib(rs, DataType.FLOAT_32, DataKind.COLOR, 4);
        }
        return rs.mElement_COLOR_F32_4;
    }

    Element(RenderScript rs, Element[] e, String[] n) {
        super(rs);
        mSize = 0;
        mElements = e;
        mElementNames = n;
        int[] ids = new int[mElements.length];
        for (int ct = 0; ct < mElements.length; ct++ ) {
            mSize += mElements[ct].mSize;
            ids[ct] = mElements[ct].mID;
        }
        mID = rs.nElementCreate2(ids, mElementNames);
    }

    Element(RenderScript rs, DataType dt, DataKind dk, boolean norm, int size) {
        super(rs);
        mSize = dt.mSize * size;
        mType = dt;
        mKind = dk;
        mNormalized = norm;
        mVectorSize = size;
        mID = rs.nElementCreate(dt.mID, dk.mID, norm, size);
    }

    public void destroy() throws IllegalStateException {
        super.destroy();
    }

    public static Element createFromClass(RenderScript rs, Class c) {
        rs.validate();
        Field[] fields = c.getFields();
        Builder b = new Builder(rs);

        for(Field f: fields) {
            Class fc = f.getType();
            if(fc == int.class) {
                b.add(createUser(rs, DataType.SIGNED_32), f.getName());
            } else if(fc == short.class) {
                b.add(createUser(rs, DataType.SIGNED_16), f.getName());
            } else if(fc == byte.class) {
                b.add(createUser(rs, DataType.SIGNED_8), f.getName());
            } else if(fc == float.class) {
                b.add(createUser(rs, DataType.FLOAT_32), f.getName());
            } else {
                throw new IllegalArgumentException("Unkown field type");
            }
        }
        return b.create();
    }


    /////////////////////////////////////////
    public static Element createUser(RenderScript rs, DataType dt) {
        return new Element(rs, dt, DataKind.USER, false, 1);
    }

    public static Element createVector(RenderScript rs, DataType dt, int size) {
        if (size < 2 || size > 4) {
            throw new IllegalArgumentException("Bad size");
        }
        return new Element(rs, dt, DataKind.USER, false, size);
    }

    public static Element createIndex(RenderScript rs) {
        return new Element(rs, DataType.UNSIGNED_16, DataKind.INDEX, false, 1);
    }

    public static Element createAttrib(RenderScript rs, DataType dt, DataKind dk, int size) {
        if (!(dt == DataType.FLOAT_32 ||
              dt == DataType.UNSIGNED_8 ||
              dt == DataType.UNSIGNED_16 ||
              dt == DataType.UNSIGNED_32 ||
              dt == DataType.SIGNED_8 ||
              dt == DataType.SIGNED_16 ||
              dt == DataType.SIGNED_32)) {
            throw new IllegalArgumentException("Unsupported DataType");
        }

        if (!(dk == DataKind.COLOR ||
              dk == DataKind.POSITION ||
              dk == DataKind.TEXTURE ||
              dk == DataKind.NORMAL ||
              dk == DataKind.POINT_SIZE ||
              dk == DataKind.USER)) {
            throw new IllegalArgumentException("Unsupported DataKind");
        }

        if (dk == DataKind.COLOR &&
            ((dt != DataType.FLOAT_32 && dt != DataType.UNSIGNED_8) ||
             size < 3 || size > 4)) {
            throw new IllegalArgumentException("Bad combo");
        }
        if (dk == DataKind.POSITION && (size < 1 || size > 4)) {
            throw new IllegalArgumentException("Bad combo");
        }
        if (dk == DataKind.TEXTURE &&
            (dt != DataType.FLOAT_32 || size < 1 || size > 4)) {
            throw new IllegalArgumentException("Bad combo");
        }
        if (dk == DataKind.NORMAL &&
            (dt != DataType.FLOAT_32 || size != 3)) {
            throw new IllegalArgumentException("Bad combo");
        }
        if (dk == DataKind.POINT_SIZE &&
            (dt != DataType.FLOAT_32 || size != 1)) {
            throw new IllegalArgumentException("Bad combo");
        }

        boolean norm = false;
        if (dk == DataKind.COLOR && dt == DataType.UNSIGNED_8) {
            norm = true;
        }

        return new Element(rs, dt, dk, norm, size);
    }

    public static Element createPixel(RenderScript rs, DataType dt, DataKind dk) {
        if (!(dk == DataKind.PIXEL_L ||
              dk == DataKind.PIXEL_A ||
              dk == DataKind.PIXEL_LA ||
              dk == DataKind.PIXEL_RGB ||
              dk == DataKind.PIXEL_RGBA)) {
            throw new IllegalArgumentException("Unsupported DataKind");
        }
        if (!(dt == DataType.UNSIGNED_8 ||
              dt == DataType.UNSIGNED_5_6_5 ||
              dt == DataType.UNSIGNED_4_4_4_4 ||
              dt == DataType.UNSIGNED_5_5_5_1)) {
            throw new IllegalArgumentException("Unsupported DataType");
        }
        if (dt == DataType.UNSIGNED_5_6_5 && dk != DataKind.PIXEL_RGB) {
            throw new IllegalArgumentException("Bad kind and type combo");
        }
        if (dt == DataType.UNSIGNED_5_5_5_1 && dk != DataKind.PIXEL_RGBA) {
            throw new IllegalArgumentException("Bad kind and type combo");
        }
        if (dt == DataType.UNSIGNED_4_4_4_4 && dk != DataKind.PIXEL_RGBA) {
            throw new IllegalArgumentException("Bad kind and type combo");
        }

        int size = 1;
        if (dk == DataKind.PIXEL_LA) {
            size = 2;
        }
        if (dk == DataKind.PIXEL_RGB) {
            size = 3;
        }
        if (dk == DataKind.PIXEL_RGBA) {
            size = 4;
        }

        return new Element(rs, dt, dk, true, size);
    }

    public static class Builder {
        RenderScript mRS;
        Element[] mElements;
        String[] mElementNames;
        int mCount;

        public Builder(RenderScript rs) {
            mRS = rs;
            mCount = 0;
            mElements = new Element[8];
            mElementNames = new String[8];
        }

        public void add(Element element, String name) {
            if(mCount == mElements.length) {
                Element[] e = new Element[mCount + 8];
                String[] s = new String[mCount + 8];
                System.arraycopy(mElements, 0, e, 0, mCount);
                System.arraycopy(mElementNames, 0, s, 0, mCount);
                mElements = e;
                mElementNames = s;
            }
            mElements[mCount] = element;
            mElementNames[mCount] = name;
            mCount++;
        }

        public Element create() {
            mRS.validate();
            Element[] ein = new Element[mCount];
            String[] sin = new String[mCount];
            java.lang.System.arraycopy(mElements, 0, ein, 0, mCount);
            java.lang.System.arraycopy(mElementNames, 0, sin, 0, mCount);
            return new Element(mRS, ein, sin);
        }
    }

    static void initPredefined(RenderScript rs) {
        int a8 = rs.nElementCreate(DataType.UNSIGNED_8.mID,
                                   DataKind.PIXEL_A.mID, true, 1);
        int rgba4444 = rs.nElementCreate(DataType.UNSIGNED_4_4_4_4.mID,
                                         DataKind.PIXEL_RGBA.mID, true, 4);
        int rgba8888 = rs.nElementCreate(DataType.UNSIGNED_8.mID,
                                         DataKind.PIXEL_RGBA.mID, true, 4);
        int rgb565 = rs.nElementCreate(DataType.UNSIGNED_5_6_5.mID,
                                       DataKind.PIXEL_RGB.mID, true, 3);
        rs.nInitElements(a8, rgba4444, rgba8888, rgb565);
    }
}