libs/ardour/ardour/search_paths.h

   1 /*
   2     Copyright (C) 2011 Tim Mayberry
   3     Copyright (C) 2013 Paul Davis
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 */
  20
  21 #ifndef __libardour_search_paths_h__
  22 #define __libardour_search_paths_h__
  23
  24 #include "pbd/search_path.h"
  25
  26 namespace ARDOUR {
  27
  28         LIBARDOUR_API const char *vst_search_path ();
  29
  30         /**
  31          * return a SearchPath containing directories in which to look for
  32          * backend plugins.
  33          *
  34          * If ARDOUR_BACKEND_PATH is defined then the SearchPath returned
  35          * will contain only those directories specified in it, otherwise it will
  36          * contain the user and system directories which may contain audio/MIDI
  37          * backends.
  38          */
  39         LIBARDOUR_API PBD::Searchpath backend_search_path ();
  40
  41         /**
  42          * return a Searchpath containing directories in which to look for
  43          * control surface plugins.
  44          *
  45          * If ARDOUR_SURFACES_PATH is defined then the Searchpath returned
  46          * will contain only those directories specified in it, otherwise it will
  47          * contain the user and system directories which may contain control
  48          * surface plugins.
  49          */
  50         LIBARDOUR_API PBD::Searchpath control_protocol_search_path ();
  51
  52         /**
  53          * return a Searchpath containing directories in which to look for
  54          * export_formats.
  55          */
  56         LIBARDOUR_API PBD::Searchpath export_formats_search_path ();
  57
  58         /**
  59          * return a Searchpath containing directories in which to look for
  60          * LADSPA plugins.
  61          *
  62          * If LADSPA_PATH is defined then the Searchpath returned
  63          * will contain the directories specified in it as well as the
  64          * user and system directories.
  65          */
  66         LIBARDOUR_API PBD::Searchpath ladspa_search_path ();
  67
  68         /**
  69          * return a Searchpath containing directories in which to look for
  70          * lv2 plugins.
  71          */
  72         LIBARDOUR_API PBD::Searchpath lv2_bundled_search_path ();
  73
  74         /**
  75          * return a Searchpath containing directories in which to look for
  76          * MIDI patch files ("*.midnam") aka MIDNAM files
  77          *
  78          * If ARDOUR_MIDI_PATCH_PATH is defined then the Searchpath returned
  79          * will contain only those directories specified in it, otherwise it will
  80          * contain the user and system directories which may contain control
  81          * surface plugins.
  82          */
  83         LIBARDOUR_API PBD::Searchpath midi_patch_search_path ();
  84
  85         /**
  86          * return a Searchpath containing directories in which to look for
  87          * panner plugins.
  88          *
  89          * If ARDOUR_PANNER_PATH is defined then the Searchpath returned
  90          * will contain only those directories specified in it, otherwise it will
  91          * contain the user and system directories which may contain control
  92          * surface plugins.
  93          */
  94         LIBARDOUR_API PBD::Searchpath panner_search_path ();
  95
  96         /**
  97          * return a Searchpath containing directories in which to look for
  98          * route templates.
  99          */
 100         LIBARDOUR_API PBD::Searchpath route_template_search_path ();
 101
 102         /**
 103          * return a Searchpath containing directories in which to look for
 104          * other templates.
 105          */
 106         LIBARDOUR_API PBD::Searchpath template_search_path ();
 107
 108 } // namespace ARDOUR
 109
 110 #endif /* __libardour_search_paths_h__ */