annotate base64.h @ 713:2f9c4e9ae095 libavutil

Use a wildcard match instead of a list to remove test programs. This is robust against renames and also removes test programs not (yet) hooked up in the main Makefiles.
author diego
date Thu, 26 Mar 2009 10:12:21 +0000
parents 396c27769b0e
children 4f98a323598c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
244
9a977b2c7069 Move base64.[ch] to libavutil.
diego
parents:
diff changeset
1 /*
9a977b2c7069 Move base64.[ch] to libavutil.
diego
parents:
diff changeset
2 * Copyright (c) 2006 Ryan Martell. (rdm4@martellventures.com)
9a977b2c7069 Move base64.[ch] to libavutil.
diego
parents:
diff changeset
3 *
9a977b2c7069 Move base64.[ch] to libavutil.
diego
parents:
diff changeset
4 * This file is part of FFmpeg.
9a977b2c7069 Move base64.[ch] to libavutil.
diego
parents:
diff changeset
5 *
9a977b2c7069 Move base64.[ch] to libavutil.
diego
parents:
diff changeset
6 * FFmpeg is free software; you can redistribute it and/or
9a977b2c7069 Move base64.[ch] to libavutil.
diego
parents:
diff changeset
7 * modify it under the terms of the GNU Lesser General Public
9a977b2c7069 Move base64.[ch] to libavutil.
diego
parents:
diff changeset
8 * License as published by the Free Software Foundation; either
9a977b2c7069 Move base64.[ch] to libavutil.
diego
parents:
diff changeset
9 * version 2.1 of the License, or (at your option) any later version.
9a977b2c7069 Move base64.[ch] to libavutil.
diego
parents:
diff changeset
10 *
9a977b2c7069 Move base64.[ch] to libavutil.
diego
parents:
diff changeset
11 * FFmpeg is distributed in the hope that it will be useful,
9a977b2c7069 Move base64.[ch] to libavutil.
diego
parents:
diff changeset
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9a977b2c7069 Move base64.[ch] to libavutil.
diego
parents:
diff changeset
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
9a977b2c7069 Move base64.[ch] to libavutil.
diego
parents:
diff changeset
14 * Lesser General Public License for more details.
9a977b2c7069 Move base64.[ch] to libavutil.
diego
parents:
diff changeset
15 *
9a977b2c7069 Move base64.[ch] to libavutil.
diego
parents:
diff changeset
16 * You should have received a copy of the GNU Lesser General Public
9a977b2c7069 Move base64.[ch] to libavutil.
diego
parents:
diff changeset
17 * License along with FFmpeg; if not, write to the Free Software
9a977b2c7069 Move base64.[ch] to libavutil.
diego
parents:
diff changeset
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
9a977b2c7069 Move base64.[ch] to libavutil.
diego
parents:
diff changeset
19 */
9a977b2c7069 Move base64.[ch] to libavutil.
diego
parents:
diff changeset
20
567
bd4052d9050c Globally rename the header inclusion guard names.
stefano
parents: 397
diff changeset
21 #ifndef AVUTIL_BASE64_H
bd4052d9050c Globally rename the header inclusion guard names.
stefano
parents: 397
diff changeset
22 #define AVUTIL_BASE64_H
344
580fffa86f08 add multiple inclusion guards to headers
mru
parents: 343
diff changeset
23
343
f21d1907d47c include all prerequisites in header files
mru
parents: 320
diff changeset
24 #include <stdint.h>
f21d1907d47c include all prerequisites in header files
mru
parents: 320
diff changeset
25
244
9a977b2c7069 Move base64.[ch] to libavutil.
diego
parents:
diff changeset
26 /**
660
396c27769b0e Document the av_base64_encode/decode functions.
stefano
parents: 659
diff changeset
27 * Decodes the base64-encoded string in \p in and puts the decoded
396c27769b0e Document the av_base64_encode/decode functions.
stefano
parents: 659
diff changeset
28 * data in \p out.
396c27769b0e Document the av_base64_encode/decode functions.
stefano
parents: 659
diff changeset
29 *
396c27769b0e Document the av_base64_encode/decode functions.
stefano
parents: 659
diff changeset
30 * @param out_size size in bytes of the \p out buffer, it should be at
396c27769b0e Document the av_base64_encode/decode functions.
stefano
parents: 659
diff changeset
31 * least 3/4 of the length of \p in
396c27769b0e Document the av_base64_encode/decode functions.
stefano
parents: 659
diff changeset
32 * @return the number of bytes written, or a negative value in case of
396c27769b0e Document the av_base64_encode/decode functions.
stefano
parents: 659
diff changeset
33 * error
244
9a977b2c7069 Move base64.[ch] to libavutil.
diego
parents:
diff changeset
34 */
659
d3cd35bec3d0 Cosmetics: "* out" -> "*out" for consistency with the other
stefano
parents: 658
diff changeset
35 int av_base64_decode(uint8_t *out, const char *in, int out_size);
244
9a977b2c7069 Move base64.[ch] to libavutil.
diego
parents:
diff changeset
36
9a977b2c7069 Move base64.[ch] to libavutil.
diego
parents:
diff changeset
37 /**
660
396c27769b0e Document the av_base64_encode/decode functions.
stefano
parents: 659
diff changeset
38 * Encodes in base64 the data in \p in and puts the resulting string
396c27769b0e Document the av_base64_encode/decode functions.
stefano
parents: 659
diff changeset
39 * in \p out.
396c27769b0e Document the av_base64_encode/decode functions.
stefano
parents: 659
diff changeset
40 *
396c27769b0e Document the av_base64_encode/decode functions.
stefano
parents: 659
diff changeset
41 * @param out_size size in bytes of the \p out string, it should be at
396c27769b0e Document the av_base64_encode/decode functions.
stefano
parents: 659
diff changeset
42 * least ((\p in_size + 2) / 3) * 4 + 1
396c27769b0e Document the av_base64_encode/decode functions.
stefano
parents: 659
diff changeset
43 * @param in_size size in bytes of the \p in buffer
396c27769b0e Document the av_base64_encode/decode functions.
stefano
parents: 659
diff changeset
44 * @return the string containing the encoded data, or NULL in case of
396c27769b0e Document the av_base64_encode/decode functions.
stefano
parents: 659
diff changeset
45 * error
244
9a977b2c7069 Move base64.[ch] to libavutil.
diego
parents:
diff changeset
46 */
658
cc7c1ea68a52 Cosmetics: rename the "size" parameter of av_base64_encode() to "in_size".
stefano
parents: 657
diff changeset
47 char *av_base64_encode(char *out, int out_size, const uint8_t *in, int in_size);
244
9a977b2c7069 Move base64.[ch] to libavutil.
diego
parents:
diff changeset
48
567
bd4052d9050c Globally rename the header inclusion guard names.
stefano
parents: 397
diff changeset
49 #endif /* AVUTIL_BASE64_H */