WAVEFILE Class Reference

Represents a RIFF WAVE -file (wav). More...

Inheritance diagram for WAVEFILE:

List of all members.

Public Member Functions
	WAVEFILE (const std::string &name="")
	Print extra debug information about RIFF header contents to stdout when opening files.
virtual WAVEFILE *	clone (void) const
	Virtual method that clones the current object and returns a pointer to it.
virtual WAVEFILE *	new_expr (void) const
	Virtual method that creates a new object of current type.
virtual std::string	name (void) const
	Object name used to identify the object type.
virtual bool	locked_audio_format (void) const
	Whether audio format is locked.
virtual std::string	parameter_names (void) const
	A comma-separated list of parameters names.
virtual void	open (void) throw (AUDIO_IO::SETUP_ERROR &)
	Opens the audio object (possibly in exclusive mode).
virtual void	close (void)
	Closes audio object.
virtual long int	read_samples (void *target_buffer, long int samples)
	Low-level routine for reading samples.
virtual void	write_samples (void *target_buffer, long int samples)
	Low-level routine for writing samples.
virtual bool	finished (void) const
	Whether all data has been processed? If opened in mode 'io_read', this means that end of stream has been reached.
virtual void	seek_position (void)
virtual void	set_parameter (int param, std::string value)
virtual std::string	get_parameter (int param) const
	Get parameter value.
Classes
struct	RB
struct	RF
struct	RH

---

Detailed Description

Represents a RIFF WAVE -file (wav).

This class currently supports only a limited set of features:

Format 1 sample data: Pulse Code Modulation (PCM) Format

Format 3 sample data: IEEE754 floats, range [-1, +1)

• multiple channels are interleaved

• 8, 16, 24 and 32 bit data supported

• if more than 8 bits, least significant byte first as specified in the stantard

---

Member Function Documentation

WAVEFILE * WAVEFILE::clone (  void   )  const [virtual]

Virtual method that clones the current object and returns a pointer to it. This must be implemented by all subclasses! Implements AUDIO_IO.

void WAVEFILE::close (  void   )  [virtual]

Closes audio object. After calling this routine, all resources (for instance files and devices) must be freed so that they can be used by other processes. Precondition: is_open() == true Postcondition: readable() != true writable() != true Reimplemented from AUDIO_IO.

bool WAVEFILE::finished (  void   )  const [virtual]

Whether all data has been processed? If opened in mode 'io_read', this means that end of stream has been reached. If opened in 'io_write' or 'io_readwrite' modes, finished status usually means that an error has occured (no space left, etc). After finished() has returned 'true', further calls to read_buffer() and/or write_buffer() won't process any data. For output for which 'finite_length_stream()' is true, when 'finished()' returns true, that means an error has occured. Otherwise 'finished()' just tells that further attempts to do i/o will fail. Implements AUDIO_IO.

string WAVEFILE::get_parameter (  int  param  )  const [virtual]

Get parameter value. Parameters: param  parameter id, require: param > 0 Reimplemented from AUDIO_IO.

virtual bool WAVEFILE::locked_audio_format (  void   )  const [inline, virtual]

Whether audio format is locked. If this is true, audio object has a known audio format, and doesn't allow overriding it. By default, audio format is not locked. Reimplemented from AUDIO_IO.

virtual std::string WAVEFILE::name (  void   )  const [inline, virtual]

Object name used to identify the object type. In most cases, object name is same for all class instances. Must be implemented in all subclasses. Implements ECA_OBJECT.

virtual WAVEFILE* WAVEFILE::new_expr (  void   )  const [inline, virtual]

Virtual method that creates a new object of current type. This must be implemented by all subclasses! Implements AUDIO_IO.

void WAVEFILE::open (  void   )  throw (AUDIO_IO::SETUP_ERROR &) [virtual]

Opens the audio object (possibly in exclusive mode). This routine is used for initializing external connections (opening files or devices, loading shared libraries, opening IPC connections). As it's impossible to know in advance what might happen, open() may throw an exception. This way it becomes possible to provide more verbose information about the problem that caused open() to fail. At this point the various audio parameters are used for the first time. Unless locked_audio_format() is 'true', object tries to use the audio format parameters set prior to this call. If object doesn't support the given parameter combination, it can either try adjust them to closest matching, or in the worst case, throw an SETUP_ERROR exception (see above). Precondition: is_open() != true Postcondition: readable() == true || writable() == true || is_open() != true Reimplemented from AUDIO_IO.

virtual std::string WAVEFILE::parameter_names (  void   )  const [inline, virtual]

A comma-separated list of parameters names. Derived classes must implement this. Reimplemented from AUDIO_IO.

long int WAVEFILE::read_samples (  void *  target_buffer, long int  samples )  [virtual]

Low-level routine for reading samples. Number of read sample frames is returned. This must be implemented by all subclasses. Implements AUDIO_IO_BUFFERED.

void WAVEFILE::write_samples (  void *  target_buffer, long int  samples )  [virtual]

Low-level routine for writing samples. This must be implemented by all subclasses. Implements AUDIO_IO_BUFFERED.

---

The documentation for this class was generated from the following files:

• audioio-wave.h
• audioio-wave.cpp

---