Auto merge of #241 - troy/remove-bytesio, r=lennartkloock

create scuffle-bytes-util
Rename `bytesio` to `scuffle-bytes-util`. We also remove the wrapper types we had and optimize the `Cursor<Bytes>` usage. A lot of what we did with the wrapper types was essentially what `BytesMut` does and what `Vec<u8>` does, which is why most of the usage has been replaced with that.

These changes allow for the code to have fewer copies in the rtmp implementation (I will look to further clean up the tests and code there in a future PR).

The old rtmp flow was such:

- copy bytes from wire into a temporary buffer
- copy that buffer into the chunk decoder (or handshake buffer) buffer
- parse chunks/handshake
- create a temporary buffer to write back result
- copy result from tmp buffer onto wire.

The new flow looks like:

- copy bytes from wire into a buffer
- parse chunks/handshake
- write result into a buffer
- copy result onto the wire

The newer example reuses existing buffers; so each connection will store additional memory (roughly 10kb/connection). As apposed to creating a buffer each time we want to read or write we just reuse an existing one.

We also remove the additional copy to the handshake or chunk decode buffers by having them all share the same buffer (the read buffer).

CLOUD-23

Requested-by: lennartkloock <[email protected]>
Reviewed-by: lennartkloock <[email protected]>

Author: scuffle-brawl[bot]

Cargo.lock

@@ -25,7 +25,6 @@ members = [
     "crates/aac",
     "crates/amf0",
     "crates/av1",
-    "crates/bytesio",
     "crates/exp_golomb",
     "crates/flv",
     "crates/h264",
@@ -35,7 +34,7 @@ members = [
     "crates/transmuxer",
     "dev-tools/xtask",
     "crates/future-ext",
-    "crates/bitio",
+    "crates/bytes-util",
 ]
 
 resolver = "2"
@@ -60,7 +59,7 @@ scuffle-h3-webtransport = { path = "crates/h3-webtransport", version = "0.0.2" }
 scuffle-metrics-derive = { path = "crates/metrics/derive", version = "0.0.2" }
 scuffle-ffmpeg-sys = { path = "crates/ffmpeg-sys", version = "7.1.0" }
 scuffle-future-ext = { path = "crates/future-ext", version = "0.0.1" }
-scuffle-bitio = { path = "crates/bitio", version = "0.0.1" }
+scuffle-bytes-util = { path = "crates/bytes-util", version = "0.0.1" }
 
 [profile.release-debug]
 inherits = "release"

Cargo.toml

@@ -13,4 +13,4 @@ byteorder = "1.5"
 num-traits = "0.2"
 num-derive = "0.4"
 scuffle-workspace-hack.workspace = true
-scuffle-bitio = { workspace = true }
+scuffle-bytes-util.workspace = true

crates/aac/Cargo.toml

@@ -4,7 +4,7 @@ use std::io;
 
 use num_derive::FromPrimitive;
 use num_traits::FromPrimitive;
-use scuffle_bitio::BitReader;
+use scuffle_bytes_util::BitReader;
 
 /// A Partial Audio Specific Config
 /// ISO/IEC 14496-3:2019(E) - 1.6

crates/aac/src/lib.rs

@@ -9,6 +9,5 @@ bytes = "1.5"
 byteorder = "1.5"
 num-traits = "0.2"
 num-derive = "0.4"
-bytesio = { path = "../bytesio" }
+scuffle-bytes-util.workspace = true
 scuffle-workspace-hack.workspace = true
-scuffle-bitio = { workspace = true }

crates/amf0/Cargo.toml

@@ -7,6 +7,5 @@ license = "MIT OR Apache-2.0"
 [dependencies]
 bytes = "1.5"
 byteorder = "1.5"
-bytesio = { path = "../bytesio" }
-scuffle-bitio = { workspace = true }
+scuffle-bytes-util.workspace = true
 scuffle-workspace-hack.workspace = true

crates/av1/Cargo.toml

@@ -1,8 +1,7 @@
 use std::io;
 
 use bytes::Bytes;
-use bytesio::bytes_reader::BytesCursor;
-use scuffle_bitio::{BitReader, BitWriter};
+use scuffle_bytes_util::{BitReader, BitWriter, BytesCursorExt};
 
 #[derive(Debug, Clone, PartialEq)]
 /// AV1 Codec Configuration Record

crates/av1/src/config.rs

@@ -3,7 +3,7 @@ use std::io::{
 };
 
 use bytes::Bytes;
-use scuffle_bitio::BitReader;
+use scuffle_bytes_util::BitReader;
 
 pub mod seq;
 

crates/av1/src/obu/mod.rs

@@ -2,7 +2,7 @@ use std::io;
 
 use byteorder::{BigEndian, ReadBytesExt};
 use bytes::Bytes;
-use scuffle_bitio::BitReader;
+use scuffle_bytes_util::BitReader;
 
 use super::ObuHeader;
 use crate::obu::read_uvlc;

crates/av1/src/obu/seq.rs

@@ -1,6 +1,6 @@
 use std::io;
 
-use scuffle_bitio::BitReader;
+use scuffle_bytes_util::BitReader;
 
 use crate::config::AV1CodecConfigurationRecord;
 use crate::seq::{ColorConfig, OperatingPoint, SequenceHeaderObu};

crates/av1/src/tests.rs

@@ -1,5 +1,5 @@
 [package]
-name = "scuffle-bitio"
+name = "scuffle-bytes-util"
 version = "0.0.1"
 edition = "2021"
 license = "MIT OR Apache-2.0"
@@ -8,4 +8,5 @@ license = "MIT OR Apache-2.0"
 unexpected_cfgs = { level = "warn", check-cfg = ['cfg(coverage_nightly)'] }
 
 [dependencies]
+bytes = "1.5"
 scuffle-workspace-hack.workspace = true

crates/bitio/src/lib.rs

@@ -1,13 +1,13 @@
-# scuffle-bitio
+# scuffle-bytes-util
 
 > [!WARNING]  
 > This crate is under active development and may not be stable.
 
-[![crates.io](https://img.shields.io/crates/v/scuffle-bitio.svg)](https://crates.io/crates/scuffle-bitio) [![docs.rs](https://img.shields.io/docsrs/scuffle-bitio)](https://docs.rs/scuffle-bitio)
+[![crates.io](https://img.shields.io/crates/v/scuffle-bytes-util.svg)](https://crates.io/crates/scuffle-bytes-util) [![docs.rs](https://img.shields.io/docsrs/scuffle-bytes-util)](https://docs.rs/scuffle-bytes-util)
 
 ---
 
-Adds a simple interface for writing and reading bits to and from a stream.
+Adds some helpful utilities for working with bits and bytes.
 
 ## License