xtea: Clarify that the current API works in big endian mode
[ffmpeg.git] / libavutil / xtea.h
1 /*
2  * A 32-bit implementation of the XTEA algorithm
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_XTEA_H
22 #define AVUTIL_XTEA_H
23
24 #include <stdint.h>
25 #include "version.h"
26
27 /**
28  * @file
29  * @brief Public header for libavutil XTEA algorithm
30  * @defgroup lavu_xtea XTEA
31  * @ingroup lavu_crypto
32  * @{
33  */
34
35 #if FF_API_CRYPTO_CONTEXT
36 typedef struct AVXTEA {
37     uint32_t key[16];
38 } AVXTEA;
39 #else
40 typedef struct AVXTEA AVXTEA;
41 #endif
42
43 /**
44  * Allocate an AVXTEA context.
45  */
46 AVXTEA *av_xtea_alloc(void);
47
48 /**
49  * Initialize an AVXTEA context.
50  *
51  * @param ctx an AVXTEA context
52  * @param key a key of 16 bytes used for encryption/decryption,
53  *            interpreted as big endian 32 bit numbers
54  */
55 void av_xtea_init(struct AVXTEA *ctx, const uint8_t key[16]);
56
57 /**
58  * Encrypt or decrypt a buffer using a previously initialized context,
59  * in big endian format.
60  *
61  * @param ctx an AVXTEA context
62  * @param dst destination array, can be equal to src
63  * @param src source array, can be equal to dst
64  * @param count number of 8 byte blocks
65  * @param iv initialization vector for CBC mode, if NULL then ECB will be used
66  * @param decrypt 0 for encryption, 1 for decryption
67  */
68 void av_xtea_crypt(struct AVXTEA *ctx, uint8_t *dst, const uint8_t *src,
69                    int count, uint8_t *iv, int decrypt);
70
71 /**
72  * @}
73  */
74
75 #endif /* AVUTIL_XTEA_H */