common/driver_interface.h

   1 /*
   2   Copyright (C) 2003 Bob Ham <rah@bash.sh>
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19
  20 #ifndef __jack_driver_interface_h__
  21 #define __jack_driver_interface_h__
  22
  23 #ifdef __cplusplus
  24 extern "C"
  25 {
  26 #endif
  27
  28 #include <limits.h>
  29
  30 #ifdef WIN32
  31 #include "types.h"
  32 #define PATH_MAX 1024
  33 #else
  34 #include <inttypes.h>
  35 #endif
  36
  37
  38 #define JACK_DRIVER_NAME_MAX          15
  39 #define JACK_DRIVER_PARAM_NAME_MAX    15
  40 #define JACK_DRIVER_PARAM_STRING_MAX  63
  41
  42     /** Driver parameter types */
  43     typedef enum
  44     {
  45         JackDriverParamInt = 1,
  46         JackDriverParamUInt,
  47         JackDriverParamChar,
  48         JackDriverParamString,
  49         JackDriverParamBool
  50     } jack_driver_param_type_t;
  51
  52     /** Driver parameter value */
  53     typedef union
  54     {
  55         uint32_t ui;
  56         int32_t i;
  57         char c;
  58         char str[JACK_DRIVER_PARAM_STRING_MAX + 1];
  59     } jack_driver_param_value_t;
  60
  61
  62     /** A driver parameter descriptor */
  63     typedef struct {
  64         char name[JACK_DRIVER_NAME_MAX + 1]; /**< The parameter's name */
  65         char character;                    /**< The parameter's character (for getopt, etc) */
  66         jack_driver_param_type_t type;     /**< The parameter's type */
  67         jack_driver_param_value_t value;   /**< The parameter's (default) value */
  68         char short_desc[64];               /**< A short (~30 chars) description for the user */
  69         char long_desc[1024];              /**< A longer description for the user */
  70     }
  71     jack_driver_param_desc_t;
  72
  73     /** A driver parameter */
  74     typedef struct {
  75         char character;
  76         jack_driver_param_value_t value;
  77     }
  78     jack_driver_param_t;
  79
  80
  81     /** A struct for describing a jack driver */
  82     typedef struct {
  83         char name[JACK_DRIVER_NAME_MAX + 1];        /**< The driver's canonical name */
  84         char file[PATH_MAX + 1];                    /**< The filename of the driver's shared object file */
  85         uint32_t nparams;                         /**< The number of parameters the driver has */
  86         jack_driver_param_desc_t * params;        /**< An array of parameter descriptors */
  87     }
  88     jack_driver_desc_t;
  89
  90
  91 #ifdef __cplusplus
  92 }
  93 #endif
  94
  95 #endif /* __jack_driver_interface_h__ */
  96
  97