CCAux 2.19.0.0
CCAux API reference
Video.h
Go to the documentation of this file.
1
2/*
3 * Copyright (C) 2010-2022 CrossControl AB - All rights reserved
4 *
5 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6 *
7 * This source code is licensed under the proprietary CrossControl software
8 * license v 1.0.Please refer to the software license text for details or
9 * contact info@crosscontrol.com for more info.
10 *
11 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12 */
13/*
14 * File description:
15 * Analog Video
16 *
17 * Use the function GetVideo() to get a handle to pass on to the other functions.
18 * Use the method Video_release(VIDEOHANDLE) to return the handle.
19 *
20 ************************************************/
21
22#ifndef CC_VIDEO_H
23#define CC_VIDEO_H
24
25#include "CCAuxErrors.h"
26#include "CCAuxTypes.h"
27#include "CCPlatform.h"
28
29#ifdef __cplusplus
30namespace CrossControl
31{
32#endif
33
34typedef void *VIDEOHANDLE;
35
52EXTERN_C
53CCAUXDLL_API
55CCAUXDLL_CALLING_CONV
57
65EXTERN_C
66CCAUXDLL_API
67void CCAUXDLL_CALLING_CONV Video_release(VIDEOHANDLE);
68
81EXTERN_C
82CCAUXDLL_API
83eErr CCAUXDLL_CALLING_CONV Video_init(VIDEOHANDLE, uint8_t deviceNr);
84
95EXTERN_C
96CCAUXDLL_API
97eErr CCAUXDLL_CALLING_CONV Video_showVideo(VIDEOHANDLE, bool show);
98
108EXTERN_C
109CCAUXDLL_API
111
121EXTERN_C
122CCAUXDLL_API
124
134EXTERN_C
135CCAUXDLL_API
136eErr CCAUXDLL_CALLING_CONV Video_setMirroring(VIDEOHANDLE, CCStatus mode);
137
147EXTERN_C
148CCAUXDLL_API
149eErr CCAUXDLL_CALLING_CONV Video_getMirroring(VIDEOHANDLE, CCStatus *mode);
150
160EXTERN_C
161CCAUXDLL_API
162eErr CCAUXDLL_CALLING_CONV Video_setRotation(VIDEOHANDLE, VideoRotation rotation);
163
173EXTERN_C
174CCAUXDLL_API
175eErr CCAUXDLL_CALLING_CONV Video_getRotation(VIDEOHANDLE, VideoRotation *rotation);
176
186EXTERN_C
187CCAUXDLL_API
188eErr CCAUXDLL_CALLING_CONV Video_setActiveChannel(VIDEOHANDLE, VideoChannel channel);
189
199EXTERN_C
200CCAUXDLL_API
201eErr CCAUXDLL_CALLING_CONV Video_getActiveChannel(VIDEOHANDLE, VideoChannel *channel);
202
216EXTERN_C
217CCAUXDLL_API
218eErr CCAUXDLL_CALLING_CONV Video_setColorKeys(VIDEOHANDLE, uint8_t rKey, uint8_t gKey, uint8_t bKey);
219
232EXTERN_C
233CCAUXDLL_API
234eErr CCAUXDLL_CALLING_CONV Video_getColorKeys(VIDEOHANDLE, uint8_t *rKey, uint8_t *gKey, uint8_t *bKey);
235
248EXTERN_C
249CCAUXDLL_API
250eErr CCAUXDLL_CALLING_CONV Video_setVideoArea(VIDEOHANDLE, uint16_t topLeftX, uint16_t topLeftY, uint16_t bottomRightX,
251 uint16_t bottomRightY);
252
265EXTERN_C
266CCAUXDLL_API
267eErr CCAUXDLL_CALLING_CONV Video_getRawImage(VIDEOHANDLE, uint16_t *width, uint16_t *height, float32_t *frameRate);
268
281EXTERN_C
282CCAUXDLL_API
283eErr CCAUXDLL_CALLING_CONV Video_getVideoArea(VIDEOHANDLE, uint16_t *topLeftX, uint16_t *topLeftY,
284 uint16_t *bottomRigthX, uint16_t *bottomRigthY);
285
296EXTERN_C
297CCAUXDLL_API
298eErr CCAUXDLL_CALLING_CONV Video_getVideoStandard(VIDEOHANDLE, videoStandard *standard);
299
320EXTERN_C
321CCAUXDLL_API
322eErr CCAUXDLL_CALLING_CONV Video_getStatus(VIDEOHANDLE, uint8_t *status);
323
336EXTERN_C
337CCAUXDLL_API
339
352EXTERN_C
353CCAUXDLL_API
354eErr CCAUXDLL_CALLING_CONV Video_getScaling(VIDEOHANDLE, float32_t *x, float32_t *y);
355
368EXTERN_C
369CCAUXDLL_API
370eErr CCAUXDLL_CALLING_CONV Video_activateSnapshot(VIDEOHANDLE, bool activate);
371
385EXTERN_C
386CCAUXDLL_API
387eErr CCAUXDLL_CALLING_CONV Video_takeSnapshot(VIDEOHANDLE, const char_t *path, bool bInterlaced);
388
408EXTERN_C
409CCAUXDLL_API
410eErr CCAUXDLL_CALLING_CONV Video_takeSnapshotRaw(VIDEOHANDLE, char_t *rawImgBuffer, uint32_t rawImgBuffSize,
411 bool bInterlaced);
412
432EXTERN_C
433CCAUXDLL_API
434eErr CCAUXDLL_CALLING_CONV Video_takeSnapshotBmp(VIDEOHANDLE, char_t **bmpBuffer, uint32_t *bmpBufSize,
435 bool bInterlaced, bool bNTSCFormat);
436
455EXTERN_C
456CCAUXDLL_API
457eErr CCAUXDLL_CALLING_CONV Video_createBitmap(VIDEOHANDLE, char_t **bmpBuffer, uint32_t *bmpBufSize,
458 const char_t *rawImgBuffer, uint32_t rawImgBufSize, bool bInterlaced,
459 bool bNTSCFormat);
460
470EXTERN_C
471CCAUXDLL_API
472eErr CCAUXDLL_CALLING_CONV Video_freeBmpBuffer(VIDEOHANDLE, char_t *bmpBuffer);
473
482EXTERN_C
483CCAUXDLL_API
484eErr CCAUXDLL_CALLING_CONV Video_minimize(VIDEOHANDLE);
485
494EXTERN_C
495CCAUXDLL_API
496eErr CCAUXDLL_CALLING_CONV Video_restore(VIDEOHANDLE);
497
510EXTERN_C
511CCAUXDLL_API
512eErr CCAUXDLL_CALLING_CONV Video_setDecoderReg(VIDEOHANDLE, uint8_t decoderRegister, uint8_t registerValue);
513
526EXTERN_C
527CCAUXDLL_API
528eErr CCAUXDLL_CALLING_CONV Video_getDecoderReg(VIDEOHANDLE, uint8_t decoderRegister, uint8_t *registerValue);
529
547EXTERN_C
548CCAUXDLL_API
549eErr CCAUXDLL_CALLING_CONV Video_setCropping(VIDEOHANDLE, uint8_t top, uint8_t left, uint8_t bottom, uint8_t right);
550
563EXTERN_C
564CCAUXDLL_API
565eErr CCAUXDLL_CALLING_CONV Video_getCropping(VIDEOHANDLE, uint8_t *top, uint8_t *left, uint8_t *bottom, uint8_t *right);
566
574EXTERN_C
575CCAUXDLL_API
576eErr CCAUXDLL_CALLING_CONV Video_showFrame(VIDEOHANDLE);
577
587EXTERN_C
588CCAUXDLL_API
590
600EXTERN_C
601CCAUXDLL_API
602eErr CCAUXDLL_CALLING_CONV Video_getGraphicsOverlay(VIDEOHANDLE, CCStatus *mode);
603
605#ifdef __cplusplus
606} /* namespace CrossControl */
607#endif
608
609#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:33
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:34
VideoRotation
Definition: CCAuxTypes.h:271
eErr
Definition: CCAuxTypes.h:162