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