comparison README @ 0:cb178e5ad177 trunk

[svn] Import audacious source.
author nenolod
date Mon, 24 Oct 2005 03:06:47 -0700
parents
children f3445e7184f7
comparison
equal deleted inserted replaced
-1:000000000000 0:cb178e5ad177
1 BMP - Beep Media Player (c) GPL 2003-2004
2
3 BMP Development Team (see AUTHORS)
4
5
6 Based on:
7
8 XMMS - X Multimedia System (c)1997-2001
9
10 A Cross platform Multimedia Player
11
12 Peter Alm, Thomas Nilsson, Olle Hallnas, Håvard Kvålen
13
14
15 NOTE: This document is hardly maintained. Please check the Users' Guide on
16 the BMP website.
17
18
19 TABLE OF CONTENTS
20 *****************
21
22 1. Disclaimer
23 2. Installation
24 2.1 Basic Installation
25 2.2 Border less Installation
26 2.3 Skin Installation
27 3. Documentation
28 3.1 Controlling BMP
29 3.1.1 Key bindings
30 3.2 Playlist Editor
31 3.3 Equalizer
32 3.4 Menu
33 3.5 Preferences
34 3.5.1 Audio I/O Plugins
35 3.5.2 Effect/General Plugins
36 3.5.3 Visualization Plugins
37 3.5.4 Options
38 3.5.5 Fonts
39 3.5.6 Title
40 3.6 Plugins
41 3.6.1 Input plugins
42 3.6.1.1 Cd Audio Player
43 3.6.1.2 MPEG Layer 1/2/3 player
44 3.6.1.3 Ogg Vorbis player
45 3.6.1.4 WAV player
46 3.6.2 Output plugins
47 3.6.2.1 OSS Driver
48 3.6.2.2 eSound Output
49 3.6.2.3 BSD Sun Output
50 3.6.3 Effect plugins
51 3.6.4 General plugins
52 3.6.5 Visualization plugins
53 3.6.5.1 Blur scope
54 4. Command Line Options
55 5. Features
56 5.1 Supported File formats
57 5.2 Supported Features
58 6. Obtaining BMP
59 7. Misc
60 7.1 Shoutcast support
61 7.2 Tips and tricks
62 8. Bugs
63 9. Contact Email
64
65
66
67
68 1. Disclaimer
69 -------------
70
71 We are not liable for any damage caused by the use of this program.
72
73 BMP is NOT a port of WinAmp (http://www.winamp.com). BMP is a fork of
74 XMMS (http://xmms.org) which borrowed the WinAmp GUI.
75
76
77 2. Installation
78 ---------------
79
80 BMP requires the following libraries and their development
81 packages installed:
82
83 Glib 2.4
84 (http://www.gtk.org/download/)
85
86 GTK+ 2.4
87 (http://www.gtk.org/download/)
88
89 libglade >= 2.3.1
90 (http://ftp.gnome.org/pub/GNOME/sources/libglade/2.3/)
91
92 The following packages are required for optional features:
93
94 Vorbis input plugin:
95 libvorbis >= 1.0
96 (http://www.xiph.org/ogg/vorbis/download.html)
97
98 ESD output plugin:
99 esound >= 0.2.3
100 (http://ftp.gnome.org/pub/GNOME/desktop/2.6/2.6.0/sources/)
101
102 ALSA output plugin:
103 alsa-lib >= 1.0
104 (http://www.alsa-project.org)
105
106 GNOME VFS support:
107 gnome-vfs >= 2.6.0
108 (http://ftp.gnome.org/pub/GNOME/desktop/2.6/2.6.0/sources/)
109
110 GConf support:
111 GConf >= 2.6.0
112 (http://ftp.gnome.org/pub/GNOME/desktop/2.6/2.6.0/sources/)
113
114 If you compile BMP from a fresh CVS checkout, you will also need
115 the following tools:
116
117 automake >= 1.7
118 autoconf >= 2.5
119
120 Note that these tools and libraries are bundled with major Linux
121 distributions. Use the packages provided with them where possible. If
122 those packages are not sufficiently new, you may need to search
123 third-party repositories for them.
124
125
126 2.1 Basic Installation
127 ----------------------
128
129 cd bmp-0.9.7
130 ./configure
131 make
132 make install
133
134 This will put the binary in /usr/local/bin and plugins in
135 /usr/local/lib/bmp/
136
137 Note for packagers: The gnome-vfs option is VERY EXPERIMENTAL. We suggest you
138 do not use it in your official distribution packages.
139
140
141 2.2 Borderless Installation
142 ---------------------------
143
144 As far as I know most WM's accepts GTK decoration hints so it will
145 not have borders. But some WM's can't handle this so you have to
146 set in manually.
147
148 AfterStep 1.0 ~/.steprc
149 Style "XMMS_Player" NoTitle, NoHandles
150 Style "XMMS_Playlist" NoTitle, NoHandles
151 Style "XMMS_Equalizer" NoTitle, NoHandles
152
153 AfterStep 1.4 ~/GNUstep/Library/AfterStep/database
154 Style "XMMS_Player" NoTitle, NoHandles
155 Style "XMMS_Playlist" NoTitle, NoHandles
156 Style "XMMS_Equalizer" NoTitle, NoHandles
157
158 Fvwm's ~/.fvwm95rc
159 Style "XMMS_Player" NoTitle
160 Style "XMMS_Playlist" NoTitle
161 Style "XMMS_Equalizer" NoTitle
162
163 CTWM's ~/.ctwmrc
164 NoTitle and NoBorder sections:
165 NoTitle {
166 "xmms"
167 }
168
169 NoBorder {
170 "xmms"
171 }
172
173 2.3 Skin Installation
174 ---------------------
175
176 BMP will create a directory called ~/.bmp/Skins/. You can unarchive
177 the skins the same way as you do for WinAmp.
178
179 However, you don't need to as BMP supports archived skins. BMP
180 currently reads the following formats: zip, wsz, tar, tar.gz and
181 tar.bz2
182
183 Just copy the archive to one of the skin path's and BMP will take care
184 of the rest.
185
186 In order to support zipped skins you will need to have unzip. Unzip
187 is bundled with most Linux distributions.
188
189 BMP looks for skins in these directories (in listing order):
190
191 <prefix>/share/bmp/Skins
192 ~/.bmp/Skins
193
194 You can set the environment variable SKINSDIR to another location of
195 your choice:
196
197 For BASH:
198 export SKINSDIR=/path/to/Skins:/more/paths/to/other/locations/of/Skins
199
200 For CSH:
201 setenv SKINSDIR /path/to/Skins:/more/paths/to/other/locations/of/Skins
202
203
204 3. Documentation
205 ----------------
206
207 This file or http://beepmp.sf.net
208
209
210 3.1 Controlling BMP
211 --------------------
212
213 When you start up BMP, you will get a console very similar to that of
214 WinAmp.
215
216 - On the top is the window title bar. To the right you will see 3 buttons,
217 Left button will minimize BMP.
218 Middle button will make BMP only display the title bar.
219 Right button will end the BMP session.
220
221 - The area in the upper left part displays the following:
222 - Play state: Paused, Stopped, or Playing
223 - Time elapsed in the current song or if you click on it, the reversed.
224 - Spectrum analyzer of the sound being played. Right mouse click will
225 bring up the Visualization menu. Left mouse button will change the
226 analyzer to an oscilloscope and/or none.
227
228 - To the right of the Spectrum analyzer is the title of the file being played.
229 This also contains the length of the song being played, as well as its
230 position in the [unsorted] playlist. Right clicking in this window will bring
231 up a new menu with some more options that are self explaining.
232
233 - In the left part of the Spectrum analyzer you'll have letters (at least if
234 you use the default skin) O A I D V. This is known as the
235 "clutterbar'. Left-clicking on these will open up menus or perform the
236 listed actions.
237 O : Options menu
238 A : Always on top
239 I : File info box
240 D : Double size mode
241 V : Visualization menu
242
243 - Underneath the track title are the following static informational data:
244 - bit rate in KBps (usually 128 or 112)
245 - Sample Rate in KHz (usually 44)
246 - Stereo or Mono channel mixing
247
248 - Underneath the informational data are a few controls you can play with:
249 - The first slider controls the volume
250 - The second slider controls the balance between speakers
251 - The button marked "EQ" loads up the graphic equalizer
252 - The button marked "PL" loads up the playlist editor
253 - The LARGE slide bar moves from left to right as the song plays. You can
254 drag this to jump to another location in the current file.
255
256 - On the bottom of the console are the standard buttons you would see on a CD
257 player: Previous track, Play, Pause, Stop, Next track, eject, shuffle
258 and repeat.
259
260 - The eject button doesn't REALLY eject, of course. :) It opens up the
261 file requester. The File Requester builds a playlist for the current
262 BMP session. You can use it to load files, add files to the list, or
263 load all mp3s in a directory.
264
265 - The shuffle button randomizes the sequence of the playlist.
266
267 - The repeat button when enabled makes the playlist loop when it reaches the
268 end of the playlist.
269
270
271 3.1.1 Key bindings
272 ------------------
273
274 Global: (Main, Equalizer and Playlist window)
275
276 z = Previous song
277 x = Play
278 c = Pause
279 v = Stop
280 b = Next song
281 l = Play file (brings up the Load file(s) dialog)
282 j = Jump to file (in the existing playlist)
283 r = Toggle Repeat
284 s = Toggle Shuffle
285
286 Control + h = Play location (url)
287 Control + p = Preferences dialog
288 Control + r = Time remaining
289 Control + o = Always on top
290 Control + w = Winshade mode
291 Control + j = Jump to time
292 Control + z = Start of list
293 Control + n = No Playlist Advance
294 Control + 3 = File info dialog
295
296 Control + Alt + w = Toggle Equalizer winshade mode
297 Shift + Control + w = Toggle Playlist winshade mode
298
299 Alt + e = Toggle playlist window
300 Alt + g = Toggle equalizer window
301
302 Main window:
303
304 Arrow key up = Volume up 2%
305 Arrow key down = Volume down 2%
306 Arrow key right = Skip 5 seconds forward in song
307 Arrow key left = Skip 5 seconds back in song
308
309 Playlist window:
310
311 Arrow key up = up one step in playlist
312 Arrow key down = Down one step in playlist
313
314 Delete = Remove selected songs from playlist
315 Page Up = Move one page up
316 Page Down = Move one page down
317 Home = Go to the first song
318 End = Go to the last song
319 Enter = Play selected song
320 Insert = Add file dialog
321 Shift + Insert = Add directory dialog
322 Alt + Insert = Add url dialog
323
324 Equalizer shade mode:
325
326 Arrow key up = Volume up 2%
327 Arrow key down = Volume down 2%
328 Arrow key right = Balance 4% to right
329 Arrow key left = Balance 4% to left
330
331
332 3.2 Playlist editor
333 -------------------
334
335 To access the Playlist editor, select the button labeled "PL" on the right
336 side of the BMP console.
337
338 This will bring up the actual playlist window, here you'll find 5 buttons.
339 All of these buttons can be held down to bring up an extra menu.
340 From left to right:
341
342 file + : will add a file to current playlist, held down mode you'll have
343 2 extra options
344 dir : will let you pick a directory (recursive)
345 url : will let you add an url for streaming
346
347 file - : will delete the highlighted file, held down mode you'll have 3
348 more options
349 crop : delete all files except the highlighted in the list
350 all : delete all files in the list
351 misc : *** NOT FUNCTIONAL ***
352
353 sel all : select all files in current playlist, held down mode you'll have
354 2 extra options
355 sel zero : select none
356 inv sel : invert you selection
357
358 misc opts : held down you'll have 2 extra options
359 fileinfo : opens the file info dialog.
360 sort : release button on this will bring up another menu with sort options
361
362 load list : will let you pick a playlist to load, held down you'll have
363 2 extra options
364 save : will let you save your playlist
365 new : will empty the playlist and let you create a new playlist
366
367 If you want to select/deselect files in the filrequester/playlist editor use
368 CTRL for files and SHIFT key for blocks of files. You can also browse the PL
369 using the cursor keys and enter to select song. Pressing the delete button will
370 remove the song from the playlist. If your mouse is equipped with a mouse
371 wheel, you can use this to scroll up and down.
372
373 3.3. Equalizer
374 --------------
375
376 To access the Equalizer, select the button labeled "EQ" on the right
377 side of the BMP console.
378
379 That will bring up the Equalizer window. It looks like an equalizer on a stereo
380 and behaves like one as well. Press the button labeled ON to enable the use of
381 the equalizer, once you turned it on you use it as a normal equalizer.
382
383 EQ presets will be saved in ~/.bmp/config when you close BMP. You can also
384 have your own presets for different song using the "Preset" button, BMP can
385 also import/export from WinAmp's preset files.
386
387 If 'Auto' is enabled, BMP will try to load equalizer presets like this:
388
389 1: Look for a preset file in the directory of the file we are about to play.
390 2: Look for a directory preset file in the same directory.
391 3: Look for a preset saved with the "auto-load" feature.
392 4: Finally, try to load the "default" preset.
393
394 The 'preset' button will open up a menu with the following options:
395
396 Load
397 Preset : Will open a window with all available presets.
398 Auto-load preset : Will open a window with all available auto-load
399 presets.
400 Default : Will load the default preset.
401 Zero : Will reset the equalizer to zero.
402 From file : Will load from a .preset file
403 From WinAMP EQF file : Will load from a WinAMP equalizer file. If you
404 choose a library file only the first entry will
405 be loaded.
406 Import
407 WinAMP presets : Imports the presets contained in an WinAMP equalizer
408 library file (often named WINAMP.q1) and add all
409 the entries to the Preset window.
410 Save
411 Preset : Let you name the current preset and save it.
412 Auto-load preset : Saves the current settings as a preset for the song
413 currently playing.
414 Default : Saves the default value for the equalizer.
415 From file : Saves the current settings in a preset file.
416 From WinAMP EQF file : Exports the current settings to a file readable by
417 WinAMP.
418 Delete
419 Preset : Let you delete a preset from the list.
420 Auto-load preset : Let you delete a auto-load preset from the list.
421
422 Configure Equalizer : Change the default names of directory based
423 preset files.
424
425 3.4. Menu
426 ---------
427
428 There are several menu hot spots on the BMP window. One place is at the left
429 hand side of the visual window described in sections 3.1 If you click the right
430 mouse button in the main window, the menus will also pop up (same as clicking
431 the button on the top left corner).
432
433 3.5. Preferences
434 ----------------
435
436 Use the menu to open Options / Preferences or press CTRL-P to bring the
437 preferences dialog up.
438
439 3.5.1. Appearance
440 -----------------
441
442 Skins
443 In the skinlist you can choose a skin. How to install skins is described above.
444 Click on a skin in the list to change to it.
445
446 Fonts
447 You can set the font in the main window by setting the 'Player' font. You can
448 change the playlist font by setting the 'Playlist' font.
449
450 Miscellaneous
451 Show track numbers in playlist - Enable/disable displaying of track numbers in
452 the playlist.
453 Use custom cursors - Enable/disable custom cursors set by the skin.
454
455
456 3.5.2. Mouse
457 ------------
458
459 Mouse wheel
460 Change how BMP handles scroll behaviours.
461
462 3.5.3. Playlist
463 ---------------
464
465 Filename
466 Convert underscores to blanks - Converts '_' (underscores) to ' ' in the
467 playlist.
468 Convert %20 to blanks - Converts '%20' to ' ' in the
469 playlist.
470
471 Metadata
472 Load metadata from playlists and files - Loads metadata from files and
473 playlists (e.g. ID3 tags).
474
475 Playback
476 Don't advance in playlist - Don't advance to the next song in the playlist when
477 the current song ends.
478 Pause between songs - Set the time (in secons) to pause on songchange
479
480 Song display
481 Title format - Choose the format to display the song names in the playlist.
482 Custom string - When the above option is set to 'Custom' insert a string of
483 substitutes here.
484
485 3.5.6. Plugins
486 --------------
487
488 Enable/disable and configure plugins in this section.
489
490 Choose a tab to list one of the types of plugins:
491 - Media (filetype/device support)
492 - General (general plugins)
493 - Visualization (visualization plugins)
494 - Effects (effect plugins)
495 - Output (output plugins)
496
497 3.6 Plugins
498 -----------
499 Plugins is what makes BMP work, by moving most of the code out of BMP and
500 into a plugin architecture it's possible to change almost everything in BMP.
501 There are today 5 different types of plugins. Only a few plugins are
502 distributed with BMP, you can find information on more of them at:
503
504 http://beepmp.sf.net
505
506
507 3.6.1 Input plugins
508 -------------------
509 The input plugins is what you use to play mp3, mod, wav and even movies with.
510
511
512 3.6.1.1 Cd Audio Player
513 -----------------------
514 Plays audio cd's on Linux, FreeBSD and Solaris. This plugin does not pass
515 the sound through BMP, so no visualization can be made nor will the
516 equalizer settings have any effect.
517
518 Before I explain the usage we better have a look on the configuration
519 first.
520
521 In the device tab you should set Device to your cdrom unit. /dev/cdrom
522 is generally a good choice on Linux systems. Set 'Directory' to where a
523 directory which will be used by BMP to present the available cd tracks in.
524 Using the normal mount point for the cdrom is recommended unless the
525 cdrom is automounted if it contains a data track.
526
527 Example:
528 --------
529 Device: /dev/cdrom (which on my system is symlinked to /dev/hdc)
530 Directory: /mnt/cdrom
531
532 The next setting is used to decide what volume is to be changed, it's either
533 the OSS Mixer for CD Audio or the actual volume on the CDROM.
534
535 In the CD Info tab you can choose if the plugin should try and get the
536 track names from a Internet database server.
537
538 You can either use the CDDB protocol or CD Index. CDDB defaults to a free
539 version of CDDB, but it will work with the infamous cddb servers as well.
540
541 Show network window will display some useful information if something goes
542 wrong, but you'll have to close and re-open it to update the content of it.
543
544 If a CDDB server is too slow for your taste, you can press 'Get server list'
545 to receive a list of alternate servers.
546
547 CD Index is another type of database, but works in a similar manner. If
548 you don't have libxml installed when you compiled the plugin, this will be
549 grayed out.
550
551 In the "Track names" box you can decide on how the plugin presents the
552 tracks to you. This is normally handled by the 'Title' (section 3.5.6) setting
553 in the main preferences, but you can choose to override them here.
554
555 Available variables are:
556
557 %p = Performer/Artist %t = Track name
558 %a = Album %n = Track number
559
560 So "%n. %t / %p (%a)" would display something like:
561
562 1. New Life / Depeche Mode (Speak & Spell)
563
564 Now to add your CDROM tracks to the playlist. Insert an audio cd into the
565 CDROM drive and press the Eject button. Go to the directory which you defined
566 earlier ( /mnt/cdrom ) and you should see a list of tracks. They will be named
567 Track XX.cda, select the tracks you want to play and press OK. If you had
568 choosed an Internet database and the CD exists in it, BMP will now display
569 the tracks you have chosen with their names according to the 'Name format'
570 configuration.
571
572 Now, that wasn't hard now was it?
573
574 If you want BMP to identify as something else when speaking with servers, you
575 can set the environmental variable "XMMS_CDDB_CLIENT_NAME", and BMP will use
576 that instead.
577
578
579 3.6.1.2 MPEG Layer 1/2/3 player
580 -------------------------------
581 The main reason why this player exists today is mp3 files, so what could be
582 better than a plugin that plays them?.
583
584 It's based off the mpg123 engine and handles MPEG Layer 1/2/3 files and
585 VBR (variable bit rate) MP3 files.
586
587 The first configuration tab is just like the MikMod one, and again, if you
588 have an older soundcard and the music is going half speed, change the
589 'Resolution' setting.
590
591 If you have mp3 files named something else than .mp3, you might want to enable
592 'Detect files by content' so BMP will know that they are supported. Although
593 I'd recommend that you rename the files (or just beat the person who burned his
594 high-school bands music with in proper file extensions into giving you a new
595 cd) since this is rather slow.
596
597 In the streaming tab you can choose a 'Buffer size' in kilobytes which BMP
598 will keep while streaming. This ranges from 4 -> 4096kb (which should be
599 sufficient for most people. The 'Pre-buffer' value is how much of the buffer
600 BMP should fill before starting to play the stream. (0%-90%)
601
602 I'll let Chad Armstrong describe the two following options.
603
604 "As streaming becomes more popular, there is rising demand for better
605 information about the current track being played. This 'Now Playing'
606 information (also known as 'Title Streaming') allows for more information to be
607 passed back to the listener. In the past, there was a method started by the
608 Shoutcast group, which embedded this information in the stream itself. The mp3
609 standard was never designed to allow for text information to be interleaved
610 with audio data, and it is this design which can cause errors in playback. The
611 Icecast Team has taken this data completely out of the mp3 data, and has
612 provided it in a side channel (via UDP)."
613
614 - Chad Armstrong (icemonk)
615
616 You're better off having both these options enabled. :)
617
618 In the 'Title' tab you can change the way BMP presents the mp3 files to the
619 playlist.
620
621 ID3 is data stored in the mp3 file and can include Artist, Album etc. If you
622 uncheck 'Use ID3 tags' BMP will display the filename instead of the ID3
623 information.
624
625 ID3V2 allows for a lot of extra data to be stored in the mp3 file, and don't
626 suffer from the limitations of ID3V1, BMP supports the same data that are
627 available in ID3V1 but not the extra data. If a mp3 file contains both ID3V1
628 and ID3V2 tags, you might see something different that the 'file info' editor
629 displays. If this happens, you might want to turn on 'Disable ID3V2 tags'.
630
631 'Override generic titles' is used if you do not want to use the generic titles
632 defined in the preferences. See section 3.5.6.
633
634 The 'ID3 format:' box allows you to alter in which order the information about
635 the current song is displayed.
636
637 Example: %p - %t (%a) [%y]
638 will display something like "Laibach - Alle Gegen Alle (Nato) [1994]"
639
640 available fields are:
641
642 %p - Artist (ex: Laibach)
643 %a - Album (ex: Nato)
644 %f - File name (ex: laibach-allegegenalle)
645 %F - File path (ex: /home/thomas/mp3)
646 %e - File extension (ex: mp3)
647
648 %t - Track name (ex: Alle Gegen Alle)
649 %n - Track number (ex: 6)
650 %y - Year (ex: 1994)
651 %g - Genre (ex: Electronic)
652 %c - Comment (ex: Cover of D.A.F)
653
654
655 3.6.1.3 Ogg Vorbis Player
656 -------------------------
657
658 Plays OGG Vorbis encoded files, see http://www.xiph.org/ogg/vorbis/index.html
659 for more information.
660
661
662 3.6.1.4 WAV player
663 -------------------
664 This plugin plays as suggested, wave files. It supports 16bit and 8bit PCM wave
665 files.
666
667
668 3.6.2 Output plugins
669 --------------------
670 This type of plugins is what is used to send the audio data to your soundcard
671 or alternative devices.
672
673
674 3.6.2.1 OSS Driver
675 ------------------
676 This plugin is probably what most of you will use if your system is equipped
677 with the OpenSoundSystem (www.opensound.com) drivers or compatible.
678 Compatible drivers are ALSA with their OSS emulation, and Linux kernel sound
679 drivers.
680
681 In the 'Devices' tab you can change the soundcard which BMP is going to use.
682 If your driver have more than one dsp, you can change the one BMP uses by
683 enabling 'Use alternate device' and changing the '/dev/dsp' to suit your needs.
684
685 If you have changed your Audio Device to another soundcard (if you for some
686 reason have two cards) don't forget to change the 'Mixer device' setting to the
687 soundcard you want to use.
688
689 In the 'Buffering' tab you can change how much data the OSS plugin will buffer.
690 The 'Buffer size' ranges from 200 - 10000ms. If you want the plugin to wait for
691 the buffer to be filled before it starts playing the music change the 'Pre-
692 buffer' value, this ranges from 0% - 90% of the 'Buffer size' value.
693
694 In the 'Mixer' tab you can change which volume setting BMP should change when
695 you alter the volume from BMP. Enable 'Volume controls Master not PCM' if you
696 want BMP to change the volume of all sounds instead of only PCM/wave sound.
697
698
699 3.6.2.2 eSound Output
700 ---------------------
701 The 'ESD' plugin will use the 'Enlightened Sound Daemon' to playback the audio.
702 It's useful if you want to be able to have sound effects in your programs and
703 still be able to listen to music with BMP.
704
705 In the 'Server' tab of the configuration, you can tell the plugin where to send
706 the audio data. Enable 'Use remote host' and enter the name/ip of the server
707 and port to send to. This is probably only useful in a LAN environment, since
708 the audio data is sent uncompressed to the remote ESD.
709
710 The 'Buffering' tab works just like the 'OSS Driver' one.
711
712
713 3.6.2.3 BSD Sun Output
714 ----------------------
715 The 'Sun' output plugin will use the native audio(4) interface provided
716 by OpenBSD and NetBSD for playback and mixing.
717
718 The $AUDIODEVICE and $MIXERDEVICE environment variables will override the
719 current configuration settings. Defaults are /dev/audio and /dev/mixer.
720
721 In the 'Devices' tab you can change the audio, audioctl and mixer devices
722 BMP is going to use. The audioctl device is used for ioctl(2) calls
723 independent of audio data I/O.
724
725 In the 'Buffering' tab you can change how much data the Sun plugin will
726 buffer. The 'Buffer size' ranges from 200 - 10000ms. If you want the plugin
727 to wait for the buffer to be filled before it starts playing the music,
728 change the 'Pre-buffer' value, this ranges from 0% - 90% of the 'Buffer size'
729 value.
730
731 In the 'Mixer' tab you can select the volume device to be affected when you
732 alter the volume from BMP. `BMP uses mixer exclusively' causes BMP to
733 keep the mixer device open instead of re-opening it for each operation.
734
735 There may also be some more options depending on what your audio mixer
736 device supports (eg. loudness, spatial, surround, preamp).
737
738 In the 'Status' tab you can see audio device information and real-time
739 playback status.
740
741
742 3.6.3 Effect plugins
743 --------------------
744 Effect plugins can alter the sound of the music you are listening to.
745
746
747 3.6.4 General plugins
748 ---------------------
749 Mostly used for controlling BMP and passing data to other programs.
750
751
752 3.6.5 Visualization plugins
753 ---------------------------
754 Eye candy plugins.
755
756
757 3.6.5.1 Blur scope
758 -------------------
759 A simple blurring oscilloscope, in the configuration you can change the color
760 with the standard GTK color dialog.
761
762
763 4. Command Line Options
764 -----------------------
765
766 beep-media-player --help will produce:
767
768 Usage: beep-media-player [options] [files] ...
769
770 Options:
771 --------
772
773 -h, --help Display this text and exit.
774 -n, --session Select BMP/XMMS session (Default: 0)
775 -r, --rew Skip backwards in playlist
776 -p, --play Start playing current playlist
777 -u, --pause Pause current song
778 -s, --stop Stop current song
779 -t, --play-pause Pause if playing, play otherwise
780 -f, --fwd Skip forward in playlist
781 -e, --enqueue Don't clear the playlist
782 -m, --show-main-window Show the main window
783 -v, --version Print version number and exit.
784
785 You can specify files on the command line, e.g:
786
787 beep-media-player file1.mp3 file2.mp3 file3.mp3
788 beep-media-player *.mp3
789 beep-media-player playlist.m3u (note: playlists must be named .m3u)
790
791 If you do this while BMP is running the current playlist
792 will be cleared and the files/playlist specified on the command
793 line will be used instead.
794
795 To keep the current playlist intact use the -e option.
796
797
798 5. Features
799 -----------
800
801 5.1 Supported File formats
802 -------------------------
803
804 OGG Vorbis
805 MP2 and MP3 streams
806 WAV/AU samples
807
808 Others:
809
810 CD audio
811 Shout/Icecast
812
813
814 5.2 Supported Features
815 ----------------------
816
817 Seeking in files
818 Volume/Balance
819 Shuffle play
820 Repeat play
821 Playlist editor
822 Spectrum Analyzer
823 One Line mode al'a WinShade in WinAmp
824 Oscilloscope
825 Timer Elapsed/Timer Remaining
826 Plug-in system Output/Input/Effect/General/Visualization
827 Equalizer
828 Double Size option
829 WinAmp 2.0 skin support (can use wsz files)
830 GTK Requesters (with theme support)
831 Streaming/Shoutcast(1.0/1.1)/Icecast support
832 Auto remove borders if the WM has support for it
833 Fast jump in playlist
834 Scroll wheel support
835 Saves HTTP streams to HD
836 HTTP authentication
837 Plays MPEG layer 1/2/3, WAV, Ogg Vorbis
838 Compiles and works on other Unixes
839 Proxy authentication support
840
841
842 6. Obtaining BMP
843 -------------------
844
845 Currently, we only provide source tarballs at:
846
847 http://sourceforge.net/project/showfiles.php?group_id=95272
848
849 The CVS snapshots listed are not regularly updated. We encourage you
850 to download BMP straight from CVS:
851
852 cvs -z3 -d:pserver:anonymous@cvs.sf.net:/cvsroot/beepmp login
853 cvs -z3 -d:pserver:anonymous@cvs.sf.net:/cvsroot/beepmp co bmp
854
855
856
857 FIXME: add links to user made packages
858
859
860 6.1 Obtaining Skins
861 -------------------
862
863 You can find BMP/XMMS skins made by BMP/XMMS users at:
864
865 http://www.xmms.org/skins.html
866 http://themes.org/skins/xmms
867
868
869 7. Misc
870 -------
871
872 7.1. Tips and Tricks
873 -------------------
874
875 If you have a windows partition with WinAmp installed, a good idea would be to
876 set the SKINSDIR variable to that dir.
877
878 BMP features some command line options like next/previous songs, those
879 things can be binded to a key. I use AfterStep and the useless window keys
880 for this. Here is an example from my .steprc:
881
882 Key Meta_R A N Exec "bmp" beep-media-player -r
883 Key Menu A N Exec "bmp" beep-media-player -f
884
885 If you want all your mp3's in one playlist an easy way is:
886 locate .mp3 > /path/to/playlistname
887
888 (considering you have a fairly recent updatedb, don't blame us if locate don't
889 find the file you downloaded 3 minutes ago)
890
891
892 8. Bugs
893 -------
894
895 BMP is under heavy development and as such, has quite a number of
896 bugs. Our bug tracker page is maintained at:
897
898 http://www.sosdg.org/~larne/bugs/
899
900 It will continue to have bugs as we fix and introduce new ones through
901 rewriting and enhancement. Help us along by reporting new bugs, and
902 verifying existing ones.
903
904 If you have a fix for any of the bugs, please let us know using the
905 tracker or posting to our development mailing list at:
906
907 beepmp-devel@lists.sourceforge.net
908
909
910 9. Contact Email's
911 ------------------
912
913 Project Admins:
914
915 Milosz Derezynski email: mderezynski at users sourceforge net
916 Chong Kai Xiong email: descender at phreaker net
917
918 You can more information about the BMP team from this page:
919
920 http://sourceforge.net/project/memberlist.php?group_id=95272