Rename all occurrences of "fbdev" into "am7xxx"
[gst-am7xxxsink.git] / src / gstam7xxxsink.c
diff --git a/src/gstam7xxxsink.c b/src/gstam7xxxsink.c
new file mode 100644 (file)
index 0000000..cd25d21
--- /dev/null
@@ -0,0 +1,453 @@
+/* GStreamer am7xxx plugin
+ * Copyright (C) 2007 Sean D'Epagnier <sean@depagnier.com>
+ *
+ * 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.
+ */
+
+/* currently the driver does not switch modes, instead uses current mode.
+   the video is centered and cropped if needed to fit onscreen.
+   Whatever bitdepth is set is used, and tested to work for 16, 24, 32 bits
+*/
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include <signal.h>
+#include <string.h>
+#include <sys/time.h>
+#include <stdlib.h>
+
+#include <fcntl.h>
+#include <sys/ioctl.h>
+#include <sys/mman.h>
+#include <unistd.h>
+#include <stdint.h>
+
+#include "gstam7xxxsink.h"
+
+enum
+{
+  ARG_0,
+  ARG_DEVICE
+};
+
+#if 0
+static void gst_am7xxxsink_get_times (GstBaseSink * basesink,
+    GstBuffer * buffer, GstClockTime * start, GstClockTime * end);
+#endif
+
+static GstFlowReturn gst_am7xxxsink_show_frame (GstVideoSink * videosink,
+    GstBuffer * buff);
+
+static gboolean gst_am7xxxsink_start (GstBaseSink * bsink);
+static gboolean gst_am7xxxsink_stop (GstBaseSink * bsink);
+
+static GstCaps *gst_am7xxxsink_getcaps (GstBaseSink * bsink, GstCaps * filter);
+static gboolean gst_am7xxxsink_setcaps (GstBaseSink * bsink, GstCaps * caps);
+
+static void gst_am7xxxsink_finalize (GObject * object);
+static void gst_am7xxxsink_set_property (GObject * object,
+    guint prop_id, const GValue * value, GParamSpec * pspec);
+static void gst_am7xxxsink_get_property (GObject * object,
+    guint prop_id, GValue * value, GParamSpec * pspec);
+static GstStateChangeReturn gst_am7xxxsink_change_state (GstElement * element,
+    GstStateChange transition);
+
+#define VIDEO_CAPS "{ RGB, BGR, BGRx, xBGR, RGB, RGBx, xRGB, RGB15, RGB16 }"
+
+static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
+    GST_PAD_SINK,
+    GST_PAD_ALWAYS,
+    GST_STATIC_CAPS (GST_VIDEO_CAPS_MAKE (VIDEO_CAPS))
+    );
+
+#define parent_class gst_am7xxxsink_parent_class
+G_DEFINE_TYPE (GstAM7XXXSink, gst_am7xxxsink, GST_TYPE_VIDEO_SINK);
+
+static void
+gst_am7xxxsink_init (GstAM7XXXSink * am7xxxsink)
+{
+  /* nothing to do here yet */
+}
+
+#if 0
+static void
+gst_am7xxxsink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
+    GstClockTime * start, GstClockTime * end)
+{
+  GstAM7XXXSink *am7xxxsink;
+
+  am7xxxsink = GST_AM7XXXSINK (basesink);
+
+  if (GST_BUFFER_TIMESTAMP_IS_VALID (buffer)) {
+    *start = GST_BUFFER_TIMESTAMP (buffer);
+    if (GST_BUFFER_DURATION_IS_VALID (buffer)) {
+      *end = *start + GST_BUFFER_DURATION (buffer);
+    } else {
+      if (am7xxxsink->fps_n > 0) {
+        *end = *start +
+            gst_util_uint64_scale_int (GST_SECOND, am7xxxsink->fps_d,
+            am7xxxsink->fps_n);
+      }
+    }
+  }
+}
+#endif
+
+static GstCaps *
+gst_am7xxxsink_getcaps (GstBaseSink * bsink, GstCaps * filter)
+{
+  GstAM7XXXSink *am7xxxsink;
+  GstVideoFormat format;
+  GstCaps *caps;
+  uint32_t rmask;
+  uint32_t gmask;
+  uint32_t bmask;
+  uint32_t tmask;
+  int endianness, depth, bpp;
+
+  am7xxxsink = GST_AM7XXXSINK (bsink);
+
+  caps = gst_static_pad_template_get_caps (&sink_template);
+
+  /* FIXME: locking */
+  if (!am7xxxsink->framebuffer)
+    goto done;
+
+  bpp = am7xxxsink->varinfo.bits_per_pixel;
+
+  rmask = ((1 << am7xxxsink->varinfo.red.length) - 1)
+      << am7xxxsink->varinfo.red.offset;
+  gmask = ((1 << am7xxxsink->varinfo.green.length) - 1)
+      << am7xxxsink->varinfo.green.offset;
+  bmask = ((1 << am7xxxsink->varinfo.blue.length) - 1)
+      << am7xxxsink->varinfo.blue.offset;
+  tmask = ((1 << am7xxxsink->varinfo.transp.length) - 1)
+      << am7xxxsink->varinfo.transp.offset;
+
+  depth = am7xxxsink->varinfo.red.length + am7xxxsink->varinfo.green.length
+      + am7xxxsink->varinfo.blue.length;
+
+  switch (am7xxxsink->varinfo.bits_per_pixel) {
+    case 32:
+      /* swap endianness of masks */
+      rmask = GUINT32_SWAP_LE_BE (rmask);
+      gmask = GUINT32_SWAP_LE_BE (gmask);
+      bmask = GUINT32_SWAP_LE_BE (bmask);
+      tmask = GUINT32_SWAP_LE_BE (tmask);
+      depth += am7xxxsink->varinfo.transp.length;
+      endianness = G_BIG_ENDIAN;
+      break;
+    case 24:{
+      /* swap red and blue masks */
+      tmask = rmask;
+      rmask = bmask;
+      bmask = tmask;
+      tmask = 0;
+      endianness = G_BIG_ENDIAN;
+      break;
+    }
+    case 15:
+    case 16:
+      tmask = 0;
+      endianness = G_LITTLE_ENDIAN;
+      break;
+    default:
+      goto unsupported_bpp;
+  }
+
+  format = gst_video_format_from_masks (depth, bpp, endianness, rmask, gmask,
+      bmask, tmask);
+
+  if (format == GST_VIDEO_FORMAT_UNKNOWN)
+    goto unknown_format;
+
+  caps = gst_caps_make_writable (caps);
+  gst_caps_set_simple (caps, "format", G_TYPE_STRING,
+      gst_video_format_to_string (format), NULL);
+
+done:
+
+  if (filter != NULL) {
+    GstCaps *icaps;
+
+    icaps = gst_caps_intersect (caps, filter);
+    gst_caps_unref (caps);
+    caps = icaps;
+  }
+
+  return caps;
+
+/* ERRORS */
+unsupported_bpp:
+  {
+    GST_WARNING_OBJECT (bsink, "unsupported bit depth: %d", bpp);
+    return NULL;
+  }
+unknown_format:
+  {
+    GST_WARNING_OBJECT (bsink, "could not map am7xxx format to GstVideoFormat: "
+        "depth=%u, bpp=%u, endianness=%u, rmask=0x%08x, gmask=0x%08x, "
+        "bmask=0x%08x, tmask=0x%08x", depth, bpp, endianness, rmask, gmask,
+        bmask, tmask);
+    return NULL;
+  }
+}
+
+static gboolean
+gst_am7xxxsink_setcaps (GstBaseSink * bsink, GstCaps * vscapslist)
+{
+  GstAM7XXXSink *am7xxxsink;
+  GstStructure *structure;
+  const GValue *fps;
+
+  am7xxxsink = GST_AM7XXXSINK (bsink);
+
+  structure = gst_caps_get_structure (vscapslist, 0);
+
+  fps = gst_structure_get_value (structure, "framerate");
+  am7xxxsink->fps_n = gst_value_get_fraction_numerator (fps);
+  am7xxxsink->fps_d = gst_value_get_fraction_denominator (fps);
+
+  gst_structure_get_int (structure, "width", &am7xxxsink->width);
+  gst_structure_get_int (structure, "height", &am7xxxsink->height);
+
+  /* calculate centering and scanlengths for the video */
+  am7xxxsink->bytespp = am7xxxsink->fixinfo.line_length / am7xxxsink->varinfo.xres;
+
+  am7xxxsink->cx = ((int) am7xxxsink->varinfo.xres - am7xxxsink->width) / 2;
+  if (am7xxxsink->cx < 0)
+    am7xxxsink->cx = 0;
+
+  am7xxxsink->cy = ((int) am7xxxsink->varinfo.yres - am7xxxsink->height) / 2;
+  if (am7xxxsink->cy < 0)
+    am7xxxsink->cy = 0;
+
+  am7xxxsink->linelen = am7xxxsink->width * am7xxxsink->bytespp;
+  if (am7xxxsink->linelen > am7xxxsink->fixinfo.line_length)
+    am7xxxsink->linelen = am7xxxsink->fixinfo.line_length;
+
+  am7xxxsink->lines = am7xxxsink->height;
+  if (am7xxxsink->lines > am7xxxsink->varinfo.yres)
+    am7xxxsink->lines = am7xxxsink->varinfo.yres;
+
+  return TRUE;
+}
+
+
+static GstFlowReturn
+gst_am7xxxsink_show_frame (GstVideoSink * videosink, GstBuffer * buf)
+{
+
+  GstAM7XXXSink *am7xxxsink;
+  GstMapInfo map;
+  int i;
+
+  am7xxxsink = GST_AM7XXXSINK (videosink);
+
+  /* optimization could remove this memcpy by allocating the buffer
+     in framebuffer memory, but would only work when xres matches
+     the video width */
+  if (!gst_buffer_map (buf, &map, GST_MAP_READ))
+    return GST_FLOW_ERROR;
+
+  for (i = 0; i < am7xxxsink->lines; i++) {
+    memcpy (am7xxxsink->framebuffer
+        + (i + am7xxxsink->cy) * am7xxxsink->fixinfo.line_length
+        + am7xxxsink->cx * am7xxxsink->bytespp,
+        map.data + i * am7xxxsink->width * am7xxxsink->bytespp,
+        am7xxxsink->linelen);
+  }
+
+  gst_buffer_unmap (buf, &map);
+
+  return GST_FLOW_OK;
+}
+
+static gboolean
+gst_am7xxxsink_start (GstBaseSink * bsink)
+{
+  GstAM7XXXSink *am7xxxsink;
+
+  am7xxxsink = GST_AM7XXXSINK (bsink);
+
+  if (!am7xxxsink->device) {
+    am7xxxsink->device = g_strdup ("/dev/fb0");
+  }
+
+  am7xxxsink->fd = open (am7xxxsink->device, O_RDWR);
+
+  if (am7xxxsink->fd == -1)
+    return FALSE;
+
+  /* get the fixed screen info */
+  if (ioctl (am7xxxsink->fd, FBIOGET_FSCREENINFO, &am7xxxsink->fixinfo))
+    return FALSE;
+
+  /* get the variable screen info */
+  if (ioctl (am7xxxsink->fd, FBIOGET_VSCREENINFO, &am7xxxsink->varinfo))
+    return FALSE;
+
+  /* map the framebuffer */
+  am7xxxsink->framebuffer = mmap (0, am7xxxsink->fixinfo.smem_len,
+      PROT_WRITE, MAP_SHARED, am7xxxsink->fd, 0);
+  if (am7xxxsink->framebuffer == MAP_FAILED)
+    return FALSE;
+
+  return TRUE;
+}
+
+static gboolean
+gst_am7xxxsink_stop (GstBaseSink * bsink)
+{
+  GstAM7XXXSink *am7xxxsink;
+
+  am7xxxsink = GST_AM7XXXSINK (bsink);
+
+  if (munmap (am7xxxsink->framebuffer, am7xxxsink->fixinfo.smem_len))
+    return FALSE;
+
+  if (close (am7xxxsink->fd))
+    return FALSE;
+
+
+  return TRUE;
+}
+
+static void
+gst_am7xxxsink_set_property (GObject * object, guint prop_id,
+    const GValue * value, GParamSpec * pspec)
+{
+  GstAM7XXXSink *am7xxxsink;
+
+  am7xxxsink = GST_AM7XXXSINK (object);
+
+  switch (prop_id) {
+    case ARG_DEVICE:{
+      g_free (am7xxxsink->device);
+      am7xxxsink->device = g_value_dup_string (value);
+      break;
+    }
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+      break;
+  }
+}
+
+
+static void
+gst_am7xxxsink_get_property (GObject * object, guint prop_id, GValue * value,
+    GParamSpec * pspec)
+{
+  GstAM7XXXSink *am7xxxsink;
+
+  am7xxxsink = GST_AM7XXXSINK (object);
+
+  switch (prop_id) {
+    case ARG_DEVICE:{
+      g_value_set_string (value, am7xxxsink->device);
+      break;
+    }
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+      break;
+  }
+}
+
+static GstStateChangeReturn
+gst_am7xxxsink_change_state (GstElement * element, GstStateChange transition)
+{
+  GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
+
+  g_return_val_if_fail (GST_IS_AM7XXXSINK (element), GST_STATE_CHANGE_FAILURE);
+
+  ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
+
+  switch (transition) {
+    default:
+      break;
+  }
+  return ret;
+}
+
+static gboolean
+plugin_init (GstPlugin * plugin)
+{
+  if (!gst_element_register (plugin, "am7xxxsink", GST_RANK_NONE,
+          GST_TYPE_AM7XXXSINK))
+    return FALSE;
+
+  return TRUE;
+}
+
+static void
+gst_am7xxxsink_class_init (GstAM7XXXSinkClass * klass)
+{
+  GObjectClass *gobject_class;
+  GstElementClass *gstelement_class;
+  GstBaseSinkClass *basesink_class;
+  GstVideoSinkClass *videosink_class;
+
+  gobject_class = (GObjectClass *) klass;
+  gstelement_class = (GstElementClass *) klass;
+  basesink_class = (GstBaseSinkClass *) klass;
+  videosink_class = (GstVideoSinkClass *) klass;
+
+  gobject_class->set_property = gst_am7xxxsink_set_property;
+  gobject_class->get_property = gst_am7xxxsink_get_property;
+  gobject_class->finalize = gst_am7xxxsink_finalize;
+
+  gstelement_class->change_state =
+      GST_DEBUG_FUNCPTR (gst_am7xxxsink_change_state);
+
+  g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_DEVICE,
+      g_param_spec_string ("device", "device",
+          "The framebuffer device eg: /dev/fb0", NULL, G_PARAM_READWRITE));
+
+  basesink_class->set_caps = GST_DEBUG_FUNCPTR (gst_am7xxxsink_setcaps);
+  basesink_class->get_caps = GST_DEBUG_FUNCPTR (gst_am7xxxsink_getcaps);
+#if 0
+  basesink_class->get_times = GST_DEBUG_FUNCPTR (gst_am7xxxsink_get_times);
+#endif
+  basesink_class->start = GST_DEBUG_FUNCPTR (gst_am7xxxsink_start);
+  basesink_class->stop = GST_DEBUG_FUNCPTR (gst_am7xxxsink_stop);
+
+  videosink_class->show_frame = GST_DEBUG_FUNCPTR (gst_am7xxxsink_show_frame);
+
+  gst_element_class_set_static_metadata (gstelement_class, "am7xxx video sink",
+      "Sink/Video", "Linux framebuffer videosink",
+      "Sean D'Epagnier <sean@depagnier.com>");
+
+  gst_element_class_add_pad_template (gstelement_class,
+      gst_static_pad_template_get (&sink_template));
+}
+
+static void
+gst_am7xxxsink_finalize (GObject * object)
+{
+  GstAM7XXXSink *am7xxxsink = GST_AM7XXXSINK (object);
+
+  g_free (am7xxxsink->device);
+
+  G_OBJECT_CLASS (parent_class)->finalize (object);
+}
+
+GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
+    GST_VERSION_MINOR,
+    am7xxxsink,
+    "Linux framebuffer video sink",
+    plugin_init, VERSION, "LGPL", "gst-am7xxxsink", "http://ao2.it")