MIRtoolbox: miroptions(method,orig,specif,varg) - File Exchange

Code covered by the BSD License

Highlights from
MIRtoolbox

aiffread(filePath,indexRange) AIFFREAD Read AIFF (Audio Interchange File Format) sound file.
center(x)
combinepeaks(p,v,thr) dedicated function for (Klapuri, 99) that creates a curve made of burst
convolve2(x, m, shape, tol) CONVOLVE2 Two dimensional convolution.
demo1pitch.m
demo2timbre
demo3tempo To get familiar with tempo estimation from audio using the MIR Toolbox.
demo4segmentation To get familiar with some approaches of segmentation of audio files
demo5export Example of use of the export function.
demo6curves(file) Example of use of curve analysis tools, such as moment estimations.
demo7tonality.m
displot(x,y,xlab,ylab,t,fp,pp... graphical display of any data (except mirscalar data) computed by MIRToolbox
fcoefs=MakeERBFilters(fs,numC... function [fcoefs]=MakeERBFilters(fs,numChannels,lowFreq)
haspeaks(d)
hwr(x) Half-Wave Rectifier
isamir(x,class)
mirattacks(orig,varargin)
mirattackslope(orig,varargin) a = mirattackslope(x) estimates the average slope of each note attack.
mirattacktime.m
mirauditory(x,varargin) Produces the output based on an auditory modelling, of the signal x,
mirbeatspectrum(orig,varargin) n = mirbeatspectrum(m) evaluates the beat spectrum.
mirbrightness(x,varargin) b = mirbrightness(s) calculates the spectral brightness, i.e. the amount
mircentroid(x,varargin) c = mircentroid(x) calculates the centroid (or center of gravity) of x.
mirchunklim(lim) c = mirchunklim returns the maximal chunk size.
mircluster(a,varargin) c = mircluster(a,f) clusters the segments in the audio sequence(s)
mircompute(algo,varargin)
mirdist(x,y,dist) d = mirdist(x,y) evaluates the distance between x and y.
mirentropy(x,varargin) h = mirentropy(a) calculates the relative entropy of a.
mirerror(operator,message)
mireval(d,file,single,export) mireval(d,filename) applies the mirdesign object d to the audio file
mirevalparallel(a,sr,w,single... Function in separate M file, because the "parfor" command is not
mireventdensity(x,varargin) e = mireventdensity(x) estimate the mean frequency of events (i.e., how
mirexport(f,varargin) mirexport(filename,...) exports statistical information related to
mirfeatures(x,varargin) f = mirfeatures(x) computes a large set of features from one or several
mirfilterbank(orig,varargin) b = mirfilterbank(x) performs a filterbank decomposition of an audio
mirflatness(orig,varargin) f = mirflatness(x) calculates the flatness of x, which can be either:
mirfluctuation(orig,varargin) f = mirfluctuation(x) calculates the fluctuation strength, indicating the
mirflux(orig,varargin) f = mirflux(x) measures distance between successive frames.
mirframe(x,varargin) f = mirframe(x) creates the frame decomposition of the audio signal x.
mirframenow(x,option)
mirfunction(method,x,varg,nou... Meta function called by all MIRtoolbox functions.
mirgetdata(x,varargin) d = mirgetdata(x) return the data contained in the object x in a
mirgetrange(x)
mirhcdf(orig,varargin) df = mirhcdf(x) calculates the Harmonic Change Detection Function
mirinharmonicity(orig,varargi... ih = mirinharmonicity(x) estimates the inharmonicity of x, i.e., the
mirkey(orig,varargin)
mirkurtosis(orig,varargin) k = mirkurtosis(x) calculates the kurtosis of x, indicating whether
mirlength(orig,varargin) mirlength(x) indicates the temporal length of x.
mirlowenergy(x,varargin) p = mirlowenergy(f) computes the percentage of frames showing a RMS
mirmap(predics_ref,ratings_re... mirmap(predictors_file, ratings_file) performs a statistical mapping
mirmean(f,varargin) m = mirmean(f) returns the mean along frames of the feature f
mirmode(x,varargin) m = mirmode(a) estimates the mode. A value of 0 indicates a complete
mirnovelty(orig,varargin) n = mirnovelty(m) evaluates the novelty score from a similarity matrix.
mironsets(x,varargin) o = mironsets(x) shows a temporal curve where peaks relate to the
miroptions(method,orig,specif... The options are determined during the bottom-up process design (see below).
mirparallel(s) mirparallel(1) toggles on parallel processing: (BETA)
mirpeaks(orig,varargin)
mirplay(a,varargin) mirplay(a) plays audio signal, envelope, or pitches.
mirpulseclarity(orig,varargin) r = mirpulseclarity(x) estimates the rhythmic clarity, indicating the
mirread(extract,orig,load,fol... Read the audio file ORIG, at temporal position indicated by EXTRACT. If
mirregularity(orig,varargin) i = mirregularity(x) calculates the irregularity of a spectrum, i.e.,
mirrms(x,varargin) e = mirrms(x) calculates the root mean square energy.
mirrolloff(x,varargin) r = mirrolloff(s) calculates the spectral roll-off in Hz.
mirroughness(x,varargin) r = mirroughness(x) calculates the roughness, or sensory dissonance,
mirsave(d,varargin) mirsave(d) saves temporal data d in a file.
mirsegment(x,varargin) f = mirsegment(a) segments an audio signal. It can also be the name of an
mirskewness(orig,varargin)
mirspread(orig,varargin) S = mirspread(x) calculates the spread of x, which can be either:
mirstat(f,varargin) stat = mirstat(f) returns basic statistics of the feature f as a
mirstd(f,varargin) m = mirstd(f) returns the standard deviation along frames of the feature f
mirsum(orig,varargin) s = mirsum(f) sums the envelope of the multi-channel object f.
mirsummary(varargin) mirsummary is the same function as mirsum.
mirtempo(x,varargin)
mirtest(audio) Version 1.0
mirtimes(a,b)
mirtype(x)
mirverbose(s) mirverbose(0) toggles off the display by MIRtoolbox of minor informations
mirwaitbar(s) mirwaitbar(0) toggles off the display by MIRtoolbox of waitbar windows.
mirzerocross(orig,varargin) mirzeroscross(x) computes the sign-changes rate along the signal x,
mp3read(FILE,N,MONO,DOWNSAMP,... MP3READ Read MP3 audio file via use of external binaries.
mp3write(D,SR,NBITS,FILE,OPTI... MP3WRITE Write MP3 file by use of external binary
mtimescell(x,varargin)
netlabgmminit(mix, x, options) GMMINIT Initialises Gaussian mixture model from data
netlabkmeans(centres, data, o... KMEANS Trains a k means cluster model.
nthoutput(orig,varargin)
num2col(k);
peaksegments(func,d,p,varargi...
pluscell(x,varargin)
purgedata(c)
surfplot(varargin) SURFPLOT Pseudocolor (checkerboard) plot.
uncell(x,lvl)
miraudio(orig,varargin)
mirautocor(orig,varargin) a = mirautocor(x) computes the autocorrelation function related to x.
mircepstrum(orig,varargin) s = mircepstrum(x) computes the cepstrum, which indicates
mirchromagram.m
mirclassify(a,da,t,dt,varargi... c = mirclassify(test,features_test,train,features_train) classifies the
mirdata(orig,varargin)
mirdesign(orig,argin,option,p...
miremotion(orig,varargin) Predicts emotion along three dimensions and five basic concepts.
mirenvelope(orig,varargin) e = mirenvelope(x) extracts the envelope of x, showing the global shape
mirhisto(x,varargin) h = mirhisto(x) constructs the histogram from x. The elements of x are
mirkeysom(orig,varargin) ks = mirkeysom(x) projects a chromagram on a self-organizing map.
mirkeystrength(orig,varargin) ks = mirkeystrength(x) computes the key strength, i.e., the probability
mirmatrix(orig,varargin) Simple numerical matrix object used to display for instance correlation
mirmfcc(orig,varargin) c = mirmfcc(a) finds the Mel frequency cepstral coefficients (ceps),
mirmidi(orig,varargin) m = mirmidi(x) converts into a MIDI sequence.
mirpattern(orig,varargin)
mirpitch(orig,varargin) p = mirpitch(x) evaluates the pitch frequencies (in Hz).
mirquery(varargin)
mirscalar(orig,varargin) s = mirscalar(x,n) creates a scalar object
mirsimatrix(orig,varargin) m = mirsimatrix(x) computes the similarity matrix resulting from the
mirspectrum(orig,varargin) s = mirspectrum(x) computes the spectrum of the audio signal x, showing
mirstruct(varargin)
mirtemporal(orig,varargin) t = mirtemporal(x) creates a temporal object from signal x.
mirtonalcentroid(orig,varargi... c = mirtonalcentroid(x) calculates the 6-dimensional tonal centroid
Contents.m
demo0grandbuffet.m
mirdemo.m
tutorial.m
View all files

from MIRtoolbox by Olivier Lartillot
An innovative environment, on top of Matlab, for music and audio analysis

miroptions(method,orig,specif,varg)

function [orig during after] = miroptions(method,orig,specif,varg)

DEFAULTFRAMELENGTH = .05;
DEFAULTFRAMEHOP = .5;

% The options are determined during the bottom-up process design (see below). 

% During the following top-down evaluation initiation, the options being
% therefore already computed have simply been passed as fourth and fifth
% arguments of miroptions.
if not(isempty(varg)) && (isstruct(varg{1}) || isempty(varg{1}))
    during = varg{1};
    if isstruct(varg{1})
        if isfield(during,'struct')
            if isa(orig,'mirdesign') 
                orig = set(orig,'Struct',during.struct);
            elseif iscell(orig)
                for i = 1:length(orig)
                    if isa(orig{i},'mirdesign')
                        orig{i} = set(orig{i},'Struct',during.struct);
                    end
                end
            end
            during = rmfield(during,'struct');
        end
    end
    if length(varg) > 1
        after = varg{2};
    else
        after = [];
    end
    return
end


during = struct;
if isfield(specif,'option')
    option = specif.option;
else
    option = struct;
end
frame = [];
after = [];
fields = fieldnames(option);
persoframe = '';
for i = 1:length(fields)
    field = fields{i};
    if isfield(option.(field),'key') && ischar(option.(field).key) ...
            && strcmpi(option.(field).key,'Frame')
        persoframe = field;
        during.(field).auto = 0;
    end
    if isfield(option.(field),'when') && ...
            (strcmpi(option.(field).when,'After') || ...
             strcmpi(option.(field).when,'Both'))
        if isamir(orig,func2str(method)) ...
                && not(strcmp(func2str(method),'miraudio'))
            after.(field) = 0;
        elseif strcmp(field,'detect')
           %if haspeaks(orig)
           %    after.(field) = 0;
           %else
               after.(field) = 'Peaks';
           %end
        elseif isfield(specif,'title')
            if isa(orig,'mirdata')
                title = get(orig,'Title');
                sameclass = (length(title) > length(specif.title) && ...
                    strcmp(title(1:length(specif.title)),specif.title));
            else
                sameclass = strcmp(func2str(get(orig,'Method')),'mironsets');
            end
            if sameclass
                after.(field) = 0;
            else
                after.(field) = option.(field).default;
            end
        elseif isfield(option.(field),'default')
            after.(field) = option.(field).default;
        else
            after.(field) = 0;
        end
    end
    if not(isfield(option.(field),'when')) || strcmpi(option.(field).when,'Both')
        if isfield(option.(field),'default')
            if strcmpi(persoframe,field)
                during.(field).length.val = option.(field).default(1);
                during.(field).length.unit = 's';
                during.(field).hop.val = option.(field).default(2);
                during.(field).hop.unit = '/1';
            else
                during.(field) = option.(field).default;
            end
        end
    end
end
i = 1;
while i <= length(varg)
    arg = varg{i};
    if strcmpi(arg,'Frame')
        frame.auto = isempty(persoframe);
        frame.length.unit = 's';
        frame.hop.unit = '/1';
        if length(varg) > i && isnumeric(varg{i+1})
            i = i+1;
            frame.length.val = varg{i};
            if length(varg) > i && ischar(varg{i+1}) && ...
                    (strcmpi(varg{i+1},'s') || strcmpi(varg{i+1},'sp'))
                i = i+1;
                frame.length.unit = varg{i};
            end
            if length(varg) > i && isnumeric(varg{i+1})
                i = i+1;
                frame.hop.val = varg{i};
                if length(varg) > i && ischar(varg{i+1}) && ...
                        (strcmpi(varg{i+1},'%') || strcmpi(varg{i+1},'/1') || ...
                         strcmpi(varg{i+1},'s') || strcmpi(varg{i+1},'sp')|| ...
                         strcmpi(varg{i+1},'Hz'))
                    i = i+1;
                    frame.hop.unit = varg{i};
                end
                if not(frame.hop.val || strcmpi(frame.hop.unit,'Hz'))
                    mirerror(func2str(method),'The hop factor should be strictly positive.')
                end
            else
                if not(isempty(persoframe))
                    if isfield(option.(persoframe),'keydefault')
                        frame.hop.val = option.(persoframe).keydefault(2);
                    else
                        frame.hop.val = option.(persoframe).default(2);
                    end
                elseif isfield(specif,'defaultframehop')
                    frame.hop.val = specif.defaultframehop;
                else
                    frame.hop.val = DEFAULTFRAMEHOP;
                end
            end
        else
            if not(isempty(persoframe))
                if isfield(option.(persoframe),'keydefault')
                    frame.length.val = option.(persoframe).keydefault(1);
                else
                    frame.length.val = option.(persoframe).default(1);
                end
            elseif isfield(specif,'defaultframelength')
                frame.length.val = specif.defaultframelength;
            else
                frame.length.val = DEFAULTFRAMELENGTH;
            end
            if not(isempty(persoframe))
                if isfield(option.(persoframe),'keydefault')
                    frame.hop.val = option.(persoframe).keydefault(2);
                else
                    frame.hop.val = option.(persoframe).default(2);
                end
            elseif isfield(specif,'defaultframehop')
                frame.hop.val = specif.defaultframehop;
            else
                frame.hop.val = DEFAULTFRAMEHOP;
            end
        end
        frame.eval = 0;
        if not(isfield(option,'frame')) || ...
                not(isfield(option.frame,'when')) || ...
                strcmpi(option.frame.when,'Before') || ...
                strcmpi(option.frame.when,'Both')
            during.frame = frame;
        end
        if isfield(option,'frame') && ...
               isfield(option.frame,'when') && ...
               (strcmpi(option.frame.when,'After') || ...
               strcmpi(option.frame.when,'Both'))
            after.frame = frame;
        end
    else
        match = 0;
        k = 0;
        while not(match) && k<length(fields)
            k = k+1;
            field = fields{k};
            if isfield(option.(field),'key')
                key = option.(field).key;
                if not(iscell(key))
                    key = {key};
                end
                for j = 1:length(key)
                    if strcmpi(arg,key{j})
                        match = 1;
                    end
                end
                if match
                    if isfield(option.(field),'type')
                        type = option.(field).type;
                    else
                        type = [];
                    end
                    if isfield(option.(field),'unit')
                        unit = option.(field).unit;
                        defaultunit = option.(field).defaultunit;
                    else
                        unit = {};
                    end
                    if isfield(option.(field),'from')
                        from = option.(field).from;
                        defaultfrom = option.(field).defaultfrom;
                    else
                        from = {};
                    end
                    if strcmpi(type,'String')
                        if length(varg) > i && ...
                                (ischar(varg{i+1}) || varg{i+1} == 0)
                            if isfield(option.(field),'choice')
                                match2 = 0;
                                arg2 = varg{i+1};
                                for j = option.(field).choice
                                    if (ischar(j{1}) && strcmpi(arg2,j)) || ...
                                       (not(ischar(j{1})) && isequal(arg2,j{1}))
                                            match2 = 1;
                                            i = i+1;
                                            optionvalue = arg2;
                                    end
                                end
                                if not(match2)
                                    if isfield(option.(field),'keydefault')
                                        optionvalue = option.(field).keydefault;
                                    else
                                        error(['SYNTAX ERROR IN ',func2str(method),...
                                            ': Unexpected keyword after key ',arg'.']);
                                    end
                                end
                            else
                                i = i+1;
                                optionvalue = varg{i};
                            end
                        elseif isfield(option.(field),'keydefault')
                            optionvalue = option.(field).keydefault;
                        elseif isfield(option.(field),'default')
                            optionvalue = option.(field).default;
                        else
                            error(['SYNTAX ERROR IN ',func2str(method),...
                                ': A string should follow the key ',arg'.']);
                        end
                    elseif strcmpi(type,'Boolean')
                        if length(varg) > i && (isnumeric(varg{i+1}) || islogical(varg{i+1}))
                            i = i+1;
                            optionvalue = varg{i};
                        elseif length(varg) > i && ischar(varg{i+1}) ...
                                && (strcmpi(varg{i+1},'on') || ...
                                    strcmpi(varg{i+1},'yes'))
                            i = i+1;
                            optionvalue = 1;
                        elseif length(varg) > i && ischar(varg{i+1}) ...
                                && (strcmpi(varg{i+1},'off') || ...
                                    strcmpi(varg{i+1},'no'))
                            i = i+1;
                            optionvalue = 0;
                        else
                            optionvalue = 1;
                        end
                    elseif strcmpi(type,'Integer') || strcmpi(type,'Integers')
                        if length(varg) > i && isnumeric(varg{i+1})
                            i = i+1;
                            optionvalue = varg{i};
                        elseif isfield(option.(field),'keydefault')
                            if strcmpi(type,'Integers')
                                optionvalue = option.(field).keydefault;
                            else
                                optionvalue = option.(field).keydefault(1);
                            end
                        elseif isfield(option.(field),'default')
                            if strcmpi(type,'Integers')
                                optionvalue = option.(field).default;
                            else
                                optionvalue = option.(field).default(1);
                            end
                        else
                            error(['SYNTAX ERROR IN ',func2str(method),...
                                ': An integer should follow the key ',arg'.']);
                        end
                        if isfield(option.(field),'number')...
                                && option.(field).number == 2
                            if length(varg) > i && isnumeric(varg{i+1})
                                i = i+1;
                                optionvalue = [optionvalue varg{i}];
                            elseif isfield(option.(field),'keydefault')
                                optionvalue = [optionvalue option.(field).keydefault(2)];
                            elseif isfield(option.(field),'default')
                                optionvalue = [optionvalue option.(field).default(2)];
                            else
                                error(['SYNTAX ERROR IN ',func2str(method),...
                                ': Two integers should follow the key ',arg'.']);
                            end
                        end
                        if not(isempty(unit))
                            if (strcmpi(unit{1},'s') || ...
                                strcmpi(unit{2},'s')) && ...
                               (strcmpi(unit{1},'Hz') || ...
                                strcmpi(unit{2},'Hz'))
                                if length(varg) > i && ...
                                   ischar(varg{i+1}) && ...
                                   (strcmpi(varg{i+1},'s') || ...
                                    strcmpi(varg{i+1},'Hz'))
                                    i = i+1;
                                    if not(strcmpi(varg{i},defaultunit))
                                        if isfield(option.(field),'opposite')
                                            field = option.(field).opposite;
                                        end
                                        optionvalue = 1/optionvalue;
                                    end
                                end
                            end
                            if (strcmpi(unit{1},'s') || ...
                                strcmpi(unit{2},'s')) && ...
                               (strcmpi(unit{1},'sp') || ...
                                strcmpi(unit{2},'sp'))
                                if length(varg) > i && ...
                                   ischar(varg{i+1}) && ...
                                   (strcmpi(varg{i+1},'sp') || ...
                                    strcmpi(varg{i+1},'s'))
                                    i = i+1;
                                    if strcmpi(varg{i},'sp')
                                        optionvalue = [optionvalue 0];
                                    else
                                        optionvalue = [optionvalue 1];
                                    end
                                else
                                    optionvalue = [optionvalue 1];
                                end
                            end
                        end
                        if not(isempty(from))
                            if length(varg) > i && ...
                               ischar(varg{i+1}) && ...
                               (strcmpi(varg{i+1},'Start') || ...
                                strcmpi(varg{i+1},'Middle') || ...
                                strcmpi(varg{i+1},'End'))
                                i = i+1;
                                if strcmpi(varg{i},'Start')
                                    optionvalue = [optionvalue 0];
                                elseif strcmpi(varg{i},'Middle')
                                    optionvalue = [optionvalue 1];
                                elseif strcmpi(varg{i},'End')
                                    optionvalue = [optionvalue 2];           
                                end
                            else
                                optionvalue = [optionvalue 0];
                            end
                            if isa(orig,'mirdesign')
                                orig = set(orig,'Size',optionvalue);
                            end
                        end
                    else
                        if length(varg) > i
                            i = i+1;
                            optionvalue = varg{i};
                        elseif isfield(option.(field),'keydefault')
                            optionvalue = option.(field).keydefault(1);
                        else
                            error(['SYNTAX ERROR IN ',func2str(method),...
                                ': Data should follow the key ',arg'.']);
                        end
                    end
                end
            else
                if isfield(option.(field),'choice')
                    for j = option.(field).choice
                        if strcmpi(arg,j)
                            match = 1;
                            optionvalue = arg;
                        end
                    end
                end
            end
            if not(match)
                if isfield(option.(field),'position')
                    if i+1 == option.(field).position
                        match = 1;
                        optionvalue = arg;
                    end
                %else
                %    error(['SYNTAX ERROR IN ',func2str(method),...
                %            ': Badly specified key ',arg'.']);
                end
            end
            if match == 1
                match = 2;
                if isfield(option.(field),'when') ...
                        && (strcmpi(option.(field).when,'After') || ...
                            strcmpi(option.(field).when,'Both'))
                    after.(field) = optionvalue;
                end
                if not(isfield(option.(field),'when')) ...
                        || strcmpi(option.(field).when,'Both')
                    during.(field) = optionvalue;
                end
            end
        end
        if not(match)
            if isnumeric(arg) || islogical(arg)
                arg = num2str(arg);
            end
            error(['SYNTAX ERROR IN ',func2str(method),...
                ': Unknown parameter ',arg'.']);
        end
    end    
    i = i+1;
end

Highlights from MIRtoolbox

Highlights from
MIRtoolbox