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.filterfw.core; 1965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 2065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn/** 2165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * @hide 2265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn */ 2365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Rennpublic abstract class GraphRunner { 2465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 2565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn protected FilterContext mFilterContext = null; 2665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 2765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn /** Interface for listeners waiting for the runner to complete. */ 2865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn public interface OnRunnerDoneListener { 2965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn /** Callback method to be called when the runner completes a 3065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * {@link #run()} call. 3165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * 3265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * @param result will be RESULT_FINISHED if the graph finished running 3365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * on its own, RESULT_STOPPED if the runner was stopped by a call 3465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * to stop(), RESULT_BLOCKED if no filters could run due to lack 3565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * of inputs or outputs or due to scheduling policies, and 3665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * RESULT_SLEEPING if a filter node requested sleep. 3765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn */ 3865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn public void onRunnerDone(int result); 3965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } 4065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 4165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn public static final int RESULT_UNKNOWN = 0; 4265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn public static final int RESULT_RUNNING = 1; 4365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn public static final int RESULT_FINISHED = 2; 4465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn public static final int RESULT_SLEEPING = 3; 4565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn public static final int RESULT_BLOCKED = 4; 4665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn public static final int RESULT_STOPPED = 5; 4765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn public static final int RESULT_ERROR = 6; 4865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 4965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn public GraphRunner(FilterContext context) { 5065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn mFilterContext = context; 5165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } 5265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 5365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn public abstract FilterGraph getGraph(); 5465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 5565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn public FilterContext getContext() { 5665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn return mFilterContext; 5765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } 5865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 5965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn /** 6065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * Helper function for subclasses to activate the GL environment before running. 6165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * @return true, if the GL environment was activated. Returns false, if the GL environment 6265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * was already active. 6365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn */ 6465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn protected boolean activateGlContext() { 6565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn GLEnvironment glEnv = mFilterContext.getGLEnvironment(); 6665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn if (glEnv != null && !glEnv.isActive()) { 6765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn glEnv.activate(); 6865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn return true; 6965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } 7065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn return false; 7165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } 7265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 7365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn /** 7465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * Helper function for subclasses to deactivate the GL environment after running. 7565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn */ 7665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn protected void deactivateGlContext() { 7765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn GLEnvironment glEnv = mFilterContext.getGLEnvironment(); 7865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn if (glEnv != null) { 7965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn glEnv.deactivate(); 8065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } 8165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } 8265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 8365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn /** Starts running the graph. Will open the filters in the graph if they are not already open. */ 8465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn public abstract void run(); 8565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 8665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn public abstract void setDoneCallback(OnRunnerDoneListener listener); 8765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn public abstract boolean isRunning(); 8865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 8965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn /** Stops graph execution. As part of stopping, also closes the graph nodes. */ 9065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn public abstract void stop(); 9165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 9265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn /** Closes the filters in a graph. Can only be called if the graph is not running. */ 9365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn public abstract void close(); 9465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 9565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn /** 9665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * Returns the last exception that happened during an asynchronous run. Returns null if 9765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * there is nothing to report. 9865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn */ 9965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn public abstract Exception getError(); 10065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn} 101