The EffectFactory class defines the list of available Effects, and provides functionality to * inspect and instantiate them. Some effects may not be available on all platforms, so before * creating a certain effect, the application should confirm that the effect is supported on this * platform by calling {@link #isEffectSupported(String)}.
*/ public class EffectFactory { private EffectContext mEffectContext; private final static String[] EFFECT_PACKAGES = { "android.media.effect.effects.", // Default effect package "" // Allows specifying full class path }; /** List of Effects */ /** *Copies the input texture to the output.
*Available parameters: None
* @hide */ public final static String EFFECT_IDENTITY = "IdentityEffect"; /** *Adjusts the brightness of the image.
*Available parameters:
*| Parameter name | Meaning | Valid values |
brightness |
* The brightness multiplier. | *Positive float. 1.0 means no change; larger values will increase brightness. | *
Adjusts the contrast of the image.
*Available parameters:
*| Parameter name | Meaning | Valid values |
contrast |
* The contrast multiplier. | *Float. 1.0 means no change; larger values will increase contrast. | *
Applies a fisheye lens distortion to the image.
*Available parameters:
*| Parameter name | Meaning | Valid values |
scale |
* The scale of the distortion. | *Float, between 0 and 1. Zero means no distortion. | *
Replaces the background of the input frames with frames from a * selected video. Requires an initial learning period with only the * background visible before the effect becomes active. The effect will wait * until it does not see any motion in the scene before learning the * background and starting the effect.
* *Available parameters:
*| Parameter name | Meaning | Valid values |
source |
* A URI for the background video to use. This parameter must be * supplied before calling apply() for the first time. | *String, such as from * {@link android.net.Uri#toString Uri.toString()} | *
If the update listener is set for this effect using * {@link Effect#setUpdateListener}, it will be called when the effect has * finished learning the background, with a null value for the info * parameter.
*/ public final static String EFFECT_BACKDROPPER = "android.media.effect.effects.BackDropperEffect"; /** *Attempts to auto-fix the image based on histogram equalization.
*Available parameters:
*| Parameter name | Meaning | Valid values |
scale |
* The scale of the adjustment. | *Float, between 0 and 1. Zero means no adjustment, while 1 indicates the maximum * amount of adjustment. | *
Adjusts the range of minimal and maximal color pixel intensities.
*Available parameters:
*| Parameter name | Meaning | Valid values |
black |
* The value of the minimal pixel. | *Float, between 0 and 1. | *
white |
* The value of the maximal pixel. | *Float, between 0 and 1. | *
Crops an upright rectangular area from the image. If the crop region falls outside of * the image bounds, the results are undefined.
*Available parameters:
*| Parameter name | Meaning | Valid values |
xorigin |
* The origin's x-value. | *Integer, between 0 and width of the image. | *
yorigin |
* The origin's y-value. | *Integer, between 0 and height of the image. | *
width |
* The width of the cropped image. | *Integer, between 1 and the width of the image minus xorigin. | *
height |
* The height of the cropped image. | *Integer, between 1 and the height of the image minus yorigin. | *
Applies a cross process effect on image, in which the red and green channels are * enhanced while the blue channel is restricted.
*Available parameters: None
*/ public final static String EFFECT_CROSSPROCESS = "android.media.effect.effects.CrossProcessEffect"; /** *Applies black and white documentary style effect on image..
*Available parameters: None
*/ public final static String EFFECT_DOCUMENTARY = "android.media.effect.effects.DocumentaryEffect"; /** *Overlays a bitmap (with premultiplied alpha channel) onto the input image. The bitmap * is stretched to fit the input image.
*Available parameters:
*| Parameter name | Meaning | Valid values |
bitmap |
* The overlay bitmap. | *A non-null Bitmap instance. | *
Representation of photo using only two color tones.
*Available parameters:
*| Parameter name | Meaning | Valid values |
first_color |
* The first color tone. | *Integer, representing an ARGB color with 8 bits per channel. May be created using * {@link android.graphics.Color Color} class. | *
second_color |
* The second color tone. | *Integer, representing an ARGB color with 8 bits per channel. May be created using * {@link android.graphics.Color Color} class. | *
Applies back-light filling to the image.
*Available parameters:
*| Parameter name | Meaning | Valid values |
strength |
* The strength of the backlight. | *Float, between 0 and 1. Zero means no change. | *
Flips image vertically and/or horizontally.
*Available parameters:
*| Parameter name | Meaning | Valid values |
vertical |
* Whether to flip image vertically. | *Boolean | *
horizontal |
* Whether to flip image horizontally. | *Boolean | *
Applies film grain effect to image.
*Available parameters:
*| Parameter name | Meaning | Valid values |
strength |
* The strength of the grain effect. | *Float, between 0 and 1. Zero means no change. | *
Converts image to grayscale.
*Available parameters: None
*/ public final static String EFFECT_GRAYSCALE = "android.media.effect.effects.GrayscaleEffect"; /** *Applies lomo-camera style effect to image.
*Available parameters: None
*/ public final static String EFFECT_LOMOISH = "android.media.effect.effects.LomoishEffect"; /** *Inverts the image colors.
*Available parameters: None
*/ public final static String EFFECT_NEGATIVE = "android.media.effect.effects.NegativeEffect"; /** *Applies posterization effect to image.
*Available parameters: None
*/ public final static String EFFECT_POSTERIZE = "android.media.effect.effects.PosterizeEffect"; /** *Removes red eyes on specified region.
*Available parameters:
*| Parameter name | Meaning | Valid values |
centers |
* Multiple center points (x, y) of the red eye regions. | *An array of floats, where (f[2*i], f[2*i+1]) specifies the center of the i'th eye. * Coordinate values are expected to be normalized between 0 and 1. | *
Rotates the image. The output frame size must be able to fit the rotated version of * the input image. Note that the rotation snaps to a the closest multiple of 90 degrees.
*Available parameters:
*| Parameter name | Meaning | Valid values |
angle |
* The angle of rotation in degrees. | *Integer value. This will be rounded to the nearest multiple of 90. | *
Adjusts color saturation of image.
*Available parameters:
*| Parameter name | Meaning | Valid values |
scale |
* The scale of color saturation. | *Float, between -1 and 1. 0 means no change, while -1 indicates full desaturation, * i.e. grayscale. | *
Converts image to sepia tone.
*Available parameters: None
*/ public final static String EFFECT_SEPIA = "android.media.effect.effects.SepiaEffect"; /** *Sharpens the image.
*Available parameters:
*| Parameter name | Meaning | Valid values |
scale |
* The degree of sharpening. | *Float, between 0 and 1. 0 means no change. | *
Rotates the image according to the specified angle, and crops the image so that no * non-image portions are visible.
*Available parameters:
*| Parameter name | Meaning | Valid values |
angle |
* The angle of rotation. | *Float, between -45 and +45. | *
Adjusts color temperature of the image.
*Available parameters:
*| Parameter name | Meaning | Valid values |
scale |
* The value of color temperature. | *Float, between 0 and 1, with 0 indicating cool, and 1 indicating warm. A value of * of 0.5 indicates no change. | *
Tints the photo with specified color.
*Available parameters:
*| Parameter name | Meaning | Valid values |
tint |
* The color of the tint. | *Integer, representing an ARGB color with 8 bits per channel. May be created using * {@link android.graphics.Color Color} class. | *
Adds a vignette effect to image, i.e. fades away the outer image edges.
*Available parameters:
*| Parameter name | Meaning | Valid values |
scale |
* The scale of vignetting. | *Float, between 0 and 1. 0 means no change. | *
The effect's parameters will be set to their default values.
* *Note that the EGL context associated with the current EffectContext need not be made * current when creating an effect. This allows the host application to instantiate effects * before any EGL context has become current.
* * @param effectName The name of the effect to create. * @return A new Effect instance. * @throws IllegalArgumentException if the effect with the specified name is not supported or * not known. */ public Effect createEffect(String effectName) { Class effectClass = getEffectClassByName(effectName); if (effectClass == null) { throw new IllegalArgumentException("Cannot instantiate unknown effect '" + effectName + "'!"); } return instantiateEffect(effectClass, effectName); } /** * Check if an effect is supported on this platform. * *Some effects may only be available on certain platforms. Use this method before * instantiating an effect to make sure it is supported.
* * @param effectName The name of the effect. * @return true, if the effect is supported on this platform. * @throws IllegalArgumentException if the effect name is not known. */ public static boolean isEffectSupported(String effectName) { return getEffectClassByName(effectName) != null; } private static Class getEffectClassByName(String className) { Class effectClass = null; // Get context's classloader; otherwise cannot load non-framework effects ClassLoader contextClassLoader = Thread.currentThread().getContextClassLoader(); // Look for the class in the imported packages for (String packageName : EFFECT_PACKAGES) { try { effectClass = contextClassLoader.loadClass(packageName + className); } catch (ClassNotFoundException e) { continue; } // Exit loop if class was found. if (effectClass != null) { break; } } return effectClass; } private Effect instantiateEffect(Class effectClass, String name) { // Make sure this is an Effect subclass try { effectClass.asSubclass(Effect.class); } catch (ClassCastException e) { throw new IllegalArgumentException("Attempting to allocate effect '" + effectClass + "' which is not a subclass of Effect!", e); } // Look for the correct constructor Constructor effectConstructor = null; try { effectConstructor = effectClass.getConstructor(EffectContext.class, String.class); } catch (NoSuchMethodException e) { throw new RuntimeException("The effect class '" + effectClass + "' does not have " + "the required constructor.", e); } // Construct the effect Effect effect = null; try { effect = (Effect)effectConstructor.newInstance(mEffectContext, name); } catch (Throwable t) { throw new RuntimeException("There was an error constructing the effect '" + effectClass + "'!", t); } return effect; } }