mirrors
/
flac
mirror of https://github.com/xiph/flac
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

minor comments

This commit is contained in:
Josh Coalson 2002-09-06 04:54:45 +00:00
parent bc8f17333e
commit 687857ac3a
2 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
include/FLAC/seekable_stream_encoder.h
View File

@ -482,7 +482,19 @@ FLAC__bool FLAC__seekable_stream_encoder_set_total_samples_estimate(FLAC__Seekab
* FLAC__stream_encoder_set_metadata().
*
* \note
* The decoder instance \b will modify the first \c SEEKTABLE block
* SEEKTABLE blocks are handled specially. Since you will not know
* the values for the seek point stream offsets, you should pass in
* a SEEKTABLE 'template', that is, a SEEKTABLE object with the
* required sample numbers (or placeholder points), with \c 0 for the
* \a frame_samples and \a stream_offset fields for each point. While
* encoding, the encoder will fill them in for you and when encoding
* is finished, it will seek back and write the real values into the
* SEEKTABLE block in the stream. There are helper routines for
* manipulating seektable template blocks; see metadata.h:
* FLAC__metadata_object_seektable_template_*().
*
* \note
* The encoder instance \b will modify the first \c SEEKTABLE block
* as it transforms the template to a valid seektable while encoding,
* but it is still up to the caller to free all metadata blocks after
* encoding.

8
include/FLAC/stream_encoder.h
View File

@ -632,6 +632,14 @@ FLAC__bool FLAC__stream_encoder_set_total_samples_estimate(FLAC__StreamEncoder *
* occur in the supplied array.
*
* \note
* By default the encoder does not create a SEEKTABLE. If one is supplied
* in the \a metadata array it will be written verbatim. However by itself
* this is not very useful as the user will not know the stream offsets for
* the seekpoints ahead of time. You must use the seekable stream encoder
* to generate a legal seektable
* (see FLAC__seekable_stream_encoder_set_metadata())
*
* \note
* A VORBIS_COMMENT block may be supplied. The vendor string in it
* will be ignored. libFLAC will use it's own vendor string. libFLAC
* will not modify the passed-in VORBIS_COMMENT's vendor string, it