rm84cmn.h

神龙卡开发原代码

/** @addtogroup  property 
    @{ */
/**
   @file rm84cmn.h 
   @brief comon definitions for EM84xx HwLib and user applications settings
   REALmagic Quasar Hardware Library
   @author Aurelia Popa-Radu
   Copyright Sigma Designs Inc
   Sigma Designs Proprietary and confidential
   @date 01/19/01
*/

#ifndef __RM84CMN_H__
#define __RM84CMN_H__

#ifdef __cplusplus
extern "C"{
#endif 

/************************  start changing the types to RMtypes***************/
// let's start changing the types to RMtypes
//#include "rmbtypes.h"
//#include "rmostype.h"

// replace ULONGLONG, DWORDLONG in HwLib code with RMuint64    = 64 bits long unsigned integer
//typedef ULONGLONG RMuint64;
// replace LONGLONG in HwLib code with RMuint64    = 64 bits long signed integer
//typedef LONGLONG RMint64;

/*****************************Property Sets***********************************/
/**
    Hardware Library Property sets
*/
typedef enum {
    /** registry set common for all board versions*/
    REGISTRY_COMMON_SET = 1,
    /** registry set used for hdtv mode*/
    REGISTRY_HDTV_SET,
    /** registry set used mostly for digital overlay */
    REGISTRY_VGAVENDOR_SET,
    /** property set for scan converter*/
    SCANCONVERTER_SET,
    /** property set for eeprom*/
    EEPROM_SET,
    /** property set for general properties of the board*/
    BOARDINFO_SET,
    /** property set for video properties of the board*/
    VIDEO_SET,
    /** property set for audio properties of the board*/
    AUDIO_SET,
    /** property set for time properties of the board*/
    TIME_SET,
    /** property set for subpicture properties of the board*/
    SUBPICTURE_SET,
    /** property set for video decoder*/
    VIDEO_DECODER_SET,
    /** property set for mpeg encoder*/
    MPEG_ENCODER_SET,
    /** property set for DVI transmitter*/
    DVI_TRANSMITTER_SET,
    /** property set for Mpeg decoder*/
    DECODER_SET,
    /** property set for TV encoder*/
    TVENCODER_SET,
    /** property set for TvTuner encoder*/
    TVTUNER_SET,
    /** property set for OSD properties*/
    OSD_SET,
    /** property set for I2C properties*/
    I2C_SET,
    /** property set for VideoIn properties of the board (video capture)*/
    VIDEOIN_SET,
    /** hardware test properties of the board*/
    HARDWARE_TEST_SET,
    /** property set for AudioIn properties of the board (audio capture)*/
    AUDIOIN_SET,

    PROPERTY_MAX_SET
}PROPERTY_SETS;

/*****************************************************************************/
/**
    Hardware Library Registry property set
    These values are set only at initialisation time.
*/
// REGISTRY_COMMON_SET uses RMuint32 = unsigned long = DWORD
typedef enum {
    eTvOut = 0,                 // DEPRECATED

    /** @li 0 HwReset returns without resetting the hardware
        @li 1 HwReset resets the hardware
        @remark The default value is 1. 
    */
    eDoHwReset,                 // RMuint32, if not 0 HwReset does hardware reset

    /** @li 0 HwReset leaves the Spdif output enabled
        @li 1 HwReset disables the Spdif output
        @remark The default value is 1.
    */
    eDisableSpdifOutputInReset, // RMuint32, if TRUE don't disable SPDIF output on reset

    /** The two values are used when playing on TV to set the
        width of the active window.  They show the number of
        active pixels displayed on TV (any value between 0...720)
        for Ntsc / Pal. They will not affect the destination
        window of the video or the scaling factors.  
        @remark The default value is 720.
    */
    eActiveVideoWidthNtsc,       // RMuint32, number of pixels per line in NTSC mode
    eActiveVideoWidthPal,        // RMuint32, number of pixels per line in PAL mode

    /** @li 1 for BROADCASTED_VIDEO -  the video is streamed and contains I blocks.
        @li 0 for DVD_VIDEO - the video contains complete I frames. 
        @remark The default value is DVD_VIDEO.
    */
    eBroadcastedVideo,           // RMuint32

    /** @li 1 for FORCED_PROGRESSIVE_OFF - displays progressive or interlaced like in the video stream
        @li 0 for FORCED_PROGRESSIVE_ON - displays only progressive if the stream switches very fast from interlaced to progressive
        @remark The default value is 0. 
    */
    eForcedProgressiveSourceOff, // RMuint32

    /** @li 1 for PROGRESSIVE_ALWAYS - displays progressive for any video stream
        @li 0 for PROGRESSIVE_MOVIES - displays progressive only for movies
        @remark The default value is 0. 
    */
    eForcedProgressiveAlways,    // RMuint32

    /** @li 1 for FRAME_DROP - it drops frames when it converts Ntsc clip to PAL TV.
        @li 0 for FIELD_DROP - it drops fields when it converts Ntsc clip to PAL TV.
        @remark The default value is 0.
    */
    eNtscPalFrameDrop,           // RMuint32, Drop frames when displaying NTSC (30 fps) content on PAL (25 fps)

    /** @li 1 for VGA_INTERLACED - displays only BOB on VGA
        @li 0 VGA_INTERLACED - displays BOB or WEAVE on VGA, depending on stream
        @remark The default value is 0.
    */
    eVGAForcedInterlaced,        // RMuint32

    /** @li 0 for AUDIO_OUTPUT_STEREO
        @li 1 for AUDIO_OUTPUT_AC3DTS
        @remark The default value is 0.
    */
    eAudioOutput,           // RMuint32

    /** audio volume right from 0 to 100
        @remark The default value is 100.
    */
    eVolumeRight,           // RMuint32: [0..100], left volume

    /** audio volume left from 0 to 100
        @remark The default value is 100. 
    */
    eVolumeLeft,            // RMuint32: [0..100], right volume

    /** Used only for a specific hardware design (STPC - to select Pcm1716 or Pcm1720) 
        @remark The default value is 1720. 
    */
    eDacType,               // RMuint32

    /** @li 0 the audio I2S 16 or 24 bit will be selected by HwLib
        @li 16 for audio I2S 16 bit
        @li 24 for audio I2S 24 bit
        @remark The default value is 0. 
    */
    eAudioDacBitsPerSample, // RMuint32: {16, 24} 

    /** This dword can be used for testing audio / video synchronization.
        DoAudioLater is the number of PTS units that will be added to the audio PTS
        from file send to the hardware. The HwLib will typecast DoAudioLater
        to LONG - this means that negative values can be programmed.
        The PTS unit is  11.(1) microseconds ( 90 kHz ).
        @remark The default value is 0.
    */
    eDoAudioLater,          // RMuint32

    /** values from 0 to 1000, used when SET_VGA is selected
        @remark The default value is 500.
    */
    eBrightness,   // RMuint32: [0..1000], image brightness

    /** values from 0 to 1000, used when SET_VGA is selected
        @remark The default value is 500.
    */
    eContrast,     // RMuint32: ]0..1000], image contrast

    /** values from 0 to 1000, used when SET_VGA is selected
        @remark The default value is 500.
    */
    eSaturation,   // RMuint32: [0..1000], image saturation

    /** values from 0 to 1000, used when SET_TV is selected
        @remark The default value is 500.
    */
    eTvBrightness, // RMuint32: [0..1000], tv out brightness

    /** values from 0 to 1000, used when SET_TV is selected
        @remark The default value is 500.
    */
    eTvContrast,   // RMuint32: [0..1000], tv out contrast

    /** values from 0 to 1000, used when SET_TV is selected
        @remark The default value is 500.
    */
    eTvSaturation, // RMuint32: [0..1000], tv out saturarion

    /** It should be set according to VGA mode selected.
        The default values are:
        @remark    eDResBitsPerPixel= 8;
        eDResScreenWidth = 1024;
        eDResScreenHeight= 768;
    */
    eDResBitsPerPixel, // RMuint32
    eDResScreenWidth,  // RMuint32
    eDResScreenHeight, // RMuint32

    /** Used for analog overlay to program the pixel clock frequency for Nova chip.
        At IDecoderBoard_HwReset time the analog overlay chip will detect the horizontal
        frequency of the VGA mode and will program its PLL trying to match the VGA pixel
        frequency. Because of not enough accuracy the result can be slightly different from
        one detection to another and this causes a one pixel change in position of the video.
        In order to avoid this, the user should save the horizontal frequency got from HwLib
        in the registry and when the new detection will happen the HwLib will use the registry
        value if the value is in a +/-200Hz range. If the value is too different the
        auto-detected frequency will be used - the VGA mode was probably changed.
        If the user don't use the value should be 0.
        @remark The default value is 0. */
    ePreviousHFreq,      // RMuint32

    /** Used for analog overlay to program the pixel clock frequency for Nova chip.
        At IDecoderBoard_HwReset time the analog overlay chip will program the PLL frequency
        based on horizontal frequency and an estimation of the pixels per line number.
        For a better accuracy this number can be programmed by user in registry.
        If the user don't use the value should be 0.
        @remark The default value is 0. 
    */
    eTotalPixelsPerLine, // RMuint32

    /** @li 0 will not power off/on the EM8400 (no ACPI ON/OFF)
        @li 1 IDecoder_Init will switch to ACPI_ON, IDecoder_Delete will switch to ACPI_OFF
        @remark The default value is 0. 
    */
    eAcpiEnable,          // RMuint32

    /** Used for Ventura2k:
        @li 0 EM8400 is master - EM8400 generates the HSync and VSync
        @li 1 EM8400 is slave - EM8400 doesn't generate the HSync and VSync
        @remark The default value is 0. 
    */
    eDecoderIsSlave,      // RMuint32, Sets the TV encoder slave or master concerning synchro

    /** @li 0 no Zoom
        @li 1 enable AcqWnd window to be the zoomed video window 
    */
    eZoomEnable,          // RMuint32

    /** @li 0 fullscreen on TV 
        @li 1 enable destination window on TV 
    */
    eWindowTvEnable,      // RMuint32

    /** @li 0 fullscreen on HDTV
        @li 1 enable destination window on HDTV 
    */
    eWindowHdtvEnable,    // RMuint32

    /** @li 0 OSD will be displayed relative to the video window 
        @li 1 OSD will be displayed relative to the output device screen 
    */
    eOsdVideoIndependent, // RMuint32

    /** Used to program the digital video pixel clock Dvclk for EM9010.
        @li 0 Dvclk will match the VGA pixel frequency
        @li 1 Dvclk will be set to maximum limit 80000kHz = 80MHz
        @li any required Dvclk in kHz, limited between hardware limits (30000 and 80000 for EM9010)
        @remark The default value is 0. 
    */
    eMaximumDvclk,        // RMuint32

    /** not a property */
    eCommonRegMax         //
}REGISTRY_COMMON_SET_ID;

/**
    high definition television mode (HDTV) settings.
*/
// REGISTRY_HDTV_SET uses RMuint32 = unsigned long = DWORD
typedef enum {
    /** horizontal frequency in Hz*/
    eHdtvHFreq = 0,   // RMuint32

    /** vertical frequency in cHz (1Hz=100cHz)*/
    eHdtvVFreq,       // RMuint32

    /** number of visible video pixels per line*/
    eHdtvVideoWidth,  // RMuint32

    /** number of visible lines per frame*/
    eHdtvVideoHeight, // RMuint32

    /** number of pixels per line (visible + blanking)*/
    eHdtvHSyncTotal,  // RMuint32

    /** number of pixels between visible and HSync*/
    eHdtvPreHSync,    // RMuint32

    /** number of pixels in HSync active signal*/
    eHdtvHSyncActive, // RMuint32

    /** number of pixels between HSync and visible*/
    eHdtvPostHSync,   // RMuint32

    /** number of lines per frame (visible + blanking)*/
    eHdtvVSyncTotal,  // RMuint32

    /** number of lines between visible and VSync*/
    eHdtvPreVSync,    // RMuint32