Make ring buffer public

3 files changed, 297 insertions, 1 deletions

diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
index 3c7ed83..3fa1ed9 100644
--- a/src/CMakeLists.txt
+++ b/src/CMakeLists.txt
@@ -5,11 +5,14 @@ project(uca C)
 set(uca_SRCS
     uca-camera.c
     uca-plugin-manager.c
+    uca-ring-buffer.c
     )
 
 set(uca_HDRS
     uca-camera.h
-    uca-plugin-manager.h)
+    uca-plugin-manager.h
+    uca-ring-buffer.h
+    )
 
 create_enums(uca-enums
              ${CMAKE_CURRENT_SOURCE_DIR}/uca-enums
diff --git a/src/uca-ring-buffer.c b/src/uca-ring-buffer.c
new file mode 100644
index 0000000..d2b40a4
--- /dev/null
+++ b/src/uca-ring-buffer.c
@@ -0,0 +1,246 @@
+/* Copyright (C) 2013 Matthias Vogelgesang <matthias.vogelgesang@kit.edu>
+   (Karlsruhe Institute of Technology)
+
+   This library is free software; you can redistribute it and/or modify it
+   under the terms of the GNU Lesser General Public License as published by the
+   Free Software Foundation; either version 2.1 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 Lesser General Public License for more
+   details.
+
+   You should have received a copy of the GNU Lesser General Public License along
+   with this library; if not, write to the Free Software Foundation, Inc., 51
+   Franklin St, Fifth Floor, Boston, MA 02110, USA */
+
+#include <math.h>
+#include "uca-ring-buffer.h"
+
+#define UCA_RING_BUFFER_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE((obj), UCA_TYPE_RING_BUFFER, UcaRingBufferPrivate))
+
+G_DEFINE_TYPE(UcaRingBuffer, uca_ring_buffer, G_TYPE_OBJECT)
+
+struct _UcaRingBufferPrivate {
+    guchar  *data;
+    gsize    block_size;
+    guint    n_blocks_total;
+    guint    n_blocks_used;
+    guint    current_index;
+};
+
+enum {
+    PROP_0,
+    PROP_BLOCK_SIZE,
+    PROP_NUM_BLOCKS,
+    N_PROPERTIES
+};
+
+static GParamSpec *properties[N_PROPERTIES] = { NULL, };
+
+UcaRingBuffer *
+uca_ring_buffer_new (gsize block_size,
+                     guint n_blocks)
+{
+    UcaRingBuffer *buffer;
+
+    buffer = g_object_new (UCA_TYPE_RING_BUFFER,
+                           "block-size", (guint64) block_size,
+                           "num-blocks", n_blocks);
+    return buffer;
+}
+
+void
+uca_ring_buffer_reset (UcaRingBuffer *buffer)
+{
+    g_return_if_fail (UCA_IS_RING_BUFFER (buffer));
+
+    buffer->priv->n_blocks_used = 0;
+    buffer->priv->current_index = 0;
+}
+
+gsize
+uca_ring_buffer_get_block_size (UcaRingBuffer *buffer)
+{
+    g_return_val_if_fail (UCA_IS_RING_BUFFER (buffer), 0);
+    return buffer->priv->block_size;
+}
+
+gpointer
+uca_ring_buffer_get_current_pointer (UcaRingBuffer *buffer)
+{
+    UcaRingBufferPrivate *priv;
+
+    g_return_val_if_fail (UCA_IS_RING_BUFFER (buffer), NULL);
+    priv = buffer->priv;
+    return priv->data + (priv->current_index % priv->n_blocks_total) * priv->block_size;
+}
+
+void
+uca_ring_buffer_set_current_pointer (UcaRingBuffer *buffer,
+                                     guint index)
+{
+    g_return_if_fail (UCA_IS_RING_BUFFER (buffer));
+    g_assert (index < buffer->priv->n_blocks_total);
+    buffer->priv->current_index = index;
+}
+
+gpointer
+uca_ring_buffer_get_pointer (UcaRingBuffer *buffer,
+                             guint index)
+{
+    UcaRingBufferPrivate *priv;
+
+    g_return_val_if_fail (UCA_IS_RING_BUFFER (buffer), NULL);
+    g_assert (index < buffer->priv->n_blocks_total);
+    priv = buffer->priv;
+    return priv->data + ((priv->current_index - priv->n_blocks_used + index) % priv->n_blocks_total) * priv->block_size;
+}
+
+guint
+uca_ring_buffer_get_num_blocks (UcaRingBuffer *buffer)
+{
+    g_return_val_if_fail (UCA_IS_RING_BUFFER (buffer), 0);
+    return buffer->priv->n_blocks_used;
+}
+
+void
+uca_ring_buffer_proceed (UcaRingBuffer *buffer)
+{
+    UcaRingBufferPrivate *priv;
+    g_return_if_fail (UCA_IS_RING_BUFFER (buffer));
+
+    priv = buffer->priv;
+    priv->current_index++;
+
+    if (priv->n_blocks_used < priv->n_blocks_total)
+        priv->n_blocks_used++;
+    else
+        priv->current_index = priv->current_index % priv->n_blocks_total;
+}
+
+static void
+realloc_mem (UcaRingBufferPrivate *priv)
+{
+    if (priv->data != NULL)
+        g_free (priv->data);
+
+    priv->data = g_malloc0_n (priv->n_blocks_total, priv->block_size);
+}
+
+static void
+uca_ring_buffer_get_property (GObject *object,
+                              guint property_id,
+                              GValue *value,
+                              GParamSpec *pspec)
+{
+    UcaRingBufferPrivate *priv;
+
+    g_return_if_fail (UCA_IS_RING_BUFFER (object));
+    priv = UCA_RING_BUFFER_GET_PRIVATE (object);
+
+    switch (property_id) {
+        case PROP_BLOCK_SIZE:
+            g_value_set_uint64 (value, (guint64) priv->block_size);
+            break;
+
+        case PROP_NUM_BLOCKS:
+            g_value_set_uint (value, priv->n_blocks_total);
+            break;
+
+        default:
+            G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
+            break;
+    }
+}
+
+static void
+uca_ring_buffer_set_property (GObject *object,
+                              guint property_id,
+                              const GValue *value,
+                              GParamSpec *pspec)
+{
+    UcaRingBufferPrivate *priv;
+
+    g_return_if_fail (UCA_IS_RING_BUFFER (object));
+    priv = UCA_RING_BUFFER_GET_PRIVATE (object);
+
+    switch (property_id) {
+        case PROP_BLOCK_SIZE:
+            priv->block_size = (gsize) g_value_get_uint64 (value);
+            realloc_mem (priv);
+            break;
+
+        case PROP_NUM_BLOCKS:
+            priv->n_blocks_total = g_value_get_uint (value);
+            realloc_mem (priv);
+            break;
+
+        default:
+            G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
+            break;
+    }
+}
+
+static void
+uca_ring_buffer_dispose (GObject *object)
+{
+    G_OBJECT_CLASS (uca_ring_buffer_parent_class)->dispose (object);
+}
+
+static void
+uca_ring_buffer_finalize (GObject *object)
+{
+    UcaRingBufferPrivate *priv;
+
+    priv = UCA_RING_BUFFER_GET_PRIVATE (object);
+    g_free (priv->data);
+    priv->data = NULL;
+    G_OBJECT_CLASS (uca_ring_buffer_parent_class)->finalize (object);
+}
+
+static void
+uca_ring_buffer_class_init (UcaRingBufferClass *klass)
+{
+    GObjectClass *oclass;
+
+    oclass = G_OBJECT_CLASS (klass);
+
+    oclass->get_property = uca_ring_buffer_get_property;
+    oclass->set_property = uca_ring_buffer_set_property;
+    oclass->dispose = uca_ring_buffer_dispose;
+    oclass->finalize = uca_ring_buffer_finalize;
+
+    properties[PROP_BLOCK_SIZE] =
+        g_param_spec_uint64 ("block-size",
+                             "Block size in bytes",
+                             "Number of bytes per block",
+                             0, G_MAXUINT64, 0,
+                             G_PARAM_READWRITE | G_PARAM_CONSTRUCT);
+
+    properties[PROP_NUM_BLOCKS] =
+        g_param_spec_uint ("num-blocks",
+                           "Number of pre-allocated blocks",
+                           "Number of pre-allocated blocks",
+                           0, G_MAXUINT, 0,
+                           G_PARAM_READWRITE | G_PARAM_CONSTRUCT);
+
+    for (guint i = PROP_0 + 1; i < N_PROPERTIES; i++)
+        g_object_class_install_property (oclass, i, properties[i]);
+
+    g_type_class_add_private (klass, sizeof (UcaRingBufferPrivate));
+}
+
+static void
+uca_ring_buffer_init (UcaRingBuffer *buffer)
+{
+    UcaRingBufferPrivate *priv;
+    priv = buffer->priv = UCA_RING_BUFFER_GET_PRIVATE (buffer);
+
+    priv->n_blocks_used = 0;
+    priv->current_index = 0;
+    priv->block_size = 0;
+    priv->n_blocks_total = 0;
+    priv->data = NULL;
+}
diff --git a/src/uca-ring-buffer.h b/src/uca-ring-buffer.h
new file mode 100644
index 0000000..03e2cae
--- /dev/null
+++ b/src/uca-ring-buffer.h
@@ -0,0 +1,47 @@
+#ifndef UCA_RING_BUFFER_H
+#define UCA_RING_BUFFER_H
+
+#include <glib-object.h>
+
+#define UCA_TYPE_RING_BUFFER             (uca_ring_buffer_get_type())
+#define UCA_RING_BUFFER(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj), UCA_TYPE_RING_BUFFER, UcaRingBuffer))
+#define UCA_IS_RING_BUFFER(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj), UCA_TYPE_RING_BUFFER))
+#define UCA_RING_BUFFER_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass), UCA_TYPE_RING_BUFFER, UcaRingBufferClass))
+#define UCA_IS_RING_BUFFER_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass), UCA_TYPE_RING_BUFFER))
+#define UCA_RING_BUFFER_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj), UCA_TYPE_RING_BUFFER, UcaRingBufferClass))
+
+G_BEGIN_DECLS
+
+typedef struct _UcaRingBuffer           UcaRingBuffer;
+typedef struct _UcaRingBufferClass      UcaRingBufferClass;
+typedef struct _UcaRingBufferPrivate    UcaRingBufferPrivate;
+
+struct _UcaRingBuffer {
+    /*< private >*/
+    GObject parent;
+
+    UcaRingBufferPrivate *priv;
+};
+
+struct _UcaRingBufferClass {
+    /*< private >*/
+    GObjectClass parent;
+};
+
+UcaRingBuffer * uca_ring_buffer_new                 (gsize          block_size,
+                                                     guint          n_blocks);
+void            uca_ring_buffer_reset               (UcaRingBuffer *buffer);
+gsize           uca_ring_buffer_get_block_size      (UcaRingBuffer *buffer);
+gpointer        uca_ring_buffer_get_current_pointer (UcaRingBuffer *buffer);
+void            uca_ring_buffer_set_current_pointer (UcaRingBuffer *buffer,
+                                                     guint          index);
+gpointer        uca_ring_buffer_get_pointer         (UcaRingBuffer *buffer,
+                                                     guint          index);
+guint           uca_ring_buffer_get_num_blocks      (UcaRingBuffer *buffer);
+void            uca_ring_buffer_proceed             (UcaRingBuffer *buffer);
+
+GType uca_ring_buffer_get_type (void);
+
+G_END_DECLS
+
+#endif