1
0
mirror of https://github.com/jojo61/vdr-plugin-softhdcuvid.git synced 2023-10-10 13:37:41 +02:00
vdr-plugin-softhdcuvid/ringbuffer.h

63 lines
1.8 KiB
C
Raw Normal View History

2018-08-19 11:45:46 +02:00
///
/// @file ringbuffer.h @brief Ringbuffer module header file
2018-08-19 11:45:46 +02:00
///
/// Copyright (c) 2009, 2011 by Johns. All Rights Reserved.
2018-08-19 11:45:46 +02:00
///
/// Contributor(s):
2018-08-19 11:45:46 +02:00
///
/// License: AGPLv3
2018-08-19 11:45:46 +02:00
///
/// This program is free software: you can redistribute it and/or modify
/// it under the terms of the GNU Affero General Public License as
/// published by the Free Software Foundation, either version 3 of the
/// License.
2018-08-19 11:45:46 +02:00
///
/// This program is distributed in the hope that it will be useful,
/// but WITHOUT ANY WARRANTY; without even the implied warranty of
/// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
/// GNU Affero General Public License for more details.
2018-08-19 11:45:46 +02:00
///
/// $Id: 8a2b4c171f1024afb8b8a7a7add631b7ebe2d45e $
2018-08-19 11:45:46 +02:00
//////////////////////////////////////////////////////////////////////////////
/// @addtogroup Ringbuffer
/// @{
2019-10-28 21:43:37 +01:00
/// ring buffer typedef
2018-08-19 11:45:46 +02:00
typedef struct _ring_buffer_ RingBuffer;
2019-10-28 21:43:37 +01:00
/// reset ring buffer pointers
2018-08-19 11:45:46 +02:00
extern void RingBufferReset(RingBuffer *);
2019-10-28 21:43:37 +01:00
/// create new ring buffer
2018-08-19 11:45:46 +02:00
extern RingBuffer *RingBufferNew(size_t);
2019-10-28 21:43:37 +01:00
/// free ring buffer
2018-08-19 11:45:46 +02:00
extern void RingBufferDel(RingBuffer *);
2019-10-28 21:43:37 +01:00
/// write into ring buffer
2018-08-19 11:45:46 +02:00
extern size_t RingBufferWrite(RingBuffer *, const void *, size_t);
2019-10-28 21:43:37 +01:00
/// get write pointer of ring buffer
2018-08-19 11:45:46 +02:00
extern size_t RingBufferGetWritePointer(RingBuffer *, void **);
2019-10-28 21:43:37 +01:00
/// advance write pointer of ring buffer
2018-08-19 11:45:46 +02:00
extern size_t RingBufferWriteAdvance(RingBuffer *, size_t);
2019-10-28 21:43:37 +01:00
/// read from ring buffer
2018-08-19 11:45:46 +02:00
extern size_t RingBufferRead(RingBuffer *, void *, size_t);
2019-10-28 21:43:37 +01:00
/// get read pointer of ring buffer
2018-08-19 11:45:46 +02:00
extern size_t RingBufferGetReadPointer(RingBuffer *, const void **);
2019-10-28 21:43:37 +01:00
/// advance read pointer of ring buffer
2018-08-19 11:45:46 +02:00
extern size_t RingBufferReadAdvance(RingBuffer *, size_t);
2019-10-28 21:43:37 +01:00
/// free bytes ring buffer
2018-08-19 11:45:46 +02:00
extern size_t RingBufferFreeBytes(RingBuffer *);
2019-10-28 21:43:37 +01:00
/// used bytes ring buffer
2018-08-19 11:45:46 +02:00
extern size_t RingBufferUsedBytes(RingBuffer *);
/// @}