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