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