src/lib/openjpwl/crc.h

   1 /*
   2  * The copyright in this software is being made available under the 2-clauses
   3  * BSD License, included below. This software may be subject to other third
   4  * party and contributor rights, including patent rights, and no such rights
   5  * are granted under this license.
   6  *
   7  * Copyright (c) 2001-2003, David Janssens
   8  * Copyright (c) 2002-2003, Yannick Verschueren
   9  * Copyright (c) 2003-2005, Francois Devaux and Antonin Descampe
  10  * Copyright (c) 2005, Herve Drolon, FreeImage Team
  11  * Copyright (c) 2002-2005, Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium
  12  * Copyright (c) 2005-2006, Dept. of Electronic and Information Engineering, Universita' degli Studi di Perugia, Italy
  13  * All rights reserved.
  14  *
  15  * Redistribution and use in source and binary forms, with or without
  16  * modification, are permitted provided that the following conditions
  17  * are met:
  18  * 1. Redistributions of source code must retain the above copyright
  19  *    notice, this list of conditions and the following disclaimer.
  20  * 2. Redistributions in binary form must reproduce the above copyright
  21  *    notice, this list of conditions and the following disclaimer in the
  22  *    documentation and/or other materials provided with the distribution.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  25  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  28  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  29  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  30  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  31  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  32  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  33  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  34  * POSSIBILITY OF SUCH DAMAGE.
  35  */
  36
  37 #ifdef USE_JPWL
  38
  39 /**
  40 @file crc.h
  41 @brief Functions used to compute the 16- and 32-bit CRC of byte arrays
  42
  43 */
  44
  45 #ifndef __CRC16_HEADER__
  46 #define __CRC16_HEADER__
  47
  48 /** file: CRC16.HPP
  49  *
  50  * CRC - Cyclic Redundancy Check (16-bit)
  51  *
  52  * A CRC-checksum is used to be sure, the data hasn't changed or is false.
  53  * To create a CRC-checksum, initialise a check-variable (unsigned short),
  54  * and set this to zero. Than call for every byte in the file (e.g.) the
  55  * procedure updateCRC16 with this check-variable as the first parameter,
  56  * and the byte as the second. At the end, the check-variable contains the
  57  * CRC-checksum.
  58  *
  59  * implemented by Michael Neumann, 14.06.1998
  60  *
  61  */
  62 void updateCRC16(unsigned short *, unsigned char);
  63
  64 #endif /* __CRC16_HEADER__ */
  65
  66
  67 #ifndef __CRC32_HEADER__
  68 #define __CRC32_HEADER__
  69
  70 /** file: CRC32.HPP
  71  *
  72  * CRC - Cyclic Redundancy Check (32-bit)
  73  *
  74  * A CRC-checksum is used to be sure, the data hasn't changed or is false.
  75  * To create a CRC-checksum, initialise a check-variable (unsigned short),
  76  * and set this to zero. Than call for every byte in the file (e.g.) the
  77  * procedure updateCRC32 with this check-variable as the first parameter,
  78  * and the byte as the second. At the end, the check-variable contains the
  79  * CRC-checksum.
  80  *
  81  * implemented by Michael Neumann, 14.06.1998
  82  *
  83  */
  84 void updateCRC32(unsigned long *, unsigned char);
  85
  86 #endif /* __CRC32_HEADER__ */
  87
  88
  89 #endif /* USE_JPWL */