Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: fix top-level bits documentation and add update CHANGELOG #339

Merged
merged 1 commit into from
Apr 3, 2024
Merged

doc: fix top-level bits documentation and add update CHANGELOG #339

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Made bits.Mask() function public
- New counter methods added to bits.Reader
- colr box support for nclc and unknown colour_type
- av01, encv, and enca direct pointers in stsd

### Changed

Expand Down
8 changes: 4 additions & 4 deletions bits/doc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
/*
Package bits - bit and bytes reading and writing including Golomb codes and EBSP.
All readaer and writer accumulates errors in the sense that they will stop reading or writing at the first error.
The first error can be retrieved with AccError().
All readers and writers accumulate errors in the sense that they will stop reading or writing at the first error.
The first error, if any, can be retrieved with AccError().

Beyond plain bit reading and writing, reading and writing of ebsp (Encapsulated Byte Sequence Packets)
with start-code emulation prevention bytes and exponential Golomb codes as used in the AVC/H.264 and HEVC video coding standards.
Beyond plain bit reading and writing, reading and writing of ebsp (Encapsulated Byte Sequence Packets) is supported.
EBSP uses insertion of start-code emulation prevention bytes 0x03 and is used in MPEG video standards from AVC (H.264) and forward.
*/
package bits
Loading