aflibfile.3

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

.PP
The functions afopen, afcreate, afread, and afwrite are all virtual and are  designed to be overriden by the derived classes. Also there are three functions called setValue1, setValue2, and setValue3. These can be used to pass implementation dependant info to a file format.
.PP
This class supports the ability to dynamically load and free these derived objects. These derived objects will each be made into a library that will be loaded only when needed.
.PP
This class can be compiled with the flag NO_MODULES. If it is then the file objects will not be dynamically loaded. Instead applications will have to link against these libraries. Also only certain file formats will be supported. 
.PP
.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION"
.PP 
.SS "aflibFile::~aflibFile ()\fC [virtual]\fP"
.PP
Destructor.
.PP
.SS "aflibFile::aflibFile ()\fC [protected]\fP"
.PP
.SH "MEMBER FUNCTION DOCUMENTATION"
.PP 
.SS "\fBaflibStatus\fP aflibFile::afcreate (const char * file, const \fBaflibConfig\fP & cfg)\fC [virtual]\fP"
.PP
Main API for opening a file or device in write mode.
.PP
This function is only used for module support. For no module support the derived classes afcreate function will be called instead. For module support this function will make a call to the derived classes function. 
.PP
Reimplemented in \fBaflibAifcFile\fP, \fBaflibAiffFile\fP, \fBaflibAuFile\fP, \fBaflibBladeFile\fP, \fBaflibLameFile\fP, \fBaflibMpgFile\fP, \fBaflibMpg123File\fP, \fBaflibOggFile\fP, \fBaflibDevFile\fP, \fBaflibSolarisSparcDevFile\fP, \fBaflibSoxFile\fP, and \fBaflibWavFile\fP.
.SS "\fBaflibStatus\fP aflibFile::afopen (const char * file, \fBaflibConfig\fP * cfg)\fC [virtual]\fP"
.PP
Main API for opening a file or device in read mode.
.PP
This function is only used for module support. For no modules support the derived classes afopen function will be called instead. For module support this function will make a call to the derived classes function. 
.PP
Reimplemented in \fBaflibAifcFile\fP, \fBaflibAiffFile\fP, \fBaflibAuFile\fP, \fBaflibBladeFile\fP, \fBaflibLameFile\fP, \fBaflibMpgFile\fP, \fBaflibMpg123File\fP, \fBaflibOggFile\fP, \fBaflibDevFile\fP, \fBaflibSolarisSparcDevFile\fP, \fBaflibSoxFile\fP, and \fBaflibWavFile\fP.
.SS "\fBaflibStatus\fP aflibFile::afread (\fBaflibData\fP & data, long long position = -1)\fC [virtual]\fP"
.PP
Main API function to read a segment of data.
.PP
This function is only used for module support. For no module support the derived classes afread function will be called instead. For module support this function will make a call to the derived classes function. 
.PP
Reimplemented in \fBaflibAifcFile\fP, \fBaflibAiffFile\fP, \fBaflibAuFile\fP, \fBaflibBladeFile\fP, \fBaflibLameFile\fP, \fBaflibMpgFile\fP, \fBaflibMpg123File\fP, \fBaflibOggFile\fP, \fBaflibDevFile\fP, \fBaflibSolarisSparcDevFile\fP, \fBaflibSoxFile\fP, and \fBaflibWavFile\fP.
.SS "\fBaflibStatus\fP aflibFile::afwrite (\fBaflibData\fP & data, long long position = -1)\fC [virtual]\fP"
.PP
Main API function to write a segment of audio data.
.PP
This function is only used for module support. For no module support the derived classes afwrite function will be called instead. For module support this function will make a call to the derived class. 
.PP
Reimplemented in \fBaflibAifcFile\fP, \fBaflibAiffFile\fP, \fBaflibAuFile\fP, \fBaflibBladeFile\fP, \fBaflibLameFile\fP, \fBaflibMpgFile\fP, \fBaflibMpg123File\fP, \fBaflibOggFile\fP, \fBaflibDevFile\fP, \fBaflibSolarisSparcDevFile\fP, \fBaflibSoxFile\fP, and \fBaflibWavFile\fP.
.SS "aflibFile * aflibFile::create (const string & format, const string & file, const \fBaflibConfig\fP & cfg, \fBaflibStatus\fP * status = NULL)\fC [static]\fP"
.PP
Main static function for writing to a device or file by format.
.PP
This is a static function of this class. Users call this function as the main API to open an audio file or device for writing. Since this is a static member function it is not associated with any aflibFile object and thus no data members can be accessed. The user passes in the file format to create. The user also specifies the file name. The specific type of audio data is specified in the cfg parameter. The status of this operation will be returned to the user as status. 
.SS "aflibFile * aflibFile::create (\fBaflibFileType\fP type_enum, const string & file, const \fBaflibConfig\fP & cfg, \fBaflibStatus\fP * status = NULL)\fC [static]\fP"
.PP
Main static function for writing to a device or file by type.
.PP
This is a static function of this class. Users call this function as the main API to open an audio file or device for writing. Since this is a static member function it is not associated with any aflibFile object and thus no data members can be accessed. The user passes in the file type to create. The user also specifies the file name. The specific type of audio data is specified in the cfg parameter. The status of this operation will be returned to the user as status. 
.SS "const string & aflibFile::getFormat () const"
.PP
Return the current file or device format.
.PP
.SS "const \fBaflibConfig\fP & aflibFile::getInputConfig () const"
.PP
.SS "bool aflibFile::getItem (const char * item, void * value)\fC [virtual]\fP"
.PP
Provides the ability to get format specific information.
.PP
This provides the ability to get specific information relating to a specific format. One passes an item that is a specific character string that will be recognized by a format. One also passes a void pointer to an allocated object of the correct type. This data will be filled with the correct information. The documentation for the specific item will say what format the data should be. TRUE will be returned if the item was processed successfully otherwise FALSE will be returned. 
.PP
Reimplemented in \fBaflibSoxFile\fP.
.SS "const \fBaflibConfig\fP & aflibFile::getOutputConfig () const"
.PP
.SS "bool aflibFile::isChannelsSupported (int & channels)\fC [virtual]\fP"
.PP
Reimplemented in \fBaflibSoxFile\fP.
.SS "bool aflibFile::isDataSizeSupported (\fBaflib_data_size\fP size)\fC [virtual]\fP"
.PP
Reimplemented in \fBaflibAifcFile\fP, \fBaflibAiffFile\fP, \fBaflibAuFile\fP, \fBaflibBladeFile\fP, \fBaflibLameFile\fP, \fBaflibMpgFile\fP, \fBaflibMpg123File\fP, \fBaflibOggFile\fP, \fBaflibDevFile\fP, \fBaflibSolarisSparcDevFile\fP, \fBaflibSoxFile\fP, and \fBaflibWavFile\fP.
.SS "bool aflibFile::isEndianSupported (\fBaflib_data_endian\fP end)\fC [virtual]\fP"
.PP
Reimplemented in \fBaflibAifcFile\fP, \fBaflibAiffFile\fP, \fBaflibAuFile\fP, \fBaflibBladeFile\fP, \fBaflibLameFile\fP, \fBaflibMpgFile\fP, \fBaflibMpg123File\fP, \fBaflibOggFile\fP, \fBaflibDevFile\fP, \fBaflibSolarisSparcDevFile\fP, \fBaflibSoxFile\fP, and \fBaflibWavFile\fP.
.SS "bool aflibFile::isSampleRateSupported (int & rate)\fC [virtual]\fP"
.PP
Reimplemented in \fBaflibAifcFile\fP, \fBaflibAiffFile\fP, \fBaflibAuFile\fP, \fBaflibBladeFile\fP, \fBaflibLameFile\fP, \fBaflibMpgFile\fP, \fBaflibMpg123File\fP, \fBaflibOggFile\fP, \fBaflibDevFile\fP, \fBaflibSolarisSparcDevFile\fP, \fBaflibSoxFile\fP, and \fBaflibWavFile\fP.
.SS "aflibFile * aflibFile::open (const string & format, const string & file, \fBaflibConfig\fP * cfg = NULL, \fBaflibStatus\fP * status = NULL)\fC [static]\fP"
.PP
Main static function to open a file or device for reading based on format string.
.PP
This is a static function of this class. Users call this function as the main API to open an audio file or device for reading. Since this is a static member function it is not associated with any aflibFile object and thus no data members can be accessed. The user passes in the file type to be opened. This must be one of the file types supplied by the function \fBaflibFile::returnSupportedFormats\fP. Also passed is the file name which should contain the file and directory in which the file can be found. Passed back to the user will be a cfg structure filled that was allocated by the caller. This will tell information about the data. Also will be a status to indicate if any errors occurred. 
.SS "aflibFile * aflibFile::open (\fBaflibFileType\fP type_enum, const string & file, \fBaflibConfig\fP * cfg = NULL, \fBaflibStatus\fP * status = NULL)\fC [static]\fP"
.PP
Main static function to open a file or device for reading based on aflibFileType.
.PP
This is a static function of this class. Users call this function as the main API to open an audio file or device for reading. Since this is a static member function it is not associated with any aflibFile object and thus no data members can be accessed. The user passes in the file type to be opened. This can be one of the defined types or AFLIB_AUTO_TYPE. This will search the list of supported formats for a match and use that format. If AFLIB_AUTO_TYPE is specified then it will open the file and use a format that matches that file type based on information supplied by each module. Also passed is the file name which should contain the file and directory in which the file can be found. Passed back to the user will be a cfg structure filled that was allocated by the caller. This will tell information about the data. Also will be a status to indicate if any errors occurred. 
.SS "const list< \fBaflibFileItem\fP * > & aflibFile::returnSupportedFormats ()\fC [static]\fP"
.PP
Returns all currently supported formats.
.PP
This public static function returns a reference to the supported module formats. See \fBaflibFileItem.h\fP for details. 
.SS "void aflibFile::returnSupportedFormats (list< string > & formats, list< string > & descriptions)\fC [static]\fP"
.PP
Returns all currently supported formats.
.PP
This public static function returns to the user two lists. The first is the list of supported formats. The second is a corresponding list of descriptions that relate to the formats returned. 
.SS "void aflibFile::setInputConfig (const \fBaflibConfig\fP & cfg)\fC [virtual]\fP"
.PP
.SS "bool aflibFile::setItem (const char * item, const void * value)\fC [virtual]\fP"
.PP
Provides the ability to set format specific information.
.PP
This provides the ability to set specific information relating to a specific format. One passes an item that is a specific character string that will be recognized by a format. One also passes a void pointer to a data item that is the data to be set. The documentation for the specific item will say what format the data should be. TRUE will be returned if the item was processed successfully otherwise FALSE will be returned. 
.PP
Reimplemented in \fBaflibMpg123File\fP, and \fBaflibDevFile\fP.
.SS "void aflibFile::setOutputConfig (const \fBaflibConfig\fP & cfg)"
.PP
.SS "void aflibFile::setValue1 (const string & value)"
.PP
Set a file format unique value number 1.
.PP
.SS "void aflibFile::setValue2 (const string & value)"
.PP
Set a file format unique value number 2.
.PP
.SS "void aflibFile::setValue3 (const string & value)"
.PP
Set a file format unique value number 3.
.PP
.SH "MEMBER DATA DOCUMENTATION"
.PP 
.SS "long aflibFile::_current_place_size\fC [protected]\fP"
.PP
.SS "long aflibFile::_one_second_size\fC [protected]\fP"
.PP
.SS "long aflibFile::_total_size\fC [protected]\fP"
.PP
.SS "string aflibFile::_value1\fC [protected]\fP"
.PP
.SS "string aflibFile::_value2\fC [protected]\fP"
.PP
.SS "string aflibFile::_value3\fC [protected]\fP"
.PP


.SH "AUTHOR"
.PP 
Generated automatically by Doxygen for Open Source Audio Library Project from the source code.