1/*
2 Simple DirectMedia Layer
3 Copyright (C) 1997-2025 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_stdinc.h>
38
39#include <SDL3/SDL_begin_code.h>
40/* Set up for C function definitions, even when using C++ */
41#ifdef __cplusplus
42extern "C" {
43#endif
44
45/* ------------ Definitions --------- */
46
47/* Definition shared by all CRC routines */
48
49#ifndef CrcUint32
50 #define CrcUint32 unsigned int
51#endif
52#ifndef CrcUint8
53 #define CrcUint8 unsigned char
54#endif
55
56#ifdef ORIGINAL_METHOD
57 #define CRC32_POLY 0x04c11db7 /* AUTODIN II, Ethernet, & FDDI */
58#else
59 #define CRC32_POLY 0xEDB88320 /* Perl String::CRC32 compatible */
60#endif
61
62/*
63 * Data structure for CRC32 (checksum) computation
64 */
65 typedef struct SDLTest_Crc32Context {
66 CrcUint32 crc32_table[256]; /* CRC table */
67 } SDLTest_Crc32Context;
68
69/* ---------- Function Prototypes ------------- */
70
71/*
72 * Initialize the CRC context
73 *
74 * Note: The function initializes the crc table required for all crc calculations.
75 *
76 * \param crcContext pointer to context variable
77 *
78 * \returns true on success or false on failure; call SDL_GetError()
79 * for more information.
80 *
81 */
82bool SDLCALL SDLTest_Crc32Init(SDLTest_Crc32Context *crcContext);
83
84/*
85 * calculate a crc32 from a data block
86 *
87 * \param crcContext pointer to context variable
88 * \param inBuf input buffer to checksum
89 * \param inLen length of input buffer
90 * \param crc32 pointer to Uint32 to store the final CRC into
91 *
92 * \returns true on success or false on failure; call SDL_GetError()
93 * for more information.
94 *
95 */
96bool SDLCALL SDLTest_Crc32Calc(SDLTest_Crc32Context *crcContext, CrcUint8 *inBuf, CrcUint32 inLen, CrcUint32 *crc32);
97
98/* Same routine broken down into three steps */
99bool SDLCALL SDLTest_Crc32CalcStart(SDLTest_Crc32Context *crcContext, CrcUint32 *crc32);
100bool SDLCALL SDLTest_Crc32CalcEnd(SDLTest_Crc32Context *crcContext, CrcUint32 *crc32);
101bool SDLCALL SDLTest_Crc32CalcBuffer(SDLTest_Crc32Context *crcContext, CrcUint8 *inBuf, CrcUint32 inLen, CrcUint32 *crc32);
102
103/*
104 * clean up CRC context
105 *
106 * \param crcContext pointer to context variable
107 *
108 * \returns true on success or false on failure; call SDL_GetError()
109 * for more information.
110 *
111*/
112
113bool SDLCALL SDLTest_Crc32Done(SDLTest_Crc32Context *crcContext);
114
115/* Ends C function definitions when using C++ */
116#ifdef __cplusplus
117}
118#endif
119#include <SDL3/SDL_close_code.h>
120
121#endif /* SDL_test_crc32_h_ */
122