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
  58
  59
  60 struct _LinphoneCall
  61 {
  62         struct _LinphoneCore *core;
  63         SalMediaDescription *localdesc;
  64         SalMediaDescription *resultdesc;
  65         LinphoneCallDir dir;
  66         struct _RtpProfile *audio_profile;
  67         struct _RtpProfile *video_profile;
  68         struct _LinphoneCallLog *log;
  69         SalOp *op;
  70         SalOp *ping_op;
  71         char localip[LINPHONE_IPADDR_SIZE]; /* our best guess for local ipaddress for this call */
  72         time_t start_time; /*time at which the call was initiated*/
  73         time_t media_start_time; /*time at which it was accepted, media streams established*/
  74         LinphoneCallState       state;
  75         int refcnt;
  76         bool_t media_pending;
  77         void * user_pointer;
  78 };
  79
  80 LinphoneCall * linphone_call_new_outgoing(struct _LinphoneCore *lc, LinphoneAddress *from, LinphoneAddress *to);
  81 LinphoneCall * linphone_call_new_incoming(struct _LinphoneCore *lc, LinphoneAddress *from, LinphoneAddress *to, SalOp *op);
  82 void linphone_call_set_terminated(LinphoneCall *call);
  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, LinphoneCallStatus status);
  87 void linphone_call_log_destroy(LinphoneCallLog *cl);
  88
  89
  90 void linphone_core_init_media_streams(LinphoneCore *lc, LinphoneCall *call);
  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 void linphone_friend_close_subscriptions(LinphoneFriend *lf);
 101 void linphone_friend_notify(LinphoneFriend *lf, LinphoneOnlineStatus os);
 102 LinphoneFriend *linphone_find_friend_by_inc_subscribe(MSList *l, SalOp *op);
 103 LinphoneFriend *linphone_find_friend_by_out_subscribe(MSList *l, SalOp *op);
 104
 105
 106 int set_lock_file();
 107 int get_lock_file();
 108 int remove_lock_file();
 109 int do_registration(LinphoneCore *lc, bool_t doit);
 110 void check_for_registration(LinphoneCore *lc);
 111 void check_sound_device(LinphoneCore *lc);
 112 void linphone_core_verify_codecs(LinphoneCore *lc);
 113 void linphone_core_get_local_ip(LinphoneCore *lc, const char *to, char *result);
 114 bool_t host_has_ipv6_network();
 115 bool_t lp_spawn_command_line_sync(const char *command, char **result,int *command_ret);
 116
 117 static inline int get_min_bandwidth(int dbw, int ubw){
 118         if (dbw<=0) return ubw;
 119         if (ubw<=0) return dbw;
 120         return MIN(dbw,ubw);
 121 }
 122
 123 static inline bool_t bandwidth_is_greater(int bw1, int bw2){
 124         if (bw1<0) return TRUE;
 125         else if (bw2<0) return FALSE;
 126         else return bw1>=bw2;
 127 }
 128
 129 static inline void set_string(char **dest, const char *src){
 130         if (*dest){
 131                 ms_free(*dest);
 132                 *dest=NULL;
 133         }
 134         if (src)
 135                 *dest=ms_strdup(src);
 136 }
 137
 138 #define PAYLOAD_TYPE_ENABLED    PAYLOAD_TYPE_USER_FLAG_0
 139
 140 SalPresenceStatus linphone_online_status_to_sal(LinphoneOnlineStatus os);
 141 void linphone_process_authentication(LinphoneCore* lc, SalOp *op);
 142 void linphone_authentication_ok(LinphoneCore *lc, SalOp *op);
 143 void linphone_subscription_new(LinphoneCore *lc, SalOp *op, const char *from);
 144 void linphone_notify_recv(LinphoneCore *lc, SalOp *op, SalSubscribeState ss, SalPresenceStatus status);
 145 void linphone_proxy_config_process_authentication_failure(LinphoneCore *lc, SalOp *op);
 146
 147 void linphone_subscription_answered(LinphoneCore *lc, SalOp *op);
 148 void linphone_subscription_closed(LinphoneCore *lc, SalOp *op);
 149
 150 MSList *linphone_find_friend(MSList *fl, const LinphoneAddress *fri, LinphoneFriend **lf);
 151
 152 void linphone_core_update_allocated_audio_bandwidth(LinphoneCore *lc);
 153 void linphone_core_update_allocated_audio_bandwidth_in_call(LinphoneCore *lc, const PayloadType *pt);
 154 void linphone_core_run_stun_tests(LinphoneCore *lc, LinphoneCall *call);
 155
 156 void linphone_core_write_friends_config(LinphoneCore* lc);
 157 void linphone_friend_write_to_config_file(struct _LpConfig *config, LinphoneFriend *lf, int index);
 158 LinphoneFriend * linphone_friend_new_from_config_file(struct _LinphoneCore *lc, int index);
 159
 160 void linphone_proxy_config_update(LinphoneProxyConfig *cfg);
 161 void linphone_proxy_config_get_contact(LinphoneProxyConfig *cfg, const char **ip, int *port);
 162 LinphoneProxyConfig * linphone_core_lookup_known_proxy(LinphoneCore *lc, const LinphoneAddress *uri);
 163 int linphone_core_get_local_ip_for(int type, const char *dest, char *result);
 164
 165 LinphoneProxyConfig *linphone_proxy_config_new_from_config_file(struct _LpConfig *config, int index);
 166 void linphone_proxy_config_write_to_config_file(struct _LpConfig* config,LinphoneProxyConfig *obj, int index);
 167
 168 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *cfg, const char *username, char *result, size_t result_len);
 169
 170 void linphone_core_text_received(LinphoneCore *lc, const char *from, const char *msg);
 171
 172 void linphone_core_start_media_streams(LinphoneCore *lc, struct _LinphoneCall *call);
 173 void linphone_core_stop_media_streams(LinphoneCore *lc, struct _LinphoneCall *call);
 174 const char * linphone_core_get_identity(LinphoneCore *lc);
 175 const char * linphone_core_get_route(LinphoneCore *lc);
 176 bool_t linphone_core_is_in_communication_with(LinphoneCore *lc, const char *to);
 177 void linphone_core_start_waiting(LinphoneCore *lc, const char *purpose);
 178 void linphone_core_update_progress(LinphoneCore *lc, const char *purpose, float progresses);
 179 void linphone_core_stop_waiting(LinphoneCore *lc);
 180
 181 int linphone_core_start_invite(LinphoneCore *lc, LinphoneCall *call, LinphoneProxyConfig *dest_proxy);
 182
 183 extern SalCallbacks linphone_sal_callbacks;
 184
 185
 186 struct _LinphoneProxyConfig
 187 {
 188         struct _LinphoneCore *lc;
 189         char *reg_proxy;
 190         char *reg_identity;
 191         char *reg_route;
 192         char *realm;
 193         int expires;
 194         int reg_time;
 195         SalOp *op;
 196         char *type;
 197         struct _SipSetupContext *ssctx;
 198         int auth_failures;
 199         char *dial_prefix;
 200         bool_t commit;
 201         bool_t reg_sendregister;
 202         bool_t registered;
 203         bool_t publish;
 204         bool_t dial_escape_plus;
 205         void* user_data;
 206 };
 207
 208 struct _LinphoneAuthInfo
 209 {
 210         char *username;
 211         char *realm;
 212         char *userid;
 213         char *passwd;
 214         char *ha1;
 215         int usecount;
 216         bool_t works;
 217 };
 218
 219 struct _LinphoneChatRoom{
 220         struct _LinphoneCore *lc;
 221         char  *peer;
 222         char *route;
 223         LinphoneAddress *peer_url;
 224         void * user_data;
 225 };
 226
 227 struct _LinphoneFriend{
 228         LinphoneAddress *uri;
 229         SalOp *insub;
 230         SalOp *outsub;
 231         LinphoneSubscribePolicy pol;
 232         LinphoneOnlineStatus status;
 233         struct _LinphoneCore *lc;
 234         BuddyInfo *info;
 235         char *refkey;
 236         bool_t subscribe;
 237         bool_t subscribe_active;
 238         bool_t inc_subscribe_pending;
 239 };
 240
 241 typedef struct sip_config
 242 {
 243         char *contact;
 244         char *guessed_contact;
 245         int sip_port;
 246         MSList *proxies;
 247         MSList *deleted_proxies;
 248         int inc_timeout;        /*timeout after an un-answered incoming call is rejected*/
 249         bool_t use_info;
 250         bool_t use_rfc2833;     /*force RFC2833 to be sent*/
 251         bool_t guess_hostname;
 252         bool_t loopback_only;
 253         bool_t ipv6_enabled;
 254         bool_t sdp_200_ack;
 255         bool_t only_one_codec; /*in SDP answers*/
 256         bool_t register_only_when_network_is_up;
 257         bool_t ping_with_options;
 258         bool_t auto_net_state_mon;
 259         unsigned int keepalive_period; /* interval in ms between keep alive messages sent to the proxy server*/
 260 } sip_config_t;
 261
 262 typedef struct rtp_config
 263 {
 264         int audio_rtp_port;
 265         int video_rtp_port;
 266         int audio_jitt_comp;  /*jitter compensation*/
 267         int video_jitt_comp;  /*jitter compensation*/
 268         int nortp_timeout;
 269 }rtp_config_t;
 270
 271
 272
 273 typedef struct net_config
 274 {
 275         char *nat_address;
 276         char *stun_server;
 277         char *relay;
 278         int download_bw;
 279         int upload_bw;
 280         int firewall_policy;
 281         int mtu;
 282         int down_ptime;
 283         bool_t nat_sdp_only;
 284 }net_config_t;
 285
 286
 287 typedef struct sound_config
 288 {
 289         struct _MSSndCard * ring_sndcard;       /* the playback sndcard currently used */
 290         struct _MSSndCard * play_sndcard;       /* the playback sndcard currently used */
 291         struct _MSSndCard * capt_sndcard; /* the capture sndcard currently used */
 292         struct _MSSndCard * lsd_card; /* dummy playback card for Linphone Sound Daemon extension */
 293         const char **cards;
 294         int latency;    /* latency in samples of the current used sound device */
 295         char rec_lev;
 296         char play_lev;
 297         char ring_lev;
 298         char soft_play_lev;
 299         char source;
 300         char *local_ring;
 301         char *remote_ring;
 302         bool_t ec;
 303         bool_t ea;
 304         bool_t agc;
 305 } sound_config_t;
 306
 307 typedef struct codecs_config
 308 {
 309         MSList *audio_codecs;  /* list of audio codecs in order of preference*/
 310         MSList *video_codecs;   /* for later use*/
 311 }codecs_config_t;
 312
 313 typedef struct video_config{
 314         struct _MSWebCam *device;
 315         const char **cams;
 316         MSVideoSize vsize;
 317         bool_t capture;
 318         bool_t show_local;
 319         bool_t display;
 320         bool_t selfview; /*during calls*/
 321 }video_config_t;
 322
 323 typedef struct ui_config
 324 {
 325         int is_daemon;
 326         int is_applet;
 327         unsigned int timer_id;  /* the timer id for registration */
 328 }ui_config_t;
 329
 330
 331
 332 typedef struct autoreplier_config
 333 {
 334         int enabled;
 335         int after_seconds;              /* accept the call after x seconds*/
 336         int max_users;                  /* maximum number of user that can call simultaneously */
 337         int max_rec_time;       /* the max time of incoming voice recorded */
 338         int max_rec_msg;                /* maximum number of recorded messages */
 339         const char *message;            /* the path of the file to be played */
 340 }autoreplier_config_t;
 341
 342
 343 struct _LinphoneCore
 344 {
 345         LinphoneCoreVTable vtable;
 346         Sal *sal;
 347         struct _LpConfig *config;
 348         net_config_t net_conf;
 349         sip_config_t sip_conf;
 350         rtp_config_t rtp_conf;
 351         sound_config_t sound_conf;
 352         video_config_t video_conf;
 353         codecs_config_t codecs_conf;
 354         ui_config_t ui_conf;
 355         autoreplier_config_t autoreplier_conf;
 356         LinphoneProxyConfig *default_proxy;
 357         MSList *friends;
 358         MSList *auth_info;
 359         struct _RingStream *ringstream;
 360         LCCallbackObj preview_finished_cb;
 361         LinphoneCall *current_call;   /* the current call */
 362         MSList *calls;                          /* all the processed calls */
 363         MSList *queued_calls;   /* used by the autoreplier */
 364         MSList *call_logs;
 365         MSList *chatrooms;
 366         int max_call_logs;
 367         int missed_calls;
 368         struct _AudioStream *audiostream;  /**/
 369         struct _VideoStream *videostream;
 370         struct _VideoStream *previewstream;
 371         struct _MSEventQueue *msevq;
 372         RtpTransport *a_rtp,*a_rtcp;
 373         MSList *bl_reqs;
 374         MSList *subscribers;    /* unknown subscribers */
 375         int minutes_away;
 376         LinphoneOnlineStatus presence_mode;
 377         LinphoneOnlineStatus prev_mode;
 378         char *alt_contact;
 379         void *data;
 380         char *play_file;
 381         char *rec_file;
 382         time_t prevtime;
 383         int dw_audio_bw;
 384         int up_audio_bw;
 385         int dw_video_bw;
 386         int up_video_bw;
 387         int audio_bw;
 388         gstate_t gstate_power;
 389         gstate_t gstate_reg;
 390         gstate_t gstate_call;
 391         LinphoneWaitingCallback wait_cb;
 392         void *wait_ctx;
 393         bool_t use_files;
 394         bool_t apply_nat_settings;
 395         bool_t ready;
 396         bool_t bl_refresh;
 397         bool_t preview_finished;
 398         bool_t auto_net_state_mon;
 399         bool_t network_reachable;
 400 };
 401
 402 bool_t linphone_core_can_we_add_call(LinphoneCore *lc);
 403 int linphone_core_add_call( LinphoneCore *lc, LinphoneCall *call);
 404 int linphone_core_del_call( LinphoneCore *lc, LinphoneCall *call);
 405 int linphone_core_set_as_current_call(LinphoneCore *lc, LinphoneCall *call);
 406 int linphone_core_unset_the_current_call(LinphoneCore *lc);
 407 int linphone_core_get_calls_nb(const LinphoneCore *lc);
 408
 409 #define HOLD_OFF        (0)
 410 #define HOLD_ON         (1)
 411
 412 #ifndef NB_MAX_CALLS
 413 #define NB_MAX_CALLS    (10)
 414 #endif
 415
 416 #endif /* _PRIVATE_H */