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