Video.h

Go to the documentation of this file.

/************************************************
 *
 *  CROSSCONTROL AUX API
 *
 *  Video.h
 *
 *  Version 2.15.2.0, 2020-07-08
 *
 *  (c) CrossControl 2010-2020
 *

 *  File description: 
 *  Analog Video
 *
 *  Use the function GetVideo() to get a handle to pass on to the other functions. 
 *  Use the method Video_release(VIDEOHANDLE) to return the handle.
 *
 ************************************************/

#ifndef CC_VIDEO_H
#define CC_VIDEO_H

#include "CCAuxErrors.h"
#include "CCAuxTypes.h"
#include "CCPlatform.h"

#ifdef __cplusplus
namespace CrossControl {
#endif

  typedef void* VIDEOHANDLE;

  EXTERN_C
    CCAUXDLL_API
    VIDEOHANDLE
    CCAUXDLL_CALLING_CONV
    GetVideo(void);

  EXTERN_C
    CCAUXDLL_API
    void 
    CCAUXDLL_CALLING_CONV
    Video_release(VIDEOHANDLE);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_init(VIDEOHANDLE, uint8_t deviceNr);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_showVideo(VIDEOHANDLE, bool show);        

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_setDeInterlaceMode(VIDEOHANDLE, DeInterlaceMode mode);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_getDeInterlaceMode(VIDEOHANDLE, DeInterlaceMode* mode);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_setMirroring(VIDEOHANDLE, CCStatus mode);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_getMirroring(VIDEOHANDLE, CCStatus* mode);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_setRotation(VIDEOHANDLE, VideoRotation rotation);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_getRotation(VIDEOHANDLE, VideoRotation *rotation);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_setActiveChannel(VIDEOHANDLE, VideoChannel channel);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_getActiveChannel(VIDEOHANDLE, VideoChannel *channel);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_setColorKeys(VIDEOHANDLE, uint8_t rKey, uint8_t gKey, uint8_t bKey);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_getColorKeys(VIDEOHANDLE, uint8_t *rKey, uint8_t *gKey, uint8_t *bKey);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_setVideoArea(VIDEOHANDLE, uint16_t topLeftX, uint16_t topLeftY, uint16_t bottomRightX, uint16_t bottomRightY);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_getRawImage(VIDEOHANDLE, uint16_t *width, uint16_t *height, float32_t *frameRate);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_getVideoArea(VIDEOHANDLE, uint16_t *topLeftX, uint16_t *topLeftY, uint16_t *bottomRigthX, uint16_t *bottomRigthY);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_getVideoStandard(VIDEOHANDLE, videoStandard *standard);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_getStatus(VIDEOHANDLE, uint8_t *status);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_setScaling(VIDEOHANDLE, float32_t x, float32_t y);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_getScaling(VIDEOHANDLE, float32_t *x, float32_t *y);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_activateSnapshot(VIDEOHANDLE, bool activate);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_takeSnapshot(VIDEOHANDLE, const char_t *path, bool bInterlaced);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_takeSnapshotRaw(VIDEOHANDLE, char_t *rawImgBuffer, uint32_t rawImgBuffSize, bool bInterlaced);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_takeSnapshotBmp(VIDEOHANDLE, char_t **bmpBuffer, uint32_t *bmpBufSize, bool bInterlaced, bool bNTSCFormat);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_createBitmap(VIDEOHANDLE,
                                 char_t **bmpBuffer,
                                 uint32_t *bmpBufSize,
                                 const char_t* rawImgBuffer,
                                 uint32_t rawImgBufSize,
                                 bool bInterlaced,
                                 bool bNTSCFormat);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_freeBmpBuffer(VIDEOHANDLE, char_t *bmpBuffer);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_minimize(VIDEOHANDLE);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_restore(VIDEOHANDLE);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_setDecoderReg(VIDEOHANDLE, uint8_t decoderRegister, uint8_t registerValue);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_getDecoderReg(VIDEOHANDLE, uint8_t decoderRegister, uint8_t *registerValue);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_setCropping(VIDEOHANDLE, uint8_t top, uint8_t left, uint8_t bottom, uint8_t right);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_getCropping(VIDEOHANDLE, uint8_t *top, uint8_t *left, uint8_t *bottom, uint8_t *right);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_showFrame(VIDEOHANDLE);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_setGraphicsOverlay(VIDEOHANDLE, CCStatus mode);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Video_getGraphicsOverlay(VIDEOHANDLE, CCStatus* mode);

#ifdef __cplusplus
} /* namespace CrossControl */
#endif

#endif /* CC_VIDEO_H */