GNU Radio C++ API
gr_wavfile_source Class Reference

Read stream from a Microsoft PCM (.wav) file, output floats. More...

#include <gr_wavfile_source.h>

Inheritance diagram for gr_wavfile_source:

Public Member Functions

 ~gr_wavfile_source ()
 
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 More...
 
unsigned int sample_rate () const
 Read the sample rate as specified in the wav file header. More...
 
int bits_per_sample () const
 Return the number of bits per sample as specified in the wav file header. Only 8 or 16 bit are supported here. More...
 
int channels () const
 Return the number of channels in the wav file as specified in the wav file header. This is also the max number of outputs you can have. More...
 
- Public Member Functions inherited from gr_sync_block
void forecast (int noutput_items, gr_vector_int &ninput_items_required)
 Estimate input requirements given output request. More...
 
int general_work (int noutput_items, gr_vector_int &ninput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
 compute output items from input items More...
 
int fixed_rate_ninput_to_noutput (int ninput)
 Given ninput samples, return number of output samples that will be produced. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this. More...
 
int fixed_rate_noutput_to_ninput (int noutput)
 Given noutput samples, return number of input samples required to produce noutput. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this. More...
 
- Public Member Functions inherited from gr_block
virtual ~gr_block ()
 
unsigned history () const
 
void set_history (unsigned history)
 
bool fixed_rate () const
 Return true if this block has a fixed input to output rate. More...
 
virtual bool start ()
 Called to enable drivers, etc for i/o devices. More...
 
virtual bool stop ()
 Called to disable drivers, etc for i/o devices. More...
 
void set_output_multiple (int multiple)
 Constrain the noutput_items argument passed to forecast and general_work. More...
 
int output_multiple () const
 
void consume (int which_input, int how_many_items)
 Tell the scheduler how_many_items of input stream which_input were consumed. More...
 
void consume_each (int how_many_items)
 Tell the scheduler how_many_items were consumed on each input stream. More...
 
void produce (int which_output, int how_many_items)
 Tell the scheduler how_many_items were produced on output stream which_output. More...
 
void set_relative_rate (double relative_rate)
 Set the approximate output rate / input rate. More...
 
double relative_rate () const
 return the approximate output rate / input rate More...
 
uint64_t nitems_read (unsigned int which_input)
 Return the number of items read on input stream which_input. More...
 
uint64_t nitems_written (unsigned int which_output)
 Return the number of items written on output stream which_output. More...
 
tag_propagation_policy_t tag_propagation_policy ()
 Asks for the policy used by the scheduler to moved tags downstream. More...
 
void set_tag_propagation_policy (tag_propagation_policy_t p)
 Set the policy by the scheduler to determine how tags are moved downstream. More...
 
gr_block_detail_sptr detail () const
 
void set_detail (gr_block_detail_sptr detail)
 
- Public Member Functions inherited from gr_basic_block
virtual ~gr_basic_block ()
 
long unique_id () const
 
std::string name () const
 
gr_io_signature_sptr input_signature () const
 
gr_io_signature_sptr output_signature () const
 
gr_basic_block_sptr to_basic_block ()
 
virtual bool check_topology (int ninputs, int noutputs)
 Confirm that ninputs and noutputs is an acceptable combination. More...
 
template<typename T >
void set_msg_handler (T msg_handler)
 Set the callback that is fired when messages are available. More...
 
- Public Member Functions inherited from gr_msg_accepter
 gr_msg_accepter ()
 
 ~gr_msg_accepter ()
 
void post (pmt::pmt_t msg)
 send msg to msg_accepter More...
 
- Public Member Functions inherited from gruel::msg_accepter
 msg_accepter ()
 
virtual ~msg_accepter ()
 

Friends

GR_CORE_API gr_wavfile_source_sptr gr_make_wavfile_source (const char *filename, bool repeat)
 

Additional Inherited Members

- Public Types inherited from gr_block
enum  { WORK_CALLED_PRODUCE = -2, WORK_DONE = -1 }
 Magic return values from general_work. More...
 
enum  tag_propagation_policy_t { TPP_DONT = 0, TPP_ALL_TO_ALL = 1, TPP_ONE_TO_ONE = 2 }
 
- Protected Types inherited from gr_basic_block
enum  vcolor { WHITE, GREY, BLACK }
 
- Protected Member Functions inherited from gr_sync_block
 gr_sync_block (void)
 
 gr_sync_block (const std::string &name, gr_io_signature_sptr input_signature, gr_io_signature_sptr output_signature)
 
- Protected Attributes inherited from gr_basic_block
std::string d_name
 
gr_io_signature_sptr d_input_signature
 
gr_io_signature_sptr d_output_signature
 
long d_unique_id
 
vcolor d_color
 

Detailed Description

Read stream from a Microsoft PCM (.wav) file, output floats.

Unless otherwise called, values are within [-1;1]. Check gr_make_wavfile_source() for extra info.

Constructor & Destructor Documentation

gr_wavfile_source::~gr_wavfile_source ( )

Member Function Documentation

int gr_wavfile_source::bits_per_sample ( ) const
inline

Return the number of bits per sample as specified in the wav file header. Only 8 or 16 bit are supported here.

int gr_wavfile_source::channels ( ) const
inline

Return the number of channels in the wav file as specified in the wav file header. This is also the max number of outputs you can have.

unsigned int gr_wavfile_source::sample_rate ( ) const
inline

Read the sample rate as specified in the wav file header.

int gr_wavfile_source::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.

Friends And Related Function Documentation

GR_CORE_API gr_wavfile_source_sptr gr_make_wavfile_source ( const char *  filename,
bool  repeat 
)
friend

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