3 Copyright (C) 2000 - 2010 Simon MORLAT (simon.morlat@linphone.org)
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.
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.
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.
19 #ifndef LINPHONECORE_H
20 #define LINPHONECORE_H
22 #include "ortp/ortp.h"
23 #include "ortp/payloadtype.h"
24 #include "mediastreamer2/mscommon.h"
25 #include "mediastreamer2/msvideo.h"
30 #include "linphone/sipsetup.h"
33 #define LINPHONE_IPADDR_SIZE 64
34 #define LINPHONE_HOSTNAME_SIZE 128
43 * Linphone core main object created by function linphone_core_new() .
44 * @ingroup initializing
46 typedef struct _LinphoneCore LinphoneCore;
52 struct _LCSipTransports{
59 typedef struct _LCSipTransports LCSipTransports;
62 * Object that represents a SIP address.
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
72 * @ingroup linphone_address
73 * @var LinphoneAddress
75 typedef struct SalAddress LinphoneAddress;
77 #include "linphonefriend.h"
79 #include "linphone/linphonefriend.h"
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);
89 * Get port number as an integer value.
92 int linphone_address_get_port_int(const LinphoneAddress *u);
94 * Get port number, null if not present.
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);
109 struct _SipSetupContext;
113 * Enum representing the direction of a call.
116 enum _LinphoneCallDir {
117 LinphoneCallOutgoing, /**< outgoing calls*/
118 LinphoneCallIncoming /**< incoming calls*/
125 typedef enum _LinphoneCallDir LinphoneCallDir;
128 * Enum representing the status of a call
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;
139 * Structure representing a call log.
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*/
153 rtp_stats_t local_stats;
154 rtp_stats_t remote_stats;
156 struct _LinphoneCore *lc;
162 void linphone_call_log_set_user_pointer(LinphoneCallLog *cl, void *up);
163 void *linphone_call_log_get_user_pointer(const LinphoneCallLog *cl);
164 void linphone_call_log_set_ref_key(LinphoneCallLog *cl, const char *refkey);
165 const char *linphone_call_log_get_ref_key(const LinphoneCallLog *cl);
166 const rtp_stats_t *linphone_call_log_get_local_stats(const LinphoneCallLog *cl);
167 const rtp_stats_t *linphone_call_log_get_remote_stats(const LinphoneCallLog *cl);
168 char * linphone_call_log_to_str(LinphoneCallLog *cl);
172 * The LinphoneCallParams is an object containing various call related parameters.
173 * It can be used to retrieve parameters from a currently running call or modify the call's characteristics
176 struct _LinphoneCallParams;
177 typedef struct _LinphoneCallParams LinphoneCallParams;
179 LinphoneCallParams * linphone_call_params_copy(const LinphoneCallParams *cp);
180 void linphone_call_params_enable_video(LinphoneCallParams *cp, bool_t enabled);
181 bool_t linphone_call_params_video_enabled(const LinphoneCallParams *cp);
182 void linphone_call_params_enable_early_media_sending(LinphoneCallParams *cp, bool_t enabled);
183 bool_t linphone_call_params_early_media_sending_enabled(const LinphoneCallParams *cp);
184 void linphone_call_params_set_audio_bandwidth_limit(LinphoneCallParams *cp, int bw);
185 void linphone_call_params_destroy(LinphoneCallParams *cp);
188 * Enum describing failure reasons.
189 * @ingroup initializing
191 enum _LinphoneReason{
193 LinphoneReasonNoResponse, /**<No response received from remote*/
194 LinphoneReasonBadCredentials, /**<Authentication failed due to bad or missing credentials*/
195 LinphoneReasonDeclined, /**<The call has been declined*/
198 typedef enum _LinphoneReason LinphoneReason;
200 const char *linphone_reason_to_string(LinphoneReason err);
203 * The LinphoneCall object represents a call issued or received by the LinphoneCore
205 struct _LinphoneCall;
206 typedef struct _LinphoneCall LinphoneCall;
209 * LinphoneCallState enum represents the different state a call can reach into.
210 * The application is notified of state changes through the LinphoneCoreVTable::call_state_changed callback.
211 * @ingroup call_control
213 typedef enum _LinphoneCallState{
214 LinphoneCallIdle, /**<Initial call state */
215 LinphoneCallIncomingReceived, /**<This is a new incoming call */
216 LinphoneCallOutgoingInit, /**<An outgoing call is started */
217 LinphoneCallOutgoingProgress, /**<An outgoing call is in progress */
218 LinphoneCallOutgoingRinging, /**<An outgoing call is ringing at remote end */
219 LinphoneCallOutgoingEarlyMedia, /**<An outgoing call is proposed early media */
220 LinphoneCallConnected, /**<Connected, the call is answered */
221 LinphoneCallStreamsRunning, /**<The media streams are established and running*/
222 LinphoneCallPausing, /**<The call is pausing at the initiative of local end */
223 LinphoneCallPaused, /**< The call is paused, remote end has accepted the pause */
224 LinphoneCallResuming, /**<The call is being resumed by local end*/
225 LinphoneCallRefered, /**<The call is being transfered to another party, resulting in a new outgoing call to follow immediately*/
226 LinphoneCallError, /**<The call encountered an error*/
227 LinphoneCallEnd, /**<The call ended normally*/
228 LinphoneCallPausedByRemote, /**<The call is paused by remote end*/
229 LinphoneCallUpdatedByRemote, /**<The call's parameters are updated, used for example when video is asked by remote */
230 LinphoneCallIncomingEarlyMedia, /**<We are proposing early media to an incoming call */
231 LinphoneCallUpdated, /**<The remote accepted the call update initiated by us */
232 LinphoneCallReleased /**< The call object is no more retained by the core */
235 const char *linphone_call_state_to_string(LinphoneCallState cs);
238 LinphoneCallState linphone_call_get_state(const LinphoneCall *call);
239 bool_t linphone_call_asked_to_autoanswer(LinphoneCall *call);
240 const LinphoneAddress * linphone_core_get_current_call_remote_address(struct _LinphoneCore *lc);
241 const LinphoneAddress * linphone_call_get_remote_address(const LinphoneCall *call);
242 char *linphone_call_get_remote_address_as_string(const LinphoneCall *call);
243 LinphoneCallDir linphone_call_get_dir(const LinphoneCall *call);
244 void linphone_call_ref(LinphoneCall *call);
245 void linphone_call_unref(LinphoneCall *call);
246 LinphoneCallLog *linphone_call_get_call_log(const LinphoneCall *call);
247 const char *linphone_call_get_refer_to(const LinphoneCall *call);
248 bool_t linphone_call_has_transfer_pending(const LinphoneCall *call);
249 LinphoneCall *linphone_call_get_replaced_call(LinphoneCall *call);
250 int linphone_call_get_duration(const LinphoneCall *call);
251 const LinphoneCallParams * linphone_call_get_current_params(const LinphoneCall *call);
252 void linphone_call_enable_camera(LinphoneCall *lc, bool_t enabled);
253 bool_t linphone_call_camera_enabled(const LinphoneCall *lc);
254 int linphone_call_take_video_snapshot(LinphoneCall *call, const char *file);
255 LinphoneReason linphone_call_get_reason(const LinphoneCall *call);
256 const char *linphone_call_get_remote_user_agent(LinphoneCall *call);
257 float linphone_call_get_play_volume(LinphoneCall *call);
258 float linphone_call_get_record_volume(LinphoneCall *call);
259 float linphone_call_get_current_quality(LinphoneCall *call);
260 float linphone_call_get_average_quality(LinphoneCall *call);
261 void *linphone_call_get_user_pointer(LinphoneCall *call);
262 void linphone_call_set_user_pointer(LinphoneCall *call, void *user_pointer);
264 * Enables or disable echo cancellation for this call
268 * @ingroup media_parameters
270 void linphone_call_enable_echo_cancellation(LinphoneCall *call, bool_t val) ;
272 * Returns TRUE if echo cancellation is enabled.
274 * @ingroup media_parameters
276 bool_t linphone_call_echo_cancellation_enabled(LinphoneCall *lc);
278 * Enables or disable echo limiter for this call
282 * @ingroup media_parameters
284 void linphone_call_enable_echo_limiter(LinphoneCall *call, bool_t val);
286 * Returns TRUE if echo limiter is enabled.
288 * @ingroup media_parameters
290 bool_t linphone_call_echo_limiter_enabled(const LinphoneCall *call);
292 /*keep this in sync with mediastreamer2/msvolume.h*/
293 #define LINPHONE_VOLUME_DB_LOWEST (-120) /**< Lowest measured that can be returned.*/
296 * @addtogroup proxies
300 * The LinphoneProxyConfig object represents a proxy configuration to be used
301 * by the LinphoneCore object.
302 * Its fields must not be used directly in favour of the accessors methods.
303 * Once created and filled properly the LinphoneProxyConfig can be given to
304 * LinphoneCore with linphone_core_add_proxy_config().
305 * This will automatically triggers the registration, if enabled.
307 * The proxy configuration are persistent to restarts because they are saved
308 * in the configuration file. As a consequence, after linphone_core_new() there
309 * might already be a list of configured proxy that can be examined with
310 * linphone_core_get_proxy_config_list().
312 * The default proxy (see linphone_core_set_default_proxy() ) is the one of the list
313 * that is used by default for calls.
315 typedef struct _LinphoneProxyConfig LinphoneProxyConfig;
318 * LinphoneRegistrationState describes proxy registration states.
320 typedef enum _LinphoneRegistrationState{
321 LinphoneRegistrationNone, /**<Initial state for registrations */
322 LinphoneRegistrationProgress, /**<Registration is in progress */
323 LinphoneRegistrationOk, /**< Registration is successful */
324 LinphoneRegistrationCleared, /**< Unregistration succeeded */
325 LinphoneRegistrationFailed /**<Registration failed */
326 }LinphoneRegistrationState;
329 * Human readable version of the #LinphoneRegistrationState
332 const char *linphone_registration_state_to_string(LinphoneRegistrationState cs);
334 LinphoneProxyConfig *linphone_proxy_config_new(void);
335 int linphone_proxy_config_set_server_addr(LinphoneProxyConfig *obj, const char *server_addr);
336 int linphone_proxy_config_set_identity(LinphoneProxyConfig *obj, const char *identity);
337 int linphone_proxy_config_set_route(LinphoneProxyConfig *obj, const char *route);
338 void linphone_proxy_config_expires(LinphoneProxyConfig *obj, int expires);
340 * Indicates either or not, REGISTRATION must be issued for this #LinphoneProxyConfig .
341 * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
342 * @param obj object pointer
343 * @param val if true, registration will be engaged
345 void linphone_proxy_config_enable_register(LinphoneProxyConfig *obj, bool_t val);
346 #define linphone_proxy_config_enableregister linphone_proxy_config_enable_register
347 void linphone_proxy_config_edit(LinphoneProxyConfig *obj);
348 int linphone_proxy_config_done(LinphoneProxyConfig *obj);
350 * Indicates either or not, PUBLISH must be issued for this #LinphoneProxyConfig .
351 * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
352 * @param obj object pointer
353 * @param val if true, publish will be engaged
356 void linphone_proxy_config_enable_publish(LinphoneProxyConfig *obj, bool_t val);
357 void linphone_proxy_config_set_dial_escape_plus(LinphoneProxyConfig *cfg, bool_t val);
358 void linphone_proxy_config_set_dial_prefix(LinphoneProxyConfig *cfg, const char *prefix);
360 LinphoneRegistrationState linphone_proxy_config_get_state(const LinphoneProxyConfig *obj);
361 bool_t linphone_proxy_config_is_registered(const LinphoneProxyConfig *obj);
362 const char *linphone_proxy_config_get_domain(const LinphoneProxyConfig *cfg);
364 const char *linphone_proxy_config_get_route(const LinphoneProxyConfig *obj);
365 const char *linphone_proxy_config_get_identity(const LinphoneProxyConfig *obj);
366 bool_t linphone_proxy_config_publish_enabled(const LinphoneProxyConfig *obj);
367 const char *linphone_proxy_config_get_addr(const LinphoneProxyConfig *obj);
368 int linphone_proxy_config_get_expires(const LinphoneProxyConfig *obj);
369 bool_t linphone_proxy_config_register_enabled(const LinphoneProxyConfig *obj);
370 void linphone_proxy_config_refresh_register(LinphoneProxyConfig *obj);
371 struct _LinphoneCore * linphone_proxy_config_get_core(const LinphoneProxyConfig *obj);
373 bool_t linphone_proxy_config_get_dial_escape_plus(const LinphoneProxyConfig *cfg);
374 const char * linphone_proxy_config_get_dial_prefix(const LinphoneProxyConfig *cfg);
376 LinphoneReason linphone_proxy_config_get_error(const LinphoneProxyConfig *cfg);
378 /* destruction is called automatically when removing the proxy config */
379 void linphone_proxy_config_destroy(LinphoneProxyConfig *cfg);
380 void linphone_proxy_config_set_sip_setup(LinphoneProxyConfig *cfg, const char *type);
381 SipSetupContext *linphone_proxy_config_get_sip_setup_context(LinphoneProxyConfig *cfg);
382 SipSetup *linphone_proxy_config_get_sip_setup(LinphoneProxyConfig *cfg);
384 * normalize a human readable phone number into a basic string. 888-444-222 becomes 888444222
386 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *proxy, const char *username, char *result, size_t result_len);
388 * attached a user data to a proxy config
390 void linphone_proxy_config_set_user_data(LinphoneProxyConfig *cr, void * ud);
392 * get user data to a proxy config. return null if any
394 void * linphone_proxy_config_get_user_data(LinphoneProxyConfig *cr);
400 typedef struct _LinphoneAccountCreator{
401 struct _LinphoneCore *lc;
402 struct _SipSetupContext *ssctx;
407 }LinphoneAccountCreator;
409 LinphoneAccountCreator *linphone_account_creator_new(struct _LinphoneCore *core, const char *type);
410 void linphone_account_creator_set_username(LinphoneAccountCreator *obj, const char *username);
411 void linphone_account_creator_set_password(LinphoneAccountCreator *obj, const char *password);
412 void linphone_account_creator_set_domain(LinphoneAccountCreator *obj, const char *domain);
413 const char * linphone_account_creator_get_username(LinphoneAccountCreator *obj);
414 const char * linphone_account_creator_get_domain(LinphoneAccountCreator *obj);
415 int linphone_account_creator_test_existence(LinphoneAccountCreator *obj);
416 LinphoneProxyConfig * linphone_account_creator_validate(LinphoneAccountCreator *obj);
417 void linphone_account_creator_destroy(LinphoneAccountCreator *obj);
419 struct _LinphoneAuthInfo;
422 * @ingroup authentication
423 * Object holding authentication information.
425 * @note The object's fields should not be accessed directly. Prefer using
426 * the accessor methods.
428 * In most case, authentication information consists of a username and password.
429 * Sometimes, a userid is required by proxy, and realm can be useful to discriminate
430 * different SIP domains.
432 * Once created and filled, a LinphoneAuthInfo must be added to the LinphoneCore in
433 * order to become known and used automatically when needed.
434 * Use linphone_core_add_auth_info() for that purpose.
436 * The LinphoneCore object can take the initiative to request authentication information
437 * when needed to the application through the auth_info_requested callback of the
438 * LinphoneCoreVTable structure.
440 * The application can respond to this information request later using
441 * linphone_core_add_auth_info(). This will unblock all pending authentication
442 * transactions and retry them with authentication headers.
445 typedef struct _LinphoneAuthInfo LinphoneAuthInfo;
447 LinphoneAuthInfo *linphone_auth_info_new(const char *username, const char *userid,
448 const char *passwd, const char *ha1,const char *realm);
449 void linphone_auth_info_set_passwd(LinphoneAuthInfo *info, const char *passwd);
450 void linphone_auth_info_set_username(LinphoneAuthInfo *info, const char *username);
451 void linphone_auth_info_set_userid(LinphoneAuthInfo *info, const char *userid);
453 const char *linphone_auth_info_get_username(const LinphoneAuthInfo *i);
454 const char *linphone_auth_info_get_passwd(const LinphoneAuthInfo *i);
455 const char *linphone_auth_info_get_userid(const LinphoneAuthInfo *i);
457 /* you don't need those function*/
458 void linphone_auth_info_destroy(LinphoneAuthInfo *info);
459 LinphoneAuthInfo * linphone_auth_info_new_from_config_file(struct _LpConfig *config, int pos);
462 struct _LinphoneChatRoom;
464 * @addtogroup chatroom
468 * A chat room is the place where text messages are exchanged.
469 * <br> Can be created by linphone_core_create_chat_room().
471 typedef struct _LinphoneChatRoom LinphoneChatRoom;
473 * Create a new chat room for messaging from a sip uri like sip:joe@sip.linphone.org
474 * @param lc #LinphoneCore object
475 * @param to destination address for messages
476 * @return #LinphoneChatRoom where messaging can take place.
478 LinphoneChatRoom * linphone_core_create_chat_room(LinphoneCore *lc, const char *to);
481 * @param cr #LinphoneChatRoom object
483 void linphone_chat_room_destroy(LinphoneChatRoom *cr);
487 * get peer address \link linphone_core_create_chat_room() associated to \endlink this #LinphoneChatRoom
488 * @param cr #LinphoneChatRoom object
489 * @return #LinphoneAddress peer address
491 const LinphoneAddress* linphone_chat_room_get_peer_address(LinphoneChatRoom *cr);
493 * send a message to peer member of this chat room.
494 * @param cr #LinphoneChatRoom object
495 * @param msg message to be sent
497 void linphone_chat_room_send_message(LinphoneChatRoom *cr, const char *msg);
499 void linphone_chat_room_set_user_data(LinphoneChatRoom *cr, void * ud);
500 void * linphone_chat_room_get_user_data(LinphoneChatRoom *cr);
508 * @addtogroup initializing
513 * LinphoneGlobalState describes the global state of the LinphoneCore object.
514 * It is notified via the LinphoneCoreVTable::global_state_changed
516 typedef enum _LinphoneGlobalState{
518 LinphoneGlobalStartup,
520 LinphoneGlobalShutdown
521 }LinphoneGlobalState;
523 const char *linphone_global_state_to_string(LinphoneGlobalState gs);
526 /**Call state notification callback prototype*/
527 typedef void (*LinphoneGlobalStateCb)(struct _LinphoneCore *lc, LinphoneGlobalState gstate, const char *message);
528 /**Call state notification callback prototype*/
529 typedef void (*LinphoneCallStateCb)(struct _LinphoneCore *lc, LinphoneCall *call, LinphoneCallState cstate, const char *message);
530 /**Call encryption changed callback prototype*/
531 typedef void (*CallEncryptionChangedCb)(struct _LinphoneCore *lc, LinphoneCall *call, bool_t on, const char *authentication_token);
534 * Registration state notification callback prototype
536 typedef void (*LinphoneRegistrationStateCb)(struct _LinphoneCore *lc, LinphoneProxyConfig *cfg, LinphoneRegistrationState cstate, const char *message);
537 /** Callback prototype */
538 typedef void (*ShowInterfaceCb)(struct _LinphoneCore *lc);
539 /** Callback prototype */
540 typedef void (*DisplayStatusCb)(struct _LinphoneCore *lc, const char *message);
541 /** Callback prototype */
542 typedef void (*DisplayMessageCb)(struct _LinphoneCore *lc, const char *message);
543 /** Callback prototype */
544 typedef void (*DisplayUrlCb)(struct _LinphoneCore *lc, const char *message, const char *url);
545 /** Callback prototype */
546 typedef void (*LinphoneCoreCbFunc)(struct _LinphoneCore *lc,void * user_data);
547 /** Callback prototype */
548 typedef void (*NotifyReceivedCb)(struct _LinphoneCore *lc, LinphoneCall *call, const char *from, const char *event);
550 * Report status change for a friend previously \link linphone_core_add_friend() added \endlink to #LinphoneCore.
551 * @param lc #LinphoneCore object .
552 * @param lf Updated #LinphoneFriend .
554 typedef void (*NotifyPresenceReceivedCb)(struct _LinphoneCore *lc, LinphoneFriend * lf);
556 * Reports that a new subscription request has been received and wait for a decision.
557 * <br> Status on this subscription request is notified by \link linphone_friend_set_inc_subscribe_policy() changing policy \endlink for this friend
558 * @param lc #LinphoneCore object
559 * @param lf #LinphoneFriend corresponding to the subscriber
560 * @param url of the subscriber
563 typedef void (*NewSubscribtionRequestCb)(struct _LinphoneCore *lc, LinphoneFriend *lf, const char *url);
564 /** Callback prototype */
565 typedef void (*AuthInfoRequested)(struct _LinphoneCore *lc, const char *realm, const char *username);
566 /** Callback prototype */
567 typedef void (*CallLogUpdated)(struct _LinphoneCore *lc, struct _LinphoneCallLog *newcl);
571 * @param lc #LinphoneCore object
572 * @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.
573 * @param from #LinphoneAddress from
574 * @param message incoming message
576 typedef void (*TextMessageReceived)(LinphoneCore *lc, LinphoneChatRoom *room, const LinphoneAddress *from, const char *message);
577 /** Callback prototype */
578 typedef void (*DtmfReceived)(struct _LinphoneCore* lc, LinphoneCall *call, int dtmf);
579 /** Callback prototype */
580 typedef void (*ReferReceived)(struct _LinphoneCore *lc, const char *refer_to);
581 /** Callback prototype */
582 typedef void (*BuddyInfoUpdated)(struct _LinphoneCore *lc, LinphoneFriend *lf);
585 * This structure holds all callbacks that the application should implement.
588 typedef struct _LinphoneVTable{
589 LinphoneGlobalStateCb global_state_changed; /**<Notifies globlal state changes*/
590 LinphoneRegistrationStateCb registration_state_changed;/**<Notifies registration state changes*/
591 LinphoneCallStateCb call_state_changed;/**<Notifies call state changes*/
592 NotifyPresenceReceivedCb notify_presence_recv; /**< Notify received presence events*/
593 NewSubscribtionRequestCb new_subscription_request; /**< Notify about pending subscription request */
594 AuthInfoRequested auth_info_requested; /**< Ask the application some authentication information */
595 CallLogUpdated call_log_updated; /**< Notifies that call log list has been updated */
596 TextMessageReceived text_received; /**< A text message has been received */
597 DtmfReceived dtmf_received; /**< A dtmf has been received received */
598 ReferReceived refer_received; /**< An out of call refer was received */
599 BuddyInfoUpdated buddy_info_updated; /**< a LinphoneFriend's BuddyInfo has changed*/
600 NotifyReceivedCb notify_recv; /**< Other notifications*/
601 DisplayStatusCb display_status; /**< Callback that notifies various events with human readable text.*/
602 DisplayMessageCb display_message;/**< Callback to display a message to the user */
603 DisplayMessageCb display_warning;/** Callback to display a warning to the user */
604 DisplayUrlCb display_url;
605 ShowInterfaceCb show; /**< Notifies the application that it should show up*/
606 CallEncryptionChangedCb call_encryption_changed; /**<Notifies on change in the encryption of call streams */
607 } LinphoneCoreVTable;
613 typedef struct _LCCallbackObj
615 LinphoneCoreCbFunc _func;
621 typedef enum _LinphoneFirewallPolicy{
622 LinphonePolicyNoFirewall,
623 LinphonePolicyUseNatAddress,
624 LinphonePolicyUseStun
625 } LinphoneFirewallPolicy;
627 typedef enum _LinphoneWaitingState{
628 LinphoneWaitingStart,
629 LinphoneWaitingProgress,
630 LinphoneWaitingFinished
631 } LinphoneWaitingState;
632 typedef void * (*LinphoneWaitingCallback)(struct _LinphoneCore *lc, void *context, LinphoneWaitingState ws, const char *purpose, float progress);
637 void linphone_core_enable_logs(FILE *file);
638 void linphone_core_enable_logs_with_cb(OrtpLogFunc logfunc);
639 void linphone_core_disable_logs(void);
640 /*sets the user-agent string in sip messages, must be set before linphone_core_new() or linphone_core_init() */
641 void linphone_core_set_user_agent(const char *ua_name, const char *version);
642 const char *linphone_core_get_version(void);
644 LinphoneCore *linphone_core_new(const LinphoneCoreVTable *vtable,
645 const char *config_path, const char *factory_config, void* userdata);
647 /* function to be periodically called in a main loop */
648 void linphone_core_iterate(LinphoneCore *lc);
650 LinphoneAddress * linphone_core_interpret_url(LinphoneCore *lc, const char *url);
652 LinphoneCall * linphone_core_invite(LinphoneCore *lc, const char *url);
654 LinphoneCall * linphone_core_invite_address(LinphoneCore *lc, const LinphoneAddress *addr);
656 LinphoneCall * linphone_core_invite_with_params(LinphoneCore *lc, const char *url, const LinphoneCallParams *params);
658 LinphoneCall * linphone_core_invite_address_with_params(LinphoneCore *lc, const LinphoneAddress *addr, const LinphoneCallParams *params);
660 int linphone_core_transfer_call(LinphoneCore *lc, LinphoneCall *call, const char *refer_to);
662 int linphone_core_transfer_call_to_another(LinphoneCore *lc, LinphoneCall *call, LinphoneCall *dest);
664 bool_t linphone_core_inc_invite_pending(LinphoneCore*lc);
666 bool_t linphone_core_in_call(const LinphoneCore *lc);
668 LinphoneCall *linphone_core_get_current_call(const LinphoneCore *lc);
670 int linphone_core_accept_call(LinphoneCore *lc, LinphoneCall *call);
672 int linphone_core_terminate_call(LinphoneCore *lc, LinphoneCall *call);
674 int linphone_core_redirect_call(LinphoneCore *lc, LinphoneCall *call, const char *redirect_uri);
676 int linphone_core_terminate_all_calls(LinphoneCore *lc);
678 int linphone_core_pause_call(LinphoneCore *lc, LinphoneCall *call);
680 int linphone_core_pause_all_calls(LinphoneCore *lc);
682 int linphone_core_resume_call(LinphoneCore *lc, LinphoneCall *call);
684 int linphone_core_update_call(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
686 LinphoneCallParams *linphone_core_create_default_call_parameters(LinphoneCore *lc);
688 LinphoneCall *linphone_core_get_call_by_remote_address(LinphoneCore *lc, const char *remote_address);
690 void linphone_core_send_dtmf(LinphoneCore *lc,char dtmf);
692 int linphone_core_set_primary_contact(LinphoneCore *lc, const char *contact);
694 const char *linphone_core_get_primary_contact(LinphoneCore *lc);
696 const char * linphone_core_get_identity(LinphoneCore *lc);
698 void linphone_core_set_guess_hostname(LinphoneCore *lc, bool_t val);
699 bool_t linphone_core_get_guess_hostname(LinphoneCore *lc);
701 bool_t linphone_core_ipv6_enabled(LinphoneCore *lc);
702 void linphone_core_enable_ipv6(LinphoneCore *lc, bool_t val);
704 LinphoneAddress *linphone_core_get_primary_contact_parsed(LinphoneCore *lc);
705 const char * linphone_core_get_identity(LinphoneCore *lc);
706 /*0= no bandwidth limit*/
707 void linphone_core_set_download_bandwidth(LinphoneCore *lc, int bw);
708 void linphone_core_set_upload_bandwidth(LinphoneCore *lc, int bw);
710 int linphone_core_get_download_bandwidth(const LinphoneCore *lc);
711 int linphone_core_get_upload_bandwidth(const LinphoneCore *lc);
713 void linphone_core_enable_adaptive_rate_control(LinphoneCore *lc, bool_t enabled);
714 bool_t linphone_core_adaptive_rate_control_enabled(const LinphoneCore *lc);
716 * set audio packetization time linphone expect to receive from peer
717 * @ingroup media_parameters
720 void linphone_core_set_download_ptime(LinphoneCore *lc, int ptime);
722 * get audio packetization time linphone expect to receive from peer, 0 means unspecified
723 * @ingroup media_parameters
725 int linphone_core_get_download_ptime(LinphoneCore *lc);
727 void linphone_core_set_upload_ptime(LinphoneCore *lc, int ptime);
729 int linphone_core_get_upload_ptime(LinphoneCore *lc);
731 /* returns a MSList of PayloadType */
732 const MSList *linphone_core_get_audio_codecs(const LinphoneCore *lc);
734 int linphone_core_set_audio_codecs(LinphoneCore *lc, MSList *codecs);
735 /* returns a MSList of PayloadType */
736 const MSList *linphone_core_get_video_codecs(const LinphoneCore *lc);
738 int linphone_core_set_video_codecs(LinphoneCore *lc, MSList *codecs);
740 bool_t linphone_core_payload_type_enabled(LinphoneCore *lc, PayloadType *pt);
742 int linphone_core_enable_payload_type(LinphoneCore *lc, PayloadType *pt, bool_t enable);
744 PayloadType* linphone_core_find_payload_type(LinphoneCore* lc, const char* type, int rate) ;
746 const char *linphone_core_get_payload_type_description(LinphoneCore *lc, PayloadType *pt);
748 bool_t linphone_core_check_payload_type_usability(LinphoneCore *lc, PayloadType *pt);
750 int linphone_core_add_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
752 void linphone_core_clear_proxy_config(LinphoneCore *lc);
754 void linphone_core_remove_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
756 const MSList *linphone_core_get_proxy_config_list(const LinphoneCore *lc);
758 void linphone_core_set_default_proxy(LinphoneCore *lc, LinphoneProxyConfig *config);
760 void linphone_core_set_default_proxy_index(LinphoneCore *lc, int index);
762 int linphone_core_get_default_proxy(LinphoneCore *lc, LinphoneProxyConfig **config);
764 void linphone_core_add_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
766 void linphone_core_remove_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
768 const MSList *linphone_core_get_auth_info_list(const LinphoneCore *lc);
770 const LinphoneAuthInfo *linphone_core_find_auth_info(LinphoneCore *lc, const char *realm, const char *username);
772 void linphone_core_abort_authentication(LinphoneCore *lc, LinphoneAuthInfo *info);
774 void linphone_core_clear_all_auth_info(LinphoneCore *lc);
776 int linphone_core_get_audio_jittcomp(LinphoneCore *lc);
778 void linphone_core_set_audio_jittcomp(LinphoneCore *lc, int value);
780 int linphone_core_get_audio_port(const LinphoneCore *lc);
782 int linphone_core_get_video_port(const LinphoneCore *lc);
784 int linphone_core_get_nortp_timeout(const LinphoneCore *lc);
786 void linphone_core_set_audio_port(LinphoneCore *lc, int port);
788 void linphone_core_set_video_port(LinphoneCore *lc, int port);
790 void linphone_core_set_nortp_timeout(LinphoneCore *lc, int port);
792 void linphone_core_set_use_info_for_dtmf(LinphoneCore *lc, bool_t use_info);
794 bool_t linphone_core_get_use_info_for_dtmf(LinphoneCore *lc);
796 void linphone_core_set_use_rfc2833_for_dtmf(LinphoneCore *lc,bool_t use_rfc2833);
798 bool_t linphone_core_get_use_rfc2833_for_dtmf(LinphoneCore *lc);
800 void linphone_core_set_sip_port(LinphoneCore *lc, int port);
802 int linphone_core_get_sip_port(LinphoneCore *lc);
804 int linphone_core_set_sip_transports(LinphoneCore *lc, const LCSipTransports *transports);
806 int linphone_core_get_sip_transports(LinphoneCore *lc, LCSipTransports *transports);
809 * Give access to the UDP sip socket. Can be useful to configure this socket as persistent I.E kCFStreamNetworkServiceType set to kCFStreamNetworkServiceTypeVoIP)
810 * @param lc #LinphoneCore
811 * @return socket file descriptor
813 ortp_socket_t linphone_core_get_sip_socket(LinphoneCore *lc);
815 void linphone_core_set_inc_timeout(LinphoneCore *lc, int seconds);
817 int linphone_core_get_inc_timeout(LinphoneCore *lc);
819 void linphone_core_set_stun_server(LinphoneCore *lc, const char *server);
821 const char * linphone_core_get_stun_server(const LinphoneCore *lc);
823 void linphone_core_set_nat_address(LinphoneCore *lc, const char *addr);
825 const char *linphone_core_get_nat_address(const LinphoneCore *lc);
827 void linphone_core_set_firewall_policy(LinphoneCore *lc, LinphoneFirewallPolicy pol);
829 LinphoneFirewallPolicy linphone_core_get_firewall_policy(const LinphoneCore *lc);
831 const char * linphone_core_get_relay_addr(const LinphoneCore *lc);
833 int linphone_core_set_relay_addr(LinphoneCore *lc, const char *addr);
835 /* sound functions */
836 /* returns a null terminated static array of string describing the sound devices */
837 const char** linphone_core_get_sound_devices(LinphoneCore *lc);
838 bool_t linphone_core_sound_device_can_capture(LinphoneCore *lc, const char *device);
839 bool_t linphone_core_sound_device_can_playback(LinphoneCore *lc, const char *device);
840 int linphone_core_get_ring_level(LinphoneCore *lc);
841 int linphone_core_get_play_level(LinphoneCore *lc);
842 int linphone_core_get_rec_level(LinphoneCore *lc);
843 void linphone_core_set_ring_level(LinphoneCore *lc, int level);
844 void linphone_core_set_play_level(LinphoneCore *lc, int level);
846 void linphone_core_set_playback_gain_db(LinphoneCore *lc, float level);
848 float linphone_core_get_playback_gain_db(LinphoneCore *lc);
849 void linphone_core_set_rec_level(LinphoneCore *lc, int level);
850 const char * linphone_core_get_ringer_device(LinphoneCore *lc);
851 const char * linphone_core_get_playback_device(LinphoneCore *lc);
852 const char * linphone_core_get_capture_device(LinphoneCore *lc);
853 int linphone_core_set_ringer_device(LinphoneCore *lc, const char * devid);
854 int linphone_core_set_playback_device(LinphoneCore *lc, const char * devid);
855 int linphone_core_set_capture_device(LinphoneCore *lc, const char * devid);
856 char linphone_core_get_sound_source(LinphoneCore *lc);
857 void linphone_core_set_sound_source(LinphoneCore *lc, char source);
858 void linphone_core_set_ring(LinphoneCore *lc, const char *path);
859 const char *linphone_core_get_ring(const LinphoneCore *lc);
860 void linphone_core_set_ringback(LinphoneCore *lc, const char *path);
861 const char * linphone_core_get_ringback(const LinphoneCore *lc);
863 void linphone_core_set_remote_ringback_tone(LinphoneCore *lc,const char *);
864 const char *linphone_core_get_remote_ringback_tone(const LinphoneCore *lc);
866 int linphone_core_preview_ring(LinphoneCore *lc, const char *ring,LinphoneCoreCbFunc func,void * userdata);
867 void linphone_core_enable_echo_cancellation(LinphoneCore *lc, bool_t val);
868 bool_t linphone_core_echo_cancellation_enabled(LinphoneCore *lc);
870 void linphone_core_enable_echo_limiter(LinphoneCore *lc, bool_t val);
871 bool_t linphone_core_echo_limiter_enabled(const LinphoneCore *lc);
873 void linphone_core_enable_agc(LinphoneCore *lc, bool_t val);
874 bool_t linphone_core_agc_enabled(const LinphoneCore *lc);
876 void linphone_core_mute_mic(LinphoneCore *lc, bool_t muted);
880 * @ingroup media_parameters
882 bool_t linphone_core_is_mic_muted(LinphoneCore *lc);
884 bool_t linphone_core_is_audio_muted(LinphoneCore *lc);
885 bool_t linphone_core_is_rtp_muted(LinphoneCore *lc);
887 bool_t linphone_core_get_rtp_no_xmit_on_audio_mute(const LinphoneCore *lc);
888 void linphone_core_set_rtp_no_xmit_on_audio_mute(LinphoneCore *lc, bool_t val);
891 /* returns a list of LinphoneCallLog */
892 const MSList * linphone_core_get_call_logs(LinphoneCore *lc);
893 void linphone_core_clear_call_logs(LinphoneCore *lc);
896 void linphone_core_enable_video(LinphoneCore *lc, bool_t vcap_enabled, bool_t display_enabled);
897 bool_t linphone_core_video_enabled(LinphoneCore *lc);
899 typedef struct MSVideoSizeDef{
903 /* returns a zero terminated table of MSVideoSizeDef*/
904 const MSVideoSizeDef *linphone_core_get_supported_video_sizes(LinphoneCore *lc);
905 void linphone_core_set_preferred_video_size(LinphoneCore *lc, MSVideoSize vsize);
906 MSVideoSize linphone_core_get_preferred_video_size(LinphoneCore *lc);
907 void linphone_core_set_preferred_video_size_by_name(LinphoneCore *lc, const char *name);
909 void linphone_core_enable_video_preview(LinphoneCore *lc, bool_t val);
910 bool_t linphone_core_video_preview_enabled(const LinphoneCore *lc);
912 void linphone_core_enable_self_view(LinphoneCore *lc, bool_t val);
913 bool_t linphone_core_self_view_enabled(const LinphoneCore *lc);
916 /* returns a null terminated static array of string describing the webcams */
917 const char** linphone_core_get_video_devices(const LinphoneCore *lc);
918 int linphone_core_set_video_device(LinphoneCore *lc, const char *id);
919 const char *linphone_core_get_video_device(const LinphoneCore *lc);
921 /* Set static picture to be used when "Static picture" is the video device */
922 int linphone_core_set_static_picture(LinphoneCore *lc, const char *path);
924 /* Set and get frame rate for static picture */
925 int linphone_core_set_static_picture_fps(LinphoneCore *lc, float fps);
926 float linphone_core_get_static_picture_fps(LinphoneCore *lc);
928 /*function to be used for eventually setting window decorations (icons, title...)*/
929 unsigned long linphone_core_get_native_video_window_id(const LinphoneCore *lc);
930 void linphone_core_set_native_video_window_id(LinphoneCore *lc, unsigned long id);
932 unsigned long linphone_core_get_native_preview_window_id(const LinphoneCore *lc);
933 void linphone_core_set_native_preview_window_id(LinphoneCore *lc, unsigned long id);
935 void linphone_core_use_preview_window(LinphoneCore *lc, bool_t yesno);
937 /*play/record support: use files instead of soundcard*/
938 void linphone_core_use_files(LinphoneCore *lc, bool_t yesno);
939 void linphone_core_set_play_file(LinphoneCore *lc, const char *file);
940 void linphone_core_set_record_file(LinphoneCore *lc, const char *file);
942 void linphone_core_play_dtmf(LinphoneCore *lc, char dtmf, int duration_ms);
943 void linphone_core_stop_dtmf(LinphoneCore *lc);
945 int linphone_core_get_current_call_duration(const LinphoneCore *lc);
948 int linphone_core_get_mtu(const LinphoneCore *lc);
949 void linphone_core_set_mtu(LinphoneCore *lc, int mtu);
952 * @ingroup network_parameters
953 * This method is called by the application to notify the linphone core library when network is reachable.
954 * Calling this method with true trigger linphone to initiate a registration process for all proxy
955 * configuration with parameter register set to enable.
956 * This method disable the automatic registration mode. It means you must call this method after each network state changes
959 void linphone_core_set_network_reachable(LinphoneCore* lc,bool_t value);
961 * @ingroup network_parameters
962 * return network state either as positioned by the application or by linphone
964 bool_t linphone_core_is_network_reachabled(LinphoneCore* lc);
967 * @ingroup network_parameters
968 * enable signaling keep alive. small udp packet sent periodically to keep udp NAT association
970 void linphone_core_enable_keep_alive(LinphoneCore* lc,bool_t enable);
972 * @ingroup network_parameters
973 * Is signaling keep alive
975 bool_t linphone_core_keep_alive_enabled(LinphoneCore* lc);
977 void *linphone_core_get_user_data(LinphoneCore *lc);
979 /* returns LpConfig object to read/write to the config file: usefull if you wish to extend
980 the config file with your own sections */
981 struct _LpConfig *linphone_core_get_config(LinphoneCore *lc);
983 /* attempts to wake up another linphone engine already running.
984 The "show" callback is called for the other linphone, causing gui to show up.
985 call_addr is an optional sip-uri to call immediately after waking up.
986 The method returns 0 if an already running linphone was found*/
988 int linphone_core_wake_up_possible_already_running_instance(
989 const char * config_file, const char * call_addr);
991 /*set a callback for some blocking operations, it takes you informed of the progress of the operation*/
992 void linphone_core_set_waiting_callback(LinphoneCore *lc, LinphoneWaitingCallback cb, void *user_context);
994 /*returns the list of registered SipSetup (linphonecore plugins) */
995 const MSList * linphone_core_get_sip_setups(LinphoneCore *lc);
997 void linphone_core_destroy(LinphoneCore *lc);
999 /*for advanced users:*/
1000 void linphone_core_set_audio_transports(LinphoneCore *lc, RtpTransport *rtp, RtpTransport *rtcp);
1001 void linphone_core_set_video_transports(LinphoneCore *lc, RtpTransport *rtp, RtpTransport *rtcp);
1004 int linphone_core_get_current_call_stats(LinphoneCore *lc, rtp_stats_t *local, rtp_stats_t *remote);
1006 const MSList *linphone_core_get_calls(LinphoneCore *lc);
1008 LinphoneGlobalState linphone_core_get_global_state(const LinphoneCore *lc);
1010 * force registration refresh to be initiated upon next iterate
1013 void linphone_core_refresh_registers(LinphoneCore* lc);
1016 void linphone_call_send_vfu_request(LinphoneCall *call);
1018 /* Path to the file storing secrets cache */
1019 void linphone_core_set_zrtp_secrets_file(LinphoneCore *lc, const char* file);
1021 bool_t linphone_call_are_all_streams_encrypted(LinphoneCall *call);
1022 const char* linphone_call_get_authentication_token(LinphoneCall *call);
1023 bool_t linphone_call_get_authentication_token_verified(LinphoneCall *call);