From f7d08514924dde111733086e560d5da454151986 Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Wed, 1 Apr 2015 02:18:29 +0000 Subject: [PATCH 1/1] oggdec: Add documentation of output size constants. 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 | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/oggdec_filter.c b/oggdec_filter.c index 11552cbb..4b801356 100644 --- a/oggdec_filter.c +++ b/oggdec_filter.c @@ -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) -- 2.39.2