function amtstart(varargin)
%AMTSTART   Start the Auditory Modeling Toolbox
%   Usage:  amtstart;
%           amtstart(flags);
%
%   AMTSTART starts the Auditory Modeling Toolbox. This command must be
%   run before using any of the function in the AMT.
%
%   Requirements
%   ------------
%
%   The AMT depends on the Linear Time Frequency Analysis Toolbox (*LTFAT*). 
%   Download LTFAT from <http://ltfat.sourceforge.net/> and unpack the downloaded file. 
%   In the AMT, there is a prepared directory thirdparty/ltfat
%   where the LTFAT can be stored and automatically recognized by the AMT. 
%   Alternatively, save the LTFAT anywhere and add the main LTFAT path to the search path.
%
%   In order to run all the AMT functionality:
%   
%   1) install the SOFA API version >= 1.0 from <http://sourceforge.net/projects/sofacoustics>.
%      In the AMT, there is a prepared directory thirdparty/SOFA. Alternatively, save 
%      the SOFA API anywhere and add the path to the search path. 
%
%   2) install SFS Toolbox version >= 1.0 from <https://github.com/sfstoolbox/sfs>. 
%      In the AMT, there is a prepared directory thirdparty/sfs. Alternatively, save 
%      the SOFA API anywhere and add the path to the search path. 
%
%   3) install Python (version >= 2.6), and the packages numpy and scipi. 
%      On Linux, sudo apt-get install python-scipy python-numpy can be applied.
%      On Windows, intall python from <https://www.python.org/>, add python.exe to path,
%      and install the packages separately.
%
%   4) run amtmex to compile some models. You will need a compiler working in your 
%      Matlab/Octave environment (see help mex).
%
%   5) in the directory src/verhulst, run make (Linux) or make.bat (Windows).
%      You will need gcc (see <https://gcc.gnu.org/>) installed and 
%      available at the command line.
%   
%   6) have the Optimization Toolbox for Matlab installed.
%
% 
%   Supplementary files:
%   --------------------
% 
%   Most of the models require auxiliary data. The AMT will download these data on-demand. 
%   The download URL for the auxiliary data is given by amtauxdataurl. 
%   The target directory for the auxiliary data is given by amtauxdatapath. 
%   If you want to run the AMT offline, download the auxiliary data first. 
%
%   Some of the models require HRTFs. The AMT will download the HRTFs on-demand.
%   The download URL for the HRTFs is given by SOFAdbURL.
%   The target directory for the HRTFs is given by SOFAdbPath. 
%   If you want to run the AMT offline, download the HRTFs first. 
%
%   Global flags:
%   -------------
%
%   AMT uses cache to store precalculated results because some of the AMT functions 
%   require large processing time. Depending on the machine and the model, it might take 
%   even days. The global cache mode is controlled on start-up of the AMT. To change the 
%   global cache mode choose a flags:
%
%     'normal'      Use cached package as far as possible. This is default. 
%                   This is kind of demonstration mode and very convenient 
%                   for fast access of results like plotting figures.
%                   This option, however, may by-pass the actual processing and thus 
%                   does not always test the actual functionality of a model. 
%                   If the cached package locally not available, downloaded from the internet. 
%                   If remotely not available, enforce recalculation.
% 
%     'cached'      Enforce to use cached package. If the cached package is 
%                   locally not available, it will be downloaded from the internet. 
%                   If it is remotely not available, an error will be thrown.
% 
%     'redo'        Enforce the recalculation of the package. This option
%                   actually tests the calculations.
% 
%     'localonly'   Package will be recalculated when locally
%                   not available. Do not connect to the internet. 
% 
%   Many AMT functions support the cache mode as input flag in order to 
%   overwrite the global cache mode. See AMTCACHE for more details.
%
%
%   The output of the messages to the command line can be controlled by one
%   of the following flags:
%
%     'verbose'        All output will be displayed. This is default. 
% 
%     'documentation'  starts the AMT in the documentation compiling
%                      mode. The output of calculation progress will be suppressed.
% 
%     'silent'         All output will be suppressed.
% 
%
%   See also:  amtmex amtflags amtload amtcache
%
%
%   Url: http://amtoolbox.sourceforge.net/amt-0.9.7/doc/amtstart.php

% Copyright (C) 2009-2015 Piotr Majdak and Peter L. Søndergaard.
% This file is part of AMToolbox version 0.9.7
%
% 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/>.
  
%   AUTHOR : Piotr Majdak, Peter L. Soendergaard


%% Start AMT
bp=amtbasepath;

% Load the version number
[FID, MSG] = fopen ([bp,'amtoolbox_version'],'r');
if FID == -1
    error(MSG);
else
    amt_version = fgetl (FID);
    fclose(FID);
end

% Check if 'silent' present in the flags
silent=0;
if isoctave, args=argv; else args=varargin; end
 for ii=1:numel(args)
   s=lower(args{ii});
   if strcmp(s,'silent') || strcmp(s,'-q')
     silent=1;
   end;
 end;
% end;


if ~silent
  disp('  ');
  disp(['AMT version ',amt_version,'. (C) Piotr Majdak and Peter L. Soendergaard.']);
  disp('  ');
  disp('Starting toolboxes...');
end;

%% LTFAT package

% Search for LTAFT package
basepath=which('amtstart');
basepath=basepath(1:end-11);
if ~exist('ltfatstart','file')
  ltfatpath=fullfile(basepath,'thirdparty','ltfat');
  if exist(ltfatpath,'dir')
    addpath(ltfatpath);
  end
end

% Start LTFAT
% if ~silent, disp('*** Starting LTFAT ***'); end
if exist('ltfatstart','file')
  if silent, ltfatstart(0); else ltfatstart; end;
else
  error(['LTFAT package could not be found. Unable to continue.' 10 ...
        'Download LTFAT from http://ltfat.sourceforge.net ' 10 ...
        'and copy to amtoolbox/thirdparty/ltfat.']); 
end

% Check for the correct version. 
s=ltfathelp('version'); 
s_r='2.0.0'; % set the required version
v=sscanf(s,'%d.%d.%d'); v(4)=0;
v_r=sscanf(s_r,'%d.%d.%d');
if ~(v(1)>v_r(1) || (v(1)>=v_r(1) && v(2)>v_r(2)) || (v(1)>=v_r(1) && v(2)>=v_r(2) && v(3)>=v_r(3)) ),
    error(['You need LTFAT >= ' s_r ' to work with AMT. ' ...
      'Please update your package from http://ltfat.sourceforge.net ']);
end
    
%% SOFA package

% Search for SOFA package
basepath=which('amtstart');
basepath=basepath(1:end-11);
if ~exist('SOFAstart','file')
  sofapath=fullfile(basepath,'thirdparty','SOFA','API_MO');
  if exist(sofapath,'dir')
    addpath(sofapath);
  end
end

% Start SOFA
if exist('SOFAstart','file')
  SOFAdbPath(fullfile(basepath,'hrtf'));
  SOFAdbURL('http://www.sofacoustics.org/data'); % This is a default path and will be overwritten later
  if silent, SOFAstart('silent'); else SOFAstart('short'); end
	warning('off','SOFA:upgrade');	% disable warning on upgrading older SOFA files
	warning('off','SOFA:load'); % disable warnings on loading SOFA files
else
  if ~silent,
  disp('SOFA package could not be found. Continue without SOFA support.');
  disp(['For SOFA support please download the package ' ...
        'from http://sofacoustics.sourceforge.net ' ...
        'and copy to amtoolbox/thirdparty/SOFA.']); 
  end
end

%% SFS package

% Search for the package
basepath=which('amtstart');
basepath=basepath(1:end-11);
if ~exist('SFS_start','file')
  sfspath=fullfile(basepath,'thirdparty','sfs');
  if exist(sfspath,'dir')
    addpath(sfspath);
  end
end

% Delete rms.m from the SFS package because of naming conflict
sfspath=fileparts(which('SFS_start.m'));
if exist(fullfile(sfspath,'SFS_general','rms.m'),'file'),
	delete(fullfile(sfspath,'SFS_general','rms.m'));
end

% Start 
% if ~silent, disp('*** Starting SFS ***'); end
if exist('SFS_start','file')
  SFS_start;
  s=SFS_version; s_r='1.0.0'; % set the required version
  if ~silent, disp(['Sound Field Synthesis Toolbox, version ' s]); end
  v=sscanf(s,'%d.%d.%d'); v(4)=0;
  v_r=sscanf(s_r,'%d.%d.%d');
  if ~(v(1)>v_r(1) || (v(1)>=v_r(1) && v(2)>v_r(2)) || (v(1)>=v_r(1) && v(2)>=v_r(2) && v(3)>=v_r(3)) ),
      error(['You need SFS >= ' s_r ' to work with AMT. ' ...
        'Please update your package from https://github.com/sfstoolbox/sfs ']);
  end  
	
elseif ~silent, 
  disp('SFS package could not be found. Continue without SFS support.');
  disp(['For SFS support please download the package ' ...
        'from https://github.com/sfstoolbox/sfs ' ...
        'and copy to amtoolbox/thirdparty/sfs.']); 
end

%% Install AMT modules
% A directory called DIRNAME containing a file 'DIRNAMEinit.m' is
% considered as a module. 
% DIRNAMEinit.m must set the variable 'status' with the following value:
%  0: disabled module, don't add to the search path
%  >0: add to the search path.

% add root of the AMT to the path
addpath(basepath);

modules={};
nplug=0;

% List all files in base directory
d=dir(basepath);

for ii=1:length(d)
  if d(ii).isdir
    if ~(d(ii).name(1)=='.')      
      % The file is a directory and it does not start with '.' This could be a module      
      name=d(ii).name;
      if exist([bp,name,filesep,name,'init.m'],'file')
          % Set 'status' to zero if the module forgets to define it.
        status=0;
        module_version=amt_version;
        addpath([bp,name]);

        eval([name,'init']);
        if status>0
          if status==1
            nplug=nplug+1;
            modules{nplug}.name=name;
            modules{nplug}.version=module_version;
          end;
        else
          rmpath([bp,name]);
        end;
      end;	

    end;
  end;
end;

%% define default start-up behaviour
flags=amtflags(varargin); % amtdisp and other amt-related functions work now!

%% ---------- load information into ltfathelp ------------

% As comp is now in the path, we can call ltfatarghelper
ltfatsetdefaults('amthelp','versiondata',amt_version,...
                 'modulesdata',modules);

%% Set the correct path to remote HRTFs
if exist('SOFAdbURL','file'),
    SOFAdbURL(['http://www.sofacoustics.org/data/amt-' amthelp('version') '/hrtf']);
end

%% Initialize aux data, cache, and display starting information
amtdisp('  ');
% amtdisp('  ');
amtdisp('AMT configuration:'); 
amtdisp(['  Auxiliary data (local): ' amtauxdatapath]);
amtdisp(['  Auxiliary data (web): ' amtauxdataurl]);
if strcmp(flags.cachemode,'global'), flags.cachemode='normal'; end
amtcache('setMode',flags.cachemode);
switch flags.cachemode
  case 'normal'
    amtdisp('  Cache mode: Download precalculated results. Examples:');
    amtdisp('              exp_model(...)        shows precalculated results');
    amtdisp('              exp_model(...,''redo'') enforces recalculation');
  case 'localonly'
    amtdisp('  Cache mode: Use local cache or recalculate. Do not connect to remote cache.');
  case 'cached'
    amtdisp('  Cache mode: Use cache or throw error. Do not recalcalculate.');
  case 'redo'
    amtdisp('  Cache mode: Recalculate always (be patient!).');
end
amtdisp(' ');
amtdisp('Type "help amtstart" for more details...');