From df108afe352a4f0e8d67510f923878e954714c94 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Thu, 13 Apr 2006 15:10:55 +0000 Subject: update documentation for release 0.8 git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@699 fefdeb5f-60dc-0310-8127-8f9354f1896f --- doc/README.html.in | 65 ++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 43 insertions(+), 22 deletions(-) (limited to 'doc/README.html.in') diff --git a/doc/README.html.in b/doc/README.html.in index eb57fdb7..dbf85411 100644 --- a/doc/README.html.in +++ b/doc/README.html.in @@ -10,13 +10,13 @@

polypaudio @PACKAGE_VERSION@

License
News
Overview
Status
Current Status
Documentation
Requirements
Installation

News

Thu Apr 13 2006:

Version 0.8 released; +changes include: too many to count; many, many minor fixes.

Sun Nov 21 2004:

Version 0.7 released; changes include: IPv6 support; PID file support; publish credentials @@ -92,13 +96,12 @@ href="@PACKAGE_URL@polypaudio-0.1.tar.gz">Version 0.1 released

Overview

polypaudio is a sound server for Linux and other Unix like -operating systems. It is intended to be an improved drop-in +

polypaudio is a networked sound server for Linux and other +Unix like operating systems. It is intended to be an improved drop-in replacement for the Enlightened Sound -Daemon (ESOUND). It is my ultimate ambition to get Polypaudio into -Gnome as a replacement for ESOUND. In -addition to the features ESOUND provides polypaudio has:

polypaudio

Extensible plugin architecture (by loading dynamic loadable modules with dlopen())

polypaudio

Flexible, implicit sample type conversion and resampling
"Zero-Copy" architecture
Module autoloading
Very accurate latency measurement for playback and recordin.
Very accurate latency measurement for playback and recording.
May be used to combine multiple sound cards to one (with sample rate adjustment)
Client side latency interpolation
Ability to fully synchronize multiple playback streams

Both the core and the client API are completely asynchronous making @@ -129,19 +133,25 @@ available. A simple main loop implementation is available as well.

module-oss: driver for Open Sound System audio sinks and sources.
module-oss-mmap: same as above, but uses mmap() access to the audio buffer. Not as compatible
module-alsa-sink, module-alsa-source: drivers for ALSA sinks and sources
module-solaris: drivers for Solaris audio sinks and sources
module-waveout: drivers for Microsoft Windows audio sinks and sources
module-pipe-sink, module-pipe-source: demonstration module providing UNIX fifos backed sinks/sources
module-combine: combine multiple sinks into one.
module-sine: a sine generate sink input.
module-x11-bell: play a sample from the sample cache on every X11 bell event.
module-x11-publish: store Polypaudio credentials in the X11 root window.
module-esound-protocol-tcp, module-esound-protocol-tcp6, module-esound-protocol-unix: ESOUND compatibility modules (for TCP/IPv6 resp. TCP/IPv6 resp. UNIX domain sockets)
module-native-protocol-tcp, module-native-protocol-tcp6, module-native-protocol-unix: Native polypaudio protocol (for TCP/IPv4 resp. TCP/IPv6 resp. UNIX domain sockets)
module-simple-protocol-tcp, module-simple-protocol-tcp6, module-simple-protocol-unix: Simplistic protocol for playback/capture for usage with tools like netcat (for TCP/IP resp. UNIX domain sockets)
module-cli-protocol-tcp, module-cli-protocol-tcp6, module-cli-protocol-unix, module-cli: Expose polypaudio's internals whith a simple command line interface. (for TCP/IP resp. UNIX domain sockets resp. STDIN/STDOUT)
module-esound-protocol-tcp, module-esound-protocol-unix: ESOUND compatibility modules (for TCP/IP resp. UNIX domain sockets)
module-native-protocol-tcp, module-native-protocol-unix: Native polypaudio protocol (for TCP/IP resp. UNIX domain sockets)
module-simple-protocol-tcp, module-simple-protocol-unix: Simplistic protocol for playback/capture for usage with tools like netcat (for TCP/IP resp. UNIX domain sockets)
module-cli-protocol-tcp, module-cli-protocol-unix, module-cli: Expose polypaudio's internals whith a simple command line interface. (for TCP/IP resp. UNIX domain sockets resp. STDIN/STDOUT)
module-tunnel-sink, module-tunnel-source: make sinks/sources from other hosts available locally.
module-match: adjust volume automatically for newly created playback streams based on a regular expression matching table.
module-null-sink: a clocked sink similar to /dev/null.
module-esound-sink: a sink for forwarding audio data to an ESOUND server.
module-detect: a module which automatically detects what sound hardware is available locally and which loads the required driver modules.
module-lirc: a module to control the volume of a sink with infrared remote controls supported by LIRC.
module-mmkbd-evdev: a module to control the volume of a sink with the special volume keys of a multimeda keyboard.
module-zeroconf-publish: a module to publish local sources/sinks using mDNS zeroconf.

polypaudio is the successor of my previous, ill-fated @@ -165,7 +175,7 @@ href="http://xine.sf.net/">Xine (merged in Xine CVS). Drivers for PortAudio will be released shortly.

Status

Current Status

Version @PACKAGE_VERSION@ is quite usable. It matches and supersedes ESOUND's feature set in nearly all areas.

@@ -178,7 +188,11 @@ release to release. The client API's library version number is currently fixed t

There is some preliminary documentation available: modules.html, cli.html, daemon.html, FAQ.html, .

+href="daemon.html">daemon.html and FAQ.html.

+ +

There is a Trac based Wiki for Polypaudio available.

+ +

First Steps

@@ -231,7 +245,7 @@ questions.

Requirements

Currently, polypaudio is tested on Linux and FreeBSD only. It requires an OSS or ALSA compatible soundcard.

Currently, polypaudio is tested on Linux, FreeBSD, Solaris and Microsoft Windows. It requires an OSS, ALSA, Win32 or Solaris compatible soundcard.

polypaudio was developed and tested on Debian GNU/Linux "testing" from November 2004, it should work on most other Linux @@ -239,11 +253,16 @@ distributions (and maybe Unix versions) since it uses GNU autoconf and GNU libtool for source code configuration and shared library management.

polypaudio needs libwrap, polypaudio needs Secret Rabbit Code (aka libsamplerate), libsndfile, alsa-lib and liboil.

+ +

Optionally it can make use of libwrap, alsa-lib, libasyncns, +lirc, HOWL (or preferably the compatibility layer included in its superior replacement Avahi) and GLIB. (The latter is required for building the GLIB main loop integration module only.)

@@ -271,18 +290,20 @@ compilation and make install (as root) for installation of

The current release is @PACKAGE_VERSION@

Get polypaudio's development sources from the Subversion repository (viewcvs):

svn checkout svn://seth.intheinter.net/polypaudio/trunk polypaudio

svn checkout svn://0pointer.de/polypaudio/trunk polypaudio

If you want to be notified whenever I release a new version of this software use the subscription feature of Freshmeat.

New! There is a general discussion mailing list for polypaudio available.

There is a general discussion mailing list for polypaudio available. In addition, you can subscribe to SVN changes and Trac Tickets.

+ +

There is a Trac based Wiki for Polypaudio available.

New! There is now a Polypaudio wiki (based on trac) available.

Please report bugs to our Trac ticket system.

Lennart Poettering <@PACKAGE_BUGREPORT@>, November 2004

Lennart Poettering <@PACKAGE_BUGREPORT@>, April 2006

$Id$

-- cgit