2 * Copyright (C) <2005> 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/rtp/gstrtpbuffer.h>
28 #include "gstrtpamrdepay.h"
30 GST_DEBUG_CATEGORY_STATIC (rtpamrdepay_debug);
31 #define GST_CAT_DEFAULT (rtpamrdepay_debug)
35 * RFC 3267 - Real-Time Transport Protocol (RTP) Payload Format and File
36 * Storage Format for the Adaptive Multi-Rate (AMR) and Adaptive Multi-Rate
37 * Wideband (AMR-WB) Audio Codecs.
40 /* RtpAMRDepay signals and args */
52 /* input is an RTP packet
54 * params see RFC 3267, section 8.1
56 static GstStaticPadTemplate gst_rtp_amr_depay_sink_template =
57 GST_STATIC_PAD_TEMPLATE ("sink",
60 GST_STATIC_CAPS ("application/x-rtp, "
61 "media = (string) \"audio\", "
62 "payload = (int) " GST_RTP_PAYLOAD_DYNAMIC_STRING ", "
63 "clock-rate = (int) 8000, "
64 "encoding-name = (string) \"AMR\", "
65 "encoding-params = (string) \"1\", "
66 /* NOTE that all values must be strings in orde to be able to do SDP <->
68 "octet-align = (string) \"1\", "
69 "crc = (string) { \"0\", \"1\" }, "
70 "robust-sorting = (string) \"0\", " "interleaving = (string) \"0\";"
71 /* following options are not needed for a decoder
73 "mode-set = (int) [ 0, 7 ], "
74 "mode-change-period = (int) [ 1, MAX ], "
75 "mode-change-neighbor = (boolean) { TRUE, FALSE }, "
76 "maxptime = (int) [ 20, MAX ], "
77 "ptime = (int) [ 20, MAX ]"
80 "media = (string) \"audio\", "
81 "payload = (int) " GST_RTP_PAYLOAD_DYNAMIC_STRING ", "
82 "clock-rate = (int) 16000, "
83 "encoding-name = (string) \"AMR-WB\", "
84 "encoding-params = (string) \"1\", "
85 /* NOTE that all values must be strings in orde to be able to do SDP <->
87 "octet-align = (string) \"1\", "
88 "crc = (string) { \"0\", \"1\" }, "
89 "robust-sorting = (string) \"0\", " "interleaving = (string) \"0\""
90 /* following options are not needed for a decoder
92 "mode-set = (int) [ 0, 7 ], "
93 "mode-change-period = (int) [ 1, MAX ], "
94 "mode-change-neighbor = (boolean) { TRUE, FALSE }, "
95 "maxptime = (int) [ 20, MAX ], "
96 "ptime = (int) [ 20, MAX ]"
101 static GstStaticPadTemplate gst_rtp_amr_depay_src_template =
102 GST_STATIC_PAD_TEMPLATE ("src",
105 GST_STATIC_CAPS ("audio/AMR, " "channels = (int) 1," "rate = (int) 8000;"
106 "audio/AMR-WB, " "channels = (int) 1," "rate = (int) 16000")
109 static gboolean gst_rtp_amr_depay_setcaps (GstBaseRTPDepayload * depayload,
111 static GstBuffer *gst_rtp_amr_depay_process (GstBaseRTPDepayload * depayload,
114 GST_BOILERPLATE (GstRtpAMRDepay, gst_rtp_amr_depay, GstBaseRTPDepayload,
115 GST_TYPE_BASE_RTP_DEPAYLOAD);
118 gst_rtp_amr_depay_base_init (gpointer klass)
120 GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
122 gst_element_class_add_pad_template (element_class,
123 gst_static_pad_template_get (&gst_rtp_amr_depay_src_template));
124 gst_element_class_add_pad_template (element_class,
125 gst_static_pad_template_get (&gst_rtp_amr_depay_sink_template));
127 gst_element_class_set_details_simple (element_class, "RTP AMR depayloader",
128 "Codec/Depayloader/Network/RTP",
129 "Extracts AMR or AMR-WB audio from RTP packets (RFC 3267)",
130 "Wim Taymans <wim.taymans@gmail.com>");
134 gst_rtp_amr_depay_class_init (GstRtpAMRDepayClass * klass)
136 GstBaseRTPDepayloadClass *gstbasertpdepayload_class;
138 gstbasertpdepayload_class = (GstBaseRTPDepayloadClass *) klass;
140 gstbasertpdepayload_class->process = gst_rtp_amr_depay_process;
141 gstbasertpdepayload_class->set_caps = gst_rtp_amr_depay_setcaps;
143 GST_DEBUG_CATEGORY_INIT (rtpamrdepay_debug, "rtpamrdepay", 0,
144 "AMR/AMR-WB RTP Depayloader");
148 gst_rtp_amr_depay_init (GstRtpAMRDepay * rtpamrdepay,
149 GstRtpAMRDepayClass * klass)
151 GstBaseRTPDepayload *depayload;
153 depayload = GST_BASE_RTP_DEPAYLOAD (rtpamrdepay);
155 gst_pad_use_fixed_caps (GST_BASE_RTP_DEPAYLOAD_SRCPAD (depayload));
159 gst_rtp_amr_depay_setcaps (GstBaseRTPDepayload * depayload, GstCaps * caps)
161 GstStructure *structure;
163 GstRtpAMRDepay *rtpamrdepay;
165 const gchar *str, *type;
166 gint clock_rate, need_clock_rate;
169 rtpamrdepay = GST_RTP_AMR_DEPAY (depayload);
171 structure = gst_caps_get_structure (caps, 0);
173 /* figure out the mode first and set the clock rates */
174 if ((str = gst_structure_get_string (structure, "encoding-name"))) {
175 if (strcmp (str, "AMR") == 0) {
176 rtpamrdepay->mode = GST_RTP_AMR_DP_MODE_NB;
177 need_clock_rate = 8000;
179 } else if (strcmp (str, "AMR-WB") == 0) {
180 rtpamrdepay->mode = GST_RTP_AMR_DP_MODE_WB;
181 need_clock_rate = 16000;
182 type = "audio/AMR-WB";
188 if (!(str = gst_structure_get_string (structure, "octet-align")))
189 rtpamrdepay->octet_align = FALSE;
191 rtpamrdepay->octet_align = (atoi (str) == 1);
193 if (!(str = gst_structure_get_string (structure, "crc")))
194 rtpamrdepay->crc = FALSE;
196 rtpamrdepay->crc = (atoi (str) == 1);
198 if (rtpamrdepay->crc) {
199 /* crc mode implies octet aligned mode */
200 rtpamrdepay->octet_align = TRUE;
203 if (!(str = gst_structure_get_string (structure, "robust-sorting")))
204 rtpamrdepay->robust_sorting = FALSE;
206 rtpamrdepay->robust_sorting = (atoi (str) == 1);
208 if (rtpamrdepay->robust_sorting) {
209 /* robust_sorting mode implies octet aligned mode */
210 rtpamrdepay->octet_align = TRUE;
213 if (!(str = gst_structure_get_string (structure, "interleaving")))
214 rtpamrdepay->interleaving = FALSE;
216 rtpamrdepay->interleaving = (atoi (str) == 1);
218 if (rtpamrdepay->interleaving) {
219 /* interleaving mode implies octet aligned mode */
220 rtpamrdepay->octet_align = TRUE;
223 if (!(params = gst_structure_get_string (structure, "encoding-params")))
224 rtpamrdepay->channels = 1;
226 rtpamrdepay->channels = atoi (params);
229 if (!gst_structure_get_int (structure, "clock-rate", &clock_rate))
230 clock_rate = need_clock_rate;
231 depayload->clock_rate = clock_rate;
233 /* we require 1 channel, 8000 Hz, octet aligned, no CRC,
234 * no robust sorting, no interleaving for now */
235 if (rtpamrdepay->channels != 1)
237 if (clock_rate != need_clock_rate)
239 if (rtpamrdepay->octet_align != TRUE)
241 if (rtpamrdepay->robust_sorting != FALSE)
243 if (rtpamrdepay->interleaving != FALSE)
246 srccaps = gst_caps_new_simple (type,
247 "channels", G_TYPE_INT, rtpamrdepay->channels,
248 "rate", G_TYPE_INT, clock_rate, NULL);
249 res = gst_pad_set_caps (GST_BASE_RTP_DEPAYLOAD_SRCPAD (depayload), srccaps);
250 gst_caps_unref (srccaps);
257 GST_ERROR_OBJECT (rtpamrdepay, "invalid encoding-name");
263 static const gint nb_frame_size[16] = {
264 12, 13, 15, 17, 19, 20, 26, 31,
265 5, -1, -1, -1, -1, -1, -1, 0
268 static const gint wb_frame_size[16] = {
269 17, 23, 32, 36, 40, 46, 50, 58,
270 60, 5, -1, -1, -1, -1, -1, 0
274 gst_rtp_amr_depay_process (GstBaseRTPDepayload * depayload, GstBuffer * buf)
276 GstRtpAMRDepay *rtpamrdepay;
277 const gint *frame_size;
278 GstBuffer *outbuf = NULL;
281 rtpamrdepay = GST_RTP_AMR_DEPAY (depayload);
283 /* setup frame size pointer */
284 if (rtpamrdepay->mode == GST_RTP_AMR_DP_MODE_NB)
285 frame_size = nb_frame_size;
287 frame_size = wb_frame_size;
289 /* when we get here, 1 channel, 8000/16000 Hz, octet aligned, no CRC,
290 * no robust sorting, no interleaving data is to be depayloaded */
292 guint8 *payload, *p, *dp;
294 gint i, num_packets, num_nonempty_packets;
298 payload_len = gst_rtp_buffer_get_payload_len (buf);
300 /* need at least 2 bytes for the header */
304 payload = gst_rtp_buffer_get_payload (buf);
306 /* depay CMR. The CMR is used by the sender to request
307 * a new encoding mode.
314 CMR = (payload[0] & 0xf0) >> 4;
316 /* strip CMR header now, pack FT and the data for the decoder */
320 GST_DEBUG_OBJECT (rtpamrdepay, "payload len %d", payload_len);
322 if (rtpamrdepay->interleaving) {
323 ILL = (payload[0] & 0xf0) >> 4;
324 ILP = (payload[0] & 0x0f);
330 goto wrong_interleaving;
334 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6
335 * +-+-+-+-+-+-+-+-+..
336 * |F| FT |Q|P|P| more FT..
337 * +-+-+-+-+-+-+-+-+..
339 /* count number of packets by counting the FTs. Also
340 * count number of amr data bytes and number of non-empty
341 * packets (this is also the number of CRCs if present). */
343 num_nonempty_packets = 0;
345 for (i = 0; i < payload_len; i++) {
349 FT = (payload[i] & 0x78) >> 3;
351 fr_size = frame_size[FT];
352 GST_DEBUG_OBJECT (rtpamrdepay, "frame size %d", fr_size);
354 goto wrong_framesize;
358 num_nonempty_packets++;
362 if ((payload[i] & 0x80) == 0)
366 if (rtpamrdepay->crc) {
367 /* data len + CRC len + header bytes should be smaller than payload_len */
368 if (num_packets + num_nonempty_packets + amr_len > payload_len)
371 /* data len + header bytes should be smaller than payload_len */
372 if (num_packets + amr_len > payload_len)
376 outbuf = gst_buffer_new_and_alloc (payload_len);
378 /* point to destination */
379 p = GST_BUFFER_DATA (outbuf);
380 /* point to first data packet */
381 dp = payload + num_packets;
382 if (rtpamrdepay->crc) {
383 /* skip CRC if present */
384 dp += num_nonempty_packets;
387 for (i = 0; i < num_packets; i++) {
390 /* copy FT, clear F bit */
391 *p++ = payload[i] & 0x7f;
393 fr_size = frame_size[(payload[i] & 0x78) >> 3];
395 /* copy data packet, FIXME, calc CRC here. */
396 memcpy (p, dp, fr_size);
402 /* we can set the duration because each packet is 20 milliseconds */
403 GST_BUFFER_DURATION (outbuf) = num_packets * 20 * GST_MSECOND;
405 if (gst_rtp_buffer_get_marker (buf)) {
406 /* marker bit marks a discont buffer after a talkspurt. */
407 GST_DEBUG_OBJECT (depayload, "marker bit was set");
408 GST_BUFFER_FLAG_SET (outbuf, GST_BUFFER_FLAG_DISCONT);
411 GST_DEBUG_OBJECT (depayload, "pushing buffer of size %d",
412 GST_BUFFER_SIZE (outbuf));
419 GST_ELEMENT_WARNING (rtpamrdepay, STREAM, DECODE,
420 (NULL), ("AMR RTP payload too small (%d)", payload_len));
425 GST_ELEMENT_WARNING (rtpamrdepay, STREAM, DECODE,
426 (NULL), ("AMR RTP wrong interleaving"));
431 GST_ELEMENT_WARNING (rtpamrdepay, STREAM, DECODE,
432 (NULL), ("AMR RTP frame size == -1"));
437 GST_ELEMENT_WARNING (rtpamrdepay, STREAM, DECODE,
438 (NULL), ("AMR RTP wrong length 1"));
443 GST_ELEMENT_WARNING (rtpamrdepay, STREAM, DECODE,
444 (NULL), ("AMR RTP wrong length 2"));
455 gst_rtp_amr_depay_plugin_init (GstPlugin * plugin)
457 return gst_element_register (plugin, "rtpamrdepay",
458 GST_RANK_SECONDARY, GST_TYPE_RTP_AMR_DEPAY);