X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=README;h=017bc0c31d71e4d984783d5d0a6a2e3a46a2fc14;hp=61ebeca37b16ca25d99eeae33feecfd6fedc3a0b;hb=db34194eaab9819772bd55ea1ab08c719ed8f1c8;hpb=9091f57db37adb226c3798bf7d53b94b03c171d6 diff --git a/README b/README index 61ebeca3..017bc0c3 100644 --- a/README +++ b/README @@ -8,11 +8,12 @@ It contains the following programs: - para_server (obligatory): - This server listens on a tcp port and accepts commands such as - play, stop, pause, next from authenticated clients. + This server supports audio streaming of mp3, ogg vorbis and + aac files. It listens on a tcp port and accepts commands + such as play, stop, pause, next from authenticated clients. - For audio streaming, at least one of the three supported senders - of para_server must be activated: + The audio stream may be sent over the network by three + different senders: The http sender is recommended for public streams that can be played by any player like mpg123, xmms, winamp... @@ -24,8 +25,6 @@ It contains the following programs: private streams that require authentication. It is possible to activate more than one sender simultaneously. - All senders have the same set of commands that allow to - control the access permissions of the stream. para_server needs an "audio file selector" to work, mainly to determine which song to stream next. There are three @@ -51,7 +50,7 @@ It contains the following programs: stdout. This one is independent from the rest of paraslash, so it might be useful also for different purposes. - para_filter combines an mp3 decoder an oggvorbis decoder + para_filter combines several decoders (mp3, oggvorbis, aac) and a volume normalzer. New filters can be added easily due to the modular design. If more than one filter is specified, the given filters are 'piped' together in-memory, i.e. without @@ -131,8 +130,8 @@ REQUIREMENTS: ~~~~~~~~~~~~~ In any case you need - - gcc, the gnu compiler collection (shipped with distro): gcc-3 - or newer is prefered, but gcc-2.95 might still work. + - gcc, the gnu compiler collection (shipped with distro): gcc-3.3 + or newer is required. - openssl (needed by server, client): usually shipped with distro, but you might have to install the "development" @@ -161,15 +160,19 @@ make sure to install the corresponding development package as well. If you want to stream ogg vorbis files you'll need: - libogg, libvorbis, libvorbisfile, and a command line ogg vorbis - decoder, e.g. para_filter or ogg123. + decoder, e.g. para_filter or ogg123. http://www.xiph.org/downloads/ Debian packages: libogg-dev libvorbis-dev -Note that para_audiod still works even if neither mp3 nor ogg support -was compiled in. You'll have to use the --no_default_filters option -in this case (and e.g. "mpg123 -" as the stream write command). +For aac files (m4a) you'll need libfaad. Get it at + + http://www.audiocoding.com/modules/wiki/?page=AAC + +Note that para_audiod still works even if no audio file support was +compiled in. You'll have to use the --no_default_filters option in this +case (and e.g. "mpg123 -" as the stream write command for mp3 streams). If you intend to use the optional ortp streamer: @@ -210,12 +213,6 @@ LICENSE: ~~~~~~~~ Distribution of paraslash is covered by the GNU GPL. See file COPYING. -LIMITATIONS: -~~~~~~~~~~~~ -The mysql selector assumes that the basenames of your audio files are -unique. If this is not the case, don't use this selector, rename your -files, or create your own one. - THE AUTHOR: ~~~~~~~~~~~ Author: Andre Noll