chiark / gitweb /
Apply the remains of Ross's patch to build on Ubuntu 8.10.
[disorder] / lib / mixer.h
index 99fbef2b7957318261b9cb92bf8135fadd4dce9c..3d4224647d212465c7326cb905b07e5c609d63c8 100644 (file)
@@ -1,36 +1,62 @@
 /*
  * This file is part of DisOrder
- * Copyright (C) 2004 Richard Kettlewell
+ * Copyright (C) 2004, 2007 Richard Kettlewell
  *
- * This program is free software; you can redistribute it and/or modify
+ * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * General Public License for more details.
- *
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+/** @file lib/mixer.h
+ * @brief Mixer support
  */
 
 #ifndef MIXER_H
 #define MIXER_H
 
-int mixer_channel(const char *c);
-/* convert @c@ to a channel number, or return -1 if it does not match */
+/** @brief Definition of a mixer */
+struct mixer {
+  /** @brief API used by this mixer */
+  int api;
 
-int mixer_control(int *left, int *right, int set);
-/* get/set the current level.  If @set@ is true then the level is set
- * according to the pointers.  In either case the eventual level is
- * returned via the pointers.
- *
- * Returns 0 on success and -1 on error.
- */
+  /** @brief Get the volume
+   * @param left Where to store left-channel volume
+   * @param right Where to store right-channel volume
+   * @return 0 on success, non-0 on error
+   */
+  int (*get)(int *left, int *right);
+
+  /** @brief Set the volume
+   * @param left Pointer to target left-channel volume
+   * @param right Pointer to target right-channel volume
+   * @return 0 on success, non-0 on error
+   *
+   * @p left and @p right are updated with the actual volume set.
+   */
+  int (*set)(int *left, int *right);
+
+  /** @brief Default device */
+  const char *device;
+
+  /** @brief Default channel */
+  const char *channel;
+};
+
+int mixer_control(int api, int *left, int *right, int set);
+const char *mixer_default_device(int api);
+const char *mixer_default_channel(int api);
+int mixer_supported(int api);
+
+extern const struct mixer mixer_oss;
+extern const struct mixer mixer_alsa;
 
 #endif /* MIXER_H */
 
@@ -40,4 +66,3 @@ c-basic-offset:2
 comment-column:40
 End:
 */
-/* arch-tag:d70a8b1bc1e79efcad02d20259246454 */