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 3 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,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU 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, see <http://www.gnu.org/licenses/>.
  17  */
  18 /** @file lib/mixer.h
  19  * @brief Mixer support
  20  */
  21
  22 #ifndef MIXER_H
  23 #define MIXER_H
  24
  25 /** @brief Definition of a mixer */
  26 struct mixer {
  27   /** @brief API used by this mixer */
  28   int api;
  29
  30   /** @brief Get the volume
  31    * @param left Where to store left-channel volume
  32    * @param right Where to store right-channel volume
  33    * @return 0 on success, non-0 on error
  34    */
  35   int (*get)(int *left, int *right);
  36
  37   /** @brief Set the volume
  38    * @param left Pointer to target left-channel volume
  39    * @param right Pointer to target right-channel volume
  40    * @return 0 on success, non-0 on error
  41    *
  42    * @p left and @p right are updated with the actual volume set.
  43    */
  44   int (*set)(int *left, int *right);
  45
  46   /** @brief Default device */
  47   const char *device;
  48
  49   /** @brief Default channel */
  50   const char *channel;
  51 };
  52
  53 int mixer_control(int api, int *left, int *right, int set);
  54 const char *mixer_default_device(int api);
  55 const char *mixer_default_channel(int api);
  56 int mixer_supported(int api);
  57
  58 extern const struct mixer mixer_oss;
  59 extern const struct mixer mixer_alsa;
  60
  61 #endif /* MIXER_H */
  62
  63 /*
  64 Local Variables:
  65 c-basic-offset:2
  66 comment-column:40
  67 End:
  68 */