opal.h

Go to the documentation of this file.

/*
 * opal.h
 *
 * "C" language interface for OPAL
 *
 * Open Phone Abstraction Library (OPAL)
 *
 * Copyright (c) 2008 Vox Lucida
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is Open Phone Abstraction Library.
 *
 * The Initial Developer of the Original Code is Vox Lucida (Robert Jongbloed)
 *
 * This code was initially written with the assisance of funding from
 * Stonevoice. http://www.stonevoice.com.
 *
 * Contributor(s): ______________________________________.
 *
 * $Revision: 20394 $
 * $Author: rjongbloed $
 * $Date: 2008-06-05 03:25:42 +0000 (Thu, 05 Jun 2008) $
 */

#ifndef __OPAL_H
#define __OPAL_H

#ifdef __cplusplus
extern "C" {
#endif

#ifdef _WIN32
  #define OPAL_EXPORT __stdcall
#else
  #define OPAL_EXPORT
#endif

typedef struct OpalHandleStruct * OpalHandle;

typedef struct OpalMessage OpalMessage;


#define OPAL_C_API_VERSION 3



OpalHandle OPAL_EXPORT OpalInitialise(unsigned * version, const char * options);

#define OPAL_INITIALISE_FUNCTION   "OpalInitialise"

typedef OpalHandle (OPAL_EXPORT *OpalInitialiseFunction)(unsigned * version, const char * options);



void OPAL_EXPORT OpalShutDown(OpalHandle opal);

#define OPAL_SHUTDOWN_FUNCTION     "OpalShutDown"

typedef void (OPAL_EXPORT *OpalShutDownFunction)(OpalHandle opal);



OpalMessage * OPAL_EXPORT OpalGetMessage(OpalHandle opal, unsigned timeout);

#define OPAL_GET_MESSAGE_FUNCTION  "OpalGetMessage"

typedef OpalMessage * (OPAL_EXPORT *OpalGetMessageFunction)(OpalHandle opal, unsigned timeout);



OpalMessage * OPAL_EXPORT OpalSendMessage(OpalHandle opal, const OpalMessage * message);

typedef OpalMessage * (OPAL_EXPORT *OpalSendMessageFunction)(OpalHandle opal, const OpalMessage * message);

#define OPAL_SEND_MESSAGE_FUNCTION "OpalSendMessage"



void OPAL_EXPORT OpalFreeMessage(OpalMessage * message);

#define OPAL_FREE_MESSAGE_FUNCTION "OpalFreeMessage"

typedef void (OPAL_EXPORT *OpalFreeMessageFunction)(OpalMessage * message);



#define OPAL_PREFIX_PC   "pc"
#define OPAL_PREFIX_H323 "h323"
#define OPAL_PREFIX_SIP  "sip"
#define OPAL_PREFIX_IAX2 "iax2"
#define OPAL_PREFIX_POTS "pots"
#define OPAL_PREFIX_PSTN "pstn"
#define OPAL_PREFIX_IVR  "ivr"

#define OPAL_PREFIX_ALL OPAL_PREFIX_PCSS " " \
                        OPAL_PREFIX_H323 " " \
                        OPAL_PREFIX_SIP  " " \
                        OPAL_PREFIX_IAX2 " " \
                        OPAL_PREFIX_POTS " " \
                        OPAL_PREFIX_PSTN " " \
                        OPAL_PREFIX_IVR


typedef enum OpalMessageType {
  OpalIndCommandError,          
  OpalCmdSetGeneralParameters,  
  OpalCmdSetProtocolParameters, 
  OpalCmdRegistration,          
  OpalIndRegistration,          
  OpalCmdSetUpCall,             
  OpalIndIncomingCall,          
  OpalCmdAnswerCall,            
  OpalCmdClearCall,             
  OpalIndAlerting,              
  OpalIndEstablished,           
  OpalIndUserInput,             
  OpalIndCallCleared,           
  OpalCmdHoldCall,              
  OpalCmdRetrieveCall,          
  OpalCmdTransferCall,          
  OpalMessageTypeCount
} OpalMessageType;


typedef struct OpalParamGeneral {
  const char * m_audioRecordDevice;   
  const char * m_audioPlayerDevice;   
  const char * m_videoInputDevice;    
  const char * m_videoOutputDevice;   
  const char * m_videoPreviewDevice;  
  const char * m_mediaOrder;          
  const char * m_mediaMask;           
  const char * m_autoRxMedia;         
  const char * m_autoTxMedia;         
  const char * m_natRouter;           
  const char * m_stunServer;          
  unsigned     m_tcpPortBase;         
  unsigned     m_tcpPortMax;          
  unsigned     m_udpPortBase;         
  unsigned     m_udpPortMax;          
  unsigned     m_rtpPortBase;         
  unsigned     m_rtpPortMax;          
  unsigned     m_rtpTypeOfService;    
  unsigned     m_rtpMaxPayloadSize;   
  unsigned     m_minAudioJitter;      
  unsigned     m_maxAudioJitter;      
  unsigned     m_silenceDetectMode;   
  unsigned     m_silenceThreshold;    
  unsigned     m_signalDeadband;      
  unsigned     m_silenceDeadband;     
  unsigned     m_silenceAdaptPeriod;  
  unsigned     m_echoCancellation;    
  unsigned     m_audioBuffers;        
} OpalParamGeneral;


typedef struct OpalParamProtocol {
  const char * m_prefix;              
  const char * m_userName;            
  const char * m_displayName;         
  const char * m_vendor;              
  const char * m_name;                
  const char * m_version;             
  unsigned     m_t35CountryCode;      
  unsigned     m_t35Extension;        
  unsigned     m_manufacturerCode;    
  const char * m_interfaceAddresses;  
} OpalParamProtocol;


typedef struct OpalParamRegistration {
  const char * m_protocol;      
  const char * m_identifier;    
  const char * m_hostName;      
  const char * m_authUserName;  
  const char * m_password;      
  const char * m_adminEntity;   
  unsigned     m_timeToLive;    
} OpalParamRegistration;


typedef struct OpalStatusRegistration {
  const char * m_protocol;    
  const char * m_serverName;  
  const char * m_error;       
} OpalStatusRegistration;


typedef struct OpalParamSetUpCall {
  const char * m_partyA;      
  const char * m_partyB;      
  const char * m_callToken;   
} OpalParamSetUpCall;


typedef struct OpalStatusIncomingCall {
  const char * m_callToken;     
  const char * m_localAddress;  
  const char * m_remoteAddress; 
} OpalStatusIncomingCall;


typedef struct OpalStatusUserInput {
  const char * m_callToken;   
  const char * m_userInput;   
  unsigned     m_duration;    
} OpalStatusUserInput;


typedef struct OpalStatusCallCleared {
  const char * m_callToken;   
  const char * m_reason;      
} OpalStatusCallCleared;


struct OpalMessage {
  OpalMessageType m_type;   
  union {
    const char *           m_commandError;       
    OpalParamGeneral       m_general;            
    OpalParamProtocol      m_protocol;           
    OpalParamRegistration  m_registrationInfo;   
    OpalStatusRegistration m_registrationStatus; 
    OpalParamSetUpCall     m_callSetUp;          
    const char *           m_callToken;          
    OpalStatusIncomingCall m_incomingCall;       
    OpalStatusUserInput    m_userInput;          
    OpalStatusCallCleared  m_callCleared;        
  } m_param;
};


#ifdef __cplusplus
};
#endif

#endif // __OPAL_H

---