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