CCAux 2.20.0.0
CCAux API reference
Video.h
Go to the documentation of this file.
1
2/*
3 * Copyright (C) 2023 CrossControl AB
4 *
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; with
8 * version 2.1 of the License.
9 */
10/*
11 * File description:
12 * Analog Video
13 *
14 * Use the function GetVideo() to get a handle to pass on to the other functions.
15 * Use the method Video_release(VIDEOHANDLE) to return the handle.
16 *
17 ************************************************/
18
19#ifndef CC_VIDEO_H
20#define CC_VIDEO_H
21
22#include "CCAuxErrors.h"
23#include "CCAuxTypes.h"
24#include "CCPlatform.h"
25
26#ifdef __cplusplus
27namespace CrossControl
28{
29#endif
30
31typedef void *VIDEOHANDLE;
32
49EXTERN_C
50CCAUXDLL_API
52CCAUXDLL_CALLING_CONV
54
62EXTERN_C
63CCAUXDLL_API
64void CCAUXDLL_CALLING_CONV Video_release(VIDEOHANDLE);
65
78EXTERN_C
79CCAUXDLL_API
80eErr CCAUXDLL_CALLING_CONV Video_init(VIDEOHANDLE, uint8_t deviceNr);
81
92EXTERN_C
93CCAUXDLL_API
94eErr CCAUXDLL_CALLING_CONV Video_showVideo(VIDEOHANDLE, bool show);
95
105EXTERN_C
106CCAUXDLL_API
108
118EXTERN_C
119CCAUXDLL_API
121
131EXTERN_C
132CCAUXDLL_API
133eErr CCAUXDLL_CALLING_CONV Video_setMirroring(VIDEOHANDLE, CCStatus mode);
134
144EXTERN_C
145CCAUXDLL_API
146eErr CCAUXDLL_CALLING_CONV Video_getMirroring(VIDEOHANDLE, CCStatus *mode);
147
157EXTERN_C
158CCAUXDLL_API
159eErr CCAUXDLL_CALLING_CONV Video_setRotation(VIDEOHANDLE, VideoRotation rotation);
160
170EXTERN_C
171CCAUXDLL_API
172eErr CCAUXDLL_CALLING_CONV Video_getRotation(VIDEOHANDLE, VideoRotation *rotation);
173
183EXTERN_C
184CCAUXDLL_API
185eErr CCAUXDLL_CALLING_CONV Video_setActiveChannel(VIDEOHANDLE, VideoChannel channel);
186
196EXTERN_C
197CCAUXDLL_API
198eErr CCAUXDLL_CALLING_CONV Video_getActiveChannel(VIDEOHANDLE, VideoChannel *channel);
199
213EXTERN_C
214CCAUXDLL_API
215eErr CCAUXDLL_CALLING_CONV Video_setColorKeys(VIDEOHANDLE, uint8_t rKey, uint8_t gKey, uint8_t bKey);
216
229EXTERN_C
230CCAUXDLL_API
231eErr CCAUXDLL_CALLING_CONV Video_getColorKeys(VIDEOHANDLE, uint8_t *rKey, uint8_t *gKey, uint8_t *bKey);
232
245EXTERN_C
246CCAUXDLL_API
247eErr CCAUXDLL_CALLING_CONV Video_setVideoArea(VIDEOHANDLE, uint16_t topLeftX, uint16_t topLeftY, uint16_t bottomRightX,
248 uint16_t bottomRightY);
249
262EXTERN_C
263CCAUXDLL_API
264eErr CCAUXDLL_CALLING_CONV Video_getRawImage(VIDEOHANDLE, uint16_t *width, uint16_t *height, float32_t *frameRate);
265
278EXTERN_C
279CCAUXDLL_API
280eErr CCAUXDLL_CALLING_CONV Video_getVideoArea(VIDEOHANDLE, uint16_t *topLeftX, uint16_t *topLeftY,
281 uint16_t *bottomRigthX, uint16_t *bottomRigthY);
282
293EXTERN_C
294CCAUXDLL_API
295eErr CCAUXDLL_CALLING_CONV Video_getVideoStandard(VIDEOHANDLE, videoStandard *standard);
296
317EXTERN_C
318CCAUXDLL_API
319eErr CCAUXDLL_CALLING_CONV Video_getStatus(VIDEOHANDLE, uint8_t *status);
320
333EXTERN_C
334CCAUXDLL_API
336
349EXTERN_C
350CCAUXDLL_API
351eErr CCAUXDLL_CALLING_CONV Video_getScaling(VIDEOHANDLE, float32_t *x, float32_t *y);
352
365EXTERN_C
366CCAUXDLL_API
367eErr CCAUXDLL_CALLING_CONV Video_activateSnapshot(VIDEOHANDLE, bool activate);
368
382EXTERN_C
383CCAUXDLL_API
384eErr CCAUXDLL_CALLING_CONV Video_takeSnapshot(VIDEOHANDLE, const char_t *path, bool bInterlaced);
385
405EXTERN_C
406CCAUXDLL_API
407eErr CCAUXDLL_CALLING_CONV Video_takeSnapshotRaw(VIDEOHANDLE, char_t *rawImgBuffer, uint32_t rawImgBuffSize,
408 bool bInterlaced);
409
429EXTERN_C
430CCAUXDLL_API
431eErr CCAUXDLL_CALLING_CONV Video_takeSnapshotBmp(VIDEOHANDLE, char_t **bmpBuffer, uint32_t *bmpBufSize,
432 bool bInterlaced, bool bNTSCFormat);
433
452EXTERN_C
453CCAUXDLL_API
454eErr CCAUXDLL_CALLING_CONV Video_createBitmap(VIDEOHANDLE, char_t **bmpBuffer, uint32_t *bmpBufSize,
455 const char_t *rawImgBuffer, uint32_t rawImgBufSize, bool bInterlaced,
456 bool bNTSCFormat);
457
467EXTERN_C
468CCAUXDLL_API
469eErr CCAUXDLL_CALLING_CONV Video_freeBmpBuffer(VIDEOHANDLE, char_t *bmpBuffer);
470
479EXTERN_C
480CCAUXDLL_API
481eErr CCAUXDLL_CALLING_CONV Video_minimize(VIDEOHANDLE);
482
491EXTERN_C
492CCAUXDLL_API
493eErr CCAUXDLL_CALLING_CONV Video_restore(VIDEOHANDLE);
494
507EXTERN_C
508CCAUXDLL_API
509eErr CCAUXDLL_CALLING_CONV Video_setDecoderReg(VIDEOHANDLE, uint8_t decoderRegister, uint8_t registerValue);
510
523EXTERN_C
524CCAUXDLL_API
525eErr CCAUXDLL_CALLING_CONV Video_getDecoderReg(VIDEOHANDLE, uint8_t decoderRegister, uint8_t *registerValue);
526
544EXTERN_C
545CCAUXDLL_API
546eErr CCAUXDLL_CALLING_CONV Video_setCropping(VIDEOHANDLE, uint8_t top, uint8_t left, uint8_t bottom, uint8_t right);
547
560EXTERN_C
561CCAUXDLL_API
562eErr CCAUXDLL_CALLING_CONV Video_getCropping(VIDEOHANDLE, uint8_t *top, uint8_t *left, uint8_t *bottom, uint8_t *right);
563
571EXTERN_C
572CCAUXDLL_API
573eErr CCAUXDLL_CALLING_CONV Video_showFrame(VIDEOHANDLE);
574
584EXTERN_C
585CCAUXDLL_API
587
597EXTERN_C
598CCAUXDLL_API
599eErr CCAUXDLL_CALLING_CONV Video_getGraphicsOverlay(VIDEOHANDLE, CCStatus *mode);
600
602#ifdef __cplusplus
603} /* namespace CrossControl */
604#endif
605
606#endif /* CC_VIDEO_H */
unsigned short uint16_t
Definition: CCAuxTypes.h:38
char char_t
Definition: CCAuxTypes.h:17
unsigned int uint32_t
Definition: CCAuxTypes.h:39
float float32_t
Definition: CCAuxTypes.h:15
unsigned char uint8_t
Definition: CCAuxTypes.h:37
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_getGraphicsOverlay(VIDEOHANDLE, CCStatus *mode)
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_setActiveChannel(VIDEOHANDLE, VideoChannel channel)
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_getVideoStandard(VIDEOHANDLE, videoStandard *standard)
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_takeSnapshot(VIDEOHANDLE, const char_t *path, bool bInterlaced)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Video_getRotation(VIDEOHANDLE, VideoRotation *rotation)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Video_freeBmpBuffer(VIDEOHANDLE, char_t *bmpBuffer)
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_minimize(VIDEOHANDLE)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Video_showFrame(VIDEOHANDLE)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Video_setDeInterlaceMode(VIDEOHANDLE, DeInterlaceMode mode)
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_init(VIDEOHANDLE, uint8_t deviceNr)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Video_getActiveChannel(VIDEOHANDLE, VideoChannel *channel)
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_restore(VIDEOHANDLE)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Video_setMirroring(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_setGraphicsOverlay(VIDEOHANDLE, CCStatus mode)
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_getMirroring(VIDEOHANDLE, CCStatus *mode)
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_showVideo(VIDEOHANDLE, bool show)
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_getRawImage(VIDEOHANDLE, uint16_t *width, uint16_t *height, float32_t *frameRate)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Video_getDeInterlaceMode(VIDEOHANDLE, DeInterlaceMode *mode)
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_getStatus(VIDEOHANDLE, uint8_t *status)
EXTERN_C CCAUXDLL_API VIDEOHANDLE CCAUXDLL_CALLING_CONV GetVideo(void)
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_activateSnapshot(VIDEOHANDLE, bool activate)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Video_setScaling(VIDEOHANDLE, float32_t x, float32_t y)
EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV Video_release(VIDEOHANDLE)
Definition: About.h:30
VideoChannel
Definition: CCAuxTypes.h:218
videoStandard
Definition: CCAuxTypes.h:260
CCStatus
Definition: CCAuxTypes.h:153
DeInterlaceMode
Definition: CCAuxTypes.h:208
void * VIDEOHANDLE
Definition: Video.h:31
VideoRotation
Definition: CCAuxTypes.h:271
eErr
Definition: CCAuxTypes.h:162