1audiotool(1) GNU Telephony audiotool(1)
2
6 audiotool - manipulate telephony audio files.
7
9 audiotool [options] command files...
10
12 The audiotool command is used to examine and manipulate telephony audio
13 files such as those which might be used in GNU Bayonne. It can be used
14 to convert audio to different formats or join audio files together as
15 well. Current releases of audiotool do not support resampling, and are
16 principally focused on either raw audio samples or SUN .au contained
17 audio. In the future .wav contained audio files may also be supported.
18
20 -buffer msecs
21 Specify ``size'' of user space buffering in milliseconds.
22 Buffering is used to reduce how frequently user space audio data
23 has to be pushed into kernel space file operations. Because
24 some codecs and conversions have fixed and specific frame sizes,
25 you want to choose a value that will be a good multiplier of any
26 possible codec that might be used. The default is 120 millisec‐
27 onds, which is good for the list of suggested framing values.
28 This also allows for predictive I/O scheduling.
29 -codecs
31 Lists codec channel encoding formats that are supported.
32 -encoding format
34 Specify the encoding format that audiotool will use for internal
35 operations. Files opened in different encoding formats will be
36 transcoded to this format if possible. The default is pcmu.
37 The list of supported formats is shown with the -codecs option.
38 -framing msecs
40 Specify audio framing in milliseconds. Generally you should use
41 values like 10, 15, 20, 30, 50, or 60 milliseconds. If no fram‐
42 ing is used, then the default requirements of the codec will be
43 selected, and this is often 20 milliseconds. Some commands are
44 only supported if ulaw or linear is chosen.
45 -help Outputs help screen for the user.
47 -note ``text''
49 Specify a file annotation when creating a new file.
50 -output format
52 Specify the output encoding that audiotool wil use for creating
53 a new file such as for the create command. This is useful when
54 it cannot be determined from the file extension alone, such as
55 when one wants to use a specific codec format for creating a .au
56 file.
57 -verbose
59 Display extra debugging information for some commands.
60 -version
62 Outputs package version and copyright notice.
63
65 append newfile files...
66 Append to existing audio file, converting other files in the
67 process.
68 create newfile files...
70 Create a new audio file, converting existing files in the
71 process. The encoding for the target file might be specified by
72 the file extension, or optionally through the -output option.
73 info files...
75 Output core library information and (when verbose) buffering
76 stats for each of the files listed. When used verbose, this can
77 be useful to better understand how buffering factors and framing
78 works as well.
79 pipe files...
81 Pipe the raw output of the specified files to stdout based on
82 the channel encoding format. The encoding format is by default
83 8khz ulaw, and hence the output can be directly piped to and
84 played on a oss /dev/audio or sun audio device if the format is
85 left unchanged.
86 text file
88 Output the annotation stored in a SUN .au (and later .wav) file.
89 verify file
91 Tests if audio file is readable. If used verbose, it will
92 report frames read successfully vs I/O context switches to ker‐
93 nel space.
94
96 Normally exit status is 0 if the request was successfully processed by
97 the sipwitch service daemon. An exit status of 1 indicates a file ref‐
98 erenced does not exist or cannot be accessed. A 2 indicates that the
99 encoding format of the specified file is unsupported or cannot be con‐
100 verted. An exit status of 3 indicates an I/O failure happened. Any
101 command syntax error will return a 4.
102
104 audiotool was written by David Sugar <dyfet@gnutelephony.org>.
105
107 Report bugs to sipwitch-devel@gnu.org.
108
110 Copyright © 2009 David Sugar, Tycho Softworks.
111 This is free software; see the source for copying conditions. There is
112 NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
113 PURPOSE.
114GNU ccAudio January 2010 audiotool(1)