Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

WvOggSpeexEncoder Class Reference

#include <wvoggspeex.h>

Inherits WvTypedEncoder< float, unsigned char >.

Collaboration diagram for WvOggSpeexEncoder:

[legend]
List of all members.

Detailed Description

Encodes PCM audio using the Ogg Speex stream format.

Input buffer must contain a sequence of signed 'float' type values in machine order representing normalized PCM audio data.

Outbut buffer will contain part of an Ogg Speex bitstream.

See also:
WvSpeexEncoder

Definition at line 29 of file wvoggspeex.h.

Public Types

typedef float IType
typedef unsigned OType
typedef WvBufBase< ITypeIBuffer
typedef WvBufBase< OTypeOBuffer
typedef WvBufViewBase< ITypeIBufferView
typedef WvBufViewBase< OTypeOBufferView

Public Member Functions

 WvOggSpeexEncoder (const WvSpeex::BitrateSpec &bitratespec, int samplingrate, int channels=1, WvSpeex::CodecMode mode=WvSpeex::DEFAULT_MODE, int complexity=WvSpeex::DEFAULT_COMPLEXITY, long serialno=RANDOM_SERIALNO)
 Creates an Ogg Speex Encoder.

virtual ~WvOggSpeexEncoder ()
void add_comment (WvStringParm comment)
 Adds a comment to the Ogg Speex stream.

void add_comment (WVSTRING_FORMAT_DECL)
 Adds a comment to the Ogg Speex stream.

void add_tag (WvStringParm tag, WvStringParm value)
 Adds a tag to the Ogg Speex stream.

int samplingrate () const
 Returns the sampling rate.

int channels () const
 Returns the number of channels.

int samplesperframe () const
 Returns the number of samples per frame.

WvSpeex::CodecMode mode () const
 Returns the current encoding mode.

bool vbr () const
 Returns true if variable bitrate support has been enabled.

int nominalbitrate () const
 Returns the nominal bitrate.

bool encode (IBuffer &inbuf, OBuffer &outbuf, bool flush=false, bool finish=false)
 Typed variant of encode().

bool encode (WvBuf &inbuf, WvBuf &outbuf, bool flush=false, bool finish=false)
 Reads data from the input buffer, encodes it, and writes the result to the output buffer.

bool flush (IBuffer &inbuf, OBuffer &outbuf, bool finish=false)
 Typed variant of flush().

bool flush (WvBuf &inbuf, WvBuf &outbuf, bool finish=false)
 Flushes the encoder and optionally finishes it.

bool finish (OBuffer &outbuf)
 Typed variant of finish().

bool finish (WvBuf &outbuf)
 Tells the encoder that NO MORE DATA will ever be encoded.

bool isok () const
 Returns true if the encoder has not encountered an error.

bool isfinished () const
 Returns true if the encoder can no longer encode data.

WvString geterror () const
 Returns an error message if any is available.

bool reset ()
 Asks an encoder to reset itself to its initial state at creation time, if supported.

bool flushstrbuf (WvStringParm instr, WvBuf &outbuf, bool finish=false)
 Flushes data through the encoder from a string to a buffer.

bool flushstrstr (WvStringParm instr, WvString &outstr, bool finish=false)
 Flushes data through the encoder from a string to a string.

bool encodebufstr (WvBuf &inbuf, WvString &outstr, bool flush=false, bool finish=false)
 Encodes data from a buffer to a string.

bool flushbufstr (WvBuf &inbuf, WvString &outstr, bool finish=false)
 Flushes data through the encoder from a buffer to a string.

WvString strflushstr (WvStringParm instr, bool finish=false)
 Flushes data through the encoder from a string to a string.

WvString strflushbuf (WvBuf &inbuf, bool finish=false)
 Flushes data through the encoder from a buffer to a string.

bool flushmembuf (const void *inmem, size_t inlen, WvBuf &outbuf, bool finish=false)
 Flushes data through the encoder from memory to a buffer.

bool flushmemmem (const void *inmem, size_t inlen, void *outmem, size_t *outlen, bool finish=false)
 Flushes data through the encoder from memory to memory.

bool encodebufmem (WvBuf &inbuf, void *outmem, size_t *outlen, bool flush=false, bool finish=false)
 Encodes data from a buffer to memory.

bool flushbufmem (WvBuf &inbuf, void *outmem, size_t *outlen, bool finish=false)
 Flushes data through the encoder from a buffer to memory.

bool flushstrmem (WvStringParm instr, void *outmem, size_t *outlen, bool finish=false)
 Flushes data through the encoder from a string to memory.

WvString strflushmem (const void *inmem, size_t inlen, bool finish=false)
 Flushes data through the encoder from memory to a string.


Static Public Attributes

const long RANDOM_SERIALNO = 0

Protected Member Functions

virtual bool _typedencode (IBuffer &inbuf, OBuffer &outbuf, bool flush)
 Typed variant of _encode().

virtual bool _typedfinish (OBuffer &outbuf)
 Typed variant of _finish().

virtual bool _isok () const
 Template method implementation of isok().

virtual WvString _geterror () const
 Template method implementation of geterror().

virtual bool _encode (WvBuf &inbuf, WvBuf &outbuf, bool flush)
 Wrapper implementation of _encode().

virtual bool _finish (WvBuf &outbuf)
 Wrapper implementation of _finish().

void setnotok ()
 Sets 'okay' to false explicitly.

void seterror (WvStringParm message)
 Sets an error condition, then setnotok().

void seterror (WVSTRING_FORMAT_DECL)
 Sets an error condition, then setnotok().

void setfinished ()
 Sets 'finished' to true explicitly.

virtual bool _isfinished () const
 Template method implementation of isfinished().

virtual bool _reset ()
 Template method implementation of reset().


Protected Attributes

bool okay
bool finished
WvString errstr


Member Typedef Documentation

typedef WvBufBase<IType> WvTypedEncoder< float , unsigned , WvEncoder >::IBuffer [inherited]
 

Definition at line 38 of file wvtypedencoder.h.

typedef WvBufViewBase<IType> WvTypedEncoder< float , unsigned , WvEncoder >::IBufferView [inherited]
 

Definition at line 40 of file wvtypedencoder.h.

typedef float WvTypedEncoder< float , unsigned , WvEncoder >::IType [inherited]
 

Definition at line 36 of file wvtypedencoder.h.

typedef WvBufBase<OType> WvTypedEncoder< float , unsigned , WvEncoder >::OBuffer [inherited]
 

Definition at line 39 of file wvtypedencoder.h.

typedef WvBufViewBase<OType> WvTypedEncoder< float , unsigned , WvEncoder >::OBufferView [inherited]
 

Definition at line 41 of file wvtypedencoder.h.

typedef unsigned WvTypedEncoder< float , unsigned , WvEncoder >::OType [inherited]
 

Definition at line 37 of file wvtypedencoder.h.


Constructor & Destructor Documentation

WvOggSpeexEncoder::WvOggSpeexEncoder const WvSpeex::BitrateSpec bitratespec,
int  samplingrate,
int  channels = 1,
WvSpeex::CodecMode  mode = WvSpeex::DEFAULT_MODE,
int  complexity = WvSpeex::DEFAULT_COMPLEXITY,
long  serialno = RANDOM_SERIALNO
 

Creates an Ogg Speex Encoder.

The special constant RANDOM_SERIALNO may be specified as the serial number to let the encoder choose one at random. The implementation uses the rand() function and assumes that the PRNG was previously seeded with srand().

"bitrate" is the bitrate specification "samplingrate" is the number of samples per second, preferably one of 8000, 16000, or 32000 "channels" is number of channels (must be 1 for now), defaults to 1 "mode" is the Speex codec mode to use or WvSpeex::DEFAULT_MODE to select one automatically based on the sampling rate, this is the default "complexity" is a measure of the amount of CPU resources that should be allocated to the encoder, ranges from 0 to 10 or WvSpeex::DEFAULT_COMPLEXITY the encoder default, this is the default "serialno" is the Ogg bitstream serial number

Definition at line 40 of file wvoggspeex.cc.

References RANDOM_SERIALNO, and WvOggSpeexEncoder().

Referenced by WvOggSpeexEncoder().

WvOggSpeexEncoder::~WvOggSpeexEncoder  )  [virtual]
 

Definition at line 70 of file wvoggspeex.cc.


Member Function Documentation

virtual bool WvTypedEncoder< float , unsigned , WvEncoder >::_encode WvBuf inbuf,
WvBuf outbuf,
bool  flush
[inline, protected, virtual, inherited]
 

Wrapper implementation of _encode().

Implements WvEncoder.

Definition at line 107 of file wvtypedencoder.h.

virtual bool WvTypedEncoder< float , unsigned , WvEncoder >::_finish WvBuf outbuf  )  [inline, protected, virtual, inherited]
 

Wrapper implementation of _finish().

Reimplemented from WvEncoder.

Definition at line 116 of file wvtypedencoder.h.

WvString WvOggSpeexEncoder::_geterror  )  const [protected, virtual]
 

Template method implementation of geterror().

Not called if any of the following cases are true:

  • isok() == true
  • errstr is not null

Most implementations do not need to override this.

Returns: the error message, or the null string if _isok() == true

See also:
seterror

Reimplemented from WvEncoder.

Definition at line 90 of file wvoggspeex.cc.

References WvEncoder::geterror().

virtual bool WvEncoder::_isfinished  )  const [inline, protected, virtual, inherited]
 

Template method implementation of isfinished().

Not called if any of the following cases are true:

  • finished == true

Most implementations do not need to override this.

Returns: true if the encoder is finished

See also:
setfinished

Reimplemented in WvEncoderChain.

Definition at line 416 of file wvencoder.h.

Referenced by WvEncoder::isfinished().

bool WvOggSpeexEncoder::_isok  )  const [protected, virtual]
 

Template method implementation of isok().

Not called if any of the following cases are true:

  • okay == false

Most implementations do not need to override this.

Returns: true if the encoder is ok

See also:
setnotok

Reimplemented from WvEncoder.

Definition at line 84 of file wvoggspeex.cc.

References WvEncoder::isok().

virtual bool WvEncoder::_reset  )  [inline, protected, virtual, inherited]
 

Template method implementation of reset().

When this method is invoked, the current local state will be okay == true and finished == false. If false is returned, then okay will be set to false.

May set a detailed error message if an error occurs.

Returns: true on success, false on error or if not supported

See also:
reset

Reimplemented in WvBackslashEncoder, WvBackslashDecoder, WvBase64Encoder, WvBase64Decoder, WvBlowfishEncoder, WvEVPMDDigest, WvHMACDigest, WvNullEncoder, WvPassthroughEncoder, WvEncoderChain, WvRealToComplexFFTEncoder, WvComplexToRealFFTEncoder, WvPowerSpectrumEncoder, WvFunctorEncoder< IT, OT, FT >, WvGzipEncoder, WvHexEncoder, WvHexDecoder, WvRSAEncoder, WvTripleDESEncoder, WvWordWrapEncoder, WvFunctorEncoder< float, signed short int, WvPCMNormFloatToSigned16Functor >, WvFunctorEncoder< double, signed short int, WvPCMNormDoubleToSigned16Functor >, WvFunctorEncoder< float, signed short int, WvPCMUnnormFloatToSigned16Functor >, WvFunctorEncoder< signed short int, float, WvPCMSigned16ToNormFloatFunctor >, WvFunctorEncoder< signed short int, double, WvPCMSigned16ToNormDoubleFunctor >, and WvFunctorEncoder< signed short int, float, WvPCMSigned16ToUnnormFloatFunctor >.

Definition at line 498 of file wvencoder.h.

Referenced by WvEncoder::reset().

bool WvOggSpeexEncoder::_typedencode IBuffer inbuf,
OBuffer outbuf,
bool  flush
[protected, virtual]
 

Typed variant of _encode().

See also:
_encode(WvBuf&, WvBuf&, bool)

Implements WvTypedEncoder< float, unsigned char >.

Definition at line 108 of file wvoggspeex.cc.

References _typedencode(), WvTypedEncoder< float, unsigned char >::encode(), WvInPlaceBufBase< unsigned char >::ptr(), WvBufBaseCommonImpl< unsigned >::used(), and WvBufBaseCommonImpl< unsigned >::zap().

Referenced by _typedencode().

bool WvOggSpeexEncoder::_typedfinish OBuffer outbuf  )  [protected, virtual]
 

Typed variant of _finish().

See also:
_finish(WvBuf&)

Reimplemented from WvTypedEncoder< float, unsigned char >.

Definition at line 155 of file wvoggspeex.cc.

References _typedfinish().

Referenced by _typedfinish().

void WvOggSpeexEncoder::add_comment WVSTRING_FORMAT_DECL   )  [inline]
 

Adds a comment to the Ogg Speex stream.

Do not call after the first invocation of encode().

Definition at line 89 of file wvoggspeex.h.

References WVSTRING_FORMAT_CALL.

void WvOggSpeexEncoder::add_comment WvStringParm  comment  ) 
 

Adds a comment to the Ogg Speex stream.

Do not call after the first invocation of encode().

"comment" is the comment

Definition at line 96 of file wvoggspeex.cc.

References add_comment(), and WvStringParm.

Referenced by add_comment().

void WvOggSpeexEncoder::add_tag WvStringParm  tag,
WvStringParm  value
 

Adds a tag to the Ogg Speex stream.

Ogg Speex tags are special comment strings of the form "=" and are typically used to store artist, date, and other simple string encoded metadata.

Do not call after the first invocation of encode().

"tag" is the tag name "value" is the value

Definition at line 102 of file wvoggspeex.cc.

References add_tag().

Referenced by add_tag().

int WvOggSpeexEncoder::channels  )  const [inline]
 

Returns the number of channels.

Returns: the number of channels

Definition at line 117 of file wvoggspeex.h.

References WvSpeexEncoder::channels().

bool WvTypedEncoder< float , unsigned , WvEncoder >::encode WvBuf inbuf,
WvBuf outbuf,
bool  flush = false,
bool  finish = false
[inline, inherited]
 

Reimplemented from WvEncoder.

Definition at line 76 of file wvtypedencoder.h.

bool WvTypedEncoder< float , unsigned , WvEncoder >::encode IBuffer inbuf,
OBuffer outbuf,
bool  flush = false,
bool  finish = false
[inline, inherited]
 

Typed variant of encode().

See also:
encode(WvBuf&, WvBuf&, bool, bool)

Definition at line 47 of file wvtypedencoder.h.

Referenced by _typedencode().

bool WvEncoder::encodebufmem WvBuf inbuf,
void *  outmem,
size_t *  outlen,
bool  flush = false,
bool  finish = false
[inherited]
 

Encodes data from a buffer to memory.

The outlen parameter specifies by reference the length of the output buffer. It is updated in place to reflect the number of bytes copied to the output buffer. If the buffer was too small to hold the data, the overflow bytes will be discarded and false will be returned.

"inmem" is the input data pointer "inlen" is the input data length "outmem" is the output data pointer "outlen" is the output data length, by reference "flush" is if true, flushes the encoder "finish" is if true, calls finish() on success Returns: true on success

Definition at line 138 of file wvencoder.cc.

References WvEncoder::encode(), WvEncoder::encodebufmem(), and WvBufBaseCommonImpl< unsigned >::used().

Referenced by WvEncoder::encodebufmem(), and WvEncoder::flushmemmem().

bool WvEncoder::encodebufstr WvBuf inbuf,
WvString outstr,
bool  flush = false,
bool  finish = false
[inherited]
 

Encodes data from a buffer to a string.

The output data is appended to the target string.

"inbuf" is the input buffer "outstr" is the output string "flush" is if true, flushes the encoder "finish" is if true, calls finish() on success Returns: true on success

Definition at line 95 of file wvencoder.cc.

References WvString::append(), WvEncoder::encode(), and WvEncoder::encodebufstr().

Referenced by WvEncoder::encodebufstr().

bool WvTypedEncoder< float , unsigned , WvEncoder >::finish WvBuf outbuf  )  [inline, inherited]
 

Reimplemented from WvEncoder.

Definition at line 86 of file wvtypedencoder.h.

bool WvTypedEncoder< float , unsigned , WvEncoder >::finish OBuffer outbuf  )  [inline, inherited]
 

Typed variant of finish().

See also:
finish(WvBuf)

Definition at line 70 of file wvtypedencoder.h.

bool WvTypedEncoder< float , unsigned , WvEncoder >::flush WvBuf inbuf,
WvBuf outbuf,
bool  finish = false
[inline, inherited]
 

Reimplemented from WvEncoder.

Definition at line 81 of file wvtypedencoder.h.

bool WvTypedEncoder< float , unsigned , WvEncoder >::flush IBuffer inbuf,
OBuffer outbuf,
bool  finish = false
[inline, inherited]
 

Typed variant of flush().

See also:
flush(WvBuf, WvBuf, bool)

Definition at line 59 of file wvtypedencoder.h.

bool WvEncoder::flushbufmem WvBuf inbuf,
void *  outmem,
size_t *  outlen,
bool  finish = false
[inline, inherited]
 

Flushes data through the encoder from a buffer to memory.

The outlen parameter specifies by reference the length of the output buffer. It is updated in place to reflect the number of bytes copied to the output buffer. If the buffer was too small to hold the data, the overflow bytes will be discarded and false will be returned.

"inbuf" is the input buffer "outmem" is the output data pointer "outlen" is the output data length, by reference "finish" is if true, calls finish() on success Returns: true on success

Definition at line 337 of file wvencoder.h.

References WvEncoder::flushbufmem().

Referenced by WvEncoder::flushbufmem(), and WvEncoder::flushstrmem().

bool WvEncoder::flushbufstr WvBuf inbuf,
WvString outstr,
bool  finish = false
[inline, inherited]
 

Flushes data through the encoder from a buffer to a string.

The output data is appended to the target string.

"inbuf" is the input buffer "outstr" is the output string "finish" is if true, calls finish() on success Returns: true on success

Definition at line 249 of file wvencoder.h.

References WvEncoder::flushbufstr().

Referenced by WvEncoder::flushbufstr(), and WvEncoder::strflushbuf().

bool WvEncoder::flushmembuf const void *  inmem,
size_t  inlen,
WvBuf outbuf,
bool  finish = false
[inherited]
 

Flushes data through the encoder from memory to a buffer.

"inmem" is the input data pointer "inlen" is the input data length "outbuf" is the output buffer "finish" is if true, calls finish() on success Returns: true on success

Definition at line 121 of file wvencoder.cc.

References WvEncoder::encode(), and WvEncoder::flushmembuf().

Referenced by WvEncoder::flushmembuf(), and WvDsp::uwrite().

bool WvEncoder::flushmemmem const void *  inmem,
size_t  inlen,
void *  outmem,
size_t *  outlen,
bool  finish = false
[inherited]
 

Flushes data through the encoder from memory to memory.

The outlen parameter specifies by reference the length of the output buffer. It is updated in place to reflect the number of bytes copied to the output buffer. If the buffer was too small to hold the data, the overflow bytes will be discarded and false will be returned.

"inmem" is the input data pointer "inlen" is the input data length "outmem" is the output data pointer "outlen" is the output data length, by reference "finish" is if true, calls finish() on success Returns: true on success

Definition at line 130 of file wvencoder.cc.

References WvEncoder::encodebufmem(), and WvEncoder::flushmemmem().

Referenced by WvEncoder::flushmemmem().

bool WvEncoder::flushstrbuf WvStringParm  instr,
WvBuf outbuf,
bool  finish = false
[inherited]
 

Flushes data through the encoder from a string to a buffer.

"instr" is the input string "outbuf" is the output buffer "finish" is if true, calls finish() on success Returns: true on success

Definition at line 75 of file wvencoder.cc.

References WvEncoder::encode(), WvEncoder::flushstrbuf(), and WvStringParm.

Referenced by WvEncoder::flushstrbuf().

bool WvEncoder::flushstrmem WvStringParm  instr,
void *  outmem,
size_t *  outlen,
bool  finish = false
[inherited]
 

Flushes data through the encoder from a string to memory.

The outlen parameter specifies by reference the length of the output buffer. It is updated in place to reflect the number of bytes copied to the output buffer. If the buffer was too small to hold the data, the overflow bytes will be discarded and false will be returned.

"instr" is the input string "outmem" is the output data pointer "outlen" is the output data length, by reference "finish" is if true, calls finish() on success Returns: true on success

Definition at line 148 of file wvencoder.cc.

References WvEncoder::flushbufmem(), and WvEncoder::flushstrmem().

Referenced by WvEncoder::flushstrmem().

bool WvEncoder::flushstrstr WvStringParm  instr,
WvString outstr,
bool  finish = false
[inherited]
 

Flushes data through the encoder from a string to a string.

The output data is appended to the target string.

"instr" is the input string "outstr" is the output string "finish" is if true, calls finish() on success Returns: true on success

Definition at line 84 of file wvencoder.cc.

References WvString::append(), WvEncoder::encode(), WvEncoder::flushstrstr(), and WvDynBuf.

Referenced by encode64(), WvEncoder::flushstrstr(), and WvEncoder::strflushstr().

WvString WvEncoder::geterror  )  const [inherited]
 

Returns an error message if any is available.

Returns: the error message, or the null string is isok() == true

Definition at line 21 of file wvencoder.cc.

References WvEncoder::_geterror(), WvEncoder::errstr, and WvEncoder::isok().

Referenced by WvOggSpeexDecoder::_geterror(), and _geterror().

bool WvEncoder::isfinished  )  const [inline, inherited]
 

Returns true if the encoder can no longer encode data.

This will be set when the encoder detects and end-of-data mark in its input, or when finish() is called.

Returns: true if the encoder is finished

Definition at line 101 of file wvencoder.h.

References WvEncoder::_isfinished(), and WvEncoder::finished.

Referenced by WvSpeexDecoder::missing().

bool WvEncoder::isok  )  const [inline, inherited]
 

Returns true if the encoder has not encountered an error.

This should only be used to record permanent failures. Transient errors (eg. bad block, but recoverable) should be detected in a different fashion.

Returns: true if the encoder is ok

Definition at line 90 of file wvencoder.h.

References WvEncoder::_isok(), and WvEncoder::okay.

Referenced by WvOggSpeexDecoder::_isok(), _isok(), WvEncoder::geterror(), and WvSpeexDecoder::missing().

WvSpeex::CodecMode WvOggSpeexEncoder::mode  )  const [inline]
 

Returns the current encoding mode.

Returns: the encoding mode

Definition at line 131 of file wvoggspeex.h.

References WvSpeexEncoder::mode().

int WvOggSpeexEncoder::nominalbitrate  )  const [inline]
 

Returns the nominal bitrate.

Returns: the bitrate, or -1 if not specified or not meaningful

Definition at line 145 of file wvoggspeex.h.

References WvSpeexEncoder::nominalbitrate().

bool WvEncoder::reset  )  [inherited]
 

Asks an encoder to reset itself to its initial state at creation time, if supported.

This function may be called at any time, even if isok() == false, or isfinished() == true.

If the behaviour is not supported or an error occurs, then false is returned and afterwards isok() == false.

Returns: true on success

See also:
_reset for the actual implementation

Definition at line 58 of file wvencoder.cc.

References WvEncoder::_reset(), WvEncoder::errstr, WvEncoder::finished, WvEncoder::okay, and WvEncoder::seterror().

int WvOggSpeexEncoder::samplesperframe  )  const [inline]
 

Returns the number of samples per frame.

Returns: the frame size

Definition at line 124 of file wvoggspeex.h.

References WvSpeexEncoder::samplesperframe().

int WvOggSpeexEncoder::samplingrate  )  const [inline]
 

Returns the sampling rate.

Returns: the sampling rate

Definition at line 110 of file wvoggspeex.h.

References WvSpeexEncoder::samplingrate().

void WvEncoder::seterror WVSTRING_FORMAT_DECL   )  [inline, protected, inherited]
 

Sets an error condition, then setnotok().

Definition at line 379 of file wvencoder.h.

References WVSTRING_FORMAT_CALL.

void WvEncoder::seterror WvStringParm  message  )  [inline, protected, inherited]
 

Sets an error condition, then setnotok().

Definition at line 375 of file wvencoder.h.

References WvEncoder::errstr, WvEncoder::seterror(), and WvEncoder::setnotok().

Referenced by WvEncoder::reset(), and WvEncoder::seterror().

void WvEncoder::setfinished  )  [inline, protected, inherited]
 

Sets 'finished' to true explicitly.

Definition at line 383 of file wvencoder.h.

References WvEncoder::finished.

Referenced by WvBase64Decoder::_encode(), WvOggVorbisDecoder::_typedencode(), WvOggSpeexDecoder::_typedencode(), and WvEncoder::finish().

void WvEncoder::setnotok  )  [inline, protected, inherited]
 

Sets 'okay' to false explicitly.

Definition at line 371 of file wvencoder.h.

References WvEncoder::okay.

Referenced by WvEncoder::seterror().

WvString WvEncoder::strflushbuf WvBuf inbuf,
bool  finish = false
[inherited]
 

Flushes data through the encoder from a buffer to a string.

"inbuf" is the input buffer "finish" is if true, calls finish() on success Returns: the resulting encoded string, does not signal errors

Definition at line 113 of file wvencoder.cc.

References WvEncoder::flushbufstr(), and WvEncoder::strflushbuf().

Referenced by WvEncoder::strflushbuf(), and WvEncoder::strflushmem().

WvString WvEncoder::strflushmem const void *  inmem,
size_t  inlen,
bool  finish = false
[inherited]
 

Flushes data through the encoder from memory to a string.

"inmem" is the input data pointer "inlen" is the input data length "finish" is if true, calls finish() on success Returns: the resulting encoded string, does not signal errors

Definition at line 156 of file wvencoder.cc.

References WvEncoder::strflushbuf(), and WvEncoder::strflushmem().

Referenced by WvEncoder::strflushmem().

WvString WvEncoder::strflushstr WvStringParm  instr,
bool  finish = false
[inherited]
 

Flushes data through the encoder from a string to a string.

"inbuf" is the input buffer "finish" is if true, calls finish() on success Returns: the resulting encoded string, does not signal errors

Definition at line 105 of file wvencoder.cc.

References WvEncoder::flushstrstr(), and WvEncoder::strflushstr().

Referenced by WvEncoder::strflushstr().

bool WvOggSpeexEncoder::vbr  )  const [inline]
 

Returns true if variable bitrate support has been enabled.

Returns: true if it is enabled

Definition at line 138 of file wvoggspeex.h.

References WvSpeexEncoder::vbr().


Member Data Documentation

WvString WvEncoder::errstr [protected, inherited]
 

the error message

Definition at line 72 of file wvencoder.h.

Referenced by WvEncoder::geterror(), WvEncoder::reset(), and WvEncoder::seterror().

bool WvEncoder::finished [protected, inherited]
 

true iff setfinished()/finish() was called

Definition at line 71 of file wvencoder.h.

Referenced by WvEncoder::encode(), WvEncoder::finish(), WvEncoder::isfinished(), WvEncoder::reset(), and WvEncoder::setfinished().

bool WvEncoder::okay [protected, inherited]
 

false iff setnotok() was called

Definition at line 70 of file wvencoder.h.

Referenced by WvEncoder::encode(), WvEncoder::finish(), WvEncoder::isok(), WvEncoder::reset(), and WvEncoder::setnotok().

const long WvOggSpeexEncoder::RANDOM_SERIALNO = 0 [static]
 

Definition at line 42 of file wvoggspeex.h.

Referenced by WvOggSpeexEncoder().


The documentation for this class was generated from the following files:
Generated on Tue Oct 5 01:09:29 2004 for WvStreams by doxygen 1.3.7