165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn/* 265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * Copyright (C) 2011 The Android Open Source Project 365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * 465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * Licensed under the Apache License, Version 2.0 (the "License"); 565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * you may not use this file except in compliance with the License. 665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * You may obtain a copy of the License at 765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * 865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * http://www.apache.org/licenses/LICENSE-2.0 965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * 1065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * Unless required by applicable law or agreed to in writing, software 1165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * distributed under the License is distributed on an "AS IS" BASIS, 1265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * See the License for the specific language governing permissions and 1465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * limitations under the License. 1565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn */ 1665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 1765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 1865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Rennpackage android.media.effect; 1965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 2065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Rennimport android.filterfw.core.CachedFrameManager; 2165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Rennimport android.filterfw.core.FilterContext; 2265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Rennimport android.filterfw.core.FilterFactory; 2365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Rennimport android.filterfw.core.GLEnvironment; 2465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Rennimport android.filterfw.core.GLFrame; 2565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Rennimport android.filterfw.core.Frame; 2665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Rennimport android.filterfw.core.FrameFormat; 2765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Rennimport android.filterfw.core.FrameManager; 2865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Rennimport android.filterfw.format.ImageFormat; 2965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 3065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn/** 3165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * The FilterEffect class is the base class for all Effects based on Filters from the Mobile 3265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * Filter Framework (MFF). 3365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * @hide 3465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn */ 3565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Rennpublic abstract class FilterEffect extends Effect { 3665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 3765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn protected EffectContext mEffectContext; 3865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn private String mName; 3965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 4065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn /** 4165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * Protected constructor as FilterEffects should be created by Factory. 4265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn */ 4365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn protected FilterEffect(EffectContext context, String name) { 4465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn mEffectContext = context; 4565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn mName = name; 4665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } 4765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 4865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn /** 4965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * Get the effect name. 5065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * 5165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * Returns the unique name of the effect, which matches the name used for instantiating this 5265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * effect by the EffectFactory. 5365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * 5465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * @return The name of the effect. 5565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn */ 5665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn @Override 5765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn public String getName() { 5865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn return mName; 5965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } 6065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 6165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn // Helper Methods for subclasses /////////////////////////////////////////////////////////////// 6265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn /** 6365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * Call this before manipulating the GL context. Will assert that the GL environment is in a 6465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * valid state, and save it. 6565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn */ 6665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn protected void beginGLEffect() { 6765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn mEffectContext.assertValidGLState(); 6865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn mEffectContext.saveGLState(); 6965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } 7065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 7165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn /** 7265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * Call this after manipulating the GL context. Restores the previous GL state. 7365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn */ 7465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn protected void endGLEffect() { 7565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn mEffectContext.restoreGLState(); 7665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } 7765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 7865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn /** 7965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * Returns the active filter context for this effect. 8065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn */ 8165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn protected FilterContext getFilterContext() { 8265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn return mEffectContext.mFilterContext; 8365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } 8465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 8565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn /** 8665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * Converts a texture into a Frame. 8765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn */ 8865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn protected Frame frameFromTexture(int texId, int width, int height) { 8965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn FrameManager manager = getFilterContext().getFrameManager(); 9065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn FrameFormat format = ImageFormat.create(width, height, 9165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn ImageFormat.COLORSPACE_RGBA, 9265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn FrameFormat.TARGET_GPU); 9365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn Frame frame = manager.newBoundFrame(format, 9465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn GLFrame.EXISTING_TEXTURE_BINDING, 9565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn texId); 9665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn frame.setTimestamp(Frame.TIMESTAMP_UNKNOWN); 9765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn return frame; 9865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } 9965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 10065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn} 10165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 102