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 "ardour/libardour_visibility.h"
  25
  26 #include "pbd/search_path.h"
  27
  28 namespace ARDOUR {
  29
  30         LIBARDOUR_API const char *vst_search_path ();
  31
  32         /**
  33          * return a SearchPath containing directories in which to look for
  34          * backend plugins.
  35          *
  36          * If ARDOUR_BACKEND_PATH is defined then the SearchPath returned
  37          * will contain only those directories specified in it, otherwise it will
  38          * contain the user and system directories which may contain audio/MIDI
  39          * backends.
  40          */
  41         LIBARDOUR_API PBD::Searchpath backend_search_path ();
  42
  43         /**
  44          * return a Searchpath containing directories in which to look for
  45          * control surface plugins.
  46          *
  47          * If ARDOUR_SURFACES_PATH is defined then the Searchpath returned
  48          * will contain only those directories specified in it, otherwise it will
  49          * contain the user and system directories which may contain control
  50          * surface plugins.
  51          */
  52         LIBARDOUR_API PBD::Searchpath control_protocol_search_path ();
  53
  54         /**
  55          * return a Searchpath containing directories in which to look for
  56          * export_formats.
  57          */
  58         LIBARDOUR_API PBD::Searchpath export_formats_search_path ();
  59
  60         /**
  61          * return a Searchpath containing directories in which to look for
  62          * LADSPA plugins.
  63          *
  64          * If LADSPA_PATH is defined then the Searchpath returned
  65          * will contain the directories specified in it as well as the
  66          * user and system directories.
  67          */
  68         LIBARDOUR_API PBD::Searchpath ladspa_search_path ();
  69
  70         /**
  71          * return a Searchpath containing directories in which to look for
  72          * lv2 plugins.
  73          */
  74         LIBARDOUR_API PBD::Searchpath lv2_bundled_search_path ();
  75
  76         /**
  77          * return a Searchpath containing directories in which to look for
  78          * MIDI patch files ("*.midnam") aka MIDNAM files
  79          *
  80          * If ARDOUR_MIDI_PATCH_PATH is defined then the Searchpath returned
  81          * will contain only those directories specified in it, otherwise it will
  82          * contain the user and system directories.
  83          */
  84         LIBARDOUR_API PBD::Searchpath midi_patch_search_path ();
  85
  86         /**
  87          * return a Searchpath containing directories in which to look for
  88          * theme files.
  89          *
  90          * If ARDOUR_THEMES_PATH is defined then the Searchpath returned
  91          * will contain only those directories specified in it, otherwise it will
  92          * contain the user and system directories
  93          */
  94         LIBARDOUR_API PBD::Searchpath theme_search_path ();
  95
  96
  97         /**
  98          * return a Searchpath containing directories in which to look for
  99          * panner plugins.
 100          *
 101          * If ARDOUR_PANNER_PATH is defined then the Searchpath returned
 102          * will contain only those directories specified in it, otherwise it will
 103          * contain the user and system directories which may contain panner
 104          * plugins.
 105          */
 106         LIBARDOUR_API PBD::Searchpath panner_search_path ();
 107
 108         /**
 109          * return a Searchpath containing directories in which to look for
 110          * route templates.
 111          */
 112         LIBARDOUR_API PBD::Searchpath route_template_search_path ();
 113
 114         /**
 115          * return a Searchpath containing directories in which to look for
 116          * other templates.
 117          */
 118         LIBARDOUR_API PBD::Searchpath template_search_path ();
 119
 120
 121         /**
 122          * return a Searchpath containing directories in which to look for
 123          * lua scripts
 124          */
 125         LIBARDOUR_API PBD::Searchpath lua_search_path ();
 126
 127
 128 } // namespace ARDOUR
 129
 130 #endif /* __libardour_search_paths_h__ */