common/JackControlAPI.h

   1 /*
   2   JACK control API
   3
   4   Copyright (C) 2008 Nedko Arnaudov
   5   Copyright (C) 2008 Grame
   6
   7   This program is free software; you can redistribute it and/or modify
   8   it under the terms of the GNU General Public License as published by
   9   the Free Software Foundation; version 2 of the License.
  10
  11   This program is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with this program; if not, write to the Free Software
  18   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19
  20 */
  21
  22 #ifndef __JackControlAPI__
  23 #define __JackControlAPI__
  24
  25 #include "jslist.h"
  26 #include "JackCompilerDeps.h"
  27
  28 /** Parameter types, intentionally similar to jack_driver_param_type_t */
  29 typedef enum
  30 {
  31     JackParamInt = 1,                   /**< @brief value type is a signed integer */
  32     JackParamUInt,                              /**< @brief value type is an unsigned integer */
  33     JackParamChar,                              /**< @brief value type is a char */
  34     JackParamString,                    /**< @brief value type is a string with max size of ::JACK_PARAM_STRING_MAX+1 chars */
  35     JackParamBool,                              /**< @brief value type is a boolean */
  36 } jackctl_param_type_t;
  37
  38 /** Driver types, intentionally similar to jack_driver_type_t */
  39 typedef enum
  40 {
  41     JackMaster = 1,         /**< @brief master driver */
  42     JackSlave,              /**< @brief slave driver */
  43 } jackctl_driver_type_t;
  44
  45 /** @brief Max value that jackctl_param_type_t type can have */
  46 #define JACK_PARAM_MAX (JackParamBool + 1)
  47
  48 /** @brief Max length of string parameter value, excluding terminating nul char */
  49 #define JACK_PARAM_STRING_MAX  127
  50
  51 /** @brief Type for parameter value */
  52 /* intentionally similar to jack_driver_param_value_t */
  53 union jackctl_parameter_value
  54 {
  55     uint32_t ui;                                /**< @brief member used for ::JackParamUInt */
  56     int32_t i;                                  /**< @brief member used for ::JackParamInt */
  57     char c;                                             /**< @brief member used for ::JackParamChar */
  58     char str[JACK_PARAM_STRING_MAX + 1]; /**< @brief member used for ::JackParamString */
  59     bool b;                             /**< @brief member used for ::JackParamBool */
  60 };
  61
  62 /** opaque type for server object */
  63 typedef struct jackctl_server jackctl_server_t;
  64
  65 /** opaque type for driver object */
  66 typedef struct jackctl_driver jackctl_driver_t;
  67
  68 /** opaque type for internal client object */
  69 typedef struct jackctl_internal jackctl_internal_t;
  70
  71 /** opaque type for parameter object */
  72 typedef struct jackctl_parameter jackctl_parameter_t;
  73
  74 /** opaque type for sigmask object */
  75 typedef struct jackctl_sigmask jackctl_sigmask_t;
  76
  77 #ifdef __cplusplus
  78 extern "C" {
  79 #endif
  80 #if 0
  81 } /* Adjust editor indent */
  82 #endif
  83
  84 SERVER_EXPORT jackctl_sigmask_t *
  85 jackctl_setup_signals(
  86     unsigned int flags);
  87
  88 SERVER_EXPORT void
  89 jackctl_wait_signals(
  90     jackctl_sigmask_t * signals);
  91
  92 SERVER_EXPORT jackctl_server_t *
  93 jackctl_server_create(
  94     bool (* on_device_acquire)(const char * device_name),
  95     void (* on_device_release)(const char * device_name));
  96
  97 SERVER_EXPORT void
  98 jackctl_server_destroy(
  99         jackctl_server_t * server);
 100
 101 SERVER_EXPORT const JSList *
 102 jackctl_server_get_drivers_list(
 103         jackctl_server_t * server);
 104
 105 SERVER_EXPORT bool
 106 jackctl_server_open(
 107     jackctl_server_t * server,
 108     jackctl_driver_t * driver);
 109
 110 SERVER_EXPORT bool
 111 jackctl_server_start(
 112     jackctl_server_t * server);
 113
 114 SERVER_EXPORT bool
 115 jackctl_server_stop(
 116     jackctl_server_t * server);
 117
 118 SERVER_EXPORT bool
 119 jackctl_server_close(
 120     jackctl_server_t * server);
 121
 122 SERVER_EXPORT const JSList *
 123 jackctl_server_get_parameters(
 124         jackctl_server_t * server);
 125
 126 SERVER_EXPORT const char *
 127 jackctl_driver_get_name(
 128         jackctl_driver_t * driver);
 129
 130 SERVER_EXPORT jackctl_driver_type_t
 131 jackctl_driver_get_type(
 132         jackctl_driver_t * driver);
 133
 134 SERVER_EXPORT const JSList *
 135 jackctl_driver_get_parameters(
 136         jackctl_driver_t * driver);
 137
 138 SERVER_EXPORT const char *
 139 jackctl_parameter_get_name(
 140         jackctl_parameter_t * parameter);
 141
 142 SERVER_EXPORT const char *
 143 jackctl_parameter_get_short_description(
 144         jackctl_parameter_t * parameter);
 145
 146 SERVER_EXPORT const char *
 147 jackctl_parameter_get_long_description(
 148         jackctl_parameter_t * parameter);
 149
 150 SERVER_EXPORT jackctl_param_type_t
 151 jackctl_parameter_get_type(
 152         jackctl_parameter_t * parameter);
 153
 154 SERVER_EXPORT char
 155 jackctl_parameter_get_id(
 156         jackctl_parameter_t * parameter);
 157
 158 SERVER_EXPORT bool
 159 jackctl_parameter_is_set(
 160         jackctl_parameter_t * parameter);
 161
 162 SERVER_EXPORT bool
 163 jackctl_parameter_reset(
 164         jackctl_parameter_t * parameter);
 165
 166 SERVER_EXPORT union jackctl_parameter_value
 167 jackctl_parameter_get_value(
 168         jackctl_parameter_t * parameter);
 169
 170 SERVER_EXPORT bool
 171 jackctl_parameter_set_value(
 172         jackctl_parameter_t * parameter,
 173         const union jackctl_parameter_value * value_ptr);
 174
 175 SERVER_EXPORT union jackctl_parameter_value
 176 jackctl_parameter_get_default_value(
 177         jackctl_parameter_t * parameter);
 178
 179 SERVER_EXPORT union jackctl_parameter_value
 180 jackctl_parameter_get_default_value(
 181     jackctl_parameter *parameter_ptr);
 182
 183 SERVER_EXPORT bool
 184 jackctl_parameter_has_range_constraint(
 185         jackctl_parameter_t * parameter_ptr);
 186
 187 SERVER_EXPORT bool
 188 jackctl_parameter_has_enum_constraint(
 189         jackctl_parameter_t * parameter_ptr);
 190
 191 SERVER_EXPORT uint32_t
 192 jackctl_parameter_get_enum_constraints_count(
 193         jackctl_parameter_t * parameter_ptr);
 194
 195 SERVER_EXPORT union jackctl_parameter_value
 196 jackctl_parameter_get_enum_constraint_value(
 197         jackctl_parameter_t * parameter_ptr,
 198         uint32_t index);
 199
 200 SERVER_EXPORT const char *
 201 jackctl_parameter_get_enum_constraint_description(
 202         jackctl_parameter_t * parameter_ptr,
 203         uint32_t index);
 204
 205 SERVER_EXPORT void
 206 jackctl_parameter_get_range_constraint(
 207         jackctl_parameter_t * parameter_ptr,
 208         union jackctl_parameter_value * min_ptr,
 209         union jackctl_parameter_value * max_ptr);
 210
 211 SERVER_EXPORT bool
 212 jackctl_parameter_constraint_is_strict(
 213         jackctl_parameter_t * parameter_ptr);
 214
 215 SERVER_EXPORT bool
 216 jackctl_parameter_constraint_is_fake_value(
 217         jackctl_parameter_t * parameter_ptr);
 218
 219 SERVER_EXPORT const JSList *
 220 jackctl_server_get_internals_list(
 221     jackctl_server *server_ptr);
 222
 223 SERVER_EXPORT const char *
 224 jackctl_internal_get_name(
 225     jackctl_internal *internal_ptr);
 226
 227 SERVER_EXPORT const JSList *
 228 jackctl_internal_get_parameters(
 229     jackctl_internal *internal_ptr);
 230
 231 SERVER_EXPORT bool jackctl_server_load_internal(
 232     jackctl_server * server,
 233     jackctl_internal * internal);
 234
 235 SERVER_EXPORT bool jackctl_server_unload_internal(
 236     jackctl_server * server,
 237     jackctl_internal * internal);
 238
 239 SERVER_EXPORT bool jackctl_server_add_slave(jackctl_server_t * server,
 240                             jackctl_driver_t * driver);
 241
 242 SERVER_EXPORT bool jackctl_server_remove_slave(jackctl_server_t * server,
 243                             jackctl_driver_t * driver);
 244
 245 SERVER_EXPORT bool
 246 jackctl_server_switch_master(jackctl_server_t * server,
 247                             jackctl_driver_t * driver);
 248
 249 SERVER_EXPORT int
 250 jackctl_parse_driver_params(jackctl_driver * driver_ptr, int argc, char* argv[]);
 251
 252 #if 0
 253 { /* Adjust editor indent */
 254 #endif
 255 #ifdef __cplusplus
 256 } /* extern "C" */
 257 #endif
 258
 259 #endif
 260