2 * Copyright (C) <2005> Philippe Khalaf <burger@speedy.org>
3 * <2005> Wim Taymans <wim@fluendo.com>
5 * gstrtpbuffer.h: various helper functions to manipulate buffers
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
24 #ifndef __GST_RTPBUFFER_H__
25 #define __GST_RTPBUFFER_H__
28 #include <gst/rtp/gstrtppayloads.h>
35 * The supported RTP version 2.
37 #define GST_RTP_VERSION 2
40 typedef struct _GstRTPBuffer GstRTPBuffer;
44 * @buffer: pointer to RTP buffer
45 * @state: internal state
46 * @n_map: number of mappings in @map
47 * @map: array of #GstMapInfo
49 * Data structure that points to an RTP packet.
50 * The size of the structure is made public to allow stack allocations.
60 #define GST_RTP_BUFFER_INIT { NULL, { GST_MAP_INFO_INIT, GST_MAP_INFO_INIT, \
61 GST_MAP_INFO_INIT, GST_MAP_INFO_INIT} }
63 /* creating buffers */
64 void gst_rtp_buffer_allocate_data (GstBuffer *buffer, guint payload_len,
65 guint8 pad_len, guint8 csrc_count);
67 GstBuffer* gst_rtp_buffer_new_take_data (gpointer data, gsize len);
68 GstBuffer* gst_rtp_buffer_new_copy_data (gpointer data, gsize len);
69 GstBuffer* gst_rtp_buffer_new_allocate (guint payload_len, guint8 pad_len, guint8 csrc_count);
70 GstBuffer* gst_rtp_buffer_new_allocate_len (guint packet_len, guint8 pad_len, guint8 csrc_count);
72 guint gst_rtp_buffer_calc_header_len (guint8 csrc_count);
73 guint gst_rtp_buffer_calc_packet_len (guint payload_len, guint8 pad_len, guint8 csrc_count);
74 guint gst_rtp_buffer_calc_payload_len (guint packet_len, guint8 pad_len, guint8 csrc_count);
76 gboolean gst_rtp_buffer_validate_data (guint8 *data, gsize len);
77 gboolean gst_rtp_buffer_validate (GstBuffer *buffer);
80 gboolean gst_rtp_buffer_map (GstBuffer *buffer, GstMapFlags flags, GstRTPBuffer *rtp);
81 gboolean gst_rtp_buffer_unmap (GstRTPBuffer *rtp);
83 void gst_rtp_buffer_set_packet_len (GstRTPBuffer *rtp, guint len);
84 guint gst_rtp_buffer_get_packet_len (GstRTPBuffer *rtp);
86 guint gst_rtp_buffer_get_header_len (GstRTPBuffer *rtp);
88 guint8 gst_rtp_buffer_get_version (GstRTPBuffer *rtp);
89 void gst_rtp_buffer_set_version (GstRTPBuffer *rtp, guint8 version);
91 gboolean gst_rtp_buffer_get_padding (GstRTPBuffer *rtp);
92 void gst_rtp_buffer_set_padding (GstRTPBuffer *rtp, gboolean padding);
93 void gst_rtp_buffer_pad_to (GstRTPBuffer *rtp, guint len);
95 gboolean gst_rtp_buffer_get_extension (GstRTPBuffer *rtp);
96 void gst_rtp_buffer_set_extension (GstRTPBuffer *rtp, gboolean extension);
97 gboolean gst_rtp_buffer_get_extension_data (GstRTPBuffer *rtp, guint16 *bits,
98 gpointer *data, guint *wordlen);
99 gboolean gst_rtp_buffer_set_extension_data (GstRTPBuffer *rtp, guint16 bits, guint16 length);
101 guint32 gst_rtp_buffer_get_ssrc (GstRTPBuffer *rtp);
102 void gst_rtp_buffer_set_ssrc (GstRTPBuffer *rtp, guint32 ssrc);
104 guint8 gst_rtp_buffer_get_csrc_count (GstRTPBuffer *rtp);
105 guint32 gst_rtp_buffer_get_csrc (GstRTPBuffer *rtp, guint8 idx);
106 void gst_rtp_buffer_set_csrc (GstRTPBuffer *rtp, guint8 idx, guint32 csrc);
108 gboolean gst_rtp_buffer_get_marker (GstRTPBuffer *rtp);
109 void gst_rtp_buffer_set_marker (GstRTPBuffer *rtp, gboolean marker);
111 guint8 gst_rtp_buffer_get_payload_type (GstRTPBuffer *rtp);
112 void gst_rtp_buffer_set_payload_type (GstRTPBuffer *rtp, guint8 payload_type);
114 guint16 gst_rtp_buffer_get_seq (GstRTPBuffer *rtp);
115 void gst_rtp_buffer_set_seq (GstRTPBuffer *rtp, guint16 seq);
117 guint32 gst_rtp_buffer_get_timestamp (GstRTPBuffer *rtp);
118 void gst_rtp_buffer_set_timestamp (GstRTPBuffer *rtp, guint32 timestamp);
120 GstBuffer* gst_rtp_buffer_get_payload_buffer (GstRTPBuffer *rtp);
121 GstBuffer* gst_rtp_buffer_get_payload_subbuffer (GstRTPBuffer *rtp, guint offset, guint len);
123 guint gst_rtp_buffer_get_payload_len (GstRTPBuffer *rtp);
124 gpointer gst_rtp_buffer_get_payload (GstRTPBuffer *rtp);
127 guint32 gst_rtp_buffer_default_clock_rate (guint8 payload_type);
128 gint gst_rtp_buffer_compare_seqnum (guint16 seqnum1, guint16 seqnum2);
129 guint64 gst_rtp_buffer_ext_timestamp (guint64 *exttimestamp, guint32 timestamp);
131 gboolean gst_rtp_buffer_get_extension_onebyte_header (GstRTPBuffer *rtp,
136 gboolean gst_rtp_buffer_get_extension_twobytes_header (GstRTPBuffer *rtp,
143 gboolean gst_rtp_buffer_add_extension_onebyte_header (GstRTPBuffer *rtp,
147 gboolean gst_rtp_buffer_add_extension_twobytes_header (GstRTPBuffer *rtp,
156 #endif /* __GST_RTPBUFFER_H__ */