2 * Copyright (C) <2006> Wim Taymans <wim.taymans@gmail.com>
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.
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.
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.
24 #include <gst/tag/tag.h>
25 #include <gst/rtp/gstrtpbuffer.h>
28 #include "gstrtpvorbisdepay.h"
30 GST_DEBUG_CATEGORY_STATIC (rtpvorbisdepay_debug);
31 #define GST_CAT_DEFAULT (rtpvorbisdepay_debug)
34 * http://www.rfc-editor.org/rfc/rfc5215.txt
37 static GstStaticPadTemplate gst_rtp_vorbis_depay_sink_template =
38 GST_STATIC_PAD_TEMPLATE ("sink",
41 GST_STATIC_CAPS ("application/x-rtp, "
42 "media = (string) \"audio\", "
43 "payload = (int) " GST_RTP_PAYLOAD_DYNAMIC_STRING ", "
44 "clock-rate = (int) [1, MAX ], " "encoding-name = (string) \"VORBIS\""
45 /* All required parameters
47 * "encoding-params = (string) <num channels>"
48 * "configuration = (string) ANY"
53 static GstStaticPadTemplate gst_rtp_vorbis_depay_src_template =
54 GST_STATIC_PAD_TEMPLATE ("src",
57 GST_STATIC_CAPS ("audio/x-vorbis")
60 #define gst_rtp_vorbis_depay_parent_class parent_class
61 G_DEFINE_TYPE (GstRtpVorbisDepay, gst_rtp_vorbis_depay,
62 GST_TYPE_RTP_BASE_DEPAYLOAD);
64 static gboolean gst_rtp_vorbis_depay_setcaps (GstRTPBaseDepayload * depayload,
66 static GstBuffer *gst_rtp_vorbis_depay_process (GstRTPBaseDepayload * depayload,
69 static void gst_rtp_vorbis_depay_finalize (GObject * object);
71 static GstStateChangeReturn gst_rtp_vorbis_depay_change_state (GstElement *
72 element, GstStateChange transition);
75 gst_rtp_vorbis_depay_class_init (GstRtpVorbisDepayClass * klass)
77 GObjectClass *gobject_class;
78 GstElementClass *gstelement_class;
79 GstRTPBaseDepayloadClass *gstrtpbasedepayload_class;
81 gobject_class = (GObjectClass *) klass;
82 gstelement_class = (GstElementClass *) klass;
83 gstrtpbasedepayload_class = (GstRTPBaseDepayloadClass *) klass;
85 gobject_class->finalize = gst_rtp_vorbis_depay_finalize;
87 gstelement_class->change_state = gst_rtp_vorbis_depay_change_state;
89 gstrtpbasedepayload_class->process = gst_rtp_vorbis_depay_process;
90 gstrtpbasedepayload_class->set_caps = gst_rtp_vorbis_depay_setcaps;
92 gst_element_class_add_pad_template (gstelement_class,
93 gst_static_pad_template_get (&gst_rtp_vorbis_depay_sink_template));
94 gst_element_class_add_pad_template (gstelement_class,
95 gst_static_pad_template_get (&gst_rtp_vorbis_depay_src_template));
97 gst_element_class_set_details_simple (gstelement_class,
98 "RTP Vorbis depayloader", "Codec/Depayloader/Network/RTP",
99 "Extracts Vorbis Audio from RTP packets (RFC 5215)",
100 "Wim Taymans <wim.taymans@gmail.com>");
102 GST_DEBUG_CATEGORY_INIT (rtpvorbisdepay_debug, "rtpvorbisdepay", 0,
103 "Vorbis RTP Depayloader");
107 gst_rtp_vorbis_depay_init (GstRtpVorbisDepay * rtpvorbisdepay)
109 rtpvorbisdepay->adapter = gst_adapter_new ();
113 free_config (GstRtpVorbisConfig * conf)
117 for (headers = conf->headers; headers; headers = g_list_next (headers)) {
118 GstBuffer *header = GST_BUFFER_CAST (headers->data);
120 gst_buffer_unref (header);
122 g_list_free (conf->headers);
127 free_indents (GstRtpVorbisDepay * rtpvorbisdepay)
131 for (walk = rtpvorbisdepay->configs; walk; walk = g_list_next (walk)) {
132 free_config ((GstRtpVorbisConfig *) walk->data);
134 g_list_free (rtpvorbisdepay->configs);
135 rtpvorbisdepay->configs = NULL;
139 gst_rtp_vorbis_depay_finalize (GObject * object)
141 GstRtpVorbisDepay *rtpvorbisdepay = GST_RTP_VORBIS_DEPAY (object);
143 g_object_unref (rtpvorbisdepay->adapter);
145 G_OBJECT_CLASS (parent_class)->finalize (object);
148 /* takes ownership of confbuf */
150 gst_rtp_vorbis_depay_parse_configuration (GstRtpVorbisDepay * rtpvorbisdepay,
161 gst_buffer_map (confbuf, &map, GST_MAP_READ);
165 GST_DEBUG_OBJECT (rtpvorbisdepay, "config size %" G_GSIZE_FORMAT, size);
167 /* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
168 * | Number of packed headers |
169 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
170 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
172 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
173 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
175 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
176 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
178 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
183 num_headers = GST_READ_UINT32_BE (data);
188 GST_DEBUG_OBJECT (rtpvorbisdepay, "have %u headers", num_headers);
191 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
192 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
193 * | Ident | length ..
194 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
195 * .. | n. of headers | length1 | length2 ..
196 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
197 * .. | Identification Header ..
198 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
199 * .................................................................
200 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
201 * .. | Comment Header ..
202 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
203 * .................................................................
204 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
205 * .. Comment Header |
206 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
208 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
209 * .................................................................
210 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
212 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
214 for (i = 0; i < num_headers; i++) {
218 GstRtpVorbisConfig *conf;
225 ident = (data[0] << 16) | (data[1] << 8) | data[2];
226 length = (data[3] << 8) | data[4];
232 GST_DEBUG_OBJECT (rtpvorbisdepay,
233 "header %d, ident 0x%08x, length %u, left %" G_GSIZE_FORMAT, i, ident,
236 /* FIXME check if we already got this ident */
238 /* length might also include count of following size fields */
239 if (size < length && size + 1 != length)
242 /* read header sizes we read 2 sizes, the third size (for which we allocate
243 * space) must be derived from the total packed header length. */
244 h_sizes = g_newa (guint, n_headers + 1);
245 for (j = 0; j < n_headers; j++) {
256 h_size = (h_size << 7) | (b & 0x7f);
258 GST_DEBUG_OBJECT (rtpvorbisdepay, "headers %d: size: %u", j, h_size);
266 /* last header length is the remaining space */
267 GST_DEBUG_OBJECT (rtpvorbisdepay, "last header size: %u", length);
270 GST_DEBUG_OBJECT (rtpvorbisdepay, "preparing headers");
271 conf = g_new0 (GstRtpVorbisConfig, 1);
274 for (j = 0; j <= n_headers; j++) {
279 if (j != n_headers || size + extra != h_size) {
283 /* otherwise means that overall length field contained total length,
284 * including extra fields */
289 GST_DEBUG_OBJECT (rtpvorbisdepay, "reading header %d, size %u", j,
292 buf = gst_buffer_copy_region (confbuf, GST_BUFFER_COPY_MEMORY, offset,
294 conf->headers = g_list_append (conf->headers, buf);
298 rtpvorbisdepay->configs = g_list_append (rtpvorbisdepay->configs, conf);
301 gst_buffer_unmap (confbuf, &map);
302 gst_buffer_unref (confbuf);
309 GST_DEBUG_OBJECT (rtpvorbisdepay, "configuration too small");
310 gst_buffer_unmap (confbuf, &map);
311 gst_buffer_unref (confbuf);
317 gst_rtp_vorbis_depay_parse_inband_configuration (GstRtpVorbisDepay *
318 rtpvorbisdepay, guint ident, guint8 * configuration, guint size,
324 if (G_UNLIKELY (size < 4))
327 /* transform inline to out-of-band and parse that one */
328 confbuf = gst_buffer_new_and_alloc (size + 9);
329 gst_buffer_map (confbuf, &map, GST_MAP_WRITE);
331 GST_WRITE_UINT32_BE (map.data, 1);
333 GST_WRITE_UINT24_BE (map.data + 4, ident);
334 /* write sort-of-length */
335 GST_WRITE_UINT16_BE (map.data + 7, length);
337 memcpy (map.data + 9, configuration, size);
338 gst_buffer_unmap (confbuf, &map);
340 return gst_rtp_vorbis_depay_parse_configuration (rtpvorbisdepay, confbuf);
344 gst_rtp_vorbis_depay_setcaps (GstRTPBaseDepayload * depayload, GstCaps * caps)
346 GstStructure *structure;
347 GstRtpVorbisDepay *rtpvorbisdepay;
349 const gchar *configuration;
353 rtpvorbisdepay = GST_RTP_VORBIS_DEPAY (depayload);
355 structure = gst_caps_get_structure (caps, 0);
358 if (!gst_structure_get_int (structure, "clock-rate", &clock_rate))
361 /* read and parse configuration string */
362 configuration = gst_structure_get_string (structure, "configuration");
368 /* deserialize base64 to buffer */
369 data = g_base64_decode (configuration, &size);
371 confbuf = gst_buffer_new ();
372 gst_buffer_take_memory (confbuf, -1,
373 gst_memory_new_wrapped (0, data, g_free, size, 0, size));
374 if (!gst_rtp_vorbis_depay_parse_configuration (rtpvorbisdepay, confbuf))
375 goto invalid_configuration;
377 GST_WARNING_OBJECT (rtpvorbisdepay, "no configuration specified");
380 /* caps seem good, configure element */
381 depayload->clock_rate = clock_rate;
383 /* set caps on pad and on header */
384 srccaps = gst_caps_new_empty_simple ("audio/x-vorbis");
385 res = gst_pad_set_caps (depayload->srcpad, srccaps);
386 gst_caps_unref (srccaps);
391 invalid_configuration:
393 GST_ERROR_OBJECT (rtpvorbisdepay, "invalid configuration specified");
398 GST_ERROR_OBJECT (rtpvorbisdepay, "no clock-rate specified");
404 gst_rtp_vorbis_depay_switch_codebook (GstRtpVorbisDepay * rtpvorbisdepay,
408 gboolean res = FALSE;
410 GST_DEBUG_OBJECT (rtpvorbisdepay, "Looking up code book ident 0x%08x", ident);
411 for (walk = rtpvorbisdepay->configs; walk; walk = g_list_next (walk)) {
412 GstRtpVorbisConfig *conf = (GstRtpVorbisConfig *) walk->data;
414 if (conf->ident == ident) {
417 /* FIXME, remove pads, create new pad.. */
419 /* push out all the headers */
420 for (headers = conf->headers; headers; headers = g_list_next (headers)) {
421 GstBuffer *header = GST_BUFFER_CAST (headers->data);
423 gst_buffer_ref (header);
424 gst_rtp_base_depayload_push (GST_RTP_BASE_DEPAYLOAD (rtpvorbisdepay),
427 /* remember the current config */
428 rtpvorbisdepay->config = conf;
433 /* we don't know about the headers, figure out an alternative method for
434 * getting the codebooks. FIXME, fail for now. */
440 gst_rtp_vorbis_depay_process (GstRTPBaseDepayload * depayload, GstBuffer * buf)
442 GstRtpVorbisDepay *rtpvorbisdepay;
446 guint8 *payload, *to_free = NULL;
447 guint32 header, ident;
448 guint8 F, VDT, packets;
449 GstRTPBuffer rtp = { NULL };
451 rtpvorbisdepay = GST_RTP_VORBIS_DEPAY (depayload);
453 gst_rtp_buffer_map (buf, GST_MAP_READ, &rtp);
455 payload_len = gst_rtp_buffer_get_payload_len (&rtp);
457 GST_DEBUG_OBJECT (depayload, "got RTP packet of size %d", payload_len);
459 /* we need at least 4 bytes for the packet header */
460 if (G_UNLIKELY (payload_len < 4))
463 payload = gst_rtp_buffer_get_payload (&rtp);
465 header = GST_READ_UINT32_BE (payload);
468 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
469 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
470 * | Ident | F |VDT|# pkts.|
471 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
473 * F: Fragment type (0=none, 1=start, 2=cont, 3=end)
474 * VDT: Vorbis data type (0=vorbis, 1=config, 2=comment, 3=reserved)
475 * pkts: number of packets.
477 VDT = (header & 0x30) >> 4;
478 if (G_UNLIKELY (VDT == 3))
479 goto ignore_reserved;
481 GST_DEBUG_OBJECT (depayload, "header: 0x%08x", header);
482 ident = (header >> 8) & 0xffffff;
483 F = (header & 0xc0) >> 6;
484 packets = (header & 0xf);
487 gboolean do_switch = FALSE;
489 /* we have a raw payload, find the codebook for the ident */
490 if (!rtpvorbisdepay->config) {
491 /* we don't have an active codebook, find the codebook and
493 GST_DEBUG_OBJECT (rtpvorbisdepay, "No active codebook, switching");
495 } else if (rtpvorbisdepay->config->ident != ident) {
496 /* codebook changed */
497 GST_DEBUG_OBJECT (rtpvorbisdepay, "codebook changed, switching");
501 if (!gst_rtp_vorbis_depay_switch_codebook (rtpvorbisdepay, ident))
510 GST_DEBUG_OBJECT (depayload, "ident: %u, F: %d, VDT: %d, packets: %d", ident,
513 /* fragmented packets, assemble */
519 /* if we start a packet, clear adapter and start assembling. */
520 gst_adapter_clear (rtpvorbisdepay->adapter);
521 GST_DEBUG_OBJECT (depayload, "start assemble");
522 rtpvorbisdepay->assembling = TRUE;
525 if (!rtpvorbisdepay->assembling)
528 /* first assembled packet, reuse 2 bytes to store the length */
529 headerskip = (F == 1 ? 4 : 6);
530 /* skip header and length. */
531 vdata = gst_rtp_buffer_get_payload_subbuffer (&rtp, headerskip, -1);
533 GST_DEBUG_OBJECT (depayload, "assemble vorbis packet");
534 gst_adapter_push (rtpvorbisdepay->adapter, vdata);
536 /* packet is not complete, we are done */
540 /* construct assembled buffer */
541 payload_len = gst_adapter_available (rtpvorbisdepay->adapter);
542 payload = gst_adapter_take (rtpvorbisdepay->adapter, payload_len);
544 payload[0] = ((payload_len - 2) >> 8) & 0xff;
545 payload[1] = (payload_len - 2) & 0xff;
549 GST_DEBUG_OBJECT (depayload, "assemble done");
551 /* we not assembling anymore now */
552 rtpvorbisdepay->assembling = FALSE;
553 gst_adapter_clear (rtpvorbisdepay->adapter);
555 /* payload now points to a length with that many vorbis data bytes.
556 * Iterate over the packets and send them out.
559 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
560 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
561 * | length | vorbis data ..
562 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
564 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
565 * | length | next vorbis packet data ..
566 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
568 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+*
570 while (payload_len > 2) {
573 length = GST_READ_UINT16_BE (payload);
577 GST_DEBUG_OBJECT (depayload, "read length %u, avail: %d", length,
580 /* skip packet if something odd happens */
581 if (G_UNLIKELY (length > payload_len))
584 /* handle in-band configuration */
585 if (G_UNLIKELY (VDT == 1)) {
586 GST_DEBUG_OBJECT (rtpvorbisdepay, "in-band configuration");
587 if (!gst_rtp_vorbis_depay_parse_inband_configuration (rtpvorbisdepay,
588 ident, payload, payload_len, length))
589 goto invalid_configuration;
593 /* create buffer for packet */
594 if (G_UNLIKELY (to_free)) {
595 outbuf = gst_buffer_new ();
596 gst_buffer_take_memory (outbuf, -1,
597 gst_memory_new_wrapped (0, to_free, g_free,
598 (payload - to_free) + length, payload - to_free, length));
601 outbuf = gst_buffer_new_and_alloc (length);
602 gst_buffer_fill (outbuf, 0, payload, length);
606 payload_len -= length;
608 ret = gst_rtp_base_depayload_push (depayload, outbuf);
609 if (ret != GST_FLOW_OK)
615 gst_rtp_buffer_unmap (&rtp);
621 gst_rtp_buffer_unmap (&rtp);
627 GST_ELEMENT_WARNING (rtpvorbisdepay, STREAM, DECODE,
628 (NULL), ("Could not switch codebooks"));
629 gst_rtp_buffer_unmap (&rtp);
634 GST_ELEMENT_WARNING (rtpvorbisdepay, STREAM, DECODE,
635 (NULL), ("Packet was too short (%d < 4)", payload_len));
636 gst_rtp_buffer_unmap (&rtp);
641 GST_WARNING_OBJECT (rtpvorbisdepay, "reserved VDT ignored");
642 gst_rtp_buffer_unmap (&rtp);
647 GST_ELEMENT_WARNING (rtpvorbisdepay, STREAM, DECODE,
648 (NULL), ("Packet contains invalid data"));
649 gst_rtp_buffer_unmap (&rtp);
652 invalid_configuration:
654 /* fatal, as we otherwise risk carrying on without output */
655 GST_ELEMENT_ERROR (rtpvorbisdepay, STREAM, DECODE,
656 (NULL), ("Packet contains invalid configuration"));
657 gst_rtp_buffer_unmap (&rtp);
662 static GstStateChangeReturn
663 gst_rtp_vorbis_depay_change_state (GstElement * element,
664 GstStateChange transition)
666 GstRtpVorbisDepay *rtpvorbisdepay;
667 GstStateChangeReturn ret;
669 rtpvorbisdepay = GST_RTP_VORBIS_DEPAY (element);
671 switch (transition) {
672 case GST_STATE_CHANGE_NULL_TO_READY:
674 case GST_STATE_CHANGE_READY_TO_PAUSED:
680 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
682 switch (transition) {
683 case GST_STATE_CHANGE_PAUSED_TO_READY:
684 free_indents (rtpvorbisdepay);
686 case GST_STATE_CHANGE_READY_TO_NULL:
695 gst_rtp_vorbis_depay_plugin_init (GstPlugin * plugin)
697 return gst_element_register (plugin, "rtpvorbisdepay",
698 GST_RANK_SECONDARY, GST_TYPE_RTP_VORBIS_DEPAY);