Mercurial > hg > aim92

annotate man/man1/bufwave.1 @ 0:5242703e91d3 tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial checkin for AIM92 aimR8.2 (last updated May 1997).
author tomwalters
date Fri, 20 May 2011 15:19:45 +0100
parents
children
rev   line source
tomwalters@0 1 .TH BUFWAVE 1 "1 September 1993"
tomwalters@0 2
tomwalters@0 3 .SH NAME
tomwalters@0 4 bufwave \- a shifting waveform buffer.
tomwalters@0 5
tomwalters@0 6 .SH SYNTAX
tomwalters@0 7 bufwave [options] [file]
tomwalters@0 8
tomwalters@0 9 .SH DESCRIPTION
tomwalters@0 10 A buffer (or window) is shifted along the input, and the
tomwalters@0 11 contents of the buffer are written to the stdout on each shift.
tomwalters@0 12
tomwalters@0 13 .SH OPTIONS
tomwalters@0 14
tomwalters@0 15 1. width, frstep.
tomwalters@0 16
tomwalters@0 17 Input is buffered in frames of size `width' samples, and the buffer is
tomwalters@0 18 shifted along the input in steps of `frstep' samples.
tomwalters@0 19 Both `width' and `frstep' may be given with time units (s or ms), in which
tomwalters@0 20 case the they are converted to a number of samples using the given
tomwalters@0 21 `samplerate' option.
tomwalters@0 22
tomwalters@0 23 2. type.
tomwalters@0 24
tomwalters@0 25 The `type' option sets the size of a binary sample in bytes.
tomwalters@0 26 Standard type names are recognised (char, short, int, float, double).
tomwalters@0 27 For example, type=1 is synonymous with type=char, both specifying a
tomwalters@0 28 binary sample of 1 byte.
tomwalters@0 29
tomwalters@0 30 The special case of type=ASCII sets a sample to be a line of ASCII text
tomwalters@0 31 (delimited by a CR), of size up to a maximum number of characters set by
tomwalters@0 32 the `length' option.
tomwalters@0 33
tomwalters@0 34 3. frame.
tomwalters@0 35
tomwalters@0 36 The `frame' option selects a sequence of contiguous frames for output by:
tomwalters@0 37
tomwalters@0 38 .nf
tomwalters@0 39 frame=a[-b]
tomwalters@0 40 .fi
tomwalters@0 41
tomwalters@0 42 where `a' and `b' are frame numbers: 1,2,3,...
tomwalters@0 43 The upper limit `b' is optional, and when it is missing then the frame
tomwalters@0 44 sequence is a single frame, otherwise `a' and `b' are inclusive limits.
tomwalters@0 45 The strings "min" and "max" are recognised as extreme limits.
tomwalters@0 46
tomwalters@0 47 4. start.
tomwalters@0 48
tomwalters@0 49 The `start' option is an offset to the start of the first frame in samples.
tomwalters@0 50 If given with time units, the start is converted to samples using the
tomwalters@0 51 given `samplerate' option.
tomwalters@0 52
tomwalters@0 53 5. reverse.
tomwalters@0 54
tomwalters@0 55 The `reverse' option causes each buffer to be written out in reverse order
tomwalters@0 56 of its samples.
tomwalters@0 57
tomwalters@0 58 .SH EXAMPLES
tomwalters@0 59
tomwalters@0 60 1. A half-frame overlapping rectangular window of size 10ms.
tomwalters@0 61
tomwalters@0 62 .nf
tomwalters@0 63 bufwave width=10ms frstep=5ms file
tomwalters@0 64 .fi
tomwalters@0 65
tomwalters@0 66 2. Reverse the contents of each frame of a given sequence of 75-sample frames.
tomwalters@0 67
tomwalters@0 68 .nf
tomwalters@0 69 bufwave rev=on width=75 frstep=75 file
tomwalters@0 70 .fi
tomwalters@0 71
tomwalters@0 72 .SH "SEE ALSO"
tomwalters@0 73 options edwave
tomwalters@0 74
tomwalters@0 75 .SH COPYRIGHT
tomwalters@0 76 .LP
tomwalters@0 77 Copyright (c) Applied Psychology Unit, Medical Research Council, 1995
tomwalters@0 78 .LP
tomwalters@0 79 Permission to use, copy, modify, and distribute this software without fee
tomwalters@0 80 is hereby granted for research purposes, provided that this copyright
tomwalters@0 81 notice appears in all copies and in all supporting documentation, and that
tomwalters@0 82 the software is not redistributed for any fee (except for a nominal
tomwalters@0 83 shipping charge). Anyone wanting to incorporate all or part of this
tomwalters@0 84 software in a commercial product must obtain a license from the Medical
tomwalters@0 85 Research Council.
tomwalters@0 86 .LP
tomwalters@0 87 The MRC makes no representations about the suitability of this
tomwalters@0 88 software for any purpose. It is provided "as is" without express or
tomwalters@0 89 implied warranty.
tomwalters@0 90 .LP
tomwalters@0 91 THE MRC DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
tomwalters@0 92 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
tomwalters@0 93 THE A.P.U. BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES
tomwalters@0 94 OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
tomwalters@0 95 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
tomwalters@0 96 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
tomwalters@0 97 SOFTWARE.
tomwalters@0 98