Merge branch 'master' into next
[paraslash.git] / mix.h
diff --git a/mix.h b/mix.h
index a410554..cad435e 100644 (file)
--- a/mix.h
+++ b/mix.h
@@ -1,3 +1,7 @@
+/* Copyright (C) 2012 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
+
+/** \file mix.h Mixer API for para_mixer. */
+
 /**
  * Opaque structure which corresponds to an instance of a mixer.
  *
@@ -8,10 +12,14 @@ struct mixer_handle;
 
 /**
  * Operations provided by each mixer plugin.
+ *
+ * Each mixer plugin must define a non-static instance of this structure, with
+ * all pointers initialized to non-NULL values. No other symbols need to be
+ * exported.
  */
 struct mixer {
-       /** Called on startup, must fill in all other members. */
-       void (*init)(struct mixer *self);
+       /** Used to identify the mixer. */
+       const char * const name;
        /** Return a handle that can be passed to other methods. */
        int (*open)(const char *dev, struct mixer_handle **handle);
        /** Returns a string of all valid mixer channels. */
@@ -23,6 +31,9 @@ struct mixer {
        int (*get)(struct mixer_handle *handle);
        /** Change the value of the selected channel. */
        int (*set)(struct mixer_handle *handle, int val);
-       /** Free all ressources associated with the given handle. */
+       /** Free all resources associated with the given handle. */
        void (*close)(struct mixer_handle **handle);
 };
+
+/** Declared even if unsupported because it does not hurt and avoids ifdefs. */
+extern const struct mixer alsa_mixer, oss_mixer;