Queue Class Reference

#include <synth.h>

Public Member Functions
	Queue ()
uint8_t	read (uint32_t *x)
uint8_t	write (uint32_t x)

Private Member Functions
int	size (void)
int	empty (void)
int	full (void)

Private Attributes
int	wpointer
int	rpointer
uint32_t	buffer [BUFSIZE]

Detailed Description

A queue containing unsigned 32-bit samples. WARNING: This class provides NO protection against interrupts. That must be done by the user:

void example_usage(void) {
    uint8_t r;
    uint32_t x;
    x = next_audio_sample;
    cli();
    r = queue.write(x);
    sei();
    // handle case where r != 0
}

Internal implementation is a fixed-size circular buffer.

Definition at line 95 of file synth.h.

Constructor & Destructor Documentation

Queue::Queue ( )

inline

Definition at line 109 of file synth.h.

Member Function Documentation

int Queue::empty ( void  )

inlineprivate

Definition at line 102 of file synth.h.

Referenced by read().

Here is the call graph for this function:

Here is the caller graph for this function:

int Queue::full ( void  )

inlineprivate

Definition at line 105 of file synth.h.

Referenced by write().

Here is the call graph for this function:

Here is the caller graph for this function:

uint8_t Queue::read

(

uint32_t *

x

)

Read a sample from the queue.

Parameters

x	a pointer to the variable to store the sample in

Returns

0 if read is successful, 1 if queue is empty.

Definition at line 100 of file synth.cpp.

Referenced by Synth::get_sample().

Here is the call graph for this function:

Here is the caller graph for this function:

int Queue::size ( void  )

inlineprivate

Definition at line 99 of file synth.h.

Referenced by empty(), and full().

Here is the caller graph for this function:

uint8_t Queue::write

(

uint32_t

x

)

Write a sample to the queue.

Parameters

x	the sample to be written

Returns

0 if write is successful, 1 if queue is full.

Definition at line 107 of file synth.cpp.

Referenced by Synth::write_sample().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

uint32_t Queue::buffer[BUFSIZE]

private

Definition at line 98 of file synth.h.

Referenced by read(), and write().

int Queue::rpointer

private

Definition at line 97 of file synth.h.

Referenced by Queue(), read(), and size().

int Queue::wpointer

private

Definition at line 97 of file synth.h.

Referenced by Queue(), size(), and write().

---

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

• teensy/synth.h
• teensy/synth.cpp