gst/rtp/: Fix element descriptions.
[platform/upstream/gstreamer.git] / gst / rtp / gstrtph263ppay.c
1 /* GStreamer
2  * Copyright (C) <2005> Wim Taymans <wim@fluendo.com>
3  *
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.
8  *
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.
13  *
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.
18  */
19
20 #ifdef HAVE_CONFIG_H
21 #  include "config.h"
22 #endif
23
24 #include <string.h>
25
26 #include <gst/rtp/gstrtpbuffer.h>
27
28 #include "gstrtph263ppay.h"
29
30 /* elementfactory information */
31 static const GstElementDetails gst_rtp_h263ppay_details =
32 GST_ELEMENT_DETAILS ("RTP packet payloader",
33     "Codec/Payloader/Network",
34     "Payload-encodes H263+ video in RTP packets (RFC 2429)",
35     "Wim Taymans <wim@fluendo.com>");
36
37 static GstStaticPadTemplate gst_rtp_h263p_pay_sink_template =
38 GST_STATIC_PAD_TEMPLATE ("sink",
39     GST_PAD_SINK,
40     GST_PAD_ALWAYS,
41     GST_STATIC_CAPS ("video/x-h263")
42     );
43
44 static GstStaticPadTemplate gst_rtp_h263p_pay_src_template =
45 GST_STATIC_PAD_TEMPLATE ("src",
46     GST_PAD_SRC,
47     GST_PAD_ALWAYS,
48     GST_STATIC_CAPS ("application/x-rtp, "
49         "media = (string) \"video\", "
50         "payload = (int) [ 96, 127 ], "
51         "clock-rate = (int) 90000, " "encoding-name = (string) \"H263-1998\"")
52     );
53
54 static void gst_rtp_h263p_pay_class_init (GstRtpH263PPayClass * klass);
55 static void gst_rtp_h263p_pay_base_init (GstRtpH263PPayClass * klass);
56 static void gst_rtp_h263p_pay_init (GstRtpH263PPay * rtph263ppay);
57 static void gst_rtp_h263p_pay_finalize (GObject * object);
58
59 static gboolean gst_rtp_h263p_pay_setcaps (GstBaseRTPPayload * payload,
60     GstCaps * caps);
61 static GstFlowReturn gst_rtp_h263p_pay_handle_buffer (GstBaseRTPPayload *
62     payload, GstBuffer * buffer);
63
64 static GstBaseRTPPayloadClass *parent_class = NULL;
65
66 static GType
67 gst_rtp_h263p_pay_get_type (void)
68 {
69   static GType rtph263ppay_type = 0;
70
71   if (!rtph263ppay_type) {
72     static const GTypeInfo rtph263ppay_info = {
73       sizeof (GstRtpH263PPayClass),
74       (GBaseInitFunc) gst_rtp_h263p_pay_base_init,
75       NULL,
76       (GClassInitFunc) gst_rtp_h263p_pay_class_init,
77       NULL,
78       NULL,
79       sizeof (GstRtpH263PPay),
80       0,
81       (GInstanceInitFunc) gst_rtp_h263p_pay_init,
82     };
83
84     rtph263ppay_type =
85         g_type_register_static (GST_TYPE_BASE_RTP_PAYLOAD, "GstRtpH263PPay",
86         &rtph263ppay_info, 0);
87   }
88   return rtph263ppay_type;
89 }
90
91 static void
92 gst_rtp_h263p_pay_base_init (GstRtpH263PPayClass * klass)
93 {
94   GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
95
96   gst_element_class_add_pad_template (element_class,
97       gst_static_pad_template_get (&gst_rtp_h263p_pay_src_template));
98   gst_element_class_add_pad_template (element_class,
99       gst_static_pad_template_get (&gst_rtp_h263p_pay_sink_template));
100
101   gst_element_class_set_details (element_class, &gst_rtp_h263ppay_details);
102 }
103
104 static void
105 gst_rtp_h263p_pay_class_init (GstRtpH263PPayClass * klass)
106 {
107   GObjectClass *gobject_class;
108   GstElementClass *gstelement_class;
109   GstBaseRTPPayloadClass *gstbasertppayload_class;
110
111   gobject_class = (GObjectClass *) klass;
112   gstelement_class = (GstElementClass *) klass;
113   gstbasertppayload_class = (GstBaseRTPPayloadClass *) klass;
114
115   parent_class = g_type_class_peek_parent (klass);
116
117   gobject_class->finalize = gst_rtp_h263p_pay_finalize;
118
119   gstbasertppayload_class->set_caps = gst_rtp_h263p_pay_setcaps;
120   gstbasertppayload_class->handle_buffer = gst_rtp_h263p_pay_handle_buffer;
121 }
122
123 static void
124 gst_rtp_h263p_pay_init (GstRtpH263PPay * rtph263ppay)
125 {
126   rtph263ppay->adapter = gst_adapter_new ();
127 }
128
129 static void
130 gst_rtp_h263p_pay_finalize (GObject * object)
131 {
132   GstRtpH263PPay *rtph263ppay;
133
134   rtph263ppay = GST_RTP_H263P_PAY (object);
135
136   g_object_unref (rtph263ppay->adapter);
137   rtph263ppay->adapter = NULL;
138
139   G_OBJECT_CLASS (parent_class)->finalize (object);
140 }
141
142 static gboolean
143 gst_rtp_h263p_pay_setcaps (GstBaseRTPPayload * payload, GstCaps * caps)
144 {
145   gst_basertppayload_set_options (payload, "video", TRUE, "H263-1998", 90000);
146   gst_basertppayload_set_outcaps (payload, NULL);
147
148   return TRUE;
149 }
150
151
152 static GstFlowReturn
153 gst_rtp_h263p_pay_flush (GstRtpH263PPay * rtph263ppay)
154 {
155   guint avail;
156   GstBuffer *outbuf;
157   GstFlowReturn ret;
158   gboolean fragmented;
159
160   avail = gst_adapter_available (rtph263ppay->adapter);
161   if (avail == 0)
162     return GST_FLOW_OK;
163
164   fragmented = FALSE;
165
166   /* This algorithm assumes the H263+ encoder sends complete frames in each
167    * buffer */
168   /* This algorithm implements the Follow-on packets method for packetization.
169    * This assumes low packet loss network. A more resilient method would be to
170    * separate large frames at synchronisation points (Segments) (See RFC 2429
171    * section 6). It would be interesting to have a property such as network
172    * quality to select between both packetization methods */
173   /* TODO Add VRC supprt (See RFC 2429 section 4.2) */
174   while (avail > 0) {
175     guint towrite;
176     guint8 *payload;
177     guint8 *data;
178     guint payload_len;
179     gint header_len;
180
181     /* for picture start frames (non-fragmented), we need to remove the first
182      * two 0x00 bytes and set P=1 */
183     header_len = (fragmented ? 2 : 0);
184
185     towrite = MIN (avail, gst_rtp_buffer_calc_payload_len
186         (GST_BASE_RTP_PAYLOAD_MTU (rtph263ppay) - header_len, 0, 0));
187
188     payload_len = header_len + towrite;
189
190     outbuf = gst_rtp_buffer_new_allocate (payload_len, 0, 0);
191     /* last fragment gets the marker bit set */
192     gst_rtp_buffer_set_marker (outbuf, avail > towrite ? 0 : 1);
193
194     payload = gst_rtp_buffer_get_payload (outbuf);
195
196     data = (guint8 *) gst_adapter_peek (rtph263ppay->adapter, towrite);
197     memcpy (&payload[header_len], data, towrite);
198
199     /*  0                   1
200      *  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
201      * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
202      * |   RR    |P|V|   PLEN    |PEBIT|
203      * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
204      */
205     payload[0] = fragmented ? 0x00 : 0x04;
206     payload[1] = 0;
207
208     GST_BUFFER_TIMESTAMP (outbuf) = rtph263ppay->first_ts;
209     gst_adapter_flush (rtph263ppay->adapter, towrite);
210
211     ret = gst_basertppayload_push (GST_BASE_RTP_PAYLOAD (rtph263ppay), outbuf);
212
213     avail -= towrite;
214     fragmented = TRUE;
215   }
216
217   return ret;
218 }
219
220 static GstFlowReturn
221 gst_rtp_h263p_pay_handle_buffer (GstBaseRTPPayload * payload,
222     GstBuffer * buffer)
223 {
224   GstRtpH263PPay *rtph263ppay;
225   GstFlowReturn ret;
226   guint size;
227
228   rtph263ppay = GST_RTP_H263P_PAY (payload);
229
230   size = GST_BUFFER_SIZE (buffer);
231   rtph263ppay->first_ts = GST_BUFFER_TIMESTAMP (buffer);
232
233   /* we always encode and flush a full picture */
234   gst_adapter_push (rtph263ppay->adapter, buffer);
235   ret = gst_rtp_h263p_pay_flush (rtph263ppay);
236
237   return ret;
238 }
239
240 gboolean
241 gst_rtp_h263p_pay_plugin_init (GstPlugin * plugin)
242 {
243   return gst_element_register (plugin, "rtph263ppay",
244       GST_RANK_NONE, GST_TYPE_RTP_H263P_PAY);
245 }