crc.h

Engine/source/core/crc.h

More...

Namespaces:

Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _CRC_H_
25#define _CRC_H_
26
27#ifndef _TORQUE_TYPES_H_
28#include "platform/types.h"
29#endif
30
31
32class Stream;
33
34namespace CRC
35{
36   /// Initial value for CRCs
37   const U32   INITIAL_CRC_VALUE = 0xFFFFFFFF;
38
39   /// Value XORd with the CRC to post condition it (ones complement)
40   const U32   CRC_POSTCOND_VALUE = 0xFFFFFFFF;
41
42   /// An invalid CRC
43   const U32   INVALID_CRC = 0xFFFFFFFF;
44
45   U32 calculateCRC(const void * buffer, S32 len, U32 crcVal = INITIAL_CRC_VALUE);
46   U32 calculateCRCStream(Stream *stream, U32 crcVal = INITIAL_CRC_VALUE);
47}
48
49#endif
50
51