Document zero-copy decoding input with memory-mapped files - #257
Merged
Conversation
Signed-off-by: KP Choi <kp5.choi@samsung.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Adds a "Zero-copy decoding input with memory-mapped files" section to the programmers guide.
The decoder only reads from the caller-owned bitstream buffer, so an application can map the input file into memory and pass pointers into the mapping directly instead of allocating a buffer and copying access units — no allocation, no copy, with the OS page cache doing demand paging and read-ahead. The section shows the pattern with POSIX (
mmap) and Windows (CreateFileMapping/MapViewOfFile) pseudo code, notes that it applies to both decoding API sets, and points out the synergy with tile-based partial decoding, where only the pages of the tiles actually decoded are touched. Documentation only; no code change.Follows up on the zero-copy input discussion in #228.