crc.h 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  1. /*
  2. * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
  3. *
  4. * This file is part of FFmpeg.
  5. *
  6. * FFmpeg is free software; you can redistribute it and/or
  7. * modify it under the terms of the GNU Lesser General Public
  8. * License as published by the Free Software Foundation; either
  9. * version 2.1 of the License, or (at your option) any later version.
  10. *
  11. * FFmpeg is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14. * Lesser General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU Lesser General Public
  17. * License along with FFmpeg; if not, write to the Free Software
  18. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19. */
  20. /**
  21. * @file
  22. * @ingroup lavu_crc32
  23. * Public header for CRC hash function implementation.
  24. */
  25. #ifndef AVUTIL_CRC_H
  26. #define AVUTIL_CRC_H
  27. #include <stdint.h>
  28. #include <stddef.h>
  29. #include "attributes.h"
  30. #include "version.h"
  31. /**
  32. * @defgroup lavu_crc32 CRC
  33. * @ingroup lavu_hash
  34. * CRC (Cyclic Redundancy Check) hash function implementation.
  35. *
  36. * This module supports numerous CRC polynomials, in addition to the most
  37. * widely used CRC-32-IEEE. See @ref AVCRCId for a list of available
  38. * polynomials.
  39. *
  40. * @{
  41. */
  42. typedef uint32_t AVCRC;
  43. typedef enum {
  44. AV_CRC_8_ATM,
  45. AV_CRC_16_ANSI,
  46. AV_CRC_16_CCITT,
  47. AV_CRC_32_IEEE,
  48. AV_CRC_32_IEEE_LE, /*< reversed bitorder version of AV_CRC_32_IEEE */
  49. AV_CRC_16_ANSI_LE, /*< reversed bitorder version of AV_CRC_16_ANSI */
  50. AV_CRC_24_IEEE,
  51. AV_CRC_8_EBU,
  52. AV_CRC_MAX, /*< Not part of public API! Do not use outside libavutil. */
  53. }AVCRCId;
  54. /**
  55. * Initialize a CRC table.
  56. * @param ctx must be an array of size sizeof(AVCRC)*257 or sizeof(AVCRC)*1024
  57. * @param le If 1, the lowest bit represents the coefficient for the highest
  58. * exponent of the corresponding polynomial (both for poly and
  59. * actual CRC).
  60. * If 0, you must swap the CRC parameter and the result of av_crc
  61. * if you need the standard representation (can be simplified in
  62. * most cases to e.g. bswap16):
  63. * av_bswap32(crc << (32-bits))
  64. * @param bits number of bits for the CRC
  65. * @param poly generator polynomial without the x**bits coefficient, in the
  66. * representation as specified by le
  67. * @param ctx_size size of ctx in bytes
  68. * @return <0 on failure
  69. */
  70. int av_crc_init(AVCRC *ctx, int le, int bits, uint32_t poly, int ctx_size);
  71. /**
  72. * Get an initialized standard CRC table.
  73. * @param crc_id ID of a standard CRC
  74. * @return a pointer to the CRC table or NULL on failure
  75. */
  76. const AVCRC *av_crc_get_table(AVCRCId crc_id);
  77. /**
  78. * Calculate the CRC of a block.
  79. * @param crc CRC of previous blocks if any or initial value for CRC
  80. * @return CRC updated with the data from the given block
  81. *
  82. * @see av_crc_init() "le" parameter
  83. */
  84. uint32_t av_crc(const AVCRC *ctx, uint32_t crc,
  85. const uint8_t *buffer, size_t length) av_pure;
  86. /**
  87. * @}
  88. */
  89. #endif /* AVUTIL_CRC_H */