2 * Copyright (C) <2007> Wim Taymans <wim.taymans@gmail.com>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
20 #ifndef __RTP_SOURCE_H__
21 #define __RTP_SOURCE_H__
24 #include <gst/rtp/gstrtcpbuffer.h>
25 #include <gst/netbuffer/gstnetbuffer.h>
29 /* the default number of consecutive RTP packets we need to receive before the
30 * source is considered valid */
31 #define RTP_NO_PROBATION 0
32 #define RTP_DEFAULT_PROBATION 2
34 #define RTP_SEQ_MOD (1 << 16)
35 #define RTP_MAX_DROPOUT 3000
36 #define RTP_MAX_MISORDER 100
38 typedef struct _RTPSource RTPSource;
39 typedef struct _RTPSourceClass RTPSourceClass;
41 #define RTP_TYPE_SOURCE (rtp_source_get_type())
42 #define RTP_SOURCE(src) (G_TYPE_CHECK_INSTANCE_CAST((src),RTP_TYPE_SOURCE,RTPSource))
43 #define RTP_SOURCE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),RTP_TYPE_SOURCE,RTPSourceClass))
44 #define RTP_IS_SOURCE(src) (G_TYPE_CHECK_INSTANCE_TYPE((src),RTP_TYPE_SOURCE))
45 #define RTP_IS_SOURCE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),RTP_TYPE_SOURCE))
46 #define RTP_SOURCE_CAST(src) ((RTPSource *)(src))
49 * RTP_SOURCE_IS_ACTIVE:
52 * Check if @src is active. A source is active when it has been validated
53 * and has not yet received a BYE packet.
55 #define RTP_SOURCE_IS_ACTIVE(src) (src->validated && !src->received_bye)
58 * RTP_SOURCE_IS_SENDER:
61 * Check if @src is a sender.
63 #define RTP_SOURCE_IS_SENDER(src) (src->is_sender)
68 * @buffer: the RTP buffer ready for processing
69 * @user_data: user data specified when registering
71 * This callback will be called when @src has @buffer ready for further
74 * Returns: a #GstFlowReturn.
76 typedef GstFlowReturn (*RTPSourcePushRTP) (RTPSource *src, GstBuffer *buffer,
82 * @payload: a payload type
83 * @user_data: user data specified when registering
85 * This callback will be called when @src needs the clock-rate of the
88 * Returns: a clock-rate for @payload.
90 typedef gint (*RTPSourceClockRate) (RTPSource *src, guint8 payload, gpointer user_data);
94 * @push_rtp: a packet becomes available for handling
95 * @clock_rate: a clock-rate is requested
96 * @get_time: the current clock time is requested
98 * Callbacks performed by #RTPSource when actions need to be performed.
101 RTPSourcePushRTP push_rtp;
102 RTPSourceClockRate clock_rate;
103 } RTPSourceCallbacks;
108 * A source in the #RTPSession
124 gboolean received_bye;
127 gboolean have_rtp_from;
128 GstNetAddress rtp_from;
129 gboolean have_rtcp_from;
130 GstNetAddress rtcp_from;
138 GstClockTime bye_time;
139 GstClockTime last_activity;
140 GstClockTime last_rtp_activity;
142 GstClockTime last_rtptime;
143 GstClockTime last_ntpnstime;
147 RTPSourceCallbacks callbacks;
150 RTPSourceStats stats;
153 struct _RTPSourceClass {
154 GObjectClass parent_class;
157 GType rtp_source_get_type (void);
159 /* managing lifetime of sources */
160 RTPSource* rtp_source_new (guint32 ssrc);
161 void rtp_source_set_callbacks (RTPSource *src, RTPSourceCallbacks *cb, gpointer data);
164 guint32 rtp_source_get_ssrc (RTPSource *src);
166 void rtp_source_set_as_csrc (RTPSource *src);
167 gboolean rtp_source_is_as_csrc (RTPSource *src);
169 gboolean rtp_source_is_active (RTPSource *src);
170 gboolean rtp_source_is_validated (RTPSource *src);
171 gboolean rtp_source_is_sender (RTPSource *src);
173 gboolean rtp_source_received_bye (RTPSource *src);
174 gchar * rtp_source_get_bye_reason (RTPSource *src);
176 void rtp_source_update_caps (RTPSource *src, GstCaps *caps);
179 gboolean rtp_source_set_sdes (RTPSource *src, GstRTCPSDESType type,
180 const guint8 *data, guint len);
181 gboolean rtp_source_set_sdes_string (RTPSource *src, GstRTCPSDESType type,
183 gboolean rtp_source_get_sdes (RTPSource *src, GstRTCPSDESType type,
184 guint8 **data, guint *len);
185 gchar* rtp_source_get_sdes_string (RTPSource *src, GstRTCPSDESType type);
187 /* handling network address */
188 void rtp_source_set_rtp_from (RTPSource *src, GstNetAddress *address);
189 void rtp_source_set_rtcp_from (RTPSource *src, GstNetAddress *address);
192 GstFlowReturn rtp_source_process_rtp (RTPSource *src, GstBuffer *buffer, RTPArrivalStats *arrival);
194 GstFlowReturn rtp_source_send_rtp (RTPSource *src, GstBuffer *buffer, guint64 ntpnstime);
197 void rtp_source_process_bye (RTPSource *src, const gchar *reason);
198 void rtp_source_process_sr (RTPSource *src, GstClockTime time, guint64 ntptime,
199 guint32 rtptime, guint32 packet_count, guint32 octet_count);
200 void rtp_source_process_rb (RTPSource *src, GstClockTime time, guint8 fractionlost,
201 gint32 packetslost, guint32 exthighestseq, guint32 jitter,
202 guint32 lsr, guint32 dlsr);
204 gboolean rtp_source_get_new_sr (RTPSource *src, GstClockTime time, guint64 *ntptime,
205 guint32 *rtptime, guint32 *packet_count,
206 guint32 *octet_count);
207 gboolean rtp_source_get_new_rb (RTPSource *src, GstClockTime time, guint8 *fractionlost,
208 gint32 *packetslost, guint32 *exthighestseq, guint32 *jitter,
209 guint32 *lsr, guint32 *dlsr);
211 gboolean rtp_source_get_last_sr (RTPSource *src, GstClockTime *time, guint64 *ntptime,
212 guint32 *rtptime, guint32 *packet_count,
213 guint32 *octet_count);
214 gboolean rtp_source_get_last_rb (RTPSource *src, guint8 *fractionlost, gint32 *packetslost,
215 guint32 *exthighestseq, guint32 *jitter,
216 guint32 *lsr, guint32 *dlsr);
218 void rtp_source_reset (RTPSource * src);
220 #endif /* __RTP_SOURCE_H__ */