Commit 227f82a8 authored by Joel Roth's avatar Joel Roth

[svn-inject] Installing original source of libaudio-ecasound-perl

parents
Revision history for Perl extension Audio::Ecasound.
0.93 Sun Jan 6 15:30:02 EST 2008
- RT #32101: missing flush to STDOUT from Andreas Koenig
$| is Makefile.PL and use MM's prompt instead of custom
0.92 Sun Dec 16 14:15:44 EST 2007
- Update email address
- 'todo' test done, shush test warning
- Require ecasound 2.4.5, document bugs around 2.4.4
http://www.eca.cx/ecasound-list/2006/06/0004.html
http://www.eca.cx/ecasound-list/2006/12/0007.html
0.91 Tue May 30 22:40:23 EST 2006
- Fixup pattern for tests on chainsetup error messages
(Joel Roth http://ecmdr.infogami.com)
- Move test.pl to t/ecasound.t
- Add t/pod.t for Kwalitee
0.9 Sun Aug 10 16:38:10 EST 2003
- Use UNIVERSAL::isa for self test (more robust)
- Updated eg/* for new cop-status
- on_error with Carp::* + docs
- Use libecasoundc-config (renamed in ecasound)
- Fix lib dir in Ecasound.xs (change in ecasound)
- Makefile.PL requires ecasound 2.2 for above
- Remove -lkvutils, not required
- Thread warning updated from feedback
- Update/Fix tests for new return formats and codes
- Warn and document ECASOUND re: env var
0.2 Tue Jun 26 01:28:01 EST 2001
- Public debut, Changes file becomes relevant
0.01 Mon May 21 14:39:57 2001
- original version; created by h2xs 1.20 with options
-A -x -p eci_ -n ECI ecasound/ecasoundc.h -lecasoundc
This diff is collapsed.
#include "EXTERN.h"
#include "perl.h"
#include "XSUB.h"
#include <libecasoundc/ecasoundc.h>
MODULE = Audio::Ecasound PACKAGE = Audio::Ecasound
PROTOTYPES: ENABLE
BOOT:
eci_init();
void
eci_cleanup()
void
eci_command(cmd)
const char * cmd
void
eci_command_float_arg(arg0, arg)
const char * arg0
double arg
double
eci_last_float()
int
eci_last_integer()
long int
eci_last_long_integer()
const char *
eci_last_string()
int
eci_last_string_list_count()
const char *
eci_last_string_list_item(n)
int n
const char *
eci_last_type()
int
eci_error()
const char *
eci_last_error()
eci_handle_t
eci_init_r()
void
eci_cleanup_r(p)
eci_handle_t p
void
eci_command_float_arg_r(p, arg1, arg)
eci_handle_t p
const char * arg1
double arg
void
eci_command_r(p, cmd)
eci_handle_t p
const char * cmd
double
eci_last_float_r(p)
eci_handle_t p
int
eci_last_integer_r(p)
eci_handle_t p
long int
eci_last_long_integer_r(p)
eci_handle_t p
int
eci_last_string_list_count_r(p)
eci_handle_t p
const char *
eci_last_string_list_item_r(p, n)
eci_handle_t p
int n
const char *
eci_last_string_r(p)
eci_handle_t p
const char *
eci_last_type_r(p)
eci_handle_t p
int
eci_error_r(p)
eci_handle_t p
const char *
eci_last_error_r(p)
eci_handle_t p
Changes
Ecasound.pm
Ecasound.xs
eg/iam_int.pl
eg/oo_int.pl
eg/raw_int.pl
eg/simple_int.pl
Makefile.PL
MANIFEST
META.yml
README
t/ecasound.t
t/pod.t
typemap
# http://module-build.sourceforge.net/META-spec.html
#XXXXXXX This is a prototype!!! It will change in the future!!! XXXXX#
name: Audio-Ecasound
version: 0.93
version_from: Ecasound.pm
installdirs: site
requires:
distribution_type: module
generated_by: ExtUtils::MakeMaker version 6.30_01
use ExtUtils::MakeMaker;
$| = 1;
WriteMakefile(
NAME => 'Audio::Ecasound',
VERSION_FROM => 'Ecasound.pm',
PREREQ_PM => {}, # e.g., Module::Name => 1.1
# next two could be from libecasoundc-config --libs --cflags
# not for now since want it to install w/o libecasoundc-config
LIBS => ['-lecasoundc'],
INC => '',
ABSTRACT_FROM => 'Ecasound.pm',
AUTHOR => 'Brad Bowman <eci-perl@bereft.net>',
dist => {
# expand my tabs to 4
PREOP => "(cd \$(DISTVNAME); \\
perl -MExtUtils::Manifest=maniread \\
-pi -e 'BEGIN{\@ARGV=keys \%{maniread()}; } \\
s/\\t/ /g' \\
)" },
CONFIGURE =>
sub {
my %cfg;
use Config;
unless ($Config{usethreads} eq 'define'
|| $Config{ccflags} =~ /\b-D_REENTRANT\b/)
{
prompt_cont(<<EOT, 'y');
Your perl was not built with -Dusethreads or -D_REENTRANT
This may cause problems loading the multithreaded library
ecasoundc (hanging on loading). It has worked fine for some.
You are welcome to try...
Proceed anyway?
EOT
}
# ecasound 2.4.4 http://www.eca.cx/ecasound-list/2006/12/0007.html
# old: ecasound < 2.2 (v2.1dev8) mv'd headers and config prgm
# old: ecasound < 2.0.1 didn't have reentrant C interface
my $eca_version = `libecasoundc-config --version`;
if(!defined($eca_version)) {
warn "Running ecasoundc-config failed: $!\n";
prompt_cont(<<EOT, 'y');
The ecasoundc-config program is used to find the version of the
ecasoundc library. You need 2.4.5 or higher.
Proceed anyway?
EOT
} else {
chomp $eca_version;
# Compare versions pre v-strings
my @ev = split /\./, $eca_version;
# maj > 2 & rest >= 4.5
unless($ev[0] >2 || ($ev[0] == 2 && "$ev[1].$ev[2]" >= '4.5')) {
prompt_cont(<<EOT, 'n');
Version 2.4.5+ of ecasound is required, you have $eca_version.
Proceed anyway? (bad idea)
EOT
}
}
unless ($ENV{ECASOUND}) {
print <<EOT;
ECI now uses the "ECASOUND" env var to find the ecasound executable.
Set it correctly to suppress the library warning.
(The PATH is searched so ECASOUND=ecasound usually works)
EOT
}
unless ($Config{ivsize} >= $Config{longsize}) {
warn "long int is bigger than IV, may cause problems with last_long_interger\n";
}
return \%cfg;
},
);
sub prompt_cont {
my ($message, $default) = @_;
local $_;
chomp($message); # because prompt() adds "[y]\n"
while (1) {
$_ = prompt($message, $default);
if(/^n/i) { print "Aborting\n"; exit; }
if(/^y/i) { print "Continuing\n"; last; }
}
}
NAME
Audio::Ecasound - Perl binding to the ecasound sampler, recorder,
fx-processor
SYNOPSIS
One function interface:
use Audio::Ecasound qw(:simple);
eci("cs-add play_chainsetup");
eci("c-add 1st_chain");
eci("-i:some_file.wav");
eci("-o:/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");
Object Interface
use Audio::Ecasound;
my $e = new Audio::Ecasound;
$e->on_error('');
$e->eci("cs-add play_chainsetup");
# etc.
Vanilla Ecasound Control Interface (See Ecasound's Programmer Guide):
use Audio::Ecasound qw(:std);
command("copp-get");
$precise_float = last_float() / 2;
command_float_arg("copp-set", $precise_float);
warn last_error() if error();
IAM Interface, pretend interactive mode commands are functions.
use Audio::Ecasound qw(:iam :simple);
# iam commands as functions with s/-/_/g
my $val = copp_get;
copp_set $val+0.1; # floats are stringified so beware
eci("-i /dev/dsp"); # not all commands are exported
DESCRIPTION
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.
Ecasound is a software package designed for multitrack audio processing.
It can be used for audio playback, recording, format conversions,
effects processing, mixing, as a LADSPA plugin host and JACK node.
Version >= 2.2.X must be installed to use this package. "SEE ALSO" for
more info.
INSTALLATION
perl Makefile.PL
If your perl wasn't built with -Dusethreads or -D_REENTRANT you will be
prompted whether to continue with the install. It's in your hands... See
"THREADING NOTE"
make
make test
make install
THREADING NOTE
The ecasoundc library uses pthreads so will may only work if your perl
was compiled with threading enabled, check with:
% perl -V:usethreads
You are welcome to try using the module with non-threaded perls (perhaps
-D_REENTRANT alone would work) it have worked for some.
EXPORT
* Nothing by default as when going OO.
* :simple gives eci() which does most everything, also errmsg and
on_error. Or you could just import 'eci' and call the others
"Audio::Ecasound::errmsg()"
* :iam imports many iam commands so that you can use them as perl
functions. Basically everything listed by ecasound's 'int-cmd-list'
except the single letter commands and hyphens are replaced by
underscores. The list is produced at run-time and returned by
Audio::Ecasound::get_iam_cmds(). See "IAM COMMANDS";
* :std to import the full ecasound control interface detailed in the
Ecasound Programmer's Guide.
* :raw and raw_r, C functions with minimal wrapping, _r ones are
reentrant and must be passed the object returned by eci_init_r(). I
don't know why you would use these, presumably you do. These options
may be removed in future.
METHODS AND FUNCTIONS
The procedural and OO interfaces use the same functions, the differences
are that when called on an Audio::Ecasound object the reentrant C
versions are used so you can have multiple independent engine (with
independent options).
new()
Constructor for Audio::Ecasound objects, inherits the on_error and
other options from the current package settings (defaults if
untouched).
eci('ecasound command string', [$float_argument])
Sends commands to the Ecasound engine. A single command may be called
with an optional float argument (to avoid precision loss).
Alternatively, multiple commands may be given separated by newlines
(with "#" starting a comment).
If called in non-void context the result of the last command is
returned, it may be an integer, float, string (ie. scalar) or a list
of strings. Which will depend on the ecasound command, see
ecasound-iam for each function's return value.
If there is an error the action given to on_error will be taken. See
on_error below for return value caveats when on_error = ''. Error
processing is performed for each command in a multiline command.
on_error('die')
Set the action to be taken when an error occurs from and "eci"
command, may be 'die', 'warn', '', 'confess', ... (default is 'warn').
When '' is selected "return;" is used for an error, that is undef or
(). To disamibiguate eci will return '' or ('') for no return value
and no string list respectively.
errmsg()
The last error message from an "eci" command. It is not reset so clear
it yourself if required "errmsg('')". This shouldn't be necessary as
you can use "defined" or on_error to find out when errors occur.
The remainder of the functions/methods are the standard Ecasound Control
Interface methods but they come in three flavours. The bare function
name may be called with or without an object:
use Audio::Ecasound ':simple':
command($cmd);
# or
my $e = new Audio::Ecasound;
$e = command($cmd);
The other two flavours are low-level, reentrant and non-reentrant. These
are thinly wrapped C functions better documented in the ECI document
with the ecasound distribution. Just add 'eci_' to the names below for
the non-reentrant version and then add a '_r' to the end for the
reentrant version. The reentrant version takes an extra first argument,
the object returned by eci_init_r() which must be destroyed with
eci_cleanup_r().
command($cmd_string)
eci_command_float_arg($cmd_string, $float_arg)
$bool = eci_error()
$err_str = eci_last_error()
$float = eci_last_float()
$int = eci_last_integer()
$lint = eci_last_long_integer()
$str = eci_last_string()
$n = eci_last_string_list_count()
$str_n = eci_last_string_list_item($n)
$type_str = eci_last_type() 's' 'S' 'i' 'li' 'f' ''
IAM COMMANDS
When the :iam tag is imported most of the commands in ecasounds
interactive mode become perl functions. The '-'s become '_'s to become
valid perl names ('cop-get' is cop_get, etc.) The list is printed with:
use Audio::Ecasound qw(:iam :simple);
print join ' ', Audio::Ecasound::get_iam_cmds();
The arguments joined together as a string and then sent to ecasound.
This means that float precision is lost, unlike with the two argument
"eci" so use it. Also use "eci" for command-line style commands like
"eci "-i /dev/dsp"". But most other things you can just use the iam
command itself (s/-/_/g):
use Audio::Ecasound qw(:iam :simple);
... # setup stuff
print status;
start;
$v = copp_get;
copp_set $v + 1.2;
I would never encourage anyone to use "no strict 'subs';" but with :iam
you may enjoy a little less discipline.
See the iam_int.pl example file in the eg directory.
EXAMPLES
See the "eg/" subdirectory.
TROUBLESHOOTING
The ecasound command 'debug' could be useful, add "eci "debug 63"" to
the top of your program. The argument is various bits OR'd and controls
the amount and type of debugging information, see the ecasound
documentation of source or just try your favorite powers of two.
FILES AND ENVIRONMENT
The libecasoundc library now uses the environment variable "ECASOUND" to
find the ecasound executable. If it is not set then the libarary will
print a warning. To suppress it, simply set the ECASOUND variable: eg.
export ECASOUND=ecaosund
The ecasound library will still process ~/.ecasoundrc and other setup
files for default values. See the library documentation.
AUTHOR
(c) 2001 Brad Bowman <eci-perl@bereft.net> This software may be
distributed under the same terms as Perl itself.
SEE ALSO
The Ecasound Programmer's Guide and ECI doc, ecasound, ecasound-iam
http://eca.cx/, http://www.ladspa.org/
The internals of libecasoundc have been rebuilt and now interact with a
running ecasound via a socket using a protocol defined in the
Programmer's Guide. The C library is now just a compatibility layer and
the Python version now talks directly to the socket. It would be
straight forward to write an equivalent Perl version should the need
arise.
libaudio-ecasound-perl (0.93-1) unstable; urgency=low
* Initial Release.
-- Joel Roth <joelz@pobox.com> Thu, 10 Jun 2010 13:31:24 -1000
Source: libaudio-ecasound-perl
Section: perl
Priority: optional
Build-Depends: debhelper (>= 7), perl
Maintainer: Joel Roth <joelz@pobox.com>
Standards-Version: 3.8.4
Homepage: http://search.cpan.org/dist/Audio-Ecasound/
Package: libaudio-ecasound-perl
Architecture: any
Depends: ${misc:Depends}, ${perl:Depends}, ${shlibs:Depends}
Description: Perl binding to the ecasound sampler, recorder, fx-processor
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.
.
Ecasound is a software package designed for multitrack audio processing. It
can be used for audio playback, recording, format conversions, effects
processing, mixing, as a LADSPA plugin host and JACK node. Version >= 2.2.X
must be installed to use this package. SEE ALSO for more info.
Format-Specification: http://svn.debian.org/wsvn/dep/web/deps/dep5.mdwn?op=file&rev=135
Maintainer: (c) 2001-2007 Brad Bowman <eci-perl@bereft.net>
This software may be distributed under the same terms as Perl itself.
Source: http://search.cpan.org/dist/Audio-Ecasound/
Name: Audio-Ecasound
DISCLAIMER: This copyright info was automatically extracted
from the perl module. It may not be accurate, so you better
check the module sources in order to ensure the module for its
inclusion in Debian or for general legal information. Please,
if licensing information is incorrectly generated, file a bug
on dh-make-perl.
NOTE: Don't forget to remove this disclaimer once you are happy
with this file.
Files: *
Copyright: (c) 2001-2007 Brad Bowman <eci-perl@bereft.net>
This software may be distributed under the same terms as Perl itself.
License:
Files: debian/*
Copyright: 2010, Joel Roth <joelz@pobox.com>
License: Artistic or GPL-1+
License: Artistic
This program is free software; you can redistribute it and/or modify
it under the terms of the Artistic License, which comes with Perl.
.
On Debian GNU/Linux systems, the complete text of the Artistic License
can be found in `/usr/share/common-licenses/Artistic'
License: GPL-1+
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 1, or (at your option)
any later version.
.
On Debian GNU/Linux systems, the complete text of the GNU General
Public License can be found in `/usr/share/common-licenses/GPL'
#!/usr/bin/make -f
%:
dh $@
version=3
http://search.cpan.org/dist/Audio-Ecasound/ .*/Audio-Ecasound-v?(\d[\d.-]+)\.(?:tar(?:\.gz|\.bz2)?|tgz|zip)$
#!/usr/bin/perl -w
use ExtUtils::testlib;
use Audio::Ecasound qw(:simple :iam);
use strict;
# :iam is nicer without strict 'subs'
no strict 'subs';
on_error('');
# no strict 'subs' lets you do this:
cs_add play_chainsetup;
c_add chain1;
eci("-i:some_file.wav
-o:/dev/dsp");
cop_add '-efl:100';
cop_select 1;
copp_select 1;
defined(cs_connect)
or die "Setup error, you need 'some_file.wav' in the current directory\n\n"
. errmsg();
on_error('die');
start;
my $cutoff_inc = 500.0;
while (1) {
sleep(1);
last if engine_status ne "running";
my $curpos = get_position;
last if $curpos > 15;
my $next_cutoff = $cutoff_inc + copp_get;
# keep float precision
eci("copp-set", $next_cutoff);
}
stop;
cs_disconnect;
print cop_status, "\n";
#!/usr/bin/perl -w
use ExtUtils::testlib;
use strict;
use Audio::Ecasound;
my $e = new Audio::Ecasound;
$e->on_error('die');
$e->eci("cs-add play_chainsetup");
$e->eci("c-add 1st_chain");
$e->eci("-i:some_file.wav");
$e->eci("-o:/dev/dsp");
$e->eci("cop-add -efl:100");
$e->eci("cop-select 1");
$e->eci("copp-select 1");
if(!defined(eval { $e->eci("cs-connect") })) {
die "Setup error, you need 'some_file.wav' in the current directory\n\n"
. $e->errmsg();
}
$e->on_error('die');
$e->eci("start");
my $cutoff_inc = 500.0;
while (1) {
sleep(1);
last if $e->eci("engine-status") ne "running";
my $curpos = $e->eci("get-position");
last if $curpos > 15;
my $next_cutoff = $cutoff_inc + $e->eci("copp-get");
$e->eci("copp-set", $next_cutoff);
}
$e->eci("stop");
$e->eci("cs-disconnect");
print $e->eci("cop-status"), "\n";
#!/usr/bin/perl -w
use ExtUtils::testlib;
use strict;
use Audio::Ecasound ':std';
# WARNING NO ERROR CHECKING!!
command("cs-add play_chainsetup");
command("c-add 1st_chain");
command("-i:some_file.wav");
command("-o:/dev/dsp");
command("cop-add -efl:100");
command("cop-select 1");
command("copp-select 1");
command("cs-connect");
if(error()) {
die "Setup error, you need 'some_file.wav' in the current directory\n\n"
. last_error();
}
command("start");
my $cutoff_inc = 500.0;
while (1) {
sleep(1);
command("engine-status");
last if last_string() ne "running";
command("get-position");
my $curpos = last_float();
last if $curpos > 15;
command("copp-get");
my $next_cutoff = $cutoff_inc + last_float();
command_float_arg("copp-set", $next_cutoff);
}
command("stop");
command("cs-disconnect");
command("cop-status");
print last_string(), "\n";
#!/usr/bin/perl -w
use ExtUtils::testlib;
use strict;
use Audio::Ecasound qw(:simple);
on_error('');
$_ = eci("
cs-add play_chainsetup
c-add 1st_chain
-i:some_file.wav
-o:/dev/dsp
cop-add -efl:100
cop-select 1
copp-select 1
cs-connect
start
");
if(!defined) {
die "Setup error, you need 'some_file.wav' in the current directory\n\n"
. errmsg();
}
on_error('die');
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");
eci("copp-set", $next_cutoff);
}
eci("stop");
eci("cs-disconnect");
print eci("cop-status"), "\n";
use Test;
BEGIN { $| = 1; plan tests => 46 }
END { ok(0) unless $loaded;}
use Audio::Ecasound qw(:simple :std :raw :raw_r :iam);
$loaded = 1;
ok(1);
use strict;
# die, warn, ''
# raw, raw_r, simple, oo
# float arg