Merge remote-tracking branch 'origin/master' into 0.11
[platform/upstream/gstreamer.git] / gst-libs / gst / rtp / gstrtpbuffer.h
1 /* GStreamer
2  * Copyright (C) <2005> Philippe Khalaf <burger@speedy.org>
3  *               <2005> Wim Taymans <wim@fluendo.com>
4  *
5  * gstrtpbuffer.h: various helper functions to manipulate buffers
6  *     with RTP payload.
7  *
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.
12  *
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.
17  *
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.
22  */
23
24 #ifndef __GST_RTPBUFFER_H__
25 #define __GST_RTPBUFFER_H__
26
27 #include <gst/gst.h>
28 #include <gst/rtp/gstrtppayloads.h>
29
30 G_BEGIN_DECLS
31
32 /**
33  * GST_RTP_VERSION:
34  *
35  * The supported RTP version 2.
36  */
37 #define GST_RTP_VERSION 2
38
39
40 typedef struct _GstRTPBuffer GstRTPBuffer;
41
42 /**
43  * GstRTPBuffer:
44  * @buffer: pointer to RTP buffer
45  *
46  * Data structure that points to an RTP packet.
47  * The size of the structure is made public to allow stack allocations.
48  */
49 struct _GstRTPBuffer
50 {
51   GstBuffer   *buffer;
52   GstMapFlags  flags;
53   guint8      *data;
54   gsize        size;
55   gsize        maxsize;
56 };
57
58 #define GST_RTP_BUFFER_INIT {NULL,0,NULL,0,0}
59
60 /* creating buffers */
61 void            gst_rtp_buffer_allocate_data         (GstBuffer *buffer, guint payload_len,
62                                                       guint8 pad_len, guint8 csrc_count);
63
64 GstBuffer*      gst_rtp_buffer_new_take_data         (gpointer data, gsize len);
65 GstBuffer*      gst_rtp_buffer_new_copy_data         (gpointer data, gsize len);
66 GstBuffer*      gst_rtp_buffer_new_allocate          (guint payload_len, guint8 pad_len, guint8 csrc_count);
67 GstBuffer*      gst_rtp_buffer_new_allocate_len      (guint packet_len, guint8 pad_len, guint8 csrc_count);
68
69 guint           gst_rtp_buffer_calc_header_len       (guint8 csrc_count);
70 guint           gst_rtp_buffer_calc_packet_len       (guint payload_len, guint8 pad_len, guint8 csrc_count);
71 guint           gst_rtp_buffer_calc_payload_len      (guint packet_len, guint8 pad_len, guint8 csrc_count);
72
73 gboolean        gst_rtp_buffer_validate_data         (guint8 *data, gsize len);
74 gboolean        gst_rtp_buffer_validate              (GstBuffer *buffer);
75
76
77 gboolean        gst_rtp_buffer_map                   (GstBuffer *buffer, GstMapFlags flags, GstRTPBuffer *rtp);
78 gboolean        gst_rtp_buffer_unmap                 (GstRTPBuffer *rtp);
79
80 void            gst_rtp_buffer_set_packet_len        (GstRTPBuffer *rtp, guint len);
81 guint           gst_rtp_buffer_get_packet_len        (GstRTPBuffer *rtp);
82
83 guint           gst_rtp_buffer_get_header_len        (GstRTPBuffer *rtp);
84
85 guint8          gst_rtp_buffer_get_version           (GstRTPBuffer *rtp);
86 void            gst_rtp_buffer_set_version           (GstRTPBuffer *rtp, guint8 version);
87
88 gboolean        gst_rtp_buffer_get_padding           (GstRTPBuffer *rtp);
89 void            gst_rtp_buffer_set_padding           (GstRTPBuffer *rtp, gboolean padding);
90 void            gst_rtp_buffer_pad_to                (GstRTPBuffer *rtp, guint len);
91
92 gboolean        gst_rtp_buffer_get_extension         (GstRTPBuffer *rtp);
93 void            gst_rtp_buffer_set_extension         (GstRTPBuffer *rtp, gboolean extension);
94 gboolean        gst_rtp_buffer_get_extension_data    (GstRTPBuffer *rtp, guint16 *bits,
95                                                       gpointer *data, guint *wordlen);
96 gboolean        gst_rtp_buffer_set_extension_data    (GstRTPBuffer *rtp, guint16 bits, guint16 length);
97
98 guint32         gst_rtp_buffer_get_ssrc              (GstRTPBuffer *rtp);
99 void            gst_rtp_buffer_set_ssrc              (GstRTPBuffer *rtp, guint32 ssrc);
100
101 guint8          gst_rtp_buffer_get_csrc_count        (GstRTPBuffer *rtp);
102 guint32         gst_rtp_buffer_get_csrc              (GstRTPBuffer *rtp, guint8 idx);
103 void            gst_rtp_buffer_set_csrc              (GstRTPBuffer *rtp, guint8 idx, guint32 csrc);
104
105 gboolean        gst_rtp_buffer_get_marker            (GstRTPBuffer *rtp);
106 void            gst_rtp_buffer_set_marker            (GstRTPBuffer *rtp, gboolean marker);
107
108 guint8          gst_rtp_buffer_get_payload_type      (GstRTPBuffer *rtp);
109 void            gst_rtp_buffer_set_payload_type      (GstRTPBuffer *rtp, guint8 payload_type);
110
111 guint16         gst_rtp_buffer_get_seq               (GstRTPBuffer *rtp);
112 void            gst_rtp_buffer_set_seq               (GstRTPBuffer *rtp, guint16 seq);
113
114 guint32         gst_rtp_buffer_get_timestamp         (GstRTPBuffer *rtp);
115 void            gst_rtp_buffer_set_timestamp         (GstRTPBuffer *rtp, guint32 timestamp);
116
117 GstBuffer*      gst_rtp_buffer_get_payload_buffer    (GstRTPBuffer *rtp);
118 GstBuffer*      gst_rtp_buffer_get_payload_subbuffer (GstRTPBuffer *rtp, guint offset, guint len);
119
120 guint           gst_rtp_buffer_get_payload_len       (GstRTPBuffer *rtp);
121 gpointer        gst_rtp_buffer_get_payload           (GstRTPBuffer *rtp);
122
123 /* some helpers */
124 guint32         gst_rtp_buffer_default_clock_rate    (guint8 payload_type);
125 gint            gst_rtp_buffer_compare_seqnum        (guint16 seqnum1, guint16 seqnum2);
126 guint64         gst_rtp_buffer_ext_timestamp         (guint64 *exttimestamp, guint32 timestamp);
127
128 gboolean        gst_rtp_buffer_get_extension_onebyte_header  (GstRTPBuffer *rtp,
129                                                               guint8 id,
130                                                               guint nth,
131                                                               gpointer * data,
132                                                               guint * size);
133 gboolean        gst_rtp_buffer_get_extension_twobytes_header (GstRTPBuffer *rtp,
134                                                               guint8 * appbits,
135                                                               guint8 id,
136                                                               guint nth,
137                                                               gpointer * data,
138                                                               guint * size);
139
140 gboolean       gst_rtp_buffer_add_extension_onebyte_header  (GstRTPBuffer *rtp,
141                                                              guint8 id,
142                                                              gpointer data,
143                                                              guint size);
144 gboolean       gst_rtp_buffer_add_extension_twobytes_header (GstRTPBuffer *rtp,
145                                                              guint8 appbits,
146                                                              guint8 id,
147                                                              gpointer data,
148                                                              guint size);
149
150
151 G_END_DECLS
152
153 #endif /* __GST_RTPBUFFER_H__ */
154