OnlinePaSource Class Reference

#include <online-audio-source.h>

Inheritance diagram for OnlinePaSource:

Collaboration diagram for OnlinePaSource:

Public Types
typedef int16	SampleType
typedef ring_buffer_size_t	rbs_t

Public Member Functions
	OnlinePaSource (const uint32 timeout, const uint32 sample_rate, const uint32 rb_size, const uint32 report_interval)
bool	Read (Vector< BaseFloat > *data)
bool	TimedOut ()
	~OnlinePaSource ()
Public Member Functions inherited from OnlineAudioSourceItf
virtual	~OnlineAudioSourceItf ()

Private Member Functions
int	Callback (const void *input, void *output, ring_buffer_size_t frame_count, const PaStreamCallbackTimeInfo *time_info, PaStreamCallbackFlags status_flags)
	KALDI_DISALLOW_COPY_AND_ASSIGN (OnlinePaSource)

Private Attributes
uint32	timeout_
bool	timed_out_
uint32	sample_rate_
int32	rb_size_
char *	ring_buffer_
PaUtilRingBuffer	pa_ringbuf_
PaStream *	pa_stream_
bool	pa_started_
uint32	report_interval_
uint32	nread_calls_
uint32	noverflows_
uint32	samples_lost_

Friends
int	PaCallback (const void *input, void *output, long unsigned frame_count, const PaStreamCallbackTimeInfo *time_info, PaStreamCallbackFlags status_flags, void *user_data)

Detailed Description

Definition at line 66 of file online-audio-source.h.

Member Typedef Documentation

rbs_t

typedef ring_buffer_size_t rbs_t

Definition at line 69 of file online-audio-source.h.

SampleType

typedef int16 SampleType

Definition at line 68 of file online-audio-source.h.

Constructor & Destructor Documentation

OnlinePaSource()

OnlinePaSource	(	const uint32	timeout,
		const uint32	sample_rate,
		const uint32	rb_size,
		const uint32	report_interval
	)

Definition at line 49 of file online-audio-source.cc.

References KALDI_ASSERT, KALDI_ERR, kaldi::Log(), OnlinePaSource::pa_ringbuf_, OnlinePaSource::pa_stream_, OnlinePaSource::PaCallback, OnlinePaSource::rb_size_, OnlinePaSource::ring_buffer_, and OnlinePaSource::sample_rate_.

    : timeout_(timeout), timed_out_(false),
      sample_rate_(sample_rate), pa_started_(false),
      report_interval_(report_interval), nread_calls_(0),
      noverflows_(0), samples_lost_(0) {
  using namespace std;

  // Note this will work for 32bit integers but not for 64bit.
  // For 64bit integers even double wouldn't work
  // You would have to use something like
  // int64 rb_bits = 0; while (rb_size != 0) {++rb_bits; rb_size >>= 1;}
  // it would be much faster than two logs of FP numbers (even floats), too,
  // but I don't have the time to test it.
  float f = Log(static_cast<float>(rb_size)) / Log(static_cast<float>(2));
  int32 rb_bits = static_cast<int32>(ceil(f));
  if (rb_bits > 30)  // ok, this limit is somewhat arbitrary
    throw invalid_argument("PortAudio ring buffer too large!");
  rb_size_ = 1 << rb_bits;
  ring_buffer_ = new char[rb_size_];
  ring_buffer_size_t rbs = PaUtil_InitializeRingBuffer(
                               &pa_ringbuf_, sizeof(SampleType),
                               rb_size_ / sizeof(SampleType), ring_buffer_);
  if (rbs != 0)
    KALDI_ERR << "PortAudio ring buffer init error";

  PaError paerr = Pa_Initialize();
  if (paerr != paNoError)
    KALDI_ERR << "PortAudio initialization error";
  // Monophone, 16-bit input hardcoded
  KALDI_ASSERT(sizeof(SampleType) == 2 &&
               "The current OnlinePaSource code assumes 16-bit input");
  paerr = Pa_OpenDefaultStream(&pa_stream_, 1, 0, paInt16, sample_rate_, 0,
                               PaCallback, this);
  if (paerr != paNoError)
    KALDI_ERR << "PortAudio failed to open the default stream";
}

~OnlinePaSource()

~OnlinePaSource

(

)

Definition at line 90 of file online-audio-source.cc.

References OnlinePaSource::pa_started_, OnlinePaSource::pa_stream_, and OnlinePaSource::ring_buffer_.

                                {
  if (pa_started_)
    Pa_StopStream(pa_stream_);
  if (pa_stream_ != 0) {
    Pa_CloseStream(pa_stream_);
    Pa_Terminate();
  }
  if (ring_buffer_ != 0)
    delete [] ring_buffer_;
}

Member Function Documentation

Callback()

int Callback ( const void *  input, void *  output, ring_buffer_size_t  frame_count, const PaStreamCallbackTimeInfo *  time_info, PaStreamCallbackFlags  status_flags  )

private

Definition at line 156 of file online-audio-source.cc.

References OnlinePaSource::noverflows_, OnlinePaSource::pa_ringbuf_, OnlinePaSource::report_interval_, and OnlinePaSource::samples_lost_.

Referenced by kaldi::PaCallback().

                                                                 {
  if (report_interval_ != 0) {
    if (frame_count > PaUtil_GetRingBufferWriteAvailable(&pa_ringbuf_))
      ++noverflows_;
  }
  rbs_t written = PaUtil_WriteRingBuffer(&pa_ringbuf_, input, frame_count);
  samples_lost_ += frame_count - written;
  return paContinue;
}

KALDI_DISALLOW_COPY_AND_ASSIGN()

KALDI_DISALLOW_COPY_AND_ASSIGN ( OnlinePaSource  )

private

Read()

bool Read ( Vector< BaseFloat > *  data )

virtual

Implements OnlineAudioSourceItf.

Definition at line 102 of file online-audio-source.cc.

References VectorBase< Real >::Dim(), Timer::Elapsed(), rnnlm::i, KALDI_ERR, KALDI_VLOG, KALDI_WARN, OnlinePaSource::noverflows_, OnlinePaSource::nread_calls_, OnlinePaSource::pa_ringbuf_, OnlinePaSource::pa_started_, OnlinePaSource::pa_stream_, OnlinePaSource::report_interval_, Vector< Real >::Resize(), OnlinePaSource::samples_lost_, OnlinePaSource::timed_out_, and OnlinePaSource::timeout_.

                                                 {
  if (!pa_started_) {  // start stream the first time Read() is called
    PaError paerr = Pa_StartStream(pa_stream_);
    if (paerr != paNoError)
      KALDI_ERR << "Error while trying to open PortAudio stream";
    pa_started_ = true;
  }
  Timer timer;
  if (report_interval_ != 0
      && (++nread_calls_ % report_interval_) == 0
      && noverflows_ > 0) {
      KALDI_VLOG(1) << noverflows_
                    << " PortAudio ring buffer overflows detected "
                    << "and " << samples_lost_ << " sample(s) were lost";
      samples_lost_ = noverflows_ = 0;
  }
  uint32 nsamples_req = data->Dim();  // samples to request
  timed_out_ = false;
  while (true) {
    ring_buffer_size_t nsamples;
    nsamples = PaUtil_GetRingBufferReadAvailable(&pa_ringbuf_);
    if (nsamples >= nsamples_req)
      break;
    if (timeout_ > 0) {
      int32 elapsed = static_cast<int32>(timer.Elapsed() * 1000);
      if (elapsed > timeout_) {
        nsamples_req = nsamples;
        timed_out_ = true;
        KALDI_VLOG(2) << "OnlinePaSource::Read() timeout";
        break;
      }
    }
    Pa_Sleep(2);
  }
  std::vector<int16> buf(nsamples_req);
  rbs_t nsamples_rcv;
  nsamples_rcv = PaUtil_ReadRingBuffer(&pa_ringbuf_, buf.data(), nsamples_req);
  if (nsamples_rcv != nsamples_req) {
    KALDI_WARN << "Requested: " << nsamples_req
               << "; Received: " << nsamples_rcv << " samples";
    // This would be a PortAudio error.
  }
  data->Resize(nsamples_rcv);
  for (int i = 0; i < nsamples_rcv; ++i)
    (*data)(i) = static_cast<BaseFloat>(buf[i]);

  return (nsamples_rcv != 0);
  // NOTE (Dan): I'm pretty sure this return value is not right, it could be
  // this way because we're waiting.  Vassil or someone will have to figure this
  // out.
}

TimedOut()

bool TimedOut ( )

inline

Definition at line 100 of file online-audio-source.h.

Referenced by main().

{ return timed_out_; }

Friends And Related Function Documentation

PaCallback

int PaCallback ( const void *  input, void *  output, long unsigned  frame_count, const PaStreamCallbackTimeInfo *  time_info, PaStreamCallbackFlags  status_flags, void *  user_data  )

friend

Definition at line 39 of file online-audio-source.cc.

Referenced by OnlinePaSource::OnlinePaSource().

                                {
  OnlinePaSource *pa_src = reinterpret_cast<OnlinePaSource*>(user_data);
  return pa_src->Callback(input, output, frame_count, time_info, status_flags);
}

Member Data Documentation

noverflows_

uint32 noverflows_

private

Definition at line 123 of file online-audio-source.h.

Referenced by OnlinePaSource::Callback(), and OnlinePaSource::Read().

nread_calls_

uint32 nread_calls_

private

Definition at line 122 of file online-audio-source.h.

Referenced by OnlinePaSource::Read().

pa_ringbuf_

PaUtilRingBuffer pa_ringbuf_

private

Definition at line 118 of file online-audio-source.h.

Referenced by OnlinePaSource::Callback(), OnlinePaSource::OnlinePaSource(), and OnlinePaSource::Read().

pa_started_

bool pa_started_

private

Definition at line 120 of file online-audio-source.h.

Referenced by OnlinePaSource::Read(), and OnlinePaSource::~OnlinePaSource().

pa_stream_

PaStream* pa_stream_

private

Definition at line 119 of file online-audio-source.h.

Referenced by OnlinePaSource::OnlinePaSource(), OnlinePaSource::Read(), and OnlinePaSource::~OnlinePaSource().

rb_size_

int32 rb_size_

private

Definition at line 116 of file online-audio-source.h.

Referenced by OnlinePaSource::OnlinePaSource().

report_interval_

uint32 report_interval_

private

Definition at line 121 of file online-audio-source.h.

Referenced by OnlinePaSource::Callback(), and OnlinePaSource::Read().

ring_buffer_

char* ring_buffer_

private

Definition at line 117 of file online-audio-source.h.

Referenced by OnlinePaSource::OnlinePaSource(), and OnlinePaSource::~OnlinePaSource().

sample_rate_

uint32 sample_rate_

private

Definition at line 115 of file online-audio-source.h.

Referenced by OnlinePaSource::OnlinePaSource().

samples_lost_

uint32 samples_lost_

private

Definition at line 124 of file online-audio-source.h.

Referenced by OnlinePaSource::Callback(), and OnlinePaSource::Read().

timed_out_

bool timed_out_

private

Definition at line 113 of file online-audio-source.h.

Referenced by OnlinePaSource::Read().

timeout_

uint32 timeout_

private

Definition at line 111 of file online-audio-source.h.

Referenced by OnlinePaSource::Read().

---

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

• online/online-audio-source.h
• online/online-audio-source.cc