aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMax Kellermann <max@duempel.org>2008-11-02 16:58:45 +0100
committerMax Kellermann <max@duempel.org>2008-11-02 16:58:45 +0100
commit85b6ff7b594775276dcec85e8caf89d245476e47 (patch)
treecb67c63371df0cea6d254773d4c2f9cf9bb1ec54
parentb42dad9b054495d709d60646d98b7e015f9c374a (diff)
downloadmpd-85b6ff7b594775276dcec85e8caf89d245476e47.tar.gz
mpd-85b6ff7b594775276dcec85e8caf89d245476e47.tar.xz
mpd-85b6ff7b594775276dcec85e8caf89d245476e47.zip
music_pipe: document struct music_chunk
Add doxygen compatible comments.
-rw-r--r--src/pipe.h11
1 files changed, 11 insertions, 0 deletions
diff --git a/src/pipe.h b/src/pipe.h
index 4d57adc04..7d2912197 100644
--- a/src/pipe.h
+++ b/src/pipe.h
@@ -28,10 +28,21 @@
struct audio_format;
+/**
+ * A chunk of music data. Its format is defined by the
+ * music_pipe_append() caller.
+ */
struct music_chunk {
+ /** number of bytes stored in this chunk */
uint16_t length;
+
+ /** current bit rate of the source file */
uint16_t bit_rate;
+
+ /** the time stamp within the song */
float times;
+
+ /** the data (probably PCM) */
char data[CHUNK_SIZE];
};