tomwalters@0: .TH BUFWAVE 1 "1 September 1993"
tomwalters@0: 
tomwalters@0: .SH NAME
tomwalters@0: bufwave \-   a shifting waveform buffer.
tomwalters@0: 
tomwalters@0: .SH SYNTAX 
tomwalters@0: bufwave [options] [file]
tomwalters@0: 
tomwalters@0: .SH DESCRIPTION
tomwalters@0: A buffer (or window) is shifted along the input, and the
tomwalters@0: contents of the buffer are written to the stdout on each shift.
tomwalters@0: 
tomwalters@0: .SH OPTIONS
tomwalters@0: 
tomwalters@0: 1. width, frstep.
tomwalters@0: 
tomwalters@0: Input is buffered in frames of size `width' samples, and the buffer is
tomwalters@0: shifted along the input in steps of `frstep' samples.
tomwalters@0: Both `width' and `frstep' may be given with time units (s or ms), in which
tomwalters@0: case the they are converted to a number of samples using the given
tomwalters@0: `samplerate' option.
tomwalters@0: 
tomwalters@0: 2. type.
tomwalters@0: 
tomwalters@0: The `type' option sets the size of a binary sample in bytes.
tomwalters@0: Standard type names are recognised (char, short, int, float, double).
tomwalters@0: For example, type=1 is synonymous with type=char, both specifying a
tomwalters@0: binary sample of 1 byte.
tomwalters@0: 
tomwalters@0: The special case of type=ASCII sets a sample to be a line of ASCII text
tomwalters@0: (delimited by a CR), of size up to a maximum number of characters set by
tomwalters@0: the `length' option.
tomwalters@0: 
tomwalters@0: 3. frame.
tomwalters@0: 
tomwalters@0: The `frame' option selects a sequence of contiguous frames for output by:
tomwalters@0: 
tomwalters@0: .nf
tomwalters@0: 	      frame=a[-b]
tomwalters@0: .fi
tomwalters@0: 
tomwalters@0: where `a' and `b' are frame numbers: 1,2,3,...
tomwalters@0: The upper limit `b' is optional, and when it is missing then the frame
tomwalters@0: sequence is a single frame, otherwise `a' and `b' are inclusive limits.
tomwalters@0: The strings "min" and "max" are recognised as extreme limits.
tomwalters@0: 
tomwalters@0: 4. start.
tomwalters@0: 
tomwalters@0: The `start' option is an offset to the start of the first frame in samples.
tomwalters@0: If given with time units, the start is converted to samples using the
tomwalters@0: given `samplerate' option.
tomwalters@0: 
tomwalters@0: 5. reverse.
tomwalters@0: 
tomwalters@0: The `reverse' option causes each buffer to be written out in reverse order
tomwalters@0: of its samples.
tomwalters@0: 
tomwalters@0: .SH EXAMPLES
tomwalters@0: 
tomwalters@0: 1. A half-frame overlapping rectangular window of size 10ms.
tomwalters@0: 
tomwalters@0: .nf
tomwalters@0: 	bufwave width=10ms frstep=5ms file
tomwalters@0: .fi
tomwalters@0: 
tomwalters@0: 2. Reverse the contents of each frame of a given sequence of 75-sample frames.
tomwalters@0: 
tomwalters@0: .nf
tomwalters@0: 	bufwave rev=on width=75 frstep=75 file
tomwalters@0: .fi
tomwalters@0: 
tomwalters@0: .SH "SEE ALSO"
tomwalters@0: options edwave
tomwalters@0: 
tomwalters@0: .SH COPYRIGHT
tomwalters@0: .LP
tomwalters@0: Copyright (c) Applied Psychology Unit, Medical Research Council, 1995
tomwalters@0: .LP
tomwalters@0: Permission to use, copy, modify, and distribute this software without fee 
tomwalters@0: is hereby granted for research purposes, provided that this copyright 
tomwalters@0: notice appears in all copies and in all supporting documentation, and that 
tomwalters@0: the software is not redistributed for any fee (except for a nominal 
tomwalters@0: shipping charge). Anyone wanting to incorporate all or part of this 
tomwalters@0: software in a commercial product must obtain a license from the Medical 
tomwalters@0: Research Council.
tomwalters@0: .LP
tomwalters@0: The MRC makes no representations about the suitability of this 
tomwalters@0: software for any purpose.  It is provided "as is" without express or 
tomwalters@0: implied warranty.
tomwalters@0: .LP
tomwalters@0: THE MRC DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING 
tomwalters@0: ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL 
tomwalters@0: THE A.P.U. BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES 
tomwalters@0: OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, 
tomwalters@0: WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, 
tomwalters@0: ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS 
tomwalters@0: SOFTWARE.
tomwalters@0: