summaryrefslogtreecommitdiff
path: root/libs/ardour/ardour/search_paths.h
blob: f280e5dd3f6d73c8c2d4075b9cc89b1ab2f5cbca (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/*
    Copyright (C) 2011 Tim Mayberry
    Copyright (C) 2013 Paul Davis

    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 2 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, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#ifndef __libardour_search_paths_h__
#define __libardour_search_paths_h__

#include "ardour/libardour_visibility.h"

#include "pbd/search_path.h"

namespace ARDOUR {

	LIBARDOUR_API const char *vst_search_path ();

	/**
	 * return a SearchPath containing directories in which to look for
	 * backend plugins.
	 *
	 * If ARDOUR_BACKEND_PATH is defined then the SearchPath returned
	 * will contain only those directories specified in it, otherwise it will
	 * contain the user and system directories which may contain audio/MIDI
	 * backends.
	 */
	LIBARDOUR_API PBD::Searchpath backend_search_path ();

	/**
	 * return a Searchpath containing directories in which to look for
	 * control surface plugins.
	 *
	 * If ARDOUR_SURFACES_PATH is defined then the Searchpath returned
	 * will contain only those directories specified in it, otherwise it will
	 * contain the user and system directories which may contain control
	 * surface plugins.
	 */
	LIBARDOUR_API PBD::Searchpath control_protocol_search_path ();

	/**
	 * return a Searchpath containing directories in which to look for
	 * export_formats.
	 */
	LIBARDOUR_API PBD::Searchpath export_formats_search_path ();

	/**
	 * return a Searchpath containing directories in which to look for
	 * LADSPA plugins.
	 *
	 * If LADSPA_PATH is defined then the Searchpath returned
	 * will contain the directories specified in it as well as the
	 * user and system directories.
	 */
	LIBARDOUR_API PBD::Searchpath ladspa_search_path ();

	/**
	 * return a Searchpath containing directories in which to look for
	 * lv2 plugins.
	 */
	LIBARDOUR_API PBD::Searchpath lv2_bundled_search_path ();

	/**
	 * return a Searchpath containing directories in which to look for
	 * MIDI patch files ("*.midnam") aka MIDNAM files
	 *
	 * If ARDOUR_MIDI_PATCH_PATH is defined then the Searchpath returned
	 * will contain only those directories specified in it, otherwise it will
	 * contain the user and system directories.
	 */
	LIBARDOUR_API PBD::Searchpath midi_patch_search_path ();

	/**
	 * return a Searchpath containing directories in which to look for
	 * theme files.
	 *
	 * If ARDOUR_THEMES_PATH is defined then the Searchpath returned
	 * will contain only those directories specified in it, otherwise it will
	 * contain the user and system directories
	 */
	LIBARDOUR_API PBD::Searchpath theme_search_path ();


	/**
	 * return a Searchpath containing directories in which to look for
	 * panner plugins.
	 *
	 * If ARDOUR_PANNER_PATH is defined then the Searchpath returned
	 * will contain only those directories specified in it, otherwise it will
	 * contain the user and system directories which may contain panner
	 * plugins.
	 */
	LIBARDOUR_API PBD::Searchpath panner_search_path ();

	/**
	 * return a Searchpath containing directories in which to look for
	 * route templates.
	 */
	LIBARDOUR_API PBD::Searchpath route_template_search_path ();

	/**
	 * return a Searchpath containing directories in which to look for
	 * other templates.
	 */
	LIBARDOUR_API PBD::Searchpath template_search_path ();


	/**
	 * return a Searchpath containing directories in which to look for
	 * lua scripts
	 */
	LIBARDOUR_API PBD::Searchpath lua_search_path ();


} // namespace ARDOUR

#endif /* __libardour_search_paths_h__ */