/usr/share/doc/tcl-snack-doc/html/CreateFilter.html is in tcl-snack-doc 2.2.10.20090623-dfsg-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 | <!doctype html public "-//w3c//dtd html 4.0 transitional//en">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta name="GENERATOR" content="Mozilla/4.72 [en] (X11; U; Linux 2.2.14-5.0 i686) [Netscape]">
<meta name="Author" content="Kåre Sjölander">
<title>CreateFilter</title>
</head>
<body>
<h3>
NAME</h3>
Snack_CreateFilterType - define new filter type
<h3>
SYNOPSIS</h3>
#include <snack.h>
<br><b>Snack_CreateFilterType</b>(filterType)
<h3>
ARGUMENTS</h3>
Snack_FilterType *filterType
<p>struct Snack_FilterType {
<br> char
*name;
<br> createProc *createProc;
<br> configProc *configProc;
<br> startProc *startProc;
<br> flowProc *flowProc;
<br> freeProc *freeProc;
<br> struct Snack_FilterType *nextPtr;
<br>} Snack_FilterType;
<p>char *<b>name</b>
<p>Snack_Filter <b>createProc</b> (Tcl_Interp *interp, int objc, Tcl_Obj
*CONST objv[])
<p>int <b>configProc </b>(Snack_Filter f, Tcl_Interp *interp, int objc,
Tcl_Obj *CONST objv[])
<p>int <b>startProc </b>(Snack_Filter f, Snack_StreamInfo si)
<p>int <b>flowProc </b>(Snack_Filter f, Snack_StreamInfo si, float *inBuffer,
float *outBuffer, int *inFrames, int *outFrames)
<p>void <b>freeProc </b>(Snack_Filter f)
<h3>
DESCRIPTION</h3>
<b>Snack_CreateFilterType</b> is used to define a new kind of filter type.
Everything regarding filters is still under development. The source code
itself is currently the only source of information.
<p>Some helpful notes on the current implementation:
<p>inFrames specifies how many samples exist in inBuffer. This value can
be modified to specify how many samples were actually consumed.
<p>outFrames is an upper bound on how many samples that may be written
to outBuffer.
<p><b>flowProc</b> should start to drain out any samples as soon as inFrames
< outFrames.
<p>If the return value of outFrames is less than the original, the procedure
will not be called again. Internal clean-up can be performed in this case.
<p>The parameters inBuffer and outBuffer may point to the same memory.
In some cases it might be neccessary to make local copies of samples during
calculations.<b></b>
<p><b>configProc</b> can be called at any time.
<p>inBuffer can be NULL if inSize is 0.
<br>
</body>
</html>
|