sjero.net Git - linphone/blob - coreapi/sal.h

   1 /*
   2 linphone
   3 Copyright (C) 2010  Simon MORLAT (simon.morlat@free.fr)
   4
   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.
   9
  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.
  14
  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.
  18 */
  19
  20 /**
  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...
  24 **/
  25
  26 #ifndef sal_h
  27 #define sal_h
  28
  29 #include "mediastreamer2/mscommon.h"
  30
  31 struct Sal;
  32
  33 typedef struct Sal Sal;
  34
  35 struct SalOp;
  36
  37 typedef struct SalOp SalOp;
  38
  39 struct SalAddress;
  40
  41 typedef struct SalAddress SalAddress;
  42
  43 typedef enum {
  44         SalTransportUDP, /*UDP*/
  45         SalTransportTCP, /*TCP*/
  46         SalTransportTLS, /*TLS*/
  47         SalTransportDTLS /*DTLS*/
  48 }SalTransport;
  49
  50 const char* sal_transport_to_string(SalTransport transport);
  51 SalTransport sal_transport_parse(const char*);
  52 /* Address manipulation API*/
  53 SalAddress * sal_address_new(const char *uri);
  54 SalAddress * sal_address_clone(const SalAddress *addr);
  55 const char *sal_address_get_scheme(const SalAddress *addr);
  56 const char *sal_address_get_display_name(const SalAddress* addr);
  57 char *sal_address_get_display_name_unquoted(const SalAddress *addr);
  58 const char *sal_address_get_username(const SalAddress *addr);
  59 const char *sal_address_get_domain(const SalAddress *addr);
  60 const char * sal_address_get_port(const SalAddress *addr);
  61 int sal_address_get_port_int(const SalAddress *addr);
  62 SalTransport sal_address_get_transport(const SalAddress* addr);
  63
  64 void sal_address_set_display_name(SalAddress *addr, const char *display_name);
  65 void sal_address_set_username(SalAddress *addr, const char *username);
  66 void sal_address_set_domain(SalAddress *addr, const char *host);
  67 void sal_address_set_port(SalAddress *addr, const char *port);
  68 void sal_address_set_port_int(SalAddress *uri, int port);
  69 void sal_address_clean(SalAddress *addr);
  70 char *sal_address_as_string(const SalAddress *u);
  71 char *sal_address_as_string_uri_only(const SalAddress *u);
  72 void sal_address_destroy(SalAddress *u);
  73 void sal_address_set_param(SalAddress *u,const char* name,const char* value);
  74 void sal_address_set_transport(SalAddress* addr,SalTransport transport);
  75
  76
  77 Sal * sal_init();
  78 void sal_uninit(Sal* sal);
  79 void sal_set_user_pointer(Sal *sal, void *user_data);
  80 void *sal_get_user_pointer(const Sal *sal);
  81
  82
  83 typedef enum {
  84         SalAudio,
  85         SalVideo,
  86         SalOther
  87 } SalStreamType;
  88
  89 typedef enum{
  90         SalProtoUnknown,
  91         SalProtoRtpAvp,
  92         SalProtoRtpSavp
  93 }SalMediaProto;
  94
  95 typedef enum{
  96         SalStreamSendRecv,
  97         SalStreamSendOnly,
  98         SalStreamRecvOnly,
  99         SalStreamInactive
 100 }SalStreamDir;
 101
 102 typedef struct SalEndpointCandidate{
 103         char addr[64];
 104         int port;
 105 }SalEndpointCandidate;
 106
 107 #define SAL_ENDPOINT_CANDIDATE_MAX 2
 108
 109 typedef struct SalStreamDescription{
 110         SalMediaProto proto;
 111         SalStreamType type;
 112         char typeother[32];
 113         char addr[64];
 114         int port;
 115         MSList *payloads; //<list of PayloadType
 116         int bandwidth;
 117         int ptime;
 118         SalEndpointCandidate candidates[SAL_ENDPOINT_CANDIDATE_MAX];
 119         SalStreamDir dir;
 120 } SalStreamDescription;
 121
 122 #define SAL_MEDIA_DESCRIPTION_MAX_STREAMS 4
 123
 124 typedef struct SalMediaDescription{
 125         int refcount;
 126         char addr[64];
 127         char username[64];
 128         int nstreams;
 129         int bandwidth;
 130         unsigned int session_ver;
 131         unsigned int session_id;
 132         SalStreamDescription streams[SAL_MEDIA_DESCRIPTION_MAX_STREAMS];
 133 } SalMediaDescription;
 134
 135 SalMediaDescription *sal_media_description_new();
 136 void sal_media_description_ref(SalMediaDescription *md);
 137 void sal_media_description_unref(SalMediaDescription *md);
 138 bool_t sal_media_description_empty(const SalMediaDescription *md);
 139 bool_t sal_media_description_equals(const SalMediaDescription *md1, const SalMediaDescription *md2);
 140 bool_t sal_media_description_has_dir(const SalMediaDescription *md, SalStreamDir dir);
 141 SalStreamDescription *sal_media_description_find_stream(SalMediaDescription *md,
 142     SalMediaProto proto, SalStreamType type);
 143 void sal_media_description_set_dir(SalMediaDescription *md, SalStreamDir stream_dir);
 144
 145 /*this structure must be at the first byte of the SalOp structure defined by implementors*/
 146 typedef struct SalOpBase{
 147         Sal *root;
 148         char *route; /*or request-uri for REGISTER*/
 149         char *contact;
 150         char *from;
 151         char *to;
 152         char *origin;
 153         char *remote_ua;
 154         SalMediaDescription *local_media;
 155         SalMediaDescription *remote_media;
 156         void *user_pointer;
 157 } SalOpBase;
 158
 159
 160 typedef enum SalError{
 161         SalErrorNoResponse,
 162         SalErrorProtocol,
 163         SalErrorFailure, /* see SalReason for more details */
 164         SalErrorUnknown
 165 } SalError;
 166
 167 typedef enum SalReason{
 168         SalReasonDeclined,
 169         SalReasonBusy,
 170         SalReasonRedirect,
 171         SalReasonTemporarilyUnavailable,
 172         SalReasonNotFound,
 173         SalReasonDoNotDisturb,
 174         SalReasonMedia,
 175         SalReasonForbidden,
 176         SalReasonUnknown
 177 }SalReason;
 178
 179 typedef enum SalPresenceStatus{
 180         SalPresenceOffline,
 181         SalPresenceOnline,
 182         SalPresenceBusy,
 183         SalPresenceBerightback,
 184         SalPresenceAway,
 185         SalPresenceOnthephone,
 186         SalPresenceOuttolunch,
 187         SalPresenceDonotdisturb,
 188         SalPresenceMoved,
 189         SalPresenceAltService,
 190 }SalPresenceStatus;
 191
 192 typedef enum SalSubscribeState{
 193         SalSubscribeActive,
 194         SalSubscribeTerminated
 195 }SalSubscribeState;
 196
 197 typedef void (*SalOnCallReceived)(SalOp *op);
 198 typedef void (*SalOnCallRinging)(SalOp *op);
 199 typedef void (*SalOnCallAccepted)(SalOp *op);
 200 typedef void (*SalOnCallAck)(SalOp *op);
 201 typedef void (*SalOnCallUpdating)(SalOp *op);/*< Called when a reINVITE is received*/
 202 typedef void (*SalOnCallTerminated)(SalOp *op, const char *from);
 203 typedef void (*SalOnCallFailure)(SalOp *op, SalError error, SalReason reason, const char *details, int code);
 204 typedef void (*SalOnCallReleased)(SalOp *salop);
 205 typedef void (*SalOnAuthRequested)(SalOp *op, const char *realm, const char *username);
 206 typedef void (*SalOnAuthSuccess)(SalOp *op, const char *realm, const char *username);
 207 typedef void (*SalOnRegisterSuccess)(SalOp *op, bool_t registered);
 208 typedef void (*SalOnRegisterFailure)(SalOp *op, SalError error, SalReason reason, const char *details);
 209 typedef void (*SalOnVfuRequest)(SalOp *op);
 210 typedef void (*SalOnDtmfReceived)(SalOp *op, char dtmf);
 211 typedef void (*SalOnRefer)(Sal *sal, SalOp *op, const char *referto);
 212 typedef void (*SalOnTextReceived)(Sal *sal, const char *from, const char *msg);
 213 typedef void (*SalOnNotify)(SalOp *op, const char *from, const char *value);
 214 typedef void (*SalOnNotifyPresence)(SalOp *op, SalSubscribeState ss, SalPresenceStatus status, const char *msg);
 215 typedef void (*SalOnSubscribeReceived)(SalOp *salop, const char *from);
 216 typedef void (*SalOnSubscribeClosed)(SalOp *salop, const char *from);
 217 typedef void (*SalOnInternalMsg)(Sal *sal, const char *msg);
 218 typedef void (*SalOnPingReply)(SalOp *salop);
 219
 220 typedef struct SalCallbacks{
 221         SalOnCallReceived call_received;
 222         SalOnCallRinging call_ringing;
 223         SalOnCallAccepted call_accepted;
 224         SalOnCallAck call_ack;
 225         SalOnCallUpdating call_updating;
 226         SalOnCallTerminated call_terminated;
 227         SalOnCallFailure call_failure;
 228         SalOnCallReleased call_released;
 229         SalOnAuthRequested auth_requested;
 230         SalOnAuthSuccess auth_success;
 231         SalOnRegisterSuccess register_success;
 232         SalOnRegisterFailure register_failure;
 233         SalOnVfuRequest vfu_request;
 234         SalOnDtmfReceived dtmf_received;
 235         SalOnRefer refer_received;
 236         SalOnTextReceived text_received;
 237         SalOnNotify notify;
 238         SalOnNotifyPresence notify_presence;
 239         SalOnSubscribeReceived subscribe_received;
 240         SalOnSubscribeClosed subscribe_closed;
 241         SalOnInternalMsg internal_message;
 242         SalOnPingReply ping_reply;
 243 }SalCallbacks;
 244
 245 typedef struct SalAuthInfo{
 246         char *username;
 247         char *userid;
 248         char *password;
 249         char *realm;
 250 }SalAuthInfo;
 251
 252 SalAuthInfo* sal_auth_info_new();
 253 SalAuthInfo* sal_auth_info_clone(const SalAuthInfo* auth_info);
 254 void sal_auth_info_delete(const SalAuthInfo* auth_info);
 255
 256 void sal_set_callbacks(Sal *ctx, const SalCallbacks *cbs);
 257 int sal_listen_port(Sal *ctx, const char *addr, int port, SalTransport tr, int is_secure);
 258 int sal_unlisten_ports(Sal *ctx);
 259 ortp_socket_t sal_get_socket(Sal *ctx);
 260 void sal_set_user_agent(Sal *ctx, const char *user_agent);
 261 /*keepalive period in ms*/
 262 void sal_set_keepalive_period(Sal *ctx,unsigned int value);
 263 /**
 264  * returns keepalive period in ms
 265  * 0 desactiaved
 266  * */
 267 unsigned int sal_get_keepalive_period(Sal *ctx);
 268 void sal_use_session_timers(Sal *ctx, int expires);
 269 void sal_use_double_registrations(Sal *ctx, bool_t enabled);
 270 void sal_use_one_matching_codec_policy(Sal *ctx, bool_t one_matching_codec);
 271 void sal_use_rport(Sal *ctx, bool_t use_rports);
 272 void sal_use_101(Sal *ctx, bool_t use_101);
 273
 274 int sal_iterate(Sal *sal);
 275 MSList * sal_get_pending_auths(Sal *sal);
 276
 277 /*create an operation */
 278 SalOp * sal_op_new(Sal *sal);
 279
 280 /*generic SalOp API, working for all operations */
 281 Sal *sal_op_get_sal(const SalOp *op);
 282 void sal_op_set_contact(SalOp *op, const char *contact);
 283 void sal_op_set_route(SalOp *op, const char *route);
 284 void sal_op_set_from(SalOp *op, const char *from);
 285 void sal_op_set_to(SalOp *op, const char *to);
 286 void sal_op_release(SalOp *h);
 287 void sal_op_authenticate(SalOp *h, const SalAuthInfo *info);
 288 void sal_op_cancel_authentication(SalOp *h);
 289 void sal_op_set_user_pointer(SalOp *h, void *up);
 290 int sal_op_get_auth_requested(SalOp *h, const char **realm, const char **username);
 291 const char *sal_op_get_from(const SalOp *op);
 292 const char *sal_op_get_to(const SalOp *op);
 293 const char *sal_op_get_contact(const SalOp *op);
 294 const char *sal_op_get_route(const SalOp *op);
 295 const char *sal_op_get_proxy(const SalOp *op);
 296 /*for incoming requests, returns the origin of the packet as a sip uri*/
 297 const char *sal_op_get_network_origin(const SalOp *op);
 298 /*returns far-end "User-Agent" string */
 299 const char *sal_op_get_remote_ua(const SalOp *op);
 300 void *sal_op_get_user_pointer(const SalOp *op);
 301
 302 /*Call API*/
 303 int sal_call_set_local_media_description(SalOp *h, SalMediaDescription *desc);
 304 int sal_call(SalOp *h, const char *from, const char *to);
 305 int sal_call_notify_ringing(SalOp *h, bool_t early_media);
 306 /*accept an incoming call or, during a call accept a reINVITE*/
 307 int sal_call_accept(SalOp*h);
 308 int sal_call_decline(SalOp *h, SalReason reason, const char *redirection /*optional*/);
 309 int sal_call_update(SalOp *h, const char *subject);
 310 SalMediaDescription * sal_call_get_final_media_description(SalOp *h);
 311 int sal_call_refer(SalOp *h, const char *refer_to);
 312 int sal_call_refer_with_replaces(SalOp *h, SalOp *other_call_h);
 313 int sal_call_accept_refer(SalOp *h);
 314 /*informs this call is consecutive to an incoming refer */
 315 int sal_call_set_referer(SalOp *h, SalOp *refered_call);
 316 /* returns the SalOp of a call that should be replaced by h, if any */
 317 SalOp *sal_call_get_replaces(SalOp *h);
 318 int sal_call_send_dtmf(SalOp *h, char dtmf);
 319 int sal_call_terminate(SalOp *h);
 320 bool_t sal_call_autoanswer_asked(SalOp *op);
 321 void sal_call_send_vfu_request(SalOp *h);
 322
 323 /*Registration*/
 324 int sal_register(SalOp *op, const char *proxy, const char *from, int expires);
 325 int sal_register_refresh(SalOp *op, int expires);
 326 int sal_unregister(SalOp *h);
 327
 328 /*Messaging */
 329 int sal_text_send(SalOp *op, const char *from, const char *to, const char *text);
 330
 331 /*presence Subscribe/notify*/
 332 int sal_subscribe_presence(SalOp *op, const char *from, const char *to);
 333 int sal_unsubscribe(SalOp *op);
 334 int sal_subscribe_accept(SalOp *op);
 335 int sal_subscribe_decline(SalOp *op);
 336 int sal_notify_presence(SalOp *op, SalPresenceStatus status, const char *status_message);
 337 int sal_notify_close(SalOp *op);
 338
 339 /*presence publish */
 340 int sal_publish(SalOp *op, const char *from, const char *to, SalPresenceStatus status);
 341
 342
 343 /*ping: main purpose is to obtain its own contact address behind firewalls*/
 344 int sal_ping(SalOp *op, const char *from, const char *to);
 345
 346 #define payload_type_set_number(pt,n)   (pt)->user_data=(void*)((long)n);
 347 #define payload_type_get_number(pt)             ((int)(long)(pt)->user_data)
 348
 349 /*misc*/
 350 void sal_get_default_local_ip(Sal *sal, int address_family, char *ip, size_t iplen);
 351
 352
 353 /*internal API */
 354 void __sal_op_init(SalOp *b, Sal *sal);
 355 void __sal_op_set_network_origin(SalOp *op, const char *origin /*a sip uri*/);
 356 void __sal_op_free(SalOp *b);
 357
 358 #endif