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 addr[64];
 130         int port;
 131         MSList *payloads; //<list of PayloadType
 132         int bandwidth;
 133         int ptime;
 134         SalEndpointCandidate candidates[SAL_ENDPOINT_CANDIDATE_MAX];
 135         SalStreamDir dir;
 136         SalSrtpCryptoAlgo crypto[SAL_CRYPTO_ALGO_MAX];
 137         unsigned int crypto_local_tag;
 138         int max_rate;
 139 } SalStreamDescription;
 140
 141 #define SAL_MEDIA_DESCRIPTION_MAX_STREAMS 4
 142
 143 typedef struct SalMediaDescription{
 144         int refcount;
 145         char addr[64];
 146         char username[64];
 147         int nstreams;
 148         int bandwidth;
 149         unsigned int session_ver;
 150         unsigned int session_id;
 151         SalStreamDescription streams[SAL_MEDIA_DESCRIPTION_MAX_STREAMS];
 152 } SalMediaDescription;
 153
 154 #define SAL_MEDIA_DESCRIPTION_MAX_MESSAGE_ATTRIBUTES 5
 155 #define SAL_MEDIA_DESCRIPTION_MAX_ICE_CANDIDATES 10
 156
 157 SalMediaDescription *sal_media_description_new();
 158 void sal_media_description_ref(SalMediaDescription *md);
 159 void sal_media_description_unref(SalMediaDescription *md);
 160 bool_t sal_media_description_empty(const SalMediaDescription *md);
 161 bool_t sal_media_description_equals(const SalMediaDescription *md1, const SalMediaDescription *md2);
 162 bool_t sal_media_description_has_dir(const SalMediaDescription *md, SalStreamDir dir);
 163 SalStreamDescription *sal_media_description_find_stream(SalMediaDescription *md,
 164     SalMediaProto proto, SalStreamType type);
 165 void sal_media_description_set_dir(SalMediaDescription *md, SalStreamDir stream_dir);
 166
 167 /*this structure must be at the first byte of the SalOp structure defined by implementors*/
 168 typedef struct SalOpBase{
 169         Sal *root;
 170         char *route; /*or request-uri for REGISTER*/
 171         char *contact;
 172         char *from;
 173         char *to;
 174         char *origin;
 175         char *remote_ua;
 176         SalMediaDescription *local_media;
 177         SalMediaDescription *remote_media;
 178         IceSession *ice_session;
 179         void *user_pointer;
 180 } SalOpBase;
 181
 182
 183 typedef enum SalError{
 184         SalErrorNoResponse,
 185         SalErrorProtocol,
 186         SalErrorFailure, /* see SalReason for more details */
 187         SalErrorUnknown
 188 } SalError;
 189
 190 typedef enum SalReason{
 191         SalReasonDeclined,
 192         SalReasonBusy,
 193         SalReasonRedirect,
 194         SalReasonTemporarilyUnavailable,
 195         SalReasonNotFound,
 196         SalReasonDoNotDisturb,
 197         SalReasonMedia,
 198         SalReasonForbidden,
 199         SalReasonUnknown
 200 }SalReason;
 201
 202 typedef enum SalPresenceStatus{
 203         SalPresenceOffline,
 204         SalPresenceOnline,
 205         SalPresenceBusy,
 206         SalPresenceBerightback,
 207         SalPresenceAway,
 208         SalPresenceOnthephone,
 209         SalPresenceOuttolunch,
 210         SalPresenceDonotdisturb,
 211         SalPresenceMoved,
 212         SalPresenceAltService,
 213 }SalPresenceStatus;
 214
 215 typedef enum SalReferStatus{
 216         SalReferTrying,
 217         SalReferSuccess,
 218         SalReferFailed
 219 }SalReferStatus;
 220
 221 typedef enum SalSubscribeStatus{
 222         SalSubscribeActive,
 223         SalSubscribeTerminated
 224 }SalSubscribeStatus;
 225
 226 typedef void (*SalOnCallReceived)(SalOp *op);
 227 typedef void (*SalOnCallRinging)(SalOp *op);
 228 typedef void (*SalOnCallAccepted)(SalOp *op);
 229 typedef void (*SalOnCallAck)(SalOp *op);
 230 typedef void (*SalOnCallUpdating)(SalOp *op);/*< Called when a reINVITE is received*/
 231 typedef void (*SalOnCallTerminated)(SalOp *op, const char *from);
 232 typedef void (*SalOnCallFailure)(SalOp *op, SalError error, SalReason reason, const char *details, int code);
 233 typedef void (*SalOnCallReleased)(SalOp *salop);
 234 typedef void (*SalOnAuthRequested)(SalOp *op, const char *realm, const char *username);
 235 typedef void (*SalOnAuthSuccess)(SalOp *op, const char *realm, const char *username);
 236 typedef void (*SalOnRegisterSuccess)(SalOp *op, bool_t registered);
 237 typedef void (*SalOnRegisterFailure)(SalOp *op, SalError error, SalReason reason, const char *details);
 238 typedef void (*SalOnVfuRequest)(SalOp *op);
 239 typedef void (*SalOnDtmfReceived)(SalOp *op, char dtmf);
 240 typedef void (*SalOnRefer)(Sal *sal, SalOp *op, const char *referto);
 241 typedef void (*SalOnTextReceived)(Sal *sal, const char *from, const char *msg);
 242 typedef void (*SalOnNotify)(SalOp *op, const char *from, const char *event);
 243 typedef void (*SalOnNotifyRefer)(SalOp *op, SalReferStatus state);
 244 typedef void (*SalOnNotifyPresence)(SalOp *op, SalSubscribeStatus ss, SalPresenceStatus status, const char *msg);
 245 typedef void (*SalOnSubscribeReceived)(SalOp *salop, const char *from);
 246 typedef void (*SalOnSubscribeClosed)(SalOp *salop, const char *from);
 247 typedef void (*SalOnPingReply)(SalOp *salop);
 248
 249 typedef struct SalCallbacks{
 250         SalOnCallReceived call_received;
 251         SalOnCallRinging call_ringing;
 252         SalOnCallAccepted call_accepted;
 253         SalOnCallAck call_ack;
 254         SalOnCallUpdating call_updating;
 255         SalOnCallTerminated call_terminated;
 256         SalOnCallFailure call_failure;
 257         SalOnCallReleased call_released;
 258         SalOnAuthRequested auth_requested;
 259         SalOnAuthSuccess auth_success;
 260         SalOnRegisterSuccess register_success;
 261         SalOnRegisterFailure register_failure;
 262         SalOnVfuRequest vfu_request;
 263         SalOnDtmfReceived dtmf_received;
 264         SalOnRefer refer_received;
 265         SalOnTextReceived text_received;
 266         SalOnNotify notify;
 267         SalOnNotifyPresence notify_presence;
 268         SalOnNotifyRefer notify_refer;
 269         SalOnSubscribeReceived subscribe_received;
 270         SalOnSubscribeClosed subscribe_closed;
 271         SalOnPingReply ping_reply;
 272 }SalCallbacks;
 273
 274 typedef struct SalAuthInfo{
 275         char *username;
 276         char *userid;
 277         char *password;
 278         char *realm;
 279 }SalAuthInfo;
 280
 281 SalAuthInfo* sal_auth_info_new();
 282 SalAuthInfo* sal_auth_info_clone(const SalAuthInfo* auth_info);
 283 void sal_auth_info_delete(const SalAuthInfo* auth_info);
 284
 285 void sal_set_callbacks(Sal *ctx, const SalCallbacks *cbs);
 286 int sal_listen_port(Sal *ctx, const char *addr, int port, SalTransport tr, int is_secure);
 287 int sal_unlisten_ports(Sal *ctx);
 288 ortp_socket_t sal_get_socket(Sal *ctx);
 289 void sal_set_user_agent(Sal *ctx, const char *user_agent);
 290 /*keepalive period in ms*/
 291 void sal_set_keepalive_period(Sal *ctx,unsigned int value);
 292 /**
 293  * returns keepalive period in ms
 294  * 0 desactiaved
 295  * */
 296 unsigned int sal_get_keepalive_period(Sal *ctx);
 297 void sal_use_session_timers(Sal *ctx, int expires);
 298 void sal_use_double_registrations(Sal *ctx, bool_t enabled);
 299 void sal_expire_old_registration_contacts(Sal *ctx, bool_t enabled);
 300 void sal_reuse_authorization(Sal *ctx, bool_t enabled);
 301 void sal_use_one_matching_codec_policy(Sal *ctx, bool_t one_matching_codec);
 302 void sal_use_rport(Sal *ctx, bool_t use_rports);
 303 void sal_use_101(Sal *ctx, bool_t use_101);
 304 void sal_set_root_ca(Sal* ctx, const char* rootCa);
 305 void sal_verify_server_certificates(Sal *ctx, bool_t verify);
 306
 307 int sal_iterate(Sal *sal);
 308 MSList * sal_get_pending_auths(Sal *sal);
 309
 310 /*create an operation */
 311 SalOp * sal_op_new(Sal *sal);
 312
 313 /*generic SalOp API, working for all operations */
 314 Sal *sal_op_get_sal(const SalOp *op);
 315 void sal_op_set_contact(SalOp *op, const char *contact);
 316 void sal_op_set_route(SalOp *op, const char *route);
 317 void sal_op_set_from(SalOp *op, const char *from);
 318 void sal_op_set_to(SalOp *op, const char *to);
 319 void sal_op_release(SalOp *h);
 320 void sal_op_authenticate(SalOp *h, const SalAuthInfo *info);
 321 void sal_op_cancel_authentication(SalOp *h);
 322 void sal_op_set_user_pointer(SalOp *h, void *up);
 323 void sal_op_set_ice_session(SalOp *h, IceSession *ice_session);
 324 int sal_op_get_auth_requested(SalOp *h, const char **realm, const char **username);
 325 const char *sal_op_get_from(const SalOp *op);
 326 const char *sal_op_get_to(const SalOp *op);
 327 const char *sal_op_get_contact(const SalOp *op);
 328 const char *sal_op_get_route(const SalOp *op);
 329 const char *sal_op_get_proxy(const SalOp *op);
 330 /*for incoming requests, returns the origin of the packet as a sip uri*/
 331 const char *sal_op_get_network_origin(const SalOp *op);
 332 /*returns far-end "User-Agent" string */
 333 const char *sal_op_get_remote_ua(const SalOp *op);
 334 void *sal_op_get_user_pointer(const SalOp *op);
 335 IceSession *sal_op_get_ice_session(const SalOp *op);
 336
 337 /*Call API*/
 338 int sal_call_set_local_media_description(SalOp *h, SalMediaDescription *desc);
 339 int sal_call(SalOp *h, const char *from, const char *to);
 340 int sal_call_notify_ringing(SalOp *h, bool_t early_media);
 341 /*accept an incoming call or, during a call accept a reINVITE*/
 342 int sal_call_accept(SalOp*h);
 343 int sal_call_decline(SalOp *h, SalReason reason, const char *redirection /*optional*/);
 344 int sal_call_update(SalOp *h, const char *subject);
 345 SalMediaDescription * sal_call_get_remote_media_description(SalOp *h);
 346 SalMediaDescription * sal_call_get_final_media_description(SalOp *h);
 347 int sal_call_refer(SalOp *h, const char *refer_to);
 348 int sal_call_refer_with_replaces(SalOp *h, SalOp *other_call_h);
 349 int sal_call_accept_refer(SalOp *h);
 350 /*informs this call is consecutive to an incoming refer */
 351 int sal_call_set_referer(SalOp *h, SalOp *refered_call);
 352 /* returns the SalOp of a call that should be replaced by h, if any */
 353 SalOp *sal_call_get_replaces(SalOp *h);
 354 int sal_call_send_dtmf(SalOp *h, char dtmf);
 355 int sal_call_terminate(SalOp *h);
 356 bool_t sal_call_autoanswer_asked(SalOp *op);
 357 void sal_call_send_vfu_request(SalOp *h);
 358 int sal_call_is_offerer(const SalOp *h);
 359 int sal_call_notify_refer_state(SalOp *h, SalOp *newcall);
 360
 361 /*Registration*/
 362 int sal_register(SalOp *op, const char *proxy, const char *from, int expires);
 363 int sal_register_refresh(SalOp *op, int expires);
 364 int sal_unregister(SalOp *h);
 365
 366 /*Messaging */
 367 int sal_text_send(SalOp *op, const char *from, const char *to, const char *text);
 368
 369 /*presence Subscribe/notify*/
 370 int sal_subscribe_presence(SalOp *op, const char *from, const char *to);
 371 int sal_unsubscribe(SalOp *op);
 372 int sal_subscribe_accept(SalOp *op);
 373 int sal_subscribe_decline(SalOp *op);
 374 int sal_notify_presence(SalOp *op, SalPresenceStatus status, const char *status_message);
 375 int sal_notify_close(SalOp *op);
 376
 377 /*presence publish */
 378 int sal_publish(SalOp *op, const char *from, const char *to, SalPresenceStatus status);
 379
 380
 381 /*ping: main purpose is to obtain its own contact address behind firewalls*/
 382 int sal_ping(SalOp *op, const char *from, const char *to);
 383
 384
 385
 386 #define payload_type_set_number(pt,n)   (pt)->user_data=(void*)((long)n);
 387 #define payload_type_get_number(pt)             ((int)(long)(pt)->user_data)
 388
 389 /*misc*/
 390 void sal_get_default_local_ip(Sal *sal, int address_family, char *ip, size_t iplen);
 391
 392
 393 /*internal API */
 394 void __sal_op_init(SalOp *b, Sal *sal);
 395 void __sal_op_set_network_origin(SalOp *op, const char *origin /*a sip uri*/);
 396 void __sal_op_free(SalOp *b);
 397
 398 #endif