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 (GstRTPBaseDepayload * depayload,
111 static GstBuffer *gst_rtp_amr_depay_process (GstRTPBaseDepayload * depayload,
114 #define gst_rtp_amr_depay_parent_class parent_class
115 G_DEFINE_TYPE (GstRtpAMRDepay, gst_rtp_amr_depay, GST_TYPE_RTP_BASE_DEPAYLOAD);
118 gst_rtp_amr_depay_class_init (GstRtpAMRDepayClass * klass)
120 GstElementClass *gstelement_class;
121 GstRTPBaseDepayloadClass *gstrtpbasedepayload_class;
123 gstelement_class = (GstElementClass *) klass;
124 gstrtpbasedepayload_class = (GstRTPBaseDepayloadClass *) klass;
126 gst_element_class_add_pad_template (gstelement_class,
127 gst_static_pad_template_get (&gst_rtp_amr_depay_src_template));
128 gst_element_class_add_pad_template (gstelement_class,
129 gst_static_pad_template_get (&gst_rtp_amr_depay_sink_template));
131 gst_element_class_set_details_simple (gstelement_class, "RTP AMR depayloader",
132 "Codec/Depayloader/Network/RTP",
133 "Extracts AMR or AMR-WB audio from RTP packets (RFC 3267)",
134 "Wim Taymans <wim.taymans@gmail.com>");
136 gstrtpbasedepayload_class->process = gst_rtp_amr_depay_process;
137 gstrtpbasedepayload_class->set_caps = gst_rtp_amr_depay_setcaps;
139 GST_DEBUG_CATEGORY_INIT (rtpamrdepay_debug, "rtpamrdepay", 0,
140 "AMR/AMR-WB RTP Depayloader");
144 gst_rtp_amr_depay_init (GstRtpAMRDepay * rtpamrdepay)
146 GstRTPBaseDepayload *depayload;
148 depayload = GST_RTP_BASE_DEPAYLOAD (rtpamrdepay);
150 gst_pad_use_fixed_caps (GST_RTP_BASE_DEPAYLOAD_SRCPAD (depayload));
154 gst_rtp_amr_depay_setcaps (GstRTPBaseDepayload * depayload, GstCaps * caps)
156 GstStructure *structure;
158 GstRtpAMRDepay *rtpamrdepay;
160 const gchar *str, *type;
161 gint clock_rate, need_clock_rate;
164 rtpamrdepay = GST_RTP_AMR_DEPAY (depayload);
166 structure = gst_caps_get_structure (caps, 0);
168 /* figure out the mode first and set the clock rates */
169 if ((str = gst_structure_get_string (structure, "encoding-name"))) {
170 if (strcmp (str, "AMR") == 0) {
171 rtpamrdepay->mode = GST_RTP_AMR_DP_MODE_NB;
172 need_clock_rate = 8000;
174 } else if (strcmp (str, "AMR-WB") == 0) {
175 rtpamrdepay->mode = GST_RTP_AMR_DP_MODE_WB;
176 need_clock_rate = 16000;
177 type = "audio/AMR-WB";
183 if (!(str = gst_structure_get_string (structure, "octet-align")))
184 rtpamrdepay->octet_align = FALSE;
186 rtpamrdepay->octet_align = (atoi (str) == 1);
188 if (!(str = gst_structure_get_string (structure, "crc")))
189 rtpamrdepay->crc = FALSE;
191 rtpamrdepay->crc = (atoi (str) == 1);
193 if (rtpamrdepay->crc) {
194 /* crc mode implies octet aligned mode */
195 rtpamrdepay->octet_align = TRUE;
198 if (!(str = gst_structure_get_string (structure, "robust-sorting")))
199 rtpamrdepay->robust_sorting = FALSE;
201 rtpamrdepay->robust_sorting = (atoi (str) == 1);
203 if (rtpamrdepay->robust_sorting) {
204 /* robust_sorting mode implies octet aligned mode */
205 rtpamrdepay->octet_align = TRUE;
208 if (!(str = gst_structure_get_string (structure, "interleaving")))
209 rtpamrdepay->interleaving = FALSE;
211 rtpamrdepay->interleaving = (atoi (str) == 1);
213 if (rtpamrdepay->interleaving) {
214 /* interleaving mode implies octet aligned mode */
215 rtpamrdepay->octet_align = TRUE;
218 if (!(params = gst_structure_get_string (structure, "encoding-params")))
219 rtpamrdepay->channels = 1;
221 rtpamrdepay->channels = atoi (params);
224 if (!gst_structure_get_int (structure, "clock-rate", &clock_rate))
225 clock_rate = need_clock_rate;
226 depayload->clock_rate = clock_rate;
228 /* we require 1 channel, 8000 Hz, octet aligned, no CRC,
229 * no robust sorting, no interleaving for now */
230 if (rtpamrdepay->channels != 1)
232 if (clock_rate != need_clock_rate)
234 if (rtpamrdepay->octet_align != TRUE)
236 if (rtpamrdepay->robust_sorting != FALSE)
238 if (rtpamrdepay->interleaving != FALSE)
241 srccaps = gst_caps_new_simple (type,
242 "channels", G_TYPE_INT, rtpamrdepay->channels,
243 "rate", G_TYPE_INT, clock_rate, NULL);
244 res = gst_pad_set_caps (GST_RTP_BASE_DEPAYLOAD_SRCPAD (depayload), srccaps);
245 gst_caps_unref (srccaps);
252 GST_ERROR_OBJECT (rtpamrdepay, "invalid encoding-name");
258 static const gint nb_frame_size[16] = {
259 12, 13, 15, 17, 19, 20, 26, 31,
260 5, -1, -1, -1, -1, -1, -1, 0
263 static const gint wb_frame_size[16] = {
264 17, 23, 32, 36, 40, 46, 50, 58,
265 60, 5, -1, -1, -1, -1, -1, 0
269 gst_rtp_amr_depay_process (GstRTPBaseDepayload * depayload, GstBuffer * buf)
271 GstRtpAMRDepay *rtpamrdepay;
272 const gint *frame_size;
273 GstBuffer *outbuf = NULL;
275 GstRTPBuffer rtp = { NULL };
279 rtpamrdepay = GST_RTP_AMR_DEPAY (depayload);
281 /* setup frame size pointer */
282 if (rtpamrdepay->mode == GST_RTP_AMR_DP_MODE_NB)
283 frame_size = nb_frame_size;
285 frame_size = wb_frame_size;
287 gst_rtp_buffer_map (buf, GST_MAP_READ, &rtp);
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;
293 gint i, num_packets, num_nonempty_packets;
297 payload_len = gst_rtp_buffer_get_payload_len (&rtp);
299 /* need at least 2 bytes for the header */
303 payload = gst_rtp_buffer_get_payload (&rtp);
305 /* depay CMR. The CMR is used by the sender to request
306 * a new encoding mode.
313 /* CMR = (payload[0] & 0xf0) >> 4; */
315 /* strip CMR header now, pack FT and the data for the decoder */
319 GST_DEBUG_OBJECT (rtpamrdepay, "payload len %d", payload_len);
321 if (rtpamrdepay->interleaving) {
322 ILL = (payload[0] & 0xf0) >> 4;
323 ILP = (payload[0] & 0x0f);
329 goto wrong_interleaving;
333 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6
334 * +-+-+-+-+-+-+-+-+..
335 * |F| FT |Q|P|P| more FT..
336 * +-+-+-+-+-+-+-+-+..
338 /* count number of packets by counting the FTs. Also
339 * count number of amr data bytes and number of non-empty
340 * packets (this is also the number of CRCs if present). */
342 num_nonempty_packets = 0;
344 for (i = 0; i < payload_len; i++) {
348 FT = (payload[i] & 0x78) >> 3;
350 fr_size = frame_size[FT];
351 GST_DEBUG_OBJECT (rtpamrdepay, "frame size %d", fr_size);
353 goto wrong_framesize;
357 num_nonempty_packets++;
361 if ((payload[i] & 0x80) == 0)
365 if (rtpamrdepay->crc) {
366 /* data len + CRC len + header bytes should be smaller than payload_len */
367 if (num_packets + num_nonempty_packets + amr_len > payload_len)
370 /* data len + header bytes should be smaller than payload_len */
371 if (num_packets + amr_len > payload_len)
375 outbuf = gst_buffer_new_and_alloc (payload_len);
377 /* point to destination */
378 odata = gst_buffer_map (outbuf, &osize, NULL, GST_MAP_WRITE);
380 /* point to first data packet */
382 dp = payload + num_packets;
383 if (rtpamrdepay->crc) {
384 /* skip CRC if present */
385 dp += num_nonempty_packets;
388 for (i = 0; i < num_packets; i++) {
391 /* copy FT, clear F bit */
392 *p++ = payload[i] & 0x7f;
394 fr_size = frame_size[(payload[i] & 0x78) >> 3];
396 /* copy data packet, FIXME, calc CRC here. */
397 memcpy (p, dp, fr_size);
403 gst_buffer_unmap (outbuf, odata, osize);
405 /* we can set the duration because each packet is 20 milliseconds */
406 GST_BUFFER_DURATION (outbuf) = num_packets * 20 * GST_MSECOND;
408 if (gst_rtp_buffer_get_marker (&rtp)) {
409 /* marker bit marks a discont buffer after a talkspurt. */
410 GST_DEBUG_OBJECT (depayload, "marker bit was set");
411 GST_BUFFER_FLAG_SET (outbuf, GST_BUFFER_FLAG_DISCONT);
414 GST_DEBUG_OBJECT (depayload, "pushing buffer of size %" G_GSIZE_FORMAT,
415 gst_buffer_get_size (outbuf));
422 GST_ELEMENT_WARNING (rtpamrdepay, STREAM, DECODE,
423 (NULL), ("AMR RTP payload too small (%d)", payload_len));
428 GST_ELEMENT_WARNING (rtpamrdepay, STREAM, DECODE,
429 (NULL), ("AMR RTP wrong interleaving"));
434 GST_ELEMENT_WARNING (rtpamrdepay, STREAM, DECODE,
435 (NULL), ("AMR RTP frame size == -1"));
440 GST_ELEMENT_WARNING (rtpamrdepay, STREAM, DECODE,
441 (NULL), ("AMR RTP wrong length 1"));
446 GST_ELEMENT_WARNING (rtpamrdepay, STREAM, DECODE,
447 (NULL), ("AMR RTP wrong length 2"));
458 gst_rtp_amr_depay_plugin_init (GstPlugin * plugin)
460 return gst_element_register (plugin, "rtpamrdepay",
461 GST_RANK_SECONDARY, GST_TYPE_RTP_AMR_DEPAY);