Add prelimary UFO camera support

6 files changed, 384 insertions, 5 deletions

diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
index cfa5f9c..db2ba46 100644
--- a/src/CMakeLists.txt
+++ b/src/CMakeLists.txt
@@ -69,11 +69,11 @@ if (PCO_FOUND AND CLSERME4_FOUND AND FGLIB5_FOUND)
 endif()
 
 if (IPE_FOUND)
-    option(HAVE_IPE_CAMERA "Camera: Custom IPE based on Xilinx FPGA" ON)
+    option(HAVE_UFO_CAMERA "Camera: Custom based on Xilinx FPGA" ON)
 
-    if (HAVE_IPE_CAMERA)
-        set(uca_SRCS ${uca_SRCS} cameras/uca-ipe-camera.c)
-        set(uca_HDRS ${uca_HDRS} cameras/uca-ipe-camera.h)
+    if (HAVE_UFO_CAMERA)
+        set(uca_SRCS ${uca_SRCS} cameras/uca-ufo-camera.c)
+        set(uca_HDRS ${uca_HDRS} cameras/uca-ufo-camera.h)
         set(uca_LIBS ${uca_LIBS} ${IPE_LIBRARIES})
 
         include_directories(${IPE_INCLUDE_DIRS})
diff --git a/src/cameras/uca-mock-camera.c b/src/cameras/uca-mock-camera.c
index 0198b9f..e573d21 100644
--- a/src/cameras/uca-mock-camera.c
+++ b/src/cameras/uca-mock-camera.c
@@ -31,6 +31,7 @@ enum {
     PROP_SENSOR_HORIZONTAL_BINNINGS,
     PROP_SENSOR_VERTICAL_BINNING,
     PROP_SENSOR_VERTICAL_BINNINGS,
+    PROP_EXPOSURE_TIME,
     PROP_ROI_X,
     PROP_ROI_Y,
     PROP_ROI_WIDTH,
@@ -52,6 +53,7 @@ static const gchar *mock_overrideables[N_PROPERTIES] = {
     "sensor-horizontal-binnings",
     "sensor-vertical-binning",
     "sensor-vertical-binnings",
+    "exposure-time",
     "roi-x",
     "roi-y",
     "roi-width",
@@ -204,6 +206,9 @@ static void uca_mock_camera_get_property(GObject *object, guint property_id, GVa
         case PROP_SENSOR_VERTICAL_BINNINGS:
             g_value_set_boxed(value, priv->binnings);
             break;
+        case PROP_EXPOSURE_TIME:
+            g_value_set_double(value, 0.001);
+            break;
         case PROP_ROI_X:
             g_value_set_uint(value, 0);
             break;
diff --git a/src/cameras/uca-ufo-camera.c b/src/cameras/uca-ufo-camera.c
new file mode 100644
index 0000000..52d06fb
--- /dev/null
+++ b/src/cameras/uca-ufo-camera.c
@@ -0,0 +1,289 @@
+/* Copyright (C) 2011, 2012 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 <stdlib.h>
+#include <stdio.h>
+#include <string.h>
+#include <pcilib.h>
+#include <errno.h>
+#include "uca-camera.h"
+#include "uca-ufo-camera.h"
+
+#define PCILIB_SET_ERROR(err, err_type)                 \
+    if (err != 0) {                                     \
+        g_set_error(error, UCA_UFO_CAMERA_ERROR,        \
+                err_type,                               \
+                "Errno: %s", strerror(err));            \
+        return;                                         \
+    }
+
+#define UCA_UFO_CAMERA_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE((obj), UCA_TYPE_UFO_CAMERA, UcaUfoCameraPrivate))
+
+G_DEFINE_TYPE(UcaUfoCamera, uca_ufo_camera, UCA_TYPE_CAMERA)
+
+static const guint SENSOR_WIDTH = 2048;
+static const guint SENSOR_HEIGHT = 1088;
+
+/**
+ * UcaUfoCameraError:
+ * @UCA_UFO_CAMERA_ERROR_INIT: Initializing pcilib failed
+ * @UCA_UFO_CAMERA_ERROR_START_RECORDING: Starting failed
+ * @UCA_UFO_CAMERA_ERROR_STOP_RECORDING: Stopping failed
+ * @UCA_UFO_CAMERA_ERROR_TRIGGER: Triggering a frame failed
+ * @UCA_UFO_CAMERA_ERROR_NEXT_EVENT: No event happened
+ * @UCA_UFO_CAMERA_ERROR_NO_DATA: No data was transmitted
+ * @UCA_UFO_CAMERA_ERROR_MAYBE_CORRUPTED: Data is potentially corrupted
+ */
+GQuark uca_ufo_camera_error_quark()
+{
+    return g_quark_from_static_string("uca-ufo-camera-error-quark");
+}
+
+enum {
+    PROP_0,
+    PROP_SENSOR_WIDTH,
+    PROP_SENSOR_HEIGHT,
+    PROP_SENSOR_BITDEPTH,
+    PROP_EXPOSURE_TIME,
+    PROP_ROI_X,
+    PROP_ROI_Y,
+    PROP_ROI_WIDTH,
+    PROP_ROI_HEIGHT,
+    PROP_HAS_STREAMING,
+    PROP_HAS_CAMRAM_RECORDING,
+    N_INTERFACE_PROPERTIES,
+
+    PROP_NAME,
+    N_PROPERTIES
+};
+
+static const gchar *base_overrideables[N_PROPERTIES] = {
+    "sensor-width",
+    "sensor-height",
+    "sensor-bitdepth",
+    "exposure-time",
+    "roi-x",
+    "roi-y",
+    "roi-width",
+    "roi-height",
+    "has-streaming",
+    "has-camram-recording"
+};
+
+static GParamSpec *ufo_properties[N_PROPERTIES - N_INTERFACE_PROPERTIES - 1] = { NULL, };
+
+
+struct _UcaUfoCameraPrivate {
+    pcilib_t *handle;
+};
+
+static void ignore_messages(const char *format, ...)
+{
+}
+
+UcaUfoCamera *uca_ufo_camera_new(GError **error)
+{
+    pcilib_model_t model = PCILIB_MODEL_DETECT;
+    pcilib_t *handle = pcilib_open("/dev/fpga0", model);
+
+    if (handle == NULL) {
+        g_set_error(error, UCA_UFO_CAMERA_ERROR, UCA_UFO_CAMERA_ERROR_INIT,
+                "Initializing pcilib failed");
+        return NULL;
+    }
+
+    pcilib_set_error_handler(&ignore_messages, &ignore_messages);
+
+    UcaUfoCamera *camera = g_object_new(UCA_TYPE_UFO_CAMERA, NULL);
+    UcaUfoCameraPrivate *priv = UCA_UFO_CAMERA_GET_PRIVATE(camera);
+
+    priv->handle = handle;
+
+    return camera;
+}
+
+static void uca_ufo_camera_start_recording(UcaCamera *camera, GError **error)
+{
+    g_return_if_fail(UCA_IS_UFO_CAMERA(camera));
+    UcaUfoCameraPrivate *priv = UCA_UFO_CAMERA_GET_PRIVATE(camera);
+    int err = pcilib_start(priv->handle, PCILIB_EVENT_DATA, PCILIB_EVENT_FLAGS_DEFAULT);
+    PCILIB_SET_ERROR(err, UCA_UFO_CAMERA_ERROR_START_RECORDING);
+}
+
+static void uca_ufo_camera_stop_recording(UcaCamera *camera, GError **error)
+{
+    g_return_if_fail(UCA_IS_UFO_CAMERA(camera));
+    UcaUfoCameraPrivate *priv = UCA_UFO_CAMERA_GET_PRIVATE(camera);
+    int err = pcilib_stop(priv->handle, PCILIB_EVENT_FLAGS_DEFAULT);
+    PCILIB_SET_ERROR(err, UCA_UFO_CAMERA_ERROR_START_RECORDING);
+}
+
+static void uca_ufo_camera_start_readout(UcaCamera *camera, GError **error)
+{
+    g_return_if_fail(UCA_IS_UFO_CAMERA(camera));
+}
+
+static void uca_ufo_camera_grab(UcaCamera *camera, gpointer *data, GError **error)
+{
+    g_return_if_fail(UCA_IS_UFO_CAMERA(camera));
+    UcaUfoCameraPrivate *priv = UCA_UFO_CAMERA_GET_PRIVATE(camera);
+    const gsize size = SENSOR_WIDTH * SENSOR_HEIGHT * sizeof(guint16);
+    pcilib_event_id_t event_id;
+    pcilib_event_info_t event_info;
+    size_t err = 0;
+
+    err = pcilib_trigger(priv->handle, PCILIB_EVENT0, 0, NULL);
+    PCILIB_SET_ERROR(err, UCA_UFO_CAMERA_ERROR_TRIGGER);
+
+    err = pcilib_get_next_event(priv->handle, PCILIB_TIMEOUT_INFINITE, &event_id, sizeof(pcilib_event_info_t), &event_info);
+    PCILIB_SET_ERROR(err, UCA_UFO_CAMERA_ERROR_NEXT_EVENT);
+
+    if (*data == NULL)
+        *data = g_malloc0(SENSOR_WIDTH * SENSOR_HEIGHT * sizeof(guint16));
+
+    gpointer src = pcilib_get_data(priv->handle, event_id, PCILIB_EVENT_DATA, &err);
+
+    if (src == NULL)
+        PCILIB_SET_ERROR(err, UCA_UFO_CAMERA_ERROR_NO_DATA);
+
+    /*
+     * Apparently, we checked that err equals total size in previous version.
+     * This is problematic because errno is positive and size could be equal
+     * even when an error condition is met, e.g. with a very small ROI. However,
+     * we don't know if src will always be NULL when an error occured.
+     */
+    /* assert(err == size); */
+
+    memcpy(data, src, size);
+
+    /*
+     * Another problem here. What does this help us? At this point we have
+     * already overwritten the original buffer but can only know here if the
+     * data is corrupted.
+     */
+    err = pcilib_return_data(priv->handle, event_id, PCILIB_EVENT_DATA, data);
+    PCILIB_SET_ERROR(err, UCA_UFO_CAMERA_ERROR_MAYBE_CORRUPTED);
+}
+
+static void uca_ufo_camera_set_property(GObject *object, guint property_id, const GValue *value, GParamSpec *pspec)
+{
+    switch (property_id) {
+        default:
+            G_OBJECT_WARN_INVALID_PROPERTY_ID(object, property_id, pspec);
+            return;
+    }
+}
+
+static void uca_ufo_camera_get_property(GObject *object, guint property_id, GValue *value, GParamSpec *pspec)
+{
+    UcaUfoCameraPrivate *priv = UCA_UFO_CAMERA_GET_PRIVATE(object);
+
+    switch (property_id) {
+        case PROP_SENSOR_WIDTH: 
+            g_value_set_uint(value, SENSOR_WIDTH);
+            break;
+
+        case PROP_SENSOR_HEIGHT: 
+            g_value_set_uint(value, SENSOR_HEIGHT);
+            break;
+
+        case PROP_SENSOR_BITDEPTH:
+            g_value_set_uint(value, 10);
+            break;
+
+        case PROP_EXPOSURE_TIME:
+            {
+                const gdouble factor = 2.67e-6;
+                pcilib_register_value_t time_steps;
+                pcilib_read_register(priv->handle, NULL, "exp_time", &time_steps);
+                g_value_set_double(value, factor * time_steps); 
+            }
+            break;
+
+        case PROP_HAS_STREAMING:
+            g_value_set_boolean(value, TRUE);
+            break;
+
+        case PROP_HAS_CAMRAM_RECORDING:
+            g_value_set_boolean(value, FALSE);
+            break;
+
+        case PROP_ROI_X:
+            g_value_set_uint(value, 0);
+            break;
+
+        case PROP_ROI_Y:
+            g_value_set_uint(value, 0);
+            break;
+
+        case PROP_ROI_WIDTH:
+            g_value_set_uint(value, SENSOR_WIDTH);
+            break;
+
+        case PROP_ROI_HEIGHT:
+            g_value_set_uint(value, SENSOR_HEIGHT);
+            break;
+
+        case PROP_NAME: 
+            g_value_set_string(value, "Ufo Camera w/ CMOSIS CMV2000");
+            break;
+
+        default:
+            G_OBJECT_WARN_INVALID_PROPERTY_ID(object, property_id, pspec);
+            break;
+    }
+}
+
+static void uca_ufo_camera_finalize(GObject *object)
+{
+    UcaUfoCameraPrivate *priv = UCA_UFO_CAMERA_GET_PRIVATE(object);
+    pcilib_close(priv->handle);
+    G_OBJECT_CLASS(uca_ufo_camera_parent_class)->finalize(object);
+}
+
+static void uca_ufo_camera_class_init(UcaUfoCameraClass *klass)
+{
+    GObjectClass *gobject_class = G_OBJECT_CLASS(klass);
+    gobject_class->set_property = uca_ufo_camera_set_property;
+    gobject_class->get_property = uca_ufo_camera_get_property;
+    gobject_class->finalize = uca_ufo_camera_finalize;
+
+    UcaCameraClass *camera_class = UCA_CAMERA_CLASS(klass);
+    camera_class->start_recording = uca_ufo_camera_start_recording;
+    camera_class->stop_recording = uca_ufo_camera_stop_recording;
+    camera_class->start_readout = uca_ufo_camera_start_readout;
+    camera_class->grab = uca_ufo_camera_grab;
+
+    for (guint id = PROP_0 + 1; id < N_INTERFACE_PROPERTIES; id++)
+        g_object_class_override_property(gobject_class, id, base_overrideables[id-1]);
+
+    ufo_properties[PROP_NAME] = 
+        g_param_spec_string("name",
+            "Name of the camera",
+            "Name of the camera",
+            "", G_PARAM_READABLE);
+
+    for (guint id = N_INTERFACE_PROPERTIES + 1; id < N_PROPERTIES; id++)
+        g_object_class_install_property(gobject_class, id, ufo_properties[id]);
+
+    g_type_class_add_private(klass, sizeof(UcaUfoCameraPrivate));
+}
+
+static void uca_ufo_camera_init(UcaUfoCamera *self)
+{
+    self->priv = UCA_UFO_CAMERA_GET_PRIVATE(self);
+}
diff --git a/src/cameras/uca-ufo-camera.h b/src/cameras/uca-ufo-camera.h
new file mode 100644
index 0000000..e97eb17
--- /dev/null
+++ b/src/cameras/uca-ufo-camera.h
@@ -0,0 +1,74 @@
+/* Copyright (C) 2011, 2012 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 */
+
+#ifndef __UCA_UFO_CAMERA_H
+#define __UCA_UFO_CAMERA_H
+
+#include <glib-object.h>
+#include "uca-camera.h"
+
+#define UCA_TYPE_UFO_CAMERA             (uca_ufo_camera_get_type())
+#define UCA_UFO_CAMERA(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj), UCA_TYPE_UFO_CAMERA, UcaUfoCamera))
+#define UCA_IS_UFO_CAMERA(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj), UCA_TYPE_UFO_CAMERA))
+#define UCA_UFO_CAMERA_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass), UCA_TYPE_UFO_CAMERA, UcaUfoCameraClass))
+#define UCA_IS_UFO_CAMERA_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass), UCA_TYPE_UFO_CAMERA))
+#define UCA_UFO_CAMERA_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj), UCA_TYPE_UFO_CAMERA, UcaUfoCameraClass))
+
+#define UCA_UFO_CAMERA_ERROR uca_ufo_camera_error_quark()
+typedef enum {
+    UCA_UFO_CAMERA_ERROR_INIT,
+    UCA_UFO_CAMERA_ERROR_START_RECORDING,
+    UCA_UFO_CAMERA_ERROR_STOP_RECORDING,
+    UCA_UFO_CAMERA_ERROR_TRIGGER,
+    UCA_UFO_CAMERA_ERROR_NEXT_EVENT,
+    UCA_UFO_CAMERA_ERROR_NO_DATA,
+    UCA_UFO_CAMERA_ERROR_MAYBE_CORRUPTED
+} UcaUfoCameraError;
+
+typedef struct _UcaUfoCamera           UcaUfoCamera;
+typedef struct _UcaUfoCameraClass      UcaUfoCameraClass;
+typedef struct _UcaUfoCameraPrivate    UcaUfoCameraPrivate;
+
+/**
+ * UcaUfoCamera:
+ *
+ * Creates #UcaUfoCamera instances by loading corresponding shared objects. The
+ * contents of the #UcaUfoCamera structure are private and should only be
+ * accessed via the provided API.
+ */
+struct _UcaUfoCamera {
+    /*< private >*/
+    UcaCamera parent;
+
+    UcaUfoCameraPrivate *priv;
+};
+
+/**
+ * UcaUfoCameraClass:
+ *
+ * #UcaUfoCamera class
+ */
+struct _UcaUfoCameraClass {
+    /*< private >*/
+    UcaCameraClass parent;
+};
+
+UcaUfoCamera *uca_ufo_camera_new(GError **error);
+
+GType uca_ufo_camera_get_type(void);
+
+#endif
diff --git a/src/config.h.in b/src/config.h.in
index 6a6b6b4..4eee2db 100644
--- a/src/config.h.in
+++ b/src/config.h.in
@@ -1,6 +1,6 @@
 #cmakedefine HAVE_PCO_CL
 #cmakedefine HAVE_PHOTON_FOCUS
 #cmakedefine HAVE_PHOTRON_FASTCAM
-#cmakedefine HAVE_IPE_CAMERA
+#cmakedefine HAVE_UFO_CAMERA
 
 #cmakedefine HAVE_MOCK_CAMERA
diff --git a/src/uca-camera.c b/src/uca-camera.c
index 563f736..1e35dc7 100644
--- a/src/uca-camera.c
+++ b/src/uca-camera.c
@@ -50,6 +50,9 @@ static gchar *uca_camera_types[] = {
 #ifdef HAVE_MOCK_CAMERA
         "mock",
 #endif
+#ifdef HAVE_UFO_CAMERA
+        "ufo",
+#endif
         NULL 
 };
 
@@ -67,6 +70,7 @@ enum {
     PROP_SENSOR_VERTICAL_BINNING,
     PROP_SENSOR_VERTICAL_BINNINGS,
     PROP_SENSOR_MAX_FRAME_RATE,
+    PROP_EXPOSURE_TIME,
     PROP_ROI_X,
     PROP_ROI_Y,
     PROP_ROI_WIDTH,
@@ -225,6 +229,13 @@ static void uca_camera_class_init(UcaCameraClass *klass)
             1, G_MAXUINT, 1,
             G_PARAM_READABLE);
 
+    camera_properties[PROP_EXPOSURE_TIME] =
+        g_param_spec_double("exposure-time",
+            "Exposure time in seconds",
+            "Exposure time in seconds",
+            0.0, G_MAXDOUBLE, 1.0,
+            G_PARAM_READABLE);
+
     camera_properties[PROP_SENSOR_MAX_FRAME_RATE] = 
         g_param_spec_float("max-frame-rate",
             "Maximum frame rate",