| 1 |
--------------------------------------------------------------------- |
| 2 |
MP3Blaster README |
| 3 |
--------------------------------------------------------------------- |
| 4 |
|
| 5 |
Table of Contents |
| 6 |
------------------------ |
| 7 |
|
| 8 |
1. Introduction |
| 9 |
2. Prerequisites |
| 10 |
3. Installation |
| 11 |
4. Usage |
| 12 |
5. Examples (TODO) |
| 13 |
6. Configuration |
| 14 |
7. Availability |
| 15 |
8. Bugs |
| 16 |
9. Frequently Asked Questions |
| 17 |
10. Developer Information |
| 18 |
11. Links |
| 19 |
12. Copyright |
| 20 |
|
| 21 |
|
| 22 |
|
| 23 |
1. Introduction |
| 24 |
------------------------- |
| 25 |
|
| 26 |
MP3Blaster is a text console based program for playing mainly mp3 audio |
| 27 |
files. It is very interactive, and has a great list of features. Its |
| 28 |
playlist can be divided in albums or categories (called 'groups'), which |
| 29 |
allows for very sophisticated playback orders. |
| 30 |
|
| 31 |
2. Prerequisites |
| 32 |
------------------------- |
| 33 |
|
| 34 |
- One of the following Operating Systems is currently supported: |
| 35 |
|
| 36 |
FreeBSD, Linux, NetBSD, OpenBSD. |
| 37 |
|
| 38 |
It should be trivial to port MP3Blaster to other UNIX-like |
| 39 |
Operating Systems. |
| 40 |
|
| 41 |
- A soundcard. Although 8-bit soundcards, and those that are limited |
| 42 |
to 22 Khz playback will work, a 44Khz capable 16 bits soundcard |
| 43 |
(as all new cards are) is recommended. |
| 44 |
|
| 45 |
- Threads. Most Operating Systems have a pthreads implementation. If |
| 46 |
yours doesn't, you can use libpth instead (see section Links for |
| 47 |
the URL) by conifuring with an extra flag '--with-pth'. |
| 48 |
|
| 49 |
3. Installation |
| 50 |
------------------------- |
| 51 |
|
| 52 |
If you're eager to start, this will do: |
| 53 |
./configure |
| 54 |
make |
| 55 |
make install |
| 56 |
|
| 57 |
Run './configure --help' to get a list of compile-time options. |
| 58 |
There are a few important options that can have an impact on the |
| 59 |
quality of audio-playback and CPU usage on your system. These are: |
| 60 |
|
| 61 |
--enable-newthreads (auto-enables --with-pth) |
| 62 |
This will use an alternative playback buffering system. It |
| 63 |
might work better than the conventional buffering system on many |
| 64 |
systems. Please give it a try if you're experiencing skips |
| 65 |
during sound playback. Mail problems / successes. |
| 66 |
|
| 67 |
--with-pth (without --enable-newthreads) |
| 68 |
Uses libpth instead of the OS-specific pthreads implementation. |
| 69 |
This might reduce CPU-overhead and improve sound playback. |
| 70 |
Please try this and reports problems / successes. |
| 71 |
|
| 72 |
If you don't supply any of the above mentioned flags, the |
| 73 |
OS-specific pthreads implementation will be used, with default |
| 74 |
buffering mechanism. On FreeBSD no buffering will be used by default |
| 75 |
since it will probably hog your CPU or simply hang. using libpth on |
| 76 |
Free(/Net/Open)BSD is therefor recommended. |
| 77 |
|
| 78 |
4. Usage |
| 79 |
------------------------- |
| 80 |
|
| 81 |
Read the MP3Blaster manpage (man mp3blaster or man -lmp3blaster.1 from |
| 82 |
source) for information about commandline parameters, config files, |
| 83 |
usage, etc. Read the next section for some examples |
| 84 |
|
| 85 |
|
| 86 |
5. Examples |
| 87 |
------------------------- |
| 88 |
|
| 89 |
MP3Blaster's defaults should be good for most systems. Most keybindings |
| 90 |
can be reconfigured easily using a config file. |
| 91 |
|
| 92 |
A simple way to play a lot of mp3's from the command line in random |
| 93 |
order: |
| 94 |
|
| 95 |
mp3blaster -p allrandom /my/mp3s/*.mp3 |
| 96 |
|
| 97 |
Load a playlist and start playing immediately: |
| 98 |
|
| 99 |
mp3blaster -a /my/playlists/coolsongs.lst |
| 100 |
|
| 101 |
Use mp3blaster with an old, 8 bit soundcard that can do 22Khz sampling: |
| 102 |
|
| 103 |
mp3blaster -28 |
| 104 |
|
| 105 |
|
| 106 |
6. Configuration |
| 107 |
------------------------- |
| 108 |
|
| 109 |
For an example configuration file, see or copy doc/sample.mp3blasterrc* |
| 110 |
to ~/.mp3blasterrc and modify to tastes. The man page has information on |
| 111 |
all available settings possible in the file. |
| 112 |
|
| 113 |
|
| 114 |
7. Availability |
| 115 |
------------------------- |
| 116 |
|
| 117 |
MP3Blaster can be downloaded from: |
| 118 |
|
| 119 |
http://mp3blaster.sourceforge.net/ |
| 120 |
|
| 121 |
8. Bugs |
| 122 |
------------------------- |
| 123 |
|
| 124 |
None. MP3Blaster happens to be fully bug-free. If you find a bug, it's |
| 125 |
probably a real life one buzzing around your head. |
| 126 |
|
| 127 |
If you believed that, and you run a nice IT company, please contact me |
| 128 |
;-) |
| 129 |
Otherwise, read the "TODO" and "ChangeLog" files for known bugs, or |
| 130 |
features on the drawing board. If you find any bugs, please report |
| 131 |
them (see section 'Developer Information') |
| 132 |
|
| 133 |
9. Frequently Asked Questions |
| 134 |
---------------------------------- |
| 135 |
|
| 136 |
Read the "FAQ" on the sourceforge project page. |
| 137 |
|
| 138 |
10. Developer Information |
| 139 |
---------------------------------- |
| 140 |
|
| 141 |
All code used by and written for MP3Blaster is GPL'd. Read the "COPYING" |
| 142 |
file for more information about the GPL license. |
| 143 |
If you want to report bugs, ask development-related questions, or just |
| 144 |
want a taste of celebrity, surf to the sourceforge project page. |
| 145 |
|
| 146 |
11. Links |
| 147 |
---------------------------------- |
| 148 |
|
| 149 |
MP3Blaster http://mp3blaster.sourceforge.net/ |
| 150 |
libpth http://www.gnu.org/software/pth/pth.html |
| 151 |
|
| 152 |
|
| 153 |
12. Copyright |
| 154 |
---------------------------------- |
| 155 |
|
| 156 |
All code used by and written for MP3Blaster is GPL'd. Read the "COPYING" |
| 157 |
file for more information about the GPL license. |