Vorbisfile documentation

libVorbisfile version 1.65 - 20020702

ov_test_callbacks

declared in "vorbis/vorbisfile.h";  "vorbis/vorbisfile.h"で定義されている

This is an alternative function used to open and test an OggVorbis_File structure when using a data source other than a file. It allows you to specify custom file manipulation routines and sets up all the related decoding structures.
これはファイル以外のデータソースを使うときに、代わりにOggVorbis_File構造体を開き、テストする関数である。 特殊なファイル操作ルーティンを使うことができるようになる。すべてのデコード関連の準備をする。
*訳注: 「すべてのデコード関連の準備をする」とあるが「テストのために部分的に開く」の間違いと思われる。

Once this has been called, the same OggVorbis_File struct should be passed to all the libvorbisfile functions.
一度この関数が呼ばれると同じ OggVorbis_File構造体が すべてのlibvorbisfileの関数に渡されなければならない。




int ov_test_callbacks(void *datasource, OggVorbis_File *vf, char *initial, long ibytes, ov_callbacks callbacks);

Parameters

f
*訳注: datasource と思われる。
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).
あらかじめ開かれたファイルかパイプのファイルポインタ。 (移動可能である必要は無い―― たとえそれがビットストリームで可能なことを制限するとしても)
*訳注: 間違いと思われる。ov_open_callbacks() が扱うストリームは FILE* とは限らないので、 独自の操作関数が使用するデータ(構造体など)へのポインタになるだろう。
vf
A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile functions. Once this has been called, the same OggVorbis_File struct should be passed to all the libvorbisfile functions.
OggVorbis_File構造体へのポインタ。 これはすべての対外的に可視であるlibvorbisfileの関数で使用される。 一度この関数が呼ばれると同じ OggVorbis_File構造体が すべてのlibvorbisfileの関数に渡されなければならない。
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.
通常はNULLをセットする。このパラメータは移動不可能なデータストリームやファイルから、 すでにいくらかデータを読み込んでしまっている場合に便利である。ibytesバイト分結合して使われる。この場合、initial は読まれたデータがあるバッファへのポインタにする必要がある。
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.
通常は0をセットする。このパラメータは移動不可能なデータストリームやファイルから、 すでにいくらかデータを読み込んでしまっている場合に便利である。この場合、 ibytes はバッファの長さをバイト単位で指定する。initialと共に使われる。
callbacks
Pointer to a completed ov_callbacks struct which indicates desired custom file manipulation routines.
設計された独自のファイル操作ルーティンを示すための 完全な ov_callbacks 構造体へのポインタ。

Return Values

  • 0 indicates success 0は成功を示す
  • less than zero for failure: 0は未満の時は失敗である



  • copyright © 2002 Xiph.org

    Ogg Vorbis

    Vorbisfile documentation

    libVorbisfile version 1.65 - 20020702