pixfmt: remove misleading and broken documentation
[ffmpeg.git] / libavutil / aes.h
1 /*
2  * copyright (c) 2007 Michael Niedermayer <michaelni@gmx.at>
3  *
4  * This file is part of Libav.
5  *
6  * Libav is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * Libav is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with Libav; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 #ifndef AVUTIL_AES_H
22 #define AVUTIL_AES_H
23
24 #include <stdint.h>
25
26 #include "attributes.h"
27 #include "version.h"
28
29 /**
30  * @defgroup lavu_aes AES
31  * @ingroup lavu_crypto
32  * @{
33  */
34
35 #if FF_API_CONTEXT_SIZE
36 extern attribute_deprecated const int av_aes_size;
37 #endif
38
39 struct AVAES;
40
41 /**
42  * Allocate an AVAES context.
43  */
44 struct AVAES *av_aes_alloc(void);
45
46 /**
47  * Initialize an AVAES context.
48  * @param key_bits 128, 192 or 256
49  * @param decrypt 0 for encryption, 1 for decryption
50  */
51 int av_aes_init(struct AVAES *a, const uint8_t *key, int key_bits, int decrypt);
52
53 /**
54  * Encrypt or decrypt a buffer using a previously initialized context.
55  * @param count number of 16 byte blocks
56  * @param dst destination array, can be equal to src
57  * @param src source array, can be equal to dst
58  * @param iv initialization vector for CBC mode, if NULL then ECB will be used
59  * @param decrypt 0 for encryption, 1 for decryption
60  */
61 void av_aes_crypt(struct AVAES *a, uint8_t *dst, const uint8_t *src, int count, uint8_t *iv, int decrypt);
62
63 /**
64  * @}
65  */
66
67 #endif /* AVUTIL_AES_H */