From 9260d09499b620470f639ec024af8ee6ac18bf64 Mon Sep 17 00:00:00 2001 From: The Android Open Source Project Date: Tue, 3 Mar 2009 18:28:40 -0800 Subject: auto import from //depot/cupcake/@135843 --- Tremor/doc/ov_open.html | 115 ------------------------------------------------ 1 file changed, 115 deletions(-) delete mode 100644 Tremor/doc/ov_open.html (limited to 'Tremor/doc/ov_open.html') diff --git a/Tremor/doc/ov_open.html b/Tremor/doc/ov_open.html deleted file mode 100644 index 654cae8..0000000 --- a/Tremor/doc/ov_open.html +++ /dev/null @@ -1,115 +0,0 @@ - - - -Tremor - function - ov_open - - - - - - - - - -

Tremor documentation

Tremor version 1.0 - 20020403

- -

ov_open

- -

declared in "ivorbisfile.h";

- -

This is the main function used to open and initialize an OggVorbis_File -structure. It sets up all the related decoding structure. -

The first argument must be a file pointer to an already opened file -or pipe (it need not be seekable--though this obviously restricts what -can be done with the bitstream). vf should be a pointer to the -OggVorbis_File structure--this is used for ALL the externally visible libvorbisidec -functions. Once this has been called, the same OggVorbis_File -struct should be passed to all the libvorbisidec functions. -

Also, you should be aware that ov_open(), once successful, takes complete possession of the file resource. After you have opened a file using ov_open(), you MUST close it using ov_clear(), not fclose() or any other function. -

-It is often useful to call ov_open() -simply to determine whether a given file is a vorbis bitstream. If the -ov_open() -call fails, then the file is not recognizable as such. -When you use ov_open() -for -this, you should fclose() the file pointer if, and only if, the -ov_open() -call fails. If it succeeds, you must call ov_clear() to clear -the decoder's buffers and close the file for you.

- -(Note that ov_test() provides a less expensive way to test a file for Vorbisness.)

- -

- - - - -
-

-int ov_open(FILE *f,OggVorbis_File *vf,char *initial,long ibytes);
-
-
- -

Parameters

-
-
f
-
File pointer to an already opened file -or pipe (it need not be seekable--though this obviously restricts what -can be done with the bitstream).
-
vf
-
A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisidec -functions. Once this has been called, the same OggVorbis_File -struct should be passed to all the libvorbisidec functions.
-
initial
-
Typically set to NULL. This parameter is useful if some data has already been -read from the file and the stream is not seekable. It is used in conjunction with ibytes. In this case, initial -should be a pointer to a buffer containing the data read.
-
ibytes
-
Typically set to 0. This parameter is useful if some data has already been -read from the file and the stream is not seekable. In this case, ibytes -should contain the length (in bytes) of the buffer. Used together with initial
-
- - -

Return Values

-
-
  • 0 indicates success
    • - -
  • less than zero for failure:
    • - -
    -

    - -

    Notes

    -

    If your decoder is threaded, it is recommended that you NOT call -ov_open() -in the main control thread--instead, call ov_open() IN your decode/playback -thread. This is important because ov_open() may be a fairly time-consuming -call, given that the full structure of the file is determined at this point, -which may require reading large parts of the file under certain circumstances -(determining all the logical bitstreams in one physical bitstream, for -example). See Thread Safety for other information on using libvorbisidec with threads. - - -

    -

    - - - - - - - - -

    copyright © 2002 Xiph.org

    Ogg Vorbis

    Tremor documentation

    Tremor version 1.0 - 20020403

    - - - - -- cgit v1.2.3