2 Copyright (C) 2003 Bob Ham <rah@bash.sh>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU Lesser General Public License as published by
6 the Free Software Foundation; either version 2.1 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU Lesser General Public License for more details.
14 You should have received a copy of the GNU Lesser General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 #ifndef __jack_driver_interface_h__
21 #define __jack_driver_interface_h__
29 #include <jack/jack.h>
31 #define JACK_DRIVER_NAME_MAX 15
32 #define JACK_DRIVER_PARAM_NAME_MAX 15
33 #define JACK_DRIVER_PARAM_STRING_MAX 63
36 /** Driver parameter types */
39 JackDriverParamInt
= 1,
42 JackDriverParamString
,
45 } jack_driver_param_type_t
;
47 /** Driver parameter value */
53 char str
[JACK_DRIVER_PARAM_STRING_MAX
+1];
54 } jack_driver_param_value_t
;
57 /** A driver parameter descriptor */
60 char name
[JACK_DRIVER_NAME_MAX
+1]; /**< The parameter's name */
61 char character
; /**< The parameter's character (for getopt, etc) */
62 jack_driver_param_type_t type
; /**< The parameter's type */
63 jack_driver_param_value_t value
; /**< The parameter's (default) value */
64 char short_desc
[64]; /**< A short (~30 chars) description for the user */
65 char long_desc
[1024]; /**< A longer description for the user */
67 } jack_driver_param_desc_t
;
69 /** A driver parameter */
73 jack_driver_param_value_t value
;
74 } jack_driver_param_t
;
77 /** A struct for describing a jack driver */
80 char name
[JACK_DRIVER_NAME_MAX
+1]; /**< The driver's canonical name */
81 char file
[PATH_MAX
+1]; /**< The filename of the driver's shared object file */
82 uint32_t nparams
; /**< The number of parameters the driver has */
83 jack_driver_param_desc_t
* params
; /**< An array of parameter descriptors */
94 #endif /* __jack_driver_interface_h__ */