2 * Copyright (c) 2010 The WebM project authors. All Rights Reserved.
4 * Use of this source code is governed by a BSD-style license
5 * that can be found in the LICENSE file in the root of the source
6 * tree. An additional intellectual property rights grant can be found
7 * in the file PATENTS. All contributing project authors may
8 * be found in the AUTHORS file in the root of the source tree.
11 #ifndef VPX_PORTS_MEM_OPS_H_
12 #define VPX_PORTS_MEM_OPS_H_
15 * \brief Provides portable memory access primitives
17 * This function provides portable primitives for getting and setting of
18 * signed and unsigned integers in 16, 24, and 32 bit sizes. The operations
19 * can be performed on unaligned data regardless of hardware support for
22 * The type used to pass the integral values may be changed by defining
23 * MEM_VALUE_T with the appropriate type. The type given must be an integral
26 * The actual functions instantiated have the MEM_VALUE_T type name pasted
27 * on to the symbol name. This allows the developer to instantiate these
28 * operations for multiple types within the same translation unit. This is
29 * of somewhat questionable utility, but the capability exists nonetheless.
30 * Users not making use of this functionality should call the functions
31 * without the type name appended, and the preprocessor will take care of
34 * NOTE: This code is not supported on platforms where char > 1 octet ATM.
38 /* Minimum Access Unit for this target */
39 #define MAU_T unsigned char
43 #define MEM_VALUE_T int
46 #undef MEM_VALUE_T_SZ_BITS
47 #define MEM_VALUE_T_SZ_BITS (sizeof(MEM_VALUE_T) << 3)
49 #undef mem_ops_wrap_symbol
50 #define mem_ops_wrap_symbol(fn) mem_ops_wrap_symbol2(fn, MEM_VALUE_T)
51 #undef mem_ops_wrap_symbol2
52 #define mem_ops_wrap_symbol2(fn, typ) mem_ops_wrap_symbol3(fn, typ)
53 #undef mem_ops_wrap_symbol3
54 #define mem_ops_wrap_symbol3(fn, typ) fn##_as_##typ
57 * Include aligned access routines
59 #define INCLUDED_BY_MEM_OPS_H
60 #include "mem_ops_aligned.h"
61 #undef INCLUDED_BY_MEM_OPS_H
64 #define mem_get_be16 mem_ops_wrap_symbol(mem_get_be16)
65 static unsigned MEM_VALUE_T mem_get_be16(const void *vmem) {
66 unsigned MEM_VALUE_T val;
67 const MAU_T *mem = (const MAU_T *)vmem;
75 #define mem_get_be24 mem_ops_wrap_symbol(mem_get_be24)
76 static unsigned MEM_VALUE_T mem_get_be24(const void *vmem) {
77 unsigned MEM_VALUE_T val;
78 const MAU_T *mem = (const MAU_T *)vmem;
87 #define mem_get_be32 mem_ops_wrap_symbol(mem_get_be32)
88 static unsigned MEM_VALUE_T mem_get_be32(const void *vmem) {
89 unsigned MEM_VALUE_T val;
90 const MAU_T *mem = (const MAU_T *)vmem;
92 val = ((unsigned MEM_VALUE_T)mem[0]) << 24;
100 #define mem_get_le16 mem_ops_wrap_symbol(mem_get_le16)
101 static unsigned MEM_VALUE_T mem_get_le16(const void *vmem) {
102 unsigned MEM_VALUE_T val;
103 const MAU_T *mem = (const MAU_T *)vmem;
111 #define mem_get_le24 mem_ops_wrap_symbol(mem_get_le24)
112 static unsigned MEM_VALUE_T mem_get_le24(const void *vmem) {
113 unsigned MEM_VALUE_T val;
114 const MAU_T *mem = (const MAU_T *)vmem;
123 #define mem_get_le32 mem_ops_wrap_symbol(mem_get_le32)
124 static unsigned MEM_VALUE_T mem_get_le32(const void *vmem) {
125 unsigned MEM_VALUE_T val;
126 const MAU_T *mem = (const MAU_T *)vmem;
128 val = ((unsigned MEM_VALUE_T)mem[3]) << 24;
135 #define mem_get_s_generic(end, sz) \
136 static VPX_INLINE signed MEM_VALUE_T mem_get_s##end##sz(const void *vmem) { \
137 const MAU_T *mem = (const MAU_T *)vmem; \
138 signed MEM_VALUE_T val = mem_get_##end##sz(mem); \
139 return (val << (MEM_VALUE_T_SZ_BITS - sz)) >> (MEM_VALUE_T_SZ_BITS - sz); \
142 /* clang-format off */
144 #define mem_get_sbe16 mem_ops_wrap_symbol(mem_get_sbe16)
145 mem_get_s_generic(be, 16)
148 #define mem_get_sbe24 mem_ops_wrap_symbol(mem_get_sbe24)
149 mem_get_s_generic(be, 24)
152 #define mem_get_sbe32 mem_ops_wrap_symbol(mem_get_sbe32)
153 mem_get_s_generic(be, 32)
156 #define mem_get_sle16 mem_ops_wrap_symbol(mem_get_sle16)
157 mem_get_s_generic(le, 16)
160 #define mem_get_sle24 mem_ops_wrap_symbol(mem_get_sle24)
161 mem_get_s_generic(le, 24)
164 #define mem_get_sle32 mem_ops_wrap_symbol(mem_get_sle32)
165 mem_get_s_generic(le, 32)
168 #define mem_put_be16 mem_ops_wrap_symbol(mem_put_be16)
169 static VPX_INLINE void mem_put_be16(void *vmem, MEM_VALUE_T val) {
170 MAU_T *mem = (MAU_T *)vmem;
172 mem[0] = (MAU_T)((val >> 8) & 0xff);
173 mem[1] = (MAU_T)((val >> 0) & 0xff);
177 #define mem_put_be24 mem_ops_wrap_symbol(mem_put_be24)
178 static VPX_INLINE void mem_put_be24(void *vmem, MEM_VALUE_T val) {
179 MAU_T *mem = (MAU_T *)vmem;
181 mem[0] = (MAU_T)((val >> 16) & 0xff);
182 mem[1] = (MAU_T)((val >> 8) & 0xff);
183 mem[2] = (MAU_T)((val >> 0) & 0xff);
187 #define mem_put_be32 mem_ops_wrap_symbol(mem_put_be32)
188 static VPX_INLINE void mem_put_be32(void *vmem, MEM_VALUE_T val) {
189 MAU_T *mem = (MAU_T *)vmem;
191 mem[0] = (MAU_T)((val >> 24) & 0xff);
192 mem[1] = (MAU_T)((val >> 16) & 0xff);
193 mem[2] = (MAU_T)((val >> 8) & 0xff);
194 mem[3] = (MAU_T)((val >> 0) & 0xff);
198 #define mem_put_le16 mem_ops_wrap_symbol(mem_put_le16)
199 static VPX_INLINE void mem_put_le16(void *vmem, MEM_VALUE_T val) {
200 MAU_T *mem = (MAU_T *)vmem;
202 mem[0] = (MAU_T)((val >> 0) & 0xff);
203 mem[1] = (MAU_T)((val >> 8) & 0xff);
207 #define mem_put_le24 mem_ops_wrap_symbol(mem_put_le24)
208 static VPX_INLINE void mem_put_le24(void *vmem, MEM_VALUE_T val) {
209 MAU_T *mem = (MAU_T *)vmem;
211 mem[0] = (MAU_T)((val >> 0) & 0xff);
212 mem[1] = (MAU_T)((val >> 8) & 0xff);
213 mem[2] = (MAU_T)((val >> 16) & 0xff);
217 #define mem_put_le32 mem_ops_wrap_symbol(mem_put_le32)
218 static VPX_INLINE void mem_put_le32(void *vmem, MEM_VALUE_T val) {
219 MAU_T *mem = (MAU_T *)vmem;
221 mem[0] = (MAU_T)((val >> 0) & 0xff);
222 mem[1] = (MAU_T)((val >> 8) & 0xff);
223 mem[2] = (MAU_T)((val >> 16) & 0xff);
224 mem[3] = (MAU_T)((val >> 24) & 0xff);
226 /* clang-format on */
228 #endif // VPX_PORTS_MEM_OPS_H_