README updates to match SCAPE template - work in progress

CMakeLists.txt

@@ -45,10 +45,10 @@ include_directories(${FFTW_INCLUDES} ${Boost_INCLUDE_DIR} libs/core libs/sound_i
 #endif (LINUX)
 
 set(CPACK_PACKAGE_NAME scape-xcorrsound)
-set(CPACK_PACKAGE_VERSION 0.9.1)
+#set(CPACK_PACKAGE_VERSION 0.9.1)
 
 set(CPACK_DEBIAN_PACKAGE_ARCHITECTURE amd64)
-set(CPACK_DEBIAN_PACKAGE_DEPENDS "libc6, libboost-program-options-dev, libfftw3-dev")
+set(CPACK_DEBIAN_PACKAGE_DEPENDS "libc6, libboost-all-dev, libfftw3-dev")
 set(CPACK_DEBIAN_PACKAGE_MAINTAINER "Jesper Sindahl Nielsen <jsn@statsbiblioteket.dk>")
 set(CPACK_PACKAGE_DESCRIPTION_SUMMARY 
 "This is a package of the toolsuite scape-xcorrsound. It contains three tools

README.md

@@ -0,0 +1,184 @@
+# XCORRSOUND
+
+Compare Sound Waves using Cross Correlation.
+
+### What does XCORRSOUND do?
+
+The xcorrSound package contains several tools.
+
+* overlap-analysis is a tool to find the overlap between two audio files.
+* waveform-compare is a tool that splits two audio files into equal sized blocks and outputs the correlation for each block (a_i,b_i), if a and b was the input.
+* sound-match is a tool to find the location of a small wavefile inside a big wavefile
+
+The tools all make use of cross correlation, which can be computed through the Fourier transform.
+
+Note that all the tools will need write access to a file called <tool>.log where various information about a run will be stored.
+
+### What are the benefits for end user?
+The automisation of manual processes offers a big performance improvement.
+
+* you can find overlaps between audio files automatically
+* you can perform quality assurance of all the files automatically after a mass audio file migration
+
+### Who is intended audience?
+XCORRSOUND is for:
+
+* Institutions who disseminate audio content
+* Institutions that preserve audio collection
+
+## Features and roadmap
+TODO
+
+## How to install and use
+
+### Requirements
+
+To install you need:
+
+* FFTW and
+* Boost
+
+### Download
+TODO
+
+### Install instructions
+
+To install follow these steps:
+
+    The tools depend on FFTW3 and Boost program options. These can be found as debian packages.
+    And as rpm packages. On Mac OS X the depdencies can be installed using
+    Homebrew (http://brew.sh). See install_dependencies.sh
+
+    Download the repository, change directory to the repository and run:
+
+    mkdir build
+    cd build
+    cmake ..
+    make
+
+    You will now find all the tools in build/apps/
+
+### BUILD DEBIAN PACKAGE
+
+    Inside the build directory run:
+
+    cpack -G DEB
+
+    Now the .deb package file is in the build directory.
+    To install
+
+    sudo dpkg -i scape-xcorrsound*deb
+
+### Use
+
+Example: overlap-analysis
+
+Syntax:
+
+overlap-analysis <file1.wav> <file2.wav> [v<log level>]
+
+Output example:
+
+The best match was below the threshold of 0.2
+Best at sample number: 11520000
+Best at second: 240
+Value of match was: 0.132016
+
+In the log various information relating to the wav files can be found,
+such as samplerate, number of channels and so on.
+
+----------------------- wav header start -----------------------
+ChunkID: RIFF$ËnWAVE
+ChunkSize: 57600036
+Format: WAVE
+----------------------- wav header end -----------------------
+----------------------- wav subchunk start -----------------------
+Subchunk1ID: fmt 
+Subchunk1Size: 16
+AudioFormat: 1
+NumChannels: 2
+SampleRate: 48000
+ByteRate: 192000
+BlockAlign: 4
+BitsPerSample: 16
+Subchunk2ID: data
+Subchunk2Size: 57600000
+----------------------- wav subchunk end -----------------------
+----------------------- wav header start -----------------------
+ChunkID: RIFF$ËnWAVE
+ChunkSize: 57600036
+Format: WAVE
+----------------------- wav header end -----------------------
+----------------------- wav subchunk start -----------------------
+Subchunk1ID: fmt 
+Subchunk1Size: 16
+AudioFormat: 1
+NumChannels: 2
+SampleRate: 48000
+ByteRate: 192000
+BlockAlign: 4
+BitsPerSample: 16
+Subchunk2ID: data
+Subchunk2Size: 57600000
+----------------------- wav subchunk end -----------------------
+
+### Troubleshooting
+TODO
+
+## More information
+
+### Publications
+TODO
+* Bolette Ammitzbøll Jurik and Jesper Sindahl Nielsen:
+  Audio Quality Assurance: An Application of Cross Correlation.
+  In: iPRES 2012 – Proceedings of the 9th International Conference on Preservation of Digital Objects. Toronto 2012, 144-149.
+  ISBN 978-0-9917997-0-1 (http://www.scape-project.eu/publication/audio-quality-assurance)
+
+### Licence
+
+XCORRSOUND is copyright 2012 State and University Library, Denmark <abr@statsbiblioteket.dk>
+released under [/usr/share/common-licenses/GPL-2]
+
+### Acknowledgements
+
+Part of this work was supported by the European Union in the 7th Framework Program, IST, through the SCAPE project, Contract 270137.
+
+### Support
+TODO
+
+## Develop
+
+* https://travis-ci.org/openplanets/scape-xcorrsound
+
+### Requirements
+
+To build you require:
+
+* C++
+* cmake?
+
+For using the recommended IDE you require:
+
+* Eclipse???
+
+### Setup IDE
+TODO
+
+### Build
+TODO move from above
+
+### Deploy
+
+To deploy do ...
+
+### Contribute
+
+1. [Fork the GitHub project](https://help.github.com/articles/fork-a-repo)
+2. Change the code and push into the forked project
+3. [Submit a pull request](https://help.github.com/articles/using-pull-requests)
+
+To increase the changes of you code being accepted and merged into the official source here's a checklist of things to go over before submitting a contribution. For example:
+
+* Has unit tests (that covers at least 80% of the code)
+* Has documentation (at least 80% of public API)
+* Agrees to contributor license agreement, certifying that any contributed code is original work and that the copyright is turned over to the project

install_dependencies.sh

@@ -7,12 +7,9 @@
 
 # This script installs dependencies
 
-sudo apt-get install libc6
-sudo apt-get install libboost-program-options-dev
-sudo apt-get install libfftw3-dev
+sudo apt-get install libfftw3-dev libboost-all-dev
 
 # On Fedora run
-# sudo yum install glibc
 # sudo yum install boost-devel
 # sudo yum install fftw-devel