include/SDL_test_crc32.h
author Andreas Schiffler <aschiffler@ferzkopp.net>
Wed, 28 Nov 2012 19:19:57 -0800
changeset 6713 fa17a97389ed
child 6885 700f1b25f77f
permissions -rw-r--r--
Add crc32 and md5 to test lib
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2012 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  *  \file SDL_test_crc32.h
    24  *  
    25  *  Include file for SDL test framework.
    26  *
    27  *  This code is a part of the SDL2_test library, not the main SDL library.
    28  */
    29 
    30 /* 
    31 
    32  Implements CRC32 calculations (default output is Perl String::CRC32 compatible).
    33   
    34 */
    35 
    36 #ifndef _SDL_test_crc32_h
    37 #define _SDL_test_crc32_h
    38 
    39 #include "begin_code.h"
    40 /* Set up for C function definitions, even when using C++ */
    41 #ifdef __cplusplus
    42 /* *INDENT-OFF* */
    43 extern "C" {
    44 /* *INDENT-ON* */
    45 #endif
    46 
    47 
    48 /* ------------ Definitions --------- */
    49 
    50 /* Definition shared by all CRC routines */
    51 
    52 #ifndef CrcUint32
    53  #define CrcUint32	unsigned int
    54 #endif
    55 #ifndef CrcUint8
    56  #define CrcUint8	unsigned char
    57 #endif
    58 
    59 #ifdef ORIGINAL_METHOD
    60  #define CRC32_POLY 0x04c11db7 	 /* AUTODIN II, Ethernet, & FDDI */
    61 #else
    62  #define CRC32_POLY 0xEDB88320   /* Perl String::CRC32 compatible */
    63 #endif
    64 
    65 /** 
    66  * Data structure for CRC32 (checksum) computation 
    67  */
    68   typedef struct {
    69     CrcUint32    crc32_table[256]; /* CRC table */
    70   } SDLTest_Crc32Context;
    71 
    72 /* ---------- Function Prototypes ------------- */
    73 
    74 /** 
    75  * /brief Initialize the CRC context
    76  *
    77  * Note: The function initializes the crc table required for all crc calculations.
    78  *
    79  * /param crcContext		pointer to context variable
    80  *
    81  * /returns 0 for OK, -1 on error
    82  *
    83  */
    84  int SDLTest_Crc32Init(SDLTest_Crc32Context * crcContext);
    85 
    86 
    87 /**
    88  * /brief calculate a crc32 from a data block
    89  * 
    90  * /param crcContext	     pointer to context variable
    91  * /param inBuf              input buffer to checksum
    92  * /param inLen              length of input buffer
    93  * /param crc32              pointer to Uint32 to store the final CRC into
    94  *
    95  * /returns 0 for OK, -1 on error
    96  *
    97  */
    98 int SDLTest_crc32Calc(SDLTest_Crc32Context * crcContext, CrcUint8 *inBuf, CrcUint32 inLen, CrcUint32 *crc32);
    99 
   100 /* Same routine broken down into three steps */
   101 int SDLTest_Crc32CalcStart(SDLTest_Crc32Context * crcContext, CrcUint32 *crc32);
   102 int SDLTest_Crc32CalcEnd(SDLTest_Crc32Context * crcContext, CrcUint32 *crc32);
   103 int SDLTest_Crc32CalcBuffer(SDLTest_Crc32Context * crcContext, CrcUint8 *inBuf, CrcUint32 inLen, CrcUint32 *crc32);
   104 
   105 
   106 /**
   107  * /brief clean up CRC context
   108  *
   109  * /param crcContext		pointer to context variable
   110  *
   111  * /returns 0 for OK, -1 on error
   112  *
   113 */
   114 
   115 int SDLTest_Crc32Done(SDLTest_Crc32Context * crcContext);
   116 
   117 
   118 /* Ends C function definitions when using C++ */
   119 #ifdef __cplusplus
   120 /* *INDENT-OFF* */
   121 }
   122 /* *INDENT-ON* */
   123 #endif
   124 #include "close_code.h"
   125 
   126 #endif /* _SDL_test_crc32_h */
   127 
   128 /* vi: set ts=4 sw=4 expandtab: */