CHiME3_enhance_wrapper.m

function CHiME3_enhance_wrapper(stubFn, outDir, part, overwrite, ignoreErrors)

% Wrapper that takes care of I/O for CHiME3 enhancement functions.
%
% Based on the baseline enhancement script, but takes as argument an
% enhancement stub function with the following interface:
%
% Y = stubFn(X, N, Ncov, fail, TDOA_s, sr);
%
% Where Y is the estimated single channel spectrogram of the speech, X is
% the multi-channel spectrogram of the noisy speech, N is the multi-channel
% spectrogram of up to 5 seconds of noise preceeding the speech, Ncov is
% the computed frequency-dependent noise covariance matrix, fail is a
% binary vector indicating whether each mic has failed, TDOA is a matrix of
% TDOA estimates for each channel for each frame measured in seconds, and
% sr is the sampling rate.
%
% Data will be written in a standard directory structure rooted at outDir.
% 
% Part is a tuple [n N] meaning process the nth of N sets of utterances to
% allow for easy parallelization across matlab sessions.


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Copyright 2015 Michael Mandel
%                University of Sheffield (Jon Barker, Ricard Marxer)
%                Inria (Emmanuel Vincent)
%                Mitsubishi Electric Research Labs (Shinji Watanabe)
% This software is distributed under the terms of the GNU Public License
% version 3 (http://www.gnu.org/licenses/gpl.txt)
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

if ~exist('outDir', 'var') || isempty(outDir), 
    outDir='/data/corpora/chime3/CHiME3/data/audio/16kHz/enhancedLocal/baseline'; % path to enhanced utterances
end
if ~exist('overwrite', 'var') || isempty(overwrite), overwrite = false; end
if ~exist('part', 'var') || isempty(part), part = [1 1]; end
if ~exist('ignoreErrors', 'var') || isempty(ignoreErrors), ignoreErrors = false; end

%addpath ../utils;
upath='/data/corpora/chime3/CHiME3/data/audio/16kHz/isolated/'; % path to segmented utterances
cpath='/data/corpora/chime3/CHiME3/data/audio/16kHz/embedded/'; % path to continuous recordings
bpath='/data/corpora/chime3/CHiME3/data/audio/16kHz/backgrounds/'; % path to noise backgrounds
apath='/data/corpora/chime3/CHiME3/data/annotations/'; % path to JSON annotations
nchan=6;

% Define hyper-parameters
pow_thresh=-20; % threshold in dB below which a microphone is considered to fail
wlen = 1024; % STFT window length
cmin=6400; % minimum context duration (400 ms)
cmax=12800; % maximum context duration (800 ms)

sets={'tr05' 'dt05' 'et05'};
modes={'real' 'simu'};
for set_ind=1:length(sets),
    set=sets{set_ind};
    for mode_ind=1:length(modes),
        mode=modes{mode_ind};
        
        % Read annotations
        mat=json2mat([apath set '_' mode '.json']);
        real_mat=json2mat([apath set '_real.json']);
            
        for utt_ind=part(1):part(2):length(mat),
            udir=[upath set '_' lower(mat{utt_ind}.environment) '_' mode '/'];
            edir=[outDir set '_' lower(mat{utt_ind}.environment) '_' mode '/'];
            uname=[mat{utt_ind}.speaker '_' mat{utt_ind}.wsj_name '_' mat{utt_ind}.environment];
            outFile = [edir uname '.wav'];
            
            if exist(outFile, 'file') && ~overwrite
                fprintf('Skipping %s\n', outFile);
                continue
            else
                fprintf('%d: %s\n', utt_ind, outFile);
            end
            
            % Load WAV files
            xsize=wavread([udir uname '.CH1.wav'],'size');
            nsampl=xsize(1);
            x=zeros(nsampl,nchan);
            for c=1:nchan,
                [x(:,c),fs]=wavread([udir uname '.CH' int2str(c) '.wav']);
            end
            
            % Check microphone failure
            xpow=sum(x.^2,1);
            xpow=10*log10(xpow/max(xpow));
            fail=(xpow<=pow_thresh);
            
            % Load context (up to 5 s immediately preceding the utterance)
            if strcmp(mode,'real'),
                cname=mat{utt_ind}.wavfile;
                cbeg=round(mat{utt_ind}.start*fs)-cmax;
                cend=round(mat{utt_ind}.start*fs)-1;
                for utt_ind_over=1:length(mat),
                    cend_over=round(mat{utt_ind_over}.end*fs);
                    if strcmp(mat{utt_ind_over}.wavfile,cname) && (cend_over >= cbeg) && (cend_over < cend),
                        cbeg=cend_over+1;
                    end
                end
                cbeg=min(cbeg,cend-cmin);
                n=zeros(cend-cbeg+1,nchan);
                for c=1:nchan,
                    n(:,c)=wavread([cpath cname '.CH' int2str(c) '.wav'],[cbeg cend]);
                end
            elseif strcmp(set,'tr05'),
                cname=mat{utt_ind}.noise_wavfile;
                cbeg=round(mat{utt_ind}.noise_start*fs)-cmax;
                cend=round(mat{utt_ind}.noise_start*fs)-1;
                if cbeg < 1  % Added by MIM
                    warning('cbeg < 1: %d, setting to 1', cbeg)
                    cbeg = 1;
                end
                n=zeros(cend-cbeg+1,nchan);
                for c=1:nchan,
                    n(:,c)=wavread([bpath cname '.CH' int2str(c) '.wav'],[cbeg cend]);
                end
            else
                cname=mat{utt_ind}.noise_wavfile;
                cbeg=round(mat{utt_ind}.noise_start*fs)-cmax;
                cend=round(mat{utt_ind}.noise_start*fs)-1;
                for utt_ind_over=1:length(real_mat),
                    cend_over=round(real_mat{utt_ind_over}.end*fs);
                    if strcmp(mat{utt_ind_over}.wavfile,cname) && (cend_over >= cbeg) && (cend_over < cend),
                        cbeg=cend_over+1;
                    end
                end
                cbeg=min(cbeg,cend-cmin);
                n=zeros(cend-cbeg+1,nchan);
                for c=1:nchan,
                    n(:,c)=wavread([cpath cname '.CH' int2str(c) '.wav'],[cbeg cend]);
                end
            end
    
            % STFT
            X = stft_multi(x.',wlen);
            [nbin,nfram,~] = size(X);
            
            % Compute noise covariance matrix
            N=stft_multi(n.',wlen);
            Ncov=zeros(nchan,nchan,nbin);
            for f=1:nbin,
                for n=1:size(N,2),
                    Ntf=permute(N(f,n,:),[3 1 2]);
                    Ncov(:,:,f)=Ncov(:,:,f)+Ntf*Ntf';
                end
                Ncov(:,:,f)=Ncov(:,:,f)/size(N,2);
            end
            
            % Localize and track the speaker
            [~,TDOA]=localize(X);
            
            %%% Call the stub
            try
                Y = stubFn(X, N, Ncov, fail, TDOA, fs);
            catch ex
                if ignoreErrors
                    disp(getReport(ex))
                else
                    rethrow(ex)
                end
            end

            % Write WAV file
            y = istft_multi(Y,nsampl).';
            y = y * 0.999/max(abs(y));

            if ~exist(edir,'dir'),
                system(['mkdir -p ' edir]);
            end
            wavwrite(y,fs,outFile);
        end
    end
end

return