ext/cairo/gstcairorender.c

   1 /* GStreamer
   2  *
   3  * Copyright (C) 2006-2009 Lutz Mueller <lutz@topfrose.de>
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Library General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Library General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Library General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20
  21 /**
  22  * SECTION:element-cairorender
  23  *
  24  * cairorender encodes a video stream into PDF, SVG, PNG or Postscript
  25  *
  26  * <refsect2>
  27  * <title>Example launch line</title>
  28  * |[
  29  * gst-launch videotestsrc num-buffers=3 ! cairorender ! "application/pdf" ! filesink location=test.pdf
  30  * ]|
  31  * </refsect2>
  32  */
  33
  34 #include "gstcairorender.h"
  35
  36 #include <cairo.h>
  37 #include <cairo-features.h>
  38 #ifdef CAIRO_HAS_PS_SURFACE
  39 #include <cairo-ps.h>
  40 #endif
  41 #ifdef CAIRO_HAS_PDF_SURFACE
  42 #include <cairo-pdf.h>
  43 #endif
  44 #ifdef CAIRO_HAS_SVG_SURFACE
  45 #include <cairo-svg.h>
  46 #endif
  47
  48 #include <gst/video/video.h>
  49
  50 #include <string.h>
  51
  52 GST_DEBUG_CATEGORY_STATIC (cairo_render_debug);
  53 #define GST_CAT_DEFAULT cairo_render_debug
  54
  55 static gboolean
  56 gst_cairo_render_event (GstPad * pad, GstEvent * e)
  57 {
  58   GstCairoRender *c = GST_CAIRO_RENDER (GST_PAD_PARENT (pad));
  59
  60   switch (GST_EVENT_TYPE (e)) {
  61     case GST_EVENT_EOS:
  62       if (c->surface)
  63         cairo_surface_finish (c->surface);
  64       break;
  65     default:
  66       break;
  67   }
  68   return gst_pad_event_default (pad, e);
  69 }
  70
  71 static cairo_status_t
  72 write_func (void *closure, const unsigned char *data, unsigned int length)
  73 {
  74   GstCairoRender *c = GST_CAIRO_RENDER (closure);
  75   GstBuffer *buf;
  76   GstFlowReturn r;
  77
  78   buf = gst_buffer_new ();
  79   gst_buffer_set_data (buf, (guint8 *) data, length);
  80   gst_buffer_set_caps (buf, GST_PAD_CAPS (c->src));
  81   if ((r = gst_pad_push (c->src, buf)) != GST_FLOW_OK) {
  82     GST_DEBUG_OBJECT (c, "Could not pass on buffer: %s.",
  83         gst_flow_get_name (r));
  84     return CAIRO_STATUS_WRITE_ERROR;
  85   }
  86   return CAIRO_STATUS_SUCCESS;
  87 }
  88
  89 static cairo_status_t
  90 read_buffer (void *closure, unsigned char *data, unsigned int length)
  91 {
  92   GstBuffer *buf = GST_BUFFER (closure);
  93
  94   if (GST_BUFFER_OFFSET (buf) + length > GST_BUFFER_SIZE (buf))
  95     return CAIRO_STATUS_READ_ERROR;
  96   memcpy (data, GST_BUFFER_DATA (buf) + GST_BUFFER_OFFSET (buf), length);
  97   GST_BUFFER_OFFSET (buf) += length;
  98   return CAIRO_STATUS_SUCCESS;
  99 }
 100
 101 static gboolean
 102 gst_cairo_render_push_surface (GstCairoRender * c, cairo_surface_t * surface)
 103 {
 104   cairo_status_t s = 0;
 105   cairo_t *cr;
 106
 107   if (!c->surface) {
 108     s = cairo_surface_write_to_png_stream (surface, write_func, c);
 109     cairo_surface_destroy (surface);
 110     if (s != CAIRO_STATUS_SUCCESS) {
 111       GST_DEBUG_OBJECT (c, "Could not create PNG stream: %s.",
 112           cairo_status_to_string (s));
 113       return FALSE;
 114     }
 115     return TRUE;
 116   }
 117
 118   cr = cairo_create (c->surface);
 119   cairo_set_source_surface (cr, surface, 0, 0);
 120   cairo_paint (cr);
 121   cairo_show_page (cr);
 122   cairo_destroy (cr);
 123   cairo_surface_destroy (surface);
 124   return (TRUE);
 125 }
 126
 127 static GstFlowReturn
 128 gst_cairo_render_chain (GstPad * pad, GstBuffer * buf)
 129 {
 130   GstCairoRender *c = GST_CAIRO_RENDER (GST_PAD_PARENT (pad));
 131   cairo_surface_t *s;
 132   gboolean success;
 133
 134   if (G_UNLIKELY (c->width <= 0 || c->height <= 0 || c->stride <= 0))
 135     return GST_FLOW_NOT_NEGOTIATED;
 136
 137   if (c->png) {
 138     GST_BUFFER_OFFSET (buf) = 0;
 139     s = cairo_image_surface_create_from_png_stream (read_buffer, buf);
 140   } else
 141     s = cairo_image_surface_create_for_data (GST_BUFFER_DATA (buf),
 142         c->format, c->width, c->height, c->stride);
 143   success = gst_cairo_render_push_surface (c, s);
 144   gst_buffer_unref (buf);
 145   return success ? GST_FLOW_OK : GST_FLOW_ERROR;
 146 }
 147
 148 static gboolean
 149 gst_cairo_render_setcaps_sink (GstPad * pad, GstCaps * caps)
 150 {
 151   GstCairoRender *c = GST_CAIRO_RENDER (GST_PAD_PARENT (pad));
 152   GstStructure *s = gst_caps_get_structure (caps, 0);
 153   const gchar *mime = gst_structure_get_name (s);
 154   gint fps_n = 0, fps_d = 1;
 155   gint w, h;
 156
 157   GST_DEBUG_OBJECT (c, "Got caps (%s).", mime);
 158   if ((c->png = !strcmp (mime, "image/png")))
 159     return TRUE;
 160
 161   /* Width and height */
 162   if (!gst_structure_get_int (s, "width", &c->width) ||
 163       !gst_structure_get_int (s, "height", &c->height)) {
 164     GST_ERROR_OBJECT (c, "Invalid caps");
 165     return FALSE;
 166   }
 167
 168   /* Colorspace */
 169   if (!strcmp (mime, "video/x-raw-yuv") || !strcmp (mime, "video/x-raw-grey")) {
 170     c->format = CAIRO_FORMAT_A8;
 171     c->stride = GST_ROUND_UP_4 (c->width);
 172   } else if (!strcmp (mime, "video/x-raw-rgb")) {
 173     c->format = CAIRO_FORMAT_RGB24;
 174     c->stride = 4 * c->width;
 175   } else {
 176     GST_DEBUG_OBJECT (c, "Unknown mime type '%s'.", mime);
 177     return FALSE;
 178   }
 179
 180   /* Framerate */
 181   gst_structure_get_fraction (s, "framerate", &fps_n, &fps_d);
 182
 183   /* Create output caps */
 184   caps = gst_pad_get_allowed_caps (c->src);
 185   caps = gst_caps_make_writable (caps);
 186   gst_caps_truncate (caps);
 187   s = gst_caps_get_structure (caps, 0);
 188   mime = gst_structure_get_name (s);
 189   gst_structure_set (s, "height", G_TYPE_INT, c->height, "width", G_TYPE_INT,
 190       c->width, "framerate", GST_TYPE_FRACTION, fps_n, fps_d, NULL);
 191
 192   if (c->surface) {
 193     cairo_surface_destroy (c->surface);
 194     c->surface = NULL;
 195   }
 196
 197   w = c->width;
 198   h = c->height;
 199
 200   GST_DEBUG_OBJECT (c, "Setting src caps %" GST_PTR_FORMAT, caps);
 201   gst_pad_set_caps (c->src, caps);
 202
 203 #if CAIRO_HAS_PS_SURFACE
 204   if (!strcmp (mime, "application/postscript")) {
 205     c->surface = cairo_ps_surface_create_for_stream (write_func, c, w, h);
 206   } else
 207 #endif
 208 #if CAIRO_HAS_PDF_SURFACE
 209   if (!strcmp (mime, "application/pdf")) {
 210     c->surface = cairo_pdf_surface_create_for_stream (write_func, c, w, h);
 211   } else
 212 #endif
 213 #if CAIRO_HAS_SVG_SURFACE
 214   if (!strcmp (mime, "image/svg+xml")) {
 215     c->surface = cairo_svg_surface_create_for_stream (write_func, c, w, h);
 216   } else
 217 #endif
 218   {
 219     gst_caps_unref (caps);
 220     return FALSE;
 221   }
 222
 223   gst_caps_unref (caps);
 224
 225   return TRUE;
 226 }
 227
 228 static GstStaticPadTemplate t_src = GST_STATIC_PAD_TEMPLATE ("src",
 229     GST_PAD_SRC, GST_PAD_ALWAYS, GST_STATIC_CAPS (
 230 #if CAIRO_HAS_PDF_SURFACE
 231         "application/pdf, "
 232         "width = (int) [ 1, MAX], " "height = (int) [ 1, MAX] "
 233 #endif
 234 #if CAIRO_HAS_PDF_SURFACE && (CAIRO_HAS_PS_SURFACE || CAIRO_HAS_SVG_SURFACE || CAIRO_HAS_PNG_FUNCTIONS)
 235         ";"
 236 #endif
 237 #if CAIRO_HAS_PS_SURFACE
 238         "application/postscript, "
 239         "width = (int) [ 1, MAX], " "height = (int) [ 1, MAX] "
 240 #endif
 241 #if (CAIRO_HAS_PDF_SURFACE || CAIRO_HAS_PS_SURFACE) && (CAIRO_HAS_SVG_SURFACE || CAIRO_HAS_PNG_FUNCTIONS)
 242         ";"
 243 #endif
 244 #if CAIRO_HAS_SVG_SURFACE
 245         "image/svg+xml, "
 246         "width = (int) [ 1, MAX], " "height = (int) [ 1, MAX] "
 247 #endif
 248 #if (CAIRO_HAS_PDF_SURFACE || CAIRO_HAS_PS_SURFACE || CAIRO_HAS_SVG_SURFACE) && CAIRO_HAS_PNG_FUNCTIONS
 249         ";"
 250 #endif
 251 #if CAIRO_HAS_PNG_FUNCTIONS
 252         "image/png, " "width = (int) [ 1, MAX], " "height = (int) [ 1, MAX] "
 253 #endif
 254     ));
 255 static GstStaticPadTemplate t_snk = GST_STATIC_PAD_TEMPLATE ("sink",
 256     GST_PAD_SINK, GST_PAD_ALWAYS, GST_STATIC_CAPS (
 257 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
 258         GST_VIDEO_CAPS_BGRx " ; "
 259 #else
 260         GST_VIDEO_CAPS_xRGB " ; "
 261 #endif
 262         GST_VIDEO_CAPS_YUV ("Y800") " ; "
 263         "video/x-raw-gray, "
 264         "bpp = 8, "
 265         "depth = 8, "
 266         "width = " GST_VIDEO_SIZE_RANGE ", "
 267         "height = " GST_VIDEO_SIZE_RANGE ", " "framerate = " GST_VIDEO_FPS_RANGE
 268         " ; "
 269 #if CAIRO_HAS_PNG_FUNCTIONS
 270         "image/png, "
 271         "width = " GST_VIDEO_SIZE_RANGE ", " "height = " GST_VIDEO_SIZE_RANGE
 272 #endif
 273     ));
 274
 275 GST_BOILERPLATE (GstCairoRender, gst_cairo_render, GstElement,
 276     GST_TYPE_ELEMENT);
 277
 278 static void
 279 gst_cairo_render_init (GstCairoRender * c, GstCairoRenderClass * klass)
 280 {
 281   /* The sink */
 282   c->snk =
 283       gst_pad_new_from_template (gst_static_pad_template_get (&t_snk), "sink");
 284   gst_pad_set_event_function (c->snk, gst_cairo_render_event);
 285   gst_pad_set_chain_function (c->snk, gst_cairo_render_chain);
 286   gst_pad_set_setcaps_function (c->snk, gst_cairo_render_setcaps_sink);
 287   gst_pad_use_fixed_caps (c->snk);
 288   gst_element_add_pad (GST_ELEMENT (c), c->snk);
 289
 290   /* The source */
 291   c->src =
 292       gst_pad_new_from_template (gst_static_pad_template_get (&t_src), "src");
 293   gst_pad_use_fixed_caps (c->src);
 294   gst_element_add_pad (GST_ELEMENT (c), c->src);
 295
 296   c->width = 0;
 297   c->height = 0;
 298   c->stride = 0;
 299 }
 300
 301 static void
 302 gst_cairo_render_base_init (gpointer g_class)
 303 {
 304   GstElementClass *ec = GST_ELEMENT_CLASS (g_class);
 305
 306   gst_element_class_set_details_simple (ec, "Cairo encoder",
 307       "Codec/Encoder", "Encodes streams using Cairo",
 308       "Lutz Mueller <lutz@topfrose.de>");
 309   gst_element_class_add_pad_template (ec, gst_static_pad_template_get (&t_snk));
 310   gst_element_class_add_pad_template (ec, gst_static_pad_template_get (&t_src));
 311 }
 312
 313 static void
 314 gst_cairo_render_finalize (GObject * object)
 315 {
 316   GstCairoRender *c = GST_CAIRO_RENDER (object);
 317
 318   if (c->surface) {
 319     cairo_surface_destroy (c->surface);
 320     c->surface = NULL;
 321   }
 322
 323   G_OBJECT_CLASS (parent_class)->finalize (object);
 324 }
 325
 326 static void
 327 gst_cairo_render_class_init (GstCairoRenderClass * klass)
 328 {
 329   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 330
 331   gobject_class->finalize = gst_cairo_render_finalize;
 332
 333   GST_DEBUG_CATEGORY_INIT (cairo_render_debug, "cairo_render", 0,
 334       "Cairo encoder");
 335 }