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"
31 /*Dirty hack, keep in sync with mediastreamer2/include/mediastream.h */
32 #ifndef PAYLOAD_TYPE_FLAG_CAN_RECV
33 #define PAYLOAD_TYPE_FLAG_CAN_RECV PAYLOAD_TYPE_USER_FLAG_1
34 #define PAYLOAD_TYPE_FLAG_CAN_SEND PAYLOAD_TYPE_USER_FLAG_2
38 typedef struct Sal Sal;
42 typedef struct SalOp SalOp;
46 typedef struct SalAddress SalAddress;
49 SalTransportUDP, /*UDP*/
50 SalTransportTCP, /*TCP*/
51 SalTransportTLS, /*TLS*/
52 SalTransportDTLS /*DTLS*/
55 const char* sal_transport_to_string(SalTransport transport);
56 SalTransport sal_transport_parse(const char*);
57 /* Address manipulation API*/
58 SalAddress * sal_address_new(const char *uri);
59 SalAddress * sal_address_clone(const SalAddress *addr);
60 const char *sal_address_get_scheme(const SalAddress *addr);
61 const char *sal_address_get_display_name(const SalAddress* addr);
62 char *sal_address_get_display_name_unquoted(const SalAddress *addr);
63 const char *sal_address_get_username(const SalAddress *addr);
64 const char *sal_address_get_domain(const SalAddress *addr);
65 const char * sal_address_get_port(const SalAddress *addr);
66 int sal_address_get_port_int(const SalAddress *addr);
67 SalTransport sal_address_get_transport(const SalAddress* addr);
69 void sal_address_set_display_name(SalAddress *addr, const char *display_name);
70 void sal_address_set_username(SalAddress *addr, const char *username);
71 void sal_address_set_domain(SalAddress *addr, const char *host);
72 void sal_address_set_port(SalAddress *addr, const char *port);
73 void sal_address_set_port_int(SalAddress *uri, int port);
74 void sal_address_clean(SalAddress *addr);
75 char *sal_address_as_string(const SalAddress *u);
76 char *sal_address_as_string_uri_only(const SalAddress *u);
77 void sal_address_destroy(SalAddress *u);
78 void sal_address_set_param(SalAddress *u,const char* name,const char* value);
79 void sal_address_set_transport(SalAddress* addr,SalTransport transport);
83 void sal_uninit(Sal* sal);
84 void sal_set_user_pointer(Sal *sal, void *user_data);
85 void *sal_get_user_pointer(const Sal *sal);
107 typedef struct SalEndpointCandidate{
110 }SalEndpointCandidate;
112 #define SAL_ENDPOINT_CANDIDATE_MAX 2
114 typedef struct SalStreamDescription{
120 MSList *payloads; //<list of PayloadType
123 SalEndpointCandidate candidates[SAL_ENDPOINT_CANDIDATE_MAX];
125 } SalStreamDescription;
127 #define SAL_MEDIA_DESCRIPTION_MAX_STREAMS 4
129 typedef struct SalMediaDescription{
135 unsigned int session_ver;
136 unsigned int session_id;
137 SalStreamDescription streams[SAL_MEDIA_DESCRIPTION_MAX_STREAMS];
138 } SalMediaDescription;
140 SalMediaDescription *sal_media_description_new();
141 void sal_media_description_ref(SalMediaDescription *md);
142 void sal_media_description_unref(SalMediaDescription *md);
143 bool_t sal_media_description_empty(const SalMediaDescription *md);
144 bool_t sal_media_description_equals(const SalMediaDescription *md1, const SalMediaDescription *md2);
145 bool_t sal_media_description_has_dir(const SalMediaDescription *md, SalStreamDir dir);
146 SalStreamDescription *sal_media_description_find_stream(SalMediaDescription *md,
147 SalMediaProto proto, SalStreamType type);
148 void sal_media_description_set_dir(SalMediaDescription *md, SalStreamDir stream_dir);
150 /*this structure must be at the first byte of the SalOp structure defined by implementors*/
151 typedef struct SalOpBase{
153 char *route; /*or request-uri for REGISTER*/
159 SalMediaDescription *local_media;
160 SalMediaDescription *remote_media;
165 typedef enum SalError{
168 SalErrorFailure, /* see SalReason for more details */
172 typedef enum SalReason{
176 SalReasonTemporarilyUnavailable,
178 SalReasonDoNotDisturb,
184 typedef enum SalPresenceStatus{
188 SalPresenceBerightback,
190 SalPresenceOnthephone,
191 SalPresenceOuttolunch,
192 SalPresenceDonotdisturb,
194 SalPresenceAltService,
197 typedef enum SalSubscribeState{
199 SalSubscribeTerminated
202 typedef void (*SalOnCallReceived)(SalOp *op);
203 typedef void (*SalOnCallRinging)(SalOp *op);
204 typedef void (*SalOnCallAccepted)(SalOp *op);
205 typedef void (*SalOnCallAck)(SalOp *op);
206 typedef void (*SalOnCallUpdating)(SalOp *op);/*< Called when a reINVITE is received*/
207 typedef void (*SalOnCallTerminated)(SalOp *op, const char *from);
208 typedef void (*SalOnCallFailure)(SalOp *op, SalError error, SalReason reason, const char *details, int code);
209 typedef void (*SalOnCallReleased)(SalOp *salop);
210 typedef void (*SalOnAuthRequested)(SalOp *op, const char *realm, const char *username);
211 typedef void (*SalOnAuthSuccess)(SalOp *op, const char *realm, const char *username);
212 typedef void (*SalOnRegisterSuccess)(SalOp *op, bool_t registered);
213 typedef void (*SalOnRegisterFailure)(SalOp *op, SalError error, SalReason reason, const char *details);
214 typedef void (*SalOnVfuRequest)(SalOp *op);
215 typedef void (*SalOnDtmfReceived)(SalOp *op, char dtmf);
216 typedef void (*SalOnRefer)(Sal *sal, SalOp *op, const char *referto);
217 typedef void (*SalOnTextReceived)(Sal *sal, const char *from, const char *msg);
218 typedef void (*SalOnNotify)(SalOp *op, const char *from, const char *value);
219 typedef void (*SalOnNotifyPresence)(SalOp *op, SalSubscribeState ss, SalPresenceStatus status, const char *msg);
220 typedef void (*SalOnSubscribeReceived)(SalOp *salop, const char *from);
221 typedef void (*SalOnSubscribeClosed)(SalOp *salop, const char *from);
222 typedef void (*SalOnInternalMsg)(Sal *sal, const char *msg);
223 typedef void (*SalOnPingReply)(SalOp *salop);
225 typedef struct SalCallbacks{
226 SalOnCallReceived call_received;
227 SalOnCallRinging call_ringing;
228 SalOnCallAccepted call_accepted;
229 SalOnCallAck call_ack;
230 SalOnCallUpdating call_updating;
231 SalOnCallTerminated call_terminated;
232 SalOnCallFailure call_failure;
233 SalOnCallReleased call_released;
234 SalOnAuthRequested auth_requested;
235 SalOnAuthSuccess auth_success;
236 SalOnRegisterSuccess register_success;
237 SalOnRegisterFailure register_failure;
238 SalOnVfuRequest vfu_request;
239 SalOnDtmfReceived dtmf_received;
240 SalOnRefer refer_received;
241 SalOnTextReceived text_received;
243 SalOnNotifyPresence notify_presence;
244 SalOnSubscribeReceived subscribe_received;
245 SalOnSubscribeClosed subscribe_closed;
246 SalOnInternalMsg internal_message;
247 SalOnPingReply ping_reply;
250 typedef struct SalAuthInfo{
257 SalAuthInfo* sal_auth_info_new();
258 SalAuthInfo* sal_auth_info_clone(const SalAuthInfo* auth_info);
259 void sal_auth_info_delete(const SalAuthInfo* auth_info);
261 void sal_set_callbacks(Sal *ctx, const SalCallbacks *cbs);
262 int sal_listen_port(Sal *ctx, const char *addr, int port, SalTransport tr, int is_secure);
263 int sal_unlisten_ports(Sal *ctx);
264 ortp_socket_t sal_get_socket(Sal *ctx);
265 void sal_set_user_agent(Sal *ctx, const char *user_agent);
266 /*keepalive period in ms*/
267 void sal_set_keepalive_period(Sal *ctx,unsigned int value);
269 * returns keepalive period in ms
272 unsigned int sal_get_keepalive_period(Sal *ctx);
273 void sal_use_session_timers(Sal *ctx, int expires);
274 void sal_use_double_registrations(Sal *ctx, bool_t enabled);
275 void sal_reuse_authorization(Sal *ctx, bool_t enabled);
276 void sal_use_one_matching_codec_policy(Sal *ctx, bool_t one_matching_codec);
277 void sal_use_rport(Sal *ctx, bool_t use_rports);
278 void sal_use_101(Sal *ctx, bool_t use_101);
279 void sal_root_ca(Sal* ctx, const char* rootCa);
281 int sal_iterate(Sal *sal);
282 MSList * sal_get_pending_auths(Sal *sal);
284 /*create an operation */
285 SalOp * sal_op_new(Sal *sal);
287 /*generic SalOp API, working for all operations */
288 Sal *sal_op_get_sal(const SalOp *op);
289 void sal_op_set_contact(SalOp *op, const char *contact);
290 void sal_op_set_route(SalOp *op, const char *route);
291 void sal_op_set_from(SalOp *op, const char *from);
292 void sal_op_set_to(SalOp *op, const char *to);
293 void sal_op_release(SalOp *h);
294 void sal_op_authenticate(SalOp *h, const SalAuthInfo *info);
295 void sal_op_cancel_authentication(SalOp *h);
296 void sal_op_set_user_pointer(SalOp *h, void *up);
297 int sal_op_get_auth_requested(SalOp *h, const char **realm, const char **username);
298 const char *sal_op_get_from(const SalOp *op);
299 const char *sal_op_get_to(const SalOp *op);
300 const char *sal_op_get_contact(const SalOp *op);
301 const char *sal_op_get_route(const SalOp *op);
302 const char *sal_op_get_proxy(const SalOp *op);
303 /*for incoming requests, returns the origin of the packet as a sip uri*/
304 const char *sal_op_get_network_origin(const SalOp *op);
305 /*returns far-end "User-Agent" string */
306 const char *sal_op_get_remote_ua(const SalOp *op);
307 void *sal_op_get_user_pointer(const SalOp *op);
310 int sal_call_set_local_media_description(SalOp *h, SalMediaDescription *desc);
311 int sal_call(SalOp *h, const char *from, const char *to);
312 int sal_call_notify_ringing(SalOp *h, bool_t early_media);
313 /*accept an incoming call or, during a call accept a reINVITE*/
314 int sal_call_accept(SalOp*h);
315 int sal_call_decline(SalOp *h, SalReason reason, const char *redirection /*optional*/);
316 int sal_call_update(SalOp *h, const char *subject);
317 SalMediaDescription * sal_call_get_final_media_description(SalOp *h);
318 int sal_call_refer(SalOp *h, const char *refer_to);
319 int sal_call_refer_with_replaces(SalOp *h, SalOp *other_call_h);
320 int sal_call_accept_refer(SalOp *h);
321 /*informs this call is consecutive to an incoming refer */
322 int sal_call_set_referer(SalOp *h, SalOp *refered_call);
323 /* returns the SalOp of a call that should be replaced by h, if any */
324 SalOp *sal_call_get_replaces(SalOp *h);
325 int sal_call_send_dtmf(SalOp *h, char dtmf);
326 int sal_call_terminate(SalOp *h);
327 bool_t sal_call_autoanswer_asked(SalOp *op);
328 void sal_call_send_vfu_request(SalOp *h);
329 int sal_call_is_offerer(const SalOp *h);
332 int sal_register(SalOp *op, const char *proxy, const char *from, int expires);
333 int sal_register_refresh(SalOp *op, int expires);
334 int sal_unregister(SalOp *h);
337 int sal_text_send(SalOp *op, const char *from, const char *to, const char *text);
339 /*presence Subscribe/notify*/
340 int sal_subscribe_presence(SalOp *op, const char *from, const char *to);
341 int sal_unsubscribe(SalOp *op);
342 int sal_subscribe_accept(SalOp *op);
343 int sal_subscribe_decline(SalOp *op);
344 int sal_notify_presence(SalOp *op, SalPresenceStatus status, const char *status_message);
345 int sal_notify_close(SalOp *op);
347 /*presence publish */
348 int sal_publish(SalOp *op, const char *from, const char *to, SalPresenceStatus status);
351 /*ping: main purpose is to obtain its own contact address behind firewalls*/
352 int sal_ping(SalOp *op, const char *from, const char *to);
356 #define payload_type_set_number(pt,n) (pt)->user_data=(void*)((long)n);
357 #define payload_type_get_number(pt) ((int)(long)(pt)->user_data)
360 void sal_get_default_local_ip(Sal *sal, int address_family, char *ip, size_t iplen);
364 void __sal_op_init(SalOp *b, Sal *sal);
365 void __sal_op_set_network_origin(SalOp *op, const char *origin /*a sip uri*/);
366 void __sal_op_free(SalOp *b);