librtmp2 0.1.1

librtmp2 — RTMP/RTMPS protocol library
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
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
//! AMF0 encoder/decoder
//!
//! Mirrors `src/amf/amf.h` and `src/amf/amf0.c`.

use crate::buffer::Buffer;
use crate::types::ErrorCode;
use crate::types::Result;

/* AMF0 type markers */
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[repr(u8)]
pub enum Amf0Type {
    Number = 0x00,
    Boolean = 0x01,
    String = 0x02,
    Object = 0x03,
    Movieclip = 0x04,
    Null = 0x05,
    Undefined = 0x06,
    Reference = 0x07,
    EcmaArray = 0x08,
    ObjectEnd = 0x09,
    StrictArray = 0x0A,
    Date = 0x0B,
    LongString = 0x0C,
    Unsupported = 0x0D,
    Recordset = 0x0E,
    XmlDoc = 0x0F,
    TypedObject = 0x10,
    Avmplus = 0x11,
}

impl Amf0Type {
    pub fn as_str(self) -> &'static str {
        match self {
            Amf0Type::Number => "number",
            Amf0Type::Boolean => "boolean",
            Amf0Type::String => "string",
            Amf0Type::Object => "object",
            Amf0Type::Null => "null",
            Amf0Type::Undefined => "undefined",
            Amf0Type::EcmaArray => "ecma_array",
            Amf0Type::LongString => "long_string",
            _ => "unknown",
        }
    }
}

/* ── HELPERS ── */

fn read_u8(buf: &mut Buffer) -> Result<u8> {
    let mut val = [0u8; 1];
    buf.read(&mut val).map_err(|_| ErrorCode::Io)?;
    Ok(val[0])
}

fn read_u16(buf: &mut Buffer) -> Result<u16> {
    let mut b = [0u8; 2];
    buf.read(&mut b).map_err(|_| ErrorCode::Io)?;
    Ok(((b[0] as u16) << 8) | (b[1] as u16))
}

fn read_u32(buf: &mut Buffer) -> Result<u32> {
    let mut b = [0u8; 4];
    buf.read(&mut b).map_err(|_| ErrorCode::Io)?;
    Ok(((b[0] as u32) << 24) | ((b[1] as u32) << 16) | ((b[2] as u32) << 8) | (b[3] as u32))
}

fn read_double(buf: &mut Buffer) -> Result<f64> {
    let mut b = [0u8; 8];
    buf.read(&mut b).map_err(|_| ErrorCode::Io)?;
    let mut bits: u64 = 0;
    for i in 0..8 {
        bits |= (b[i] as u64) << ((7 - i) * 8);
    }
    Ok(f64::from_bits(bits))
}

/* ── ENCODER ── */

/// Write an AMF0 number (double, 8 bytes big-endian).
pub fn write_number(buf: &mut Buffer, value: f64) -> Result<()> {
    buf.write(&[Amf0Type::Number as u8])
        .map_err(|_| ErrorCode::Internal)?;
    let bits = value.to_bits();
    let mut b = [0u8; 8];
    for i in 0..8 {
        b[i] = (bits >> ((7 - i) * 8)) as u8;
    }
    buf.write(&b).map_err(|_| ErrorCode::Internal)?;
    Ok(())
}

/// Write an AMF0 boolean.
pub fn write_boolean(buf: &mut Buffer, value: bool) -> Result<()> {
    buf.write(&[Amf0Type::Boolean as u8])
        .map_err(|_| ErrorCode::Internal)?;
    buf.write(&[if value { 1 } else { 0 }])
        .map_err(|_| ErrorCode::Internal)?;
    Ok(())
}

/// Write an AMF0 null.
pub fn write_null(buf: &mut Buffer) -> Result<()> {
    buf.write(&[Amf0Type::Null as u8])
        .map_err(|_| ErrorCode::Internal)?;
    Ok(())
}

/// Write an AMF0 undefined.
pub fn write_undefined(buf: &mut Buffer) -> Result<()> {
    buf.write(&[Amf0Type::Undefined as u8])
        .map_err(|_| ErrorCode::Internal)?;
    Ok(())
}

/// Write an AMF0 string (2-byte length + UTF-8).
pub fn write_string(buf: &mut Buffer, s: &str) -> Result<()> {
    let len = s.len();
    if len > u16::MAX as usize {
        return Err(ErrorCode::Amf);
    }
    buf.write(&[Amf0Type::String as u8])
        .map_err(|_| ErrorCode::Internal)?;
    buf.write(&(len as u16).to_be_bytes())
        .map_err(|_| ErrorCode::Internal)?;
    buf.write(s.as_bytes()).map_err(|_| ErrorCode::Internal)?;
    Ok(())
}

/// Write an AMF0 long string (4-byte length + UTF-8).
pub fn write_long_string(buf: &mut Buffer, s: &str) -> Result<()> {
    let len = s.len();
    if len > u32::MAX as usize {
        return Err(ErrorCode::Amf);
    }
    buf.write(&[Amf0Type::LongString as u8])
        .map_err(|_| ErrorCode::Internal)?;
    buf.write(&(len as u32).to_be_bytes())
        .map_err(|_| ErrorCode::Internal)?;
    buf.write(s.as_bytes()).map_err(|_| ErrorCode::Internal)?;
    Ok(())
}

/// Write the beginning of an AMF0 object.
pub fn write_object_begin(buf: &mut Buffer) -> Result<()> {
    buf.write(&[Amf0Type::Object as u8])
        .map_err(|_| ErrorCode::Internal)?;
    Ok(())
}

/// Write the end of an AMF0 object (0x00 0x00 0x09).
pub fn write_object_end(buf: &mut Buffer) -> Result<()> {
    buf.write(&[0x00, 0x00, 0x09])
        .map_err(|_| ErrorCode::Internal)?;
    Ok(())
}

/// Write an AMF0 object key (2-byte length + UTF-8).
pub fn write_object_key(buf: &mut Buffer, key: &str) -> Result<()> {
    let len = key.len();
    if len > u16::MAX as usize {
        return Err(ErrorCode::Amf);
    }
    buf.write(&(len as u16).to_be_bytes())
        .map_err(|_| ErrorCode::Internal)?;
    buf.write(key.as_bytes()).map_err(|_| ErrorCode::Internal)?;
    Ok(())
}

/// Write the beginning of an AMF0 ECMA array (4-byte count).
pub fn write_ecma_array_begin(buf: &mut Buffer, count: u32) -> Result<()> {
    buf.write(&[Amf0Type::EcmaArray as u8])
        .map_err(|_| ErrorCode::Internal)?;
    buf.write(&count.to_be_bytes())
        .map_err(|_| ErrorCode::Internal)?;
    Ok(())
}

/* ── DECODER ── */

/// Read an AMF0 type marker.
pub fn read_type(buf: &mut Buffer) -> Result<Amf0Type> {
    let t = read_u8(buf)?;
    Ok(match t {
        0x00 => Amf0Type::Number,
        0x01 => Amf0Type::Boolean,
        0x02 => Amf0Type::String,
        0x03 => Amf0Type::Object,
        0x04 => Amf0Type::Movieclip,
        0x05 => Amf0Type::Null,
        0x06 => Amf0Type::Undefined,
        0x07 => Amf0Type::Reference,
        0x08 => Amf0Type::EcmaArray,
        0x09 => Amf0Type::ObjectEnd,
        0x0A => Amf0Type::StrictArray,
        0x0B => Amf0Type::Date,
        0x0C => Amf0Type::LongString,
        0x0D => Amf0Type::Unsupported,
        0x0E => Amf0Type::Recordset,
        0x0F => Amf0Type::XmlDoc,
        0x10 => Amf0Type::TypedObject,
        0x11 => Amf0Type::Avmplus,
        _ => return Err(ErrorCode::Amf),
    })
}

/// Read an AMF0 number (without type marker).
pub fn read_number(buf: &mut Buffer) -> Result<f64> {
    read_double(buf)
}

/// Read an AMF0 boolean.
pub fn read_boolean(buf: &mut Buffer) -> Result<bool> {
    let b = read_u8(buf)?;
    Ok(b != 0)
}

/// Read an AMF0 string into a byte buffer.
pub fn read_string(buf: &mut Buffer, out: &mut [u8]) -> Result<usize> {
    let ty = read_u8(buf)?;
    if ty != Amf0Type::String as u8 {
        return Err(ErrorCode::Amf);
    }
    let str_len = read_u16(buf)? as usize;
    if str_len >= out.len() {
        return Err(ErrorCode::Amf);
    }
    buf.read(&mut out[..str_len]).map_err(|_| ErrorCode::Amf)?;
    out[str_len] = 0;
    Ok(str_len)
}

/// Read an AMF0 long string.
pub fn read_long_string(buf: &mut Buffer, out: &mut [u8]) -> Result<usize> {
    let ty = read_u8(buf)?;
    if ty != Amf0Type::LongString as u8 {
        return Err(ErrorCode::Amf);
    }
    let str_len = read_u32(buf)? as usize;
    if out.is_empty() || str_len >= out.len() {
        return Err(ErrorCode::Amf);
    }
    buf.read(&mut out[..str_len]).map_err(|_| ErrorCode::Amf)?;
    out[str_len] = 0;
    Ok(str_len)
}

/// Read the beginning of an AMF0 object.
pub fn read_object_begin(buf: &mut Buffer) -> Result<()> {
    let ty = read_u8(buf)?;
    if ty != Amf0Type::Object as u8 {
        return Err(ErrorCode::Amf);
    }
    Ok(())
}

/// Read an AMF0 object key.
pub fn read_object_key(buf: &mut Buffer, out: &mut [u8]) -> Result<usize> {
    let klen = read_u16(buf)? as usize;
    if klen >= out.len() {
        return Err(ErrorCode::Amf);
    }
    buf.read(&mut out[..klen]).map_err(|_| ErrorCode::Amf)?;
    out[klen] = 0;
    Ok(klen)
}

/// Check if the next 3 bytes are the object end marker (0x00 0x00 0x09).
pub fn is_object_end(buf: &mut Buffer) -> bool {
    let peek = buf.peek();
    if peek.len() < 3 {
        return false;
    }
    peek[0] == 0x00 && peek[1] == 0x00 && peek[2] == 0x09
}

const MAX_SKIP_DEPTH: i32 = 32;
const MAX_OBJECT_KEYS: usize = 256;

fn skip_value_depth(buf: &mut Buffer, depth: i32) -> Result<()> {
    let ty = read_type(buf)?;

    match ty {
        Amf0Type::Number => {
            read_double(buf)?;
            Ok(())
        }
        Amf0Type::Boolean => {
            read_u8(buf)?;
            Ok(())
        }
        Amf0Type::String => {
            let len = read_u16(buf)? as usize;
            if buf.available() < len {
                return Err(ErrorCode::Io);
            }
            buf.drain(len);
            Ok(())
        }
        Amf0Type::LongString => {
            let len = read_u32(buf)? as usize;
            if buf.available() < len {
                return Err(ErrorCode::Io);
            }
            buf.drain(len);
            Ok(())
        }
        Amf0Type::StrictArray => {
            if depth >= MAX_SKIP_DEPTH {
                return Err(ErrorCode::Amf);
            }
            let count = read_u32(buf)? as usize;
            if count > MAX_OBJECT_KEYS {
                return Err(ErrorCode::Amf);
            }
            for _ in 0..count {
                skip_value_depth(buf, depth + 1)?;
            }
            Ok(())
        }
        Amf0Type::Object | Amf0Type::EcmaArray => {
            if depth >= MAX_SKIP_DEPTH {
                return Err(ErrorCode::Amf);
            }
            if ty == Amf0Type::EcmaArray {
                read_u32(buf)?; // ecma count
            }
            let mut keys = 0;
            loop {
                if is_object_end(buf) {
                    let mut end = [0u8; 3];
                    buf.read(&mut end).map_err(|_| ErrorCode::Io)?;
                    return Ok(());
                }
                keys += 1;
                if keys > MAX_OBJECT_KEYS {
                    return Err(ErrorCode::Amf);
                }
                let klen = read_u16(buf)? as usize;
                if buf.available() < klen {
                    return Err(ErrorCode::Io);
                }
                buf.drain(klen);
                skip_value_depth(buf, depth + 1)?;
            }
        }
        Amf0Type::Date => {
            // 8-byte double (ms since epoch) + 2-byte timezone field.
            if buf.available() < 10 {
                return Err(ErrorCode::Io);
            }
            buf.drain(10);
            Ok(())
        }
        Amf0Type::Reference => {
            if buf.available() < 2 {
                return Err(ErrorCode::Io);
            }
            buf.drain(2);
            Ok(())
        }
        Amf0Type::Null | Amf0Type::Undefined => Ok(()),
        _ => Err(ErrorCode::Unsupported),
    }
}

/// Skip an AMF0 value.
pub fn skip_value(buf: &mut Buffer) -> Result<()> {
    skip_value_depth(buf, 0)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn string_wire_format_is_big_endian() {
        let mut buf = Buffer::new();
        write_string(&mut buf, "abc").unwrap();
        // marker(1) + len(2, big-endian) + bytes
        assert_eq!(buf.peek(), &[0x02, 0x00, 0x03, b'a', b'b', b'c']);
    }

    #[test]
    fn number_round_trips() {
        let mut buf = Buffer::new();
        write_number(&mut buf, 42.5).unwrap();
        assert_eq!(read_type(&mut buf).unwrap(), Amf0Type::Number);
        assert_eq!(read_number(&mut buf).unwrap(), 42.5);
    }

    #[test]
    fn boolean_round_trips() {
        let mut buf = Buffer::new();
        write_boolean(&mut buf, true).unwrap();
        assert_eq!(read_type(&mut buf).unwrap(), Amf0Type::Boolean);
        assert!(read_boolean(&mut buf).unwrap());
    }

    #[test]
    fn string_round_trips_through_read_string() {
        let mut buf = Buffer::new();
        write_string(&mut buf, "hello").unwrap();
        let mut out = [0u8; 16];
        let len = read_string(&mut buf, &mut out).unwrap();
        assert_eq!(&out[..len], b"hello");
    }

    #[test]
    fn long_string_wire_format_is_big_endian() {
        let mut buf = Buffer::new();
        write_long_string(&mut buf, "x").unwrap();
        assert_eq!(buf.peek(), &[0x0C, 0x00, 0x00, 0x00, 0x01, b'x']);
    }

    #[test]
    fn object_key_wire_format_is_big_endian() {
        let mut buf = Buffer::new();
        write_object_key(&mut buf, "k").unwrap();
        assert_eq!(buf.peek(), &[0x00, 0x01, b'k']);
    }

    #[test]
    fn strict_array_can_be_skipped() {
        let mut buf = Buffer::new();
        buf.write(&[
            0x0A, 0x00, 0x00, 0x00, 0x01, 0x02, 0x00, 0x04, b'a', b'v', b'0', b'1',
        ])
        .unwrap();
        skip_value(&mut buf).unwrap();
        assert_eq!(buf.available(), 0);
    }

    #[test]
    fn ecma_array_begin_wire_format_is_big_endian() {
        let mut buf = Buffer::new();
        write_ecma_array_begin(&mut buf, 2).unwrap();
        assert_eq!(buf.peek(), &[0x08, 0x00, 0x00, 0x00, 0x02]);
    }

    #[test]
    fn skip_value_skips_nested_object() {
        let mut buf = Buffer::new();
        write_object_begin(&mut buf).unwrap();
        write_object_key(&mut buf, "a").unwrap();
        write_number(&mut buf, 1.0).unwrap();
        write_object_end(&mut buf).unwrap();
        write_number(&mut buf, 2.0).unwrap();

        skip_value(&mut buf).unwrap();
        assert_eq!(read_type(&mut buf).unwrap(), Amf0Type::Number);
        assert_eq!(read_number(&mut buf).unwrap(), 2.0);
    }

    #[test]
    fn is_object_end_detects_marker() {
        let mut buf = Buffer::new();
        write_object_end(&mut buf).unwrap();
        assert!(is_object_end(&mut buf));
    }
}