usr/src/man/man1/audiorecord.1

   1 '\" te
   2 .\"  Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4 .\"  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the
   5 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH AUDIORECORD 1 "April 9, 2016"
   7 .SH NAME
   8 audiorecord \- record an audio file
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBaudiorecord\fR [\fB-af\fR] [\fB-v\fR \fIvol\fR] [\fB-c\fR \fIchannels\fR] [\fI-s\fR \fIrate\fR]
  13      [\fB-e\fR \fIencoding\fR] [\fB-t\fR \fItime\fR] [\fB-i\fR \fIinfo\fR] [\fB-d\fR \fIdev\fR]
  14      [\fB-T\fR \fBau\fR | \fBaif\fR[\fBf\fR] | \fBwav\fR] [\fIfile\fR[.\fBau\fR|.\fBaif\fR[\fBf\fR]]|.\fBwav\fR]
  15 .fi
  16
  17 .SH DESCRIPTION
  18 .LP
  19 The \fBaudiorecord\fR utility copies audio data from the audio device to a
  20 named audio file, or to the standard output if no filename is present. If no
  21 output file is specified and standard output is a tty, the program exits with
  22 an error message.
  23 .sp
  24 .LP
  25 By default, monaural audio data is recorded at 8 kHz and encoded in \fB-law\fR
  26 format. If the audio device supports additional configurations, the \fB-c\fR,
  27 \fB-s\fR, and \fB-e\fR options may be used to specify the data format. The
  28 output file is prefixed by an audio file header that identifies the format of
  29 the data encoded in the file.
  30 .sp
  31 .LP
  32 Recording begins immediately and continues until a \fBSIGINT\fR signal (for
  33 example, Control-c) is received. If the \fB-t\fR option is specified,
  34 \fBaudiorecord\fR stops when the specified quantity of data has been recorded.
  35 .sp
  36 .LP
  37 If the audio device is unavailable, that is, if another process currently has
  38 read access, \fBaudiorecord\fR prints an error message and exits immediately.
  39 .SH OPTIONS
  40 .LP
  41 The following options are supported:
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fB-\e?\fR\fR
  46 .ad
  47 .RS 24n
  48 \fIHelp\fR: Prints a command line usage message.
  49 .RE
  50
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fB-a\fR\fR
  55 .ad
  56 .RS 24n
  57 \fIAppend\fR: Appends the data on the end of the named audio file. The audio
  58 device must support the audio data format of the existing file.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fB-c\fR \fIchannels\fR\fR
  65 .ad
  66 .RS 24n
  67 \fIChannels\fR: Specifies the number of audio channels (1 or 2). The value may
  68 be specified as an integer or as the string \fBmono\fR or \fBstereo\fR. The
  69 default value is \fBmono\fR.
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fB-d\fR \fIdev\fR\fR
  76 .ad
  77 .RS 24n
  78 \fIDevice\fR: The \fIdev\fR argument specifies an alternate audio device from
  79 which input should be taken. If the \fB-d\fR option is not specified, the
  80 \fBAUDIODEV\fR environment variable is consulted (see below). Otherwise,
  81 \fB/dev/audio\fR is used as the default audio device.
  82 .RE
  83
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fB-e\fR \fIencoding\fR\fR
  88 .ad
  89 .RS 24n
  90 \fIEncoding\fR: Specifies the audio data encoding. This value may be one of
  91 \fBulaw\fR, \fBalaw\fR, or \fBlinear\fR. The default encoding is \fBulaw\fR.
  92 .RE
  93
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fB-f\fR\fR
  98 .ad
  99 .RS 24n
 100 \fIForce\fR: When the \fB-a\fR flag is specified, the sample rate of the audio
 101 device must match the sample rate at which the original file was recorded. If
 102 the \fB-f\fR flag is also specified, sample rate differences are ignored, with
 103 a warning message printed on the standard error.
 104 .RE
 105
 106 .sp
 107 .ne 2
 108 .na
 109 \fB\fB-i\fR \fIinfo\fR\fR
 110 .ad
 111 .RS 24n
 112 \fIInformation\fR: The `information' field of the output file header is set to
 113 the string specified by the \fIinfo\fR argument. This option cannot be
 114 specified in conjunction with the \fB-a\fR argument.
 115 .RE
 116
 117 .sp
 118 .ne 2
 119 .na
 120 \fB\fB-s\fR \fIrate\fR\fR
 121 .ad
 122 .RS 24n
 123 \fISample Rate\fR: Specifies the sample rate, in samples per second. If a
 124 number is followed by the letter \fBk\fR, it is multiplied by 1000 (for
 125 example, 44.1k = 44100). The default sample rate is 8 kHz.
 126 .RE
 127
 128 .sp
 129 .ne 2
 130 .na
 131 \fB\fB-t\fR \fItime\fR\fR
 132 .ad
 133 .RS 24n
 134 \fITime\fR: The \fItime\fR argument specifies the maximum length of time to
 135 record. Time can be specified as a floating-point value, indicating the number
 136 of seconds, or in the form: \fIhh:mm:ss.dd\fR, where the hour and minute
 137 specifications are optional.
 138 .RE
 139
 140 .sp
 141 .ne 2
 142 .na
 143 \fB\fB-T\fR \fBau\fR | \fBaif\fR[\fBf\fR] | \fBwav\fR\fR
 144 .ad
 145 .RS 24n
 146 Specifies the audio file type to create. If the \fB-a\fR option is used, the
 147 file type must match the file to which it is being appended. Regardless of the
 148 file suffix, the type is set as specified in this option. If this option is not
 149 specified, the file suffix determines the type.
 150 .RE
 151
 152 .sp
 153 .ne 2
 154 .na
 155 \fB\fB-v\fR \fIvol\fR\fR
 156 .ad
 157 .RS 24n
 158 \fIVolume\fR: The recording gain is set to the specified value before recording
 159 begins, and is reset to its previous level when \fBaudiorecord\fR exits. The
 160 \fIvol\fR argument is an integer value between 0 and 100, inclusive. If this
 161 argument is not specified, the input volume remains at the level most recently
 162 set by any process.
 163 .RE
 164
 165 .SH OPERANDS
 166 .ne 2
 167 .na
 168 \fB\fIfile\fR[\fB\&.au\fR|\fB\&.aif\fR[\fBf\fR]]|\fB\&.wav\fR\fR
 169 .ad
 170 .sp .6
 171 .RS 4n
 172 \fIFile Specification\fR: The named audio file is rewritten, or appended. If no
 173 filename is present, and standard output is not a tty, or if the special
 174 filename "\fB\(mi\fR" is specified, output is directed to the standard
 175 output.
 176 .sp
 177 If the \fB-T\fR option is not specified, the file suffix determines the type of
 178 file. If the suffix is not recognized, the default is \fB\&.au\fR. If the
 179 \fB-T\fR option \fBis\fR specified, that file type is used regardless of the
 180 file suffix.
 181 .RE
 182
 183 .SH USAGE
 184 .LP
 185 See \fBlargefile\fR(5) for the description of the behavior of \fBaudiorecord\fR
 186 when encountering files greater than or equal to 2 Gbyte ( 2^31 bytes).
 187 .SH ENVIRONMENT VARIABLES
 188 .ne 2
 189 .na
 190 \fB\fBAUDIODEV\fR\fR
 191 .ad
 192 .RS 12n
 193 The full path name of the audio device to record from, if no \fB-d\fR argument
 194 is supplied. If the \fBAUDIODEV\fR variable is not set, \fB/dev/audio\fR is
 195 used.
 196 .RE
 197
 198 .SH ATTRIBUTES
 199 .LP
 200 See \fBattributes\fR(5) for descriptions of the following attributes:
 201 .sp
 202
 203 .sp
 204 .TS
 205 box;
 206 c | c
 207 l | l .
 208 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 209 _
 210 Architecture    SPARC, x86
 211 _
 212 Interface Stability     Committed
 213 .TE
 214
 215 .SH SEE ALSO
 216 .LP
 217 \fBaudioconvert\fR(1), \fBaudioplay\fR(1), \fBmixerctl\fR(1),
 218 \fBattributes\fR(5), \fBlargefile\fR(5), \fBaudio\fR(7I)