sjero.net Git - linphone/blob - coreapi/private.h

   1 /***************************************************************************
   2  *            private.h
   3  *
   4  *  Mon Jun 13 14:23:23 2005
   5  *  Copyright  2005  Simon Morlat
   6  *  Email simon dot morlat at linphone dot org
   7  ****************************************************************************/
   8
   9 /*
  10  *  This program is free software; you can redistribute it and/or modify
  11  *  it under the terms of the GNU General Public License as published by
  12  *  the Free Software Foundation; either version 2 of the License, or
  13  *  (at your option) any later version.
  14  *
  15  *  This program is distributed in the hope that it will be useful,
  16  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  *  GNU General Public License for more details.
  19  *
  20  *  You should have received a copy of the GNU General Public License
  21  *  along with this program; if not, write to the Free Software
  22  *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23  */
  24
  25 #ifndef _PRIVATE_H
  26 #define _PRIVATE_H
  27
  28 #include "linphonecore.h"
  29 #include "sal.h"
  30
  31 #ifdef HAVE_CONFIG_H
  32 #include "config.h"
  33 #endif
  34
  35 #ifndef LIBLINPHONE_VERSION
  36 #define LIBLINPHONE_VERSION LINPHONE_VERSION
  37 #endif
  38
  39 #ifndef PACKAGE_SOUND_DIR
  40 #define PACKAGE_SOUND_DIR "."
  41 #endif
  42
  43 #ifdef HAVE_GETTEXT
  44 #include <libintl.h>
  45 #ifndef _
  46 #define _(String) gettext(String)
  47 #endif
  48 #else
  49 #ifndef _
  50 #define _(something)    (something)
  51 #endif
  52 #ifndef ngettext
  53 #define ngettext(singular, plural, number)      (((number)==1)?(singular):(plural))
  54 #endif
  55 #endif
  56
  57 typedef enum _LCState{
  58         LCStateInit,
  59         LCStateRinging,
  60         LCStateAVRunning
  61 }LCState;
  62
  63
  64 typedef struct _LinphoneCall
  65 {
  66         struct _LinphoneCore *core;
  67         SalMediaDescription *localdesc;
  68         SalMediaDescription *resultdesc;
  69         LinphoneCallDir dir;
  70         struct _RtpProfile *profile;    /*points to the local_profile or to the remote "guessed" profile*/
  71         struct _LinphoneCallLog *log;
  72         SalOp *op;
  73         char localip[LINPHONE_IPADDR_SIZE]; /* our best guess for local ipaddress for this call */
  74         time_t start_time; /*time at which the call was initiated*/
  75         time_t media_start_time; /*time at which it was accepted, media streams established*/
  76         LCState state;
  77 } LinphoneCall;
  78
  79 LinphoneCall * linphone_call_new_outgoing(struct _LinphoneCore *lc, LinphoneAddress *from, LinphoneAddress *to);
  80 LinphoneCall * linphone_call_new_incoming(struct _LinphoneCore *lc, LinphoneAddress *from, LinphoneAddress *to, SalOp *op);
  81 #define linphone_call_set_state(lcall,st)       (lcall)->state=(st)
  82 void linphone_call_destroy(struct _LinphoneCall *obj);
  83
  84 /* private: */
  85 LinphoneCallLog * linphone_call_log_new(LinphoneCall *call, LinphoneAddress *local, LinphoneAddress * remote);
  86 void linphone_call_log_completed(LinphoneCallLog *calllog, LinphoneCall *call);
  87 void linphone_call_log_destroy(LinphoneCallLog *cl);
  88
  89
  90 void linphone_core_init_media_streams(LinphoneCore *lc);
  91
  92 void linphone_auth_info_write_config(struct _LpConfig *config, LinphoneAuthInfo *obj, int pos);
  93
  94 void linphone_core_update_proxy_register(LinphoneCore *lc);
  95 void linphone_core_refresh_subscribes(LinphoneCore *lc);
  96
  97 int linphone_proxy_config_send_publish(LinphoneProxyConfig *cfg, LinphoneOnlineStatus os);
  98
  99 int linphone_online_status_to_eXosip(LinphoneOnlineStatus os);
 100
 101 void linphone_friend_notify(LinphoneFriend *lf, int ss, LinphoneOnlineStatus os);
 102
 103 int set_lock_file();
 104 int get_lock_file();
 105 int remove_lock_file();
 106 int do_registration(LinphoneCore *lc, bool_t doit);
 107 void check_for_registration(LinphoneCore *lc);
 108 void check_sound_device(LinphoneCore *lc);
 109 void linphone_core_setup_local_rtp_profile(LinphoneCore *lc);
 110 void linphone_core_get_local_ip(LinphoneCore *lc, const char *to, char *result);
 111 bool_t host_has_ipv6_network();
 112 bool_t lp_spawn_command_line_sync(const char *command, char **result,int *command_ret);
 113
 114 static inline int get_min_bandwidth(int dbw, int ubw){
 115         if (dbw<0) return ubw;
 116         if (ubw<0) return dbw;
 117         return MIN(dbw,ubw);
 118 }
 119
 120 static inline bool_t bandwidth_is_greater(int bw1, int bw2){
 121         if (bw1<0) return TRUE;
 122         else if (bw2<0) return FALSE;
 123         else return bw1>=bw2;
 124 }
 125
 126 static inline void set_string(char **dest, const char *src){
 127         if (*dest){
 128                 ms_free(*dest);
 129                 *dest=NULL;
 130         }
 131         if (src)
 132                 *dest=ms_strdup(src);
 133 }
 134
 135 #define PAYLOAD_TYPE_ENABLED    PAYLOAD_TYPE_USER_FLAG_0
 136
 137 void linphone_process_authentication(LinphoneCore* lc, SalOp *op);
 138 void linphone_authentication_ok(LinphoneCore *lc, SalOp *op);
 139 void linphone_subscription_new(LinphoneCore *lc, SalOp *op);
 140 void linphone_notify_recv(LinphoneCore *lc, SalOp *op);
 141 void linphone_proxy_config_process_authentication_failure(LinphoneCore *lc, SalOp *op);
 142
 143 void linphone_subscription_answered(LinphoneCore *lc, SalOp *op);
 144 void linphone_subscription_closed(LinphoneCore *lc, SalOp *op);
 145
 146 MSList *linphone_find_friend(MSList *fl, const LinphoneAddress *fri, LinphoneFriend **lf);
 147
 148 void linphone_core_update_allocated_audio_bandwidth(LinphoneCore *lc);
 149 void linphone_core_update_allocated_audio_bandwidth_in_call(LinphoneCore *lc, const PayloadType *pt);
 150 void linphone_core_run_stun_tests(LinphoneCore *lc, LinphoneCall *call);
 151
 152 void linphone_core_write_friends_config(LinphoneCore* lc);
 153 void linphone_friend_write_to_config_file(struct _LpConfig *config, LinphoneFriend *lf, int index);
 154 LinphoneFriend * linphone_friend_new_from_config_file(struct _LinphoneCore *lc, int index);
 155
 156 void linphone_proxy_config_update(LinphoneProxyConfig *cfg);
 157 void linphone_proxy_config_get_contact(LinphoneProxyConfig *cfg, const char **ip, int *port);
 158 LinphoneProxyConfig * linphone_core_lookup_known_proxy(LinphoneCore *lc, const LinphoneAddress *uri);
 159 int linphone_core_get_local_ip_for(const char *dest, char *result);
 160
 161 LinphoneProxyConfig *linphone_proxy_config_new_from_config_file(struct _LpConfig *config, int index);
 162 void linphone_proxy_config_write_to_config_file(struct _LpConfig* config,LinphoneProxyConfig *obj, int index);
 163
 164 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *cfg, const char *username, char *result, size_t result_len);
 165
 166 /*internal use only */
 167 void linphone_core_start_media_streams(LinphoneCore *lc, struct _LinphoneCall *call);
 168 void linphone_core_stop_media_streams(LinphoneCore *lc);
 169 const char * linphone_core_get_identity(LinphoneCore *lc);
 170 const char * linphone_core_get_route(LinphoneCore *lc);
 171 bool_t linphone_core_interpret_url(LinphoneCore *lc, const char *url, LinphoneAddress **real_parsed_url, char **route);
 172 void linphone_core_start_waiting(LinphoneCore *lc, const char *purpose);
 173 void linphone_core_update_progress(LinphoneCore *lc, const char *purpose, float progresses);
 174 void linphone_core_stop_waiting(LinphoneCore *lc);
 175
 176
 177 extern SalCallbacks linphone_sal_callbacks;
 178
 179
 180 struct _LinphoneProxyConfig
 181 {
 182         struct _LinphoneCore *lc;
 183         char *reg_proxy;
 184         char *reg_identity;
 185         char *reg_route;
 186         char *realm;
 187         int expires;
 188         int reg_time;
 189         SalOp *op;
 190         char *type;
 191         struct _SipSetupContext *ssctx;
 192         int auth_failures;
 193         char *dial_prefix;
 194         bool_t commit;
 195         bool_t reg_sendregister;
 196         bool_t registered;
 197         bool_t publish;
 198         bool_t dial_escape_plus;
 199 };
 200
 201 struct _LinphoneAuthInfo
 202 {
 203         char *username;
 204         char *realm;
 205         char *userid;
 206         char *passwd;
 207         char *ha1;
 208         bool_t works;
 209         bool_t first_time;
 210 };
 211
 212 struct _LinphoneChatRoom{
 213         struct _LinphoneCore *lc;
 214         char  *peer;
 215         char *route;
 216         LinphoneAddress *peer_url;
 217         void * user_data;
 218 };
 219
 220 struct _LinphoneFriend{
 221         LinphoneAddress *uri;
 222         SalOp *insub;
 223         SalOp *outsub;
 224         LinphoneSubscribePolicy pol;
 225         LinphoneOnlineStatus status;
 226         struct _LinphoneProxyConfig *proxy;
 227         struct _LinphoneCore *lc;
 228         BuddyInfo *info;
 229         char *refkey;
 230         bool_t subscribe;
 231         bool_t inc_subscribe_pending;
 232 };
 233
 234 typedef struct sip_config
 235 {
 236         char *contact;
 237         char *guessed_contact;
 238         int sip_port;
 239         MSList *proxies;
 240         MSList *deleted_proxies;
 241         int inc_timeout;        /*timeout after an un-answered incoming call is rejected*/
 242         bool_t use_info;
 243         bool_t use_rfc2833;     /*force RFC2833 to be sent*/
 244         bool_t guess_hostname;
 245         bool_t loopback_only;
 246         bool_t ipv6_enabled;
 247         bool_t sdp_200_ack;
 248         bool_t only_one_codec; /*in SDP answers*/
 249         bool_t register_only_when_network_is_up;
 250 } sip_config_t;
 251
 252 typedef struct rtp_config
 253 {
 254         int audio_rtp_port;
 255         int video_rtp_port;
 256         int audio_jitt_comp;  /*jitter compensation*/
 257         int video_jitt_comp;  /*jitter compensation*/
 258         int nortp_timeout;
 259 }rtp_config_t;
 260
 261
 262
 263 typedef struct net_config
 264 {
 265         char *nat_address;
 266         char *stun_server;
 267         char *relay;
 268         int download_bw;
 269         int upload_bw;
 270         int firewall_policy;
 271         int mtu;
 272         bool_t nat_sdp_only;
 273 }net_config_t;
 274
 275
 276 typedef struct sound_config
 277 {
 278         struct _MSSndCard * ring_sndcard;       /* the playback sndcard currently used */
 279         struct _MSSndCard * play_sndcard;       /* the playback sndcard currently used */
 280         struct _MSSndCard * capt_sndcard; /* the capture sndcard currently used */
 281         const char **cards;
 282         int latency;    /* latency in samples of the current used sound device */
 283         char rec_lev;
 284         char play_lev;
 285         char ring_lev;
 286         char source;
 287         char *local_ring;
 288         char *remote_ring;
 289         bool_t ec;
 290         bool_t ea;
 291         bool_t agc;
 292 } sound_config_t;
 293
 294 typedef struct codecs_config
 295 {
 296         MSList *audio_codecs;  /* list of audio codecs in order of preference*/
 297         MSList *video_codecs;   /* for later use*/
 298 }codecs_config_t;
 299
 300 typedef struct video_config{
 301         struct _MSWebCam *device;
 302         const char **cams;
 303         MSVideoSize vsize;
 304         bool_t capture;
 305         bool_t show_local;
 306         bool_t display;
 307         bool_t selfview; /*during calls*/
 308 }video_config_t;
 309
 310 typedef struct ui_config
 311 {
 312         int is_daemon;
 313         int is_applet;
 314         unsigned int timer_id;  /* the timer id for registration */
 315 }ui_config_t;
 316
 317
 318
 319 typedef struct autoreplier_config
 320 {
 321         int enabled;
 322         int after_seconds;              /* accept the call after x seconds*/
 323         int max_users;                  /* maximum number of user that can call simultaneously */
 324         int max_rec_time;       /* the max time of incoming voice recorded */
 325         int max_rec_msg;                /* maximum number of recorded messages */
 326         const char *message;            /* the path of the file to be played */
 327 }autoreplier_config_t;
 328
 329
 330 struct _LinphoneCore
 331 {
 332         LinphoneCoreVTable vtable;
 333         Sal *sal;
 334         struct _LpConfig *config;
 335         net_config_t net_conf;
 336         sip_config_t sip_conf;
 337         rtp_config_t rtp_conf;
 338         sound_config_t sound_conf;
 339         video_config_t video_conf;
 340         codecs_config_t codecs_conf;
 341         ui_config_t ui_conf;
 342         autoreplier_config_t autoreplier_conf;
 343         LinphoneProxyConfig *default_proxy;
 344         MSList *friends;
 345         MSList *auth_info;
 346         struct _RingStream *ringstream;
 347         LCCallbackObj preview_finished_cb;
 348         struct _LinphoneCall *call;   /* the current call, in the future it will be a list of calls (conferencing)*/
 349         MSList *queued_calls;   /* used by the autoreplier */
 350         MSList *call_logs;
 351         MSList *chatrooms;
 352         int max_call_logs;
 353         int missed_calls;
 354         struct _AudioStream *audiostream;  /**/
 355         struct _VideoStream *videostream;
 356         struct _VideoStream *previewstream;
 357         RtpTransport *a_rtp,*a_rtcp;
 358         struct _RtpProfile *local_profile;
 359         MSList *bl_reqs;
 360         MSList *subscribers;    /* unknown subscribers */
 361         int minutes_away;
 362         LinphoneOnlineStatus presence_mode;
 363         LinphoneOnlineStatus prev_mode;
 364         char *alt_contact;
 365         void *data;
 366         char *play_file;
 367         char *rec_file;
 368         time_t prevtime;
 369         int dw_audio_bw;
 370         int up_audio_bw;
 371         int dw_video_bw;
 372         int up_video_bw;
 373         int audio_bw;
 374         gstate_t gstate_power;
 375         gstate_t gstate_reg;
 376         gstate_t gstate_call;
 377         LinphoneWaitingCallback wait_cb;
 378         void *wait_ctx;
 379         bool_t use_files;
 380         bool_t apply_nat_settings;
 381         bool_t ready;
 382         bool_t bl_refresh;
 383         bool_t preview_finished;
 384 };
 385
 386 #endif /* _PRIVATE_H */