sjero.net Git - linphone/blob - 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 containing 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         float quality;
 156     int video_enabled;
 157         struct _LinphoneCore *lc;
 158         time_t start_date_time; /**Start date of the call in seconds as expressed in a time_t */
 159         const char* call_id; /**unique id of a call*/
 160 } LinphoneCallLog;
 161
 162
 163 /**
 164  * Enum describing type of media encryption types.
 165 **/
 166 enum LinphoneMediaEncryption {
 167         LinphoneMediaEncryptionNone,
 168         LinphoneMediaEncryptionSRTP,
 169         LinphoneMediaEncryptionZRTP
 170 };
 171
 172 /**
 173  * Enum describing type of media encryption types.
 174 **/
 175 typedef enum LinphoneMediaEncryption LinphoneMediaEncryption;
 176
 177 /*public: */
 178 void linphone_call_log_set_user_pointer(LinphoneCallLog *cl, void *up);
 179 void *linphone_call_log_get_user_pointer(const LinphoneCallLog *cl);
 180 void linphone_call_log_set_ref_key(LinphoneCallLog *cl, const char *refkey);
 181 const char *linphone_call_log_get_ref_key(const LinphoneCallLog *cl);
 182 const rtp_stats_t *linphone_call_log_get_local_stats(const LinphoneCallLog *cl);
 183 const rtp_stats_t *linphone_call_log_get_remote_stats(const LinphoneCallLog *cl);
 184 char * linphone_call_log_to_str(LinphoneCallLog *cl);
 185
 186 struct _LinphoneCallParams;
 187
 188 /**
 189  * The LinphoneCallParams is an object containing various call related parameters.
 190  * It can be used to retrieve parameters from a currently running call or modify the call's characteristics
 191  * dynamically.
 192 **/
 193 typedef struct _LinphoneCallParams LinphoneCallParams;
 194
 195 const PayloadType* linphone_call_params_get_used_audio_codec(const LinphoneCallParams *cp);
 196 const PayloadType* linphone_call_params_get_used_video_codec(const LinphoneCallParams *cp);
 197 LinphoneCallParams * linphone_call_params_copy(const LinphoneCallParams *cp);
 198 void linphone_call_params_enable_video(LinphoneCallParams *cp, bool_t enabled);
 199 bool_t linphone_call_params_video_enabled(const LinphoneCallParams *cp);
 200 LinphoneMediaEncryption linphone_call_params_get_media_encryption(const LinphoneCallParams *cp);
 201 void linphone_call_params_set_media_encryption(LinphoneCallParams *cp, LinphoneMediaEncryption e);
 202 void linphone_call_params_enable_early_media_sending(LinphoneCallParams *cp, bool_t enabled);
 203 bool_t linphone_call_params_early_media_sending_enabled(const LinphoneCallParams *cp);
 204 bool_t linphone_call_params_local_conference_mode(const LinphoneCallParams *cp);
 205 void linphone_call_params_set_audio_bandwidth_limit(LinphoneCallParams *cp, int bw);
 206 void linphone_call_params_destroy(LinphoneCallParams *cp);
 207 /**
 208  * @ingroup call_control
 209  * Use to know if this call has been configured in low bandwidth mode.
 210  * This mode can be automatically discovered thanks to a stun server when activate_edge_workarounds=1 in section [net] of configuration file
 211  * <br> When enabled, this param may transform a call request with video in audio only mode.
 212  * @return TRUE if low bandwidth has been configured/detected
 213  */
 214 bool_t linphone_call_params_low_bandwidth_enabled(const LinphoneCallParams *cp);
 215 /**
 216  * Enum describing failure reasons.
 217  * @ingroup initializing
 218 **/
 219 enum _LinphoneReason{
 220         LinphoneReasonNone,
 221         LinphoneReasonNoResponse, /**<No response received from remote*/
 222         LinphoneReasonBadCredentials, /**<Authentication failed due to bad or missing credentials*/
 223         LinphoneReasonDeclined, /**<The call has been declined*/
 224         LinphoneReasonNotFound, /**<Destination of the calls was not found.*/
 225         LinphoneReasonNotAnswered
 226 };
 227
 228 /**
 229  * Enum describing failure reasons.
 230  * @ingroup initializing
 231 **/
 232 typedef enum _LinphoneReason LinphoneReason;
 233
 234 const char *linphone_reason_to_string(LinphoneReason err);
 235
 236 /**
 237  * Structure describing policy regarding video streams establishments.
 238  * @ingroup media_parameters
 239 **/
 240 struct _LinphoneVideoPolicy{
 241         bool_t automatically_initiate; /**<Whether video shall be automatically proposed for outgoing calls.*/
 242         bool_t automatically_accept; /**<Whether video shall be automatically accepted for incoming calls*/
 243         bool_t unused[2];
 244 };
 245
 246 /**
 247  * Structure describing policy regarding video streams establishments.
 248  * @ingroup media_parameters
 249 **/
 250 typedef struct _LinphoneVideoPolicy LinphoneVideoPolicy;
 251
 252 /**
 253  * The LinphoneCall object represents a call issued or received by the LinphoneCore
 254  * @ingroup call_control
 255 **/
 256 struct _LinphoneCall;
 257 /**
 258  * The LinphoneCall object represents a call issued or received by the LinphoneCore
 259  * @ingroup call_control
 260 **/
 261 typedef struct _LinphoneCall LinphoneCall;
 262
 263
 264 /**
 265  * @addtogroup call_misc
 266  * @{
 267 **/
 268
 269 #define LINPHONE_CALL_STATS_AUDIO 0
 270 #define LINPHONE_CALL_STATS_VIDEO 1
 271
 272 /**
 273  * Enum describing ICE states.
 274  * @ingroup initializing
 275 **/
 276 enum _LinphoneIceState{
 277         LinphoneIceStateNotActivated, /**< ICE has not been activated for this call */
 278         LinphoneIceStateFailed, /**< ICE processing has failed */
 279         LinphoneIceStateInProgress, /**< ICE process is in progress */
 280         LinphoneIceStateHostConnection, /**< ICE has established a direct connection to the remote host */
 281         LinphoneIceStateReflexiveConnection, /**< ICE has established a connection to the remote host through one or several NATs */
 282         LinphoneIceStateRelayConnection /**< ICE has established a connection through a relay */
 283 };
 284
 285 /**
 286  * Enum describing Ice states.
 287  * @ingroup initializing
 288 **/
 289 typedef enum _LinphoneIceState LinphoneIceState;
 290
 291 /**
 292  * The LinphoneCallStats objects carries various statistic informations regarding quality of audio or video streams.
 293  *
 294  * To receive these informations periodically and as soon as they are computed, the application is invited to place a #CallStatsUpdated callback in the LinphoneCoreVTable structure
 295  * it passes for instanciating the LinphoneCore object (see linphone_core_new() ).
 296  *
 297  * At any time, the application can access last computed statistics using linphone_call_get_audio_stats() or linphone_call_get_video_stats().
 298 **/
 299 typedef struct _LinphoneCallStats LinphoneCallStats;
 300
 301 /**
 302  * The LinphoneCallStats objects carries various statistic informations regarding quality of audio or video streams.
 303  *
 304  * To receive these informations periodically and as soon as they are computed, the application is invited to place a #CallStatsUpdated callback in the LinphoneCoreVTable structure
 305  * it passes for instanciating the LinphoneCore object (see linphone_core_new() ).
 306  *
 307  * At any time, the application can access last computed statistics using linphone_call_get_audio_stats() or linphone_call_get_video_stats().
 308 **/
 309 struct _LinphoneCallStats {
 310         int             type; /**< Can be either LINPHONE_CALL_STATS_AUDIO or LINPHONE_CALL_STATS_VIDEO*/
 311         jitter_stats_t  jitter_stats; /**<jitter buffer statistics, see oRTP documentation for details */
 312         mblk_t*         received_rtcp; /**<Last RTCP packet received, as a mblk_t structure. See oRTP documentation for details how to extract information from it*/
 313         mblk_t*         sent_rtcp;/**<Last RTCP packet sent, as a mblk_t structure. See oRTP documentation for details how to extract information from it*/
 314         float           round_trip_delay; /**<Round trip propagation time in seconds if known, -1 if unknown.*/
 315         LinphoneIceState        ice_state; /**< State of ICE processing. */
 316         float download_bandwidth; /**<Download bandwidth measurement of received stream, expressed in kbit/s, including IP/UDP/RTP headers*/
 317         float upload_bandwidth; /**<Download bandwidth measurement of sent stream, expressed in kbit/s, including IP/UDP/RTP headers*/
 318 };
 319
 320 /**
 321  * @}
 322 **/
 323
 324 const LinphoneCallStats *linphone_call_get_audio_stats(const LinphoneCall *call);
 325 const LinphoneCallStats *linphone_call_get_video_stats(const LinphoneCall *call);
 326
 327
 328 /** Callback prototype */
 329 typedef void (*LinphoneCallCbFunc)(struct _LinphoneCall *call,void * user_data);
 330
 331 /**
 332  * LinphoneCallState enum represents the different state a call can reach into.
 333  * The application is notified of state changes through the LinphoneCoreVTable::call_state_changed callback.
 334  * @ingroup call_control
 335 **/
 336 typedef enum _LinphoneCallState{
 337         LinphoneCallIdle,                                       /**<Initial call state */
 338         LinphoneCallIncomingReceived, /**<This is a new incoming call */
 339         LinphoneCallOutgoingInit, /**<An outgoing call is started */
 340         LinphoneCallOutgoingProgress, /**<An outgoing call is in progress */
 341         LinphoneCallOutgoingRinging, /**<An outgoing call is ringing at remote end */
 342         LinphoneCallOutgoingEarlyMedia, /**<An outgoing call is proposed early media */
 343         LinphoneCallConnected, /**<Connected, the call is answered */
 344         LinphoneCallStreamsRunning, /**<The media streams are established and running*/
 345         LinphoneCallPausing, /**<The call is pausing at the initiative of local end */
 346         LinphoneCallPaused, /**< The call is paused, remote end has accepted the pause */
 347         LinphoneCallResuming, /**<The call is being resumed by local end*/
 348         LinphoneCallRefered, /**<The call is being transfered to another party, resulting in a new outgoing call to follow immediately*/
 349         LinphoneCallError, /**<The call encountered an error*/
 350         LinphoneCallEnd, /**<The call ended normally*/
 351         LinphoneCallPausedByRemote, /**<The call is paused by remote end*/
 352         LinphoneCallUpdatedByRemote, /**<The call's parameters change is requested by remote end, used for example when video is added by remote */
 353         LinphoneCallIncomingEarlyMedia, /**<We are proposing early media to an incoming call */
 354         LinphoneCallUpdating, /**<A call update has been initiated by us */
 355         LinphoneCallReleased /**< The call object is no more retained by the core */
 356 } LinphoneCallState;
 357
 358 const char *linphone_call_state_to_string(LinphoneCallState cs);
 359
 360 LinphoneCore *linphone_call_get_core(const LinphoneCall *call);
 361 LinphoneCallState linphone_call_get_state(const LinphoneCall *call);
 362 bool_t linphone_call_asked_to_autoanswer(LinphoneCall *call);
 363 const LinphoneAddress * linphone_core_get_current_call_remote_address(struct _LinphoneCore *lc);
 364 const LinphoneAddress * linphone_call_get_remote_address(const LinphoneCall *call);
 365 char *linphone_call_get_remote_address_as_string(const LinphoneCall *call);
 366 LinphoneCallDir linphone_call_get_dir(const LinphoneCall *call);
 367 LinphoneCall * linphone_call_ref(LinphoneCall *call);
 368 void linphone_call_unref(LinphoneCall *call);
 369 LinphoneCallLog *linphone_call_get_call_log(const LinphoneCall *call);
 370 const char *linphone_call_get_refer_to(const LinphoneCall *call);
 371 bool_t linphone_call_has_transfer_pending(const LinphoneCall *call);
 372 LinphoneCall *linphone_call_get_replaced_call(LinphoneCall *call);
 373 int linphone_call_get_duration(const LinphoneCall *call);
 374 const LinphoneCallParams * linphone_call_get_current_params(const LinphoneCall *call);
 375 const LinphoneCallParams * linphone_call_get_remote_params(LinphoneCall *call);
 376 void linphone_call_enable_camera(LinphoneCall *lc, bool_t enabled);
 377 bool_t linphone_call_camera_enabled(const LinphoneCall *lc);
 378 int linphone_call_take_video_snapshot(LinphoneCall *call, const char *file);
 379 LinphoneReason linphone_call_get_reason(const LinphoneCall *call);
 380 const char *linphone_call_get_remote_user_agent(LinphoneCall *call);
 381 float linphone_call_get_play_volume(LinphoneCall *call);
 382 float linphone_call_get_record_volume(LinphoneCall *call);
 383 float linphone_call_get_current_quality(LinphoneCall *call);
 384 float linphone_call_get_average_quality(LinphoneCall *call);
 385 const char* linphone_call_get_authentication_token(LinphoneCall *call);
 386 bool_t linphone_call_get_authentication_token_verified(LinphoneCall *call);
 387 void linphone_call_set_authentication_token_verified(LinphoneCall *call, bool_t verified);
 388 void linphone_call_send_vfu_request(LinphoneCall *call);
 389 void *linphone_call_get_user_pointer(LinphoneCall *call);
 390 void linphone_call_set_user_pointer(LinphoneCall *call, void *user_pointer);
 391 void linphone_call_set_next_video_frame_decoded_callback(LinphoneCall *call, LinphoneCallCbFunc cb, void* user_data);
 392 LinphoneCallState linphone_call_get_transfer_state(LinphoneCall *call);
 393 void linphone_call_zoom_video(LinphoneCall* call, float zoom_factor, float* cx, float* cy);
 394 /**
 395  * Return TRUE if this call is currently part of a conference
 396  *@param call #LinphoneCall
 397  *@return TRUE if part of a conference.
 398  *
 399  @ingroup call_control
 400  */
 401 bool_t linphone_call_is_in_conference(const LinphoneCall *call);
 402 /**
 403  * Enables or disable echo cancellation for this call
 404  * @param call
 405  * @param val
 406  *
 407  * @ingroup media_parameters
 408 **/
 409 void linphone_call_enable_echo_cancellation(LinphoneCall *call, bool_t val) ;
 410 /**
 411  * Returns TRUE if echo cancellation is enabled.
 412  *
 413  * @ingroup media_parameters
 414 **/
 415 bool_t linphone_call_echo_cancellation_enabled(LinphoneCall *lc);
 416 /**
 417  * Enables or disable echo limiter for this call
 418  * @param call
 419  * @param val
 420  *
 421  * @ingroup media_parameters
 422 **/
 423 void linphone_call_enable_echo_limiter(LinphoneCall *call, bool_t val);
 424 /**
 425  * Returns TRUE if echo limiter is enabled.
 426  *
 427  * @ingroup media_parameters
 428 **/
 429 bool_t linphone_call_echo_limiter_enabled(const LinphoneCall *call);
 430
 431 /*keep this in sync with mediastreamer2/msvolume.h*/
 432
 433 /**
 434  * Lowest volume measurement that can be returned by linphone_call_get_play_volume() or linphone_call_get_record_volume(), corresponding to pure silence.
 435  * @ingroup call_misc
 436 **/
 437 #define LINPHONE_VOLUME_DB_LOWEST (-120)
 438
 439 /**
 440  * @addtogroup proxies
 441  * @{
 442 **/
 443 /**
 444  * The LinphoneProxyConfig object represents a proxy configuration to be used
 445  * by the LinphoneCore object.
 446  * Its fields must not be used directly in favour of the accessors methods.
 447  * Once created and filled properly the LinphoneProxyConfig can be given to
 448  * LinphoneCore with linphone_core_add_proxy_config().
 449  * This will automatically triggers the registration, if enabled.
 450  *
 451  * The proxy configuration are persistent to restarts because they are saved
 452  * in the configuration file. As a consequence, after linphone_core_new() there
 453  * might already be a list of configured proxy that can be examined with
 454  * linphone_core_get_proxy_config_list().
 455  *
 456  * The default proxy (see linphone_core_set_default_proxy() ) is the one of the list
 457  * that is used by default for calls.
 458 **/
 459 typedef struct _LinphoneProxyConfig LinphoneProxyConfig;
 460
 461 /**
 462  * LinphoneRegistrationState describes proxy registration states.
 463 **/
 464 typedef enum _LinphoneRegistrationState{
 465         LinphoneRegistrationNone, /**<Initial state for registrations */
 466         LinphoneRegistrationProgress, /**<Registration is in progress */
 467         LinphoneRegistrationOk, /**< Registration is successful */
 468         LinphoneRegistrationCleared, /**< Unregistration succeeded */
 469         LinphoneRegistrationFailed      /**<Registration failed */
 470 }LinphoneRegistrationState;
 471
 472 /**
 473  * Human readable version of the #LinphoneRegistrationState
 474  * @param cs sate
 475  */
 476 const char *linphone_registration_state_to_string(LinphoneRegistrationState cs);
 477
 478 LinphoneProxyConfig *linphone_proxy_config_new(void);
 479 int linphone_proxy_config_set_server_addr(LinphoneProxyConfig *obj, const char *server_addr);
 480 int linphone_proxy_config_set_identity(LinphoneProxyConfig *obj, const char *identity);
 481 int linphone_proxy_config_set_route(LinphoneProxyConfig *obj, const char *route);
 482 void linphone_proxy_config_expires(LinphoneProxyConfig *obj, int expires);
 483 /**
 484  * Indicates  either or not, REGISTRATION must be issued for this #LinphoneProxyConfig .
 485  * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
 486  * @param obj object pointer
 487  * @param val if true, registration will be engaged
 488  */
 489 void linphone_proxy_config_enable_register(LinphoneProxyConfig *obj, bool_t val);
 490 #define linphone_proxy_config_enableregister linphone_proxy_config_enable_register
 491 void linphone_proxy_config_edit(LinphoneProxyConfig *obj);
 492 int linphone_proxy_config_done(LinphoneProxyConfig *obj);
 493 /**
 494  * Indicates  either or not, PUBLISH must be issued for this #LinphoneProxyConfig .
 495  * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
 496  * @param obj object pointer
 497  * @param val if true, publish will be engaged
 498  *
 499  */
 500 void linphone_proxy_config_enable_publish(LinphoneProxyConfig *obj, bool_t val);
 501 void linphone_proxy_config_set_dial_escape_plus(LinphoneProxyConfig *cfg, bool_t val);
 502 void linphone_proxy_config_set_dial_prefix(LinphoneProxyConfig *cfg, const char *prefix);
 503
 504 LinphoneRegistrationState linphone_proxy_config_get_state(const LinphoneProxyConfig *obj);
 505 bool_t linphone_proxy_config_is_registered(const LinphoneProxyConfig *obj);
 506 const char *linphone_proxy_config_get_domain(const LinphoneProxyConfig *cfg);
 507
 508 const char *linphone_proxy_config_get_route(const LinphoneProxyConfig *obj);
 509 const char *linphone_proxy_config_get_identity(const LinphoneProxyConfig *obj);
 510 bool_t linphone_proxy_config_publish_enabled(const LinphoneProxyConfig *obj);
 511 const char *linphone_proxy_config_get_addr(const LinphoneProxyConfig *obj);
 512 int linphone_proxy_config_get_expires(const LinphoneProxyConfig *obj);
 513 bool_t linphone_proxy_config_register_enabled(const LinphoneProxyConfig *obj);
 514 void linphone_proxy_config_refresh_register(LinphoneProxyConfig *obj);
 515 const char *linphone_proxy_config_get_contact_parameters(const LinphoneProxyConfig *obj);
 516 void linphone_proxy_config_set_contact_parameters(LinphoneProxyConfig *obj, const char *contact_params);
 517 struct _LinphoneCore * linphone_proxy_config_get_core(const LinphoneProxyConfig *obj);
 518
 519 bool_t linphone_proxy_config_get_dial_escape_plus(const LinphoneProxyConfig *cfg);
 520 const char * linphone_proxy_config_get_dial_prefix(const LinphoneProxyConfig *cfg);
 521
 522 LinphoneReason linphone_proxy_config_get_error(const LinphoneProxyConfig *cfg);
 523
 524 /* destruction is called automatically when removing the proxy config */
 525 void linphone_proxy_config_destroy(LinphoneProxyConfig *cfg);
 526 void linphone_proxy_config_set_sip_setup(LinphoneProxyConfig *cfg, const char *type);
 527 SipSetupContext *linphone_proxy_config_get_sip_setup_context(LinphoneProxyConfig *cfg);
 528 SipSetup *linphone_proxy_config_get_sip_setup(LinphoneProxyConfig *cfg);
 529 /**
 530  * normalize a human readable phone number into a basic string. 888-444-222 becomes 888444222
 531  */
 532 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *proxy, const char *username, char *result, size_t result_len);
 533 /*
 534  *  attached a user data to a proxy config
 535  */
 536 void linphone_proxy_config_set_user_data(LinphoneProxyConfig *cr, void * ud);
 537 /*
 538  *  get user data to a proxy config. return null if any
 539  */
 540 void * linphone_proxy_config_get_user_data(LinphoneProxyConfig *cr);
 541
 542 /**
 543  * @}
 544 **/
 545
 546 typedef struct _LinphoneAccountCreator{
 547         struct _LinphoneCore *lc;
 548         struct _SipSetupContext *ssctx;
 549         char *username;
 550         char *password;
 551         char *domain;
 552         char *route;
 553         char *email;
 554         int suscribe;
 555         bool_t succeeded;
 556 }LinphoneAccountCreator;
 557
 558 LinphoneAccountCreator *linphone_account_creator_new(struct _LinphoneCore *core, const char *type);
 559 void linphone_account_creator_set_username(LinphoneAccountCreator *obj, const char *username);
 560 void linphone_account_creator_set_password(LinphoneAccountCreator *obj, const char *password);
 561 void linphone_account_creator_set_domain(LinphoneAccountCreator *obj, const char *domain);
 562 void linphone_account_creator_set_route(LinphoneAccountCreator *obj, const char *route);
 563 void linphone_account_creator_set_email(LinphoneAccountCreator *obj, const char *email);
 564 void linphone_account_creator_set_suscribe(LinphoneAccountCreator *obj, int suscribre);
 565 const char * linphone_account_creator_get_username(LinphoneAccountCreator *obj);
 566 const char * linphone_account_creator_get_domain(LinphoneAccountCreator *obj);
 567 int linphone_account_creator_test_existence(LinphoneAccountCreator *obj);
 568 int linphone_account_creator_test_validation(LinphoneAccountCreator *obj);
 569 LinphoneProxyConfig * linphone_account_creator_validate(LinphoneAccountCreator *obj);
 570 void linphone_account_creator_destroy(LinphoneAccountCreator *obj);
 571
 572 struct _LinphoneAuthInfo;
 573
 574 /**
 575  * @ingroup authentication
 576  * Object holding authentication information.
 577  *
 578  * @note The object's fields should not be accessed directly. Prefer using
 579  * the accessor methods.
 580  *
 581  * In most case, authentication information consists of a username and password.
 582  * Sometimes, a userid is required by proxy, and realm can be useful to discriminate
 583  * different SIP domains.
 584  *
 585  * Once created and filled, a LinphoneAuthInfo must be added to the LinphoneCore in
 586  * order to become known and used automatically when needed.
 587  * Use linphone_core_add_auth_info() for that purpose.
 588  *
 589  * The LinphoneCore object can take the initiative to request authentication information
 590  * when needed to the application through the auth_info_requested callback of the
 591  * LinphoneCoreVTable structure.
 592  *
 593  * The application can respond to this information request later using
 594  * linphone_core_add_auth_info(). This will unblock all pending authentication
 595  * transactions and retry them with authentication headers.
 596  *
 597 **/
 598 typedef struct _LinphoneAuthInfo LinphoneAuthInfo;
 599
 600 LinphoneAuthInfo *linphone_auth_info_new(const char *username, const char *userid,
 601                 const char *passwd, const char *ha1,const char *realm);
 602 void linphone_auth_info_set_passwd(LinphoneAuthInfo *info, const char *passwd);
 603 void linphone_auth_info_set_username(LinphoneAuthInfo *info, const char *username);
 604 void linphone_auth_info_set_userid(LinphoneAuthInfo *info, const char *userid);
 605
 606 const char *linphone_auth_info_get_username(const LinphoneAuthInfo *i);
 607 const char *linphone_auth_info_get_passwd(const LinphoneAuthInfo *i);
 608 const char *linphone_auth_info_get_userid(const LinphoneAuthInfo *i);
 609
 610 /* you don't need those function*/
 611 void linphone_auth_info_destroy(LinphoneAuthInfo *info);
 612 LinphoneAuthInfo * linphone_auth_info_new_from_config_file(struct _LpConfig *config, int pos);
 613
 614
 615 struct _LinphoneChatRoom;
 616 /**
 617  * @addtogroup chatroom
 618  * @{
 619  */
 620
 621 /**
 622  * A chat room message to old content to be sent.
 623  * <br> Can be created by linphone_chat_room_create_message().
 624  */
 625 typedef struct _LinphoneChatMessage LinphoneChatMessage;
 626
 627 /**
 628  * A chat room is the place where text messages are exchanged.
 629  * <br> Can be created by linphone_core_create_chat_room().
 630  */
 631 typedef struct _LinphoneChatRoom LinphoneChatRoom;
 632
 633 /**
 634  * Create a new chat room for messaging from a sip uri like sip:joe@sip.linphone.org
 635  * @param lc #LinphoneCore object
 636  * @param to destination address for messages
 637  * @return #LinphoneChatRoom where messaging can take place.
 638  */
 639 LinphoneChatRoom * linphone_core_create_chat_room(LinphoneCore *lc, const char *to);
 640 /**
 641  * Destructor
 642  * @param cr #LinphoneChatRoom object
 643  */
 644 void linphone_chat_room_destroy(LinphoneChatRoom *cr);
 645
 646 /**
 647  * create a message attached to a dedicated chat room;
 648  */
 649 LinphoneChatMessage* linphone_chat_room_create_message(const LinphoneChatRoom *cr,const char* message);
 650
 651
 652 /**
 653  * get peer address \link linphone_core_create_chat_room() associated to \endlink this #LinphoneChatRoom
 654  * @param cr #LinphoneChatRoom object
 655  * @return #LinphoneAddress peer address
 656  */
 657 const LinphoneAddress* linphone_chat_room_get_peer_address(LinphoneChatRoom *cr);
 658 /**
 659  * send a message to peer member of this chat room.
 660  * @param cr #LinphoneChatRoom object
 661  * @param msg message to be sent
 662  */
 663 void linphone_chat_room_send_message(LinphoneChatRoom *cr, const char *msg);
 664 /**
 665  *LinphoneChatMessageStatus used to notify if message has been succesfully delivered or not
 666  */
 667 typedef enum _LinphoneChatMessageStates {
 668         LinphoneChatMessageStateIdle, /** initial state*/
 669         LinphoneChatMessageStateInProgress, /*delivery in progress**/
 670         LinphoneChatMessageStateDelivered, /** message succesffully delivered an acknoleged by remote end point*/
 671         LinphoneChatMessageStateNotDelivered /** message was not delivered*/
 672 }LinphoneChatMessageState;
 673
 674
 675 /**
 676  * to string function
 677  */
 678 const char* linphone_chat_message_state_to_string(const LinphoneChatMessageState state);
 679
 680 /**
 681  * clone a chat message
 682  *@param message #LinphoneChatMessage obj
 683  *@return #LinphoneChatMessage
 684  */
 685 LinphoneChatMessage* linphone_chat_message_clone(const LinphoneChatMessage* message);
 686 /**
 687  * set origine of the message
 688  *@param message #LinphoneChatMessage obj
 689  *@param from #LinphoneAddress origin of this message (copied)
 690  */
 691 void linphone_chat_message_set_from(LinphoneChatMessage* message, const LinphoneAddress* from);
 692
 693 /**
 694  * get origine of the message
 695  *@param message #LinphoneChatMessage obj
 696  *@return #LinphoneAddress
 697  */
 698 LinphoneAddress* linphone_chat_message_get_from(const LinphoneChatMessage* message);
 699
 700 /**
 701  * Linphone message can carry external body as defined by rfc2017
 702  * @param message #LinphoneChatMessage
 703  * @return return external body url null if not present.
 704  */
 705 const char* linphone_chat_message_get_external_body_url(const LinphoneChatMessage* message);
 706
 707 /**
 708  * Linphone message can carry external body as defined by rfc2017
 709  *
 710  * @param  #LinphoneChatMessage
 711  * @param url ex: access-type=URL; URL="http://www.foo.com/file"
 712  */
 713 void linphone_chat_message_set_external_body_url(LinphoneChatMessage* message,const char* url);
 714
 715 /**
 716  * get text part of this message
 717  *@return text or NULL if no text.
 718  */
 719 const char * linphone_chat_message_get_text(const LinphoneChatMessage* message);
 720 /**
 721  * user pointer get function
 722  */
 723
 724 void* linphone_chat_message_get_user_data(const LinphoneChatMessage* message);
 725 /**
 726  * user pointer set function
 727  */
 728 void linphone_chat_message_set_user_data(LinphoneChatMessage* message,void*);
 729
 730 /**
 731  * Call back used to notify message delivery status
 732  *@param msg #LinphoneChatMessage object
 733  *@param status #LinphoneChatMessageStatus
 734  *@param ud us user data
 735  */
 736 typedef void (*LinphoneChatMessageStateChangeCb)(LinphoneChatMessage* msg,LinphoneChatMessageState state,void* ud);
 737 /**
 738  * send a message to peer member of this chat room.
 739  * @param cr #LinphoneChatRoom object
 740  * @param msg #LinphoneChatMessage message to be sent
 741  * @param status_cb #LinphoneChatMessageStatus status call back invoked when to message is delivered or not. May be NULL
 742  * @param ud user data for the status cb.
 743  */
 744 void linphone_chat_room_send_message2(LinphoneChatRoom *cr, LinphoneChatMessage* msg,LinphoneChatMessageStateChangeCb status_cb,void* ud);
 745 LinphoneCore* linphone_chat_room_get_lc(LinphoneChatRoom *cr);
 746 LinphoneChatRoom* linphone_chat_message_get_chat_room(LinphoneChatMessage *msg);
 747 char* linphone_chat_message_get_message(LinphoneChatMessage *msg);
 748 const LinphoneAddress* linphone_chat_message_get_peer_address(LinphoneChatMessage *msg);
 749 void linphone_chat_room_set_user_data(LinphoneChatRoom *cr, void * ud);
 750 void * linphone_chat_room_get_user_data(LinphoneChatRoom *cr);
 751
 752 /**
 753  * @}
 754  */
 755
 756
 757 /**
 758  * @addtogroup initializing
 759  * @{
 760 **/
 761
 762 /**
 763  * LinphoneGlobalState describes the global state of the LinphoneCore object.
 764  * It is notified via the LinphoneCoreVTable::global_state_changed
 765 **/
 766 typedef enum _LinphoneGlobalState{
 767         LinphoneGlobalOff,
 768         LinphoneGlobalStartup,
 769         LinphoneGlobalOn,
 770         LinphoneGlobalShutdown
 771 }LinphoneGlobalState;
 772
 773 const char *linphone_global_state_to_string(LinphoneGlobalState gs);
 774
 775
 776 /**Call state notification callback prototype*/
 777 typedef void (*LinphoneGlobalStateCb)(struct _LinphoneCore *lc, LinphoneGlobalState gstate, const char *message);
 778 /**Call state notification callback prototype*/
 779 typedef void (*LinphoneCallStateCb)(struct _LinphoneCore *lc, LinphoneCall *call, LinphoneCallState cstate, const char *message);
 780 /**Call encryption changed callback prototype*/
 781 typedef void (*CallEncryptionChangedCb)(struct _LinphoneCore *lc, LinphoneCall *call, bool_t on, const char *authentication_token);
 782
 783 /** @ingroup Proxies
 784  * Registration state notification callback prototype
 785  * */
 786 typedef void (*LinphoneRegistrationStateCb)(struct _LinphoneCore *lc, LinphoneProxyConfig *cfg, LinphoneRegistrationState cstate, const char *message);
 787 /** Callback prototype */
 788 typedef void (*ShowInterfaceCb)(struct _LinphoneCore *lc);
 789 /** Callback prototype */
 790 typedef void (*DisplayStatusCb)(struct _LinphoneCore *lc, const char *message);
 791 /** Callback prototype */
 792 typedef void (*DisplayMessageCb)(struct _LinphoneCore *lc, const char *message);
 793 /** Callback prototype */
 794 typedef void (*DisplayUrlCb)(struct _LinphoneCore *lc, const char *message, const char *url);
 795 /** Callback prototype */
 796 typedef void (*LinphoneCoreCbFunc)(struct _LinphoneCore *lc,void * user_data);
 797 /** Callback prototype */
 798 typedef void (*NotifyReceivedCb)(struct _LinphoneCore *lc, LinphoneCall *call, const char *from, const char *event);
 799 /**
 800  * Report status change for a friend previously \link linphone_core_add_friend() added \endlink to #LinphoneCore.
 801  * @param lc #LinphoneCore object .
 802  * @param lf Updated #LinphoneFriend .
 803  */
 804 typedef void (*NotifyPresenceReceivedCb)(struct _LinphoneCore *lc, LinphoneFriend * lf);
 805 /**
 806  *  Reports that a new subscription request has been received and wait for a decision.
 807  *  <br> Status on this subscription request is notified by \link linphone_friend_set_inc_subscribe_policy() changing policy \endlink for this friend
 808  *      @param lc #LinphoneCore object
 809  *      @param lf #LinphoneFriend corresponding to the subscriber
 810  *      @param url of the subscriber
 811  *  Callback prototype
 812  *  */
 813 typedef void (*NewSubscribtionRequestCb)(struct _LinphoneCore *lc, LinphoneFriend *lf, const char *url);
 814 /** Callback prototype */
 815 typedef void (*AuthInfoRequested)(struct _LinphoneCore *lc, const char *realm, const char *username);
 816 /** Callback prototype */
 817 typedef void (*CallLogUpdated)(struct _LinphoneCore *lc, struct _LinphoneCallLog *newcl);
 818 /**
 819  * Callback prototype
 820  * @deprecated use #MessageReceived instead.
 821  *
 822  * @param lc #LinphoneCore object
 823  * @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.
 824  * @param from #LinphoneAddress from
 825  * @param message incoming message
 826  *  */
 827 typedef void (*TextMessageReceived)(LinphoneCore *lc, LinphoneChatRoom *room, const LinphoneAddress *from, const char *message);
 828 /**
 829  * Chat message callback prototype
 830  *
 831  * @param lc #LinphoneCore object
 832  * @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.
 833  * @param LinphoneChatMessage incoming message
 834  * */
 835 typedef void (*MessageReceived)(LinphoneCore *lc, LinphoneChatRoom *room, LinphoneChatMessage *message);
 836
 837 /** Callback prototype */
 838 typedef void (*DtmfReceived)(struct _LinphoneCore* lc, LinphoneCall *call, int dtmf);
 839 /** Callback prototype */
 840 typedef void (*ReferReceived)(struct _LinphoneCore *lc, const char *refer_to);
 841 /** Callback prototype */
 842 typedef void (*BuddyInfoUpdated)(struct _LinphoneCore *lc, LinphoneFriend *lf);
 843 /** Callback prototype for in progress transfers. The new_call_state is the state of the call resulting of the transfer, at the other party. */
 844 typedef void (*LinphoneTransferStateChanged)(struct _LinphoneCore *lc, LinphoneCall *transfered, LinphoneCallState new_call_state);
 845 /** Callback prototype for receiving quality statistics for calls*/
 846 typedef void (*CallStatsUpdated)(struct _LinphoneCore *lc, LinphoneCall *call, const LinphoneCallStats *stats);
 847
 848 /**
 849  * This structure holds all callbacks that the application should implement.
 850  *  None is mandatory.
 851 **/
 852 typedef struct _LinphoneVTable{
 853         LinphoneGlobalStateCb global_state_changed; /**<Notifies globlal state changes*/
 854         LinphoneRegistrationStateCb registration_state_changed;/**<Notifies registration state changes*/
 855         LinphoneCallStateCb call_state_changed;/**<Notifies call state changes*/
 856         NotifyPresenceReceivedCb notify_presence_recv; /**< Notify received presence events*/
 857         NewSubscribtionRequestCb new_subscription_request; /**< Notify about pending subscription request */
 858         AuthInfoRequested auth_info_requested; /**< Ask the application some authentication information */
 859         CallLogUpdated call_log_updated; /**< Notifies that call log list has been updated */
 860         TextMessageReceived text_received; /** @deprecated, use #message_received instead <br> A text message has been received */
 861         MessageReceived message_received; /** a message is received, can be text or external body*/
 862         DtmfReceived dtmf_received; /**< A dtmf has been received received */
 863         ReferReceived refer_received; /**< An out of call refer was received */
 864         CallEncryptionChangedCb call_encryption_changed; /**<Notifies on change in the encryption of call streams */
 865         LinphoneTransferStateChanged transfer_state_changed; /**<Notifies when a transfer is in progress */
 866         BuddyInfoUpdated buddy_info_updated; /**< a LinphoneFriend's BuddyInfo has changed*/
 867         NotifyReceivedCb notify_recv; /**< Other notifications*/
 868         CallStatsUpdated call_stats_updated; /**<Notifies on refreshing of call's statistics. */
 869         DisplayStatusCb display_status; /**< DEPRECATED Callback that notifies various events with human readable text.*/
 870         DisplayMessageCb display_message;/**< DEPRECATED Callback to display a message to the user */
 871         DisplayMessageCb display_warning;/**< DEPRECATED Callback to display a warning to the user */
 872         DisplayUrlCb display_url; /**< DEPRECATED */
 873         ShowInterfaceCb show; /**< DEPRECATED Notifies the application that it should show up*/
 874 } LinphoneCoreVTable;
 875
 876 /**
 877  * @}
 878 **/
 879
 880 typedef struct _LCCallbackObj
 881 {
 882   LinphoneCoreCbFunc _func;
 883   void * _user_data;
 884 }LCCallbackObj;
 885
 886
 887
 888 typedef enum _LinphoneFirewallPolicy{
 889         LinphonePolicyNoFirewall,
 890         LinphonePolicyUseNatAddress,
 891         LinphonePolicyUseStun,
 892         LinphonePolicyUseIce
 893 } LinphoneFirewallPolicy;
 894
 895 typedef enum _LinphoneWaitingState{
 896         LinphoneWaitingStart,
 897         LinphoneWaitingProgress,
 898         LinphoneWaitingFinished
 899 } LinphoneWaitingState;
 900 typedef void * (*LinphoneWaitingCallback)(struct _LinphoneCore *lc, void *context, LinphoneWaitingState ws, const char *purpose, float progress);
 901
 902
 903 /* THE main API */
 904
 905 void linphone_core_enable_logs(FILE *file);
 906 void linphone_core_enable_logs_with_cb(OrtpLogFunc logfunc);
 907 void linphone_core_disable_logs(void);
 908 /*sets the user-agent string in sip messages, must be set before linphone_core_new() or linphone_core_init() */
 909 void linphone_core_set_user_agent(const char *ua_name, const char *version);
 910 const char *linphone_core_get_version(void);
 911 const char *linphone_core_get_user_agent_name(void);
 912 const char *linphone_core_get_user_agent_version(void);
 913
 914 LinphoneCore *linphone_core_new(const LinphoneCoreVTable *vtable,
 915                                                 const char *config_path, const char *factory_config, void* userdata);
 916
 917 /* function to be periodically called in a main loop */
 918 /* For ICE to work properly it should be called every 20ms */
 919 void linphone_core_iterate(LinphoneCore *lc);
 920 #if 0 /*not implemented yet*/
 921 /**
 922  * @ingroup initializing
 923  * Provide Linphone Core with an unique identifier. This be later used to identified contact address coming from this device.
 924  * Value is not saved.
 925  * @param lc object
 926  * @param string identifying the device, can be EMEI or UDID
 927  *
 928  */
 929 void linphone_core_set_device_identifier(LinphoneCore *lc,const char* device_id);
 930 /**
 931  * @ingroup initializing
 932  * get Linphone unique identifier
 933  *
 934  */
 935 const char*  linphone_core_get_device_identifier(const LinphoneCore *lc);
 936
 937 #endif
 938
 939 LinphoneAddress * linphone_core_interpret_url(LinphoneCore *lc, const char *url);
 940
 941 LinphoneCall * linphone_core_invite(LinphoneCore *lc, const char *url);
 942
 943 LinphoneCall * linphone_core_invite_address(LinphoneCore *lc, const LinphoneAddress *addr);
 944
 945 LinphoneCall * linphone_core_invite_with_params(LinphoneCore *lc, const char *url, const LinphoneCallParams *params);
 946
 947 LinphoneCall * linphone_core_invite_address_with_params(LinphoneCore *lc, const LinphoneAddress *addr, const LinphoneCallParams *params);
 948
 949 int linphone_core_transfer_call(LinphoneCore *lc, LinphoneCall *call, const char *refer_to);
 950
 951 int linphone_core_transfer_call_to_another(LinphoneCore *lc, LinphoneCall *call, LinphoneCall *dest);
 952
 953 bool_t linphone_core_inc_invite_pending(LinphoneCore*lc);
 954
 955 bool_t linphone_core_in_call(const LinphoneCore *lc);
 956
 957 LinphoneCall *linphone_core_get_current_call(const LinphoneCore *lc);
 958
 959 int linphone_core_accept_call(LinphoneCore *lc, LinphoneCall *call);
 960
 961 int linphone_core_accept_call_with_params(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
 962
 963 int linphone_core_terminate_call(LinphoneCore *lc, LinphoneCall *call);
 964
 965 int linphone_core_redirect_call(LinphoneCore *lc, LinphoneCall *call, const char *redirect_uri);
 966
 967 int linphone_core_terminate_all_calls(LinphoneCore *lc);
 968
 969 int linphone_core_pause_call(LinphoneCore *lc, LinphoneCall *call);
 970
 971 int linphone_core_pause_all_calls(LinphoneCore *lc);
 972
 973 int linphone_core_resume_call(LinphoneCore *lc, LinphoneCall *call);
 974
 975 int linphone_core_update_call(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
 976
 977 int linphone_core_defer_call_update(LinphoneCore *lc, LinphoneCall *call);
 978
 979 int linphone_core_accept_call_update(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
 980
 981 LinphoneCallParams *linphone_core_create_default_call_parameters(LinphoneCore *lc);
 982
 983 LinphoneCall *linphone_core_get_call_by_remote_address(LinphoneCore *lc, const char *remote_address);
 984
 985 void linphone_core_send_dtmf(LinphoneCore *lc,char dtmf);
 986
 987 int linphone_core_set_primary_contact(LinphoneCore *lc, const char *contact);
 988
 989 const char *linphone_core_get_primary_contact(LinphoneCore *lc);
 990
 991 const char * linphone_core_get_identity(LinphoneCore *lc);
 992
 993 void linphone_core_set_guess_hostname(LinphoneCore *lc, bool_t val);
 994 bool_t linphone_core_get_guess_hostname(LinphoneCore *lc);
 995
 996 bool_t linphone_core_ipv6_enabled(LinphoneCore *lc);
 997 void linphone_core_enable_ipv6(LinphoneCore *lc, bool_t val);
 998
 999 LinphoneAddress *linphone_core_get_primary_contact_parsed(LinphoneCore *lc);
1000 const char * linphone_core_get_identity(LinphoneCore *lc);
1001 /*0= no bandwidth limit*/
1002 void linphone_core_set_download_bandwidth(LinphoneCore *lc, int bw);
1003 void linphone_core_set_upload_bandwidth(LinphoneCore *lc, int bw);
1004
1005 int linphone_core_get_download_bandwidth(const LinphoneCore *lc);
1006 int linphone_core_get_upload_bandwidth(const LinphoneCore *lc);
1007
1008 void linphone_core_enable_adaptive_rate_control(LinphoneCore *lc, bool_t enabled);
1009 bool_t linphone_core_adaptive_rate_control_enabled(const LinphoneCore *lc);
1010 /**
1011  * set audio packetization time linphone expect to receive from peer
1012  * @ingroup media_parameters
1013  *
1014  */
1015 void linphone_core_set_download_ptime(LinphoneCore *lc, int ptime);
1016 /**
1017  * get audio packetization time linphone expect to receive from peer, 0 means unspecified
1018  * @ingroup media_parameters
1019  */
1020 int  linphone_core_get_download_ptime(LinphoneCore *lc);
1021
1022 void linphone_core_set_upload_ptime(LinphoneCore *lc, int ptime);
1023
1024 int linphone_core_get_upload_ptime(LinphoneCore *lc);
1025
1026 /* returns a MSList of PayloadType */
1027 const MSList *linphone_core_get_audio_codecs(const LinphoneCore *lc);
1028
1029 int linphone_core_set_audio_codecs(LinphoneCore *lc, MSList *codecs);
1030 /* returns a MSList of PayloadType */
1031 const MSList *linphone_core_get_video_codecs(const LinphoneCore *lc);
1032
1033 int linphone_core_set_video_codecs(LinphoneCore *lc, MSList *codecs);
1034
1035 bool_t linphone_core_payload_type_enabled(LinphoneCore *lc, const PayloadType *pt);
1036
1037 int linphone_core_enable_payload_type(LinphoneCore *lc, PayloadType *pt, bool_t enable);
1038
1039 /**
1040  * Wildcard value used by #linphone_core_find_payload_type to ignore rate in search algirithm
1041  * @ingroup media_parameters
1042  */
1043 #define LINPHONE_FIND_PAYLOAD_IGNORE_RATE -1
1044 /**
1045  * Wildcard value used by #linphone_core_find_payload_type to ignore channel in search algirithm
1046  * @ingroup media_parameters
1047  */
1048 #define LINPHONE_FIND_PAYLOAD_IGNORE_CHANNELS -1
1049 /**
1050  * Get payload type  from mime type and clock rate
1051  * @ingroup media_parameters
1052  * This function searches in audio and video codecs for the given payload type name and clockrate.
1053  * @param lc #LinphoneCore object
1054  * @param type payload mime type (I.E SPEEX, PCMU, VP8)
1055  * @param rate, can be #LINPHONE_FIND_PAYLOAD_IGNORE_RATE
1056  * @param channels, number of channels, can be #LINPHONE_FIND_PAYLOAD_IGNORE_CHANNELS
1057  * @return Returns NULL if not found.
1058  */
1059 PayloadType* linphone_core_find_payload_type(LinphoneCore* lc, const char* type, int rate, int channels) ;
1060
1061 int linphone_core_get_payload_type_number(LinphoneCore *lc, const PayloadType *pt);
1062
1063 const char *linphone_core_get_payload_type_description(LinphoneCore *lc, PayloadType *pt);
1064
1065 bool_t linphone_core_check_payload_type_usability(LinphoneCore *lc, PayloadType *pt);
1066
1067 /**
1068  * @ingroup proxy
1069  *Create a proxy config with default value from Linphone core.
1070  *@param lc #LinphoneCore object
1071  *@return #LinphoneProxyConfig with defualt value set
1072  */
1073 LinphoneProxyConfig * linphone_core_create_proxy_config(LinphoneCore *lc);
1074
1075 int linphone_core_add_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
1076
1077 void linphone_core_clear_proxy_config(LinphoneCore *lc);
1078
1079 void linphone_core_remove_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
1080
1081 const MSList *linphone_core_get_proxy_config_list(const LinphoneCore *lc);
1082
1083 void linphone_core_set_default_proxy(LinphoneCore *lc, LinphoneProxyConfig *config);
1084
1085 void linphone_core_set_default_proxy_index(LinphoneCore *lc, int index);
1086
1087 int linphone_core_get_default_proxy(LinphoneCore *lc, LinphoneProxyConfig **config);
1088
1089 void linphone_core_add_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
1090
1091 void linphone_core_remove_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
1092
1093 const MSList *linphone_core_get_auth_info_list(const LinphoneCore *lc);
1094
1095 const LinphoneAuthInfo *linphone_core_find_auth_info(LinphoneCore *lc, const char *realm, const char *username);
1096
1097 void linphone_core_abort_authentication(LinphoneCore *lc,  LinphoneAuthInfo *info);
1098
1099 void linphone_core_clear_all_auth_info(LinphoneCore *lc);
1100
1101 void linphone_core_enable_audio_adaptive_jittcomp(LinphoneCore *lc, bool_t enable);
1102
1103 bool_t linphone_core_audio_adaptive_jittcomp_enabled(LinphoneCore *lc);
1104
1105 int linphone_core_get_audio_jittcomp(LinphoneCore *lc);
1106
1107 void linphone_core_set_audio_jittcomp(LinphoneCore *lc, int value);
1108
1109 void linphone_core_enable_video_adaptive_jittcomp(LinphoneCore *lc, bool_t enable);
1110
1111 bool_t linphone_core_video_adaptive_jittcomp_enabled(LinphoneCore *lc);
1112
1113 int linphone_core_get_video_jittcomp(LinphoneCore *lc);
1114
1115 void linphone_core_set_video_jittcomp(LinphoneCore *lc, int value);
1116
1117 int linphone_core_get_audio_port(const LinphoneCore *lc);
1118
1119 void linphone_core_get_audio_port_range(const LinphoneCore *lc, int *min_port, int *max_port);
1120
1121 int linphone_core_get_video_port(const LinphoneCore *lc);
1122
1123 void linphone_core_get_video_port_range(const LinphoneCore *lc, int *min_port, int *max_port);
1124
1125 int linphone_core_get_nortp_timeout(const LinphoneCore *lc);
1126
1127 void linphone_core_set_audio_port(LinphoneCore *lc, int port);
1128
1129 void linphone_core_set_audio_port_range(LinphoneCore *lc, int min_port, int max_port);
1130
1131 void linphone_core_set_video_port(LinphoneCore *lc, int port);
1132
1133 void linphone_core_set_video_port_range(LinphoneCore *lc, int min_port, int max_port);
1134
1135 void linphone_core_set_nortp_timeout(LinphoneCore *lc, int port);
1136
1137 void linphone_core_set_use_info_for_dtmf(LinphoneCore *lc, bool_t use_info);
1138
1139 bool_t linphone_core_get_use_info_for_dtmf(LinphoneCore *lc);
1140
1141 void linphone_core_set_use_rfc2833_for_dtmf(LinphoneCore *lc,bool_t use_rfc2833);
1142
1143 bool_t linphone_core_get_use_rfc2833_for_dtmf(LinphoneCore *lc);
1144
1145 void linphone_core_set_sip_port(LinphoneCore *lc, int port);
1146
1147 int linphone_core_get_sip_port(LinphoneCore *lc);
1148
1149 int linphone_core_set_sip_transports(LinphoneCore *lc, const LCSipTransports *transports);
1150
1151 int linphone_core_get_sip_transports(LinphoneCore *lc, LCSipTransports *transports);
1152 /**
1153  *
1154  * Give access to the UDP sip socket. Can be useful to configure this socket as persistent I.E kCFStreamNetworkServiceType set to kCFStreamNetworkServiceTypeVoIP)
1155  * @param lc #LinphoneCore
1156  * @return socket file descriptor
1157  */
1158 ortp_socket_t linphone_core_get_sip_socket(LinphoneCore *lc);
1159
1160 void linphone_core_set_inc_timeout(LinphoneCore *lc, int seconds);
1161
1162 int linphone_core_get_inc_timeout(LinphoneCore *lc);
1163
1164 void linphone_core_set_stun_server(LinphoneCore *lc, const char *server);
1165
1166 const char * linphone_core_get_stun_server(const LinphoneCore *lc);
1167
1168 void linphone_core_set_nat_address(LinphoneCore *lc, const char *addr);
1169
1170 const char *linphone_core_get_nat_address(const LinphoneCore *lc);
1171
1172 void linphone_core_set_firewall_policy(LinphoneCore *lc, LinphoneFirewallPolicy pol);
1173
1174 LinphoneFirewallPolicy linphone_core_get_firewall_policy(const LinphoneCore *lc);
1175
1176 const char * linphone_core_get_relay_addr(const LinphoneCore *lc);
1177
1178 int linphone_core_set_relay_addr(LinphoneCore *lc, const char *addr);
1179
1180 /* sound functions */
1181 /* returns a null terminated static array of string describing the sound devices */
1182 const char**  linphone_core_get_sound_devices(LinphoneCore *lc);
1183 void linphone_core_reload_sound_devices(LinphoneCore *lc);
1184 bool_t linphone_core_sound_device_can_capture(LinphoneCore *lc, const char *device);
1185 bool_t linphone_core_sound_device_can_playback(LinphoneCore *lc, const char *device);
1186 int linphone_core_get_ring_level(LinphoneCore *lc);
1187 int linphone_core_get_play_level(LinphoneCore *lc);
1188 int linphone_core_get_rec_level(LinphoneCore *lc);
1189 void linphone_core_set_ring_level(LinphoneCore *lc, int level);
1190 void linphone_core_set_play_level(LinphoneCore *lc, int level);
1191
1192 void linphone_core_set_playback_gain_db(LinphoneCore *lc, float level);
1193
1194 float linphone_core_get_playback_gain_db(LinphoneCore *lc);
1195 void linphone_core_set_rec_level(LinphoneCore *lc, int level);
1196 const char * linphone_core_get_ringer_device(LinphoneCore *lc);
1197 const char * linphone_core_get_playback_device(LinphoneCore *lc);
1198 const char * linphone_core_get_capture_device(LinphoneCore *lc);
1199 int linphone_core_set_ringer_device(LinphoneCore *lc, const char * devid);
1200 int linphone_core_set_playback_device(LinphoneCore *lc, const char * devid);
1201 int linphone_core_set_capture_device(LinphoneCore *lc, const char * devid);
1202 char linphone_core_get_sound_source(LinphoneCore *lc);
1203 void linphone_core_set_sound_source(LinphoneCore *lc, char source);
1204 void linphone_core_set_ring(LinphoneCore *lc, const char *path);
1205 const char *linphone_core_get_ring(const LinphoneCore *lc);
1206 void linphone_core_verify_server_certificates(LinphoneCore *lc, bool_t yesno);
1207 void linphone_core_set_root_ca(LinphoneCore *lc, const char *path);
1208 void linphone_core_set_ringback(LinphoneCore *lc, const char *path);
1209 const char * linphone_core_get_ringback(const LinphoneCore *lc);
1210
1211 void linphone_core_set_remote_ringback_tone(LinphoneCore *lc,const char *);
1212 const char *linphone_core_get_remote_ringback_tone(const LinphoneCore *lc);
1213
1214 int linphone_core_preview_ring(LinphoneCore *lc, const char *ring,LinphoneCoreCbFunc func,void * userdata);
1215 void linphone_core_enable_echo_cancellation(LinphoneCore *lc, bool_t val);
1216 bool_t linphone_core_echo_cancellation_enabled(LinphoneCore *lc);
1217
1218 void linphone_core_enable_echo_limiter(LinphoneCore *lc, bool_t val);
1219 bool_t linphone_core_echo_limiter_enabled(const LinphoneCore *lc);
1220
1221 void linphone_core_enable_agc(LinphoneCore *lc, bool_t val);
1222 bool_t linphone_core_agc_enabled(const LinphoneCore *lc);
1223
1224 void linphone_core_mute_mic(LinphoneCore *lc, bool_t muted);
1225 /**
1226  * return mic state.
1227  *
1228  * @ingroup media_parameters
1229 **/
1230 bool_t linphone_core_is_mic_muted(LinphoneCore *lc);
1231
1232 bool_t linphone_core_is_audio_muted(LinphoneCore *lc);
1233 bool_t linphone_core_is_rtp_muted(LinphoneCore *lc);
1234
1235 bool_t linphone_core_get_rtp_no_xmit_on_audio_mute(const LinphoneCore *lc);
1236 void linphone_core_set_rtp_no_xmit_on_audio_mute(LinphoneCore *lc, bool_t val);
1237
1238
1239 /* returns a list of LinphoneCallLog */
1240 const MSList * linphone_core_get_call_logs(LinphoneCore *lc);
1241 void linphone_core_clear_call_logs(LinphoneCore *lc);
1242 int linphone_core_get_missed_calls_count(LinphoneCore *lc);
1243 void linphone_core_reset_missed_calls_count(LinphoneCore *lc);
1244 void linphone_core_remove_call_log(LinphoneCore *lc, LinphoneCallLog *call_log);
1245
1246 /* video support */
1247 bool_t linphone_core_video_supported(LinphoneCore *lc);
1248 void linphone_core_enable_video(LinphoneCore *lc, bool_t vcap_enabled, bool_t display_enabled);
1249 bool_t linphone_core_video_enabled(LinphoneCore *lc);
1250 void linphone_core_set_video_policy(LinphoneCore *lc, const LinphoneVideoPolicy *policy);
1251 const LinphoneVideoPolicy *linphone_core_get_video_policy(LinphoneCore *lc);
1252
1253 typedef struct MSVideoSizeDef{
1254         MSVideoSize vsize;
1255         const char *name;
1256 }MSVideoSizeDef;
1257 /* returns a zero terminated table of MSVideoSizeDef*/
1258 const MSVideoSizeDef *linphone_core_get_supported_video_sizes(LinphoneCore *lc);
1259 void linphone_core_set_preferred_video_size(LinphoneCore *lc, MSVideoSize vsize);
1260 MSVideoSize linphone_core_get_preferred_video_size(LinphoneCore *lc);
1261 void linphone_core_set_preferred_video_size_by_name(LinphoneCore *lc, const char *name);
1262
1263 void linphone_core_enable_video_preview(LinphoneCore *lc, bool_t val);
1264 bool_t linphone_core_video_preview_enabled(const LinphoneCore *lc);
1265
1266 void linphone_core_enable_self_view(LinphoneCore *lc, bool_t val);
1267 bool_t linphone_core_self_view_enabled(const LinphoneCore *lc);
1268
1269
1270 /* returns a null terminated static array of string describing the webcams */
1271 void linphone_core_reload_video_devices(LinphoneCore *lc);
1272 const char**  linphone_core_get_video_devices(const LinphoneCore *lc);
1273 int linphone_core_set_video_device(LinphoneCore *lc, const char *id);
1274 const char *linphone_core_get_video_device(const LinphoneCore *lc);
1275
1276 /* Set static picture to be used when "Static picture" is the video device */
1277 int linphone_core_set_static_picture(LinphoneCore *lc, const char *path);
1278
1279 /* Set and get frame rate for static picture */
1280 int linphone_core_set_static_picture_fps(LinphoneCore *lc, float fps);
1281 float linphone_core_get_static_picture_fps(LinphoneCore *lc);
1282
1283 /*function to be used for eventually setting window decorations (icons, title...)*/
1284 unsigned long linphone_core_get_native_video_window_id(const LinphoneCore *lc);
1285 void linphone_core_set_native_video_window_id(LinphoneCore *lc, unsigned long id);
1286
1287 unsigned long linphone_core_get_native_preview_window_id(const LinphoneCore *lc);
1288 void linphone_core_set_native_preview_window_id(LinphoneCore *lc, unsigned long id);
1289
1290 void linphone_core_use_preview_window(LinphoneCore *lc, bool_t yesno);
1291 int linphone_core_get_device_rotation(LinphoneCore *lc );
1292 void linphone_core_set_device_rotation(LinphoneCore *lc, int rotation);
1293
1294 /* start or stop streaming video in case of embedded window */
1295 void linphone_core_show_video(LinphoneCore *lc, bool_t show);
1296
1297 /*play/record support: use files instead of soundcard*/
1298 void linphone_core_use_files(LinphoneCore *lc, bool_t yesno);
1299 void linphone_core_set_play_file(LinphoneCore *lc, const char *file);
1300 void linphone_core_set_record_file(LinphoneCore *lc, const char *file);
1301
1302 void linphone_core_play_dtmf(LinphoneCore *lc, char dtmf, int duration_ms);
1303 void linphone_core_stop_dtmf(LinphoneCore *lc);
1304
1305 int linphone_core_get_current_call_duration(const LinphoneCore *lc);
1306
1307
1308 int linphone_core_get_mtu(const LinphoneCore *lc);
1309 void linphone_core_set_mtu(LinphoneCore *lc, int mtu);
1310
1311 /**
1312  * @ingroup network_parameters
1313  * This method is called by the application to notify the linphone core library when network is reachable.
1314  * Calling this method with true trigger linphone to initiate a registration process for all proxies.
1315  * Calling this method disables the automatic network detection mode. It means you must call this method after each network state changes.
1316  */
1317 void linphone_core_set_network_reachable(LinphoneCore* lc,bool_t value);
1318 /**
1319  * @ingroup network_parameters
1320  * return network state either as positioned by the application or by linphone itself.
1321  */
1322 bool_t linphone_core_is_network_reachable(LinphoneCore* lc);
1323
1324 /**
1325  *  @ingroup network_parameters
1326  *  enable signaling keep alive. small udp packet sent periodically to keep udp NAT association
1327  */
1328 void linphone_core_enable_keep_alive(LinphoneCore* lc,bool_t enable);
1329 /**
1330  *  @ingroup network_parameters
1331  * Is signaling keep alive
1332  */
1333 bool_t linphone_core_keep_alive_enabled(LinphoneCore* lc);
1334
1335 void *linphone_core_get_user_data(LinphoneCore *lc);
1336 void linphone_core_set_user_data(LinphoneCore *lc, void *userdata);
1337
1338 /* returns LpConfig object to read/write to the config file: usefull if you wish to extend
1339 the config file with your own sections */
1340 struct _LpConfig *linphone_core_get_config(LinphoneCore *lc);
1341
1342 /*set a callback for some blocking operations, it takes you informed of the progress of the operation*/
1343 void linphone_core_set_waiting_callback(LinphoneCore *lc, LinphoneWaitingCallback cb, void *user_context);
1344
1345 /*returns the list of registered SipSetup (linphonecore plugins) */
1346 const MSList * linphone_core_get_sip_setups(LinphoneCore *lc);
1347
1348 void linphone_core_destroy(LinphoneCore *lc);
1349
1350 /*for advanced users:*/
1351 typedef RtpTransport * (*LinphoneRtpTransportFactoryFunc)(void *data, int port);
1352 struct _LinphoneRtpTransportFactories{
1353         LinphoneRtpTransportFactoryFunc audio_rtp_func;
1354         void *audio_rtp_func_data;
1355         LinphoneRtpTransportFactoryFunc audio_rtcp_func;
1356         void *audio_rtcp_func_data;
1357         LinphoneRtpTransportFactoryFunc video_rtp_func;
1358         void *video_rtp_func_data;
1359         LinphoneRtpTransportFactoryFunc video_rtcp_func;
1360         void *video_rtcp_func_data;
1361 };
1362 typedef struct _LinphoneRtpTransportFactories LinphoneRtpTransportFactories;
1363
1364 void linphone_core_set_rtp_transport_factories(LinphoneCore* lc, LinphoneRtpTransportFactories *factories);
1365
1366 int linphone_core_get_current_call_stats(LinphoneCore *lc, rtp_stats_t *local, rtp_stats_t *remote);
1367
1368 int linphone_core_get_calls_nb(const LinphoneCore *lc);
1369
1370 const MSList *linphone_core_get_calls(LinphoneCore *lc);
1371
1372 LinphoneGlobalState linphone_core_get_global_state(const LinphoneCore *lc);
1373 /**
1374  * force registration refresh to be initiated upon next iterate
1375  * @ingroup proxies
1376  */
1377 void linphone_core_refresh_registers(LinphoneCore* lc);
1378
1379 /* Path to the file storing secrets cache */
1380 void linphone_core_set_zrtp_secrets_file(LinphoneCore *lc, const char* file);
1381
1382
1383 const LinphoneCall* linphone_core_find_call_from_uri(LinphoneCore *lc, const char *uri);
1384
1385 int linphone_core_add_to_conference(LinphoneCore *lc, LinphoneCall *call);
1386 int linphone_core_add_all_to_conference(LinphoneCore *lc);
1387 int linphone_core_remove_from_conference(LinphoneCore *lc, LinphoneCall *call);
1388 bool_t linphone_core_is_in_conference(const LinphoneCore *lc);
1389 int linphone_core_enter_conference(LinphoneCore *lc);
1390 int linphone_core_leave_conference(LinphoneCore *lc);
1391 float linphone_core_get_conference_local_input_volume(LinphoneCore *lc);
1392
1393 int linphone_core_terminate_conference(LinphoneCore *lc);
1394 int linphone_core_get_conference_size(LinphoneCore *lc);
1395
1396 int linphone_core_get_max_calls(LinphoneCore *lc);
1397 void linphone_core_set_max_calls(LinphoneCore *lc, int max);
1398
1399 bool_t linphone_core_sound_resources_locked(LinphoneCore *lc);
1400
1401 bool_t linphone_core_media_encryption_supported(const LinphoneCore *lc, LinphoneMediaEncryption menc);
1402
1403 /**
1404  * Choose media encryption policy to be used for RTP packets
1405  */
1406 int linphone_core_set_media_encryption(LinphoneCore *lc, enum LinphoneMediaEncryption menc);
1407 LinphoneMediaEncryption linphone_core_get_media_encryption(LinphoneCore *lc);
1408
1409 bool_t linphone_core_is_media_encryption_mandatory(LinphoneCore *lc);
1410 /**
1411  * Defines Linphone behaviour when encryption parameters negociation fails on outoing call.
1412  * If set to TRUE call will fail; if set to FALSE will resend an INVITE with encryption disabled
1413  */
1414 void linphone_core_set_media_encryption_mandatory(LinphoneCore *lc, bool_t m);
1415
1416 /**
1417  * Init call params using LinphoneCore's current configuration
1418  */
1419 void linphone_core_init_default_params(LinphoneCore*lc, LinphoneCallParams *params);
1420
1421 /**
1422  * True if tunnel support was compiled.
1423  */
1424 bool_t linphone_core_tunnel_available(void);
1425
1426 typedef struct LinphoneTunnel LinphoneTunnel;
1427 /**
1428 * get tunnel instance if available
1429 */
1430 LinphoneTunnel *linphone_core_get_tunnel(LinphoneCore *lc);
1431
1432 void linphone_core_set_sip_dscp(LinphoneCore *lc, int dscp);
1433 int linphone_core_get_sip_dscp(const LinphoneCore *lc);
1434
1435 void linphone_core_set_audio_dscp(LinphoneCore *lc, int dscp);
1436 int linphone_core_get_audio_dscp(const LinphoneCore *lc);
1437
1438 void linphone_core_set_video_dscp(LinphoneCore *lc, int dscp);
1439 int linphone_core_get_video_dscp(const LinphoneCore *lc);
1440
1441
1442
1443 #ifdef __cplusplus
1444 }
1445 #endif
1446
1447
1448 #endif