├── README.md ├── enhan ├── MVDR_RTF.m ├── NOISE.m ├── MVDR_EV.m ├── PMWF.m ├── GSC.m └── cGaussMask.m ├── utils ├── ISTFT.m ├── STFT.m ├── json2mat.m └── mat2json.m ├── egs ├── CHiMEInit.m └── CHiME4.m └── LICENSE /README.md: -------------------------------------------------------------------------------- 1 | # SPMI Lab array processing toolkit 2 | Author: Hongyu Xiang, Tsinghua University SPMI Lab 3 | 4 | Introduction: 5 | This is the front-end code corresponding to "The THU-SPMI CHiME-4 system : Lightweight design with 6 | advanced multi-channel processing, feature enhancement, and language modeling. Hongyu Xiang, Bin Wang, Zhijian Ou" 7 | 8 | Implemented methods: 9 | ME (complex Gauss based mask estimation) 10 | MVDR-EV 11 | MVDR-RTF 12 | PMWF 13 | GSC (a simple one, may not well-implemented) 14 | 15 | Copyright 2016 Tsinghua University SPMI Lab, Hongyu Xiang 16 | This software is distributed under the GNU Public License 17 | -------------------------------------------------------------------------------- /enhan/MVDR_RTF.m: -------------------------------------------------------------------------------- 1 | % Copyright 2016 Tsinghua University SPMI Lab, Hongyu Xiang 2 | % This software is distributed under the terms of the GNU Public License 3 | % version 3 (http://www.gnu.org/licenses/gpl.txt) 4 | 5 | function Y = MVDR_RTF(ftbin, Gcor, Ncor, refMic) 6 | 7 | [Nchan,Nbin,~] = size(ftbin); 8 | u0 = zeros(Nchan,1); 9 | u0(refMic) = 1; 10 | ng = zeros(Nchan,Nchan,Nbin); 11 | lambda = zeros(Nbin,1); 12 | 13 | for flp = 1:Nbin 14 | ng(:,:,flp) = Ncor(:,:,flp) \ Gcor(:,:,flp); 15 | lambda(flp) = trace(ng(:,:,flp)); 16 | end 17 | Y = bsxfun(@rdivide, squeeze(sum(bsxfun(@times, conj(sum(bsxfun(@times, ng, u0.'), 2)), permute(ftbin,[1,4,2,3])),1)),lambda); -------------------------------------------------------------------------------- /enhan/NOISE.m: -------------------------------------------------------------------------------- 1 | % Copyright 2016 Tsinghua University SPMI Lab, Hongyu Xiang 2 | % This software is distributed under the terms of the GNU Public License 3 | % version 3 (http://www.gnu.org/licenses/gpl.txt) 4 | 5 | function noise = NOISE(ftbin, Gcor, Ncor, refMic) 6 | % estimate noises, not used yet 7 | [Nchan, Nbin, ~] = size(ftbin); 8 | u0 = zeros(Nchan,1); 9 | u0(refMic) = 1; 10 | 11 | Tcor = Gcor + Ncor; 12 | TcorInv = zeros(size(Tcor)); 13 | 14 | for flp=1:Nbin 15 | TcorInv(:,:,flp) = inv(Tcor(:,:,flp)); 16 | end 17 | noise = squeeze(sum(bsxfun(@times, conj(sum(bsxfun(@times, TcorInv, permute(sum(bsxfun(@times, Ncor, u0.'),2),[2,1,3])),2)), permute(ftbin,[1,4,2,3])),1)); -------------------------------------------------------------------------------- /utils/ISTFT.m: -------------------------------------------------------------------------------- 1 | % Copyright 2016 Tsinghua University SPMI Lab, Hongyu Xiang 2 | % This software is distributed under the terms of the GNU Public License 3 | % version 3 (http://www.gnu.org/licenses/gpl.txt) 4 | 5 | function y = ISTFT(FTbin, Lwindow, overlap) 6 | %FTbin nbin * nframe * nchan 7 | FTbin = cat(1,FTbin, conj(FTbin(end-1:-1:2,:,:))); 8 | [Nfft, Nframe, Nchan] = size(FTbin); 9 | Lgap = Lwindow - Lwindow * overlap; 10 | y = zeros(Nframe * Lgap + Lwindow * overlap, Nchan); 11 | for clp = 1:Nchan 12 | for tlp = 1:Nframe 13 | y((tlp - 1)*Lgap+1:(tlp-1)*Lgap+Lwindow,clp) = y((tlp - 1)*Lgap+1:(tlp-1)*Lgap+Lwindow,clp)+ sqrt(Nfft) * ifft(FTbin(:,tlp,clp), Lwindow); 14 | end 15 | end -------------------------------------------------------------------------------- /enhan/MVDR_EV.m: -------------------------------------------------------------------------------- 1 | % Copyright 2016 Tsinghua University SPMI Lab, Hongyu Xiang 2 | % This software is distributed under the terms of the GNU Public License 3 | % version 3 (http://www.gnu.org/licenses/gpl.txt) 4 | 5 | function Y = MVDR_EV(ftbin, Gcor, Ncor) 6 | [Nchan,Nbin,~] = size(ftbin); 7 | Df = zeros(Nchan, Nbin); 8 | NcorInv = zeros(Nchan,Nchan,Nbin); 9 | for flp = 1:Nbin 10 | NcorInv(:,:,flp) = inv(Ncor(:,:,flp)); 11 | [vv,dd] = eig(Gcor(:,:,flp)); 12 | [~,ddind] = max(diag(dd)); 13 | Df(:,flp) = vv(:,ddind); 14 | end 15 | %tdt : Nchan * 1 * Nbin 16 | tdt = sum(bsxfun(@times,NcorInv,permute(Df,[3,1,2])),2); 17 | Y = squeeze(sum(bsxfun(@times,conj(bsxfun(@rdivide, tdt, sum(bsxfun(@times,tdt,conj(permute(Df,[1,3,2]))),1))),permute(ftbin,[1,4,2,3])),1)); 18 | end -------------------------------------------------------------------------------- /enhan/PMWF.m: -------------------------------------------------------------------------------- 1 | % Copyright 2016 Tsinghua University SPMI Lab, Hongyu Xiang 2 | % This software is distributed under the terms of the GNU Public License 3 | % version 3 (http://www.gnu.org/licenses/gpl.txt) 4 | 5 | function Y = PMWF(ftbin, Gcor, Ncor, refMic, gamma) 6 | % X_n(t,w) = H(w)S_n(t,w) + N_n(t,w) 7 | % X_n(t,w) = G_n(t,x) + N_n(t,w) 8 | % target is G_ref 9 | % PMWF beamforming 10 | %Y = zeros(size(X,1), size(X,2)); 11 | [Nchan, Nbin, ~] = size(ftbin); 12 | u0 = zeros(Nchan,1); 13 | u0(refMic) = 1; 14 | 15 | Tcor = Gcor+gamma*Ncor; 16 | TcorInv = zeros(size(Tcor)); 17 | 18 | for flp=1:Nbin 19 | TcorInv(:,:,flp) = inv(Tcor(:,:,flp)); 20 | end 21 | 22 | %Gcor : nchan * nchan * nbin 23 | %Ncor : nchan * nchan * nbin 24 | %u0 : nhcan 25 | %ftbin : nchan * nbin * nframe 26 | Y = squeeze(sum(bsxfun(@times, conj(sum(bsxfun(@times, TcorInv, permute(sum(bsxfun(@times, Gcor, u0.'),2),[2,1,3])),2)), permute(ftbin,[1,4,2,3])),1)); 27 | -------------------------------------------------------------------------------- /utils/STFT.m: -------------------------------------------------------------------------------- 1 | % Copyright 2016 Tsinghua University SPMI Lab, Hongyu Xiang 2 | % This software is distributed under the terms of the GNU Public License 3 | % version 3 (http://www.gnu.org/licenses/gpl.txt) 4 | 5 | function [ftbin,Nframe,Nbin,Lspeech,speechFrame] = STFT(x, Lwindow, overlap, Nfft) 6 | %ftbin : nchan * nbin * nframe 7 | 8 | %separate frame 9 | [lgth,Nchan] = size(x); 10 | Loverlap = Lwindow * overlap; 11 | Lgap = Lwindow - Loverlap; 12 | Nframe = ceil((lgth - Loverlap)/ Lgap); 13 | Lspeech = Nframe * Lgap + Loverlap; 14 | x = [x; zeros(Lspeech - lgth, Nchan)]; 15 | speechFrame = zeros(Lwindow, Nframe, Nchan); 16 | %win = 0.5*(1-cos(2*pi*(0:Lwindow-1)'/(Lwindow-1))); 17 | win = window(@hann, Lwindow); 18 | 19 | for clp = 1:Nchan 20 | for flp = 1:Nframe 21 | speechFrame(:, flp, clp) = x((flp - 1)*Lgap+1:(flp-1)*Lgap+Lwindow,clp) .* win; 22 | end 23 | end 24 | 25 | %speechFrame : Nfft * Nframe * Nchan 26 | %ftbin = zeros(Nchan, Nbin, Nframe); 27 | Nbin = Nfft / 2 + 1; 28 | ftbin = permute(fft(speechFrame, Nfft, 1), [3,1,2]) / sqrt(Nfft); 29 | %ftbin = permute(fft(speechFrame, Nfft, 1), [3,1,2]); 30 | ftbin = ftbin(:,1:Nbin,:); -------------------------------------------------------------------------------- /egs/CHiMEInit.m: -------------------------------------------------------------------------------- 1 | % initialize path and directories for CHiME4 enhancent 2 | 3 | % Copyright 2016 Tsinghua University SPMI Lab, Hongyu Xiang 4 | % This software is distributed under the terms of the GNU Public License 5 | % version 3 (http://www.gnu.org/licenses/gpl.txt) 6 | 7 | chimeRoot = 'G:/CHIME/CHiME3/'; 8 | enhRoot = 'G:/CHIME/CHiME3/data/BSS_ENH_test/'; 9 | workRoot = 'G:/CHIME/CHiME3/TEST/BSS_OPI/'; 10 | addpath utils 11 | addpath enhan 12 | 13 | Path.isolated = [chimeRoot,'data/audio/16kHz/isolated/']; 14 | Path.enhanced = [chimeRoot,'data/audio/16kHz/enhanced/']; 15 | Path.embedded = [chimeRoot,'data/audio/16kHz/embedded/']; 16 | Path.backgrounds = [chimeRoot,'data/audio/16kHz/backgrounds/']; 17 | Path.annotations = [chimeRoot,'data/annotations/']; % path to JSON annotations 18 | 19 | Path.enhBss = [enhRoot,'enhBss/']; 20 | Path.enhBssMvdrRtf = [enhRoot, 'enhBssMvdrRtf/']; 21 | Path.enhBssMvdrEg = [enhRoot, 'enhBssMvdrEg/']; 22 | Path.enhBssPmwf = [enhRoot, 'enhBssPmwf/']; 23 | Path.enhGsc = [enhRoot, 'enhGsc/']; 24 | 25 | Path.enhBssNoise = [enhRoot,'enhBssNoise/']; 26 | Path.enhBssMvdrRtfNoise = [enhRoot, 'enhBssMvdrRtfNoise/']; 27 | Path.enhBssMvdrEgNoise = [enhRoot, 'enhBssMvdrEgNoise/']; 28 | Path.enhBssPmwfNoise = [enhRoot, 'enhBssPmwfNoise/']; 29 | 30 | enhDirs = {'enhBss','enhBssMvdrRtf','enhBssMvdrEg','enhBssPmwf','enhGsc','enhBssNoise','enhBssMvdrRtfNoise','enhBssMvdrEgNoise','enhBssPmwfNoise'}; 31 | sets={'et05','dt05','tr05'}; 32 | envirs = {'bus','caf','ped','str'}; 33 | modes={'real','simu'}; 34 | for hlp = 1:length(enhDirs) 35 | for slp = 1:length(sets) 36 | for elp = 1:length(envirs) 37 | for mlp = 1:length(modes) 38 | tDir = [enhRoot enhDirs{hlp} '/' sets{slp} '_' envirs{elp} '_' modes{mlp} '/']; 39 | if ~exist(tDir,'dir') 40 | mkdir(tDir); 41 | end 42 | end 43 | end 44 | end 45 | end -------------------------------------------------------------------------------- /utils/json2mat.m: -------------------------------------------------------------------------------- 1 | function mat=json2mat(filename) 2 | 3 | % JSON2MAT Reads a JSON file 4 | % 5 | % mat=json2mat(filename) 6 | % 7 | % Input: 8 | % filename: JSON filename (.json extension) 9 | % 10 | % Output: 11 | % mat: Matlab cell array whose entries are Matlab structures containing the 12 | % value for each JSON field 13 | % 14 | % Note: all numeric fields are rounded to double precision. Digits beyond 15 | % double precision are lost. 16 | % 17 | % If you use this software in a publication, please cite: 18 | % 19 | % Jon Barker, Ricard Marxer, Emmanuel Vincent, and Shinji Watanabe, The 20 | % third 'CHiME' Speech Separation and Recognition Challenge: Dataset, 21 | % task and baselines, submitted to IEEE 2015 Automatic Speech Recognition 22 | % and Understanding Workshop (ASRU), 2015. 23 | % 24 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 25 | % Copyright 2015 University of Sheffield (Jon Barker, Ricard Marxer) 26 | % Inria (Emmanuel Vincent) 27 | % Mitsubishi Electric Research Labs (Shinji Watanabe) 28 | % This software is distributed under the terms of the GNU Public License 29 | % version 3 (http://www.gnu.org/licenses/gpl.txt) 30 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 31 | 32 | fid=fopen(filename,'r'); 33 | fgetl(fid); % [ 34 | txt=fgetl(fid); % { or ] 35 | txt=fgetl(fid); % first field 36 | mat=cell(1); 37 | ind=1; % entry index 38 | while txt~=-1, % end of file 39 | if strcmp(txt,' }, ') || strcmp(txt,' }'), % next entry 40 | ind=ind+1; 41 | txt=fgetl(fid); % { or ] 42 | else 43 | try 44 | pos=strfind(txt,'"'); 45 | field=txt(pos(1)+1:pos(2)-1); 46 | catch 47 | keyboard; 48 | end 49 | if ~strcmp(txt(end-1:end),', '), % last field 50 | txt=txt(pos(2)+3:end); 51 | else 52 | txt=txt(pos(2)+3:end-2); 53 | end 54 | if strcmp(txt(1),'"') && strcmp(txt(end),'"'), % text value 55 | value=txt(2:end-1); 56 | else % boolean or numerical value 57 | value=eval(txt); 58 | end 59 | mat{ind}.(field)=value; 60 | end 61 | txt=fgetl(fid); % next field 62 | end 63 | fclose(fid); 64 | 65 | return -------------------------------------------------------------------------------- /enhan/GSC.m: -------------------------------------------------------------------------------- 1 | % Copyright 2016 Tsinghua University SPMI Lab, Hongyu Xiang 2 | % This software is distributed under the terms of the GNU Public License 3 | % version 3 (http://www.gnu.org/licenses/gpl.txt) 4 | 5 | function Y = GSC(ftbin, targetY) 6 | % GSC frond-end. 7 | % just a simple one, may not well-implemented 8 | 9 | [Nchan, Nbin, ~] = size(ftbin); 10 | B = zeros(Nchan-1,Nchan,Nbin); 11 | 12 | for lp = 1:Nchan-1 13 | B(lp,lp,:)=1; 14 | B(lp,lp+1,:)=-1; 15 | end 16 | 17 | % Df = zeros(Nchan, Nbin); 18 | % for flp = 1:Nbin 19 | % [vv,dd] = eig(Gcor(:,:,flp)); 20 | % [~,ddind] = max(diag(dd)); 21 | % Df(:,flp) = vv(:,ddind); 22 | % end 23 | % H = -bsxfun(@rdivide, Df, Df(1,:)); 24 | % H = conj(H(2:end,:)); 25 | % B(:,1,:) = permute(H, [1,3,2]); 26 | % B(:,2:end,:) = repmat(eye(Nchan-1),[1,1,Nbin]); 27 | 28 | z = BM(B, ftbin); 29 | R = zeros(Nchan-1, Nbin); 30 | %[RR, ~] = AF(targetY, z, ftbin, R); 31 | %[~, Y] = AF(targetY, z, ftbin, RR); 32 | [~, Y] = AF(targetY, z, ftbin, R); 33 | end 34 | 35 | function [R, e] = AF(b, z, ftbin, R) 36 | % z is the output of block matrix, (nchan-1) * nbin * nframe 37 | % b is the output of the fixed beamformer, nbin * nframe 38 | 39 | % R is the filter: (nchan-1) * nbin 40 | % e is the output of AD, is the desired signal: nbin * nframe 41 | [~, Nbin, Nframe] = size(ftbin); 42 | mu = 0.005; 43 | alpha = 0.1; 44 | e = zeros(Nbin, Nframe); 45 | %R = zeros(Nchan-1, Nbin); 46 | P = zeros(Nbin, 1); 47 | for tlp = 1:Nframe 48 | e(:,tlp) = b(:,tlp) - permute(sum(conj(R).*z(:,:,tlp),1),[2,1]); % e = b - R * z; 49 | P = alpha * P + (1 - alpha) * permute(sum(conj(ftbin(:,:,tlp).*ftbin(:,:,tlp)),1),[2,1]); %P = alpha * P + (1 - alpha) * ftbin^2; 50 | %P = alpha * P + (1 - alpha) * permute(sum(conj(z(:,:,tlp).*z(:,:,tlp)),1),[2,1]); 51 | R = R + mu * bsxfun(@times, z(:,:,tlp), permute(conj(e(:,tlp))./(P+eps), [2,1])); % R = R + mu * e * z; 52 | end 53 | end 54 | 55 | function z = BM(B, ftbin) 56 | % B is (nchan-1) * nchan * nbin 57 | % ftbin is nchan * nbin * nframe 58 | % z is (nchan -1) * nbin * nframe 59 | z = squeeze(sum(bsxfun(@times, conj(B), permute(ftbin, [4,1,2,3])),2)); 60 | end 61 | -------------------------------------------------------------------------------- /utils/mat2json.m: -------------------------------------------------------------------------------- 1 | function mat2json(mat,filename) 2 | 3 | % MAT2JSON Writes a JSON file 4 | % 5 | % mat2json(mat,filename) 6 | % 7 | % Inputs: 8 | % mat: Matlab cell array whose entries are Matlab structures containing the 9 | % value for each JSON field 10 | % filename: JSON filename (.json extension) 11 | % 12 | % Note: using JSON2MAT followed by MAT2JSON will generally not lead back to 13 | % the original JSON file due to the loss of digits beyond double precision 14 | % and to the handling of trailing zeros. 15 | % 16 | % If you use this software in a publication, please cite: 17 | % 18 | % Jon Barker, Ricard Marxer, Emmanuel Vincent, and Shinji Watanabe, The 19 | % third 'CHiME' Speech Separation and Recognition Challenge: Dataset, 20 | % task and baselines, submitted to IEEE 2015 Automatic Speech Recognition 21 | % and Understanding Workshop (ASRU), 2015. 22 | % 23 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 24 | % Copyright 2015 University of Sheffield (Jon Barker, Ricard Marxer) 25 | % Inria (Emmanuel Vincent) 26 | % Mitsubishi Electric Research Labs (Shinji Watanabe) 27 | % This software is distributed under the terms of the GNU Public License 28 | % version 3 (http://www.gnu.org/licenses/gpl.txt) 29 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 30 | 31 | fid=fopen(filename,'w'); 32 | fprintf(fid,'%s\n','['); 33 | for ind=1:length(mat), % loop over entries 34 | fprintf(fid,' %s\n','{'); % entry delimiter 35 | fields=fieldnames(mat{ind}); 36 | for f=1:length(fields), % loop over fields 37 | field=fields{f}; 38 | value=mat{ind}.(field); 39 | if ischar(value), % text field 40 | fprintf(fid,' "%s": "%s"',field,value); 41 | elseif islogical(value), % boolean field 42 | if value, 43 | fprintf(fid,' "%s": true',field); 44 | else 45 | fprintf(fid,' "%s": false',field); 46 | end 47 | elseif value==floor(value), % integer field 48 | fprintf(fid,' "%s": %d',field,value); 49 | else % double field 50 | fprintf(fid,' "%s": %17.*f',field,15-max(0,floor(log10(value))),value); 51 | end 52 | if f~=length(fields), % field delimiter 53 | fprintf(fid,', '); 54 | end 55 | fprintf(fid,'\n'); 56 | end 57 | fprintf(fid,' }'); % entry delimiter 58 | if ind~=length(mat), 59 | fprintf(fid,', '); 60 | end 61 | fprintf(fid,'\n'); 62 | end 63 | fprintf(fid,']'); 64 | fclose(fid); 65 | 66 | return -------------------------------------------------------------------------------- /enhan/cGaussMask.m: -------------------------------------------------------------------------------- 1 | % calculate masks for time-frequency bin using complex Gauss model 2 | % corresponding to 'ME" in "The THU-SPMI CHiME-4 system : Lightweight design with 3 | % advanced multi-channel processing, feature enhancement, and language modeling." 4 | 5 | % implemented based on Higuchi T, Ito N, Yoshioka T, et al. 6 | % "Robust MVDR beamforming using time-frequency masks for online/offline ASR in noise[C]" 7 | % IEEE International Conference on Acoustics, Speech and Signal Processing. 2016. 8 | 9 | % Copyright 2016 Tsinghua University SPMI Lab, Hongyu Xiang 10 | 11 | % This software is distributed under the terms of the GNU Public License 12 | % version 3 (http://www.gnu.org/licenses/gpl.txt) 13 | 14 | function softmask = cGaussMask(ftbin,Nsource,XX,EMITERNUM) 15 | 16 | [Nchan,Nbin,Nframe] = size(ftbin); 17 | %EM algorithm 18 | softmask = zeros(Nbin, Nframe, Nsource); 19 | %init parameters 20 | phiCor = ones(Nbin, Nframe, Nsource); 21 | Rcor = zeros(Nchan, Nchan, Nbin, Nsource); 22 | Rcor(:,:,:,1) = mean(XX, 4);% + repmat(1 * eye(Nchan),[1,1,Nfft]); 23 | Rcor(:,:,:,2) = mean(XX(:,:,:,[1:10,Nframe-10:Nframe]),4); 24 | %Rcor(:,:,:,2) = bsxfun(@times, mean(mean(mean(XX, 4),1),2), repmat(eye(Nchan),[1,1,Nfft])); 25 | RcorDet = zeros(Nbin, Nsource); 26 | RcorInv = zeros(Nchan,Nchan,Nbin,Nsource); 27 | for EMiter = 1:EMITERNUM 28 | for flp = 1:Nbin 29 | for slp = 1:Nsource 30 | RcorDet(flp,slp) = abs(det(Rcor(:,:,flp,slp))); 31 | condRcor = rcond(Rcor(:,:,flp,slp)); 32 | if (condRcor < eps) 33 | return; 34 | end 35 | RcorInv(:,:,flp,slp) = inv(Rcor(:,:,flp,slp)); 36 | end 37 | end 38 | 39 | %the LOG coefficient before exp term of gauss 40 | coeff = - bsxfun(@plus, Nchan * log(phiCor), permute(log(RcorDet),[1,3,2])); 41 | 42 | %ignore mu for simplity, yh * Rcor * y 43 | retr = abs((squeeze(sum(bsxfun(@times, sum(bsxfun(@times, conj(permute(ftbin, [1,4,2,3])), permute(RcorInv,[1,2,3,5,4])),1), permute(ftbin,[4,1,2,3])), 2)))); 44 | 45 | ex = -retr ./ phiCor; 46 | 47 | exc = coeff + ex; 48 | %for calculate cost 49 | %ct = exc; 50 | exc = bsxfun(@minus, exc, max(exc,[],3)); 51 | softmask = bsxfun(@rdivide, exp(exc), sum(exp(exc), 3)); 52 | 53 | %calculate cost to ensure converge 54 | %tt = ct .* softmask; 55 | %cost = sum(tt(:)) 56 | 57 | %update Rcor 58 | % Rcor = bsxfun(@rdivide, squeeze(sum(bsxfun(@times, permute(softmask./((phiCor)),[4,5,1,2,3]),XX),4)),... 59 | % permute(squeeze(sum(softmask,2)),[3,4,1,2])); 60 | 61 | Rcor = bsxfun(@rdivide, permute(sum(bsxfun(@times, permute(softmask./((phiCor)),[4,5,1,2,3]),XX),4), [1,2,3,5,4]),... 62 | permute(squeeze(sum(softmask,2)),[3,4,1,2])); 63 | phiCor = retr / Nchan; 64 | %max(phiCor(:)) 65 | %disp(['EMiter',num2str(EMiter)]); 66 | end -------------------------------------------------------------------------------- /egs/CHiME4.m: -------------------------------------------------------------------------------- 1 | % speech enhancement for CHiME4 6-ch data 2 | % corresponding to "The THU-SPMI CHiME-4 system : Lightweight design with 3 | % advanced multi-channel processing, feature enhancement, and language modeling" 4 | 5 | % based on CHiME3 official code 6 | % Jon Barker, Ricard Marxer, Emmanuel Vincent, and Shinji Watanabe, The 7 | % third 'CHiME' Speech Separation and Recognition Challenge: Dataset, 8 | % task and baselines, submitted to IEEE 2015 Automatic Speech Recognition 9 | % and Understanding Workshop (ASRU), 2015. 10 | 11 | % This software is distributed under the terms of the GNU Public License 12 | % version 3 (http://www.gnu.org/licenses/gpl.txt) 13 | 14 | clear all; 15 | CHiMEInit; 16 | 17 | Nsource = 2; 18 | Nchan = 6; 19 | Lwindow = 256; 20 | Nfft = Lwindow; 21 | overlap = 0.75; 22 | powThresh = -10; 23 | cmin = 6400; % minimum context duration (400 ms) 24 | cmax = 12800; % maximum context duration (800 ms) 25 | EMITERNUM = 20; 26 | GAMMA = 20; 27 | 28 | sets = {'et05' 'dt05' 'tr05'}; 29 | modes = {'real' 'simu'}; 30 | micFailFid = fopen([workRoot 'micfail.txt'],'a'); 31 | 32 | 33 | setIndBegin = 1; 34 | setIndEnd = 2; 35 | modeIndBegin = [1 1 1]; 36 | modeIndEnd = [1 1 1]; 37 | uttIndBegin = [1 1; 38 | 1 1; 39 | 1 1]; 40 | 41 | %for setInd = setIndBegin:length(sets) 42 | for setInd = setIndBegin:setIndEnd 43 | set = sets{setInd}; 44 | %for modeInd = modeIndBegin(setInd):length(modes) 45 | for modeInd = modeIndBegin(setInd):modeIndEnd(setInd) 46 | mode = modes{modeInd}; 47 | 48 | % Read annotations 49 | mat = json2mat([Path.annotations set '_' mode '.json']); 50 | realMat = json2mat([Path.annotations set '_real.json']); 51 | 52 | for uttInd = uttIndBegin(setInd,modeInd):length(mat) 53 | Nchan = 6; 54 | disp([set, ' ', mode, ' ', 'uttInd ',num2str(uttInd)]); 55 | sem = [set '_' lower(mat{uttInd}.environment) '_' mode]; 56 | udir = [Path.isolated sem '/']; 57 | uname = [mat{uttInd}.speaker '_' mat{uttInd}.wsj_name '_' mat{uttInd}.environment]; 58 | 59 | % Load WAV files 60 | xsize = size(wavread([udir uname '.CH1.wav'])); 61 | x = zeros(xsize(1),Nchan); 62 | xc = zeros(xsize(1),Nchan); 63 | for clp = 1:Nchan, 64 | [x(:,clp),fs] = wavread([udir uname '.CH' int2str(clp) '.wav']); 65 | xc(:,clp) = x(:,clp) / norm(x(:,clp)) * norm(x(:,1)); 66 | end 67 | 68 | % Check microphone failure 69 | CLwindow = 2048; 70 | Coverlap = 0.5; 71 | CNfft = CLwindow; 72 | [~,~,~,~,CspeechFrame] = STFT(xc, CLwindow, Coverlap, CNfft); 73 | CspeechFrame = permute(CspeechFrame, [3,1,2]); 74 | NcorFFT = 2 * (CNfft-1); 75 | c1 = fft(repmat(permute(CspeechFrame, [1,4,2,3]),[1 Nchan 1 1]), NcorFFT, 3); 76 | c2 = fft(repmat(permute(CspeechFrame, [4,1,2,3]),[Nchan 1 1 1]), NcorFFT, 3); 77 | corr = real(ifft(c1 .* conj(c2),NcorFFT,3)); 78 | corr = squeeze(max(corr, [], 3)); 79 | corrjudge = sum(corr, 2) - sum(bsxfun(@times,corr,eye(Nchan)),2); 80 | corrjudge = squeeze(corrjudge); 81 | corrjudge_rate = bsxfun(@rdivide, corrjudge, median(corrjudge,1)); 82 | fail = corrjudge_rate < 0.6; 83 | fail = (sum(fail,2) > 1); 84 | fail = fail'; 85 | if all(fail) 86 | fail = (sum(corrjudge_rate,2) == max(sum(corrjudge_rate,2))); 87 | fail = ~fail; 88 | fail = fail'; 89 | end 90 | if (any(fail)) 91 | disp(['find one failure: ',set,' ',mode,' ','uttInd ',num2str(uttInd),' ',uname,' : ',num2str(fail)]); 92 | fprintf(micFailFid, [set,' ',mode,' ','uttInd ',num2str(uttInd),' ',uname,' : ',num2str(fail),'\n']); 93 | end 94 | 95 | % choose reference mic 96 | [~,refMic] = max(sum(corrjudge(~fail,:),2)); 97 | 98 | Nchan = sum(~fail); 99 | x = x(:,~fail); 100 | 101 | [ftbin,Nframe,Nbin,Lspeech] = STFT(x, Lwindow, overlap, Nfft); 102 | % for GSC fixed beamformer 103 | targetY = squeeze(mean(ftbin,1)); 104 | 105 | % correlation of X 106 | XX = bsxfun(@times, permute(ftbin,[1,4,2,3]), conj(permute(ftbin,[4,1,2,3]))); 107 | 108 | Xcor = mean(XX, 4); 109 | % Ncor = mean(XX(:,:,:,[1:10,Nframe-10:Nframe]),4); 110 | % Load context (up to 5 s immediately preceding the utterance) 111 | % noise = read_context(nchan, c_ind, Path, mode, mat, real_mat, uttInd, cmax, cmin); 112 | softmask = cGaussMask(ftbin,Nsource,XX,EMITERNUM); 113 | Ncor = bsxfun(@rdivide, mean(bsxfun(@times, XX, permute(softmask(:,:,2),[3,4,1,2])),4),permute(mean(softmask(:,:,2),2), [2,3,1])); 114 | Gcor = Xcor - Ncor; 115 | 116 | %for GSC 117 | yGscFt= GSC(ftbin, targetY); 118 | yGsc = ISTFT(yGscFt, Lwindow, overlap); 119 | yGsc = yGsc / max(abs(yGsc)); 120 | wavwrite(yGsc, 16000, 16, [Path.enhGsc sem '/' uname '.wav']); 121 | 122 | 123 | %for bss 124 | yBssFt = bsxfun(@times, ftbin, permute(softmask(:,:,1),[3,1,2])); 125 | yBssFt = squeeze(yBssFt(refMic,:,:)); 126 | nBssFt = bsxfun(@times, ftbin, permute(softmask(:,:,2),[3,1,2])); 127 | nBssFt = squeeze(nBssFt(refMic,:,:)); 128 | yBss = ISTFT(yBssFt,Lwindow,overlap); 129 | nBss = ISTFT(nBssFt,Lwindow,overlap); 130 | 131 | SNR = sum(yBss.^2) / sum(nBss.^2); 132 | yBss = yBss / max(abs(yBss)); 133 | nBss = nBss / max(abs(nBss)); 134 | 135 | wavwrite(yBss, 16000, 16, [Path.enhBss sem '/' uname '.wav']); 136 | wavwrite(nBss, 16000, 16, [Path.enhBssNoise sem '/' uname '.wav']); 137 | 138 | %for bssPmwf 139 | yBssPmwfFt = PMWF(ftbin, Gcor, Ncor, refMic, min(GAMMA/SNR,50)); 140 | nBssPmwfFt = NOISE(ftbin, Gcor, Ncor, refMic); 141 | yBssPmwf = ISTFT(yBssPmwfFt,Lwindow,overlap); 142 | nBssPmwf = ISTFT(nBssPmwfFt,Lwindow,overlap); 143 | yBssPmwf = yBssPmwf / max(abs(yBssPmwf)); 144 | nBssPmwf = nBssPmwf / max(abs(nBssPmwf)); 145 | 146 | wavwrite(yBssPmwf, 16000, 16, [Path.enhBssPmwf sem '/' uname '.wav']); 147 | wavwrite(nBssPmwf, 16000, 16, [Path.enhBssPmwfNoise sem '/' uname '.wav']); 148 | 149 | %for bssMvdrEg 150 | yBssMvdrEgFt = MVDR_EV(ftbin, Gcor, Ncor); 151 | yBssMvdrEg = ISTFT(yBssMvdrEgFt,Lwindow,overlap); 152 | yBssMvdrEg = yBssMvdrEg / max(abs(yBssMvdrEg)); 153 | wavwrite(yBssMvdrEg, 16000, 16, [Path.enhBssMvdrEg sem '/' uname '.wav']); 154 | 155 | %for bssMvdrRtf 156 | yBssMvdrRtfFt = MVDR_RTF(ftbin, Gcor, Ncor, refMic); 157 | yBssMvdrRtf = ISTFT(yBssMvdrRtfFt,Lwindow,overlap); 158 | yBssMvdrRtf = yBssMvdrRtf / max(abs(yBssMvdrRtf)); 159 | wavwrite(yBssMvdrRtf, 16000, 16, [Path.enhBssMvdrRtf sem '/' uname '.wav']); 160 | 161 | end 162 | end 163 | end 164 | fclose(micFailFid); -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------