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