Commit 93d61051 authored by sagnowski's avatar sagnowski Committed by Jan Kiene
Browse files

Improve documentation comments for TD ring buffer

parent 5b398160
Loading
Loading
Loading
Loading
+2 −2
Original line number Diff line number Diff line
@@ -1436,8 +1436,8 @@ typedef struct

typedef struct
{
    Word32 *data; /* samples in interleaved layout */
    UWord32 capacity;
    Word32 *data;     /* samples in interleaved layout, e.g. for channels A, B, C, samples are stored: A1, B1, C1, A2, B2, C2, ... */
    UWord32 capacity; /* max number of Word32 values that can be stored */
    UWord16 num_channels;
    UWord32 write_pos;
    UWord32 read_pos;
+6 −0
Original line number Diff line number Diff line
@@ -44,6 +44,12 @@
 * Local function prototypes
 *-----------------------------------------------------------------------*/

/*---------------------------------------------------------------------*
 * ivas_td_ringbuf_total_size()
 *
 * Returns total number of buffered samples (including number of channels)
 *---------------------------------------------------------------------*/

static UWord32 ivas_td_ringbuf_total_size(
    TD_RINGBUF_HANDLE h )
{