libobs: Remove circlebuf

Deprecated since a4b8e1a6a987bf396fe49e0ad793405e78c89fca (30.1).

docs/sphinx/reference-libobs-util-circlebuf.rst

@@ -1,161 +0,0 @@
-Circular Buffers
-================
-
-A circular buffer that will automatically increase in size as necessary
-as data is pushed to the front or back.
-
-.. deprecated:: 30.1
-   Replaced by :doc:`reference-libobs-util-deque`
-
-.. code:: cpp
-
-   #include <util/circlebuf.h>
-
-
-Circular Buffer Structure (struct circlebuf)
---------------------------------------------
-
-.. struct:: circlebuf
-.. member:: void   *circlebuf.data
-.. member:: size_t circlebuf.size
-.. member:: size_t circlebuf.start_pos
-.. member:: size_t circlebuf.end_pos
-.. member:: size_t circlebuf.capacity
-
-
-Circular Buffer Inline Functions
---------------------------------
-
-.. function:: void circlebuf_init(struct circlebuf *cb)
-
-   Initializes a circular buffer (just zeroes out the entire structure).
-
-   :param cb: The circular buffer
-
----------------------
-
-.. function:: void circlebuf_free(struct circlebuf *cb)
-
-   Frees a circular buffer.
-
-   :param cb: The circular buffer
-
----------------------
-
-.. function:: void circlebuf_reserve(struct circlebuf *cb, size_t capacity)
-
-   Reserves a specific amount of buffer space to ensure minimum
-   upsizing.
-
-   :param cb:       The circular buffer
-   :param capacity: The new capacity, in bytes
-
----------------------
-
-.. function:: void circlebuf_upsize(struct circlebuf *cb, size_t size)
-
-   Sets the current active (not just reserved) size.  Any new data is
-   zeroed.
-
-   :param cb:       The circular buffer
-   :param size:     The new size, in bytes
-
----------------------
-
-.. function:: void circlebuf_place(struct circlebuf *cb, size_t position, const void *data, size_t size)
-
-   Places data at a specific positional index (relative to the starting
-   point) within the circular buffer.
-
-   :param cb:       The circular buffer
-   :param position: Positional index relative to starting point
-   :param data:     Data to insert
-   :param size:     Size of data to insert
-
----------------------
-
-.. function:: void circlebuf_push_back(struct circlebuf *cb, const void *data, size_t size)
-
-   Pushes data to the end of the circular buffer.
-
-   :param cb:       The circular buffer
-   :param data:     Data
-   :param size:     Size of data
-
----------------------
-
-.. function:: void circlebuf_push_front(struct circlebuf *cb, const void *data, size_t size)
-
-   Pushes data to the front of the circular buffer.
-
-   :param cb:       The circular buffer
-   :param data:     Data
-   :param size:     Size of data
-
----------------------
-
-.. function:: void circlebuf_push_back_zero(struct circlebuf *cb, size_t size)
-
-   Pushes zeroed data to the end of the circular buffer.
-
-   :param cb:       The circular buffer
-   :param size:     Size
-
----------------------
-
-.. function:: void circlebuf_push_front_zero(struct circlebuf *cb, size_t size)
-
-   Pushes zeroed data to the front of the circular buffer.
-
-   :param cb:       The circular buffer
-   :param size:     Size
-
----------------------
-
-.. function:: void circlebuf_peek_front(struct circlebuf *cb, void *data, size_t size)
-
-   Peeks data at the front of the circular buffer.
-
-   :param cb:       The circular buffer
-   :param data:     Buffer to store data in
-   :param size:     Size of data to retrieve
-
----------------------
-
-.. function:: void circlebuf_peek_back(struct circlebuf *cb, void *data, size_t size)
-
-   Peeks data at the back of the circular buffer.
-
-   :param cb:       The circular buffer
-   :param data:     Buffer to store data in
-   :param size:     Size of data to retrieve
-
----------------------
-
-.. function:: void circlebuf_pop_front(struct circlebuf *cb, void *data, size_t size)
-
-   Pops data from the front of the circular buffer.
-
-   :param cb:       The circular buffer
-   :param data:     Buffer to store data in, or *NULL*
-   :param size:     Size of data to retrieve
-
----------------------
-
-.. function:: void circlebuf_pop_back(struct circlebuf *cb, void *data, size_t size)
-
-   Pops data from the back of the circular buffer.
-
-   :param cb:       The circular buffer
-   :param data:     Buffer to store data in, or *NULL*
-   :param size:     Size of data to retrieve
-
----------------------
-
-.. function:: void *circlebuf_data(struct circlebuf *cb, size_t idx)
-
-   Gets a direct pointer to data at a specific positional index within
-   the circular buffer, relative to the starting point.
-
-   :param cb:       The circular buffer
-   :param idx:      Byte index relative to the starting point

docs/sphinx/reference-libobs-util.rst

@@ -6,7 +6,6 @@ Platform/Utility API Reference (libobs/util)
 
    reference-libobs-util-base
    reference-libobs-util-bmem
-   reference-libobs-util-circlebuf
    reference-libobs-util-config-file
    reference-libobs-util-darray
    reference-libobs-util-deque

libobs/CMakeLists.txt

@@ -98,7 +98,6 @@ target_sources(
     util/cf-lexer.h
     util/cf-parser.c
     util/cf-parser.h
-    util/circlebuf.h
     util/config-file.c
     util/config-file.h
     util/crc32.c
@@ -342,7 +341,6 @@ set(
   util/c99defs.h
   util/cf-lexer.h
   util/cf-parser.h
-  util/circlebuf.h
   util/config-file.h
   util/crc32.h
   util/darray.h

libobs/util/circlebuf.h

@@ -1,319 +0,0 @@
-/*
- * Copyright (c) 2023 Lain Bailey <[email protected]>
- *
- * Permission to use, copy, modify, and distribute this software for any
- * purpose with or without fee is hereby granted, provided that the above
- * copyright notice and this permission notice appear in all copies.
- *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
- * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
- * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
- * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
- * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
- * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
- * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
- */
-
-#pragma once
-
-#include "c99defs.h"
-#include <string.h>
-#include <stdlib.h>
-#include <assert.h>
-
-#include "bmem.h"
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/* Dynamic circular buffer */
-
-OBS_DEPRECATED struct circlebuf {
-	void *data;
-	size_t size;
-
-	size_t start_pos;
-	size_t end_pos;
-	size_t capacity;
-};
-
-OBS_DEPRECATED static inline void circlebuf_init(struct circlebuf *cb)
-{
-	memset(cb, 0, sizeof(struct circlebuf));
-}
-
-OBS_DEPRECATED static inline void circlebuf_free(struct circlebuf *cb)
-{
-	bfree(cb->data);
-	memset(cb, 0, sizeof(struct circlebuf));
-}
-
-OBS_DEPRECATED static inline void circlebuf_reorder_data(struct circlebuf *cb, size_t new_capacity)
-{
-	size_t difference;
-	uint8_t *data;
-
-	if (!cb->size || !cb->start_pos || cb->end_pos > cb->start_pos)
-		return;
-
-	difference = new_capacity - cb->capacity;
-	data = (uint8_t *)cb->data + cb->start_pos;
-	memmove(data + difference, data, cb->capacity - cb->start_pos);
-	cb->start_pos += difference;
-}
-
-OBS_DEPRECATED static inline void circlebuf_ensure_capacity(struct circlebuf *cb)
-{
-	size_t new_capacity;
-	if (cb->size <= cb->capacity)
-		return;
-
-	new_capacity = cb->capacity * 2;
-	if (cb->size > new_capacity)
-		new_capacity = cb->size;
-
-	cb->data = brealloc(cb->data, new_capacity);
-	circlebuf_reorder_data(cb, new_capacity);
-	cb->capacity = new_capacity;
-}
-
-OBS_DEPRECATED static inline void circlebuf_reserve(struct circlebuf *cb, size_t capacity)
-{
-	if (capacity <= cb->capacity)
-		return;
-
-	cb->data = brealloc(cb->data, capacity);
-	circlebuf_reorder_data(cb, capacity);
-	cb->capacity = capacity;
-}
-
-OBS_DEPRECATED static inline void circlebuf_upsize(struct circlebuf *cb, size_t size)
-{
-	size_t add_size = size - cb->size;
-	size_t new_end_pos = cb->end_pos + add_size;
-
-	if (size <= cb->size)
-		return;
-
-	cb->size = size;
-	circlebuf_ensure_capacity(cb);
-
-	if (new_end_pos > cb->capacity) {
-		size_t back_size = cb->capacity - cb->end_pos;
-		size_t loop_size = add_size - back_size;
-
-		if (back_size)
-			memset((uint8_t *)cb->data + cb->end_pos, 0, back_size);
-
-		memset(cb->data, 0, loop_size);
-		new_end_pos -= cb->capacity;
-	} else {
-		memset((uint8_t *)cb->data + cb->end_pos, 0, add_size);
-	}
-
-	cb->end_pos = new_end_pos;
-}
-
-/** Overwrites data at a specific point in the buffer (relative).  */
-OBS_DEPRECATED static inline void circlebuf_place(struct circlebuf *cb, size_t position, const void *data, size_t size)
-{
-	size_t end_point = position + size;
-	size_t data_end_pos;
-
-	if (end_point > cb->size)
-		circlebuf_upsize(cb, end_point);
-
-	position += cb->start_pos;
-	if (position >= cb->capacity)
-		position -= cb->capacity;
-
-	data_end_pos = position + size;
-	if (data_end_pos > cb->capacity) {
-		size_t back_size = data_end_pos - cb->capacity;
-		size_t loop_size = size - back_size;
-
-		memcpy((uint8_t *)cb->data + position, data, loop_size);
-		memcpy(cb->data, (uint8_t *)data + loop_size, back_size);
-	} else {
-		memcpy((uint8_t *)cb->data + position, data, size);
-	}
-}
-
-OBS_DEPRECATED static inline void circlebuf_push_back(struct circlebuf *cb, const void *data, size_t size)
-{
-	size_t new_end_pos = cb->end_pos + size;
-
-	cb->size += size;
-	circlebuf_ensure_capacity(cb);
-
-	if (new_end_pos > cb->capacity) {
-		size_t back_size = cb->capacity - cb->end_pos;
-		size_t loop_size = size - back_size;
-
-		if (back_size)
-			memcpy((uint8_t *)cb->data + cb->end_pos, data, back_size);
-		memcpy(cb->data, (uint8_t *)data + back_size, loop_size);
-
-		new_end_pos -= cb->capacity;
-	} else {
-		memcpy((uint8_t *)cb->data + cb->end_pos, data, size);
-	}
-
-	cb->end_pos = new_end_pos;
-}
-
-OBS_DEPRECATED static inline void circlebuf_push_front(struct circlebuf *cb, const void *data, size_t size)
-{
-	cb->size += size;
-	circlebuf_ensure_capacity(cb);
-
-	if (cb->size == size) {
-		cb->start_pos = 0;
-		cb->end_pos = size;
-		memcpy((uint8_t *)cb->data, data, size);
-
-	} else if (cb->start_pos < size) {
-		size_t back_size = size - cb->start_pos;
-
-		if (cb->start_pos)
-			memcpy(cb->data, (uint8_t *)data + back_size, cb->start_pos);
-
-		cb->start_pos = cb->capacity - back_size;
-		memcpy((uint8_t *)cb->data + cb->start_pos, data, back_size);
-	} else {
-		cb->start_pos -= size;
-		memcpy((uint8_t *)cb->data + cb->start_pos, data, size);
-	}
-}
-
-OBS_DEPRECATED static inline void circlebuf_push_back_zero(struct circlebuf *cb, size_t size)
-{
-	size_t new_end_pos = cb->end_pos + size;
-
-	cb->size += size;
-	circlebuf_ensure_capacity(cb);
-
-	if (new_end_pos > cb->capacity) {
-		size_t back_size = cb->capacity - cb->end_pos;
-		size_t loop_size = size - back_size;
-
-		if (back_size)
-			memset((uint8_t *)cb->data + cb->end_pos, 0, back_size);
-		memset(cb->data, 0, loop_size);
-
-		new_end_pos -= cb->capacity;
-	} else {
-		memset((uint8_t *)cb->data + cb->end_pos, 0, size);
-	}
-
-	cb->end_pos = new_end_pos;
-}
-
-OBS_DEPRECATED static inline void circlebuf_push_front_zero(struct circlebuf *cb, size_t size)
-{
-	cb->size += size;
-	circlebuf_ensure_capacity(cb);
-
-	if (cb->size == size) {
-		cb->start_pos = 0;
-		cb->end_pos = size;
-		memset((uint8_t *)cb->data, 0, size);
-
-	} else if (cb->start_pos < size) {
-		size_t back_size = size - cb->start_pos;
-
-		if (cb->start_pos)
-			memset(cb->data, 0, cb->start_pos);
-
-		cb->start_pos = cb->capacity - back_size;
-		memset((uint8_t *)cb->data + cb->start_pos, 0, back_size);
-	} else {
-		cb->start_pos -= size;
-		memset((uint8_t *)cb->data + cb->start_pos, 0, size);
-	}
-}
-
-OBS_DEPRECATED static inline void circlebuf_peek_front(struct circlebuf *cb, void *data, size_t size)
-{
-	assert(size <= cb->size);
-
-	if (data) {
-		size_t start_size = cb->capacity - cb->start_pos;
-
-		if (start_size < size) {
-			memcpy(data, (uint8_t *)cb->data + cb->start_pos, start_size);
-			memcpy((uint8_t *)data + start_size, cb->data, size - start_size);
-		} else {
-			memcpy(data, (uint8_t *)cb->data + cb->start_pos, size);
-		}
-	}
-}
-
-OBS_DEPRECATED static inline void circlebuf_peek_back(struct circlebuf *cb, void *data, size_t size)
-{
-	assert(size <= cb->size);
-
-	if (data) {
-		size_t back_size = (cb->end_pos ? cb->end_pos : cb->capacity);
-
-		if (back_size < size) {
-			size_t front_size = size - back_size;
-			size_t new_end_pos = cb->capacity - front_size;
-
-			memcpy((uint8_t *)data + (size - back_size), cb->data, back_size);
-			memcpy(data, (uint8_t *)cb->data + new_end_pos, front_size);
-		} else {
-			memcpy(data, (uint8_t *)cb->data + cb->end_pos - size, size);
-		}
-	}
-}
-
-OBS_DEPRECATED static inline void circlebuf_pop_front(struct circlebuf *cb, void *data, size_t size)
-{
-	circlebuf_peek_front(cb, data, size);
-
-	cb->size -= size;
-	if (!cb->size) {
-		cb->start_pos = cb->end_pos = 0;
-		return;
-	}
-
-	cb->start_pos += size;
-	if (cb->start_pos >= cb->capacity)
-		cb->start_pos -= cb->capacity;
-}
-
-OBS_DEPRECATED static inline void circlebuf_pop_back(struct circlebuf *cb, void *data, size_t size)
-{
-	circlebuf_peek_back(cb, data, size);
-
-	cb->size -= size;
-	if (!cb->size) {
-		cb->start_pos = cb->end_pos = 0;
-		return;
-	}
-
-	if (cb->end_pos <= size)
-		cb->end_pos = cb->capacity - (size - cb->end_pos);
-	else
-		cb->end_pos -= size;
-}
-
-OBS_DEPRECATED static inline void *circlebuf_data(struct circlebuf *cb, size_t idx)
-{
-	uint8_t *ptr = (uint8_t *)cb->data;
-	size_t offset = cb->start_pos + idx;
-
-	if (idx >= cb->size)
-		return NULL;
-
-	if (offset >= cb->capacity)
-		offset -= cb->capacity;
-
-	return ptr + offset;
-}
-
-#ifdef __cplusplus
-}
-#endif