1 /***************************************************************************
4 * Mon Jun 13 14:23:23 2005
5 * Copyright 2005 Simon Morlat
6 * Email simon dot morlat at linphone dot org
7 ****************************************************************************/
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.
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.
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.
30 #include "linphonecore.h"
31 #include "linphonefriend.h"
32 #include "linphone_tunnel.h"
33 #include "linphonecore_utils.h"
40 #include "mediastreamer2/ice.h"
41 #include "mediastreamer2/mediastream.h"
42 #include "mediastreamer2/msconference.h"
47 #ifndef LIBLINPHONE_VERSION
48 #define LIBLINPHONE_VERSION LINPHONE_VERSION
51 #ifndef PACKAGE_SOUND_DIR
52 #define PACKAGE_SOUND_DIR "."
55 #ifndef PACKAGE_DATA_DIR
56 #define PACKAGE_DATA_DIR "."
62 #define _(String) gettext(String)
66 #define _(something) (something)
69 #define ngettext(singular, plural, number) (((number)==1)?(singular):(plural))
73 struct _LinphoneCallParams{
74 LinphoneCall *referer; /*in case this call creation is consecutive to an incoming transfer, this points to the original call */
75 int audio_bw; /* bandwidth limit for audio stream */
76 LinphoneMediaEncryption media_encryption;
77 PayloadType *audio_codec; /*audio codec currently in use */
78 PayloadType *video_codec; /*video codec currently in use */
84 bool_t real_early_media; /*send real media even during early media (for outgoing calls)*/
85 bool_t in_conference; /*in conference mode */
90 typedef struct _CallCallbackObj
92 LinphoneCallCbFunc _func;
96 static const int linphone_call_magic=0x3343;
98 struct _LinphoneChatMessage {
100 LinphoneChatRoom* chat_room;
101 LinphoneChatMessageStateChangeCb cb;
103 void* message_userdata;
104 char* external_body_url;
105 LinphoneAddress* from;
108 typedef struct StunCandidate{
116 int magic; /*used to distinguish from proxy config*/
117 struct _LinphoneCore *core;
118 SalMediaDescription *localdesc;
119 SalMediaDescription *resultdesc;
121 LinphoneCall *referer; /*when this call is the result of a transfer, referer is set to the original call that caused the transfer*/
122 struct _RtpProfile *audio_profile;
123 struct _RtpProfile *video_profile;
124 struct _LinphoneCallLog *log;
127 char localip[LINPHONE_IPADDR_SIZE]; /* our best guess for local ipaddress for this call */
128 time_t start_time; /*time at which the call was initiated*/
129 time_t media_start_time; /*time at which it was accepted, media streams established*/
130 LinphoneCallState state;
131 LinphoneCallState transfer_state; /*idle if no transfer*/
132 LinphoneReason reason;
133 LinphoneProxyConfig *dest_proxy;
138 StunCandidate ac,vc; /*audio video ip/port discovered by STUN*/
139 struct _AudioStream *audiostream; /**/
140 struct _VideoStream *videostream;
141 MSAudioEndpoint *endpoint; /*used for conferencing*/
143 LinphoneCallParams params;
144 LinphoneCallParams current_params;
145 LinphoneCallParams remote_params;
146 int up_bw; /*upload bandwidth setting at the time the call is started. Used to detect if it changes during a call */
147 int audio_bw; /*upload bandwidth used by audio */
148 OrtpEvQueue *audiostream_app_evq;
150 OrtpEvQueue *videostream_app_evq;
151 CallCallbackObj nextVideoFrameDecoded;
152 LinphoneCallStats stats[2];
154 UpnpSession *upnp_session;
156 IceSession *ice_session;
157 LinphoneChatMessage* pending_message;
159 bool_t refer_pending;
160 bool_t media_pending;
162 bool_t camera_active;
164 bool_t all_muted; /*this flag is set during early medias*/
165 bool_t playing_ringbacktone;
166 bool_t owns_call_log;
167 bool_t ringing_beep; /* whether this call is ringing through an already existent current call*/
169 bool_t videostream_encrypted;
170 bool_t audiostream_encrypted;
171 bool_t auth_token_verified;
174 bool_t was_automatically_paused;
179 LinphoneCall * linphone_call_new_outgoing(struct _LinphoneCore *lc, LinphoneAddress *from, LinphoneAddress *to, const LinphoneCallParams *params);
180 LinphoneCall * linphone_call_new_incoming(struct _LinphoneCore *lc, LinphoneAddress *from, LinphoneAddress *to, SalOp *op);
181 void linphone_call_set_state(LinphoneCall *call, LinphoneCallState cstate, const char *message);
184 LinphoneCallLog * linphone_call_log_new(LinphoneCall *call, LinphoneAddress *local, LinphoneAddress * remote);
185 void linphone_call_log_completed(LinphoneCall *call);
186 void linphone_call_log_destroy(LinphoneCallLog *cl);
187 void linphone_call_set_transfer_state(LinphoneCall* call, LinphoneCallState state);
189 void linphone_auth_info_write_config(struct _LpConfig *config, LinphoneAuthInfo *obj, int pos);
191 void linphone_core_update_proxy_register(LinphoneCore *lc);
192 void linphone_core_refresh_subscribes(LinphoneCore *lc);
193 int linphone_core_abort_call(LinphoneCore *lc, LinphoneCall *call, const char *error);
195 int linphone_proxy_config_send_publish(LinphoneProxyConfig *cfg, LinphoneOnlineStatus os);
196 void linphone_proxy_config_set_state(LinphoneProxyConfig *cfg, LinphoneRegistrationState rstate, const char *message);
198 int linphone_online_status_to_eXosip(LinphoneOnlineStatus os);
199 void linphone_friend_close_subscriptions(LinphoneFriend *lf);
200 void linphone_friend_notify(LinphoneFriend *lf, LinphoneOnlineStatus os);
201 LinphoneFriend *linphone_find_friend_by_inc_subscribe(MSList *l, SalOp *op);
202 LinphoneFriend *linphone_find_friend_by_out_subscribe(MSList *l, SalOp *op);
204 int parse_hostname_to_addr(const char *server, struct sockaddr_storage *ss, socklen_t *socklen);
207 int remove_lock_file();
208 void check_sound_device(LinphoneCore *lc);
209 void linphone_core_get_local_ip(LinphoneCore *lc, const char *to, char *result);
210 bool_t host_has_ipv6_network();
211 bool_t lp_spawn_command_line_sync(const char *command, char **result,int *command_ret);
213 static inline int get_min_bandwidth(int dbw, int ubw){
214 if (dbw<=0) return ubw;
215 if (ubw<=0) return dbw;
219 static inline bool_t bandwidth_is_greater(int bw1, int bw2){
220 if (bw1<0) return TRUE;
221 else if (bw2<0) return FALSE;
222 else return bw1>=bw2;
225 static inline int get_video_bandwidth(int total, int audio){
226 if (total<=0) return 0;
227 return total-audio-10;
230 static inline void set_string(char **dest, const char *src){
236 *dest=ms_strdup(src);
239 #define PAYLOAD_TYPE_ENABLED PAYLOAD_TYPE_USER_FLAG_0
241 SalPresenceStatus linphone_online_status_to_sal(LinphoneOnlineStatus os);
242 void linphone_process_authentication(LinphoneCore* lc, SalOp *op);
243 void linphone_authentication_ok(LinphoneCore *lc, SalOp *op);
244 void linphone_subscription_new(LinphoneCore *lc, SalOp *op, const char *from);
245 void linphone_notify_recv(LinphoneCore *lc, SalOp *op, SalSubscribeStatus ss, SalPresenceStatus status);
246 void linphone_proxy_config_process_authentication_failure(LinphoneCore *lc, SalOp *op);
248 void linphone_subscription_answered(LinphoneCore *lc, SalOp *op);
249 void linphone_subscription_closed(LinphoneCore *lc, SalOp *op);
251 MSList *linphone_find_friend(MSList *fl, const LinphoneAddress *fri, LinphoneFriend **lf);
253 void linphone_core_update_allocated_audio_bandwidth(LinphoneCore *lc);
254 void linphone_core_update_allocated_audio_bandwidth_in_call(LinphoneCall *call, const PayloadType *pt);
256 int linphone_core_run_stun_tests(LinphoneCore *lc, LinphoneCall *call);
257 void linphone_core_adapt_to_network(LinphoneCore *lc, int ping_time_ms, LinphoneCallParams *params);
258 int linphone_core_gather_ice_candidates(LinphoneCore *lc, LinphoneCall *call);
259 void linphone_core_update_ice_state_in_call_stats(LinphoneCall *call);
260 void linphone_core_update_local_media_description_from_ice(SalMediaDescription *desc, IceSession *session);
261 void linphone_core_update_ice_from_remote_media_description(LinphoneCall *call, const SalMediaDescription *md);
262 bool_t linphone_core_media_description_contains_video_stream(const SalMediaDescription *md);
264 void linphone_core_send_initial_subscribes(LinphoneCore *lc);
265 void linphone_core_write_friends_config(LinphoneCore* lc);
266 void linphone_friend_write_to_config_file(struct _LpConfig *config, LinphoneFriend *lf, int index);
267 LinphoneFriend * linphone_friend_new_from_config_file(struct _LinphoneCore *lc, int index);
269 void linphone_proxy_config_update(LinphoneProxyConfig *cfg);
270 void linphone_proxy_config_get_contact(LinphoneProxyConfig *cfg, const char **ip, int *port);
271 LinphoneProxyConfig * linphone_core_lookup_known_proxy(LinphoneCore *lc, const LinphoneAddress *uri);
272 const char *linphone_core_find_best_identity(LinphoneCore *lc, const LinphoneAddress *to, const char **route);
273 int linphone_core_get_local_ip_for(int type, const char *dest, char *result);
275 LinphoneProxyConfig *linphone_proxy_config_new_from_config_file(struct _LpConfig *config, int index);
276 void linphone_proxy_config_write_to_config_file(struct _LpConfig* config,LinphoneProxyConfig *obj, int index);
278 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *cfg, const char *username, char *result, size_t result_len);
280 void linphone_core_message_received(LinphoneCore *lc, const char *from, const char *raw_msg,const char* external_url);
282 void linphone_core_play_tone(LinphoneCore *lc);
284 void linphone_call_init_stats(LinphoneCallStats *stats, int type);
286 void linphone_call_init_audio_stream(LinphoneCall *call);
287 void linphone_call_init_video_stream(LinphoneCall *call);
288 void linphone_call_init_media_streams(LinphoneCall *call);
289 void linphone_call_start_media_streams(LinphoneCall *call, bool_t all_inputs_muted, bool_t send_ringbacktone);
290 void linphone_call_start_media_streams_for_ice_gathering(LinphoneCall *call);
291 void linphone_call_stop_audio_stream(LinphoneCall *call);
292 void linphone_call_stop_video_stream(LinphoneCall *call);
293 void linphone_call_stop_media_streams(LinphoneCall *call);
294 void linphone_call_delete_ice_session(LinphoneCall *call);
295 void linphone_call_delete_upnp_session(LinphoneCall *call);
296 void linphone_call_stop_media_streams_for_ice_gathering(LinphoneCall *call);
297 void linphone_call_update_crypto_parameters(LinphoneCall *call, SalMediaDescription *old_md, SalMediaDescription *new_md);
299 const char * linphone_core_get_identity(LinphoneCore *lc);
300 const char * linphone_core_get_route(LinphoneCore *lc);
301 void linphone_core_start_waiting(LinphoneCore *lc, const char *purpose);
302 void linphone_core_update_progress(LinphoneCore *lc, const char *purpose, float progresses);
303 void linphone_core_stop_waiting(LinphoneCore *lc);
305 int linphone_core_proceed_with_invite_if_ready(LinphoneCore *lc, LinphoneCall *call, LinphoneProxyConfig *dest_proxy);
306 int linphone_core_start_invite(LinphoneCore *lc, LinphoneCall *call);
307 int linphone_core_start_update_call(LinphoneCore *lc, LinphoneCall *call);
308 int linphone_core_start_accept_call_update(LinphoneCore *lc, LinphoneCall *call);
309 void linphone_core_start_refered_call(LinphoneCore *lc, LinphoneCall *call);
310 void linphone_core_notify_incoming_call(LinphoneCore *lc, LinphoneCall *call);
311 bool_t linphone_core_incompatible_security(LinphoneCore *lc, SalMediaDescription *md);
312 extern SalCallbacks linphone_sal_callbacks;
313 void linphone_proxy_config_set_error(LinphoneProxyConfig *cfg, LinphoneReason error);
314 bool_t linphone_core_rtcp_enabled(const LinphoneCore *lc);
316 LinphoneCall * is_a_linphone_call(void *user_pointer);
317 LinphoneProxyConfig * is_a_linphone_proxy_config(void *user_pointer);
319 static const int linphone_proxy_config_magic=0x7979;
322 void linphone_chat_message_destroy(LinphoneChatMessage* msg);
325 struct _LinphoneProxyConfig
328 struct _LinphoneCore *lc;
333 char *contact_params;
338 struct _SipSetupContext *ssctx;
341 LinphoneRegistrationState state;
344 bool_t reg_sendregister;
346 bool_t dial_escape_plus;
348 time_t deletion_date;
349 LinphoneReason error;
352 struct _LinphoneAuthInfo
360 time_t last_use_time;
364 struct _LinphoneChatRoom{
365 struct _LinphoneCore *lc;
367 LinphoneAddress *peer_url;
373 struct _LinphoneFriend{
374 LinphoneAddress *uri;
377 LinphoneSubscribePolicy pol;
378 LinphoneOnlineStatus status;
379 struct _LinphoneCore *lc;
383 bool_t subscribe_active;
384 bool_t inc_subscribe_pending;
389 typedef struct sip_config
392 char *guessed_contact;
394 MSList *deleted_proxies;
395 int inc_timeout; /*timeout after an un-answered incoming call is rejected*/
396 int in_call_timeout; /*timeout after a call is hangup */
397 unsigned int keepalive_period; /* interval in ms between keep alive messages sent to the proxy server*/
398 LCSipTransports transports;
400 bool_t use_rfc2833; /*force RFC2833 to be sent*/
401 bool_t guess_hostname;
402 bool_t loopback_only;
405 bool_t register_only_when_network_is_up;
406 bool_t ping_with_options;
407 bool_t auto_net_state_mon;
410 typedef struct rtp_config
412 int audio_rtp_min_port;
413 int audio_rtp_max_port;
414 int video_rtp_min_port;
415 int video_rtp_max_port;
416 int audio_jitt_comp; /*jitter compensation*/
417 int video_jitt_comp; /*jitter compensation*/
419 bool_t rtp_no_xmit_on_audio_mute;
420 /* stop rtp xmit when audio muted */
421 bool_t audio_adaptive_jitt_comp_enabled;
422 bool_t video_adaptive_jitt_comp_enabled;
428 typedef struct net_config
430 char *nat_address; /* may be IP or host name */
431 char *nat_address_ip; /* ip translated from nat_address */
442 typedef struct sound_config
444 struct _MSSndCard * ring_sndcard; /* the playback sndcard currently used */
445 struct _MSSndCard * play_sndcard; /* the playback sndcard currently used */
446 struct _MSSndCard * capt_sndcard; /* the capture sndcard currently used */
447 struct _MSSndCard * lsd_card; /* dummy playback card for Linphone Sound Daemon extension */
449 int latency; /* latency in samples of the current used sound device */
450 float soft_play_lev; /*playback gain in db.*/
451 float soft_mic_lev; /*mic gain in db.*/
464 typedef struct codecs_config
466 MSList *audio_codecs; /* list of audio codecs in order of preference*/
467 MSList *video_codecs; /* for later use*/
470 typedef struct video_config{
471 struct _MSWebCam *device;
477 bool_t selfview; /*during calls*/
478 const char *displaytype;
481 typedef struct ui_config
485 unsigned int timer_id; /* the timer id for registration */
490 typedef struct autoreplier_config
493 int after_seconds; /* accept the call after x seconds*/
494 int max_users; /* maximum number of user that can call simultaneously */
495 int max_rec_time; /* the max time of incoming voice recorded */
496 int max_rec_msg; /* maximum number of recorded messages */
497 const char *message; /* the path of the file to be played */
498 }autoreplier_config_t;
500 struct _LinphoneConference{
501 MSAudioConference *conf;
502 AudioStream *local_participant;
503 MSAudioEndpoint *local_endpoint;
504 RtpProfile *local_dummy_profile;
508 typedef struct _LinphoneConference LinphoneConference;
512 LinphoneCoreVTable vtable;
514 LinphoneGlobalState state;
515 struct _LpConfig *config;
516 RtpProfile *default_profile;
517 net_config_t net_conf;
518 sip_config_t sip_conf;
519 rtp_config_t rtp_conf;
520 sound_config_t sound_conf;
521 video_config_t video_conf;
522 codecs_config_t codecs_conf;
524 autoreplier_config_t autoreplier_conf;
525 MSList *payload_types;
527 LinphoneProxyConfig *default_proxy;
530 struct _RingStream *ringstream;
531 time_t dmfs_playing_start_time;
532 LCCallbackObj preview_finished_cb;
533 LinphoneCall *current_call; /* the current call */
534 MSList *calls; /* all the processed calls */
535 MSList *queued_calls; /* used by the autoreplier */
540 VideoPreview *previewstream;
541 struct _MSEventQueue *msevq;
542 LinphoneRtpTransportFactories *rtptf;
544 MSList *subscribers; /* unknown subscribers */
546 LinphoneOnlineStatus presence_mode;
553 LinphoneWaitingCallback wait_cb;
555 unsigned long video_window_id;
556 unsigned long preview_window_id;
557 time_t netup_time; /*time when network went reachable */
558 struct _EcCalibrator *ecc;
560 LinphoneConference conf_ctx;
561 char* zrtp_secrets_cache;
562 LinphoneVideoPolicy video_policy;
564 bool_t apply_nat_settings;
565 bool_t initial_subscribes_sent;
568 bool_t preview_finished;
569 bool_t auto_net_state_mon;
570 bool_t network_reachable;
571 bool_t use_preview_window;
573 time_t network_last_check;
574 bool_t network_last_status;
576 bool_t ringstream_autorelease;
580 LinphoneTunnel *tunnel;
582 MSList *last_recv_msg_ids;
588 LinphoneTunnel *linphone_core_tunnel_new(LinphoneCore *lc);
589 void linphone_tunnel_destroy(LinphoneTunnel *tunnel);
590 void linphone_tunnel_configure(LinphoneTunnel *tunnel);
591 void linphone_tunnel_enable_logs_with_handler(LinphoneTunnel *tunnel, bool_t enabled, OrtpLogFunc logHandler);
593 bool_t linphone_core_can_we_add_call(LinphoneCore *lc);
594 int linphone_core_add_call( LinphoneCore *lc, LinphoneCall *call);
595 int linphone_core_del_call( LinphoneCore *lc, LinphoneCall *call);
596 int linphone_core_set_as_current_call(LinphoneCore *lc, LinphoneCall *call);
597 int linphone_core_get_calls_nb(const LinphoneCore *lc);
599 void linphone_core_set_state(LinphoneCore *lc, LinphoneGlobalState gstate, const char *message);
600 void linphone_call_make_local_media_description(LinphoneCore *lc, LinphoneCall *call);
601 void linphone_core_update_streams(LinphoneCore *lc, LinphoneCall *call, SalMediaDescription *new_md);
603 bool_t linphone_core_is_payload_type_usable_for_bandwidth(LinphoneCore *lc, PayloadType *pt, int bandwidth_limit);
605 #define linphone_core_ready(lc) ((lc)->state!=LinphoneGlobalStartup)
606 void _linphone_core_configure_resolver();
608 struct _EcCalibrator{
610 MSSndCard *play_card,*capt_card;
611 MSFilter *sndread,*det,*rec;
612 MSFilter *play, *gen, *sndwrite;
613 MSFilter *read_resampler,*write_resampler;
615 LinphoneEcCalibrationCallback cb;
622 LinphoneEcCalibratorStatus status;
625 typedef struct _EcCalibrator EcCalibrator;
627 LinphoneEcCalibratorStatus ec_calibrator_get_status(EcCalibrator *ecc);
629 void ec_calibrator_destroy(EcCalibrator *ecc);
631 void linphone_call_background_tasks(LinphoneCall *call, bool_t one_second_elapsed);
632 void linphone_core_preempt_sound_resources(LinphoneCore *lc);
633 /*conferencing subsystem*/
634 void _post_configure_audio_stream(AudioStream *st, LinphoneCore *lc, bool_t muted);
635 /* When a conference participant pause the conference he may send a music.
636 * We don't want to hear that music or to send it to the other participants.
637 * Use muted=yes to handle this case.
639 void linphone_call_add_to_conf(LinphoneCall *call, bool_t muted);
640 void linphone_call_remove_from_conf(LinphoneCall *call);
641 void linphone_core_conference_check_uninit(LinphoneCore *lc);
642 bool_t linphone_core_sound_resources_available(LinphoneCore *lc);
643 void linphone_core_notify_refer_state(LinphoneCore *lc, LinphoneCall *referer, LinphoneCall *newcall);
644 unsigned int linphone_core_get_audio_features(LinphoneCore *lc);
646 void __linphone_core_invalidate_registers(LinphoneCore* lc);
647 void _linphone_core_codec_config_write(LinphoneCore *lc);
653 #define NB_MAX_CALLS (10)
655 void call_logs_write_to_config_file(LinphoneCore *lc);
657 int linphone_core_get_edge_bw(LinphoneCore *lc);
658 int linphone_core_get_edge_ptime(LinphoneCore *lc);
660 int linphone_upnp_init(LinphoneCore *lc);
661 void linphone_upnp_destroy(LinphoneCore *lc);
667 #endif /* _PRIVATE_H */