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 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
#[cfg(test)]
mod vp9_test;
use std::fmt;
use std::sync::Arc;
use bytes::{Buf, BufMut, Bytes, BytesMut};
use crate::error::{Error, Result};
use crate::packetizer::{Depacketizer, Payloader};
/// Flexible mode 15 bit picture ID
const VP9HEADER_SIZE: usize = 3;
const MAX_SPATIAL_LAYERS: u8 = 5;
const MAX_VP9REF_PICS: usize = 3;
/// InitialPictureIDFn is a function that returns random initial picture ID.
pub type InitialPictureIDFn = Arc<dyn (Fn() -> u16) + Send + Sync>;
/// Vp9Payloader payloads VP9 packets
#[derive(Default, Clone)]
pub struct Vp9Payloader {
picture_id: u16,
initialized: bool,
pub initial_picture_id_fn: Option<InitialPictureIDFn>,
}
impl fmt::Debug for Vp9Payloader {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("Vp9Payloader")
.field("picture_id", &self.picture_id)
.field("initialized", &self.initialized)
.finish()
}
}
impl Payloader for Vp9Payloader {
/// Payload fragments an Vp9Payloader packet across one or more byte arrays
fn payload(&mut self, mtu: usize, payload: &Bytes) -> Result<Vec<Bytes>> {
/*
* https://www.ietf.org/id/draft-ietf-payload-vp9-13.txt
*
* Flexible mode (F=1)
* 0 1 2 3 4 5 6 7
* +-+-+-+-+-+-+-+-+
* |I|P|L|F|B|E|V|Z| (REQUIRED)
* +-+-+-+-+-+-+-+-+
* I: |M| PICTURE ID | (REQUIRED)
* +-+-+-+-+-+-+-+-+
* M: | EXTENDED PID | (RECOMMENDED)
* +-+-+-+-+-+-+-+-+
* L: | tid |U| SID |D| (CONDITIONALLY RECOMMENDED)
* +-+-+-+-+-+-+-+-+ -\
* P,F: | P_DIFF |N| (CONDITIONALLY REQUIRED) - up to 3 times
* +-+-+-+-+-+-+-+-+ -/
* V: | SS |
* | .. |
* +-+-+-+-+-+-+-+-+
*
* Non-flexible mode (F=0)
* 0 1 2 3 4 5 6 7
* +-+-+-+-+-+-+-+-+
* |I|P|L|F|B|E|V|Z| (REQUIRED)
* +-+-+-+-+-+-+-+-+
* I: |M| PICTURE ID | (RECOMMENDED)
* +-+-+-+-+-+-+-+-+
* M: | EXTENDED PID | (RECOMMENDED)
* +-+-+-+-+-+-+-+-+
* L: | tid |U| SID |D| (CONDITIONALLY RECOMMENDED)
* +-+-+-+-+-+-+-+-+
* | tl0picidx | (CONDITIONALLY REQUIRED)
* +-+-+-+-+-+-+-+-+
* V: | SS |
* | .. |
* +-+-+-+-+-+-+-+-+
*/
if payload.is_empty() || mtu == 0 {
return Ok(vec![]);
}
if !self.initialized {
if self.initial_picture_id_fn.is_none() {
self.initial_picture_id_fn =
Some(Arc::new(|| -> u16 { rand::random::<u16>() & 0x7FFF }));
}
self.picture_id = if let Some(f) = &self.initial_picture_id_fn {
f()
} else {
0
};
self.initialized = true;
}
let max_fragment_size = mtu as isize - VP9HEADER_SIZE as isize;
let mut payloads = vec![];
let mut payload_data_remaining = payload.len();
let mut payload_data_index = 0;
if std::cmp::min(max_fragment_size, payload_data_remaining as isize) <= 0 {
return Ok(vec![]);
}
while payload_data_remaining > 0 {
let current_fragment_size =
std::cmp::min(max_fragment_size as usize, payload_data_remaining);
let mut out = BytesMut::with_capacity(VP9HEADER_SIZE + current_fragment_size);
let mut buf = [0u8; VP9HEADER_SIZE];
buf[0] = 0x90; // F=1 I=1
if payload_data_index == 0 {
buf[0] |= 0x08; // B=1
}
if payload_data_remaining == current_fragment_size {
buf[0] |= 0x04; // E=1
}
buf[1] = (self.picture_id >> 8) as u8 | 0x80;
buf[2] = (self.picture_id & 0xFF) as u8;
out.put(&buf[..]);
out.put(
&*payload.slice(payload_data_index..payload_data_index + current_fragment_size),
);
payloads.push(out.freeze());
payload_data_remaining -= current_fragment_size;
payload_data_index += current_fragment_size;
}
self.picture_id += 1;
self.picture_id &= 0x7FFF;
Ok(payloads)
}
fn clone_to(&self) -> Box<dyn Payloader + Send + Sync> {
Box::new(self.clone())
}
}
/// Vp9Packet represents the VP9 header that is stored in the payload of an RTP Packet
#[derive(PartialEq, Eq, Debug, Default, Clone)]
pub struct Vp9Packet {
/// picture ID is present
pub i: bool,
/// inter-picture predicted frame.
pub p: bool,
/// layer indices present
pub l: bool,
/// flexible mode
pub f: bool,
/// start of frame. beginning of new vp9 frame
pub b: bool,
/// end of frame
pub e: bool,
/// scalability structure (SS) present
pub v: bool,
/// Not a reference frame for upper spatial layers
pub z: bool,
/// Recommended headers
/// 7 or 16 bits, picture ID.
pub picture_id: u16,
/// Conditionally recommended headers
/// Temporal layer ID
pub tid: u8,
/// Switching up point
pub u: bool,
/// Spatial layer ID
pub sid: u8,
/// Inter-layer dependency used
pub d: bool,
/// Conditionally required headers
/// Reference index (F=1)
pub pdiff: Vec<u8>,
/// Temporal layer zero index (F=0)
pub tl0picidx: u8,
/// Scalability structure headers
/// N_S + 1 indicates the number of spatial layers present in the VP9 stream
pub ns: u8,
/// Each spatial layer's frame resolution present
pub y: bool,
/// PG description present flag.
pub g: bool,
/// N_G indicates the number of pictures in a Picture Group (PG)
pub ng: u8,
pub width: Vec<u16>,
pub height: Vec<u16>,
/// Temporal layer ID of pictures in a Picture Group
pub pgtid: Vec<u8>,
/// Switching up point of pictures in a Picture Group
pub pgu: Vec<bool>,
/// Reference indices of pictures in a Picture Group
pub pgpdiff: Vec<Vec<u8>>,
}
impl Depacketizer for Vp9Packet {
/// depacketize parses the passed byte slice and stores the result in the Vp9Packet this method is called upon
fn depacketize(&mut self, packet: &Bytes) -> Result<Bytes> {
if packet.is_empty() {
return Err(Error::ErrShortPacket);
}
let reader = &mut packet.clone();
let b = reader.get_u8();
self.i = (b & 0x80) != 0;
self.p = (b & 0x40) != 0;
self.l = (b & 0x20) != 0;
self.f = (b & 0x10) != 0;
self.b = (b & 0x08) != 0;
self.e = (b & 0x04) != 0;
self.v = (b & 0x02) != 0;
self.z = (b & 0x01) != 0;
let mut payload_index = 1;
if self.i {
payload_index = self.parse_picture_id(reader, payload_index)?;
}
if self.l {
payload_index = self.parse_layer_info(reader, payload_index)?;
}
if self.f && self.p {
payload_index = self.parse_ref_indices(reader, payload_index)?;
}
if self.v {
payload_index = self.parse_ssdata(reader, payload_index)?;
}
Ok(packet.slice(payload_index..))
}
/// is_partition_head checks whether if this is a head of the VP9 partition
fn is_partition_head(&self, payload: &Bytes) -> bool {
if payload.is_empty() {
false
} else {
(payload[0] & 0x08) != 0
}
}
fn is_partition_tail(&self, marker: bool, _payload: &Bytes) -> bool {
marker
}
}
impl Vp9Packet {
// Picture ID:
//
// +-+-+-+-+-+-+-+-+
// I: |M| PICTURE ID | M:0 => picture id is 7 bits.
// +-+-+-+-+-+-+-+-+ M:1 => picture id is 15 bits.
// M: | EXTENDED PID |
// +-+-+-+-+-+-+-+-+
//
fn parse_picture_id(
&mut self,
reader: &mut dyn Buf,
mut payload_index: usize,
) -> Result<usize> {
if reader.remaining() == 0 {
return Err(Error::ErrShortPacket);
}
let b = reader.get_u8();
payload_index += 1;
// PID present?
if (b & 0x80) != 0 {
if reader.remaining() == 0 {
return Err(Error::ErrShortPacket);
}
// M == 1, PID is 15bit
self.picture_id = (((b & 0x7f) as u16) << 8) | (reader.get_u8() as u16);
payload_index += 1;
} else {
self.picture_id = (b & 0x7F) as u16;
}
Ok(payload_index)
}
fn parse_layer_info(
&mut self,
reader: &mut dyn Buf,
mut payload_index: usize,
) -> Result<usize> {
payload_index = self.parse_layer_info_common(reader, payload_index)?;
if self.f {
Ok(payload_index)
} else {
self.parse_layer_info_non_flexible_mode(reader, payload_index)
}
}
// Layer indices (flexible mode):
//
// +-+-+-+-+-+-+-+-+
// L: | T |U| S |D|
// +-+-+-+-+-+-+-+-+
//
fn parse_layer_info_common(
&mut self,
reader: &mut dyn Buf,
mut payload_index: usize,
) -> Result<usize> {
if reader.remaining() == 0 {
return Err(Error::ErrShortPacket);
}
let b = reader.get_u8();
payload_index += 1;
self.tid = b >> 5;
self.u = b & 0x10 != 0;
self.sid = (b >> 1) & 0x7;
self.d = b & 0x01 != 0;
if self.sid >= MAX_SPATIAL_LAYERS {
Err(Error::ErrTooManySpatialLayers)
} else {
Ok(payload_index)
}
}
// Layer indices (non-flexible mode):
//
// +-+-+-+-+-+-+-+-+
// L: | T |U| S |D|
// +-+-+-+-+-+-+-+-+
// | tl0picidx |
// +-+-+-+-+-+-+-+-+
//
fn parse_layer_info_non_flexible_mode(
&mut self,
reader: &mut dyn Buf,
mut payload_index: usize,
) -> Result<usize> {
if reader.remaining() == 0 {
return Err(Error::ErrShortPacket);
}
self.tl0picidx = reader.get_u8();
payload_index += 1;
Ok(payload_index)
}
// Reference indices:
//
// +-+-+-+-+-+-+-+-+ P=1,F=1: At least one reference index
// P,F: | P_DIFF |N| up to 3 times has to be specified.
// +-+-+-+-+-+-+-+-+ N=1: An additional P_DIFF follows
// current P_DIFF.
//
fn parse_ref_indices(
&mut self,
reader: &mut dyn Buf,
mut payload_index: usize,
) -> Result<usize> {
let mut b = 1u8;
while (b & 0x1) != 0 {
if reader.remaining() == 0 {
return Err(Error::ErrShortPacket);
}
b = reader.get_u8();
payload_index += 1;
self.pdiff.push(b >> 1);
if self.pdiff.len() >= MAX_VP9REF_PICS {
return Err(Error::ErrTooManyPDiff);
}
}
Ok(payload_index)
}
// Scalability structure (SS):
//
// +-+-+-+-+-+-+-+-+
// V: | N_S |Y|G|-|-|-|
// +-+-+-+-+-+-+-+-+ -|
// Y: | WIDTH | (OPTIONAL) .
// + + .
// | | (OPTIONAL) .
// +-+-+-+-+-+-+-+-+ . N_S + 1 times
// | HEIGHT | (OPTIONAL) .
// + + .
// | | (OPTIONAL) .
// +-+-+-+-+-+-+-+-+ -|
// G: | N_G | (OPTIONAL)
// +-+-+-+-+-+-+-+-+ -|
// N_G: | T |U| R |-|-| (OPTIONAL) .
// +-+-+-+-+-+-+-+-+ -| . N_G times
// | P_DIFF | (OPTIONAL) . R times .
// +-+-+-+-+-+-+-+-+ -| -|
//
fn parse_ssdata(&mut self, reader: &mut dyn Buf, mut payload_index: usize) -> Result<usize> {
if reader.remaining() == 0 {
return Err(Error::ErrShortPacket);
}
let b = reader.get_u8();
payload_index += 1;
self.ns = b >> 5;
self.y = b & 0x10 != 0;
self.g = (b >> 1) & 0x7 != 0;
let ns = (self.ns + 1) as usize;
self.ng = 0;
if self.y {
if reader.remaining() < 4 * ns {
return Err(Error::ErrShortPacket);
}
self.width = vec![0u16; ns];
self.height = vec![0u16; ns];
for i in 0..ns {
self.width[i] = reader.get_u16();
self.height[i] = reader.get_u16();
}
payload_index += 4 * ns;
}
if self.g {
if reader.remaining() == 0 {
return Err(Error::ErrShortPacket);
}
self.ng = reader.get_u8();
payload_index += 1;
}
for i in 0..self.ng as usize {
if reader.remaining() == 0 {
return Err(Error::ErrShortPacket);
}
let b = reader.get_u8();
payload_index += 1;
self.pgtid.push(b >> 5);
self.pgu.push(b & 0x10 != 0);
let r = ((b >> 2) & 0x3) as usize;
if reader.remaining() < r {
return Err(Error::ErrShortPacket);
}
self.pgpdiff.push(vec![]);
for _ in 0..r {
let b = reader.get_u8();
payload_index += 1;
self.pgpdiff[i].push(b);
}
}
Ok(payload_index)
}
}