forked from deepfire/xmms
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME
1264 lines (933 loc) · 40.2 KB
/
README
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
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
XMMS - X Multimedia System (C) 1997-2004
A Cross platform Multimedia Player
Peter Alm, Thomas Nilsson, Olle Hallnas, Håvard Kvålen
TABLE OF CONTENTS
*****************
1. Disclaimer
2. Installation
2.1 Basic Installation
2.2 Border less Installation
2.3 Skin Installation
3. Documentation
3.1 Controlling XMMS
3.1.1 Key bindings
3.2 Playlist Editor
3.3 Equalizer
3.4 Menu
3.5 Preferences
3.5.1 Audio I/O Plugins
3.5.2 Effect Plugins
3.5.3 General Plugins
3.5.4 Visualization Plugins
3.5.5 Options
3.5.6 Fonts
3.5.7 Title
3.6 Plugins
3.6.1 Input plugins
3.6.1.1 Cd Audio Player
3.6.1.2 Mikmod player
3.6.1.3 MPEG Layer 1/2/3 player
3.6.1.4 Tone Generator
3.6.1.5 Ogg Vorbis player
3.6.1.6 Wave player
3.6.2 Output plugins
3.6.2.1 OSS Driver
3.6.2.2 Disk Writer
3.6.2.3 eSound Output
3.6.2.4 BSD Sun Output
3.6.2.5 ALSA Output
3.6.3 Effect plugins
3.6.3.1 Echo
3.6.3.2 Extra Stereo
3.6.3.3 Voice removal
3.6.4 General plugins
3.6.4.1 IRman Control
3.6.4.2 Joystick Control
3.6.4.3 Song Change
3.6.5 Visualization plugins
3.6.5.1 Blur scope
3.6.5.2 OpenGL Spectrum analyzer
3.6.5.3 Simple Spectrum analyzer
4. Command Line Options
5. Features
5.1 Supported File formats
5.2 Supported Features
6. Obtaining XMMS
7. Misc
7.1 Shoutcast support
7.2 Tips and tricks
8. Bugs
9. Contact Email
1. Disclaimer
-------------
We are not liable for any damage caused by the use of this program.
XMMS is NOT a port of windows95's WinAmp. We just borrowed the GUI! :)
2. Installation
---------------
These libraries are needed to compile XMMS.
gtk/glib 1.2.2 or better.
ftp://ftp.gtk.org/pub/gtk/v1.2/
For libc5 users, you also need to obtain,
gnu gettext 0.10 (use configure --with-gnu-gettext)
ftp://prep.ai.mit.edu/pub/gnu/gettext/gettext-0.10.tar.gz
linuxthreads 0.71
http://www.xmms.org/files/libc5/linuxthreads.tar.gz
Thread safe Xlibs (at least aware)
http://www.xmms.org/files/libc5/XFree86-3.3-libs.tar.gz (thread aware)
If you want XMMS to play mod/s3m/med and formats supported by mikmod
you need to install libmikmod before running ./configure on XMMS.
http://www.ibiblio.org/pub/linux/apps/sound/libs/
For the OpenGL plugin you'll need Mesa 3.0 or better.
http://www.mesa3d.org/
To compile the Ogg Vorbis plugin you'll need libvorbis from:
http://www.vorbis.com/download_unix.psp
2.1 Basic Installation
----------------------
cd xmms-1.2.8
./configure
make
make install
This will put the binary in /usr/local/bin and plugins in
/usr/local/lib/xmms/
2.2 Borderless Installation
---------------------------
As far as I know most WM's accepts GTK decoration hints so it will
not have borders. But some WM's can't handle this so you have to
set in manually.
AfterStep 1.0 ~/.steprc
Style "XMMS_Player" NoTitle, NoHandles
Style "XMMS_Playlist" NoTitle, NoHandles
Style "XMMS_Equalizer" NoTitle, NoHandles
AfterStep 1.4 ~/GNUstep/Library/AfterStep/database
Style "XMMS_Player" NoTitle, NoHandles
Style "XMMS_Playlist" NoTitle, NoHandles
Style "XMMS_Equalizer" NoTitle, NoHandles
Fvwm's ~/.fvwm95rc
Style "XMMS_Player" NoTitle
Style "XMMS_Playlist" NoTitle
Style "XMMS_Equalizer" NoTitle
CTWM's ~/.ctwmrc
NoTitle and NoBorder sections:
NoTitle {
"xmms"
}
NoBorder {
"xmms"
}
2.3 Skin Installation
---------------------
XMMS will create a drawer called ~/.xmms/Skins/ in which you just unarchive the
skins the same way as you do for WinAmp.
However, you don't need to unarchive them since XMMS supports archived skins.
XMMS currently reads the following formats: zip, wsz, tar, tar.gz and tar.bz2
Just copy the archive to one of the skin path's and XMMS will take care of the
rest.
In order to support zipped skins you will need to download unzip.
ftp://sunsite.unc.edu/pub/Linux/utils/compress/unzip-5.31.tar.gz
If you do not wish to have unzip in your path, then set the variable UNZIPCMD
to the directory in which you keep the unzip command.
Use ALT+S when using XMMS to bring up the skin selector. XMMS will remember
which skin you had loaded when you start XMMS the next time. (saved in
~/.xmms/config) in the skin selector you have an option to use random skin on
play, this will pick a random skin on song change.
XMMS looks for skins in these directories:
<prefix>/share/xmms/Skins
~/.xmms/Skins
or you can set the variable SKINSDIR to another location of your choice.
for bash:
export SKINSDIR=/path/to/Skins:/more/paths/to/other/locations/of/Skins
for csh:
setenv SKINSDIR /path/to/Skins:/more/paths/to/other/locations/of/Skins
3. Documentation
----------------
This file or http://www.xmms.org/docs/readme.php
3.1 Controlling XMMS
--------------------
When you start up XMMS, you will get a console very similar to that of
WinAmp.
- On the top is the window title bar. To the right you will see 3 buttons,
Left button will minimize XMMS.
Middle button will make XMMS only display the title bar.
Right button will end the XMMS session.
- The area in the upper left part displays the following:
- Play state: Paused, Stopped, or Playing
- Time elapsed in the current song or if you click on it, the reversed.
- Spectrum analyzer of the sound being played. Right mouse click will
bring up the Visualization menu. Left mouse button will change the
analyzer to an oscilloscope and/or none.
- To the right of the Spectrum analyzer is the title of the file being played.
This also contains the length of the song being played, as well as its
position in the [unsorted] playlist. Right clicking in this window will bring
up a new menu with some more options that are self explaining.
- In the left part of the Spectrum analyzer you'll have letters (at least if
you use the default skin) O A I D V left mouse clicking on these will open
up menus or perform actions.
O : Options menu
A : Always on top
I : File info box
D : Double size mode
V : Visualization menu
- Underneath the track title are the following static informational data:
- bit rate in KBps (usually 128 or 112)
- Sample Rate in KHz (usually 44)
- Stereo or Mono channel mixing
- Underneath the informational data are a few controls you can play with:
- The first slider controls the volume
- The second slider controls the balance between speakers
- The button marked "EQ" loads up the graphic equalizer
- The button marked "PL" loads up the playlist editor
- The LARGE slide bar moves from left to right as the song plays. You can
drag this to jump to another location in the current file.
- On the bottom of the console are the standard buttons you would see on a CD
player: Previous track, Play, Pause, Stop, Next track, eject, shuffle
and repeat.
- The eject button doesn't REALLY eject, of course. :) It opens up the
file requester. The File Requester builds a playlist for the current
XMMS session. You can use it to load files, add files to the list, or
load all mp3s in a directory.
- The shuffle button randomizes the sequence of the playlist.
- The repeat button when enabled makes the playlist loop when it reaches the
end of the playlist.
3.1.1 Key bindings
------------------
Global: (Main, Equalizer and Playlist window)
z = Previous song
x = Play
c = Pause
v = Stop
b = Next song
l = Play file (brings up the Load file(s) dialog)
j = Jump to file (in the existing playlist)
r = Toggle Repeat
s = Toggle Shuffle
Shift + l = Play directory (brings up the Add Directory dialog)
Control + l = Play location (url)
Control + p = Preferences dialog
Control + v = Visualization plugin dialog
Control + r = Time remaining
Control + a = Always on top
Control + w = Winshade mode
Control + d = Doublesize mode
Control + e = Easy move
Control + j = Jump to time
Control + z = Start of list
Control + n = No Playlist Advance
Control + 3 = File info dialog
Control + Alt + w = Toggle Equalizer winshade mode
Shift + Control + w = Toggle Playlist winshade mode
Alt + w = Toggle mainwindow
Alt + e = Toggle playlist window
Alt + g = Toggle equalizer window
Alt + s = Skin selector
Main window:
Arrow key up = Volume up 2%
Arrow key down = Volume down 2%
Arrow key right = Skip 5 seconds forward in song
Arrow key left = Skip 5 seconds back in song
Playlist window:
Arrow key up = up one step in playlist
Arrow key down = Down one step in playlist
Delete = Remove selected songs from playlist
Control+ Delete = Keeps the selected tracks and removes the rest
Q = Queue/Dequeue the tracks selected
Shift + Q = Clear the queue list
Alt + Q = Queue manager
Page Up = Move one page up
Page Down = Move one page down
Home = Go to the first song
End = Go to the last song
Enter = Play selected song
Insert = Add file dialog
Shift + Insert = Add directory dialog
Alt + Insert = Add url dialog
Equalizer shade mode:
Arrow key up = Volume up 2%
Arrow key down = Volume down 2%
Arrow key right = Balance 4% to right
Arrow key left = Balance 4% to left
3.2 Playlist editor
-------------------
To access the Playlist editor, select the button labeled "PL" on the right
side of the XMMS console.
This will bring up the actual playlist window, here you'll find 5 buttons.
All of these buttons can be held down to bring up an extra menu.
From left to right:
file + : will add a file to current playlist, held down mode you'll have
2 extra options
dir : will let you pick a directory (recursive)
url : will let you add an url for streaming
file - : will delete the highlighted file, held down mode you'll have 3
more options
crop : delete all files except the highlighted in the list
all : delete all files in the list
misc : *** NOT FUNCTIONAL ***
sel all : select all files in current playlist, held down mode you'll have
2 extra options
sel zero : select none
inv sel : invert you selection
misc opts : held down you'll have 2 extra options
fileinfo : opens the file info dialog.
sort : release button on this will bring up another menu with sort options
load list : will let you pick a playlist to load, held down you'll have
2 extra options
save : will let you save your playlist
new : will empty the playlist and let you create a new playlist
If you want to select/deselect files in the filrequester/playlist editor use
CTRL for files and SHIFT key for blocks of files. You can also browse the PL
using the cursor keys and enter to select song. Pressing the delete button will
remove the song from the playlist. If your mouse is equipped with a mouse
wheel, you can use this to scroll up and down.
3.3. Equalizer
--------------
To access the Equalizer, select the button labeled "EQ" on the right
side of the XMMS console.
That will bring up the Equalizer window. It looks like an equalizer on a stereo
and behaves like one as well. Press the button labeled ON to enable the use of
the equalizer, once you turned it on you use it as a normal equalizer.
EQ presets will be saved in ~/.xmms/config when you close XMMS. You can also
have your own presets for different song using the "Preset" button, XMMS can
also import/export from WinAmp's preset files.
If 'Auto' is enabled, XMMS will try to load equalizer presets like this:
1: Look for a preset file in the directory of the file we are about to play.
2: Look for a directory preset file in the same directory.
3: Look for a preset saved with the "auto-load" feature.
4: Finally, try to load the "default" preset.
The 'preset' button will open up a menu with the following options:
Load
Preset : Will open a window with all available presets.
Auto-load preset : Will open a window with all available auto-load
presets.
Default : Will load the default preset.
Zero : Will reset the equalizer to zero.
From file : Will load from a .preset file
From WinAMP EQF file : Will load from a WinAMP equalizer file. If you
choose a library file only the first entry will
be loaded.
Import
WinAMP presets : Imports the presets contained in an WinAMP equalizer
library file (often named WINAMP.q1) and add all
the entries to the Preset window.
Save
Preset : Let you name the current preset and save it.
Auto-load preset : Saves the current settings as a preset for the song
currently playing.
Default : Saves the default value for the equalizer.
From file : Saves the current settings in a preset file.
From WinAMP EQF file : Exports the current settings to a file readable by
WinAMP.
Delete
Preset : Let you delete a preset from the list.
Auto-load preset : Let you delete a auto-load preset from the list.
Configure Equalizer : Change the default names of directory based
preset files.
3.4 Menu
--------
There are several menu hot spots on the XMMS window. One place is at the left
hand side of the visual window described in sections 3.1 If you click the right
mouse button in the main window, the menus will also pop up (same as clicking
the button on the top left corner).
3.5 Preferences
---------------
Use the menu to open Options / Preferences or press CTRL-P to bring the
preferences dialog up.
The first three tabs are for different types of plugins, the plugins specific
configuration and usage will be explained in the plugins section of this
manual.
3.5.1 Audio I/O Plugins
-----------------------
In the 'Audio I/O' tab you control the heart of XMMS, which would be the Input
and Output plugins.
In the 'Input plugins' part you can disable/enable and configure the available
plugins. The list box displays the name of the plugin, it's file name and
'(disabled)' if you have disabled the plugin.
The 'Output Plugin' is where you tell XMMS how it should play the audio back.
Today you can only have one 'Output Plugin' active at a time. So you can't
both listen to the music through the 'OSS Driver' and save the music to disk
with 'Disk Writer'.
3.5.2 Effect Plugins
--------------------
Effect plugins can alter the sound in different ways.
3.5.3 General Plugins
---------------------
General plugins are mostly for controling XMMS.
3.5.4 Visualization Plugins
---------------------------
The 'Visualization' tab controls which visual effects you want to see when XMMS
is playing your music. See section 3.6.5 for the plugins shipped with XMMS.
3.5.5 Options
-------------
Here you change most of XMMS's behavior and settings.
'Read info on'
tells XMMS when to load the information from the files in your playlist.
'Demand' will load the information when the files are visible in the
playlist. 'Load' will load the information when you add the file to the
playlist. Having 'Load' turned on when loading a 6000 song playlist might
not be a good idea. If both options are turned off XMMS will only load
the information when the song is currently playing.
'Convert %20 to space'
This will convert "%20" to " " when the filename is displayed in the
playlist. (%20 is what browsers use instead of space)
'Convert underscore to space'
This will display " " instead of "_" in the playlist.
'Dim titlebar when inactive'
Will tell XMMS to use the dimmed titlebar from the current skin when
the window is inactive.
'Sort "jump to file" alphabetical'
Will sort the 'Jump to file' dialog (available by pressing "j") in
alphabetical order instead of the order it's in the playlist.
'Use realtime priority when available'
This works only if XMMS is run as root or is setuid as root. It will allow
XMMS to get all the CPU power it needs, and can greatly improve the playback
on slower systems. NOTE: The 'Disk Writer' plugin will NOT work with this
option enabled, also you need to restart XMMS in order for this to make a
change.
'Pause between song for [ ] seconds'
Will make a defined pause between each song.
'Show windowmanager decorations'
Enables the windowmanager borders around XMMS.
'Mouse Wheel adjust Volume by (%)'
If you have a mouse with a wheel, you can change how much of the volume to
be changed when you move it up or down.
'Allow multiple instances'
This will allow you to start more than one XMMS. You have to quit XMMS
before this change takes effect.
'Always show clutterbar'
Will make the OAIDV part of the main window to be displayed all the time.
'Save window positions'
Will save the main window's position on the screen instead of letting the
windowmanager choose location.
'Show numbers in playlist'
Enables the display of the internal track number in the playlist.
'Equalizer doublesize linked'
Will display the Equalizer in doublesize if you make XMMS doublesize.
'Smooth title scroll'
Makes the title scroll go smoother.
'Snap window at [ ] pixels'
Tells XMMS how close you can position the three windows until they dock /
snap together with each other.
'Use "\" as a directory delimiter'
This will come in handy if you are using playlist files from a windows
player, so XMMS will treat \ as /.
'Use meta data in playlists'
When enabled, all playlists will be saved with the configured 'Title'
string for quick loading of information when you load a playlist.
3.5.6 Fonts
-----------
Here you can change the fonts XMMS use.
'Use fontsets'
Will enable the usage of multi-byte charsets.
'Playlist'
Let's you choose what font XMMS should use for the playlist.
'Use X font'
Makes XMMS use a font for the scrolling title in the main window.
3.5.7 Title
-----------
The 'Title format:' box allows you to alter in which order the information
about the current song is displayed.
Example: %p - %t (%a) [%y]
will display something like "Laibach - Alle Gegen Alle (Nato) [1994]"
Available fields are:
%p - Artist (ex: Laibach)
%a - Album (ex: Nato)
%g - Genre (ex: Electronic)
%f - File name (ex: laibach-allegegenalle)
%F - File path (ex: /home/thomas/mp3)
%e - File extension (ex: mp3)
%t - Track name (ex: Alle Gegen Alle)
%n - Track number (ex: 6)
%d - Date (ex: ???)
%y - Year (ex: 1994)
%c - Comment (ex: Cover of D.A.F)
These fields makes use of normal printf(3) formatting codes.
Examples:
%0.3n Will pad the track number with 0's until it's 3 chars long.
%30p Prefix-pads the artist name to 30 chars length with spaces.
%-30 Same as previous, but suffix instead.
%-30.30p Suffix-pad to 30 chars and "cut" to 30 too.
3.6 Plugins
-----------
Plugins is what makes XMMS work, by moving most of the code out of XMMS and
into a plugin architecture it's possible to change almost everything in XMMS.
There are today 5 different types of plugins. Only a few plugins are
distributed with XMMS, you can find a lot more on http://www.xmms.org/
3.6.1 Input plugins
-------------------
The input plugins is what you use to play mp3, mod, wav and even movies with.
3.6.1.1 Cd Audio Player
-----------------------
Before I explain the usage we better have a look on the configuration
first.
Device tab
----------
Device:
Device
The actual device of your CD-ROM unit. On my system
I use /dev/cdrom which is a symlink to /dev/hdc.
Directory
This is where XMMS will "hijack" the filerequester and present
the content of the CD. On my system I have it set to
/mnt/cdrom, but if you're using some sort of automounter or
simmilar I suggest you change it to something like
/mnt/audio_cd and make sure the directory exists.
Play mode:
Analog
Analog playback requires that you have a cable connected
between the CD-ROM and the soundcard. Also it will not be
passed through any effect or visualization plugins.
Digital audio extraction
This allows XMMS to pass the sounddata through the effect and
visualization plugins.
Volume control:
This section is only active when you're using analog playback.
No mixer
You can't control the volume at all.
CDROM drive
The volume is controled directly on the CDROM, not all drives
support this though.
OSS mixer
The volume is controled through the OSS mixer
Check drive:
Makes a rudimentary check if everything is properly configured.
Remove drive:
If you have more than 1 drives configured this will remove the current
one.
Add drive:
If you have more than 1 drives on your system you can add another to
the plugin settings.
CD Info tab
-----------
CDDB:
CDDB is used to get track information for your CD from a CDDB
compatible database.
You can set the enviroment variable "XMMS_CDDB_CLIENT_NAME" to change
how XMMS presents itself to the CDDB server. Default value is
"XMMS 1.2.8"
Use CDDB:
Enable CDDB use.
Show network window:
Will open up a window containing useful debug information when
XMMS tries to do a CDDB lookup.
Get server list:
Press this button to get a list of alternative servers from the
server you've configured below.
CDDB server:
The CDDB server XMMS will use, default is 'freedb.freedb.org'
Track names:
Override generic titles:
By enabling this, the plugin will ignore the 'Title' settings
from XMMS (section 3.5.6).
Name format:
Works as explained in section 3.5.6 but you only have 4
available variables.
%p = Performer/Artist %t = Track name
%a = Album %n = Track number
Using the CD Audio Player plugin
--------------------------------
Now to add your CDROM tracks to the playlist. Insert an audio cd into the
CDROM drive and press the Eject button. Go to the directory which you defined
earlier ( /mnt/cdrom ) and you should see a list of tracks. They will be named
Track XX.cda, select the tracks you want to play and press OK. If you had
choosed an Internet database and the CD exists in it, XMMS will now display
the tracks you have chosen with their names according to the 'Name format'
configuration.
Now, that wasn't hard now was it?
3.6.1.2 Mikmod player
---------------------
This plugin will play a numerous older "module" formats supported by
the MikMod library (libmikmod). MikMod can be found at
http://www.ibiblio.org/pub/linux/apps/sound/libs/ and you'll need
3.1.6 or better to be able to build this plugin.
In the first configuration tab you can choose in which quality mikmod
should play the modules. If you have an older soundcard you might want to
change the defaults to match your card. If the modules are played in what
seems to be half speed change 'Resolution' to 8 bit.
In the 'Options' tab you have five options. 'Look for hidden patterns in
modules' can be used to play "patterns" which exist in the modules, but
wouldn't be called when played. (Since most module formats decide on a
pattern basis which the next pattern should be, you can "hide" smaller tunes
within a larger module.)
'Use surround mixing' will as hinted turn on some mixing that gives you an
surround effect. This is however only usable if you're playing the module
in stereo.
'Force volume fade...' will fade out the music when the modules reaches
it's end.
'Use interpolation' can enhance the sound of the samples contained in the
modules, unless you're really out for that old crispy retro feeling. :)
'Default panning separation' "The original Amiga formats had an implicit
channel allocation (because the Amiga's hardware had same), 100% left or 100%
right depending on the track number (left right right left, or right left left
right, I forget). That sounded OK when they were written because most monitors
had only a single speaker, and the flash monitors didn't separate the speakers
more than about a foot, but when you try something like that with your speakers
in opposite corners of the room it drives you to distraction. That control
lessens the annoyance for file formats that don't specify the balance."
- Simon Hosie
3.6.1.3 MPEG Layer 1/2/3 player
-------------------------------
The main reason why this player exists today is mp3 files, so what could be
better than a plugin that plays them?.
It's based off the mpg123 engine and handles MPEG Layer 1/2/3 files and
VBR (variable bit rate) MP3 files.
The first configuration tab is just like the MikMod one, and again, if you
have an older soundcard and the music is going half speed, change the
'Resolution' setting.
In the 'Options' section you can tell XMMS how to handle the files you feed it.
You can tell the plugin to dectect files by extension, content and both. The
reason why this option exists is to make XMMS less demanding when you add a lot
of MP3 files with the extension .mp3. If you use both then XMMS will first look
at the extension and then try to detect by content. This is useful if you have
CDs with music that aren't correctly named.
In the streaming tab you can choose a 'Buffer size' in kilobytes which XMMS
will keep while streaming. This ranges from 4 -> 4096kb (which should be
sufficient for most people. The 'Pre-buffer' value is how much of the buffer
XMMS should fill before starting to play the stream. (0%-90%)
I'll let Chad Armstrong describe the two following options.
"As streaming becomes more popular, there is rising demand for better
information about the current track being played. This 'Now Playing'
information (also known as 'Title Streaming') allows for more information to be
passed back to the listener. In the past, there was a method started by the
Shoutcast group, which embedded this information in the stream itself. The mp3
standard was never designed to allow for text information to be interleaved
with audio data, and it is this design which can cause errors in playback. The
Icecast Team has taken this data completely out of the mp3 data, and has
provided it in a side channel (via UDP)."
- Chad Armstrong (icemonk)
You're better off having both these options enabled. :)
In the 'Title' tab you can change the way XMMS presents the mp3 files to the
playlist.
ID3 is data stored in the mp3 file and can include Artist, Album etc. If you
uncheck 'Use ID3 tags' XMMS will display the filename instead of the ID3
information.
ID3V2 allows for a lot of extra data to be stored in the mp3 file, and don't
suffer from the limitations of ID3V1, XMMS supports the same data that are
available in ID3V1 but not the extra data. If a mp3 file contains both ID3V1
and ID3V2 tags, you might see something different that the 'file info' editor
displays. If this happens, you might want to turn on 'Disable ID3V2 tags'.
'Override generic titles' is used if you do not want to use the generic titles
defined in the preferences. See section 3.5.6.
The 'ID3 format:' box allows you to alter in which order the information about
the current song is displayed.
Example: %p - %t (%a) [%y]
will display something like "Laibach - Alle Gegen Alle (Nato) [1994]"
available fields are:
%p - Artist (ex: Laibach)
%a - Album (ex: Nato)
%f - File name (ex: laibach-allegegenalle)
%F - File path (ex: /home/thomas/mp3)
%e - File extension (ex: mp3)
%t - Track name (ex: Alle Gegen Alle)
%n - Track number (ex: 6)
%y - Year (ex: 1994)
%g - Genre (ex: Electronic)
%c - Comment (ex: Cover of D.A.F)
3.6.1.4 Tone Generator
----------------------
Will generate a sinus tone or a mix of several sinus tones. To use it add a
URL: tone://frequency1;frequency2;frequency3;...
Example: tone://2000
will play a 2000Hz tone.
Example: tone://2000;2005
will play a 2000Hz tone and a 2005Hz tone at the same time. Notice the 5Hz
beats between the two tones.
The use of this baffles me, but at least I can use it to annoy my neighbors
dog.
3.6.1.5 Ogg Vorbis Player
-------------------------
Plays OGG Vorbis encoded files, see http://www.xiph.org/ogg/vorbis/
for more information.
3.6.1.6 Wave player
-------------------
This plugin plays as suggested, wave files. It supports 16bit and 8bit PCM wave
files.
3.6.2 Output plugins
--------------------
This type of plugins is what is used to send the audio data to your soundcard
or alternative devices.
3.6.2.1 OSS Driver
------------------
This plugin is probably what most of you will use if your system is equipped
with the OpenSoundSystem (www.opensound.com) drivers or compatible.
Compatible drivers are ALSA with their OSS emulation, and Linux kernel sound
drivers.
In the 'Devices' tab you can change the soundcard which XMMS is going to use.
If your driver have more than one dsp, you can change the one XMMS uses by
enabling 'Use alternate device' and changing the '/dev/dsp' to suit your needs.
If you have changed your Audio Device to another soundcard (if you for some
reason have two cards) don't forget to change the 'Mixer device' setting to the
soundcard you want to use.
In the 'Buffering' tab you can change how much data the OSS plugin will buffer.
The 'Buffer size' ranges from 200 - 10000ms. If you want the plugin to wait for
the buffer to be filled before it starts playing the music change the 'Pre-
buffer' value, this ranges from 0% - 90% of the 'Buffer size' value.
In the 'Mixer' tab you can change which volume setting XMMS should change when
you alter the volume from XMMS. Enable 'Volume controls Master not PCM' if you
want XMMS to change the volume of all sounds instead of only PCM/wave sound.
3.6.2.2 Disk Writer
-------------------
The 'Disk Writer' plugin will only output the music into a .wav file in
the 'Path' you set in it's configuration window.
3.6.2.3 eSound Output
---------------------
The 'ESD' plugin will use the 'Enlightened Sound Daemon' to playback the audio.
It's useful if you want to be able to have sound effects in your programs and
still be able to listen to music with XMMS.
In the 'Server' tab of the configuration, you can tell the plugin where to send
the audio data. Enable 'Use remote host' and enter the name/ip of the server
and port to send to. This is probably only useful in a LAN environment, since
the audio data is sent uncompressed to the remote ESD.
The 'Buffering' tab works just like the 'OSS Driver' one.
3.6.2.4 BSD Sun Output
----------------------
The 'Sun' output plugin will use the native audio(4) interface provided
by OpenBSD and NetBSD for playback and mixing.
The $AUDIODEVICE and $MIXERDEVICE environment variables will override the
current configuration settings. Defaults are /dev/audio and /dev/mixer.
In the 'Devices' tab you can change the audio, audioctl and mixer devices
XMMS is going to use. The audioctl device is used for ioctl(2) calls
independent of audio data I/O.
In the 'Buffering' tab you can change how much data the Sun plugin will
buffer. The 'Buffer size' ranges from 200 - 10000ms. If you want the plugin
to wait for the buffer to be filled before it starts playing the music,
change the 'Pre-buffer' value, this ranges from 0% - 90% of the 'Buffer size'
value.
In the 'Mixer' tab you can select the volume device to be affected when you
alter the volume from XMMS. `XMMS uses mixer exclusively' causes XMMS to
keep the mixer device open instead of re-opening it for each operation.
There may also be some more options depending on what your audio mixer
device supports (eg. loudness, spatial, surround, preamp).
In the 'Status' tab you can see audio device information and real-time
playback status.
3.6.2.5 ALSA Output
-------------------
Undocumented.
3.6.3 Effect plugins
--------------------
Effect plugins can alter the sound of the music you are listening to.
3.6.3.1 Echo
------------
Adds an echo effect to the audio.
In the configuration you can change 'Delay' 'Feedback' 'Volume' and enable
'Surround Echo'
3.6.3.2 Extra Stereo
--------------------
Enhances the stereo effect on the audio.
In the configuration screen you can choose intensity.
3.6.3.3 Voice removal
---------------------
A simple voice removal plugin, no configuration.
3.6.4 General plugins
---------------------
Mostly used for controlling XMMS and passing data to other programs.
3.6.4.1 IRman Control
---------------------
With this plugin you can use a remote control compatible with IRman to
control XMMS. To set the functions on the remote control, open the
configuration screen and choose on which device the IRman is on. Press the
function you want to assign and then press the button on the remote which
you want it to use for the current function.
Device
Device
The serial device your IRman is plugged into.
(COM1 = /dev/ttyS0, COM2 = /dev/ttyS1)
IR code length
Undocumented
Controls
Play - Repeat
These will effectively press the appropriate corresponding
button in XMMS and cause that action to immediately take
effect.