mem_ops.h 6.33 KB
Newer Older
John Koleszar's avatar
John Koleszar committed
1
/*
2
 *  Copyright (c) 2010 The WebM project authors. All Rights Reserved.
John Koleszar's avatar
John Koleszar committed
3
 *
4
 *  Use of this source code is governed by a BSD-style license
5 6
 *  that can be found in the LICENSE file in the root of the source
 *  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.
John Koleszar's avatar
John Koleszar committed
9 10
 */

11 12
#ifndef VPX_PORTS_MEM_OPS_H_
#define VPX_PORTS_MEM_OPS_H_
John Koleszar's avatar
John Koleszar committed
13

14 15
/* \file
 * \brief Provides portable memory access primitives
John Koleszar's avatar
John Koleszar committed
16
 *
17
 * This function provides portable primitives for getting and setting of
John Koleszar's avatar
John Koleszar committed
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
 * signed and unsigned integers in 16, 24, and 32 bit sizes. The operations
 * can be performed on unaligned data regardless of hardware support for
 * unaligned accesses.
 *
 * The type used to pass the integral values may be changed by defining
 * MEM_VALUE_T with the appropriate type. The type given must be an integral
 * numeric type.
 *
 * The actual functions instantiated have the MEM_VALUE_T type name pasted
 * on to the symbol name. This allows the developer to instantiate these
 * operations for multiple types within the same translation unit. This is
 * of somewhat questionable utility, but the capability exists nonetheless.
 * Users not making use of this functionality should call the functions
 * without the type name appended, and the preprocessor will take care of
 * it.
 *
 * NOTE: This code is not supported on platforms where char > 1 octet ATM.
 */

#ifndef MAU_T
/* Minimum Access Unit for this target */
#define MAU_T unsigned char
#endif

#ifndef MEM_VALUE_T
#define MEM_VALUE_T int
#endif

#undef MEM_VALUE_T_SZ_BITS
#define MEM_VALUE_T_SZ_BITS (sizeof(MEM_VALUE_T) << 3)

#undef  mem_ops_wrap_symbol
#define mem_ops_wrap_symbol(fn) mem_ops_wrap_symbol2(fn, MEM_VALUE_T)
#undef  mem_ops_wrap_symbol2
#define mem_ops_wrap_symbol2(fn,typ) mem_ops_wrap_symbol3(fn,typ)
#undef  mem_ops_wrap_symbol3
#define mem_ops_wrap_symbol3(fn,typ) fn##_as_##typ

/*
 * Include aligned access routines
 */
#define INCLUDED_BY_MEM_OPS_H
#include "mem_ops_aligned.h"
#undef  INCLUDED_BY_MEM_OPS_H

#undef  mem_get_be16
#define mem_get_be16 mem_ops_wrap_symbol(mem_get_be16)
John Koleszar's avatar
John Koleszar committed
65 66 67 68 69 70 71
static unsigned MEM_VALUE_T mem_get_be16(const void *vmem) {
  unsigned MEM_VALUE_T  val;
  const MAU_T          *mem = (const MAU_T *)vmem;

  val = mem[0] << 8;
  val |= mem[1];
  return val;
John Koleszar's avatar
John Koleszar committed
72 73 74 75
}

#undef  mem_get_be24
#define mem_get_be24 mem_ops_wrap_symbol(mem_get_be24)
John Koleszar's avatar
John Koleszar committed
76 77 78 79 80 81 82 83
static unsigned MEM_VALUE_T mem_get_be24(const void *vmem) {
  unsigned MEM_VALUE_T  val;
  const MAU_T          *mem = (const MAU_T *)vmem;

  val = mem[0] << 16;
  val |= mem[1] << 8;
  val |= mem[2];
  return val;
John Koleszar's avatar
John Koleszar committed
84 85 86 87
}

#undef  mem_get_be32
#define mem_get_be32 mem_ops_wrap_symbol(mem_get_be32)
John Koleszar's avatar
John Koleszar committed
88 89 90 91 92 93 94 95 96
static unsigned MEM_VALUE_T mem_get_be32(const void *vmem) {
  unsigned MEM_VALUE_T  val;
  const MAU_T          *mem = (const MAU_T *)vmem;

  val = mem[0] << 24;
  val |= mem[1] << 16;
  val |= mem[2] << 8;
  val |= mem[3];
  return val;
John Koleszar's avatar
John Koleszar committed
97 98 99 100
}

#undef  mem_get_le16
#define mem_get_le16 mem_ops_wrap_symbol(mem_get_le16)
John Koleszar's avatar
John Koleszar committed
101 102 103 104 105 106 107
static unsigned MEM_VALUE_T mem_get_le16(const void *vmem) {
  unsigned MEM_VALUE_T  val;
  const MAU_T          *mem = (const MAU_T *)vmem;

  val = mem[1] << 8;
  val |= mem[0];
  return val;
John Koleszar's avatar
John Koleszar committed
108 109 110 111
}

#undef  mem_get_le24
#define mem_get_le24 mem_ops_wrap_symbol(mem_get_le24)
John Koleszar's avatar
John Koleszar committed
112 113 114 115 116 117 118 119
static unsigned MEM_VALUE_T mem_get_le24(const void *vmem) {
  unsigned MEM_VALUE_T  val;
  const MAU_T          *mem = (const MAU_T *)vmem;

  val = mem[2] << 16;
  val |= mem[1] << 8;
  val |= mem[0];
  return val;
John Koleszar's avatar
John Koleszar committed
120 121 122 123
}

#undef  mem_get_le32
#define mem_get_le32 mem_ops_wrap_symbol(mem_get_le32)
John Koleszar's avatar
John Koleszar committed
124 125 126 127 128 129 130 131 132
static unsigned MEM_VALUE_T mem_get_le32(const void *vmem) {
  unsigned MEM_VALUE_T  val;
  const MAU_T          *mem = (const MAU_T *)vmem;

  val = mem[3] << 24;
  val |= mem[2] << 16;
  val |= mem[1] << 8;
  val |= mem[0];
  return val;
John Koleszar's avatar
John Koleszar committed
133 134 135
}

#define mem_get_s_generic(end,sz) \
136
  static VPX_INLINE signed MEM_VALUE_T mem_get_s##end##sz(const void *vmem) {\
John Koleszar's avatar
John Koleszar committed
137 138 139 140
    const MAU_T *mem = (const MAU_T*)vmem;\
    signed MEM_VALUE_T val = mem_get_##end##sz(mem);\
    return (val << (MEM_VALUE_T_SZ_BITS - sz)) >> (MEM_VALUE_T_SZ_BITS - sz);\
  }
John Koleszar's avatar
John Koleszar committed
141 142 143

#undef  mem_get_sbe16
#define mem_get_sbe16 mem_ops_wrap_symbol(mem_get_sbe16)
144
mem_get_s_generic(be, 16)
John Koleszar's avatar
John Koleszar committed
145 146 147

#undef  mem_get_sbe24
#define mem_get_sbe24 mem_ops_wrap_symbol(mem_get_sbe24)
148
mem_get_s_generic(be, 24)
John Koleszar's avatar
John Koleszar committed
149 150 151

#undef  mem_get_sbe32
#define mem_get_sbe32 mem_ops_wrap_symbol(mem_get_sbe32)
152
mem_get_s_generic(be, 32)
John Koleszar's avatar
John Koleszar committed
153 154 155

#undef  mem_get_sle16
#define mem_get_sle16 mem_ops_wrap_symbol(mem_get_sle16)
156
mem_get_s_generic(le, 16)
John Koleszar's avatar
John Koleszar committed
157 158 159

#undef  mem_get_sle24
#define mem_get_sle24 mem_ops_wrap_symbol(mem_get_sle24)
160
mem_get_s_generic(le, 24)
John Koleszar's avatar
John Koleszar committed
161 162 163

#undef  mem_get_sle32
#define mem_get_sle32 mem_ops_wrap_symbol(mem_get_sle32)
164
mem_get_s_generic(le, 32)
John Koleszar's avatar
John Koleszar committed
165 166 167

#undef  mem_put_be16
#define mem_put_be16 mem_ops_wrap_symbol(mem_put_be16)
168
static VPX_INLINE void mem_put_be16(void *vmem, MEM_VALUE_T val) {
John Koleszar's avatar
John Koleszar committed
169
  MAU_T *mem = (MAU_T *)vmem;
John Koleszar's avatar
John Koleszar committed
170

John Koleszar's avatar
John Koleszar committed
171 172
  mem[0] = (val >> 8) & 0xff;
  mem[1] = (val >> 0) & 0xff;
John Koleszar's avatar
John Koleszar committed
173 174 175 176
}

#undef  mem_put_be24
#define mem_put_be24 mem_ops_wrap_symbol(mem_put_be24)
177
static VPX_INLINE void mem_put_be24(void *vmem, MEM_VALUE_T val) {
John Koleszar's avatar
John Koleszar committed
178
  MAU_T *mem = (MAU_T *)vmem;
John Koleszar's avatar
John Koleszar committed
179

John Koleszar's avatar
John Koleszar committed
180 181 182
  mem[0] = (val >> 16) & 0xff;
  mem[1] = (val >>  8) & 0xff;
  mem[2] = (val >>  0) & 0xff;
John Koleszar's avatar
John Koleszar committed
183 184 185 186
}

#undef  mem_put_be32
#define mem_put_be32 mem_ops_wrap_symbol(mem_put_be32)
187
static VPX_INLINE void mem_put_be32(void *vmem, MEM_VALUE_T val) {
John Koleszar's avatar
John Koleszar committed
188 189 190 191 192 193
  MAU_T *mem = (MAU_T *)vmem;

  mem[0] = (val >> 24) & 0xff;
  mem[1] = (val >> 16) & 0xff;
  mem[2] = (val >>  8) & 0xff;
  mem[3] = (val >>  0) & 0xff;
John Koleszar's avatar
John Koleszar committed
194 195 196 197
}

#undef  mem_put_le16
#define mem_put_le16 mem_ops_wrap_symbol(mem_put_le16)
198
static VPX_INLINE void mem_put_le16(void *vmem, MEM_VALUE_T val) {
John Koleszar's avatar
John Koleszar committed
199
  MAU_T *mem = (MAU_T *)vmem;
John Koleszar's avatar
John Koleszar committed
200

John Koleszar's avatar
John Koleszar committed
201 202
  mem[0] = (val >>  0) & 0xff;
  mem[1] = (val >>  8) & 0xff;
John Koleszar's avatar
John Koleszar committed
203 204 205 206
}

#undef  mem_put_le24
#define mem_put_le24 mem_ops_wrap_symbol(mem_put_le24)
207
static VPX_INLINE void mem_put_le24(void *vmem, MEM_VALUE_T val) {
John Koleszar's avatar
John Koleszar committed
208
  MAU_T *mem = (MAU_T *)vmem;
John Koleszar's avatar
John Koleszar committed
209

John Koleszar's avatar
John Koleszar committed
210 211 212
  mem[0] = (val >>  0) & 0xff;
  mem[1] = (val >>  8) & 0xff;
  mem[2] = (val >> 16) & 0xff;
John Koleszar's avatar
John Koleszar committed
213 214 215 216
}

#undef  mem_put_le32
#define mem_put_le32 mem_ops_wrap_symbol(mem_put_le32)
217
static VPX_INLINE void mem_put_le32(void *vmem, MEM_VALUE_T val) {
John Koleszar's avatar
John Koleszar committed
218 219 220 221 222 223
  MAU_T *mem = (MAU_T *)vmem;

  mem[0] = (val >>  0) & 0xff;
  mem[1] = (val >>  8) & 0xff;
  mem[2] = (val >> 16) & 0xff;
  mem[3] = (val >> 24) & 0xff;
John Koleszar's avatar
John Koleszar committed
224
}
225 226

#endif  // VPX_PORTS_MEM_OPS_H_