doxygen: update configuration and fix errors in doc

parent d9df9695
......@@ -41,7 +41,7 @@
* ////////////////////////////////////////////////////////////////////////// */
/** \file b64/b64.h
/** \file ortp/b64.h
*
* \brief [C/C++] Header file for the b64 library.
*/
......
......@@ -521,12 +521,12 @@ typedef struct OrtpLossRateEstimator{
float loss_rate;
/**
* Total number of outgoing duplicate packets on last
* #ortp_loss_rate_estimator_process_report_block iteration.
* ortp_loss_rate_estimator_process_report_block iteration.
**/
int32_t last_dup_packet_sent_count;
/**
* Total number of outgoing unique packets on last
* #ortp_loss_rate_estimator_process_report_block iteration.
* ortp_loss_rate_estimator_process_report_block iteration.
**/
int32_t last_packet_sent_count;
}OrtpLossRateEstimator;
......
......@@ -54,7 +54,7 @@ ORTP_VAR_PUBLIC RtpProfile av_profile;
ORTP_PUBLIC void rtp_profile_set_payload(RtpProfile *prof, int idx, PayloadType *pt);
/**
* Set payload type number @index unassigned in the profile.
* Set payload type number \a index unassigned in the profile.
*
*@param profile an RTP profile
*@param index the payload type number
......
......@@ -102,8 +102,8 @@ typedef struct _RtpTransportModifier
int (*t_process_on_receive)(struct _RtpTransportModifier *t, mblk_t *msg);
void (*t_process_on_schedule)(struct _RtpTransportModifier *t); /*invoked each time rtp_session_recvm is called even is no message are available*/
/**
* Mandatory callback responsible of freeing the #RtpTransportModifierAND the pointer.
* @param[in] transport #RtpTransportModifier object to free.
* Mandatory callback responsible of freeing the #_RtpTransportModifier AND the pointer.
* @param[in] transport #_RtpTransportModifier object to free.
*/
void (*t_destroy)(struct _RtpTransportModifier *transport);
} RtpTransportModifier;
......@@ -117,8 +117,8 @@ typedef struct _RtpTransport
int (*t_recvfrom)(struct _RtpTransport *t, mblk_t *msg, int flags, struct sockaddr *from, socklen_t *fromlen);
void (*t_close)(struct _RtpTransport *transport, void *userData);
/**
* Mandatory callback responsible of freeing the #RtpTransport object AND the pointer.
* @param[in] transport #RtpTransport object to free.
* Mandatory callback responsible of freeing the #_RtpTransport object AND the pointer.
* @param[in] transport #_RtpTransport object to free.
*/
void (*t_destroy)(struct _RtpTransport *transport);
} RtpTransport;
......@@ -127,7 +127,7 @@ typedef enum _OrtpNetworkSimulatorMode{
OrtpNetworkSimulatorInvalid=-1,
OrtpNetworkSimulatorInbound,/**<simulation is applied when receiving packets*/
OrtpNetworkSimulatorOutbound, /**<simulation is applied to sent packets*/
OrtpNetworkSimulatorOutboundControlled /**<simulation is applied to sent packets according to sent timestamp
OrtpNetworkSimulatorOutboundControlled /**<simulation is applied to sent packets according to sent timestamp
set in the timestamp field of mblk_t, which is definied only with -DORTP_TIMESTAMP */
}OrtpNetworkSimulatorMode;
......@@ -424,7 +424,7 @@ extern "C"
ORTP_PUBLIC const char *ortp_network_simulator_mode_to_string(OrtpNetworkSimulatorMode mode);
ORTP_PUBLIC OrtpNetworkSimulatorMode ortp_network_simulator_mode_from_string(const char *str);
/* public API */
ORTP_PUBLIC RtpSession *rtp_session_new(int mode);
ORTP_PUBLIC void rtp_session_set_scheduling_mode(RtpSession *session, int yesno);
......@@ -654,15 +654,15 @@ void update_sent_bytes(OrtpStream *os, int nbytes);
/**
* get endpoint if any
* @param[in] t #RtpTransport object.
* @return #rtpEndpoint
* @param[in] transport RtpTransport object.
* @return #_RtpTransport
*
* */
ORTP_PUBLIC RtpTransport* meta_rtp_transport_get_endpoint(const RtpTransport *transport);
/**
* set endpoint
* @param[in] t #RtpTransport object.
* @param[in] t #RtpEndpoint.
* @param[in] transport RtpTransport object.
* @param[in] endpoint RtpEndpoint.
*
* */
ORTP_PUBLIC void meta_rtp_transport_set_endpoint(RtpTransport *transport,RtpTransport *endpoint);
......
......@@ -16,7 +16,7 @@
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/**
/**
* \file sessionset.h
* \brief Sending and receiving multiple streams together with only one thread.
*
......@@ -105,7 +105,7 @@ ORTP_PUBLIC SessionSet * session_set_new(void);
/**
* This macro tests if the session is part of the set. 1 is returned if true, 0 else.
*@param ss a set (#SessionSet object)
*@param ss a set
*@param rtpsession a rtp session
*
**/
......@@ -128,12 +128,12 @@ ORTP_PUBLIC SessionSet * session_set_new(void);
**/
ORTP_PUBLIC void session_set_destroy(SessionSet *set);
ORTP_PUBLIC int session_set_select(SessionSet *recvs, SessionSet *sends, SessionSet *errors);
ORTP_PUBLIC int session_set_timedselect(SessionSet *recvs, SessionSet *sends, SessionSet *errors, struct timeval *timeout);
#ifdef __cplusplus
}
#endif
#endif
This source diff could not be displayed because it is too large. You can view the blob instead.
......@@ -132,7 +132,7 @@ void jitter_control_new_packet(JitterControl *ctl, uint32_t packet_ts, uint32_t
ctl->adapt_jitt_comp_ts=(int) MAX(ctl->jitt_comp_ts,2*ctl->jitter);
//jitter_control_dump_stats(ctl);
}
ctl->slide=slide;
}else {
/*ctl->slide and jitter size are not updated*/
......@@ -153,11 +153,10 @@ float jitter_control_compute_mean_size(JitterControl *ctl){
/**
*rtp_session_set_jitter_compensation:
*@session: a RtpSession
*@milisec: the time interval in milisec to be jitter compensed.
*@param session: a RtpSession
*@param milisec: the time interval in milisec to be jitter compensed.
*
* Sets the time interval for which packet are buffered instead of being delivered to the
* Sets the time interval for which packet are buffered instead of being delivered to the
* application.
**/
void
......
......@@ -87,7 +87,7 @@ void ortp_init()
/**
* Initialize the oRTP scheduler. You only have to do that if you intend to use the
* scheduled mode of the #RtpSession in your application.
* scheduled mode of the RtpSession in your application.
*
**/
void ortp_scheduler_init()
......
......@@ -150,12 +150,12 @@ RtpProfile * rtp_profile_new(const char *name)
* @param pt the payload type description
*
**/
void rtp_profile_set_payload(RtpProfile *prof, int idx, PayloadType *pt){
void rtp_profile_set_payload(RtpProfile *profile, int idx, PayloadType *pt){
if (idx<0 || idx>=RTP_PROFILE_MAX_PAYLOADS) {
ortp_error("Bad index %i",idx);
return;
}
prof->payload[idx]=pt;
profile->payload[idx]=pt;
}
/**
......@@ -163,10 +163,10 @@ void rtp_profile_set_payload(RtpProfile *prof, int idx, PayloadType *pt){
*@param profile a RTP profile
*
**/
void rtp_profile_clear_all(RtpProfile *obj){
void rtp_profile_clear_all(RtpProfile *profile){
int i;
for (i=0;i<RTP_PROFILE_MAX_PAYLOADS;i++){
obj->payload[i]=0;
profile->payload[i]=0;
}
}
......@@ -174,12 +174,12 @@ void rtp_profile_clear_all(RtpProfile *obj){
/**
* Set a name to the rtp profile. (This is not required)
* @param profile a rtp profile object
* @param nm a string
* @param name a string
*
**/
void rtp_profile_set_name(RtpProfile *obj, const char *name){
if (obj->name!=NULL) ortp_free(obj->name);
obj->name=ortp_strdup(name);
void rtp_profile_set_name(RtpProfile *profile, const char *name){
if (profile->name!=NULL) ortp_free(profile->name);
profile->name=ortp_strdup(name);
}
/* ! payload are not cloned*/
......
This diff is collapsed.
......@@ -335,10 +335,10 @@ static void set_socket_sizes(ortp_socket_t sock, unsigned int sndbufsz, unsigned
/**
*rtp_session_set_local_addr:
*@session: a rtp session freshly created.
*@addr: a local IP address in the xxx.xxx.xxx.xxx form.
*@rtp_port: a local port or -1 to let oRTP choose the port randomly
*@rtcp_port: a local port or -1 to let oRTP choose the port randomly
*@param session: a rtp session freshly created.
*@param addr: a local IP address in the xxx.xxx.xxx.xxx form.
*@param rtp_port: a local port or -1 to let oRTP choose the port randomly
*@param rtcp_port: a local port or -1 to let oRTP choose the port randomly
*
* Specify the local addr to be use to listen for rtp packets or to send rtp packet from.
* In case where the rtp session is send-only, then it is not required to call this function:
......@@ -431,8 +431,8 @@ int rtp_session_join_multicast_group(RtpSession *session, const char *ip){
/**
*rtp_session_set_pktinfo:
*@session: a rtp session
*@activate: activation flag (0 to deactivate, other value to activate)
*@param session: a rtp session
*@param activate: activation flag (0 to deactivate, other value to activate)
*
* (De)activates packet info for incoming and outgoing packets.
*
......@@ -491,8 +491,8 @@ int rtp_session_set_pktinfo(RtpSession *session, int activate)
/**
*rtp_session_set_multicast_ttl:
*@session: a rtp session
*@ttl: desired Multicast Time-To-Live
*@param session: a rtp session
*@param ttl: desired Multicast Time-To-Live
*
* Sets the TTL (Time-To-Live) for outgoing multicast packets.
*
......@@ -545,7 +545,7 @@ int rtp_session_set_multicast_ttl(RtpSession *session, int ttl)
/**
*rtp_session_get_multicast_ttl:
*@session: a rtp session
*@param session: a rtp session
*
* Returns the TTL (Time-To-Live) for outgoing multicast packets.
*
......@@ -557,9 +557,8 @@ int rtp_session_get_multicast_ttl(RtpSession *session)
/**
*rtp_session_set_multicast_loopback:
*@session: a rtp session
*@ttl: desired Multicast Time-To-Live
*@param session: a rtp session
*@param yesno: desired Multicast Time-To-Live
*
* Sets the TTL (Time-To-Live) for outgoing multicast packets.
*
......@@ -617,7 +616,7 @@ int rtp_session_set_multicast_loopback(RtpSession *session, int yesno)
/**
*rtp_session_get_multicast_loopback:
*@session: a rtp session
*@param session: a rtp session
*
* Returns the multicast loopback state of rtp session (true or false).
*
......@@ -629,8 +628,8 @@ int rtp_session_get_multicast_loopback(RtpSession *session)
/**
*rtp_session_set_dscp:
*@session: a rtp session
*@dscp: desired DSCP PHB value
*@param session: a rtp session
*@param dscp: desired DSCP PHB value
*
* Sets the DSCP (Differentiated Services Code Point) for outgoing RTP packets.
*
......@@ -747,7 +746,7 @@ int rtp_session_set_dscp(RtpSession *session, int dscp){
/**
*rtp_session_get_dscp:
*@session: a rtp session
*@param session: a rtp session
*
* Returns the DSCP (Differentiated Services Code Point) for outgoing RTP packets.
*
......@@ -760,7 +759,7 @@ int rtp_session_get_dscp(const RtpSession *session)
/**
*rtp_session_get_local_port:
*@session: a rtp session for which rtp_session_set_local_addr() or rtp_session_set_remote_addr() has been called
*@param session: a rtp session for which rtp_session_set_local_addr() or rtp_session_set_remote_addr() has been called
*
* This function can be useful to retrieve the local port that was randomly choosen by
* rtp_session_set_remote_addr() when rtp_session_set_local_addr() was not called.
......@@ -778,9 +777,9 @@ int rtp_session_get_local_rtcp_port(const RtpSession *session){
/**
*rtp_session_set_remote_addr:
*@session: a rtp session freshly created.
*@addr: a local IP address in the xxx.xxx.xxx.xxx form.
*@port: a local port.
*@param session: a rtp session freshly created.
*@param addr: a local IP address in the xxx.xxx.xxx.xxx form.
*@param port: a local port.
*
* Sets the remote address of the rtp session, ie the destination address where rtp packet
* are sent. If the session is recv-only or duplex, it also sets the origin of incoming RTP
......@@ -795,11 +794,11 @@ rtp_session_set_remote_addr (RtpSession * session, const char * addr, int port){
/**
*rtp_session_set_remote_addr_full:
*@session: a rtp session freshly created.
*@rtp_addr: a local IP address in the xxx.xxx.xxx.xxx form.
*@rtp_port: a local rtp port.
*@rtcp_addr: a local IP address in the xxx.xxx.xxx.xxx form.
*@rtcp_port: a local rtcp port.
*@param session: a rtp session freshly created.
*@param rtp_addr: a local IP address in the xxx.xxx.xxx.xxx form.
*@param rtp_port: a local rtp port.
*@param rtcp_addr: a local IP address in the xxx.xxx.xxx.xxx form.
*@param rtcp_port: a local rtcp port.
*
* Sets the remote address of the rtp session, ie the destination address where rtp packet
* are sent. If the session is recv-only or duplex, it also sets the origin of incoming RTP
......@@ -957,11 +956,11 @@ int rtp_session_set_remote_addr_and_port(RtpSession * session, const char * addr
/**
*rtp_session_add_remote_aux_addr_full:
*@session: a rtp session freshly created.
*@rtp_addr: a local IP address in the xxx.xxx.xxx.xxx form.
*@rtp_port: a local rtp port.
*@rtcp_addr: a local IP address in the xxx.xxx.xxx.xxx form.
*@rtcp_port: a local rtcp port.
*@param session: a rtp session freshly created.
*@param rtp_addr: a local IP address in the xxx.xxx.xxx.xxx form.
*@param rtp_port: a local rtp port.
*@param rtcp_addr: a local IP address in the xxx.xxx.xxx.xxx form.
*@param rtcp_port: a local rtcp port.
*
* Add an auxiliary remote address for the rtp session, ie a destination address where rtp packet
* are sent.
......@@ -1011,7 +1010,7 @@ void rtp_session_get_transports(const RtpSession *session, RtpTransport **rtptr,
/**
*rtp_session_flush_sockets:
*@session: a rtp session
*@param session: a rtp session
*
* Flushes the sockets for all pending incoming packets.
* This can be usefull if you did not listen to the stream for a while
......@@ -1178,7 +1177,7 @@ int rtp_session_rtp_send (RtpSession * session, mblk_t * m){
static int rtp_session_rtcp_sendto(RtpSession * session, mblk_t * m, struct sockaddr *destaddr, socklen_t destlen, bool_t is_aux){
int error=0;
ortp_socket_t sockfd = rtp_session_get_socket(session, FALSE);
if (rtp_session_using_transport(session, rtcp)){
error = (session->rtcp.gs.tr->t_sendto) (session->rtcp.gs.tr, m, 0,
destaddr, destlen);
......@@ -1533,7 +1532,7 @@ static void rtp_process_incoming_packet(RtpSession * session, mblk_t * mp, bool_
}
remaddr = (struct sockaddr *)&mp->net_addr;
addrlen = mp->net_addrlen;
/*in case of rtcp-mux, we are allowed to reconsider whether it is an RTP or RTCP packet*/
if (session->rtcp_mux && is_rtp_packet){
if (rtp_get_version(mp) == 2){
......@@ -1614,7 +1613,7 @@ int rtp_session_rtp_recv (RtpSession * session, uint32_t user_ts) {
mp = msgb_allocator_alloc(&session->rtp.gs.allocator, session->recv_buf_size);
mp->reserved1 = user_ts;
if (sock_connected){
error=rtp_session_rtp_recv_abstract(sockfd, mp, 0, NULL, NULL);
}else if (rtp_session_using_transport(session, rtp)) {
......@@ -1669,7 +1668,7 @@ int rtp_session_rtcp_recv (RtpSession * session) {
mp = msgb_allocator_alloc(&session->rtp.gs.allocator, RTCP_MAX_RECV_BUFSIZE);
mp->reserved1 = session->rtp.rcv_last_app_ts;
if (sock_connected){
error=rtp_session_rtp_recv_abstract(session->rtcp.gs.socket, mp, 0, NULL, NULL);
}else{
......@@ -1710,7 +1709,7 @@ int rtp_session_rtcp_recv (RtpSession * session) {
/*EWOULDBLOCK errors or transports returning 0 are ignored.*/
rtp_session_process_incoming(session, NULL, is_rtp_packet, session->rtp.rcv_last_app_ts);
}
freemsg(mp);
return -1; /* avoids an infinite loop ! */
}
......
......@@ -45,7 +45,7 @@ void session_set_destroy(SessionSet *set)
ortp_free(set);
}
int count_power_items_simple(int v)
int count_power_items_simple(int v)
{
int c = 0,j;
for (j=0;j<32;j++){
......@@ -56,7 +56,7 @@ int count_power_items_simple(int v)
return c;
}
int count_power_items_fast(int v)
int count_power_items_fast(int v)
{
int c = 0;
while(v) {
......@@ -89,20 +89,20 @@ int session_set_and(SessionSet *sched_set, int maxs, SessionSet *user_set, Sessi
}
/**
* This function performs similarly as libc select() function, but performs on #RtpSession
* This function performs similarly as libc select() function, but performs on RtpSession
* instead of file descriptors.
* session_set_select() suspends the calling process until some events arrive on one of the
* three sets passed in argument. Two of the sets can be NULL.
* The first set @recvs is interpreted as a set of RtpSession waiting for receive events:
* The first set \a recvs is interpreted as a set of RtpSession waiting for receive events:
* a new buffer (perhaps empty) is availlable on one or more sessions of the set, or the last
* receive operation with rtp_session_recv_with_ts() would have finished if it were in
* receive operation with rtp_session_recv_with_ts() would have finished if it were in
* blocking mode.
* The second set is interpreted as a set of RtpSession waiting for send events, i.e. the last
* rtp_session_send_with_ts() call on a session would have finished if it were in blocking mode.
*
*
* When some events arrived on some of sets, then the function returns and sets are changed
* to indicate the sessions where events happened.
* Sessions can be added to sets using session_set_set(), a session has to be tested to be
* Sessions can be added to sets using session_set_set(), a session has to be tested to be
* part of a set using session_set_is_set().
*
* @param recvs a set of rtp sessions to be watched for read events
......@@ -115,10 +115,10 @@ int session_set_select(SessionSet *recvs, SessionSet *sends, SessionSet *errors)
int ret=0,bits;
SessionSet temp;
RtpScheduler *sched=ortp_get_scheduler();
/*lock the scheduler to not read the masks while they are being modified by the scheduler*/
rtp_scheduler_lock(sched);
while(1){
/* computes the SessionSet intersection (in the other words mask intersection) between
the mask given by the user and scheduler masks */
......
......@@ -35,9 +35,9 @@ PayloadType payload_type_telephone_event={
};
/**
* Tells whether telephony events payload type is supported within the
* Tells whether telephony events payload type is supported within the
* context of the rtp session.
* @param session a rtp session
* @param session a rtp session
*
* @return the payload type number used for telephony events if found, -1 if not found.
**/
......@@ -54,9 +54,9 @@ bool_t rtp_profile_is_telephone_event(const RtpProfile *prof, int pt_num){
/**
* Tells whether telephone event payload type is supported for send within the
* Tells whether telephone event payload type is supported for send within the
* context of the rtp session.
* @param session a rtp session
* @param session a rtp session
*
* @return the payload type number used for telephony events if found, -1 if not found.
**/
......@@ -67,9 +67,9 @@ int rtp_session_send_telephone_events_supported(RtpSession *session)
}
/**
* Tells whether telephone event payload type is supported for receiving within the
* Tells whether telephone event payload type is supported for receiving within the
* context of the rtp session.
* @param session a rtp session
* @param session a rtp session
*
* @return the payload type number used for telephony events if found, -1 if not found.
**/int rtp_session_recv_telephone_events_supported(RtpSession *session)
......@@ -97,7 +97,7 @@ mblk_t *rtp_session_create_telephone_event_packet(RtpSession *session, int start
rtp_header_t *rtp;
PayloadType *cur_pt=rtp_profile_get_payload(session->snd.profile, rtp_session_get_send_payload_type(session));
int tev_pt = session->tev_send_pt;
if (tev_pt != -1){
PayloadType *cur_tev_pt=rtp_profile_get_payload(session->snd.profile, tev_pt);
if (!cur_tev_pt){
......@@ -108,12 +108,12 @@ mblk_t *rtp_session_create_telephone_event_packet(RtpSession *session, int start
tev_pt, cur_tev_pt->clock_rate, cur_pt->clock_rate);
}
}
if (tev_pt == -1){
tev_pt = rtp_profile_find_payload_number(session->snd.profile, "telephone-event", cur_pt ? cur_pt->clock_rate : 8000, 1);
}
return_val_if_fail(tev_pt!=-1,NULL);
mp=allocb(RTP_FIXED_HEADER_SIZE+TELEPHONY_EVENTS_ALLOCATED_SIZE,BPRI_MED);
if (mp==NULL) return NULL;
rtp=(rtp_header_t*)mp->b_rptr;
......@@ -125,10 +125,10 @@ mblk_t *rtp_session_create_telephone_event_packet(RtpSession *session, int start
rtp->ssrc = session->snd.ssrc;
/* timestamp set later, when packet is sended */
/*seq number set later, when packet is sended */
/*set the payload type */
rtp->paytype=tev_pt;
/*copy the payload */
mp->b_wptr+=RTP_FIXED_HEADER_SIZE;
return mp;
......@@ -281,12 +281,12 @@ int rtp_session_send_dtmf2(RtpSession *session, char dtmf, uint32_t userts, int
m2=rtp_session_create_telephone_event_packet(session,0);
if (m2==NULL) return -1;
rtp_session_add_telephone_event(session,m2,tev_type,0,10, durationtier+durationtier);
/* create a third and final packet */
m3=rtp_session_create_telephone_event_packet(session,0);
if (m3==NULL) return -1;
rtp_session_add_telephone_event(session,m3,tev_type,1,10,duration);
/* and now sends them */
rtp_session_sendm_with_ts(session,m1,userts);
rtp_session_sendm_with_ts(session,m2,userts);
......@@ -308,7 +308,7 @@ int rtp_session_send_dtmf2(RtpSession *session, char dtmf, uint32_t userts, int
/**
* Reads telephony events from a rtp packet. *@tab points to the beginning of the event buffer.
* Reads telephony events from a rtp packet. \a *tab points to the beginning of the event buffer.
*
* @param session a rtp session from which telephony events are received.
* @param packet a rtp packet as a mblk_t.
......@@ -368,15 +368,15 @@ void rtp_session_check_telephone_events(RtpSession *session, mblk_t *m0)
mblk_t *cur_tev;
unsigned char *payload;
int datasize;
hdr=(rtp_header_t*)m0->b_rptr;
datasize=rtp_get_payload(m0,&payload);
num=datasize/sizeof(telephone_event_t);
events=(telephone_event_t*)payload;
if (hdr->markbit==1)
{
/* this is a start of new events. Store the event buffer for later use*/
......@@ -426,7 +426,7 @@ void rtp_session_check_telephone_events(RtpSession *session, mblk_t *m0)
else
{
/* there is no pending events, but we did not received marked bit packet
either the sending implementation is not compliant, either it has been lost,
either the sending implementation is not compliant, either it has been lost,
we must deal with it anyway.*/
session->current_tev=copymsg(m0);
/* inform the application if there are tone ends */
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment