%% -*- mode: octave -*-
%%
%% *SpHEAR Project
%%
%% sphear_fir_render_directions: plot frequency response of FIR filter A2B matrix for principal
%%                               and diagonal directions
%%
%% usage:
%%   [] = sphear_fir_render_directions(FIR, fmin, fmax, ymin, ymax, Fs, Nfft, plot_on, smooth)
%%
%% FIR: A2B matrix of FIR filters
%% fmin, fmax: range of frequencies to use
%% ymin, ymax: vertical scale for plot
%% Fs: sampling rate
%% Nfft: size of FFT
%%
%% optional parameters:
%%
%% plot_on: plot frequency response of components, default is "epsc"
%%          can be one of 0, "eps", "epsc" (color), "png", "pngc" (color)
%% smooth: number of samples to average, default is 0
%%
%% Copyright 2016, Fernando Lopez-Lezcano, All Rights Reserved
%% nando@ccrma.stanford.edu
%%
%%  This program is free software: you can redistribute it and/or modify
%%  it under the terms of the GNU General Public License as published by
%%  the Free Software Foundation, either version 3 of the License, or
%%  (at your option) any later version.
%%
%%  This program is distributed in the hope that it will be useful,
%%  but WITHOUT ANY WARRANTY; without even the implied warranty of
%%  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
%%  GNU General Public License for more details.
%%
%%  You should have received a copy of the GNU General Public License
%%  along with this program.  If not, see <http://www.gnu.org/licenses/>.

function [BFF] = sphear_fir_render_directions(FIR, fmin, fmax, ymin, ymax, Fs, Nfft, plot_on, smooth)

  %% no smoothing or plotting by default
  if (!exist("smooth"))
    smooth = 0;
  end
  if (!exist("plot_on"))
    plot_on = "epsc";
  else
    if (plot_on == 1)
      plot_on = "epsc"
    end
  end

  %% plot if requested
  if (plot_on != 0)
    if (strcmp(plot_on, "epsc") || strcmp(plot_on, "pngc"))
      %% color plot
      wopts = 'k;W;';
      xopts = 'r;X;';
      yopts = 'b;Y;';
      copt = '-color';
      cext = "_color";
    else
      %% mono plot
      wopts = '-';
      xopts = '--';
      yopts = ':';
      copt = '-mono';
      cext = "_mono";
    end
    f = figure;
    hold on;
    grid on;
    axis([fmin, fmax, ymin, ymax]);
    tics('y', [6, 3, 0, -3, -6, -9, -12, -15, -20, -25, -30]);
    tics('x', [300, 500, 1000, 2000, 3000, 5000, 7000, 10000, 15000, 20000]);
    ca=get (gcf, "currentaxes");
    set(ca,"fontweight","bold","linewidth",1.5)

    %% measurements, first four in cardinal directions
    measurements = [1, 5, 9, 13, 3, 7, 11, 15];

    %% which components to plot, we ommit the ones that are nulled
    %% 0: do not plot, 1: cardinal, 2: diagonal plot
    m_W = [1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0];
    m_X = [1, 0, 2, 0, 0, 0, 2, 0, 1, 0, 2, 0, 0, 0, 2, 0];
    m_Y = [0, 0, 2, 0, 1, 0, 2, 0, 0, 0, 2, 0, 1, 0, 2, 0];
    m_Z = [1, 0, 2, 0, 1, 0, 2, 0, 1, 0, 2, 0, 1, 0, 2, 0];

    W_offset = +0;
    X_offset = -3;
    Y_offset = -3;
    idx = 1;
    for m = measurements
      %% render b format components
      bf(idx,:,:) = sphear_a_to_b(m, FIR, Nfft);

      %% calculate B format frequency responses
      for b = 1:4
	if (smooth > 0)
	  bfft(idx,b,:) = fastsmooth(10*log10(abs(fft(bf(idx,b,:), Nfft))), smooth, 2, 1)(1:end/2);
	else
	  bfft(idx,b,:) = 10*log10(abs(fft(bf(idx,b,:), Nfft)))(1:end/2);
	end
      end
      fr = (1:Nfft/2) * Fs/Nfft;

      fft_avg = mean(bfft(1,1,round(end/4):round(end/2)));
      %%fft_avg = 0.0;

      for b = 1:4
	if (m_W(m) > 0 && b == 1)
	  if (m_W(m) > 1)
	    pW = semilogx(fr, bfft(idx,b,:) - fft_avg + W_offset, wopts, "linewidth", 1.5, "linestyle", "--");
	  else
	    pW = semilogx(fr, bfft(idx,b,:) - fft_avg + W_offset, wopts, "linewidth", 1.5);
	  end
	end
	if (m_X(m) > 0 && b == 2)
	  if (m_X(m) > 1)
	    pXd = semilogx(fr, bfft(idx,b,:) - fft_avg + X_offset, xopts, "linewidth", 1.5, "linestyle", "--");
	  else
	    pXp = semilogx(fr, bfft(idx,b,:) - fft_avg + X_offset, xopts, "linewidth", 1.5);
	  end
	end
	if (m_Y(m) > 0 && b == 3)
	  if (m_Y(m) > 1)
	    pYd = semilogx(fr, bfft(idx,b,:) - fft_avg + Y_offset, yopts, "linewidth", 1.5, "linestyle", "--");
	  else
	    pYp = semilogx(fr, bfft(idx,b,:) - fft_avg + Y_offset, yopts, "linewidth", 1.5);
	  end
	end
      end

      idx = idx + 1;
    end
    l = legend([pW, pXp, pXd, pYp, pYd],
	       {sprintf("W principal directions (%.1fdB offset)", W_offset),
		sprintf("X principal directions (%.1fdB offset)", X_offset),
		sprintf("X diagonal directions (%.1fdB offset)", Y_offset),
		sprintf("Y principal directions (%.1fdB offset)", X_offset),
		sprintf("Y diagonal directions (%.1fdB offset)", Y_offset),
	       });
    legend(l, 'location', 'southwest');
    if (strcmp(plot_on, 'eps') || strcmp(plot_on, 'epsc') || plot_on == 1)
      print(f, '-deps', '-tight', '-S1920,1080', copt,["../figures/sphear_directions.eps"]);
    else
      print(f, '-deps', copt, ["../figures/sphear_directions.eps"]);
    end

  end
end