3 Copyright (C) 2010 Simon MORLAT (simon.morlat@free.fr)
5 This program is free software; you can redistribute it and/or
6 modify it under the terms of the GNU General Public License
7 as published by the Free Software Foundation; either version 2
8 of the License, or (at your option) any later version.
10 This program 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
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
21 This header files defines the Signaling Abstraction Layer.
22 The purpose of this layer is too allow experiment different call signaling
23 protocols and implementations under linphone, for example SIP, JINGLE...
29 #include "mediastreamer2/mscommon.h"
33 typedef struct Sal Sal;
37 typedef struct SalOp SalOp;
41 typedef struct SalAddress SalAddress;
43 /* Address manipulation API*/
44 SalAddress * sal_address_new(const char *uri);
45 SalAddress * sal_address_clone(const SalAddress *addr);
46 const char *sal_address_get_scheme(const SalAddress *addr);
47 const char *sal_address_get_display_name(const SalAddress* addr);
48 char *sal_address_get_display_name_unquoted(const SalAddress *addr);
49 const char *sal_address_get_username(const SalAddress *addr);
50 const char *sal_address_get_domain(const SalAddress *addr);
51 const char * sal_address_get_port(const SalAddress *addr);
52 int sal_address_get_port_int(const SalAddress *uri);
54 void sal_address_set_display_name(SalAddress *addr, const char *display_name);
55 void sal_address_set_username(SalAddress *addr, const char *username);
56 void sal_address_set_domain(SalAddress *addr, const char *host);
57 void sal_address_set_port(SalAddress *addr, const char *port);
58 void sal_address_set_port_int(SalAddress *uri, int port);
59 void sal_address_clean(SalAddress *addr);
60 char *sal_address_as_string(const SalAddress *u);
61 char *sal_address_as_string_uri_only(const SalAddress *u);
62 void sal_address_destroy(SalAddress *u);
63 void sal_address_add_param(SalAddress *u,const char* name,const char* value);
68 void sal_uninit(Sal* sal);
69 void sal_set_user_pointer(Sal *sal, void *user_data);
70 void *sal_get_user_pointer(const Sal *sal);
96 typedef struct SalEndpointCandidate{
99 }SalEndpointCandidate;
101 #define SAL_ENDPOINT_CANDIDATE_MAX 2
103 typedef struct SalStreamDescription{
109 MSList *payloads; //<list of PayloadType
112 SalEndpointCandidate candidates[SAL_ENDPOINT_CANDIDATE_MAX];
114 } SalStreamDescription;
116 #define SAL_MEDIA_DESCRIPTION_MAX_STREAMS 4
118 typedef struct SalMediaDescription{
124 unsigned int session_ver;
125 unsigned int session_id;
126 SalStreamDescription streams[SAL_MEDIA_DESCRIPTION_MAX_STREAMS];
127 } SalMediaDescription;
129 SalMediaDescription *sal_media_description_new();
130 void sal_media_description_ref(SalMediaDescription *md);
131 void sal_media_description_unref(SalMediaDescription *md);
132 bool_t sal_media_description_empty(const SalMediaDescription *md);
133 bool_t sal_media_description_equals(const SalMediaDescription *md1, const SalMediaDescription *md2);
134 bool_t sal_media_description_has_dir(const SalMediaDescription *md, SalStreamDir dir);
135 SalStreamDescription *sal_media_description_find_stream(SalMediaDescription *md,
136 SalMediaProto proto, SalStreamType type);
137 void sal_media_description_set_dir(SalMediaDescription *md, SalStreamDir stream_dir);
139 /*this structure must be at the first byte of the SalOp structure defined by implementors*/
140 typedef struct SalOpBase{
142 char *route; /*or request-uri for REGISTER*/
148 SalMediaDescription *local_media;
149 SalMediaDescription *remote_media;
154 typedef enum SalError{
157 SalErrorFailure, /* see SalReason for more details */
161 typedef enum SalReason{
165 SalReasonTemporarilyUnavailable,
167 SalReasonDoNotDisturb,
173 typedef enum SalPresenceStatus{
177 SalPresenceBerightback,
179 SalPresenceOnthephone,
180 SalPresenceOuttolunch,
181 SalPresenceDonotdisturb,
183 SalPresenceAltService,
186 typedef enum SalSubscribeState{
188 SalSubscribeTerminated
191 typedef void (*SalOnCallReceived)(SalOp *op);
192 typedef void (*SalOnCallRinging)(SalOp *op);
193 typedef void (*SalOnCallAccepted)(SalOp *op);
194 typedef void (*SalOnCallAck)(SalOp *op);
195 typedef void (*SalOnCallUpdating)(SalOp *op);/*< Called when a reINVITE is received*/
196 typedef void (*SalOnCallTerminated)(SalOp *op, const char *from);
197 typedef void (*SalOnCallFailure)(SalOp *op, SalError error, SalReason reason, const char *details, int code);
198 typedef void (*SalOnCallReleased)(SalOp *salop);
199 typedef void (*SalOnAuthRequested)(SalOp *op, const char *realm, const char *username);
200 typedef void (*SalOnAuthSuccess)(SalOp *op, const char *realm, const char *username);
201 typedef void (*SalOnRegisterSuccess)(SalOp *op, bool_t registered);
202 typedef void (*SalOnRegisterFailure)(SalOp *op, SalError error, SalReason reason, const char *details);
203 typedef void (*SalOnVfuRequest)(SalOp *op);
204 typedef void (*SalOnDtmfReceived)(SalOp *op, char dtmf);
205 typedef void (*SalOnRefer)(Sal *sal, SalOp *op, const char *referto);
206 typedef void (*SalOnTextReceived)(Sal *sal, const char *from, const char *msg);
207 typedef void (*SalOnNotify)(SalOp *op, const char *from, const char *value);
208 typedef void (*SalOnNotifyPresence)(SalOp *op, SalSubscribeState ss, SalPresenceStatus status, const char *msg);
209 typedef void (*SalOnSubscribeReceived)(SalOp *salop, const char *from);
210 typedef void (*SalOnSubscribeClosed)(SalOp *salop, const char *from);
211 typedef void (*SalOnInternalMsg)(Sal *sal, const char *msg);
212 typedef void (*SalOnPingReply)(SalOp *salop);
214 typedef struct SalCallbacks{
215 SalOnCallReceived call_received;
216 SalOnCallRinging call_ringing;
217 SalOnCallAccepted call_accepted;
218 SalOnCallAck call_ack;
219 SalOnCallUpdating call_updating;
220 SalOnCallTerminated call_terminated;
221 SalOnCallFailure call_failure;
222 SalOnCallReleased call_released;
223 SalOnAuthRequested auth_requested;
224 SalOnAuthSuccess auth_success;
225 SalOnRegisterSuccess register_success;
226 SalOnRegisterFailure register_failure;
227 SalOnVfuRequest vfu_request;
228 SalOnDtmfReceived dtmf_received;
229 SalOnRefer refer_received;
230 SalOnTextReceived text_received;
232 SalOnNotifyPresence notify_presence;
233 SalOnSubscribeReceived subscribe_received;
234 SalOnSubscribeClosed subscribe_closed;
235 SalOnInternalMsg internal_message;
236 SalOnPingReply ping_reply;
239 typedef struct SalAuthInfo{
246 SalAuthInfo* sal_auth_info_new();
247 SalAuthInfo* sal_auth_info_clone(const SalAuthInfo* auth_info);
248 void sal_auth_info_delete(const SalAuthInfo* auth_info);
250 void sal_set_callbacks(Sal *ctx, const SalCallbacks *cbs);
251 int sal_listen_port(Sal *ctx, const char *addr, int port, SalTransport tr, int is_secure);
252 int sal_unlisten_ports(Sal *ctx);
253 ortp_socket_t sal_get_socket(Sal *ctx);
254 void sal_set_user_agent(Sal *ctx, const char *user_agent);
255 /*keepalive period in ms*/
256 void sal_set_keepalive_period(Sal *ctx,unsigned int value);
258 * returns keepalive period in ms
261 unsigned int sal_get_keepalive_period(Sal *ctx);
262 void sal_use_session_timers(Sal *ctx, int expires);
263 void sal_use_double_registrations(Sal *ctx, bool_t enabled);
264 void sal_use_one_matching_codec_policy(Sal *ctx, bool_t one_matching_codec);
265 void sal_use_rport(Sal *ctx, bool_t use_rports);
267 int sal_iterate(Sal *sal);
268 MSList * sal_get_pending_auths(Sal *sal);
270 /*create an operation */
271 SalOp * sal_op_new(Sal *sal);
273 /*generic SalOp API, working for all operations */
274 Sal *sal_op_get_sal(const SalOp *op);
275 void sal_op_set_contact(SalOp *op, const char *contact);
276 void sal_op_set_route(SalOp *op, const char *route);
277 void sal_op_set_from(SalOp *op, const char *from);
278 void sal_op_set_to(SalOp *op, const char *to);
279 void sal_op_release(SalOp *h);
280 void sal_op_authenticate(SalOp *h, const SalAuthInfo *info);
281 void sal_op_cancel_authentication(SalOp *h);
282 void sal_op_set_user_pointer(SalOp *h, void *up);
283 int sal_op_get_auth_requested(SalOp *h, const char **realm, const char **username);
284 const char *sal_op_get_from(const SalOp *op);
285 const char *sal_op_get_to(const SalOp *op);
286 const char *sal_op_get_contact(const SalOp *op);
287 const char *sal_op_get_route(const SalOp *op);
288 const char *sal_op_get_proxy(const SalOp *op);
289 /*for incoming requests, returns the origin of the packet as a sip uri*/
290 const char *sal_op_get_network_origin(const SalOp *op);
291 /*returns far-end "User-Agent" string */
292 const char *sal_op_get_remote_ua(const SalOp *op);
293 void *sal_op_get_user_pointer(const SalOp *op);
296 int sal_call_set_local_media_description(SalOp *h, SalMediaDescription *desc);
297 int sal_call(SalOp *h, const char *from, const char *to);
298 int sal_call_notify_ringing(SalOp *h, bool_t early_media);
299 /*accept an incoming call or, during a call accept a reINVITE*/
300 int sal_call_accept(SalOp*h);
301 int sal_call_decline(SalOp *h, SalReason reason, const char *redirection /*optional*/);
302 int sal_call_update(SalOp *h, const char *subject);
303 SalMediaDescription * sal_call_get_final_media_description(SalOp *h);
304 int sal_call_refer(SalOp *h, const char *refer_to);
305 int sal_call_refer_with_replaces(SalOp *h, SalOp *other_call_h);
306 int sal_call_accept_refer(SalOp *h);
307 /*informs this call is consecutive to an incoming refer */
308 int sal_call_set_referer(SalOp *h, SalOp *refered_call);
309 /* returns the SalOp of a call that should be replaced by h, if any */
310 SalOp *sal_call_get_replaces(SalOp *h);
311 int sal_call_send_dtmf(SalOp *h, char dtmf);
312 int sal_call_terminate(SalOp *h);
313 bool_t sal_call_autoanswer_asked(SalOp *op);
314 void sal_call_send_vfu_request(SalOp *h);
317 int sal_register(SalOp *op, const char *proxy, const char *from, int expires);
318 int sal_register_refresh(SalOp *op, int expires);
319 int sal_unregister(SalOp *h);
322 int sal_text_send(SalOp *op, const char *from, const char *to, const char *text);
324 /*presence Subscribe/notify*/
325 int sal_subscribe_presence(SalOp *op, const char *from, const char *to);
326 int sal_unsubscribe(SalOp *op);
327 int sal_subscribe_accept(SalOp *op);
328 int sal_subscribe_decline(SalOp *op);
329 int sal_notify_presence(SalOp *op, SalPresenceStatus status, const char *status_message);
330 int sal_notify_close(SalOp *op);
332 /*presence publish */
333 int sal_publish(SalOp *op, const char *from, const char *to, SalPresenceStatus status);
336 /*ping: main purpose is to obtain its own contact address behind firewalls*/
337 int sal_ping(SalOp *op, const char *from, const char *to);
339 #define payload_type_set_number(pt,n) (pt)->user_data=(void*)((long)n);
340 #define payload_type_get_number(pt) ((int)(long)(pt)->user_data)
343 void sal_get_default_local_ip(Sal *sal, int address_family, char *ip, size_t iplen);
347 void __sal_op_init(SalOp *b, Sal *sal);
348 void __sal_op_set_network_origin(SalOp *op, const char *origin /*a sip uri*/);
349 void __sal_op_free(SalOp *b);