iaxclient.h

Go to the documentation of this file.

/*
 * iaxclient: a cross-platform IAX softphone library
 *
 * Copyrights:
 * Copyright (C) 2003-2006, Horizon Wimba, Inc.
 * Copyright (C) 2007, Wimba, Inc.
 *
 * Contributors:
 * Steve Kann <stevek@stevek.com>
 * Frik Strecker <frik@gatherworks.com>
 * Mihai Balea <mihai AT hates DOT ms>
 * Peter Grayson <jpgrayson@gmail.com>
 * Bill Cholewka <bcholew@gmail.com>
 * Erik Bunce <kde@bunce.us>
 *
 * This program is free software, distributed under the terms of
 * the GNU Lesser (Library) General Public License.
 */
#ifndef _iaxclient_h
#define _iaxclient_h

#ifdef __cplusplus
extern "C" {
#endif

#ifndef DOXYGEN_SHOULD_SKIP_THIS
#ifdef _MSC_VER
typedef int socklen_t;
#endif
#include <stdio.h>
#if defined(WIN32)  ||  defined(_WIN32_WCE)
#include <windows.h>
#include <winsock.h>
#else
#include <sys/socket.h>
#endif

#ifdef BUILDING_DLL
# if defined(WIN32) ||  defined(_WIN32_WCE)
#  ifdef _MSC_VER
#   define EXPORT __declspec(dllexport)
#  else
#   define EXPORT  __stdcall __declspec(dllexport)
#  endif
# else
#  define EXPORT
#endif
#else
# define EXPORT
#endif
#endif /* DOXYGEN_SHOULD_SKIP_THIS */

#if defined(WIN32)  ||  defined(_WIN32_WCE)
#if defined(_MSC_VER)
        typedef int (__stdcall *iaxc_sendto_t)(SOCKET, const void *, size_t, int,
                        const struct sockaddr *, socklen_t);
        typedef int (__stdcall *iaxc_recvfrom_t)(SOCKET, void *, size_t, int,
                        struct sockaddr *, socklen_t *);
#else
        typedef int PASCAL (*iaxc_sendto_t)(SOCKET, const char *, int, int,
                        const struct sockaddr *, int);
        typedef int PASCAL (*iaxc_recvfrom_t)(SOCKET, char *, int, int,
                        struct sockaddr *, int *);
#endif
#else

        typedef int (*iaxc_sendto_t)(int, const void *, size_t, int,
                        const struct sockaddr *, socklen_t);
        typedef int (*iaxc_recvfrom_t)(int, void *, size_t, int,
                        struct sockaddr *, socklen_t *);
#endif

#define IAXC_AUDIO_FORMAT_MASK  ((1<<16)-1)

#define IAXC_VIDEO_FORMAT_MASK  (((1<<25)-1) & ~IAXC_AUDIO_FORMAT_MASK)

/* payload formats : WARNING: must match libiax values!!! */
/* Data formats for capabilities and frames alike */
#define IAXC_FORMAT_G723_1       (1 << 0)   
#define IAXC_FORMAT_GSM          (1 << 1)   
#define IAXC_FORMAT_ULAW         (1 << 2)   
#define IAXC_FORMAT_ALAW         (1 << 3)   
#define IAXC_FORMAT_G726         (1 << 4)   
#define IAXC_FORMAT_ADPCM        (1 << 5)   
#define IAXC_FORMAT_SLINEAR      (1 << 6)   
#define IAXC_FORMAT_LPC10        (1 << 7)   
#define IAXC_FORMAT_G729A        (1 << 8)   
#define IAXC_FORMAT_SPEEX        (1 << 9)   
#define IAXC_FORMAT_ILBC         (1 << 10)  
#define IAXC_FORMAT_MAX_AUDIO    (1 << 15)  
#define IAXC_FORMAT_JPEG         (1 << 16)  
#define IAXC_FORMAT_PNG          (1 << 17)  
#define IAXC_FORMAT_H261         (1 << 18)  
#define IAXC_FORMAT_H263         (1 << 19)  
#define IAXC_FORMAT_H263_PLUS    (1 << 20)  
#define IAXC_FORMAT_H264         (1 << 21)  
#define IAXC_FORMAT_MPEG4        (1 << 22)  
#define IAXC_FORMAT_THEORA       (1 << 24)  
#define IAXC_FORMAT_MAX_VIDEO    (1 << 24)  
#define IAXC_EVENT_TEXT          1   
#define IAXC_EVENT_LEVELS        2   
#define IAXC_EVENT_STATE         3   
#define IAXC_EVENT_NETSTAT       4   
#define IAXC_EVENT_URL           5   
#define IAXC_EVENT_VIDEO         6   
#define IAXC_EVENT_REGISTRATION  8   
#define IAXC_EVENT_DTMF          9   
#define IAXC_EVENT_AUDIO         10  
#define IAXC_EVENT_VIDEOSTATS    11  
#define IAXC_CALL_STATE_FREE     0       
#define IAXC_CALL_STATE_ACTIVE   (1<<1)  
#define IAXC_CALL_STATE_OUTGOING (1<<2)  
#define IAXC_CALL_STATE_RINGING  (1<<3)  
#define IAXC_CALL_STATE_COMPLETE (1<<4)  
#define IAXC_CALL_STATE_SELECTED (1<<5)  
#define IAXC_CALL_STATE_BUSY     (1<<6)  
#define IAXC_CALL_STATE_TRANSFER (1<<7)  
#define IAXC_TEXT_TYPE_STATUS     1   

#define IAXC_TEXT_TYPE_NOTICE     2   

#define IAXC_TEXT_TYPE_ERROR      3   

#define IAXC_TEXT_TYPE_FATALERROR 4   

#define IAXC_TEXT_TYPE_IAX        5   

/* registration replys, corresponding to IAX_EVENTs*/
#define IAXC_REGISTRATION_REPLY_ACK     18   
#define IAXC_REGISTRATION_REPLY_REJ     30   
#define IAXC_REGISTRATION_REPLY_TIMEOUT 6    
#define IAXC_URL_URL              1  
#define IAXC_URL_LDCOMPLETE       2  
#define IAXC_URL_LINKURL          3  
#define IAXC_URL_LINKREJECT       4  
#define IAXC_URL_UNLINK           5  
/* The source of the video or audio data triggering the event. */
#define IAXC_SOURCE_LOCAL  1 
#define IAXC_SOURCE_REMOTE 2 
#define IAXC_EVENT_BUFSIZ 256

struct iaxc_ev_levels {
        float input;

        float output;
};

struct iaxc_ev_text {
        int type;

        int callNo; 

        char message[IAXC_EVENT_BUFSIZ];
};

struct iaxc_ev_call_state {
        int callNo;

        int state;
        
        int format;
        
        int vformat;

        char remote[IAXC_EVENT_BUFSIZ];

        char remote_name[IAXC_EVENT_BUFSIZ];
        
        char local[IAXC_EVENT_BUFSIZ];

        char local_context[IAXC_EVENT_BUFSIZ];
};

struct iaxc_netstat {
        int jitter;

        int losspct;

        int losscnt;

        int packets;

        int delay;
        
        int dropped;

        int ooo;
};

struct iaxc_ev_netstats {
        int callNo;
        
        int rtt;

        struct iaxc_netstat local;

        struct iaxc_netstat remote;
};

struct iaxc_video_stats
{
        unsigned long received_slices;  
        unsigned long acc_recv_size;    
        unsigned long sent_slices;      
        unsigned long acc_sent_size;    
        unsigned long dropped_frames;   
        unsigned long inbound_frames;   
        unsigned long outbound_frames;  
        float         avg_inbound_fps;  
        unsigned long avg_inbound_bps;  
        float         avg_outbound_fps; 
        unsigned long avg_outbound_bps; 
        struct timeval start_time;      
};

struct iaxc_ev_video_stats {
        int callNo;

        struct iaxc_video_stats stats;
};

struct iaxc_ev_url {
        int callNo;

        int type;

        char url[IAXC_EVENT_BUFSIZ];
};

struct iaxc_ev_video {
        int callNo;

        unsigned int ts;

        int format;
        
        int width;
        
        int height;

        int encoded;

        int source;

        int size;

        char *data;
};

struct iaxc_ev_audio
{
        int callNo;

        unsigned int ts;

        int format;

        int encoded;

        int source;

        int size;

        unsigned char *data;
};

struct iaxc_ev_registration {
        int id;

        int reply;

        int msgcount;
};

typedef struct iaxc_event_struct {
        struct iaxc_event_struct *next;

        int type; 
        
        union {
                struct iaxc_ev_levels           levels;
                struct iaxc_ev_text             text;       
                struct iaxc_ev_call_state       call;       
                struct iaxc_ev_netstats         netstats;   
                struct iaxc_ev_video_stats      videostats; 
                struct iaxc_ev_url              url;        
                struct iaxc_ev_video            video;      
                struct iaxc_ev_audio            audio;      
                struct iaxc_ev_registration     reg;        
        } ev;
} iaxc_event;

typedef int (*iaxc_event_callback_t)(iaxc_event e);

EXPORT void iaxc_set_event_callback(iaxc_event_callback_t func);

EXPORT int iaxc_set_event_callpost(void *handle, int id);

EXPORT void iaxc_free_event(iaxc_event *e);


/* Event Accessors */
EXPORT struct iaxc_ev_levels *iaxc_get_event_levels(iaxc_event *e);

EXPORT struct iaxc_ev_text *iaxc_get_event_text(iaxc_event *e);

EXPORT struct iaxc_ev_call_state *iaxc_get_event_state(iaxc_event *e);

EXPORT void iaxc_set_preferred_source_udp_port(int sourceUdpPort);

EXPORT short iaxc_get_bind_port();

EXPORT int iaxc_initialize(int num_calls);

EXPORT void iaxc_shutdown();

EXPORT void iaxc_set_formats(int preferred, int allowed);

EXPORT void iaxc_set_min_outgoing_framesize(int samples);

EXPORT void iaxc_set_callerid(const char * name, const char * number);

EXPORT int iaxc_start_processing_thread();

EXPORT int iaxc_stop_processing_thread();

EXPORT int iaxc_call(const char * num);

EXPORT int iaxc_call_ex(const char* num, const char* callerid_name, const char* callerid_number, int video);

EXPORT int iaxc_unregister( int id );

EXPORT int iaxc_register(const char * user, const char * pass, const char * host);

EXPORT void iaxc_send_busy_on_incoming_call(int callNo);

EXPORT void iaxc_answer_call(int callNo);

EXPORT void iaxc_blind_transfer_call(int callNo, const char * number);

EXPORT void iaxc_setup_call_transfer(int sourceCallNo, int targetCallNo);

EXPORT void iaxc_dump_all_calls(void);

EXPORT void iaxc_dump_call(void);

EXPORT void iaxc_reject_call(void);

EXPORT void iaxc_reject_call_number(int callNo);

EXPORT void iaxc_send_dtmf(char digit);

EXPORT void iaxc_send_text(const char * text);

EXPORT void iaxc_send_url(const char *url, int link); /* link == 1 ? AST_HTML_LINKURL : AST_HTML_URL */

EXPORT void iaxc_millisleep(long ms);

EXPORT void iaxc_set_silence_threshold(float thr);

EXPORT void iaxc_set_audio_output(int mode);

EXPORT int iaxc_select_call(int callNo);

EXPORT int iaxc_first_free_call();

EXPORT int iaxc_selected_call();

EXPORT int iaxc_quelch(int callNo, int MOH);

EXPORT int iaxc_unquelch(int callNo);

EXPORT int iaxc_mic_boost_get( void ) ;

EXPORT int iaxc_mic_boost_set( int enable ) ;

EXPORT char* iaxc_version(char *ver);

EXPORT void iaxc_set_jb_target_extra( long value );

EXPORT void iaxc_set_networking(iaxc_sendto_t st, iaxc_recvfrom_t rf) ;

EXPORT int iaxc_get_netstats(int call, int *rtt, struct iaxc_netstat *local, struct iaxc_netstat *remote);

#define IAXC_AD_INPUT           (1<<0) 
#define IAXC_AD_OUTPUT          (1<<1) 
#define IAXC_AD_RING            (1<<2) 
#define IAXC_AD_INPUT_DEFAULT   (1<<3) 
#define IAXC_AD_OUTPUT_DEFAULT  (1<<4) 
#define IAXC_AD_RING_DEFAULT    (1<<5) 
struct iaxc_audio_device {

        const char * name;

        long capabilities;      

        int devID;
};

EXPORT int iaxc_audio_devices_get(struct iaxc_audio_device **devs, int *nDevs, int *input, int *output, int *ring);

EXPORT int iaxc_audio_devices_set(int input, int output, int ring);

EXPORT float iaxc_input_level_get();

EXPORT float iaxc_output_level_get();

EXPORT int iaxc_input_level_set(float level);

EXPORT int iaxc_output_level_set(float level);

struct iaxc_sound {
        short   *data;           
        long    len;             
        int     malloced;        
        int     channel;         
        int     repeat;          
        long    pos;             
        int     id;              
        struct iaxc_sound *next; 
};

EXPORT int iaxc_play_sound(struct iaxc_sound *sound, int ring);

EXPORT int iaxc_stop_sound(int id);

#define IAXC_FILTER_DENOISE     (1<<0) 
#define IAXC_FILTER_AGC         (1<<1) 
#define IAXC_FILTER_ECHO        (1<<2) 
#define IAXC_FILTER_AAGC        (1<<3) 
#define IAXC_FILTER_CN          (1<<4) 
EXPORT int iaxc_get_filters(void);

EXPORT void iaxc_set_filters(int filters);

EXPORT void iaxc_set_speex_settings(int decode_enhance, float quality, int bitrate, int vbr, int abr, int complexity);

/*
 Functions and flags for setting and getting audio callback preferences
  The application can request to receive local/remote, raw/encoded audio
  through the callback mechanism. Please note that changing callback
  settings will overwrite all previous settings.
*/
#define IAXC_AUDIO_PREF_RECV_LOCAL_RAW      (1 << 0) 

#define IAXC_AUDIO_PREF_RECV_LOCAL_ENCODED  (1 << 1) 

#define IAXC_AUDIO_PREF_RECV_REMOTE_RAW     (1 << 2) 

#define IAXC_AUDIO_PREF_RECV_REMOTE_ENCODED (1 << 3) 

#define IAXC_AUDIO_PREF_SEND_DISABLE        (1 << 4) 

EXPORT unsigned int iaxc_get_audio_prefs(void);

EXPORT int iaxc_set_audio_prefs(unsigned int prefs);

/*
 * Acceptable range for video rezolution
 */
#define IAXC_VIDEO_MAX_WIDTH    704 
#define IAXC_VIDEO_MAX_HEIGHT   576 
#define IAXC_VIDEO_MIN_WIDTH    80  
#define IAXC_VIDEO_MIN_HEIGHT   60  
/*
 Video callback preferences
 The client application can obtain any combination of
 remote/local, encoded/raw video through the event callback
 mechanism
 Use these flags to specify what kind of video do you want to receive
 */

#define IAXC_VIDEO_PREF_RECV_LOCAL_RAW      (1 << 0) 

#define IAXC_VIDEO_PREF_RECV_LOCAL_ENCODED  (1 << 1) 

#define IAXC_VIDEO_PREF_RECV_REMOTE_RAW     (1 << 2) 

#define IAXC_VIDEO_PREF_RECV_REMOTE_ENCODED (1 << 3) 

#define IAXC_VIDEO_PREF_SEND_DISABLE        (1 << 4) 

#define IAXC_VIDEO_PREF_RECV_RGB32          (1 << 5)

#define IAXC_VIDEO_PREF_CAPTURE_DISABLE     (1 << 6)

EXPORT unsigned int iaxc_get_video_prefs(void);

EXPORT int iaxc_set_video_prefs(unsigned int prefs);

EXPORT void iaxc_video_format_get_cap(int *preferred, int *allowed);

EXPORT void iaxc_video_format_set_cap(int preferred, int allowed);

EXPORT void iaxc_video_format_set(int preferred, int allowed, int framerate, int bitrate, int width, int height, int fs);

EXPORT void iaxc_video_params_change(int framerate, int bitrate, int width, int height, int fs);

EXPORT int iaxc_set_holding_frame(char *);

EXPORT int iaxc_video_bypass_jitter(int);

EXPORT int iaxc_is_camera_working();

EXPORT void iaxc_YUV420_to_RGB32(int width, int height, char *src, char *dest);

#ifdef __cplusplus
}
#endif

#endif

---