tmbsl7113.h

PNX1500上视频采集芯片7113的设置源代码

//
// Copyright (C) 2003 Koninklijke Philips Electronics N.V., 
// All Rights Reserved. 
//
// This source code and any compilation or derivative thereof is the 
// proprietary information of Koninklijke Philips Electronics N.V. 
// and is confidential in nature. 
// Under no circumstances is this software to be exposed to or placed 
// under an Open Source License of any type without the expressed 
// written permission of Koninklijke Philips Electronics N.V. 
// 
//###########################################################
//! 
//      \file           tmbsl7113.h 
// 
//      \brief          - 
// 
// 
//-----------------------------------------------------------
// 
//      %version:       eh04#16 % 
//      instance:       DS_4 
//      %date_created:  2004-12-02 16:38:11 % 
//
//###########################################################




//-----------------------------------------------------------------------------
// FILE NAME:    tmbsl7113.h
//
// DESCRIPTION:  This is the API definition to handle/simulate the external
//               analog video input decoder.
//
// DOCUMENT REF: DVP Software Coding Guidelines
//               DVP Software Versioning Specification
//               DVP Board Support Library Architecture Specification
//
// NOTES:        None
//-----------------------------------------------------------------------------
//

//-----------------------------------------------------------------------------
// Standard include files:
//-----------------------------------------------------------------------------
//
#include <tmNxTypes.h>                    // DVP standard data types/structures
#include <tmAvFormats.h>                // Rectangles, video formats, etc.
#include <tmStdLib.h>                   // DVP standard 'C' library header file
#include <tmbslAvi.h>                   // DVP AVI BSL interface


#ifndef TMBSL_7113_H
#define TMBSL_7113_H

#if defined(__cplusplus)
extern "C" {
#endif

//-----------------------------------------------------------------------------
// Types and defines:
//-----------------------------------------------------------------------------
//

//  compatibility and version numbers
#define SAA7113_BSL_COMP_NUM   1           // compatibility number
#define SAA7113_BSL_MAJOR_VER  1           // major version number
#define SAA7113_BSL_MINOR_VER  0           // minor version number

#define TMBSL7113_SUPPORTED_STANDARDS	(vasNone | vasNTSC | vasPAL)
#define TMBSL7113_SUPPORTED_ADAPTERS	(vaaNone | vaaCVBS | vaaSvideo)
#define TMBSL7113_CAPABILITIES_FLAGS    (vcapNone)
#define TMBSL7113_OUTPUT_FORMATS        (vdfNone)

//-----------------------------------------------------------------------------
// Global data:
//-----------------------------------------------------------------------------
//


//-----------------------------------------------------------------------------
// Exported functions:
//-----------------------------------------------------------------------------
//

//-----------------------------------------------------------------------------
//
// FUNCTION:    tmbsl7113Init:
//
// DESCRIPTION: 
//
// RETURN:      tmErrorCode_t for success or error
//
// NOTES:       NONE
//
//-----------------------------------------------------------------------------
tmErrorCode_t   
tmbsl7113Init (
    tmUnitSelect_t   aviUnit,           //  I: AVI Unit number
    ptmbslAvi_t      pDec,              //  I: ptr to video decoder
    ptmbslAviParam_t params             //  I: Video modes, etc
    );

//-----------------------------------------------------------------------------
//
// FUNCTION:    tmbsl7113Deinit:
//
// DESCRIPTION: 
//
// RETURN:      tmErrorCode_t for success or error
//
// NOTES:       NONE
//
//-----------------------------------------------------------------------------
tmErrorCode_t   
tmbsl7113Deinit (
    tmUnitSelect_t   aviUnit            //  I: AVI Unit number
    );

//-----------------------------------------------------------------------------
//
// FUNCTION:    tmbsl7113GetSWVersion:
//
// DESCRIPTION: 
//
// RETURN:      tmErrorCode_t for success or error
//
// NOTES:       NONE
//
//-----------------------------------------------------------------------------
tmErrorCode_t   
tmbsl7113GetSWVersion (
    ptmSWVersion_t     pSWVersion        //  I: Receives SW Version 
    );

//-----------------------------------------------------------------------------
//
// FUNCTION:    tmbsl7113GetPowerState:
//
// DESCRIPTION: Get the power state of this device.
//
// RETURN:      tmErrorCode_t for success or error
//
// NOTES:
//
//-----------------------------------------------------------------------------
tmErrorCode_t
tmbsl7113GetPowerState (
    tmUnitSelect_t      aviUnit,        //  I: AVI Unit number
    ptmPowerState_t     pPowerState     //  O: Power state of this device
);

//-----------------------------------------------------------------------------
//
// FUNCTION:    tmbsl7113SetPowerState:
//
// DESCRIPTION: Set the power state of this device.
//
// RETURN:      tmErrorCode_t for success or error
//
// NOTES:
//
//-----------------------------------------------------------------------------
tmErrorCode_t
tmbsl7113SetPowerState (
    tmUnitSelect_t      aviUnit,        //  I: AVI Unit number
    tmPowerState_t      powerState      //  I: Power state of this device
);

//-----------------------------------------------------------------------------
//
// FUNCTION:    tmbsl7113DisableDecoder:
//
// DESCRIPTION: disables decoder if applicable 
//
// RETURN:      tmErrorCode_t for success or error
//
// NOTES:       NONE
//
//-----------------------------------------------------------------------------
tmErrorCode_t   
tmbsl7113DisableDecoder (
    tmUnitSelect_t     aviUnit,          //  I: AVI Unit number
    Bool               disable           //  I: set True to disable decoder
    );

//-----------------------------------------------------------------------------
//
// FUNCTION:    tmbsl7113SetStandard:
//
// DESCRIPTION: Set the video analog standard 
//
// RETURN:      tmErrorCode_t for success or error
//
// NOTES:       NONE
//
//-----------------------------------------------------------------------------
tmErrorCode_t   
tmbsl7113SetStandard (
    tmUnitSelect_t          aviUnit,    //  I: AVI Unit number
    tmVideoAnalogStandard_t standard    //  I: new video standard
    );

//-----------------------------------------------------------------------------
//
// FUNCTION:    tmbsl7113GetStandard:
//
// DESCRIPTION: 
//
// RETURN:      tmErrorCode_t for success or error
//
// NOTES:       NONE
//
//-----------------------------------------------------------------------------
tmErrorCode_t   
tmbsl7113GetStandard (
    tmUnitSelect_t          aviUnit,     //  I: AVI Unit number        
    tmVideoAnalogStandard_t *pStandard   //  O: video standard 
    );

//-----------------------------------------------------------------------------
//
// FUNCTION:    tmbsl7113SetVideoColor:
//
// DESCRIPTION: Set video color (brightness,contrast, saturation, hue)
//
// RETURN:      tmErrorCode_t for success or error
//
// NOTES:       NONE
//
//-----------------------------------------------------------------------------
tmErrorCode_t   
tmbsl7113SetVideoColor (
    tmUnitSelect_t     aviUnit,         //  I: AVI Unit number                
    tmVideoColor_t     color,           //  I: specifies the color type 
    UInt32             val);            //  I: new value
    
//-----------------------------------------------------------------------------
//
// FUNCTION:    tmbsl7113GetVideoColor:
//
// DESCRIPTION: Get current video color (brightness,contrast, saturation, hue)
//
// RETURN:      tmErrorCode_t for success or error
//
// NOTES:       NONE
//
//-----------------------------------------------------------------------------
tmErrorCode_t   
tmbsl7113GetVideoColor (
    tmUnitSelect_t     aviUnit,         //  I: AVI Unit number                
    tmVideoColor_t     color,           //  I: specifies the color type 
    UInt32             *pVal            //  O: receives current value
    );

//-----------------------------------------------------------------------------
//
// FUNCTION:    tmbsl7113SetAnalogInput:
//
// DESCRIPTION: Set input port out of retrieved input array 
//
// RETURN:      tmErrorCode_t for success or error
//
// NOTES:       NONE
//
//-----------------------------------------------------------------------------
tmErrorCode_t   
tmbsl7113SetAnalogInput (
    tmUnitSelect_t        aviUnit,      //  I: AVI Unit number                
    tmVideoAnalogAdapter_t adapter,     //  I: type (CVBS,SVideo,...)
    UInt32           adapterIndex       //  I: index of this type
    );

//-----------------------------------------------------------------------------
//
// FUNCTION:    tmbsl7113GetAnalogInput:
//
// DESCRIPTION: Get currently used input port 
//
// RETURN:      tmErrorCode_t for success or error
//
// NOTES:       NONE
//
//-----------------------------------------------------------------------------
tmErrorCode_t   
tmbsl7113GetAnalogInput (
    tmUnitSelect_t         aviUnit,     //  I: AVI Unit number                
    tmVideoAnalogAdapter_t *pAdapter,   //  O: receives type
    UInt32           *pAdapterIndex     //  O: receives index
    );

//-----------------------------------------------------------------------------
//
// FUNCTION:    tmbsl7113SetSourceType:
//
// DESCRIPTION: Set source type: TV, video, camera 
//
// RETURN:      tmErrorCode_t for success or error
//
// NOTES:       NONE
//
//-----------------------------------------------------------------------------
tmErrorCode_t   
tmbsl7113SetSourceType (
    tmUnitSelect_t      aviUnit,        //  I: AVI Unit number                
    tmVideoSourceType_t type            //  I: new source(TV,video,camera)
    );

//-----------------------------------------------------------------------------
//
// FUNCTION:    tmbsl7113GetSourceType:
//
// DESCRIPTION: Get current source type settings 
//
// RETURN:      tmErrorCode_t for success or error
//
// NOTES:       NONE
//
//-----------------------------------------------------------------------------
tmErrorCode_t   
tmbsl7113GetSourceType (
    tmUnitSelect_t      aviUnit,        //  I: AVI Unit number                
    tmVideoSourceType_t *pType          //  O: receives current source
    );
    
//-----------------------------------------------------------------------------
//
// FUNCTION:    tmbsl7113GetAdapterVideoStandard:
//
// DESCRIPTION: 
//
// RETURN:      tmErrorCode_t for success or error
//
// NOTES:       NONE
//
//-----------------------------------------------------------------------------
tmErrorCode_t   
tmbsl7113GetAdapterVideoStandard (
    tmUnitSelect_t         aviUnit,     //  I: AVI Unit number                
    tmVideoAnalogAdapter_t adapter,     //  I: selected adapter type 
    UInt32                adapterIndex, //  I: selected adapter index
    tmVideoAnalogStandard_t *pStandard  //  O: current standard
    );

//-----------------------------------------------------------------------------
//
// FUNCTION:    tmbsl7113GetGPIOCount:
//
// DESCRIPTION: Get number of GPIO pins in use
//
// RETURN:      tmErrorCode_t for success or error
//
// NOTES:       NONE
//
//-----------------------------------------------------------------------------
tmErrorCode_t  
tmbsl7113GetGPIOCount (
    tmUnitSelect_t   aviUnit,           //  I: AVI Unit number                
    UInt32           *pNum              //  O: nr of GPIO pins in use
    );

//-----------------------------------------------------------------------------
//
// FUNCTION:    tmbsl7113SetGPIOState:
//
// DESCRIPTION: Set GPIO pin state 
//
// RETURN:      tmErrorCode_t for success or error
//
// NOTES:       NONE
//
//-----------------------------------------------------------------------------
tmErrorCode_t   
tmbsl7113SetGPIOState (
    tmUnitSelect_t   aviUnit,          //  I: AVI Unit number                
    UInt32           pin,              //  I: pin number to set     
    Bool             state             //  I: state value (0,1)
    );

//-----------------------------------------------------------------------------
//
// FUNCTION:    tmbsl7113GetGPIOState:
//
// DESCRIPTION: Get current GPIO pin state 
//
// RETURN:      tmErrorCode_t for success or error
//
// NOTES:       NONE
//
//-----------------------------------------------------------------------------
tmErrorCode_t   
tmbsl7113GetGPIOState (
    tmUnitSelect_t   aviUnit,          //  I: AVI Unit number                
    UInt32           pin,              //  I: pin nr to get state from
    Bool             *pState         //  O: receives state value
    );

//-----------------------------------------------------------------------------
// VBI slicer related functions:
//-----------------------------------------------------------------------------
     
//-----------------------------------------------------------------------------
//
// FUNCTION:    tmbsl7113OpenVBI:
//
// DESCRIPTION: initializes VBI support of decoder
//
// RETURN:      tmErrorCode_t for success or error
//
// NOTES:       NONE
//
//-----------------------------------------------------------------------------
tmErrorCode_t   
tmbsl7113OpenVBI (
    tmUnitSelect_t     aviUnit,        //  I: AVI Unit number                
    UInt32             sampleFreq,     //  I: sample frequency
    UInt32             startLine,      //  I: first VBI line
    UInt32             numLines        //  I: nr of VBI lines
    );
  
//-----------------------------------------------------------------------------
//
// FUNCTION:    tmbsl7113EnableVBI:
//
// DESCRIPTION: enables VBI feature of decoder
//
// RETURN:      tmErrorCode_t for success or error
//
// NOTES:       NONE
//
//-----------------------------------------------------------------------------
tmErrorCode_t   
tmbsl7113EnableVBI (
    tmUnitSelect_t     aviUnit,        //  I: AVI Unit number                
    Bool               enable          //  I: set True to enable VBI
    );

//-----------------------------------------------------------------------------
//
// FUNCTION:    tmbsl7113SetVBIMode:
//
// DESCRIPTION: sets VBI mode  
//