include/ortp/rtpsession.h

Go to the documentation of this file.
00001  /*
00002   The oRTP library is an RTP (Realtime Transport Protocol - rfc3550) stack.
00003   Copyright (C) 2001  Simon MORLAT simon.morlat@linphone.org
00004 
00005   This library is free software; you can redistribute it and/or
00006   modify it under the terms of the GNU Lesser General Public
00007   License as published by the Free Software Foundation; either
00008   version 2.1 of the License, or (at your option) any later version.
00009 
00010   This library is distributed in the hope that it will be useful,
00011   but WITHOUT ANY WARRANTY; without even the implied warranty of
00012   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013   Lesser General Public License for more details.
00014 
00015   You should have received a copy of the GNU Lesser General Public
00016   License along with this library; if not, write to the Free Software
00017   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00018 */
00019 
00030 #ifndef RTPSESSION_H
00031 #define RTPSESSION_H
00032 
00033 
00034 #include <ortp/port.h>
00035 #include <ortp/rtp.h>
00036 #include <ortp/payloadtype.h>
00037 #include <ortp/sessionset.h>
00038 #include <ortp/rtcp.h>
00039 #include <ortp/str_utils.h>
00040 #include <ortp/rtpsignaltable.h>
00041 #include <ortp/event.h>
00042 
00043 
00044 
00045 typedef enum {
00046         RTP_SESSION_RECVONLY,
00047         RTP_SESSION_SENDONLY,
00048         RTP_SESSION_SENDRECV
00049 } RtpSessionMode;
00050 
00051 
00054 typedef struct _JBParameters{
00055         int min_size; 
00056         int nom_size; 
00057         int max_size; 
00058         bool_t adaptive;
00059 } JBParameters;
00060 
00061 typedef struct _JitterControl
00062 {
00063         int jitt_comp;   /* the user jitt_comp in miliseconds*/
00064         int jitt_comp_ts; /* the jitt_comp converted in rtp time (same unit as timestamp) */
00065         int adapt_jitt_comp_ts;
00066         float slide;
00067         float jitter;
00068         int count;
00069         int olddiff;
00070         float inter_jitter;     /* interarrival jitter as defined in the RFC */
00071         int corrective_step;
00072         int corrective_slide;
00073         bool_t adaptive;
00074         bool_t enabled;
00075 } JitterControl;
00076 
00077 typedef struct _WaitPoint
00078 {
00079         ortp_mutex_t lock;
00080         ortp_cond_t  cond;
00081         uint32_t time;
00082         bool_t wakeup;
00083 } WaitPoint;
00084 
00085 typedef struct _RtpTransport
00086 {
00087         void *data;
00088         ortp_socket_t (*t_getsocket)(struct _RtpTransport *t);
00089         int  (*t_sendto)(struct _RtpTransport *t, mblk_t *msg , int flags, const struct sockaddr *to, socklen_t tolen);
00090         int  (*t_recvfrom)(struct _RtpTransport *t, mblk_t *msg, int flags, struct sockaddr *from, socklen_t *fromlen);
00091         struct _RtpSession *session;//<back pointer to the owning session, set by oRTP
00092 }  RtpTransport;
00093 
00094 
00095         
00096 typedef struct _RtpStream
00097 {
00098         ortp_socket_t socket;
00099         struct _RtpTransport *tr; 
00100         int sockfamily;
00101         int max_rq_size;
00102         int time_jump;
00103         uint32_t ts_jump;
00104         queue_t rq;
00105         queue_t tev_rq;
00106         mblk_t *cached_mp;
00107         int loc_port;
00108 #ifdef ORTP_INET6
00109         struct sockaddr_storage rem_addr;
00110 #else
00111         struct sockaddr_in rem_addr;
00112 #endif
00113         int rem_addrlen;
00114         JitterControl jittctl;
00115         uint32_t snd_time_offset;/*the scheduler time when the application send its first timestamp*/   
00116         uint32_t snd_ts_offset; /* the first application timestamp sent by the application */
00117         uint32_t snd_rand_offset;       /* a random number added to the user offset to make the stream timestamp*/
00118         uint32_t snd_last_ts;   /* the last stream timestamp sended */
00119         uint32_t rcv_time_offset; /*the scheduler time when the application ask for its first timestamp*/
00120         uint32_t rcv_ts_offset;  /* the first stream timestamp */
00121         uint32_t rcv_query_ts_offset;   /* the first user timestamp asked by the application */
00122         uint32_t rcv_diff_ts;   /* difference between the first user timestamp and first stream timestamp */
00123         uint32_t hwrcv_diff_ts;
00124         uint32_t rcv_last_ts;   /* the last stream timestamp got by the application */
00125         uint32_t rcv_last_app_ts; /* the last application timestamp asked by the application */ 
00126         uint32_t rcv_last_ret_ts; /* the timestamp of the last sample returned (only for continuous audio)*/
00127         uint32_t hwrcv_extseq; /* last received on socket extended sequence number */
00128         uint32_t hwrcv_seq_at_last_SR;
00129         uint32_t hwrcv_since_last_SR;
00130         uint32_t last_rcv_SR_ts;     /* NTP timestamp (middle 32 bits) of last received SR */
00131         struct timeval last_rcv_SR_time;   /* time at which last SR was received  */
00132         uint16_t snd_seq; /* send sequence number */
00133         uint32_t last_rtcp_report_snt_r;        /* the time of the last rtcp report sent, in recv timestamp unit */
00134         uint32_t last_rtcp_report_snt_s;        /* the time of the last rtcp report sent, in send timestamp unit */
00135         uint32_t rtcp_report_snt_interval; /* the interval in timestamp unit between rtcp report sent */
00136         uint32_t last_rtcp_packet_count; /*the sender's octet count in the last sent RTCP SR*/
00137         unsigned int sent_bytes; /* used for bandwidth estimation */
00138         struct timeval send_bw_start; /* used for bandwidth estimation */
00139         unsigned int recv_bytes; /* used for bandwidth estimation */
00140         struct timeval recv_bw_start; /* used for bandwidth estimation */
00141         rtp_stats_t stats;
00142         int recv_errno;
00143         int send_errno;
00144 }RtpStream;
00145 
00146 typedef struct _RtcpStream
00147 {
00148         ortp_socket_t socket;
00149         int sockfamily;
00150         struct _RtpTransport *tr; 
00151 
00152         mblk_t *cached_mp;
00153 #ifdef ORTP_INET6
00154         struct sockaddr_storage rem_addr;
00155 #else
00156         struct sockaddr_in rem_addr;
00157 #endif
00158         int rem_addrlen;
00159         bool_t enabled; /*tells whether we can send RTCP packets */
00160 } RtcpStream;
00161 
00162 typedef struct _RtpSession RtpSession;
00163 
00164 
00173 struct _RtpSession
00174 {
00175         RtpSession *next;       /* next RtpSession, when the session are enqueued by the scheduler */
00176         int mask_pos;   /* the position in the scheduler mask of RtpSession : do not move this field: it is part of the ABI since the session_set macros use it*/
00177         struct {
00178           RtpProfile *profile;
00179           int pt;
00180           unsigned int ssrc;
00181           WaitPoint wp;
00182           int telephone_events_pt;      /* the payload type used for telephony events */
00183         } snd,rcv;
00184         unsigned int inc_ssrc_candidate;
00185         int inc_same_ssrc_count;
00186         int hw_recv_pt; /* recv payload type before jitter buffer */
00187         int recv_buf_size;
00188         RtpSignalTable on_ssrc_changed;
00189         RtpSignalTable on_payload_type_changed;
00190         RtpSignalTable on_telephone_event_packet;
00191         RtpSignalTable on_telephone_event;
00192         RtpSignalTable on_timestamp_jump;
00193         RtpSignalTable on_network_error;
00194         RtpSignalTable on_rtcp_bye;
00195         struct _OList *signal_tables;
00196         struct _OList *eventqs;
00197         RtpStream rtp;
00198         RtcpStream rtcp;
00199         RtpSessionMode mode;
00200         struct _RtpScheduler *sched;
00201         uint32_t flags;
00202         int dscp;
00203         int multicast_ttl;
00204         int multicast_loopback;
00205         void * user_data;
00206         /* FIXME: Should be a table for all session participants. */
00207         struct timeval last_recv_time; /* Time of receiving the RTP/RTCP packet. */
00208 
00209         /* telephony events extension */
00210         mblk_t *current_tev;            /* the pending telephony events */
00211         mblk_t *sd;
00212         queue_t contributing_sources;
00213         bool_t symmetric_rtp;
00214         bool_t permissive; /*use the permissive algorithm*/
00215         bool_t use_connect; /* use connect() on the socket */
00216         bool_t ssrc_set;
00217 };
00218         
00219 
00220 
00221 
00222 #ifdef __cplusplus
00223 extern "C"
00224 {
00225 #endif
00226 
00227 /* public API */
00228 RtpSession *rtp_session_new(int mode);
00229 void rtp_session_set_scheduling_mode(RtpSession *session, int yesno);
00230 void rtp_session_set_blocking_mode(RtpSession *session, int yesno);
00231 void rtp_session_set_profile(RtpSession *session, RtpProfile *profile);
00232 void rtp_session_set_send_profile(RtpSession *session,RtpProfile *profile);
00233 void rtp_session_set_recv_profile(RtpSession *session,RtpProfile *profile);
00234 RtpProfile *rtp_session_get_profile(RtpSession *session);
00235 RtpProfile *rtp_session_get_send_profile(RtpSession *session);
00236 RtpProfile *rtp_session_get_recv_profile(RtpSession *session);
00237 int rtp_session_signal_connect(RtpSession *session,const char *signal_name, RtpCallback cb, unsigned long user_data);
00238 int rtp_session_signal_disconnect_by_callback(RtpSession *session,const char *signal_name, RtpCallback cb);
00239 void rtp_session_set_ssrc(RtpSession *session, uint32_t ssrc);
00240 void rtp_session_set_seq_number(RtpSession *session, uint16_t seq);
00241 uint16_t rtp_session_get_seq_number(RtpSession *session);
00242 
00243 void rtp_session_enable_jitter_buffer(RtpSession *session , bool_t enabled);
00244 bool_t rtp_session_jitter_buffer_enabled(const RtpSession *session);
00245 void rtp_session_set_jitter_buffer_params(RtpSession *session, const JBParameters *par);
00246 void rtp_session_get_jitter_buffer_params(RtpSession *session, JBParameters *par);
00247 
00248 /*deprecated jitter control functions*/
00249 void rtp_session_set_jitter_compensation(RtpSession *session, int milisec);
00250 void rtp_session_enable_adaptive_jitter_compensation(RtpSession *session, bool_t val);
00251 bool_t rtp_session_adaptive_jitter_compensation_enabled(RtpSession *session);
00252 
00253 void rtp_session_set_time_jump_limit(RtpSession *session, int miliseconds);
00254 int rtp_session_set_local_addr(RtpSession *session,const char *addr, int port);
00255 int rtp_session_get_local_port(const RtpSession *session);
00256 int rtp_session_set_remote_addr_and_port (RtpSession * session, const char * addr, int rtp_port, int rtcp_port);
00257 int rtp_session_set_remote_addr(RtpSession *session,const char *addr, int port);
00258 /* alternatively to the set_remote_addr() and set_local_addr(), an application can give
00259 a valid socket (potentially connect()ed )to be used by the RtpSession */
00260 void rtp_session_set_sockets(RtpSession *session, int rtpfd, int rtcpfd);
00261 void rtp_session_set_transports(RtpSession *session, RtpTransport *rtptr, RtpTransport *rtcptr);
00262 
00263 /*those methods are provided for people who wants to send non-RTP messages using the RTP/RTCP sockets */
00264 ortp_socket_t rtp_session_get_rtp_socket(const RtpSession *session);
00265 ortp_socket_t rtp_session_get_rtcp_socket(const RtpSession *session);
00266 
00267 
00268 /* QOS / DSCP */
00269 int rtp_session_set_dscp(RtpSession *session, int dscp);
00270 int rtp_session_get_dscp(const RtpSession *session);
00271 
00272 
00273 /* Multicast methods */
00274 int rtp_session_set_multicast_ttl(RtpSession *session, int ttl);
00275 int rtp_session_get_multicast_ttl(RtpSession *session);
00276 
00277 int rtp_session_set_multicast_loopback(RtpSession *session, int yesno);
00278 int rtp_session_get_multicast_loopback(RtpSession *session);
00279 
00280 
00281 
00282 int rtp_session_set_send_payload_type(RtpSession *session, int paytype);
00283 int rtp_session_get_send_payload_type(const RtpSession *session);
00284 
00285 int rtp_session_get_recv_payload_type(const RtpSession *session);
00286 int rtp_session_set_recv_payload_type(RtpSession *session, int pt);
00287 
00288 int rtp_session_set_payload_type(RtpSession *session, int pt);
00289 
00290 void rtp_session_set_symmetric_rtp (RtpSession * session, bool_t yesno);
00291 
00292 void rtp_session_set_connected_mode(RtpSession *session, bool_t yesno);
00293 
00294 void rtp_session_enable_rtcp(RtpSession *session, bool_t yesno);
00295 
00296 /*low level recv and send functions */
00297 mblk_t * rtp_session_recvm_with_ts (RtpSession * session, uint32_t user_ts);
00298 mblk_t * rtp_session_create_packet(RtpSession *session,int header_size, const uint8_t *payload, int payload_size);
00299 mblk_t * rtp_session_create_packet_with_data(RtpSession *session, uint8_t *payload, int payload_size, void (*freefn)(void*));
00300 mblk_t * rtp_session_create_packet_in_place(RtpSession *session,uint8_t *buffer, int size, void (*freefn)(void*) );
00301 int rtp_session_sendm_with_ts (RtpSession * session, mblk_t *mp, uint32_t userts);
00302 /* high level recv and send functions */
00303 int rtp_session_recv_with_ts(RtpSession *session, uint8_t *buffer, int len, uint32_t ts, int *have_more);
00304 int rtp_session_send_with_ts(RtpSession *session, const uint8_t *buffer, int len, uint32_t userts);
00305 
00306 /* event API*/
00307 void rtp_session_register_event_queue(RtpSession *session, OrtpEvQueue *q);
00308 void rtp_session_unregister_event_queue(RtpSession *session, OrtpEvQueue *q);
00309 
00310 
00311 /* IP bandwidth usage estimation functions, returning bits/s*/
00312 float rtp_session_compute_send_bandwidth(RtpSession *session);
00313 float rtp_session_compute_recv_bandwidth(RtpSession *session);
00314 
00315 void rtp_session_send_rtcp_APP(RtpSession *session, uint8_t subtype, const char *name, const uint8_t *data, int datalen);
00316 
00317 uint32_t rtp_session_get_current_send_ts(RtpSession *session);
00318 uint32_t rtp_session_get_current_recv_ts(RtpSession *session);
00319 void rtp_session_flush_sockets(RtpSession *session);
00320 void rtp_session_release_sockets(RtpSession *session);
00321 void rtp_session_resync(RtpSession *session);
00322 void rtp_session_reset(RtpSession *session);
00323 void rtp_session_destroy(RtpSession *session);
00324 
00325 const rtp_stats_t * rtp_session_get_stats(const RtpSession *session);
00326 void rtp_session_reset_stats(RtpSession *session);
00327 
00328 void rtp_session_set_data(RtpSession *session, void *data);
00329 void *rtp_session_get_data(const RtpSession *session);
00330 
00331 void rtp_session_set_recv_buf_size(RtpSession *session, int bufsize);
00332 
00333 /* in use with the scheduler to convert a timestamp in scheduler time unit (ms) */
00334 uint32_t rtp_session_ts_to_time(RtpSession *session,uint32_t timestamp);
00335 uint32_t rtp_session_time_to_ts(RtpSession *session, int millisecs);
00336 /* this function aims at simulating senders with "imprecise" clocks, resulting in 
00337 rtp packets sent with timestamp uncorrelated with the system clock .
00338 This is only availlable to sessions working with the oRTP scheduler */
00339 void rtp_session_make_time_distorsion(RtpSession *session, int milisec);
00340 
00341 /*RTCP functions */
00342 void rtp_session_set_source_description(RtpSession *session, const char *cname,
00343         const char *name, const char *email, const char *phone, 
00344     const char *loc, const char *tool, const char *note);
00345 void rtp_session_add_contributing_source(RtpSession *session, uint32_t csrc, 
00346     const char *cname, const char *name, const char *email, const char *phone, 
00347     const char *loc, const char *tool, const char *note);
00348 void rtp_session_remove_contributing_sources(RtpSession *session, uint32_t csrc);
00349 mblk_t* rtp_session_create_rtcp_sdes_packet(RtpSession *session);
00350 
00351 void rtp_session_get_last_recv_time(RtpSession *session, struct timeval *tv);
00352 int rtp_session_bye(RtpSession *session, const char *reason);
00353 
00354 int rtp_session_get_last_send_error_code(RtpSession *session);
00355 void rtp_session_clear_send_error_code(RtpSession *session);
00356 int rtp_session_get_last_recv_error_code(RtpSession *session);
00357 void rtp_session_clear_recv_error_code(RtpSession *session);
00358 
00359 /*private */
00360 void rtp_session_init(RtpSession *session, int mode);
00361 #define rtp_session_set_flag(session,flag) (session)->flags|=(flag)
00362 #define rtp_session_unset_flag(session,flag) (session)->flags&=~(flag)
00363 void rtp_session_uninit(RtpSession *session);
00364 
00365 #ifdef __cplusplus
00366 }
00367 #endif
00368 
00369 #endif

Generated on Tue Feb 5 21:35:36 2008 for oRTP by  doxygen 1.5.4