tom@516: % Copyright 2012, Google, Inc. dicklyon@523: % Author Richard F. Lyon tom@516: % tom@516: % This Matlab file is part of an implementation of Lyon's cochlear model: tom@516: % "Cascade of Asymmetric Resonators with Fast-Acting Compression" tom@516: % to supplement Lyon's upcoming book "Human and Machine Hearing" tom@516: % tom@516: % Licensed under the Apache License, Version 2.0 (the "License"); tom@516: % you may not use this file except in compliance with the License. tom@516: % You may obtain a copy of the License at tom@516: % tom@516: % http://www.apache.org/licenses/LICENSE-2.0 tom@516: % tom@516: % Unless required by applicable law or agreed to in writing, software tom@516: % distributed under the License is distributed on an "AS IS" BASIS, tom@516: % WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. tom@516: % See the License for the specific language governing permissions and tom@516: % limitations under the License. tom@516: dicklyon@563: function [CF, decim_naps, naps, BM, ohc, agc] = CARFAC_Run ... tom@516: (CF, input_waves, AGC_plot_fig_num) dicklyon@563: % function [CF, decim_naps, naps, BM, ohc, agc] = CARFAC_Run ... dicklyon@523: % (CF, input_waves, AGC_plot_fig_num) tom@516: % This function runs the CARFAC; that is, filters a 1 or more channel tom@516: % sound input to make one or more neural activity patterns (naps). tom@516: % tom@516: % The CF struct holds the filterbank design and state; if you want to tom@516: % break the input up into segments, you need to use the updated CF tom@516: % to keep the state between segments. tom@516: % tom@516: % input_waves is a column vector if there's just one audio channel; tom@516: % more generally, it has a row per time sample, a column per audio channel. tom@516: % tom@516: % naps has a row per time sample, a column per filterbank channel, and tom@516: % a layer per audio channel if more than 1. tom@516: % decim_naps is like naps but time-decimated by the int CF.decimation. tom@516: % tom@516: % the input_waves are assumed to be sampled at the same rate as the tom@516: % CARFAC is designed for; a resampling may be needed before calling this. tom@516: % dicklyon@563: % ohc and agc are optional extra outputs for diagnosing internals. tom@516: dicklyon@534: [n_samp, n_ears] = size(input_waves); tom@516: n_ch = CF.n_ch; tom@516: tom@516: if nargin < 3 tom@516: AGC_plot_fig_num = 0; tom@516: end tom@516: dicklyon@536: if nargout > 3 dicklyon@536: BM = zeros(n_samp, n_ch, n_ears); dicklyon@536: else dicklyon@536: BM = []; dicklyon@536: end dicklyon@536: dicklyon@563: if nargout > 4 dicklyon@563: ohc = zeros(n_samp, n_ch, n_ears); dicklyon@563: else dicklyon@563: ohc = []; dicklyon@563: end dicklyon@563: dicklyon@563: if nargout > 5 dicklyon@563: agc = zeros(n_samp, n_ch, n_ears); dicklyon@563: else dicklyon@563: agc = []; dicklyon@563: end dicklyon@563: dicklyon@534: if n_ears ~= CF.n_ears tom@516: error('bad number of input_waves channels passed to CARFAC_Run') tom@516: end tom@516: dicklyon@534: dicklyon@534: naps = zeros(n_samp, n_ch, n_ears); dicklyon@534: dicklyon@565: seglen = 441; % anything should work; this is 20 ms at default fs dicklyon@534: n_segs = ceil(n_samp / seglen); dicklyon@534: dicklyon@534: if nargout > 1 tom@516: % make decimated detect output: dicklyon@534: decim_naps = zeros(n_segs, CF.n_ch, CF.n_ears); tom@516: else tom@516: decim_naps = []; tom@516: end tom@516: dicklyon@534: if nargout > 2 dicklyon@534: % make decimated detect output: dicklyon@534: naps = zeros(n_samp, CF.n_ch, CF.n_ears); dicklyon@534: else dicklyon@534: naps = []; dicklyon@534: end tom@516: dicklyon@534: for seg_num = 1:n_segs dicklyon@534: if seg_num == n_segs dicklyon@534: % The last segement may be short of seglen, but do it anyway: dicklyon@534: k_range = (seglen*(seg_num - 1) + 1):n_samp; dicklyon@534: else dicklyon@534: k_range = seglen*(seg_num - 1) + (1:seglen); tom@516: end dicklyon@534: % Process a segment to get a slice of decim_naps, and plot AGC state: dicklyon@536: if ~isempty(BM) dicklyon@563: % ask for everything in this case, for laziness: dicklyon@563: [seg_naps, CF, seg_BM, seg_ohc, seg_agc] = CARFAC_Run_Segment(CF, input_waves(k_range, :)); dicklyon@536: else dicklyon@536: [seg_naps, CF] = CARFAC_Run_Segment(CF, input_waves(k_range, :)); dicklyon@536: end dicklyon@536: dicklyon@536: if ~isempty(BM) dicklyon@536: for ear = 1:n_ears dicklyon@536: % Accumulate segment BM to make full BM dicklyon@536: BM(k_range, :, ear) = seg_BM(:, :, ear); dicklyon@536: end dicklyon@536: end dicklyon@534: dicklyon@534: if ~isempty(naps) dicklyon@534: for ear = 1:n_ears dicklyon@534: % Accumulate segment naps to make full naps dicklyon@534: naps(k_range, :, ear) = seg_naps(:, :, ear); tom@516: end dicklyon@523: end dicklyon@523: dicklyon@563: if ~isempty(ohc) dicklyon@563: for ear = 1:n_ears dicklyon@563: % Accumulate segment naps to make full naps dicklyon@563: ohc(k_range, :, ear) = seg_ohc(:, :, ear); dicklyon@563: end dicklyon@563: end dicklyon@563: dicklyon@563: if ~isempty(agc) dicklyon@563: for ear = 1:n_ears dicklyon@563: % Accumulate segment naps to make full naps dicklyon@563: agc(k_range, :, ear) = seg_agc(:, :, ear); dicklyon@563: end dicklyon@563: end dicklyon@563: dicklyon@534: if ~isempty(decim_naps) dicklyon@534: for ear = 1:n_ears dicklyon@561: decim_naps(seg_num, :, ear) = CF.ears(ear).IHC_state.ihc_accum / seglen; dicklyon@561: CF.ears(ear).IHC_state.ihc_accum = zeros(n_ch,1); dicklyon@534: end tom@516: end dicklyon@523: dicklyon@534: if AGC_plot_fig_num dicklyon@523: figure(AGC_plot_fig_num); hold off; clf dicklyon@534: for ear = 1:n_ears dicklyon@561: maxes(ear) = max(CF.ears(ear).AGC_state.AGC_memory(:)); dicklyon@523: hold on dicklyon@537: for stage = 1:4; dicklyon@561: plot(2^(stage-1) * CF.ears(ear).AGC_state.AGC_memory(:, stage)); dicklyon@523: end dicklyon@523: end dicklyon@536: axis([0, CF.n_ch+1, 0.0, max(maxes) * 1.01 + 0.002]); dicklyon@523: drawnow dicklyon@523: end dicklyon@534: tom@516: end tom@516: dicklyon@534: dicklyon@534: