rav1e 0.8.1

The fastest and safest AV1 encoder
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252

// Copyright (c) 2023, The rav1e contributors. All rights reserved
//
// This source code is subject to the terms of the BSD 2 Clause License and
// the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License
// was not distributed with this source code in the LICENSE file, you can
// obtain it at www.aomedia.org/license/software. If the Alliance for Open
// Media Patent License 1.0 was not distributed with this source code in the
// PATENTS file, you can obtain it at www.aomedia.org/license/patent.

use crate::asm::aarch64::dist::to_index;
use crate::asm::aarch64::dist::DIST_FNS_LENGTH;
use crate::cpu_features::CpuFeatureLevel;
use crate::dist::*;
use crate::encoder::IMPORTANCE_BLOCK_SIZE;
use crate::partition::BlockSize;
use crate::rdo::DistortionScale;
use crate::tiling::PlaneRegion;
use crate::util::*;

type WeightedSseFn = unsafe extern fn(
  src: *const u8,
  src_stride: isize,
  dst: *const u8,
  dst_stride: isize,
  scale: *const u32,
  scale_stride: isize,
) -> u64;

type WeightedSseHBDFn = unsafe extern fn(
  src: *const u16,
  src_stride: isize,
  dst: *const u16,
  dst_stride: isize,
  scale: *const u32,
  scale_stride: isize,
) -> u64;

macro_rules! declare_asm_sse_fn {
  ($($name: ident),+) => (
    $(
      extern { fn $name (
        src: *const u8, src_stride: isize, dst: *const u8, dst_stride: isize, scale: *const u32, scale_stride: isize
      ) -> u64; }
    )+
  )
}

macro_rules! declare_asm_hbd_sse_fn {
  ($($name: ident),+) => (
    $(
      extern { fn $name (
        src: *const u16, src_stride: isize, dst: *const u16, dst_stride: isize, scale: *const u32, scale_stride: isize
      ) -> u64; }
    )+
  )
}

declare_asm_sse_fn![
  rav1e_weighted_sse_4x4_neon,
  rav1e_weighted_sse_4x8_neon,
  rav1e_weighted_sse_4x16_neon,
  rav1e_weighted_sse_8x4_neon,
  rav1e_weighted_sse_8x8_neon,
  rav1e_weighted_sse_8x16_neon,
  rav1e_weighted_sse_8x32_neon,
  rav1e_weighted_sse_16x4_neon,
  rav1e_weighted_sse_16x8_neon,
  rav1e_weighted_sse_16x16_neon,
  rav1e_weighted_sse_16x32_neon,
  rav1e_weighted_sse_16x64_neon,
  rav1e_weighted_sse_32x8_neon,
  rav1e_weighted_sse_32x16_neon,
  rav1e_weighted_sse_32x32_neon,
  rav1e_weighted_sse_32x64_neon,
  rav1e_weighted_sse_64x16_neon,
  rav1e_weighted_sse_64x32_neon,
  rav1e_weighted_sse_64x64_neon,
  rav1e_weighted_sse_64x128_neon,
  rav1e_weighted_sse_128x64_neon,
  rav1e_weighted_sse_128x128_neon
];

declare_asm_hbd_sse_fn![
  rav1e_weighted_sse_4x4_hbd_neon,
  rav1e_weighted_sse_4x8_hbd_neon,
  rav1e_weighted_sse_4x16_hbd_neon,
  rav1e_weighted_sse_8x4_hbd_neon,
  rav1e_weighted_sse_8x8_hbd_neon,
  rav1e_weighted_sse_8x16_hbd_neon,
  rav1e_weighted_sse_8x32_hbd_neon,
  rav1e_weighted_sse_16x4_hbd_neon,
  rav1e_weighted_sse_16x8_hbd_neon,
  rav1e_weighted_sse_16x16_hbd_neon,
  rav1e_weighted_sse_16x32_hbd_neon,
  rav1e_weighted_sse_16x64_hbd_neon,
  rav1e_weighted_sse_32x8_hbd_neon,
  rav1e_weighted_sse_32x16_hbd_neon,
  rav1e_weighted_sse_32x32_hbd_neon,
  rav1e_weighted_sse_32x64_hbd_neon,
  rav1e_weighted_sse_64x16_hbd_neon,
  rav1e_weighted_sse_64x32_hbd_neon,
  rav1e_weighted_sse_64x64_hbd_neon,
  rav1e_weighted_sse_64x128_hbd_neon,
  rav1e_weighted_sse_128x64_hbd_neon,
  rav1e_weighted_sse_128x128_hbd_neon
];

/// # Panics
///
/// - If in `check_asm` mode, panics on mismatch between native and ASM results.
#[inline(always)]
#[allow(clippy::let_and_return)]
pub fn get_weighted_sse<T: Pixel>(
  src: &PlaneRegion<'_, T>, dst: &PlaneRegion<'_, T>, scale: &[u32],
  scale_stride: usize, w: usize, h: usize, bit_depth: usize,
  cpu: CpuFeatureLevel,
) -> u64 {
  // Assembly breaks if imp block size changes.
  assert_eq!(IMPORTANCE_BLOCK_SIZE >> 1, 4);

  let bsize_opt = BlockSize::from_width_and_height_opt(w, h);

  let call_rust = || -> u64 {
    rust::get_weighted_sse(dst, src, scale, scale_stride, w, h, bit_depth, cpu)
  };

  #[cfg(feature = "check_asm")]
  let ref_dist = call_rust();

  let den =
    DistortionScale::new(1, 1 << rust::GET_WEIGHTED_SSE_SHIFT).0 as u64;
  let dist = match (bsize_opt, T::type_enum()) {
    (Err(_), _) => call_rust(),
    (Ok(bsize), PixelType::U8) => {
      match SSE_FNS[cpu.as_index()][to_index(bsize)] {
        // SAFETY: Calls Assembly code.
        Some(func) => unsafe {
          ((func)(
            src.data_ptr() as *const _,
            T::to_asm_stride(src.plane_cfg.stride),
            dst.data_ptr() as *const _,
            T::to_asm_stride(dst.plane_cfg.stride),
            scale.as_ptr(),
            (scale_stride * std::mem::size_of::<u32>()) as isize,
          ) + (den >> 1))
            / den
        },
        None => call_rust(),
      }
    }
    (Ok(bsize), PixelType::U16) => {
      match SSE_HBD_FNS[cpu.as_index()][to_index(bsize)] {
        // SAFETY: Calls Assembly code.
        Some(func) => unsafe {
          ((func)(
            src.data_ptr() as *const _,
            T::to_asm_stride(src.plane_cfg.stride),
            dst.data_ptr() as *const _,
            T::to_asm_stride(dst.plane_cfg.stride),
            scale.as_ptr(),
            (scale_stride * std::mem::size_of::<u32>()) as isize,
          ) + (den >> 1))
            / den
        },
        None => call_rust(),
      }
    }
  };

  #[cfg(feature = "check_asm")]
  assert_eq!(
    dist, ref_dist,
    "Weighted SSE {:?}: Assembly doesn't match reference code.",
    bsize_opt
  );

  dist
}

static SSE_FNS_NEON: [Option<WeightedSseFn>; DIST_FNS_LENGTH] = {
  let mut out: [Option<WeightedSseFn>; DIST_FNS_LENGTH] =
    [None; DIST_FNS_LENGTH];

  use BlockSize::*;
  out[BLOCK_4X4 as usize] = Some(rav1e_weighted_sse_4x4_neon);
  out[BLOCK_4X8 as usize] = Some(rav1e_weighted_sse_4x8_neon);
  out[BLOCK_4X16 as usize] = Some(rav1e_weighted_sse_4x16_neon);
  out[BLOCK_8X4 as usize] = Some(rav1e_weighted_sse_8x4_neon);
  out[BLOCK_8X8 as usize] = Some(rav1e_weighted_sse_8x8_neon);
  out[BLOCK_8X16 as usize] = Some(rav1e_weighted_sse_8x16_neon);
  out[BLOCK_8X32 as usize] = Some(rav1e_weighted_sse_8x32_neon);
  out[BLOCK_16X4 as usize] = Some(rav1e_weighted_sse_16x4_neon);
  out[BLOCK_16X8 as usize] = Some(rav1e_weighted_sse_16x8_neon);
  out[BLOCK_16X16 as usize] = Some(rav1e_weighted_sse_16x16_neon);
  out[BLOCK_16X32 as usize] = Some(rav1e_weighted_sse_16x32_neon);
  out[BLOCK_16X64 as usize] = Some(rav1e_weighted_sse_16x64_neon);
  out[BLOCK_32X8 as usize] = Some(rav1e_weighted_sse_32x8_neon);
  out[BLOCK_32X16 as usize] = Some(rav1e_weighted_sse_32x16_neon);
  out[BLOCK_32X32 as usize] = Some(rav1e_weighted_sse_32x32_neon);
  out[BLOCK_32X64 as usize] = Some(rav1e_weighted_sse_32x64_neon);
  out[BLOCK_64X16 as usize] = Some(rav1e_weighted_sse_64x16_neon);
  out[BLOCK_64X32 as usize] = Some(rav1e_weighted_sse_64x32_neon);
  out[BLOCK_64X64 as usize] = Some(rav1e_weighted_sse_64x64_neon);
  out[BLOCK_64X128 as usize] = Some(rav1e_weighted_sse_64x128_neon);
  out[BLOCK_128X64 as usize] = Some(rav1e_weighted_sse_128x64_neon);
  out[BLOCK_128X128 as usize] = Some(rav1e_weighted_sse_128x128_neon);

  out
};

static SSE_HBD_FNS_NEON: [Option<WeightedSseHBDFn>; DIST_FNS_LENGTH] = {
  let mut out: [Option<WeightedSseHBDFn>; DIST_FNS_LENGTH] =
    [None; DIST_FNS_LENGTH];

  use BlockSize::*;
  out[BLOCK_4X4 as usize] = Some(rav1e_weighted_sse_4x4_hbd_neon);
  out[BLOCK_4X8 as usize] = Some(rav1e_weighted_sse_4x8_hbd_neon);
  out[BLOCK_4X16 as usize] = Some(rav1e_weighted_sse_4x16_hbd_neon);
  out[BLOCK_8X4 as usize] = Some(rav1e_weighted_sse_8x4_hbd_neon);
  out[BLOCK_8X8 as usize] = Some(rav1e_weighted_sse_8x8_hbd_neon);
  out[BLOCK_8X16 as usize] = Some(rav1e_weighted_sse_8x16_hbd_neon);
  out[BLOCK_8X32 as usize] = Some(rav1e_weighted_sse_8x32_hbd_neon);
  out[BLOCK_16X4 as usize] = Some(rav1e_weighted_sse_16x4_hbd_neon);
  out[BLOCK_16X8 as usize] = Some(rav1e_weighted_sse_16x8_hbd_neon);
  out[BLOCK_16X16 as usize] = Some(rav1e_weighted_sse_16x16_hbd_neon);
  out[BLOCK_16X32 as usize] = Some(rav1e_weighted_sse_16x32_hbd_neon);
  out[BLOCK_16X64 as usize] = Some(rav1e_weighted_sse_16x64_hbd_neon);
  out[BLOCK_32X8 as usize] = Some(rav1e_weighted_sse_32x8_hbd_neon);
  out[BLOCK_32X16 as usize] = Some(rav1e_weighted_sse_32x16_hbd_neon);
  out[BLOCK_32X32 as usize] = Some(rav1e_weighted_sse_32x32_hbd_neon);
  out[BLOCK_32X64 as usize] = Some(rav1e_weighted_sse_32x64_hbd_neon);
  out[BLOCK_64X16 as usize] = Some(rav1e_weighted_sse_64x16_hbd_neon);
  out[BLOCK_64X32 as usize] = Some(rav1e_weighted_sse_64x32_hbd_neon);
  out[BLOCK_64X64 as usize] = Some(rav1e_weighted_sse_64x64_hbd_neon);
  out[BLOCK_64X128 as usize] = Some(rav1e_weighted_sse_64x128_hbd_neon);
  out[BLOCK_128X64 as usize] = Some(rav1e_weighted_sse_128x64_hbd_neon);
  out[BLOCK_128X128 as usize] = Some(rav1e_weighted_sse_128x128_hbd_neon);

  out
};

cpu_function_lookup_table!(
  SSE_FNS: [[Option<WeightedSseFn>; DIST_FNS_LENGTH]],
  default: [None; DIST_FNS_LENGTH],
  [NEON]
);

cpu_function_lookup_table!(
  SSE_HBD_FNS: [[Option<WeightedSseHBDFn>; DIST_FNS_LENGTH]],
  default: [None; DIST_FNS_LENGTH],
  [NEON]
);