
                                polypaudio 0.7

   Copyright 2004 Lennart Poettering <mzcbylcnhqvb (at) 0pointer (dot)
   de>
     * [1]License
     * [2]News
     * [3]Overview
     * [4]Status
     * [5]Documentation
     * [6]Requirements
     * [7]Installation
     * [8]Acknowledgements
     * [9]Download

License

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU Lesser General Public License as
   published by the Free Software Foundation; either version 2 of the
   License, or (at your option) any later version.

   This program is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with this program; if not, write to the Free Software
   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

News

   Sun Nov 21 2004:

   [10]Version 0.7 released; changes include: IPv6 support; PID file
   support; publish credentials in X11 root window (module-x11-publish;
   new tool pacmd; ESOUND backend; new command load-sample-dir-lazy;
   many, many minor fixes.

   Thu Oct 28 2004:

   [11]Version 0.6 released; changes include: TCP wrappers support; don't
   load the complete sound file into memory when playing back using
   pa_play_file(); autoload API change; don't load all sound files as
   FLOAT32; shorten default buffers; client-side latency interpolation;
   add new user volume metrics; add module-tunnel, module-null-sink,
   module-match and new tool paplay; new API version macros; many client
   API improvements; correctly lock cookie file generation; correctly
   lock daemon autospawning; print daemon layout to STDERR on SIGHUP; new
   options for pacat: allow sample type specification.

   Mon Sep 24 2004:

   [12]Version 0.5.1 released; changes include: improve esound protocol
   compatibility; fix autospawning via libesd; make use of POSIX
   capabilities; allow SCHED_FIFO scheduling only for users in group
   realtime; minor build system fix.

   Mon Sep 20 2004:

   [13]Version 0.5 released; changes include: extensive API improvements,
   new module module-combine for combining multiple sound cards into one,
   gcc 2.95 compatibility, configuration files, add "lazy" samples,
   support for source and network latency measurements, add
   module-pipe-source, many other fixes and improvements.

   Wed Sep 8 2004:

   [14]Version 0.4 released; changes include: daemon auto spawning,
   support for SCHED_FIFO scheduling, three new modules, proper logging,
   CPU load watchdog, many fixes.

   Fri Aug 27 2004:

   [15]Version 0.3 released; changes include: support for both glib 2.0
   and glib 1.2, future cancellation, API updates, many fixes, relicense
   client library to LGPL.

   Fri Aug 20 2004:

   [16]Version 0.2 released; changes include: added sample cache,
   introspection API, client API documentation, module autoloading, glib
   support, a module for intercepting X11 bell events, and much more.

   Sat Jul 17 2004:

   [17]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 replacement for the
   [18]Enlightened Sound Daemon (ESOUND). It is my ultimate ambition to
   get Polypaudio into [19]Gnome as a replacement for ESOUND. In addition
   to the features ESOUND provides polypaudio has:
     * Extensible plugin architecture (by loading dynamic loadable
       modules with dlopen())
     * Support for more than one sink/source
     * Better low latency behaviour
     * Embedabble into other software (the core is available as C
       library)
     * Completely asynchronous C API
     * Simple command line interface for reconfiguring the daemon while
       running
     * Flexible, implicit sample type conversion and resampling
     * "Zero-Copy" architecture
     * Module autoloading
     * Very accurate latency measurement for playback and recordin.
     * May be used to combine multiple sound cards to one (with sample
       rate adjustment)
     * Client side latency interpolation

   Both the core and the client API are completely asynchronous making
   use of a simple main loop abstraction layer. This allows easy
   integration with asynchronous applications using the glib/gtk
   mainloop. Since the asynchronous API available through polyplib is
   quite difficult to use there is a simplified synchronous API wrapper
   polyplib-simple available. A simple main loop implementation is
   available as well.

   The following modules are currently available:
     * 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-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-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.

   polypaudio is the successor of my previous, ill-fated attempt to write
   a sound server, [20]asd.

   A GTK GUI manager application for polypaudio is the [21]Polypaudio
   Manager. Another GTK GUI tool for Polypaudio is the [22]Polypaudio
   Volume Meter.

   There are output plugins for [23]XMMS, [24]libao (merged in libao SVN)
   and [25]gstreamer (merged in gstreamer-plugins CVS), [26]MPlayer
   (merged in MPlayer CVS) and [27]Xine (merged in Xine CVS). Drivers for
   [28]PortAudio will be released shortly.

Status

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

   Warning: polypaudio's client API and protocol are not stable yet. The
   client interface is still a moving target and changes from release to
   release. The client API's library version number is currently fixed to
   0.0.0.

Documentation

   There is some preliminary documentation available: [29]modules.html,
   [30]cli.html, [31]daemon.html, [32]FAQ.html, .

  First Steps

   Simply start the polypaudio daemon with the argument -nC
polypaudio -nC

   This will present you a screen like this:
Welcome to polypaudio! Use "help" for usage information.
>>>

   Now you can issue CLI commands as described in [33]cli.html. Another
   way to start polypaudio is by specifying a configuration script like
   that one included in the distribution on the command line :
polypaudio -nF polypaudio.pa

   This will load some drivers and protocols automatically.

   The best idea is to configure your daemon in
   /etc/polypaudio/daemon.conf and /etc/polypaudio/default.pa and to run
   polypaudio without any arguments.

   Beware! Unless you pass the option --sysconfdir=/etc to configure, the
   directory /etc/polypaudio/ is really /usr/local/etc/polypaudio/.

  Developing polypaudio Clients

   You may browse the [34]Doxygen generated [35]programing documentation
   for the client API. (Run make doxygen to generate this documentation
   from the source tree)

  Developing polypaudio Modules

   There are several reasons for writing loadable modules for polypaudio:
     * Device driver support in addition to ALSA/OSS
     * Protocol support beyond ESOUND's protocol and the native protocol.
       (such as NAS or a subset of aRts)
     * New programming interfaces such as XMLRPC or DBUS for controlling
       the daemon.
     * Hooking audio event sources directly into polypaudio (similar to
       module-x11-bell)
     * For low latency applications such as VOIP: load the VOIP core
       directly into polypaudio and have a slim GUI frontend to control
       it.

   There is currently no documentation how to write loadable modules for
   polypaudio. Read the source, Luke! If you are interested in writing
   new modules feel free to contact the author in case you have any
   questions.

Requirements

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

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

   polypaudio needs libwrap, [36]Secret Rabbit Code (aka libsamplerate),
   [37]libsndfile, [38]alsa-lib and [39]GLIB. (The latter is required for
   building the GLIB main loop integration module only.)

Installation

   As this package is made with the GNU autotools you should run
   ./configure inside the distribution directory for configuring the
   source tree. After that you should run make for compilation and make
   install (as root) for installation of polypaudio.

Acknowledgements

   Eric B. Mitchell for writing ESOUND

   Jeff Waugh for creating Ubuntu packages (and hopefully soon Debian)

   Miguel Freitas for writing a Polypaudio driver for Xine

   Joe Marcus Clarke for porting Polypaudio to FreeBSD

Download

   The newest release is always available from
   [40]http://0pointer.de/lennart/projects/polypaudio/

   The current release is [41]0.7

   Get polypaudio's development sources from the [42]Subversion
   [43]repository ([44]viewcvs):
svn checkout svn://seth.intheinter.net/polypaudio/trunk polypaudio

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

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

   New! There is now a [47]Polypaudio wiki (based on [48]trac) available.
     _________________________________________________________________


    Lennart Poettering <mzcbylcnhqvb (at) 0pointer (dot) de>, November
    2004

   $Id: README.html.in 310 2004-11-21 22:07:47Z lennart $

References

   1. README#license
   2. README#news
   3. README#overview
   4. README#status
   5. README#documentation
   6. README#requirements
   7. README#installation
   8. README#acks
   9. README#download
  10. http://0pointer.de/lennart/projects/polypaudio/polypaudio-0.7.tar.gz
  11. http://0pointer.de/lennart/projects/polypaudio/polypaudio-0.6.tar.gz
  12. http://0pointer.de/lennart/projects/polypaudio/polypaudio-0.5.1.tar.gz
  13. http://0pointer.de/lennart/projects/polypaudio/polypaudio-0.5.tar.gz
  14. http://0pointer.de/lennart/projects/polypaudio/polypaudio-0.4.tar.gz
  15. http://0pointer.de/lennart/projects/polypaudio/polypaudio-0.3.tar.gz
  16. http://0pointer.de/lennart/projects/polypaudio/polypaudio-0.2.tar.gz
  17. http://0pointer.de/lennart/projects/polypaudio/polypaudio-0.1.tar.gz
  18. http://www.tux.org/~ricdude/apps.html
  19. http://www.gnome.org/
  20. http://asd.sf.net/
  21. http://0pointer.de/lennart/projects/paman/
  22. http://0pointer.de/lennart/projects/pavumeter
  23. http://0pointer.de/lennart/projects/xmms-polyp/
  24. http://0pointer.de/lennart/projects/libao-polyp/
  25. http://0pointer.de/lennart/projects/gst-polyp/
  26. http://mplayerhq.hu/
  27. http://xine.sf.net/
  28. http://www.portaudio.com/
  29. file://localhost/home/lennart/projects/polypaudio/doc/modules.html
  30. file://localhost/home/lennart/projects/polypaudio/doc/cli.html
  31. file://localhost/home/lennart/projects/polypaudio/doc/daemon.html
  32. file://localhost/home/lennart/projects/polypaudio/doc/FAQ.html
  33. file://localhost/home/lennart/projects/polypaudio/doc/cli.html
  34. http://www.doxygen.org/
  35. http://0pointer.de/lennart/projects/polypaudio/doxygen/
  36. http://www.mega-nerd.com/SRC/
  37. http://www.mega-nerd.com/libsndfile
  38. http://www.alsa-project.org/
  39. http://www.gtk.org/
  40. http://0pointer.de/lennart/projects/polypaudio/
  41. http://0pointer.de/lennart/projects/polypaudio/polypaudio-0.7.tar.gz
  42. http://subversion.tigris.org/
  43. svn://seth.intheinter.net/polypaudio
  44. http://0pointer.de/cgi-bin/viewcvs.cgi/?root=polypaudio
  45. http://freshmeat.net/projects/polypaudio/
  46. https://seth.intheinter.net/mailman/listinfo/polypaudio-discuss
  47. http://0pointer.de/trac/polypaudio/
  48. http://www.edgewall.com/products/trac/
