summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTanu Kaskinen <tanuk@iki.fi>2018-09-04 19:29:55 +0300
committerLuiz Augusto von Dentz <luiz.von.dentz@intel.com>2018-09-11 11:06:17 +0300
commitf7412ee508a154ed7b882dfd32a37b583f6341ef (patch)
treed1ae55cf8aa9c423a327d8ecbcc96f9f377fbb5f
parentb3ae4260da118e53f5e6c195d40788273ff3d0b4 (diff)
downloadsbc-f7412ee508a154ed7b882dfd32a37b583f6341ef.tar.gz
sbc: fix frame_length and codesize documentation
frame_length is the output block size when encoding and the input block size when decoding, with codesize it's vice versa. The documentation was inaccurate regarding this. Using the terms "compressed" and "uncompressed" instead of "output" and "input" should make the function semantics clear.
-rw-r--r--sbc/sbc.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/sbc/sbc.h b/sbc/sbc.h
index d6f123e..835460a 100644
--- a/sbc/sbc.h
+++ b/sbc/sbc.h
@@ -100,13 +100,13 @@ ssize_t sbc_decode(sbc_t *sbc, const void *input, size_t input_len,
ssize_t sbc_encode(sbc_t *sbc, const void *input, size_t input_len,
void *output, size_t output_len, ssize_t *written);
-/* Returns the output block size in bytes */
+/* Returns the compressed block size in bytes */
size_t sbc_get_frame_length(sbc_t *sbc);
/* Returns the time one input/output block takes to play in msec*/
unsigned sbc_get_frame_duration(sbc_t *sbc);
-/* Returns the input block size in bytes */
+/* Returns the uncompressed block size in bytes */
size_t sbc_get_codesize(sbc_t *sbc);
const char *sbc_get_implementation_info(sbc_t *sbc);