Changeset 5a6f362 in mainline

Timestamp:

2013-04-04T15:39:00Z (12 years ago)

Author:

Jan Vesely <jano.vesely@…>

Branches:

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

Children:

5029c788

Parents:

76ea1b7

Message:

libpcm: Add doxygen

File:

• uspace/lib/pcm/src/format.c (modified) (5 diffs)

uspace/lib/pcm/src/format.c

@@ -90 +90 @@
     unsigned frame, unsigned channel, const pcm_format_t *f);
 
+/**
+ * Compare PCM format attribtues.
+ * @param a Format description.
+ * @param b Format description.
+ * @return True if a and b describe the same format, false otherwise.
+ */
 bool pcm_format_same(const pcm_format_t *a, const pcm_format_t* b)
 {
@@ -100 +106 @@
 }
 
+/**
+ * Fill audio buffer with silence in the specified format.
+ * @param dst Destination audio buffer.
+ * @param size Size of the destination audio buffer.
+ * @param f Pointer to the format description.
+ */
 void pcm_format_silence(void *dst, size_t size, const pcm_format_t *f)
 {
@@ -146 +158 @@
 }
 
+/**
+ * Mix audio data of the same format and size.
+ * @param dst Destination buffer
+ * @param src Source buffer
+ * @param size Size of both the destination and the source buffer
+ * @param f Pointer to the format descriptor.
+ * @return Error code.
+ */
 int pcm_format_mix(void *dst, const void *src, size_t size, const pcm_format_t *f)
 {
         return pcm_format_convert_and_mix(dst, size, src, size, f, f);
 }
+
+/**
+ * Add and mix audio data.
+ * @param dst Destination audio buffer
+ * @param dst_size Size of the destination buffer
+ * @param src Source audio buffer
+ * @param src_size Size of the source buffer.
+ * @param sf Pointer to the source format descriptor.
+ * @param df Pointer to the destination format descriptor.
+ * @return Error code.
+ *
+ * Buffers must contain entire frames. Destination buffer is always filled.
+ * If there are not enough data in the source buffer silent data is assumed.
+ */
 int pcm_format_convert_and_mix(void *dst, size_t dst_size, const void *src,
     size_t src_size, const pcm_format_t *sf, const pcm_format_t *df)
@@ -160 +194 @@
 
         const size_t dst_frame_size = pcm_format_frame_size(df);
-        if ((src_size % dst_frame_size) != 0)
+        if ((dst_size % dst_frame_size) != 0)
                 return EINVAL;
 
@@ -226 +260 @@
 }
 
-/** Converts all sample formats to float <-1,1> */
+/**
+ * Converts all sample formats to float <-1,1>
+ * @param buffer Audio data
+ * @param size Size of the buffer
+ * @param frame Index of the frame to read
+ * @param channel Channel within the frame
+ * @param f Pointer to a format descriptor
+ * @return Normalized sample <-1,1>, 0.0 if the data could not be read
+ */
 static float get_normalized_sample(const void *buffer, size_t size,
     unsigned frame, unsigned channel, const pcm_format_t *f)