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