lavfi: fix avfilter_get_audio_buffer() doxy to match reality.

[ffmpeg] / libavutil / base64.h

diff --git a/libavutil/base64.h b/libavutil/base64.h
index 5552e30fe2b90aeb4ad9d8d9eaa9e1e90e356ce1..092980b09388cff64445bd7498b1e9f173580b3f 100644 (file)
--- a/libavutil/base64.h
+++ b/libavutil/base64.h
@@ -24,16 +24,31 @@
 #include <stdint.h>
 
 /**
- * Decodes Base64.
- * Parameter order is the same as strncpy().
+ * Decode a base64-encoded string.
+ *
+ * @param out      buffer for decoded data
+ * @param in       null-terminated input string
+ * @param out_size size in bytes of the out buffer, must be at
+ *                 least 3/4 of the length of in
+ * @return         number of bytes written, or a negative value in case of
+ *                 invalid input
  */
-int av_base64_decode(uint8_t * out, const char *in, int out_size);
+int av_base64_decode(uint8_t *out, const char *in, int out_size);
 
 /**
- * Encodes Base64.
- * @param src data, not a string
- * @param buf output string
+ * Encode data to base64 and null-terminate.
+ *
+ * @param out      buffer for encoded data
+ * @param out_size size in bytes of the output buffer, must be at
+ *                 least AV_BASE64_SIZE(in_size)
+ * @param in_size  size in bytes of the 'in' buffer
+ * @return         'out' or NULL in case of error
  */
 char *av_base64_encode(char *out, int out_size, const uint8_t *in, int in_size);
 
+/**
+ * Calculate the output size needed to base64-encode x bytes.
+ */
+#define AV_BASE64_SIZE(x)  (((x)+2) / 3 * 4 + 1)
+
 #endif /* AVUTIL_BASE64_H */