frmgrab.h

Go to the documentation of this file.

/****************************************************************************
 *
 * $Id: frmgrab.h 14478 2011-10-17 20:49:08Z monich $
 *
 * Copyright (C) 2008-2011 Epiphan Systems Inc. All rights reserved.
 *
 * Header file for the Epiphan frame grabber library
 *
 ****************************************************************************/

#ifndef _EPIPHAN_FRMGRAB_H_
#define _EPIPHAN_FRMGRAB_H_ 1

#include "v2u_defs.h"

#ifdef __cplusplus
extern "C" {
#endif  /* __cplusplus */

typedef struct _FrmGrabber FrmGrabber;
struct sockaddr_in;
    
void FrmGrab_Init(void);
void FrmGrab_Deinit(void);
void FrmGrabNet_Init(void);
void FrmGrabNet_Deinit(void);

FrmGrabber* FrmGrabLocal_Open(void);
FrmGrabber* FrmGrabLocal_OpenSN(const char* sn);
FrmGrabber* FrmGrabLocal_OpenIndex(int i);
int FrmGrabLocal_Count(void);
int FrmGrabLocal_OpenAll(FrmGrabber* grabbers[], int maxcount);

typedef V2U_BOOL (*FrmGrabAuthProc)(char* user, char* pass, void* param);
#define FG_USERNAME_SIZE 32
#define FG_PASSWORD_SIZE 64

typedef enum _FrmGrabConnectStatus {
    FrmGrabConnectOK,           /* Connection OK, authentication not needed */
    FrmGrabConnectAuthOK,       /* Connection OK, authentication successful */
    FrmGrabConnectError,        /* Connection failed */
    FrmGrabConnectAuthFail,     /* Authentication failure */
    FrmGrabConnectAuthCancel    /* Authentication was cancelled */
} FrmGrabConnectStatus;

FrmGrabber* FrmGrabNet_Open(void);
FrmGrabber* FrmGrabNet_OpenSN(const char* sn);
FrmGrabber* FrmGrabNet_OpenLocation(const char* location);
FrmGrabber* FrmGrabNet_OpenAddress(V2U_UINT32 ipaddr, V2U_UINT16 port);
FrmGrabber* FrmGrabNet_OpenAddress2(V2U_UINT32 ipaddr, V2U_UINT16 port,
    FrmGrabAuthProc authproc, void* param, FrmGrabConnectStatus* status);

V2U_BOOL FrmGrabNet_IsProtected(FrmGrabber* fg);
FrmGrabConnectStatus FrmGrabNet_Auth(FrmGrabber* fg, FrmGrabAuthProc authproc,
    void* param);

FrmGrabConnectStatus FrmGrabNet_Auth2(FrmGrabber* fg, const char* user,
    const char* pass);

typedef struct _FrmGrabNetStat {
    V2U_UINT64 bytesSent;       /* Total bytes sent over the network */
    V2U_UINT64 bytesReceived;   /* Total bytes received from the network */
} FrmGrabNetStat;

V2U_BOOL FrmGrabNet_GetStat(FrmGrabber* fg, FrmGrabNetStat* netstat);
V2U_BOOL FrmGrabNet_GetRemoteAddr(FrmGrabber* fg, struct sockaddr_in* addr);

/* Other network-specific functions */
V2U_BOOL FrmGrabNet_IsAlive(FrmGrabber* fg);
V2U_BOOL FrmGrabNet_SetAutoReconnect(FrmGrabber* fg, V2U_BOOL enable);

FrmGrabber* FrmGrab_Open(const char* location);

FrmGrabber* FrmGrab_Dup(FrmGrabber* fg);

const char* FrmGrab_GetSN(FrmGrabber* fg);

int FrmGrab_GetProductId(FrmGrabber* fg);

#define PRODUCT_ID_MASK     0x0000ffff
#define PRODUCT_TYPE_MASK   0x00ff0000
#define PRODUCT_TYPE_USB    0x00010000  /* Local USB grabber */
#define PRODUCT_TYPE_NET    0x00020000  /* Network grabber */
#define PRODUCT_TYPE_NETAPP 0x00030000  /* Network appliance, not a grabber */
#define PRODUCT_TYPE_FILE   0x00040000  /* Reserved */
#define PRODUCT_TYPE_PCI    0x00050000  /* Local PCI grabber */

#define FrmGrab_IsNetGrabber(fg) \
    ((FrmGrab_GetProductId(fg) & PRODUCT_TYPE_MASK) == PRODUCT_TYPE_NET)

#define FrmGrab_IsUsbGrabber(fg) \
    ((FrmGrab_GetProductId(fg) & PRODUCT_TYPE_MASK) == PRODUCT_TYPE_USB)

#define FrmGrab_IsPciGrabber(fg) \
    ((FrmGrab_GetProductId(fg) & PRODUCT_TYPE_MASK) == PRODUCT_TYPE_PCI)

#define FrmGrab_IsLocalGrabber(fg) \
    (FrmGrab_IsUsbGrabber(fg) || \
     FrmGrab_IsPciGrabber(fg))

const char* FrmGrab_GetProductName(FrmGrabber* fg);

const char* FrmGrab_GetLocation(FrmGrabber* fg);

V2U_UINT32 FrmGrab_GetCaps(FrmGrabber* fg);

void FrmGrab_GetVideoMode(FrmGrabber* fg, V2U_VideoMode* vm);

V2U_BOOL FrmGrab_DetectVideoMode(FrmGrabber* fg, V2U_VideoMode* vm);

V2U_BOOL FrmGrab_GetGrabParams(FrmGrabber* fg, V2U_GrabParameters* gp);

V2U_BOOL FrmGrab_GetGrabParams2(FrmGrabber* fg, V2U_GrabParameters* gp,
    V2UAdjRange* range);

V2U_BOOL FrmGrab_SetGrabParams(FrmGrabber* fg, const V2U_GrabParameters* gp);

V2U_BOOL FrmGrab_GetProperty(FrmGrabber* fg, V2U_Property* prop);

V2U_BOOL FrmGrab_SetProperty(FrmGrabber* fg, const V2U_Property* prop);

typedef struct _FrmGrabVgaModes {
    V2UVideoModeDescr* customModes; /* Custom modes */
    V2UVideoModeDescr* stdModes;    /* Standard modes */
    int numCustomModes;             /* Number of custom modes */
    int numStdModes;                /* Number of standard modes */
} FrmGrabVgaModes;

FrmGrabVgaModes* FrmGrab_GetVGAModes(FrmGrabber* fg);

V2U_BOOL FrmGrab_SetVGAModes(FrmGrabber* fg, const FrmGrabVgaModes* vgaModes);

V2U_BOOL FrmGrab_SendPS2(FrmGrabber* fg, const V2U_SendPS2* ps2);

V2U_BOOL FrmGrab_SetMaxFps(FrmGrabber* fg, double maxFps);

V2U_BOOL FrmGrab_Start(FrmGrabber* fg);

void FrmGrab_Stop(FrmGrabber* fg);

V2U_GrabFrame2* FrmGrab_Frame(FrmGrabber* fg, V2U_UINT32 format,
    const V2URect* crop);

void FrmGrab_Release(FrmGrabber* fg, V2U_GrabFrame2* frame);

void FrmGrab_Close(FrmGrabber* fg);

void FrmGrab_Free(void* ptr);

typedef void* (*FrmGrabMemAlloc)(void* param, V2U_UINT32 len);
typedef void (*FrmGrabMemFree)(void* param, void* ptr);

typedef struct _FrmGrabMemCB {
    FrmGrabMemAlloc alloc;
    FrmGrabMemFree free;
} FrmGrabMemCB;

void FrmGrab_SetAlloc(FrmGrabber* fg, const FrmGrabMemCB* memcb, void* param);
    
#ifdef __cplusplus
} /* end of extern "C" */
#endif  /* __cplusplus */

#endif /* _EPIPHAN_FRMGRAB_H_ */

/*
 * Local Variables:
 * c-basic-offset: 4
 * indent-tabs-mode: nil
 * End:
 */