annotate README @ 282:d9319859a4cf tip

(none)
author benoitrigolleau
date Fri, 31 Oct 2008 11:00:24 +0000
parents 84d1d2076bf7
children
rev   line source
lbajardsilogic@0 1
lbajardsilogic@43 2 Sound Access - Easaier Frontend Client
lbajardsilogic@43 3 ======================================
lbajardsilogic@0 4
lbajardsilogic@43 5 Sound Access is a program for viewing and analysing the contents
lbajardsilogic@43 6 of a multimedia archive.
lbajardsilogic@0 7
lbajardsilogic@43 8 With Sound Access you can:
lbajardsilogic@0 9
lbajardsilogic@43 10 * Query a multimedia archive on audio caracteristics (author,
lbajardsilogic@43 11 title, tonality, audio content...)
lbajardsilogic@0 12
lbajardsilogic@43 13 * Load and visualize audio files, related metadata and related media
lbajardsilogic@43 14
lbajardsilogic@43 15 * Add your own annotation metadata to an audio file of the archive
lbajardsilogic@43 16 and export it in an external file
lbajardsilogic@0 17
lbajardsilogic@43 18 * Run feature-extraction plugins to calculate metadata
lbajardsilogic@43 19 automatically, using algorithms such as beat trackers, pitch
lbajardsilogic@43 20 detectors and so on
lbajardsilogic@0 21
lbajardsilogic@43 22 * Run realtime audio plugin in cascade for source modification (source
lbajardsilogic@43 23 segmentation, noise reduction, pitch/scale modification...)
lbajardsilogic@0 24
lbajardsilogic@43 25 * Play back the original audio with related metadata and
lbajardsilogic@43 26 related media, taking care to synchronise playback with the
lbajardsilogic@43 27 display position
lbajardsilogic@0 28
lbajardsilogic@43 29 * Slow down playback and loop segments of interest, including
lbajardsilogic@43 30 seamless looping of complex non-contiguous areas
lbajardsilogic@0 31
lbajardsilogic@43 32 Sound Access can also be controlled remotely using the Open Sound
lbajardsilogic@0 33 Control (OSC) protocol.
lbajardsilogic@0 34
lbajardsilogic@0 35
lbajardsilogic@0 36 To compile from source
lbajardsilogic@0 37 ----------------------
lbajardsilogic@0 38
lbajardsilogic@0 39 First, please consider getting one of the ready-to-run binary
lbajardsilogic@43 40 distributions available from http://sourceforge.net/projects/easaier/.
lbajardsilogic@0 41
lbajardsilogic@0 42 The following additional libraries are required or optional when
lbajardsilogic@43 43 building Sound Access:
lbajardsilogic@0 44
lbajardsilogic@0 45 REQUIRED Vamp Plugin SDK http://www.sonicvisualiser.org/
lbajardsilogic@0 46
lbajardsilogic@0 47 REQUIRED Qt4 Free Edition http://www.trolltech.com/
lbajardsilogic@0 48 REQUIRED libsndfile http://www.mega-nerd.com/libsndfile/
lbajardsilogic@0 49 REQUIRED libsamplerate http://www.mega-nerd.com/SRC/
lbajardsilogic@0 50 REQUIRED FFTW3 http://www.fftw.org/
lbajardsilogic@0 51 REQUIRED bzip2 library http://www.bzip.org/
lbajardsilogic@0 52
lbajardsilogic@0 53 Optional JACK http://www.jackaudio.org/
lbajardsilogic@0 54 Optional PortAudio v18 or v19 http://www.portaudio.com/
lbajardsilogic@0 55 Optional MAD mp3 decoder http://www.underbit.com/products/mad/
lbajardsilogic@43 56 Optional Oggz and fishsound http://www.xiph.org/downloads/
lbajardsilogic@43 57 Optional liblo OSC library http://www.plugin.org.uk/liblo/
lbajardsilogic@0 58
lbajardsilogic@0 59 Although JACK and PortAudio are individually optional, you will need
lbajardsilogic@0 60 to have one or the other of them in order to get any audio playback.
lbajardsilogic@0 61 Usually JACK is preferred on Linux and PortAudio elsewhere.
lbajardsilogic@0 62
lbajardsilogic@0 63 If you happen to be using a Debian-based Linux, you probably want to
lbajardsilogic@0 64 apt-get install the following packages: libqt4-dev libsndfile1-dev
lbajardsilogic@0 65 libsamplerate0-dev fftw3-dev libbz2-dev libjack0.100.0-dev libmad0-dev
lbajardsilogic@0 66 liboggz1-dev libfishsound1-dev liblo0-dev.
lbajardsilogic@0 67
lbajardsilogic@0 68 If you are building on a Unix-like system that supports pkg-config and
lbajardsilogic@0 69 uses it for all appropriate libraries (such as a modern Linux
lbajardsilogic@0 70 distribution) then you should be able to just run "qmake" (being
lbajardsilogic@0 71 careful to ensure it is the Qt 4 version of qmake you are running, and
lbajardsilogic@0 72 not a Qt 3 version).
lbajardsilogic@0 73
lbajardsilogic@0 74 If you do not have pkg-config, you should first edit the file sv.prf
lbajardsilogic@0 75 and comment out any of the optional HAVE_* lines (in the section
lbajardsilogic@0 76 starting "If you don't have pkg-config...") for library dependencies
lbajardsilogic@0 77 that you aren't using. Then run the Qt 4 "qmake" command. This will
lbajardsilogic@0 78 create the proper Makefile.
lbajardsilogic@0 79
lbajardsilogic@0 80 (If you're on the Mac and you have Qt3 installed as well, you must
lbajardsilogic@0 81 export QMAKESPEC=macx-g++ before you do this, or Qt will get confused.)
lbajardsilogic@0 82
lbajardsilogic@0 83 Then type "make". The program will then either build, or not build.
lbajardsilogic@0 84
lbajardsilogic@43 85 Under Windows, the VC project is provided. You can used it to
lbajardsilogic@43 86 compile the sources with Visual Studio 2005 Pro or Visual Studio Express 2005.
lbajardsilogic@43 87 Note that in this case Qt must also be compiled with Visual Studio
lbajardsilogic@43 88 (http://qtnode.net/wiki/Qt4_with_Visual_Studio).
lbajardsilogic@43 89
lbajardsilogic@0 90
lbajardsilogic@0 91 Qt Library Version Requirements
lbajardsilogic@0 92 -------------------------------
lbajardsilogic@0 93
lbajardsilogic@43 94 Sound Access requires Qt version 4.x. It can not be built with
lbajardsilogic@0 95 Qt 3 or earlier.
lbajardsilogic@0 96
lbajardsilogic@43 97 You can build Sound Access using Qt 4.0, 4.1, or 4.2, but the
lbajardsilogic@0 98 build scripts provided will only work with Qt 4.2 because of an
lbajardsilogic@0 99 incompatible change in the Qt build utilities. Please read
lbajardsilogic@0 100 README.Qt41 if you want to build with Qt 4.0 or 4.1.
lbajardsilogic@0 101
lbajardsilogic@0 102
lbajardsilogic@0 103 Credits
lbajardsilogic@0 104 -------
lbajardsilogic@0 105
lbajardsilogic@43 106 Sound Access was developed under the EASAIER project funded by the
lbajardsilogic@43 107 European Commission (EU-FP6-IST-033902).
lbajardsilogic@0 108
lbajardsilogic@43 109 http://www.easaier.org
lbajardsilogic@0 110
lbajardsilogic@43 111 Sound Access is based on Sonic Visualizer (http://www.sonicvisualiser.org/)
lbajardsilogic@43 112 developped by Chris Cannam, with additional DSP and program
lbajardsilogic@0 113 design work by Christian Landone. Code copyright 2005-2007 Chris
lbajardsilogic@0 114 Cannam with parts copyright 2006-2007 Queen Mary, University of
lbajardsilogic@0 115 London, except where indicated in the individual source files.
lbajardsilogic@0 116
lbajardsilogic@0 117 This program is free software; you can redistribute it and/or modify
lbajardsilogic@0 118 it under the terms of the GNU General Public License as published by
lbajardsilogic@0 119 the Free Software Foundation; either version 2 of the License, or (at
lbajardsilogic@0 120 your option) any later version. See the file COPYING included with
lbajardsilogic@0 121 this distribution for more information.
lbajardsilogic@0 122
lbajardsilogic@0 123
lbajardsilogic@0 124 More information
lbajardsilogic@0 125 ----------------
lbajardsilogic@0 126
lbajardsilogic@43 127 http://www.easaier.org
lbajardsilogic@0 128