Commit 068b2fa1 authored by Alessio Treglia's avatar Alessio Treglia

Imported Upstream version 0.0.2+20110630.gitb083f60

parents
-*- text -*-
* Pete Bessman <ninjadroid@gazuga.net>
Founder, primary developer untill 2005-09-14
* Alexander <aharvey@ij.net>
modified midi.c to treat note-on events with velocity of 0x00 as
note-offs.
* Dave Robillard <drobilla@connect.carleton.ca>
Lash support. Removed Gnome-ui requirement for about dialog.
* David R. Clark <davidrclark@earthlink.net>
Invaluable testing, feedback, and discussion, as well as some nifty
sample generating programs.
* Dimitry Baikov <dsbaikov@gmail.com>
Added support for MIDI CC events.
Update to jack_midi API.
* Lars Luthman <lars.luthman@gmail.com>
Jack-midi implementation.
* Loki Davison <ltdav1@student.monash.edu>
Sync code, and initial implementation of lots of stuff which got
lost during The Cleansing. Responsible for convincing ninjadroid to
keep on hacking.
* Nedko Arnaudov <nedko@arnaudov.name>
Made specimen window resizeable.
* peter <kickback@users.sourceforge.net>
Rewrote the build system during the year of limbo.
* Sacha Berger <sacha@woanders.de>
updated beef.c to reflect newly gained parameters.
* Thorsten Wilms <t_w_@freenet.de>
UI advice, and designed the fansliders used extensively in the GUI.
* Torben Hohn <torbenh@users.sourceforge.net>
was an immense help to Pete in optimizing the waveform code (and he
pointed out that it needed to be done in the first place).
* Eric Dantan Rzewnicki <eric@zhevny.com>
maintainer
* James W. Morris <james@jwm-art.net>
forker of Specimen to Petri-Foo, primary developer of Petri-Foo
added modulation routing, midi-cc as modulation sources, remover
of deprecated GUI code, etc, etc, etc.
-*- text -*-
* Pete Bessman <ninjadroid@gazuga.net>
Founder, primary developer untill 2005-09-14
* Alexander <aharvey@ij.net>
modified midi.c to treat note-on events with velocity of 0x00 as
note-offs.
* Dave Robillard <drobilla@connect.carleton.ca>
Lash support. Removed Gnome-ui requirement for about dialog.
* David R. Clark <davidrclark@earthlink.net>
Invaluable testing, feedback, and discussion, as well as some nifty
sample generating programs.
* Dimitry Baikov <dsbaikov@gmail.com>
Added support for MIDI CC events.
Update to jack_midi API.
* Lars Luthman <lars.luthman@gmail.com>
Jack-midi implementation.
* Loki Davison <ltdav1@student.monash.edu>
Sync code, and initial implementation of lots of stuff which got
lost during The Cleansing. Responsible for convincing ninjadroid to
keep on hacking.
* Nedko Arnaudov <nedko@arnaudov.name>
Made specimen window resizeable.
* peter <kickback@users.sourceforge.net>
Rewrote the build system during the year of limbo.
* Sacha Berger <sacha@woanders.de>
updated beef.c to reflect newly gained parameters.
* Thorsten Wilms <t_w_@freenet.de>
UI advice, and designed the fansliders used extensively in the GUI.
* Torben Hohn <torbenh@users.sourceforge.net>
was an immense help to Pete in optimizing the waveform code (and he
pointed out that it needed to be done in the first place).
* Eric Dantan Rzewnicki <eric@zhevny.com>
maintainer
KNOWN BUGS
==========
* mixer_mixdown is sometimes called before mixer_set_jack_client
resulting in a segfault. i've not yet determined if that statement
is true or not, but it seems likely.
-------------------------
the list that follows is inherited from Specimen. i've not actually checked
if it is still relevant or not - jwm 2011/03/28
Known Bugs
==========
* Create some patches, load some samples, connect to JACK, and start
running a MIDI pattern . Then, flick back and forth between the
patches quickly (a mousewheel is handy for this). JACK will fail with
something along the lines of "unable to execute processing graph
(invalid file descriptor)". JACK will stop processing data until
Specimen is closed (it will exit with a segfault); JACK and all of
it's clients will then resume normal operation. [This seems to have
magically disappeared, which I find quite disturbing. Can anybody
reproduce it? --pete]
* Sample start/stop and loop points don't behave properly when
switching audio sample rates. It's probably time to store the audio
sample rate along with the session file, BTW.
* Midi syncing appears to be broken with Fedora Core 2's kernel. If
you compile --enable-debug you'll see the gory details.
* Midi syncing drifts like a bitch anyway.
* Help -> About -> credits causes a segfault.
* audio settings dialog currently resets jack client name to default
"specimen" instead of using previously set name.
This diff is collapsed.
This diff is collapsed.
Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002 Free Software
Foundation, Inc.
This file is free documentation; the Free Software Foundation gives
unlimited permission to copy, distribute and modify it.
Basic Installation
==================
These are generic installation instructions.
The `configure' shell script attempts to guess correct values for
various system-dependent variables used during compilation. It uses
those values to create a `Makefile' in each directory of the package.
It may also create one or more `.h' files containing system-dependent
definitions. Finally, it creates a shell script `config.status' that
you can run in the future to recreate the current configuration, and a
file `config.log' containing compiler output (useful mainly for
debugging `configure').
It can also use an optional file (typically called `config.cache'
and enabled with `--cache-file=config.cache' or simply `-C') that saves
the results of its tests to speed up reconfiguring. (Caching is
disabled by default to prevent problems with accidental use of stale
cache files.)
If you need to do unusual things to compile the package, please try
to figure out how `configure' could check whether to do them, and mail
diffs or instructions to the address given in the `README' so they can
be considered for the next release. If you are using the cache, and at
some point `config.cache' contains results you don't want to keep, you
may remove or edit it.
The file `configure.ac' (or `configure.in') is used to create
`configure' by a program called `autoconf'. You only need
`configure.ac' if you want to change it or regenerate `configure' using
a newer version of `autoconf'.
The simplest way to compile this package is:
1. `cd' to the directory containing the package's source code and type
`./configure' to configure the package for your system. If you're
using `csh' on an old version of System V, you might need to type
`sh ./configure' instead to prevent `csh' from trying to execute
`configure' itself.
Running `configure' takes awhile. While running, it prints some
messages telling which features it is checking for.
2. Type `make' to compile the package.
3. Optionally, type `make check' to run any self-tests that come with
the package.
4. Type `make install' to install the programs and any data files and
documentation.
5. You can remove the program binaries and object files from the
source code directory by typing `make clean'. To also remove the
files that `configure' created (so you can compile the package for
a different kind of computer), type `make distclean'. There is
also a `make maintainer-clean' target, but that is intended mainly
for the package's developers. If you use it, you may have to get
all sorts of other programs in order to regenerate files that came
with the distribution.
Compilers and Options
=====================
Some systems require unusual options for compilation or linking that
the `configure' script does not know about. Run `./configure --help'
for details on some of the pertinent environment variables.
You can give `configure' initial values for configuration parameters
by setting variables in the command line or in the environment. Here
is an example:
./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
*Note Defining Variables::, for more details.
Compiling For Multiple Architectures
====================================
You can compile the package for more than one kind of computer at the
same time, by placing the object files for each architecture in their
own directory. To do this, you must use a version of `make' that
supports the `VPATH' variable, such as GNU `make'. `cd' to the
directory where you want the object files and executables to go and run
the `configure' script. `configure' automatically checks for the
source code in the directory that `configure' is in and in `..'.
If you have to use a `make' that does not support the `VPATH'
variable, you have to compile the package for one architecture at a
time in the source code directory. After you have installed the
package for one architecture, use `make distclean' before reconfiguring
for another architecture.
Installation Names
==================
By default, `make install' will install the package's files in
`/usr/local/bin', `/usr/local/man', etc. You can specify an
installation prefix other than `/usr/local' by giving `configure' the
option `--prefix=PATH'.
You can specify separate installation prefixes for
architecture-specific files and architecture-independent files. If you
give `configure' the option `--exec-prefix=PATH', the package will use
PATH as the prefix for installing programs and libraries.
Documentation and other data files will still use the regular prefix.
In addition, if you use an unusual directory layout you can give
options like `--bindir=PATH' to specify different values for particular
kinds of files. Run `configure --help' for a list of the directories
you can set and what kinds of files go in them.
If the package supports it, you can cause programs to be installed
with an extra prefix or suffix on their names by giving `configure' the
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
Optional Features
=================
Some packages pay attention to `--enable-FEATURE' options to
`configure', where FEATURE indicates an optional part of the package.
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
is something like `gnu-as' or `x' (for the X Window System). The
`README' should mention any `--enable-' and `--with-' options that the
package recognizes.
For packages that use the X Window System, `configure' can usually
find the X include and library files automatically, but if it doesn't,
you can use the `configure' options `--x-includes=DIR' and
`--x-libraries=DIR' to specify their locations.
Specifying the System Type
==========================
There may be some features `configure' cannot figure out
automatically, but needs to determine by the type of machine the package
will run on. Usually, assuming the package is built to be run on the
_same_ architectures, `configure' can figure that out, but if it prints
a message saying it cannot guess the machine type, give it the
`--build=TYPE' option. TYPE can either be a short name for the system
type, such as `sun4', or a canonical name which has the form:
CPU-COMPANY-SYSTEM
where SYSTEM can have one of these forms:
OS KERNEL-OS
See the file `config.sub' for the possible values of each field. If
`config.sub' isn't included in this package, then this package doesn't
need to know the machine type.
If you are _building_ compiler tools for cross-compiling, you should
use the `--target=TYPE' option to select the type of system they will
produce code for.
If you want to _use_ a cross compiler, that generates code for a
platform different from the build platform, you should specify the
"host" platform (i.e., that on which the generated programs will
eventually be run) with `--host=TYPE'.
Sharing Defaults
================
If you want to set default values for `configure' scripts to share,
you can create a site shell script called `config.site' that gives
default values for variables like `CC', `cache_file', and `prefix'.
`configure' looks for `PREFIX/share/config.site' if it exists, then
`PREFIX/etc/config.site' if it exists. Or, you can set the
`CONFIG_SITE' environment variable to the location of the site script.
A warning: not all `configure' scripts look for a site script.
Defining Variables
==================
Variables not defined in a site shell script can be set in the
environment passed to `configure'. However, some packages may run
configure again during the build, and the customized values of these
variables may be lost. In order to avoid this problem, you should set
them in the `configure' command line, using `VAR=value'. For example:
./configure CC=/usr/local2/bin/gcc
will cause the specified gcc to be used as the C compiler (unless it is
overridden in the site shell script).
`configure' Invocation
======================
`configure' recognizes the following options to control how it
operates.
`--help'
`-h'
Print a summary of the options to `configure', and exit.
`--version'
`-V'
Print the version of Autoconf used to generate the `configure'
script, and exit.
`--cache-file=FILE'
Enable the cache: use and save the results of the tests in FILE,
traditionally `config.cache'. FILE defaults to `/dev/null' to
disable caching.
`--config-cache'
`-C'
Alias for `--cache-file=config.cache'.
`--quiet'
`--silent'
`-q'
Do not print messages saying which checks are being made. To
suppress all normal output, redirect it to `/dev/null' (any error
messages will still be shown).
`--srcdir=DIR'
Look for the package's source code in directory DIR. Usually
`configure' can determine that directory automatically.
`configure' also accepts some other, not widely useful, options. Run
`configure --help' for more details.
SUBDIRS = src pixmaps
EXTRA_DIST = acx_pthread.m4 petri-foo.spec bootstrap BUGS ROADMAP WISHLIST
PETRI-FOO ORIGINAL FILES
* src/dish_file.[ch]
these replace beef.[ch] and are so substantially different
i consider them to be my own original work.
* src/midi_control.h
so very loosely based on control.h that again i consider it
to be substantially different enough to be my own work.
* src/mod_src.[ch]
routines for handling modulation sources. implemented
specifically for petri-foo.
* src/names.[ch]
routines for getting names of things. implemented
specifically for petri-foo.
* src/gui/mod_src_gui.[ch]
routines for generating GUI elements specifically with
modulation routing in mind. implemented specifcally
for petri-foo.
* src/gui/mod_section.[ch]
routines for generating the modulation section widgets.
implemented specifically for petri-foo.
* src/gui/basic_combos.[ch]
routines for generating combo boxes. implemented for
petri-foo.
* src/gui/param_tab.[ch]
generic replacement for specimens filtertab also
handling the amp and pitch tabs. the most tenuous
of links with specimen make me consider it my
origin work.
last edited: 30th June 2011
Petri-Foo
---------
Petri-Foo is a fork of the Specimen Sampler project. Specimen was
originally developed by Pete Bessman. See the AUTHORS file for
the list of other authors who've made contributions.
Petri-Foo is forked and developed by James Morris.
STAGE I GOALS
-------------
The primary goal of forking Specimen to create Petri-Foo was to allow
frequency modulation of the LFOs, and to allow user selection of
modulation sources throughout the program.
This has been accomplished.
STAGE II GOALS
--------------
Once stage 1 was complete, these were ideas I originally planned upon
implementing:
* Sample position retrigger by LFO. TODO.
* Sample start position modulation. TODO.
* Sample loop position modulation. TODO.
* X-fades for loops/retriggers. Basic implementation..
* Replace existing filter implementation. TODO.
* Visual display of ADSRs and LFOs. FORGOTTEN.
* Noise modulation source. TODO.
* Sample and Hold. TODO.
* Effects via LADSPA/LV2 UNNECESSARY
WHAT HAPPENED INSTEAD
---------------------
* Removal of deprecated GTK/GDK code
* Default auto-generated patch/sample
* Many code re-arrangements
* Mark navigation in waveform display
* Opening of raw audio formats
* Complete rewrite of bank file I/O code and XML file layout.
* MIDI Controllers subsumed as modulation sources.
* Amplitude modulation added to LFOs.
STAGE III GOALS
---------------
* Obtain a stable feature set
* Sort out value mapping of MIDI controllers
* Figure out how to best handle state/switchable items that are
often controlled by MIDI controllers (ie portamento on/off)
+ Sample point modulation as listed in stage 2 goals
+ Figure out how to best handle things that are triggered
- Random/noise source
- Sample and hold
DEVELOPMENT
-----------
Development can be followed at http://github.com/jwm-art-net/Petri-Foo
WHY HAVE I FORKED SPECIMEN?
---------------------------
1) I think my changes are too much of a departure.
2) Development of Specimen was dead.
3) I had ideas for which I wanted the freedom to follow.
strip out old build system
add new build system from peter <zenadsl6252@zen.co.uk>
make it work with just specimen devel
merge jack midi
test build
test functionality
merge lash patch
test build
test functionality
jack_client_new vs _open change
release 0.5.2rcN
fix bugs
repeat
release 0.5.2
***********************************************************************
-Engine: specimen can have portamento turned on/off via midi cc,
petri-foo is not currently capable of such a thing.
implement method of doing so, giving user same range of
choice as existing modulation slots.
the method should be capable to be used by other parameters
such as playback mode, sample positions, monophonic + legato
operation
***********************************************************************
-Engine: Voice modes
+polyphonic re-trigger mode (new note repetition cuts old note).
-Engine: Keyboard tracking
+add to lfo's for frequency modulation
-Engine: Velocity sensitivity
+add to eg's for amplitude modulation (i'm not convinced by this)
-Engine: Logarithmic Amplitudes
+Fix and remove artefacts arising from use of LAT for log_amplitude
function in maths.[ch] (research info online about alternatives
such as curved ADSRs for example).
-GUI: general
+replace PHAT widgets with something else?
+custom cairo based widgets?
-GUI: Patch List:
+use an editible widget: note this has been tried, but getting
menu->rename to use the functionality of the editible cell
is just far far far too much hard work for little gain.
-GUI: Sample Editor
+ two tool modes: pointer, and zoom
+ zoom tool: select area and zoom
+ pointer tool: *drag* play/loop point markers
+ zoom in/out/all buttons
(TODO file from the Specimen project)
-Add per-channel volume and panning parameters
-Make the volume and channel MIDI controllers affect per-channel parameters
instead of per-patch ones
-Add per-channel volume and panning controls to the GUI
-Move the pitch bend parameter from patch data to a per-channel struct
-Make "loop to end" optional
-Create a better file format
-Make a sample browser
-Allow patches to have their own JACK ports
-Automatically append .beef to a filename when saving a bank if it
doesn't have that already
-Make it possible to copy and paste whole parameter tabs
-A way to import a bunch of samples at once
-TOOLTIPS! Or a status bar... or tooltips AND a statusbar! This is
low hanging fruit, any takers? Please? FOR THE LOVE OF GOD!!!
-Make the bank save-as dialog prompt you before overwriting
an existing file
-Allow patches to host a few effects
-Allow for longer times in the Envelopes and LFOs using non-linear sliders
-Add more filter types
-Figure out why some parts of the gui don't redraw properly, such as
the waveform and the audio-settings window
-Add a progressbar when loading soundfiles and banks
-Fix syncing drift
-Add snap and zero functions to sample editor
-Fix the timing code, it's gotta be broken somehow
-Add a CLI option to specify a custom gtkrc theme file.
-Allow sample playback to be looped indefinitely while fooling with
parameters beyond just loop and playback points.
-Add the ability to export modified samples.
-Add undo
-Ask to save if any changes exist before quitting
-Enable optimized build
-Enable profiling build
-Stereo view in the loop editor
-Add a sampling capability
-Fix --enable-debug, which currently does nothing
lash -everyone
jack-midi -everyone
multiple jack outs -thorwil, yves potin
envelope, velocity controllable plugins -thorwil, larsl
"I would like to see loopingfeatures like the Ensoniq samplers which should not
add many cpu load. For instance midi controlled loop start and end, loop
offset and -let me call it so- PPG wavetablemode where the loop jumps always a
defined amount so it switches waveforms. Ensoniq called it transwave."
-Malte Steiner
dnl Available from the GNU Autoconf Macro Archive at:
dnl http://www.gnu.org/software/ac-archive/htmldoc/acx_pthread.html
dnl
AC_DEFUN([ACX_PTHREAD], [
AC_REQUIRE([AC_CANONICAL_HOST])
AC_LANG_SAVE
AC_LANG_C
acx_pthread_ok=no
# We used to check for pthread.h first, but this fails if pthread.h
# requires special compiler flags (e.g. on True64 or Sequent).
# It gets checked for in the link test anyway.
# First of all, check if the user has set any of the PTHREAD_LIBS,
# etcetera environment variables, and if threads linking works using
# them:
if test x"$PTHREAD_LIBS$PTHREAD_CFLAGS" != x; then
save_CFLAGS="$CFLAGS"
CFLAGS="$CFLAGS $PTHREAD_CFLAGS"
save_LIBS="$LIBS"
LIBS="$PTHREAD_LIBS $LIBS"
AC_MSG_CHECKING([for pthread_join in LIBS=$PTHREAD_LIBS with CFLAGS=$PTHREAD_CFLAGS])
AC_TRY_LINK_FUNC(pthread_join, acx_pthread_ok=yes)
AC_MSG_RESULT($acx_pthread_ok)
if test x"$acx_pthread_ok" = xno; then
PTHREAD_LIBS=""
PTHREAD_CFLAGS=""
fi
LIBS="$save_LIBS"
CFLAGS="$save_CFLAGS"
fi
# We must check for the threads library under a number of different
# names; the ordering is very important because some systems
# (e.g. DEC) have both -lpthread and -lpthreads, where one of the
# libraries is broken (non-POSIX).
# Create a list of thread flags to try. Items starting with a "-" are
# C compiler flags, and other items are library names, except for "none"
# which indicates that we try without any flags at all, and "pthread-config"
# which is a program returning the flags for the Pth emulation library.
acx_pthread_flags="pthreads none -Kthread -kthread lthread -pthread -pthreads -mthreads pthread --thread-safe -mt pthread-config"
# The ordering *is* (sometimes) important. Some notes on the
# individual items follow:
# pthreads: AIX (must check this before -lpthread)
# none: in case threads are in libc; should be tried before -Kthread and
# other compiler flags to prevent continual compiler warnings