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., 51 Franklin St, Fifth Floor,
21 * Boston, MA 02110-1301, 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 * @data: array of data
47 * @size: array of size
48 * @map: array of #GstMapInfo
50 * Data structure that points to an RTP packet.
51 * The size of the structure is made public to allow stack allocations.
62 #define GST_RTP_BUFFER_INIT { NULL, 0, { NULL, NULL, NULL, NULL}, { 0, 0, 0, 0 }, \
63 { GST_MAP_INFO_INIT, GST_MAP_INFO_INIT, GST_MAP_INFO_INIT, GST_MAP_INFO_INIT} }
65 /* creating buffers */
66 void gst_rtp_buffer_allocate_data (GstBuffer *buffer, guint payload_len,
67 guint8 pad_len, guint8 csrc_count);
69 GstBuffer* gst_rtp_buffer_new_take_data (gpointer data, gsize len);
70 GstBuffer* gst_rtp_buffer_new_copy_data (gpointer data, gsize len);
71 GstBuffer* gst_rtp_buffer_new_allocate (guint payload_len, guint8 pad_len, guint8 csrc_count);
72 GstBuffer* gst_rtp_buffer_new_allocate_len (guint packet_len, guint8 pad_len, guint8 csrc_count);
74 guint gst_rtp_buffer_calc_header_len (guint8 csrc_count);
75 guint gst_rtp_buffer_calc_packet_len (guint payload_len, guint8 pad_len, guint8 csrc_count);
76 guint gst_rtp_buffer_calc_payload_len (guint packet_len, guint8 pad_len, guint8 csrc_count);
78 gboolean gst_rtp_buffer_map (GstBuffer *buffer, GstMapFlags flags, GstRTPBuffer *rtp);
79 void gst_rtp_buffer_unmap (GstRTPBuffer *rtp);
81 void gst_rtp_buffer_set_packet_len (GstRTPBuffer *rtp, guint len);
82 guint gst_rtp_buffer_get_packet_len (GstRTPBuffer *rtp);
84 guint gst_rtp_buffer_get_header_len (GstRTPBuffer *rtp);
86 guint8 gst_rtp_buffer_get_version (GstRTPBuffer *rtp);
87 void gst_rtp_buffer_set_version (GstRTPBuffer *rtp, guint8 version);
89 gboolean gst_rtp_buffer_get_padding (GstRTPBuffer *rtp);
90 void gst_rtp_buffer_set_padding (GstRTPBuffer *rtp, gboolean padding);
91 void gst_rtp_buffer_pad_to (GstRTPBuffer *rtp, guint len);
93 gboolean gst_rtp_buffer_get_extension (GstRTPBuffer *rtp);
94 void gst_rtp_buffer_set_extension (GstRTPBuffer *rtp, gboolean extension);
95 gboolean gst_rtp_buffer_get_extension_data (GstRTPBuffer *rtp, guint16 *bits,
96 gpointer *data, guint *wordlen);
97 gboolean gst_rtp_buffer_set_extension_data (GstRTPBuffer *rtp, guint16 bits, guint16 length);
99 guint32 gst_rtp_buffer_get_ssrc (GstRTPBuffer *rtp);
100 void gst_rtp_buffer_set_ssrc (GstRTPBuffer *rtp, guint32 ssrc);
102 guint8 gst_rtp_buffer_get_csrc_count (GstRTPBuffer *rtp);
103 guint32 gst_rtp_buffer_get_csrc (GstRTPBuffer *rtp, guint8 idx);
104 void gst_rtp_buffer_set_csrc (GstRTPBuffer *rtp, guint8 idx, guint32 csrc);
106 gboolean gst_rtp_buffer_get_marker (GstRTPBuffer *rtp);
107 void gst_rtp_buffer_set_marker (GstRTPBuffer *rtp, gboolean marker);
109 guint8 gst_rtp_buffer_get_payload_type (GstRTPBuffer *rtp);
110 void gst_rtp_buffer_set_payload_type (GstRTPBuffer *rtp, guint8 payload_type);
112 guint16 gst_rtp_buffer_get_seq (GstRTPBuffer *rtp);
113 void gst_rtp_buffer_set_seq (GstRTPBuffer *rtp, guint16 seq);
115 guint32 gst_rtp_buffer_get_timestamp (GstRTPBuffer *rtp);
116 void gst_rtp_buffer_set_timestamp (GstRTPBuffer *rtp, guint32 timestamp);
118 GstBuffer* gst_rtp_buffer_get_payload_buffer (GstRTPBuffer *rtp);
119 GstBuffer* gst_rtp_buffer_get_payload_subbuffer (GstRTPBuffer *rtp, guint offset, guint len);
121 guint gst_rtp_buffer_get_payload_len (GstRTPBuffer *rtp);
122 gpointer gst_rtp_buffer_get_payload (GstRTPBuffer *rtp);
125 guint32 gst_rtp_buffer_default_clock_rate (guint8 payload_type);
126 gint gst_rtp_buffer_compare_seqnum (guint16 seqnum1, guint16 seqnum2);
127 guint64 gst_rtp_buffer_ext_timestamp (guint64 *exttimestamp, guint32 timestamp);
129 gboolean gst_rtp_buffer_get_extension_onebyte_header (GstRTPBuffer *rtp,
134 gboolean gst_rtp_buffer_get_extension_twobytes_header (GstRTPBuffer *rtp,
141 gboolean gst_rtp_buffer_add_extension_onebyte_header (GstRTPBuffer *rtp,
145 gboolean gst_rtp_buffer_add_extension_twobytes_header (GstRTPBuffer *rtp,
154 #endif /* __GST_RTPBUFFER_H__ */