1/*
2 * Copyright (C) 2012 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
17package android.renderscript;
18
19import android.util.Log;
20
21/**
22 * Intrinsic for applying a 5x5 convolve to an allocation.
23 *
24 **/
25public final class ScriptIntrinsicConvolve5x5 extends ScriptIntrinsic {
26    private final float[] mValues = new float[25];
27    private Allocation mInput;
28
29    private ScriptIntrinsicConvolve5x5(int id, RenderScript rs) {
30        super(id, rs);
31    }
32
33    /**
34     * Supported elements types are {@link Element#U8}, {@link
35     * Element#U8_2}, {@link Element#U8_3}, {@link Element#U8_4},
36     * {@link Element#F32}, {@link Element#F32_2}, {@link
37     * Element#F32_3}, and {@link Element#F32_4}
38     *
39     * The default coefficients are.
40     * <code>
41     * <p> [ 0,  0,  0,  0,  0  ]
42     * <p> [ 0,  0,  0,  0,  0  ]
43     * <p> [ 0,  0,  1,  0,  0  ]
44     * <p> [ 0,  0,  0,  0,  0  ]
45     * <p> [ 0,  0,  0,  0,  0  ]
46     * </code>
47     *
48     * @param rs The RenderScript context
49     * @param e Element type for intputs and outputs
50     *
51     * @return ScriptIntrinsicConvolve5x5
52     */
53    public static ScriptIntrinsicConvolve5x5 create(RenderScript rs, Element e) {
54        if (!e.isCompatible(Element.U8(rs)) &&
55            !e.isCompatible(Element.U8_2(rs)) &&
56            !e.isCompatible(Element.U8_3(rs)) &&
57            !e.isCompatible(Element.U8_4(rs)) &&
58            !e.isCompatible(Element.F32(rs)) &&
59            !e.isCompatible(Element.F32_2(rs)) &&
60            !e.isCompatible(Element.F32_3(rs)) &&
61            !e.isCompatible(Element.F32_4(rs))) {
62            throw new RSIllegalArgumentException("Unsuported element type.");
63        }
64
65        int id = rs.nScriptIntrinsicCreate(4, e.getID(rs));
66        return new ScriptIntrinsicConvolve5x5(id, rs);
67
68    }
69
70    /**
71     * Set the input of the blur.
72     * Must match the element type supplied during create.
73     *
74     * @param ain The input allocation.
75     */
76    public void setInput(Allocation ain) {
77        mInput = ain;
78        setVar(1, ain);
79    }
80
81    /**
82    * Set the coefficients for the convolve.
83    *
84    * The convolve layout is
85    * <code>
86    * <p> [ 0,  1,  2,  3,  4  ]
87    * <p> [ 5,  6,  7,  8,  9  ]
88    * <p> [ 10, 11, 12, 13, 14 ]
89    * <p> [ 15, 16, 17, 18, 19 ]
90    * <p> [ 20, 21, 22, 23, 24 ]
91    * </code>
92    *
93    * @param v The array of coefficients to set
94    */
95    public void setCoefficients(float v[]) {
96        FieldPacker fp = new FieldPacker(25*4);
97        for (int ct=0; ct < mValues.length; ct++) {
98            mValues[ct] = v[ct];
99            fp.addF32(mValues[ct]);
100        }
101        setVar(0, fp);
102    }
103
104    /**
105     * Apply the filter to the input and save to the specified
106     * allocation.
107     *
108     * @param aout Output allocation. Must match creation element
109     *             type.
110     */
111    public void forEach(Allocation aout) {
112        forEach(0, null, aout, null);
113    }
114
115    /**
116     * Get a KernelID for this intrinsic kernel.
117     *
118     * @return Script.KernelID The KernelID object.
119     */
120    public Script.KernelID getKernelID() {
121        return createKernelID(0, 2, null, null);
122    }
123
124    /**
125     * Get a FieldID for the input field of this intrinsic.
126     *
127     * @return Script.FieldID The FieldID object.
128     */
129    public Script.FieldID getFieldID_Input() {
130        return createFieldID(1, null);
131    }
132}
133
134