Piotr Brzeziński 601e31fe6e queuearray: Add sorting and sorted pushing
Adds gst_queue_array_sort for sorting and gst_queue_array_push_sorted{,struct} for pushing in a sorted order.
All three functions accept a comparison GCompareDataFunc along with optional user_data to pass to it.

In gst_queue_array_sort a small workaround was needed to correctly sort non-struct arrays. Like what _find() already
does, we need to dereference our pointers first, to make sure we can use the same comparison functions everywhere.
This is done via a small wrapper around the provided comparison function.
The array can also wrap around (tail ends up 'before' the head), in which case we have to reorder the array (similar to
what do_expand() does) to then be able to use an existing sorting function, like g_qsort_with_data().

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/5112>
2023-08-16 06:54:55 +00:00

127 lines
4.3 KiB
C

/* GStreamer
* Copyright (C) 2009-2010 Edward Hervey <bilboed@bilboed.com>
*
* gstqueuearray.h:
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#include <glib.h>
#ifndef __GST_QUEUE_ARRAY_H__
#define __GST_QUEUE_ARRAY_H__
#include <gst/base/base-prelude.h>
G_BEGIN_DECLS
/**
* GstQueueArray: (skip)
*/
typedef struct _GstQueueArray GstQueueArray;
GST_BASE_API
GstQueueArray * gst_queue_array_new (guint initial_size);
GST_BASE_API
void gst_queue_array_free (GstQueueArray * array);
GST_BASE_API
void gst_queue_array_set_clear_func (GstQueueArray *array,
GDestroyNotify clear_func);
GST_BASE_API
void gst_queue_array_clear (GstQueueArray * array);
GST_BASE_API
gpointer gst_queue_array_pop_head (GstQueueArray * array);
GST_BASE_API
gpointer gst_queue_array_peek_head (GstQueueArray * array);
GST_BASE_API
gpointer gst_queue_array_peek_nth (GstQueueArray * array, guint idx);
GST_BASE_API
gpointer gst_queue_array_pop_tail (GstQueueArray * array);
GST_BASE_API
gpointer gst_queue_array_peek_tail (GstQueueArray * array);
GST_BASE_API
void gst_queue_array_push_tail (GstQueueArray * array,
gpointer data);
GST_BASE_API
gboolean gst_queue_array_is_empty (GstQueueArray * array);
GST_BASE_API
gpointer gst_queue_array_drop_element (GstQueueArray * array,
guint idx);
GST_BASE_API
guint gst_queue_array_find (GstQueueArray * array,
GCompareFunc func,
gpointer data);
GST_BASE_API
guint gst_queue_array_get_length (GstQueueArray * array);
/* Functions for use with structures */
GST_BASE_API
GstQueueArray * gst_queue_array_new_for_struct (gsize struct_size,
guint initial_size);
GST_BASE_API
void gst_queue_array_push_tail_struct (GstQueueArray * array,
gpointer p_struct);
GST_BASE_API
gpointer gst_queue_array_pop_head_struct (GstQueueArray * array);
GST_BASE_API
gpointer gst_queue_array_peek_head_struct (GstQueueArray * array);
GST_BASE_API
gpointer gst_queue_array_peek_nth_struct (GstQueueArray * array, guint idx);
GST_BASE_API
gboolean gst_queue_array_drop_struct (GstQueueArray * array,
guint idx,
gpointer p_struct);
GST_BASE_API
gpointer gst_queue_array_pop_tail_struct (GstQueueArray * array);
GST_BASE_API
gpointer gst_queue_array_peek_tail_struct (GstQueueArray * array);
GST_BASE_API
void gst_queue_array_push_sorted (GstQueueArray * array,
gpointer data,
GCompareDataFunc func,
gpointer user_data);
GST_BASE_API
void gst_queue_array_push_sorted_struct (GstQueueArray * array,
gpointer p_struct,
GCompareDataFunc func,
gpointer user_data);
GST_BASE_API
void gst_queue_array_sort (GstQueueArray *array,
GCompareDataFunc compare_func,
gpointer user_data);
G_END_DECLS
#endif