From 687857ac3a335c44b228865ace1c9f953f8d6b70 Mon Sep 17 00:00:00 2001 From: Josh Coalson Date: Fri, 6 Sep 2002 04:54:45 +0000 Subject: [PATCH] minor comments --- include/FLAC/seekable_stream_encoder.h | 14 +++++++++++++- include/FLAC/stream_encoder.h | 8 ++++++++ 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/include/FLAC/seekable_stream_encoder.h b/include/FLAC/seekable_stream_encoder.h index 36c5f13..fb52643 100644 --- a/include/FLAC/seekable_stream_encoder.h +++ b/include/FLAC/seekable_stream_encoder.h @@ -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. diff --git a/include/FLAC/stream_encoder.h b/include/FLAC/stream_encoder.h index 32a0212..5684c27 100644 --- a/include/FLAC/stream_encoder.h +++ b/include/FLAC/stream_encoder.h @@ -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 -- 2.7.4