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