lavu/base64: extend/clarify doxy for the base64 API

Also improve overall consistency.
pull/8/head
Stefano Sabatini 12 years ago
parent 49a78e6b8c
commit 69d75dc4dd
  1. 12
      libavutil/base64.h

@ -46,15 +46,17 @@ int av_base64_decode(uint8_t *out, const char *in, int out_size);
* Encode data to base64 and null-terminate. * Encode data to base64 and null-terminate.
* *
* @param out buffer for encoded data * @param out buffer for encoded data
* @param out_size size in bytes of the output buffer, must be at * @param out_size size in bytes of the out buffer (including the
* least AV_BASE64_SIZE(in_size) * null terminator), must be at least AV_BASE64_SIZE(in_size)
* @param in_size size in bytes of the 'in' buffer * @param in input buffer containing the data to encode
* @return 'out' or NULL in case of error * @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); 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. * Calculate the output size needed to base64-encode x bytes to a
* null-terminated string.
*/ */
#define AV_BASE64_SIZE(x) (((x)+2) / 3 * 4 + 1) #define AV_BASE64_SIZE(x) (((x)+2) / 3 * 4 + 1)

Loading…
Cancel
Save