X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=README;h=d4521bc5298122d493884d6159dde3578d9fa68c;hp=b311307d1e54177adec3b43a05c777028ca95b57;hb=e63886e85c55c99e9732e5715b7ce641eff09914;hpb=09ca53c1a6409d5a4f8a78763f2c4fb1fd4c4f6d diff --git a/README b/README index b311307d..d4521bc5 100644 --- a/README +++ b/README @@ -30,29 +30,31 @@ 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 spcifying 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) @@ -65,7 +67,7 @@ little programming effort. All connections between para_server and para_client are encrypted by default. For each user of paraslash you must create a public/secret -key pair for authentication. The (authenticated) connection is crypted +key pair for authentication. The (authenticated) connection is encrypted with a symmetric rc4 session key. -------------------- @@ -84,7 +86,7 @@ is completely independent from the rest of paraslash, so it might be useful also for different purposes. para_filter combines several decoders (mp3, oggvorbis, aac) and a -volume normalzer. New filters can be added easily due to the modular +volume normalizer 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 calling any of the read(2)/write(2)/select(2) etc. functions. @@ -94,7 +96,7 @@ para_write (obligatory) ----------------------- A modular audio stream writer. It supports a simple file writer -output plugin and optional wav/raw players for alsa (linux-only, +output plug-in and optional wav/raw players for alsa (linux-only, Debian package: libasound2-dev) and Mac OS. para_write can also be used as a stand-alone wav or raw audio player. @@ -106,7 +108,7 @@ The local daemon that collects information from para_server. It runs on the client side and connects to para_server. The audio stream is read from the network and sent through any of paraslash's filters (decoder, -volume normalizer). The resulting stream is written to an output plugin +volume normalizer). The resulting stream is written to an output plug-in (writer), e.g. the alsa writer on linux systems. It is possible to capture the stream at any position in the filter chain. @@ -135,47 +137,12 @@ 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) -------------------------- @@ -191,21 +158,14 @@ In any case you need - gcc, the gnu compiler collection (shipped with distro): gcc-3.3 or newer is required. + - gnu make (shipped with disto, might be called gmake) + - bash - 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, @@ -222,20 +182,6 @@ 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 -------