aflibfile.3

一个共享源码的音频库5(doc 文档)

.TH "aflibFile" 3 "8 May 2002" "Open Source Audio Library Project" \" -*- nroff -*-
.ad l
.nh
.SH NAME
aflibFile \- Base class for audio file/device reading and writing. 
.SH SYNOPSIS
.br
.PP
\fC#include <aflibFile.h>\fP
.PP
Inherited by \fBaflibAifcFile\fP, \fBaflibAiffFile\fP, \fBaflibAuFile\fP, \fBaflibBladeFile\fP, \fBaflibDevFile\fP, \fBaflibLameFile\fP, \fBaflibMpg123File\fP, \fBaflibMpgFile\fP, \fBaflibOggFile\fP, \fBaflibSolarisSparcDevFile\fP, \fBaflibSoxFile\fP, and \fBaflibWavFile\fP.
.PP
.SS "Public Methods"

.in +1c
.ti -1c
.RI "virtual \fB~aflibFile\fP ()"
.br
.RI "\fIDestructor.\fP"
.ti -1c
.RI "virtual \fBaflibStatus\fP \fBafopen\fP (const char *file, \fBaflibConfig\fP *cfg)"
.br
.RI "\fIMain API for opening a file or device in read mode.\fP"
.ti -1c
.RI "virtual \fBaflibStatus\fP \fBafcreate\fP (const char *file, const \fBaflibConfig\fP &cfg)"
.br
.RI "\fIMain API for opening a file or device in write mode.\fP"
.ti -1c
.RI "virtual \fBaflibStatus\fP \fBafread\fP (\fBaflibData\fP &data, long long position=-1)"
.br
.RI "\fIMain API function to read a segment of data.\fP"
.ti -1c
.RI "virtual \fBaflibStatus\fP \fBafwrite\fP (\fBaflibData\fP &data, long long position=-1)"
.br
.RI "\fIMain API function to write a segment of audio data.\fP"
.ti -1c
.RI "virtual bool \fBsetItem\fP (const char *item, const void *value)"
.br
.RI "\fIProvides the ability to set format specific information.\fP"
.ti -1c
.RI "virtual bool \fBgetItem\fP (const char *item, void *value)"
.br
.RI "\fIProvides the ability to get format specific information.\fP"
.ti -1c
.RI "const string & \fBgetFormat\fP () const"
.br
.RI "\fIReturn the current file or device format.\fP"
.ti -1c
.RI "virtual void \fBsetInputConfig\fP (const \fBaflibConfig\fP &cfg)"
.br
.ti -1c
.RI "const \fBaflibConfig\fP & \fBgetInputConfig\fP () const"
.br
.ti -1c
.RI "void \fBsetOutputConfig\fP (const \fBaflibConfig\fP &cfg)"
.br
.ti -1c
.RI "const \fBaflibConfig\fP & \fBgetOutputConfig\fP () const"
.br
.ti -1c
.RI "void \fBsetValue1\fP (const string &value)"
.br
.RI "\fISet a file format unique value number 1.\fP"
.ti -1c
.RI "void \fBsetValue2\fP (const string &value)"
.br
.RI "\fISet a file format unique value number 2.\fP"
.ti -1c
.RI "void \fBsetValue3\fP (const string &value)"
.br
.RI "\fISet a file format unique value number 3.\fP"
.ti -1c
.RI "virtual bool \fBisDataSizeSupported\fP (\fBaflib_data_size\fP size)"
.br
.ti -1c
.RI "virtual bool \fBisEndianSupported\fP (\fBaflib_data_endian\fP end)"
.br
.ti -1c
.RI "virtual bool \fBisSampleRateSupported\fP (int &rate)"
.br
.ti -1c
.RI "virtual bool \fBisChannelsSupported\fP (int &channels)"
.br
.in -1c
.SS "Static Public Methods"

.in +1c
.ti -1c
.RI "void \fBreturnSupportedFormats\fP (list< string > &formats, list< string > &descriptions)"
.br
.RI "\fIReturns all currently supported formats.\fP"
.ti -1c
.RI "const list< \fBaflibFileItem\fP * > & \fBreturnSupportedFormats\fP ()"
.br
.RI "\fIReturns all currently supported formats.\fP"
.ti -1c
.RI "aflibFile * \fBopen\fP (\fBaflibFileType\fP type_enum, const string &file, \fBaflibConfig\fP *cfg=NULL, \fBaflibStatus\fP *status=NULL)"
.br
.RI "\fIMain static function to open a file or device for reading based on aflibFileType.\fP"
.ti -1c
.RI "aflibFile * \fBopen\fP (const string &format, const string &file, \fBaflibConfig\fP *cfg=NULL, \fBaflibStatus\fP *status=NULL)"
.br
.RI "\fIMain static function to open a file or device for reading based on format string.\fP"
.ti -1c
.RI "aflibFile * \fBcreate\fP (\fBaflibFileType\fP type_enum, const string &file, const \fBaflibConfig\fP &cfg, \fBaflibStatus\fP *status=NULL)"
.br
.RI "\fIMain static function for writing to a device or file by type.\fP"
.ti -1c
.RI "aflibFile * \fBcreate\fP (const string &format, const string &file, const \fBaflibConfig\fP &cfg, \fBaflibStatus\fP *status=NULL)"
.br
.RI "\fIMain static function for writing to a device or file by format.\fP"
.in -1c
.SS "Protected Methods"

.in +1c
.ti -1c
.RI "\fBaflibFile\fP ()"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "long \fB_total_size\fP"
.br
.ti -1c
.RI "long \fB_one_second_size\fP"
.br
.ti -1c
.RI "long \fB_current_place_size\fP"
.br
.ti -1c
.RI "string \fB_value1\fP"
.br
.ti -1c
.RI "string \fB_value2\fP"
.br
.ti -1c
.RI "string \fB_value3\fP"
.br
.in -1c
.SH "DETAILED DESCRIPTION"
.PP 
Base class for audio file/device reading and writing.
.PP
This is the base class for all audio file and device objects. It provides the functionality for calling derived classes and defines the API for these derived classes. The main entry APIs are the open and create static functions. Users actually use these. This will in turn allocate an object of the proper derived class. There are no public constructors for this class. Also static is a function called  returnSupportedFormats. It will return all the current supported file formats. Once an object is allocated and initialized then one can call getFormat to get  the file format that is currently being used.