annotate lib/libavutil/crc.h @ 2202:44d956d4f838

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