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 const char *sal_address_get_username(const SalAddress *addr);
  49 const char *sal_address_get_domain(const SalAddress *addr);
  50 void sal_address_set_display_name(SalAddress *addr, const char *display_name);
  51 void sal_address_set_username(SalAddress *addr, const char *username);
  52 void sal_address_set_domain(SalAddress *addr, const char *host);
  53 void sal_address_set_port(SalAddress *addr, const char *port);
  54 void sal_address_set_port_int(SalAddress *uri, int port);
  55 void sal_address_clean(SalAddress *addr);
  56 char *sal_address_as_string(const SalAddress *u);
  57 char *sal_address_as_string_uri_only(const SalAddress *u);
  58 void sal_address_destroy(SalAddress *u);
  59
  60
  61
  62
  63 Sal * sal_init();
  64 void sal_uninit(Sal* sal);
  65
  66 typedef enum {
  67         SalTransportDatagram,
  68         SalTransportStream
  69 }SalTransport;
  70
  71 typedef enum {
  72         SalAudio,
  73         SalVideo,
  74         SalOther
  75 } SalStreamType;
  76
  77 typedef enum{
  78         SalProtoUnknown,
  79         SalProtoRtpAvp,
  80         SalProtoRtpSavp
  81 }SalMediaProto;
  82
  83 typedef struct SalStreamDescription{
  84         SalMediaProto proto;
  85         SalStreamType type;
  86         char addr[64];
  87         int port;
  88         MSList *payloads; //<list of PayloadType
  89         int bandwidth;
  90         int ptime;
  91 } SalStreamDescription;
  92
  93 #define SAL_MEDIA_DESCRIPTION_MAX_STREAMS 4
  94
  95 typedef struct SalMediaDescription{
  96         int refcount;
  97         char addr[64];
  98         char username[64];
  99         int nstreams;
 100         SalStreamDescription streams[SAL_MEDIA_DESCRIPTION_MAX_STREAMS];
 101 } SalMediaDescription;
 102
 103 SalMediaDescription *sal_media_description_new();
 104 void sal_media_description_ref(SalMediaDescription *md);
 105 void sal_media_description_unref(SalMediaDescription *md);
 106 SalStreamDescription *sal_media_description_find_stream(SalMediaDescription *md,
 107     SalMediaProto proto, SalStreamType type);
 108
 109 /*this structure must be at the first byte of the SalOp structure defined by implementors*/
 110 typedef struct SalOpBase{
 111         Sal *root;
 112         char *route;
 113         char *contact;
 114         char *from;
 115         char *to;
 116         SalMediaDescription *local_media;
 117         SalMediaDescription *remote_media;
 118         void *user_pointer;
 119 } SalOpBase;
 120
 121
 122 typedef enum SalError{
 123         SalErrorNoResponse,
 124         SalErrorMedia,
 125         SalErrorFailure, /* see SalReason for more details */
 126         SalErrorUnknown
 127 } SalError;
 128
 129 typedef enum SalReason{
 130         SalReasonDeclined,
 131         SalReasonBusy,
 132         SalReasonRedirect,
 133         SalReasonTemporarilyUnavailable,
 134         SalReasonNotFound,
 135         SalReasonDoNotDisturb,
 136         SalReasonForbidden,
 137         SalReasonUnknown
 138 }SalReason;
 139
 140 typedef enum SalPresenceStatus{
 141         SalPresenceOffline,
 142         SalPresenceOnline,
 143         SalPresenceBusy,
 144         SalPresenceBerightback,
 145         SalPresenceAway,
 146         SalPresenceOnthephone,
 147         SalPresenceOuttolunch,
 148         SalPresenceDonotdisturb,
 149         SalPresenceMoved,
 150         SalPresenceAltService,
 151 }SalPresenceStatus;
 152
 153 typedef void (*SalOnCallReceived)(SalOp *op);
 154 typedef void (*SalOnCallRinging)(SalOp *op);
 155 typedef void (*SalOnCallAccepted)(SalOp *op);
 156 typedef void (*SalOnCallAck)(SalOp *op);
 157 typedef void (*SalOnCallUpdated)(SalOp *op);
 158 typedef void (*SalOnCallTerminated)(SalOp *op);
 159 typedef void (*SalOnCallFailure)(SalOp *op, SalError error, SalReason reason, const char *details);
 160 typedef void (*SalOnAuthRequested)(SalOp *op, const char *realm, const char *username);
 161 typedef void (*SalOnAuthSuccess)(SalOp *op, const char *realm, const char *username);
 162 typedef void (*SalOnRegisterSuccess)(SalOp *op, bool_t registered);
 163 typedef void (*SalOnRegisterFailure)(SalOp *op, SalError error, SalReason reason, const char *details);
 164 typedef void (*SalOnVfuRequest)(SalOp *op);
 165 typedef void (*SalOnDtmfReceived)(SalOp *op, char dtmf);
 166 typedef void (*SalOnRefer)(Sal *sal, SalOp *op, const char *referto);
 167 typedef void (*SalOnTextReceived)(Sal *sal, const char *from, const char *msg);
 168 typedef void (*SalOnPresenceChanged)(SalOp *op, SalPresenceStatus status, const char *msg);
 169 typedef void (*SalOnSubscribeReceived)(SalOp *sal, const char *from);
 170 typedef void (*SalOnInternalMsg)(Sal *sal, const char *msg);
 171
 172 typedef struct SalCallbacks{
 173         SalOnCallReceived call_received;
 174         SalOnCallRinging call_ringing;
 175         SalOnCallAccepted call_accepted;
 176         SalOnCallAck call_ack;
 177         SalOnCallUpdated call_updated;
 178         SalOnCallTerminated call_terminated;
 179         SalOnCallFailure call_failure;
 180         SalOnAuthRequested auth_requested;
 181         SalOnAuthSuccess auth_success;
 182         SalOnRegisterSuccess register_success;
 183         SalOnRegisterFailure register_failure;
 184         SalOnVfuRequest vfu_request;
 185         SalOnDtmfReceived dtmf_received;
 186         SalOnRefer refer_received;
 187         SalOnTextReceived text_received;
 188         SalOnPresenceChanged presence_changed;
 189         SalOnSubscribeReceived subscribe_received;
 190         SalOnInternalMsg internal_message;
 191 }SalCallbacks;
 192
 193 typedef struct SalAuthInfo{
 194         char *username;
 195         char *userid;
 196         char *password;
 197         char *realm;
 198 }SalAuthInfo;
 199
 200 void sal_set_callbacks(Sal *ctx, const SalCallbacks *cbs);
 201 int sal_listen_port(Sal *ctx, const char *addr, int port, SalTransport tr, int is_secure);
 202 void sal_set_user_agent(Sal *ctx, const char *user_agent);
 203 void sal_use_session_timers(Sal *ctx, int expires);
 204 int sal_iterate(Sal *sal);
 205
 206 /*create an operation */
 207 SalOp * sal_op_new(Sal *sal);
 208
 209 /*generic SalOp API, working for all operations */
 210 void sal_op_set_contact(SalOp *op, const char *contact);
 211 void sal_op_set_route(SalOp *op, const char *route);
 212 void sal_op_set_from(SalOp *op, const char *from);
 213 void sal_op_set_to(SalOp *op, const char *to);
 214 void sal_op_release(SalOp *h);
 215 void sal_op_authenticate(SalOp *h, const SalAuthInfo *info);
 216 void sal_op_set_user_pointer(SalOp *h, void *up);
 217 const char *sal_op_get_from(const SalOp *op);
 218 const char *sal_op_get_to(const SalOp *op);
 219 const char *sal_op_get_contact(const SalOp *op);
 220 const char *sal_op_get_route(const SalOp *op);
 221 void *sal_op_get_user_pointer(const SalOp *op);
 222
 223 /*Call API*/
 224 int sal_call_set_local_media_description(SalOp *h, SalMediaDescription *desc);
 225 int sal_call(SalOp *h, const char *from, const char *to);
 226 int sal_call_accept(SalOp*h);
 227 int sal_call_decline(SalOp *h, SalReason reason, const char *redirection /*optional*/);
 228 const SalMediaDescription * sal_call_get_final_media_description(SalOp *h);
 229 int sal_call_terminate(SalOp *h);
 230
 231 /*Registration*/
 232 int sal_register(SalOp *op, const char *proxy, const char *from, int expires);
 233
 234 /*Messaging */
 235 int sal_text_send(SalOp *op, const char *from, const char *to, const char *text);
 236
 237 /*presence Subscribe/notify*/
 238 int sal_subscribe_presence(SalOp *op, const char *from, const char *to);
 239 int sal_subscribe_accept(SalOp *op);
 240 int sal_subscribe_decline(SalOp *op);
 241 int sal_notify_presence(SalOp *op, SalPresenceStatus status, const char *status_message);
 242
 243
 244 #define payload_type_set_number(pt,n)   (pt)->user_data=(void*)((long)n);
 245 #define payload_type_get_number(pt)             ((int)(long)(pt)->user_data)
 246
 247 /*misc*/
 248 void sal_get_default_local_ip(Sal *sal, int address_family, char *ip, size_t iplen);
 249
 250
 251 /*internal API */
 252 void __sal_op_init(SalOp *b, Sal *sal);
 253 void __sal_op_free(SalOp *b);
 254
 255
 256 #endif