X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=README;h=0173fb3bbb60e1cf6d0c7402593238605a4b288d;hp=ef07eed52c059fa26c5b9752ff73380d330a4cd6;hb=c03bc512fc733c05292225cf878f14e41d1d59c9;hpb=9be19e7946fd413df61eca5e9a934834c5757494 diff --git a/README b/README index ef07eed5..0173fb3b 100644 --- a/README +++ b/README @@ -8,9 +8,9 @@ _Play, archive, rate and stream large audio sets happily_ It contains the following programs: ------------------------ +------------------------ para_server (obligatory) ------------------------ +------------------------ para_server streams binary audio data (mp3/oggvorbis/m4a files) over local and/or remote networks. It listens on a tcp port and @@ -30,29 +30,33 @@ or rtp. It is possible to activate more than one sender simultaneously. -para_server needs an audio file selector to work, mainly to determine -which audio file to stream next. The following three selectors are -built in: +The built-in audio file selector of paraslash is used to manage your +audio files. It maintains statistics on the usage of all available audio +files such as last played time, and the number of times each file was +selected. + +Its features include - * The random selector chooses audio files out of a given directory - by random + * attributes: Allow fine-grained audio file selection. - * The playlist selector chooses files from a specified playlist + * image table. For storage of e.g. album cover art. - * The (optional) mysql selector is more involved. It connects - to a mysql server which holds information on your audio files - and maintains statistics on the available audio files. Audio - file selection works by sending a user-defined sql-query - to the mysql server. This allows rather sophisticated - configurations and is explained in detail in README.mysql. + * lyrics table. For storage of lyrics. -It is possible to switch between all supported selectors at any time. + * playlist table. Stores arbitrary many playlists. + + * mood mode. Audio file selection works by specifying mood + methods involving attributes, pattern matching for file names + and more. This allows rather sophisticated configurations + and is explained in more detail in INSTALL. + + * rename detection. If files are moved or renamed, afs will + recognioze them despite of this change. Despite of all these features, paraslash is lightweight. The stripped binary of para_server with all its features compiled in -(mysql/random/playlist selector, mp3/ogg/aac support, http/dccp/ortp -support) is about 120K on i386 under Linux. para_audiod (see below) -is even smaller. +mp3/ogg/aac support, http/dccp/ortp support) is about 150K on i386 +under Linux. para_audiod (see below) is even smaller. ------------------------ para_client (obligatory) @@ -135,112 +139,24 @@ the obtained information in an ncurses window. para_gui provides key-bindings for the most common commands and new key-bindings can be added easily. ------------------------ -para_sdl_gui (optional) ------------------------ - -SDL-based gui. Similar to para_gui but presents its output in an X -window (fullscreen mode is also available) and can display jpg images -on a per song basis. para_sdl_gui provides an input prompt to enter -arbitrary commands. However, it can also be used non-interactively -(e.g. as a screen saver) via the -i switch. - -------------------------------------------------------------------------- -para_krell (optional, only useful in conjunction with the mysql selector) -------------------------------------------------------------------------- - -A plugin for gkrellm which shows small pictures of the current song. It -allows you to launch 27 different commands by clicking in different -areas of its picture (9 small squares x 3 mouse buttons). - -------------------- para_fade (optional) -------------------- A (Linux-only) alarm clock and volume-fader. -------------------------------------------------------------------------- -para_dbadm (optional, only useful in conjunction with the mysql selector) -------------------------------------------------------------------------- - -Very simple curses-based frontend which uses libmenu. Useful for -quickly changing the attributes of the current song (e.g. from para_gui -as an external command). - --------------------------------------------------------------------------- -para_slider (optional, only useful in conjunction with the mysql selector) --------------------------------------------------------------------------- - -A small X application which shows a scrollbar for each attribute -defined in the mysql database. It creates a stream definition from -the values of the scrollbars. This allows to smoothly change the mood -of the given stream without any file editing. - -------------------------- bash_completion (optional) -------------------------- A small bash script for inclusion in ~/.bashrc. It gives you command line completion for some paraslash commands. - ------------- -Requirements ------------- - -In any case you need - - - 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 package" - (called libssl-dev on debian systems) as well: - http://www.openssl.org/ - - software mixing, e.g. ALSA and the direct mixing plugin (dmix) - -If you want to use the mysql-based audio file selector, you also need - - - mysql-server - - mysql-client - - libmysqlclient - -These are usually shipped with the distro but probably not installed -by default. - -The mp3 decoder of para_filter is based on libmad: If you prefer to -use the libmad package provided by your distributor, make sure to -install the corresponding development package as well. Otherwise, -just download libmad from http://www.underbit.com/products/mad/ - -For ogg vorbis streams you'll need libogg, libvorbis, libvorbisfile, -The corresponding Debian packages are called libogg-dev libvorbis-dev, -other distributors chose similar names. All of these are also -available at http://www.xiph.org/downloads/ - -For aac files (m4a) you'll need libfaad. Get it at -http://www.audiocoding.com/modules/wiki/?page=AAC - -If you intend to use the optional ortp streamer, you'll need libortp: -http://www.linphone.org/ortp/ - -For the optional SDL-based gui, the following packages must be installed: - - - X (usually shipped with distro): http://www.x.org/ - - libSDL (usually shipped with distro): http://www.libsdl.org/index.php - - SDL_image: http://www.libsdl.org/projects/SDL_image/ - -For para_slider, the zero memory widget library is neccessary: -http://www710.univ-lyon1.fr/~exco/ZMW/ - -Finally, para_krell needs - - - gtk2: http://www.gtk.org/ - - gkrellm2: http://members.dslextreme.com/users/billw/gkrellm/gkrellm.html - ------- LICENSE ------- -Distribution of paraslash is covered by the GNU GPL. See file COPYING. +Distribution of paraslash is covered by the GNU GPL, version 2. See file +COPYING. ---------- THE AUTHOR