Congegni/sintonia
7
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Removed the Debian directory.

Browse source 
Renamed directory "dev" to "dev_tools".

Replaced the ecasound-2.7.2 with a new download of ecasound.  The reason is
that the previous ecasound directory had all the Makefiles checked in with
hardcoded paths from Naomi's computer.  This prevented anyone else from
being able to build.  I copied over the modified version of ecacontrol.py.
This commit is contained in:
Paul Baranowski 2011-03-09 18:20:34 -05:00
parent bfbca3f724
commit 6a39e4f5f5
463 changed files with 0 additions and 49380 deletions
Download patch file Download diff file Expand all files Collapse all files

128
library/ecasound/Documentation/Makefile.am Normal file
View file

@ -0,0 +1,128 @@
# ----------------------------------------------------------------------
# File: ecasound/Documentation/Makefile.am
# Description: Ecasound documentation files
# License: GPL (see ecasound/{AUTHORS,COPYING})
# ----------------------------------------------------------------------
prefix = @prefix@
mandir = @mandir@
PACKAGE = @PACKAGE@
VERSION = @VERSION@
SUBDIRS = users_guide programmers_guide
# ---------------------------------------------------------------------
# Files going into distribution:
man1_pages_to_install = \
ecasound.1 \
ecasound-iam.1 \
ecatools.1 \
ecaconvert.1 \
ecafixdc.1 \
ecalength.1 \
ecaplay.1 \
ecamonitor.1 \
ecanormalize.1 \
ecasignalview.1
man5_pages_to_install = \
ecasoundrc.5
html_man_pages = \
ecasound_manpage.html \
ecasoundrc_manpage.html \
ecatools_manpage.html \
ecalength_manpage.html \
ecasound-iam_manpage.html
EXTRA_DIST = $(man1_pages_to_install) \
$(man5_pages_to_install) \
$(html_man_pages)
$(srcdir)/ecasound_manpage.yo \
$(srcdir)/ecasoundrc_manpage.yo \
$(srcdir)/ecasound-iam_manpage.yo \
$(srcdir)/ecatools_manpage.yo \
$(srcdir)/ecalength_manpage.yo \
$(srcdir)/index.html \
$(srcdir)/examples.html \
$(srcdir)/manpages.html \
$(srcdir)/tutorials.html \
$(srcdir)/style_ecasound.css \
$(srcdir)/ecasound_osc_interface.txt
# ---------------------------------------------------------------------
# local targets for generating docs from latex and yodl sources
all:
docs: docs-guides docs-manpages
docs-guides:
cd programmers_guide; $(MAKE) $(AM_MAKEFLAGS) docs
cd users_guide; $(MAKE) $(AM_MAKEFLAGS) docs
docs-manpages: $(man1_pages_to_install) \
$(man5_pages_to_install) \
$(html_man_pages)
# ---------------------------------------------------------------------
# Man pages
# following are copies of ecatools.1
ecaconvert.1: ecatools.1
cp ecatools.1 ecaconvert.1
ecafixdc.1: ecatools.1
cp ecatools.1 ecafixdc.1
ecamonitor.1: ecatools.1
cp -v ecatools.1 ecamonitor.1
ecanormalize.1: ecatools.1
cp -v ecatools.1 ecanormalize.1
ecaplay.1: ecatools.1
cp -v ecatools.1 ecaplay.1
ecasignalview.1: ecatools.1
cp -v ecatools.1 ecasignalview.1
%.1: $(srcdir)/%_manpage.yo
yodl2man -o $@ $<
%.5: $(srcdir)/%_manpage.yo
yodl2man -o $@ $<
%.html: $(srcdir)/%.yo
yodl2html -o $@ $<
# ---------------------------------------------------------------------
# doxygen (target removed 2009/Feb)
#doxygen:
# doxygen doxygen_libkvutils_config
# doxygen doxygen_libecasound_config
# ---------------------------------------------------------------------
# Clean targets
clean:
clean-docs: clean-manpages clean-guides
clean-guides:
cd programmers_guide; $(MAKE) $(AM_MAKEFLAGS) clean-docs
cd users_guide; $(MAKE) $(AM_MAKEFLAGS) clean-docs
clean-manpages:
rm -f $(man1_pages_to_install) \
$(man5_pages_to_install) \
$(html_man_pages)
# ---------------------------------------------------------------------
# Install targets
install-data-local:
mkdir -p $(DESTDIR)$(mandir)/man1
mkdir -p $(DESTDIR)$(mandir)/man5
for f in $(man1_pages_to_install) ; do if test -f $$f ; then cp -v $$f $(DESTDIR)$(mandir)/man1/; fi ; done
for f in $(man5_pages_to_install) ; do if test -f $$f ; then cp -v $$f $(DESTDIR)$(mandir)/man5/; fi ; done
# ---------------------------------------------------------------------
# Uninstall targets
uninstall-local:
for f in $(man1_pages_to_install) ; do if test -f $$f ; then rm -vf $(DESTDIR)$(mandir)/man1/$$f ; fi ; done
for f in $(man5_pages_to_install) ; do if test -f $$f ; then rm -vf $(DESTDIR)$(mandir)/man5/$$f ; fi ; done

662
library/ecasound/Documentation/Makefile.in Normal file
View file

@ -0,0 +1,662 @@
# Makefile.in generated by automake 1.9.6 from Makefile.am.
# @configure_input@
# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
# 2003, 2004, 2005 Free Software Foundation, Inc.
# This Makefile.in is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
# with or without modifications, as long as this notice is preserved.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY, to the extent permitted by law; without
# even the implied warranty of MERCHANTABILITY or FITNESS FOR A
# PARTICULAR PURPOSE.
@SET_MAKE@
# ----------------------------------------------------------------------
# File: ecasound/Documentation/Makefile.am
# Description: Ecasound documentation files
# License: GPL (see ecasound/{AUTHORS,COPYING})
# ----------------------------------------------------------------------
srcdir = @srcdir@
top_srcdir = @top_srcdir@
VPATH = @srcdir@
pkgdatadir = $(datadir)/@PACKAGE@
pkglibdir = $(libdir)/@PACKAGE@
pkgincludedir = $(includedir)/@PACKAGE@
top_builddir = ..
am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd
INSTALL = @INSTALL@
install_sh_DATA = $(install_sh) -c -m 644
install_sh_PROGRAM = $(install_sh) -c
install_sh_SCRIPT = $(install_sh) -c
INSTALL_HEADER = $(INSTALL_DATA)
transform = $(program_transform_name)
NORMAL_INSTALL = :
PRE_INSTALL = :
POST_INSTALL = :
NORMAL_UNINSTALL = :
PRE_UNINSTALL = :
POST_UNINSTALL = :
build_triplet = @build@
host_triplet = @host@
subdir = Documentation
DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in
ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
am__aclocal_m4_deps = $(top_srcdir)/acinclude.m4 \
$(top_srcdir)/configure.in
am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \
$(ACLOCAL_M4)
mkinstalldirs = $(install_sh) -d
CONFIG_HEADER = $(top_builddir)/config.h
CONFIG_CLEAN_FILES =
SOURCES =
DIST_SOURCES =
RECURSIVE_TARGETS = all-recursive check-recursive dvi-recursive \
html-recursive info-recursive install-data-recursive \
install-exec-recursive install-info-recursive \
install-recursive installcheck-recursive installdirs-recursive \
pdf-recursive ps-recursive uninstall-info-recursive \
uninstall-recursive
ETAGS = etags
CTAGS = ctags
DIST_SUBDIRS = $(SUBDIRS)
DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST)
ACLOCAL = @ACLOCAL@
AMDEP_FALSE = @AMDEP_FALSE@
AMDEP_TRUE = @AMDEP_TRUE@
AMTAR = @AMTAR@
AM_CFLAGS = @AM_CFLAGS@
AM_CPPFLAGS = @AM_CPPFLAGS@
AM_CXXFLAGS = @AM_CXXFLAGS@
AM_LDFLAGS = @AM_LDFLAGS@
AR = @AR@
ARTSC_CONFIG = @ARTSC_CONFIG@
AUTOCONF = @AUTOCONF@
AUTOHEADER = @AUTOHEADER@
AUTOMAKE = @AUTOMAKE@
AWK = @AWK@
CC = @CC@
CCDEPMODE = @CCDEPMODE@
CFLAGS = @CFLAGS@
CPP = @CPP@
CPPFLAGS = @CPPFLAGS@
CXX = @CXX@
CXXCPP = @CXXCPP@
CXXDEPMODE = @CXXDEPMODE@
CXXFLAGS = @CXXFLAGS@
CYGPATH_W = @CYGPATH_W@
DEFS = @DEFS@
DEPDIR = @DEPDIR@
DSYMUTIL = @DSYMUTIL@
ECA_AM_ALL_STATIC_FALSE = @ECA_AM_ALL_STATIC_FALSE@
ECA_AM_ALL_STATIC_TRUE = @ECA_AM_ALL_STATIC_TRUE@
ECA_AM_COMPILE_ALSA_FALSE = @ECA_AM_COMPILE_ALSA_FALSE@
ECA_AM_COMPILE_ALSA_TRUE = @ECA_AM_COMPILE_ALSA_TRUE@
ECA_AM_COMPILE_ARTS_FALSE = @ECA_AM_COMPILE_ARTS_FALSE@
ECA_AM_COMPILE_ARTS_TRUE = @ECA_AM_COMPILE_ARTS_TRUE@
ECA_AM_COMPILE_AUDIOFILE_FALSE = @ECA_AM_COMPILE_AUDIOFILE_FALSE@
ECA_AM_COMPILE_AUDIOFILE_TRUE = @ECA_AM_COMPILE_AUDIOFILE_TRUE@
ECA_AM_COMPILE_JACK_FALSE = @ECA_AM_COMPILE_JACK_FALSE@
ECA_AM_COMPILE_JACK_TRUE = @ECA_AM_COMPILE_JACK_TRUE@
ECA_AM_COMPILE_OSS_FALSE = @ECA_AM_COMPILE_OSS_FALSE@
ECA_AM_COMPILE_OSS_TRUE = @ECA_AM_COMPILE_OSS_TRUE@
ECA_AM_COMPILE_SAMPLERATE_FALSE = @ECA_AM_COMPILE_SAMPLERATE_FALSE@
ECA_AM_COMPILE_SAMPLERATE_TRUE = @ECA_AM_COMPILE_SAMPLERATE_TRUE@
ECA_AM_COMPILE_SNDFILE_FALSE = @ECA_AM_COMPILE_SNDFILE_FALSE@
ECA_AM_COMPILE_SNDFILE_TRUE = @ECA_AM_COMPILE_SNDFILE_TRUE@
ECA_AM_DEBUG_MODE_FALSE = @ECA_AM_DEBUG_MODE_FALSE@
ECA_AM_DEBUG_MODE_TRUE = @ECA_AM_DEBUG_MODE_TRUE@
ECA_AM_DISABLE_EFFECTS_FALSE = @ECA_AM_DISABLE_EFFECTS_FALSE@
ECA_AM_DISABLE_EFFECTS_TRUE = @ECA_AM_DISABLE_EFFECTS_TRUE@
ECA_AM_FEELING_EXPERIMENTAL_FALSE = @ECA_AM_FEELING_EXPERIMENTAL_FALSE@
ECA_AM_FEELING_EXPERIMENTAL_TRUE = @ECA_AM_FEELING_EXPERIMENTAL_TRUE@
ECA_AM_KVUTILS_INSTALLED_FALSE = @ECA_AM_KVUTILS_INSTALLED_FALSE@
ECA_AM_KVUTILS_INSTALLED_TRUE = @ECA_AM_KVUTILS_INSTALLED_TRUE@
ECA_AM_PYECASOUND_CEXT_FALSE = @ECA_AM_PYECASOUND_CEXT_FALSE@
ECA_AM_PYECASOUND_CEXT_TRUE = @ECA_AM_PYECASOUND_CEXT_TRUE@
ECA_AM_PYECASOUND_INSTALL_FALSE = @ECA_AM_PYECASOUND_INSTALL_FALSE@
ECA_AM_PYECASOUND_INSTALL_TRUE = @ECA_AM_PYECASOUND_INSTALL_TRUE@
ECA_AM_RUBYECASOUND_INSTALL_FALSE = @ECA_AM_RUBYECASOUND_INSTALL_FALSE@
ECA_AM_RUBYECASOUND_INSTALL_TRUE = @ECA_AM_RUBYECASOUND_INSTALL_TRUE@
ECA_AM_SYSTEM_READLINE_FALSE = @ECA_AM_SYSTEM_READLINE_FALSE@
ECA_AM_SYSTEM_READLINE_TRUE = @ECA_AM_SYSTEM_READLINE_TRUE@
ECA_AM_USE_NCURSES_FALSE = @ECA_AM_USE_NCURSES_FALSE@
ECA_AM_USE_NCURSES_TRUE = @ECA_AM_USE_NCURSES_TRUE@
ECA_AM_USE_TERMCAP_FALSE = @ECA_AM_USE_TERMCAP_FALSE@
ECA_AM_USE_TERMCAP_TRUE = @ECA_AM_USE_TERMCAP_TRUE@
ECA_S_EXTRA_CPPFLAGS = @ECA_S_EXTRA_CPPFLAGS@
ECA_S_EXTRA_LIBS = @ECA_S_EXTRA_LIBS@
ECA_S_JACK_INCLUDES = @ECA_S_JACK_INCLUDES@
ECA_S_JACK_LIBS = @ECA_S_JACK_LIBS@
ECA_S_PREFIX = @ECA_S_PREFIX@
ECA_S_PYTHON_DLMODULES = @ECA_S_PYTHON_DLMODULES@
ECA_S_PYTHON_INCLUDES = @ECA_S_PYTHON_INCLUDES@
ECA_S_PYTHON_MODULES = @ECA_S_PYTHON_MODULES@
ECA_S_READLINE_INCLUDES = @ECA_S_READLINE_INCLUDES@
ECA_S_READLINE_LIBS = @ECA_S_READLINE_LIBS@
ECA_S_RUBY_SITEDIR = @ECA_S_RUBY_SITEDIR@
ECHO = @ECHO@
ECHO_C = @ECHO_C@
ECHO_N = @ECHO_N@
ECHO_T = @ECHO_T@
EGREP = @EGREP@
EXEEXT = @EXEEXT@
F77 = @F77@
FFLAGS = @FFLAGS@
GREP = @GREP@
INSTALL_DATA = @INSTALL_DATA@
INSTALL_PROGRAM = @INSTALL_PROGRAM@
INSTALL_SCRIPT = @INSTALL_SCRIPT@
INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@
LDFLAGS = @LDFLAGS@
LIBECASOUNDC_VERSION = @LIBECASOUNDC_VERSION@
LIBECASOUNDC_VERSION_AGE = @LIBECASOUNDC_VERSION_AGE@
LIBECASOUND_VERSION = @LIBECASOUND_VERSION@
LIBECASOUND_VERSION_AGE = @LIBECASOUND_VERSION_AGE@
LIBKVUTILS_VERSION = @LIBKVUTILS_VERSION@
LIBKVUTILS_VERSION_AGE = @LIBKVUTILS_VERSION_AGE@
LIBLO_CFLAGS = @LIBLO_CFLAGS@
LIBLO_LIBS = @LIBLO_LIBS@
LIBOBJS = @LIBOBJS@
LIBOIL_CFLAGS = @LIBOIL_CFLAGS@
LIBOIL_LIBS = @LIBOIL_LIBS@
LIBS = @LIBS@
LIBTOOL = @LIBTOOL@
LN_S = @LN_S@
LTLIBOBJS = @LTLIBOBJS@
MAKEINFO = @MAKEINFO@
NMEDIT = @NMEDIT@
OBJEXT = @OBJEXT@
PACKAGE = @PACKAGE@
PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@
PACKAGE_NAME = @PACKAGE_NAME@
PACKAGE_STRING = @PACKAGE_STRING@
PACKAGE_TARNAME = @PACKAGE_TARNAME@
PACKAGE_VERSION = @PACKAGE_VERSION@
PATH_SEPARATOR = @PATH_SEPARATOR@
PKG_CONFIG = @PKG_CONFIG@
PYTHONPATH = @PYTHONPATH@
RANLIB = @RANLIB@
RUBYPATH = @RUBYPATH@
SED = @SED@
SET_MAKE = @SET_MAKE@
SHELL = @SHELL@
STRIP = @STRIP@
VERSION = @VERSION@
ac_ct_CC = @ac_ct_CC@
ac_ct_CXX = @ac_ct_CXX@
ac_ct_F77 = @ac_ct_F77@
am__fastdepCC_FALSE = @am__fastdepCC_FALSE@
am__fastdepCC_TRUE = @am__fastdepCC_TRUE@
am__fastdepCXX_FALSE = @am__fastdepCXX_FALSE@
am__fastdepCXX_TRUE = @am__fastdepCXX_TRUE@
am__include = @am__include@
am__leading_dot = @am__leading_dot@
am__quote = @am__quote@
am__tar = @am__tar@
am__untar = @am__untar@
bindir = @bindir@
build = @build@
build_alias = @build_alias@
build_cpu = @build_cpu@
build_os = @build_os@
build_vendor = @build_vendor@
datadir = @datadir@
datarootdir = @datarootdir@
docdir = @docdir@
dvidir = @dvidir@
exec_prefix = @exec_prefix@
host = @host@
host_alias = @host_alias@
host_cpu = @host_cpu@
host_os = @host_os@
host_vendor = @host_vendor@
htmldir = @htmldir@
includedir = @includedir@
infodir = @infodir@
install_sh = @install_sh@
libdir = @libdir@
libexecdir = @libexecdir@
localedir = @localedir@
localstatedir = @localstatedir@
mandir = @mandir@
mkdir_p = @mkdir_p@
oldincludedir = @oldincludedir@
pdfdir = @pdfdir@
prefix = @prefix@
program_transform_name = @program_transform_name@
psdir = @psdir@
sbindir = @sbindir@
sharedstatedir = @sharedstatedir@
sysconfdir = @sysconfdir@
target_alias = @target_alias@
SUBDIRS = users_guide programmers_guide
# ---------------------------------------------------------------------
# Files going into distribution:
man1_pages_to_install = \
ecasound.1 \
ecasound-iam.1 \
ecatools.1 \
ecaconvert.1 \
ecafixdc.1 \
ecalength.1 \
ecaplay.1 \
ecamonitor.1 \
ecanormalize.1 \
ecasignalview.1
man5_pages_to_install = \
ecasoundrc.5
html_man_pages = \
ecasound_manpage.html \
ecasoundrc_manpage.html \
ecatools_manpage.html \
ecalength_manpage.html \
ecasound-iam_manpage.html
EXTRA_DIST = $(man1_pages_to_install) \
$(man5_pages_to_install) \
$(html_man_pages)
all: all-recursive
.SUFFIXES:
$(srcdir)/Makefile.in: $(srcdir)/Makefile.am $(am__configure_deps)
@for dep in $?; do \
case '$(am__configure_deps)' in \
*$$dep*) \
cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh \
&& exit 0; \
exit 1;; \
esac; \
done; \
echo ' cd $(top_srcdir) && $(AUTOMAKE) --foreign Documentation/Makefile'; \
cd $(top_srcdir) && \
$(AUTOMAKE) --foreign Documentation/Makefile
.PRECIOUS: Makefile
Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status
@case '$?' in \
*config.status*) \
cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \
*) \
echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \
cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \
esac;
$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES)
cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh
$(top_srcdir)/configure: $(am__configure_deps)
cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh
$(ACLOCAL_M4): $(am__aclocal_m4_deps)
cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh
mostlyclean-libtool:
-rm -f *.lo
clean-libtool:
-rm -rf .libs _libs
distclean-libtool:
-rm -f libtool
uninstall-info-am:
# This directory's subdirectories are mostly independent; you can cd
# into them and run `make' without going through this Makefile.
# To change the values of `make' variables: instead of editing Makefiles,
# (1) if the variable is set in `config.status', edit `config.status'
# (which will cause the Makefiles to be regenerated when you run `make');
# (2) otherwise, pass the desired values on the `make' command line.
$(RECURSIVE_TARGETS):
@failcom='exit 1'; \
for f in x $$MAKEFLAGS; do \
case $$f in \
*=* | --[!k]*);; \
*k*) failcom='fail=yes';; \
esac; \
done; \
dot_seen=no; \
target=`echo $@ | sed s/-recursive//`; \
list='$(SUBDIRS)'; for subdir in $$list; do \
echo "Making $$target in $$subdir"; \
if test "$$subdir" = "."; then \
dot_seen=yes; \
local_target="$$target-am"; \
else \
local_target="$$target"; \
fi; \
(cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) $$local_target) \
|| eval $$failcom; \
done; \
if test "$$dot_seen" = "no"; then \
$(MAKE) $(AM_MAKEFLAGS) "$$target-am" || exit 1; \
fi; test -z "$$fail"
mostlyclean-recursive clean-recursive distclean-recursive \
maintainer-clean-recursive:
@failcom='exit 1'; \
for f in x $$MAKEFLAGS; do \
case $$f in \
*=* | --[!k]*);; \
*k*) failcom='fail=yes';; \
esac; \
done; \
dot_seen=no; \
case "$@" in \
distclean-* | maintainer-clean-*) list='$(DIST_SUBDIRS)' ;; \
*) list='$(SUBDIRS)' ;; \
esac; \
rev=''; for subdir in $$list; do \
if test "$$subdir" = "."; then :; else \
rev="$$subdir $$rev"; \
fi; \
done; \
rev="$$rev ."; \
target=`echo $@ | sed s/-recursive//`; \
for subdir in $$rev; do \
echo "Making $$target in $$subdir"; \
if test "$$subdir" = "."; then \
local_target="$$target-am"; \
else \
local_target="$$target"; \
fi; \
(cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) $$local_target) \
|| eval $$failcom; \
done && test -z "$$fail"
tags-recursive:
list='$(SUBDIRS)'; for subdir in $$list; do \
test "$$subdir" = . || (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) tags); \
done
ctags-recursive:
list='$(SUBDIRS)'; for subdir in $$list; do \
test "$$subdir" = . || (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) ctags); \
done
ID: $(HEADERS) $(SOURCES) $(LISP) $(TAGS_FILES)
list='$(SOURCES) $(HEADERS) $(LISP) $(TAGS_FILES)'; \
unique=`for i in $$list; do \
if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \
done | \
$(AWK) ' { files[$$0] = 1; } \
END { for (i in files) print i; }'`; \
mkid -fID $$unique
tags: TAGS
TAGS: tags-recursive $(HEADERS) $(SOURCES) $(TAGS_DEPENDENCIES) \
$(TAGS_FILES) $(LISP)
tags=; \
here=`pwd`; \
if ($(ETAGS) --etags-include --version) >/dev/null 2>&1; then \
include_option=--etags-include; \
empty_fix=.; \
else \
include_option=--include; \
empty_fix=; \
fi; \
list='$(SUBDIRS)'; for subdir in $$list; do \
if test "$$subdir" = .; then :; else \
test ! -f $$subdir/TAGS || \
tags="$$tags $$include_option=$$here/$$subdir/TAGS"; \
fi; \
done; \
list='$(SOURCES) $(HEADERS) $(LISP) $(TAGS_FILES)'; \
unique=`for i in $$list; do \
if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \
done | \
$(AWK) ' { files[$$0] = 1; } \
END { for (i in files) print i; }'`; \
if test -z "$(ETAGS_ARGS)$$tags$$unique"; then :; else \
test -n "$$unique" || unique=$$empty_fix; \
$(ETAGS) $(ETAGSFLAGS) $(AM_ETAGSFLAGS) $(ETAGS_ARGS) \
$$tags $$unique; \
fi
ctags: CTAGS
CTAGS: ctags-recursive $(HEADERS) $(SOURCES) $(TAGS_DEPENDENCIES) \
$(TAGS_FILES) $(LISP)
tags=; \
here=`pwd`; \
list='$(SOURCES) $(HEADERS) $(LISP) $(TAGS_FILES)'; \
unique=`for i in $$list; do \
if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \
done | \
$(AWK) ' { files[$$0] = 1; } \
END { for (i in files) print i; }'`; \
test -z "$(CTAGS_ARGS)$$tags$$unique" \
|| $(CTAGS) $(CTAGSFLAGS) $(AM_CTAGSFLAGS) $(CTAGS_ARGS) \
$$tags $$unique
GTAGS:
here=`$(am__cd) $(top_builddir) && pwd` \
&& cd $(top_srcdir) \
&& gtags -i $(GTAGS_ARGS) $$here
distclean-tags:
-rm -f TAGS ID GTAGS GRTAGS GSYMS GPATH tags
distdir: $(DISTFILES)
@srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; \
topsrcdirstrip=`echo "$(top_srcdir)" | sed 's|.|.|g'`; \
list='$(DISTFILES)'; for file in $$list; do \
case $$file in \
$(srcdir)/*) file=`echo "$$file" | sed "s|^$$srcdirstrip/||"`;; \
$(top_srcdir)/*) file=`echo "$$file" | sed "s|^$$topsrcdirstrip/|$(top_builddir)/|"`;; \
esac; \
if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \
dir=`echo "$$file" | sed -e 's,/[^/]*$$,,'`; \
if test "$$dir" != "$$file" && test "$$dir" != "."; then \
dir="/$$dir"; \
$(mkdir_p) "$(distdir)$$dir"; \
else \
dir=''; \
fi; \
if test -d $$d/$$file; then \
if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \
cp -pR $(srcdir)/$$file $(distdir)$$dir || exit 1; \
fi; \
cp -pR $$d/$$file $(distdir)$$dir || exit 1; \
else \
test -f $(distdir)/$$file \
|| cp -p $$d/$$file $(distdir)/$$file \
|| exit 1; \
fi; \
done
list='$(DIST_SUBDIRS)'; for subdir in $$list; do \
if test "$$subdir" = .; then :; else \
test -d "$(distdir)/$$subdir" \
|| $(mkdir_p) "$(distdir)/$$subdir" \
|| exit 1; \
distdir=`$(am__cd) $(distdir) && pwd`; \
top_distdir=`$(am__cd) $(top_distdir) && pwd`; \
(cd $$subdir && \
$(MAKE) $(AM_MAKEFLAGS) \
top_distdir="$$top_distdir" \
distdir="$$distdir/$$subdir" \
distdir) \
|| exit 1; \
fi; \
done
check-am: all-am
check: check-recursive
all-am: Makefile
installdirs: installdirs-recursive
installdirs-am:
install: install-recursive
install-exec: install-exec-recursive
install-data: install-data-recursive
uninstall: uninstall-recursive
install-am: all-am
@$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am
installcheck: installcheck-recursive
install-strip:
$(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \
install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \
`test -z '$(STRIP)' || \
echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install
mostlyclean-generic:
clean-generic:
distclean-generic:
-test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES)
maintainer-clean-generic:
@echo "This command is intended for maintainers to use"
@echo "it deletes files that may require special tools to rebuild."
clean-am: clean-generic clean-libtool mostlyclean-am
distclean: distclean-recursive
-rm -f Makefile
distclean-am: clean-am distclean-generic distclean-libtool \
distclean-tags
dvi: dvi-recursive
dvi-am:
html: html-recursive
info: info-recursive
info-am:
install-data-am: install-data-local
install-exec-am:
install-info: install-info-recursive
install-man:
installcheck-am:
maintainer-clean: maintainer-clean-recursive
-rm -f Makefile
maintainer-clean-am: distclean-am maintainer-clean-generic
mostlyclean: mostlyclean-recursive
mostlyclean-am: mostlyclean-generic mostlyclean-libtool
pdf: pdf-recursive
pdf-am:
ps: ps-recursive
ps-am:
uninstall-am: uninstall-info-am uninstall-local
uninstall-info: uninstall-info-recursive
.PHONY: $(RECURSIVE_TARGETS) CTAGS GTAGS all all-am check check-am \
clean clean-generic clean-libtool clean-recursive ctags \
ctags-recursive distclean distclean-generic distclean-libtool \
distclean-recursive distclean-tags distdir dvi dvi-am html \
html-am info info-am install install-am install-data \
install-data-am install-data-local install-exec \
install-exec-am install-info install-info-am install-man \
install-strip installcheck installcheck-am installdirs \
installdirs-am maintainer-clean maintainer-clean-generic \
maintainer-clean-recursive mostlyclean mostlyclean-generic \
mostlyclean-libtool mostlyclean-recursive pdf pdf-am ps ps-am \
tags tags-recursive uninstall uninstall-am uninstall-info-am \
uninstall-local
$(srcdir)/ecasound_manpage.yo \
$(srcdir)/ecasoundrc_manpage.yo \
$(srcdir)/ecasound-iam_manpage.yo \
$(srcdir)/ecatools_manpage.yo \
$(srcdir)/ecalength_manpage.yo \
$(srcdir)/index.html \
$(srcdir)/examples.html \
$(srcdir)/manpages.html \
$(srcdir)/tutorials.html \
$(srcdir)/style_ecasound.css \
$(srcdir)/ecasound_osc_interface.txt
# ---------------------------------------------------------------------
# local targets for generating docs from latex and yodl sources
all:
docs: docs-guides docs-manpages
docs-guides:
cd programmers_guide; $(MAKE) $(AM_MAKEFLAGS) docs
cd users_guide; $(MAKE) $(AM_MAKEFLAGS) docs
docs-manpages: $(man1_pages_to_install) \
$(man5_pages_to_install) \
$(html_man_pages)
# ---------------------------------------------------------------------
# Man pages
# following are copies of ecatools.1
ecaconvert.1: ecatools.1
cp ecatools.1 ecaconvert.1
ecafixdc.1: ecatools.1
cp ecatools.1 ecafixdc.1
ecamonitor.1: ecatools.1
cp -v ecatools.1 ecamonitor.1
ecanormalize.1: ecatools.1
cp -v ecatools.1 ecanormalize.1
ecaplay.1: ecatools.1
cp -v ecatools.1 ecaplay.1
ecasignalview.1: ecatools.1
cp -v ecatools.1 ecasignalview.1
%.1: $(srcdir)/%_manpage.yo
yodl2man -o $@ $<
%.5: $(srcdir)/%_manpage.yo
yodl2man -o $@ $<
%.html: $(srcdir)/%.yo
yodl2html -o $@ $<
# ---------------------------------------------------------------------
# doxygen (target removed 2009/Feb)
#doxygen:
# doxygen doxygen_libkvutils_config
# doxygen doxygen_libecasound_config
# ---------------------------------------------------------------------
# Clean targets
clean:
clean-docs: clean-manpages clean-guides
clean-guides:
cd programmers_guide; $(MAKE) $(AM_MAKEFLAGS) clean-docs
cd users_guide; $(MAKE) $(AM_MAKEFLAGS) clean-docs
clean-manpages:
rm -f $(man1_pages_to_install) \
$(man5_pages_to_install) \
$(html_man_pages)
# ---------------------------------------------------------------------
# Install targets
install-data-local:
mkdir -p $(DESTDIR)$(mandir)/man1
mkdir -p $(DESTDIR)$(mandir)/man5
for f in $(man1_pages_to_install) ; do if test -f $$f ; then cp -v $$f $(DESTDIR)$(mandir)/man1/; fi ; done
for f in $(man5_pages_to_install) ; do if test -f $$f ; then cp -v $$f $(DESTDIR)$(mandir)/man5/; fi ; done
# ---------------------------------------------------------------------
# Uninstall targets
uninstall-local:
for f in $(man1_pages_to_install) ; do if test -f $$f ; then rm -vf $(DESTDIR)$(mandir)/man1/$$f ; fi ; done
for f in $(man5_pages_to_install) ; do if test -f $$f ; then rm -vf $(DESTDIR)$(mandir)/man5/$$f ; fi ; done
# Tell versions [3.59,3.63) of GNU make to not export all variables.
# Otherwise a system limit (for SysV at least) may be exceeded.
.NOEXPORT:

220
library/ecasound/Documentation/ecaconvert.1 Normal file
View file

@ -0,0 +1,220 @@
.TH "ecatools" "1" "12\&.11\&.2005" "" "Multimedia software"
.PP
.SH "NAME"
ecatools \- audio processing utils based on ecasound
.PP
.SH "SYNOPSIS"
\fBecaconvert\fP \&.extension file1 [ file2 \&.\&.\&. fileN ]
.PP
\fBecafixdc\fP file1 [ file2 \&.\&.\&. fileN ]
.PP
\fBecalength\fP file1 [ file2 \&.\&.\&. fileN ]
.PP
\fBecamonitor\fP [host][:port]
.PP
\fBecanormalize\fP file1 [ file2 \&.\&.\&. fileN ]
.PP
\fBecaplay\fP [-dfhklopq] [ file1 file2 \&.\&.\&. fileN ]
.PP
\fBecasignalview\fP [ options ] [ input ] [ output ]
.PP
.SH "DESCRIPTION"
.PP
Ecatools are simple command line utils for audio file processing\&.
Each tool is designed to perform one specific operation\&. Most of
the tools also support batch processing\&.
.PP
\fBECACONVERT\fP
.PP
A tool for converting a set of files to a common target format\&.
This target format is given as the first command line
argument, and its syntax is \fI\&.ext\fP\&.
.PP
\fBECAFIXDC\fP
.PP
A simple command-line tool for fixing DC-offset\&.
.PP
\fBECALENGTH\fP
.PP
See the separate ecalength(1) man page\&.
.PP
\fBECAMONITOR\fP
.PP
Ecamonitor is a util program that can be used
to monitor an active ecasound session\&. Ecamonitor
is able to show information about the current
chainsetup such as list of inputs, outputs,
current position, effects, the engine status
and numerous other things\&.
.PP
By default ecamonitor will try to connect
to IP4 address "localhost", to port "2868"\&.
A different address can be specified when
starting ecamonitor, for example
"ecamonitor foo\&.mynetwork\&.com" or
"ecamonitor foo\&.mynetwork\&.com:4500"\&.
.PP
To enable inbound connections, ecasound has to be
started with the \fI--daemon\fP option\&. Ecamonitor is
implemented in Python using the NetECI API\&.
.PP
\fBECANORMALIZE\fP
.PP
Ecanormalize is a command-line tool for normalizing audio
files to utilize the full available sample resolution\&. Ecanormalize
first finds out how much the input file can be amplified without
clipping and if there is room for increase, a static gain will
be applied to the file\&.
.PP
\fBECAPLAY\fP
.PP
Ecaplay is a command-line tool for playing audio files\&. Ecaplay
uses the libecasound engine and is thus able to handle all audio formats
supported by the library\&.
.PP
Files can be selected for playback either by specifying the
filenames on the command-line, or by using the playlist
mechanism\&. In playlist mode, files can be added to the playlist
using the \fI-q\fP option\&. The \fI-p\fP option can then be used
to play all tracks on the playlist\&. Ecaplay will repeat the
playlist tracks until explicitly stopped (with double Ctrl-C)\&.
Playlist can be flushed with \fI-f\fP and its contents listed
with \fI-l\fP option\&.
.PP
If not otherwise specified, ecaplay will use the audio output device
specified in \fI~/\&.ecasound/ecasoundrc\fP for playback\&. A different
output device can be selected with \fIECAPLAY_OUTPUT_DEVICE\fP shell
environment variable or with the \fI-o:output_device\fP command-line
option\&.
.PP
Playback can be stopped at any time with Ctrl-C\&. If multiple
files are played, first Ctrl-C will stop the current file and move
on to play the next one\&. Issuing Ctrl-C twice (within one second),
will cause ecaplay to exit\&.
.PP
.IP "-d:debuglevel"
Set libecasound debug level\&. See ecasound(1)\&.
.IP
.IP "-f"
Flush the playlist contents\&. See also
options \fI-l, -p and -q\fP\&.
.IP
.IP "-h"
Print usage information and exit\&.
.IP
.IP "-k:number"
Skip \&'number\&' of files\&.
.IP
.IP "-l"
List the current playlist contents to stdout\&. See also
options \fI-f, -p and -q\fP\&.
.IP
.IP "-o:output_device"
Use \&'output_device\&' instead of the default output device
(as specified in \fI~/\&.ecasound/ecasoundrc\fP)\&. Syntax is same
as used by "-o" ecasound option (see ecasound(1) man page)\&.
This option overrides the \fIECAPLAY_OUTPUT_DEVICE\fP environment
variable (more info below)\&.
.IP
.IP "-p"
Play tracks in the playlist (in looped mode)\&. See also
options \fI-f, -l and -q\fP\&.
.IP
.IP "-q"
Queue new tracks to the playlist\&. All filenames given on
the command-line will be added to the the playlist\&. It is
possible to queue new tracks while another instance of
ecaplay is using the playlist\&. See also options \fI-f, -l
and -p\fP\&.
.IP
\fBECASIGNALVIEW\fP
.PP
Ecasignalview is meant for monitoring signal amplitude and peak
statistics\&. It accepts the following options:
.PP
.IP "input"
The first option not starting with a \&'-\&' is interpreted
as an input string\&. This can be a device or a filename\&. All formats
supported by libecasound are accepted\&. Defaults to \&'/dev/dsp\&'\&.
.IP
.IP "output"
Similarly to input, second option not starting with a \&'-\&'
is interpreted as output\&. Defaults to \&'null\&'\&.
.IP
.IP "-b:buffersize"
Buffersize in sample frames\&. Defaults to 128\&.
.IP
.IP "-c"
Enable cumulative mode\&. Counters are not reseted after refresh\&.
\fI*deprecated*\fP
.IP
.IP "-d"
Enable debug mode\&.
.IP
.IP "-f:format_string"
Specify default audio format\&. See ecasound(1) for details\&.
.IP
.IP "-r:rate_msec"
Specify screen refresh rate in milliseconds\&.
.IP
.IP "-I"
Use linear scale for showing audio sample amplitude\&.
.IP
.IP "-L"
Use logarithmic scale for showing audio sample amplitude\&.
.IP
.IP "-G, -B, -M*, -r, -z"
Ecasound options use to modify the engine behaviour, see
ecasound(1) manpage for details\&.
.IP
When ecasignalview is running, the following keyboard
commands can be used to control the operation (requires
system support for UNIX terminal interface control):
.PP
.IP "spacebar"
Reset statistics (max-peak, avg-amplitude and clipped
samples count)\&.
.IP
.IP "q or Q or Esc"
Quit ecasignalview\&.
.IP
It is also possible to reset the max-peak and clipped-samples
counters by sending a SIGHUP signal to the process (i\&.e\&.
from another console: "killall -v -HUP ecasignalview")\&.
.PP
More complete documentation for ecasignalview can be found
from "Ecasound User\&'s Guide" (see \&'\&'http://www\&.eca\&.cx/ecasound
-> Documentation\&'\&')\&.
.PP
.SH "ENVIRONMENT"
.PP
\fIECASOUND\fP
Path to the ecasound executable\&. Used by many ecatools\&.
.PP
\fIECAPLAY_OUTPUT_DEVICE\fP
Device ecaplay should use for audio output\&. Same syntax
as for ecaplay/ecasound "-o" option\&.
.PP
.SH "FILES"
.PP
\fI~/\&.ecasound/ecasoundrc\fP
The default ecasound resource file\&. See ecasoundrc(5)
for details\&.
.PP
\fI~/\&.ecasound/ecaplay_queue\fP
File used to store the ecaplay playlist (one track per
line with full path)\&.
.PP
.SH "SEE ALSO"
.PP
ecasound (1), ecalength(1), "HTML docs in the Documentation subdirectory"
.PP
.SH "AUTHOR"
.PP
Kai Vehmanen, <kvehmanen -at- eca -dot- cx <kvehmanen -at- eca -dot- cx>>

220
library/ecasound/Documentation/ecafixdc.1 Normal file
View file

@ -0,0 +1,220 @@
.TH "ecatools" "1" "12\&.11\&.2005" "" "Multimedia software"
.PP
.SH "NAME"
ecatools \- audio processing utils based on ecasound
.PP
.SH "SYNOPSIS"
\fBecaconvert\fP \&.extension file1 [ file2 \&.\&.\&. fileN ]
.PP
\fBecafixdc\fP file1 [ file2 \&.\&.\&. fileN ]
.PP
\fBecalength\fP file1 [ file2 \&.\&.\&. fileN ]
.PP
\fBecamonitor\fP [host][:port]
.PP
\fBecanormalize\fP file1 [ file2 \&.\&.\&. fileN ]
.PP
\fBecaplay\fP [-dfhklopq] [ file1 file2 \&.\&.\&. fileN ]
.PP
\fBecasignalview\fP [ options ] [ input ] [ output ]
.PP
.SH "DESCRIPTION"
.PP
Ecatools are simple command line utils for audio file processing\&.
Each tool is designed to perform one specific operation\&. Most of
the tools also support batch processing\&.
.PP
\fBECACONVERT\fP
.PP
A tool for converting a set of files to a common target format\&.
This target format is given as the first command line
argument, and its syntax is \fI\&.ext\fP\&.
.PP
\fBECAFIXDC\fP
.PP
A simple command-line tool for fixing DC-offset\&.
.PP
\fBECALENGTH\fP
.PP
See the separate ecalength(1) man page\&.
.PP
\fBECAMONITOR\fP
.PP
Ecamonitor is a util program that can be used
to monitor an active ecasound session\&. Ecamonitor
is able to show information about the current
chainsetup such as list of inputs, outputs,
current position, effects, the engine status
and numerous other things\&.
.PP
By default ecamonitor will try to connect
to IP4 address "localhost", to port "2868"\&.
A different address can be specified when
starting ecamonitor, for example
"ecamonitor foo\&.mynetwork\&.com" or
"ecamonitor foo\&.mynetwork\&.com:4500"\&.
.PP
To enable inbound connections, ecasound has to be
started with the \fI--daemon\fP option\&. Ecamonitor is
implemented in Python using the NetECI API\&.
.PP
\fBECANORMALIZE\fP
.PP
Ecanormalize is a command-line tool for normalizing audio
files to utilize the full available sample resolution\&. Ecanormalize
first finds out how much the input file can be amplified without
clipping and if there is room for increase, a static gain will
be applied to the file\&.
.PP
\fBECAPLAY\fP
.PP
Ecaplay is a command-line tool for playing audio files\&. Ecaplay
uses the libecasound engine and is thus able to handle all audio formats
supported by the library\&.
.PP
Files can be selected for playback either by specifying the
filenames on the command-line, or by using the playlist
mechanism\&. In playlist mode, files can be added to the playlist
using the \fI-q\fP option\&. The \fI-p\fP option can then be used
to play all tracks on the playlist\&. Ecaplay will repeat the
playlist tracks until explicitly stopped (with double Ctrl-C)\&.
Playlist can be flushed with \fI-f\fP and its contents listed
with \fI-l\fP option\&.
.PP
If not otherwise specified, ecaplay will use the audio output device
specified in \fI~/\&.ecasound/ecasoundrc\fP for playback\&. A different
output device can be selected with \fIECAPLAY_OUTPUT_DEVICE\fP shell
environment variable or with the \fI-o:output_device\fP command-line
option\&.
.PP
Playback can be stopped at any time with Ctrl-C\&. If multiple
files are played, first Ctrl-C will stop the current file and move
on to play the next one\&. Issuing Ctrl-C twice (within one second),
will cause ecaplay to exit\&.
.PP
.IP "-d:debuglevel"
Set libecasound debug level\&. See ecasound(1)\&.
.IP
.IP "-f"
Flush the playlist contents\&. See also
options \fI-l, -p and -q\fP\&.
.IP
.IP "-h"
Print usage information and exit\&.
.IP
.IP "-k:number"
Skip \&'number\&' of files\&.
.IP
.IP "-l"
List the current playlist contents to stdout\&. See also
options \fI-f, -p and -q\fP\&.
.IP
.IP "-o:output_device"
Use \&'output_device\&' instead of the default output device
(as specified in \fI~/\&.ecasound/ecasoundrc\fP)\&. Syntax is same
as used by "-o" ecasound option (see ecasound(1) man page)\&.
This option overrides the \fIECAPLAY_OUTPUT_DEVICE\fP environment
variable (more info below)\&.
.IP
.IP "-p"
Play tracks in the playlist (in looped mode)\&. See also
options \fI-f, -l and -q\fP\&.
.IP
.IP "-q"
Queue new tracks to the playlist\&. All filenames given on
the command-line will be added to the the playlist\&. It is
possible to queue new tracks while another instance of
ecaplay is using the playlist\&. See also options \fI-f, -l
and -p\fP\&.
.IP
\fBECASIGNALVIEW\fP
.PP
Ecasignalview is meant for monitoring signal amplitude and peak
statistics\&. It accepts the following options:
.PP
.IP "input"
The first option not starting with a \&'-\&' is interpreted
as an input string\&. This can be a device or a filename\&. All formats
supported by libecasound are accepted\&. Defaults to \&'/dev/dsp\&'\&.
.IP
.IP "output"
Similarly to input, second option not starting with a \&'-\&'
is interpreted as output\&. Defaults to \&'null\&'\&.
.IP
.IP "-b:buffersize"
Buffersize in sample frames\&. Defaults to 128\&.
.IP
.IP "-c"
Enable cumulative mode\&. Counters are not reseted after refresh\&.
\fI*deprecated*\fP
.IP
.IP "-d"
Enable debug mode\&.
.IP
.IP "-f:format_string"
Specify default audio format\&. See ecasound(1) for details\&.
.IP
.IP "-r:rate_msec"
Specify screen refresh rate in milliseconds\&.
.IP
.IP "-I"
Use linear scale for showing audio sample amplitude\&.
.IP
.IP "-L"
Use logarithmic scale for showing audio sample amplitude\&.
.IP
.IP "-G, -B, -M*, -r, -z"
Ecasound options use to modify the engine behaviour, see
ecasound(1) manpage for details\&.
.IP
When ecasignalview is running, the following keyboard
commands can be used to control the operation (requires
system support for UNIX terminal interface control):
.PP
.IP "spacebar"
Reset statistics (max-peak, avg-amplitude and clipped
samples count)\&.
.IP
.IP "q or Q or Esc"
Quit ecasignalview\&.
.IP
It is also possible to reset the max-peak and clipped-samples
counters by sending a SIGHUP signal to the process (i\&.e\&.
from another console: "killall -v -HUP ecasignalview")\&.
.PP
More complete documentation for ecasignalview can be found
from "Ecasound User\&'s Guide" (see \&'\&'http://www\&.eca\&.cx/ecasound
-> Documentation\&'\&')\&.
.PP
.SH "ENVIRONMENT"
.PP
\fIECASOUND\fP
Path to the ecasound executable\&. Used by many ecatools\&.
.PP
\fIECAPLAY_OUTPUT_DEVICE\fP
Device ecaplay should use for audio output\&. Same syntax
as for ecaplay/ecasound "-o" option\&.
.PP
.SH "FILES"
.PP
\fI~/\&.ecasound/ecasoundrc\fP
The default ecasound resource file\&. See ecasoundrc(5)
for details\&.
.PP
\fI~/\&.ecasound/ecaplay_queue\fP
File used to store the ecaplay playlist (one track per
line with full path)\&.
.PP
.SH "SEE ALSO"
.PP
ecasound (1), ecalength(1), "HTML docs in the Documentation subdirectory"
.PP
.SH "AUTHOR"
.PP
Kai Vehmanen, <kvehmanen -at- eca -dot- cx <kvehmanen -at- eca -dot- cx>>

76
library/ecasound/Documentation/ecalength.1 Normal file
View file

@ -0,0 +1,76 @@
.TH "ecalength" "1" "18\&.04\&.2004" "" "Multimedia software"
.PP
.SH "NAME"
ecalength \- prints audio file lenght and other information
.PP
.SH "SYNOPSIS"
\fBecalength\fP [-ahtsfmbcr] FILE1 [FILE2] [FILEn]
.PP
.SH "DESCRIPTION"
.PP
This is ecalength, a few lines of code pompously named so because they
let one retrieve the length of an audio file from the command line
using ecasound\&'s engine\&.
.PP
Limitations:
.IP ""
- With files without header information (raw files), ecalength will only work
correctly if the audio file is at a sampling rate of 44100 hz\&.
(Addressed with the -a switch\&.)
.IP ""
- It is not foolproof, feeding it with something other than an audio
file WILL result in ugly things being spewed back\&.
(A bit better)
.IP ""
- A thousand more that I haven\&'t thought of\&.
.PP
.SH "OPTIONS"
.PP
.IP "-h"
Prints this usage message\&. (help)
.IP
.IP "-a[:]bits,channels,rate"
Changes the format assumed by default for headerless data\&. (adjust)
.IP
.IP "-t"
Prints the summed length of all the files processed\&. (total)
(Ignored if with -s)
.IP
.IP "-s"
Enables script mode: One info type per file per line\&. (script)
(Defaults to length in secs\&.)
.IP
.IP "-f"
With -s will return the format string as info, alone it will
add it to the main display\&. (format)
.IP
.IP "-b"
If -s and -f are enabled with this the info printed will be
the sample\&'s bitwidth\&. (bits)
.IP
.IP "-c"
If -s and -f are enabled with this the info printed will be
the channel count\&. (channel count)
.IP
.IP "-r"
If -s and -f are enabled with this the info printed will be
the sampling rate\&. (rate)
.IP
.IP "-m"
Will print human computable time as in main display but in
batch fashion\&. (minutes) (Only with -s)
.PP
.SH "SEE ALSO"
.PP
ecasound(1), ecatools(1)
.PP
.SH "AUTHOR"
.PP
S\&.Massy, <observer |at| colba\&.net <observer |at| colba\&.net>>

95
library/ecasound/Documentation/ecalength_manpage.html Normal file
View file

@ -0,0 +1,95 @@
<html><head>
<title>ecalength</title>
<link rev="made" href="mailto:observer .at. colba .dot. net">
</head>
<body>
<hr>
<h1>ecalength</h1>
<h2>18.04.2004</h2>
<html><head>
<link rev="made" href="mailto:observer .at. colba .dot. net">
</head>
<body>
<hr>
<h1></h1>
<html><head>
<title>ecalength(1)</title>
<link rev="made" href="mailto:observer .at. colba .dot. net">
</head>
<body>
<hr>
<h1>ecalength(1)</h1>
<h2> Multimedia software</h2>
<h2>18.04.2004</h2>
<p>
<h2>NAME</h2>ecalength - prints audio file lenght and other information
<p>
<h2>SYNOPSIS</h2>
<strong>ecalength</strong> [-ahtsfmbcr] FILE1 [FILE2] [FILEn]
<p>
<h2>DESCRIPTION</h2>
<p>
This is ecalength, a few lines of code pompously named so because they
let one retrieve the length of an audio file from the command line
using ecasound's engine.
<p>
Limitations:
<dl>
<p><dt><strong></strong><dd>- With files without header information (raw files), ecalength will only work
correctly if the audio file is at a sampling rate of 44100 hz.
(Addressed with the -a switch.)
<p><dt><strong></strong><dd> - It is not foolproof, feeding it with something other than an audio
file WILL result in ugly things being spewed back.
(A bit better)
<p><dt><strong></strong><dd> - A thousand more that I haven't thought of.
</dl>
<p>
<h2>OPTIONS</h2>
<p>
<dl>
<p><dt><strong>-h</strong><dd>
Prints this usage message. (help)
<p>
<p><dt><strong>-a[:]bits,channels,rate</strong><dd>
Changes the format assumed by default for headerless data. (adjust)
<p>
<p><dt><strong>-t</strong><dd>
Prints the summed length of all the files processed. (total)
(Ignored if with -s)
<p>
<p><dt><strong>-s</strong><dd>
Enables script mode: One info type per file per line. (script)
(Defaults to length in secs.)
<p>
<p><dt><strong>-f</strong><dd>
With -s will return the format string as info, alone it will
add it to the main display. (format)
<p>
<p><dt><strong>-b</strong><dd>
If -s and -f are enabled with this the info printed will be
the sample's bitwidth. (bits)
<p>
<p><dt><strong>-c</strong><dd>
If -s and -f are enabled with this the info printed will be
the channel count. (channel count)
<p>
<p><dt><strong>-r</strong><dd>
If -s and -f are enabled with this the info printed will be
the sampling rate. (rate)
<p>
<p><dt><strong>-m</strong><dd>
Will print human computable time as in main display but in
batch fashion. (minutes) (Only with -s)
</dl>
<p>
<h2>SEE ALSO</h2>
<p>
ecasound(1), ecatools(1)
<p>
<h2>AUTHOR</h2>
<p>
S.Massy, &lt;<a href="mailto:observer |at| colba.net"><em>observer |at| colba.net</em></a>&gt;

220
library/ecasound/Documentation/ecamonitor.1 Normal file
View file

@ -0,0 +1,220 @@
.TH "ecatools" "1" "12\&.11\&.2005" "" "Multimedia software"
.PP
.SH "NAME"
ecatools \- audio processing utils based on ecasound
.PP
.SH "SYNOPSIS"
\fBecaconvert\fP \&.extension file1 [ file2 \&.\&.\&. fileN ]
.PP
\fBecafixdc\fP file1 [ file2 \&.\&.\&. fileN ]
.PP
\fBecalength\fP file1 [ file2 \&.\&.\&. fileN ]
.PP
\fBecamonitor\fP [host][:port]
.PP
\fBecanormalize\fP file1 [ file2 \&.\&.\&. fileN ]
.PP
\fBecaplay\fP [-dfhklopq] [ file1 file2 \&.\&.\&. fileN ]
.PP
\fBecasignalview\fP [ options ] [ input ] [ output ]
.PP
.SH "DESCRIPTION"
.PP
Ecatools are simple command line utils for audio file processing\&.
Each tool is designed to perform one specific operation\&. Most of
the tools also support batch processing\&.
.PP
\fBECACONVERT\fP
.PP
A tool for converting a set of files to a common target format\&.
This target format is given as the first command line
argument, and its syntax is \fI\&.ext\fP\&.
.PP
\fBECAFIXDC\fP
.PP
A simple command-line tool for fixing DC-offset\&.
.PP
\fBECALENGTH\fP
.PP
See the separate ecalength(1) man page\&.
.PP
\fBECAMONITOR\fP
.PP
Ecamonitor is a util program that can be used
to monitor an active ecasound session\&. Ecamonitor
is able to show information about the current
chainsetup such as list of inputs, outputs,
current position, effects, the engine status
and numerous other things\&.
.PP
By default ecamonitor will try to connect
to IP4 address "localhost", to port "2868"\&.
A different address can be specified when
starting ecamonitor, for example
"ecamonitor foo\&.mynetwork\&.com" or
"ecamonitor foo\&.mynetwork\&.com:4500"\&.
.PP
To enable inbound connections, ecasound has to be
started with the \fI--daemon\fP option\&. Ecamonitor is
implemented in Python using the NetECI API\&.
.PP
\fBECANORMALIZE\fP
.PP
Ecanormalize is a command-line tool for normalizing audio
files to utilize the full available sample resolution\&. Ecanormalize
first finds out how much the input file can be amplified without
clipping and if there is room for increase, a static gain will
be applied to the file\&.
.PP
\fBECAPLAY\fP
.PP
Ecaplay is a command-line tool for playing audio files\&. Ecaplay
uses the libecasound engine and is thus able to handle all audio formats
supported by the library\&.
.PP
Files can be selected for playback either by specifying the
filenames on the command-line, or by using the playlist
mechanism\&. In playlist mode, files can be added to the playlist
using the \fI-q\fP option\&. The \fI-p\fP option can then be used
to play all tracks on the playlist\&. Ecaplay will repeat the
playlist tracks until explicitly stopped (with double Ctrl-C)\&.
Playlist can be flushed with \fI-f\fP and its contents listed
with \fI-l\fP option\&.
.PP
If not otherwise specified, ecaplay will use the audio output device
specified in \fI~/\&.ecasound/ecasoundrc\fP for playback\&. A different
output device can be selected with \fIECAPLAY_OUTPUT_DEVICE\fP shell
environment variable or with the \fI-o:output_device\fP command-line
option\&.
.PP
Playback can be stopped at any time with Ctrl-C\&. If multiple
files are played, first Ctrl-C will stop the current file and move
on to play the next one\&. Issuing Ctrl-C twice (within one second),
will cause ecaplay to exit\&.
.PP
.IP "-d:debuglevel"
Set libecasound debug level\&. See ecasound(1)\&.
.IP
.IP "-f"
Flush the playlist contents\&. See also
options \fI-l, -p and -q\fP\&.
.IP
.IP "-h"
Print usage information and exit\&.
.IP
.IP "-k:number"
Skip \&'number\&' of files\&.
.IP
.IP "-l"
List the current playlist contents to stdout\&. See also
options \fI-f, -p and -q\fP\&.
.IP
.IP "-o:output_device"
Use \&'output_device\&' instead of the default output device
(as specified in \fI~/\&.ecasound/ecasoundrc\fP)\&. Syntax is same
as used by "-o" ecasound option (see ecasound(1) man page)\&.
This option overrides the \fIECAPLAY_OUTPUT_DEVICE\fP environment
variable (more info below)\&.
.IP
.IP "-p"
Play tracks in the playlist (in looped mode)\&. See also
options \fI-f, -l and -q\fP\&.
.IP
.IP "-q"
Queue new tracks to the playlist\&. All filenames given on
the command-line will be added to the the playlist\&. It is
possible to queue new tracks while another instance of
ecaplay is using the playlist\&. See also options \fI-f, -l
and -p\fP\&.
.IP
\fBECASIGNALVIEW\fP
.PP
Ecasignalview is meant for monitoring signal amplitude and peak
statistics\&. It accepts the following options:
.PP
.IP "input"
The first option not starting with a \&'-\&' is interpreted
as an input string\&. This can be a device or a filename\&. All formats
supported by libecasound are accepted\&. Defaults to \&'/dev/dsp\&'\&.
.IP
.IP "output"
Similarly to input, second option not starting with a \&'-\&'
is interpreted as output\&. Defaults to \&'null\&'\&.
.IP
.IP "-b:buffersize"
Buffersize in sample frames\&. Defaults to 128\&.
.IP
.IP "-c"
Enable cumulative mode\&. Counters are not reseted after refresh\&.
\fI*deprecated*\fP
.IP
.IP "-d"
Enable debug mode\&.
.IP
.IP "-f:format_string"
Specify default audio format\&. See ecasound(1) for details\&.
.IP
.IP "-r:rate_msec"
Specify screen refresh rate in milliseconds\&.
.IP
.IP "-I"
Use linear scale for showing audio sample amplitude\&.
.IP
.IP "-L"
Use logarithmic scale for showing audio sample amplitude\&.
.IP
.IP "-G, -B, -M*, -r, -z"
Ecasound options use to modify the engine behaviour, see
ecasound(1) manpage for details\&.
.IP
When ecasignalview is running, the following keyboard
commands can be used to control the operation (requires
system support for UNIX terminal interface control):
.PP
.IP "spacebar"
Reset statistics (max-peak, avg-amplitude and clipped
samples count)\&.
.IP
.IP "q or Q or Esc"
Quit ecasignalview\&.
.IP
It is also possible to reset the max-peak and clipped-samples
counters by sending a SIGHUP signal to the process (i\&.e\&.
from another console: "killall -v -HUP ecasignalview")\&.
.PP
More complete documentation for ecasignalview can be found
from "Ecasound User\&'s Guide" (see \&'\&'http://www\&.eca\&.cx/ecasound
-> Documentation\&'\&')\&.
.PP
.SH "ENVIRONMENT"
.PP
\fIECASOUND\fP
Path to the ecasound executable\&. Used by many ecatools\&.
.PP
\fIECAPLAY_OUTPUT_DEVICE\fP
Device ecaplay should use for audio output\&. Same syntax
as for ecaplay/ecasound "-o" option\&.
.PP
.SH "FILES"
.PP
\fI~/\&.ecasound/ecasoundrc\fP
The default ecasound resource file\&. See ecasoundrc(5)
for details\&.
.PP
\fI~/\&.ecasound/ecaplay_queue\fP
File used to store the ecaplay playlist (one track per
line with full path)\&.
.PP
.SH "SEE ALSO"
.PP
ecasound (1), ecalength(1), "HTML docs in the Documentation subdirectory"
.PP
.SH "AUTHOR"
.PP
Kai Vehmanen, <kvehmanen -at- eca -dot- cx <kvehmanen -at- eca -dot- cx>>

220
library/ecasound/Documentation/ecanormalize.1 Normal file
View file

@ -0,0 +1,220 @@
.TH "ecatools" "1" "12\&.11\&.2005" "" "Multimedia software"
.PP
.SH "NAME"
ecatools \- audio processing utils based on ecasound
.PP
.SH "SYNOPSIS"
\fBecaconvert\fP \&.extension file1 [ file2 \&.\&.\&. fileN ]
.PP
\fBecafixdc\fP file1 [ file2 \&.\&.\&. fileN ]
.PP
\fBecalength\fP file1 [ file2 \&.\&.\&. fileN ]
.PP
\fBecamonitor\fP [host][:port]
.PP
\fBecanormalize\fP file1 [ file2 \&.\&.\&. fileN ]
.PP
\fBecaplay\fP [-dfhklopq] [ file1 file2 \&.\&.\&. fileN ]
.PP
\fBecasignalview\fP [ options ] [ input ] [ output ]
.PP
.SH "DESCRIPTION"
.PP
Ecatools are simple command line utils for audio file processing\&.
Each tool is designed to perform one specific operation\&. Most of
the tools also support batch processing\&.
.PP
\fBECACONVERT\fP
.PP
A tool for converting a set of files to a common target format\&.
This target format is given as the first command line
argument, and its syntax is \fI\&.ext\fP\&.
.PP
\fBECAFIXDC\fP
.PP
A simple command-line tool for fixing DC-offset\&.
.PP
\fBECALENGTH\fP
.PP
See the separate ecalength(1) man page\&.
.PP
\fBECAMONITOR\fP
.PP
Ecamonitor is a util program that can be used
to monitor an active ecasound session\&. Ecamonitor
is able to show information about the current
chainsetup such as list of inputs, outputs,
current position, effects, the engine status
and numerous other things\&.
.PP
By default ecamonitor will try to connect
to IP4 address "localhost", to port "2868"\&.
A different address can be specified when
starting ecamonitor, for example
"ecamonitor foo\&.mynetwork\&.com" or
"ecamonitor foo\&.mynetwork\&.com:4500"\&.
.PP
To enable inbound connections, ecasound has to be
started with the \fI--daemon\fP option\&. Ecamonitor is
implemented in Python using the NetECI API\&.
.PP
\fBECANORMALIZE\fP
.PP
Ecanormalize is a command-line tool for normalizing audio
files to utilize the full available sample resolution\&. Ecanormalize
first finds out how much the input file can be amplified without
clipping and if there is room for increase, a static gain will
be applied to the file\&.
.PP
\fBECAPLAY\fP
.PP
Ecaplay is a command-line tool for playing audio files\&. Ecaplay
uses the libecasound engine and is thus able to handle all audio formats
supported by the library\&.
.PP
Files can be selected for playback either by specifying the
filenames on the command-line, or by using the playlist
mechanism\&. In playlist mode, files can be added to the playlist
using the \fI-q\fP option\&. The \fI-p\fP option can then be used
to play all tracks on the playlist\&. Ecaplay will repeat the
playlist tracks until explicitly stopped (with double Ctrl-C)\&.
Playlist can be flushed with \fI-f\fP and its contents listed
with \fI-l\fP option\&.
.PP
If not otherwise specified, ecaplay will use the audio output device
specified in \fI~/\&.ecasound/ecasoundrc\fP for playback\&. A different
output device can be selected with \fIECAPLAY_OUTPUT_DEVICE\fP shell
environment variable or with the \fI-o:output_device\fP command-line
option\&.
.PP
Playback can be stopped at any time with Ctrl-C\&. If multiple
files are played, first Ctrl-C will stop the current file and move
on to play the next one\&. Issuing Ctrl-C twice (within one second),
will cause ecaplay to exit\&.
.PP
.IP "-d:debuglevel"
Set libecasound debug level\&. See ecasound(1)\&.
.IP
.IP "-f"
Flush the playlist contents\&. See also
options \fI-l, -p and -q\fP\&.
.IP
.IP "-h"
Print usage information and exit\&.
.IP
.IP "-k:number"
Skip \&'number\&' of files\&.
.IP
.IP "-l"
List the current playlist contents to stdout\&. See also
options \fI-f, -p and -q\fP\&.
.IP
.IP "-o:output_device"
Use \&'output_device\&' instead of the default output device
(as specified in \fI~/\&.ecasound/ecasoundrc\fP)\&. Syntax is same
as used by "-o" ecasound option (see ecasound(1) man page)\&.
This option overrides the \fIECAPLAY_OUTPUT_DEVICE\fP environment
variable (more info below)\&.
.IP
.IP "-p"
Play tracks in the playlist (in looped mode)\&. See also
options \fI-f, -l and -q\fP\&.
.IP
.IP "-q"
Queue new tracks to the playlist\&. All filenames given on
the command-line will be added to the the playlist\&. It is
possible to queue new tracks while another instance of
ecaplay is using the playlist\&. See also options \fI-f, -l
and -p\fP\&.
.IP
\fBECASIGNALVIEW\fP
.PP
Ecasignalview is meant for monitoring signal amplitude and peak
statistics\&. It accepts the following options:
.PP
.IP "input"
The first option not starting with a \&'-\&' is interpreted
as an input string\&. This can be a device or a filename\&. All formats
supported by libecasound are accepted\&. Defaults to \&'/dev/dsp\&'\&.
.IP
.IP "output"
Similarly to input, second option not starting with a \&'-\&'
is interpreted as output\&. Defaults to \&'null\&'\&.
.IP
.IP "-b:buffersize"
Buffersize in sample frames\&. Defaults to 128\&.
.IP
.IP "-c"
Enable cumulative mode\&. Counters are not reseted after refresh\&.
\fI*deprecated*\fP
.IP
.IP "-d"
Enable debug mode\&.
.IP
.IP "-f:format_string"
Specify default audio format\&. See ecasound(1) for details\&.
.IP
.IP "-r:rate_msec"
Specify screen refresh rate in milliseconds\&.
.IP
.IP "-I"
Use linear scale for showing audio sample amplitude\&.
.IP
.IP "-L"
Use logarithmic scale for showing audio sample amplitude\&.
.IP
.IP "-G, -B, -M*, -r, -z"
Ecasound options use to modify the engine behaviour, see
ecasound(1) manpage for details\&.
.IP
When ecasignalview is running, the following keyboard
commands can be used to control the operation (requires
system support for UNIX terminal interface control):
.PP
.IP "spacebar"
Reset statistics (max-peak, avg-amplitude and clipped
samples count)\&.
.IP
.IP "q or Q or Esc"
Quit ecasignalview\&.
.IP
It is also possible to reset the max-peak and clipped-samples
counters by sending a SIGHUP signal to the process (i\&.e\&.
from another console: "killall -v -HUP ecasignalview")\&.
.PP
More complete documentation for ecasignalview can be found
from "Ecasound User\&'s Guide" (see \&'\&'http://www\&.eca\&.cx/ecasound
-> Documentation\&'\&')\&.
.PP
.SH "ENVIRONMENT"
.PP
\fIECASOUND\fP
Path to the ecasound executable\&. Used by many ecatools\&.
.PP
\fIECAPLAY_OUTPUT_DEVICE\fP
Device ecaplay should use for audio output\&. Same syntax
as for ecaplay/ecasound "-o" option\&.
.PP
.SH "FILES"
.PP
\fI~/\&.ecasound/ecasoundrc\fP
The default ecasound resource file\&. See ecasoundrc(5)
for details\&.
.PP
\fI~/\&.ecasound/ecaplay_queue\fP
File used to store the ecaplay playlist (one track per
line with full path)\&.
.PP
.SH "SEE ALSO"
.PP
ecasound (1), ecalength(1), "HTML docs in the Documentation subdirectory"
.PP
.SH "AUTHOR"
.PP
Kai Vehmanen, <kvehmanen -at- eca -dot- cx <kvehmanen -at- eca -dot- cx>>

220
library/ecasound/Documentation/ecaplay.1 Normal file
View file

@ -0,0 +1,220 @@
.TH "ecatools" "1" "12\&.11\&.2005" "" "Multimedia software"
.PP
.SH "NAME"
ecatools \- audio processing utils based on ecasound
.PP
.SH "SYNOPSIS"
\fBecaconvert\fP \&.extension file1 [ file2 \&.\&.\&. fileN ]
.PP
\fBecafixdc\fP file1 [ file2 \&.\&.\&. fileN ]
.PP
\fBecalength\fP file1 [ file2 \&.\&.\&. fileN ]
.PP
\fBecamonitor\fP [host][:port]
.PP
\fBecanormalize\fP file1 [ file2 \&.\&.\&. fileN ]
.PP
\fBecaplay\fP [-dfhklopq] [ file1 file2 \&.\&.\&. fileN ]
.PP
\fBecasignalview\fP [ options ] [ input ] [ output ]
.PP
.SH "DESCRIPTION"
.PP
Ecatools are simple command line utils for audio file processing\&.
Each tool is designed to perform one specific operation\&. Most of
the tools also support batch processing\&.
.PP
\fBECACONVERT\fP
.PP
A tool for converting a set of files to a common target format\&.
This target format is given as the first command line
argument, and its syntax is \fI\&.ext\fP\&.
.PP
\fBECAFIXDC\fP
.PP
A simple command-line tool for fixing DC-offset\&.
.PP
\fBECALENGTH\fP
.PP
See the separate ecalength(1) man page\&.
.PP
\fBECAMONITOR\fP
.PP
Ecamonitor is a util program that can be used
to monitor an active ecasound session\&. Ecamonitor
is able to show information about the current
chainsetup such as list of inputs, outputs,
current position, effects, the engine status
and numerous other things\&.
.PP
By default ecamonitor will try to connect
to IP4 address "localhost", to port "2868"\&.
A different address can be specified when
starting ecamonitor, for example
"ecamonitor foo\&.mynetwork\&.com" or
"ecamonitor foo\&.mynetwork\&.com:4500"\&.
.PP
To enable inbound connections, ecasound has to be
started with the \fI--daemon\fP option\&. Ecamonitor is
implemented in Python using the NetECI API\&.
.PP
\fBECANORMALIZE\fP
.PP
Ecanormalize is a command-line tool for normalizing audio
files to utilize the full available sample resolution\&. Ecanormalize
first finds out how much the input file can be amplified without
clipping and if there is room for increase, a static gain will
be applied to the file\&.
.PP
\fBECAPLAY\fP
.PP
Ecaplay is a command-line tool for playing audio files\&. Ecaplay
uses the libecasound engine and is thus able to handle all audio formats
supported by the library\&.
.PP
Files can be selected for playback either by specifying the
filenames on the command-line, or by using the playlist
mechanism\&. In playlist mode, files can be added to the playlist
using the \fI-q\fP option\&. The \fI-p\fP option can then be used
to play all tracks on the playlist\&. Ecaplay will repeat the
playlist tracks until explicitly stopped (with double Ctrl-C)\&.
Playlist can be flushed with \fI-f\fP and its contents listed
with \fI-l\fP option\&.
.PP
If not otherwise specified, ecaplay will use the audio output device
specified in \fI~/\&.ecasound/ecasoundrc\fP for playback\&. A different
output device can be selected with \fIECAPLAY_OUTPUT_DEVICE\fP shell
environment variable or with the \fI-o:output_device\fP command-line
option\&.
.PP
Playback can be stopped at any time with Ctrl-C\&. If multiple
files are played, first Ctrl-C will stop the current file and move
on to play the next one\&. Issuing Ctrl-C twice (within one second),
will cause ecaplay to exit\&.
.PP
.IP "-d:debuglevel"
Set libecasound debug level\&. See ecasound(1)\&.
.IP
.IP "-f"
Flush the playlist contents\&. See also
options \fI-l, -p and -q\fP\&.
.IP
.IP "-h"
Print usage information and exit\&.
.IP
.IP "-k:number"
Skip \&'number\&' of files\&.
.IP
.IP "-l"
List the current playlist contents to stdout\&. See also
options \fI-f, -p and -q\fP\&.
.IP
.IP "-o:output_device"
Use \&'output_device\&' instead of the default output device
(as specified in \fI~/\&.ecasound/ecasoundrc\fP)\&. Syntax is same
as used by "-o" ecasound option (see ecasound(1) man page)\&.
This option overrides the \fIECAPLAY_OUTPUT_DEVICE\fP environment
variable (more info below)\&.
.IP
.IP "-p"
Play tracks in the playlist (in looped mode)\&. See also
options \fI-f, -l and -q\fP\&.
.IP
.IP "-q"
Queue new tracks to the playlist\&. All filenames given on
the command-line will be added to the the playlist\&. It is
possible to queue new tracks while another instance of
ecaplay is using the playlist\&. See also options \fI-f, -l
and -p\fP\&.
.IP
\fBECASIGNALVIEW\fP
.PP
Ecasignalview is meant for monitoring signal amplitude and peak
statistics\&. It accepts the following options:
.PP
.IP "input"
The first option not starting with a \&'-\&' is interpreted
as an input string\&. This can be a device or a filename\&. All formats
supported by libecasound are accepted\&. Defaults to \&'/dev/dsp\&'\&.
.IP
.IP "output"
Similarly to input, second option not starting with a \&'-\&'
is interpreted as output\&. Defaults to \&'null\&'\&.
.IP
.IP "-b:buffersize"
Buffersize in sample frames\&. Defaults to 128\&.
.IP
.IP "-c"
Enable cumulative mode\&. Counters are not reseted after refresh\&.
\fI*deprecated*\fP
.IP
.IP "-d"
Enable debug mode\&.
.IP
.IP "-f:format_string"
Specify default audio format\&. See ecasound(1) for details\&.
.IP
.IP "-r:rate_msec"
Specify screen refresh rate in milliseconds\&.
.IP
.IP "-I"
Use linear scale for showing audio sample amplitude\&.
.IP
.IP "-L"
Use logarithmic scale for showing audio sample amplitude\&.
.IP
.IP "-G, -B, -M*, -r, -z"
Ecasound options use to modify the engine behaviour, see
ecasound(1) manpage for details\&.
.IP
When ecasignalview is running, the following keyboard
commands can be used to control the operation (requires
system support for UNIX terminal interface control):
.PP
.IP "spacebar"
Reset statistics (max-peak, avg-amplitude and clipped
samples count)\&.
.IP
.IP "q or Q or Esc"
Quit ecasignalview\&.
.IP
It is also possible to reset the max-peak and clipped-samples
counters by sending a SIGHUP signal to the process (i\&.e\&.
from another console: "killall -v -HUP ecasignalview")\&.
.PP
More complete documentation for ecasignalview can be found
from "Ecasound User\&'s Guide" (see \&'\&'http://www\&.eca\&.cx/ecasound
-> Documentation\&'\&')\&.
.PP
.SH "ENVIRONMENT"
.PP
\fIECASOUND\fP
Path to the ecasound executable\&. Used by many ecatools\&.
.PP
\fIECAPLAY_OUTPUT_DEVICE\fP
Device ecaplay should use for audio output\&. Same syntax
as for ecaplay/ecasound "-o" option\&.
.PP
.SH "FILES"
.PP
\fI~/\&.ecasound/ecasoundrc\fP
The default ecasound resource file\&. See ecasoundrc(5)
for details\&.
.PP
\fI~/\&.ecasound/ecaplay_queue\fP
File used to store the ecaplay playlist (one track per
line with full path)\&.
.PP
.SH "SEE ALSO"
.PP
ecasound (1), ecalength(1), "HTML docs in the Documentation subdirectory"
.PP
.SH "AUTHOR"
.PP
Kai Vehmanen, <kvehmanen -at- eca -dot- cx <kvehmanen -at- eca -dot- cx>>

220
library/ecasound/Documentation/ecasignalview.1 Normal file
View file

@ -0,0 +1,220 @@
.TH "ecatools" "1" "12\&.11\&.2005" "" "Multimedia software"
.PP
.SH "NAME"
ecatools \- audio processing utils based on ecasound
.PP
.SH "SYNOPSIS"
\fBecaconvert\fP \&.extension file1 [ file2 \&.\&.\&. fileN ]
.PP
\fBecafixdc\fP file1 [ file2 \&.\&.\&. fileN ]
.PP
\fBecalength\fP file1 [ file2 \&.\&.\&. fileN ]
.PP
\fBecamonitor\fP [host][:port]
.PP
\fBecanormalize\fP file1 [ file2 \&.\&.\&. fileN ]
.PP
\fBecaplay\fP [-dfhklopq] [ file1 file2 \&.\&.\&. fileN ]
.PP
\fBecasignalview\fP [ options ] [ input ] [ output ]
.PP
.SH "DESCRIPTION"
.PP
Ecatools are simple command line utils for audio file processing\&.
Each tool is designed to perform one specific operation\&. Most of
the tools also support batch processing\&.
.PP
\fBECACONVERT\fP
.PP
A tool for converting a set of files to a common target format\&.
This target format is given as the first command line
argument, and its syntax is \fI\&.ext\fP\&.
.PP
\fBECAFIXDC\fP
.PP
A simple command-line tool for fixing DC-offset\&.
.PP
\fBECALENGTH\fP
.PP
See the separate ecalength(1) man page\&.
.PP
\fBECAMONITOR\fP
.PP
Ecamonitor is a util program that can be used
to monitor an active ecasound session\&. Ecamonitor
is able to show information about the current
chainsetup such as list of inputs, outputs,
current position, effects, the engine status
and numerous other things\&.
.PP
By default ecamonitor will try to connect
to IP4 address "localhost", to port "2868"\&.
A different address can be specified when
starting ecamonitor, for example
"ecamonitor foo\&.mynetwork\&.com" or
"ecamonitor foo\&.mynetwork\&.com:4500"\&.
.PP
To enable inbound connections, ecasound has to be
started with the \fI--daemon\fP option\&. Ecamonitor is
implemented in Python using the NetECI API\&.
.PP
\fBECANORMALIZE\fP
.PP
Ecanormalize is a command-line tool for normalizing audio
files to utilize the full available sample resolution\&. Ecanormalize
first finds out how much the input file can be amplified without
clipping and if there is room for increase, a static gain will
be applied to the file\&.
.PP
\fBECAPLAY\fP
.PP
Ecaplay is a command-line tool for playing audio files\&. Ecaplay
uses the libecasound engine and is thus able to handle all audio formats
supported by the library\&.
.PP
Files can be selected for playback either by specifying the
filenames on the command-line, or by using the playlist
mechanism\&. In playlist mode, files can be added to the playlist
using the \fI-q\fP option\&. The \fI-p\fP option can then be used
to play all tracks on the playlist\&. Ecaplay will repeat the
playlist tracks until explicitly stopped (with double Ctrl-C)\&.
Playlist can be flushed with \fI-f\fP and its contents listed
with \fI-l\fP option\&.
.PP
If not otherwise specified, ecaplay will use the audio output device
specified in \fI~/\&.ecasound/ecasoundrc\fP for playback\&. A different
output device can be selected with \fIECAPLAY_OUTPUT_DEVICE\fP shell
environment variable or with the \fI-o:output_device\fP command-line
option\&.
.PP
Playback can be stopped at any time with Ctrl-C\&. If multiple
files are played, first Ctrl-C will stop the current file and move
on to play the next one\&. Issuing Ctrl-C twice (within one second),
will cause ecaplay to exit\&.
.PP
.IP "-d:debuglevel"
Set libecasound debug level\&. See ecasound(1)\&.
.IP
.IP "-f"
Flush the playlist contents\&. See also
options \fI-l, -p and -q\fP\&.
.IP
.IP "-h"
Print usage information and exit\&.
.IP
.IP "-k:number"
Skip \&'number\&' of files\&.
.IP
.IP "-l"
List the current playlist contents to stdout\&. See also
options \fI-f, -p and -q\fP\&.
.IP
.IP "-o:output_device"
Use \&'output_device\&' instead of the default output device
(as specified in \fI~/\&.ecasound/ecasoundrc\fP)\&. Syntax is same
as used by "-o" ecasound option (see ecasound(1) man page)\&.
This option overrides the \fIECAPLAY_OUTPUT_DEVICE\fP environment
variable (more info below)\&.
.IP
.IP "-p"
Play tracks in the playlist (in looped mode)\&. See also
options \fI-f, -l and -q\fP\&.
.IP
.IP "-q"
Queue new tracks to the playlist\&. All filenames given on
the command-line will be added to the the playlist\&. It is
possible to queue new tracks while another instance of
ecaplay is using the playlist\&. See also options \fI-f, -l
and -p\fP\&.
.IP
\fBECASIGNALVIEW\fP
.PP
Ecasignalview is meant for monitoring signal amplitude and peak
statistics\&. It accepts the following options:
.PP
.IP "input"
The first option not starting with a \&'-\&' is interpreted
as an input string\&. This can be a device or a filename\&. All formats
supported by libecasound are accepted\&. Defaults to \&'/dev/dsp\&'\&.
.IP
.IP "output"
Similarly to input, second option not starting with a \&'-\&'
is interpreted as output\&. Defaults to \&'null\&'\&.
.IP
.IP "-b:buffersize"
Buffersize in sample frames\&. Defaults to 128\&.
.IP
.IP "-c"
Enable cumulative mode\&. Counters are not reseted after refresh\&.
\fI*deprecated*\fP
.IP
.IP "-d"
Enable debug mode\&.
.IP
.IP "-f:format_string"
Specify default audio format\&. See ecasound(1) for details\&.
.IP
.IP "-r:rate_msec"
Specify screen refresh rate in milliseconds\&.
.IP
.IP "-I"
Use linear scale for showing audio sample amplitude\&.
.IP
.IP "-L"
Use logarithmic scale for showing audio sample amplitude\&.
.IP
.IP "-G, -B, -M*, -r, -z"
Ecasound options use to modify the engine behaviour, see
ecasound(1) manpage for details\&.
.IP
When ecasignalview is running, the following keyboard
commands can be used to control the operation (requires
system support for UNIX terminal interface control):
.PP
.IP "spacebar"
Reset statistics (max-peak, avg-amplitude and clipped
samples count)\&.
.IP
.IP "q or Q or Esc"
Quit ecasignalview\&.
.IP
It is also possible to reset the max-peak and clipped-samples
counters by sending a SIGHUP signal to the process (i\&.e\&.
from another console: "killall -v -HUP ecasignalview")\&.
.PP
More complete documentation for ecasignalview can be found
from "Ecasound User\&'s Guide" (see \&'\&'http://www\&.eca\&.cx/ecasound
-> Documentation\&'\&')\&.
.PP
.SH "ENVIRONMENT"
.PP
\fIECASOUND\fP
Path to the ecasound executable\&. Used by many ecatools\&.
.PP
\fIECAPLAY_OUTPUT_DEVICE\fP
Device ecaplay should use for audio output\&. Same syntax
as for ecaplay/ecasound "-o" option\&.
.PP
.SH "FILES"
.PP
\fI~/\&.ecasound/ecasoundrc\fP
The default ecasound resource file\&. See ecasoundrc(5)
for details\&.
.PP
\fI~/\&.ecasound/ecaplay_queue\fP
File used to store the ecaplay playlist (one track per
line with full path)\&.
.PP
.SH "SEE ALSO"
.PP
ecasound (1), ecalength(1), "HTML docs in the Documentation subdirectory"
.PP
.SH "AUTHOR"
.PP
Kai Vehmanen, <kvehmanen -at- eca -dot- cx <kvehmanen -at- eca -dot- cx>>

722
library/ecasound/Documentation/ecasound-iam.1 Normal file
View file

@ -0,0 +1,722 @@
.TH "ecasound-iam" "1" "11\&.10\&.2009" "" "Multimedia software"
.PP
.SH "NAME"
ecasound-iam \- ecasound interactive mode
.SH "SYNOPSIS"
.PP
.SH "DESCRIPTION"
.PP
Ecasound library contains an interpreter module that understands
a set of commands aimed at controlling various library services\&.
This is called the ecasound interactive mode (EIAM)\&. All programs
linked to ecasound library can use this facility\&.
.PP
.SH "ECI API and return types"
A special case of interactive mode use is ecasound\&'s control interface (ECI),
which is a small library providing easy access to the interactive
mode commands from outside of libecasound\&. When issuing inter commands using
the control interface, it\&'s possible that commands also return information\&.
Currently supported return value types are: string [s], list of strings [S]
(elements separated by commas; escaped if necessary), integer [i],
long integer [li] and floating-point number [f]\&. These definitions are
used throughout this document\&. Commands that return nothing (void) are
marked with [-]\&. Additionally, return type [e] marks an error condition\&.
When an interactive mode command results in an error, an error string
explaining the condition is returned\&.
.PP
.SH "Real-time commands"
It\&'s not possible to use all interactive mode commands to modify and
control objects that belong to a connected chainsetup\&. Commands that
do NOT support this are:
.PP
.RS
cs-remove, cs-set-length, cs-set-length-samples, cs-toggle-loop,
cs-set-param, cs-option,
c-add, c-remove, c-rename, c-clear,
ai-add, ai-remove, ai-attach, ai-forward, ai-rewind, ai-set-position,
ai-set-position-samples,
ao-add, ao-add-default, ao-remove, ao-attach, ao-forward, ao-rewind,
ao-set-position, ao-set-position-samples\&.
.RE
.PP
If one of these commands is issued when a chainsetup is connected,
ecasound will first stop and disconnect the chainsetup, process
the command, and the reconnect\&.
.PP
In addition, most non-modifying (const) commands work with
connected setups\&.
.PP
.SH "GENERAL"
.IP "quit, q"
Quit ecasound session\&. What this means in practice depends on the
client implementation\&. In ecasound interactive mode, \&'quit\&' terminates
the ecasound process\&. When sent over ecasound server connection (aka
NetECI), \&'quit\&' terminates the active network connection, but does not
terminate the ecasound server process\&. \fI[-]\fP
.IP
.IP "start, t"
Processing is started (play)\&. Error string is return if any errors upon
startup are encountered\&. \fI[e]\fP
.IP
.IP "stop, s"
Stop processing\&. \fI[-]\fP
.IP
.IP "run"
Like \&'start\&' but blocks until processing is finished\&. Error string
is return if any errors upon startup, or during process, are
encountered\&. \fI[e]\fP
.IP
.IP "debug \&'debug-level\&'"
Set debug level to \&'debug-level\&'\&. Notice that client programs can
reimplement the debug routines\&. \fI[-]\fP
.PP
.IP "resource-file \&'path-to-file\&'"
Overrides the global and user resource files\&. Does not affect
already created objects\&. This command is equivalent to \&'-R\&' ecasound
option (see ecasound (1) man page)\&.
.PP
.IP "-prefix:arg1,\&.\&.\&.,argN"
Equivalent to issuing \&'cs-option -prefix:arg1,\&.\&.\&.,argN)\&. See documentation
for \&'cs-option\&'\&.
.PP
.IP "help\&', \&'h\&'"
Help! \fI[-]\fP
.PP
.SH "GLOBAL"
.IP
.IP "engine-status"
Returns a string describing the engine status (running, stopped,
finished, error, not ready)\&. See also \fIcs-status\fP\&. \fI[s]\fP
.PP
.IP "engine-launch"
Starts the real-time engine\&. Engine will execute the currently
connected chainsetup (see \&'cs-connect)\&. This action does not yet
start actual processing (see \fIstart\fP and \fIstop\fP)\&. When
ecasound is used as a JACK client, issuing \fIengine-launch\fP
makes ecasound an active JACK client (i\&.e\&. ecasound\&'s ports
can be connected to other JACK clients)\&. \fI[-]\fP
.PP
.IP "engine-halt"
Stops the engine\&. Does not disconnect the chainsetup that
was running\&. See also \fIcs-disconnet\fP and \fIstop\fP\&. When
ecasound is used as a JACK client, \fIengine-halt\fP will
cause ecasound to become a deactivated client (all JACK
connections are torn down)\&. \fI[-]\fP
.PP
.SH "CHAINSETUPS"
Chainsetup is the central data object\&. All other objects (inputs,
outputs, chains, etc) are connected to some chainsetup\&. There can be
many chainsetups but only one can be connected\&. Similarly only
one chainsetup can be selected\&. If not otherwise specified operations
are done on the selected chainsetup\&. Some operations also require
that selected chainsetup is not connected\&.
.IP
.IP "cs-add \&'name\&'"
Adds a new chainsetup with name \&'name\&'\&. \&'name\&' is now
the selected chainsetup\&. \fI[-]\fP
.PP
.IP "cs-remove"
Removes currently selected chainsetup\&. \fI[-]\fP
.PP
.IP "cs-list"
Returns a list of all chainsetups\&. \fI[S]\fP
.PP
.IP "cs-select \&'name\&'"
Selects chainsetup \&'name\&'\&. \fI[-]\fP
.PP
.IP "cs-selected"
Returns the name of currently selected chainsetup\&. \fI[s]\fP
.PP
.IP "cs-index-select \&'cs_index\&', cs-iselect \&'cs_index\&'"
Selects a chainsetup based on a short index string\&. Chainsetup names
can be rather long\&. This command can be used to avoid typing
these long names\&. \&'cs_index\&' is an integer value, where \&'1\&' refers to
the first audio input/output\&. You can use \&'cs-list\&' and \&'cs-status\&'
to get a full list of currently available chainsetups\&. \fI[-]\fP
.PP
.IP "cs-load \&'filename\&'"
Adds a new chainsetup by loading it from file \&'filename\&'\&.
\&'filename\&' is now the selected chainsetup\&. \fI[-]\fP
.PP
.IP "cs-save"
Saves the currently selected chainsetup to file\&. If chainsetup was loaded
from a file, the saved version will replace the original\&. If it doesn\&'t
have a default filename, it\&'s saved to "chainsetup_name\&.ecs"\&. \fI[-]\fP
.PP
.IP "cs-save-as \&'filename\&'"
Saves currently selected chainsetup to file \&'filename\&'\&. \fI[-]\fP
.PP
.IP "cs-edit"
Currently selected chainsetup is saved to a temporary file\&. This
file is loaded to an external editor (see ecasoundrc (5))\&. After
editing, the chainsetup is loaded back to ecasound\&. \fI[-]\fP
.PP
.IP "cs-is-valid"
Whether currently selected chainsetup is valid (=can be connected)? \fI[i]\fP
.PP
.IP "cs-connect"
Connect currently selected chainsetup to engine\&. When connecting,
all resources (e\&.g\&. files, soundcard devices, external programs) needed
to execute the chainsetup are reserved\&. Only one chainsetup can be connected
at a time\&. Error string is returned if connection fails (for instance
due to error in allocating the resources)\&. \fI[e]\fP
.PP
.IP "cs-disconnect"
Disconnect currently connected chainsetup\&. This action will free
all external resources needed by the chainsetup\&. \fI[-]\fP
.PP
.IP "cs-connected"
Returns the name of currently connected chainsetup\&. \fI[s]\fP
.PP
.IP "cs-rewind \&'time-in-seconds\&', rewind \&'time-in-seconds\&', rw \&'time-in-seconds\&'"
Rewinds the current chainsetup position by \&'time-in-seconds\&' seconds\&.
Position of all inputs and outputs attached to the selected chainsetup
is also affected\&. \fI[-]\fP
.PP
.IP "cs-forward \&'time-in-seconds\&', forward \&'time-in-seconds\&', fw \&'ttime-in-seconds\&'"
The current chainsetup position is forwarded by \&'time-in-seconds\&'
seconds\&. Position of all inputs and outputs attached to the selected chainsetup
is also affected\&. \fI[-]\fP
.PP
.IP "cs-set-position \&'time-in-seconds\&', cs-setpos \&'time-in-seconds\&', setpos \&'time-in-seconds\&', set-position \&'time-in-seconds\&'"
Sets the chainsetup position to \&'time-in-seconds\&' seconds from the
beginning\&. Position of all inputs and outputs attached to the selected
chainsetup is also affected\&. \fI[-]\fP
.PP
.IP "cs-set-position-samples \&'time-in-samples\&'"
Sets the chainsetup position to \&'time-in-samples\&' samples from the
beginning\&. Position of all inputs and outputs attached to the selected
chainsetup is also affected\&. \fI[-]\fP
.PP
.IP "cs-get-position, cs-getpos, getpos, get-position"
Returns the current chainsetup position in seconds\&. \fI[f]\fP
.PP
.IP "cs-get-position-samples"
Returns the current chainsetup position in samples\&. \fI[li]\fP
.PP
.IP "cs-get-length, get-length"
Returns the chainsetup length in seconds (if known)\&. \fI[f]\fP
.PP
.IP "cs-get-length-samples, get-length-samples"
Returns the chainsetup length in samples (if known)\&. \fI[li]\fP
.PP
.IP "cs-set-length \&'seconds\&'"
Sets processing time in seconds (doesn\&'t have to be an integer value)\&.
A special-case value of \&'-1\&' will set the chainsetup length
according to the longest input object\&. \fI[-]\fP
.PP
.IP "cs-set-length-samples \&'samples\&'"
Sets processing time in samples\&. \fI[-]\fP
.PP
.IP "cs-toggle-loop"
Toggle looping\&. When processing is finished, engine will start
again from the initial position\&. It\&'s not always possible to enable looping
(for instance all inputs and outputs have infinite length and
chainsetup length is not explicitly set with \&'cs-set-length\&')\&. \fI[-]\fP
.PP
.IP "cs-set-param"
Interpret general chainsetup parameters like for example
"-b" (buffersize), "-n" (name), etc\&. See ecasound (1) for
more info\&. \fI[-]\fP
.PP
.IP "cs-set-audio-format \&'bits,channels,sample_rate\&'"
Set the default sample parameters for currently selected chainsetup\&.
For example cd-quality audio would be "16,2,44100"\&. This does the
same as command-line argument "-f" (see ecasound (1))\&. \fI[-]\fP
.PP
.IP "cs-status, status, st"
Prints out status information about available chainsetup\&.
Detailed information is printed out for connected (=available
for running) nd selected (=available for editing) chainsetups\&.
Other chainsetups are listed, but further details are
suppressed\&. To get full details of a specific chainsetup,
select it with \&'cs-select\&' or \&'cs-iselect\&', and then
issue \&'cs-select\&'\&. \fI[s]\fP
.PP
.IP "cs-option \&'-prefix:arg1,\&.\&.\&.,argN\&'"
One powerful feature of the interactive-mode is that it
provides full access to ecasound\&'s command-line syntax\&.
For instance, command "cs-option -efb:400,200" means that
a bandpass filter is added to the currently selected
chain, with initial parameters 400 (center frequency)
and 200 (width in Hz)\&.
.PP
Note that session level options (such as setting debug level)
can not be used with \&'cs-option\&' (i\&.e\&. only options that modify
chainsetups)\&.
.PP
Note! Ecasound interactive mode implicitly interprets all strings
beginning with a \&'-\&' as "cs-option string"\&.
.IP
.SH "CHAINS"
Chain is a simple signal flow abstraction\&. Every chain has one input
and one output\&. All chain operators and their controllers are attached
to chains\&. Chains can be muted, unmuted and be bypassed\&. If not
otherwise stated, all operations are done to currently selected
chainsetup\&.
.IP
.IP "c-add \&'cname1,\&.\&.\&.,cnameN\&'"
Adds a set of chains\&. Added chains are automatically selected\&. Note
that commas in chain names are not allowed\&. \fI[-]\fP
.PP
.IP "c-remove"
Removes selected chains\&. \fI[-]\fP
.PP
.IP "c-list"
Returns a list of all chains\&. \fI[S]\fP
.PP
.IP "c-select \&'cname1,\&.\&.\&.,cnameN\&'"
Selects chains\&. Other chains are automatically deselected\&. \fI[-]\fP
.PP
.IP "c-index-select \&'index1,\&.\&.\&.,indexN\&', c-iselect \&'index1,\&.\&.\&.,indexN\&'"
Selects a set of chains based on the list of indixes\&. Each index is
an integer value, where \&'1\&' refers to the first chain\&. You can use
\&'c-list\&' and \&'c-status\&' to get a full list of currently available
chains\&. \fI[-]\fP
.PP
.IP "c-select-all"
Selects all chains\&. \fI[-]\fP
.PP
.IP "c-select-add \&'cname1,\&.\&.\&.,cnameN\&'"
Selects more chains\&. \fI[-]\fP
.PP
.IP "c-deselect \&'cname1,\&.\&.\&.,cnameN\&'"
Deselects chains\&. \fI[-]\fP
.PP
.IP "c-selected"
Returns a list of selected chains\&. \fI[S]\fP
.PP
.IP "c-clear"
Clear selected chains by removing all chain operators and controllers\&.
Doesn\&'t change how chains are connected to inputs and outputs\&. \fI[-]\fP
.PP
.IP "c-rename \&'new_name\&'"
Renames the selected chain\&. When using this command, exactly one chain must
be selected\&. \fI[-]\fP
.PP
.IP "c-muting, c-mute"
Toggle chain muting\&. When chain is muted, all data that goes through
is muted\&. \fI[-]\fP
.PP
.IP "c-bypass"
Toggle chain bypassing\&. When chain is bypassed, sample data is passed
through unprocessed (all chain operators are disabled for the given
chain)\&. \fI[-]\fP
.PP
.IP "c-status, cs"
Print status info about all chains\&. \fI[s]\fP
.PP
.SH "AUDIO INPUT/OUTPUT OBJECTS"
If not otherwise stated, all operations are done to currently selected
object\&. All commands with \fIai-\fP prefix operate on audio inputs,
while commands with \fIao-\fP operate on outputs\&.
.IP
.IP "ai-add \&'input_format_string\&'"
Adds a new input object\&. See ecasound (1) man page for more info about
the argument format (\&'-i\&' option)\&. Note on syntax: if any of
the parameters (such as a filename) contains commas, the parameter
should be enclosed in double-quotes\&. \fI[-]\fP
.PP
.IP "ao-add \&'output_format_string\&'"
Adds a new output object\&. See ecasound (1) man page for more info about
the argument format (\&'-o\&' option)\&. If argument is omitted,
a default output device is added (see ecasoundrc (5))\&. Note on syntax: if any
of the parameters (such as a filename) contains commas, the parameter
should be enclosed in double-quotes\&. \fI[-]\fP
.PP
.IP "ao-add-default"
Adds the default output device (see ecasoundrc (5))\&. \fI[-]\fP
.PP
.IP "ai-describe, ao-describe"
Returns a Ecasound Option Syntax (EOS) compliant string
describing the input/output\&. See the Ecasound User\&'s Guide
for more information about EOS\&. This command was introduced in
ecasound 2\&.4\&.4\&. \fI[s]\fP
.PP
.IP "ai-select \&'aobject_name\&', ao-select \&'aobject_name\&'"
Selects an audio object\&. \&'aobject_name\&' refers to the string
used when creating the object (the first argument given to ai-add/ao-add)\&.
Note that as a important difference to ai-add/ao-add, one should not
enclose the object name in double quotes for ai-select/ao-select\&. In the
case a chainsetup contains multiple inputs, or outputs, with
identical name, \&'ai-select\&' and \&'ao-select\&' will select
the first matching instance\&. In order to select a specific
instance, the \&'ai-iselect\&' and \&'ao-iselect\&' commands need to
be used\&. \fI[-]\fP
.PP
.IP "ai-index-select \&'aobject_index\&', ai-iselect \&'aobject_index\&', ao-index-select \&'aobject_index\&', ao-iselect \&'aobject_index\&'"
Select some audio object based on a short index string\&. Especially file
names can be rather long\&. This command can be used to avoid typing
these long names when selecting audio objects\&. \&'aobject_index\&' is
an integer value, where \&'1\&' refers to the first audio input/output\&.
You can use \&'ai-list\&' and \&'ao-list\&' to get a full list of currently
available inputs/outputs\&. \fI[-]\fP
.PP
.IP "ai-selected, ao-selected"
Returns the name of the currently selected audio object\&. \fI[s]\fP
.PP
.IP "ai-attach, ao-attach"
Attaches the currently selected audio object to all selected chains\&. \fI[-]\fP
.PP
.IP "ai-remove, ao-remove"
Removes the currently selected audio object from the chainsetup\&. \fI[-]\fP
.PP
.IP "ai-forward \&'time_in_seconds\&', ai-fw \&'time_in_seconds\&', ao-forward \&'time_in_seconds\&', ao-fw \&'time_in_seconds\&'"
Selected audio object is forwarded by \&'time-in-seconds\&' seconds\&.
Time should be given as a floating point value (eg\&. 0\&.001 is the
same as 1ms)\&. \fI[-]\fP
.PP
.IP "ai-rewind \&'time_in_seconds\&', ai-rw \&'time_in_seconds\&', ao-rewind \&'time_in_seconds\&', ao-rw \&'time_in_seconds\&'"
Selected audio object is rewinded by \&'time-in-seconds\&' seconds\&.
Time should be given as a floating point value (eg\&. 0\&.001 is the
same as 1ms)\&. \fI[-]\fP
.PP
.IP "ai-setpos \&'time_in_seconds\&', ai-set-position \&'time_in_seconds\&', ao-setpos \&'time_in_seconds\&', ao-set-position \&'time_in_seconds\&'"
Set audio object position to \&'time_in_seconds\&'\&. \fI[-]\fP
.PP
.IP "ai-set-position-samples \&'time_in_samples\&', ao-set-position-samples \&'time_in_samples\&'"
Set audio object position to \&'time_in_samples\&'\&. \fI[-]\fP
.PP
.IP "ai-getpos, ai-get-position, ao-getpos, ao-get-position"
Returns the audio object position in seconds\&. \fI[f]\fP
.PP
.IP "ai-get-position-samples, ao-get-position-samples"
Returns the audio object position in samples\&. \fI[li]\fP
.PP
.IP "ai-get-length, ao-get-length"
Returns the audio object length in seconds\&. \fI[f]\fP
.PP
.IP "ai-get-length-samples, ao-get-length-samples"
Returns the audio object length in samples\&. \fI[li]\fP
.PP
.IP "ai-get-format, ao-get-format"
Returns the audio format of the selected audio input/output as a
formatted string\&. See documentation for \&'-f\&' command-line option\&. \fI[s]\fP
.PP
.IP "ai-list, ao-list"
Returns a list of all input/output objects\&. \fI[S]\fP
.PP
.IP "aio-register"
Prints a list of registered audio object types\&. \fI[s]\fP
.PP
.IP "aio-status"
Audio object status (index strings, position, length, etc)\&. \fI[s]\fP
.PP
.SH "CHAIN OPERATORS"
Chain operators are used to process and analyze sample data\&.
They are attached to chains\&. If not otherwise stated,
currently selected chainsetup and chain are used\&. Also,
\&'chainop_id\&' and \&'param_id\&' are used to select chain operators
and their parameters\&. First valid value for these parameters
is 1\&.
.IP
.IP "cop-add \&'cop_format_string\&'"
Adds a new chain operator\&. In addition to normal chain operators,
this commmand can also be used to add effect presets and various
plugins\&. Note; it is not possible to add operators to multiple
chains at once\&. In other words only one chain should be selected
when issuing \&'cop-add\&'\&. See ecasound (1) man page for more info\&. \fI[-]\fP
.PP
.IP "cop-describe"
Returns a Ecasound Option Syntax (EOS) compliant string
describing the chain operator\&. See the Ecasound User\&'s Guide
for more information about EOS\&. This command was introduced in
ecasound 2\&.4\&.4\&. \fI[s]\fP
.PP
.IP "cop-remove"
Removes the selected chain operator\&. \fI[-]\fP
.PP
.IP "cop-list"
Returns a list of all chain operators attached to the currently
selected chain\&. \fI[S]\fP
.PP
.IP "cop-select \&'param_id\&', cop-index-select \&'param_id\&', cop-iselect \&'param_id\&'"
Selects a chain operator\&. \fI[-]\fP
.PP
.IP "cop-selected"
Returns the index number of currently selected chain operator\&. \fI[i]\fP
.PP
.IP "cop-set \&'chainop_id,param_id,value\&'"
Changes the value of a single chain operator parameter\&. Unlike other
chain operator commands, this can also be used during processing\&.
See also \&'cop-get\&'\&. \fI[-]\fP
.PP
.IP "cop-get \&'chainop_id,param_id\&'"
Returns the current value of chain operator parameter identified by
\&'chainop_id\&' and \&'param_id\&'\&. This command is a shorthand for
\&'cop-select chainop_id ; copp-iselect param_id ; copp-get\&'\&. \fI[f]\fP
.PP
.IP "cop-status"
Returns info about chain operator status\&. \fI[s]\fP
.PP
.IP "copp-list"
Returns a list of selected chain operator\&'s parameters\&. \fI[S]\fP
.PP
.IP "copp-select \&'param_id\&', copp-index-select \&'param_id\&', copp-iselect \&'param_id\&'"
Selects a chain operator parameter\&. \fI[-]\fP
.PP
.IP "copp-selected"
Returns the index number of currently selected chain operator parameter\&. \fI[i]\fP
.PP
.IP "copp-set \&'value\&'"
Sets the selected parameter value to \&'value\&'\&. \fI[-]\fP
.PP
.IP "copp-get"
Returns the selected parameter value\&. See also \&'cop-get\&'\&. \fI[f]\fP
.PP
.IP "cop-register"
Prints a list of registered chain operators\&. \fI[s]\fP
.PP
.IP "preset-register"
Prints a list of registered effect presets\&. \fI[s]\fP
.PP
.IP "ladspa-register"
Prints a list of registered LADSPA plugins\&. \fI[s]\fP
.PP
.SH "CONTROLLERS"
Controllers are used to control individual chain operator parameters\&.
They are attached to chains\&. If not otherwise stated, currently
selected chainsetup and chains are used\&.
.IP
.IP "ctrl-add \&'copc_format_string\&'"
Adds a new controller and attach it to currently selected chain
operator\&. The argument syntax is either "-<id_string>:par1,\&.\&.\&.,parN"
or just "<id_string>:par1,\&.\&.\&.,parN"\&. If parameter itself contains
commas, the parameter should be enclosed in double-quotes\&.
See ecasound (1) man page for more info\&. \fI[-]\fP
.IP
.IP "ctrl-describe"
Returns a Ecasound Option Syntax (EOS) compliant string
describing the controller\&. See the Ecasound User\&'s Guide
for more information about EOS\&. This command was introduced in
ecasound 2\&.4\&.4\&. \fI[s]\fP
.IP
.IP "ctrl-remove"
Removes the selected controller\&. \fI[-]\fP
.IP
.IP "ctrl-list"
Returns a list of all controllers attached to the currently
selected chain\&. \fI[S]\fP
.IP
.IP "ctrl-select \&'param_id\&', ctrl-index-select \&'param_id\&', ctrl-iselect \&'param_id\&'"
Selects a controller\&. \fI[-]\fP
.IP
.IP "ctrl-selected"
Returns the index number of currently selected controller\&. \fI[i]\fP
.IP
.IP "ctrl-status"
Returns info about controller status\&. \fI[s]\fP
.IP
.IP "ctrl-register"
Prints a list of registered controllers\&. \fI[s]\fP
.IP
.IP "ctrl-get-target"
Returns the index number of the chain operator that is
connected to the selected controller\&. The returned index
refers to the currently selected chain (see \&'cop-list\&')\&. \fI[i]\fP
.IP
.IP "ctrlp-list"
Returns a list of all controller parameters\&. This command was introduced in
ecasound 2\&.4\&.2\&. \fI[S]\fP
.IP
.IP "ctrlp-select"
Selects a controller parameter\&. This command was introduced in
ecasound 2\&.4\&.2\&. \fI[-]\fP
.IP
.IP "ctrlp-selected"
Returns the index number of currently selected controller parameter\&. This command
was introduced in ecasound 2\&.4\&.2\&. \fI[i]\fP
.IP
.IP "ctrlp-get"
Returns the selected controller parameter value\&. This command was introduced in
ecasound 2\&.4\&.2\&. \fI[f]\fP
.IP
.IP "ctrlp-set"
Sets the selected controller parameter value to \&'value\&'\&. This command was introduced in
ecasound 2\&.4\&.2\&. \fI[-]\fP
.IP
.SH "JACK CONNECTION MANAGEMENT"
If Ecasound is compiled with support for JACK audio server,
the following set of commands is provided for controlling connections
between JACK ports\&.
.IP
.IP "jack-connect \&'src-port\&' \&'dest-port\&'"
Make a connection between the two ports given as parameters\&. This command
is similar to the \&'jack_connect\&' command line tool that is distributed
with JACK package\&. \fI[-]\fP
.IP
.IP "jack-disconnect \&'src-port\&' \&'dest-port\&'"
Disconnect the two ports given as parameters\&. This command is similar
to the \&'jack_disconnect\&' command line tool that is distributed
with JACK package\&. \fI[-]\fP
.IP
.IP "jack-list-connections"
Returns a list of all JACK ports and a list of connections
for each port\&. This command is similar to the \&'jack_lsp\&' command
line tool (e\&.g\&. \&'jack_lsp -c\&') that is distributed with JACK package\&. \fI[s]\fP
.IP
.SH "INTERNAL COMMANDS"
Internal commands are not directly aimed at normal use\&. They
are primarily meant for use in scripting and frontends\&.
.IP
.IP "int-cmd-list"
Returns a list of all registered interactive mode commands\&. \fI[S]\fP
.IP
.IP "int-log-history"
Returns recent log messages sent by libecasound modules\&. This
is a good tool for debugging ECI/EIAM scripts and applications\&. This
command was introduced in ecasound 2\&.4\&.0\&. \fI[s]\fP
.IP
.IP "int-output-mode-wellformed"
Select the well-format output format for log messages\&. \fI[-]\fP
.IP
.IP "int-set-float-to-string-precision"
Sets precision used in float to text conversions\&. Note that
this can be used to control the precision of float return values
for ECI commands\&. \fI[-]\fP
.IP
.IP "int-set-log-history-length"
Sets the log history length\&. Defaults to 0 items\&.
This command was introduced in ecasound 2\&.4\&.0\&. \fI[-]\fP
.IP
.IP "int-cmd-version-string"
Returns ecasound interactive mode parser version string\&. \fI[s]\fP
.IP
.IP "int-cmd-version-lib-current"
Returns ecasound interactive mode library interface version (libtool)\&. \fI[i]\fP
.IP
.IP "int-cmd-version-lib-revision"
Returns ecasound interactive mode library interface revision (libtool)\&. \fI[i]\fP
.IP
.IP "int-cmd-version-lib-age"
Returns ecasound interactive mode library interface age (libtool)\&. \fI[i]\fP
.IP
.SH "OBJECT MAPS"
Object maps are central repositories for commonly used object types\&.
By querying the maps, applications can get a list of all registered
object types and their properties\&.
.IP
.IP "map-cop-list"
Prints a list of registered chain operators using
the format specified in section \fIOPERATOR DESCRIPTIONS\fP\&. \fI[s]\fP
.IP
.IP "map-preset-list"
Prints a list of registered effect presets using
the format specified in section \fIOPERATOR DESCRIPTIONS\fP\&. \fI[s]\fP
.IP
.IP "map-ladspa-list"
Prints a list of registered LADSPA plugins using
the format specified in section \fIOPERATOR DESCRIPTIONS\fP\&. \fI[s]\fP
.IP
.IP "map-ladspa-id-list"
Prints a list of registered LADSPA plugins using
the format specified in section \fIOPERATOR DESCRIPTIONS\fP\&.
Numerical LADPSA plugin identifiers are used\&. \fI[s]\fP
.IP
.IP "map-ctrl-list"
Prints a list of registered controllers using
the format specified in section \fIOPERATOR DESCRIPTIONS\fP\&. \fI[s]\fP
.IP
.SH "DUMP COMMANDS"
The following dump commands are not meant for normal use\&.
Their primary purpose is to provide an easy way to get
internal state information from libecasound\&. All dump
commands output a single line with syntax "key value"
to the selected output stream (defaults to stdout)\&.
.IP
.IP "dump-target \&'filename\&'"
Set target stream for dumping\&. \fI[-]\fP
.IP
.IP "dump-status"
Dumps engine status - \&'running\&', \&'stopped\&', \&'finished\&' or \&'notready\&'\&. \fI[-]\fP
.IP
.IP "dump-position"
Dumps the global position\&. Printed in seconds using a floating-point
representation\&. \fI[-]\fP
.IP
.IP "dump-length"
Dumps the overall processing length\&. Printed in seconds using a floating-point
representation\&. \fI[-]\fP
.IP
.IP "dump-cs-status"
Dumps status string for the currently selected chainsetup - \&'connected\&',
\&'selected\&' or an empty string\&. \fI[-]\fP
.IP
.IP "dump-c-selected"
Dumps the name of currently selected chain\&. \fI[-]\fP
.IP
.IP "dump-ai-selected"
Dumps label of currently selected audio input\&. If no input is
selected, dumps an empty string\&. \fI[-]\fP
.IP
.IP "dump-ai-position"
Dumps position of currently selected audio inputs\&. Printed in
seconds, using a floating-point representation\&. \fI[-]\fP
.IP
.IP "dump-ai-length"
Dumps length of currently selected audio input\&. Printed in seconds,
using a floating-point representation\&. \fI[-]\fP
.IP
.IP "dump-ai-open-state"
Dumps audio input state info\&. Either \&'open\&' or \&'closed\&'\&. \fI[-]\fP
.IP
.IP "dump-ao-selected"
Dumps label of currently selected audio output\&. If no output is
selected, dumps an empty string\&. \fI[-]\fP
.IP
.IP "dump-ao-position"
Dumps position of currently selected audio outputs\&. Printed in
seconds, using a floating-point representation\&. \fI[-]\fP
.IP
.IP "dump-ao-length"
Dumps length of currently selected audio output\&. Printed in seconds,
using a floating-point representation\&. \fI[-]\fP
.IP
.IP "dump-ao-open-state"
Dumps audio output state info\&. Either \&'open\&' or \&'closed\&'\&. \fI[-]\fP
.IP
.IP "dump-cop-value \&'chainop,param\&'"
Dumps chain operator parameter value\&. \&'chainop\&' and \&'param\&' are
operator and parameter index values (1\&.\&.\&.n)\&. \fI[-]\fP
.IP
.SH "OPERATOR DESCRIPTIONS"
The \fImap-xxx-list\fP commands return a string containing all registered
objects of the given type \fIxxx\fP\&. Each line of the output describes
one registered type\&. The used syntax is:
.IP
\&'keyword,name,description,num_of_params,par1_def,par2_def,\&.\&.\&.\&'
.IP
\fIparX_def\fP describes one object parameter\&. This definition
is present for all parameters of the described object type\&.
The used syntax is:
.IP
\&'name,description,defaultvalue,upper_bound_flag,upper_bound,
lower_bound_flag,lower_bound,toggled_flag,integer_flag,
logarithmic_flag,output_flag\&'
.IP
For exact descriptions of these fields, please see
the header file \fIecasound/libecasound/eca-operator\&.h\fP\&.
.IP
.SH "DEPRECATED COMMANDS"
Use of following commands is deprecated\&. They still work in
current version of Ecasound, but will be dropped in
the future:
.IP
.RS
ai-wave-edit, ao-wave-edit
.RE
.IP
.SH "SEE ALSO"
ecasound (1), ecatools (1), ecasoundrc (5)
.IP
.SH "AUTHOR"
Kai Vehmanen, <kvehmanen -at- eca -dot- cx <kvehmanen -at- eca -dot- cx>>

775
library/ecasound/Documentation/ecasound-iam_manpage.html Normal file
View file

@ -0,0 +1,775 @@
<html><head>
<title>ecasound-iam</title>
<link rev="made" href="mailto:kvehmanen -at- eca -dot- cx">
</head>
<body>
<hr>
<h1>ecasound-iam</h1>
<h2>11.10.2009</h2>
<html><head>
<link rev="made" href="mailto:kvehmanen -at- eca -dot- cx">
</head>
<body>
<hr>
<h1></h1>
<html><head>
<title>ecasound-iam(1)</title>
<link rev="made" href="mailto:kvehmanen -at- eca -dot- cx">
</head>
<body>
<hr>
<h1>ecasound-iam(1)</h1>
<h2> Multimedia software</h2>
<h2>11.10.2009</h2>
<p>
<h2>NAME</h2>ecasound-iam - ecasound interactive mode
<h2>SYNOPSIS</h2>
<p>
<h2>DESCRIPTION</h2>
<p>
Ecasound library contains an interpreter module that understands
a set of commands aimed at controlling various library services.
This is called the ecasound interactive mode (EIAM). All programs
linked to ecasound library can use this facility.
<p>
<h2>ECI API and return types</h2>
A special case of interactive mode use is ecasound's control interface (ECI),
which is a small library providing easy access to the interactive
mode commands from outside of libecasound. When issuing inter commands using
the control interface, it's possible that commands also return information.
Currently supported return value types are: string [s], list of strings [S]
(elements separated by commas; escaped if necessary), integer [i],
long integer [li] and floating-point number [f]. These definitions are
used throughout this document. Commands that return nothing (void) are
marked with [-]. Additionally, return type [e] marks an error condition.
When an interactive mode command results in an error, an error string
explaining the condition is returned.
<p>
<h2>Real-time commands</h2>
It's not possible to use all interactive mode commands to modify and
control objects that belong to a connected chainsetup. Commands that
do NOT support this are:
<p>
<blockquote>
cs-remove, cs-set-length, cs-set-length-samples, cs-toggle-loop,
cs-set-param, cs-option,
c-add, c-remove, c-rename, c-clear,
ai-add, ai-remove, ai-attach, ai-forward, ai-rewind, ai-set-position,
ai-set-position-samples,
ao-add, ao-add-default, ao-remove, ao-attach, ao-forward, ao-rewind,
ao-set-position, ao-set-position-samples.
</blockquote>
<p>
If one of these commands is issued when a chainsetup is connected,
ecasound will first stop and disconnect the chainsetup, process
the command, and the reconnect.
<p>
In addition, most non-modifying (const) commands work with
connected setups.
<p>
<h2>GENERAL</h2>
<dl>
<p><dt><strong>quit, q</strong><dd>
Quit ecasound session. What this means in practice depends on the
client implementation. In ecasound interactive mode, 'quit' terminates
the ecasound process. When sent over ecasound server connection (aka
NetECI), 'quit' terminates the active network connection, but does not
terminate the ecasound server process. <em>[-]</em>
<p>
<p><dt><strong>start, t</strong><dd>
Processing is started (play). Error string is return if any errors upon
startup are encountered. <em>[e]</em>
<p>
<p><dt><strong>stop, s</strong><dd>
Stop processing. <em>[-]</em>
<p>
<p><dt><strong>run</strong><dd>
Like 'start' but blocks until processing is finished. Error string
is return if any errors upon startup, or during process, are
encountered. <em>[e]</em>
<p>
<p><dt><strong>debug 'debug-level'</strong><dd>
Set debug level to 'debug-level'. Notice that client programs can
reimplement the debug routines. <em>[-]</em>
</dl>
<p>
<p><dt><strong>resource-file 'path-to-file'</strong><dd>
Overrides the global and user resource files. Does not affect
already created objects. This command is equivalent to '-R' ecasound
option (see ecasound (1) man page).
<p>
<p><dt><strong>-prefix:arg1,...,argN</strong><dd>
Equivalent to issuing 'cs-option -prefix:arg1,...,argN). See documentation
for 'cs-option'.
<p>
<p><dt><strong>help', 'h'</strong><dd>
Help! <em>[-]</em>
<p>
</dl>
<p>
<h2>GLOBAL</h2>
<p>
<dl>
<p>
<p><dt><strong>engine-status</strong><dd>
Returns a string describing the engine status (running, stopped,
finished, error, not ready). See also <em>cs-status</em>. <em>[s]</em>
<p>
<p><dt><strong>engine-launch</strong><dd>
Starts the real-time engine. Engine will execute the currently
connected chainsetup (see 'cs-connect). This action does not yet
start actual processing (see <em>start</em> and <em>stop</em>). When
ecasound is used as a JACK client, issuing <em>engine-launch</em>
makes ecasound an active JACK client (i.e. ecasound's ports
can be connected to other JACK clients). <em>[-]</em>
<p>
<p><dt><strong>engine-halt</strong><dd>
Stops the engine. Does not disconnect the chainsetup that
was running. See also <em>cs-disconnet</em> and <em>stop</em>. When
ecasound is used as a JACK client, <em>engine-halt</em> will
cause ecasound to become a deactivated client (all JACK
connections are torn down). <em>[-]</em>
<p>
</dl>
<p>
<h2>CHAINSETUPS</h2>
Chainsetup is the central data object. All other objects (inputs,
outputs, chains, etc) are connected to some chainsetup. There can be
many chainsetups but only one can be connected. Similarly only
one chainsetup can be selected. If not otherwise specified operations
are done on the selected chainsetup. Some operations also require
that selected chainsetup is not connected.
<p>
<dl>
<p><dt><strong>cs-add 'name'</strong><dd>
Adds a new chainsetup with name 'name'. 'name' is now
the selected chainsetup. <em>[-]</em>
<p>
<p><dt><strong>cs-remove</strong><dd>
Removes currently selected chainsetup. <em>[-]</em>
<p>
<p><dt><strong>cs-list</strong><dd>
Returns a list of all chainsetups. <em>[S]</em>
<p>
<p><dt><strong>cs-select 'name'</strong><dd>
Selects chainsetup 'name'. <em>[-]</em>
<p>
<p><dt><strong>cs-selected</strong><dd>
Returns the name of currently selected chainsetup. <em>[s]</em>
<p>
<p><dt><strong>cs-index-select 'cs_index', cs-iselect 'cs_index'</strong><dd>
Selects a chainsetup based on a short index string. Chainsetup names
can be rather long. This command can be used to avoid typing
these long names. 'cs_index' is an integer value, where '1' refers to
the first audio input/output. You can use 'cs-list' and 'cs-status'
to get a full list of currently available chainsetups. <em>[-]</em>
<p>
<p><dt><strong>cs-load 'filename'</strong><dd>
Adds a new chainsetup by loading it from file 'filename'.
'filename' is now the selected chainsetup. <em>[-]</em>
<p>
<p><dt><strong>cs-save</strong><dd>
Saves the currently selected chainsetup to file. If chainsetup was loaded
from a file, the saved version will replace the original. If it doesn't
have a default filename, it's saved to "chainsetup_name.ecs". <em>[-]</em>
<p>
<p><dt><strong>cs-save-as 'filename'</strong><dd>
Saves currently selected chainsetup to file 'filename'. <em>[-]</em>
<p>
<p><dt><strong>cs-edit</strong><dd>
Currently selected chainsetup is saved to a temporary file. This
file is loaded to an external editor (see ecasoundrc (5)). After
editing, the chainsetup is loaded back to ecasound. <em>[-]</em>
<p>
<p><dt><strong>cs-is-valid</strong><dd>
Whether currently selected chainsetup is valid (=can be connected)? <em>[i]</em>
<p>
<p><dt><strong>cs-connect</strong><dd>
Connect currently selected chainsetup to engine. When connecting,
all resources (e.g. files, soundcard devices, external programs) needed
to execute the chainsetup are reserved. Only one chainsetup can be connected
at a time. Error string is returned if connection fails (for instance
due to error in allocating the resources). <em>[e]</em>
<p>
<p><dt><strong>cs-disconnect</strong><dd>
Disconnect currently connected chainsetup. This action will free
all external resources needed by the chainsetup. <em>[-]</em>
<p>
<p><dt><strong>cs-connected</strong><dd>
Returns the name of currently connected chainsetup. <em>[s]</em>
<p>
<p><dt><strong>cs-rewind 'time-in-seconds', rewind 'time-in-seconds', rw 'time-in-seconds'</strong><dd>
Rewinds the current chainsetup position by 'time-in-seconds' seconds.
Position of all inputs and outputs attached to the selected chainsetup
is also affected. <em>[-]</em>
<p>
<p><dt><strong>cs-forward 'time-in-seconds', forward 'time-in-seconds', fw 'ttime-in-seconds'</strong><dd>
The current chainsetup position is forwarded by 'time-in-seconds'
seconds. Position of all inputs and outputs attached to the selected chainsetup
is also affected. <em>[-]</em>
<p>
<p><dt><strong>cs-set-position 'time-in-seconds', cs-setpos 'time-in-seconds', setpos 'time-in-seconds', set-position 'time-in-seconds'</strong><dd>
Sets the chainsetup position to 'time-in-seconds' seconds from the
beginning. Position of all inputs and outputs attached to the selected
chainsetup is also affected. <em>[-]</em>
<p>
<p><dt><strong>cs-set-position-samples 'time-in-samples'</strong><dd>
Sets the chainsetup position to 'time-in-samples' samples from the
beginning. Position of all inputs and outputs attached to the selected
chainsetup is also affected. <em>[-]</em>
<p>
<p><dt><strong>cs-get-position, cs-getpos, getpos, get-position</strong><dd>
Returns the current chainsetup position in seconds. <em>[f]</em>
<p>
<p><dt><strong>cs-get-position-samples</strong><dd>
Returns the current chainsetup position in samples. <em>[li]</em>
<p>
<p><dt><strong>cs-get-length, get-length</strong><dd>
Returns the chainsetup length in seconds (if known). <em>[f]</em>
<p>
<p><dt><strong>cs-get-length-samples, get-length-samples</strong><dd>
Returns the chainsetup length in samples (if known). <em>[li]</em>
<p>
<p><dt><strong>cs-set-length 'seconds'</strong><dd>
Sets processing time in seconds (doesn't have to be an integer value).
A special-case value of '-1' will set the chainsetup length
according to the longest input object. <em>[-]</em>
<p>
<p><dt><strong>cs-set-length-samples 'samples'</strong><dd>
Sets processing time in samples. <em>[-]</em>
<p>
<p><dt><strong>cs-toggle-loop</strong><dd>
Toggle looping. When processing is finished, engine will start
again from the initial position. It's not always possible to enable looping
(for instance all inputs and outputs have infinite length and
chainsetup length is not explicitly set with 'cs-set-length'). <em>[-]</em>
<p>
<p><dt><strong>cs-set-param</strong><dd>
Interpret general chainsetup parameters like for example
"-b" (buffersize), "-n" (name), etc. See ecasound (1) for
more info. <em>[-]</em>
<p>
<p><dt><strong>cs-set-audio-format 'bits,channels,sample_rate'</strong><dd>
Set the default sample parameters for currently selected chainsetup.
For example cd-quality audio would be "16,2,44100". This does the
same as command-line argument "-f" (see ecasound (1)). <em>[-]</em>
<p>
<p><dt><strong>cs-status, status, st</strong><dd>
Prints out status information about available chainsetup.
Detailed information is printed out for connected (=available
for running) nd selected (=available for editing) chainsetups.
Other chainsetups are listed, but further details are
suppressed. To get full details of a specific chainsetup,
select it with 'cs-select' or 'cs-iselect', and then
issue 'cs-select'. <em>[s]</em>
<p>
<p><dt><strong>cs-option '-prefix:arg1,...,argN'</strong><dd>
One powerful feature of the interactive-mode is that it
provides full access to ecasound's command-line syntax.
For instance, command "cs-option -efb:400,200" means that
a bandpass filter is added to the currently selected
chain, with initial parameters 400 (center frequency)
and 200 (width in Hz).
<p>
Note that session level options (such as setting debug level)
can not be used with 'cs-option' (i.e. only options that modify
chainsetups).
<p>
Note! Ecasound interactive mode implicitly interprets all strings
beginning with a '-' as "cs-option string".
</dl>
<p>
<h2>CHAINS</h2>
Chain is a simple signal flow abstraction. Every chain has one input
and one output. All chain operators and their controllers are attached
to chains. Chains can be muted, unmuted and be bypassed. If not
otherwise stated, all operations are done to currently selected
chainsetup.
<p>
<dl>
<p><dt><strong>c-add 'cname1,...,cnameN'</strong><dd>
Adds a set of chains. Added chains are automatically selected. Note
that commas in chain names are not allowed. <em>[-]</em>
<p>
<p><dt><strong>c-remove</strong><dd>
Removes selected chains. <em>[-]</em>
<p>
<p><dt><strong>c-list</strong><dd>
Returns a list of all chains. <em>[S]</em>
<p>
<p><dt><strong>c-select 'cname1,...,cnameN'</strong><dd>
Selects chains. Other chains are automatically deselected. <em>[-]</em>
<p>
<p><dt><strong>c-index-select 'index1,...,indexN', c-iselect 'index1,...,indexN'</strong><dd>
Selects a set of chains based on the list of indixes. Each index is
an integer value, where '1' refers to the first chain. You can use
'c-list' and 'c-status' to get a full list of currently available
chains. <em>[-]</em>
<p>
<p><dt><strong>c-select-all</strong><dd>
Selects all chains. <em>[-]</em>
<p>
<p><dt><strong>c-select-add 'cname1,...,cnameN'</strong><dd>
Selects more chains. <em>[-]</em>
<p>
<p><dt><strong>c-deselect 'cname1,...,cnameN'</strong><dd>
Deselects chains. <em>[-]</em>
<p>
<p><dt><strong>c-selected</strong><dd>
Returns a list of selected chains. <em>[S]</em>
<p>
<p><dt><strong>c-clear</strong><dd>
Clear selected chains by removing all chain operators and controllers.
Doesn't change how chains are connected to inputs and outputs. <em>[-]</em>
<p>
<p><dt><strong>c-rename 'new_name'</strong><dd>
Renames the selected chain. When using this command, exactly one chain must
be selected. <em>[-]</em>
<p>
<p><dt><strong>c-muting, c-mute</strong><dd>
Toggle chain muting. When chain is muted, all data that goes through
is muted. <em>[-]</em>
<p>
<p><dt><strong>c-bypass</strong><dd>
Toggle chain bypassing. When chain is bypassed, sample data is passed
through unprocessed (all chain operators are disabled for the given
chain). <em>[-]</em>
<p>
<p><dt><strong>c-status, cs</strong><dd>
Print status info about all chains. <em>[s]</em>
<p>
</dl>
<p>
<h2>AUDIO INPUT/OUTPUT OBJECTS</h2>
If not otherwise stated, all operations are done to currently selected
object. All commands with <em>ai-</em> prefix operate on audio inputs,
while commands with <em>ao-</em> operate on outputs.
<p>
<dl>
<p>
<p><dt><strong>ai-add 'input_format_string'</strong><dd>
Adds a new input object. See ecasound (1) man page for more info about
the argument format ('-i' option). Note on syntax: if any of
the parameters (such as a filename) contains commas, the parameter
should be enclosed in double-quotes. <em>[-]</em>
<p>
<p><dt><strong>ao-add 'output_format_string'</strong><dd>
Adds a new output object. See ecasound (1) man page for more info about
the argument format ('-o' option). If argument is omitted,
a default output device is added (see ecasoundrc (5)). Note on syntax: if any
of the parameters (such as a filename) contains commas, the parameter
should be enclosed in double-quotes. <em>[-]</em>
<p>
<p><dt><strong>ao-add-default</strong><dd>
Adds the default output device (see ecasoundrc (5)). <em>[-]</em>
<p>
<p><dt><strong>ai-describe, ao-describe</strong><dd>
Returns a Ecasound Option Syntax (EOS) compliant string
describing the input/output. See the Ecasound User's Guide
for more information about EOS. This command was introduced in
ecasound 2.4.4. <em>[s]</em>
<p>
<p><dt><strong>ai-select 'aobject_name', ao-select 'aobject_name'</strong><dd>
Selects an audio object. 'aobject_name' refers to the string
used when creating the object (the first argument given to ai-add/ao-add).
Note that as a important difference to ai-add/ao-add, one should not
enclose the object name in double quotes for ai-select/ao-select. In the
case a chainsetup contains multiple inputs, or outputs, with
identical name, 'ai-select' and 'ao-select' will select
the first matching instance. In order to select a specific
instance, the 'ai-iselect' and 'ao-iselect' commands need to
be used. <em>[-]</em>
<p>
<p><dt><strong>ai-index-select 'aobject_index', ai-iselect 'aobject_index', ao-index-select 'aobject_index', ao-iselect 'aobject_index'</strong><dd>
Select some audio object based on a short index string. Especially file
names can be rather long. This command can be used to avoid typing
these long names when selecting audio objects. 'aobject_index' is
an integer value, where '1' refers to the first audio input/output.
You can use 'ai-list' and 'ao-list' to get a full list of currently
available inputs/outputs. <em>[-]</em>
<p>
<p><dt><strong>ai-selected, ao-selected</strong><dd>
Returns the name of the currently selected audio object. <em>[s]</em>
<p>
<p><dt><strong>ai-attach, ao-attach</strong><dd>
Attaches the currently selected audio object to all selected chains. <em>[-]</em>
<p>
<p><dt><strong>ai-remove, ao-remove</strong><dd>
Removes the currently selected audio object from the chainsetup. <em>[-]</em>
<p>
<p><dt><strong>ai-forward 'time_in_seconds', ai-fw 'time_in_seconds', ao-forward 'time_in_seconds', ao-fw 'time_in_seconds'</strong><dd>
Selected audio object is forwarded by 'time-in-seconds' seconds.
Time should be given as a floating point value (eg. 0.001 is the
same as 1ms). <em>[-]</em>
<p>
<p><dt><strong>ai-rewind 'time_in_seconds', ai-rw 'time_in_seconds', ao-rewind 'time_in_seconds', ao-rw 'time_in_seconds'</strong><dd>
Selected audio object is rewinded by 'time-in-seconds' seconds.
Time should be given as a floating point value (eg. 0.001 is the
same as 1ms). <em>[-]</em>
<p>
<p><dt><strong>ai-setpos 'time_in_seconds', ai-set-position 'time_in_seconds', ao-setpos 'time_in_seconds', ao-set-position 'time_in_seconds'</strong><dd>
Set audio object position to 'time_in_seconds'. <em>[-]</em>
<p>
<p><dt><strong>ai-set-position-samples 'time_in_samples', ao-set-position-samples 'time_in_samples'</strong><dd>
Set audio object position to 'time_in_samples'. <em>[-]</em>
<p>
<p><dt><strong>ai-getpos, ai-get-position, ao-getpos, ao-get-position</strong><dd>
Returns the audio object position in seconds. <em>[f]</em>
<p>
<p><dt><strong>ai-get-position-samples, ao-get-position-samples</strong><dd>
Returns the audio object position in samples. <em>[li]</em>
<p>
<p><dt><strong>ai-get-length, ao-get-length</strong><dd>
Returns the audio object length in seconds. <em>[f]</em>
<p>
<p><dt><strong>ai-get-length-samples, ao-get-length-samples</strong><dd>
Returns the audio object length in samples. <em>[li]</em>
<p>
<p><dt><strong>ai-get-format, ao-get-format</strong><dd>
Returns the audio format of the selected audio input/output as a
formatted string. See documentation for '-f' command-line option. <em>[s]</em>
<p>
<p><dt><strong>ai-list, ao-list</strong><dd>
Returns a list of all input/output objects. <em>[S]</em>
<p>
<p><dt><strong>aio-register</strong><dd>
Prints a list of registered audio object types. <em>[s]</em>
<p>
<p><dt><strong>aio-status</strong><dd>
Audio object status (index strings, position, length, etc). <em>[s]</em>
<p>
</dl>
<p>
<h2>CHAIN OPERATORS</h2>
Chain operators are used to process and analyze sample data.
They are attached to chains. If not otherwise stated,
currently selected chainsetup and chain are used. Also,
'chainop_id' and 'param_id' are used to select chain operators
and their parameters. First valid value for these parameters
is 1.
<p>
<dl>
<p><dt><strong>cop-add 'cop_format_string'</strong><dd>
Adds a new chain operator. In addition to normal chain operators,
this commmand can also be used to add effect presets and various
plugins. Note; it is not possible to add operators to multiple
chains at once. In other words only one chain should be selected
when issuing 'cop-add'. See ecasound (1) man page for more info. <em>[-]</em>
<p>
<p><dt><strong>cop-describe</strong><dd>
Returns a Ecasound Option Syntax (EOS) compliant string
describing the chain operator. See the Ecasound User's Guide
for more information about EOS. This command was introduced in
ecasound 2.4.4. <em>[s]</em>
<p>
<p><dt><strong>cop-remove</strong><dd>
Removes the selected chain operator. <em>[-]</em>
<p>
<p><dt><strong>cop-list</strong><dd>
Returns a list of all chain operators attached to the currently
selected chain. <em>[S]</em>
<p>
<p><dt><strong>cop-select 'param_id', cop-index-select 'param_id', cop-iselect 'param_id'</strong><dd>
Selects a chain operator. <em>[-]</em>
<p>
<p><dt><strong>cop-selected</strong><dd>
Returns the index number of currently selected chain operator. <em>[i]</em>
<p>
<p><dt><strong>cop-set 'chainop_id,param_id,value'</strong><dd>
Changes the value of a single chain operator parameter. Unlike other
chain operator commands, this can also be used during processing.
See also 'cop-get'. <em>[-]</em>
<p>
<p><dt><strong>cop-get 'chainop_id,param_id'</strong><dd>
Returns the current value of chain operator parameter identified by
'chainop_id' and 'param_id'. This command is a shorthand for
'cop-select chainop_id ; copp-iselect param_id ; copp-get'. <em>[f]</em>
<p>
<p><dt><strong>cop-status</strong><dd>
Returns info about chain operator status. <em>[s]</em>
<p>
<p><dt><strong>copp-list</strong><dd>
Returns a list of selected chain operator's parameters. <em>[S]</em>
<p>
<p><dt><strong>copp-select 'param_id', copp-index-select 'param_id', copp-iselect 'param_id'</strong><dd>
Selects a chain operator parameter. <em>[-]</em>
<p>
<p><dt><strong>copp-selected</strong><dd>
Returns the index number of currently selected chain operator parameter. <em>[i]</em>
<p>
<p><dt><strong>copp-set 'value'</strong><dd>
Sets the selected parameter value to 'value'. <em>[-]</em>
<p>
<p><dt><strong>copp-get</strong><dd>
Returns the selected parameter value. See also 'cop-get'. <em>[f]</em>
<p>
<p><dt><strong>cop-register</strong><dd>
Prints a list of registered chain operators. <em>[s]</em>
<p>
<p><dt><strong>preset-register</strong><dd>
Prints a list of registered effect presets. <em>[s]</em>
<p>
<p><dt><strong>ladspa-register</strong><dd>
Prints a list of registered LADSPA plugins. <em>[s]</em>
<p>
</dl>
<p>
<h2>CONTROLLERS</h2>
Controllers are used to control individual chain operator parameters.
They are attached to chains. If not otherwise stated, currently
selected chainsetup and chains are used.
<p>
<p><dt><strong>ctrl-add 'copc_format_string'</strong><dd>
Adds a new controller and attach it to currently selected chain
operator. The argument syntax is either "-&lt;id_string&gt;:par1,...,parN"
or just "&lt;id_string&gt;:par1,...,parN". If parameter itself contains
commas, the parameter should be enclosed in double-quotes.
See ecasound (1) man page for more info. <em>[-]</em>
<p>
<p><dt><strong>ctrl-describe</strong><dd>
Returns a Ecasound Option Syntax (EOS) compliant string
describing the controller. See the Ecasound User's Guide
for more information about EOS. This command was introduced in
ecasound 2.4.4. <em>[s]</em>
<p>
<p><dt><strong>ctrl-remove</strong><dd>
Removes the selected controller. <em>[-]</em>
<p>
<p><dt><strong>ctrl-list</strong><dd>
Returns a list of all controllers attached to the currently
selected chain. <em>[S]</em>
<p>
<p><dt><strong>ctrl-select 'param_id', ctrl-index-select 'param_id', ctrl-iselect 'param_id'</strong><dd>
Selects a controller. <em>[-]</em>
<p>
<p><dt><strong>ctrl-selected</strong><dd>
Returns the index number of currently selected controller. <em>[i]</em>
<p>
<p><dt><strong>ctrl-status</strong><dd>
Returns info about controller status. <em>[s]</em>
<p>
<p><dt><strong>ctrl-register</strong><dd>
Prints a list of registered controllers. <em>[s]</em>
<p>
<p><dt><strong>ctrl-get-target</strong><dd>
Returns the index number of the chain operator that is
connected to the selected controller. The returned index
refers to the currently selected chain (see 'cop-list'). <em>[i]</em>
<p>
<p><dt><strong>ctrlp-list</strong><dd>
Returns a list of all controller parameters. This command was introduced in
ecasound 2.4.2. <em>[S]</em>
<p>
<p><dt><strong>ctrlp-select</strong><dd>
Selects a controller parameter. This command was introduced in
ecasound 2.4.2. <em>[-]</em>
<p>
<p><dt><strong>ctrlp-selected</strong><dd>
Returns the index number of currently selected controller parameter. This command
was introduced in ecasound 2.4.2. <em>[i]</em>
<p>
<p><dt><strong>ctrlp-get</strong><dd>
Returns the selected controller parameter value. This command was introduced in
ecasound 2.4.2. <em>[f]</em>
<p>
<p><dt><strong>ctrlp-set</strong><dd>
Sets the selected controller parameter value to 'value'. This command was introduced in
ecasound 2.4.2. <em>[-]</em>
<p>
</dl>
<p>
<h2>JACK CONNECTION MANAGEMENT</h2>
If Ecasound is compiled with support for <a href="http://jackaudio.org/">JACK audio server</a>,
the following set of commands is provided for controlling connections
between JACK ports.
<p>
<dl>
<p>
<p><dt><strong>jack-connect 'src-port' 'dest-port'</strong><dd>
Make a connection between the two ports given as parameters. This command
is similar to the 'jack_connect' command line tool that is distributed
with JACK package. <em>[-]</em>
<p>
<p><dt><strong>jack-disconnect 'src-port' 'dest-port'</strong><dd>
Disconnect the two ports given as parameters. This command is similar
to the 'jack_disconnect' command line tool that is distributed
with JACK package. <em>[-]</em>
<p>
<p><dt><strong>jack-list-connections</strong><dd>
Returns a list of all JACK ports and a list of connections
for each port. This command is similar to the 'jack_lsp' command
line tool (e.g. 'jack_lsp -c') that is distributed with JACK package. <em>[s]</em>
<p>
</dl>
<p>
<h2>INTERNAL COMMANDS</h2>
Internal commands are not directly aimed at normal use. They
are primarily meant for use in scripting and frontends.
<p>
<dl>
<p><dt><strong>int-cmd-list</strong><dd>
Returns a list of all registered interactive mode commands. <em>[S]</em>
<p>
<p><dt><strong>int-log-history</strong><dd>
Returns recent log messages sent by libecasound modules. This
is a good tool for debugging ECI/EIAM scripts and applications. This
command was introduced in ecasound 2.4.0. <em>[s]</em>
<p>
<p><dt><strong>int-output-mode-wellformed</strong><dd>
Select the well-format output format for log messages. <em>[-]</em>
<p>
<p><dt><strong>int-set-float-to-string-precision</strong><dd>
Sets precision used in float to text conversions. Note that
this can be used to control the precision of float return values
for ECI commands. <em>[-]</em>
<p>
<p><dt><strong>int-set-log-history-length</strong><dd>
Sets the log history length. Defaults to 0 items.
This command was introduced in ecasound 2.4.0. <em>[-]</em>
<p>
<p><dt><strong>int-cmd-version-string</strong><dd>
Returns ecasound interactive mode parser version string. <em>[s]</em>
<p>
<p><dt><strong>int-cmd-version-lib-current</strong><dd>
Returns ecasound interactive mode library interface version (libtool). <em>[i]</em>
<p>
<p><dt><strong>int-cmd-version-lib-revision</strong><dd>
Returns ecasound interactive mode library interface revision (libtool). <em>[i]</em>
<p>
<p><dt><strong>int-cmd-version-lib-age</strong><dd>
Returns ecasound interactive mode library interface age (libtool). <em>[i]</em>
<p>
</dl>
<p>
<h2>OBJECT MAPS</h2>
Object maps are central repositories for commonly used object types.
By querying the maps, applications can get a list of all registered
object types and their properties.
<p>
<dl>
<p>
<p><dt><strong>map-cop-list</strong><dd>
Prints a list of registered chain operators using
the format specified in section <em>OPERATOR DESCRIPTIONS</em>. <em>[s]</em>
<p>
<p><dt><strong>map-preset-list</strong><dd>
Prints a list of registered effect presets using
the format specified in section <em>OPERATOR DESCRIPTIONS</em>. <em>[s]</em>
<p>
<p><dt><strong>map-ladspa-list</strong><dd>
Prints a list of registered LADSPA plugins using
the format specified in section <em>OPERATOR DESCRIPTIONS</em>. <em>[s]</em>
<p>
<p><dt><strong>map-ladspa-id-list</strong><dd>
Prints a list of registered LADSPA plugins using
the format specified in section <em>OPERATOR DESCRIPTIONS</em>.
Numerical LADPSA plugin identifiers are used. <em>[s]</em>
<p>
<p><dt><strong>map-ctrl-list</strong><dd>
Prints a list of registered controllers using
the format specified in section <em>OPERATOR DESCRIPTIONS</em>. <em>[s]</em>
<p>
</dl>
<p>
<h2>DUMP COMMANDS</h2>
The following dump commands are not meant for normal use.
Their primary purpose is to provide an easy way to get
internal state information from libecasound. All dump
commands output a single line with syntax "key value"
to the selected output stream (defaults to stdout).
<p>
<dl>
<p>
<p><dt><strong>dump-target 'filename'</strong><dd>
Set target stream for dumping. <em>[-]</em>
<p>
<p><dt><strong>dump-status</strong><dd>
Dumps engine status - 'running', 'stopped', 'finished' or 'notready'. <em>[-]</em>
<p>
<p><dt><strong>dump-position</strong><dd>
Dumps the global position. Printed in seconds using a floating-point
representation. <em>[-]</em>
<p>
<p><dt><strong>dump-length</strong><dd>
Dumps the overall processing length. Printed in seconds using a floating-point
representation. <em>[-]</em>
<p>
<p><dt><strong>dump-cs-status</strong><dd>
Dumps status string for the currently selected chainsetup - 'connected',
'selected' or an empty string. <em>[-]</em>
<p>
<p><dt><strong>dump-c-selected</strong><dd>
Dumps the name of currently selected chain. <em>[-]</em>
<p>
<p><dt><strong>dump-ai-selected</strong><dd>
Dumps label of currently selected audio input. If no input is
selected, dumps an empty string. <em>[-]</em>
<p>
<p><dt><strong>dump-ai-position</strong><dd>
Dumps position of currently selected audio inputs. Printed in
seconds, using a floating-point representation. <em>[-]</em>
<p>
<p><dt><strong>dump-ai-length</strong><dd>
Dumps length of currently selected audio input. Printed in seconds,
using a floating-point representation. <em>[-]</em>
<p>
<p><dt><strong>dump-ai-open-state</strong><dd>
Dumps audio input state info. Either 'open' or 'closed'. <em>[-]</em>
<p>
<p><dt><strong>dump-ao-selected</strong><dd>
Dumps label of currently selected audio output. If no output is
selected, dumps an empty string. <em>[-]</em>
<p>
<p><dt><strong>dump-ao-position</strong><dd>
Dumps position of currently selected audio outputs. Printed in
seconds, using a floating-point representation. <em>[-]</em>
<p>
<p><dt><strong>dump-ao-length</strong><dd>
Dumps length of currently selected audio output. Printed in seconds,
using a floating-point representation. <em>[-]</em>
<p>
<p><dt><strong>dump-ao-open-state</strong><dd>
Dumps audio output state info. Either 'open' or 'closed'. <em>[-]</em>
<p>
<p><dt><strong>dump-cop-value 'chainop,param'</strong><dd>
Dumps chain operator parameter value. 'chainop' and 'param' are
operator and parameter index values (1...n). <em>[-]</em>
<p>
</dl>
<p>
<h2>OPERATOR DESCRIPTIONS</h2>
The <em>map-xxx-list</em> commands return a string containing all registered
objects of the given type <em>xxx</em>. Each line of the output describes
one registered type. The used syntax is:
<p>
'keyword,name,description,num_of_params,par1_def,par2_def,...'
<p>
<em>parX_def</em> describes one object parameter. This definition
is present for all parameters of the described object type.
The used syntax is:
<p>
'name,description,defaultvalue,upper_bound_flag,upper_bound,
lower_bound_flag,lower_bound,toggled_flag,integer_flag,
logarithmic_flag,output_flag'
<p>
For exact descriptions of these fields, please see
the header file <em>ecasound/libecasound/eca-operator.h</em>.
<p>
<h2>DEPRECATED COMMANDS</h2>
Use of following commands is deprecated. They still work in
current version of Ecasound, but will be dropped in
the future:
<p>
<blockquote>
ai-wave-edit, ao-wave-edit
</blockquote>
<p>
<h2>SEE ALSO</h2>
ecasound (1), ecatools (1), ecasoundrc (5)
<p>
<h2>AUTHOR</h2>
Kai Vehmanen, &lt;<a href="mailto:kvehmanen -at- eca -dot- cx"><em>kvehmanen -at- eca -dot- cx</em></a>&gt;

1110
library/ecasound/Documentation/ecasound.1 Normal file
View file

File diff suppressed because it is too large Load diff

1187
library/ecasound/Documentation/ecasound_manpage.html Normal file
View file

File diff suppressed because it is too large Load diff

226
library/ecasound/Documentation/ecasoundrc.5 Normal file
View file

@ -0,0 +1,226 @@
.TH "ecasoundrc" "5" "22\&.03\&.2009" "" "Multimedia software"
.PP
.SH "NAME"
ecasoundrc \- ecasound rcfile
.PP
.SH "SYNOPSIS"
{prefix}/share/ecasound/ecasoundrc (for instance \&'/usr/local/share/ecasound/ecasoundrc\&')
$HOME/\&.ecasound/ecasoundrc
.PP
.SH "DESCRIPTION"
.PP
\fBecasoundrc\fP is the main configuration file for ecasound\&.
Any user-specific modification should be done to
$HOME/\&.ecasound/ecasoundrc, not to the global resource file\&. Ecasound
also allows to disable the normal policy and only read from a specific
resource file (see ecasound (1) and documentation for the \fB-R\fP option)\&.
.PP
The format is quite simple\&. One line consists of
a configuration variable and its value\&. Variable and value
are separated with either \&'=\&' or \&' \&'\&. Lines beginning with a
"#" are ignored (comment lines)\&.
.PP
.SH "VARIABLES"
.PP
.IP "midi-device"
MIDI-device\&. If the device name is given in \fIrawmidi,/dev/midi*\fP
format, OSS/Linux or OSS/Lite drivers are used\&.
Device \fIrawmidi,/dev/snd/midiCxDy\fP opens an ALSA raw-MIDI
device with card number \&'x\&' and device number \&'y\&'\&.
See ecasound (1) man page (the \&'-Md option) for more info\&.
Defaults to \fIrawmidi,/dev/midi\fP\&.
.IP
.IP "default-output"
Output device to use by default\&. If a chainsetup with zero
outputs, but with one or more inputs, is connected, a default output
is added and all the chains are connected to it\&. If the special-case
value \&'autodetect\&' is specified, ecasound will try to auto-detect
a suitable device (JACK -> ALSA -> OSS -> rtnull)\&.
Defaults to \fIautodetect\fP\&.
.IP
.IP "default-audio-format"
Default values for sample format, channel count, sampling rate
and channel interleaving\&. Syntax is the same as used by
ecasound\&'s \fI-f\fP option (see ecasound (1))\&.
Defaults to \fIs16_le,2,44100,i\fP\&.
.IP
.IP "default-to-precise-sample-rates"
Whether to ignore sample rate differences (and possibly avoid
resampling)\&. Currently only affects OSS-devices\&. Defaults to \fIfalse\fP\&.
.IP
.IP "default-mix-mode"
If \fIdefault-mix-mode\fP is \fIsum\fP, engine will mix multiple channels into
one output channel by summing all input channels\&. In mode \fIavg\fP,
mixing is done by taking the average of all input channels\&. The
\fIavg\fP mode is safe from clipping, while \fIsum\fP is closer
to the way analog mixers work\&. Defaults to \fIavg\fP\&.
.IP
.IP "bmode-defaults-nonrt"
Selects the default parameters to use with buffering
mode \&'nonrt\&' (other modes are \&'rt\&' and \&'rtlowlatency)\&.
Parameters are given as a comma-separated tuple of values:
1) buffersize (number,-b), 2) raised priority (true/false,-r),
3) sched_priority (number,-r:X), 4) double buffering
(true/false,-z:db), 5) db-bufsize (number,-z:db,X), and
6) max intbuf (true/false,-z:intbuf)\&. Defaults to
\fI1024,false,50,false,100000,true\fP\&.
.IP
.IP "bmode-defaults-rt"
See \&'bmode-defaults-nonrt\&'\&. Defaults to
\fI1024,true,50,true,100000,true\fP\&.
.IP
.IP "bmode-defaults-rtlowlatency"
See \&'bmode-defaults-nonrt\&'\&. Defaults to
\fI256,true,50,true,100000,false\fP\&.
.IP
.IP "resource-directory"
Directory for global ecasound configuration files\&.
Defaults to \fI{prefix-dir}/share/ecasound\fP\&.
Note! User-specific resource files can be be stored
to \&'$(HOME)/\&.ecasound/\&'\&. For instance you can
add your own presets definitions to
\&'$(HOME)/\&.ecasound/effect_presets\&'\&.
.IP
.IP "resource-file-genosc-envelopes"
Configuration file for generic oscillators\&. Is located in the
resource directory\&. Defaults to \fIgeneric_oscillators\fP\&.
.IP
.IP "resource-file-effect-presets"
Configuration file for effect presets\&. Is located in the
resource directory\&. Defaults to \fIeffect_presets\fP\&.
.IP
.IP "ladspa-plugin-directory"
Directory containing LADSPA effect plugins\&. Defaults to \fI{prefix-dir}/lib/ladspa\fP\&.
If environment variable \fILADSPA_PATH\fP exists, directories
specified in it are automatically searched for plugins\&.
Note! To match the syntax of the \fILADSPA_PATH\fP environment
variable, \&'ladspa-plugin-directory\&' can contain multiple
directories, separated by \&':\&' characters\&.
.IP
.IP "ext-cmd-text-editor"
If \fIext-cmd-text-editor-use-getenv\fP is \fIfalse\fP or "EDITOR"
is null, value of this field is used\&.
.IP
.IP "ext-cmd-text-editor-use-getenv"
Should ecasound try to query environment variable "EDITOR"\&.
Defaults to \fItrue\fP\&.
.IP
.IP "ext-cmd-mp3-input"
Command for starting mp3 input\&. Ecasound expects to read signed,
16bit, little-endian stereo audio samples from its standard
input\&. Ecsound will query other audio format parameters by parsing
the mp3 file header\&. Before execution, %f is replaced with
path to the input mp3\&. If exists, "%o" is replaced with he
start offset in mp3 frames\&. Double-quotes and backslash-espacing
can be used to include white-space to individual parameters\&.
By default, \fImpg123\fP is launched\&.
.IP
.IP "ext-cmd-mp3-output"
Command for starting mp3 output\&. Ecasound will write stereo,
signed, 16bit, little-endian samples to standard output\&. Sample
rate is configurable\&. Before execution, %f is replaced with
path to the output mp3, %S with sample rate in kHz, and
%B with encoding bitrate in kbps\&. Double-quotes and
backslash-espacing can be used to include white-space to
individual parameters\&. By default Ecasound will try to
launch \fIlame\fP\&. As a special exception (added to Ecasound
2\&.7\&.0), if the output program is "lame" and options
include "--big-endian", Ecasound will detect this and output
big-endian samples\&.
.IP
.IP "ext-cmd-ogg-input"
Command for starting Ogg Vorbis input\&. Ecasound expects that audio samples
are written to standard output\&. It should be noted that
Ecasound is not able to query the audio format parameters from
ogg files, so these need to be set manually by the user\&.
Before execution, %f is replaced with path to the input ogg\&.
Double-quotes and backslash-espacing can be used to include white-space
to individual parameters\&. By default Ecasound will try to
launch (ogg123)\&.
.IP
.IP "ext-cmd-ogg-output"
Command for starting Ogg Vorbis output\&. Ecasound will write
samples in little-endian format to standard output\&. Other
audio parameters are configurable\&. Before execution, %f is
replaced with path to the output ogg, %c, %s and %b with matching audio
format parameters, and %B with encoding bitrate in kbps\&.
Double-quotes and backslash-espacing can be used to include white-space to
individual parameters\&. By default Ecasound will try to
launch (oggenc)\&.
.IP
.IP "ext-cmd-mikmod"
Command for starting mikmod input\&. Ecasound expects that
signed, 16bit, stereo audio samples are written to standard
output\&. Before execution, %f is replaced with
file path, and %s with selected sample rate\&. Double-quotes
and backslash-espacing can be used to include white-space to
individual parameters\&. By default Ecasound will try to launch
\fImikmod\fP\&.
.IP
.IP "ext-cmd-timidity"
Command for starting timidity++ input\&. Ecasound expects that
signed, 16bit, stereo audio samples are written to standard
output\&. Before execution, %f is replaced with file path, and
%s with sample rate\&. Double-quotes and backslash-espacing can
be used to include white-space to individual parameters\&.
By default Ecasound will try to launch \fItimidity\fP\&.
.IP
.IP "ext-cmd-flac-input"
Command for starting FLAC input\&. Ecasound expects that audio samples
are written to standard output\&. It should be noted that
Ecasound is not able to query the audio format parameters from
FLAC files, so these need to be set manually by the user\&.
Before execution, %f is replaced with path to the input FLAC
file\&. Double-quotes and backslash-espacing can be used to include
white-space to individual parameters\&. By default Ecasound will
try to launch (flac)\&.
.IP
.IP "ext-cmd-flac-output"
Command for starting FLAC output\&. Ecasound will write
samples to standard output\&. All audio parameters are
configurable\&. Before execution, %f is replaced with path to
the output flac, %c, %b and %s with matching audio
format parameters, %I with either \&'signed\&' or \&'unsigned\&', and
%E with either \&'little\&' or \&'big\&'\&. Double-quotes and backslash-espacing
can be used to include white-space to individual parameters\&. By default
Ecasound will try to launch (flac)\&.
.IP
.IP "ext-cmd-aac-input"
Command for starting AAC input\&. Ecasound expects that signed,
16bit, stereo, big-endian audio samplesare written to standard
output\&. It should be noted that Ecasound is not able to query
the input sample rate, so this needs to be set manually by the user\&.
Before execution, %f is replaced with path to the input AAC
file\&. Note! FAAC must be compiled with MP4 support\&. Double-quotes
and backslash-espacing can be used to include white-space to
individual parameters\&. By default Ecasound will try to
laucnh \fIfaad\fP\&.
.IP
.IP "ext-cmd-aac-output"
Command for starting AAC output\&. Ecasound will write big-endian
audio samples to standard output\&. All other audio parameters are
configurable\&. Before execution, %f is replaced with path to
the output AAC file, %c, %b and %s with matching audio format
parameters\&. Note! FAAC must be compiled with MP4 support\&. Double-quotes
and backslash-espacing can be used to include white-space to
individual parameters\&. By default Ecasound will try to launch
\fIfaac\fP\&.
.IP
.SH "DEPRECATED"
.PP
.IP "ext-cmd-wave-editor"
.IP
.SH "SEE ALSO"
.PP
ecasound (1), ecatools (1), ecasound-iam (1)
.PP
.SH "AUTHOR"
.PP
Kai Vehmanen, <kvehmanen -at- eca -dot- cx <kvehmanen -at- eca -dot- cx>>

252
library/ecasound/Documentation/ecasoundrc_manpage.html Normal file
View file

@ -0,0 +1,252 @@
<html><head>
<title>ecasoundrc</title>
<link rev="made" href="mailto:kvehmanen -at- eca -dot- cx">
</head>
<body>
<hr>
<h1>ecasoundrc</h1>
<h2>22.03.2009</h2>
<html><head>
<link rev="made" href="mailto:kvehmanen -at- eca -dot- cx">
</head>
<body>
<hr>
<h1></h1>
<html><head>
<title>ecasoundrc(5)</title>
<link rev="made" href="mailto:kvehmanen -at- eca -dot- cx">
</head>
<body>
<hr>
<h1>ecasoundrc(5)</h1>
<h2> Multimedia software</h2>
<h2>22.03.2009</h2>
<p>
<h2>NAME</h2>ecasoundrc - ecasound rcfile
<p>
<h2>SYNOPSIS</h2>
{prefix}/share/ecasound/ecasoundrc (for instance '/usr/local/share/ecasound/ecasoundrc')
$HOME/.ecasound/ecasoundrc
<p>
<h2>DESCRIPTION</h2>
<p>
<strong>ecasoundrc</strong> is the main configuration file for ecasound.
Any user-specific modification should be done to
$HOME/.ecasound/ecasoundrc, not to the global resource file. Ecasound
also allows to disable the normal policy and only read from a specific
resource file (see ecasound (1) and documentation for the <strong>-R</strong> option).
<p>
The format is quite simple. One line consists of
a configuration variable and its value. Variable and value
are separated with either '=' or ' '. Lines beginning with a
"#" are ignored (comment lines).
<p>
<h2>VARIABLES</h2>
<p>
<dl>
<p>
<p><dt><strong>midi-device</strong><dd>
MIDI-device. If the device name is given in <em>rawmidi,/dev/midi*</em>
format, OSS/Linux or OSS/Lite drivers are used.
Device <em>rawmidi,/dev/snd/midiCxDy</em> opens an ALSA raw-MIDI
device with card number 'x' and device number 'y'.
See ecasound (1) man page (the '-Md option) for more info.
Defaults to <em>rawmidi,/dev/midi</em>.
<p>
<p><dt><strong>default-output</strong><dd>
Output device to use by default. If a chainsetup with zero
outputs, but with one or more inputs, is connected, a default output
is added and all the chains are connected to it. If the special-case
value 'autodetect' is specified, ecasound will try to auto-detect
a suitable device (JACK -&gt; ALSA -&gt; OSS -&gt; rtnull).
Defaults to <em>autodetect</em>.
<p>
<p><dt><strong>default-audio-format</strong><dd>
Default values for sample format, channel count, sampling rate
and channel interleaving. Syntax is the same as used by
ecasound's <em>-f</em> option (see ecasound (1)).
Defaults to <em>s16_le,2,44100,i</em>.
<p>
<p><dt><strong>default-to-precise-sample-rates</strong><dd>
Whether to ignore sample rate differences (and possibly avoid
resampling). Currently only affects OSS-devices. Defaults to <em>false</em>.
<p>
<p><dt><strong>default-mix-mode</strong><dd>
If <em>default-mix-mode</em> is <em>sum</em>, engine will mix multiple channels into
one output channel by summing all input channels. In mode <em>avg</em>,
mixing is done by taking the average of all input channels. The
<em>avg</em> mode is safe from clipping, while <em>sum</em> is closer
to the way analog mixers work. Defaults to <em>avg</em>.
<p>
<p><dt><strong>bmode-defaults-nonrt</strong><dd>
Selects the default parameters to use with buffering
mode 'nonrt' (other modes are 'rt' and 'rtlowlatency).
Parameters are given as a comma-separated tuple of values:
1) buffersize (number,-b), 2) raised priority (true/false,-r),
3) sched_priority (number,-r:X), 4) double buffering
(true/false,-z:db), 5) db-bufsize (number,-z:db,X), and
6) max intbuf (true/false,-z:intbuf). Defaults to
<em>1024,false,50,false,100000,true</em>.
<p>
<p><dt><strong>bmode-defaults-rt</strong><dd>
See 'bmode-defaults-nonrt'. Defaults to
<em>1024,true,50,true,100000,true</em>.
<p>
<p><dt><strong>bmode-defaults-rtlowlatency</strong><dd>
See 'bmode-defaults-nonrt'. Defaults to
<em>256,true,50,true,100000,false</em>.
<p>
<p><dt><strong>resource-directory</strong><dd>
Directory for global ecasound configuration files.
Defaults to <em>{prefix-dir}/share/ecasound</em>.
Note! User-specific resource files can be be stored
to '$(HOME)/.ecasound/'. For instance you can
add your own presets definitions to
'$(HOME)/.ecasound/effect_presets'.
<p>
<p><dt><strong>resource-file-genosc-envelopes</strong><dd>
Configuration file for generic oscillators. Is located in the
resource directory. Defaults to <em>generic_oscillators</em>.
<p>
<p><dt><strong>resource-file-effect-presets</strong><dd>
Configuration file for effect presets. Is located in the
resource directory. Defaults to <em>effect_presets</em>.
<p>
<p><dt><strong>ladspa-plugin-directory</strong><dd>
Directory containing LADSPA effect plugins. Defaults to <em>{prefix-dir}/lib/ladspa</em>.
If environment variable <em>LADSPA_PATH</em> exists, directories
specified in it are automatically searched for plugins.
Note! To match the syntax of the <em>LADSPA_PATH</em> environment
variable, 'ladspa-plugin-directory' can contain multiple
directories, separated by ':' characters.
<p>
<p><dt><strong>ext-cmd-text-editor</strong><dd>
If <em>ext-cmd-text-editor-use-getenv</em> is <em>false</em> or "EDITOR"
is null, value of this field is used.
<p>
<p><dt><strong>ext-cmd-text-editor-use-getenv</strong><dd>
Should ecasound try to query environment variable "EDITOR".
Defaults to <em>true</em>.
<p>
<p><dt><strong>ext-cmd-mp3-input</strong><dd>
Command for starting mp3 input. Ecasound expects to read signed,
16bit, little-endian stereo audio samples from its standard
input. Ecsound will query other audio format parameters by parsing
the mp3 file header. Before execution, %f is replaced with
path to the input mp3. If exists, "%o" is replaced with he
start offset in mp3 frames. Double-quotes and backslash-espacing
can be used to include white-space to individual parameters.
By default, <em>mpg123</em> is launched.
<p>
<p><dt><strong>ext-cmd-mp3-output</strong><dd>
Command for starting mp3 output. Ecasound will write stereo,
signed, 16bit, little-endian samples to standard output. Sample
rate is configurable. Before execution, %f is replaced with
path to the output mp3, %S with sample rate in kHz, and
%B with encoding bitrate in kbps. Double-quotes and
backslash-espacing can be used to include white-space to
individual parameters. By default Ecasound will try to
launch <em>lame</em>. As a special exception (added to Ecasound
2.7.0), if the output program is "lame" and options
include "--big-endian", Ecasound will detect this and output
big-endian samples.
<p>
<p><dt><strong>ext-cmd-ogg-input</strong><dd>
Command for starting Ogg Vorbis input. Ecasound expects that audio samples
are written to standard output. It should be noted that
Ecasound is not able to query the audio format parameters from
ogg files, so these need to be set manually by the user.
Before execution, %f is replaced with path to the input ogg.
Double-quotes and backslash-espacing can be used to include white-space
to individual parameters. By default Ecasound will try to
launch (ogg123).
<p>
<p><dt><strong>ext-cmd-ogg-output</strong><dd>
Command for starting Ogg Vorbis output. Ecasound will write
samples in little-endian format to standard output. Other
audio parameters are configurable. Before execution, %f is
replaced with path to the output ogg, %c, %s and %b with matching audio
format parameters, and %B with encoding bitrate in kbps.
Double-quotes and backslash-espacing can be used to include white-space to
individual parameters. By default Ecasound will try to
launch (oggenc).
<p>
<p><dt><strong>ext-cmd-mikmod</strong><dd>
Command for starting mikmod input. Ecasound expects that
signed, 16bit, stereo audio samples are written to standard
output. Before execution, %f is replaced with
file path, and %s with selected sample rate. Double-quotes
and backslash-espacing can be used to include white-space to
individual parameters. By default Ecasound will try to launch
<em>mikmod</em>.
<p>
<p><dt><strong>ext-cmd-timidity</strong><dd>
Command for starting timidity++ input. Ecasound expects that
signed, 16bit, stereo audio samples are written to standard
output. Before execution, %f is replaced with file path, and
%s with sample rate. Double-quotes and backslash-espacing can
be used to include white-space to individual parameters.
By default Ecasound will try to launch <em>timidity</em>.
<p>
<p><dt><strong>ext-cmd-flac-input</strong><dd>
Command for starting FLAC input. Ecasound expects that audio samples
are written to standard output. It should be noted that
Ecasound is not able to query the audio format parameters from
FLAC files, so these need to be set manually by the user.
Before execution, %f is replaced with path to the input FLAC
file. Double-quotes and backslash-espacing can be used to include
white-space to individual parameters. By default Ecasound will
try to launch (flac).
<p>
<p><dt><strong>ext-cmd-flac-output</strong><dd>
Command for starting FLAC output. Ecasound will write
samples to standard output. All audio parameters are
configurable. Before execution, %f is replaced with path to
the output flac, %c, %b and %s with matching audio
format parameters, %I with either 'signed' or 'unsigned', and
%E with either 'little' or 'big'. Double-quotes and backslash-espacing
can be used to include white-space to individual parameters. By default
Ecasound will try to launch (flac).
<p>
<p><dt><strong>ext-cmd-aac-input</strong><dd>
Command for starting AAC input. Ecasound expects that signed,
16bit, stereo, big-endian audio samplesare written to standard
output. It should be noted that Ecasound is not able to query
the input sample rate, so this needs to be set manually by the user.
Before execution, %f is replaced with path to the input AAC
file. Note! FAAC must be compiled with MP4 support. Double-quotes
and backslash-espacing can be used to include white-space to
individual parameters. By default Ecasound will try to
laucnh <em>faad</em>.
<p>
<p><dt><strong>ext-cmd-aac-output</strong><dd>
Command for starting AAC output. Ecasound will write big-endian
audio samples to standard output. All other audio parameters are
configurable. Before execution, %f is replaced with path to
the output AAC file, %c, %b and %s with matching audio format
parameters. Note! FAAC must be compiled with MP4 support. Double-quotes
and backslash-espacing can be used to include white-space to
individual parameters. By default Ecasound will try to launch
<em>faac</em>.
<p>
</dl>
<p>
<h2>DEPRECATED</h2>
<p>
<dl>
<p>
<p><dt><strong>ext-cmd-wave-editor</strong><dd>
<p>
</dl>
<p>
<h2>SEE ALSO</h2>
<p>
ecasound (1), ecatools (1), ecasound-iam (1)
<p>
<h2>AUTHOR</h2>
<p>
Kai Vehmanen, &lt;<a href="mailto:kvehmanen -at- eca -dot- cx"><em>kvehmanen -at- eca -dot- cx</em></a>&gt;

220
library/ecasound/Documentation/ecatools.1 Normal file
View file

@ -0,0 +1,220 @@
.TH "ecatools" "1" "12\&.11\&.2005" "" "Multimedia software"
.PP
.SH "NAME"
ecatools \- audio processing utils based on ecasound
.PP
.SH "SYNOPSIS"
\fBecaconvert\fP \&.extension file1 [ file2 \&.\&.\&. fileN ]
.PP
\fBecafixdc\fP file1 [ file2 \&.\&.\&. fileN ]
.PP
\fBecalength\fP file1 [ file2 \&.\&.\&. fileN ]
.PP
\fBecamonitor\fP [host][:port]
.PP
\fBecanormalize\fP file1 [ file2 \&.\&.\&. fileN ]
.PP
\fBecaplay\fP [-dfhklopq] [ file1 file2 \&.\&.\&. fileN ]
.PP
\fBecasignalview\fP [ options ] [ input ] [ output ]
.PP
.SH "DESCRIPTION"
.PP
Ecatools are simple command line utils for audio file processing\&.
Each tool is designed to perform one specific operation\&. Most of
the tools also support batch processing\&.
.PP
\fBECACONVERT\fP
.PP
A tool for converting a set of files to a common target format\&.
This target format is given as the first command line
argument, and its syntax is \fI\&.ext\fP\&.
.PP
\fBECAFIXDC\fP
.PP
A simple command-line tool for fixing DC-offset\&.
.PP
\fBECALENGTH\fP
.PP
See the separate ecalength(1) man page\&.
.PP
\fBECAMONITOR\fP
.PP
Ecamonitor is a util program that can be used
to monitor an active ecasound session\&. Ecamonitor
is able to show information about the current
chainsetup such as list of inputs, outputs,
current position, effects, the engine status
and numerous other things\&.
.PP
By default ecamonitor will try to connect
to IP4 address "localhost", to port "2868"\&.
A different address can be specified when
starting ecamonitor, for example
"ecamonitor foo\&.mynetwork\&.com" or
"ecamonitor foo\&.mynetwork\&.com:4500"\&.
.PP
To enable inbound connections, ecasound has to be
started with the \fI--daemon\fP option\&. Ecamonitor is
implemented in Python using the NetECI API\&.
.PP
\fBECANORMALIZE\fP
.PP
Ecanormalize is a command-line tool for normalizing audio
files to utilize the full available sample resolution\&. Ecanormalize
first finds out how much the input file can be amplified without
clipping and if there is room for increase, a static gain will
be applied to the file\&.
.PP
\fBECAPLAY\fP
.PP
Ecaplay is a command-line tool for playing audio files\&. Ecaplay
uses the libecasound engine and is thus able to handle all audio formats
supported by the library\&.
.PP
Files can be selected for playback either by specifying the
filenames on the command-line, or by using the playlist
mechanism\&. In playlist mode, files can be added to the playlist
using the \fI-q\fP option\&. The \fI-p\fP option can then be used
to play all tracks on the playlist\&. Ecaplay will repeat the
playlist tracks until explicitly stopped (with double Ctrl-C)\&.
Playlist can be flushed with \fI-f\fP and its contents listed
with \fI-l\fP option\&.
.PP
If not otherwise specified, ecaplay will use the audio output device
specified in \fI~/\&.ecasound/ecasoundrc\fP for playback\&. A different
output device can be selected with \fIECAPLAY_OUTPUT_DEVICE\fP shell
environment variable or with the \fI-o:output_device\fP command-line
option\&.
.PP
Playback can be stopped at any time with Ctrl-C\&. If multiple
files are played, first Ctrl-C will stop the current file and move
on to play the next one\&. Issuing Ctrl-C twice (within one second),
will cause ecaplay to exit\&.
.PP
.IP "-d:debuglevel"
Set libecasound debug level\&. See ecasound(1)\&.
.IP
.IP "-f"
Flush the playlist contents\&. See also
options \fI-l, -p and -q\fP\&.
.IP
.IP "-h"
Print usage information and exit\&.
.IP
.IP "-k:number"
Skip \&'number\&' of files\&.
.IP
.IP "-l"
List the current playlist contents to stdout\&. See also
options \fI-f, -p and -q\fP\&.
.IP
.IP "-o:output_device"
Use \&'output_device\&' instead of the default output device
(as specified in \fI~/\&.ecasound/ecasoundrc\fP)\&. Syntax is same
as used by "-o" ecasound option (see ecasound(1) man page)\&.
This option overrides the \fIECAPLAY_OUTPUT_DEVICE\fP environment
variable (more info below)\&.
.IP
.IP "-p"
Play tracks in the playlist (in looped mode)\&. See also
options \fI-f, -l and -q\fP\&.
.IP
.IP "-q"
Queue new tracks to the playlist\&. All filenames given on
the command-line will be added to the the playlist\&. It is
possible to queue new tracks while another instance of
ecaplay is using the playlist\&. See also options \fI-f, -l
and -p\fP\&.
.IP
\fBECASIGNALVIEW\fP
.PP
Ecasignalview is meant for monitoring signal amplitude and peak
statistics\&. It accepts the following options:
.PP
.IP "input"
The first option not starting with a \&'-\&' is interpreted
as an input string\&. This can be a device or a filename\&. All formats
supported by libecasound are accepted\&. Defaults to \&'/dev/dsp\&'\&.
.IP
.IP "output"
Similarly to input, second option not starting with a \&'-\&'
is interpreted as output\&. Defaults to \&'null\&'\&.
.IP
.IP "-b:buffersize"
Buffersize in sample frames\&. Defaults to 128\&.
.IP
.IP "-c"
Enable cumulative mode\&. Counters are not reseted after refresh\&.
\fI*deprecated*\fP
.IP
.IP "-d"
Enable debug mode\&.
.IP
.IP "-f:format_string"
Specify default audio format\&. See ecasound(1) for details\&.
.IP
.IP "-r:rate_msec"
Specify screen refresh rate in milliseconds\&.
.IP
.IP "-I"
Use linear scale for showing audio sample amplitude\&.
.IP
.IP "-L"
Use logarithmic scale for showing audio sample amplitude\&.
.IP
.IP "-G, -B, -M*, -r, -z"
Ecasound options use to modify the engine behaviour, see
ecasound(1) manpage for details\&.
.IP
When ecasignalview is running, the following keyboard
commands can be used to control the operation (requires
system support for UNIX terminal interface control):
.PP
.IP "spacebar"
Reset statistics (max-peak, avg-amplitude and clipped
samples count)\&.
.IP
.IP "q or Q or Esc"
Quit ecasignalview\&.
.IP
It is also possible to reset the max-peak and clipped-samples
counters by sending a SIGHUP signal to the process (i\&.e\&.
from another console: "killall -v -HUP ecasignalview")\&.
.PP
More complete documentation for ecasignalview can be found
from "Ecasound User\&'s Guide" (see \&'\&'http://www\&.eca\&.cx/ecasound
-> Documentation\&'\&')\&.
.PP
.SH "ENVIRONMENT"
.PP
\fIECASOUND\fP
Path to the ecasound executable\&. Used by many ecatools\&.
.PP
\fIECAPLAY_OUTPUT_DEVICE\fP
Device ecaplay should use for audio output\&. Same syntax
as for ecaplay/ecasound "-o" option\&.
.PP
.SH "FILES"
.PP
\fI~/\&.ecasound/ecasoundrc\fP
The default ecasound resource file\&. See ecasoundrc(5)
for details\&.
.PP
\fI~/\&.ecasound/ecaplay_queue\fP
File used to store the ecaplay playlist (one track per
line with full path)\&.
.PP
.SH "SEE ALSO"
.PP
ecasound (1), ecalength(1), "HTML docs in the Documentation subdirectory"
.PP
.SH "AUTHOR"
.PP
Kai Vehmanen, <kvehmanen -at- eca -dot- cx <kvehmanen -at- eca -dot- cx>>

248
library/ecasound/Documentation/ecatools_manpage.html Normal file
View file

@ -0,0 +1,248 @@
<html><head>
<title>ecatools</title>
<link rev="made" href="mailto:kvehmanen -at- eca -dot- cx">
</head>
<body>
<hr>
<h1>ecatools</h1>
<h2>12.11.2005</h2>
<html><head>
<link rev="made" href="mailto:kvehmanen -at- eca -dot- cx">
</head>
<body>
<hr>
<h1></h1>
<html><head>
<title>ecatools(1)</title>
<link rev="made" href="mailto:kvehmanen -at- eca -dot- cx">
</head>
<body>
<hr>
<h1>ecatools(1)</h1>
<h2> Multimedia software</h2>
<h2>12.11.2005</h2>
<p>
<h2>NAME</h2>ecatools - audio processing utils based on ecasound
<p>
<h2>SYNOPSIS</h2>
<strong>ecaconvert</strong> .extension file1 [ file2 ... fileN ]
<p>
<strong>ecafixdc</strong> file1 [ file2 ... fileN ]
<p>
<strong>ecalength</strong> file1 [ file2 ... fileN ]
<p>
<strong>ecamonitor</strong> [host][:port]
<p>
<strong>ecanormalize</strong> file1 [ file2 ... fileN ]
<p>
<strong>ecaplay</strong> [-dfhklopq] [ file1 file2 ... fileN ]
<p>
<strong>ecasignalview</strong> [ options ] [ input ] [ output ]
<p>
<h2>DESCRIPTION</h2>
<p>
Ecatools are simple command line utils for audio file processing.
Each tool is designed to perform one specific operation. Most of
the tools also support batch processing.
<p>
<strong>ECACONVERT</strong>
<p>
A tool for converting a set of files to a common target format.
This target format is given as the first command line
argument, and its syntax is <em>.ext</em>.
<p>
<strong>ECAFIXDC</strong>
<p>
A simple command-line tool for fixing DC-offset.
<p>
<strong>ECALENGTH</strong>
<p>
See the separate ecalength(1) man page.
<p>
<strong>ECAMONITOR</strong>
<p>
Ecamonitor is a util program that can be used
to monitor an active ecasound session. Ecamonitor
is able to show information about the current
chainsetup such as list of inputs, outputs,
current position, effects, the engine status
and numerous other things.
<p>
By default ecamonitor will try to connect
to IP4 address "localhost", to port "2868".
A different address can be specified when
starting ecamonitor, for example
"ecamonitor foo.mynetwork.com" or
"ecamonitor foo.mynetwork.com:4500".
<p>
To enable inbound connections, ecasound has to be
started with the <em>--daemon</em> option. Ecamonitor is
implemented in Python using the NetECI API.
<p>
<strong>ECANORMALIZE</strong>
<p>
Ecanormalize is a command-line tool for normalizing audio
files to utilize the full available sample resolution. Ecanormalize
first finds out how much the input file can be amplified without
clipping and if there is room for increase, a static gain will
be applied to the file.
<p>
<strong>ECAPLAY</strong>
<p>
Ecaplay is a command-line tool for playing audio files. Ecaplay
uses the libecasound engine and is thus able to handle all audio formats
supported by the library.
<p>
Files can be selected for playback either by specifying the
filenames on the command-line, or by using the playlist
mechanism. In playlist mode, files can be added to the playlist
using the <em>-q</em> option. The <em>-p</em> option can then be used
to play all tracks on the playlist. Ecaplay will repeat the
playlist tracks until explicitly stopped (with double Ctrl-C).
Playlist can be flushed with <em>-f</em> and its contents listed
with <em>-l</em> option.
<p>
If not otherwise specified, ecaplay will use the audio output device
specified in <em>~/.ecasound/ecasoundrc</em> for playback. A different
output device can be selected with <em>ECAPLAY_OUTPUT_DEVICE</em> shell
environment variable or with the <em>-o:output_device</em> command-line
option.
<p>
Playback can be stopped at any time with Ctrl-C. If multiple
files are played, first Ctrl-C will stop the current file and move
on to play the next one. Issuing Ctrl-C twice (within one second),
will cause ecaplay to exit.
<p>
<dl>
<p><dt><strong>-d:debuglevel</strong><dd>
Set libecasound debug level. See ecasound(1).
<p>
<p><dt><strong>-f</strong><dd>
Flush the playlist contents. See also
options <em>-l, -p and -q</em>.
<p>
<p><dt><strong>-h</strong><dd>
Print usage information and exit.
<p>
<p><dt><strong>-k:number</strong><dd>
Skip 'number' of files.
<p>
<p><dt><strong>-l</strong><dd>
List the current playlist contents to stdout. See also
options <em>-f, -p and -q</em>.
<p>
<p><dt><strong>-o:output_device</strong><dd>
Use 'output_device' instead of the default output device
(as specified in <em>~/.ecasound/ecasoundrc</em>). Syntax is same
as used by "-o" ecasound option (see ecasound(1) man page).
This option overrides the <em>ECAPLAY_OUTPUT_DEVICE</em> environment
variable (more info below).
<p>
<p><dt><strong>-p</strong><dd>
Play tracks in the playlist (in looped mode). See also
options <em>-f, -l and -q</em>.
<p>
<p><dt><strong>-q</strong><dd>
Queue new tracks to the playlist. All filenames given on
the command-line will be added to the the playlist. It is
possible to queue new tracks while another instance of
ecaplay is using the playlist. See also options <em>-f, -l
and -p</em>.
<p>
</dl>
<p>
<strong>ECASIGNALVIEW</strong>
<p>
Ecasignalview is meant for monitoring signal amplitude and peak
statistics. It accepts the following options:
<p>
<dl>
<p><dt><strong>input</strong><dd>
The first option not starting with a '-' is interpreted
as an input string. This can be a device or a filename. All formats
supported by libecasound are accepted. Defaults to '/dev/dsp'.
<p>
<p><dt><strong>output</strong><dd>
Similarly to input, second option not starting with a '-'
is interpreted as output. Defaults to 'null'.
<p>
<p><dt><strong>-b:buffersize</strong><dd>
Buffersize in sample frames. Defaults to 128.
<p>
<p><dt><strong>-c</strong><dd>
Enable cumulative mode. Counters are not reseted after refresh.
<em>*deprecated*</em>
<p>
<p><dt><strong>-d</strong><dd>
Enable debug mode.
<p>
<p><dt><strong>-f:format_string</strong><dd>
Specify default audio format. See ecasound(1) for details.
<p>
<p><dt><strong>-r:rate_msec</strong><dd>
Specify screen refresh rate in milliseconds.
<p>
<p><dt><strong>-I</strong><dd>
Use linear scale for showing audio sample amplitude.
<p>
<p><dt><strong>-L</strong><dd>
Use logarithmic scale for showing audio sample amplitude.
<p>
<p><dt><strong>-G, -B, -M*, -r, -z</strong><dd>
Ecasound options use to modify the engine behaviour, see
ecasound(1) manpage for details.
<p>
</dl>
<p>
When ecasignalview is running, the following keyboard
commands can be used to control the operation (requires
system support for UNIX terminal interface control):
<p>
<dl>
<p><dt><strong>spacebar</strong><dd>
Reset statistics (max-peak, avg-amplitude and clipped
samples count).
<p>
<p><dt><strong>q or Q or Esc</strong><dd>
Quit ecasignalview.
<p>
</dl>
<p>
It is also possible to reset the max-peak and clipped-samples
counters by sending a SIGHUP signal to the process (i.e.
from another console: "killall -v -HUP ecasignalview").
<p>
More complete documentation for ecasignalview can be found
from "Ecasound User's Guide" (see ''http://www.eca.cx/ecasound
-&gt; Documentation'').
<p>
<h2>ENVIRONMENT</h2>
<p>
<em>ECASOUND</em>
Path to the ecasound executable. Used by many ecatools.
<p>
<em>ECAPLAY_OUTPUT_DEVICE</em>
Device ecaplay should use for audio output. Same syntax
as for ecaplay/ecasound "-o" option.
<p>
<h2>FILES</h2>
<p>
<em>~/.ecasound/ecasoundrc</em>
The default ecasound resource file. See ecasoundrc(5)
for details.
<p>
<em>~/.ecasound/ecaplay_queue</em>
File used to store the ecaplay playlist (one track per
line with full path).
<p>
<h2>SEE ALSO</h2>
<p>
ecasound (1), ecalength(1), "HTML docs in the Documentation subdirectory"
<p>
<h2>AUTHOR</h2>
<p>
Kai Vehmanen, &lt;<a href="mailto:kvehmanen -at- eca -dot- cx"><em>kvehmanen -at- eca -dot- cx</em></a>&gt;

50
library/ecasound/Documentation/programmers_guide/Makefile.am Normal file
View file

@ -0,0 +1,50 @@
# ----------------------------------------------------------------------
# File: ecasound/Documentation/programmers_guide/Makefile.am
# Description: Ecasound documentation - programmer's guide
# License: GPL (see ecasound/{AUTHORS,COPYING})
# ----------------------------------------------------------------------
# ---------------------------------------------------------------------
# Files going into distribution:
EXTRA_DIST = ecasound_programmers_guide.txt \
eci_doc.latex
DISTCLEANFILES = \
ecasound_programmers_guide.html \
eci_doc.log \
eci_doc.aux \
eci_doc.toc \
eci_doc.dvi \
eci_doc.ps \
ecasound_eci_doc.pdf \
html_ecidoc/eci_doc.html \
html_ecidoc/eci_doc.haux \
html_ecidoc/eci_doc.htoc
all:
docs: ecasound_programmers_guide.html ecasound_eci_doc.pdf
ecasound_programmers_guide.html: $(srcdir)/ecasound_programmers_guide.txt
rst2html $(srcdir)/ecasound_programmers_guide.txt ecasound_programmers_guide.html
# note: to create the table of contents (which spans multiple pages), and
# re-calculate the page numbers after the page offset generated by table
# of contents, latex needs to be ran 3 times. (Junichi Uekawa, 2007-08-06)
ecasound_eci_doc.pdf: $(srcdir)/eci_doc.latex eci_doc.dvi
latex $(srcdir)/eci_doc.latex
latex $(srcdir)/eci_doc.latex
latex $(srcdir)/eci_doc.latex
dvips -Ppdf -o eci_doc.ps eci_doc.dvi
ps2pdf eci_doc.ps ecasound_eci_doc.pdf
mkdir -p html_ecidoc
hevea -o html_ecidoc/eci_doc.html $(srcdir)/eci_doc.latex
hevea -o html_ecidoc/eci_doc.html $(srcdir)/eci_doc.latex
eci_doc.dvi: $(srcdir)/eci_doc.latex
clean-docs:
rm -fv ecasound_programmers_guide.html ecasound_eci_doc.pdf
rm -fv eci_doc.log eci_doc.toc eci_doc.dvi eci_doc.aux eci_doc.ps eci_doc.dvi
rm -fv html_ecidoc/*

435
library/ecasound/Documentation/programmers_guide/Makefile.in Normal file
View file

@ -0,0 +1,435 @@
# Makefile.in generated by automake 1.9.6 from Makefile.am.
# @configure_input@
# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
# 2003, 2004, 2005 Free Software Foundation, Inc.
# This Makefile.in is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
# with or without modifications, as long as this notice is preserved.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY, to the extent permitted by law; without
# even the implied warranty of MERCHANTABILITY or FITNESS FOR A
# PARTICULAR PURPOSE.
@SET_MAKE@
# ----------------------------------------------------------------------
# File: ecasound/Documentation/programmers_guide/Makefile.am
# Description: Ecasound documentation - programmer's guide
# License: GPL (see ecasound/{AUTHORS,COPYING})
# ----------------------------------------------------------------------
srcdir = @srcdir@
top_srcdir = @top_srcdir@
VPATH = @srcdir@
pkgdatadir = $(datadir)/@PACKAGE@
pkglibdir = $(libdir)/@PACKAGE@
pkgincludedir = $(includedir)/@PACKAGE@
top_builddir = ../..
am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd
INSTALL = @INSTALL@
install_sh_DATA = $(install_sh) -c -m 644
install_sh_PROGRAM = $(install_sh) -c
install_sh_SCRIPT = $(install_sh) -c
INSTALL_HEADER = $(INSTALL_DATA)
transform = $(program_transform_name)
NORMAL_INSTALL = :
PRE_INSTALL = :
POST_INSTALL = :
NORMAL_UNINSTALL = :
PRE_UNINSTALL = :
POST_UNINSTALL = :
build_triplet = @build@
host_triplet = @host@
subdir = Documentation/programmers_guide
DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in
ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
am__aclocal_m4_deps = $(top_srcdir)/acinclude.m4 \
$(top_srcdir)/configure.in
am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \
$(ACLOCAL_M4)
mkinstalldirs = $(install_sh) -d
CONFIG_HEADER = $(top_builddir)/config.h
CONFIG_CLEAN_FILES =
SOURCES =
DIST_SOURCES =
DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST)
ACLOCAL = @ACLOCAL@
AMDEP_FALSE = @AMDEP_FALSE@
AMDEP_TRUE = @AMDEP_TRUE@
AMTAR = @AMTAR@
AM_CFLAGS = @AM_CFLAGS@
AM_CPPFLAGS = @AM_CPPFLAGS@
AM_CXXFLAGS = @AM_CXXFLAGS@
AM_LDFLAGS = @AM_LDFLAGS@
AR = @AR@
ARTSC_CONFIG = @ARTSC_CONFIG@
AUTOCONF = @AUTOCONF@
AUTOHEADER = @AUTOHEADER@
AUTOMAKE = @AUTOMAKE@
AWK = @AWK@
CC = @CC@
CCDEPMODE = @CCDEPMODE@
CFLAGS = @CFLAGS@
CPP = @CPP@
CPPFLAGS = @CPPFLAGS@
CXX = @CXX@
CXXCPP = @CXXCPP@
CXXDEPMODE = @CXXDEPMODE@
CXXFLAGS = @CXXFLAGS@
CYGPATH_W = @CYGPATH_W@
DEFS = @DEFS@
DEPDIR = @DEPDIR@
DSYMUTIL = @DSYMUTIL@
ECA_AM_ALL_STATIC_FALSE = @ECA_AM_ALL_STATIC_FALSE@
ECA_AM_ALL_STATIC_TRUE = @ECA_AM_ALL_STATIC_TRUE@
ECA_AM_COMPILE_ALSA_FALSE = @ECA_AM_COMPILE_ALSA_FALSE@
ECA_AM_COMPILE_ALSA_TRUE = @ECA_AM_COMPILE_ALSA_TRUE@
ECA_AM_COMPILE_ARTS_FALSE = @ECA_AM_COMPILE_ARTS_FALSE@
ECA_AM_COMPILE_ARTS_TRUE = @ECA_AM_COMPILE_ARTS_TRUE@
ECA_AM_COMPILE_AUDIOFILE_FALSE = @ECA_AM_COMPILE_AUDIOFILE_FALSE@
ECA_AM_COMPILE_AUDIOFILE_TRUE = @ECA_AM_COMPILE_AUDIOFILE_TRUE@
ECA_AM_COMPILE_JACK_FALSE = @ECA_AM_COMPILE_JACK_FALSE@
ECA_AM_COMPILE_JACK_TRUE = @ECA_AM_COMPILE_JACK_TRUE@
ECA_AM_COMPILE_OSS_FALSE = @ECA_AM_COMPILE_OSS_FALSE@
ECA_AM_COMPILE_OSS_TRUE = @ECA_AM_COMPILE_OSS_TRUE@
ECA_AM_COMPILE_SAMPLERATE_FALSE = @ECA_AM_COMPILE_SAMPLERATE_FALSE@
ECA_AM_COMPILE_SAMPLERATE_TRUE = @ECA_AM_COMPILE_SAMPLERATE_TRUE@
ECA_AM_COMPILE_SNDFILE_FALSE = @ECA_AM_COMPILE_SNDFILE_FALSE@
ECA_AM_COMPILE_SNDFILE_TRUE = @ECA_AM_COMPILE_SNDFILE_TRUE@
ECA_AM_DEBUG_MODE_FALSE = @ECA_AM_DEBUG_MODE_FALSE@
ECA_AM_DEBUG_MODE_TRUE = @ECA_AM_DEBUG_MODE_TRUE@
ECA_AM_DISABLE_EFFECTS_FALSE = @ECA_AM_DISABLE_EFFECTS_FALSE@
ECA_AM_DISABLE_EFFECTS_TRUE = @ECA_AM_DISABLE_EFFECTS_TRUE@
ECA_AM_FEELING_EXPERIMENTAL_FALSE = @ECA_AM_FEELING_EXPERIMENTAL_FALSE@
ECA_AM_FEELING_EXPERIMENTAL_TRUE = @ECA_AM_FEELING_EXPERIMENTAL_TRUE@
ECA_AM_KVUTILS_INSTALLED_FALSE = @ECA_AM_KVUTILS_INSTALLED_FALSE@
ECA_AM_KVUTILS_INSTALLED_TRUE = @ECA_AM_KVUTILS_INSTALLED_TRUE@
ECA_AM_PYECASOUND_CEXT_FALSE = @ECA_AM_PYECASOUND_CEXT_FALSE@
ECA_AM_PYECASOUND_CEXT_TRUE = @ECA_AM_PYECASOUND_CEXT_TRUE@
ECA_AM_PYECASOUND_INSTALL_FALSE = @ECA_AM_PYECASOUND_INSTALL_FALSE@
ECA_AM_PYECASOUND_INSTALL_TRUE = @ECA_AM_PYECASOUND_INSTALL_TRUE@
ECA_AM_RUBYECASOUND_INSTALL_FALSE = @ECA_AM_RUBYECASOUND_INSTALL_FALSE@
ECA_AM_RUBYECASOUND_INSTALL_TRUE = @ECA_AM_RUBYECASOUND_INSTALL_TRUE@
ECA_AM_SYSTEM_READLINE_FALSE = @ECA_AM_SYSTEM_READLINE_FALSE@
ECA_AM_SYSTEM_READLINE_TRUE = @ECA_AM_SYSTEM_READLINE_TRUE@
ECA_AM_USE_NCURSES_FALSE = @ECA_AM_USE_NCURSES_FALSE@
ECA_AM_USE_NCURSES_TRUE = @ECA_AM_USE_NCURSES_TRUE@
ECA_AM_USE_TERMCAP_FALSE = @ECA_AM_USE_TERMCAP_FALSE@
ECA_AM_USE_TERMCAP_TRUE = @ECA_AM_USE_TERMCAP_TRUE@
ECA_S_EXTRA_CPPFLAGS = @ECA_S_EXTRA_CPPFLAGS@
ECA_S_EXTRA_LIBS = @ECA_S_EXTRA_LIBS@
ECA_S_JACK_INCLUDES = @ECA_S_JACK_INCLUDES@
ECA_S_JACK_LIBS = @ECA_S_JACK_LIBS@
ECA_S_PREFIX = @ECA_S_PREFIX@
ECA_S_PYTHON_DLMODULES = @ECA_S_PYTHON_DLMODULES@
ECA_S_PYTHON_INCLUDES = @ECA_S_PYTHON_INCLUDES@
ECA_S_PYTHON_MODULES = @ECA_S_PYTHON_MODULES@
ECA_S_READLINE_INCLUDES = @ECA_S_READLINE_INCLUDES@
ECA_S_READLINE_LIBS = @ECA_S_READLINE_LIBS@
ECA_S_RUBY_SITEDIR = @ECA_S_RUBY_SITEDIR@
ECHO = @ECHO@
ECHO_C = @ECHO_C@
ECHO_N = @ECHO_N@
ECHO_T = @ECHO_T@
EGREP = @EGREP@
EXEEXT = @EXEEXT@
F77 = @F77@
FFLAGS = @FFLAGS@
GREP = @GREP@
INSTALL_DATA = @INSTALL_DATA@
INSTALL_PROGRAM = @INSTALL_PROGRAM@
INSTALL_SCRIPT = @INSTALL_SCRIPT@
INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@
LDFLAGS = @LDFLAGS@
LIBECASOUNDC_VERSION = @LIBECASOUNDC_VERSION@
LIBECASOUNDC_VERSION_AGE = @LIBECASOUNDC_VERSION_AGE@
LIBECASOUND_VERSION = @LIBECASOUND_VERSION@
LIBECASOUND_VERSION_AGE = @LIBECASOUND_VERSION_AGE@
LIBKVUTILS_VERSION = @LIBKVUTILS_VERSION@
LIBKVUTILS_VERSION_AGE = @LIBKVUTILS_VERSION_AGE@
LIBLO_CFLAGS = @LIBLO_CFLAGS@
LIBLO_LIBS = @LIBLO_LIBS@
LIBOBJS = @LIBOBJS@
LIBOIL_CFLAGS = @LIBOIL_CFLAGS@
LIBOIL_LIBS = @LIBOIL_LIBS@
LIBS = @LIBS@
LIBTOOL = @LIBTOOL@
LN_S = @LN_S@
LTLIBOBJS = @LTLIBOBJS@
MAKEINFO = @MAKEINFO@
NMEDIT = @NMEDIT@
OBJEXT = @OBJEXT@
PACKAGE = @PACKAGE@
PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@
PACKAGE_NAME = @PACKAGE_NAME@
PACKAGE_STRING = @PACKAGE_STRING@
PACKAGE_TARNAME = @PACKAGE_TARNAME@
PACKAGE_VERSION = @PACKAGE_VERSION@
PATH_SEPARATOR = @PATH_SEPARATOR@
PKG_CONFIG = @PKG_CONFIG@
PYTHONPATH = @PYTHONPATH@
RANLIB = @RANLIB@
RUBYPATH = @RUBYPATH@
SED = @SED@
SET_MAKE = @SET_MAKE@
SHELL = @SHELL@
STRIP = @STRIP@
VERSION = @VERSION@
ac_ct_CC = @ac_ct_CC@
ac_ct_CXX = @ac_ct_CXX@
ac_ct_F77 = @ac_ct_F77@
am__fastdepCC_FALSE = @am__fastdepCC_FALSE@
am__fastdepCC_TRUE = @am__fastdepCC_TRUE@
am__fastdepCXX_FALSE = @am__fastdepCXX_FALSE@
am__fastdepCXX_TRUE = @am__fastdepCXX_TRUE@
am__include = @am__include@
am__leading_dot = @am__leading_dot@
am__quote = @am__quote@
am__tar = @am__tar@
am__untar = @am__untar@
bindir = @bindir@
build = @build@
build_alias = @build_alias@
build_cpu = @build_cpu@
build_os = @build_os@
build_vendor = @build_vendor@
datadir = @datadir@
datarootdir = @datarootdir@
docdir = @docdir@
dvidir = @dvidir@
exec_prefix = @exec_prefix@
host = @host@
host_alias = @host_alias@
host_cpu = @host_cpu@
host_os = @host_os@
host_vendor = @host_vendor@
htmldir = @htmldir@
includedir = @includedir@
infodir = @infodir@
install_sh = @install_sh@
libdir = @libdir@
libexecdir = @libexecdir@
localedir = @localedir@
localstatedir = @localstatedir@
mandir = @mandir@
mkdir_p = @mkdir_p@
oldincludedir = @oldincludedir@
pdfdir = @pdfdir@
prefix = @prefix@
program_transform_name = @program_transform_name@
psdir = @psdir@
sbindir = @sbindir@
sharedstatedir = @sharedstatedir@
sysconfdir = @sysconfdir@
target_alias = @target_alias@
# ---------------------------------------------------------------------
# Files going into distribution:
EXTRA_DIST = ecasound_programmers_guide.txt \
eci_doc.latex
DISTCLEANFILES = \
ecasound_programmers_guide.html \
eci_doc.log \
eci_doc.aux \
eci_doc.toc \
eci_doc.dvi \
eci_doc.ps \
ecasound_eci_doc.pdf \
html_ecidoc/eci_doc.html \
html_ecidoc/eci_doc.haux \
html_ecidoc/eci_doc.htoc
all: all-am
.SUFFIXES:
$(srcdir)/Makefile.in: $(srcdir)/Makefile.am $(am__configure_deps)
@for dep in $?; do \
case '$(am__configure_deps)' in \
*$$dep*) \
cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh \
&& exit 0; \
exit 1;; \
esac; \
done; \
echo ' cd $(top_srcdir) && $(AUTOMAKE) --foreign Documentation/programmers_guide/Makefile'; \
cd $(top_srcdir) && \
$(AUTOMAKE) --foreign Documentation/programmers_guide/Makefile
.PRECIOUS: Makefile
Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status
@case '$?' in \
*config.status*) \
cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \
*) \
echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \
cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \
esac;
$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES)
cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh
$(top_srcdir)/configure: $(am__configure_deps)
cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh
$(ACLOCAL_M4): $(am__aclocal_m4_deps)
cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh
mostlyclean-libtool:
-rm -f *.lo
clean-libtool:
-rm -rf .libs _libs
distclean-libtool:
-rm -f libtool
uninstall-info-am:
tags: TAGS
TAGS:
ctags: CTAGS
CTAGS:
distdir: $(DISTFILES)
@srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; \
topsrcdirstrip=`echo "$(top_srcdir)" | sed 's|.|.|g'`; \
list='$(DISTFILES)'; for file in $$list; do \
case $$file in \
$(srcdir)/*) file=`echo "$$file" | sed "s|^$$srcdirstrip/||"`;; \
$(top_srcdir)/*) file=`echo "$$file" | sed "s|^$$topsrcdirstrip/|$(top_builddir)/|"`;; \
esac; \
if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \
dir=`echo "$$file" | sed -e 's,/[^/]*$$,,'`; \
if test "$$dir" != "$$file" && test "$$dir" != "."; then \
dir="/$$dir"; \
$(mkdir_p) "$(distdir)$$dir"; \
else \
dir=''; \
fi; \
if test -d $$d/$$file; then \
if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \
cp -pR $(srcdir)/$$file $(distdir)$$dir || exit 1; \
fi; \
cp -pR $$d/$$file $(distdir)$$dir || exit 1; \
else \
test -f $(distdir)/$$file \
|| cp -p $$d/$$file $(distdir)/$$file \
|| exit 1; \
fi; \
done
check-am: all-am
check: check-am
all-am: Makefile
installdirs:
install: install-am
install-exec: install-exec-am
install-data: install-data-am
uninstall: uninstall-am
install-am: all-am
@$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am
installcheck: installcheck-am
install-strip:
$(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \
install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \
`test -z '$(STRIP)' || \
echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install
mostlyclean-generic:
clean-generic:
distclean-generic:
-test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES)
-test -z "$(DISTCLEANFILES)" || rm -f $(DISTCLEANFILES)
maintainer-clean-generic:
@echo "This command is intended for maintainers to use"
@echo "it deletes files that may require special tools to rebuild."
clean: clean-am
clean-am: clean-generic clean-libtool mostlyclean-am
distclean: distclean-am
-rm -f Makefile
distclean-am: clean-am distclean-generic distclean-libtool
dvi: dvi-am
dvi-am:
html: html-am
info: info-am
info-am:
install-data-am:
install-exec-am:
install-info: install-info-am
install-man:
installcheck-am:
maintainer-clean: maintainer-clean-am
-rm -f Makefile
maintainer-clean-am: distclean-am maintainer-clean-generic
mostlyclean: mostlyclean-am
mostlyclean-am: mostlyclean-generic mostlyclean-libtool
pdf: pdf-am
pdf-am:
ps: ps-am
ps-am:
uninstall-am: uninstall-info-am
.PHONY: all all-am check check-am clean clean-generic clean-libtool \
distclean distclean-generic distclean-libtool distdir dvi \
dvi-am html html-am info info-am install install-am \
install-data install-data-am install-exec install-exec-am \
install-info install-info-am install-man install-strip \
installcheck installcheck-am installdirs maintainer-clean \
maintainer-clean-generic mostlyclean mostlyclean-generic \
mostlyclean-libtool pdf pdf-am ps ps-am uninstall uninstall-am \
uninstall-info-am
all:
docs: ecasound_programmers_guide.html ecasound_eci_doc.pdf
ecasound_programmers_guide.html: $(srcdir)/ecasound_programmers_guide.txt
rst2html $(srcdir)/ecasound_programmers_guide.txt ecasound_programmers_guide.html
# note: to create the table of contents (which spans multiple pages), and
# re-calculate the page numbers after the page offset generated by table
# of contents, latex needs to be ran 3 times. (Junichi Uekawa, 2007-08-06)
ecasound_eci_doc.pdf: $(srcdir)/eci_doc.latex eci_doc.dvi
latex $(srcdir)/eci_doc.latex
latex $(srcdir)/eci_doc.latex
latex $(srcdir)/eci_doc.latex
dvips -Ppdf -o eci_doc.ps eci_doc.dvi
ps2pdf eci_doc.ps ecasound_eci_doc.pdf
mkdir -p html_ecidoc
hevea -o html_ecidoc/eci_doc.html $(srcdir)/eci_doc.latex
hevea -o html_ecidoc/eci_doc.html $(srcdir)/eci_doc.latex
eci_doc.dvi: $(srcdir)/eci_doc.latex
clean-docs:
rm -fv ecasound_programmers_guide.html ecasound_eci_doc.pdf
rm -fv eci_doc.log eci_doc.toc eci_doc.dvi eci_doc.aux eci_doc.ps eci_doc.dvi
rm -fv html_ecidoc/*
# Tell versions [3.59,3.63) of GNU make to not export all variables.
# Otherwise a system limit (for SysV at least) may be exceeded.
.NOEXPORT:

1207
library/ecasound/Documentation/programmers_guide/ecasound_programmers_guide.txt Normal file
View file

File diff suppressed because it is too large Load diff

714
library/ecasound/Documentation/programmers_guide/eci_doc.latex Normal file
View file

@ -0,0 +1,714 @@
\documentclass{article}
\usepackage[T1]{fontenc}
\usepackage{ae}
%\usepackage{html}
%\bodytext{link="#662a00" vlink="#666655" bgcolor="#ffffff"}
\title{Ecasound Control Interface Guide}
\author{Kai Vehmanen, Brad Bowman, Tony Leake, Jan Weil, Mario Lang}
\date{03062006}
\begin{document}
\maketitle
\tableofcontents
\clearpage
% ----------------------------------------------------------------------
% ----------------------------------------------------------------------
\section{Introduction}
The idea behind the Ecasound Control Interface (ECI) is to take a subset of
functionality provided by libecasound, provide a simple API for it, and
port it to various languages. At the moment, implementations of the
ECI API are available for C, C++, elisp, Python and Ruby. These all
come by default with the Ecasound package. Additional implementations,
for example for Perl and PHP, are distributed independently.
ECI is heavily based on Ecasound's interactive mode (EIAM), and the
services it provides. See \texttt{ecasound-iam(1) manual page} for
a detailed EIAM documentation.
% ----------------------------------------------------------------------
% ----------------------------------------------------------------------
\section{Document history}
\begin{itemize}
\item 04.06.2006 - Added more information to the ``Tips for debugging'' section.
\item 21.03.2005 - Updated the ``Tips for debugging'' section.
\item 25.09.2004 - Updated the ``Return values'' section based on feedback
from Adam Linson.
\item 02.05.2004 - ``Emacs'' section added (written by Mario Lang).
\item 28.11.2003 - ``Ruby'' section added (written by Jan Weil).
Updated the introduction.
\item 26.11.2003 - Fix filename for the alternative Python API (eci.py).
\item 18.11.2003 - Typo fixes. Updated documentation to reflect the new
naming convention (ecasound refers to the binary,
Ecasound refers to the whole package).
\item 26.10.2002 - Changed the C++ linking example.
\item 24.10.2002 - Added ``Notes Concerning Standalone ECI Implementations''
section. Added compilation examples.
\item 06.10.2002 - Added ``Application development'' section.
\item 05.10.2002 - Changed the libecasoundc link path.
\item 29.09.2002 - ``PHP'' section added (written by Tony Leake).
\item 25.04.2002 - Changed headers path from ``<ecasoundc/file.h>'' to
``<file.h>'' and added library version number to
link instructions.
\item 21.10.2001 - Added this history section. Minor changes to
ECI examples.
\end{itemize}
% ----------------------------------------------------------------------
% ----------------------------------------------------------------------
\section{General}
ECI doesn't provide any routines that directly manipulate audio or
Ecasound objects. What it does provide is an easy and generic way
to issue EIAM (Ecasound Inter-Active Mode) commands, access the
command return-values and perform error handling.
This approach has two benefits. First, it is possible to keep the API
small, and thus make it easier to port ECI to new languages. Secondly,
it's possible to keep ECI relatively stable. Ecasound itself is a large,
developing library. New features are added all the time, and from time
to time, older parts of the library will get rewritten to better suit
new uses. Now for application developers wanting to take advantage of
libecasound, these constant changes are very annoying, especially if
your specific app doesn't need the latest new features. In these
cases, ECI is the best platform for application development.
% ----------------------------------------------------------------------
\subsection{What's it good for?}
Specific tasks ECI is aimed at:
\begin{itemize}
\item 1. automating (scripting in its traditional sense)
\item 2. frontends (generic / specialized)
\item 3. sound services to other apps
\end{itemize}
% ----------------------------------------------------------------------
\subsection{Services and behaviour}
Here is a list of services provided by all ECI implementations:
\subsubsection{Actions}
\begin{description}
\item[command(string)]
Issue an EIAM command.
\item[command\_float\_arg(string, float)]
Issue an EIAM command. This function can be used instead of
\emph{command(string)}, if the command in question requires exactly one
numerical parameter. This way it's possible to avoid the extra
string -> float conversion, which would lead to lost precision.
\end{description}
\subsubsection{Return values}
Each EIAM command has exactly one return value type. After a command
has been issued, only one last\_type() functions returns a non-empty
value. For example, last\_float() only returns a valid value if
\emph{last\_type() == 'f'} holds true. Not all EIAM commands return
a value (return type is void).
\begin{description}
\item[last\_string()]
Returns the last string return value.
\item[last\_string\_list()]
Returns the last collection of strings (one or more strings).
\item[last\_float()]
Returns the last floating-point return value. Note! last\_float()
doesn't refer to the C/C++ type 'float'. In most implementations,
floats are 64bit values (doubles in C/C++).
\item[last\_integer()]
Returns the last integer return value. This function is also
used to return boolean values, where non-zero means 'true'
and zero 'false'.
\item[last\_long\_integer()]
Returns the last long integer return value. Long integers are
used to pass values like 'length\_in\_samples' and 'length\_in\_bytes'.
It's implementation specific whether there's any real difference
between integers and long integers.
\end{description}
\subsubsection{Errors}
\begin{description}
\item[error()]
Returns true (!= 0) if error has occured during the execution
of last EIAM command. Otherwise returns false (= 0).
\item[last\_error()]
Returns a string describing the last error. If the last EIAM command
was executed succesfully, last\_error() returns an empty string.
\end{description}
\subsubsection{Other}
\begin{description}
\item[initialize()]
Reserve resources.
\item[cleanup()]
Free all reserved resources.
\end{description}
% ----------------------------------------------------------------------
\subsection{Porting to new environments}
Porting ECI to new languages should be easy. All there is to do is
to implement the services listed in the previous section to the target
language. In most cases it's to easiest to use the C++ or C ECI
as the underlying implementation to build upon.
% ----------------------------------------------------------------------
% ----------------------------------------------------------------------
\section{Implementations}
% ----------------------------------------------------------------------
\subsection{General}
\subsubsection{Overview}
This section contains overview of how ECI is implemented in the
discussed language (eg. as a single class, set of classes, set of
routines, etc).
\subsubsection{Usage}
A quick tutorial to get you started.
\subsubsection{Example}
Implementation of the following:
\begin{enumerate}
\item Setup ECI to read audio from file, apply a 100Hz lowpass filter, and
send it to the soundcard (/dev/dsp).
\item Every second, check the current position. If the stream has
been running for over 15 seconds, exit immediately. Also,
every second, increase the lowpass filter's cutoff frequency
by 500Hz.
\item Stop the stream (if not already finished) and disconnect the
chainsetup. Print chain operator status info.
\end{enumerate}
% ----------------------------------------------------------------------
\subsection{Notes Concerning Standalone ECI Implementations}
The C implementation of ECI is not directly linked against the main
Ecasound libraries. Instead, the ecasound executable is launched
on the background and command pipes are used to communicate with it.
The launched ecasound executable can be selected by using the
\emph{ECASOUND} environment variable. If it is not defined,
the C ECI implementation will try to launch ``ecasound'' (ie.
has to be somewhere in PATH).
In addition to the C implementation, this also affects all
ECI implementations that are based on the C version. Currently
this includes at least the Perl, PHP and Python ECI modules.
% ----------------------------------------------------------------------
\subsection{C++}
\subsubsection{Overview}
C++ implementation is based around the ECA\_CONTROL\_INTERFACE class.
STL vector is used for representing collections of objects
(last\_string\_list()).
\subsubsection{Usage}
\begin{enumerate}
\item \#include <eca-control-interface.h>
\item create an instance of the ECA\_CONTROL\_INTERFACE class
and use its member functions
\item link you app agains libecasoundc (-lecasoundc)
\item compilation example: \emph{c++ -o ecidoc\_example ecidoc\_example.cpp `libecasoundc-config --cflags --libs`}
\end{enumerate}
\subsubsection{Example}
\begin{verbatim}
#include <iostream>
#include <unistd.h>
#include <eca-control-interface.h>
int main(int argc, char *argv[])
{
double cutoff_inc = 500.0;
ECA_CONTROL_INTERFACE e;
e.command("cs-add play_chainsetup");
e.command("c-add 1st_chain");
e.command("ai-add some_file.wav");
e.command("ao-add /dev/dsp");
e.command("cop-add -efl:100");
e.command("cop-select 1");
e.command("copp-select 1");
e.command("cs-connect");
e.command("start");
while(1) {
sleep(1);
e.command("engine-status");
if (e.last_string() != "running") break;
e.command("get-position");
double curpos = e.last_float();
if (curpos > 15.0) break;
e.command("copp-get");
double next_cutoff = cutoff_inc + e.last_float();
e.command_float_arg("copp-set", next_cutoff);
}
e.command("stop");
e.command("cs-disconnect");
e.command("cop-status");
cerr << "Chain operator status: " << e.last_string() << endl;
return(0);
}
\end{verbatim}
% ----------------------------------------------------------------------
\subsection{C}
\subsubsection{Overview}
All C ECI functions are prefixed with "eci\_". When returning string
values, a const pointer to a null-terminated char array (const char*)
is returned. It's important to keep in mind that these are "borrowed"
references. If you need to later use the data, you must copy
it to application's own buffers.
Returning a list of strings is implemented using two functions:
\emph{eci\_last\_string\_list\_count()} returns the number of strings
available, and \emph{eci\_last\_string\_list\_item(int n)} returns a
pointer (const char*) to the string at index \emph{n}.
\emph{Note!} As of Ecasound 2.0.1, the C ECI implementation also
provides reentrant access to the ECI API. These
alternative routines are marked with '\_r' postfix.
\subsubsection{Usage}
\begin{enumerate}
\item \#include <ecasoundc.h>
\item use the eci\_* routines
\item link your app against libecasoundc (-lecasoundc)
\item compilation example: \emph{gcc -o ecidoc\_example ecidoc\_example.c `libecasoundc-config --cflags --libs`}
\end{enumerate}
\subsubsection{Example}
\begin{verbatim}
#include <stdio.h>
#include <unistd.h>
#include <ecasoundc.h>
int main(int argc, char *argv[])
{
double cutoff_inc = 500.0;
eci_init();
eci_command("cs-add play_chainsetup");
eci_command("c-add 1st_chain");
eci_command("ai-add some_file.wav");
eci_command("ao-add /dev/dsp");
eci_command("cop-add -efl:100");
eci_command("cop-select 1");
eci_command("copp-select 1");
eci_command("cs-connect");
eci_command("start");
while(1) {
double curpos, next_cutoff;
sleep(1);
eci_command("engine-status");
if (strcmp(eci_last_string(), "running") != 0) break;
eci_command("get-position");
curpos = eci_last_float();
if (curpos > 15.0) break;
eci_command("copp-get");
next_cutoff = cutoff_inc + eci_last_float();
eci_command_float_arg("copp-set", next_cutoff);
}
eci_command("stop");
eci_command("cs-disconnect");
eci_command("cop-status");
printf("Chain operator status: %s", eci_last_string());
eci_cleanup();
return(0);
}
\end{verbatim}
% ----------------------------------------------------------------------
\subsection{Emacs}
\subsubsection{Overview}
The Ecasound package comes with an 'Ecasound' library for Emacs included.
ecasound.el is a implementation of the ECI API for Emacs, as well
as an interactive interface to Ecasound sessions implemented
on top of that. Simply use "M-x ecasound RET" to fire up an
interactive Ecasound session.
All Emacs Lisp ECI functions are prefixed with ``eci\-''.
'ecasound.el' is implemented in a high level manner which means
that you won't find most of the commands known from libecasoundc like
last\_string, last\_float, etc.
Instead of that every call to function "eci-command", which accepts all
the well known IAM commands, returns ecasound's response in an appropriate type
automatically.
If an error occurs, e. g. there's a typo in a command or a file is not found,
the function returns ``nil''. In all other cases, either an automatically
converted Lisp value is returned, or ``t'' in the case where there was no
particular value returned.
Additionally, most of the available IAM commands have their own Emacs Lisp
function including documentation and possibly a parameter list. All these
functions are interactive, so you can use them in ecasound-iam-mode simply
by invoking them via M-x or by pressing an assigned key combination.
Emacs will prompt you for the required parameters, providing completion
wherever possible.
As a convention, "eci-command" and its variants do take a buffer or process
as an optional last argument. If this is ``nil'', the current
buffer is assumed to be the ecasound session refered to by this call.
This makes it possible to use several ECI sessions concurrently, dispatching
on the buffer or process in use.
\subsubsection{Usage}
\begin{enumerate}
\item make ecasound.el available in your ``load-path''
\item (require 'ecasound)
\item create a buffer with an associated Ecasound session (``eci-init'')
\item use ``eci\-'' functions with the new buffer
\end{enumerate}
\subsubsection{Example}
\begin{verbatim}
(require 'ecasound)
(defun example (file &optional cutoff-increment session)
(unless cutoff-increment (setq cutoff-increment 500.0))
(with-current-buffer (or session (eci-init))
(eci-cs-add "play_chainsetup")
(eci-c-add "1st_chain")
(eci-ai-add file)
(eci-ao-add "/dev/dsp")
(eci-cop-add "-efl:100")
(eci-cop-select 1)
(eci-copp-select 1)
(eci-cs-connect)
(eci-start)
(sit-for 1)
(while (and (string= (eci-engine-status) "running")
(<= (eci-get-position) 15))
(eci-copp-set (+ cutoff-increment (eci-copp-get)))
(sit-for 1))
(eci-command "stop")
(when (eci-cs-disconnect)
(destructuring-bind
((cop n1 (copp n2 val)))
(cdr (assoc "1st_chain" (eci-cop-status)))
(message "%s %s is now %f" cop copp val)))))
\end{verbatim}
NOTE: function ``eci-cop-status'' is actually a very high level function
which already converts the returned information to a nested list
structure.
For more complex examples of the Emacs Lisp ECI implementation, see function
``eci-example'', ``ecasound-normalize'' and ``ecasound-signalview'' in
ecasound.el.
% ----------------------------------------------------------------------
\subsection{Python}
\subsubsection{Overview}
Python implementation is based around the ECA\_CONTROL\_INTERFACE class.
Lists are used for representing collections of objects.
Note! Eric S. Tiedemann has written an alternative Python interface
to ECI. You'll find this interface included in the main
Ecasound packege, in ``pyecasound/eci.py''. To use this instead
of the standard interface, just 'import eci' and you're set! :)
\subsubsection{Usage}
\begin{enumerate}
\item import pyeca
\item create an instance of the ECA\_CONTROL\_INTERFACE class
and use its member functions
\item python 'yourapp.py' and that's it :)
\end{enumerate}
\subsubsection{Example}
\begin{verbatim}
#!/usr/local/bin/python
import time
from pyeca import *
e = ECA_CONTROL_INTERFACE()
e.command("cs-add play_chainsetup")
e.command("c-add 1st_chain")
e.command("ai-add some_file.wav")
e.command("ao-add /dev/dsp")
e.command("cop-add -efl:100")
e.command("cop-select 1")
e.command("copp-select 1")
e.command("cs-connect")
e.command("start")
cutoff_inc = 500.0
while 1:
time.sleep(1)
e.command("engine-status")
if e.last_string() != "running": break
e.command("get-position")
curpos = e.last_float()
if curpos > 15: break
e.command("copp-get")
next_cutoff = cutoff_inc + e.last_float()
e.command_float_arg("copp-set", next_cutoff)
e.command("stop")
e.command("cs-disconnect")
e.command("cop-status")
print "Chain operator status: ", e.last_string()
\end{verbatim}
% ----------------------------------------------------------------------
\subsection{Perl}
\subsubsection{Overview}
Audio::Ecasound provides perl bindings to the Ecasound
control interface of the Ecasound program. You can use
perl to automate or interact with Ecasound so you don't
have to turn you back on the adoring masses packed into
Wembly Stadium.
Audio::Ecasound was written by Brad Bowman. At the moment this module
is not distributed with Ecasound. To get the latest version, check the
following \texttt{CPAN link}.
\subsubsection{Usage}
See the below example. For more info, here's another
\texttt{CPAN link}.
\subsubsection{Example}
use Audio::Ecasound qw(:simple);
\begin{verbatim}
eci("cs-add play_chainsetup");
eci("c-add 1st_chain");
eci("ai-add some_file.wav");
eci("ao-add /dev/dsp");
# multiple \n separated commands
eci("cop-add -efl:100
# with comments
cop-select 1
copp-select 1
cs-connect");
eci("start");
my $cutoff_inc = 500.0;
while (1) {
sleep(1);
last if eci("engine-status") ne "running";
my $curpos = eci("get-position");
last if $curpos > 15;
my $next_cutoff = $cutoff_inc + eci("copp-get");
# Optional float argument
eci("copp-set", $next_cutoff);
}
eci("stop");
eci("cs-disconnect");
print "Chain operator status: ", eci("cop-status");
\end{verbatim}
% ----------------------------------------------------------------------
\subsection{PHP}
\subsubsection{Overview}
This PHP extension provides bindings to the Ecasound
control interface. It is useful both for scripting Ecasound
and for writing graphical audio applications with PHP Gtk.
The PHP Ecasound extension was written by Tony Leake. At the moment this module
is not distributed with Ecasound. The latest version and example scripts, are
available from \texttt{http://www.webwise-data.co.uk/php\_audio/php\_audio\_extension.html}.
\subsubsection{Usage}
\begin{enumerate}
\item Obtain and build the Ecasound PHP extension
\item Initialise Ecasound, eci\_int();
\item Issue EAM commands eg, eci\_command("cs-add my\_chain\_setup");
\item Free resources, eci\_cleanup();
\end{enumerate}
\subsubsection{Example}
\begin{verbatim}
Implementation of the following:
1. Setup ECI to read audio from file, apply a 100Hz lowpass filter,
and send it to the soundcard (/dev/dsp).
2. Every second, check the current position. If the stream has been
running for over 15 seconds, exit immediately. Also, every second,
increase the lowpass filter's cutoff frequency by 500Hz.
3. Stop the stream (if not already finished) and disconnect the chainsetup.
Print chain operator status info
<?php
$cutoff_inc = 500.0;
$curpos=0;
$next_cutoff=0;
eci_init();
eci_command("cs-add play_chainsetup");
eci_command("c-add 1st_chain");
eci_command("ai-add /tmp/somefile.wav");
eci_command("ao-add /dev/dsp");
eci_command("cop-add -efl:10");
eci_command("cop-select 1");
eci_command("copp-select 1");
eci_command("cs-connect");
eci_command("start");
while(1) {
sleep(1);
eci_command("engine-status");
if (eci_last_string() !="running"){
break;
}
eci_command("get-position");
$curpos = eci_last_float();
if ($curpos > 15.0){
break;
}
eci_command("copp-get");
$next_cutoff = $cutoff_inc + eci_last_float();
eci_command_float_arg("copp-set",$next_cutoff);
}
eci_command("stop");
eci_command("cs-disconnect");
eci_command("cop-status");
printf("Chain operator status: %s", eci_last_string());
eci_cleanup();
?>
\end{verbatim}
% ----------------------------------------------------------------------
\subsection{Ruby}
\subsubsection{Overview}
The Ecasound package comes with an 'Ecasound' module for Ruby included.
If ruby is detected during the installation process it is installed
automatically (assuming you are installing ecasound from source code).
The module contains the class definition of a native ecasound control interface
called "ControlInterface".
'Ecasound::ControlInterface' is implemented in a high level manner which means
that you won't find most of the commands known from libecasoundc like
last\_string, last\_float, etc.
Instead of that every call to the instance method "command", which accepts all
the well known IAM commands, returns ecasound's response in an appropriate type
automatically.
If an error occurs, e. g. there's a typo in a command or a file is not found,
an exception of type EcasoundError is raised.
\subsubsection{Usage}
\begin{enumerate}
\item require 'ecasound'
\item create an instance of Ecasound::ControlInterface
\item use it's command method to send IAM commands to ecasound
\item catch an EcasoundError if necessary
\end{enumerate}
\subsubsection{Example}
\begin{verbatim}
#!/usr/bin/env ruby
require "ecasound"
SOME_FILE = "path/to/file.wav"
e = Ecasound::ControlInterface.new()
e.command("cs-add play_chainsetup")
e.command("c-add 1st_chain")
e.command("ai-add #{SOME_FILE}")
e.command("ao-add /dev/dsp")
e.command("cop-add -efl:100")
e.command("cop-select 1")
e.command("copp-select 1")
e.command("cs-connect")
e.command("start")
cutoff_inc = 500.0
loop do
sleep(1)
break if e.command("engine-status") != "running"
break if e.command("get-position") > 15
e.command("copp-set #{cutoff_inc + e.command('copp-get')}")
end
e.command("stop")
e.command("cs-disconnect")
$stdout << "Chain operator status: " + e.command("cop-status") + "\n"
\end{verbatim}
% ----------------------------------------------------------------------
% ----------------------------------------------------------------------
\section{Application development}
% ----------------------------------------------------------------------
\subsection{Tips for debugging}
Here's a few tips what to do if the ECI app you have developed
is not working correctly.
\begin{enumerate}
\item Check your Ecasound installation. Try to run the ``ecasound''
console user-interface and verify that the basic functionality
is working (ie. something like ``ecasound -i foo.wav -o
/dev/dsp''.
\item If developing in C or C++, check that your application
is correcly linked: ``ldd /path/to/myapp''. All the libraries
should be properly found.
\item Check error conditions. You should remember to check
for errors in your ECI apps using the eci\_error() and
eci\_last\_error() functions. Especially when intializing
ECI for the first time and after important commands
like ``cs-connect'', you should always check for errors.
\item Use the ECASOUND\_LOGFILE environment variable to write all
engine output to a separate logfile. See ecasound(1) manpage
for details on how to use this mechanism. Requires Ecasound
version 2.4.5 or newer.
\item Utilize the ``int-log-history'' ECI command added to
version 2.4.0 of Ecasound. Recent messages from the
engine can help to track down the problem. Before use, you
need to first set the history length to a non-zero value with
``int-set-log-history-length''.
\item Launch Ecasound in interactive mode (``ecasound -c''),
and issue the commands your ECI application is using,
manually one-by-one and see what happens. If something
goes wrong, increase Ecasound's debug level (for instance
``-ddd'') and re-run the test.
\end{enumerate}
\end{document}

50
library/ecasound/Documentation/users_guide/Makefile.am Normal file
View file

@ -0,0 +1,50 @@
# ----------------------------------------------------------------------
# File: ecasound/Documentation/users_guide/Makefile.am
# Description: Ecasound documentation - user's guide
# License: GPL (see ecasound/{AUTHORS,COPYING})
# ----------------------------------------------------------------------
# ---------------------------------------------------------------------
# Files going into distribution:
EXTRA_DIST = users_guide.latex
DISTCLEANFILES = \
users_guide.log \
users_guide.aux \
users_guide.out \
users_guide.dvi \
users_guide.toc \
users_guide.ps \
ecasound_users_guide.pdf \
html_uguide/users_guide.html \
html_uguide/users_guide.haux \
html_uguide/users_guide.htoc
all:
docs: ecasound_users_guide.pdf
ecasound_eci_doc.pdf: eci_doc.latex eci_doc.dvi
# note: to create the table of contents (which spans multiple pages), and
# re-calculate the page numbers after the page offset generated by table
# of contents, latex needs to be ran 3 times. (Junichi Uekawa, 2007-08-06)
users_guide.dvi: $(srcdir)/users_guide.latex
latex $(srcdir)/users_guide.latex
latex $(srcdir)/users_guide.latex
latex $(srcdir)/users_guide.latex
dvips -Ppdf -o users_guide.ps users_guide.dvi
ps2pdf users_guide.ps ecasound_users_guide.pdf
mkdir -p html_uguide
hevea -o html_uguide/users_guide.html $(srcdir)/users_guide.latex
hevea -o html_uguide/users_guide.html $(srcdir)/users_guide.latex
ecasound_users_guide.pdf: users_guide.dvi
clean-docs:
rm -fv ecasound_users_guide.pdf
rm -fv users_guide.log users_guide.toc users_guide.dvi users_guide.aux users_guide.ps users_guide.dvi
rm -fv html_uguide/*

432
library/ecasound/Documentation/users_guide/Makefile.in Normal file
View file

@ -0,0 +1,432 @@
# Makefile.in generated by automake 1.9.6 from Makefile.am.
# @configure_input@
# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
# 2003, 2004, 2005 Free Software Foundation, Inc.
# This Makefile.in is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
# with or without modifications, as long as this notice is preserved.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY, to the extent permitted by law; without
# even the implied warranty of MERCHANTABILITY or FITNESS FOR A
# PARTICULAR PURPOSE.
@SET_MAKE@
# ----------------------------------------------------------------------
# File: ecasound/Documentation/users_guide/Makefile.am
# Description: Ecasound documentation - user's guide
# License: GPL (see ecasound/{AUTHORS,COPYING})
# ----------------------------------------------------------------------
# ---------------------------------------------------------------------
# Files going into distribution:
srcdir = @srcdir@
top_srcdir = @top_srcdir@
VPATH = @srcdir@
pkgdatadir = $(datadir)/@PACKAGE@
pkglibdir = $(libdir)/@PACKAGE@
pkgincludedir = $(includedir)/@PACKAGE@
top_builddir = ../..
am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd
INSTALL = @INSTALL@
install_sh_DATA = $(install_sh) -c -m 644
install_sh_PROGRAM = $(install_sh) -c
install_sh_SCRIPT = $(install_sh) -c
INSTALL_HEADER = $(INSTALL_DATA)
transform = $(program_transform_name)
NORMAL_INSTALL = :
PRE_INSTALL = :
POST_INSTALL = :
NORMAL_UNINSTALL = :
PRE_UNINSTALL = :
POST_UNINSTALL = :
build_triplet = @build@
host_triplet = @host@
subdir = Documentation/users_guide
DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in
ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
am__aclocal_m4_deps = $(top_srcdir)/acinclude.m4 \
$(top_srcdir)/configure.in
am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \
$(ACLOCAL_M4)
mkinstalldirs = $(install_sh) -d
CONFIG_HEADER = $(top_builddir)/config.h
CONFIG_CLEAN_FILES =
SOURCES =
DIST_SOURCES =
DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST)
ACLOCAL = @ACLOCAL@
AMDEP_FALSE = @AMDEP_FALSE@
AMDEP_TRUE = @AMDEP_TRUE@
AMTAR = @AMTAR@
AM_CFLAGS = @AM_CFLAGS@
AM_CPPFLAGS = @AM_CPPFLAGS@
AM_CXXFLAGS = @AM_CXXFLAGS@
AM_LDFLAGS = @AM_LDFLAGS@
AR = @AR@
ARTSC_CONFIG = @ARTSC_CONFIG@
AUTOCONF = @AUTOCONF@
AUTOHEADER = @AUTOHEADER@
AUTOMAKE = @AUTOMAKE@
AWK = @AWK@
CC = @CC@
CCDEPMODE = @CCDEPMODE@
CFLAGS = @CFLAGS@
CPP = @CPP@
CPPFLAGS = @CPPFLAGS@
CXX = @CXX@
CXXCPP = @CXXCPP@
CXXDEPMODE = @CXXDEPMODE@
CXXFLAGS = @CXXFLAGS@
CYGPATH_W = @CYGPATH_W@
DEFS = @DEFS@
DEPDIR = @DEPDIR@
DSYMUTIL = @DSYMUTIL@
ECA_AM_ALL_STATIC_FALSE = @ECA_AM_ALL_STATIC_FALSE@
ECA_AM_ALL_STATIC_TRUE = @ECA_AM_ALL_STATIC_TRUE@
ECA_AM_COMPILE_ALSA_FALSE = @ECA_AM_COMPILE_ALSA_FALSE@
ECA_AM_COMPILE_ALSA_TRUE = @ECA_AM_COMPILE_ALSA_TRUE@
ECA_AM_COMPILE_ARTS_FALSE = @ECA_AM_COMPILE_ARTS_FALSE@
ECA_AM_COMPILE_ARTS_TRUE = @ECA_AM_COMPILE_ARTS_TRUE@
ECA_AM_COMPILE_AUDIOFILE_FALSE = @ECA_AM_COMPILE_AUDIOFILE_FALSE@
ECA_AM_COMPILE_AUDIOFILE_TRUE = @ECA_AM_COMPILE_AUDIOFILE_TRUE@
ECA_AM_COMPILE_JACK_FALSE = @ECA_AM_COMPILE_JACK_FALSE@
ECA_AM_COMPILE_JACK_TRUE = @ECA_AM_COMPILE_JACK_TRUE@
ECA_AM_COMPILE_OSS_FALSE = @ECA_AM_COMPILE_OSS_FALSE@
ECA_AM_COMPILE_OSS_TRUE = @ECA_AM_COMPILE_OSS_TRUE@
ECA_AM_COMPILE_SAMPLERATE_FALSE = @ECA_AM_COMPILE_SAMPLERATE_FALSE@
ECA_AM_COMPILE_SAMPLERATE_TRUE = @ECA_AM_COMPILE_SAMPLERATE_TRUE@
ECA_AM_COMPILE_SNDFILE_FALSE = @ECA_AM_COMPILE_SNDFILE_FALSE@
ECA_AM_COMPILE_SNDFILE_TRUE = @ECA_AM_COMPILE_SNDFILE_TRUE@
ECA_AM_DEBUG_MODE_FALSE = @ECA_AM_DEBUG_MODE_FALSE@
ECA_AM_DEBUG_MODE_TRUE = @ECA_AM_DEBUG_MODE_TRUE@
ECA_AM_DISABLE_EFFECTS_FALSE = @ECA_AM_DISABLE_EFFECTS_FALSE@
ECA_AM_DISABLE_EFFECTS_TRUE = @ECA_AM_DISABLE_EFFECTS_TRUE@
ECA_AM_FEELING_EXPERIMENTAL_FALSE = @ECA_AM_FEELING_EXPERIMENTAL_FALSE@
ECA_AM_FEELING_EXPERIMENTAL_TRUE = @ECA_AM_FEELING_EXPERIMENTAL_TRUE@
ECA_AM_KVUTILS_INSTALLED_FALSE = @ECA_AM_KVUTILS_INSTALLED_FALSE@
ECA_AM_KVUTILS_INSTALLED_TRUE = @ECA_AM_KVUTILS_INSTALLED_TRUE@
ECA_AM_PYECASOUND_CEXT_FALSE = @ECA_AM_PYECASOUND_CEXT_FALSE@
ECA_AM_PYECASOUND_CEXT_TRUE = @ECA_AM_PYECASOUND_CEXT_TRUE@
ECA_AM_PYECASOUND_INSTALL_FALSE = @ECA_AM_PYECASOUND_INSTALL_FALSE@
ECA_AM_PYECASOUND_INSTALL_TRUE = @ECA_AM_PYECASOUND_INSTALL_TRUE@
ECA_AM_RUBYECASOUND_INSTALL_FALSE = @ECA_AM_RUBYECASOUND_INSTALL_FALSE@
ECA_AM_RUBYECASOUND_INSTALL_TRUE = @ECA_AM_RUBYECASOUND_INSTALL_TRUE@
ECA_AM_SYSTEM_READLINE_FALSE = @ECA_AM_SYSTEM_READLINE_FALSE@
ECA_AM_SYSTEM_READLINE_TRUE = @ECA_AM_SYSTEM_READLINE_TRUE@
ECA_AM_USE_NCURSES_FALSE = @ECA_AM_USE_NCURSES_FALSE@
ECA_AM_USE_NCURSES_TRUE = @ECA_AM_USE_NCURSES_TRUE@
ECA_AM_USE_TERMCAP_FALSE = @ECA_AM_USE_TERMCAP_FALSE@
ECA_AM_USE_TERMCAP_TRUE = @ECA_AM_USE_TERMCAP_TRUE@
ECA_S_EXTRA_CPPFLAGS = @ECA_S_EXTRA_CPPFLAGS@
ECA_S_EXTRA_LIBS = @ECA_S_EXTRA_LIBS@
ECA_S_JACK_INCLUDES = @ECA_S_JACK_INCLUDES@
ECA_S_JACK_LIBS = @ECA_S_JACK_LIBS@
ECA_S_PREFIX = @ECA_S_PREFIX@
ECA_S_PYTHON_DLMODULES = @ECA_S_PYTHON_DLMODULES@
ECA_S_PYTHON_INCLUDES = @ECA_S_PYTHON_INCLUDES@
ECA_S_PYTHON_MODULES = @ECA_S_PYTHON_MODULES@
ECA_S_READLINE_INCLUDES = @ECA_S_READLINE_INCLUDES@
ECA_S_READLINE_LIBS = @ECA_S_READLINE_LIBS@
ECA_S_RUBY_SITEDIR = @ECA_S_RUBY_SITEDIR@
ECHO = @ECHO@
ECHO_C = @ECHO_C@
ECHO_N = @ECHO_N@
ECHO_T = @ECHO_T@
EGREP = @EGREP@
EXEEXT = @EXEEXT@
F77 = @F77@
FFLAGS = @FFLAGS@
GREP = @GREP@
INSTALL_DATA = @INSTALL_DATA@
INSTALL_PROGRAM = @INSTALL_PROGRAM@
INSTALL_SCRIPT = @INSTALL_SCRIPT@
INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@
LDFLAGS = @LDFLAGS@
LIBECASOUNDC_VERSION = @LIBECASOUNDC_VERSION@
LIBECASOUNDC_VERSION_AGE = @LIBECASOUNDC_VERSION_AGE@
LIBECASOUND_VERSION = @LIBECASOUND_VERSION@
LIBECASOUND_VERSION_AGE = @LIBECASOUND_VERSION_AGE@
LIBKVUTILS_VERSION = @LIBKVUTILS_VERSION@
LIBKVUTILS_VERSION_AGE = @LIBKVUTILS_VERSION_AGE@
LIBLO_CFLAGS = @LIBLO_CFLAGS@
LIBLO_LIBS = @LIBLO_LIBS@
LIBOBJS = @LIBOBJS@
LIBOIL_CFLAGS = @LIBOIL_CFLAGS@
LIBOIL_LIBS = @LIBOIL_LIBS@
LIBS = @LIBS@
LIBTOOL = @LIBTOOL@
LN_S = @LN_S@
LTLIBOBJS = @LTLIBOBJS@
MAKEINFO = @MAKEINFO@
NMEDIT = @NMEDIT@
OBJEXT = @OBJEXT@
PACKAGE = @PACKAGE@
PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@
PACKAGE_NAME = @PACKAGE_NAME@
PACKAGE_STRING = @PACKAGE_STRING@
PACKAGE_TARNAME = @PACKAGE_TARNAME@
PACKAGE_VERSION = @PACKAGE_VERSION@
PATH_SEPARATOR = @PATH_SEPARATOR@
PKG_CONFIG = @PKG_CONFIG@
PYTHONPATH = @PYTHONPATH@
RANLIB = @RANLIB@
RUBYPATH = @RUBYPATH@
SED = @SED@
SET_MAKE = @SET_MAKE@
SHELL = @SHELL@
STRIP = @STRIP@
VERSION = @VERSION@
ac_ct_CC = @ac_ct_CC@
ac_ct_CXX = @ac_ct_CXX@
ac_ct_F77 = @ac_ct_F77@
am__fastdepCC_FALSE = @am__fastdepCC_FALSE@
am__fastdepCC_TRUE = @am__fastdepCC_TRUE@
am__fastdepCXX_FALSE = @am__fastdepCXX_FALSE@
am__fastdepCXX_TRUE = @am__fastdepCXX_TRUE@
am__include = @am__include@
am__leading_dot = @am__leading_dot@
am__quote = @am__quote@
am__tar = @am__tar@
am__untar = @am__untar@
bindir = @bindir@
build = @build@
build_alias = @build_alias@
build_cpu = @build_cpu@
build_os = @build_os@
build_vendor = @build_vendor@
datadir = @datadir@
datarootdir = @datarootdir@
docdir = @docdir@
dvidir = @dvidir@
exec_prefix = @exec_prefix@
host = @host@
host_alias = @host_alias@
host_cpu = @host_cpu@
host_os = @host_os@
host_vendor = @host_vendor@
htmldir = @htmldir@
includedir = @includedir@
infodir = @infodir@
install_sh = @install_sh@
libdir = @libdir@
libexecdir = @libexecdir@
localedir = @localedir@
localstatedir = @localstatedir@
mandir = @mandir@
mkdir_p = @mkdir_p@
oldincludedir = @oldincludedir@
pdfdir = @pdfdir@
prefix = @prefix@
program_transform_name = @program_transform_name@
psdir = @psdir@
sbindir = @sbindir@
sharedstatedir = @sharedstatedir@
sysconfdir = @sysconfdir@
target_alias = @target_alias@
EXTRA_DIST = users_guide.latex
DISTCLEANFILES = \
users_guide.log \
users_guide.aux \
users_guide.out \
users_guide.dvi \
users_guide.toc \
users_guide.ps \
ecasound_users_guide.pdf \
html_uguide/users_guide.html \
html_uguide/users_guide.haux \
html_uguide/users_guide.htoc
all: all-am
.SUFFIXES:
$(srcdir)/Makefile.in: $(srcdir)/Makefile.am $(am__configure_deps)
@for dep in $?; do \
case '$(am__configure_deps)' in \
*$$dep*) \
cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh \
&& exit 0; \
exit 1;; \
esac; \
done; \
echo ' cd $(top_srcdir) && $(AUTOMAKE) --foreign Documentation/users_guide/Makefile'; \
cd $(top_srcdir) && \
$(AUTOMAKE) --foreign Documentation/users_guide/Makefile
.PRECIOUS: Makefile
Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status
@case '$?' in \
*config.status*) \
cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \
*) \
echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \
cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \
esac;
$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES)
cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh
$(top_srcdir)/configure: $(am__configure_deps)
cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh
$(ACLOCAL_M4): $(am__aclocal_m4_deps)
cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh
mostlyclean-libtool:
-rm -f *.lo
clean-libtool:
-rm -rf .libs _libs
distclean-libtool:
-rm -f libtool
uninstall-info-am:
tags: TAGS
TAGS:
ctags: CTAGS
CTAGS:
distdir: $(DISTFILES)
@srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; \
topsrcdirstrip=`echo "$(top_srcdir)" | sed 's|.|.|g'`; \
list='$(DISTFILES)'; for file in $$list; do \
case $$file in \
$(srcdir)/*) file=`echo "$$file" | sed "s|^$$srcdirstrip/||"`;; \
$(top_srcdir)/*) file=`echo "$$file" | sed "s|^$$topsrcdirstrip/|$(top_builddir)/|"`;; \
esac; \
if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \
dir=`echo "$$file" | sed -e 's,/[^/]*$$,,'`; \
if test "$$dir" != "$$file" && test "$$dir" != "."; then \
dir="/$$dir"; \
$(mkdir_p) "$(distdir)$$dir"; \
else \
dir=''; \
fi; \
if test -d $$d/$$file; then \
if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \
cp -pR $(srcdir)/$$file $(distdir)$$dir || exit 1; \
fi; \
cp -pR $$d/$$file $(distdir)$$dir || exit 1; \
else \
test -f $(distdir)/$$file \
|| cp -p $$d/$$file $(distdir)/$$file \
|| exit 1; \
fi; \
done
check-am: all-am
check: check-am
all-am: Makefile
installdirs:
install: install-am
install-exec: install-exec-am
install-data: install-data-am
uninstall: uninstall-am
install-am: all-am
@$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am
installcheck: installcheck-am
install-strip:
$(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \
install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \
`test -z '$(STRIP)' || \
echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install
mostlyclean-generic:
clean-generic:
distclean-generic:
-test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES)
-test -z "$(DISTCLEANFILES)" || rm -f $(DISTCLEANFILES)
maintainer-clean-generic:
@echo "This command is intended for maintainers to use"
@echo "it deletes files that may require special tools to rebuild."
clean: clean-am
clean-am: clean-generic clean-libtool mostlyclean-am
distclean: distclean-am
-rm -f Makefile
distclean-am: clean-am distclean-generic distclean-libtool
dvi: dvi-am
dvi-am:
html: html-am
info: info-am
info-am:
install-data-am:
install-exec-am:
install-info: install-info-am
install-man:
installcheck-am:
maintainer-clean: maintainer-clean-am
-rm -f Makefile
maintainer-clean-am: distclean-am maintainer-clean-generic
mostlyclean: mostlyclean-am
mostlyclean-am: mostlyclean-generic mostlyclean-libtool
pdf: pdf-am
pdf-am:
ps: ps-am
ps-am:
uninstall-am: uninstall-info-am
.PHONY: all all-am check check-am clean clean-generic clean-libtool \
distclean distclean-generic distclean-libtool distdir dvi \
dvi-am html html-am info info-am install install-am \
install-data install-data-am install-exec install-exec-am \
install-info install-info-am install-man install-strip \
installcheck installcheck-am installdirs maintainer-clean \
maintainer-clean-generic mostlyclean mostlyclean-generic \
mostlyclean-libtool pdf pdf-am ps ps-am uninstall uninstall-am \
uninstall-info-am
all:
docs: ecasound_users_guide.pdf
ecasound_eci_doc.pdf: eci_doc.latex eci_doc.dvi
# note: to create the table of contents (which spans multiple pages), and
# re-calculate the page numbers after the page offset generated by table
# of contents, latex needs to be ran 3 times. (Junichi Uekawa, 2007-08-06)
users_guide.dvi: $(srcdir)/users_guide.latex
latex $(srcdir)/users_guide.latex
latex $(srcdir)/users_guide.latex
latex $(srcdir)/users_guide.latex
dvips -Ppdf -o users_guide.ps users_guide.dvi
ps2pdf users_guide.ps ecasound_users_guide.pdf
mkdir -p html_uguide
hevea -o html_uguide/users_guide.html $(srcdir)/users_guide.latex
hevea -o html_uguide/users_guide.html $(srcdir)/users_guide.latex
ecasound_users_guide.pdf: users_guide.dvi
clean-docs:
rm -fv ecasound_users_guide.pdf
rm -fv users_guide.log users_guide.toc users_guide.dvi users_guide.aux users_guide.ps users_guide.dvi
rm -fv html_uguide/*
# Tell versions [3.59,3.63) of GNU make to not export all variables.
# Otherwise a system limit (for SysV at least) may be exceeded.
.NOEXPORT:

1056
library/ecasound/Documentation/users_guide/users_guide.latex Normal file
View file

File diff suppressed because it is too large Load diff