Merge commit 'ae365453c370c85f278bff7fbf9e20d9d335cb2a'
[ffmpeg.git] / libavutil / rc4.h
1 /*
2  * RC4 encryption/decryption/pseudo-random number generator
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg 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  * FFmpeg 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 FFmpeg; 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_RC4_H
22 #define AVUTIL_RC4_H
23
24 #include <stdint.h>
25 #include "version.h"
26
27 /**
28  * @defgroup lavu_rc4 RC4
29  * @ingroup lavu_crypto
30  * @{
31  */
32
33 #if FF_API_CRYPTO_CONTEXT
34 typedef struct AVRC4 {
35     uint8_t state[256];
36     int x, y;
37 } AVRC4;
38 #else
39 typedef struct AVRC4 AVRC4;
40 #endif
41
42 /**
43  * Allocate an AVRC4 context.
44  */
45 AVRC4 *av_rc4_alloc(void);
46
47 /**
48  * @brief Initializes an AVRC4 context.
49  *
50  * @param key_bits must be a multiple of 8
51  * @param decrypt 0 for encryption, 1 for decryption, currently has no effect
52  */
53 int av_rc4_init(struct AVRC4 *d, const uint8_t *key, int key_bits, int decrypt);
54
55 /**
56  * @brief Encrypts / decrypts using the RC4 algorithm.
57  *
58  * @param count number of bytes
59  * @param dst destination array, can be equal to src
60  * @param src source array, can be equal to dst, may be NULL
61  * @param iv not (yet) used for RC4, should be NULL
62  * @param decrypt 0 for encryption, 1 for decryption, not (yet) used
63  */
64 void av_rc4_crypt(struct AVRC4 *d, uint8_t *dst, const uint8_t *src, int count, uint8_t *iv, int decrypt);
65
66 /**
67  * @}
68  */
69
70 #endif /* AVUTIL_RC4_H */