Miguel Ruiz / SDL_lib

SDL standard library

Dependents:   H261_encoder

SDL_test_crc32.h@0:dda4f4550403, 2016-09-07 (annotated)

Committer:
miruga27
Date:
Wed Sep 07 18:46:53 2016 +0000
Revision:
0:dda4f4550403
7/09/2016;

Who changed what in which revision?

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