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