]> sjero.net Git - linphone/blob - coreapi/private.h
add API to set custom parameters in the SIP contact address of registers.
[linphone] / 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 #ifdef __cplusplus
28 extern "C" {
29 #endif
30 #include "linphonecore.h"
31 #include "linphone_tunnel.h"
32 #include "linphonecore_utils.h"
33 #include "sal.h"
34
35 #ifdef HAVE_CONFIG_H
36 #include "config.h"
37 #endif
38 #include "mediastreamer2/mediastream.h"
39 #include "mediastreamer2/msconference.h"
40
41 #ifndef LIBLINPHONE_VERSION
42 #define LIBLINPHONE_VERSION LINPHONE_VERSION
43 #endif
44
45 #ifndef PACKAGE_SOUND_DIR
46 #define PACKAGE_SOUND_DIR "."
47 #endif
48
49 #ifndef PACKAGE_DATA_DIR
50 #define PACKAGE_DATA_DIR "."
51 #endif
52
53 #ifdef HAVE_GETTEXT
54 #include <libintl.h>
55 #ifndef _
56 #define _(String) gettext(String)
57 #endif
58 #else
59 #ifndef _
60 #define _(something)    (something)
61 #endif
62 #ifndef ngettext
63 #define ngettext(singular, plural, number)      (((number)==1)?(singular):(plural))
64 #endif
65 #endif
66
67 struct _LinphoneCallParams{
68         LinphoneCall *referer; /*in case this call creation is consecutive to an incoming transfer, this points to the original call */
69         int audio_bw; /* bandwidth limit for audio stream */
70         LinphoneMediaEncryption media_encryption;
71         PayloadType *audio_codec;
72         PayloadType *video_codec;
73         bool_t has_video;
74         bool_t real_early_media; /*send real media even during early media (for outgoing calls)*/
75         bool_t in_conference; /*in conference mode */
76         bool_t pad;
77         
78 };
79     
80 typedef struct _CallCallbackObj
81 {
82     LinphoneCallCbFunc _func;
83     void * _user_data;
84 }CallCallbackObj;
85
86 static const int linphone_call_magic=0x3343;
87
88 struct _LinphoneCall
89 {
90         int magic; /*used to distinguish from proxy config*/
91         struct _LinphoneCore *core;
92         SalMediaDescription *localdesc;
93         SalMediaDescription *resultdesc;
94         LinphoneCallDir dir;
95         LinphoneCall *referer; /*when this call is the result of a transfer, referer is set to the original call that caused the transfer*/
96         struct _RtpProfile *audio_profile;
97         struct _RtpProfile *video_profile;
98         struct _LinphoneCallLog *log;
99         SalOp *op;
100         SalOp *ping_op;
101         char localip[LINPHONE_IPADDR_SIZE]; /* our best guess for local ipaddress for this call */
102         time_t start_time; /*time at which the call was initiated*/
103         time_t media_start_time; /*time at which it was accepted, media streams established*/
104         LinphoneCallState       state;
105         LinphoneCallState transfer_state; /*idle if no transfer*/
106         LinphoneReason reason;
107         int refcnt;
108         void * user_pointer;
109         int audio_port;
110         int video_port;
111         struct _AudioStream *audiostream;  /**/
112         struct _VideoStream *videostream;
113         MSAudioEndpoint *endpoint; /*used for conferencing*/
114         char *refer_to;
115         LinphoneCallParams params;
116         LinphoneCallParams current_params;
117         LinphoneCallParams remote_params;
118         int up_bw; /*upload bandwidth setting at the time the call is started. Used to detect if it changes during a call */
119         int audio_bw;   /*upload bandwidth used by audio */
120         bool_t refer_pending;
121         bool_t media_pending;
122         bool_t audio_muted;
123         bool_t camera_active;
124         bool_t all_muted; /*this flag is set during early medias*/
125         bool_t playing_ringbacktone;
126         bool_t owns_call_log;
127         bool_t ringing_beep; /* whether this call is ringing through an already existent current call*/
128         OrtpEvQueue *audiostream_app_evq;
129         char *auth_token;
130         OrtpEvQueue *videostream_app_evq;
131         bool_t videostream_encrypted;
132         bool_t audiostream_encrypted;
133         bool_t auth_token_verified;
134         bool_t defer_update;
135         bool_t was_automatically_paused;
136         CallCallbackObj nextVideoFrameDecoded;
137         LinphoneCallStats stats[2];
138 };
139
140
141 LinphoneCall * linphone_call_new_outgoing(struct _LinphoneCore *lc, LinphoneAddress *from, LinphoneAddress *to, const LinphoneCallParams *params);
142 LinphoneCall * linphone_call_new_incoming(struct _LinphoneCore *lc, LinphoneAddress *from, LinphoneAddress *to, SalOp *op);
143 void linphone_call_set_state(LinphoneCall *call, LinphoneCallState cstate, const char *message);
144
145 /* private: */
146 LinphoneCallLog * linphone_call_log_new(LinphoneCall *call, LinphoneAddress *local, LinphoneAddress * remote);
147 void linphone_call_log_completed(LinphoneCall *call);
148 void linphone_call_log_destroy(LinphoneCallLog *cl);
149 void linphone_call_set_transfer_state(LinphoneCall* call, LinphoneCallState state);
150
151 void linphone_auth_info_write_config(struct _LpConfig *config, LinphoneAuthInfo *obj, int pos);
152
153 void linphone_core_update_proxy_register(LinphoneCore *lc);
154 void linphone_core_refresh_subscribes(LinphoneCore *lc);
155 int linphone_core_abort_call(LinphoneCore *lc, LinphoneCall *call, const char *error);
156
157 int linphone_proxy_config_send_publish(LinphoneProxyConfig *cfg, LinphoneOnlineStatus os);
158 void linphone_proxy_config_set_state(LinphoneProxyConfig *cfg, LinphoneRegistrationState rstate, const char *message);
159
160 int linphone_online_status_to_eXosip(LinphoneOnlineStatus os);
161 void linphone_friend_close_subscriptions(LinphoneFriend *lf);
162 void linphone_friend_notify(LinphoneFriend *lf, LinphoneOnlineStatus os);
163 LinphoneFriend *linphone_find_friend_by_inc_subscribe(MSList *l, SalOp *op);
164 LinphoneFriend *linphone_find_friend_by_out_subscribe(MSList *l, SalOp *op);
165
166 int parse_hostname_to_addr(const char *server, struct sockaddr_storage *ss, socklen_t *socklen);
167 int set_lock_file();
168 int get_lock_file();
169 int remove_lock_file();
170 int do_registration(LinphoneCore *lc, bool_t doit);
171 void check_for_registration(LinphoneCore *lc);
172 void check_sound_device(LinphoneCore *lc);
173 void linphone_core_verify_codecs(LinphoneCore *lc);
174 void linphone_core_get_local_ip(LinphoneCore *lc, const char *to, char *result);
175 bool_t host_has_ipv6_network();
176 bool_t lp_spawn_command_line_sync(const char *command, char **result,int *command_ret);
177
178 static inline int get_min_bandwidth(int dbw, int ubw){
179         if (dbw<=0) return ubw;
180         if (ubw<=0) return dbw;
181         return MIN(dbw,ubw);
182 }
183
184 static inline bool_t bandwidth_is_greater(int bw1, int bw2){
185         if (bw1<0) return TRUE;
186         else if (bw2<0) return FALSE;
187         else return bw1>=bw2;
188 }
189
190 static inline int get_video_bandwidth(int total, int audio){
191         if (total<=0) return 0;
192         return total-audio-10;
193 }
194
195 static inline void set_string(char **dest, const char *src){
196         if (*dest){
197                 ms_free(*dest);
198                 *dest=NULL;
199         }
200         if (src)
201                 *dest=ms_strdup(src);
202 }
203
204 #define PAYLOAD_TYPE_ENABLED    PAYLOAD_TYPE_USER_FLAG_0
205
206 SalPresenceStatus linphone_online_status_to_sal(LinphoneOnlineStatus os);
207 void linphone_process_authentication(LinphoneCore* lc, SalOp *op);
208 void linphone_authentication_ok(LinphoneCore *lc, SalOp *op);
209 void linphone_subscription_new(LinphoneCore *lc, SalOp *op, const char *from);
210 void linphone_notify_recv(LinphoneCore *lc, SalOp *op, SalSubscribeStatus ss, SalPresenceStatus status);
211 void linphone_proxy_config_process_authentication_failure(LinphoneCore *lc, SalOp *op);
212
213 void linphone_subscription_answered(LinphoneCore *lc, SalOp *op);
214 void linphone_subscription_closed(LinphoneCore *lc, SalOp *op);
215
216 MSList *linphone_find_friend(MSList *fl, const LinphoneAddress *fri, LinphoneFriend **lf);
217
218 void linphone_core_update_allocated_audio_bandwidth(LinphoneCore *lc);
219 void linphone_core_update_allocated_audio_bandwidth_in_call(LinphoneCall *call, const PayloadType *pt);
220 void linphone_core_run_stun_tests(LinphoneCore *lc, LinphoneCall *call);
221
222 void linphone_core_send_initial_subscribes(LinphoneCore *lc);
223 void linphone_core_write_friends_config(LinphoneCore* lc);
224 void linphone_friend_write_to_config_file(struct _LpConfig *config, LinphoneFriend *lf, int index);
225 LinphoneFriend * linphone_friend_new_from_config_file(struct _LinphoneCore *lc, int index);
226
227 void linphone_proxy_config_update(LinphoneProxyConfig *cfg);
228 void linphone_proxy_config_get_contact(LinphoneProxyConfig *cfg, const char **ip, int *port);
229 LinphoneProxyConfig * linphone_core_lookup_known_proxy(LinphoneCore *lc, const LinphoneAddress *uri);
230 const char *linphone_core_find_best_identity(LinphoneCore *lc, const LinphoneAddress *to, const char **route);
231 int linphone_core_get_local_ip_for(int type, const char *dest, char *result);
232
233 LinphoneProxyConfig *linphone_proxy_config_new_from_config_file(struct _LpConfig *config, int index);
234 void linphone_proxy_config_write_to_config_file(struct _LpConfig* config,LinphoneProxyConfig *obj, int index);
235
236 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *cfg, const char *username, char *result, size_t result_len);
237
238 void linphone_core_text_received(LinphoneCore *lc, const char *from, const char *msg);
239
240 void linphone_core_play_tone(LinphoneCore *lc);
241
242 void linphone_call_init_stats(LinphoneCallStats *stats, int type);
243
244 void linphone_call_init_media_streams(LinphoneCall *call);
245 void linphone_call_start_media_streams(LinphoneCall *call, bool_t all_inputs_muted, bool_t send_ringbacktone);
246 void linphone_call_stop_media_streams(LinphoneCall *call);
247
248 const char * linphone_core_get_identity(LinphoneCore *lc);
249 const char * linphone_core_get_route(LinphoneCore *lc);
250 void linphone_core_start_waiting(LinphoneCore *lc, const char *purpose);
251 void linphone_core_update_progress(LinphoneCore *lc, const char *purpose, float progresses);
252 void linphone_core_stop_waiting(LinphoneCore *lc);
253
254 int linphone_core_start_invite(LinphoneCore *lc, LinphoneCall *call, LinphoneProxyConfig *dest_proxy);
255 void linphone_core_start_refered_call(LinphoneCore *lc, LinphoneCall *call);
256 extern SalCallbacks linphone_sal_callbacks;
257 void linphone_proxy_config_set_error(LinphoneProxyConfig *cfg, LinphoneReason error);
258 bool_t linphone_core_rtcp_enabled(const LinphoneCore *lc);
259
260 LinphoneCall * is_a_linphone_call(void *user_pointer);
261 LinphoneProxyConfig * is_a_linphone_proxy_config(void *user_pointer);
262
263 static const int linphone_proxy_config_magic=0x7979;
264
265 struct _LinphoneProxyConfig
266 {
267         int magic;
268         struct _LinphoneCore *lc;
269         char *reg_proxy;
270         char *reg_identity;
271         char *reg_route;
272         char *realm;
273         char *contact_params;
274         int expires;
275         int reg_time;
276         SalOp *op;
277         char *type;
278         struct _SipSetupContext *ssctx;
279         int auth_failures;
280         char *dial_prefix;
281         LinphoneRegistrationState state;
282         SalOp *publish_op;
283         bool_t commit;
284         bool_t reg_sendregister;
285         bool_t publish;
286         bool_t dial_escape_plus;
287         void* user_data;
288         time_t deletion_date;
289         LinphoneReason error;
290 };
291
292 struct _LinphoneAuthInfo
293 {
294         char *username;
295         char *realm;
296         char *userid;
297         char *passwd;
298         char *ha1;
299         int usecount;
300         time_t last_use_time;
301         bool_t works;
302 };
303
304 struct _LinphoneChatRoom{
305         struct _LinphoneCore *lc;
306         char  *peer;
307         LinphoneAddress *peer_url;
308         SalOp *op;
309         void * user_data;
310 };
311
312 struct _LinphoneFriend{
313         LinphoneAddress *uri;
314         SalOp *insub;
315         SalOp *outsub;
316         LinphoneSubscribePolicy pol;
317         LinphoneOnlineStatus status;
318         struct _LinphoneCore *lc;
319         BuddyInfo *info;
320         char *refkey;
321         bool_t subscribe;
322         bool_t subscribe_active;
323         bool_t inc_subscribe_pending;
324         bool_t commit;
325 };
326
327
328 typedef struct sip_config
329 {
330         char *contact;
331         char *guessed_contact;
332         MSList *proxies;
333         MSList *deleted_proxies;
334         int inc_timeout;        /*timeout after an un-answered incoming call is rejected*/
335         unsigned int keepalive_period; /* interval in ms between keep alive messages sent to the proxy server*/
336         LCSipTransports transports;
337         bool_t use_info;
338         bool_t use_rfc2833;     /*force RFC2833 to be sent*/
339         bool_t guess_hostname;
340         bool_t loopback_only;
341         bool_t ipv6_enabled;
342         bool_t sdp_200_ack;
343         bool_t register_only_when_network_is_up;
344         bool_t ping_with_options;
345         bool_t auto_net_state_mon;
346 } sip_config_t;
347
348 typedef struct rtp_config
349 {
350         int audio_rtp_port;
351         int video_rtp_port;
352         int audio_jitt_comp;  /*jitter compensation*/
353         int video_jitt_comp;  /*jitter compensation*/
354         int nortp_timeout;
355         bool_t rtp_no_xmit_on_audio_mute;
356                               /* stop rtp xmit when audio muted */
357 }rtp_config_t;
358
359
360
361 typedef struct net_config
362 {
363         char *nat_address; /* may be IP or host name */
364         char *nat_address_ip; /* ip translated from nat_address */
365         char *stun_server;
366         char *relay;
367         int download_bw;
368         int upload_bw;
369         int firewall_policy;
370         int mtu;
371         int down_ptime;
372         bool_t nat_sdp_only;
373 }net_config_t;
374
375
376 typedef struct sound_config
377 {
378         struct _MSSndCard * ring_sndcard;       /* the playback sndcard currently used */
379         struct _MSSndCard * play_sndcard;       /* the playback sndcard currently used */
380         struct _MSSndCard * capt_sndcard; /* the capture sndcard currently used */
381         struct _MSSndCard * lsd_card; /* dummy playback card for Linphone Sound Daemon extension */
382         const char **cards;
383         int latency;    /* latency in samples of the current used sound device */
384         char rec_lev;
385         char play_lev;
386         char ring_lev;
387         char soft_play_lev;
388         char source;
389         char *local_ring;
390         char *remote_ring;
391         char *ringback_tone;
392         bool_t ec;
393         bool_t ea;
394         bool_t agc;
395 } sound_config_t;
396
397 typedef struct codecs_config
398 {
399         MSList *audio_codecs;  /* list of audio codecs in order of preference*/
400         MSList *video_codecs;   /* for later use*/
401 }codecs_config_t;
402
403 typedef struct video_config{
404         struct _MSWebCam *device;
405         const char **cams;
406         MSVideoSize vsize;
407         bool_t capture;
408         bool_t show_local;
409         bool_t display;
410         bool_t selfview; /*during calls*/
411         const char *displaytype;
412 }video_config_t;
413
414 typedef struct ui_config
415 {
416         int is_daemon;
417         int is_applet;
418         unsigned int timer_id;  /* the timer id for registration */
419 }ui_config_t;
420
421
422
423 typedef struct autoreplier_config
424 {
425         int enabled;
426         int after_seconds;              /* accept the call after x seconds*/
427         int max_users;                  /* maximum number of user that can call simultaneously */
428         int max_rec_time;       /* the max time of incoming voice recorded */
429         int max_rec_msg;                /* maximum number of recorded messages */
430         const char *message;            /* the path of the file to be played */
431 }autoreplier_config_t;
432
433 struct _LinphoneConference{
434         MSAudioConference *conf;
435         AudioStream *local_participant;
436         MSAudioEndpoint *local_endpoint;
437         RtpProfile *local_dummy_profile;
438         bool_t local_muted;
439 };
440
441 typedef struct _LinphoneConference LinphoneConference;
442
443 struct _LinphoneCore
444 {
445         LinphoneCoreVTable vtable;
446         Sal *sal;
447         LinphoneGlobalState state;
448         struct _LpConfig *config;
449         net_config_t net_conf;
450         sip_config_t sip_conf;
451         rtp_config_t rtp_conf;
452         sound_config_t sound_conf;
453         video_config_t video_conf;
454         codecs_config_t codecs_conf;
455         ui_config_t ui_conf;
456         autoreplier_config_t autoreplier_conf;
457         MSList *payload_types;
458         int dyn_pt;
459         LinphoneProxyConfig *default_proxy;
460         MSList *friends;
461         MSList *auth_info;
462         struct _RingStream *ringstream;
463         time_t dmfs_playing_start_time;
464         LCCallbackObj preview_finished_cb;
465         LinphoneCall *current_call;   /* the current call */
466         MSList *calls;                          /* all the processed calls */
467         MSList *queued_calls;   /* used by the autoreplier */
468         MSList *call_logs;
469         MSList *chatrooms;
470         int max_call_logs;
471         int missed_calls;
472         VideoPreview *previewstream;
473         struct _MSEventQueue *msevq;
474         LinphoneRtpTransportFactories *rtptf;
475         MSList *bl_reqs;
476         MSList *subscribers;    /* unknown subscribers */
477         int minutes_away;
478         LinphoneOnlineStatus presence_mode;
479         char *alt_contact;
480         void *data;
481         char *play_file;
482         char *rec_file;
483         time_t prevtime;
484         int audio_bw;
485         LinphoneWaitingCallback wait_cb;
486         void *wait_ctx;
487         unsigned long video_window_id;
488         unsigned long preview_window_id;
489         time_t netup_time; /*time when network went reachable */
490         struct _EcCalibrator *ecc;
491         MSList *hooks;
492         LinphoneConference conf_ctx;
493         char* zrtp_secrets_cache;
494         LinphoneVideoPolicy video_policy;
495         bool_t use_files;
496         bool_t apply_nat_settings;
497         bool_t initial_subscribes_sent;
498         bool_t bl_refresh;
499         
500         bool_t preview_finished;
501         bool_t auto_net_state_mon;
502         bool_t network_reachable;
503         bool_t use_preview_window;
504         
505         bool_t ringstream_autorelease;
506         bool_t pad[3];
507         int device_rotation;
508         int max_calls;
509         LinphoneTunnel *tunnel;
510 };
511
512 LinphoneTunnel *linphone_core_tunnel_new(LinphoneCore *lc);
513 void linphone_tunnel_destroy(LinphoneTunnel *tunnel);
514 void linphone_tunnel_configure(LinphoneTunnel *tunnel);
515 void linphone_tunnel_enable_logs_with_handler(LinphoneTunnel *tunnel, bool_t enabled, OrtpLogFunc logHandler);
516         
517 bool_t linphone_core_can_we_add_call(LinphoneCore *lc);
518 int linphone_core_add_call( LinphoneCore *lc, LinphoneCall *call);
519 int linphone_core_del_call( LinphoneCore *lc, LinphoneCall *call);
520 int linphone_core_set_as_current_call(LinphoneCore *lc, LinphoneCall *call);
521 int linphone_core_get_calls_nb(const LinphoneCore *lc);
522
523 void linphone_core_set_state(LinphoneCore *lc, LinphoneGlobalState gstate, const char *message);
524
525 SalMediaDescription *create_local_media_description(LinphoneCore *lc, LinphoneCall *call);
526 void update_local_media_description(LinphoneCore *lc, LinphoneCall *call);
527
528 void linphone_core_update_streams(LinphoneCore *lc, LinphoneCall *call, SalMediaDescription *new_md);
529
530 bool_t linphone_core_is_payload_type_usable_for_bandwidth(LinphoneCore *lc, PayloadType *pt,  int bandwidth_limit);
531
532 #define linphone_core_ready(lc) ((lc)->state!=LinphoneGlobalStartup)
533 void _linphone_core_configure_resolver();
534
535 struct _EcCalibrator{
536         ms_thread_t thread;
537         MSSndCard *play_card,*capt_card;
538         MSFilter *sndread,*det,*rec;
539         MSFilter *play, *gen, *sndwrite,*resampler;
540         MSTicker *ticker;
541         LinphoneEcCalibrationCallback cb;
542         void *cb_data;
543         int recv_count;
544         int sent_count;
545         int64_t acc;
546         int delay;
547         unsigned int rate;
548         LinphoneEcCalibratorStatus status;
549 };
550
551 typedef struct _EcCalibrator EcCalibrator;
552
553 LinphoneEcCalibratorStatus ec_calibrator_get_status(EcCalibrator *ecc);
554
555 void ec_calibrator_destroy(EcCalibrator *ecc);
556
557 void linphone_call_background_tasks(LinphoneCall *call, bool_t one_second_elapsed);
558 void linphone_core_preempt_sound_resources(LinphoneCore *lc);
559 /*conferencing subsystem*/
560 void _post_configure_audio_stream(AudioStream *st, LinphoneCore *lc, bool_t muted);
561 /* When a conference participant pause the conference he may send a music.
562  * We don't want to hear that music or to send it to the other participants.
563  * Use muted=yes to handle this case.
564  */
565 void linphone_call_add_to_conf(LinphoneCall *call, bool_t muted);
566 void linphone_call_remove_from_conf(LinphoneCall *call);
567 void linphone_core_conference_check_uninit(LinphoneCore *lc);
568 bool_t linphone_core_sound_resources_available(LinphoneCore *lc);
569 void linphone_core_notify_refer_state(LinphoneCore *lc, LinphoneCall *referer, LinphoneCall *newcall);
570
571 void __linphone_core_invalidate_registers(LinphoneCore* lc);
572 void _linphone_core_codec_config_write(LinphoneCore *lc);
573
574 #define HOLD_OFF        (0)
575 #define HOLD_ON         (1)
576
577 #ifndef NB_MAX_CALLS
578 #define NB_MAX_CALLS    (10)
579 #endif
580 void call_logs_write_to_config_file(LinphoneCore *lc);
581
582
583
584 #ifdef __cplusplus
585 }
586 #endif
587
588 #endif /* _PRIVATE_H */