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{
108 MSList *payloads; //<list of PayloadType
111 SalEndpointCandidate candidates[SAL_ENDPOINT_CANDIDATE_MAX];
113 } SalStreamDescription;
115 #define SAL_MEDIA_DESCRIPTION_MAX_STREAMS 4
117 typedef struct SalMediaDescription{
123 SalStreamDescription streams[SAL_MEDIA_DESCRIPTION_MAX_STREAMS];
124 } SalMediaDescription;
126 SalMediaDescription *sal_media_description_new();
127 void sal_media_description_ref(SalMediaDescription *md);
128 void sal_media_description_unref(SalMediaDescription *md);
129 bool_t sal_media_description_empty(const SalMediaDescription *md);
130 bool_t sal_media_description_equals(const SalMediaDescription *md1, const SalMediaDescription *md2);
131 bool_t sal_media_description_has_dir(const SalMediaDescription *md, SalStreamDir dir);
132 SalStreamDescription *sal_media_description_find_stream(SalMediaDescription *md,
133 SalMediaProto proto, SalStreamType type);
134 void sal_media_description_set_dir(SalMediaDescription *md, SalStreamDir stream_dir);
136 /*this structure must be at the first byte of the SalOp structure defined by implementors*/
137 typedef struct SalOpBase{
139 char *route; /*or request-uri for REGISTER*/
145 SalMediaDescription *local_media;
146 SalMediaDescription *remote_media;
151 typedef enum SalError{
154 SalErrorFailure, /* see SalReason for more details */
158 typedef enum SalReason{
162 SalReasonTemporarilyUnavailable,
164 SalReasonDoNotDisturb,
170 typedef enum SalPresenceStatus{
174 SalPresenceBerightback,
176 SalPresenceOnthephone,
177 SalPresenceOuttolunch,
178 SalPresenceDonotdisturb,
180 SalPresenceAltService,
183 typedef enum SalSubscribeState{
185 SalSubscribeTerminated
188 typedef void (*SalOnCallReceived)(SalOp *op);
189 typedef void (*SalOnCallRinging)(SalOp *op);
190 typedef void (*SalOnCallAccepted)(SalOp *op);
191 typedef void (*SalOnCallAck)(SalOp *op);
192 typedef void (*SalOnCallUpdating)(SalOp *op);/*< Called when a reINVITE is received*/
193 typedef void (*SalOnCallTerminated)(SalOp *op, const char *from);
194 typedef void (*SalOnCallFailure)(SalOp *op, SalError error, SalReason reason, const char *details, int code);
195 typedef void (*SalOnAuthRequested)(SalOp *op, const char *realm, const char *username);
196 typedef void (*SalOnAuthSuccess)(SalOp *op, const char *realm, const char *username);
197 typedef void (*SalOnRegisterSuccess)(SalOp *op, bool_t registered);
198 typedef void (*SalOnRegisterFailure)(SalOp *op, SalError error, SalReason reason, const char *details);
199 typedef void (*SalOnVfuRequest)(SalOp *op);
200 typedef void (*SalOnDtmfReceived)(SalOp *op, char dtmf);
201 typedef void (*SalOnRefer)(Sal *sal, SalOp *op, const char *referto);
202 typedef void (*SalOnTextReceived)(Sal *sal, const char *from, const char *msg);
203 typedef void (*SalOnNotify)(SalOp *op, const char *from, const char *value);
204 typedef void (*SalOnNotifyPresence)(SalOp *op, SalSubscribeState ss, SalPresenceStatus status, const char *msg);
205 typedef void (*SalOnSubscribeReceived)(SalOp *salop, const char *from);
206 typedef void (*SalOnSubscribeClosed)(SalOp *salop, const char *from);
207 typedef void (*SalOnInternalMsg)(Sal *sal, const char *msg);
208 typedef void (*SalOnPingReply)(SalOp *salop);
210 typedef struct SalCallbacks{
211 SalOnCallReceived call_received;
212 SalOnCallRinging call_ringing;
213 SalOnCallAccepted call_accepted;
214 SalOnCallAck call_ack;
215 SalOnCallUpdating call_updating;
216 SalOnCallTerminated call_terminated;
217 SalOnCallFailure call_failure;
218 SalOnAuthRequested auth_requested;
219 SalOnAuthSuccess auth_success;
220 SalOnRegisterSuccess register_success;
221 SalOnRegisterFailure register_failure;
222 SalOnVfuRequest vfu_request;
223 SalOnDtmfReceived dtmf_received;
224 SalOnRefer refer_received;
225 SalOnTextReceived text_received;
227 SalOnNotifyPresence notify_presence;
228 SalOnSubscribeReceived subscribe_received;
229 SalOnSubscribeClosed subscribe_closed;
230 SalOnInternalMsg internal_message;
231 SalOnPingReply ping_reply;
234 typedef struct SalAuthInfo{
241 void sal_set_callbacks(Sal *ctx, const SalCallbacks *cbs);
242 int sal_listen_port(Sal *ctx, const char *addr, int port, SalTransport tr, int is_secure);
243 int sal_unlisten_ports(Sal *ctx);
244 ortp_socket_t sal_get_socket(Sal *ctx);
245 void sal_set_user_agent(Sal *ctx, const char *user_agent);
246 /*keepalive period in ms*/
247 void sal_set_keepalive_period(Sal *ctx,unsigned int value);
248 void sal_use_session_timers(Sal *ctx, int expires);
249 void sal_use_one_matching_codec_policy(Sal *ctx, bool_t one_matching_codec);
250 int sal_iterate(Sal *sal);
251 MSList * sal_get_pending_auths(Sal *sal);
253 /*create an operation */
254 SalOp * sal_op_new(Sal *sal);
256 /*generic SalOp API, working for all operations */
257 Sal *sal_op_get_sal(const SalOp *op);
258 void sal_op_set_contact(SalOp *op, const char *contact);
259 void sal_op_set_route(SalOp *op, const char *route);
260 void sal_op_set_from(SalOp *op, const char *from);
261 void sal_op_set_to(SalOp *op, const char *to);
262 void sal_op_release(SalOp *h);
263 void sal_op_authenticate(SalOp *h, const SalAuthInfo *info);
264 void sal_op_set_user_pointer(SalOp *h, void *up);
265 int sal_op_get_auth_requested(SalOp *h, const char **realm, const char **username);
266 const char *sal_op_get_from(const SalOp *op);
267 const char *sal_op_get_to(const SalOp *op);
268 const char *sal_op_get_contact(const SalOp *op);
269 const char *sal_op_get_route(const SalOp *op);
270 const char *sal_op_get_proxy(const SalOp *op);
271 /*for incoming requests, returns the origin of the packet as a sip uri*/
272 const char *sal_op_get_network_origin(const SalOp *op);
273 /*returns far-end "User-Agent" string */
274 const char *sal_op_get_remote_ua(const SalOp *op);
275 void *sal_op_get_user_pointer(const SalOp *op);
278 int sal_call_set_local_media_description(SalOp *h, SalMediaDescription *desc);
279 int sal_call(SalOp *h, const char *from, const char *to);
280 int sal_call_notify_ringing(SalOp *h, bool_t early_media);
281 /*accept an incoming call or, during a call accept a reINVITE*/
282 int sal_call_accept(SalOp*h);
283 int sal_call_decline(SalOp *h, SalReason reason, const char *redirection /*optional*/);
284 int sal_call_hold(SalOp *h, bool_t holdon);
285 int sal_call_update(SalOp *h);
286 SalMediaDescription * sal_call_get_final_media_description(SalOp *h);
287 int sal_call_refer(SalOp *h, const char *refer_to);
288 int sal_call_refer_with_replaces(SalOp *h, SalOp *other_call_h);
289 int sal_call_accept_refer(SalOp *h);
290 /*informs this call is consecutive to an incoming refer */
291 int sal_call_set_referer(SalOp *h, SalOp *refered_call);
292 /* returns the SalOp of a call that should be replaced by h, if any */
293 SalOp *sal_call_get_replaces(SalOp *h);
294 int sal_call_send_dtmf(SalOp *h, char dtmf);
295 int sal_call_terminate(SalOp *h);
296 bool_t sal_call_autoanswer_asked(SalOp *op);
299 int sal_register(SalOp *op, const char *proxy, const char *from, int expires);
300 int sal_unregister(SalOp *h);
303 int sal_text_send(SalOp *op, const char *from, const char *to, const char *text);
305 /*presence Subscribe/notify*/
306 int sal_subscribe_presence(SalOp *op, const char *from, const char *to);
307 int sal_unsubscribe(SalOp *op);
308 int sal_subscribe_accept(SalOp *op);
309 int sal_subscribe_decline(SalOp *op);
310 int sal_notify_presence(SalOp *op, SalPresenceStatus status, const char *status_message);
311 int sal_notify_close(SalOp *op);
313 /*presence publish */
314 int sal_publish(SalOp *op, const char *from, const char *to, SalPresenceStatus status);
317 /*ping: main purpose is to obtain its own contact address behind firewalls*/
318 int sal_ping(SalOp *op, const char *from, const char *to);
320 #define payload_type_set_number(pt,n) (pt)->user_data=(void*)((long)n);
321 #define payload_type_get_number(pt) ((int)(long)(pt)->user_data)
324 void sal_get_default_local_ip(Sal *sal, int address_family, char *ip, size_t iplen);
328 void __sal_op_init(SalOp *b, Sal *sal);
329 void __sal_op_set_network_origin(SalOp *op, const char *origin /*a sip uri*/);
330 void __sal_op_free(SalOp *b);