From 7b8c329578d642d31618d487b97864306c43073c Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Sat, 17 Jul 2004 14:06:13 +0000 Subject: add documentation git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@86 fefdeb5f-60dc-0310-8127-8f9354f1896f --- LICENSE | 340 +++++++++++++++++++++++++++++++++++++++++++++ Makefile.am | 21 ++- configure.ac | 21 ++- doc/Makefile.am | 39 ++++++ doc/README.html.in | 133 ++++++++++++++++++ doc/cli.html.in | 152 ++++++++++++++++++++ doc/daemon.html.in | 51 +++++++ doc/modules.html.in | 191 +++++++++++++++++++++++++ doc/style.css | 34 +++++ src/Makefile.am | 1 - src/modargs.c | 6 +- src/module-protocol-stub.c | 2 +- src/todo | 1 - 13 files changed, 985 insertions(+), 7 deletions(-) create mode 100644 LICENSE create mode 100644 doc/Makefile.am create mode 100644 doc/README.html.in create mode 100644 doc/cli.html.in create mode 100644 doc/daemon.html.in create mode 100644 doc/modules.html.in create mode 100644 doc/style.css diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..d60c31a9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,340 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General +Public License instead of this License. diff --git a/Makefile.am b/Makefile.am index dc7024a4..43009b44 100644 --- a/Makefile.am +++ b/Makefile.am @@ -17,11 +17,28 @@ # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 # USA. -EXTRA_DIST = bootstrap.sh -SUBDIRS=src +EXTRA_DIST = bootstrap.sh README LICENSE +SUBDIRS=src doc + +MAINTAINERCLEANFILES=README +noinst_DATA = README pkgconfigdir = $(libdir)/pkgconfig pkgconfig_DATA = polyplib.pc polyplib-simple.pc polyplib-error.pc polyplib-mainloop.pc +README: + rm -f README + $(MAKE) -C doc README + cd $(srcdir) && ln -s doc/README README + +homepage: all dist + test -d $$HOME/homepage/private + mkdir -p $$HOME/homepage/private/projects/polypaudio + cp *.tar.gz $$HOME/homepage/private/projects/polypaudio + cp doc/README.html doc/cli.html doc/daemon.html doc/modules.html doc/style.css doc/NEWS $$HOME/homepage/private/projects/polypaudio + cp $$HOME/homepage/private/projects/polypaudio/README.html $$HOME/homepage/private/projects/polypaudio/index.html + distcleancheck: @: + +.PHONY: homepage distcleancheck diff --git a/configure.ac b/configure.ac index e73cb033..86398f4d 100644 --- a/configure.ac +++ b/configure.ac @@ -55,7 +55,26 @@ if test "x$GCC" = "xyes" ; then CFLAGS="$CFLAGS -pipe -Wall -W -Wno-unused-parameter" fi +# LYNX documentation generation +AC_ARG_ENABLE(lynx, + AS_HELP_STRING(--disable-lynx,Turn off lynx usage for documentation generation), +[case "${enableval}" in + yes) lynx=yes ;; + no) lynx=no ;; + *) AC_MSG_ERROR(bad value ${enableval} for --disable-lynx) ;; +esac],[lynx=yes]) + +if test x$lynx = xyes ; then + AC_CHECK_PROG(have_lynx, lynx, yes, no) + + if test x$have_lynx = xno ; then + AC_MSG_ERROR([*** Sorry, you have to install lynx or use --disable-lynx ***]) + fi +fi + +AM_CONDITIONAL([USE_LYNX], [test "x$lynx" = xyes]) + AM_CONDITIONAL(BUILD_LIBPOLYPCORE, false) -AC_CONFIG_FILES([Makefile src/Makefile polyplib.pc polyplib-simple.pc polyplib-mainloop.pc polyplib-error.pc]) +AC_CONFIG_FILES([Makefile src/Makefile polyplib.pc polyplib-simple.pc polyplib-mainloop.pc polyplib-error.pc doc/Makefile doc/README.html doc/cli.html doc/daemon.html doc/modules.html]) AC_OUTPUT diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 00000000..015d503d --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,39 @@ +# $Id$ + +# This file is part of polypaudio. +# +# polypaudio is free software; you can redistribute it and/or modify it +# under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# polypaudio 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 +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with polypaudio; if not, write to the Free Software Foundation, +# Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. + +noinst_DATA = README.html cli.html modules.html daemon.html README +EXTRA_DIST = $(noinst_DATA) style.css README.html.in cli.html.in modules.html.in daemon.html.in + +MAINTAINERCLEANFILES = README README.html cli.html modules.html daemon.html +CLEANFILES = + +if USE_LYNX +README: README.html + lynx --dump $^ | sed 's,file://localhost/.*/doc/README.html,README,' > $@ + +CLEANFILES += README +endif + +tidy: README.html cli.html modules.html daemon.html + tidy -e < README.html + tidy -e < cli.html + tidy -e < modules.html + tidy -e < daemon.html + +.PHONY: tidy + diff --git a/doc/README.html.in b/doc/README.html.in new file mode 100644 index 00000000..a9b07d60 --- /dev/null +++ b/doc/README.html.in @@ -0,0 +1,133 @@ + + + + + +polypaudio @PACKAGE_VERSION@ + + + + +

polypaudio @PACKAGE_VERSION@

+ +

Copyright 2002-2004 Lennart Poettering <@PACKAGE_BUGREPORT@>

+ + + +

License

+ +

This program is free software; you can redistribute it and/or +modify it under the terms of the GNU 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 +General Public License for more details.

+ +

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

+ +

News

+ + +
Sat Jul 17 2004:

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 Enlightened Sound +Daemon (ESOUND). In addition to the features ESOUND provides +polypaudio has:

+ +
    +
  • Extensible plugin architecture (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
    • +
+ +

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.

+ +

Status

+ +

Version @PACKAGE_VERSION@ is quite usable. polypaudio does +not yet match all ESOUND features: currently a sample cache and +automatic releasing of unused sound drivers are missing. Have a look on the more extensive TODO list.

+ +

Documentation

+ +

There is some prelimenary documentation available: modules.html, cli.html, daemeon.html.

+ +

Documentation for developing with polypaudio is not yet +available. Read the source, Luke!

+ +

Requirements

+ +

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

+ +

polypaudio was developed and tested on Debian GNU/Linux +"testing" from July 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 Secret Rabbit Code (aka libsamplerate) and alsa-lib.

+ +

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

+ +

Download

+ +

The newest release is always available from @PACKAGE_URL@

+ +

The current release is @PACKAGE_VERSION@

+ +

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

+ +

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

+ +
+
Lennart Poettering <@PACKAGE_BUGREPORT@>, July 2004
+
$Id$
+ + + diff --git a/doc/cli.html.in b/doc/cli.html.in new file mode 100644 index 00000000..c67d78db --- /dev/null +++ b/doc/cli.html.in @@ -0,0 +1,152 @@ + + + + +polypaudio: Simple Command Line Language + + + + +

Simple Command Line Language

+ +

polypaudio provides a simple command line language used by +configuration scripts as well as the modules module-cli +and module-cli-protocol-{unix,tcp}. Empty lines and lines +beginning with a hashmark (#) are silently ignored. Several +commands are supported:

+ +

Miscellaneous Commands

+ +

help

+ +

Show a quick help on the commands available.

+ +

exit

+ +

Terminate the daemon. If you want to terminate a CLI connection +("log out") you might want to use C-d.

+ +

Status Commands

+ +

modules

+ +

Show all currently loaded modules with their arguments.

+ +

sinks/sources

+ +

Show all currently registered sinks (resp. sources).

+ +

clients

+ +

Show all currently active clients.

+ +

sink_inputs/sink_outputs

+ +

Show all currently active inputs to sinks (resp. outputs of sources).

+ +

stat

+ +

Show some simple statistics about the allocated memory blocks and +the space used by them.

+ +

info

+ +

A combination of all status commands described above. ls +and list are synonyms for info.

+ +

Module Management

+ +

load

+ +

Load a module specified by its name and arguments. For most modules +it is OK to be loaded more than once.

+ +

unload

+ +

Unload a module specified by its index in the module list as +returned by modules.

+ +

Configuration Commands

+ +

sink_volume

+ +

Set the volume of the specified sink. You may specify the sink either +by its index in the sink list or by its name. The volume should be an +integer value greater or equal than 0 (= muted). Volume 256 +(0x100) is normal volume, values greater than this amplify +the audio signal with clipping.

+ +

sink_input_volume

+ +

Set the volume of a sink input specified by its index the the sink +input list. The same volume rules apply as with sink_volume.

+ +

sink_default/source_default

+ +

Make a sink (resp. source) the default. You may specify the sink +(resp. ssource) by its index in the sink (resp. source) list or by its +name.

+ +

Killing clients/streams

+ +

kill_client

+ +

Remove a client forcibly from the server. There is no protection that +the client reconnects immediately.

+ +

kill_sink_input/kill_source_output

+ +

Remove a sink input (resp. source output) forcibly from the +server. This will not remove the owning client or any other streams +opened by the client from the server.

+ +

Meta Commands

+ +

In addition the the commands described above there a few meta +directives supported by the command line interpreter:

+ +

.include

+ +

Executes the commands from the specified script file.

+ +

.fail/.nofail

+ +

Enable (resp. disable) that following failing commands will cancel +the execution of the current script file. This is a ignored when used +on the interactive command line.

+ +

.verbose/.noverbose

+

Enable (resp. disable) extra verbosity.

+ +

Example Configuration Script

+ +
+#!/usr/bin/polaudio -F
+
+# Load audio drivers
+load module-alsa-sink device=plughw:0,0 rate=48000
+load module-alsa-source device=hw:1,0
+
+# Load several protocols
+load module-esound-protocol-tcp
+load module-simple-protocol-tcp
+load module-native-protocol-unix
+load module-cli-protocol-unix
+
+# Load the CLI module (This is similar to passing "-C" on the command line of polypaudio)
+load module-cli
+
+.nofail
+
+# Make some devices default
+sink_default alsa_output
+source_default alsa_input
+
+# Use digital amplification
+sink_volume alsa_output 0x200
+
+ +
+
Lennart Poettering <@PACKAGE_BUGREPORT@>, July 2004
+
$Id$
+ diff --git a/doc/daemon.html.in b/doc/daemon.html.in new file mode 100644 index 00000000..a5d933db --- /dev/null +++ b/doc/daemon.html.in @@ -0,0 +1,51 @@ + + + + +polypaudio: Daemon + + + + +

Daemon

+ +

Command Line Arguments

+ +The polypaudio daemon accepts several command line arguments: + +

-L MODULE: Load the specified module. This option may be specified more than once.

+

-F FILE: Run the specified script. This option may be specified more than once.

+

-C: Load the module module-cli after startup.

+

-D: Daemonize after successfully executing all scripts and loading all modules.

+

-f: Unless this option is given the daemon will terminate if any of the specified modules failed to load or the script didn't execute successfully.

+

-v: Increase the verbosity of the daemon.

+

-h: Show a quick help.

+ +

Example

+ +

It is a good idea to run the daemon like this:

+ +
polypaudio -D -F /etc/polypaudio/polypaudio.pa
+ +

/etc/polypaudio/polypaudio.pa should be a script written in the CLI language described in cli.html + +

Signals

+ +

The following signals are trapped specially:

+ +

SIGINT

+ +

The daemon is shut down cleanly.

+ +

SIGUSR1

+ +

The daemon tries to load the module module-cli, effectively providing a command line interface on the calling TTY.

+ +

SIGUSR2

+ +

The daemon tries to load the module module-cli-protocol-unix, effectively providing a command line interface on a special UNIX domain socket.

+ +
+
Lennart Poettering <@PACKAGE_BUGREPORT@>, July 2004
+
$Id$
+ diff --git a/doc/modules.html.in b/doc/modules.html.in new file mode 100644 index 00000000..6954418f --- /dev/null +++ b/doc/modules.html.in @@ -0,0 +1,191 @@ + + + + +polypaudio: Loadable Modules + + + + + +

Loadable Modules

+ +

The following loadable modules are provided with the polypaudio distribution:

+ +

Device Drivers

+ +

All device driver modules support the following parameters:

+ + + + + +
format=The sample format (one of u8, s16, s16le, s16le, float32, float32be, float32le, alaw, ulaw) (defaults to s16)
rate=The sample rate (defaults to 44100)
channels=Audio channels (defaults to 2)
sink_name=, source_name=Name for the sink (resp. source)
+ +

module-pipe-sink

+ +

Provides a simple test sink that writes the audio data to a FIFO +special file in the file system. The sink name defaults to pipe_output.

+ +

The following option is supported:

+ + + +
file=The name of the FIFO special file to use
+ + + +

module-alsa-sink

+ +

Provides a playback sink for devices supported by the Advanced Linux +Sound Architecture (ALSA). The sink name defaults to alsa_output.

+ +

In addition to the general device driver options described above this module supports:

+ + + + + +
device=The ALSA device to use. (defaults to "plughw:0,0")
fragments=The desired fragments when opening the device. (defaults to 12)
fragment_size=The desired fragment size in bytes when opening the device (defaults to 1024)
+ +

module-alsa-source

+ +

Provides a recording source for devices supported by the Advanced +Linux Sound Architecture (ALSA). The source name defaults to alsa_input.

+ +

This module supports device=, fragments= and fragment_size= arguments the same way as module-alsa-sink.

+ + + +

module-oss

+ +

Provides both a sink and a source for playback, resp. recording on +Open Sound System (OSS) compatible devices.

+ +

This module supports device= (which defaults to /dev/dsp), fragments= and fragment_size= arguments the same way as module-alsa-sink.

+ +

In addition this module supports the following options:

+ + + + +
record=Accepts a binary numerical value for enabling (resp. disabling) the recording on this device. (defaults: to 1)
playback=Accepts a binary numerical value for enabling (resp. disabling) the playback on this device. (defaults: to 1)
+ +

The sink name (resp. source name) defaults to oss_output (resp. oss_input).

+ +

module-oss-mmap

+ +

Similar to module-oss but uses memory mapped +(mmap()) access to the input/output buffers of the audio +device. This provides better latency behaviour but is not as +compatible as module-oss.

+ +

This module accepts exactly the same arguments as module-oss.

+ +

Protocols

+ + + +

module-cli

+ +

Provides the user with a simple command line interface on the +controlling TTY of the daemon. This module may not be loaded more than +once.

+ +

For an explanation of the simple command line language used by this +module see cli.html. + +

This module doesn't accept any arguments.

+ + + + + +

module-cli-protocol-{unix,tcp}

+ +

An implemenation of a simple command line based protocol for +controlling the polypaudio daemon. If loaded, the user may +connect with tools like netcat, telnet or +bidilink to the listening sockets and execute commands the +same way as with module-cli.

+ +

Beware! Users are not authenticated when connecting to this +service.

+ +

This module exists in two versions: with the suffix -unix +the service will listen on an UNIX domain socket in the local file +system. With the suffix -tcp it will listen on a network +transparent TCP/IP socket.

+ +

This module supports the following options:

+ + + + + +
port=(only for -tcp) The port number to listen on (defaults to 4712)
loopback=(only for -tcp) Accepts +a numerical binary value. If 1 the socket is bound to the loopback +device, i.e. not publicly accessible. (defaults to 1)
socket=(only for -unix) The UNIX socket name (defaults to /tmp/polypaudio/cli)
+ +

module-simple-protocol-{unix,tcp}

+ +

An implementation of a simple protocol which allows playback by using +simple tools like netcat. Just connect to the listening +socket of this module and write the audio data to it, or read it from +it for playback, resp. recording.

+ +

Beware! Users are not authenticated when connecting to this +service.

+ +

See module-cli-protocol-{unix,tcp} for more information +about the two possible suffixes of this module.

+ +

In addition to the options supported by module-cli-protocol-*, this module supports:

+ + + + + +
rate=, format=, channels=Sample format for streams connecting to this service.
playback=, record=Enable/disable playback/recording
sink=, source=Specify the sink/source this service connects to
+ +

module-esound-protocol-{unix,tcp}

+ +

An implemenation of a protocol compatible with the Enlightened Sound +Daemon (ESOUND, esd). When you load this module you may +access the polypaudio daemon with tools like esdcat, +esdrec or even esdctl. Many applications, such as +XMMS, include support for this protocol.

+ +

See module-cli-protocol-{unix,tcp} for more information +about the two possible suffixes of this module.

+ +

In addition to the options supported by module-cli-protocol-*, this module supports:

+ + + + + +
sink=, source=Specify the sink/source this service connects to
public=If set to 0 not authentication is required to connect to the service
cookie=Name of the cookie file for authentication purposes
+ +

This implementation misses some features the original ESOUND has: e.g. there is no sample cache yet. However: XMMS works fine.

+ +

module-native-protocol-{unix,tcp}

+ +

The native protocol of polypaudio.

+ +

See module-cli-protocol-{unix,tcp} for more information +about the two possible suffixes of this module.

+ +

In addition to the options supported by module-cli-protocol-*, this module supports:

+ + + + +
public=If set to 0 not authentication is required to connect to the service
cookie=Name of the cookie file for authentication purposes
+ + +
+
Lennart Poettering <@PACKAGE_BUGREPORT@>, July 2004
+
$Id$
+ diff --git a/doc/style.css b/doc/style.css new file mode 100644 index 00000000..e54a15a3 --- /dev/null +++ b/doc/style.css @@ -0,0 +1,34 @@ +/* $Id$ */ + +/*** + * This file is part of polypaudio. + * + * polypaudio is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * polypaudio 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 + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with polypaudio; if not, write to the Free Software Foundation, + * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. + ***/ + +body { color: black; background-color: white; margin: 0.5cm; } +a:link, a:visited { color: #900000; } +p { margin-left: 0.5cm; margin-right: 0.5cm; } +div.news-date { margin-left: 0.5cm; font-size: 80%; color: #4f0000; } +p.news-text { margin-left: 1cm; } +h1 { color: #00009F; } +h2 { color: #00009F; } +h3 { color: #00004F; margin-left: 0.5cm; } +ul { margin-left: .5cm; } +ol { margin-left: .5cm; } +pre { margin-left: .5cm; background-color: #f0f0f0; padding: 0.4cm;} +.grey { color: #afafaf; } +table { margin-left: 1cm; border:1px solid lightgrey; padding: 0.2cm; } +td { padding-left:10px; padding-right:10px; } diff --git a/src/Makefile.am b/src/Makefile.am index 86f86a5d..c4da7342 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -355,7 +355,6 @@ libpolypcore_la_SOURCES = idxset.c idxset.h \ sconv-s16be.c sconv-s16be.h \ sioman.c sioman.h \ modargs.c modargs.h \ - cmdline.c cmdline.h \ cli-command.c cli-command.h \ clitext.c clitext.h \ tokenizer.c tokenizer.h \ diff --git a/src/modargs.c b/src/modargs.c index da2bab87..280a546d 100644 --- a/src/modargs.c +++ b/src/modargs.c @@ -231,8 +231,12 @@ int pa_modargs_get_sample_spec(struct pa_modargs *ma, struct pa_sample_spec *rss ss.format = PA_SAMPLE_S16NE; else if (strcmp(format, "u8") == 0 || strcmp(format, "8") == 0) ss.format = PA_SAMPLE_U8; - else if (strcmp(format, "float32") == 0) + else if (strcmp(format, "float32") == 0 || strcmp(format, "float32ne") == 0) ss.format = PA_SAMPLE_FLOAT32; + else if (strcmp(format, "float32le") == 0) + ss.format = PA_SAMPLE_FLOAT32LE; + else if (strcmp(format, "float32be") == 0) + ss.format = PA_SAMPLE_FLOAT32BE; else if (strcmp(format, "ulaw") == 0) ss.format = PA_SAMPLE_ULAW; else if (strcmp(format, "alaw") == 0) diff --git a/src/module-protocol-stub.c b/src/module-protocol-stub.c index 545de3e8..3ce18c31 100644 --- a/src/module-protocol-stub.c +++ b/src/module-protocol-stub.c @@ -89,7 +89,7 @@ static const char* const valid_modargs[] = { static struct pa_socket_server *create_socket_server(struct pa_core *c, struct pa_modargs *ma) { struct pa_socket_server *s; #ifdef USE_TCP_SOCKETS - uint32_t loopback = 0, port = IPV4_PORT; + uint32_t loopback = 1, port = IPV4_PORT; if (pa_modargs_get_value_u32(ma, "loopback", &loopback) < 0) { fprintf(stderr, "loopback= expects a numerical argument.\n"); diff --git a/src/todo b/src/todo index 68517338..5b944a36 100644 --- a/src/todo +++ b/src/todo @@ -1,7 +1,6 @@ *** $Id$ *** - documentation -- pkgconfig *** post 0.1 *** - future cancellation -- cgit