gstrtpceltpay.c 13.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
/* GStreamer
 * Copyright (C) <2009> Wim Taymans <wim.taymans@gmail.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., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#ifdef HAVE_CONFIG_H
#  include "config.h"
#endif

#include <stdlib.h>
#include <string.h>
#include <gst/rtp/gstrtpbuffer.h>

#include "gstrtpceltpay.h"

GST_DEBUG_CATEGORY_STATIC (rtpceltpay_debug);
#define GST_CAT_DEFAULT (rtpceltpay_debug)

static GstStaticPadTemplate gst_rtp_celt_pay_sink_template =
GST_STATIC_PAD_TEMPLATE ("sink",
    GST_PAD_SINK,
    GST_PAD_ALWAYS,
    GST_STATIC_CAPS ("audio/x-celt, "
38 39
        "rate = (int) [ 32000, 64000 ], "
        "channels = (int) [1, 2], " "frame-size = (int) [ 64, 512 ]")
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
    );

static GstStaticPadTemplate gst_rtp_celt_pay_src_template =
GST_STATIC_PAD_TEMPLATE ("src",
    GST_PAD_SRC,
    GST_PAD_ALWAYS,
    GST_STATIC_CAPS ("application/x-rtp, "
        "media = (string) \"audio\", "
        "payload = (int) " GST_RTP_PAYLOAD_DYNAMIC_STRING ", "
        "clock-rate =  (int) [ 32000, 48000 ], "
        "encoding-name = (string) \"CELT\"")
    );

static void gst_rtp_celt_pay_finalize (GObject * object);

static GstStateChangeReturn gst_rtp_celt_pay_change_state (GstElement *
    element, GstStateChange transition);

Wim Taymans's avatar
Wim Taymans committed
58
static gboolean gst_rtp_celt_pay_setcaps (GstRTPBasePayload * payload,
59
    GstCaps * caps);
Wim Taymans's avatar
Wim Taymans committed
60
static GstCaps *gst_rtp_celt_pay_getcaps (GstRTPBasePayload * payload,
61
    GstPad * pad, GstCaps * filter);
Wim Taymans's avatar
Wim Taymans committed
62
static GstFlowReturn gst_rtp_celt_pay_handle_buffer (GstRTPBasePayload *
63 64
    payload, GstBuffer * buffer);

65
#define gst_rtp_celt_pay_parent_class parent_class
Wim Taymans's avatar
Wim Taymans committed
66
G_DEFINE_TYPE (GstRtpCELTPay, gst_rtp_celt_pay, GST_TYPE_RTP_BASE_PAYLOAD);
67 68 69 70 71 72

static void
gst_rtp_celt_pay_class_init (GstRtpCELTPayClass * klass)
{
  GObjectClass *gobject_class;
  GstElementClass *gstelement_class;
Wim Taymans's avatar
Wim Taymans committed
73
  GstRTPBasePayloadClass *gstrtpbasepayload_class;
74

75 76 77
  GST_DEBUG_CATEGORY_INIT (rtpceltpay_debug, "rtpceltpay", 0,
      "CELT RTP Payloader");

78 79
  gobject_class = (GObjectClass *) klass;
  gstelement_class = (GstElementClass *) klass;
Wim Taymans's avatar
Wim Taymans committed
80
  gstrtpbasepayload_class = (GstRTPBasePayloadClass *) klass;
81 82 83 84 85

  gobject_class->finalize = gst_rtp_celt_pay_finalize;

  gstelement_class->change_state = gst_rtp_celt_pay_change_state;

86 87 88 89 90 91 92 93 94 95
  gst_element_class_add_pad_template (gstelement_class,
      gst_static_pad_template_get (&gst_rtp_celt_pay_sink_template));
  gst_element_class_add_pad_template (gstelement_class,
      gst_static_pad_template_get (&gst_rtp_celt_pay_src_template));

  gst_element_class_set_details_simple (gstelement_class, "RTP CELT payloader",
      "Codec/Payloader/Network/RTP",
      "Payload-encodes CELT audio into a RTP packet",
      "Wim Taymans <wim.taymans@gmail.com>");

Wim Taymans's avatar
Wim Taymans committed
96 97 98
  gstrtpbasepayload_class->set_caps = gst_rtp_celt_pay_setcaps;
  gstrtpbasepayload_class->get_caps = gst_rtp_celt_pay_getcaps;
  gstrtpbasepayload_class->handle_buffer = gst_rtp_celt_pay_handle_buffer;
99 100 101
}

static void
102
gst_rtp_celt_pay_init (GstRtpCELTPay * rtpceltpay)
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
{
  rtpceltpay->queue = g_queue_new ();
}

static void
gst_rtp_celt_pay_finalize (GObject * object)
{
  GstRtpCELTPay *rtpceltpay;

  rtpceltpay = GST_RTP_CELT_PAY (object);

  g_queue_free (rtpceltpay->queue);

  G_OBJECT_CLASS (parent_class)->finalize (object);
}

static void
gst_rtp_celt_pay_clear_queued (GstRtpCELTPay * rtpceltpay)
{
  GstBuffer *buf;

  while ((buf = g_queue_pop_head (rtpceltpay->queue)))
    gst_buffer_unref (buf);

  rtpceltpay->bytes = 0;
  rtpceltpay->sbytes = 0;
  rtpceltpay->qduration = 0;
}

static void
gst_rtp_celt_pay_add_queued (GstRtpCELTPay * rtpceltpay, GstBuffer * buffer,
    guint ssize, guint size, GstClockTime duration)
{
  g_queue_push_tail (rtpceltpay->queue, buffer);
  rtpceltpay->sbytes += ssize;
  rtpceltpay->bytes += size;
139 140 141 142 143 144 145 146 147 148
  /* only add durations when we have a valid previous duration */
  if (rtpceltpay->qduration != -1) {
    if (duration != -1)
      /* only add valid durations */
      rtpceltpay->qduration += duration;
    else
      /* if we add a buffer without valid duration, our total queued duration
       * becomes unknown */
      rtpceltpay->qduration = -1;
  }
149 150 151
}

static gboolean
Wim Taymans's avatar
Wim Taymans committed
152
gst_rtp_celt_pay_setcaps (GstRTPBasePayload * payload, GstCaps * caps)
153 154 155 156 157 158 159
{
  /* don't configure yet, we wait for the ident packet */
  return TRUE;
}


static GstCaps *
Wim Taymans's avatar
Wim Taymans committed
160
gst_rtp_celt_pay_getcaps (GstRTPBasePayload * payload, GstPad * pad,
161
    GstCaps * filter)
162 163 164
{
  GstCaps *otherpadcaps;
  GstCaps *caps;
165
  const gchar *params;
166

Wim Taymans's avatar
Wim Taymans committed
167
  caps = gst_pad_get_pad_template_caps (pad);
168

Wim Taymans's avatar
Wim Taymans committed
169
  otherpadcaps = gst_pad_get_allowed_caps (payload->srcpad);
170 171
  if (otherpadcaps) {
    if (!gst_caps_is_empty (otherpadcaps)) {
Wim Taymans's avatar
Wim Taymans committed
172 173
      GstStructure *ps;
      GstStructure *s;
174
      gint clock_rate = 0, frame_size = 0, channels = 1;
175

Wim Taymans's avatar
Wim Taymans committed
176 177 178 179 180
      caps = gst_caps_make_writable (caps);

      ps = gst_caps_get_structure (otherpadcaps, 0);
      s = gst_caps_get_structure (caps, 0);

181 182 183
      if (gst_structure_get_int (ps, "clock-rate", &clock_rate)) {
        gst_structure_fixate_field_nearest_int (s, "rate", clock_rate);
      }
184 185 186 187 188 189

      if ((params = gst_structure_get_string (ps, "frame-size")))
        frame_size = atoi (params);
      if (frame_size)
        gst_structure_set (s, "frame-size", G_TYPE_INT, frame_size, NULL);

190
      if ((params = gst_structure_get_string (ps, "encoding-params"))) {
191
        channels = atoi (params);
192 193
        gst_structure_fixate_field_nearest_int (s, "channels", channels);
      }
194 195 196

      GST_DEBUG_OBJECT (payload, "clock-rate=%d frame-size=%d channels=%d",
          clock_rate, frame_size, channels);
197 198 199 200 201 202 203 204 205 206 207 208 209
    }
    gst_caps_unref (otherpadcaps);
  }

  return caps;
}

static gboolean
gst_rtp_celt_pay_parse_ident (GstRtpCELTPay * rtpceltpay,
    const guint8 * data, guint size)
{
  guint32 version, header_size, rate, nb_channels, frame_size, overlap;
  guint32 bytes_per_packet;
Wim Taymans's avatar
Wim Taymans committed
210
  GstRTPBasePayload *payload;
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
  gchar *cstr, *fsstr;
  gboolean res;

  /* we need the header string (8), the version string (20), the version
   * and the header length. */
  if (size < 36)
    goto too_small;

  if (!g_str_has_prefix ((const gchar *) data, "CELT    "))
    goto wrong_header;

  /* skip header and version string */
  data += 28;

  version = GST_READ_UINT32_LE (data);
  GST_DEBUG_OBJECT (rtpceltpay, "version %08x", version);
#if 0
  if (version != 1)
    goto wrong_version;
#endif

  data += 4;
  /* ensure sizes */
  header_size = GST_READ_UINT32_LE (data);
  if (header_size < 56)
    goto header_too_small;

  if (size < header_size)
    goto payload_too_small;

  data += 4;
  rate = GST_READ_UINT32_LE (data);
  data += 4;
  nb_channels = GST_READ_UINT32_LE (data);
  data += 4;
  frame_size = GST_READ_UINT32_LE (data);
  data += 4;
  overlap = GST_READ_UINT32_LE (data);
  data += 4;
  bytes_per_packet = GST_READ_UINT32_LE (data);

  GST_DEBUG_OBJECT (rtpceltpay, "rate %d, nb_channels %d, frame_size %d",
      rate, nb_channels, frame_size);
  GST_DEBUG_OBJECT (rtpceltpay, "overlap %d, bytes_per_packet %d",
      overlap, bytes_per_packet);

Wim Taymans's avatar
Wim Taymans committed
257
  payload = GST_RTP_BASE_PAYLOAD (rtpceltpay);
258

Wim Taymans's avatar
Wim Taymans committed
259
  gst_rtp_base_payload_set_options (payload, "audio", FALSE, "CELT", rate);
260 261
  cstr = g_strdup_printf ("%d", nb_channels);
  fsstr = g_strdup_printf ("%d", frame_size);
Wim Taymans's avatar
Wim Taymans committed
262
  res = gst_rtp_base_payload_set_outcaps (payload, "encoding-params",
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
      G_TYPE_STRING, cstr, "frame-size", G_TYPE_STRING, fsstr, NULL);
  g_free (cstr);
  g_free (fsstr);

  return res;

  /* ERRORS */
too_small:
  {
    GST_DEBUG_OBJECT (rtpceltpay,
        "ident packet too small, need at least 32 bytes");
    return FALSE;
  }
wrong_header:
  {
    GST_DEBUG_OBJECT (rtpceltpay,
        "ident packet does not start with \"CELT    \"");
    return FALSE;
  }
#if 0
wrong_version:
  {
    GST_DEBUG_OBJECT (rtpceltpay, "can only handle version 1, have version %d",
        version);
    return FALSE;
  }
#endif
header_too_small:
  {
    GST_DEBUG_OBJECT (rtpceltpay,
        "header size too small, need at least 80 bytes, " "got only %d",
        header_size);
    return FALSE;
  }
payload_too_small:
  {
    GST_DEBUG_OBJECT (rtpceltpay,
        "payload too small, need at least %d bytes, got only %d", header_size,
        size);
    return FALSE;
  }
}

static GstFlowReturn
gst_rtp_celt_pay_flush_queued (GstRtpCELTPay * rtpceltpay)
{
  GstFlowReturn ret;
  GstBuffer *buf, *outbuf;
  guint8 *payload, *spayload;
  guint payload_len;
  GstClockTime duration;
Wim Taymans's avatar
Wim Taymans committed
314
  GstRTPBuffer rtp = { NULL, };
315 316 317 318 319 320 321 322 323 324 325 326

  payload_len = rtpceltpay->bytes + rtpceltpay->sbytes;
  duration = rtpceltpay->qduration;

  GST_DEBUG_OBJECT (rtpceltpay, "flushing out %u, duration %" GST_TIME_FORMAT,
      payload_len, GST_TIME_ARGS (rtpceltpay->qduration));

  /* get a big enough packet for the sizes + payloads */
  outbuf = gst_rtp_buffer_new_allocate (payload_len, 0, 0);

  GST_BUFFER_DURATION (outbuf) = duration;

Wim Taymans's avatar
Wim Taymans committed
327 328
  gst_rtp_buffer_map (outbuf, GST_MAP_WRITE, &rtp);

329
  /* point to the payload for size headers and data */
Wim Taymans's avatar
Wim Taymans committed
330
  spayload = gst_rtp_buffer_get_payload (&rtp);
331 332 333 334 335 336 337 338 339 340
  payload = spayload + rtpceltpay->sbytes;

  while ((buf = g_queue_pop_head (rtpceltpay->queue))) {
    guint size;

    /* copy first timestamp to output */
    if (GST_BUFFER_TIMESTAMP (outbuf) == -1)
      GST_BUFFER_TIMESTAMP (outbuf) = GST_BUFFER_TIMESTAMP (buf);

    /* write the size to the header */
Wim Taymans's avatar
Wim Taymans committed
341
    size = gst_buffer_get_size (buf);
342 343 344 345 346 347 348
    while (size > 0xff) {
      *spayload++ = 0xff;
      size -= 0xff;
    }
    *spayload++ = size;

    /* copy payload */
Wim Taymans's avatar
Wim Taymans committed
349 350
    size = gst_buffer_get_size (buf);
    gst_buffer_extract (buf, 0, payload, size);
351 352 353 354
    payload += size;

    gst_buffer_unref (buf);
  }
Wim Taymans's avatar
Wim Taymans committed
355
  gst_rtp_buffer_unmap (&rtp);
356 357 358 359 360 361

  /* we consumed it all */
  rtpceltpay->bytes = 0;
  rtpceltpay->sbytes = 0;
  rtpceltpay->qduration = 0;

Wim Taymans's avatar
Wim Taymans committed
362
  ret = gst_rtp_base_payload_push (GST_RTP_BASE_PAYLOAD (rtpceltpay), outbuf);
363 364 365 366 367

  return ret;
}

static GstFlowReturn
Wim Taymans's avatar
Wim Taymans committed
368
gst_rtp_celt_pay_handle_buffer (GstRTPBasePayload * basepayload,
369 370 371 372
    GstBuffer * buffer)
{
  GstFlowReturn ret;
  GstRtpCELTPay *rtpceltpay;
Wim Taymans's avatar
Wim Taymans committed
373 374
  gsize payload_len;
  GstMapInfo map;
375 376 377 378 379 380 381
  GstClockTime duration, packet_dur;
  guint i, ssize, packet_len;

  rtpceltpay = GST_RTP_CELT_PAY (basepayload);

  ret = GST_FLOW_OK;

Wim Taymans's avatar
Wim Taymans committed
382
  gst_buffer_map (buffer, &map, GST_MAP_READ);
383 384 385 386 387

  switch (rtpceltpay->packet) {
    case 0:
      /* ident packet. We need to parse the headers to construct the RTP
       * properties. */
Wim Taymans's avatar
Wim Taymans committed
388
      if (!gst_rtp_celt_pay_parse_ident (rtpceltpay, map.data, map.size))
389 390
        goto parse_error;

Wim Taymans's avatar
Wim Taymans committed
391
      goto cleanup;
392 393
    case 1:
      /* comment packet, we ignore it */
Wim Taymans's avatar
Wim Taymans committed
394
      goto cleanup;
395 396 397 398
    default:
      /* other packets go in the payload */
      break;
  }
Wim Taymans's avatar
Wim Taymans committed
399
  gst_buffer_unmap (buffer, &map);
400 401 402

  duration = GST_BUFFER_DURATION (buffer);

403
  GST_LOG_OBJECT (rtpceltpay,
404
      "got buffer of duration %" GST_TIME_FORMAT ", size %" G_GSIZE_FORMAT,
Wim Taymans's avatar
Wim Taymans committed
405
      GST_TIME_ARGS (duration), map.size);
406 407 408

  /* calculate the size of the size field and the payload */
  ssize = 1;
Wim Taymans's avatar
Wim Taymans committed
409
  for (i = map.size; i > 0xff; i -= 0xff)
410 411 412 413
    ssize++;

  GST_DEBUG_OBJECT (rtpceltpay, "bytes for size %u", ssize);

414
  /* calculate what the new size and duration would be of the packet */
Wim Taymans's avatar
Wim Taymans committed
415
  payload_len = ssize + map.size + rtpceltpay->bytes + rtpceltpay->sbytes;
416 417 418 419
  if (rtpceltpay->qduration != -1 && duration != -1)
    packet_dur = rtpceltpay->qduration + duration;
  else
    packet_dur = 0;
420 421 422

  packet_len = gst_rtp_buffer_calc_packet_len (payload_len, 0, 0);

Wim Taymans's avatar
Wim Taymans committed
423
  if (gst_rtp_base_payload_is_filled (basepayload, packet_len, packet_dur)) {
424 425 426 427 428
    /* size or duration would overflow the packet, flush the queued data */
    ret = gst_rtp_celt_pay_flush_queued (rtpceltpay);
  }

  /* queue the packet */
Wim Taymans's avatar
Wim Taymans committed
429
  gst_rtp_celt_pay_add_queued (rtpceltpay, buffer, ssize, map.size, duration);
430 431 432 433 434 435 436

done:
  rtpceltpay->packet++;

  return ret;

  /* ERRORS */
Wim Taymans's avatar
Wim Taymans committed
437 438
cleanup:
  {
Wim Taymans's avatar
Wim Taymans committed
439
    gst_buffer_unmap (buffer, &map);
Wim Taymans's avatar
Wim Taymans committed
440 441
    goto done;
  }
442 443 444 445
parse_error:
  {
    GST_ELEMENT_ERROR (rtpceltpay, STREAM, DECODE, (NULL),
        ("Error parsing first identification packet."));
Wim Taymans's avatar
Wim Taymans committed
446
    gst_buffer_unmap (buffer, &map);
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
    return GST_FLOW_ERROR;
  }
}

static GstStateChangeReturn
gst_rtp_celt_pay_change_state (GstElement * element, GstStateChange transition)
{
  GstRtpCELTPay *rtpceltpay;
  GstStateChangeReturn ret;

  rtpceltpay = GST_RTP_CELT_PAY (element);

  switch (transition) {
    case GST_STATE_CHANGE_NULL_TO_READY:
      break;
    case GST_STATE_CHANGE_READY_TO_PAUSED:
      rtpceltpay->packet = 0;
      break;
    default:
      break;
  }

  ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);

  switch (transition) {
    case GST_STATE_CHANGE_PAUSED_TO_READY:
      gst_rtp_celt_pay_clear_queued (rtpceltpay);
      break;
    case GST_STATE_CHANGE_READY_TO_NULL:
      break;
    default:
      break;
  }
  return ret;
}

gboolean
gst_rtp_celt_pay_plugin_init (GstPlugin * plugin)
{
  return gst_element_register (plugin, "rtpceltpay",
487
      GST_RANK_SECONDARY, GST_TYPE_RTP_CELT_PAY);
488
}