copysd.1

speech signal process tools

.\" @(#)copysd.1	1.8 4/8/87
.TH COPYSD 1\-ESPS 4/8/87
.ds ]W "\fI\s+4\ze\h'0.05'e\s-4\v'-0.4m'\fP\(*p\v'0.4m'\ Entropic Processing, Inc.
.SH NAME
copysd - copy selected portions of sd files to a new file.
.SH SYNOPSIS
.B copysd
[
.BI \-x " debug_level"
] [
.BI \-r " range"
] [
.BI \-d " data_type"
] [
.BI \-s " scale"
] [
.B \-o 
] [
.B \-q
] 
.I " file1"
[
.I " file2 ..."
]
.I " outfile"
.SH DESCRIPTION
.PP
.I Copysd
copies selected portions of sampled data files into a new sampled data
file.
In addition to the range of points that are copied,
.I copysd
allows the user to specify 
with the 
.B \-d
option
the data type of the new file
and with the \fB-s\fR option a scale factor to multiply the data by.
Allowable data types are bytes, shorts, longs, float, or double;  the
default data type of the output file is that of the first input file.
.PP
If an input file name is replaced by a minus sign, stdin is read; similarly,
if
.I outfile
is a minus sign, the output is written to stdout.
.PP
When converting from a floating to integer, the values are rounded.
Values that are too large to represent in the output data type are
clipped and a warning is given.
.PP
The header of the output file is created by using \fIcopy_header\fR(3\-ESPSu)
with the \fIfirst\fR input file as the source.   
.SH OPTIONS
.PP
The following options are supported:
.TP
.BI \-x " debug level"
Only debug level 1 is defined in this version; this causes several
messages to be printed.  The default level is zero, which causes no
debug output.
.TP
.BI \-r " range"
Select a range of points to be processed.  By default, all points in
the file are processed. As is usual for ESPS programs a range is
specified as follows:  two numbers separated by a colon (beginning :
end), a single number (a range consisting of one value), a number
followed by a colon (the largest possible value determines the end of
the range), or a colon followed by an number (the default is to start
the range at the smallest possible value). (See
.I range_switch(3)
for full details of range specification.)
.TP
.BI \-d " data_type"
The argument of the switch is a character representing the output data
type:
.I b
for byte,
.I s
for short,
.I l
for long,
.I f
for float, and
.I d
for double.
.TP
.B \-s
The argument is a float value by which the input samples are multiplied
before being written to the output.
.TP
.B \-o
Normally the ESPS header from the input files are
copied into the header of the new output file as source files.
If the
.B \-o
is specified, the input files' headers are not stored in the output file.
.TP
.B \-q
When data is converted to smaller data type (e.g. LONG to
SHORT) each sample is compared to the maximum value of the target data
type.  Samples that exceed this maximum are clipped.   Normally, when
clipping occurs, a warning message is printed giving the sample number
and the original value.    The \fB\-q\fR option suppresses this
warning.
.SH ESPS COMMON
.PP
The following items are read from the ESPS Common File:
.IP
.I "start - integer"
.IP
This is the starting point in the input file to begin copying.
.sp
.I "nan - integer"
.IP
This is the number of points to copy from the input file.
A value of zero means the last point in the file.
.sp
.I "filename - string"
.IP
This is the name of the input file, if an input file is not specified on
the command line.
.PP
The values of \fIstart\fR and \fInan\fR are only used if the input filename on
the command line is the same as the filename in the common file, or
if the filename was used from the common file.
If \fIstart\fR and/or \fInan\fR are not given in the common file, or
if the common file can't be opened for reading, then \fIstart\fR
defaults to the beginning of the file and \fInan\fR defaults to the
number of points in the file.
.PP
The following items are written into the ESPS Common file:
.IP
.I "start - integer"
.IP
The starting point from the input file.
.sp
.I "nan - integer"
.IP
The number of points in the selected range.
.sp
.I "prog - string"
.IP
This is the name of the program (\fIcopysd\fP in this case).
.sp
.I "filename - string"
.IP
The name of the input file.  If multiple input files are processed, this
is the name of the first file.   
.PP
These items are not written to ESPS COMMON if the input file is <stdin>.
.SH BUGS
Cannot write a sampled data file of type byte (char in C terms).
This is because of a limitation of \fIput_ddata\fR.  It will be changed
in a later release.
.SH AUTHOR
.PP
David Burton, Alan Parker