audio_alsa_sink Class Reference

#include <audio_alsa_sink.h>

Inheritance diagram for audio_alsa_sink:

Inheritance graph
[legend]
Collaboration diagram for audio_alsa_sink:

Collaboration graph
[legend]
List of all members.

Detailed Description

audio sink using ALSA

The sink has N input streams of floats, where N depends on the hardware characteristics of the selected device.

Input samples must be in the range [-1,1].


Public Member Functions

 ~audio_alsa_sink ()
bool check_topology (int ninputs, int noutputs)
 Confirm that ninputs and noutputs is an acceptable combination.
int work (int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
 just like gr_block::general_work, only this arranges to call consume_each for you

Protected Member Functions

 audio_alsa_sink (int sampling_rate, const std::string device_name, bool ok_to_block)
bool write_buffer (const void *buffer, unsigned nframes, unsigned sizeof_frame)
int work_s16 (int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
int work_s16_1x2 (int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
int work_s32 (int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
int work_s32_1x2 (int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)

Friends

audio_alsa_sink_sptr audio_alsa_make_sink (int sampling_rate, const std::string device_name, bool ok_to_block)
 make an alsa audio sink.

Constructor & Destructor Documentation

audio_alsa_sink::audio_alsa_sink (  int  sampling_rate,
const std::string  device_name,
bool  ok_to_block
)  [protected]
 

audio_alsa_sink::~audio_alsa_sink (   ) 
 

Member Function Documentation

bool audio_alsa_sink::check_topology (  int  ninputs,
int  noutputs
)  [virtual]
 

Confirm that ninputs and noutputs is an acceptable combination.

Parameters:
ninputs number of input streams connected
noutputs number of output streams connected
Returns:
true if this is a valid configuration for this block.
This function is called by the runtime system whenever the topology changes. Most classes do not need to override this. This check is in addition to the constraints specified by the input and output gr_io_signatures.

Reimplemented from gr_basic_block.

int audio_alsa_sink::work (  int  noutput_items,
gr_vector_const_void_star &  input_items,
gr_vector_void_star &  output_items
)  [virtual]
 

just like gr_block::general_work, only this arranges to call consume_each for you

The user must override work to define the signal processing code

Implements gr_sync_block.

int audio_alsa_sink::work_s16 (  int  noutput_items,
gr_vector_const_void_star &  input_items,
gr_vector_void_star &  output_items
)  [protected]
 

int audio_alsa_sink::work_s16_1x2 (  int  noutput_items,
gr_vector_const_void_star &  input_items,
gr_vector_void_star &  output_items
)  [protected]
 

int audio_alsa_sink::work_s32 (  int  noutput_items,
gr_vector_const_void_star &  input_items,
gr_vector_void_star &  output_items
)  [protected]
 

int audio_alsa_sink::work_s32_1x2 (  int  noutput_items,
gr_vector_const_void_star &  input_items,
gr_vector_void_star &  output_items
)  [protected]
 

bool audio_alsa_sink::write_buffer (  const void *  buffer,
unsigned  nframes,
unsigned  sizeof_frame
)  [protected]
 

Friends And Related Function Documentation

audio_alsa_sink_sptr audio_alsa_make_sink (  int  sampling_rate,
const std::string  device_name,
bool  ok_to_block
)  [friend]
 

make an alsa audio sink.

Parameters:
sampling_rate sampling rate in Hz
dev ALSA pcm device name, e.g., "hw:0,0"
ok_to_block (currently ignored)

The documentation for this class was generated from the following files:
Generated on Wed Jan 31 17:19:34 2007 for GNU Radio 3.0svn by  doxygen 1.4.6