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         /**
  29          * return a SearchPath containing directories in which to look for
  30          * backend plugins.
  31          *
  32          * If ARDOUR_BACKEND_PATH is defined then the SearchPath returned
  33          * will contain only those directories specified in it, otherwise it will
  34          * contain the user and system directories which may contain audio/MIDI
  35          * backends.
  36          */
  37         LIBARDOUR_API PBD::Searchpath backend_search_path ();
  38
  39         /**
  40          * return a Searchpath containing directories in which to look for
  41          * control surface plugins.
  42          *
  43          * If ARDOUR_SURFACES_PATH is defined then the Searchpath returned
  44          * will contain only those directories specified in it, otherwise it will
  45          * contain the user and system directories which may contain control
  46          * surface plugins.
  47          */
  48         LIBARDOUR_API PBD::Searchpath control_protocol_search_path ();
  49
  50         /**
  51          * return a Searchpath containing directories in which to look for
  52          * export_formats.
  53          */
  54         LIBARDOUR_API PBD::Searchpath export_formats_search_path ();
  55
  56 } // namespace ARDOUR
  57
  58 #endif /* __libardour_search_paths_h__ */