libs/gst/base/gstqueuearray.h

   1 /* GStreamer
   2  * Copyright (C) 2009-2010 Edward Hervey <bilboed@bilboed.com>
   3  *
   4  * gstqueuearray.h:
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Library General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Library General Public
  17  * License along with this library; if not, write to the
  18  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  19  * Boston, MA 02110-1301, USA.
  20  */
  21
  22 #include <glib.h>
  23
  24 #ifndef __GST_QUEUE_ARRAY_H__
  25 #define __GST_QUEUE_ARRAY_H__
  26
  27 G_BEGIN_DECLS
  28
  29 /**
  30  * GstQueueArray: (skip)
  31  */
  32 typedef struct _GstQueueArray GstQueueArray;
  33
  34 GST_EXPORT
  35 GstQueueArray * gst_queue_array_new       (guint initial_size);
  36
  37 GST_EXPORT
  38 void            gst_queue_array_free      (GstQueueArray * array);
  39
  40 GST_EXPORT
  41 gpointer        gst_queue_array_pop_head  (GstQueueArray * array);
  42
  43 GST_EXPORT
  44 gpointer        gst_queue_array_peek_head (GstQueueArray * array);
  45
  46 GST_EXPORT
  47 void            gst_queue_array_push_tail (GstQueueArray * array,
  48                                            gpointer        data);
  49 GST_EXPORT
  50 gboolean        gst_queue_array_is_empty  (GstQueueArray * array);
  51
  52 GST_EXPORT
  53 gpointer        gst_queue_array_drop_element (GstQueueArray * array,
  54                                               guint           idx);
  55 GST_EXPORT
  56 guint           gst_queue_array_find (GstQueueArray * array,
  57                                       GCompareFunc    func,
  58                                       gpointer        data);
  59 GST_EXPORT
  60 guint           gst_queue_array_get_length (GstQueueArray * array);
  61
  62 /* Functions for use with structures */
  63
  64 GST_EXPORT
  65 GstQueueArray * gst_queue_array_new_for_struct (gsize struct_size,
  66                                                 guint initial_size);
  67 GST_EXPORT
  68 void            gst_queue_array_push_tail_struct (GstQueueArray * array,
  69                                                   gpointer        p_struct);
  70 GST_EXPORT
  71 gpointer        gst_queue_array_pop_head_struct  (GstQueueArray * array);
  72
  73 GST_EXPORT
  74 gpointer        gst_queue_array_peek_head_struct (GstQueueArray * array);
  75
  76 GST_EXPORT
  77 gboolean        gst_queue_array_drop_struct      (GstQueueArray * array,
  78                                                   guint           idx,
  79                                                   gpointer        p_struct);
  80
  81 G_END_DECLS
  82
  83 #endif