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 SalCustomHeader *custom_headers;
86 bool_t real_early_media; /*send real media even during early media (for outgoing calls)*/
87 bool_t in_conference; /*in conference mode */
92 struct _LinphoneCallLog{
93 struct _LinphoneCore *lc;
94 LinphoneCallDir dir; /**< The direction of the call*/
95 LinphoneCallStatus status; /**< The status of the call*/
96 LinphoneAddress *from; /**<Originator of the call as a LinphoneAddress object*/
97 LinphoneAddress *to; /**<Destination of the call as a LinphoneAddress object*/
98 char start_date[128]; /**<Human readable string containing the start date*/
99 int duration; /**<Duration of the call in seconds*/
102 rtp_stats_t local_stats;
103 rtp_stats_t remote_stats;
105 time_t start_date_time; /**Start date of the call in seconds as expressed in a time_t */
106 char* call_id; /**unique id of a call*/
107 bool_t video_enabled;
110 typedef struct _CallCallbackObj
112 LinphoneCallCbFunc _func;
116 static const int linphone_call_magic=0x3343;
118 struct _LinphoneChatMessage {
120 LinphoneChatRoom* chat_room;
121 LinphoneChatMessageStateChangeCb cb;
123 void* message_userdata;
124 char* external_body_url;
125 LinphoneAddress* from;
127 SalCustomHeader *custom_headers;
130 typedef struct StunCandidate{
138 int magic; /*used to distinguish from proxy config*/
139 struct _LinphoneCore *core;
140 SalMediaDescription *localdesc;
141 SalMediaDescription *resultdesc;
143 LinphoneCall *referer; /*when this call is the result of a transfer, referer is set to the original call that caused the transfer*/
144 struct _RtpProfile *audio_profile;
145 struct _RtpProfile *video_profile;
146 struct _LinphoneCallLog *log;
149 char localip[LINPHONE_IPADDR_SIZE]; /* our best guess for local ipaddress for this call */
150 time_t start_time; /*time at which the call was initiated*/
151 time_t media_start_time; /*time at which it was accepted, media streams established*/
152 LinphoneCallState state;
153 LinphoneCallState transfer_state; /*idle if no transfer*/
154 LinphoneReason reason;
155 LinphoneProxyConfig *dest_proxy;
160 StunCandidate ac,vc; /*audio video ip/port discovered by STUN*/
161 struct _AudioStream *audiostream; /**/
162 struct _VideoStream *videostream;
163 MSAudioEndpoint *endpoint; /*used for conferencing*/
165 LinphoneCallParams params;
166 LinphoneCallParams current_params;
167 LinphoneCallParams remote_params;
168 int up_bw; /*upload bandwidth setting at the time the call is started. Used to detect if it changes during a call */
169 int audio_bw; /*upload bandwidth used by audio */
170 OrtpEvQueue *audiostream_app_evq;
172 OrtpEvQueue *videostream_app_evq;
173 CallCallbackObj nextVideoFrameDecoded;
174 LinphoneCallStats stats[2];
176 UpnpSession *upnp_session;
178 IceSession *ice_session;
179 LinphoneChatMessage* pending_message;
181 unsigned int remote_session_id;
182 unsigned int remote_session_ver;
183 bool_t refer_pending;
184 bool_t media_pending;
186 bool_t camera_active;
188 bool_t all_muted; /*this flag is set during early medias*/
189 bool_t playing_ringbacktone;
190 bool_t owns_call_log;
191 bool_t ringing_beep; /* whether this call is ringing through an already existent current call*/
193 bool_t videostream_encrypted;
194 bool_t audiostream_encrypted;
195 bool_t auth_token_verified;
198 bool_t was_automatically_paused;
200 bool_t record_active;
204 LinphoneCall * linphone_call_new_outgoing(struct _LinphoneCore *lc, LinphoneAddress *from, LinphoneAddress *to, const LinphoneCallParams *params);
205 LinphoneCall * linphone_call_new_incoming(struct _LinphoneCore *lc, LinphoneAddress *from, LinphoneAddress *to, SalOp *op);
206 void linphone_call_set_state(LinphoneCall *call, LinphoneCallState cstate, const char *message);
209 LinphoneCallLog * linphone_call_log_new(LinphoneCall *call, LinphoneAddress *local, LinphoneAddress * remote);
210 void linphone_call_log_completed(LinphoneCall *call);
211 void linphone_call_log_destroy(LinphoneCallLog *cl);
212 void linphone_call_set_transfer_state(LinphoneCall* call, LinphoneCallState state);
214 void linphone_auth_info_write_config(struct _LpConfig *config, LinphoneAuthInfo *obj, int pos);
216 void linphone_core_update_proxy_register(LinphoneCore *lc);
217 void linphone_core_refresh_subscribes(LinphoneCore *lc);
218 int linphone_core_abort_call(LinphoneCore *lc, LinphoneCall *call, const char *error);
220 int linphone_proxy_config_send_publish(LinphoneProxyConfig *cfg, LinphoneOnlineStatus os);
221 void linphone_proxy_config_set_state(LinphoneProxyConfig *cfg, LinphoneRegistrationState rstate, const char *message);
223 int linphone_online_status_to_eXosip(LinphoneOnlineStatus os);
224 void linphone_friend_close_subscriptions(LinphoneFriend *lf);
225 void linphone_friend_notify(LinphoneFriend *lf, LinphoneOnlineStatus os);
226 LinphoneFriend *linphone_find_friend_by_inc_subscribe(MSList *l, SalOp *op);
227 LinphoneFriend *linphone_find_friend_by_out_subscribe(MSList *l, SalOp *op);
229 int parse_hostname_to_addr(const char *server, struct sockaddr_storage *ss, socklen_t *socklen);
232 int remove_lock_file();
233 void check_sound_device(LinphoneCore *lc);
234 void linphone_core_get_local_ip(LinphoneCore *lc, const char *to, char *result);
235 bool_t host_has_ipv6_network();
236 bool_t lp_spawn_command_line_sync(const char *command, char **result,int *command_ret);
238 static inline int get_min_bandwidth(int dbw, int ubw){
239 if (dbw<=0) return ubw;
240 if (ubw<=0) return dbw;
244 static inline bool_t bandwidth_is_greater(int bw1, int bw2){
245 if (bw1<0) return TRUE;
246 else if (bw2<0) return FALSE;
247 else return bw1>=bw2;
250 static inline int get_video_bandwidth(int total, int audio){
251 if (total<=0) return 0;
252 return total-audio-10;
255 static inline void set_string(char **dest, const char *src){
261 *dest=ms_strdup(src);
264 #define PAYLOAD_TYPE_ENABLED PAYLOAD_TYPE_USER_FLAG_0
266 SalPresenceStatus linphone_online_status_to_sal(LinphoneOnlineStatus os);
267 void linphone_process_authentication(LinphoneCore* lc, SalOp *op);
268 void linphone_authentication_ok(LinphoneCore *lc, SalOp *op);
269 void linphone_subscription_new(LinphoneCore *lc, SalOp *op, const char *from);
270 void linphone_notify_recv(LinphoneCore *lc, SalOp *op, SalSubscribeStatus ss, SalPresenceStatus status);
271 void linphone_proxy_config_process_authentication_failure(LinphoneCore *lc, SalOp *op);
273 void linphone_subscription_answered(LinphoneCore *lc, SalOp *op);
274 void linphone_subscription_closed(LinphoneCore *lc, SalOp *op);
276 MSList *linphone_find_friend(MSList *fl, const LinphoneAddress *fri, LinphoneFriend **lf);
278 void linphone_core_update_allocated_audio_bandwidth(LinphoneCore *lc);
279 void linphone_core_update_allocated_audio_bandwidth_in_call(LinphoneCall *call, const PayloadType *pt);
281 int linphone_core_run_stun_tests(LinphoneCore *lc, LinphoneCall *call);
282 void linphone_core_adapt_to_network(LinphoneCore *lc, int ping_time_ms, LinphoneCallParams *params);
283 int linphone_core_gather_ice_candidates(LinphoneCore *lc, LinphoneCall *call);
284 void linphone_core_update_ice_state_in_call_stats(LinphoneCall *call);
285 void linphone_core_update_local_media_description_from_ice(SalMediaDescription *desc, IceSession *session);
286 void linphone_core_update_ice_from_remote_media_description(LinphoneCall *call, const SalMediaDescription *md);
287 bool_t linphone_core_media_description_contains_video_stream(const SalMediaDescription *md);
289 void linphone_core_send_initial_subscribes(LinphoneCore *lc);
290 void linphone_core_write_friends_config(LinphoneCore* lc);
291 void linphone_friend_write_to_config_file(struct _LpConfig *config, LinphoneFriend *lf, int index);
292 LinphoneFriend * linphone_friend_new_from_config_file(struct _LinphoneCore *lc, int index);
294 void linphone_proxy_config_update(LinphoneProxyConfig *cfg);
295 void linphone_proxy_config_get_contact(LinphoneProxyConfig *cfg, const char **ip, int *port);
296 LinphoneProxyConfig * linphone_core_lookup_known_proxy(LinphoneCore *lc, const LinphoneAddress *uri);
297 const char *linphone_core_find_best_identity(LinphoneCore *lc, const LinphoneAddress *to, const char **route);
298 int linphone_core_get_local_ip_for(int type, const char *dest, char *result);
300 LinphoneProxyConfig *linphone_proxy_config_new_from_config_file(struct _LpConfig *config, int index);
301 void linphone_proxy_config_write_to_config_file(struct _LpConfig* config,LinphoneProxyConfig *obj, int index);
303 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *cfg, const char *username, char *result, size_t result_len);
305 void linphone_core_message_received(LinphoneCore *lc, SalOp *op, const SalMessage *msg);
307 void linphone_core_play_tone(LinphoneCore *lc);
309 void linphone_call_init_stats(LinphoneCallStats *stats, int type);
311 void linphone_call_init_audio_stream(LinphoneCall *call);
312 void linphone_call_init_video_stream(LinphoneCall *call);
313 void linphone_call_init_media_streams(LinphoneCall *call);
314 void linphone_call_start_media_streams(LinphoneCall *call, bool_t all_inputs_muted, bool_t send_ringbacktone);
315 void linphone_call_start_media_streams_for_ice_gathering(LinphoneCall *call);
316 void linphone_call_stop_audio_stream(LinphoneCall *call);
317 void linphone_call_stop_video_stream(LinphoneCall *call);
318 void linphone_call_stop_media_streams(LinphoneCall *call);
319 void linphone_call_delete_ice_session(LinphoneCall *call);
320 void linphone_call_delete_upnp_session(LinphoneCall *call);
321 void linphone_call_stop_media_streams_for_ice_gathering(LinphoneCall *call);
322 void linphone_call_update_crypto_parameters(LinphoneCall *call, SalMediaDescription *old_md, SalMediaDescription *new_md);
323 void linphone_call_update_remote_session_id_and_ver(LinphoneCall *call);
325 const char * linphone_core_get_identity(LinphoneCore *lc);
326 const char * linphone_core_get_route(LinphoneCore *lc);
327 void linphone_core_start_waiting(LinphoneCore *lc, const char *purpose);
328 void linphone_core_update_progress(LinphoneCore *lc, const char *purpose, float progresses);
329 void linphone_core_stop_waiting(LinphoneCore *lc);
331 int linphone_core_proceed_with_invite_if_ready(LinphoneCore *lc, LinphoneCall *call, LinphoneProxyConfig *dest_proxy);
332 int linphone_core_start_invite(LinphoneCore *lc, LinphoneCall *call);
333 int linphone_core_start_update_call(LinphoneCore *lc, LinphoneCall *call);
334 int linphone_core_start_accept_call_update(LinphoneCore *lc, LinphoneCall *call);
335 void linphone_core_start_refered_call(LinphoneCore *lc, LinphoneCall *call);
336 void linphone_core_notify_incoming_call(LinphoneCore *lc, LinphoneCall *call);
337 bool_t linphone_core_incompatible_security(LinphoneCore *lc, SalMediaDescription *md);
338 extern SalCallbacks linphone_sal_callbacks;
339 void linphone_proxy_config_set_error(LinphoneProxyConfig *cfg, LinphoneReason error);
340 bool_t linphone_core_rtcp_enabled(const LinphoneCore *lc);
342 LinphoneCall * is_a_linphone_call(void *user_pointer);
343 LinphoneProxyConfig * is_a_linphone_proxy_config(void *user_pointer);
345 static const int linphone_proxy_config_magic=0x7979;
348 void linphone_chat_message_destroy(LinphoneChatMessage* msg);
351 struct _LinphoneProxyConfig
354 struct _LinphoneCore *lc;
359 char *contact_params;
364 struct _SipSetupContext *ssctx;
367 LinphoneRegistrationState state;
370 bool_t reg_sendregister;
372 bool_t dial_escape_plus;
374 time_t deletion_date;
375 LinphoneReason error;
378 struct _LinphoneAuthInfo
386 time_t last_use_time;
390 struct _LinphoneChatRoom{
391 struct _LinphoneCore *lc;
393 LinphoneAddress *peer_url;
399 struct _LinphoneFriend{
400 LinphoneAddress *uri;
403 LinphoneSubscribePolicy pol;
404 LinphoneOnlineStatus status;
405 struct _LinphoneCore *lc;
409 bool_t subscribe_active;
410 bool_t inc_subscribe_pending;
415 typedef struct sip_config
418 char *guessed_contact;
420 MSList *deleted_proxies;
421 int inc_timeout; /*timeout after an un-answered incoming call is rejected*/
422 int in_call_timeout; /*timeout after a call is hangup */
423 int delayed_timeout; /*timeout after a delayed call is resumed */
424 unsigned int keepalive_period; /* interval in ms between keep alive messages sent to the proxy server*/
425 LCSipTransports transports;
427 bool_t use_rfc2833; /*force RFC2833 to be sent*/
428 bool_t guess_hostname;
429 bool_t loopback_only;
432 bool_t register_only_when_network_is_up;
433 bool_t register_only_when_upnp_is_ok;
434 bool_t ping_with_options;
435 bool_t auto_net_state_mon;
436 bool_t tcp_tls_keepalive;
439 typedef struct rtp_config
441 int audio_rtp_min_port;
442 int audio_rtp_max_port;
443 int video_rtp_min_port;
444 int video_rtp_max_port;
445 int audio_jitt_comp; /*jitter compensation*/
446 int video_jitt_comp; /*jitter compensation*/
448 bool_t rtp_no_xmit_on_audio_mute;
449 /* stop rtp xmit when audio muted */
450 bool_t audio_adaptive_jitt_comp_enabled;
451 bool_t video_adaptive_jitt_comp_enabled;
457 typedef struct net_config
459 char *nat_address; /* may be IP or host name */
460 char *nat_address_ip; /* ip translated from nat_address */
471 typedef struct sound_config
473 struct _MSSndCard * ring_sndcard; /* the playback sndcard currently used */
474 struct _MSSndCard * play_sndcard; /* the playback sndcard currently used */
475 struct _MSSndCard * capt_sndcard; /* the capture sndcard currently used */
476 struct _MSSndCard * lsd_card; /* dummy playback card for Linphone Sound Daemon extension */
478 int latency; /* latency in samples of the current used sound device */
479 float soft_play_lev; /*playback gain in db.*/
480 float soft_mic_lev; /*mic gain in db.*/
493 typedef struct codecs_config
495 MSList *audio_codecs; /* list of audio codecs in order of preference*/
496 MSList *video_codecs; /* for later use*/
499 typedef struct video_config{
500 struct _MSWebCam *device;
506 bool_t selfview; /*during calls*/
507 const char *displaytype;
510 typedef struct ui_config
514 unsigned int timer_id; /* the timer id for registration */
519 typedef struct autoreplier_config
522 int after_seconds; /* accept the call after x seconds*/
523 int max_users; /* maximum number of user that can call simultaneously */
524 int max_rec_time; /* the max time of incoming voice recorded */
525 int max_rec_msg; /* maximum number of recorded messages */
526 const char *message; /* the path of the file to be played */
527 }autoreplier_config_t;
529 struct _LinphoneConference{
530 MSAudioConference *conf;
531 AudioStream *local_participant;
532 MSAudioEndpoint *local_endpoint;
533 RtpProfile *local_dummy_profile;
537 typedef struct _LinphoneConference LinphoneConference;
541 LinphoneCoreVTable vtable;
543 LinphoneGlobalState state;
544 struct _LpConfig *config;
545 RtpProfile *default_profile;
546 net_config_t net_conf;
547 sip_config_t sip_conf;
548 rtp_config_t rtp_conf;
549 sound_config_t sound_conf;
550 video_config_t video_conf;
551 codecs_config_t codecs_conf;
553 autoreplier_config_t autoreplier_conf;
554 MSList *payload_types;
556 LinphoneProxyConfig *default_proxy;
559 struct _RingStream *ringstream;
560 time_t dmfs_playing_start_time;
561 LCCallbackObj preview_finished_cb;
562 LinphoneCall *current_call; /* the current call */
563 MSList *calls; /* all the processed calls */
564 MSList *queued_calls; /* used by the autoreplier */
569 VideoPreview *previewstream;
570 struct _MSEventQueue *msevq;
571 LinphoneRtpTransportFactories *rtptf;
573 MSList *subscribers; /* unknown subscribers */
575 LinphoneOnlineStatus presence_mode;
582 LinphoneWaitingCallback wait_cb;
584 unsigned long video_window_id;
585 unsigned long preview_window_id;
586 time_t netup_time; /*time when network went reachable */
587 struct _EcCalibrator *ecc;
589 LinphoneConference conf_ctx;
590 char* zrtp_secrets_cache;
591 LinphoneVideoPolicy video_policy;
593 bool_t apply_nat_settings;
594 bool_t initial_subscribes_sent;
597 bool_t preview_finished;
598 bool_t auto_net_state_mon;
599 bool_t network_reachable;
600 bool_t use_preview_window;
602 time_t network_last_check;
603 bool_t network_last_status;
605 bool_t ringstream_autorelease;
609 LinphoneTunnel *tunnel;
611 MSList *last_recv_msg_ids;
617 LinphoneTunnel *linphone_core_tunnel_new(LinphoneCore *lc);
618 void linphone_tunnel_destroy(LinphoneTunnel *tunnel);
619 void linphone_tunnel_configure(LinphoneTunnel *tunnel);
620 void linphone_tunnel_enable_logs_with_handler(LinphoneTunnel *tunnel, bool_t enabled, OrtpLogFunc logHandler);
622 bool_t linphone_core_can_we_add_call(LinphoneCore *lc);
623 int linphone_core_add_call( LinphoneCore *lc, LinphoneCall *call);
624 int linphone_core_del_call( LinphoneCore *lc, LinphoneCall *call);
625 int linphone_core_set_as_current_call(LinphoneCore *lc, LinphoneCall *call);
626 int linphone_core_get_calls_nb(const LinphoneCore *lc);
628 void linphone_core_set_state(LinphoneCore *lc, LinphoneGlobalState gstate, const char *message);
629 void linphone_call_make_local_media_description(LinphoneCore *lc, LinphoneCall *call);
630 void linphone_core_update_streams(LinphoneCore *lc, LinphoneCall *call, SalMediaDescription *new_md);
632 bool_t linphone_core_is_payload_type_usable_for_bandwidth(LinphoneCore *lc, PayloadType *pt, int bandwidth_limit);
634 #define linphone_core_ready(lc) ((lc)->state!=LinphoneGlobalStartup)
635 void _linphone_core_configure_resolver();
637 struct _EcCalibrator{
639 MSSndCard *play_card,*capt_card;
640 MSFilter *sndread,*det,*rec;
641 MSFilter *play, *gen, *sndwrite;
642 MSFilter *read_resampler,*write_resampler;
644 LinphoneEcCalibrationCallback cb;
651 LinphoneEcCalibratorStatus status;
654 typedef struct _EcCalibrator EcCalibrator;
656 LinphoneEcCalibratorStatus ec_calibrator_get_status(EcCalibrator *ecc);
658 void ec_calibrator_destroy(EcCalibrator *ecc);
660 void linphone_call_background_tasks(LinphoneCall *call, bool_t one_second_elapsed);
661 void linphone_core_preempt_sound_resources(LinphoneCore *lc);
662 /*conferencing subsystem*/
663 void _post_configure_audio_stream(AudioStream *st, LinphoneCore *lc, bool_t muted);
664 /* When a conference participant pause the conference he may send a music.
665 * We don't want to hear that music or to send it to the other participants.
666 * Use muted=yes to handle this case.
668 void linphone_call_add_to_conf(LinphoneCall *call, bool_t muted);
669 void linphone_call_remove_from_conf(LinphoneCall *call);
670 void linphone_core_conference_check_uninit(LinphoneCore *lc);
671 bool_t linphone_core_sound_resources_available(LinphoneCore *lc);
672 void linphone_core_notify_refer_state(LinphoneCore *lc, LinphoneCall *referer, LinphoneCall *newcall);
673 unsigned int linphone_core_get_audio_features(LinphoneCore *lc);
675 void __linphone_core_invalidate_registers(LinphoneCore* lc);
676 void _linphone_core_codec_config_write(LinphoneCore *lc);
682 #define NB_MAX_CALLS (10)
684 void call_logs_write_to_config_file(LinphoneCore *lc);
686 int linphone_core_get_edge_bw(LinphoneCore *lc);
687 int linphone_core_get_edge_ptime(LinphoneCore *lc);
688 void _linphone_call_params_copy(LinphoneCallParams *params, const LinphoneCallParams *refparams);
689 void linphone_call_params_uninit(LinphoneCallParams *params);
691 int linphone_upnp_init(LinphoneCore *lc);
692 void linphone_upnp_destroy(LinphoneCore *lc);
698 #endif /* _PRIVATE_H */