annotate aes.h @ 261:2ed59b450840 libavutil

Add Doxygen author and file description, rephrase a Doxygen comment.
author diego
date Tue, 27 Feb 2007 14:41:03 +0000
parents 998d097d926d
children 53126d45b095
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
201
921cee9e3a14 the missing header ...
michael
parents:
diff changeset
1 /*
921cee9e3a14 the missing header ...
michael
parents:
diff changeset
2 * copyright (c) 2007 Michael Niedermayer <michaelni@gmx.at>
921cee9e3a14 the missing header ...
michael
parents:
diff changeset
3 *
921cee9e3a14 the missing header ...
michael
parents:
diff changeset
4 * This file is part of FFmpeg.
921cee9e3a14 the missing header ...
michael
parents:
diff changeset
5 *
921cee9e3a14 the missing header ...
michael
parents:
diff changeset
6 * FFmpeg is free software; you can redistribute it and/or
921cee9e3a14 the missing header ...
michael
parents:
diff changeset
7 * modify it under the terms of the GNU Lesser General Public
921cee9e3a14 the missing header ...
michael
parents:
diff changeset
8 * License as published by the Free Software Foundation; either
921cee9e3a14 the missing header ...
michael
parents:
diff changeset
9 * version 2.1 of the License, or (at your option) any later version.
921cee9e3a14 the missing header ...
michael
parents:
diff changeset
10 *
921cee9e3a14 the missing header ...
michael
parents:
diff changeset
11 * FFmpeg is distributed in the hope that it will be useful,
921cee9e3a14 the missing header ...
michael
parents:
diff changeset
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
921cee9e3a14 the missing header ...
michael
parents:
diff changeset
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
921cee9e3a14 the missing header ...
michael
parents:
diff changeset
14 * Lesser General Public License for more details.
921cee9e3a14 the missing header ...
michael
parents:
diff changeset
15 *
921cee9e3a14 the missing header ...
michael
parents:
diff changeset
16 * You should have received a copy of the GNU Lesser General Public
921cee9e3a14 the missing header ...
michael
parents:
diff changeset
17 * License along with FFmpeg; if not, write to the Free Software
921cee9e3a14 the missing header ...
michael
parents:
diff changeset
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
921cee9e3a14 the missing header ...
michael
parents:
diff changeset
19 */
921cee9e3a14 the missing header ...
michael
parents:
diff changeset
20
921cee9e3a14 the missing header ...
michael
parents:
diff changeset
21 #ifndef AES_H
921cee9e3a14 the missing header ...
michael
parents:
diff changeset
22 #define AES_H
921cee9e3a14 the missing header ...
michael
parents:
diff changeset
23
206
cd7c6ff2132c remove dependancy on *malloc()
michael
parents: 202
diff changeset
24 extern const int av_aes_size;
cd7c6ff2132c remove dependancy on *malloc()
michael
parents: 202
diff changeset
25
201
921cee9e3a14 the missing header ...
michael
parents:
diff changeset
26 struct AVAES;
921cee9e3a14 the missing header ...
michael
parents:
diff changeset
27
202
f80912b7cb09 av_aes_init()
michael
parents: 201
diff changeset
28 /**
206
cd7c6ff2132c remove dependancy on *malloc()
michael
parents: 202
diff changeset
29 * initalizes a AVAES context
202
f80912b7cb09 av_aes_init()
michael
parents: 201
diff changeset
30 * @param key_bits 128, 192 or 256
f80912b7cb09 av_aes_init()
michael
parents: 201
diff changeset
31 * @param decrypt 0 for encryption, 1 for decryption
f80912b7cb09 av_aes_init()
michael
parents: 201
diff changeset
32 */
241
998d097d926d make key parameter const
bcoudurier
parents: 221
diff changeset
33 int av_aes_init(struct AVAES *a, const uint8_t *key, int key_bits, int decrypt);
202
f80912b7cb09 av_aes_init()
michael
parents: 201
diff changeset
34
217
10fffb98ff76 public API
michael
parents: 206
diff changeset
35 /**
10fffb98ff76 public API
michael
parents: 206
diff changeset
36 * encrypts / decrypts.
10fffb98ff76 public API
michael
parents: 206
diff changeset
37 * @param count number of 16 byte blocks
10fffb98ff76 public API
michael
parents: 206
diff changeset
38 * @param dst destination array, can be equal to src
10fffb98ff76 public API
michael
parents: 206
diff changeset
39 * @param src source array, can be equal to dst
10fffb98ff76 public API
michael
parents: 206
diff changeset
40 * @param iv initalization vector for CBC mode, if NULL then ECB will be used
10fffb98ff76 public API
michael
parents: 206
diff changeset
41 * @param decrypt 0 for encryption, 1 for decryption
10fffb98ff76 public API
michael
parents: 206
diff changeset
42 */
221
6ff860ccdcff 10l (aes_crypt -> av_aes_crypt)
michael
parents: 218
diff changeset
43 void av_aes_crypt(struct AVAES *a, uint8_t *dst, uint8_t *src, int count, uint8_t *iv, int decrypt);
217
10fffb98ff76 public API
michael
parents: 206
diff changeset
44
201
921cee9e3a14 the missing header ...
michael
parents:
diff changeset
45 #endif /* AES_H */