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_has_dir(const SalMediaDescription *md, SalStreamDir dir);
 131 const SalStreamDescription *sal_media_description_find_stream(const SalMediaDescription *md,
 132     SalMediaProto proto, SalStreamType type);
 133 void sal_media_description_set_dir(SalMediaDescription *md, SalStreamDir stream_dir);
 134
 135 /*this structure must be at the first byte of the SalOp structure defined by implementors*/
 136 typedef struct SalOpBase{
 137         Sal *root;
 138         char *route; /*or request-uri for REGISTER*/
 139         char *contact;
 140         char *from;
 141         char *to;
 142         char *origin;
 143         SalMediaDescription *local_media;
 144         SalMediaDescription *remote_media;
 145         void *user_pointer;
 146 } SalOpBase;
 147
 148
 149 typedef enum SalError{
 150         SalErrorNoResponse,
 151         SalErrorProtocol,
 152         SalErrorFailure, /* see SalReason for more details */
 153         SalErrorUnknown
 154 } SalError;
 155
 156 typedef enum SalReason{
 157         SalReasonDeclined,
 158         SalReasonBusy,
 159         SalReasonRedirect,
 160         SalReasonTemporarilyUnavailable,
 161         SalReasonNotFound,
 162         SalReasonDoNotDisturb,
 163         SalReasonMedia,
 164         SalReasonForbidden,
 165         SalReasonUnknown
 166 }SalReason;
 167
 168 typedef enum SalPresenceStatus{
 169         SalPresenceOffline,
 170         SalPresenceOnline,
 171         SalPresenceBusy,
 172         SalPresenceBerightback,
 173         SalPresenceAway,
 174         SalPresenceOnthephone,
 175         SalPresenceOuttolunch,
 176         SalPresenceDonotdisturb,
 177         SalPresenceMoved,
 178         SalPresenceAltService,
 179 }SalPresenceStatus;
 180
 181 typedef enum SalSubscribeState{
 182         SalSubscribeActive,
 183         SalSubscribeTerminated
 184 }SalSubscribeState;
 185
 186 typedef void (*SalOnCallReceived)(SalOp *op);
 187 typedef void (*SalOnCallRinging)(SalOp *op);
 188 typedef void (*SalOnCallAccepted)(SalOp *op);
 189 typedef void (*SalOnCallAck)(SalOp *op);
 190 typedef void (*SalOnCallUpdating)(SalOp *op);/*< Called when a reINVITE is received*/
 191 typedef void (*SalOnCallTerminated)(SalOp *op, const char *from);
 192 typedef void (*SalOnCallFailure)(SalOp *op, SalError error, SalReason reason, const char *details, int code);
 193 typedef void (*SalOnAuthRequested)(SalOp *op, const char *realm, const char *username);
 194 typedef void (*SalOnAuthSuccess)(SalOp *op, const char *realm, const char *username);
 195 typedef void (*SalOnRegisterSuccess)(SalOp *op, bool_t registered);
 196 typedef void (*SalOnRegisterFailure)(SalOp *op, SalError error, SalReason reason, const char *details);
 197 typedef void (*SalOnVfuRequest)(SalOp *op);
 198 typedef void (*SalOnDtmfReceived)(SalOp *op, char dtmf);
 199 typedef void (*SalOnRefer)(Sal *sal, SalOp *op, const char *referto);
 200 typedef void (*SalOnTextReceived)(Sal *sal, const char *from, const char *msg);
 201 typedef void (*SalOnNotify)(SalOp *op, const char *from, const char *value);
 202 typedef void (*SalOnNotifyPresence)(SalOp *op, SalSubscribeState ss, SalPresenceStatus status, const char *msg);
 203 typedef void (*SalOnSubscribeReceived)(SalOp *salop, const char *from);
 204 typedef void (*SalOnSubscribeClosed)(SalOp *salop, const char *from);
 205 typedef void (*SalOnInternalMsg)(Sal *sal, const char *msg);
 206 typedef void (*SalOnPingReply)(SalOp *salop);
 207
 208 typedef struct SalCallbacks{
 209         SalOnCallReceived call_received;
 210         SalOnCallRinging call_ringing;
 211         SalOnCallAccepted call_accepted;
 212         SalOnCallAck call_ack;
 213         SalOnCallUpdating call_updating;
 214         SalOnCallTerminated call_terminated;
 215         SalOnCallFailure call_failure;
 216         SalOnAuthRequested auth_requested;
 217         SalOnAuthSuccess auth_success;
 218         SalOnRegisterSuccess register_success;
 219         SalOnRegisterFailure register_failure;
 220         SalOnVfuRequest vfu_request;
 221         SalOnDtmfReceived dtmf_received;
 222         SalOnRefer refer_received;
 223         SalOnTextReceived text_received;
 224         SalOnNotify notify;
 225         SalOnNotifyPresence notify_presence;
 226         SalOnSubscribeReceived subscribe_received;
 227         SalOnSubscribeClosed subscribe_closed;
 228         SalOnInternalMsg internal_message;
 229         SalOnPingReply ping_reply;
 230 }SalCallbacks;
 231
 232 typedef struct SalAuthInfo{
 233         char *username;
 234         char *userid;
 235         char *password;
 236         char *realm;
 237 }SalAuthInfo;
 238
 239 void sal_set_callbacks(Sal *ctx, const SalCallbacks *cbs);
 240 int sal_listen_port(Sal *ctx, const char *addr, int port, SalTransport tr, int is_secure);
 241 int sal_unlisten_ports(Sal *ctx);
 242 ortp_socket_t sal_get_socket(Sal *ctx);
 243 void sal_set_user_agent(Sal *ctx, const char *user_agent);
 244 /*keepalive period in ms*/
 245 void sal_set_keepalive_period(Sal *ctx,unsigned int value);
 246 void sal_use_session_timers(Sal *ctx, int expires);
 247 int sal_iterate(Sal *sal);
 248 MSList * sal_get_pending_auths(Sal *sal);
 249
 250 /*create an operation */
 251 SalOp * sal_op_new(Sal *sal);
 252
 253 /*generic SalOp API, working for all operations */
 254 Sal *sal_op_get_sal(const SalOp *op);
 255 void sal_op_set_contact(SalOp *op, const char *contact);
 256 void sal_op_set_route(SalOp *op, const char *route);
 257 void sal_op_set_from(SalOp *op, const char *from);
 258 void sal_op_set_to(SalOp *op, const char *to);
 259 void sal_op_release(SalOp *h);
 260 void sal_op_authenticate(SalOp *h, const SalAuthInfo *info);
 261 void sal_op_set_user_pointer(SalOp *h, void *up);
 262 int sal_op_get_auth_requested(SalOp *h, const char **realm, const char **username);
 263 const char *sal_op_get_from(const SalOp *op);
 264 const char *sal_op_get_to(const SalOp *op);
 265 const char *sal_op_get_contact(const SalOp *op);
 266 const char *sal_op_get_route(const SalOp *op);
 267 const char *sal_op_get_proxy(const SalOp *op);
 268 /*for incoming requests, returns the origin of the packet as a sip uri*/
 269 const char *sal_op_get_network_origin(const SalOp *op);
 270 void *sal_op_get_user_pointer(const SalOp *op);
 271
 272 /*Call API*/
 273 int sal_call_set_local_media_description(SalOp *h, SalMediaDescription *desc);
 274 int sal_call(SalOp *h, const char *from, const char *to);
 275 int sal_call_notify_ringing(SalOp *h);
 276 /*accept an incoming call or, during a call accept a reINVITE*/
 277 int sal_call_accept(SalOp*h);
 278 int sal_call_decline(SalOp *h, SalReason reason, const char *redirection /*optional*/);
 279 int sal_call_hold(SalOp *h, bool_t holdon);
 280 SalMediaDescription * sal_call_get_final_media_description(SalOp *h);
 281 int sal_refer(SalOp *h, const char *refer_to);
 282 int sal_refer_accept(SalOp *h);
 283 int sal_call_send_dtmf(SalOp *h, char dtmf);
 284 int sal_call_terminate(SalOp *h);
 285 bool_t sal_call_autoanswer_asked(SalOp *op);
 286
 287 /*Registration*/
 288 int sal_register(SalOp *op, const char *proxy, const char *from, int expires);
 289 int sal_unregister(SalOp *h);
 290
 291 /*Messaging */
 292 int sal_text_send(SalOp *op, const char *from, const char *to, const char *text);
 293
 294 /*presence Subscribe/notify*/
 295 int sal_subscribe_presence(SalOp *op, const char *from, const char *to);
 296 int sal_unsubscribe(SalOp *op);
 297 int sal_subscribe_accept(SalOp *op);
 298 int sal_subscribe_decline(SalOp *op);
 299 int sal_notify_presence(SalOp *op, SalPresenceStatus status, const char *status_message);
 300 int sal_notify_close(SalOp *op);
 301
 302 /*presence publish */
 303 int sal_publish(SalOp *op, const char *from, const char *to, SalPresenceStatus status);
 304
 305
 306 /*ping: main purpose is to obtain its own contact address behind firewalls*/
 307 int sal_ping(SalOp *op, const char *from, const char *to);
 308
 309 #define payload_type_set_number(pt,n)   (pt)->user_data=(void*)((long)n);
 310 #define payload_type_get_number(pt)             ((int)(long)(pt)->user_data)
 311
 312 /*misc*/
 313 void sal_get_default_local_ip(Sal *sal, int address_family, char *ip, size_t iplen);
 314
 315
 316 /*internal API */
 317 void __sal_op_init(SalOp *b, Sal *sal);
 318 void __sal_op_set_network_origin(SalOp *op, const char *origin /*a sip uri*/);
 319 void __sal_op_free(SalOp *b);
 320
 321 #endif