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