Logo Search packages:      
Sourcecode: ecasound version File versions  Download package

Classes | Public Types | Public Member Functions

AUDIO_IO Class Reference

#include <audioio.h>

Inheritance diagram for AUDIO_IO:
Inheritance graph
[legend]
Collaboration diagram for AUDIO_IO:
Collaboration graph
[legend]

List of all members.

Classes

class  SETUP_ERROR

Public Types

typedef string parameter_t
Public type definitions and constants
enum  Io_mode { io_read = 1, io_write = 2, io_readwrite = 4 }
Public type definitions and constants
enum  Sample_format {
  sfmt_none, sfmt_u8, sfmt_s8, sfmt_s16,
  sfmt_s16_le, sfmt_s16_be, sfmt_s24, sfmt_s24_le,
  sfmt_s24_be, sfmt_s32, sfmt_s32_le, sfmt_s32_be,
  sfmt_f32, sfmt_f32_le, sfmt_f32_be, sfmt_f64,
  sfmt_f64_le, sfmt_f64_be
}
enum  Sample_endianess { se_native, se_big, se_little }
enum  Sample_coding { sc_signed, sc_unsigned, sc_float }

Public Member Functions

virtual std::string description (void) const
std::string get_parameter_name (int id) const
virtual std::string name (void) const =0
int number_of_params (void) const
virtual bool variable_params (void) const
Public functions for handling object managers
virtual AUDIO_IO_MANAGERcreate_object_manager (void) const
Constructors and destructors
virtual AUDIO_IOclone (void) const =0
virtual AUDIO_IOnew_expr (void) const =0
virtual ~AUDIO_IO (void)
 AUDIO_IO (const string &name="uninitialized", int mode=io_read)
Attribute functions
virtual int supported_io_modes (void) const
virtual bool supports_nonblocking_mode (void) const
virtual bool finite_length_stream (void) const
virtual bool locked_audio_format (void) const
Configuration

For setting and getting configuration parameters.

virtual void set_buffersize (long int samples)=0
virtual long int buffersize (void) const =0
int io_mode (void) const
const string & label (void) const
string format_info (void) const
void set_io_mode (int mode)
void set_label (const string &id_label)
void toggle_nonblocking_mode (bool value)
virtual string parameter_names (void) const
virtual void set_parameter (int param, string value)
virtual string get_parameter (int param) const
Main functionality
virtual void read_buffer (SAMPLE_BUFFER *sbuf)=0
virtual void write_buffer (SAMPLE_BUFFER *sbuf)=0
virtual void open (void) throw (AUDIO_IO::SETUP_ERROR &)
virtual void close (void)
Runtime information
virtual int poll_descriptor (void) const
virtual long int samples_available (void) const
bool is_open (void) const
virtual bool finished (void) const =0
virtual bool nonblocking_mode (void) const
virtual bool readable (void) const
virtual bool writable (void) const
virtual string status (void) const
ECA_AUDIO_TIME length (void) const
ECA_AUDIO_TIME position (void) const
Functions overridden and reimplemented from
SAMPLE_SPECS::sample_rate_t samples_per_second (void) const
virtual void set_samples_per_second (SAMPLE_SPECS::sample_rate_t v)
virtual void set_audio_format (const ECA_AUDIO_FORMAT &f_str)
Functions implemented from ECA_AUDIO_POSITION
virtual bool supports_seeking (void) const
virtual bool supports_seeking_sample_accurate (void) const
virtual SAMPLE_SPECS::sample_pos_t seek_position (SAMPLE_SPECS::sample_pos_t pos)
Public functions for getting audio format information
int frame_size (void) const
int sample_size (void) const
int bits (void) const
Sample_format sample_format (void) const
Sample_coding sample_coding (void) const
Sample_endianess sample_endianess (void) const
long int bytes_per_second (void) const
SAMPLE_SPECS::channel_t channels (void) const
bool interleaved_channels (void) const
ECA_AUDIO_FORMAT audio_format (void) const
std::string format_string (void) const
Public virtual functions for setting audio format information
virtual void set_channels (SAMPLE_SPECS::channel_t v)
virtual void set_sample_format (Sample_format v) throw (ECA_ERROR&)
virtual void toggle_interleaved_channels (bool v)
Public functions for setting audio format information
void set_sample_format_string (const std::string &f_str) throw (ECA_ERROR&)
void set_sample_coding (Sample_coding v)
void set_sample_endianess (Sample_endianess v)
Public functions for getting length information
SAMPLE_SPECS::sample_pos_t length_in_samples (void) const
int length_in_seconds (void) const
double length_in_seconds_exact (void) const
bool length_set (void) const
Public functions for getting position information
SAMPLE_SPECS::sample_pos_t position_in_samples (void) const
int position_in_seconds (void) const
double position_in_seconds_exact (void) const
Public functions for setting position (with action)
void seek_position_in_samples (SAMPLE_SPECS::sample_pos_t pos_in_samples)
void seek_position_in_samples_advance (SAMPLE_SPECS::sample_pos_t pos_in_samples)
void seek_position_in_seconds (double pos_in_seconds)
void seek_first (void)
void seek_last (void)
Public utility functions
bool out_position (void) const

Protected Member Functions

Protected functions for setting length
void set_length_in_samples (SAMPLE_SPECS::sample_pos_t pos)
void set_length_in_seconds (int pos_in_seconds)
void set_length_in_seconds (double pos_in_seconds)
void extend_position (void)
Protected functions for setting position (without action)
void set_position_in_samples (SAMPLE_SPECS::sample_pos_t pos)
void set_position_in_seconds (int pos_in_seconds)
void set_position_in_seconds (double pos_in_seconds)
void change_position_in_samples (SAMPLE_SPECS::sample_pos_t pos)
void change_position_in_seconds (double pos_in_seconds)

Functions provided for subclasses.

int io_mode_rep
string id_label_rep
bool nonblocking_rep
bool open_rep
void position (const ECA_AUDIO_TIME &v)
void length (const ECA_AUDIO_TIME &v)
std::string parameter_get_to_string (int param) const
std::string parameter_set_to_string (int param, std::string value) const

Detailed Description

Virtual base class for all audio I/O objects. Different types of audio objects include files, audio devices, sound producing program modules, audio server clients, and so on.

The class interface is divided into following sections:

Author:
Kai Vehmanen

Definition at line 37 of file audioio.h.


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

Generated by  Doxygen 1.6.0   Back to index