Skip to content

doc: describe when the partial block after a seek is written #924

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

Open
Alb3e3 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

doc: describe when the partial block after a seek is written #924

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
11 changes: 10 additions & 1 deletion include/FLAC/stream_decoder.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1755,7 +1755,16 @@ FLAC_API FLAC__bool FLAC__stream_decoder_skip_single_link(FLAC__StreamDecoder *d

/** Flush the input and seek to an absolute sample.
* Decoding will resume at the given sample. Note that because of
* this, the next write callback may contain a partial block. The
* this, the next write callback may contain a partial block. That
* write callback happens while this function is still running: the
* block containing \a sample is decoded during the seek, and the
* samples from \a sample to the end of that block are handed to the
* write callback before this function returns. Decoding then
* continues with the block after it, so when \a sample lies in the
* last block of the stream there is nothing left to decode and the
* next call to FLAC__stream_decoder_process_single() returns \c true
* without another write callback, with the decoder state set to
* \c FLAC__STREAM_DECODER_END_OF_STREAM. The
* client must support seeking the input or this function will fail
* and return \c false. Furthermore, if the decoder state is
* \c FLAC__STREAM_DECODER_SEEK_ERROR, then the decoder must be flushed
Expand Down