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  * @flags: flags used when mapping
  46  * @map: the #GstMapInfo
  47  *
  48  * Data structure that points to an RTP packet.
  49  * The size of the structure is made public to allow stack allocations.
  50  */
  51 struct _GstRTPBuffer
  52 {
  53   GstBuffer   *buffer;
  54   GstMapInfo   map;
  55 };
  56
  57 #define GST_RTP_BUFFER_INIT { NULL, GST_MAP_INFO_INIT}
  58
  59 /* creating buffers */
  60 void            gst_rtp_buffer_allocate_data         (GstBuffer *buffer, guint payload_len,
  61                                                       guint8 pad_len, guint8 csrc_count);
  62
  63 GstBuffer*      gst_rtp_buffer_new_take_data         (gpointer data, gsize len);
  64 GstBuffer*      gst_rtp_buffer_new_copy_data         (gpointer data, gsize len);
  65 GstBuffer*      gst_rtp_buffer_new_allocate          (guint payload_len, guint8 pad_len, guint8 csrc_count);
  66 GstBuffer*      gst_rtp_buffer_new_allocate_len      (guint packet_len, guint8 pad_len, guint8 csrc_count);
  67
  68 guint           gst_rtp_buffer_calc_header_len       (guint8 csrc_count);
  69 guint           gst_rtp_buffer_calc_packet_len       (guint payload_len, guint8 pad_len, guint8 csrc_count);
  70 guint           gst_rtp_buffer_calc_payload_len      (guint packet_len, guint8 pad_len, guint8 csrc_count);
  71
  72 gboolean        gst_rtp_buffer_validate_data         (guint8 *data, gsize len);
  73 gboolean        gst_rtp_buffer_validate              (GstBuffer *buffer);
  74
  75
  76 gboolean        gst_rtp_buffer_map                   (GstBuffer *buffer, GstMapFlags flags, GstRTPBuffer *rtp);
  77 gboolean        gst_rtp_buffer_unmap                 (GstRTPBuffer *rtp);
  78
  79 void            gst_rtp_buffer_set_packet_len        (GstRTPBuffer *rtp, guint len);
  80 guint           gst_rtp_buffer_get_packet_len        (GstRTPBuffer *rtp);
  81
  82 guint           gst_rtp_buffer_get_header_len        (GstRTPBuffer *rtp);
  83
  84 guint8          gst_rtp_buffer_get_version           (GstRTPBuffer *rtp);
  85 void            gst_rtp_buffer_set_version           (GstRTPBuffer *rtp, guint8 version);
  86
  87 gboolean        gst_rtp_buffer_get_padding           (GstRTPBuffer *rtp);
  88 void            gst_rtp_buffer_set_padding           (GstRTPBuffer *rtp, gboolean padding);
  89 void            gst_rtp_buffer_pad_to                (GstRTPBuffer *rtp, guint len);
  90
  91 gboolean        gst_rtp_buffer_get_extension         (GstRTPBuffer *rtp);
  92 void            gst_rtp_buffer_set_extension         (GstRTPBuffer *rtp, gboolean extension);
  93 gboolean        gst_rtp_buffer_get_extension_data    (GstRTPBuffer *rtp, guint16 *bits,
  94                                                       gpointer *data, guint *wordlen);
  95 gboolean        gst_rtp_buffer_set_extension_data    (GstRTPBuffer *rtp, guint16 bits, guint16 length);
  96
  97 guint32         gst_rtp_buffer_get_ssrc              (GstRTPBuffer *rtp);
  98 void            gst_rtp_buffer_set_ssrc              (GstRTPBuffer *rtp, guint32 ssrc);
  99
 100 guint8          gst_rtp_buffer_get_csrc_count        (GstRTPBuffer *rtp);
 101 guint32         gst_rtp_buffer_get_csrc              (GstRTPBuffer *rtp, guint8 idx);
 102 void            gst_rtp_buffer_set_csrc              (GstRTPBuffer *rtp, guint8 idx, guint32 csrc);
 103
 104 gboolean        gst_rtp_buffer_get_marker            (GstRTPBuffer *rtp);
 105 void            gst_rtp_buffer_set_marker            (GstRTPBuffer *rtp, gboolean marker);
 106
 107 guint8          gst_rtp_buffer_get_payload_type      (GstRTPBuffer *rtp);
 108 void            gst_rtp_buffer_set_payload_type      (GstRTPBuffer *rtp, guint8 payload_type);
 109
 110 guint16         gst_rtp_buffer_get_seq               (GstRTPBuffer *rtp);
 111 void            gst_rtp_buffer_set_seq               (GstRTPBuffer *rtp, guint16 seq);
 112
 113 guint32         gst_rtp_buffer_get_timestamp         (GstRTPBuffer *rtp);
 114 void            gst_rtp_buffer_set_timestamp         (GstRTPBuffer *rtp, guint32 timestamp);
 115
 116 GstBuffer*      gst_rtp_buffer_get_payload_buffer    (GstRTPBuffer *rtp);
 117 GstBuffer*      gst_rtp_buffer_get_payload_subbuffer (GstRTPBuffer *rtp, guint offset, guint len);
 118
 119 guint           gst_rtp_buffer_get_payload_len       (GstRTPBuffer *rtp);
 120 gpointer        gst_rtp_buffer_get_payload           (GstRTPBuffer *rtp);
 121
 122 /* some helpers */
 123 guint32         gst_rtp_buffer_default_clock_rate    (guint8 payload_type);
 124 gint            gst_rtp_buffer_compare_seqnum        (guint16 seqnum1, guint16 seqnum2);
 125 guint64         gst_rtp_buffer_ext_timestamp         (guint64 *exttimestamp, guint32 timestamp);
 126
 127 gboolean        gst_rtp_buffer_get_extension_onebyte_header  (GstRTPBuffer *rtp,
 128                                                               guint8 id,
 129                                                               guint nth,
 130                                                               gpointer * data,
 131                                                               guint * size);
 132 gboolean        gst_rtp_buffer_get_extension_twobytes_header (GstRTPBuffer *rtp,
 133                                                               guint8 * appbits,
 134                                                               guint8 id,
 135                                                               guint nth,
 136                                                               gpointer * data,
 137                                                               guint * size);
 138
 139 gboolean       gst_rtp_buffer_add_extension_onebyte_header  (GstRTPBuffer *rtp,
 140                                                              guint8 id,
 141                                                              gpointer data,
 142                                                              guint size);
 143 gboolean       gst_rtp_buffer_add_extension_twobytes_header (GstRTPBuffer *rtp,
 144                                                              guint8 appbits,
 145                                                              guint8 id,
 146                                                              gpointer data,
 147                                                              guint size);
 148
 149
 150 G_END_DECLS
 151
 152 #endif /* __GST_RTPBUFFER_H__ */
 153