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