Changeset c799138 in mainline for uspace/srv/audio/hound/audio_sink.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_sink.h (modified) (2 diffs)

uspace/srv/audio/hound/audio_sink.h

@@ -47 +47 @@
 typedef struct audio_sink audio_sink_t;
 
+/** Audio sink abstraction structure */
 struct audio_sink {
+        /** Link in hound's sink list */
         link_t link;
+        /** List of all related connections */
         list_t connections;
+        /** Sink's name */
         const char *name;
+        /** Consumes data in this format */
         pcm_format_t format;
+        /** Backend data */
         void *private_data;
+        /** Connect/disconnect callback */
         int (*connection_change)(audio_sink_t *, bool);
+        /** Backend callback to check data */
         int (*check_format)(audio_sink_t *);
 };
 
+/**
+ * List instance helper.
+ * @param l link
+ * @return pointer to a sink structure, NULL on failure.
+ */
 static inline audio_sink_t * audio_sink_list_instance(link_t *l)
 {
@@ -65 +78 @@
     void *private_data, int (*connection_change)(audio_sink_t *, bool),
     int (*check_format)(audio_sink_t *), const pcm_format_t *f);
+
 void audio_sink_fini(audio_sink_t *sink);
-
 int audio_sink_set_format(audio_sink_t *sink, const pcm_format_t *format);
-//int audio_sink_add_source(audio_sink_t *sink, audio_source_t *source);
-//int audio_sink_remove_source(audio_sink_t *sink, audio_source_t *source);
 void audio_sink_mix_inputs(audio_sink_t *sink, void* dest, size_t size);
 
-
 #endif
-
 /**
  * @}
  */
-