annotate toolboxes/AudioInpaintingToolbox/readme.txt @ 247:ecce33192fcc tip

Added tag ver_2.1 for changeset cef4500b936f
author luisf <luis.figueira@eecs.qmul.ac.uk>
date Wed, 31 Oct 2012 12:24:44 +0000
parents 56d719a5fd31
children
rev   line source
ivan@138 1
ivan@138 2 -------------------------------------------------
ivan@138 3
ivan@138 4 Audio Inpainting Toolbox
ivan@138 5
ivan@138 6 By
ivan@138 7
ivan@138 8 Valentin Emiya, INRIA, France
ivan@138 9 Amir Adler, The Technion, Israel
ivan@138 10 Maria Jafari, Queen Mary University of London, UK
ivan@138 11
ivan@138 12 Contact: valentin.emiya@inria.fr
ivan@138 13 -------------------------------------------------
ivan@138 14
ivan@138 15 %%%%%%%%%%%%
ivan@138 16 Requirements
ivan@138 17 %%%%%%%%%%%%
ivan@138 18 The code has been developped in Matlab (R2010a).
ivan@138 19 The CVX toolbox is required by solvers.
ivan@138 20
ivan@138 21 %%%%%%%%%%%%
ivan@138 22 Installation
ivan@138 23 %%%%%%%%%%%%
ivan@138 24 Just unpack the archive and ensure that you have CVX installed.
ivan@138 25
ivan@138 26 %%%%%%%%%%%%%%%
ivan@138 27 Getting started
ivan@138 28 %%%%%%%%%%%%%%%
ivan@138 29 Just run the files in the subdirectories of 'Experiments/'.
ivan@138 30 As a starting example, the simplest one is declipOneSoundExperiment.m.
ivan@138 31
ivan@138 32 %%%%%%%%%%%%%%%%%%%
ivan@138 33 Very quick tutorial
ivan@138 34 %%%%%%%%%%%%%%%%%%%
ivan@138 35 The toolbox is organized into several types of components, each type being located in a separate directory:
ivan@138 36 - Problems (API: '[problemData,solutionData] = generateMyProblem(mysound,problemParam);'): generates a particular problem (e.g. "declip this sound"), with given parameters, and generates the true solution.
ivan@138 37 - Solvers/algorithms (API: 'solutionEstimate = mySolver(problemData,solverParameters);'): given a problem and the solver parameters (a dictionary, thresholds, and so on), a solver proposes a solution using its particular algorithm
ivan@138 38 - Utils: e.g. dictionaries, evaluation functions are stored here
ivan@138 39 - Data: audio datasets including speech, music
ivan@138 40 - Experiments (API: 'myExperiment(experimentParameters);'): they are the main files one may run. A specific experiment takes a dataset, generates specific problems (e.g. increasing clipping levels), solves each problem with a number of solvers (specified in the experiment parameters), displays the performance for each solver. The experiments can be run without any input argument. In this case, default values will be used.
ivan@138 41
ivan@138 42 You may find more information:
ivan@138 43 - about each function 'myFunction', by typing 'help myFunction' in Matlab
ivan@138 44 - in the documented code of each function
ivan@138 45 - in the extended abstract and slides presented at the SPARS'11 workshop
ivan@138 46 - in the paper available at http://hal.inria.fr/inria-00577079/en
ivan@138 47
ivan@138 48 %%%%%%%%%%%%%%%%%%%%%%%%
ivan@138 49 How to cite this toolbox
ivan@138 50 %%%%%%%%%%%%%%%%%%%%%%%%
ivan@138 51 Please cite the following paper:
ivan@138 52 Adler Amir; Emiya Valentin; Jafari Maria; Elad Michael; Gribonval Remi; Plumbley Mark
ivan@138 53 Audio Inpainting
ivan@138 54 Submitted to IEEE Transactions on Audio, Speech, and Language Processing (2011)
ivan@138 55 Available at http://hal.inria.fr/inria-00577079/en.
ivan@138 56
ivan@138 57 %%%%%%%%%%%%%%%%%%%%%%%%%%%
ivan@138 58 Known issues / Future works
ivan@138 59 %%%%%%%%%%%%%%%%%%%%%%%%%%%
ivan@138 60 - The multithread processing of audio frames is not yet available (you may wonder about the Java TCP/IP utils, which will be used soon for this purpose).
ivan@138 61 - Some solvers based on L1 minimization will be added soon.
ivan@138 62 - The experiment called 'FromSmallToLargeHoleExperiment' will be added soon.
ivan@138 63
ivan@138 64 %%%%%%%
ivan@138 65 License
ivan@138 66 %%%%%%%
ivan@138 67 The code of this toolbox is distributed under the terms of the GNU Public License version 3 (http://www.gnu.org/licenses/gpl.txt).
ivan@138 68 The data files are distributed under specific licenses as stated in the related .txt files in the directory 'Data/'.
ivan@138 69
ivan@138 70