oRTP 0.23.0
telephonyevents.h
Go to the documentation of this file.
1/*
2 The oRTP library is an RTP (Realtime Transport Protocol - rfc3550) stack.
3 Copyright (C) 2001 Simon MORLAT simon.morlat@linphone.org
4
5 This library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Lesser General Public
7 License as published by the Free Software Foundation; either
8 version 2.1 of the License, or (at your option) any later version.
9
10 This library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Lesser General Public License for more details.
14
15 You should have received a copy of the GNU Lesser General Public
16 License along with this library; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18*/
19
27#ifndef TELEPHONYEVENTS_H
28#define TELEPHONYEVENTS_H
29
30#include <ortp/rtpsession.h>
31
32
34{
35#ifdef ORTP_BIGENDIAN
36 uint32_t event:8;
37 uint32_t E:1;
38 uint32_t R:1;
39 uint32_t volume:6;
40 uint32_t duration:16;
41#else
42 uint32_t event:8;
43 uint32_t volume:6;
44 uint32_t R:1;
45 uint32_t E:1;
46 uint32_t duration:16;
47#endif
48};
49
51
52#ifdef __cplusplus
53extern "C" {
54#endif
55
56/* tell if the session supports telephony events. For this the telephony events payload_type
57 must be present in the rtp profile used by the session */
58
59/* low level functions */
63
64ORTP_PUBLIC mblk_t *rtp_session_create_telephone_event_packet(RtpSession *session, int start);
65
66ORTP_PUBLIC int rtp_session_add_telephone_event(RtpSession *session,
67 mblk_t *packet, uint8_t event, int end, uint8_t volume, uint16_t duration);
68
69ORTP_PUBLIC int rtp_session_read_telephone_event(RtpSession *session,
70 mblk_t *packet,telephone_event_t **tab);
71
72/* high level functions*/
73ORTP_PUBLIC int rtp_session_send_dtmf(RtpSession *session, char dtmf, uint32_t userts);
74ORTP_PUBLIC int rtp_session_send_dtmf2(RtpSession *session, char dtmf, uint32_t userts, int duration);
75/* for high level telephony event callback */
76ORTP_PUBLIC void rtp_session_check_telephone_events(RtpSession *session, mblk_t *m0);
77
78#ifdef __cplusplus
79}
80#endif
81
82/* the size allocated for telephony events packets */
83#define TELEPHONY_EVENTS_ALLOCATED_SIZE (4*sizeof(telephone_event_t))
84
85/* list of named events */
86#define TEV_DTMF_0 (0)
87#define TEV_DTMF_1 (1)
88#define TEV_DTMF_2 (2)
89#define TEV_DTMF_3 (3)
90#define TEV_DTMF_4 (4)
91#define TEV_DTMF_5 (5)
92#define TEV_DTMF_6 (6)
93#define TEV_DTMF_7 (7)
94#define TEV_DTMF_8 (8)
95#define TEV_DTMF_9 (9)
96#define TEV_DTMF_STAR (10)
97#define TEV_DTMF_POUND (11)
98#define TEV_DTMF_A (12)
99#define TEV_DTMF_B (13)
100#define TEV_DTMF_C (14)
101#define TEV_DTMF_D (15)
102#define TEV_FLASH (16)
103
104
105#endif
The RtpSession api.
Definition: rtpsession.h:202
Definition: telephonyevents.h:34
Definition: str_utils.h:50
ORTP_PUBLIC mblk_t * rtp_session_create_telephone_event_packet(RtpSession *session, int start)
Definition: telephonyevents.c:96
ORTP_PUBLIC int rtp_session_read_telephone_event(RtpSession *session, mblk_t *packet, telephone_event_t **tab)
Definition: telephonyevents.c:304
ORTP_PUBLIC int rtp_session_telephone_events_supported(RtpSession *session)
Definition: telephonyevents.c:44
ORTP_PUBLIC int rtp_session_send_dtmf2(RtpSession *session, char dtmf, uint32_t userts, int duration)
Definition: telephonyevents.c:187
ORTP_PUBLIC int rtp_session_send_telephone_events_supported(RtpSession *session)
Definition: telephonyevents.c:61
ORTP_PUBLIC int rtp_session_recv_telephone_events_supported(RtpSession *session)
Definition: telephonyevents.c:75
ORTP_PUBLIC int rtp_session_send_dtmf(RtpSession *session, char dtmf, uint32_t userts)
Definition: telephonyevents.c:173
ORTP_PUBLIC int rtp_session_add_telephone_event(RtpSession *session, mblk_t *packet, uint8_t event, int end, uint8_t volume, uint16_t duration)
Definition: telephonyevents.c:137