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 #ifdef MSG_STORAGE_ENABLED
51 #ifndef LIBLINPHONE_VERSION
52 #define LIBLINPHONE_VERSION LINPHONE_VERSION
55 #ifndef PACKAGE_SOUND_DIR
56 #define PACKAGE_SOUND_DIR "."
59 #ifndef PACKAGE_DATA_DIR
60 #define PACKAGE_DATA_DIR "."
66 #define _(String) gettext(String)
70 #define _(something) (something)
73 #define ngettext(singular, plural, number) (((number)==1)?(singular):(plural))
77 struct _LinphoneCallParams{
78 LinphoneCall *referer; /*in case this call creation is consecutive to an incoming transfer, this points to the original call */
79 int audio_bw; /* bandwidth limit for audio stream */
80 LinphoneMediaEncryption media_encryption;
81 PayloadType *audio_codec; /*audio codec currently in use */
82 PayloadType *video_codec; /*video codec currently in use */
88 SalCustomHeader *custom_headers;
90 bool_t real_early_media; /*send real media even during early media (for outgoing calls)*/
91 bool_t in_conference; /*in conference mode */
96 struct _LinphoneCallLog{
97 struct _LinphoneCore *lc;
98 LinphoneCallDir dir; /**< The direction of the call*/
99 LinphoneCallStatus status; /**< The status of the call*/
100 LinphoneAddress *from; /**<Originator of the call as a LinphoneAddress object*/
101 LinphoneAddress *to; /**<Destination of the call as a LinphoneAddress object*/
102 char start_date[128]; /**<Human readable string containing the start date*/
103 int duration; /**<Duration of the call in seconds*/
106 rtp_stats_t local_stats;
107 rtp_stats_t remote_stats;
109 time_t start_date_time; /**Start date of the call in seconds as expressed in a time_t */
110 char* call_id; /**unique id of a call*/
111 bool_t video_enabled;
114 typedef struct _CallCallbackObj
116 LinphoneCallCbFunc _func;
120 static const int linphone_call_magic=0x3343;
122 typedef enum _LinphoneChatMessageDir{
123 LinphoneChatMessageIncoming,
124 LinphoneChatMessageOutgoing
125 } LinphoneChatMessageDir;
127 struct _LinphoneChatMessage {
128 LinphoneChatRoom* chat_room;
129 LinphoneChatMessageDir dir;
131 LinphoneChatMessageStateChangeCb cb;
133 void* message_userdata;
134 char* external_body_url;
135 LinphoneAddress *from;
138 SalCustomHeader *custom_headers;
139 LinphoneChatMessageState state;
143 typedef struct StunCandidate{
151 int magic; /*used to distinguish from proxy config*/
152 struct _LinphoneCore *core;
153 SalMediaDescription *localdesc;
154 SalMediaDescription *resultdesc;
156 LinphoneCall *referer; /*when this call is the result of a transfer, referer is set to the original call that caused the transfer*/
157 struct _RtpProfile *audio_profile;
158 struct _RtpProfile *video_profile;
159 struct _LinphoneCallLog *log;
162 char localip[LINPHONE_IPADDR_SIZE]; /* our best guess for local ipaddress for this call */
163 time_t start_time; /*time at which the call was initiated*/
164 time_t media_start_time; /*time at which it was accepted, media streams established*/
165 LinphoneCallState state;
166 LinphoneCallState transfer_state; /*idle if no transfer*/
167 LinphoneReason reason;
168 LinphoneProxyConfig *dest_proxy;
173 StunCandidate ac,vc; /*audio video ip/port discovered by STUN*/
174 struct _AudioStream *audiostream; /**/
175 struct _VideoStream *videostream;
176 MSAudioEndpoint *endpoint; /*used for conferencing*/
178 LinphoneCallParams params;
179 LinphoneCallParams current_params;
180 LinphoneCallParams remote_params;
181 int up_bw; /*upload bandwidth setting at the time the call is started. Used to detect if it changes during a call */
182 int audio_bw; /*upload bandwidth used by audio */
183 OrtpEvQueue *audiostream_app_evq;
185 OrtpEvQueue *videostream_app_evq;
186 CallCallbackObj nextVideoFrameDecoded;
187 LinphoneCallStats stats[2];
189 UpnpSession *upnp_session;
191 IceSession *ice_session;
192 LinphoneChatMessage* pending_message;
194 unsigned int remote_session_id;
195 unsigned int remote_session_ver;
196 bool_t refer_pending;
197 bool_t media_pending;
199 bool_t camera_active;
201 bool_t all_muted; /*this flag is set during early medias*/
202 bool_t playing_ringbacktone;
203 bool_t owns_call_log;
204 bool_t ringing_beep; /* whether this call is ringing through an already existent current call*/
206 bool_t videostream_encrypted;
207 bool_t audiostream_encrypted;
208 bool_t auth_token_verified;
211 bool_t was_automatically_paused;
213 bool_t record_active;
217 LinphoneCall * linphone_call_new_outgoing(struct _LinphoneCore *lc, LinphoneAddress *from, LinphoneAddress *to, const LinphoneCallParams *params);
218 LinphoneCall * linphone_call_new_incoming(struct _LinphoneCore *lc, LinphoneAddress *from, LinphoneAddress *to, SalOp *op);
219 void linphone_call_set_state(LinphoneCall *call, LinphoneCallState cstate, const char *message);
222 LinphoneCallLog * linphone_call_log_new(LinphoneCall *call, LinphoneAddress *local, LinphoneAddress * remote);
223 void linphone_call_log_completed(LinphoneCall *call);
224 void linphone_call_log_destroy(LinphoneCallLog *cl);
225 void linphone_call_set_transfer_state(LinphoneCall* call, LinphoneCallState state);
227 void linphone_auth_info_write_config(struct _LpConfig *config, LinphoneAuthInfo *obj, int pos);
229 void linphone_core_update_proxy_register(LinphoneCore *lc);
230 void linphone_core_refresh_subscribes(LinphoneCore *lc);
231 int linphone_core_abort_call(LinphoneCore *lc, LinphoneCall *call, const char *error);
233 int linphone_proxy_config_send_publish(LinphoneProxyConfig *cfg, LinphoneOnlineStatus os);
234 void linphone_proxy_config_set_state(LinphoneProxyConfig *cfg, LinphoneRegistrationState rstate, const char *message);
236 int linphone_online_status_to_eXosip(LinphoneOnlineStatus os);
237 void linphone_friend_close_subscriptions(LinphoneFriend *lf);
238 void linphone_friend_notify(LinphoneFriend *lf, LinphoneOnlineStatus os);
239 LinphoneFriend *linphone_find_friend_by_inc_subscribe(MSList *l, SalOp *op);
240 LinphoneFriend *linphone_find_friend_by_out_subscribe(MSList *l, SalOp *op);
242 int parse_hostname_to_addr(const char *server, struct sockaddr_storage *ss, socklen_t *socklen);
245 int remove_lock_file();
246 void check_sound_device(LinphoneCore *lc);
247 void linphone_core_get_local_ip(LinphoneCore *lc, const char *to, char *result);
248 bool_t host_has_ipv6_network();
249 bool_t lp_spawn_command_line_sync(const char *command, char **result,int *command_ret);
251 static inline int get_min_bandwidth(int dbw, int ubw){
252 if (dbw<=0) return ubw;
253 if (ubw<=0) return dbw;
257 static inline bool_t bandwidth_is_greater(int bw1, int bw2){
258 if (bw1<0) return TRUE;
259 else if (bw2<0) return FALSE;
260 else return bw1>=bw2;
263 static inline int get_video_bandwidth(int total, int audio){
264 if (total<=0) return 0;
265 return total-audio-10;
268 static inline void set_string(char **dest, const char *src){
274 *dest=ms_strdup(src);
277 #define PAYLOAD_TYPE_ENABLED PAYLOAD_TYPE_USER_FLAG_0
279 SalPresenceStatus linphone_online_status_to_sal(LinphoneOnlineStatus os);
280 void linphone_process_authentication(LinphoneCore* lc, SalOp *op);
281 void linphone_authentication_ok(LinphoneCore *lc, SalOp *op);
282 void linphone_subscription_new(LinphoneCore *lc, SalOp *op, const char *from);
283 void linphone_notify_recv(LinphoneCore *lc, SalOp *op, SalSubscribeStatus ss, SalPresenceStatus status);
284 void linphone_proxy_config_process_authentication_failure(LinphoneCore *lc, SalOp *op);
286 void linphone_subscription_answered(LinphoneCore *lc, SalOp *op);
287 void linphone_subscription_closed(LinphoneCore *lc, SalOp *op);
289 MSList *linphone_find_friend(MSList *fl, const LinphoneAddress *fri, LinphoneFriend **lf);
291 void linphone_core_update_allocated_audio_bandwidth(LinphoneCore *lc);
292 void linphone_core_update_allocated_audio_bandwidth_in_call(LinphoneCall *call, const PayloadType *pt);
294 int linphone_core_run_stun_tests(LinphoneCore *lc, LinphoneCall *call);
295 void linphone_core_adapt_to_network(LinphoneCore *lc, int ping_time_ms, LinphoneCallParams *params);
296 int linphone_core_gather_ice_candidates(LinphoneCore *lc, LinphoneCall *call);
297 void linphone_core_update_ice_state_in_call_stats(LinphoneCall *call);
298 void linphone_core_update_local_media_description_from_ice(SalMediaDescription *desc, IceSession *session);
299 void linphone_core_update_ice_from_remote_media_description(LinphoneCall *call, const SalMediaDescription *md);
300 bool_t linphone_core_media_description_contains_video_stream(const SalMediaDescription *md);
302 void linphone_core_send_initial_subscribes(LinphoneCore *lc);
303 void linphone_core_write_friends_config(LinphoneCore* lc);
304 void linphone_friend_write_to_config_file(struct _LpConfig *config, LinphoneFriend *lf, int index);
305 LinphoneFriend * linphone_friend_new_from_config_file(struct _LinphoneCore *lc, int index);
307 void linphone_proxy_config_update(LinphoneProxyConfig *cfg);
308 void linphone_proxy_config_get_contact(LinphoneProxyConfig *cfg, const char **ip, int *port);
309 LinphoneProxyConfig * linphone_core_lookup_known_proxy(LinphoneCore *lc, const LinphoneAddress *uri);
310 const char *linphone_core_find_best_identity(LinphoneCore *lc, const LinphoneAddress *to, const char **route);
311 int linphone_core_get_local_ip_for(int type, const char *dest, char *result);
313 LinphoneProxyConfig *linphone_proxy_config_new_from_config_file(struct _LpConfig *config, int index);
314 void linphone_proxy_config_write_to_config_file(struct _LpConfig* config,LinphoneProxyConfig *obj, int index);
316 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *cfg, const char *username, char *result, size_t result_len);
318 void linphone_core_message_received(LinphoneCore *lc, SalOp *op, const SalMessage *msg);
320 void linphone_core_play_tone(LinphoneCore *lc);
322 void linphone_call_init_stats(LinphoneCallStats *stats, int type);
324 void linphone_call_init_audio_stream(LinphoneCall *call);
325 void linphone_call_init_video_stream(LinphoneCall *call);
326 void linphone_call_init_media_streams(LinphoneCall *call);
327 void linphone_call_start_media_streams(LinphoneCall *call, bool_t all_inputs_muted, bool_t send_ringbacktone);
328 void linphone_call_start_media_streams_for_ice_gathering(LinphoneCall *call);
329 void linphone_call_stop_audio_stream(LinphoneCall *call);
330 void linphone_call_stop_video_stream(LinphoneCall *call);
331 void linphone_call_stop_media_streams(LinphoneCall *call);
332 void linphone_call_delete_ice_session(LinphoneCall *call);
333 void linphone_call_delete_upnp_session(LinphoneCall *call);
334 void linphone_call_stop_media_streams_for_ice_gathering(LinphoneCall *call);
335 void linphone_call_update_crypto_parameters(LinphoneCall *call, SalMediaDescription *old_md, SalMediaDescription *new_md);
336 void linphone_call_update_remote_session_id_and_ver(LinphoneCall *call);
338 const char * linphone_core_get_identity(LinphoneCore *lc);
339 const char * linphone_core_get_route(LinphoneCore *lc);
340 void linphone_core_start_waiting(LinphoneCore *lc, const char *purpose);
341 void linphone_core_update_progress(LinphoneCore *lc, const char *purpose, float progresses);
342 void linphone_core_stop_waiting(LinphoneCore *lc);
344 int linphone_core_proceed_with_invite_if_ready(LinphoneCore *lc, LinphoneCall *call, LinphoneProxyConfig *dest_proxy);
345 int linphone_core_start_invite(LinphoneCore *lc, LinphoneCall *call);
346 int linphone_core_start_update_call(LinphoneCore *lc, LinphoneCall *call);
347 int linphone_core_start_accept_call_update(LinphoneCore *lc, LinphoneCall *call);
348 void linphone_core_start_refered_call(LinphoneCore *lc, LinphoneCall *call);
349 void linphone_core_notify_incoming_call(LinphoneCore *lc, LinphoneCall *call);
350 bool_t linphone_core_incompatible_security(LinphoneCore *lc, SalMediaDescription *md);
351 extern SalCallbacks linphone_sal_callbacks;
352 void linphone_proxy_config_set_error(LinphoneProxyConfig *cfg, LinphoneReason error);
353 bool_t linphone_core_rtcp_enabled(const LinphoneCore *lc);
355 LinphoneCall * is_a_linphone_call(void *user_pointer);
356 LinphoneProxyConfig * is_a_linphone_proxy_config(void *user_pointer);
358 static const int linphone_proxy_config_magic=0x7979;
361 void linphone_chat_message_destroy(LinphoneChatMessage* msg);
364 struct _LinphoneProxyConfig
367 struct _LinphoneCore *lc;
372 char *contact_params;
377 struct _SipSetupContext *ssctx;
380 LinphoneRegistrationState state;
383 bool_t reg_sendregister;
385 bool_t dial_escape_plus;
387 time_t deletion_date;
388 LinphoneReason error;
391 struct _LinphoneAuthInfo
399 time_t last_use_time;
403 struct _LinphoneChatRoom{
404 struct _LinphoneCore *lc;
406 LinphoneAddress *peer_url;
408 MSList *messages_hist;
413 struct _LinphoneFriend{
414 LinphoneAddress *uri;
417 LinphoneSubscribePolicy pol;
418 LinphoneOnlineStatus status;
419 struct _LinphoneCore *lc;
423 bool_t subscribe_active;
424 bool_t inc_subscribe_pending;
429 typedef struct sip_config
432 char *guessed_contact;
434 MSList *deleted_proxies;
435 int inc_timeout; /*timeout after an un-answered incoming call is rejected*/
436 int in_call_timeout; /*timeout after a call is hangup */
437 int delayed_timeout; /*timeout after a delayed call is resumed */
438 unsigned int keepalive_period; /* interval in ms between keep alive messages sent to the proxy server*/
439 LCSipTransports transports;
441 bool_t use_rfc2833; /*force RFC2833 to be sent*/
442 bool_t guess_hostname;
443 bool_t loopback_only;
446 bool_t register_only_when_network_is_up;
447 bool_t register_only_when_upnp_is_ok;
448 bool_t ping_with_options;
449 bool_t auto_net_state_mon;
450 bool_t tcp_tls_keepalive;
453 typedef struct rtp_config
455 int audio_rtp_min_port;
456 int audio_rtp_max_port;
457 int video_rtp_min_port;
458 int video_rtp_max_port;
459 int audio_jitt_comp; /*jitter compensation*/
460 int video_jitt_comp; /*jitter compensation*/
463 bool_t rtp_no_xmit_on_audio_mute;
464 /* stop rtp xmit when audio muted */
465 bool_t audio_adaptive_jitt_comp_enabled;
466 bool_t video_adaptive_jitt_comp_enabled;
472 typedef struct net_config
474 char *nat_address; /* may be IP or host name */
475 char *nat_address_ip; /* ip translated from nat_address */
486 typedef struct sound_config
488 struct _MSSndCard * ring_sndcard; /* the playback sndcard currently used */
489 struct _MSSndCard * play_sndcard; /* the playback sndcard currently used */
490 struct _MSSndCard * capt_sndcard; /* the capture sndcard currently used */
491 struct _MSSndCard * lsd_card; /* dummy playback card for Linphone Sound Daemon extension */
493 int latency; /* latency in samples of the current used sound device */
494 float soft_play_lev; /*playback gain in db.*/
495 float soft_mic_lev; /*mic gain in db.*/
508 typedef struct codecs_config
510 MSList *audio_codecs; /* list of audio codecs in order of preference*/
511 MSList *video_codecs; /* for later use*/
514 typedef struct video_config{
515 struct _MSWebCam *device;
521 bool_t selfview; /*during calls*/
522 const char *displaytype;
525 typedef struct ui_config
529 unsigned int timer_id; /* the timer id for registration */
534 typedef struct autoreplier_config
537 int after_seconds; /* accept the call after x seconds*/
538 int max_users; /* maximum number of user that can call simultaneously */
539 int max_rec_time; /* the max time of incoming voice recorded */
540 int max_rec_msg; /* maximum number of recorded messages */
541 const char *message; /* the path of the file to be played */
542 }autoreplier_config_t;
544 struct _LinphoneConference{
545 MSAudioConference *conf;
546 AudioStream *local_participant;
547 MSAudioEndpoint *local_endpoint;
548 MSAudioEndpoint *record_endpoint;
549 RtpProfile *local_dummy_profile;
553 typedef struct _LinphoneConference LinphoneConference;
557 LinphoneCoreVTable vtable;
559 LinphoneGlobalState state;
560 struct _LpConfig *config;
561 RtpProfile *default_profile;
562 net_config_t net_conf;
563 sip_config_t sip_conf;
564 rtp_config_t rtp_conf;
565 sound_config_t sound_conf;
566 video_config_t video_conf;
567 codecs_config_t codecs_conf;
569 autoreplier_config_t autoreplier_conf;
570 MSList *payload_types;
572 LinphoneProxyConfig *default_proxy;
575 struct _RingStream *ringstream;
576 time_t dmfs_playing_start_time;
577 LCCallbackObj preview_finished_cb;
578 LinphoneCall *current_call; /* the current call */
579 MSList *calls; /* all the processed calls */
580 MSList *queued_calls; /* used by the autoreplier */
585 VideoPreview *previewstream;
586 struct _MSEventQueue *msevq;
587 LinphoneRtpTransportFactories *rtptf;
589 MSList *subscribers; /* unknown subscribers */
591 LinphoneOnlineStatus presence_mode;
598 LinphoneWaitingCallback wait_cb;
600 unsigned long video_window_id;
601 unsigned long preview_window_id;
602 time_t netup_time; /*time when network went reachable */
603 struct _EcCalibrator *ecc;
605 LinphoneConference conf_ctx;
606 char* zrtp_secrets_cache;
607 LinphoneVideoPolicy video_policy;
609 bool_t apply_nat_settings;
610 bool_t initial_subscribes_sent;
613 bool_t preview_finished;
614 bool_t auto_net_state_mon;
615 bool_t network_reachable;
616 bool_t use_preview_window;
618 time_t network_last_check;
619 bool_t network_last_status;
621 bool_t ringstream_autorelease;
625 LinphoneTunnel *tunnel;
627 MSList *last_recv_msg_ids;
629 #ifdef MSG_STORAGE_ENABLED
637 LinphoneTunnel *linphone_core_tunnel_new(LinphoneCore *lc);
638 void linphone_tunnel_destroy(LinphoneTunnel *tunnel);
639 void linphone_tunnel_configure(LinphoneTunnel *tunnel);
640 void linphone_tunnel_enable_logs_with_handler(LinphoneTunnel *tunnel, bool_t enabled, OrtpLogFunc logHandler);
642 bool_t linphone_core_can_we_add_call(LinphoneCore *lc);
643 int linphone_core_add_call( LinphoneCore *lc, LinphoneCall *call);
644 int linphone_core_del_call( LinphoneCore *lc, LinphoneCall *call);
645 int linphone_core_set_as_current_call(LinphoneCore *lc, LinphoneCall *call);
646 int linphone_core_get_calls_nb(const LinphoneCore *lc);
648 void linphone_core_set_state(LinphoneCore *lc, LinphoneGlobalState gstate, const char *message);
649 void linphone_call_make_local_media_description(LinphoneCore *lc, LinphoneCall *call);
650 void linphone_core_update_streams(LinphoneCore *lc, LinphoneCall *call, SalMediaDescription *new_md);
652 bool_t linphone_core_is_payload_type_usable_for_bandwidth(LinphoneCore *lc, PayloadType *pt, int bandwidth_limit);
654 #define linphone_core_ready(lc) ((lc)->state!=LinphoneGlobalStartup)
655 void _linphone_core_configure_resolver();
657 struct _EcCalibrator{
659 MSSndCard *play_card,*capt_card;
660 MSFilter *sndread,*det,*rec;
661 MSFilter *play, *gen, *sndwrite;
662 MSFilter *read_resampler,*write_resampler;
664 LinphoneEcCalibrationCallback cb;
669 LinphoneEcCalibratorStatus status;
670 bool_t freq1,freq2,freq3;
673 typedef struct _EcCalibrator EcCalibrator;
675 LinphoneEcCalibratorStatus ec_calibrator_get_status(EcCalibrator *ecc);
677 void ec_calibrator_destroy(EcCalibrator *ecc);
679 void linphone_call_background_tasks(LinphoneCall *call, bool_t one_second_elapsed);
680 void linphone_core_preempt_sound_resources(LinphoneCore *lc);
681 /*conferencing subsystem*/
682 void _post_configure_audio_stream(AudioStream *st, LinphoneCore *lc, bool_t muted);
683 /* When a conference participant pause the conference he may send a music.
684 * We don't want to hear that music or to send it to the other participants.
685 * Use muted=yes to handle this case.
687 void linphone_call_add_to_conf(LinphoneCall *call, bool_t muted);
688 void linphone_call_remove_from_conf(LinphoneCall *call);
689 void linphone_core_conference_check_uninit(LinphoneCore *lc);
690 bool_t linphone_core_sound_resources_available(LinphoneCore *lc);
691 void linphone_core_notify_refer_state(LinphoneCore *lc, LinphoneCall *referer, LinphoneCall *newcall);
692 unsigned int linphone_core_get_audio_features(LinphoneCore *lc);
694 void __linphone_core_invalidate_registers(LinphoneCore* lc);
695 void _linphone_core_codec_config_write(LinphoneCore *lc);
701 #define NB_MAX_CALLS (10)
703 void call_logs_write_to_config_file(LinphoneCore *lc);
705 int linphone_core_get_edge_bw(LinphoneCore *lc);
706 int linphone_core_get_edge_ptime(LinphoneCore *lc);
707 void _linphone_call_params_copy(LinphoneCallParams *params, const LinphoneCallParams *refparams);
708 void linphone_call_params_uninit(LinphoneCallParams *params);
710 int linphone_upnp_init(LinphoneCore *lc);
711 void linphone_upnp_destroy(LinphoneCore *lc);
713 #ifdef MSG_STORAGE_ENABLED
714 sqlite3 * linphone_message_storage_init();
716 void linphone_chat_message_store(LinphoneChatMessage *msg);
717 void linphone_chat_message_store_state(LinphoneChatMessage *msg);
718 void linphone_core_message_storage_init(LinphoneCore *lc);
719 void linphone_core_message_storage_close(LinphoneCore *lc);
725 #endif /* _PRIVATE_H */