From 1dba62f5b60aba6dd4782787617d15112eb4f230 Mon Sep 17 00:00:00 2001 From: Josh Coalson Date: Sun, 17 Jun 2001 02:38:32 +0000 Subject: [PATCH] update libFLAC section with new _set_ functions --- doc/documentation.html | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/doc/documentation.html b/doc/documentation.html index 3316016..57b281a 100644 --- a/doc/documentation.html +++ b/doc/documentation.html @@ -755,10 +755,12 @@

The basic usage of libFLAC is as follows:

    -
  1. The program creates an instance of a decoder or encoder.
    2. -
  2. The program initializes the instance and provides libFLAC with callbacks for reading, writing, error reporting, and metadata reporting.
    3. -
  3. The program calls libFLAC functions to encode or decode data, which subsequently calls the callbacks.
    4. -
  4. The program finishes the instance, which flushes the input and output.
    5. +
  5. The program creates an instance of a decoder or encoder using *_init().
    6. +
  6. The program sets the parameters of the instance and callbacks for reading, writing, error reporting, and metadata reporting using *_set_*() functions.
    7. +
  7. The program initializes the instance to validate the parameters and prepare for decoding/encoding using *_init().
    8. +
  8. The program calls *_process_*() functions to encode or decode data, which subsequently calls the callbacks.
    9. +
  9. The program finishes the instance with *_finish(), which flushes the input and output.
    10. +
  10. The instance may be used again or deleted with *_delete().

@@ -771,7 +773,7 @@ STREAM DECODER

- First we discuss the stream decoder. The instance type is FLAC__StreamDecoder. Typically the program will create a new instance by calling FLAC__stream_decoder_new(), then call FLAC__stream_decoder_init() with the addresses of the required callbacks. The program can also supply a client_data pointer to FLAC__stream_decoder_init() which will be included when calling the callbacks. + First we discuss the stream decoder. The instance type is FLAC__StreamDecoder. Typically the program will create a new instance by calling FLAC__stream_decoder_new(), then call FLAC__stream_decoder_set_*() functions to set the callbacks and client data, and call FLAC__stream_decoder_init(). The required callbacks are:

- The program must also give FLAC__stream_encoder_init() addresses for the following callbacks: + The program provide addresses for the following callbacks:

- When the program is finished encoding data, it calls FLAC__stream_encoder_finish(), which causes the encoder to encode any data still in its input pipe, and call the metadata callback with the correct encoding statistics. Then the instance may be deleted with FLAC__stream_encoder_delete() or initialized again to encode another stream. + When the program is finished encoding data, it calls FLAC__stream_encoder_finish(), which causes the encoder to encode any data still in its input pipe, and call the metadata callback with the final encoding statistics. Then the instance may be deleted with FLAC__stream_encoder_delete() or initialized again to encode another stream.

MISCELLANEOUS -- 2.7.4