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