emhwlib_propertytypes.h

Sigma SMP8634 Mrua v. 2.8.2.0

	/** Specifies the audio sample frequency. range 8000 -> 192000 */
	RMuint32 sample_frequency;
};

/** Set ProLogic IIx parameters */
struct AudioEngine_PL2x_type {
	/** Specifies the ProLogic IIx decoding mode. range 0 -> 10 */
	RMuint32 mode;
	/** Disable the ProLogic IIx Autobalance. */
	RMbool a;
	/** Specifies the ProLogic IIx dimension setting. range 0 -> 14 */
	RMuint32 d;
	/** Enable the ProLogic IIx Surround Channel Shelf Filter. */
	RMbool f;
	/** Specifies the ProLogic IIx  PCM scale factor. range 0 -> 1 */
	RMuint32 p;
	/** Enable the ProLogic IIx Rs polarity Inversion. */
	RMbool r;
	/** Enable the ProLogic IIx Panorama mode. */
	RMbool t;
	/** Specifies the ProLogic IIx  Center width Control Setting. range 0 -> 7 */
	RMuint32 w;
	/** Enable the ProLogic IIx inverted matrix. */
	RMbool x;
	/** Enable ProLogic IIx. */
	RMbool on;
	/** Enable auto Detection for EX flag for ProLogic IIx. */
	RMbool autoEX;
};

/** Set or Get serialout enable */
enum AudioEngine_SerialOut_type {
	/** Serial Out Enabled */
	AudioEngine_SerialOut_SO_ENABLE = 0,
	/** Serial Out Disabled */
	AudioEngine_SerialOut_SO_DISABLE = 1,
};

/** Set I2S audio output configuration. Both audio decoders will share same channel status. */
struct AudioEngine_I2SConfig_type {
	/** Number of bits the data is shifted against the L/R-Clock. */
	RMuint32 DataAlignment;
	/** Bit order. TRUE=MSB first, FALSE=LSB first. */
	RMbool SClkInvert;
	/** Bit order. TRUE=MSB first, FALSE=LSB first. */
	RMbool FrameInvert;
	/** Bit order. TRUE=MSB first, FALSE=LSB first. */
	RMbool MSBFirst;
	/** Sample size. TRUE=16 bit, FALSE=32 bit. */
	RMbool SampleSize16Bit;
};

/** Set or Get spdifout enable */
enum AudioEngine_SpdifOut_type {
	/** spdif output disabled */
	AudioEngine_SpdifOut_Disabled = 0,
	/** spdif output enabled, data is forced to 0, or 1 if polarity bit is 1 */
	AudioEngine_SpdifOut_ActiveData0 = 1,
	/** spdif output enabled */
	AudioEngine_SpdifOut_Active = 3,
};

/** Set or Get i2sout enable */
enum AudioEngine_I2sOut_type {
	/** i2s output disabled (i2s clock output disabled) */
	AudioEngine_I2sOut_i2s_Disabled = 0,
	/** i2s0 output enabled, data is forced to 0, or 1 if polarity bit is 1 */
	AudioEngine_I2sOut_ActiveData0_i2s0 = 1,
	/** i2s1 output enabled, data is forced to 0, or 1 if polarity bit is 1 */
	AudioEngine_I2sOut_ActiveData0_i2s1 = 2,
	/** i2s2 output enabled, data is forced to 0, or 1 if polarity bit is 1 */
	AudioEngine_I2sOut_ActiveData0_i2s2 = 4,
	/** i2s3 output enabled, data is forced to 0, or 1 if polarity bit is 1 */
	AudioEngine_I2sOut_ActiveData0_i2s3 = 8,
	/** i2s4 output enabled, data is forced to 0, or 1 if polarity bit is 1 */
	AudioEngine_I2sOut_ActiveData0_i2s4 = 16,
	/** i2s0 output enabled */
	AudioEngine_I2sOut_Active_i2s0 = 32,
	/** i2s1 output enabled */
	AudioEngine_I2sOut_Active_i2s1 = 64,
	/** i2s2 output enabled */
	AudioEngine_I2sOut_Active_i2s2 = 128,
	/** i2s3 output enabled */
	AudioEngine_I2sOut_Active_i2s3 = 256,
	/** i2s4 output enabled */
	AudioEngine_I2sOut_Active_i2s4 = 512,
};

/** Set SPDIF audio output channel status. Both audio decoders will share same channel status. */
struct AudioEngine_ChannelStatus_type {
	/** Specifies the bit mask that will be owned by application. The bits set to 1 in Mask are left unchanged by emhwlib. */
	RMuint32 Mask;
	/** Specifies the value to be set in ChannelStatus. This Value will be and logic with Mask. */
	RMuint32 Value;
};

/** Set SPDIF audio output subcode data. Both audio decoders will share same data. */
struct AudioEngine_SubcodeData_type {
	/** TRUE: send a constant bit value in all bits of the subcode (user) data, FALSE: Use Mask and Data for the content of the subcode data bits */
	RMbool ConstantValue;
	/** Value of the subcode data bit. Used when ConstantValue is TRUE, or for bits 32 and beyond. */
	RMbool ConstantData;
	/** Specifies the bit mask that will be owned by application. The bits set to 1 in Mask are left unchanged by emhwlib. */
	RMuint32 Mask;
	/** Specifies the data to be sent in the subcode (user) data. This Value will be and logic with Mask. */
	RMuint32 Data;
};

/** STC maintained by a clock derived from the I2S output clock */
struct AudioEngine_STC_type {
	/**  */
	RMbool Enable;
	/**  */
	RMuint32 time_resolution;
	/**  */
	RMuint64 time;
};

/** Operate dram2dram dmacopy on idle DSP */
struct AudioEngine_Memcpy_type {
	/** Member default */
	RMuint32 dest;
	/** Member default */
	RMuint32 src;
	/** Member default */
	RMuint32 n;
};

/** Get SPDIF audio input channel status. */
struct AudioEngine_InputSPDIFStatus_type {
	/** ChannelStatus of the SPDIF input. */
	RMuint32 ChannelStatus;
	/** Pc (Burst Info) value from the most recent IEC61937 burst header. */
	RMuint16 Pc;
	/** Pd (Burst Length) value from the most recent IEC61937 burst header. */
	RMuint16 Pd;
	/** Pe (Extended Data Type) value from the most recent IEC61937 burst header with Pc==0x001F. */
	RMuint16 Pe;
	/** Pf value from the most recent IEC61937 burst header with Pc==0x001F. */
	RMuint16 Pf;
};

/** struct Default */
struct AudioEngine_DecoderSharedMemory_type {
	/** DRAM shared by all audio decoders on the AudioEngine - memory used for post processing */
	RMuint32 Address;
	/** Member default */
	RMuint32 Size;
};

/** connect/disconnect audio tasks to audio engine. */
struct AudioEngine_ConnectTask_type {
	/** Member default */
	RMbool connect;
	/**  */
	RMuint32 task_index;
};

/** customized downmixing tables, e.g, ARIB. */
struct AudioEngine_Downmixing_tables_type {
	/** Member default */
	enum AudioEngine_dmx_tables_type dmx_table_index;
	/** Member default */
	RMuint32 dmx_table_pointer;
};

/** Sets the audio decoder Profile. The profile consist in defining the maximum number of resources (Memory, Number of channels...) the audio decoder will use.@note @li The CachedSize and UncachedSize values can be obtained using the ::RMAudioDecoderPropertyID_DRAMSize exchange properties. The application has to provide these values since it is solely responsible for the DDR-DRAM memory allocation in each DRAM controller.@li The CachedAddress and UncachedAddress can be obtained in the RUA interface by calling RUAMalloc. Refer to the em86xx REALmagic User API document for more info.@li In order to release the resources or change the decoder profile, use the ::RMAudioDecoderPropertyID_Close. You cannot free the memory used by the decoder before calling the ::RMAudioDecoderPropertyID_Close property. */
struct AudioDecoder_Open_type {
	/** Member default */
	RMuint32 MaxChannelOutCount;
	/** Member default */
	RMuint32 PCMLineCount;
	/** Member default */
	RMuint32 BitstreamFIFOSize;
	/** Member default */
	RMuint32 XferFIFOCount;
	/** Member default */
	RMuint32 CachedAddress;
	/** Member default */
	RMuint32 CachedSize;
	/** Member default */
	RMuint32 UncachedAddress;
	/** Member default */
	RMuint32 UncachedSize;
	/** index of DemuxProgram */
	RMuint32 DemuxProgramId;
	/** index of STC or timer */
	RMuint32 TimerId;
};

/** Sets the audio decoder Profile. The profile consist in defining the maximum number of resources (Memory, Number of channels...) the audio decoder will use.@note @li The CachedSize and UncachedSize values can be obtained using the ::RMAudioDecoderPropertyID_DRAMSize exchange properties. The application has to provide these values since it is solely responsible for the DDR-DRAM memory allocation in each DRAM controller.@li The CachedAddress and UncachedAddress can be obtained in the RUA interface by calling RUAMalloc. Refer to the em86xx REALmagic User API document for more info.@li In order to release the resources or change the decoder profile, use the ::RMAudioDecoderPropertyID_Close. You cannot free the memory used by the decoder before calling the ::RMAudioDecoderPropertyID_Close property. */
struct AudioDecoder_OpenPCMX_type {
	/** Member default */
	RMuint32 BitstreamFIFOSize0;
	/** Member default */
	RMuint32 XferFIFOCount0;
	/** Member default */
	RMuint32 BitstreamFIFOSize1;
	/** Member default */
	RMuint32 XferFIFOCount1;
	/** Member default */
	RMuint32 BitstreamFIFOSize2;
	/** Member default */
	RMuint32 XferFIFOCount2;
	/** Member default */
	RMuint32 BitstreamFIFOSize3;
	/** Member default */
	RMuint32 XferFIFOCount3;
	/** Member default */
	RMuint32 BitstreamFIFOSize4;
	/** Member default */
	RMuint32 XferFIFOCount4;
	/** Member default */
	RMuint32 BitstreamFIFOSize5;
	/** Member default */
	RMuint32 XferFIFOCount5;
	/** Member default */
	RMuint32 BitstreamFIFOSize6;
	/** Member default */
	RMuint32 XferFIFOCount6;
	/** Member default */
	RMuint32 BitstreamFIFOSize7;
	/** Member default */
	RMuint32 XferFIFOCount7;
	/** Member default */
	RMuint32 BitstreamFIFOSize8;
	/** Member default */
	RMuint32 XferFIFOCount8;
	/** Member default */
	RMuint32 UnProtectedAddress;
	/** Member default */
	RMuint32 UnProtectedSize;
};

/** Set the Audio decoder playback mode (Play, pause or stop).@note @li This property should be called only once the DSP microcode has been loaded using the ::RMAudioEnginePropertyID_MicrocodeVersion property.@li The init command is used to set the microcode in stop mode. The stop mode is mode where the audio codec is already know and must therefore be selected prior to the init command.@li Use the ::RMAudioDecoderPropertyID_State to wait for the command command completion.@li The audio codec can be selected only in stop mode and before the init command. */
enum AudioDecoder_Command_type {
	/** Set the decoder into play mode. */
	AudioDecoder_Command_Play = 1,
	/** Set the decoder into pause mode. */
	AudioDecoder_Command_Pause = 2,
	/** Set the decoder into stop mode. */
	AudioDecoder_Command_Stop = 3,
	/** Initializes the decoder. This command has to be called after loading and running the microcode and before any other command. Note that the codec must be selected prior to calling this function. */
	AudioDecoder_Command_Init = 6,
	/** Uninitializes the decoder. This command should be called before a new Init to change the decoder type will come. */
	AudioDecoder_Command_Uninit = 7,
};

/** State machine of the Audio decoder */
enum AudioDecoder_State_type {
	/** Audio decoder not initialized yet */
	AudioDecoder_State_Uninitialized = 0,
	/** The microcode is error state and should be stopped or reset */
	AudioDecoder_State_Error = 1,
	/** A stop command has been issued but has not been completed yet. @note @li you can use ::RUAWaitForMultipleEvents to wait for command completion */
	AudioDecoder_State_StopPending = 2,
	/** In Enum default */
	AudioDecoder_State_Stopped = 3,
	/** In Enum default */
	AudioDecoder_State_PlayPending = 4,
	/** In Enum default */
	AudioDecoder_State_Playing = 5,
	/** In Enum default */
	AudioDecoder_State_PausePending = 6,
	/** In Enum default */
	AudioDecoder_State_Paused = 7,
	/** In Enum default */
	AudioDecoder_State_UninitPending = 8,
	/** In Enum default */
	AudioDecoder_State_Closed = 9,
};

/** Select the audio codec (Currently supported codecs: PCM, MPEG1 L1/2/3 or AC3).@note @li The audio codec can be selected only in stop mode or before the init command. */
enum AudioDecoder_Codec_type {
	/** Selects audio AC3 codecs */
	AudioDecoder_Codec_AC3 = 1,
	/** Selects the audio MPEG1 codec. It supports layer 1, 2 and 3 (Also known as mp3) and MPEG2 backward compatible audio layers (Only support for 2 channels). */
	AudioDecoder_Codec_MPEG1 = 2,
	/** Selects the AAC codec. It supports several types of payload formats (see ::RMAudioDecoderPropertyID_AACParameters) */
	AudioDecoder_Codec_AAC = 3,
	/** Select the DVD Audio code. Not supported yet */
	AudioDecoder_Codec_DVDA = 4,
	/** Select the PCM codecs. It supports several types of PCM formats (see ::RMAudioDecoderPropertyID_PcmParameters) */
	AudioDecoder_Codec_PCM = 5,
	/** Supported */
	AudioDecoder_Codec_DTS = 6,
	/** Supported */
	AudioDecoder_Codec_WMA = 7,
	/** Supported */
	AudioDecoder_Codec_WMAPRO = 8,
	/** EVD ExAC supported */
	AudioDecoder_Codec_EXAC = 9,
	/** Supported. */
	AudioDecoder_Codec_ATX = 10,
	/** Compressed WMAPRO over SPDIF. */
	AudioDecoder_Codec_WMAPRO_SPDIF = 11,
	/** Select the PCMX codecs. */
	AudioDecoder_Codec_PCMX = 12,
	/** MPEG-4 BSAC decoder. */
	AudioDecoder_Codec_BSAC = 13,
	/** Test tone generator. */
	AudioDecoder_Codec_TTONE = 14,
};

/** struct Default */
struct AudioDecoder_PCMXParameters_type {
	/** Member default */
	enum PcmCdaChannelAssign_type ChannelAssign;
	/** Member default range 8 -> 24 */
	RMuint32 BitsPerSample;
	/** Member default */
	RMuint32 SamplingFrequency;
	/** Member default */
	RMbool MsbFirst;
	/** Member default */
	enum OutputDualMode_type OutputDualMode;
	/** Member default */
	enum AudioOutputChannels_type OutputChannels;
	/** Member default */
	RMbool OutputLfe;
	/** Member default */
	RMbool SignedPCM;
	/** Selects between disable, uncompressed and compressed SpdifOutput. */
	enum OutputSpdif_type OutputSpdif;
	/** Member default */
	enum AudioOutputSurround20_type OutputSurround20;
	/** Member default */
	RMuint32 BassMode;
};

/** struct Default */
struct AudioDecoder_AACParameters_type {
	/** Member default */
	enum AACInputFormat InputFormat;
	/** Selects between disable, uncompressed and compressed SpdifOutput. */
	enum OutputSpdif_type OutputSpdif;
	/** Member default */
	enum OutputDualMode_type OutputDualMode;
	/** Member default */
	enum AacOutputChannels_type OutputChannels;
	/** Member default */
	RMbool Acmod2DualMode;
	/** Member default */
	RMbool OutputLfe;
	/** Member default */
	enum AudioOutputSurround20_type OutputSurround20;
	/** Member default */
	RMuint32 BassMode;
};

/** struct Default */
struct AudioDecoder_DVDAParameters_type {
	/** Member default */
	RMuint32 Chconfig;
	/** Member default */
	RMuint32 DRCenable;
	/** Member default */
	RMuint32 DRCboost;
	/** Member default */
	RMuint32 DRCcut;
	/** Member default */
	RMint32 DRCdialref;
	/** Member default */
	RMbool Lossless;
	/** Selects between disable, uncompressed and compressed SpdifOutput. */
	enum OutputSpdif_type OutputSpdif;
	/** Member default */
	enum OutputDualMode_type OutputDualMode;
	/** Member default */
	enum AudioOutputChannels_type OutputChannels;
	/** Member default */
	RMbool OutputLfe;
	/** Member default */
	enum AudioOutputSurround20_type OutputSurround20;
	/** Member default */
	RMuint32 BassMode;
};

/** struct Default */
struct AudioDecoder_TToneParameters_type {
	/** Member default */
	enum TestToneType TToneType;
	/** Member default */
	enum AudioChannelMask_type TToneChannelMask;
	/** Selects between disable, uncompressed and compressed SpdifOutput. */
	enum OutputSpdif_type OutputSpdif;
	/** Member default */
	enum OutputDualMode_type OutputDualMode;
	/** Member default */
	enum AacOutputChannels_type OutputChannels;
	/** Member default */
	RMbool OutputLfe;
	/** Member default */
	RMuint32 BassMode;
};

/** struct Default */
struct AudioDecoder_BSACParameters_type {
	/** Member default */
	enum AACInputFormat InputFormat;
	/** Selects between disable, uncompressed and compressed SpdifOutput. */
	enum OutputSpdif_type OutputSpdif;
	/** Member default */
	enum OutputDualMode_type OutputDualMode;
	/** Member default */
	enum AacOutputChannels_type OutputChannels;
	/** Member default */
	RMbool OutputLfe;
	/** Member default */
	enum AudioOutputSurround20_type OutputSurround20;
	/** Member default */
	RMuint32 BassMode;
};

/** struct Default */
struct AudioDecoder_ExACParameters_type {
	/** Selects between disable, uncompressed and compressed SpdifOutput. */
	enum OutputSpdif_type OutputSpdif;
	/** Member default */
	enum OutputDualMode_type OutputDualMode;