|
1 /* GStreamer |
|
2 * Copyright (C) <2007> Wim Taymans <wim@fluendo.com> |
|
3 * |
|
4 * gstrtcpbuffer.h: various helper functions to manipulate buffers |
|
5 * with RTCP payload. |
|
6 * |
|
7 * This library is free software; you can redistribute it and/or |
|
8 * modify it under the terms of the GNU Library General Public |
|
9 * License as published by the Free Software Foundation; either |
|
10 * version 2 of the License, or (at your option) any later version. |
|
11 * |
|
12 * This library is distributed in the hope that it will be useful, |
|
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|
15 * Library General Public License for more details. |
|
16 * |
|
17 * You should have received a copy of the GNU Library General Public |
|
18 * License along with this library; if not, write to the |
|
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
|
20 * Boston, MA 02111-1307, USA. |
|
21 */ |
|
22 |
|
23 #ifndef __GST_RTCPBUFFER_H__ |
|
24 #define __GST_RTCPBUFFER_H__ |
|
25 |
|
26 #include <gst/gst.h> |
|
27 |
|
28 G_BEGIN_DECLS |
|
29 |
|
30 /** |
|
31 * GST_RTCP_VERSION: |
|
32 * |
|
33 * The supported RTCP version 2. |
|
34 */ |
|
35 #define GST_RTCP_VERSION 2 |
|
36 |
|
37 /** |
|
38 * GstRTCPType: |
|
39 * @GST_RTCP_TYPE_INVALID: Invalid type |
|
40 * @GST_RTCP_TYPE_SR: Sender report |
|
41 * @GST_RTCP_TYPE_RR: Receiver report |
|
42 * @GST_RTCP_TYPE_SDES: Source description |
|
43 * @GST_RTCP_TYPE_BYE: Goodbye |
|
44 * @GST_RTCP_TYPE_APP: Application defined |
|
45 * |
|
46 * Different RTCP packet types. |
|
47 */ |
|
48 typedef enum |
|
49 { |
|
50 GST_RTCP_TYPE_INVALID = 0, |
|
51 GST_RTCP_TYPE_SR = 200, |
|
52 GST_RTCP_TYPE_RR = 201, |
|
53 GST_RTCP_TYPE_SDES = 202, |
|
54 GST_RTCP_TYPE_BYE = 203, |
|
55 GST_RTCP_TYPE_APP = 204 |
|
56 } GstRTCPType; |
|
57 |
|
58 /** |
|
59 * GstRTCPSDESType: |
|
60 * @GST_RTCP_SDES_INVALID: Invalid SDES entry |
|
61 * @GST_RTCP_SDES_END: End of SDES list |
|
62 * @GST_RTCP_SDES_CNAME: Canonical name |
|
63 * @GST_RTCP_SDES_NAME: User name |
|
64 * @GST_RTCP_SDES_EMAIL: User's electronic mail address |
|
65 * @GST_RTCP_SDES_PHONE: User's phone number |
|
66 * @GST_RTCP_SDES_LOC: Geographic user location |
|
67 * @GST_RTCP_SDES_TOOL: Name of application or tool |
|
68 * @GST_RTCP_SDES_NOTE: Notice about the source |
|
69 * @GST_RTCP_SDES_PRIV: Private extensions |
|
70 * |
|
71 * Different types of SDES content. |
|
72 */ |
|
73 typedef enum |
|
74 { |
|
75 GST_RTCP_SDES_INVALID = -1, |
|
76 GST_RTCP_SDES_END = 0, |
|
77 GST_RTCP_SDES_CNAME = 1, |
|
78 GST_RTCP_SDES_NAME = 2, |
|
79 GST_RTCP_SDES_EMAIL = 3, |
|
80 GST_RTCP_SDES_PHONE = 4, |
|
81 GST_RTCP_SDES_LOC = 5, |
|
82 GST_RTCP_SDES_TOOL = 6, |
|
83 GST_RTCP_SDES_NOTE = 7, |
|
84 GST_RTCP_SDES_PRIV = 8 |
|
85 } GstRTCPSDESType; |
|
86 |
|
87 /** |
|
88 * GST_RTCP_MAX_SDES: |
|
89 * |
|
90 * The maximum text length for an SDES item. |
|
91 */ |
|
92 #define GST_RTCP_MAX_SDES 255 |
|
93 |
|
94 /** |
|
95 * GST_RTCP_MAX_RB_COUNT: |
|
96 * |
|
97 * The maximum amount of Receiver report blocks in RR and SR messages. |
|
98 */ |
|
99 #define GST_RTCP_MAX_RB_COUNT 31 |
|
100 |
|
101 /** |
|
102 * GST_RTCP_MAX_SDES_ITEM_COUNT: |
|
103 * |
|
104 * The maximum amount of SDES items. |
|
105 */ |
|
106 #define GST_RTCP_MAX_SDES_ITEM_COUNT 31 |
|
107 |
|
108 /** |
|
109 * GST_RTCP_MAX_BYE_SSRC_COUNT: |
|
110 * |
|
111 * The maximum amount of SSRCs in a BYE packet. |
|
112 */ |
|
113 #define GST_RTCP_MAX_BYE_SSRC_COUNT 31 |
|
114 |
|
115 /** |
|
116 * GST_RTCP_VALID_MASK: |
|
117 * |
|
118 * Mask for version, padding bit and packet type pair |
|
119 */ |
|
120 #define GST_RTCP_VALID_MASK (0xc000 | 0x2000 | 0xfe) |
|
121 /** |
|
122 * GST_RTCP_VALID_VALUE: |
|
123 * |
|
124 * Valid value for the first two bytes of an RTCP packet after applying |
|
125 * #GST_RTCP_VALID_MASK to them. |
|
126 */ |
|
127 #define GST_RTCP_VALID_VALUE ((GST_RTCP_VERSION << 14) | GST_RTCP_TYPE_SR) |
|
128 |
|
129 typedef struct _GstRTCPPacket GstRTCPPacket; |
|
130 |
|
131 /** |
|
132 * GstRTCPPacket: |
|
133 * @buffer: pointer to RTCP buffer |
|
134 * @offset: offset of packet in buffer data |
|
135 * |
|
136 * Data structure that points to a packet at @offset in @buffer. |
|
137 * The size of the structure is made public to allow stack allocations. |
|
138 */ |
|
139 struct _GstRTCPPacket |
|
140 { |
|
141 GstBuffer *buffer; |
|
142 guint offset; |
|
143 |
|
144 /*< private >*/ |
|
145 gboolean padding; /* padding field of current packet */ |
|
146 guint8 count; /* count field of current packet */ |
|
147 GstRTCPType type; /* type of current packet */ |
|
148 guint16 length; /* length of current packet in 32-bits words */ |
|
149 |
|
150 guint item_offset; /* current item offset for navigating SDES */ |
|
151 guint item_count; /* current item count */ |
|
152 guint entry_offset; /* current entry offset for navigating SDES items */ |
|
153 }; |
|
154 |
|
155 /* creating buffers */ |
|
156 #ifdef __SYMBIAN32__ |
|
157 IMPORT_C |
|
158 #endif |
|
159 |
|
160 GstBuffer* gst_rtcp_buffer_new_take_data (gpointer data, guint len); |
|
161 #ifdef __SYMBIAN32__ |
|
162 IMPORT_C |
|
163 #endif |
|
164 |
|
165 GstBuffer* gst_rtcp_buffer_new_copy_data (gpointer data, guint len); |
|
166 #ifdef __SYMBIAN32__ |
|
167 IMPORT_C |
|
168 #endif |
|
169 |
|
170 |
|
171 gboolean gst_rtcp_buffer_validate_data (guint8 *data, guint len); |
|
172 #ifdef __SYMBIAN32__ |
|
173 IMPORT_C |
|
174 #endif |
|
175 |
|
176 gboolean gst_rtcp_buffer_validate (GstBuffer *buffer); |
|
177 #ifdef __SYMBIAN32__ |
|
178 IMPORT_C |
|
179 #endif |
|
180 |
|
181 |
|
182 GstBuffer* gst_rtcp_buffer_new (guint mtu); |
|
183 #ifdef __SYMBIAN32__ |
|
184 IMPORT_C |
|
185 #endif |
|
186 |
|
187 void gst_rtcp_buffer_end (GstBuffer *buffer); |
|
188 |
|
189 /* adding/retrieving packets */ |
|
190 #ifdef __SYMBIAN32__ |
|
191 IMPORT_C |
|
192 #endif |
|
193 |
|
194 guint gst_rtcp_buffer_get_packet_count (GstBuffer *buffer); |
|
195 #ifdef __SYMBIAN32__ |
|
196 IMPORT_C |
|
197 #endif |
|
198 |
|
199 gboolean gst_rtcp_buffer_get_first_packet (GstBuffer *buffer, GstRTCPPacket *packet); |
|
200 #ifdef __SYMBIAN32__ |
|
201 IMPORT_C |
|
202 #endif |
|
203 |
|
204 gboolean gst_rtcp_packet_move_to_next (GstRTCPPacket *packet); |
|
205 #ifdef __SYMBIAN32__ |
|
206 IMPORT_C |
|
207 #endif |
|
208 |
|
209 |
|
210 gboolean gst_rtcp_buffer_add_packet (GstBuffer *buffer, GstRTCPType type, |
|
211 GstRTCPPacket *packet); |
|
212 #ifdef __SYMBIAN32__ |
|
213 IMPORT_C |
|
214 #endif |
|
215 |
|
216 void gst_rtcp_packet_remove (GstRTCPPacket *packet); |
|
217 |
|
218 /* working with packets */ |
|
219 #ifdef __SYMBIAN32__ |
|
220 IMPORT_C |
|
221 #endif |
|
222 |
|
223 gboolean gst_rtcp_packet_get_padding (GstRTCPPacket *packet); |
|
224 #ifdef __SYMBIAN32__ |
|
225 IMPORT_C |
|
226 #endif |
|
227 |
|
228 guint8 gst_rtcp_packet_get_count (GstRTCPPacket *packet); |
|
229 #ifdef __SYMBIAN32__ |
|
230 IMPORT_C |
|
231 #endif |
|
232 |
|
233 GstRTCPType gst_rtcp_packet_get_type (GstRTCPPacket *packet); |
|
234 #ifdef __SYMBIAN32__ |
|
235 IMPORT_C |
|
236 #endif |
|
237 |
|
238 guint16 gst_rtcp_packet_get_length (GstRTCPPacket *packet); |
|
239 |
|
240 |
|
241 /* sender reports */ |
|
242 #ifdef __SYMBIAN32__ |
|
243 IMPORT_C |
|
244 #endif |
|
245 |
|
246 void gst_rtcp_packet_sr_get_sender_info (GstRTCPPacket *packet, guint32 *ssrc, |
|
247 guint64 *ntptime, guint32 *rtptime, |
|
248 guint32 *packet_count, guint32 *octet_count); |
|
249 #ifdef __SYMBIAN32__ |
|
250 IMPORT_C |
|
251 #endif |
|
252 |
|
253 void gst_rtcp_packet_sr_set_sender_info (GstRTCPPacket *packet, guint32 ssrc, |
|
254 guint64 ntptime, guint32 rtptime, |
|
255 guint32 packet_count, guint32 octet_count); |
|
256 /* receiver reports */ |
|
257 #ifdef __SYMBIAN32__ |
|
258 IMPORT_C |
|
259 #endif |
|
260 |
|
261 guint32 gst_rtcp_packet_rr_get_ssrc (GstRTCPPacket *packet); |
|
262 #ifdef __SYMBIAN32__ |
|
263 IMPORT_C |
|
264 #endif |
|
265 |
|
266 void gst_rtcp_packet_rr_set_ssrc (GstRTCPPacket *packet, guint32 ssrc); |
|
267 |
|
268 |
|
269 /* report blocks for SR and RR */ |
|
270 #ifdef __SYMBIAN32__ |
|
271 IMPORT_C |
|
272 #endif |
|
273 |
|
274 guint gst_rtcp_packet_get_rb_count (GstRTCPPacket *packet); |
|
275 #ifdef __SYMBIAN32__ |
|
276 IMPORT_C |
|
277 #endif |
|
278 |
|
279 void gst_rtcp_packet_get_rb (GstRTCPPacket *packet, guint nth, guint32 *ssrc, |
|
280 guint8 *fractionlost, gint32 *packetslost, |
|
281 guint32 *exthighestseq, guint32 *jitter, |
|
282 guint32 *lsr, guint32 *dlsr); |
|
283 #ifdef __SYMBIAN32__ |
|
284 IMPORT_C |
|
285 #endif |
|
286 |
|
287 gboolean gst_rtcp_packet_add_rb (GstRTCPPacket *packet, guint32 ssrc, |
|
288 guint8 fractionlost, gint32 packetslost, |
|
289 guint32 exthighestseq, guint32 jitter, |
|
290 guint32 lsr, guint32 dlsr); |
|
291 #ifdef __SYMBIAN32__ |
|
292 IMPORT_C |
|
293 #endif |
|
294 |
|
295 void gst_rtcp_packet_set_rb (GstRTCPPacket *packet, guint nth, guint32 ssrc, |
|
296 guint8 fractionlost, gint32 packetslost, |
|
297 guint32 exthighestseq, guint32 jitter, |
|
298 guint32 lsr, guint32 dlsr); |
|
299 |
|
300 /* source description packet */ |
|
301 #ifdef __SYMBIAN32__ |
|
302 IMPORT_C |
|
303 #endif |
|
304 |
|
305 guint gst_rtcp_packet_sdes_get_item_count (GstRTCPPacket *packet); |
|
306 #ifdef __SYMBIAN32__ |
|
307 IMPORT_C |
|
308 #endif |
|
309 |
|
310 gboolean gst_rtcp_packet_sdes_first_item (GstRTCPPacket *packet); |
|
311 #ifdef __SYMBIAN32__ |
|
312 IMPORT_C |
|
313 #endif |
|
314 |
|
315 gboolean gst_rtcp_packet_sdes_next_item (GstRTCPPacket *packet); |
|
316 #ifdef __SYMBIAN32__ |
|
317 IMPORT_C |
|
318 #endif |
|
319 |
|
320 guint32 gst_rtcp_packet_sdes_get_ssrc (GstRTCPPacket *packet); |
|
321 #ifdef __SYMBIAN32__ |
|
322 IMPORT_C |
|
323 #endif |
|
324 |
|
325 gboolean gst_rtcp_packet_sdes_first_entry (GstRTCPPacket *packet); |
|
326 #ifdef __SYMBIAN32__ |
|
327 IMPORT_C |
|
328 #endif |
|
329 |
|
330 gboolean gst_rtcp_packet_sdes_next_entry (GstRTCPPacket *packet); |
|
331 #ifdef __SYMBIAN32__ |
|
332 IMPORT_C |
|
333 #endif |
|
334 |
|
335 gboolean gst_rtcp_packet_sdes_get_entry (GstRTCPPacket *packet, |
|
336 GstRTCPSDESType *type, guint8 *len, |
|
337 guint8 **data); |
|
338 #ifdef __SYMBIAN32__ |
|
339 IMPORT_C |
|
340 #endif |
|
341 |
|
342 gboolean gst_rtcp_packet_sdes_copy_entry (GstRTCPPacket *packet, |
|
343 GstRTCPSDESType *type, guint8 *len, |
|
344 guint8 **data); |
|
345 #ifdef __SYMBIAN32__ |
|
346 IMPORT_C |
|
347 #endif |
|
348 |
|
349 |
|
350 gboolean gst_rtcp_packet_sdes_add_item (GstRTCPPacket *packet, guint32 ssrc); |
|
351 #ifdef __SYMBIAN32__ |
|
352 IMPORT_C |
|
353 #endif |
|
354 |
|
355 gboolean gst_rtcp_packet_sdes_add_entry (GstRTCPPacket *packet, GstRTCPSDESType type, |
|
356 guint8 len, const guint8 *data); |
|
357 |
|
358 /* bye packet */ |
|
359 #ifdef __SYMBIAN32__ |
|
360 IMPORT_C |
|
361 #endif |
|
362 |
|
363 guint gst_rtcp_packet_bye_get_ssrc_count (GstRTCPPacket *packet); |
|
364 #ifdef __SYMBIAN32__ |
|
365 IMPORT_C |
|
366 #endif |
|
367 |
|
368 guint32 gst_rtcp_packet_bye_get_nth_ssrc (GstRTCPPacket *packet, guint nth); |
|
369 #ifdef __SYMBIAN32__ |
|
370 IMPORT_C |
|
371 #endif |
|
372 |
|
373 gboolean gst_rtcp_packet_bye_add_ssrc (GstRTCPPacket *packet, guint32 ssrc); |
|
374 #ifdef __SYMBIAN32__ |
|
375 IMPORT_C |
|
376 #endif |
|
377 |
|
378 gboolean gst_rtcp_packet_bye_add_ssrcs (GstRTCPPacket *packet, guint32 *ssrc, guint len); |
|
379 #ifdef __SYMBIAN32__ |
|
380 IMPORT_C |
|
381 #endif |
|
382 |
|
383 guint8 gst_rtcp_packet_bye_get_reason_len (GstRTCPPacket *packet); |
|
384 #ifdef __SYMBIAN32__ |
|
385 IMPORT_C |
|
386 #endif |
|
387 |
|
388 gchar* gst_rtcp_packet_bye_get_reason (GstRTCPPacket *packet); |
|
389 #ifdef __SYMBIAN32__ |
|
390 IMPORT_C |
|
391 #endif |
|
392 |
|
393 gboolean gst_rtcp_packet_bye_set_reason (GstRTCPPacket *packet, const gchar *reason); |
|
394 |
|
395 /* helper functions */ |
|
396 #ifdef __SYMBIAN32__ |
|
397 IMPORT_C |
|
398 #endif |
|
399 |
|
400 guint64 gst_rtcp_ntp_to_unix (guint64 ntptime); |
|
401 #ifdef __SYMBIAN32__ |
|
402 IMPORT_C |
|
403 #endif |
|
404 |
|
405 guint64 gst_rtcp_unix_to_ntp (guint64 unixtime); |
|
406 |
|
407 G_END_DECLS |
|
408 |
|
409 #endif /* __GST_RTCPBUFFER_H__ */ |
|
410 |