README

   1 What license is this software released on?
   2
   3         zlib/libpng license (see file COPYING in this directory)
   4
   5 -------------------------------------------------------------------------------
   6
   7 what is it?
   8
   9         didgmo is a acronym, which stands for DIDGeridoo MOdeling. It is
  10         a plain console program for didgeridoo sound design. In the course
  11         of building my own didgeridoos, i was on the search for a method to
  12         predict the sound of a didgeridoo in advance. the method i found is
  13         described in the book "Das Didgeridoo Phänomen" and on the web page
  14         of the author "http://www.didgeridoo-physik.de".
  15         As the original author does not yet provide a binary version of his
  16         software nor the source code, i decided to start an open-source
  17         variant.
  18
  19 what is it good for?
  20
  21         didgmo uses the method of acoustic transmission-line-modeling. with
  22         this approach, the didgeridoo's inner geometry is divided into conical
  23         segments. the calculation of the transmission line in the complex number
  24         space solves for the input impedance of the didgeridoo.
  25         by combining the impedance spectrum with the overblow spectrum from the
  26         base tone and its first overblow, didgmo outputs a pretty realistic
  27         sound spectrum.
  28
  29         while writing this code, i had in mind to use it not only for calculating
  30         single didgeridoo sound spectra, but to iterativly try iterativley
  31         different potential inner geometries to find the best inner geometry
  32         according to given criterions. the program is therefore written in plain
  33         ansi c and optimised for speed. it is easily extensible by dynamically
  34         loadable plugins.
  35
  36 who may use it?
  37
  38         me of course! but it may me useful to you, too.
  39
  40 -------------------------------------------------------------------------------
  41
  42 required libraries and development packages/headers
  43         1) glib-2.0-dev
  44         2) gmodule-2.0-dev
  45         3) libfftw3-dev
  46         4) pkg-config (required for the autotools)
  47         5) autotools (aclocal, autoconf, libtool, automake)
  48
  49 -------------------------------------------------------------------------------
  50
  51 build
  52
  53         - default strategy
  54         1) ./autogen.sh
  55         2) ./configure
  56         3) make
  57
  58         - the debian way
  59         1) ./debgen
  60
  61 -------------------------------------------------------------------------------
  62
  63 install
  64
  65         - default strategy
  66         1) sudo make install
  67
  68         - the debian way
  69         1) sudo dpgk -i ../enlua_VERSION_PLATFORM.deb
  70
  71 -------------------------------------------------------------------------------
  72
  73 directory structure
  74
  75         root (root directory)
  76         |- debian (files needed for automatic package building process on debian)
  77         |- m4 (files needed for macro processor of autobuild process)
  78         |- scripts (example scripts)
  79         |- src (source tree)
  80                 |- bin
  81                 |- modules
  82
  83 -------------------------------------------------------------------------------
  84