ivan@138: 
ivan@138: -------------------------------------------------
ivan@138: 
ivan@138: Audio Inpainting Toolbox
ivan@138: 
ivan@138: By
ivan@138: 
ivan@138: Valentin Emiya, INRIA, France
ivan@138: Amir Adler, The Technion, Israel
ivan@138: Maria Jafari, Queen Mary University of London, UK
ivan@138: 
ivan@138: Contact: valentin.emiya@inria.fr
ivan@138: -------------------------------------------------
ivan@138: 
ivan@138: %%%%%%%%%%%%
ivan@138: Requirements
ivan@138: %%%%%%%%%%%%
ivan@138: The code has been developped in Matlab (R2010a).
ivan@138: The CVX toolbox is required by solvers.
ivan@138: 
ivan@138: %%%%%%%%%%%%
ivan@138: Installation
ivan@138: %%%%%%%%%%%%
ivan@138: Just unpack the archive and ensure that you have CVX installed.
ivan@138: 
ivan@138: %%%%%%%%%%%%%%%
ivan@138: Getting started
ivan@138: %%%%%%%%%%%%%%%
ivan@138: Just run the files in the subdirectories of 'Experiments/'.
ivan@138: As a starting example, the simplest one is declipOneSoundExperiment.m.
ivan@138: 
ivan@138: %%%%%%%%%%%%%%%%%%%
ivan@138: Very quick tutorial
ivan@138: %%%%%%%%%%%%%%%%%%%
ivan@138: The toolbox is organized into several types of components, each type being located in a separate directory:
ivan@138: - 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: - 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: - Utils: e.g. dictionaries, evaluation functions are stored here
ivan@138: - Data: audio datasets including speech, music
ivan@138: - 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: 
ivan@138: You may find more information:
ivan@138: - about each function 'myFunction', by typing 'help myFunction' in Matlab
ivan@138: - in the documented code of each function
ivan@138: - in the extended abstract and slides presented at the SPARS'11 workshop
ivan@138: - in the paper available at http://hal.inria.fr/inria-00577079/en
ivan@138: 
ivan@138: %%%%%%%%%%%%%%%%%%%%%%%%
ivan@138: How to cite this toolbox
ivan@138: %%%%%%%%%%%%%%%%%%%%%%%%
ivan@138: Please cite the following paper:
ivan@138: Adler Amir; Emiya Valentin; Jafari Maria; Elad Michael; Gribonval Remi; Plumbley Mark
ivan@138: Audio Inpainting
ivan@138: Submitted to IEEE Transactions on Audio, Speech, and Language Processing (2011)
ivan@138: Available at http://hal.inria.fr/inria-00577079/en.
ivan@138: 
ivan@138: %%%%%%%%%%%%%%%%%%%%%%%%%%%
ivan@138: Known issues / Future works
ivan@138: %%%%%%%%%%%%%%%%%%%%%%%%%%%
ivan@138: - 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: - Some solvers based on L1 minimization will be added soon.
ivan@138: - The experiment called 'FromSmallToLargeHoleExperiment' will be added soon.
ivan@138: 
ivan@138: %%%%%%%
ivan@138: License
ivan@138: %%%%%%%
ivan@138: 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: The data files are distributed under specific licenses as stated in the related .txt files in the directory 'Data/'.
ivan@138: 
ivan@138: