CCAux  2.15.2.0
CCAux API reference
Video.h
Go to the documentation of this file.
1 /************************************************
2  *
3  * CROSSCONTROL AUX API
4  *
5  * Video.h
6  *
7  * Version 2.15.2.0, 2020-07-08
8  *
9  * (c) CrossControl 2010-2020
10  *
11 
12  * File description:
13  * Analog Video
14  *
15  * Use the function GetVideo() to get a handle to pass on to the other functions.
16  * Use the method Video_release(VIDEOHANDLE) to return the handle.
17  *
18  ************************************************/
19 
20 #ifndef CC_VIDEO_H
21 #define CC_VIDEO_H
22 
23 #include "CCAuxErrors.h"
24 #include "CCAuxTypes.h"
25 #include "CCPlatform.h"
26 
27 #ifdef __cplusplus
28 namespace CrossControl {
29 #endif
30 
31  typedef void* VIDEOHANDLE;
32 
43  EXTERN_C
44  CCAUXDLL_API
46  CCAUXDLL_CALLING_CONV
47  GetVideo(void);
48 
56  EXTERN_C
57  CCAUXDLL_API
58  void
59  CCAUXDLL_CALLING_CONV
61 
74  EXTERN_C
75  CCAUXDLL_API
76  eErr
77  CCAUXDLL_CALLING_CONV
78  Video_init(VIDEOHANDLE, uint8_t deviceNr);
79 
90  EXTERN_C
91  CCAUXDLL_API
92  eErr
93  CCAUXDLL_CALLING_CONV
94  Video_showVideo(VIDEOHANDLE, bool show);
95 
105  EXTERN_C
106  CCAUXDLL_API
107  eErr
108  CCAUXDLL_CALLING_CONV
110 
120  EXTERN_C
121  CCAUXDLL_API
122  eErr
123  CCAUXDLL_CALLING_CONV
125 
135  EXTERN_C
136  CCAUXDLL_API
137  eErr
138  CCAUXDLL_CALLING_CONV
140 
150  EXTERN_C
151  CCAUXDLL_API
152  eErr
153  CCAUXDLL_CALLING_CONV
155 
165  EXTERN_C
166  CCAUXDLL_API
167  eErr
168  CCAUXDLL_CALLING_CONV
170 
180  EXTERN_C
181  CCAUXDLL_API
182  eErr
183  CCAUXDLL_CALLING_CONV
185 
195  EXTERN_C
196  CCAUXDLL_API
197  eErr
198  CCAUXDLL_CALLING_CONV
200 
210  EXTERN_C
211  CCAUXDLL_API
212  eErr
213  CCAUXDLL_CALLING_CONV
215 
229  EXTERN_C
230  CCAUXDLL_API
231  eErr
232  CCAUXDLL_CALLING_CONV
234 
247  EXTERN_C
248  CCAUXDLL_API
249  eErr
250  CCAUXDLL_CALLING_CONV
251  Video_getColorKeys(VIDEOHANDLE, uint8_t *rKey, uint8_t *gKey, uint8_t *bKey);
252 
265  EXTERN_C
266  CCAUXDLL_API
267  eErr
268  CCAUXDLL_CALLING_CONV
269  Video_setVideoArea(VIDEOHANDLE, uint16_t topLeftX, uint16_t topLeftY, uint16_t bottomRightX, uint16_t bottomRightY);
270 
283  EXTERN_C
284  CCAUXDLL_API
285  eErr
286  CCAUXDLL_CALLING_CONV
287  Video_getRawImage(VIDEOHANDLE, uint16_t *width, uint16_t *height, float32_t *frameRate);
288 
301  EXTERN_C
302  CCAUXDLL_API
303  eErr
304  CCAUXDLL_CALLING_CONV
305  Video_getVideoArea(VIDEOHANDLE, uint16_t *topLeftX, uint16_t *topLeftY, uint16_t *bottomRigthX, uint16_t *bottomRigthY);
306 
317  EXTERN_C
318  CCAUXDLL_API
319  eErr
320  CCAUXDLL_CALLING_CONV
322 
343  EXTERN_C
344  CCAUXDLL_API
345  eErr
346  CCAUXDLL_CALLING_CONV
348 
361  EXTERN_C
362  CCAUXDLL_API
363  eErr
364  CCAUXDLL_CALLING_CONV
366 
379  EXTERN_C
380  CCAUXDLL_API
381  eErr
382  CCAUXDLL_CALLING_CONV
384 
397  EXTERN_C
398  CCAUXDLL_API
399  eErr
400  CCAUXDLL_CALLING_CONV
401  Video_activateSnapshot(VIDEOHANDLE, bool activate);
402 
416  EXTERN_C
417  CCAUXDLL_API
418  eErr
419  CCAUXDLL_CALLING_CONV
420  Video_takeSnapshot(VIDEOHANDLE, const char_t *path, bool bInterlaced);
421 
441  EXTERN_C
442  CCAUXDLL_API
443  eErr
444  CCAUXDLL_CALLING_CONV
445  Video_takeSnapshotRaw(VIDEOHANDLE, char_t *rawImgBuffer, uint32_t rawImgBuffSize, bool bInterlaced);
446 
466  EXTERN_C
467  CCAUXDLL_API
468  eErr
469  CCAUXDLL_CALLING_CONV
470  Video_takeSnapshotBmp(VIDEOHANDLE, char_t **bmpBuffer, uint32_t *bmpBufSize, bool bInterlaced, bool bNTSCFormat);
471 
490  EXTERN_C
491  CCAUXDLL_API
492  eErr
493  CCAUXDLL_CALLING_CONV
495  char_t **bmpBuffer,
496  uint32_t *bmpBufSize,
497  const char_t* rawImgBuffer,
498  uint32_t rawImgBufSize,
499  bool bInterlaced,
500  bool bNTSCFormat);
501 
511  EXTERN_C
512  CCAUXDLL_API
513  eErr
514  CCAUXDLL_CALLING_CONV
516 
525  EXTERN_C
526  CCAUXDLL_API
527  eErr
528  CCAUXDLL_CALLING_CONV
530 
539  EXTERN_C
540  CCAUXDLL_API
541  eErr
542  CCAUXDLL_CALLING_CONV
544 
557  EXTERN_C
558  CCAUXDLL_API
559  eErr
560  CCAUXDLL_CALLING_CONV
561  Video_setDecoderReg(VIDEOHANDLE, uint8_t decoderRegister, uint8_t registerValue);
562 
575  EXTERN_C
576  CCAUXDLL_API
577  eErr
578  CCAUXDLL_CALLING_CONV
579  Video_getDecoderReg(VIDEOHANDLE, uint8_t decoderRegister, uint8_t *registerValue);
580 
598  EXTERN_C
599  CCAUXDLL_API
600  eErr
601  CCAUXDLL_CALLING_CONV
602  Video_setCropping(VIDEOHANDLE, uint8_t top, uint8_t left, uint8_t bottom, uint8_t right);
603 
616  EXTERN_C
617  CCAUXDLL_API
618  eErr
619  CCAUXDLL_CALLING_CONV
620  Video_getCropping(VIDEOHANDLE, uint8_t *top, uint8_t *left, uint8_t *bottom, uint8_t *right);
621 
629  EXTERN_C
630  CCAUXDLL_API
631  eErr
632  CCAUXDLL_CALLING_CONV
634 
644  EXTERN_C
645  CCAUXDLL_API
646  eErr
647  CCAUXDLL_CALLING_CONV
649 
659  EXTERN_C
660  CCAUXDLL_API
661  eErr
662  CCAUXDLL_CALLING_CONV
664 
665 #ifdef __cplusplus
666 } /* namespace CrossControl */
667 #endif
668 
669 #endif /* CC_VIDEO_H */
670 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Video_getDecoderReg(VIDEOHANDLE, uint8_t decoderRegister, uint8_t *registerValue)
eErr
Definition: CCAuxTypes.h:159
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Video_setDeInterlaceMode(VIDEOHANDLE, DeInterlaceMode mode)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Video_setActiveChannel(VIDEOHANDLE, VideoChannel channel)
CCStatus
Definition: CCAuxTypes.h:150
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_getVideoStandard(VIDEOHANDLE, videoStandard *standard)
float float32_t
Definition: CCAuxTypes.h:25
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_getScaling(VIDEOHANDLE, float32_t *x, float32_t *y)
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_takeSnapshotBmp(VIDEOHANDLE, char_t **bmpBuffer, uint32_t *bmpBufSize, bool bInterlaced, bool bNTSCFormat)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Video_getGraphicsOverlay(VIDEOHANDLE, CCStatus *mode)
Definition: About.h:30
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_getActiveChannel(VIDEOHANDLE, VideoChannel *channel)
unsigned short uint16_t
Definition: CCAuxTypes.h:48
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Video_setGraphicsOverlay(VIDEOHANDLE, CCStatus mode)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Video_showFrame(VIDEOHANDLE)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Video_init(VIDEOHANDLE, uint8_t deviceNr)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Video_getRotation(VIDEOHANDLE, VideoRotation *rotation)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Video_setMirroring(VIDEOHANDLE, CCStatus mode)
EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV Video_release(VIDEOHANDLE)
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)
unsigned int uint32_t
Definition: CCAuxTypes.h:49
DeInterlaceMode
Definition: CCAuxTypes.h:202
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_restore(VIDEOHANDLE)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Video_getStatus(VIDEOHANDLE, uint8_t *status)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Video_freeBmpBuffer(VIDEOHANDLE, char_t *bmpBuffer)
unsigned char uint8_t
Definition: CCAuxTypes.h:47
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Video_activateSnapshot(VIDEOHANDLE, bool activate)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Video_setRotation(VIDEOHANDLE, VideoRotation rotation)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Video_getCropping(VIDEOHANDLE, uint8_t *top, uint8_t *left, uint8_t *bottom, uint8_t *right)
VideoChannel
Definition: CCAuxTypes.h:212
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Video_minimize(VIDEOHANDLE)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Video_getDeInterlaceMode(VIDEOHANDLE, DeInterlaceMode *mode)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Video_getMirroring(VIDEOHANDLE, CCStatus *mode)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Video_showVideo(VIDEOHANDLE, bool show)
EXTERN_C CCAUXDLL_API VIDEOHANDLE CCAUXDLL_CALLING_CONV GetVideo(void)
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_setColorKeys(VIDEOHANDLE, uint8_t rKey, uint8_t gKey, uint8_t bKey)
videoStandard
Definition: CCAuxTypes.h:247
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Video_takeSnapshotRaw(VIDEOHANDLE, char_t *rawImgBuffer, uint32_t rawImgBuffSize, bool bInterlaced)
void * VIDEOHANDLE
Definition: Video.h:31
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_setScaling(VIDEOHANDLE, float32_t x, float32_t y)
VideoRotation
Definition: CCAuxTypes.h:258
char char_t
Definition: CCAuxTypes.h:27