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

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