devela::_dep::symphonia::core::io::vlc

Struct CodebookBuilder

pub struct CodebookBuilder { /* private fields */ }

Available on crate feature dep_symphonia only.

Expand description

CodebookBuilder generates a Codebook using a provided codebook specification and description.

Implementations§

§

impl CodebookBuilder

pub fn new(bit_order: BitOrder) -> CodebookBuilder

Instantiates a new CodebookBuilder.

The bit_order parameter specifies if the codeword bits should be reversed when constructing the codebook. If the BitReader or BitStream reading the constructed codebook reads bits in an order different from the order of the provided codewords, then this option can be used to make them compatible.

pub fn new_sparse(bit_order: BitOrder) -> CodebookBuilder

Instantiates a new CodebookBuilder for sparse codebooks.

A sparse codebook is one in which not all codewords are valid. These invalid codewords are effectively “unused” and have no value. Therefore, it is illegal for a bitstream to contain the codeword bit pattern.

Unused codewords are marked by having a length of 0.

pub fn bits_per_read(&mut self, max_bits_per_read: u8) -> &mut CodebookBuilder

Specify the maximum number of bits that should be consumed from the source at a time. This value must be within the range 1 <= max_bits_per_read <= 16. Values outside of this range will cause this function to panic. If not provided, a value will be automatically chosen.

pub fn make<E>( &mut self, code_words: &[u32], code_lens: &[u8], values: &[<E as CodebookEntry>::ValueType], ) -> Result<Codebook<E>, Error> ⓘ
where E: CodebookEntry,

Construct a Codebook using the given codewords, their respective lengths, and values.

This function may fail if the provided codewords do not form a complete VLC tree, or if the CodebookEntry is undersized.

This function will panic if the number of code words, code lengths, and values differ.

Auto Trait Implementations§

§

Struct CodebookBuilderCopy item path

Implementations§

impl CodebookBuilder

pub fn new(bit_order: BitOrder) -> CodebookBuilder

pub fn new_sparse(bit_order: BitOrder) -> CodebookBuilder

pub fn bits_per_read(&mut self, max_bits_per_read: u8) -> &mut CodebookBuilder

pub fn make<E>( &mut self, code_words: &[u32], code_lens: &[u8], values: &[<E as CodebookEntry>::ValueType], ) -> Result<Codebook<E>, Error> ⓘwhere E: CodebookEntry,

Auto Trait Implementations§

impl Freeze for CodebookBuilder

impl RefUnwindSafe for CodebookBuilder

impl Send for CodebookBuilder

impl Sync for CodebookBuilder

impl Unpin for CodebookBuilder

impl UnwindSafe for CodebookBuilder

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> ArchivePointee for T

type ArchivedMetadata = ()

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> ByteSized for T

const BYTE_ALIGN: usize = _

const BYTE_SIZE: usize = _

fn byte_align(&self) -> usize ⓘ

fn byte_size(&self) -> usize ⓘ

fn ptr_size_ratio(&self) -> [usize; 2]

impl<T, R> Chain<R> for Twhere T: ?Sized,

fn chain<F>(self, f: F) -> Rwhere F: FnOnce(Self) -> R, Self: Sized,

fn chain_ref<F>(&self, f: F) -> Rwhere F: FnOnce(&Self) -> R,

fn chain_mut<F>(&mut self, f: F) -> Rwhere F: FnOnce(&mut Self) -> R,

impl<T> ExtAny for Twhere T: Any + ?Sized,

fn type_id() -> TypeId

fn type_of(&self) -> TypeId

fn type_name(&self) -> &'static str ⓘ

fn type_is<T: 'static>(&self) -> bool

fn as_any_ref(&self) -> &dyn Anywhere Self: Sized,

fn as_any_mut(&mut self) -> &mut dyn Anywhere Self: Sized,

fn as_any_box(self: Box<Self>) -> Box<dyn Any>where Self: Sized,

fn downcast_ref<T: 'static>(&self) -> Option<&T> ⓘ

fn downcast_mut<T: 'static>(&mut self) -> Option<&mut T> ⓘ

impl<T> ExtMem for Twhere T: ?Sized,

const NEEDS_DROP: bool = _

fn mem_align_of<T>() -> usize ⓘ

fn mem_align_of_val(&self) -> usize ⓘ

fn mem_size_of<T>() -> usize ⓘ

fn mem_size_of_val(&self) -> usize ⓘ

fn mem_copy(&self) -> Selfwhere Self: Copy,

fn mem_needs_drop(&self) -> bool

fn mem_drop(self)where Self: Sized,

fn mem_forget(self)where Self: Sized,

fn mem_replace(&mut self, other: Self) -> Selfwhere Self: Sized,

fn mem_take(&mut self) -> Selfwhere Self: Default,

fn mem_swap(&mut self, other: &mut Self)where Self: Sized,

unsafe fn mem_zeroed<T>() -> T

unsafe fn mem_transmute_copy<Src, Dst>(src: &Src) -> Dst

fn mem_as_bytes(&self) -> &[u8] ⓘwhere Self: Sync + Unpin,

fn mem_as_bytes_mut(&mut self) -> &mut [u8] ⓘwhere Self: Sync + Unpin,

impl<T> From<T> for T

fn from(t: T) -> T

impl<S> FromSample<S> for S

fn from_sample_(s: S) -> S

impl<T> Hook for T

fn hook_ref<F>(self, f: F) -> Selfwhere F: FnOnce(&Self),

fn hook_mut<F>(self, f: F) -> Selfwhere F: FnOnce(&mut Self),

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

fn in_current_span(self) -> Instrumented<Self> ⓘ

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘwhere F: FnOnce(&Self) -> bool,

impl<F, T> IntoSample<T> for Fwhere T: FromSample<F>,

fn into_sample(self) -> T

impl<T> LayoutRaw for T

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError> ⓘ

Struct CodebookBuilder

pub fn make<E>( &mut self, code_words: &[u32], code_lens: &[u8], values: &[<E as CodebookEntry>::ValueType], ) -> Result<Codebook<E>, Error> ⓘ
where E: CodebookEntry,

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T, R> Chain<R> for T
where T: ?Sized,

fn chain<F>(self, f: F) -> R
where F: FnOnce(Self) -> R, Self: Sized,

fn chain_ref<F>(&self, f: F) -> R
where F: FnOnce(&Self) -> R,

fn chain_mut<F>(&mut self, f: F) -> R
where F: FnOnce(&mut Self) -> R,

impl<T> ExtAny for T
where T: Any + ?Sized,

fn as_any_ref(&self) -> &dyn Any
where Self: Sized,

fn as_any_mut(&mut self) -> &mut dyn Any
where Self: Sized,

fn as_any_box(self: Box<Self>) -> Box<dyn Any>
where Self: Sized,

impl<T> ExtMem for T
where T: ?Sized,

fn mem_copy(&self) -> Self
where Self: Copy,

fn mem_drop(self)
where Self: Sized,

fn mem_forget(self)
where Self: Sized,

fn mem_replace(&mut self, other: Self) -> Self
where Self: Sized,

fn mem_take(&mut self) -> Self
where Self: Default,

fn mem_swap(&mut self, other: &mut Self)
where Self: Sized,

fn mem_as_bytes(&self) -> &[u8] ⓘ
where Self: Sync + Unpin,

fn mem_as_bytes_mut(&mut self) -> &mut [u8] ⓘ
where Self: Sync + Unpin,

fn hook_ref<F>(self, f: F) -> Self
where F: FnOnce(&Self),

fn hook_mut<F>(self, f: F) -> Self
where F: FnOnce(&mut Self),

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

impl<T> Ungil for T
where T: Send,