2 * Copyright (C) <2005> Wim Taymans <wim@fluendo.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
19 #include <gst/rtp/gstrtpbuffer.h>
22 #include "gstrtpamrdec.h"
26 * RFC 3267 - Real-Time Transport Protocol (RTP) Payload Format and File Storage Format
27 * for the Adaptive Multi-Rate (AMR) and Adaptive Multi-Rate Wideband (AMR-WB) Audio
31 /* elementfactory information */
32 static GstElementDetails gst_rtp_amrdec_details = {
34 "Codec/Parser/Network",
35 "Extracts MPEG audio from RTP packets",
36 "Wim Taymans <wim@fluendo.com>"
39 /* RtpAMRDec signals and args */
52 /* input is an RTP packet
54 * params see RFC 3267, section 8.1
56 static GstStaticPadTemplate gst_rtpamrdec_sink_template =
57 GST_STATIC_PAD_TEMPLATE ("sink",
60 GST_STATIC_CAPS ("application/x-rtp, "
61 "octet-align = (boolean) TRUE, "
62 "crc = (boolean) FALSE, "
63 "robust-sorting = (boolean) FALSE, "
64 "interleaving = (boolean) FALSE, "
65 "channels = (int) 1, " "rate = (int) 8000"
66 /* following options are not needed for a decoder
68 "mode-set = (int) [ 0, 7 ], "
69 "mode-change-period = (int) [ 1, MAX ], "
70 "mode-change-neighbor = (boolean) { TRUE, FALSE }, "
71 "maxptime = (int) [ 20, MAX ], "
72 "ptime = (int) [ 20, MAX ]"
77 static GstStaticPadTemplate gst_rtpamrdec_src_template =
78 GST_STATIC_PAD_TEMPLATE ("src",
81 GST_STATIC_CAPS ("audio/AMR, " "channels = (int) 1," "rate = (int) 8000")
84 static void gst_rtpamrdec_class_init (GstRtpAMRDecClass * klass);
85 static void gst_rtpamrdec_base_init (GstRtpAMRDecClass * klass);
86 static void gst_rtpamrdec_init (GstRtpAMRDec * rtpamrdec);
88 static gboolean gst_rtpamrdec_sink_setcaps (GstPad * pad, GstCaps * caps);
89 static GstFlowReturn gst_rtpamrdec_chain (GstPad * pad, GstBuffer * buffer);
91 static void gst_rtpamrdec_set_property (GObject * object, guint prop_id,
92 const GValue * value, GParamSpec * pspec);
93 static void gst_rtpamrdec_get_property (GObject * object, guint prop_id,
94 GValue * value, GParamSpec * pspec);
96 static GstStateChangeReturn gst_rtpamrdec_change_state (GstElement * element,
97 GstStateChange transition);
99 static GstElementClass *parent_class = NULL;
102 gst_rtpamrdec_get_type (void)
104 static GType rtpamrdec_type = 0;
106 if (!rtpamrdec_type) {
107 static const GTypeInfo rtpamrdec_info = {
108 sizeof (GstRtpAMRDecClass),
109 (GBaseInitFunc) gst_rtpamrdec_base_init,
111 (GClassInitFunc) gst_rtpamrdec_class_init,
114 sizeof (GstRtpAMRDec),
116 (GInstanceInitFunc) gst_rtpamrdec_init,
120 g_type_register_static (GST_TYPE_ELEMENT, "GstRtpAMRDec",
123 return rtpamrdec_type;
127 gst_rtpamrdec_base_init (GstRtpAMRDecClass * klass)
129 GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
131 gst_element_class_add_pad_template (element_class,
132 gst_static_pad_template_get (&gst_rtpamrdec_src_template));
133 gst_element_class_add_pad_template (element_class,
134 gst_static_pad_template_get (&gst_rtpamrdec_sink_template));
136 gst_element_class_set_details (element_class, &gst_rtp_amrdec_details);
140 gst_rtpamrdec_class_init (GstRtpAMRDecClass * klass)
142 GObjectClass *gobject_class;
143 GstElementClass *gstelement_class;
145 gobject_class = (GObjectClass *) klass;
146 gstelement_class = (GstElementClass *) klass;
148 parent_class = g_type_class_ref (GST_TYPE_ELEMENT);
150 gobject_class->set_property = gst_rtpamrdec_set_property;
151 gobject_class->get_property = gst_rtpamrdec_get_property;
153 gstelement_class->change_state = gst_rtpamrdec_change_state;
157 gst_rtpamrdec_init (GstRtpAMRDec * rtpamrdec)
162 gst_pad_new_from_template (gst_static_pad_template_get
163 (&gst_rtpamrdec_src_template), "src");
166 srccaps = gst_caps_new_simple ("audio/AMR",
167 "channels", G_TYPE_INT, 1, "rate", G_TYPE_INT, 8000, NULL);
168 gst_pad_set_caps (rtpamrdec->srcpad, srccaps);
169 gst_caps_unref (srccaps);
171 gst_element_add_pad (GST_ELEMENT (rtpamrdec), rtpamrdec->srcpad);
174 gst_pad_new_from_template (gst_static_pad_template_get
175 (&gst_rtpamrdec_sink_template), "sink");
176 gst_pad_set_setcaps_function (rtpamrdec->sinkpad, gst_rtpamrdec_sink_setcaps);
177 gst_pad_set_chain_function (rtpamrdec->sinkpad, gst_rtpamrdec_chain);
178 gst_element_add_pad (GST_ELEMENT (rtpamrdec), rtpamrdec->sinkpad);
182 gst_rtpamrdec_sink_setcaps (GstPad * pad, GstCaps * caps)
184 GstStructure *structure;
186 GstRtpAMRDec *rtpamrdec;
188 rtpamrdec = GST_RTP_AMR_DEC (GST_OBJECT_PARENT (pad));
190 structure = gst_caps_get_structure (caps, 0);
192 if (!gst_structure_get_boolean (structure, "octet-align",
193 &rtpamrdec->octet_align))
194 rtpamrdec->octet_align = FALSE;
196 /* FIXME, force octect align for now until all elements negotiate
198 rtpamrdec->octet_align = TRUE;
200 if (!gst_structure_get_boolean (structure, "crc", &rtpamrdec->crc))
201 rtpamrdec->crc = FALSE;
203 if (rtpamrdec->crc) {
204 /* crc mode implies octet aligned mode */
205 rtpamrdec->octet_align = TRUE;
208 if (!gst_structure_get_boolean (structure, "robust-sorting",
209 &rtpamrdec->robust_sorting))
210 rtpamrdec->robust_sorting = FALSE;
212 if (rtpamrdec->robust_sorting) {
213 /* robust_sorting mode implies octet aligned mode */
214 rtpamrdec->octet_align = TRUE;
217 if (!gst_structure_get_boolean (structure, "interleaving",
218 &rtpamrdec->interleaving))
219 rtpamrdec->interleaving = FALSE;
221 if (rtpamrdec->interleaving) {
222 /* interleaving mode implies octet aligned mode */
223 rtpamrdec->octet_align = TRUE;
226 if (!gst_structure_get_int (structure, "channels", &rtpamrdec->channels))
227 rtpamrdec->channels = 1;
228 if (!gst_structure_get_int (structure, "rate", &rtpamrdec->rate))
229 rtpamrdec->rate = 8000;
231 /* we require 1 channel, 8000 Hz, octet aligned, no CRC,
232 * no robust sorting, no interleaving for now */
233 if (rtpamrdec->channels != 1)
235 if (rtpamrdec->rate != 8000)
237 if (rtpamrdec->octet_align != TRUE)
239 if (rtpamrdec->crc != FALSE)
241 if (rtpamrdec->robust_sorting != FALSE)
243 if (rtpamrdec->interleaving != FALSE)
246 srccaps = gst_caps_new_simple ("audio/AMR",
247 "channels", G_TYPE_INT, rtpamrdec->channels,
248 "rate", G_TYPE_INT, rtpamrdec->rate, NULL);
249 gst_pad_set_caps (rtpamrdec->srcpad, srccaps);
250 gst_caps_unref (srccaps);
252 rtpamrdec->negotiated = TRUE;
258 gst_rtpamrdec_chain (GstPad * pad, GstBuffer * buf)
260 GstRtpAMRDec *rtpamrdec;
264 rtpamrdec = GST_RTP_AMR_DEC (GST_OBJECT_PARENT (pad));
266 if (!rtpamrdec->negotiated)
269 if (!gst_rtpbuffer_validate (buf))
272 /* when we get here, 1 channel, 8000 Hz, octet aligned, no CRC,
273 * no robust sorting, no interleaving data is to be parsed */
278 guint8 CMR, F, FT, Q;
280 payload_len = gst_rtpbuffer_get_payload_len (buf);
282 /* need at least 2 bytes for the header */
286 payload = gst_rtpbuffer_get_payload (buf);
289 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6
290 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+..
291 * | CMR=6 |R|R|R|R|0|FT#1=5 |Q|P|P|
292 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+..
294 CMR = (payload[0] & 0xf0) >> 4;
295 F = (payload[1] & 0x80) >> 7;
296 /* we only support 1 packet per RTP packet for now */
298 goto one_packet_only;
300 FT = (payload[1] & 0x78) >> 3;
301 Q = (payload[1] & 0x04) >> 2;
304 if (FT > 9 && FT < 15) {
309 /* strip header now, leave FT in the data for the decoder */
313 timestamp = gst_rtpbuffer_get_timestamp (buf);
315 outbuf = gst_buffer_new_and_alloc (payload_len);
317 GST_BUFFER_TIMESTAMP (outbuf) = timestamp * GST_SECOND / 8000;
319 memcpy (GST_BUFFER_DATA (outbuf), payload, payload_len);
321 gst_buffer_set_caps (outbuf, GST_PAD_CAPS (rtpamrdec->srcpad));
323 GST_DEBUG ("gst_rtpamrdec_chain: pushing buffer of size %d",
324 GST_BUFFER_SIZE (outbuf));
325 ret = gst_pad_push (rtpamrdec->srcpad, outbuf);
328 gst_buffer_unref (buf);
335 GST_DEBUG ("not_negotiated");
336 gst_buffer_unref (buf);
337 return GST_FLOW_NOT_NEGOTIATED;
341 GST_DEBUG ("Packet did not validate");
342 gst_buffer_unref (buf);
343 return GST_FLOW_ERROR;
347 GST_DEBUG ("One packet per RTP packet only");
348 gst_buffer_unref (buf);
349 return GST_FLOW_ERROR;
354 gst_rtpamrdec_set_property (GObject * object, guint prop_id,
355 const GValue * value, GParamSpec * pspec)
357 GstRtpAMRDec *rtpamrdec;
359 rtpamrdec = GST_RTP_AMR_DEC (object);
363 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
369 gst_rtpamrdec_get_property (GObject * object, guint prop_id, GValue * value,
372 GstRtpAMRDec *rtpamrdec;
374 rtpamrdec = GST_RTP_AMR_DEC (object);
378 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
383 static GstStateChangeReturn
384 gst_rtpamrdec_change_state (GstElement * element, GstStateChange transition)
386 GstRtpAMRDec *rtpamrdec;
387 GstStateChangeReturn ret;
389 rtpamrdec = GST_RTP_AMR_DEC (element);
391 switch (transition) {
392 case GST_STATE_CHANGE_NULL_TO_READY:
394 case GST_STATE_CHANGE_READY_TO_PAUSED:
395 /* FIXME, don't require negotiation until all elements
397 rtpamrdec->negotiated = TRUE;
403 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
405 switch (transition) {
406 case GST_STATE_CHANGE_READY_TO_NULL:
415 gst_rtpamrdec_plugin_init (GstPlugin * plugin)
417 return gst_element_register (plugin, "rtpamrdec",
418 GST_RANK_NONE, GST_TYPE_RTP_AMR_DEC);