Skip to content

Commit

Permalink
doc: fix top-level bits documentation and add update CHANGELOG
Browse files Browse the repository at this point in the history
  • Loading branch information
tobbee committed Apr 2, 2024
1 parent db0c2fc commit dd437e9
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
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
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

0 comments on commit dd437e9

Please sign in to comment.