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