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