itpp::SND_Format Class Reference
[Audio]

Base class for SND reading classes (the .au format). More...

#include <itpp/srccode/audiofile.h>

Inheritance diagram for itpp::SND_Format:

List of all members.

Public Types
enum	data_encoding {   enc_unknown = 0, enc_mulaw8 = 1, enc_alaw8 = 27, enc_linear8 = 2,   enc_linear16 = 3, enc_linear24 = 4, enc_linear32 = 5, enc_float = 6,   enc_double = 7 }
	ACTION: ADD DOCUMENTATION FOR THIS MEMBER!!!!!!!!!!! More...
Public Member Functions
int	samples () const
	ACTION: ADD DOCUMENTATION FOR THIS MEMBER!!!!!!!!!!!
data_encoding	encoding () const
	ACTION: ADD DOCUMENTATION FOR THIS MEMBER!!!!!!!!!!!
int	rate () const
	ACTION: ADD DOCUMENTATION FOR THIS MEMBER!!!!!!!!!!!
void	set_rate (int r)
	ACTION: ADD DOCUMENTATION FOR THIS MEMBER!!!!!!!!!!!
int	channels () const
	ACTION: ADD DOCUMENTATION FOR THIS MEMBER!!!!!!!!!!!
Protected Member Functions
int	sample_size () const
	ACTION: Add documentation for this protected member.
bool	read_header (std::istream &f)
	ACTION: Add documentation for this protected member.
bool	write_header (std::ostream &f)
	ACTION: Add documentation for this protected member.
Protected Attributes
struct {
unsigned   magic
	Magic number.
unsigned   hdr_size
	Size of this header.
unsigned   data_size
	Length of data (optional).
unsigned   encoding
	Data encoding format.
unsigned   sample_rate
	Samples per second.
unsigned   channels
	Number of interleaved channels.
char   info [SND_INFO_LEN]
	Info string.
}	header
	Definition of the header structure.

---

Detailed Description

Base class for SND reading classes (the .au format).

ACTION: ADD DETAILED DOCUMENTATION FOR THIS CLASS!!!!!!!!!!!

Definition at line 82 of file audiofile.h.

---

Member Enumeration Documentation

enum itpp::SND_Format::data_encoding

ACTION: ADD DOCUMENTATION FOR THIS MEMBER!!!!!!!!!!!

Enumerator:

enc_unknown
enc_mulaw8
enc_alaw8
enc_linear8
enc_linear16
enc_linear24
enc_linear32
enc_float
enc_double

Definition at line 85 of file audiofile.h.

---

Member Function Documentation

int itpp::SND_Format::samples

(

)

const [inline]

ACTION: ADD DOCUMENTATION FOR THIS MEMBER!!!!!!!!!!!

Definition at line 97 of file audiofile.h.

References header, and sample_size().

Referenced by itpp::SND_In_File::read().

data_encoding itpp::SND_Format::encoding

(

)

const [inline]

ACTION: ADD DOCUMENTATION FOR THIS MEMBER!!!!!!!!!!!

Definition at line 99 of file audiofile.h.

References header.

int itpp::SND_Format::rate

(

)

const [inline]

ACTION: ADD DOCUMENTATION FOR THIS MEMBER!!!!!!!!!!!

Definition at line 101 of file audiofile.h.

References header.

void itpp::SND_Format::set_rate

(

int

r

)

[inline]

ACTION: ADD DOCUMENTATION FOR THIS MEMBER!!!!!!!!!!!

Definition at line 103 of file audiofile.h.

References header.

int itpp::SND_Format::channels

(

)

const [inline]

ACTION: ADD DOCUMENTATION FOR THIS MEMBER!!!!!!!!!!!

Definition at line 105 of file audiofile.h.

References header.

int itpp::SND_Format::sample_size

(

)

const [protected]

ACTION: Add documentation for this protected member.

Definition at line 208 of file audiofile.cpp.

References enc_alaw8, enc_double, enc_float, enc_linear16, enc_linear24, enc_linear32, enc_linear8, enc_mulaw8, and header.

Referenced by samples(), itpp::SND_In_File::seek_read(), itpp::SND_Out_File::seek_write(), itpp::SND_In_File::tell_read(), and itpp::SND_Out_File::tell_write().

bool itpp::SND_Format::read_header

(

std::istream &

f

)

[protected]

ACTION: Add documentation for this protected member.

Definition at line 223 of file audiofile.cpp.

References header, and it_warning.

Referenced by itpp::SND_IO_File::open(), and itpp::SND_In_File::open().

bool itpp::SND_Format::write_header

(

std::ostream &

f

)

[protected]

ACTION: Add documentation for this protected member.

Definition at line 243 of file audiofile.cpp.

References header.

Referenced by itpp::SND_IO_File::close(), itpp::SND_Out_File::close(), and itpp::SND_Out_File::open().

---

Member Data Documentation

unsigned itpp::SND_Format::magic

Magic number.

Definition at line 112 of file audiofile.h.

unsigned itpp::SND_Format::hdr_size

Size of this header.

Definition at line 114 of file audiofile.h.

unsigned itpp::SND_Format::data_size

Length of data (optional).

Definition at line 116 of file audiofile.h.

unsigned itpp::SND_Format::encoding

Data encoding format.

Definition at line 118 of file audiofile.h.

unsigned itpp::SND_Format::sample_rate

Samples per second.

Definition at line 120 of file audiofile.h.

unsigned itpp::SND_Format::channels

Number of interleaved channels.

Definition at line 122 of file audiofile.h.

char itpp::SND_Format::info[SND_INFO_LEN]

Info string.

Definition at line 124 of file audiofile.h.

struct { ... } itpp::SND_Format::header [protected]

Definition of the header structure.

Referenced by channels(), itpp::SND_Out_File::close(), encoding(), itpp::SND_Out_File::open(), rate(), itpp::SND_In_File::read(), read_header(), sample_size(), samples(), itpp::SND_In_File::seek_read(), itpp::SND_Out_File::seek_write(), set_rate(), itpp::SND_In_File::tell_read(), itpp::SND_Out_File::tell_write(), itpp::SND_Out_File::write(), and write_header().

---

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

• itpp/srccode/audiofile.h
• itpp/srccode/audiofile.cpp

Generated on Wed Apr 18 11:23:43 2007 for IT++ by Doxygen 1.5.2