From 43db9a8267823d7a8c46d7b8aafb43c0ad41173c Mon Sep 17 00:00:00 2001 From: The Android Open Source Project Date: Tue, 3 Mar 2009 19:30:49 -0800 Subject: auto import from //depot/cupcake/@135843 --- Tremor/doc/ov_callbacks.html | 78 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 78 insertions(+) create mode 100644 Tremor/doc/ov_callbacks.html (limited to 'Tremor/doc/ov_callbacks.html') diff --git a/Tremor/doc/ov_callbacks.html b/Tremor/doc/ov_callbacks.html new file mode 100644 index 0000000..776352d --- /dev/null +++ b/Tremor/doc/ov_callbacks.html @@ -0,0 +1,78 @@ + + + +Tremor - datatype - ov_callbacks + + + + + + + + + +

Tremor documentation

Tremor version 1.0 - 20020403

+ +

ov_callbacks

+ +

declared in "ivorbiscodec.h"

+ +

+The ov_callbacks structure contains file manipulation function prototypes necessary for opening, closing, seeking, and location. + +

+The ov_callbacks structure does not need to be user-defined if you are +working with stdio-based file manipulation; the ov_open() call provides default callbacks for +stdio. ov_callbacks are defined and passed to ov_open_callbacks() when +implementing non-stdio based stream manipulation (such as playback +from a memory buffer). +

+ + + + + +
+
typedef struct {
+  size_t (*read_func)  (void *ptr, size_t size, size_t nmemb, void *datasource);
+  int    (*seek_func)  (void *datasource, ogg_int64_t offset, int whence);
+  int    (*close_func) (void *datasource);
+  long   (*tell_func)  (void *datasource);
+} ov_callbacks;
+
+ +

Relevant Struct Members

+
+
read_func
+
Pointer to custom data reading function.
+
seek_func
+
Pointer to custom data seeking function. If the data source is not seekable (or the application wants the data source to be treated as unseekable at all times), the provided seek callback should always return -1 (failure).
+
close_func
+
Pointer to custom data source closure function.
+
tell_func
+
Pointer to custom data location function.
+
+ +

+ +See the callbacks and non-stdio I/O document for more +detailed information on required behavior of the various callback +functions.

+ +

+

+ + + + + + + + +

copyright © 2002 Xiph.org

Ogg Vorbis

Tremor documentation

Tremor version 1.0 - 20020403

+ + + + -- cgit v1.2.3