File: somaplayer.1

package info (click to toggle)
somaplayer 0.5.2-2.1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 5,668 kB
  • ctags: 2,521
  • sloc: ansic: 32,358; sh: 9,393; makefile: 858; yacc: 316; sed: 16
file content (375 lines) | stat: -rw-r--r-- 9,333 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
.\" Process this file with
.\" groff -man -Tascii foo.1
.\"
.TH SOMAPLAYER 1 "OCTOBER 2004" Linux "User Command"
.SH NAME
somaplayer \- the default player for soma
.SH SYNOPSIS
.B somaplayer [-ao
.I output
.B [-ad
.I option
.B ]] [-no] [-cd] [-dsp] [-z] [-r] [-g] [-nr] [-nb] [-tf] [-so] [-b
.I buffersize
.B ] [-nv] [-v
.I volume
.B ] [-m] [-a
.I option
.b ] [-s] [-d]
.I file stream directory ...
.SH DESCRIPTION
somaplayer is music player for MP3, Ogg, wav, audio CDs, MP3 streams, and Ogg streams. It is able to use the appropriate sound drivers or demons or to stream directly to an Icecast server (Icecast2 or SHOUTcast) or to encode in MP3 and Ogg Vorbis. It also acts as a sound daemon that is able to accept connections from other somaplayers or any other sound player (xmms, mpg123, and others) thanks to a special wrapper.
.SH OPTIONS
.IP "-ao, --audiooutput" 
Add an audio output.  You can select one of the following:
audio oss alsa alsa09 esd sun arts stdout null wav aiff au raw paf svx nist
voc ircam w64 mat4 mat5 pvf xi htk icecast icecast2 shoutcast lame vorbis sds
.IP "-ad, --audiodevice"
The options for your audio output.
.IP "-no, --nooutput"
no audio output.
.IP "-cd, --cdromdevice"
Set your cdrom device.
.IP "-dsp, --devicedsp"
Set your dsp device.
.IP "-z, --random"
Somaplayer will randomly play the selected files and streams.
.IP "-r, --repeat"
Somaplayer will repeatedly played the selected files and streams.  A file or 
stream will not be played again until all files and streams are played first. 
.IP "-b, --buffer"
Somaplayer buffers the file or stream into memory.  Somaplayer accepts bBkKmM.
You can use any of these in combination.  For example to have play buffer 3
Meg and 12 Kilobytes in memory you would us 3m12k.
.IP "-nb, --nobuffer"
Somaplayer decodes directly the file (or the stream) without a internal buffer.
.IP "-tf, --timeforced"
Set the output time as the real time of the input
.IP "-nr, --norealtime"
No check for output realtime.
.IP "-so, --splitoutput"
stop and start the single outputs when change the song.
.IP "-blt, --badlist_timer"
how many seconds between one retry and the next one. [greater then 0] default 5.
.IP "-blmr, --badlist_max_retry"
how many retry for output problems. [-1 always | 0 disactivated] default 5.
.IP "-nv, --noverbose"
No verbose output.
.IP "-g, --graphic"
active the gtk interface
.IP "-v, --volume"
Somaplayer can change it is playing at from 0 to 100%.  Somaplayer accepts an
integer from 0 to 100.
.IP "-m,--mic"
Get data from microphone or line-in. You can set some flags. Read after.
.IP "-s,--sds"
Get data from a SdS [type://server[:port]]. The types are: unix socket or tcp
socket. If your write tcp is like tcp://localhost, if unix, somaplayer searchs
the sds and uses it.
.IP "-d,--daemon"
Somaplayer runs as SdS. Read after.
.IP "-a,--admin"
Active the admin interface with unix/tcp socket. Read after.
.IP "-h, --help"
Output a short summary of available command line options.
.SH Keyboard Control
These are the controls for while somaplayer is running in text mode.
.nf
V       increase volume 1%
v       decrease volume 1%
m       volume 0%
M       volume 100%
b       balance 1% to the left
B       balance 1% to the right
c/C     balance center
l       all on the left
L       all on the right
s/S     save the configuration
r/R     repeatedly play selected files and streams 
z/Z     randomly play selected files and streams
q       quit
space   pause
enter   next song
t       active silence trimming
T       disactive silence trimming
I       active the microphone input
i       disactive the microphone input
A       active realtime ouput
a       disactive realtime ouput
.SH OUTPUTS
.PP
The default audio is "audio". So you can run: 'somaplayer file.mp3'
.PP
Test your audio device with somaplayer_configure. This software set the 
default audio output in somaplayer configure file.
.PP
You can set more one outputs in the same time. For example: 'somaplayer -ao wav -ad test.wav -ao audio -ao aiff -ad test.aiff input.mp3 input.ogg'
.PP
The outputs that write a file, make file with this name: file1.mp3 file2.mp3 
file3.mp3 and so on...
.TP
.B "audio"
no options
.TP 
.B "oss/alsa/alsa09/esd/arts/sun/irix"
dsp device/audio server (optional) Ex: somaplayer -ao oss -ad /dev/dsp ...
.TP 
.B "null/output"
no options
.TP
.B "wav/aiff/au/raw/paf/svx/nist/voc/ircam/w64/mat4/mat5/pvf/xi/htk"
the output file. Ex: somaplayer -ao aiff -ad test.aiff ...
.TP
.B icecast
The options are:
.RS
.TP
.B rate
output rate - default 22050
.TP
.B bitrate
set the output bitrate - default 24
.TP
.B channels
set the output channels (1 or 2) default: 1
.TP
.B server
icecast server. You can do: 'server=http://server.net:8000/yourradio' and no set port and mount point. The server can be ipv6 or https.
.TP
.B password
server password
.TP
.B  mount
your radio mount point
.TP
.B name
the name of your radio
.TP
.B port
server port
.TP
.B port
your radio is public ? 'false' or 'true' default: true
.TP
.B description
radio description
.TP
.B dumpfilelocal
if you want a copy of your stream, set the output file
.TP
.B dumpfileremote
dump remote file on the server
.TP
.B genre
your genre
.TP
.B highpass
high pass - default: 0
.TP
.B lowpass
low pass - default: 0
.TP
.B quality
encode quality - default: 8
.TP
.B url
web site of your radio

.PP
Example:
.PP
somaplayer -ao icecast -ad 'server=http://server.net:8000/yourradio,genre=rock,url=www.myradio.net -m
.PP
You can write everything in a file like this:
.PP
.nf
	description = "my radio!"
	rate = 44100
	quality = 8
	server = server.net
	port = 8000
        url = "http://your.website.info"
	...
.fi
.PP
and run somaplayer like it:
.PP
somaplayer -ao icecast -ad yourfile -m
.RE
.TP

.B icecast2
the same options of icecast:
.RS
.TP
.B "no dumpfileremote"
.TP
.B type
m/o or M/O (Mp3 or OGG) - default: o
.RE
.TP

.B shoutcast
the same options of icecast: 
.RS
.TP
.B "no dumpfileremote and no description"
.TP
.B aim
your aim info
.TP
.B irc
your irc info
.TP
.B icq
your icq info
.RE
.TP

.B lame
encode a mp3 file
.PP
.RS
.B file
output file 
.TP
.B rate
output rate - default: 44100
.TP
.B quality
output quality - default: 8
.TP
.B bitrate
output bitrate - default: 96
.TP
.B channels
output bitrate - default: 2
.TP
.B lowpass
output lowpass - default: 0
.TP
.B highpass
output highpass - default: 0
.PP
Example:
.PP
somaplayer -ao lame -ad file=/tmp/test.mp3,rate=22050,channels=1 -m
.PP
You can write everything in a file like this:
.PP
.nf
	rate = 44100
	quality = 8
	file = /tmp/test.mp3
	...
.fi
.PP
and run somaplayer like it:
.PP
somaplayer -ao lame -ad yourfile -m.PP
.RE
.TP

.B ogg
encode a ogg file like lame
.TP

.B sds
the options are:
.PP
.RS
.B listen
number of client in the same time
.TP
.B interface
if you want bind the connection on special interface [default: 0.0.0.0]
.TP
.B ipv6
open a connection on ipv6
.TP
.B port
if you don't want the standard port [default: 12321]
.TP
.B type
unix or tcp socket.
.PP

.SH SDS
When somaplayer run with '-d' or '--daemon' flags, it starts as daemon sound.
The outputs sintax is the same, but changes the functions. A daemon sound gets
some audio inputs and does some outputs (like somaplayer). So you can connect
X somaplayers to an SdS and it mixs the inputs.
You can set some values to the daemon:
.PP
somaplayer -d type=u,socket=/tmp/test
.PP
The values are:
.PP
.B type
U/T or u/t for unix or tcp socket
.TP
.B listen
if you want accept a different number of connection in the same time (default: 100)
.TP
.B interface
if you want bind the socket on a interface (only for tcp socket)
.TP
.B port
if you want open a no standard port (default: 12321 - only for tcp socket)
.TP
.B socket
if you want bind the unix socket to a no standard file (default: /tmp/somaplayer-PID.sock - only for unix socket)
.TP
.B ipv6
IPv6 support
.PP
In graphic interface you can active crossfade of volumes, balance, autofader,
solo, mute and so on.
.PP
.SH ADMIN INTERFACE
With -a or --admin you can active the admin interface with unix/tcp 
socket. The parameter are:
.PP
.B type
U/T or u/t for unix or tcp socket
.TP
.B listen
if you want accept a different number of connection in the same time (default: 5)
.TP
.B interface
if you want bind the socket on a interface (only for tcp socket)
.TP
.B port
if you want open a no standard port (default: 12421 - only for tcp socket)
.TP
.B socket
if you want bind the unix socket to a no standard file (default: /tmp/somaplayer-PID.sock - only for unix socket)
.PP
.SH "SEE ALSO"
.BR somaplayer_controller (1),
.BR sdsvumeter (1),
.BR somad (1),
.BR somaclient (1),
.BR somacheck (1)

.SH AUTHOR
.nf
Somaplayer written by Andrea Marchesini <bakunin@autistici.org>
Man page written by Joshua Eichen <joshua@bitmine.net.net>
                 and Andrea Marchesini <bakunin@autistici.org>

.SH OBTAINING
You can download the newest version to 
.B http://soma.realityhacking.org

.SH MAILING LIST
There is a soma suite mailing list, to subscribe simply send a e-mail to: 
.B soma@inventati.org 
with only the words "subscribe soma" in the body. You will recive another mail 
to confirm this and once you have replied you can post to the list by 
sending e-mail to 
.B soma@inventati.org. 
This is helpful place for bug reports.

.SH COPYRIGHT
Copyright (c) 2003, 2004 Andrea Marchesini