gst/rtp/gstrtpspeexpay.c

   1 /* GStreamer
   2  * Copyright (C) <2005> Edgard Lima <edgard.lima@indt.org.br>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #ifdef HAVE_CONFIG_H
  21 #  include "config.h"
  22 #endif
  23
  24 #include <stdlib.h>
  25 #include <string.h>
  26 #include <gst/rtp/gstrtpbuffer.h>
  27
  28 #include "gstrtpspeexpay.h"
  29
  30 GST_DEBUG_CATEGORY_STATIC (rtpspeexpay_debug);
  31 #define GST_CAT_DEFAULT (rtpspeexpay_debug)
  32
  33 static GstStaticPadTemplate gst_rtp_speex_pay_sink_template =
  34 GST_STATIC_PAD_TEMPLATE ("sink",
  35     GST_PAD_SINK,
  36     GST_PAD_ALWAYS,
  37     GST_STATIC_CAPS ("audio/x-speex, "
  38         "rate = (int) [ 6000, 48000 ], " "channels = (int) 1")
  39     );
  40
  41 static GstStaticPadTemplate gst_rtp_speex_pay_src_template =
  42 GST_STATIC_PAD_TEMPLATE ("src",
  43     GST_PAD_SRC,
  44     GST_PAD_ALWAYS,
  45     GST_STATIC_CAPS ("application/x-rtp, "
  46         "media = (string) \"audio\", "
  47         "payload = (int) " GST_RTP_PAYLOAD_DYNAMIC_STRING ", "
  48         "clock-rate =  (int) [ 6000, 48000 ], "
  49         "encoding-name = (string) \"SPEEX\", "
  50         "encoding-params = (string) \"1\"")
  51     );
  52
  53 static GstStateChangeReturn gst_rtp_speex_pay_change_state (GstElement *
  54     element, GstStateChange transition);
  55
  56 static gboolean gst_rtp_speex_pay_setcaps (GstRTPBasePayload * payload,
  57     GstCaps * caps);
  58 static GstCaps *gst_rtp_speex_pay_getcaps (GstRTPBasePayload * payload,
  59     GstPad * pad, GstCaps * filter);
  60 static GstFlowReturn gst_rtp_speex_pay_handle_buffer (GstRTPBasePayload *
  61     payload, GstBuffer * buffer);
  62
  63 #define gst_rtp_speex_pay_parent_class parent_class
  64 G_DEFINE_TYPE (GstRtpSPEEXPay, gst_rtp_speex_pay, GST_TYPE_RTP_BASE_PAYLOAD);
  65
  66 static void
  67 gst_rtp_speex_pay_class_init (GstRtpSPEEXPayClass * klass)
  68 {
  69   GstElementClass *gstelement_class;
  70   GstRTPBasePayloadClass *gstrtpbasepayload_class;
  71
  72   gstelement_class = (GstElementClass *) klass;
  73   gstrtpbasepayload_class = (GstRTPBasePayloadClass *) klass;
  74
  75   gstelement_class->change_state = gst_rtp_speex_pay_change_state;
  76
  77   gstrtpbasepayload_class->set_caps = gst_rtp_speex_pay_setcaps;
  78   gstrtpbasepayload_class->get_caps = gst_rtp_speex_pay_getcaps;
  79   gstrtpbasepayload_class->handle_buffer = gst_rtp_speex_pay_handle_buffer;
  80
  81   gst_element_class_add_pad_template (gstelement_class,
  82       gst_static_pad_template_get (&gst_rtp_speex_pay_sink_template));
  83   gst_element_class_add_pad_template (gstelement_class,
  84       gst_static_pad_template_get (&gst_rtp_speex_pay_src_template));
  85   gst_element_class_set_details_simple (gstelement_class, "RTP Speex payloader",
  86       "Codec/Payloader/Network/RTP",
  87       "Payload-encodes Speex audio into a RTP packet",
  88       "Edgard Lima <edgard.lima@indt.org.br>");
  89
  90   GST_DEBUG_CATEGORY_INIT (rtpspeexpay_debug, "rtpspeexpay", 0,
  91       "Speex RTP Payloader");
  92 }
  93
  94 static void
  95 gst_rtp_speex_pay_init (GstRtpSPEEXPay * rtpspeexpay)
  96 {
  97   GST_RTP_BASE_PAYLOAD (rtpspeexpay)->clock_rate = 8000;
  98   GST_RTP_BASE_PAYLOAD_PT (rtpspeexpay) = 110;  /* Create String */
  99 }
 100
 101 static gboolean
 102 gst_rtp_speex_pay_setcaps (GstRTPBasePayload * payload, GstCaps * caps)
 103 {
 104   /* don't configure yet, we wait for the ident packet */
 105   return TRUE;
 106 }
 107
 108
 109 static GstCaps *
 110 gst_rtp_speex_pay_getcaps (GstRTPBasePayload * payload, GstPad * pad,
 111     GstCaps * filter)
 112 {
 113   GstCaps *otherpadcaps;
 114   GstCaps *caps;
 115
 116   otherpadcaps = gst_pad_get_allowed_caps (payload->srcpad);
 117   caps = gst_caps_copy (gst_pad_get_pad_template_caps (pad));
 118
 119   if (otherpadcaps) {
 120     if (!gst_caps_is_empty (otherpadcaps)) {
 121       GstStructure *ps = gst_caps_get_structure (otherpadcaps, 0);
 122       GstStructure *s = gst_caps_get_structure (caps, 0);
 123       gint clock_rate;
 124
 125       if (gst_structure_get_int (ps, "clock-rate", &clock_rate)) {
 126         gst_structure_fixate_field_nearest_int (s, "rate", clock_rate);
 127       }
 128     }
 129     gst_caps_unref (otherpadcaps);
 130   }
 131
 132   if (filter) {
 133     GstCaps *tcaps = caps;
 134
 135     caps = gst_caps_intersect_full (filter, tcaps, GST_CAPS_INTERSECT_FIRST);
 136     gst_caps_unref (tcaps);
 137   }
 138
 139   return caps;
 140 }
 141
 142 static gboolean
 143 gst_rtp_speex_pay_parse_ident (GstRtpSPEEXPay * rtpspeexpay,
 144     const guint8 * data, guint size)
 145 {
 146   guint32 version, header_size, rate, mode, nb_channels;
 147   GstRTPBasePayload *payload;
 148   gchar *cstr;
 149   gboolean res;
 150
 151   /* we need the header string (8), the version string (20), the version
 152    * and the header length. */
 153   if (size < 36)
 154     goto too_small;
 155
 156   if (!g_str_has_prefix ((const gchar *) data, "Speex   "))
 157     goto wrong_header;
 158
 159   /* skip header and version string */
 160   data += 28;
 161
 162   version = GST_READ_UINT32_LE (data);
 163   if (version != 1)
 164     goto wrong_version;
 165
 166   data += 4;
 167   /* ensure sizes */
 168   header_size = GST_READ_UINT32_LE (data);
 169   if (header_size < 80)
 170     goto header_too_small;
 171
 172   if (size < header_size)
 173     goto payload_too_small;
 174
 175   data += 4;
 176   rate = GST_READ_UINT32_LE (data);
 177   data += 4;
 178   mode = GST_READ_UINT32_LE (data);
 179   data += 8;
 180   nb_channels = GST_READ_UINT32_LE (data);
 181
 182   GST_DEBUG_OBJECT (rtpspeexpay, "rate %d, mode %d, nb_channels %d",
 183       rate, mode, nb_channels);
 184
 185   payload = GST_RTP_BASE_PAYLOAD (rtpspeexpay);
 186
 187   gst_rtp_base_payload_set_options (payload, "audio", FALSE, "SPEEX", rate);
 188   cstr = g_strdup_printf ("%d", nb_channels);
 189   res = gst_rtp_base_payload_set_outcaps (payload, "encoding-params",
 190       G_TYPE_STRING, cstr, NULL);
 191   g_free (cstr);
 192
 193   return res;
 194
 195   /* ERRORS */
 196 too_small:
 197   {
 198     GST_DEBUG_OBJECT (rtpspeexpay,
 199         "ident packet too small, need at least 32 bytes");
 200     return FALSE;
 201   }
 202 wrong_header:
 203   {
 204     GST_DEBUG_OBJECT (rtpspeexpay,
 205         "ident packet does not start with \"Speex   \"");
 206     return FALSE;
 207   }
 208 wrong_version:
 209   {
 210     GST_DEBUG_OBJECT (rtpspeexpay, "can only handle version 1, have version %d",
 211         version);
 212     return FALSE;
 213   }
 214 header_too_small:
 215   {
 216     GST_DEBUG_OBJECT (rtpspeexpay,
 217         "header size too small, need at least 80 bytes, " "got only %d",
 218         header_size);
 219     return FALSE;
 220   }
 221 payload_too_small:
 222   {
 223     GST_DEBUG_OBJECT (rtpspeexpay,
 224         "payload too small, need at least %d bytes, got only %d", header_size,
 225         size);
 226     return FALSE;
 227   }
 228 }
 229
 230 static GstFlowReturn
 231 gst_rtp_speex_pay_handle_buffer (GstRTPBasePayload * basepayload,
 232     GstBuffer * buffer)
 233 {
 234   GstRtpSPEEXPay *rtpspeexpay;
 235   guint payload_len;
 236   gsize size;
 237   GstBuffer *outbuf;
 238   guint8 *payload, *data;
 239   GstClockTime timestamp, duration;
 240   GstFlowReturn ret;
 241   GstRTPBuffer rtp;
 242
 243   rtpspeexpay = GST_RTP_SPEEX_PAY (basepayload);
 244
 245   data = gst_buffer_map (buffer, &size, NULL, GST_MAP_READ);
 246
 247   switch (rtpspeexpay->packet) {
 248     case 0:
 249       /* ident packet. We need to parse the headers to construct the RTP
 250        * properties. */
 251       if (!gst_rtp_speex_pay_parse_ident (rtpspeexpay, data, size))
 252         goto parse_error;
 253
 254       ret = GST_FLOW_OK;
 255       goto done;
 256     case 1:
 257       /* comment packet, we ignore it */
 258       ret = GST_FLOW_OK;
 259       goto done;
 260     default:
 261       /* other packets go in the payload */
 262       break;
 263   }
 264
 265   if (GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_FLAG_GAP)) {
 266     ret = GST_FLOW_OK;
 267     goto done;
 268   }
 269
 270   timestamp = GST_BUFFER_TIMESTAMP (buffer);
 271   duration = GST_BUFFER_DURATION (buffer);
 272
 273   /* FIXME, only one SPEEX frame per RTP packet for now */
 274   payload_len = size;
 275
 276   outbuf = gst_rtp_buffer_new_allocate (payload_len, 0, 0);
 277   /* FIXME, assert for now */
 278   g_assert (payload_len <= GST_RTP_BASE_PAYLOAD_MTU (rtpspeexpay));
 279
 280   /* copy timestamp and duration */
 281   GST_BUFFER_TIMESTAMP (outbuf) = timestamp;
 282   GST_BUFFER_DURATION (outbuf) = duration;
 283
 284   gst_rtp_buffer_map (outbuf, GST_MAP_WRITE, &rtp);
 285   /* get payload */
 286   payload = gst_rtp_buffer_get_payload (&rtp);
 287
 288   /* copy data in payload */
 289   memcpy (&payload[0], data, size);
 290
 291   gst_rtp_buffer_unmap (&rtp);
 292
 293   ret = gst_rtp_base_payload_push (basepayload, outbuf);
 294
 295 done:
 296   gst_buffer_unmap (buffer, data, -1);
 297   gst_buffer_unref (buffer);
 298
 299   rtpspeexpay->packet++;
 300
 301   return ret;
 302
 303   /* ERRORS */
 304 parse_error:
 305   {
 306     GST_ELEMENT_ERROR (rtpspeexpay, STREAM, DECODE, (NULL),
 307         ("Error parsing first identification packet."));
 308     gst_buffer_unmap (buffer, data, -1);
 309     gst_buffer_unref (buffer);
 310     return GST_FLOW_ERROR;
 311   }
 312 }
 313
 314 static GstStateChangeReturn
 315 gst_rtp_speex_pay_change_state (GstElement * element, GstStateChange transition)
 316 {
 317   GstRtpSPEEXPay *rtpspeexpay;
 318   GstStateChangeReturn ret;
 319
 320   rtpspeexpay = GST_RTP_SPEEX_PAY (element);
 321
 322   switch (transition) {
 323     case GST_STATE_CHANGE_NULL_TO_READY:
 324       break;
 325     case GST_STATE_CHANGE_READY_TO_PAUSED:
 326       rtpspeexpay->packet = 0;
 327       break;
 328     default:
 329       break;
 330   }
 331
 332   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 333
 334   switch (transition) {
 335     case GST_STATE_CHANGE_READY_TO_NULL:
 336       break;
 337     default:
 338       break;
 339   }
 340   return ret;
 341 }
 342
 343 gboolean
 344 gst_rtp_speex_pay_plugin_init (GstPlugin * plugin)
 345 {
 346   return gst_element_register (plugin, "rtpspeexpay",
 347       GST_RANK_SECONDARY, GST_TYPE_RTP_SPEEX_PAY);
 348 }