MWUSBCapture.h

/************************************************************************************************/
// MWUSBCapture.h : header file
 
// MAGEWELL PROPRIETARY INFORMATION
 
// The following license only applies to head files and library within Magewell's SDK 
// and not to Magewell's SDK as a whole. 
 
// Copyrights ? Nanjing Magewell Electronics Co., Ltd. ("Magewell") All rights reserved.
 
// Magewell grands to any person who obtains the copy of Magewell's head files and library 
// the rights,including without limitation, to use on the condition that the following terms are met:
// - The above copyright notice shall be retained in any circumstances.
// -The following disclaimer shall be included in the software and documentation and/or 
// other materials provided for the purpose of publish, distribution or sublicense.
 
// THE SOFTWARE IS PROVIDED BY MAGEWELL "AS IS" AND ANY EXPRESS, INCLUDING BUT NOT LIMITED TO,
// THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
// IN NO EVENT SHALL MAGEWELL BE LIABLE 
 
// FOR ANY CLAIM, DIRECT OR INDIRECT DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT,
// TORT OR OTHERWISE, ARISING IN ANY WAY OF USING THE SOFTWARE.
 
// CONTACT INFORMATION:
// SDK@magewell.net
// http://www.magewell.com/
//
/************************************************************************************************/
#ifndef _MWUSB_CAPTURE_H_
#define _MWUSB_CAPTURE_H_
 
#ifdef LIBMWCAPTURE_EXPORTS
#define LIBMWCAPTURE_API __declspec(dllexport)
#elif LIBMWCAPTURE_DLL
#define LIBMWCAPTURE_API __declspec(dllimport)
#else
#define LIBMWCAPTURE_API 
#endif
 
#ifdef _WIN32
#include <Windows.h>
#endif
#include <stdint.h>
#include "MWUSBCaptureExtension.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBRegisterHotPlug(
    LPFN_HOT_PLUG_CALLBACK lpfnCallback,
    void *                 pParam
    );
 
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBUnRegisterHotPlug(
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBSetNotifyEnable(
    HUSBCHANNEL                     hChannel,
    MWCAP_NOTIFY_ENABLE *           pNotify
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBGetNotifyStatus(
    HUSBCHANNEL                     hChannel,
    uint64_t *                      pullStatusBit
    );
 
// * @ingroup group_functions_usbcapture
// * @brief Erases firmware data from USB device
// * @param[in] hChannel                    Channel handle of USB device
// * @param[in] cbOffset                    Address offset
// * @param[in] cbErase                 Erased size
//@return Returns MW_SUCCEED if succeeded, otherwise returns MW_FAILED or MW_INVALID_PARAMS
//*/
//MW_RESULT
//LIBMWCAPTURE_API
//MWUSBSetFirmwareErase(
//  HUSBCHANNEL                     hChannel,
//  uint32_t                        cbOffset,
//  uint32_t                        cbErase
//  );
//
// * @ingroup group_functions_usbcapture
// * @brief Gets read address of USB device firmware.
// * @param[in] hChannel                    Channel handle of USB device
// * @param[out] pdwAddress             Read address of firmware
//@return Returns MW_SUCCEED if succeeded, otherwise returns MW_FAILED or MW_INVALID_PARAMS
//*/
//MW_RESULT
//LIBMWCAPTURE_API
//MWUSBGetFirmwareReadAddress(
//  HUSBCHANNEL                     hChannel,
//  uint32_t *                      pdwAddress
//  );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBGetEDIDLoopThrough(
    HUSBCHANNEL                     hChannel,
    char *                          pbyEDID,
    uint32_t *                      pcbEDID
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBGetLoopThroughValid(
    HUSBCHANNEL                     hChannel,
    bool_t *                        pbValid
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBGetAudioVolume(
    HUSBCHANNEL                     hChannel,
    MWCAP_USB_AUDIO_NODE            audioNode,
    MWCAP_AUDIO_VOLUME*             pVolume
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBSetAudioVolume(
    HUSBCHANNEL                     hChannel,
    MWCAP_USB_AUDIO_NODE            audioNode,
    MWCAP_AUDIO_VOLUME*             pVolume
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBGetVideoCaptureConnectionFormat(
    HUSBCHANNEL                     hChannel,
    MWCAP_VIDEO_CONNECTION_FORMAT*  pConnFormat
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBGetVideoCaptureProcessSettings(
    HUSBCHANNEL                     hChannel,
    MWCAP_VIDEO_PROCESS_SETTINGS*   pProcSettings
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBSetVideoCaptureProcessSettings(
    HUSBCHANNEL                     hChannel,
    MWCAP_VIDEO_PROCESS_SETTINGS*   pProcSettings
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBGetVideoOutputFOURCC(
    HUSBCHANNEL                     hChannel,
    MWCAP_VIDEO_OUTPUT_FOURCC*      pOutputFourCC
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBSetVideoOutputFOURCC(
    HUSBCHANNEL                     hChannel,
    MWCAP_VIDEO_OUTPUT_FOURCC*      pOutputFourCC
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBGetVideoOutputFrameSize(
    HUSBCHANNEL                         hChannel,
    MWCAP_VIDEO_OUTPUT_FRAME_SIZE*      pFrameSize
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBSetVideoOutputFrameSize(
    HUSBCHANNEL                         hChannel,
    MWCAP_VIDEO_OUTPUT_FRAME_SIZE*      pFrameSize
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBGetVideoOutputFrameInterval(
    HUSBCHANNEL                             hChannel,
    MWCAP_VIDEO_OUTPUT_FRAME_INTERVAL*      pFrameInterval
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBSetVideoOutputFrameInterval(
    HUSBCHANNEL                             hChannel,
    MWCAP_VIDEO_OUTPUT_FRAME_INTERVAL*      pFrameInterval
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBGetStatusImageMode(
    HUSBCHANNEL                     hChannel,
    MWCAP_STATUS_IMAGE_MODE *       pImageMode
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBSetStatusImageMode(
    HUSBCHANNEL                     hChannel,
    MWCAP_STATUS_IMAGE_MODE *       pImageMode
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBGetDeviceNameMode(
    HUSBCHANNEL                     hChannel,
    MWCAP_DEVICE_NAME_MODE *        pNameMode
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBSetDeviceNameMode(
    HUSBCHANNEL                     hChannel,
    MWCAP_DEVICE_NAME_MODE *        pNameMode
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBSaveOptions(
    HUSBCHANNEL     hChannel 
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBLoadOptions(
    HUSBCHANNEL     hChannel
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBResetOptions(
    HUSBCHANNEL     hChannel
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBGetVideoAutoHAlign(
    HUSBCHANNEL                     hChannel,
    bool_t *                        pbAutoHAlign
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBSetVideoAutoHAlign(
    HUSBCHANNEL                     hChannel,
    bool_t                          pbAutoHAlign
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBGetVideoSamplingPhase(
    HUSBCHANNEL                     hChannel,
    uint8_t *                       puSamplingPhase
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBSetVideoSamplingPhase(
    HUSBCHANNEL                     hChannel,
    uint8_t*                        puSamplingPhase
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBGetVideoSamplingPhaseAutoAdjust(
    HUSBCHANNEL                     hChannel,
    bool_t *                        pbAutoSamplingPhase
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBSetVideoSamplingPhaseAutoAdjust(
    HUSBCHANNEL                     hChannel,
    bool_t *                        pbAutoSamplingPhase
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBSetVideoTiming(
    HUSBCHANNEL                     hChannel,
    MWCAP_VIDEO_TIMING *            pTiming
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBGetPreferredVideoTimings(
    HUSBCHANNEL                     hChannel,
    MWCAP_VIDEO_TIMING_ARRAY *      paTimings
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBGetCustomVideoTimings(
    HUSBCHANNEL                         hChannel,
    MWCAP_VIDEO_CUSTOM_TIMING_ARRAY *   paCustomTimings
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBSetCustomVideoTimings(
    HUSBCHANNEL                         hChannel,
    MWCAP_VIDEO_CUSTOM_TIMING_ARRAY *   paCustomTimings
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBSetCustomVideoTiming(
    HUSBCHANNEL                         hChannel,
    MWCAP_VIDEO_CUSTOM_TIMING *         pCustomTiming
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBGetCustomVideoResolutions(
    HUSBCHANNEL                                     hChannel,
    MWCAP_VIDEO_CUSTOM_RESOLUTION_ARRAY *           paCustomResolutions
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBSetCustomVideoResolutions(
    HUSBCHANNEL                                     hChannel,
    MWCAP_VIDEO_CUSTOM_RESOLUTION_ARRAY *           paCustomResolutions
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBGetExtensionSupported(
    HUSBCHANNEL             hChannel,
    uint32_t *              pdwFlag
    );
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBGetInputSourceScanState(HUSBCHANNEL hChannel, bool_t * pbScanning);
MW_RESULT
LIBMWCAPTURE_API
MWUSBGetEDIDMode(HUSBCHANNEL hChannel, MWCAP_EDID_MODE * pMode);
MW_RESULT
LIBMWCAPTURE_API
MWUSBSetEDIDMode(HUSBCHANNEL hChannel, MWCAP_EDID_MODE mode);
 
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBGetVideoCaptureSupportFrameRate(
    HCHANNEL                    hChannel,
    MWCAP_VIDEO_FRAMERATE*      pFramerate,
    int*                        nCount
);
 
 
MW_RESULT
LIBMWCAPTURE_API
MWUSBGetVideoCaptureSupportFrameRateEx(
    HCHANNEL                    hChannel,
    MWCAP_VIDEO_FRAMERATE_EX*   pFramerate,
    int*                        nCount
);
 
 
 
#ifdef __cplusplus
}
#endif
 
 
#endif //_MWUSB_CAPTURE_H_