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