Commit 9d09e4b5 authored by sagnowski's avatar sagnowski
Browse files

Improve documentation comments for TD ring buffer

parent 6f3ffe53

lib_rend/ivas_stat_rend.h

+2 −2
Original line number Diff line number Diff line
@@ -1381,8 +1381,8 @@ typedef struct 


typedef struct

{

    float *data; /* samples in interleaved layout */

    uint32_t capacity;

    float *data;       /* samples in interleaved layout, e.g. for channels A, B, C, samples are stored: A1, B1, C1, A2, B2, C2, ... */

    uint32_t capacity; /* max number of float values that can be stored */

    uint16_t num_channels;

    uint32_t write_pos;

    uint32_t read_pos;

lib_rend/ivas_td_ring_buffer.c

+6 −0
Original line number Diff line number Diff line
@@ -42,6 +42,12 @@ 
 * Local function prototypes

 *-----------------------------------------------------------------------*/



/*---------------------------------------------------------------------*

 * ivas_td_ringbuf_total_size()

 *

 * Returns total number of buffered samples (including number of channels)

 *---------------------------------------------------------------------*/



static uint32_t ivas_td_ringbuf_total_size(

    TD_RINGBUF_HANDLE h )

{