chiark - git - mdw - disorder/blob - lib/mixer.h

   1 /*
   2  * This file is part of DisOrder
   3  * Copyright (C) 2004, 2007 Richard Kettlewell
   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, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  18  * USA
  19  */
  20
  21 #ifndef MIXER_H
  22 #define MIXER_H
  23
  24 /** @brief Definition of a mixer */
  25 struct mixer {
  26   /** @brief API used by this mixer */
  27   int api;
  28
  29   /** @brief Return non-0 iff @p d is a valid device name */
  30   int (*validate_device)(const char *d);
  31
  32   /** @brief Return non-0 iff @p c is a valid channel name */
  33   int (*validate_channel)(const char *c);
  34
  35   /** @brief Get the volume
  36    * @param left Where to store left-channel volume
  37    * @param right Where to store right-channel volume
  38    * @return 0 on success, non-0 on error
  39    */
  40   int (*get)(int *left, int *right);
  41
  42   /** @brief Set the volume
  43    * @param left Pointer to target left-channel volume
  44    * @param right Pointer to target right-channel volume
  45    * @return 0 on success, non-0 on error
  46    *
  47    * @p left and @p right are updated with the actual volume set.
  48    */
  49   int (*set)(int *left, int *right);
  50
  51   /** @brief Default device */
  52   const char *device;
  53
  54   /** @brief Default channel */
  55   const char *channel;
  56 };
  57
  58 int mixer_valid_device(int api, const char *d);
  59 int mixer_valid_channel(int api, const char *c);
  60 int mixer_control(int *left, int *right, int set);
  61 const char *mixer_default_device(int api);
  62 const char *mixer_default_channel(int api);
  63
  64 extern const struct mixer mixer_oss;
  65
  66 #endif /* MIXER_H */
  67
  68 /*
  69 Local Variables:
  70 c-basic-offset:2
  71 comment-column:40
  72 End:
  73 */