doc/filter.html (9f831d9) - Blinker · BlinkenArea

filter.html

<html>
  <head>
    <title>Blinker - Filter</title>
  </head>
  <body>
    <h1>Blinker - Filter</h1>
    <p>
      The filter module filters the frames of the input stream based on their
      format.
      It passes all frames matching the filter criteria unmodified.
      Frames not matching the filter criteria are translated to no frame
      at the output.
    </p>
    <p>
      There are different filter criteria that can be active or not. If a
      criteria file is not present, it does not affect the filtering. A frame
      is only forwarded if it passes all criteria. If no criteria are specified
      all frames are passed.
    </p>
    <h2>Configuration</h2>
    <p>
      The configuration of the filter module with name <code>NAME</code>
      is located in the <code>filters/NAME</code> subdirectory.
    </p>
    <h3>Input Stream</h3>
    <p>
      The file <code>instream</code> contains the name of the stream to
      receive.
      The frames received from this stream are filtered and passed to the
      output stream.
    </p>
    <h3>Format</h3>
    <p>
      The file <code>format</code> describes the required format of the
      stream, i.e. its dimensions, the number of channels and the color depth
      on each channel.
      If present, the file must contain a string
      <code>&lt;width&gt;x&lt;height&gt;-&lt;channels&gt;/&lt;colors&gt;</code>,
      e.g. <code>18x8-1/256</code> for 18 pixels width, 8 pixels height
      in 256 grayscales.
    </p>
    <h3>Size</h3>
    <p>
      The file <code>size</code> describes the required size of the
      stream, i.e. its dimensions.
      If present, the file must contain a string
      <code>&lt;width&gt;x&lt;height&gt;</code>,
      e.g. <code>18x8</code> for 18 pixels width, 8 pixels height.
    </p>
    <h3>Minimum and Maximum Files</h3>
    <p>
      The files <code>width_min</code>, <code>width_max</code>,
                <code>height_min</code>, <code>height_min</code>,
                <code>channels_min</code>, <code>channels_max</code>,
                <code>colors_min</code>, <code>colors_max</code>
      can be used to limit the minimum and maximum values of the movie
      format parameters (namely width, height, number of channels and
      number of colors per channel). If present, the file has to contain
      a single unsigned integer number. The limit will be enforced in this
      case. Otherwise, there is no restriction regarding the respective
      parameter.
    </p>
    <h3>Output Stream</h3>
    <p>
      The file <code>outstream</code> contains the name of the stream to
      send the filtered frames to.
    </p>
  </body>
</html>

Blinker

implement filter module