]> sjero.net Git - linphone/blob - coreapi/linphonecore.h
add IOS section in doxygen
[linphone] / coreapi / linphonecore.h
1 /*
2 linphone
3 Copyright (C) 2000 - 2010 Simon MORLAT (simon.morlat@linphone.org)
4
5 This program is free software; you can redistribute it and/or
6 modify it under the terms of the GNU General Public License
7 as published by the Free Software Foundation; either version 2
8 of the License, or (at your option) any later version.
9
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18 */
19 #ifndef LINPHONECORE_H
20 #define LINPHONECORE_H
21
22 #include "ortp/ortp.h"
23 #include "ortp/payloadtype.h"
24 #include "mediastreamer2/mscommon.h"
25 #include "mediastreamer2/msvideo.h"
26
27 #ifdef IN_LINPHONE
28 #include "sipsetup.h"
29 #else
30 #include "linphone/sipsetup.h"
31 #endif
32
33 #define LINPHONE_IPADDR_SIZE 64
34 #define LINPHONE_HOSTNAME_SIZE 128
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 struct _MSSndCard;
41 struct _LinphoneCore;
42 /**
43  * Linphone core main object created by function linphone_core_new() .
44  * @ingroup initializing
45  */
46 typedef struct _LinphoneCore LinphoneCore;
47 struct SalOp;
48
49 struct _LpConfig;
50
51
52 struct _LCSipTransports{
53         int udp_port;
54         int tcp_port;
55         int dtls_port;
56         int tls_port;
57 };
58
59 typedef struct _LCSipTransports LCSipTransports;
60
61 /**
62  * Object that represents a SIP address.
63  *
64  * The LinphoneAddress is an opaque object to represents SIP addresses, ie
65  * the content of SIP's 'from' and 'to' headers.
66  * A SIP address is made of display name, username, domain name, port, and various
67  * uri headers (such as tags). It looks like 'Alice <sip:alice@example.net>'.
68  * The LinphoneAddress has methods to extract and manipulate all parts of the address.
69  * When some part of the address (for example the username) is empty, the accessor methods
70  * return NULL.
71  * 
72  * @ingroup linphone_address
73  * @var LinphoneAddress
74  */
75 typedef struct SalAddress LinphoneAddress;
76 #ifdef IN_LINPHONE
77 #include "linphonefriend.h"
78 #else
79 #include "linphone/linphonefriend.h"
80 #endif
81
82 LinphoneAddress * linphone_address_new(const char *uri);
83 LinphoneAddress * linphone_address_clone(const LinphoneAddress *uri);
84 const char *linphone_address_get_scheme(const LinphoneAddress *u);
85 const char *linphone_address_get_display_name(const LinphoneAddress* u);
86 const char *linphone_address_get_username(const LinphoneAddress *u);
87 const char *linphone_address_get_domain(const LinphoneAddress *u);
88 /**
89  * Get port number as an integer value.
90  *
91  */
92 int linphone_address_get_port_int(const LinphoneAddress *u);
93 /**
94  * Get port number, null if not present.
95  */
96 const char* linphone_address_get_port(const LinphoneAddress *u);
97 void linphone_address_set_display_name(LinphoneAddress *u, const char *display_name);
98 void linphone_address_set_username(LinphoneAddress *uri, const char *username);
99 void linphone_address_set_domain(LinphoneAddress *uri, const char *host);
100 void linphone_address_set_port(LinphoneAddress *uri, const char *port);
101 void linphone_address_set_port_int(LinphoneAddress *uri, int port);
102 /*remove tags, params etc... so that it is displayable to the user*/
103 void linphone_address_clean(LinphoneAddress *uri);
104 char *linphone_address_as_string(const LinphoneAddress *u);
105 char *linphone_address_as_string_uri_only(const LinphoneAddress *u);
106 bool_t linphone_address_weak_equal(const LinphoneAddress *a1, const LinphoneAddress *a2);
107 void linphone_address_destroy(LinphoneAddress *u);
108
109 struct _SipSetupContext;
110
111
112 /**
113  * Enum representing the direction of a call.
114  * @ingroup call_logs
115 **/
116 enum _LinphoneCallDir {
117         LinphoneCallOutgoing, /**< outgoing calls*/
118         LinphoneCallIncoming  /**< incoming calls*/
119 };
120
121 /**
122  * Typedef for enum
123  * @ingroup call_logs
124 **/
125 typedef enum _LinphoneCallDir LinphoneCallDir;
126
127 /**
128  * Enum representing the status of a call
129  * @ingroup call_logs
130 **/
131 typedef enum _LinphoneCallStatus { 
132         LinphoneCallSuccess, /**< The call was sucessful*/
133         LinphoneCallAborted, /**< The call was aborted */
134         LinphoneCallMissed, /**< The call was missed (unanswered)*/
135         LinphoneCallDeclined /**< The call was declined, either locally or by remote end*/
136 } LinphoneCallStatus;
137
138 /**
139  * Structure representing a call log.
140  *
141  * @ingroup call_logs
142  * 
143 **/
144 typedef struct _LinphoneCallLog{
145         LinphoneCallDir dir; /**< The direction of the call*/
146         LinphoneCallStatus status; /**< The status of the call*/
147         LinphoneAddress *from; /**<Originator of the call as a LinphoneAddress object*/
148         LinphoneAddress *to; /**<Destination of the call as a LinphoneAddress object*/
149         char start_date[128]; /**<Human readable string containg the start date*/
150         int duration; /**<Duration of the call in seconds*/
151         char *refkey;
152         void *user_pointer;
153         rtp_stats_t local_stats;
154         rtp_stats_t remote_stats;
155         struct _LinphoneCore *lc;
156 } LinphoneCallLog;
157
158
159
160 /*public: */
161 void linphone_call_log_set_user_pointer(LinphoneCallLog *cl, void *up);
162 void *linphone_call_log_get_user_pointer(const LinphoneCallLog *cl);
163 void linphone_call_log_set_ref_key(LinphoneCallLog *cl, const char *refkey);
164 const char *linphone_call_log_get_ref_key(const LinphoneCallLog *cl);
165 const rtp_stats_t *linphone_call_log_get_local_stats(const LinphoneCallLog *cl);
166 const rtp_stats_t *linphone_call_log_get_remote_stats(const LinphoneCallLog *cl);
167 char * linphone_call_log_to_str(LinphoneCallLog *cl);
168
169
170 /**
171  * The LinphoneCallParams is an object containing various call related parameters.
172  * It can be used to retrieve parameters from a currently running call or modify the call's characteristics 
173  * dynamically.
174 **/
175 struct _LinphoneCallParams;
176 typedef struct _LinphoneCallParams LinphoneCallParams;
177
178 LinphoneCallParams * linphone_call_params_copy(const LinphoneCallParams *cp);
179 void linphone_call_params_enable_video(LinphoneCallParams *cp, bool_t enabled);
180 bool_t linphone_call_params_video_enabled(const LinphoneCallParams *cp);
181 void linphone_call_params_enable_early_media_sending(LinphoneCallParams *cp, bool_t enabled);
182 bool_t linphone_call_params_early_media_sending_enabled(const LinphoneCallParams *cp);
183 void linphone_call_params_set_audio_bandwidth_limit(LinphoneCallParams *cp, int bw);
184 void linphone_call_params_destroy(LinphoneCallParams *cp);
185
186 /**
187  * Enum describing failure reasons.
188  * @ingroup initializing
189 **/
190 enum _LinphoneReason{
191         LinphoneReasonNone,
192         LinphoneReasonNoResponse, /**<No response received from remote*/
193         LinphoneReasonBadCredentials, /**<Authentication failed due to bad or missing credentials*/
194         LinphoneReasonDeclined, /**<The call has been declined*/
195 };
196
197 typedef enum _LinphoneReason LinphoneReason;
198
199 const char *linphone_reason_to_string(LinphoneReason err);
200
201 /**
202  * The LinphoneCall object represents a call issued or received by the LinphoneCore
203 **/
204 struct _LinphoneCall;
205 typedef struct _LinphoneCall LinphoneCall;
206
207 /**
208  * LinphoneCallState enum represents the different state a call can reach into.
209  * The application is notified of state changes through the LinphoneCoreVTable::call_state_changed callback.
210  * @ingroup call_control
211 **/
212 typedef enum _LinphoneCallState{
213         LinphoneCallIdle,                                       /**<Initial call state */
214         LinphoneCallIncomingReceived, /**<This is a new incoming call */
215         LinphoneCallOutgoingInit, /**<An outgoing call is started */
216         LinphoneCallOutgoingProgress, /**<An outgoing call is in progress */
217         LinphoneCallOutgoingRinging, /**<An outgoing call is ringing at remote end */
218         LinphoneCallOutgoingEarlyMedia, /**<An outgoing call is proposed early media */
219         LinphoneCallConnected, /**<Connected, the call is answered */
220         LinphoneCallStreamsRunning, /**<The media streams are established and running*/
221         LinphoneCallPausing, /**<The call is pausing at the initiative of local end */
222         LinphoneCallPaused, /**< The call is paused, remote end has accepted the pause */
223         LinphoneCallResuming, /**<The call is being resumed by local end*/
224         LinphoneCallRefered, /**<The call is being transfered to another party, resulting in a new outgoing call to follow immediately*/
225         LinphoneCallError, /**<The call encountered an error*/
226         LinphoneCallEnd, /**<The call ended normally*/
227         LinphoneCallPausedByRemote, /**<The call is paused by remote end*/
228         LinphoneCallUpdatedByRemote, /**<The call's parameters are updated, used for example when video is asked by remote */
229         LinphoneCallIncomingEarlyMedia, /**<We are proposing early media to an incoming call */
230         LinphoneCallUpdated, /**<The remote accepted the call update initiated by us */
231         LinphoneCallReleased /**< The call object is no more retained by the core */
232 } LinphoneCallState;
233
234 const char *linphone_call_state_to_string(LinphoneCallState cs);
235
236
237 LinphoneCallState linphone_call_get_state(const LinphoneCall *call);
238 bool_t linphone_call_asked_to_autoanswer(LinphoneCall *call);
239 const LinphoneAddress * linphone_core_get_current_call_remote_address(struct _LinphoneCore *lc);
240 const LinphoneAddress * linphone_call_get_remote_address(const LinphoneCall *call);
241 char *linphone_call_get_remote_address_as_string(const LinphoneCall *call);
242 LinphoneCallDir linphone_call_get_dir(const LinphoneCall *call);
243 void linphone_call_ref(LinphoneCall *call);
244 void linphone_call_unref(LinphoneCall *call);
245 LinphoneCallLog *linphone_call_get_call_log(const LinphoneCall *call);
246 const char *linphone_call_get_refer_to(const LinphoneCall *call);
247 bool_t linphone_call_has_transfer_pending(const LinphoneCall *call);
248 LinphoneCall *linphone_call_get_replaced_call(LinphoneCall *call);
249 int linphone_call_get_duration(const LinphoneCall *call);
250 const LinphoneCallParams * linphone_call_get_current_params(const LinphoneCall *call);
251 void linphone_call_enable_camera(LinphoneCall *lc, bool_t enabled);
252 bool_t linphone_call_camera_enabled(const LinphoneCall *lc);
253 int linphone_call_take_video_snapshot(LinphoneCall *call, const char *file);
254 LinphoneReason linphone_call_get_reason(const LinphoneCall *call);
255 const char *linphone_call_get_remote_user_agent(LinphoneCall *call);
256 float linphone_call_get_play_volume(LinphoneCall *call);
257 float linphone_call_get_record_volume(LinphoneCall *call);
258 void *linphone_call_get_user_pointer(LinphoneCall *call);
259 void linphone_call_set_user_pointer(LinphoneCall *call, void *user_pointer);
260 /**
261  * Enables or disable echo cancellation for this call
262  * @param call
263  * @param val
264  *
265  * @ingroup media_parameters
266 **/
267 void linphone_call_enable_echo_cancellation(LinphoneCall *call, bool_t val) ;
268 /**
269  * Returns TRUE if echo cancellation is enabled.
270  *
271  * @ingroup media_parameters
272 **/
273 bool_t linphone_call_echo_cancellation_enabled(LinphoneCall *lc);
274 /**
275  * Enables or disable echo limiter for this call
276  * @param call
277  * @param val
278  *
279  * @ingroup media_parameters
280 **/
281 void linphone_call_enable_echo_limiter(LinphoneCall *call, bool_t val);
282 /**
283  * Returns TRUE if echo limiter is enabled.
284  *
285  * @ingroup media_parameters
286 **/
287 bool_t linphone_call_echo_limiter_enabled(const LinphoneCall *call);
288
289 /*keep this in sync with mediastreamer2/msvolume.h*/
290 #define LINPHONE_VOLUME_DB_LOWEST (-120) /**< Lowest measured that can be returned.*/
291
292 /**
293  * @addtogroup proxies
294  * @{
295 **/
296 /**
297  * The LinphoneProxyConfig object represents a proxy configuration to be used
298  * by the LinphoneCore object.
299  * Its fields must not be used directly in favour of the accessors methods.
300  * Once created and filled properly the LinphoneProxyConfig can be given to
301  * LinphoneCore with linphone_core_add_proxy_config().
302  * This will automatically triggers the registration, if enabled.
303  *
304  * The proxy configuration are persistent to restarts because they are saved
305  * in the configuration file. As a consequence, after linphone_core_new() there
306  * might already be a list of configured proxy that can be examined with
307  * linphone_core_get_proxy_config_list().
308  *
309  * The default proxy (see linphone_core_set_default_proxy() ) is the one of the list
310  * that is used by default for calls.
311 **/
312 typedef struct _LinphoneProxyConfig LinphoneProxyConfig;
313
314 /**
315  * LinphoneRegistrationState describes proxy registration states.
316 **/
317 typedef enum _LinphoneRegistrationState{
318         LinphoneRegistrationNone, /**<Initial state for registrations */
319         LinphoneRegistrationProgress, /**<Registration is in progress */
320         LinphoneRegistrationOk, /**< Registration is successful */
321         LinphoneRegistrationCleared, /**< Unregistration succeeded */
322         LinphoneRegistrationFailed      /**<Registration failed */
323 }LinphoneRegistrationState;
324
325 /**
326  * Human readable version of the #LinphoneRegistrationState
327  * @param cs sate
328  */
329 const char *linphone_registration_state_to_string(LinphoneRegistrationState cs);
330
331 LinphoneProxyConfig *linphone_proxy_config_new(void);
332 int linphone_proxy_config_set_server_addr(LinphoneProxyConfig *obj, const char *server_addr);
333 int linphone_proxy_config_set_identity(LinphoneProxyConfig *obj, const char *identity);
334 int linphone_proxy_config_set_route(LinphoneProxyConfig *obj, const char *route);
335 void linphone_proxy_config_expires(LinphoneProxyConfig *obj, int expires);
336 /**
337  * Indicates  either or not, REGISTRATION must be issued for this #LinphoneProxyConfig .
338  * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
339  * @param obj object pointer
340  * @param val if true, registration will be engaged
341  */
342 void linphone_proxy_config_enable_register(LinphoneProxyConfig *obj, bool_t val);
343 #define linphone_proxy_config_enableregister linphone_proxy_config_enable_register
344 void linphone_proxy_config_edit(LinphoneProxyConfig *obj);
345 int linphone_proxy_config_done(LinphoneProxyConfig *obj);
346 /**
347  * Indicates  either or not, PUBLISH must be issued for this #LinphoneProxyConfig .
348  * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
349  * @param obj object pointer
350  * @param val if true, publish will be engaged
351  *
352  */
353 void linphone_proxy_config_enable_publish(LinphoneProxyConfig *obj, bool_t val);
354 void linphone_proxy_config_set_dial_escape_plus(LinphoneProxyConfig *cfg, bool_t val);
355 void linphone_proxy_config_set_dial_prefix(LinphoneProxyConfig *cfg, const char *prefix);
356
357 LinphoneRegistrationState linphone_proxy_config_get_state(const LinphoneProxyConfig *obj);
358 bool_t linphone_proxy_config_is_registered(const LinphoneProxyConfig *obj);
359 const char *linphone_proxy_config_get_domain(const LinphoneProxyConfig *cfg);
360
361 const char *linphone_proxy_config_get_route(const LinphoneProxyConfig *obj);
362 const char *linphone_proxy_config_get_identity(const LinphoneProxyConfig *obj);
363 bool_t linphone_proxy_config_publish_enabled(const LinphoneProxyConfig *obj);
364 const char *linphone_proxy_config_get_addr(const LinphoneProxyConfig *obj);
365 int linphone_proxy_config_get_expires(const LinphoneProxyConfig *obj);
366 bool_t linphone_proxy_config_register_enabled(const LinphoneProxyConfig *obj);
367 struct _LinphoneCore * linphone_proxy_config_get_core(const LinphoneProxyConfig *obj);
368
369 bool_t linphone_proxy_config_get_dial_escape_plus(const LinphoneProxyConfig *cfg);
370 const char * linphone_proxy_config_get_dial_prefix(const LinphoneProxyConfig *cfg);
371
372 LinphoneReason linphone_proxy_config_get_error(const LinphoneProxyConfig *cfg);
373
374 /* destruction is called automatically when removing the proxy config */
375 void linphone_proxy_config_destroy(LinphoneProxyConfig *cfg);
376 void linphone_proxy_config_set_sip_setup(LinphoneProxyConfig *cfg, const char *type);
377 SipSetupContext *linphone_proxy_config_get_sip_setup_context(LinphoneProxyConfig *cfg);
378 SipSetup *linphone_proxy_config_get_sip_setup(LinphoneProxyConfig *cfg);
379 /**
380  * normalize a human readable phone number into a basic string. 888-444-222 becomes 888444222
381  */
382 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *proxy, const char *username, char *result, size_t result_len);
383 /*
384  *  attached a user data to a proxy config
385  */
386 void linphone_proxy_config_set_user_data(LinphoneProxyConfig *cr, void * ud);
387 /*
388  *  get user data to a proxy config. return null if any
389  */
390 void * linphone_proxy_config_get_user_data(LinphoneProxyConfig *cr);
391
392 /**
393  * @}
394 **/
395
396 typedef struct _LinphoneAccountCreator{
397         struct _LinphoneCore *lc;
398         struct _SipSetupContext *ssctx;
399         char *username;
400         char *password;
401         char *domain;
402         bool_t succeeded;
403 }LinphoneAccountCreator;
404
405 LinphoneAccountCreator *linphone_account_creator_new(struct _LinphoneCore *core, const char *type);
406 void linphone_account_creator_set_username(LinphoneAccountCreator *obj, const char *username);
407 void linphone_account_creator_set_password(LinphoneAccountCreator *obj, const char *password);
408 void linphone_account_creator_set_domain(LinphoneAccountCreator *obj, const char *domain);
409 const char * linphone_account_creator_get_username(LinphoneAccountCreator *obj);
410 const char * linphone_account_creator_get_domain(LinphoneAccountCreator *obj);
411 int linphone_account_creator_test_existence(LinphoneAccountCreator *obj);
412 LinphoneProxyConfig * linphone_account_creator_validate(LinphoneAccountCreator *obj);
413 void linphone_account_creator_destroy(LinphoneAccountCreator *obj);
414
415 struct _LinphoneAuthInfo;
416
417 /**
418  * @ingroup authentication
419  * Object holding authentication information.
420  *
421  * @note The object's fields should not be accessed directly. Prefer using
422  * the accessor methods.
423  *
424  * In most case, authentication information consists of a username and password.
425  * Sometimes, a userid is required by proxy, and realm can be useful to discriminate
426  * different SIP domains.
427  *
428  * Once created and filled, a LinphoneAuthInfo must be added to the LinphoneCore in
429  * order to become known and used automatically when needed. 
430  * Use linphone_core_add_auth_info() for that purpose.
431  *
432  * The LinphoneCore object can take the initiative to request authentication information
433  * when needed to the application through the auth_info_requested callback of the
434  * LinphoneCoreVTable structure.
435  *
436  * The application can respond to this information request later using 
437  * linphone_core_add_auth_info(). This will unblock all pending authentication 
438  * transactions and retry them with authentication headers.
439  *
440 **/
441 typedef struct _LinphoneAuthInfo LinphoneAuthInfo;
442
443 LinphoneAuthInfo *linphone_auth_info_new(const char *username, const char *userid,
444                 const char *passwd, const char *ha1,const char *realm);
445 void linphone_auth_info_set_passwd(LinphoneAuthInfo *info, const char *passwd);
446 void linphone_auth_info_set_username(LinphoneAuthInfo *info, const char *username);
447 void linphone_auth_info_set_userid(LinphoneAuthInfo *info, const char *userid);
448
449 const char *linphone_auth_info_get_username(const LinphoneAuthInfo *i);
450 const char *linphone_auth_info_get_passwd(const LinphoneAuthInfo *i);
451 const char *linphone_auth_info_get_userid(const LinphoneAuthInfo *i);
452
453 /* you don't need those function*/
454 void linphone_auth_info_destroy(LinphoneAuthInfo *info);
455 LinphoneAuthInfo * linphone_auth_info_new_from_config_file(struct _LpConfig *config, int pos);
456
457
458 struct _LinphoneChatRoom;
459 /**
460  * @addtogroup chatroom
461  * @{
462  */
463 /**
464  * A chat room is the place where text messages are exchanged.
465  * <br> Can be created by linphone_core_create_chat_room().
466  */
467 typedef struct _LinphoneChatRoom LinphoneChatRoom;
468 /**
469  * Create a new chat room for messaging from a sip uri like sip:joe@sip.linphone.org
470  * @param lc #LinphoneCore object
471  * @param to destination address for messages
472  * @return #LinphoneChatRoom where messaging can take place.
473  */
474 LinphoneChatRoom * linphone_core_create_chat_room(LinphoneCore *lc, const char *to);
475 /**
476  * Destructor
477  * @param cr #LinphoneChatRoom object
478  */
479 void linphone_chat_room_destroy(LinphoneChatRoom *cr);
480
481
482 /**
483  * get peer address \link linphone_core_create_chat_room() associated to \endlink this #LinphoneChatRoom
484  * @param cr #LinphoneChatRoom object
485  * @return #LinphoneAddress peer address
486  */
487 const LinphoneAddress* linphone_chat_room_get_peer_address(LinphoneChatRoom *cr);
488 /**
489  * send a message to peer member of this chat room.
490  * @param cr #LinphoneChatRoom object
491  * @param msg message to be sent
492  */
493 void linphone_chat_room_send_message(LinphoneChatRoom *cr, const char *msg);
494
495 void linphone_chat_room_set_user_data(LinphoneChatRoom *cr, void * ud);
496 void * linphone_chat_room_get_user_data(LinphoneChatRoom *cr);
497
498 /**
499  * @}
500  */
501
502
503 /**
504  * @addtogroup initializing
505  * @{
506 **/
507
508 /**
509  * LinphoneGlobalState describes the global state of the LinphoneCore object.
510  * It is notified via the LinphoneCoreVTable::global_state_changed
511 **/
512 typedef enum _LinphoneGlobalState{
513         LinphoneGlobalOff,
514         LinphoneGlobalStartup,
515         LinphoneGlobalOn,
516         LinphoneGlobalShutdown
517 }LinphoneGlobalState;
518
519 const char *linphone_global_state_to_string(LinphoneGlobalState gs);
520
521
522 /**Call state notification callback prototype*/
523 typedef void (*LinphoneGlobalStateCb)(struct _LinphoneCore *lc, LinphoneGlobalState gstate, const char *message);
524 /**Call state notification callback prototype*/
525 typedef void (*LinphoneCallStateCb)(struct _LinphoneCore *lc, LinphoneCall *call, LinphoneCallState cstate, const char *message);
526 /** @ingroup Proxies
527  * Registration state notification callback prototype
528  * */
529 typedef void (*LinphoneRegistrationStateCb)(struct _LinphoneCore *lc, LinphoneProxyConfig *cfg, LinphoneRegistrationState cstate, const char *message);
530 /** Callback prototype */
531 typedef void (*ShowInterfaceCb)(struct _LinphoneCore *lc);
532 /** Callback prototype */
533 typedef void (*DisplayStatusCb)(struct _LinphoneCore *lc, const char *message);
534 /** Callback prototype */
535 typedef void (*DisplayMessageCb)(struct _LinphoneCore *lc, const char *message);
536 /** Callback prototype */
537 typedef void (*DisplayUrlCb)(struct _LinphoneCore *lc, const char *message, const char *url);
538 /** Callback prototype */
539 typedef void (*LinphoneCoreCbFunc)(struct _LinphoneCore *lc,void * user_data);
540 /** Callback prototype */
541 typedef void (*NotifyReceivedCb)(struct _LinphoneCore *lc, LinphoneCall *call, const char *from, const char *event);
542 /**
543  * Report status change for a friend previously \link linphone_core_add_friend() added \endlink to #LinphoneCore.
544  * @param lc #LinphoneCore object .
545  * @param lf Updated #LinphoneFriend .
546  */
547 typedef void (*NotifyPresenceReceivedCb)(struct _LinphoneCore *lc, LinphoneFriend * lf);
548 /**
549  *  Reports that a new subscription request has been received and wait for a decision.
550  *  <br> Status on this subscription request is notified by \link linphone_friend_set_inc_subscribe_policy() changing policy \endlink for this friend
551  *      @param lc #LinphoneCore object
552  *      @param lf #LinphoneFriend corresponding to the subscriber
553  *      @param url of the subscriber
554  *  Callback prototype
555  *  */
556 typedef void (*NewSubscribtionRequestCb)(struct _LinphoneCore *lc, LinphoneFriend *lf, const char *url);
557 /** Callback prototype */
558 typedef void (*AuthInfoRequested)(struct _LinphoneCore *lc, const char *realm, const char *username);
559 /** Callback prototype */
560 typedef void (*CallLogUpdated)(struct _LinphoneCore *lc, struct _LinphoneCallLog *newcl);
561 /**
562  * Callback prototype
563  *
564  * @param lc #LinphoneCore object
565  * @param room #LinphoneChatRoom involved in this conversation. Can be be created by the framework in case \link #LinphoneAddress the from \endlink is not present in any chat room.
566  * @param from #LinphoneAddress from
567  * @param message incoming message
568  *  */
569 typedef void (*TextMessageReceived)(LinphoneCore *lc, LinphoneChatRoom *room, const LinphoneAddress *from, const char *message);
570 /** Callback prototype */
571 typedef void (*DtmfReceived)(struct _LinphoneCore* lc, LinphoneCall *call, int dtmf);
572 /** Callback prototype */
573 typedef void (*ReferReceived)(struct _LinphoneCore *lc, const char *refer_to);
574 /** Callback prototype */
575 typedef void (*BuddyInfoUpdated)(struct _LinphoneCore *lc, LinphoneFriend *lf);
576
577 /**
578  * This structure holds all callbacks that the application should implement.
579  *  None is mandatory.
580 **/
581 typedef struct _LinphoneVTable{
582         LinphoneGlobalStateCb global_state_changed; /**<Notifies globlal state changes*/
583         LinphoneRegistrationStateCb registration_state_changed;/**<Notifies registration state changes*/
584         LinphoneCallStateCb call_state_changed;/**<Notifies call state changes*/
585         NotifyPresenceReceivedCb notify_presence_recv; /**< Notify received presence events*/
586         NewSubscribtionRequestCb new_subscription_request; /**< Notify about pending subscription request */
587         AuthInfoRequested auth_info_requested; /**< Ask the application some authentication information */
588         CallLogUpdated call_log_updated; /**< Notifies that call log list has been updated */
589         TextMessageReceived text_received; /**< A text message has been received */
590         DtmfReceived dtmf_received; /**< A dtmf has been received received */
591         ReferReceived refer_received; /**< An out of call refer was received */
592         BuddyInfoUpdated buddy_info_updated; /**< a LinphoneFriend's BuddyInfo has changed*/
593         NotifyReceivedCb notify_recv; /**< Other notifications*/
594         DisplayStatusCb display_status; /**< Callback that notifies various events with human readable text.*/
595         DisplayMessageCb display_message;/**< Callback to display a message to the user */
596         DisplayMessageCb display_warning;/** Callback to display a warning to the user */
597         DisplayUrlCb display_url;
598         ShowInterfaceCb show; /**< Notifies the application that it should show up*/
599 } LinphoneCoreVTable;
600
601 /**
602  * @}
603 **/
604
605 typedef struct _LCCallbackObj
606 {
607   LinphoneCoreCbFunc _func;
608   void * _user_data;
609 }LCCallbackObj;
610
611
612
613 typedef enum _LinphoneFirewallPolicy{
614         LinphonePolicyNoFirewall,
615         LinphonePolicyUseNatAddress,
616         LinphonePolicyUseStun
617 } LinphoneFirewallPolicy;
618
619 typedef enum _LinphoneWaitingState{
620         LinphoneWaitingStart,
621         LinphoneWaitingProgress,
622         LinphoneWaitingFinished
623 } LinphoneWaitingState;
624 typedef void * (*LinphoneWaitingCallback)(struct _LinphoneCore *lc, void *context, LinphoneWaitingState ws, const char *purpose, float progress);
625
626
627 /* THE main API */
628
629 void linphone_core_enable_logs(FILE *file);
630 void linphone_core_enable_logs_with_cb(OrtpLogFunc logfunc);
631 void linphone_core_disable_logs(void);
632 /*sets the user-agent string in sip messages, must be set before linphone_core_new() or linphone_core_init() */
633 void linphone_core_set_user_agent(const char *ua_name, const char *version);
634 const char *linphone_core_get_version(void);
635
636 LinphoneCore *linphone_core_new(const LinphoneCoreVTable *vtable,
637                                                 const char *config_path, const char *factory_config, void* userdata);
638
639 /* function to be periodically called in a main loop */
640 void linphone_core_iterate(LinphoneCore *lc);
641
642 LinphoneAddress * linphone_core_interpret_url(LinphoneCore *lc, const char *url);
643
644 LinphoneCall * linphone_core_invite(LinphoneCore *lc, const char *url);
645
646 LinphoneCall * linphone_core_invite_address(LinphoneCore *lc, const LinphoneAddress *addr);
647
648 LinphoneCall * linphone_core_invite_with_params(LinphoneCore *lc, const char *url, const LinphoneCallParams *params);
649
650 LinphoneCall * linphone_core_invite_address_with_params(LinphoneCore *lc, const LinphoneAddress *addr, const LinphoneCallParams *params);
651
652 int linphone_core_transfer_call(LinphoneCore *lc, LinphoneCall *call, const char *refer_to);
653
654 int linphone_core_transfer_call_to_another(LinphoneCore *lc, LinphoneCall *call, LinphoneCall *dest);
655
656 bool_t linphone_core_inc_invite_pending(LinphoneCore*lc);
657
658 bool_t linphone_core_in_call(const LinphoneCore *lc);
659
660 LinphoneCall *linphone_core_get_current_call(const LinphoneCore *lc);
661
662 int linphone_core_accept_call(LinphoneCore *lc, LinphoneCall *call);
663
664 int linphone_core_terminate_call(LinphoneCore *lc, LinphoneCall *call);
665
666 int linphone_core_terminate_all_calls(LinphoneCore *lc);
667
668 int linphone_core_pause_call(LinphoneCore *lc, LinphoneCall *call);
669
670 int linphone_core_pause_all_calls(LinphoneCore *lc);
671
672 int linphone_core_resume_call(LinphoneCore *lc, LinphoneCall *call);
673
674 int linphone_core_update_call(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
675
676 LinphoneCallParams *linphone_core_create_default_call_parameters(LinphoneCore *lc);
677
678 LinphoneCall *linphone_core_get_call_by_remote_address(LinphoneCore *lc, const char *remote_address);
679
680 void linphone_core_send_dtmf(LinphoneCore *lc,char dtmf);
681
682 int linphone_core_set_primary_contact(LinphoneCore *lc, const char *contact);
683
684 const char *linphone_core_get_primary_contact(LinphoneCore *lc);
685
686 const char * linphone_core_get_identity(LinphoneCore *lc);
687
688 void linphone_core_set_guess_hostname(LinphoneCore *lc, bool_t val);
689 bool_t linphone_core_get_guess_hostname(LinphoneCore *lc);
690
691 bool_t linphone_core_ipv6_enabled(LinphoneCore *lc);
692 void linphone_core_enable_ipv6(LinphoneCore *lc, bool_t val);
693
694 LinphoneAddress *linphone_core_get_primary_contact_parsed(LinphoneCore *lc);
695 const char * linphone_core_get_identity(LinphoneCore *lc);
696 /*0= no bandwidth limit*/
697 void linphone_core_set_download_bandwidth(LinphoneCore *lc, int bw);
698 void linphone_core_set_upload_bandwidth(LinphoneCore *lc, int bw);
699
700 int linphone_core_get_download_bandwidth(const LinphoneCore *lc);
701 int linphone_core_get_upload_bandwidth(const LinphoneCore *lc);
702 /**
703  * set audio packetization time linphone expect to received from peer
704  * @ingroup media_parameters
705  *
706  */
707 void linphone_core_set_download_ptime(LinphoneCore *lc, int ptime);
708 /**
709  * get audio packetization time linphone expect to received from peer, 0 means unspecified
710  * @ingroup media_parameters
711  */
712 int  linphone_core_get_download_ptime(LinphoneCore *lc);
713
714 /* returns a MSList of PayloadType */
715 const MSList *linphone_core_get_audio_codecs(const LinphoneCore *lc);
716
717 int linphone_core_set_audio_codecs(LinphoneCore *lc, MSList *codecs);
718 /* returns a MSList of PayloadType */
719 const MSList *linphone_core_get_video_codecs(const LinphoneCore *lc);
720
721 int linphone_core_set_video_codecs(LinphoneCore *lc, MSList *codecs);
722
723 bool_t linphone_core_payload_type_enabled(LinphoneCore *lc, PayloadType *pt);
724
725 int linphone_core_enable_payload_type(LinphoneCore *lc, PayloadType *pt, bool_t enable);
726
727 PayloadType* linphone_core_find_payload_type(LinphoneCore* lc, const char* type, int rate) ;
728
729 const char *linphone_core_get_payload_type_description(LinphoneCore *lc, PayloadType *pt);
730
731 bool_t linphone_core_check_payload_type_usability(LinphoneCore *lc, PayloadType *pt);
732
733 int linphone_core_add_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
734
735 void linphone_core_clear_proxy_config(LinphoneCore *lc);
736
737 void linphone_core_remove_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
738
739 const MSList *linphone_core_get_proxy_config_list(const LinphoneCore *lc);
740
741 void linphone_core_set_default_proxy(LinphoneCore *lc, LinphoneProxyConfig *config);
742
743 void linphone_core_set_default_proxy_index(LinphoneCore *lc, int index);
744
745 int linphone_core_get_default_proxy(LinphoneCore *lc, LinphoneProxyConfig **config);
746
747 void linphone_core_add_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
748
749 void linphone_core_remove_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
750
751 const MSList *linphone_core_get_auth_info_list(const LinphoneCore *lc);
752
753 const LinphoneAuthInfo *linphone_core_find_auth_info(LinphoneCore *lc, const char *realm, const char *username);
754
755 void linphone_core_abort_authentication(LinphoneCore *lc,  LinphoneAuthInfo *info);
756
757 void linphone_core_clear_all_auth_info(LinphoneCore *lc);
758
759 int linphone_core_get_audio_jittcomp(LinphoneCore *lc);
760
761 void linphone_core_set_audio_jittcomp(LinphoneCore *lc, int value);
762
763 int linphone_core_get_audio_port(const LinphoneCore *lc);
764
765 int linphone_core_get_video_port(const LinphoneCore *lc);
766
767 int linphone_core_get_nortp_timeout(const LinphoneCore *lc);
768
769 void linphone_core_set_audio_port(LinphoneCore *lc, int port);
770
771 void linphone_core_set_video_port(LinphoneCore *lc, int port);
772
773 void linphone_core_set_nortp_timeout(LinphoneCore *lc, int port);
774
775 void linphone_core_set_use_info_for_dtmf(LinphoneCore *lc, bool_t use_info);
776
777 bool_t linphone_core_get_use_info_for_dtmf(LinphoneCore *lc);
778
779 void linphone_core_set_use_rfc2833_for_dtmf(LinphoneCore *lc,bool_t use_rfc2833);
780
781 bool_t linphone_core_get_use_rfc2833_for_dtmf(LinphoneCore *lc);
782
783 void linphone_core_set_sip_port(LinphoneCore *lc, int port);
784
785 int linphone_core_get_sip_port(LinphoneCore *lc);
786
787 int linphone_core_set_sip_transports(LinphoneCore *lc, const LCSipTransports *transports);
788
789 int linphone_core_get_sip_transports(LinphoneCore *lc, LCSipTransports *transports);
790 /**
791  * @ingroup IOS
792  * Give access to the UDP sip socket. Can be useful to configure this socket as persistent I.E kCFStreamNetworkServiceType set to kCFStreamNetworkServiceTypeVoIP)
793  * @param lc #LinphoneCore
794  * @return socket file descriptor
795  */
796 ortp_socket_t linphone_core_get_sip_socket(LinphoneCore *lc);
797
798 void linphone_core_set_inc_timeout(LinphoneCore *lc, int seconds);
799
800 int linphone_core_get_inc_timeout(LinphoneCore *lc);
801
802 void linphone_core_set_stun_server(LinphoneCore *lc, const char *server);
803
804 const char * linphone_core_get_stun_server(const LinphoneCore *lc);
805
806 void linphone_core_set_nat_address(LinphoneCore *lc, const char *addr);
807
808 const char *linphone_core_get_nat_address(const LinphoneCore *lc);
809
810 void linphone_core_set_firewall_policy(LinphoneCore *lc, LinphoneFirewallPolicy pol);
811
812 LinphoneFirewallPolicy linphone_core_get_firewall_policy(const LinphoneCore *lc);
813
814 const char * linphone_core_get_relay_addr(const LinphoneCore *lc);
815
816 int linphone_core_set_relay_addr(LinphoneCore *lc, const char *addr);
817
818 /* sound functions */
819 /* returns a null terminated static array of string describing the sound devices */ 
820 const char**  linphone_core_get_sound_devices(LinphoneCore *lc);
821 bool_t linphone_core_sound_device_can_capture(LinphoneCore *lc, const char *device);
822 bool_t linphone_core_sound_device_can_playback(LinphoneCore *lc, const char *device);
823 int linphone_core_get_ring_level(LinphoneCore *lc);
824 int linphone_core_get_play_level(LinphoneCore *lc);
825 int linphone_core_get_rec_level(LinphoneCore *lc);
826 void linphone_core_set_ring_level(LinphoneCore *lc, int level);
827 void linphone_core_set_play_level(LinphoneCore *lc, int level);
828
829 void linphone_core_set_playback_gain_db(LinphoneCore *lc, float level);
830
831 float linphone_core_get_playback_gain_db(LinphoneCore *lc);
832 void linphone_core_set_rec_level(LinphoneCore *lc, int level);
833 const char * linphone_core_get_ringer_device(LinphoneCore *lc);
834 const char * linphone_core_get_playback_device(LinphoneCore *lc);
835 const char * linphone_core_get_capture_device(LinphoneCore *lc);
836 int linphone_core_set_ringer_device(LinphoneCore *lc, const char * devid);
837 int linphone_core_set_playback_device(LinphoneCore *lc, const char * devid);
838 int linphone_core_set_capture_device(LinphoneCore *lc, const char * devid);
839 char linphone_core_get_sound_source(LinphoneCore *lc);
840 void linphone_core_set_sound_source(LinphoneCore *lc, char source);
841 void linphone_core_set_ring(LinphoneCore *lc, const char *path);
842 const char *linphone_core_get_ring(const LinphoneCore *lc);
843 void linphone_core_set_ringback(LinphoneCore *lc, const char *path);
844 const char * linphone_core_get_ringback(const LinphoneCore *lc);
845
846 void linphone_core_set_remote_ringback_tone(LinphoneCore *lc,const char *);
847 const char *linphone_core_get_remote_ringback_tone(const LinphoneCore *lc);
848
849 int linphone_core_preview_ring(LinphoneCore *lc, const char *ring,LinphoneCoreCbFunc func,void * userdata);
850 void linphone_core_enable_echo_cancellation(LinphoneCore *lc, bool_t val);
851 bool_t linphone_core_echo_cancellation_enabled(LinphoneCore *lc);
852
853 void linphone_core_enable_echo_limiter(LinphoneCore *lc, bool_t val);
854 bool_t linphone_core_echo_limiter_enabled(const LinphoneCore *lc);
855
856 void linphone_core_enable_agc(LinphoneCore *lc, bool_t val);
857 bool_t linphone_core_agc_enabled(const LinphoneCore *lc);
858
859 void linphone_core_mute_mic(LinphoneCore *lc, bool_t muted);
860 /**
861  * return mic state.
862  *
863  * @ingroup media_parameters
864 **/
865 bool_t linphone_core_is_mic_muted(LinphoneCore *lc);
866
867 bool_t linphone_core_is_audio_muted(LinphoneCore *lc);
868 bool_t linphone_core_is_rtp_muted(LinphoneCore *lc);
869
870 bool_t linphone_core_get_rtp_no_xmit_on_audio_mute(const LinphoneCore *lc);
871 void linphone_core_set_rtp_no_xmit_on_audio_mute(LinphoneCore *lc, bool_t val);
872
873
874 /* returns a list of LinphoneCallLog */
875 const MSList * linphone_core_get_call_logs(LinphoneCore *lc);
876 void linphone_core_clear_call_logs(LinphoneCore *lc);
877
878 /* video support */
879 void linphone_core_enable_video(LinphoneCore *lc, bool_t vcap_enabled, bool_t display_enabled);
880 bool_t linphone_core_video_enabled(LinphoneCore *lc);
881
882 typedef struct MSVideoSizeDef{
883         MSVideoSize vsize;
884         const char *name;
885 }MSVideoSizeDef;
886 /* returns a zero terminated table of MSVideoSizeDef*/
887 const MSVideoSizeDef *linphone_core_get_supported_video_sizes(LinphoneCore *lc);
888 void linphone_core_set_preferred_video_size(LinphoneCore *lc, MSVideoSize vsize);
889 MSVideoSize linphone_core_get_preferred_video_size(LinphoneCore *lc);
890 void linphone_core_set_preferred_video_size_by_name(LinphoneCore *lc, const char *name);
891
892 void linphone_core_enable_video_preview(LinphoneCore *lc, bool_t val);
893 bool_t linphone_core_video_preview_enabled(const LinphoneCore *lc);
894
895 void linphone_core_enable_self_view(LinphoneCore *lc, bool_t val);
896 bool_t linphone_core_self_view_enabled(const LinphoneCore *lc);
897
898
899 /* returns a null terminated static array of string describing the webcams */ 
900 const char**  linphone_core_get_video_devices(const LinphoneCore *lc);
901 int linphone_core_set_video_device(LinphoneCore *lc, const char *id);
902 const char *linphone_core_get_video_device(const LinphoneCore *lc);
903
904 /* Set static picture to be used when "Static picture" is the video device */
905 int linphone_core_set_static_picture(LinphoneCore *lc, const char *path);
906
907 /* Set and get frame rate for static picture */
908 int linphone_core_set_static_picture_fps(LinphoneCore *lc, float fps);
909 float linphone_core_get_static_picture_fps(LinphoneCore *lc);
910
911 /*function to be used for eventually setting window decorations (icons, title...)*/
912 unsigned long linphone_core_get_native_video_window_id(const LinphoneCore *lc);
913 void linphone_core_set_native_video_window_id(LinphoneCore *lc, unsigned long id);
914
915 unsigned long linphone_core_get_native_preview_window_id(const LinphoneCore *lc);
916 void linphone_core_set_native_preview_window_id(LinphoneCore *lc, unsigned long id);
917
918 void linphone_core_use_preview_window(LinphoneCore *lc, bool_t yesno);
919
920 /*play/record support: use files instead of soundcard*/
921 void linphone_core_use_files(LinphoneCore *lc, bool_t yesno);
922 void linphone_core_set_play_file(LinphoneCore *lc, const char *file);
923 void linphone_core_set_record_file(LinphoneCore *lc, const char *file);
924
925 void linphone_core_play_dtmf(LinphoneCore *lc, char dtmf, int duration_ms);
926 void linphone_core_stop_dtmf(LinphoneCore *lc);
927
928 int linphone_core_get_current_call_duration(const LinphoneCore *lc);
929
930
931 int linphone_core_get_mtu(const LinphoneCore *lc);
932 void linphone_core_set_mtu(LinphoneCore *lc, int mtu);
933
934 /**
935  * @ingroup network_parameters
936  * This method is called by the application to notify the linphone core library when network is reachable.
937  * Calling this method with true trigger linphone to initiate a registration process for all proxy
938  * configuration with parameter register set to enable.
939  * This method disable the automatic registration mode. It means you must call this method after each network state changes
940  *
941  */
942 void linphone_core_set_network_reachable(LinphoneCore* lc,bool_t value);
943 /**
944  * @ingroup network_parameters
945  * return network state either as positioned by the application or by linphone
946  */
947 bool_t linphone_core_is_network_reachabled(LinphoneCore* lc);
948
949 /**
950  *  @ingroup network_parameters
951  *  enable signaling keep alive. small udp packet sent periodically to keep udp NAT association
952  */
953 void linphone_core_enable_keep_alive(LinphoneCore* lc,bool_t enable);
954 /**
955  *  @ingroup network_parameters
956  * Is signaling keep alive
957  */
958 bool_t linphone_core_keep_alive_enabled(LinphoneCore* lc);
959
960 void *linphone_core_get_user_data(LinphoneCore *lc);
961
962 /* returns LpConfig object to read/write to the config file: usefull if you wish to extend
963 the config file with your own sections */
964 struct _LpConfig *linphone_core_get_config(LinphoneCore *lc);
965
966 /* attempts to wake up another linphone engine already running.
967 The "show" callback is called for the other linphone, causing gui to show up.
968 call_addr is an optional sip-uri to call immediately after waking up.
969 The method returns 0 if an already running linphone was found*/
970
971 int linphone_core_wake_up_possible_already_running_instance(
972     const char * config_file, const char * call_addr);
973
974 /*set a callback for some blocking operations, it takes you informed of the progress of the operation*/
975 void linphone_core_set_waiting_callback(LinphoneCore *lc, LinphoneWaitingCallback cb, void *user_context);
976
977 /*returns the list of registered SipSetup (linphonecore plugins) */
978 const MSList * linphone_core_get_sip_setups(LinphoneCore *lc);
979
980 void linphone_core_destroy(LinphoneCore *lc);
981
982 /*for advanced users:*/
983 void linphone_core_set_audio_transports(LinphoneCore *lc, RtpTransport *rtp, RtpTransport *rtcp);
984
985 int linphone_core_get_current_call_stats(LinphoneCore *lc, rtp_stats_t *local, rtp_stats_t *remote);
986
987 const MSList *linphone_core_get_calls(LinphoneCore *lc);
988
989 LinphoneGlobalState linphone_core_get_global_state(const LinphoneCore *lc);
990 /**
991  * force registration refresh to be initiated upon next iterate
992  * @ingroup proxies
993  */
994 void linphone_core_refresh_registers(LinphoneCore* lc); 
995 #ifdef __cplusplus
996 }
997 #endif
998
999 void linphone_call_send_vfu_request(LinphoneCall *call);
1000
1001 #endif