| AOMedia AV1 Codec

aom_integer.h
1/*
2 * Copyright (c) 2016, Alliance for Open Media. All rights reserved
3 *
4 * This source code is subject to the terms of the BSD 2 Clause License and
5 * the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License
6 * was not distributed with this source code in the LICENSE file, you can
7 * obtain it at www.aomedia.org/license/software. If the Alliance for Open
8 * Media Patent License 1.0 was not distributed with this source code in the
9 * PATENTS file, you can obtain it at www.aomedia.org/license/patent.
10 */
11#ifndef AOM_AOM_AOM_INTEGER_H_
12#define AOM_AOM_AOM_INTEGER_H_
13
14/* get ptrdiff_t, size_t, wchar_t, NULL */
15#include <stddef.h> // IWYU pragma: export
16
17#if defined(_MSC_VER)
18#define AOM_FORCE_INLINE __forceinline
19#define AOM_INLINE __inline
20#else
21#define AOM_FORCE_INLINE __inline__ __attribute__((always_inline))
22#define AOM_INLINE inline
23#endif
24
25/* Assume platforms have the C99 standard integer types. */
26
27#if defined(__cplusplus)
28#if !defined(__STDC_FORMAT_MACROS)
29#define __STDC_FORMAT_MACROS
30#endif
31#if !defined(__STDC_LIMIT_MACROS)
32#define __STDC_LIMIT_MACROS
33#endif
34#endif // __cplusplus
35
36#include <stdint.h> // IWYU pragma: export
37#include <inttypes.h> // IWYU pragma: export
38
39#if defined(__cplusplus)
40 extern "C" {
41#endif // __cplusplus
42
43// Returns size of uint64_t when encoded using LEB128.
44 size_t aom_uleb_size_in_bytes(uint64_t value);
45
46// Returns 0 on success, -1 on decode failure.
47// On success, 'value' stores the decoded LEB128 value and 'length' stores
48// the number of bytes decoded.
49 int aom_uleb_decode(const uint8_t *buffer, size_t available, uint64_t *value,
50 size_t *length);
51
52// Encodes LEB128 integer. Returns 0 when successful, and -1 upon failure.
53 int aom_uleb_encode(uint64_t value, size_t available, uint8_t *coded_value,
54 size_t *coded_size);
55
56// Encodes LEB128 integer to size specified. Returns 0 when successful, and -1
57// upon failure.
58// Note: This will write exactly pad_to_size bytes; if the value cannot be
59// encoded in this many bytes, then this will fail.
60 int aom_uleb_encode_fixed_size(uint64_t value, size_t available,
61 size_t pad_to_size, uint8_t *coded_value,
62 size_t *coded_size);
63
64#if defined(__cplusplus)
65} // extern "C"
66#endif // __cplusplus
67
68#endif // AOM_AOM_AOM_INTEGER_H_