IT. Expert System.

Direct Known Subclasses:

AutoFixFilter, BackDropperFilter, BitmapOverlayFilter, BitmapSource, BlackWhiteFilter, CallbackFilter, CameraSource, ColorTemperatureFilter, CropFilter, CropRectFilter, CrossProcessFilter, DocumentaryFilter, DrawOverlayFilter, DrawRectFilter, DuotoneFilter, FillLightFilter, FisheyeFilter, FixedRotationFilter, FlipFilter, FrameBranch, FrameFetch, FrameSource, FrameStore, GLTextureSource, GLTextureTarget, GrainFilter, ImageCombineFilter, ImageEncoder, ImageSlicer, ImageStitcher, InputStreamSource, LomoishFilter, MediaEncoderFilter, MediaSource, NegativeFilter, NullFilter, ObjectSource, OutputStreamTarget, PosterizeFilter, RedEyeFilter, ResizeFilter, RetargetFilter, RotateFilter, SaturateFilter, SepiaFilter, SharpenFilter, SimpleImageFilter, SinWaveFilter, StraightenFilter, StringLogger, StringSource, SurfaceRenderFilter, SurfaceTargetFilter, SurfaceTextureSource, SurfaceTextureTarget, ThroughputFilter, TintFilter, ToPackedGrayFilter, ToRGBAFilter, ToRGBFilter, ToUpperCase, VignetteFilter

public abstract class Filter
extends Object

• Constructor Summary

  Constructors

  Constructor and Description
  Filter(String name)

• Method Summary

  Methods

  Modifier and Type	Method and Description
  protected void	addFieldPort(String name, Field field, boolean hasDefault, boolean isFinal)
  protected void	addInputPort(String name) Adds an input port to the filter.
  protected void	addMaskedInputPort(String name, FrameFormat formatMask) Adds an input port to the filter.
  protected void	addOutputBasedOnInput(String outputName, String inputName) Adds an output port to the filter.
  protected void	addOutputPort(String name, FrameFormat format) Adds an output port to the filter with a fixed output format.
  protected void	addProgramPort(String name, String varName, Field field, Class varType, boolean hasDefault)
  void	close(FilterContext context)
  protected void	closeOutputPort(String name)
  protected void	delayNextProcess(int millisecs)
  void	fieldPortValueUpdated(String name, FilterContext context)
  String	getFilterClassName()
  FrameFormat	getInputFormat(String portName)
  InputPort	getInputPort(String portName)
  String	getName()
  int	getNumberOfConnectedInputs()
  int	getNumberOfConnectedOutputs()
  int	getNumberOfInputs()
  int	getNumberOfOutputs()
  FrameFormat	getOutputFormat(String portName, FrameFormat inputFormat)
  OutputPort	getOutputPort(String portName)
  int	getSleepDelay()
  void	init()
  protected void	initProgramInputs(Program program, FilterContext context) Assigns all program variables to the ports they are connected to.
  void	initWithAssignmentList(Object... keyValues)
  void	initWithAssignmentString(String assignments)
  void	initWithValueMap(KeyValueMap valueMap)
  static boolean	isAvailable(String filterName) Tests to see if a given filter is installed on the system.
  boolean	isOpen()
  void	open(FilterContext context)
  protected void	parametersUpdated(Set<String> updated)
  protected void	prepare(FilterContext context)
  abstract void	process(FilterContext context)
  protected Frame	pullInput(String name)
  protected void	pushOutput(String name, Frame frame)
  void	setInputFrame(String inputName, Frame frame)
  void	setInputValue(String inputName, Object value)
  abstract void	setupPorts()
  protected void	setWaitsOnInputPort(String portName, boolean waits) Specifies whether the filter should not be scheduled until a frame is available on that input port.
  protected void	setWaitsOnOutputPort(String portName, boolean waits) Specifies whether the filter should not be scheduled until the output port is free, i.e.
  void	tearDown(FilterContext context)
  String	toString() Returns a string containing a concise, human-readable description of this object.
  protected void	transferInputPortFrame(String name, FilterContext context) Transfers any frame from an input port to its destination.

  • Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

• Constructor Detail

  • Filter

    public Filter(String name)

• Method Detail

  • isAvailable

    public static final boolean isAvailable(String filterName)

    Tests to see if a given filter is installed on the system. Requires full filter package name, including filterpack.

  • initWithValueMap

    public final void initWithValueMap(KeyValueMap valueMap)

  • initWithAssignmentString

    public final void initWithAssignmentString(String assignments)

  • initWithAssignmentList

    public final void initWithAssignmentList(Object... keyValues)

  • init

    public final void init()
                    throws ProtocolException

    Throws:

    ProtocolException

  • getFilterClassName

    public String getFilterClassName()

  • getName

    public final String getName()

  • isOpen

    public boolean isOpen()

  • setInputFrame

    public void setInputFrame(String inputName,
                     Frame frame)

  • setInputValue

    public final void setInputValue(String inputName,
                     Object value)

  • prepare

    protected void prepare(FilterContext context)

  • parametersUpdated

    protected void parametersUpdated(Set<String> updated)

  • delayNextProcess

    protected void delayNextProcess(int millisecs)

  • setupPorts

    public abstract void setupPorts()

  • getOutputFormat

    public FrameFormat getOutputFormat(String portName,
                              FrameFormat inputFormat)

  • getInputFormat

    public final FrameFormat getInputFormat(String portName)

  • open

    public void open(FilterContext context)

  • process

    public abstract void process(FilterContext context)

  • getSleepDelay

    public final int getSleepDelay()

  • close

    public void close(FilterContext context)

  • tearDown

    public void tearDown(FilterContext context)

  • getNumberOfConnectedInputs

    public final int getNumberOfConnectedInputs()

  • getNumberOfConnectedOutputs

    public final int getNumberOfConnectedOutputs()

  • getNumberOfInputs

    public final int getNumberOfInputs()

  • getNumberOfOutputs

    public final int getNumberOfOutputs()

  • getInputPort

    public final InputPort getInputPort(String portName)

  • getOutputPort

    public final OutputPort getOutputPort(String portName)

  • pushOutput

    protected final void pushOutput(String name,
                  Frame frame)

  • pullInput

    protected final Frame pullInput(String name)

  • fieldPortValueUpdated

    public void fieldPortValueUpdated(String name,
                             FilterContext context)

  • transferInputPortFrame

    protected void transferInputPortFrame(String name,
                              FilterContext context)

    Transfers any frame from an input port to its destination. This is useful to force a transfer from a FieldPort or ProgramPort to its connected target (field or program variable).

  • initProgramInputs

    protected void initProgramInputs(Program program,
                         FilterContext context)

    Assigns all program variables to the ports they are connected to. Call this after constructing a Program instance with attached ProgramPorts.

  • addInputPort

    protected void addInputPort(String name)

    Adds an input port to the filter. You should call this from within setupPorts, if your filter has input ports. No type-checking is performed on the input. If you would like to check against a type mask, use addMaskedInputPort instead.

    Parameters:

    name - the name of the input port

  • addMaskedInputPort

    protected void addMaskedInputPort(String name,
                          FrameFormat formatMask)

    Adds an input port to the filter. You should call this from within setupPorts, if your filter has input ports. When type-checking is performed, the input format is checked against the provided format mask. An exception is thrown in case of a conflict.

    Parameters:

    name - the name of the input port

    formatMask - a format mask, which filters the allowable input types

  • addOutputPort

    protected void addOutputPort(String name,
                     FrameFormat format)

    Adds an output port to the filter with a fixed output format. You should call this from within setupPorts, if your filter has output ports. You cannot use this method, if your output format depends on the input format (e.g. in a pass-through filter). In this case, use addOutputBasedOnInput instead.

    Parameters:

    name - the name of the output port

    format - the fixed output format of this port

  • addOutputBasedOnInput

    protected void addOutputBasedOnInput(String outputName,
                             String inputName)

    Adds an output port to the filter. You should call this from within setupPorts, if your filter has output ports. Using this method indicates that the output format for this particular port, depends on the format of an input port. You MUST also override getOutputFormat to specify what format your filter will output for a given input. If the output format of your filter port does not depend on the input, use addOutputPort instead.

    Parameters:

    outputName - the name of the output port

    inputName - the name of the input port, that this output depends on

  • addFieldPort

    protected void addFieldPort(String name,
                    Field field,
                    boolean hasDefault,
                    boolean isFinal)

  • addProgramPort

    protected void addProgramPort(String name,
                      String varName,
                      Field field,
                      Class varType,
                      boolean hasDefault)

  • closeOutputPort

    protected void closeOutputPort(String name)

  • setWaitsOnInputPort

    protected void setWaitsOnInputPort(String portName,
                           boolean waits)

    Specifies whether the filter should not be scheduled until a frame is available on that input port. Note, that setting this to false, does not block a new frame from coming in (though there is no necessity to pull that frame for processing).

    Parameters:

    portName - the name of the input port.

    waits - true, if the filter should wait for a frame on this port.

  • setWaitsOnOutputPort

    protected void setWaitsOnOutputPort(String portName,
                            boolean waits)

    Specifies whether the filter should not be scheduled until the output port is free, i.e. there is no frame waiting on that output.

    Parameters:

    portName - the name of the output port.

    waits - true, if the filter should wait for the port to become free.

  • toString

    public String toString()

    Description copied from class: Object
    Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

       getClass().getName() + '@' + Integer.toHexString(hashCode())

    See Writing a useful toString method if you intend implementing your own toString method.

    Overrides:

    toString in class Object

    Returns:

    a printable representation of this object.