Package: bitstreamio 0.1.0

bitstreamio: Read and Write Bits from Files, Connections and Raw Vectors

Bit-level reading and writing are necessary when dealing with many file formats e.g. compressed data and binary files. Currently, R connections are manipulated at the byte level. This package wraps existing connections and raw vectors so that it is possible to read bits, bit sequences, unaligned bytes and low-bit representations of integers.

Authors:Mike Cheng [aut, cre, cph]

bitstreamio_0.1.0.tar.gz
bitstreamio_0.1.0.zip(r-4.7)bitstreamio_0.1.0.zip(r-4.6)bitstreamio_0.1.0.zip(r-4.5)
bitstreamio_0.1.0.tgz(r-4.6-any)bitstreamio_0.1.0.tgz(r-4.5-any)
bitstreamio_0.1.0.tar.gz(r-4.7-any)bitstreamio_0.1.0.tar.gz(r-4.6-any)
bitstreamio_0.1.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
bitstreamio/json (API)

# Install 'bitstreamio' in R:

install.packages('bitstreamio', repos = c('https://coolbutuseless.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/coolbutuseless/bitstreamio/issues

On CRAN:

4.30 score 4 stars 4 scripts 160 downloads 28 exports 0 dependencies

Last updated from:036447f7ca. Checks:9 OK. Indexed: yes.

Target	Result	Time
linux-devel-x86_64	OK	109
source / vignettes	OK	180
linux-release-x86_64	OK	113
macos-release-arm64	OK	103
macos-oldrel-arm64	OK	88
windows-devel	OK	65
windows-release	OK	73
windows-oldrel	OK	87
wasm-release	OK	91

Exports:assert_bs bits_to_raw bits_to_uint bs_advance bs_align bs_close bs_flush bs_is_aligned bs_open bs_peek bs_read_bit bs_read_byte bs_read_sint_exp_golomb bs_read_uint bs_read_uint_exp_golomb bs_write_bit bs_write_byte bs_write_sint_exp_golomb bs_write_uint bs_write_uint_exp_golomb exp_golomb_bits_to_sint exp_golomb_bits_to_uint is_bs pad_bits raw_to_bits sint_to_exp_golomb_bits uint_to_bits uint_to_exp_golomb_bits

Dependencies:

Overview

What's in the box | Read/Write with a raw vector | Reading/Write with a connection | Read/write unsigned integers at varying bit depths | Read/write integers with Exponential-Golomb coding

Rendered fromoverview.Rmdusingknitr::rmarkdown

Last update: 2025-01-13
Started: 2025-01-13

Citation

Development and contributors

Readme and manuals

Help Manual

Help page	Topics
Test if an object is a bitstream object and fail if it is not	assert_bs
Convert between logical vector of bits and raw vector	bits_to_raw raw_to_bits
Convert between bits and unsigned integers	bits_to_uint uint_to_bits
Advance bitstream	bs_advance
Align the bitstream to the given number of bits - relative to start of bitstream	bs_align
Flush bits in the buffer	bs_flush
Is the current bit connection aligned at the given number of bits for reading/writing?	bs_is_aligned
Open/close a bitstream	bs_close bs_open
Peek at bits from a bitstream i.e. examine bits without advancing bitstream	bs_peek
Read bits from a bitstream	bs_read_bit
Write unaligned bits to a bitstream	bs_write_bit
Read/Write unaligned bytes with a bitstream	bs_read_byte bs_write_byte
Read/Write Exponential-Golomb encoded signed integers	bs_read_sint_exp_golomb bs_write_sint_exp_golomb
Read/Write unsigned integers	bs_read_uint bs_write_uint
Read/Write Exponential-Golomb encoded non-negative integers	bs_read_uint_exp_golomb bs_write_uint_exp_golomb
Test if an object is a bitstream object	is_bs
Pad a logical vector to the given size	pad_bits
Convert between signed integers and Exponential-Golomb bit sequences	exp_golomb_bits_to_sint sint_to_exp_golomb_bits
Convert between non-negative integers and Exponential Golomb bit sequences	exp_golomb_bits_to_uint uint_to_exp_golomb_bits