oocapability.h

来自「一个非常美妙的proxy。功能强大。基于sip的协议。如果还要的话」· C头文件 代码 · 共 710 行 · 第 1/2 页

 */
EXTERN int ooCapabilityAddH263VideoCapability(struct OOH323CallData *call, 
                               unsigned sqcifMPI, unsigned qcifMPI, 
                               unsigned cifMPI, unsigned cif4MPI, 
                               unsigned cif16MPI, unsigned maxBitRate, int dir,
                               cb_StartReceiveChannel startReceiveChannel,
                               cb_StartTransmitChannel startTransmitChannel,
                               cb_StopReceiveChannel stopReceiveChannel,
                               cb_StopTransmitChannel stopTransmitChannel, 
                               OOBOOL remote);


/**
 * This function is an helper function to ooCapabilityAddH263VideoCapability.
 * @param call                 Handle to a call. If this is not Null, then 
 *                             capability is added to call's remote enpoint 
 *                             capability list, else it is added to local H323 
 *                             endpoint list.
 * @param sqcifMPI             Minimum picture interval for encoding/decoding 
 *                             of SQCIF pictures.
 * @param qcifMPI              Minimum picture interval for encoding/decoding 
 *                             of QCIF pictures.
 * @param cifMPI               Minimum picture interval for encoding/decoding 
 *                             of CIF pictures.
 * @param cif4MPI              Minimum picture interval for encoding/decoding 
 *                             of CIF4 pictures.
 * @param cif16MPI             Minimum picture interval for encoding/decoding 
 *                             of CIF16 pictures.
 * @param maxBitRate           Maximum bit rate in units of 100 bits/s at
 *                             which a transmitter can transmit video or a 
 *                             receiver can receive video.
 * @param dir                  Direction of capability.OORX, OOTX, OORXANDTX
 * @param startReceiveChannel  Callback function to start receive channel.
 * @param startTransmitChannel Callback function to start transmit channel.
 * @param stopReceiveChannel   Callback function to stop receive channel.
 * @param stopTransmitChannel  Callback function to stop transmit channel.
 * @param remote               TRUE, if adding call's remote capabilities.
 *
 * @return                     OO_OK, on success. OO_FAILED, on failure. 
 */
int ooCapabilityAddH263VideoCapability_helper(struct OOH323CallData *call, 
                              unsigned sqcifMPI, unsigned qcifMPI, 
                              unsigned cifMPI, unsigned cif4MPI, 
                              unsigned cif16MPI, unsigned maxBitRate, int dir, 
                              cb_StartReceiveChannel startReceiveChannel,
                              cb_StartTransmitChannel startTransmitChannel,
                              cb_StopReceiveChannel stopReceiveChannel,
                              cb_StopTransmitChannel stopTransmitChannel, 
                              OOBOOL remote);

/**
 * This function is used to add a audio capability to calls remote  
 * capability list.
 * @param call                Handle to the call.
 * @param audioCap            Handle to the remote endpoint's audio capability.
 * @param dir                 Direction in which capability is supported by 
 *                            remote endpoint.
 *
 * @return                    OO_OK, on success. OO_FAILED, otherwise.
 */
int ooAddRemoteAudioCapability(struct OOH323CallData *call,
                               H245AudioCapability *audioCap, int dir);


/**
 * This function is used to add a capability to call's remote  capability list.
 * The capabilities to be added are extracted from received TCS message.
 * @param call           Handle to the call.
 * @param cap            Handle to the remote endpoint's H245 capability.
 *
 * @return               OO_OK, on success. OO_FAILED, otherwise.
 */
int ooAddRemoteCapability(struct OOH323CallData *call, H245Capability *cap);

/**
 * This function is used to update joint capabilities for call. It checks
 * whether remote capability can be supported by local capabilities for the
 * call and if supported makes entry into the joint capability list for the 
 * call.
 * @param call           Handle to the call
 * @param cap            Remote cap which will be tested for compatibility.
 *
 * @return               returns OO_OK, if updated else OO_FAILED;  
 */
EXTERN int ooCapabilityUpdateJointCapabilities
   (struct OOH323CallData* call, H245Capability *cap);


/**
 * This function is used to update joint video capabilities for call. It checks
 * whether remote capability can be supported by local capabilities for the
 * call and if supported makes entry into the joint capability list for the 
 * call.
 * @param call           Handle to the call
 * @param videoCap       Remote video capability which will be tested for 
 *                       compatibility.
 * @param dir            Direction of the capability
 *
 * @return               returns OO_OK, if updated else OO_FAILED;  
 */
EXTERN int ooCapabilityUpdateJointCapabilitiesVideo
   (struct OOH323CallData *call, H245VideoCapability *videoCap, int dir);


/**
 * This function is used to update joint video H263 capabilities for call. It 
 * checks whether remote capability can be supported by local capabilities for 
 * the call and if supported makes entry into the joint capability list for the
 * call.
 * @param call           Handle to the call
 * @param pH263Cap       Remote H263 video capability which will be tested for 
 *                       compatibility.
 * @param dir            Direction of the H263 capability
 *
 * @return               returns OO_OK, if updated else OO_FAILED;  
 */
EXTERN int ooCapabilityUpdateJointCapabilitiesVideoH263
   (struct OOH323CallData *call, H245H263VideoCapability *pH263Cap, int dir);


/**
 * This function is used to test whether the endpoint capability in the 
 * specified direction can be supported by the audio capability.
 * @param call               Handle to the call.
 * @param epCap              Endpoint capability.
 * @param dataType           Data type with which compatibility has to 
 *                           be tested.
 * @param dir                Direction indicating whether endpoint capability
 *                           will be used for transmission or reception.
 *
 * @return                   TRUE, if compatible. FALSE, otherwise. 
 */

ASN1BOOL ooCapabilityCheckCompatibility(struct OOH323CallData *call, 
				ooH323EpCapability *epCap, 
				H245DataType *dataType, int dir);


/**
 * This function is used to create a audio capability structure using the
 * capability type.
 * @param epCap       Capability.
 * @param pctxt       Handle to OOCTXT which will be used to allocate memory 
 *                    for new audio capability.
 * @param dir         Direction in which the newly created capability will be 
 *                    used.
 *
 * @return            Newly created audio capability on success, NULL on 
 *                    failure.
 */
struct H245AudioCapability* ooCapabilityCreateAudioCapability 
(ooH323EpCapability* epCap, OOCTXT *pctxt, int dir);

/**
 * This function is used to create a video capability structure using the
 * capability type.
 * @param epCap       Capability.
 * @param pctxt       Handle to OOCTXT which will be used to allocate memory 
 *                    for new video capability.
 * @param dir         Direction in which the newly created capability will be 
 *                    used.
 *
 * @return            Newly created video capability on success, NULL on 
 *                    failure.
 */
struct H245VideoCapability* ooCapabilityCreateVideoCapability
   (ooH323EpCapability *epCap, OOCTXT *pctxt, int dir);


/**
 * This function is used to create a dtmf capability which can be added to
 * a TCS message.
 * @param cap         Type of dtmf capability to be created.
 * @param pctxt       Pointer to OOCTXT structure to be used for memory 
 *                    allocation.
 *
 * @return            Pointer to the created DTMF capability, NULL in case of
 *                    failure.
 */
void * ooCapabilityCreateDTMFCapability(int cap, OOCTXT *pctxt);


/**
 * This function is used to create a GSM Full Rate capability structure.
 * @param epCap       Handle to the endpoint capability.
 * @param pctxt       Handle to OOCTXT which will be used to allocate memory
 *                    for new audio capability.
 * @param dir         Direction for the newly created capability.
 *
 * @return            Newly created audio capability on success, NULL on 
 *                    failure.
 */
struct H245AudioCapability* ooCapabilityCreateGSMFullRateCapability
   (ooH323EpCapability *epCap, OOCTXT* pctxt, int dir);

/**
 * This function is used to create a simple(g711, g729) audio capability 
 * structure.
 * @param epCap       Handle to the endpoint capability
 * @param pctxt       Handle to OOCTXT which will be used to allocate memory 
 *                    for new audio capability.
 * @param dir         Direction in which the newly created capability will be 
 *                    used.
 *
 * @return            Newly created audio capability on success, NULL on 
 *                    failure.
 */
struct H245AudioCapability* ooCapabilityCreateSimpleCapability
   (ooH323EpCapability *epCap, OOCTXT* pctxt, int dir);


/**
 * This function is used to create a H263 video capability 
 * structure.
 * @param epCap       Handle to the endpoint capability
 * @param pctxt       Handle to OOCTXT which will be used to allocate memory 
 *                    for new video capability.
 * @param dir         Direction in which the newly created capability will be 
 *                    used.
 *
 * @return            Newly created video capability on success, NULL on 
 *                    failure.
 */
struct H245VideoCapability* ooCapabilityCreateH263VideoCapability
(ooH323EpCapability *epCap, OOCTXT* pctxt, int dir);


/**
 * This function is used to determine whether a particular capability
 * can be supported by the endpoint.
 * @param call       Handle to the call.
 * @param audioCap   Handle to the audio capability.
 * @param dir        Direction in which support is desired. 
 *
 * @return          Handle to the copyof capability which supports audioCap, 
 *                  Null if none found
 */
ooH323EpCapability* ooIsAudioDataTypeSupported
(struct OOH323CallData *call, H245AudioCapability* audioCap, int dir);

/**
 * This function is used to determine whether a particular video capability
 * can be supported by the endpoint.
 * @param call       Handle to the call.
 * @param pVideoCap  Handle to the  video capability.
 * @param dir        Direction in which support is desired. 
 *
 * @return          Handle to the copy of capability which supports video 
 *                  capability, Null if none found
 */
ooH323EpCapability* ooIsVideoDataTypeSupported
   (struct OOH323CallData *call, H245VideoCapability* pVideoCap, int dir);

/**
 * This function is used to determine whether a particular H263 capability
 * can be supported by the endpoint.
 * @param call       Handle to the call.
 * @param pH263Cap   Handle to the H263 video capability.
 * @param dir        Direction in which support is desired. 
 * @param picFormat  Picture type(cif, qcif etc.)
 *
 * @return          Handle to the copy of capability which supports H263 
 *                  capability, Null if none found
 */
ooH323EpCapability* ooIsVideoDataTypeH263Supported
   (struct OOH323CallData *call, H245H263VideoCapability* pH263Cap, int dir, 
    OOPictureFormat picFormat);

/**
 * This function is used to determine whether a particular capability type
 * can be supported by the endpoint.
 * @param call       Handle to the call.
 * @param data       Handle to the capability type.
 * @param dir        Direction in which support is desired. 
 *
 * @return          Handle to the copy of capability which supports specified 
 *                  capability type, Null if none found
 */
ooH323EpCapability* ooIsDataTypeSupported
(struct OOH323CallData *call, H245DataType *data, int dir);

/**
 * This function is used to clear the capability preference order.
 * @param call      Handle to call, if capability preference order for call
 *                  has to be cleared, NULL for endpoint.
 *
 * @return          OO_OK, on success. OO_FAILED, on failure
 */
EXTERN  int ooResetCapPrefs(struct OOH323CallData *call);

/**
 * This function is used to remove a particular capability from preference
 * list.
 * @param call     Handle to call, if call's preference list has to be modified
 *                 else NULL, to modify endpoint's preference list.
 * @param cap      Capability to be removed
 *
 * @return         OO_OK, on success. OO_FAILED, otherwise.
 */
EXTERN  int ooRemoveCapFromCapPrefs(struct OOH323CallData *call, int cap);

/**
 * This function is used to append a particular capability to preference
 * list.
 * @param call     Handle to call, if call's preference list has to be modified
 *                 else NULL, to modify endpoint's preference list.
 * @param cap      Capability to be appended.
 *
 * @return         OO_OK, on success. OO_FAILED, otherwise.
 */
EXTERN int ooAppendCapToCapPrefs(struct OOH323CallData *call, int cap);

/**
 * This function is used to change preference order of a particular capability 
 * in the preference list.
 * @param call     Handle to call, if call's preference list has to be modified
 *                 else NULL, to modify endpoint's preference list.
 * @param cap      Capability concerned
 * @param pos      New position in the preference order
 *
 * @return         OO_OK, on success. OO_FAILED, otherwise.
 */
EXTERN int ooChangeCapPrefOrder(struct OOH323CallData *call, int cap, int pos);

/**
 * This function is used to preppend a particular capability to preference
 * list.
 * @param call     Handle to call, if call's preference list has to be modified
 *                 else NULL, to modify endpoint's preference list.
 * @param cap      Capability to be preppended.
 *
 * @return         OO_OK, on success. OO_FAILED, otherwise.
 */
EXTERN int ooPreppendCapToCapPrefs(struct OOH323CallData *call, int cap);

/**
 * This function is used to retrieve the text description for a capability
 * type.
 * @param cap     Capability
 * @return        The text description string.
 */
EXTERN const char* ooGetCapTypeText (OOCapabilities cap);


/** 
 * @} 
 */
#ifdef __cplusplus
}
#endif

#endif