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 "linphonecore_utils.h"
  30 #include "sal.h"
  31
  32 #ifdef HAVE_CONFIG_H
  33 #include "config.h"
  34 #endif
  35 #include "mediastreamer2/mediastream.h"
  36
  37 #ifndef LIBLINPHONE_VERSION
  38 #define LIBLINPHONE_VERSION LINPHONE_VERSION
  39 #endif
  40
  41 #ifndef PACKAGE_SOUND_DIR
  42 #define PACKAGE_SOUND_DIR "."
  43 #endif
  44
  45 #ifdef HAVE_GETTEXT
  46 #include <libintl.h>
  47 #ifndef _
  48 #define _(String) gettext(String)
  49 #endif
  50 #else
  51 #ifndef _
  52 #define _(something)    (something)
  53 #endif
  54 #ifndef ngettext
  55 #define ngettext(singular, plural, number)      (((number)==1)?(singular):(plural))
  56 #endif
  57 #endif
  58
  59
  60 struct _LinphoneCallParams{
  61         LinphoneCall *referer; /*in case this call creation is consecutive to an incoming transfer, this points to the original call */
  62         int audio_bw; /* bandwidth limit for audio stream */
  63         bool_t has_video;
  64         bool_t real_early_media; /*send real media even during early media (for outgoing calls)*/
  65         bool_t pad[2];
  66 };
  67
  68 struct _LinphoneCall
  69 {
  70         struct _LinphoneCore *core;
  71         SalMediaDescription *localdesc;
  72         SalMediaDescription *resultdesc;
  73         LinphoneCallDir dir;
  74         struct _RtpProfile *audio_profile;
  75         struct _RtpProfile *video_profile;
  76         struct _LinphoneCallLog *log;
  77         SalOp *op;
  78         SalOp *ping_op;
  79         char localip[LINPHONE_IPADDR_SIZE]; /* our best guess for local ipaddress for this call */
  80         time_t start_time; /*time at which the call was initiated*/
  81         time_t media_start_time; /*time at which it was accepted, media streams established*/
  82         LinphoneCallState       state;
  83         LinphoneReason reason;
  84         int refcnt;
  85         void * user_pointer;
  86         int audio_port;
  87         int video_port;
  88         struct _AudioStream *audiostream;  /**/
  89         struct _VideoStream *videostream;
  90         char *refer_to;
  91         LinphoneCallParams params;
  92         LinphoneCallParams current_params;
  93         int up_bw; /*upload bandwidth setting at the time the call is started. Used to detect if it changes during a call */
  94         int audio_bw;   /*upload bandwidth used by audio */
  95         bool_t refer_pending;
  96         bool_t media_pending;
  97         bool_t audio_muted;
  98         bool_t camera_active;
  99         bool_t all_muted; /*this flag is set during early medias*/
 100         bool_t playing_ringbacktone;
 101         bool_t owns_call_log;
 102         OrtpEvQueue *audiostream_app_evq;
 103         bool_t audiostream_encrypted;
 104         char *auth_token;
 105         bool_t auth_token_verified;
 106         OrtpEvQueue *videostream_app_evq;
 107         bool_t videostream_encrypted;
 108 };
 109
 110
 111 LinphoneCall * linphone_call_new_outgoing(struct _LinphoneCore *lc, LinphoneAddress *from, LinphoneAddress *to, const LinphoneCallParams *params);
 112 LinphoneCall * linphone_call_new_incoming(struct _LinphoneCore *lc, LinphoneAddress *from, LinphoneAddress *to, SalOp *op);
 113 void linphone_call_set_state(LinphoneCall *call, LinphoneCallState cstate, const char *message);
 114
 115 /* private: */
 116 LinphoneCallLog * linphone_call_log_new(LinphoneCall *call, LinphoneAddress *local, LinphoneAddress * remote);
 117 void linphone_call_log_completed(LinphoneCall *call);
 118 void linphone_call_log_destroy(LinphoneCallLog *cl);
 119
 120 void linphone_auth_info_write_config(struct _LpConfig *config, LinphoneAuthInfo *obj, int pos);
 121
 122 void linphone_core_update_proxy_register(LinphoneCore *lc);
 123 void linphone_core_refresh_subscribes(LinphoneCore *lc);
 124 int linphone_core_abort_call(LinphoneCore *lc, LinphoneCall *call, const char *error);
 125
 126 int linphone_proxy_config_send_publish(LinphoneProxyConfig *cfg, LinphoneOnlineStatus os);
 127 void linphone_proxy_config_set_state(LinphoneProxyConfig *cfg, LinphoneRegistrationState rstate, const char *message);
 128
 129 int linphone_online_status_to_eXosip(LinphoneOnlineStatus os);
 130 void linphone_friend_close_subscriptions(LinphoneFriend *lf);
 131 void linphone_friend_notify(LinphoneFriend *lf, LinphoneOnlineStatus os);
 132 LinphoneFriend *linphone_find_friend_by_inc_subscribe(MSList *l, SalOp *op);
 133 LinphoneFriend *linphone_find_friend_by_out_subscribe(MSList *l, SalOp *op);
 134
 135 int parse_hostname_to_addr(const char *server, struct sockaddr_storage *ss, socklen_t *socklen);
 136 int set_lock_file();
 137 int get_lock_file();
 138 int remove_lock_file();
 139 int do_registration(LinphoneCore *lc, bool_t doit);
 140 void check_for_registration(LinphoneCore *lc);
 141 void check_sound_device(LinphoneCore *lc);
 142 void linphone_core_verify_codecs(LinphoneCore *lc);
 143 void linphone_core_get_local_ip(LinphoneCore *lc, const char *to, char *result);
 144 bool_t host_has_ipv6_network();
 145 bool_t lp_spawn_command_line_sync(const char *command, char **result,int *command_ret);
 146
 147 static inline int get_min_bandwidth(int dbw, int ubw){
 148         if (dbw<=0) return ubw;
 149         if (ubw<=0) return dbw;
 150         return MIN(dbw,ubw);
 151 }
 152
 153 static inline bool_t bandwidth_is_greater(int bw1, int bw2){
 154         if (bw1<0) return TRUE;
 155         else if (bw2<0) return FALSE;
 156         else return bw1>=bw2;
 157 }
 158
 159 static inline int get_video_bandwidth(int total, int audio){
 160         if (total<=0) return 0;
 161         return total-audio-10;
 162 }
 163
 164 static inline void set_string(char **dest, const char *src){
 165         if (*dest){
 166                 ms_free(*dest);
 167                 *dest=NULL;
 168         }
 169         if (src)
 170                 *dest=ms_strdup(src);
 171 }
 172
 173 #define PAYLOAD_TYPE_ENABLED    PAYLOAD_TYPE_USER_FLAG_0
 174
 175 SalPresenceStatus linphone_online_status_to_sal(LinphoneOnlineStatus os);
 176 void linphone_process_authentication(LinphoneCore* lc, SalOp *op);
 177 void linphone_authentication_ok(LinphoneCore *lc, SalOp *op);
 178 void linphone_subscription_new(LinphoneCore *lc, SalOp *op, const char *from);
 179 void linphone_notify_recv(LinphoneCore *lc, SalOp *op, SalSubscribeState ss, SalPresenceStatus status);
 180 void linphone_proxy_config_process_authentication_failure(LinphoneCore *lc, SalOp *op);
 181
 182 void linphone_subscription_answered(LinphoneCore *lc, SalOp *op);
 183 void linphone_subscription_closed(LinphoneCore *lc, SalOp *op);
 184
 185 MSList *linphone_find_friend(MSList *fl, const LinphoneAddress *fri, LinphoneFriend **lf);
 186
 187 void linphone_core_update_allocated_audio_bandwidth(LinphoneCore *lc);
 188 void linphone_core_update_allocated_audio_bandwidth_in_call(LinphoneCall *call, const PayloadType *pt);
 189 void linphone_core_run_stun_tests(LinphoneCore *lc, LinphoneCall *call);
 190
 191 void linphone_core_send_initial_subscribes(LinphoneCore *lc);
 192 void linphone_core_write_friends_config(LinphoneCore* lc);
 193 void linphone_friend_write_to_config_file(struct _LpConfig *config, LinphoneFriend *lf, int index);
 194 LinphoneFriend * linphone_friend_new_from_config_file(struct _LinphoneCore *lc, int index);
 195
 196 void linphone_proxy_config_update(LinphoneProxyConfig *cfg);
 197 void linphone_proxy_config_get_contact(LinphoneProxyConfig *cfg, const char **ip, int *port);
 198 LinphoneProxyConfig * linphone_core_lookup_known_proxy(LinphoneCore *lc, const LinphoneAddress *uri);
 199 const char *linphone_core_find_best_identity(LinphoneCore *lc, const LinphoneAddress *to, const char **route);
 200 int linphone_core_get_local_ip_for(int type, const char *dest, char *result);
 201
 202 LinphoneProxyConfig *linphone_proxy_config_new_from_config_file(struct _LpConfig *config, int index);
 203 void linphone_proxy_config_write_to_config_file(struct _LpConfig* config,LinphoneProxyConfig *obj, int index);
 204
 205 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *cfg, const char *username, char *result, size_t result_len);
 206
 207 void linphone_core_text_received(LinphoneCore *lc, const char *from, const char *msg);
 208
 209 void linphone_call_init_media_streams(LinphoneCall *call);
 210 void linphone_call_start_media_streams(LinphoneCall *call, bool_t all_inputs_muted, bool_t send_ringbacktone);
 211 void linphone_call_stop_media_streams(LinphoneCall *call);
 212
 213 const char * linphone_core_get_identity(LinphoneCore *lc);
 214 const char * linphone_core_get_route(LinphoneCore *lc);
 215 void linphone_core_start_waiting(LinphoneCore *lc, const char *purpose);
 216 void linphone_core_update_progress(LinphoneCore *lc, const char *purpose, float progresses);
 217 void linphone_core_stop_waiting(LinphoneCore *lc);
 218
 219 int linphone_core_start_invite(LinphoneCore *lc, LinphoneCall *call, LinphoneProxyConfig *dest_proxy);
 220 void linphone_core_start_refered_call(LinphoneCore *lc, LinphoneCall *call);
 221 extern SalCallbacks linphone_sal_callbacks;
 222 void linphone_proxy_config_set_error(LinphoneProxyConfig *cfg, LinphoneReason error);
 223
 224 struct _LinphoneProxyConfig
 225 {
 226         struct _LinphoneCore *lc;
 227         char *reg_proxy;
 228         char *reg_identity;
 229         char *reg_route;
 230         char *realm;
 231         int expires;
 232         int reg_time;
 233         SalOp *op;
 234         char *type;
 235         struct _SipSetupContext *ssctx;
 236         int auth_failures;
 237         char *dial_prefix;
 238         LinphoneRegistrationState state;
 239         SalOp *publish_op;
 240         bool_t commit;
 241         bool_t reg_sendregister;
 242         bool_t registered;
 243         bool_t publish;
 244         bool_t dial_escape_plus;
 245         void* user_data;
 246         time_t deletion_date;
 247         LinphoneReason error;
 248 };
 249
 250 struct _LinphoneAuthInfo
 251 {
 252         char *username;
 253         char *realm;
 254         char *userid;
 255         char *passwd;
 256         char *ha1;
 257         int usecount;
 258         time_t last_use_time;
 259         bool_t works;
 260 };
 261
 262 struct _LinphoneChatRoom{
 263         struct _LinphoneCore *lc;
 264         char  *peer;
 265         LinphoneAddress *peer_url;
 266         SalOp *op;
 267         void * user_data;
 268 };
 269
 270 struct _LinphoneFriend{
 271         LinphoneAddress *uri;
 272         SalOp *insub;
 273         SalOp *outsub;
 274         LinphoneSubscribePolicy pol;
 275         LinphoneOnlineStatus status;
 276         struct _LinphoneCore *lc;
 277         BuddyInfo *info;
 278         char *refkey;
 279         bool_t subscribe;
 280         bool_t subscribe_active;
 281         bool_t inc_subscribe_pending;
 282         bool_t commit;
 283 };
 284
 285
 286 typedef struct sip_config
 287 {
 288         char *contact;
 289         char *guessed_contact;
 290         MSList *proxies;
 291         MSList *deleted_proxies;
 292         int inc_timeout;        /*timeout after an un-answered incoming call is rejected*/
 293         unsigned int keepalive_period; /* interval in ms between keep alive messages sent to the proxy server*/
 294         LCSipTransports transports;
 295         bool_t use_info;
 296         bool_t use_rfc2833;     /*force RFC2833 to be sent*/
 297         bool_t guess_hostname;
 298         bool_t loopback_only;
 299         bool_t ipv6_enabled;
 300         bool_t sdp_200_ack;
 301         bool_t register_only_when_network_is_up;
 302         bool_t ping_with_options;
 303         bool_t auto_net_state_mon;
 304 } sip_config_t;
 305
 306 typedef struct rtp_config
 307 {
 308         int audio_rtp_port;
 309         int video_rtp_port;
 310         int audio_jitt_comp;  /*jitter compensation*/
 311         int video_jitt_comp;  /*jitter compensation*/
 312         int nortp_timeout;
 313         bool_t rtp_no_xmit_on_audio_mute;
 314                               /* stop rtp xmit when audio muted */
 315 }rtp_config_t;
 316
 317
 318
 319 typedef struct net_config
 320 {
 321         char *nat_address; /* may be IP or host name */
 322         char *nat_address_ip; /* ip translated from nat_address */
 323         char *stun_server;
 324         char *relay;
 325         int download_bw;
 326         int upload_bw;
 327         int firewall_policy;
 328         int mtu;
 329         int down_ptime;
 330         bool_t nat_sdp_only;
 331 }net_config_t;
 332
 333
 334 typedef struct sound_config
 335 {
 336         struct _MSSndCard * ring_sndcard;       /* the playback sndcard currently used */
 337         struct _MSSndCard * play_sndcard;       /* the playback sndcard currently used */
 338         struct _MSSndCard * capt_sndcard; /* the capture sndcard currently used */
 339         struct _MSSndCard * lsd_card; /* dummy playback card for Linphone Sound Daemon extension */
 340         const char **cards;
 341         int latency;    /* latency in samples of the current used sound device */
 342         char rec_lev;
 343         char play_lev;
 344         char ring_lev;
 345         char soft_play_lev;
 346         char source;
 347         char *local_ring;
 348         char *remote_ring;
 349         char *ringback_tone;
 350         bool_t ec;
 351         bool_t ea;
 352         bool_t agc;
 353 } sound_config_t;
 354
 355 typedef struct codecs_config
 356 {
 357         MSList *audio_codecs;  /* list of audio codecs in order of preference*/
 358         MSList *video_codecs;   /* for later use*/
 359 }codecs_config_t;
 360
 361 typedef struct video_config{
 362         struct _MSWebCam *device;
 363         const char **cams;
 364         MSVideoSize vsize;
 365         bool_t capture;
 366         bool_t show_local;
 367         bool_t display;
 368         bool_t selfview; /*during calls*/
 369         const char *displaytype;
 370 }video_config_t;
 371
 372 typedef struct ui_config
 373 {
 374         int is_daemon;
 375         int is_applet;
 376         unsigned int timer_id;  /* the timer id for registration */
 377 }ui_config_t;
 378
 379
 380
 381 typedef struct autoreplier_config
 382 {
 383         int enabled;
 384         int after_seconds;              /* accept the call after x seconds*/
 385         int max_users;                  /* maximum number of user that can call simultaneously */
 386         int max_rec_time;       /* the max time of incoming voice recorded */
 387         int max_rec_msg;                /* maximum number of recorded messages */
 388         const char *message;            /* the path of the file to be played */
 389 }autoreplier_config_t;
 390
 391
 392 struct _LinphoneCore
 393 {
 394         LinphoneCoreVTable vtable;
 395         Sal *sal;
 396         LinphoneGlobalState state;
 397         struct _LpConfig *config;
 398         net_config_t net_conf;
 399         sip_config_t sip_conf;
 400         rtp_config_t rtp_conf;
 401         sound_config_t sound_conf;
 402         video_config_t video_conf;
 403         codecs_config_t codecs_conf;
 404         ui_config_t ui_conf;
 405         autoreplier_config_t autoreplier_conf;
 406         MSList *payload_types;
 407         int dyn_pt;
 408         LinphoneProxyConfig *default_proxy;
 409         MSList *friends;
 410         MSList *auth_info;
 411         struct _RingStream *ringstream;
 412         time_t dmfs_playing_start_time;
 413         LCCallbackObj preview_finished_cb;
 414         LinphoneCall *current_call;   /* the current call */
 415         MSList *calls;                          /* all the processed calls */
 416         MSList *queued_calls;   /* used by the autoreplier */
 417         MSList *call_logs;
 418         MSList *chatrooms;
 419         int max_call_logs;
 420         int missed_calls;
 421         VideoPreview *previewstream;
 422         struct _MSEventQueue *msevq;
 423         RtpTransport *a_rtp,*a_rtcp;
 424         RtpTransport *v_rtp,*v_rtcp;
 425         MSList *bl_reqs;
 426         MSList *subscribers;    /* unknown subscribers */
 427         int minutes_away;
 428         LinphoneOnlineStatus presence_mode;
 429         char *alt_contact;
 430         void *data;
 431         char *play_file;
 432         char *rec_file;
 433         time_t prevtime;
 434         int audio_bw;
 435         LinphoneWaitingCallback wait_cb;
 436         void *wait_ctx;
 437         unsigned long video_window_id;
 438         unsigned long preview_window_id;
 439         time_t netup_time; /*time when network went reachable */
 440         struct _EcCalibrator *ecc;
 441         MSList *hooks;
 442         bool_t use_files;
 443         bool_t apply_nat_settings;
 444         bool_t initial_subscribes_sent;
 445         bool_t bl_refresh;
 446         bool_t preview_finished;
 447         bool_t auto_net_state_mon;
 448         bool_t network_reachable;
 449         bool_t use_preview_window;
 450         bool_t ringstream_autorelease;
 451         char* zrtp_secrets_cache;
 452 };
 453
 454 bool_t linphone_core_can_we_add_call(LinphoneCore *lc);
 455 int linphone_core_add_call( LinphoneCore *lc, LinphoneCall *call);
 456 int linphone_core_del_call( LinphoneCore *lc, LinphoneCall *call);
 457 int linphone_core_set_as_current_call(LinphoneCore *lc, LinphoneCall *call);
 458 int linphone_core_get_calls_nb(const LinphoneCore *lc);
 459
 460 void linphone_core_set_state(LinphoneCore *lc, LinphoneGlobalState gstate, const char *message);
 461
 462 SalMediaDescription *create_local_media_description(LinphoneCore *lc, LinphoneCall *call);
 463 void update_local_media_description(LinphoneCore *lc, LinphoneCall *call, SalMediaDescription **md);
 464
 465 void linphone_core_update_streams(LinphoneCore *lc, LinphoneCall *call, SalMediaDescription *new_md);
 466
 467 bool_t linphone_core_is_payload_type_usable_for_bandwidth(LinphoneCore *lc, PayloadType *pt,  int bandwidth_limit);
 468
 469 #define linphone_core_ready(lc) ((lc)->state!=LinphoneGlobalStartup)
 470 void _linphone_core_configure_resolver();
 471
 472 struct _EcCalibrator{
 473         ms_thread_t thread;
 474         MSSndCard *play_card,*capt_card;
 475         MSFilter *sndread,*det,*rec;
 476         MSFilter *play, *gen, *sndwrite,*resampler;
 477         MSTicker *ticker;
 478         LinphoneEcCalibrationCallback cb;
 479         void *cb_data;
 480         int recv_count;
 481         int sent_count;
 482         int64_t acc;
 483         int delay;
 484         unsigned int rate;
 485         LinphoneEcCalibratorStatus status;
 486 };
 487
 488 typedef struct _EcCalibrator EcCalibrator;
 489
 490 LinphoneEcCalibratorStatus ec_calibrator_get_status(EcCalibrator *ecc);
 491
 492 void ec_calibrator_destroy(EcCalibrator *ecc);
 493
 494 void linphone_call_background_tasks(LinphoneCall *call, bool_t one_second_elapsed);
 495
 496 #define HOLD_OFF        (0)
 497 #define HOLD_ON         (1)
 498
 499 #ifndef NB_MAX_CALLS
 500 #define NB_MAX_CALLS    (10)
 501 #endif
 502 void call_logs_write_to_config_file(LinphoneCore *lc);
 503 #endif /* _PRIVATE_H */