2 * Copyright (C) <2007> Nokia Corporation
3 * Copyright (C) <2007> Collabora Ltd
4 * @author: Olivier Crete <olivier.crete@collabora.co.uk>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
19 * Boston, MA 02110-1301, USA.
23 * This payloader assumes that the data will ALWAYS come as zero or more
24 * 10 bytes frame of audio followed by 0 or 1 2 byte frame of silence.
25 * Any other buffer format won't work
33 #include <gst/rtp/gstrtpbuffer.h>
34 #include <gst/base/gstadapter.h>
35 #include <gst/audio/audio.h>
37 #include "gstrtpg729pay.h"
38 #include "gstrtputils.h"
40 GST_DEBUG_CATEGORY_STATIC (rtpg729pay_debug);
41 #define GST_CAT_DEFAULT (rtpg729pay_debug)
43 #define G729_FRAME_SIZE 10
44 #define G729B_CN_FRAME_SIZE 2
45 #define G729_FRAME_DURATION (10 * GST_MSECOND)
46 #define G729_FRAME_DURATION_MS (10)
49 gst_rtp_g729_pay_set_caps (GstRTPBasePayload * payload, GstCaps * caps);
51 gst_rtp_g729_pay_handle_buffer (GstRTPBasePayload * payload, GstBuffer * buf);
53 static GstStateChangeReturn
54 gst_rtp_g729_pay_change_state (GstElement * element, GstStateChange transition);
56 static GstStaticPadTemplate gst_rtp_g729_pay_sink_template =
57 GST_STATIC_PAD_TEMPLATE ("sink",
60 GST_STATIC_CAPS ("audio/G729, " /* according to RFC 3555 */
61 "channels = (int) 1, " "rate = (int) 8000")
64 static GstStaticPadTemplate gst_rtp_g729_pay_src_template =
65 GST_STATIC_PAD_TEMPLATE ("src",
68 GST_STATIC_CAPS ("application/x-rtp, "
69 "media = (string) \"audio\", "
70 "payload = (int) " GST_RTP_PAYLOAD_G729_STRING ", "
71 "clock-rate = (int) 8000, "
72 "encoding-name = (string) \"G729\"; "
74 "media = (string) \"audio\", "
75 "payload = (int) " GST_RTP_PAYLOAD_DYNAMIC_STRING ", "
76 "clock-rate = (int) 8000, " "encoding-name = (string) \"G729\"")
79 #define gst_rtp_g729_pay_parent_class parent_class
80 G_DEFINE_TYPE (GstRTPG729Pay, gst_rtp_g729_pay, GST_TYPE_RTP_BASE_PAYLOAD);
83 gst_rtp_g729_pay_finalize (GObject * object)
85 GstRTPG729Pay *pay = GST_RTP_G729_PAY (object);
87 g_object_unref (pay->adapter);
89 G_OBJECT_CLASS (parent_class)->finalize (object);
93 gst_rtp_g729_pay_class_init (GstRTPG729PayClass * klass)
95 GObjectClass *gobject_class = (GObjectClass *) klass;
96 GstElementClass *gstelement_class = (GstElementClass *) klass;
97 GstRTPBasePayloadClass *payload_class = GST_RTP_BASE_PAYLOAD_CLASS (klass);
99 GST_DEBUG_CATEGORY_INIT (rtpg729pay_debug, "rtpg729pay", 0,
100 "G.729 RTP Payloader");
102 gobject_class->finalize = gst_rtp_g729_pay_finalize;
104 gstelement_class->change_state = gst_rtp_g729_pay_change_state;
106 gst_element_class_add_static_pad_template (gstelement_class,
107 &gst_rtp_g729_pay_sink_template);
108 gst_element_class_add_static_pad_template (gstelement_class,
109 &gst_rtp_g729_pay_src_template);
111 gst_element_class_set_static_metadata (gstelement_class,
112 "RTP G.729 payloader", "Codec/Payloader/Network/RTP",
113 "Packetize G.729 audio into RTP packets",
114 "Olivier Crete <olivier.crete@collabora.co.uk>");
116 payload_class->set_caps = gst_rtp_g729_pay_set_caps;
117 payload_class->handle_buffer = gst_rtp_g729_pay_handle_buffer;
121 gst_rtp_g729_pay_init (GstRTPG729Pay * pay)
123 GstRTPBasePayload *payload = GST_RTP_BASE_PAYLOAD (pay);
125 payload->pt = GST_RTP_PAYLOAD_G729;
127 pay->adapter = gst_adapter_new ();
131 gst_rtp_g729_pay_reset (GstRTPG729Pay * pay)
133 gst_adapter_clear (pay->adapter);
134 pay->discont = FALSE;
135 pay->next_rtp_time = 0;
136 pay->first_ts = GST_CLOCK_TIME_NONE;
137 pay->first_rtp_time = 0;
141 gst_rtp_g729_pay_set_caps (GstRTPBasePayload * payload, GstCaps * caps)
145 gst_rtp_base_payload_set_options (payload, "audio",
146 payload->pt != GST_RTP_PAYLOAD_G729, "G729", 8000);
148 res = gst_rtp_base_payload_set_outcaps (payload, NULL);
154 gst_rtp_g729_pay_push (GstRTPG729Pay * rtpg729pay, GstBuffer * buf)
156 GstRTPBasePayload *basepayload;
157 GstClockTime duration;
161 GstRTPBuffer rtp = { NULL };
162 guint payload_len = gst_buffer_get_size (buf);
164 basepayload = GST_RTP_BASE_PAYLOAD (rtpg729pay);
166 GST_DEBUG_OBJECT (rtpg729pay, "Pushing %d bytes ts %" GST_TIME_FORMAT,
167 payload_len, GST_TIME_ARGS (rtpg729pay->next_ts));
169 /* create buffer to hold the payload */
170 outbuf = gst_rtp_buffer_new_allocate (0, 0, 0);
172 gst_rtp_buffer_map (outbuf, GST_MAP_READWRITE, &rtp);
176 (payload_len / G729_FRAME_SIZE) + ((payload_len % G729_FRAME_SIZE) >> 1);
177 duration = frames * G729_FRAME_DURATION;
178 GST_BUFFER_PTS (outbuf) = rtpg729pay->next_ts;
179 GST_BUFFER_DURATION (outbuf) = duration;
180 GST_BUFFER_OFFSET (outbuf) = rtpg729pay->next_rtp_time;
181 rtpg729pay->next_ts += duration;
182 rtpg729pay->next_rtp_time += frames * 80;
184 if (G_UNLIKELY (rtpg729pay->discont)) {
185 GST_DEBUG_OBJECT (basepayload, "discont, setting marker bit");
186 GST_BUFFER_FLAG_SET (outbuf, GST_BUFFER_FLAG_DISCONT);
187 gst_rtp_buffer_set_marker (&rtp, TRUE);
188 rtpg729pay->discont = FALSE;
190 gst_rtp_buffer_unmap (&rtp);
193 gst_rtp_copy_meta (GST_ELEMENT_CAST (basepayload), outbuf, buf,
194 g_quark_from_static_string (GST_META_TAG_AUDIO_STR));
195 outbuf = gst_buffer_append (outbuf, buf);
197 ret = gst_rtp_base_payload_push (basepayload, outbuf);
203 gst_rtp_g729_pay_recalc_rtp_time (GstRTPG729Pay * rtpg729pay, GstClockTime time)
205 if (GST_CLOCK_TIME_IS_VALID (rtpg729pay->first_ts)
206 && GST_CLOCK_TIME_IS_VALID (time) && time >= rtpg729pay->first_ts) {
210 diff = time - rtpg729pay->first_ts;
211 rtpdiff = (diff / GST_MSECOND) * 8;
212 rtpg729pay->next_rtp_time = rtpg729pay->first_rtp_time + rtpdiff;
213 GST_DEBUG_OBJECT (rtpg729pay,
214 "elapsed time %" GST_TIME_FORMAT ", rtp %" G_GUINT32_FORMAT ", "
215 "new offset %" G_GUINT32_FORMAT, GST_TIME_ARGS (diff), rtpdiff,
216 rtpg729pay->next_rtp_time);
221 gst_rtp_g729_pay_handle_buffer (GstRTPBasePayload * payload, GstBuffer * buf)
223 GstFlowReturn ret = GST_FLOW_OK;
224 GstRTPG729Pay *rtpg729pay = GST_RTP_G729_PAY (payload);
225 GstAdapter *adapter = NULL;
228 guint maxptime_octets = G_MAXUINT;
229 guint minptime_octets = 0;
230 guint min_payload_len;
231 guint max_payload_len;
233 GstClockTime timestamp;
235 size = gst_buffer_get_size (buf);
237 if (size % G729_FRAME_SIZE != 0 &&
238 size % G729_FRAME_SIZE != G729B_CN_FRAME_SIZE)
241 /* max number of bytes based on given ptime, has to be multiple of
243 if (payload->max_ptime != -1) {
244 guint ptime_ms = payload->max_ptime / GST_MSECOND;
246 maxptime_octets = G729_FRAME_SIZE *
247 (int) (ptime_ms / G729_FRAME_DURATION_MS);
249 if (maxptime_octets < G729_FRAME_SIZE) {
250 GST_WARNING_OBJECT (payload, "Given ptime %" G_GINT64_FORMAT
251 " is smaller than minimum %d ns, overwriting to minimum",
252 payload->max_ptime, G729_FRAME_DURATION_MS);
253 maxptime_octets = G729_FRAME_SIZE;
257 max_payload_len = MIN (
259 (int) (gst_rtp_buffer_calc_payload_len (GST_RTP_BASE_PAYLOAD_MTU
260 (payload), 0, 0) / G729_FRAME_SIZE)
265 /* min number of bytes based on a given ptime, has to be a multiple
268 guint64 min_ptime = payload->min_ptime;
270 min_ptime = min_ptime / GST_MSECOND;
271 minptime_octets = G729_FRAME_SIZE *
272 (int) (min_ptime / G729_FRAME_DURATION_MS);
275 min_payload_len = MAX (minptime_octets, G729_FRAME_SIZE);
277 if (min_payload_len > max_payload_len) {
278 min_payload_len = max_payload_len;
281 /* If the ptime is specified in the caps, tried to adhere to it exactly */
282 if (payload->ptime) {
283 guint64 ptime = payload->ptime / GST_MSECOND;
284 guint ptime_in_bytes = G729_FRAME_SIZE *
285 (guint) (ptime / G729_FRAME_DURATION_MS);
287 /* clip to computed min and max lengths */
288 ptime_in_bytes = MAX (min_payload_len, ptime_in_bytes);
289 ptime_in_bytes = MIN (max_payload_len, ptime_in_bytes);
291 min_payload_len = max_payload_len = ptime_in_bytes;
294 GST_LOG_OBJECT (payload,
295 "Calculated min_payload_len %u and max_payload_len %u",
296 min_payload_len, max_payload_len);
298 adapter = rtpg729pay->adapter;
299 available = gst_adapter_available (adapter);
301 timestamp = GST_BUFFER_PTS (buf);
303 /* resync rtp time on discont or a discontinuous cn packet */
304 if (GST_BUFFER_IS_DISCONT (buf)) {
305 /* flush remainder */
307 gst_rtp_g729_pay_push (rtpg729pay,
308 gst_adapter_take_buffer_fast (adapter, available));
311 rtpg729pay->discont = TRUE;
312 gst_rtp_g729_pay_recalc_rtp_time (rtpg729pay, timestamp);
315 if (size < G729_FRAME_SIZE)
316 gst_rtp_g729_pay_recalc_rtp_time (rtpg729pay, timestamp);
318 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (rtpg729pay->first_ts))) {
319 rtpg729pay->first_ts = timestamp;
320 rtpg729pay->first_rtp_time = rtpg729pay->next_rtp_time;
323 /* let's reset the base timestamp when the adapter is empty */
325 rtpg729pay->next_ts = timestamp;
327 if (available == 0 && size >= min_payload_len && size <= max_payload_len) {
328 ret = gst_rtp_g729_pay_push (rtpg729pay, buf);
332 gst_adapter_push (adapter, buf);
333 available = gst_adapter_available (adapter);
335 /* as long as we have full frames */
336 /* this loop will push all available buffers till the last frame */
337 while (available >= min_payload_len ||
338 available % G729_FRAME_SIZE == G729B_CN_FRAME_SIZE) {
339 /* We send as much as we can */
340 if (available <= max_payload_len) {
341 payload_len = available;
343 payload_len = MIN (max_payload_len,
344 (available / G729_FRAME_SIZE) * G729_FRAME_SIZE);
347 ret = gst_rtp_g729_pay_push (rtpg729pay,
348 gst_adapter_take_buffer_fast (adapter, payload_len));
349 available -= payload_len;
357 GST_ELEMENT_ERROR (payload, STREAM, WRONG_TYPE,
358 ("Invalid input buffer size"),
359 ("Invalid buffer size, should be a multiple of"
360 " G729_FRAME_SIZE(10) with an optional G729B_CN_FRAME_SIZE(2)"
361 " added to it, but it is %" G_GSIZE_FORMAT, size));
362 gst_buffer_unref (buf);
363 return GST_FLOW_ERROR;
367 static GstStateChangeReturn
368 gst_rtp_g729_pay_change_state (GstElement * element, GstStateChange transition)
370 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
372 /* handle upwards state changes here */
373 switch (transition) {
378 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
380 /* handle downwards state changes */
381 switch (transition) {
382 case GST_STATE_CHANGE_PAUSED_TO_READY:
383 gst_rtp_g729_pay_reset (GST_RTP_G729_PAY (element));
393 gst_rtp_g729_pay_plugin_init (GstPlugin * plugin)
395 return gst_element_register (plugin, "rtpg729pay",
396 GST_RANK_SECONDARY, GST_TYPE_RTP_G729_PAY);