videoframe 0.2.0

A common vocabulary of pixel-format and color-metadata types for video processing pipelines.
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
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
use super::*;
use std::{vec, vec::Vec};

// ---- Gbrpf32Frame ----------------------------------------------------------
// Three f32 planes. Stride in elements. DimensionOverflow uses i32::MAX + 1.

#[test]
fn gbrpf32_frame_try_new_accepts_valid_tight() {
  // stride == width, planes exactly cover the frame.
  let g = vec![0.0f32; 8 * 4];
  let b = vec![0.0f32; 8 * 4];
  let r = vec![0.0f32; 8 * 4];
  let f = Gbrpf32LeFrame::try_new(&g, &b, &r, 8, 4, 8, 8, 8).expect("valid tight frame");
  assert_eq!(f.width(), 8);
  assert_eq!(f.height(), 4);
  assert_eq!(f.g_stride(), 8);
  assert_eq!(f.b_stride(), 8);
  assert_eq!(f.r_stride(), 8);
}

#[test]
fn gbrpf32_try_new_accepts_padded_strides() {
  // stride > width — padded layout, planes must cover stride * (h-1) + w
  let stride: u32 = 16;
  let w: u32 = 8;
  let h: u32 = 4;
  // needed = stride * (h-1) + w = 16*3+8 = 56
  let p = vec![0.0f32; (stride as usize) * (h as usize - 1) + w as usize];
  let f = Gbrpf32LeFrame::try_new(&p, &p, &p, w, h, stride, stride, stride)
    .expect("padded stride accepted");
  assert_eq!(f.g_stride(), 16);
}

#[test]
fn gbrpf32_try_new_accepts_height_one() {
  // h-1 == 0, so needed == width only
  let p = vec![0.0f32; 8];
  let f = Gbrpf32LeFrame::try_new(&p, &p, &p, 8, 1, 8, 8, 8).expect("height=1 accepted");
  assert_eq!(f.height(), 1);
}

#[test]
fn gbrpf32_frame_try_new_rejects_zero_dimension() {
  let p = vec![0.0f32; 16];
  assert!(matches!(
    Gbrpf32LeFrame::try_new(&p, &p, &p, 0, 4, 8, 8, 8),
    Err(GbrFloatFrameError::ZeroDimension(_))
  ));
  assert!(matches!(
    Gbrpf32LeFrame::try_new(&p, &p, &p, 8, 0, 8, 8, 8),
    Err(GbrFloatFrameError::ZeroDimension(_))
  ));
}

#[test]
fn gbrpf32_frame_try_new_rejects_stride_below_width() {
  let p = vec![0.0f32; 8 * 4];
  // G stride too small
  assert!(matches!(
    Gbrpf32LeFrame::try_new(&p, &p, &p, 8, 4, 7, 8, 8),
    Err(GbrFloatFrameError::StrideBelowWidth(_))
  ));
  // B stride too small
  assert!(matches!(
    Gbrpf32LeFrame::try_new(&p, &p, &p, 8, 4, 8, 7, 8),
    Err(GbrFloatFrameError::StrideBelowWidth(_))
  ));
  // R stride too small
  assert!(matches!(
    Gbrpf32LeFrame::try_new(&p, &p, &p, 8, 4, 8, 8, 7),
    Err(GbrFloatFrameError::StrideBelowWidth(_))
  ));
}

#[test]
fn gbrpf32_frame_try_new_rejects_plane_too_short() {
  // need stride*(h-1)+w = 8*3+8 = 32 elements; supply 16
  let short = vec![0.0f32; 16];
  let full = vec![0.0f32; 8 * 4];
  assert!(matches!(
    Gbrpf32LeFrame::try_new(&short, &full, &full, 8, 4, 8, 8, 8),
    Err(GbrFloatFrameError::InsufficientPlane(_))
  ));
  assert!(matches!(
    Gbrpf32LeFrame::try_new(&full, &short, &full, 8, 4, 8, 8, 8),
    Err(GbrFloatFrameError::InsufficientPlane(_))
  ));
  assert!(matches!(
    Gbrpf32LeFrame::try_new(&full, &full, &short, 8, 4, 8, 8, 8),
    Err(GbrFloatFrameError::InsufficientPlane(_))
  ));
}

#[test]
fn gbrpf32_frame_try_new_rejects_dimension_overflow() {
  // width * height > i32::MAX: use two values whose product is 2^31.
  let w: u32 = 1 << 16;
  let h: u32 = 1 << 15; // 2^16 * 2^15 = 2^31 > i32::MAX (= 2^31 - 1)
  let p: &[f32] = &[];
  assert!(matches!(
    Gbrpf32LeFrame::try_new(p, p, p, w, h, w, w, w),
    Err(GbrFloatFrameError::DimensionOverflow(_))
  ));
}

#[test]
fn gbrpf32_try_new_rejects_geometry_overflow() {
  // stride * (height - 1) overflows usize on 32-bit; on 64-bit this also
  // overflows because u32::MAX/2+1 squared > usize::MAX on 32-bit.
  // We use values that overflow usize even on 64-bit hosts by picking
  // a stride that is just over half of u32::MAX, paired with a large height.
  // On 64-bit hosts (usize=u64), stride * (h-1) = (2^31) * (2^31) = 2^62 < u64::MAX,
  // so this won't overflow on 64-bit. Instead we rely on the DimensionOverflow
  // check (width*height > i32::MAX) to fire first on large values.
  //
  // To specifically trigger GeometryOverflow we need stride to be > i32::MAX
  // but width <= stride (stride >= width). width*height must still fit i32::MAX
  // which is impossible if stride >= width > i32::MAX.
  // The check order is: ZeroDimension → DimensionOverflow → per-plane.
  // GeometryOverflow fires only if stride*height overflows usize,
  // which on 64-bit cannot happen with u32 inputs (u32::MAX * u32::MAX < u64::MAX).
  // So on 64-bit this test is only meaningful on 32-bit targets.
  // We skip on 64-bit and just verify the DimensionOverflow path works.
  #[cfg(target_pointer_width = "32")]
  {
    let stride: u32 = u32::MAX / 2 + 1;
    let _height: u32 = u32::MAX / 2 + 1;
    // width must be <= stride to avoid StrideBelowWidth, but also large enough
    // that width*height check might pass. Actually width*height will overflow i32::MAX
    // too, so DimensionOverflow will fire. Use width=1 so w*h passes i32::MAX check.
    let p: &[f32] = &[];
    // With width=1, height=stride/2+1: product = height < i32::MAX. stride >= 1.
    // stride*(height-1) on 32-bit: (u32::MAX/2+1) * (u32::MAX/2) overflows usize (u32).
    let small_h: u32 = 3;
    assert!(matches!(
      Gbrpf32LeFrame::try_new(p, p, p, 1, small_h, stride, stride, stride),
      Err(GbrFloatFrameError::GeometryOverflow(_))
    ));
  }
  #[cfg(not(target_pointer_width = "32"))]
  {
    // On 64-bit, GeometryOverflow cannot fire with u32 strides/heights since
    // u32::MAX * u32::MAX = ~1.8e19 < u64::MAX. Verify the error type exists
    // by constructing a dummy value.
    let _ = GbrFloatFrameError::GeometryOverflow(GeometryOverflow::new(0, 0));
  }
}

// ---- Gbrapf32Frame ---------------------------------------------------------
// Four f32 planes (adds alpha).

#[test]
fn gbrapf32_frame_try_new_accepts_valid_tight() {
  let p = vec![0.0f32; 8 * 4];
  let f = Gbrapf32LeFrame::try_new(&p, &p, &p, &p, 8, 4, 8, 8, 8, 8).expect("valid");
  assert_eq!(f.width(), 8);
  assert_eq!(f.height(), 4);
  assert_eq!(f.a_stride(), 8);
}

#[test]
fn gbrapf32_frame_try_new_rejects_zero_dimension() {
  let p = vec![0.0f32; 16];
  assert!(matches!(
    Gbrapf32LeFrame::try_new(&p, &p, &p, &p, 0, 4, 8, 8, 8, 8),
    Err(GbrFloatFrameError::ZeroDimension(_))
  ));
}

#[test]
fn gbrapf32_frame_try_new_rejects_stride_below_width() {
  let p = vec![0.0f32; 8 * 4];
  // A stride too small
  assert!(matches!(
    Gbrapf32LeFrame::try_new(&p, &p, &p, &p, 8, 4, 8, 8, 8, 7),
    Err(GbrFloatFrameError::StrideBelowWidth(_))
  ));
}

#[test]
fn gbrapf32_frame_try_new_rejects_plane_too_short() {
  let short = vec![0.0f32; 16];
  let full = vec![0.0f32; 8 * 4];
  assert!(matches!(
    Gbrapf32LeFrame::try_new(&full, &full, &full, &short, 8, 4, 8, 8, 8, 8),
    Err(GbrFloatFrameError::InsufficientPlane(_))
  ));
}

#[test]
fn gbrapf32_frame_try_new_rejects_dimension_overflow() {
  let w: u32 = 1 << 16;
  let h: u32 = 1 << 15;
  let p: &[f32] = &[];
  assert!(matches!(
    Gbrapf32LeFrame::try_new(p, p, p, p, w, h, w, w, w, w),
    Err(GbrFloatFrameError::DimensionOverflow(_))
  ));
}

#[test]
fn gbrapf32_try_new_rejects_geometry_overflow() {
  #[cfg(target_pointer_width = "32")]
  {
    let stride: u32 = u32::MAX / 2 + 1;
    let p: &[f32] = &[];
    assert!(matches!(
      Gbrapf32LeFrame::try_new(p, p, p, p, 1, 3, stride, stride, stride, stride),
      Err(GbrFloatFrameError::GeometryOverflow(_))
    ));
  }
  #[cfg(not(target_pointer_width = "32"))]
  {
    let _ = GbrFloatFrameError::GeometryOverflow(GeometryOverflow::new(0, 0));
  }
}

// ---- Gbrpf16Frame ----------------------------------------------------------
// Three half::f16 planes, no alpha.

fn f16_zeros(n: usize) -> Vec<half::f16> {
  vec![half::f16::ZERO; n]
}

#[test]
fn gbrpf16_frame_try_new_accepts_valid_tight() {
  let p = f16_zeros(8 * 4);
  let f = Gbrpf16LeFrame::try_new(&p, &p, &p, 8, 4, 8, 8, 8).expect("valid");
  assert_eq!(f.width(), 8);
  assert_eq!(f.height(), 4);
  assert_eq!(f.g_stride(), 8);
}

#[test]
fn gbrpf16_frame_try_new_rejects_zero_dimension() {
  let p = f16_zeros(16);
  assert!(matches!(
    Gbrpf16LeFrame::try_new(&p, &p, &p, 8, 0, 8, 8, 8),
    Err(GbrFloatFrameError::ZeroDimension(_))
  ));
}

#[test]
fn gbrpf16_frame_try_new_rejects_stride_below_width() {
  let p = f16_zeros(8 * 4);
  assert!(matches!(
    Gbrpf16LeFrame::try_new(&p, &p, &p, 8, 4, 7, 8, 8),
    Err(GbrFloatFrameError::StrideBelowWidth(_))
  ));
  assert!(matches!(
    Gbrpf16LeFrame::try_new(&p, &p, &p, 8, 4, 8, 7, 8),
    Err(GbrFloatFrameError::StrideBelowWidth(_))
  ));
  assert!(matches!(
    Gbrpf16LeFrame::try_new(&p, &p, &p, 8, 4, 8, 8, 7),
    Err(GbrFloatFrameError::StrideBelowWidth(_))
  ));
}

#[test]
fn gbrpf16_frame_try_new_rejects_plane_too_short() {
  let short = f16_zeros(16);
  let full = f16_zeros(8 * 4);
  assert!(matches!(
    Gbrpf16LeFrame::try_new(&short, &full, &full, 8, 4, 8, 8, 8),
    Err(GbrFloatFrameError::InsufficientPlane(_))
  ));
  assert!(matches!(
    Gbrpf16LeFrame::try_new(&full, &short, &full, 8, 4, 8, 8, 8),
    Err(GbrFloatFrameError::InsufficientPlane(_))
  ));
  assert!(matches!(
    Gbrpf16LeFrame::try_new(&full, &full, &short, 8, 4, 8, 8, 8),
    Err(GbrFloatFrameError::InsufficientPlane(_))
  ));
}

#[test]
fn gbrpf16_frame_try_new_rejects_dimension_overflow() {
  let w: u32 = 1 << 16;
  let h: u32 = 1 << 15;
  let p: &[half::f16] = &[];
  assert!(matches!(
    Gbrpf16LeFrame::try_new(p, p, p, w, h, w, w, w),
    Err(GbrFloatFrameError::DimensionOverflow(_))
  ));
}

#[test]
fn gbrpf16_try_new_rejects_geometry_overflow() {
  #[cfg(target_pointer_width = "32")]
  {
    let stride: u32 = u32::MAX / 2 + 1;
    let p: &[half::f16] = &[];
    assert!(matches!(
      Gbrpf16LeFrame::try_new(p, p, p, 1, 3, stride, stride, stride),
      Err(GbrFloatFrameError::GeometryOverflow(_))
    ));
  }
  #[cfg(not(target_pointer_width = "32"))]
  {
    let _ = GbrFloatFrameError::GeometryOverflow(GeometryOverflow::new(0, 0));
  }
}

// ---- Gbrapf16Frame ---------------------------------------------------------
// Four half::f16 planes, with alpha.

#[test]
fn gbrapf16_frame_try_new_accepts_valid_tight() {
  let p = f16_zeros(8 * 4);
  let f = Gbrapf16LeFrame::try_new(&p, &p, &p, &p, 8, 4, 8, 8, 8, 8).expect("valid");
  assert_eq!(f.width(), 8);
  assert_eq!(f.height(), 4);
  assert_eq!(f.a_stride(), 8);
}

#[test]
fn gbrapf16_frame_try_new_rejects_zero_dimension() {
  let p = f16_zeros(16);
  assert!(matches!(
    Gbrapf16LeFrame::try_new(&p, &p, &p, &p, 0, 4, 8, 8, 8, 8),
    Err(GbrFloatFrameError::ZeroDimension(_))
  ));
}

#[test]
fn gbrapf16_frame_try_new_rejects_stride_below_width() {
  let p = f16_zeros(8 * 4);
  assert!(matches!(
    Gbrapf16LeFrame::try_new(&p, &p, &p, &p, 8, 4, 8, 8, 8, 7),
    Err(GbrFloatFrameError::StrideBelowWidth(_))
  ));
}

#[test]
fn gbrapf16_frame_try_new_rejects_plane_too_short() {
  let short = f16_zeros(16);
  let full = f16_zeros(8 * 4);
  assert!(matches!(
    Gbrapf16LeFrame::try_new(&full, &full, &full, &short, 8, 4, 8, 8, 8, 8),
    Err(GbrFloatFrameError::InsufficientPlane(_))
  ));
}

#[test]
fn gbrapf16_frame_try_new_rejects_dimension_overflow() {
  let w: u32 = 1 << 16;
  let h: u32 = 1 << 15;
  let p: &[half::f16] = &[];
  assert!(matches!(
    Gbrapf16LeFrame::try_new(p, p, p, p, w, h, w, w, w, w),
    Err(GbrFloatFrameError::DimensionOverflow(_))
  ));
}

#[test]
fn gbrapf16_try_new_rejects_geometry_overflow() {
  #[cfg(target_pointer_width = "32")]
  {
    let stride: u32 = u32::MAX / 2 + 1;
    let p: &[half::f16] = &[];
    assert!(matches!(
      Gbrapf16LeFrame::try_new(p, p, p, p, 1, 3, stride, stride, stride, stride),
      Err(GbrFloatFrameError::GeometryOverflow(_))
    ));
  }
  #[cfg(not(target_pointer_width = "32"))]
  {
    let _ = GbrFloatFrameError::GeometryOverflow(GeometryOverflow::new(0, 0));
  }
}

// ---- Phase 4: BE alias + is_be() exposure ---------------------------------

#[test]
fn gbrpf32_le_alias_is_be_returns_false() {
  let p = vec![0.0f32; 16];
  let f = Gbrpf32LeFrame::try_new(&p, &p, &p, 4, 4, 4, 4, 4).unwrap();
  assert!(!f.is_be());
}

#[test]
fn gbrpf32_be_alias_constructs_and_is_be() {
  let p = vec![0.0f32; 16];
  let f = Gbrpf32BeFrame::try_new(&p, &p, &p, 4, 4, 4, 4, 4).unwrap();
  assert!(f.is_be());
  assert_eq!(f.width(), 4);
  assert_eq!(f.height(), 4);
}

#[test]
fn gbrapf32_be_alias_constructs() {
  let p = vec![0.0f32; 16];
  let f = Gbrapf32BeFrame::try_new(&p, &p, &p, &p, 4, 4, 4, 4, 4, 4).unwrap();
  assert!(f.is_be());
}

#[test]
fn gbrpf16_be_alias_constructs() {
  let p = vec![half::f16::ZERO; 16];
  let f = Gbrpf16BeFrame::try_new(&p, &p, &p, 4, 4, 4, 4, 4).unwrap();
  assert!(f.is_be());
}

#[test]
fn gbrapf16_be_alias_constructs() {
  let p = vec![half::f16::ZERO; 16];
  let f = Gbrapf16BeFrame::try_new(&p, &p, &p, &p, 4, 4, 4, 4, 4, 4).unwrap();
  assert!(f.is_be());
}