aboutsummaryrefslogtreecommitdiffstats
path: root/src/output_internal.h
diff options
context:
space:
mode:
authorMax Kellermann <max@duempel.org>2008-09-24 07:21:46 +0200
committerMax Kellermann <max@duempel.org>2008-09-24 07:21:46 +0200
commit08352184ac887fd37510ddb46aedaec1c99fcd44 (patch)
tree334475e1b63d4de374c0a6d1cf9c28126264fcd9 /src/output_internal.h
parentacc4a0ba2dd0be3f28c4ca009e08d1cc1bbc534a (diff)
downloadmpd-08352184ac887fd37510ddb46aedaec1c99fcd44.tar.gz
mpd-08352184ac887fd37510ddb46aedaec1c99fcd44.tar.xz
mpd-08352184ac887fd37510ddb46aedaec1c99fcd44.zip
output: document the audio_output elements
Diffstat (limited to 'src/output_internal.h')
-rw-r--r--src/output_internal.h62
1 files changed, 58 insertions, 4 deletions
diff --git a/src/output_internal.h b/src/output_internal.h
index 25094f6fb..5c11a9521 100644
--- a/src/output_internal.h
+++ b/src/output_internal.h
@@ -24,22 +24,70 @@
#include "notify.h"
struct audio_output {
- int open;
+ /**
+ * The device's configured display name.
+ */
const char *name;
+ /**
+ * The plugin which implements this output device.
+ */
const struct audio_output_plugin *plugin;
- int convertAudioFormat;
+ /**
+ * The plugin's internal data. It is passed to every plugin
+ * method.
+ */
+ void *data;
+
+ /**
+ * Is the device (already) open and functional?
+ */
+ int open;
+
+ /**
+ * The audio_format in which audio data is received from the
+ * player thread (which in turn receives it from the decoder).
+ */
struct audio_format inAudioFormat;
+
+ /**
+ * The audio_format which is really sent to the device. This
+ * is basically reqAudioFormat (if configured) or
+ * inAudioFormat, but may have been modified by
+ * plugin->open().
+ */
struct audio_format outAudioFormat;
+
+ /**
+ * The audio_format which was configured. Only set if
+ * convertAudioFormat is true.
+ */
struct audio_format reqAudioFormat;
+
ConvState convState;
char *convBuffer;
size_t convBufferLen;
+ /**
+ * The thread handle, or "0" if the output thread isn't
+ * running.
+ */
pthread_t thread;
+
+ /**
+ * Notify object for the thread.
+ */
struct notify notify;
+
+ /**
+ * The next command to be performed by the output thread.
+ */
enum audio_output_command command;
+
+ /**
+ * Command arguments, depending on the command.
+ */
union {
struct {
const char *data;
@@ -48,11 +96,17 @@ struct audio_output {
const struct tag *tag;
} args;
- int result;
- void *data;
+ /**
+ * Result value of the command. Generally, "0" means success.
+ */
+ int result;
};
+/**
+ * Notify object used by the thread's client, i.e. we will send a
+ * notify signal to this object, expecting the caller to wait on it.
+ */
extern struct notify audio_output_client_notify;
#endif