Changeset c799138 in mainline for uspace/srv/audio/hound/audio_data.h

Timestamp:

2013-04-11T01:34:41Z (12 years ago)

Author:

Jan Vesely <jano.vesely@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

250828a

Parents:

f0a647c

Message:

hound: doxygen and cleanup

File:

• uspace/srv/audio/hound/audio_data.h (modified) (4 diffs)

uspace/srv/audio/hound/audio_data.h

@@ -43 +43 @@
 #include <pcm/format.h>
 
+/** Reference counted audio buffer */
 typedef struct {
+        /** Audio data */
         const void *data;
+        /** Size of the buffer pointer to by data */
         size_t size;
+        /** Format of the audio data */
         pcm_format_t format;
+        /** Reference counter */
         atomic_t refcount;
 } audio_data_t;
 
+/** Audio data pipe structure */
 typedef struct {
+        /** List of audio data buffers */
         list_t list;
+        /** Total size of all buffers */
         size_t bytes;
+        /** Total frames stored in all buffers */
         size_t frames;
+        /** List access synchronization */
         fibril_mutex_t guard;
 } audio_pipe_t;
@@ -71 +81 @@
     const pcm_format_t *f);
 
+/**
+ * Total bytes getter.
+ * @param pipe The audio pipe.
+ * @return Total size of buffer stored in the pipe.
+ */
 static inline size_t audio_pipe_bytes(audio_pipe_t *pipe)
 {
@@ -77 +92 @@
 }
 
+/**
+ * Total bytes getter.
+ * @param pipe The audio pipe.
+ * @return Total number of frames stored in the pipe.
+ */
 static inline size_t audio_pipe_frames(audio_pipe_t *pipe)
 {
@@ -83 +103 @@
 }
 
+/**
+ * Push data form buffer directly to pipe.
+ * @param pipe The target pipe.
+ * @param data audio buffer.
+ * @param size size of the @p data buffer
+ * @param f format of the audio data.
+ * @return Error code.
+ *
+ * Reference counted buffer is created automatically.
+ */
 static inline int audio_pipe_push_data(audio_pipe_t *pipe,
     const void *data, size_t size, pcm_format_t f)