oggdec: Add documentation of output size constants.
authorAndre Noll <maan@tuebingen.mpg.de>
Wed, 1 Apr 2015 02:18:29 +0000 (02:18 +0000)
committerAndre Noll <maan@tuebingen.mpg.de>
Wed, 19 Aug 2015 19:47:19 +0000 (21:47 +0200)
The OGGDEC_MAX_OUTPUT_SIZE and OGGDEC_OUTPUT_CHUNK_SIZE defines in
oggdec_filter.c are undocumented. This commit adds comments for both which
explain the meaning of the two sizes.

oggdec_filter.c

index 11552cb..4b80135 100644 (file)
@@ -178,7 +178,15 @@ out:
        return ret;
 }
 
+/** Suspend decoding if output queue size is larger than that. */
 #define OGGDEC_MAX_OUTPUT_SIZE (96 * 1024)
+
+/**
+  * Allocate chunks of this size and produce at most one chunk of output per
+  * ->post_select() invocation. If the buffer could only be filled partially
+  * due to insufficient input being available, it is shrunk to the real output
+  * size and the resized buffer is fed into the output queue.
+  */
 #define OGGDEC_OUTPUT_CHUNK_SIZE (32 * 1024)
 
 static void ogg_pre_select(struct sched *s, void *context)