Add method to retrieve the checksum of the end page for a Packet
#38
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Ogg specification demands that each Ogg page has a checksum of its data for error detection and correction purposes. Logically, this checksum is an implementation detail of the Ogg transport, and higher-level decoders need not know it to parse logical bitstreams. However, specialized decoders may want to efficiently use it to compute a checksum of the data that flows through it, avoiding hashing packet data again (this is my concrete use case for that). In addition, testing code may also find use in a checksum to assert that the data of the page a packet belongs to is reasonably similar to what's expected.
Given that the Ogg parsing code already reads and compares page checksums, exposing them in the public
Packet
API, which already allows users to retrieve Ogg encapsulation data such as the granule position, comes at practically no additional cost.