SDL 3.0
SDL_test_crc32.h
Go to the documentation of this file.
1/*
2 Simple DirectMedia Layer
3 Copyright (C) 1997-2024 Sam Lantinga <slouken@libsdl.org>
4
5 This software is provided 'as-is', without any express or implied
6 warranty. In no event will the authors be held liable for any damages
7 arising from the use of this software.
8
9 Permission is granted to anyone to use this software for any purpose,
10 including commercial applications, and to alter it and redistribute it
11 freely, subject to the following restrictions:
12
13 1. The origin of this software must not be misrepresented; you must not
14 claim that you wrote the original software. If you use this software
15 in a product, an acknowledgment in the product documentation would be
16 appreciated but is not required.
17 2. Altered source versions must be plainly marked as such, and must not be
18 misrepresented as being the original software.
19 3. This notice may not be removed or altered from any source distribution.
20*/
21
22/**
23 * CRC32 functions of SDL test framework.
24 *
25 * This code is a part of the SDL test library, not the main SDL library.
26 */
27
28/*
29
30 Implements CRC32 calculations (default output is Perl String::CRC32 compatible).
31
32*/
33
34#ifndef SDL_test_crc32_h_
35#define SDL_test_crc32_h_
36
37#include <SDL3/SDL_begin_code.h>
38/* Set up for C function definitions, even when using C++ */
39#ifdef __cplusplus
40extern "C" {
41#endif
42
43
44/* ------------ Definitions --------- */
45
46/* Definition shared by all CRC routines */
47
48#ifndef CrcUint32
49 #define CrcUint32 unsigned int
50#endif
51#ifndef CrcUint8
52 #define CrcUint8 unsigned char
53#endif
54
55#ifdef ORIGINAL_METHOD
56 #define CRC32_POLY 0x04c11db7 /* AUTODIN II, Ethernet, & FDDI */
57#else
58 #define CRC32_POLY 0xEDB88320 /* Perl String::CRC32 compatible */
59#endif
60
61/*
62 * Data structure for CRC32 (checksum) computation
63 */
64 typedef struct SDLTest_Crc32Context {
65 CrcUint32 crc32_table[256]; /* CRC table */
67
68/* ---------- Function Prototypes ------------- */
69
70/*
71 * Initialize the CRC context
72 *
73 * Note: The function initializes the crc table required for all crc calculations.
74 *
75 * \param crcContext pointer to context variable
76 *
77 * \returns 0 for OK, -1 on error
78 *
79 */
81
82
83/*
84 * calculate a crc32 from a data block
85 *
86 * \param crcContext pointer to context variable
87 * \param inBuf input buffer to checksum
88 * \param inLen length of input buffer
89 * \param crc32 pointer to Uint32 to store the final CRC into
90 *
91 * \returns 0 for OK, -1 on error
92 *
93 */
94int SDLTest_Crc32Calc(SDLTest_Crc32Context *crcContext, CrcUint8 *inBuf, CrcUint32 inLen, CrcUint32 *crc32);
95
96/* Same routine broken down into three steps */
100
101
102/*
103 * clean up CRC context
104 *
105 * \param crcContext pointer to context variable
106 *
107 * \returns 0 for OK, -1 on error
108 *
109*/
110
112
113
114/* Ends C function definitions when using C++ */
115#ifdef __cplusplus
116}
117#endif
118#include <SDL3/SDL_close_code.h>
119
120#endif /* SDL_test_crc32_h_ */
int SDLTest_Crc32Done(SDLTest_Crc32Context *crcContext)
int SDLTest_Crc32Calc(SDLTest_Crc32Context *crcContext, CrcUint8 *inBuf, CrcUint32 inLen, CrcUint32 *crc32)
int SDLTest_Crc32Init(SDLTest_Crc32Context *crcContext)
int SDLTest_Crc32CalcBuffer(SDLTest_Crc32Context *crcContext, CrcUint8 *inBuf, CrcUint32 inLen, CrcUint32 *crc32)
int SDLTest_Crc32CalcStart(SDLTest_Crc32Context *crcContext, CrcUint32 *crc32)
int SDLTest_Crc32CalcEnd(SDLTest_Crc32Context *crcContext, CrcUint32 *crc32)
#define CrcUint8
#define CrcUint32
CrcUint32 crc32_table[256]