emhwlib_properties_3000.h

Sigma SMP8634 Mrua v. 2.8.2.0

	/** ::enum EMhwlibClosedCaptionType, (W) @par 
		By default it is EMhwlibClosedCaptionType_None. In case that the user data contains two types of closed caption the first one detected will be parsed and sent to CCFifo.  */
	RMVideoDecoderPropertyID_ClosedCaptionType = 4614,
};

/** This module provides access to the Audio DSP specific functionalities */
enum RMAudioEnginePropertyID {
	/** ::RMuint32, (W) @par 
		Set Capture Fifo Container address */
	RMAudioEnginePropertyID_audio_captureFifo_container = 4615,
	/** ::RMuint32, (R) @par 
		Get Capture Fifo Size */
	RMAudioEnginePropertyID_audio_captureFifo_info = 4616,
	/** ::RMuint32, (R) @par 
		Retrieves loaded Audio DSP Microcode Version */
	RMAudioEnginePropertyID_MicrocodeVersion = 4136,
	/** AudioEngine_Microcode_type, (W) @par 
		Select and load the Audio DSP microcode. @note @li This property should be called only when the DSP is in stopped state.\n @li Use the ::RMAudioEnginePropertyID_MicrocodeDRAMSize  property followed by a call to ::RUAMalloc to allocate the memory specified by the Address parameter */
	RMAudioEnginePropertyID_Microcode = 4137,
	/** AudioEngine_MicrocodeDRAMSize_in_type and AudioEngine_MicrocodeDRAMSize_out_type, (R/W Exchange) @par 
		Returns DDR-DRAM memory (cached or un-cached) requirements for a specified microcode. @note @li This function must be used before allocating the returned memory size using ::RUAMalloc. The ::RMAudioEnginePropertyID_Microcode  property needs this memory to store microcode specific overlays and data. \n @li The same Microcode version has to be used when calling ::RMAudioEnginePropertyID_Microcode. Failure to do so may result in insufficient memory or memory overrun. */
	RMAudioEnginePropertyID_MicrocodeDRAMSize = 4138,
	/** ::ProcessorState, (R/W) @par 
		Set or Get Audio DSP processor state. This property is used to reset, stop and run the DSP during initialization time. Once a DSP is running, it should remain as such until the system is in error state or shutdowned. @note @li This property should be used with extreme cautious since it affects directly the hardware state.\n @li DO NOT USE this call to control the audio decoding process. Use ::RMAudioDecoderPropertyID_Command property instead.@sa ::RMAudioEnginePropertyID_MicrocodeVersion */
	RMAudioEnginePropertyID_State = 4139,
	/** ::RMuint32, (R/W) @par 
		Set the decoder PLL input and Audio output frequencies (in Hz). @note @li This property should be called before sending any DSP command using ::RMAudioDecoderPropertyID_Command.@li An auto-detection frequency mechanism for compressed audio (i.e. not PCM data) may be added in later releases.@li The same output frequencies apply to all Audio decoders. All audio decoders other then PCM used on a single DSP currently require to be encoded at the same input frequency. PCM supports some frequency adjustments. */
	RMAudioEnginePropertyID_SampleFrequency = 4140,
	/** ::RMbool, (R/W) @par 
		Set forced sample frequency (FALSE, default) or sample frequency set from stream information by audio decoder (TRUE). */
	RMAudioEnginePropertyID_SampleFrequencyFromStream = 4141,
	/** AudioEngine_SampleFrequencyFromSource_type, (R/W) @par 
		Extended version of property SampleFrequency. @note SampleFrequency is the same as SampleFrequencyFromSource, with GeneratorNumber = 3, Source = 1 (XtalIn) at 27MHz and IntermediateFrequency = 148500000. */
	RMAudioEnginePropertyID_SampleFrequencyFromSource = 4142,
	/** ::enum MClkFactor, (R/W) @par 
		Set or Get the Master CLock factor, either 256 * fs or 128 * fs */
	RMAudioEnginePropertyID_MasterClockFactor = 4480,
	/** AudioEngine_Volume_type, (R/W) @par 
		Set audio output channel FIFO volume.@li Increasing the audio volume above 0db may cause distortion (cropping) on the audio output depending on the audio source.@li This volume is the master output volume for the specified channel. Even though this volume will be applied to 2 audio decoders, there are currently no way to control the volume separately on these 2 decoders. */
	RMAudioEnginePropertyID_Volume = 4143,
	/** AudioEngine_Delay_type, (W) @par 
		Set audio output channel FIFO volume.@li Increasing the audio volume above 0db may cause distortion (cropping) on the audio output depending on the audio source.@li This volume is the master output volume for the specified channel. Even though this volume will be applied to 2 audio decoders, there are currently no way to control the volume separately on these 2 decoders. */
	RMAudioEnginePropertyID_Delay = 4144,
	/** AudioEngine_PL2x_type, (W) @par 
		Set ProLogic IIx parameters */
	RMAudioEnginePropertyID_PL2x = 4594,
	/** AudioEngine_QueryVolume_in_type and AudioEngine_QueryVolume_out_type, (R/W Exchange) @par 
		Returns audio volume on a specified channel.@note @li This volume is the master output volume for the specified channel. Even though this volume will be applied to 2 audio decoders, there are currently no way to control the volume separately on these 2 decoders. */
	RMAudioEnginePropertyID_QueryVolume = 4145,
	/** AudioEngine_SerialOut_enum, (R/W) @par 
		Set or Get serialout enable */
	RMAudioEnginePropertyID_SerialOut = 4146,
	/** AudioEngine_I2SConfig_type, (R/W) @par 
		Set I2S audio output configuration. Both audio decoders will share same channel status. */
	RMAudioEnginePropertyID_I2SConfig = 4147,
	/** AudioEngine_SpdifOut_enum, (R/W) @par 
		Set or Get spdifout enable */
	RMAudioEnginePropertyID_SpdifOut = 4148,
	/** AudioEngine_I2sOut_enum, (R/W) @par 
		Set or Get i2sout enable */
	RMAudioEnginePropertyID_I2sOut = 4591,
	/** AudioEngine_ChannelStatus_type, (R/W) @par 
		Set SPDIF audio output channel status. Both audio decoders will share same channel status. */
	RMAudioEnginePropertyID_ChannelStatus = 4149,
	/** AudioEngine_SubcodeData_type, (R/W) @par 
		Set SPDIF audio output subcode data. Both audio decoders will share same data. */
	RMAudioEnginePropertyID_SubcodeData = 4618,
	/** AudioEngine_STC_type, (R/W) @par 
		STC maintained by a clock derived from the I2S output clock */
	RMAudioEnginePropertyID_STC = 4150,
	/** AudioEngine_Memcpy_type, (W) @par 
		Operate dram2dram dmacopy on idle DSP */
	RMAudioEnginePropertyID_Memcpy = 4151,
	/** AudioEngine_InputSPDIFStatus_type, (R) @par 
		Get SPDIF audio input channel status. */
	RMAudioEnginePropertyID_InputSPDIFStatus = 4572,
	/** AudioEngine_DecoderSharedMemoryInfo_in_type and AudioEngine_DecoderSharedMemoryInfo_out_type, (R/W Exchange) @par 
		Enum Default; */
	RMAudioEnginePropertyID_DecoderSharedMemoryInfo = 4586,
	/** AudioEngine_DecoderSharedMemory_type, (R/W) @par 
		Enum Default; */
	RMAudioEnginePropertyID_DecoderSharedMemory = 4587,
	/** ::RMuint32, (R) @par 
		Number of audio tasks opened on this audio engine. */
	RMAudioEnginePropertyID_ConnectedTaskCount = 4588,
	/** AudioEngine_Downmixing_tables_type, (R/W) @par 
		customized downmixing tables, e.g, ARIB. */
	RMAudioEnginePropertyID_Downmixing_tables = 4592,
	/** ::RMuint32, (W) @par 
		set karaoke mode */
	RMAudioEnginePropertyID_KaraokeMode = 4617,
	/** ::struct EMhwlibAudioEngineMixing, (W) @par 
		Not completely implemented. To be defined as final API: master, slave,... */
	RMAudioEnginePropertyID_InterEngineMixing = 4613,
};

/** This module provides access to the Audio decoder settings */
enum RMAudioDecoderPropertyID {
	/** AudioDecoder_DRAMSize_in_type and AudioDecoder_DRAMSize_out_type, (R/W Exchange) @par 
		Gets the audio decoder DDR-DRAM memory size requirements (cacheable and non-cacheable) based on input/output characteristics.@note @li The CachedSize and UncachedSize values should be used to allocate memory in DDR-DRAM.@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 Cacheable memory is memory that is only used by the pt110. Any memory that involves DMA transfers (Either PCI master transfers or em86xx internal MBUS/VBUS transfers) as to be non-cacheable. This allows the pt110 to access data without flushing/reloading its cache and allows better performance. */
	RMAudioDecoderPropertyID_DRAMSize = 4152,
	/** AudioDecoder_Open_type, (W) @par 
		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. */
	RMAudioDecoderPropertyID_Open = 4153,
	/** AudioDecoder_DRAMSizePCMX_in_type and AudioDecoder_DRAMSizePCMX_out_type, (R/W Exchange) @par 
		Gets the audio decoder DDR-DRAM memory size requirements (cacheable and non-cacheable) based on input/output characteristics.@note @li The CachedSize and UncachedSize values should be used to allocate memory in DDR-DRAM.@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 Cacheable memory is memory that is only used by the pt110. Any memory that involves DMA transfers (Either PCI master transfers or em86xx internal MBUS/VBUS transfers) as to be non-cacheable. This allows the pt110 to access data without flushing/reloading its cache and allows better performance. */
	RMAudioDecoderPropertyID_DRAMSizePCMX = 4154,
	/** AudioDecoder_OpenPCMX_type, (W) @par 
		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. */
	RMAudioDecoderPropertyID_OpenPCMX = 4155,
	/** ::RMuint32, (W) @par 
		Free resources (DRAM buffers...) allocated during previous call to ::RMAudioDecoderPropertyID_Open.@note @li The application should call the close property after using the decoder or before next call to ::RMAudioDecoderPropertyID_Open (When changing profile for instance). */
	RMAudioDecoderPropertyID_Close = 4156,
	/** ::RMuint32, (W) @par 
		pcmx mix */
	RMAudioDecoderPropertyID_PCMXMix = 4157,
	/** AudioDecoder_Command_enum, (W) @par 
		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. */
	RMAudioDecoderPropertyID_Command = 4158,
	/** AudioDecoder_State_enum, (R) @par 
		State machine of the Audio decoder */
	RMAudioDecoderPropertyID_State = 4159,
	/** AudioDecoder_Codec_enum, (R/W) @par 
		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. */
	RMAudioDecoderPropertyID_Codec = 4160,
	/** ::RMuint32, (W) @par 
		bts threshold for playback (1 = 1k byts), 0 = flush bts. */
	RMAudioDecoderPropertyID_AudioBtsThreshold = 4161,
	/** ::enum AudioOutputChannels_type, (R) @par 
		current output channel setup */
	RMAudioDecoderPropertyID_OutputChannels = 4609,
	/** ::RMbool, (R) @par 
		current output lfe setup */
	RMAudioDecoderPropertyID_OutputLfe = 4610,
	/** AudioDecoder_PCMXParameters_type, (W) @par 
		Enum Default; */
	RMAudioDecoderPropertyID_PCMXParameters = 4162,
	/** AudioDecoder_AACParameters_type, (W) @par 
		Enum Default; */
	RMAudioDecoderPropertyID_AACParameters = 4163,
	/** AudioDecoder_DVDAParameters_type, (W) @par 
		Enum Default; */
	RMAudioDecoderPropertyID_DVDAParameters = 4482,
	/** AudioDecoder_TToneParameters_type, (W) @par 
		Enum Default; */
	RMAudioDecoderPropertyID_TToneParameters = 4603,
	/** AudioDecoder_BSACParameters_type, (W) @par 
		Enum Default; */
	RMAudioDecoderPropertyID_BSACParameters = 4481,
	/** AudioDecoder_ExACParameters_type, (W) @par 
		Enum Default; */
	RMAudioDecoderPropertyID_ExACParameters = 4608,
	/** AudioDecoder_Ac3Parameters_type, (W) @par 
		Enum Default; */
	RMAudioDecoderPropertyID_Ac3Parameters = 4164,
	/** AudioDecoder_DtsParameters_type, (W) @par 
		Enum Default; */
	RMAudioDecoderPropertyID_DtsParameters = 4165,
	/** AudioDecoder_LpcmVobParameters_type, (W) @par 
		Enum Default; */
	RMAudioDecoderPropertyID_LpcmVobParameters = 4166,
	/** AudioDecoder_LpcmAobParameters_type, (W) @par 
		Enum Default; */
	RMAudioDecoderPropertyID_LpcmAobParameters = 4167,
	/** AudioDecoder_PcmCdaParameters_type, (W) @par 
		Enum Default; */
	RMAudioDecoderPropertyID_PcmCdaParameters = 4168,
	/** AudioDecoder_LpcmBDParameters_type, (W) @par 
		Enum Default; */
	RMAudioDecoderPropertyID_LpcmBDParameters = 4169,
	/** AudioDecoder_MpegParameters_type, (W) @par 
		Enum Default; */
	RMAudioDecoderPropertyID_MpegParameters = 4170,
	/** AudioDecoder_WMAParameters_type, (W) @par 
		Enum Default; */
	RMAudioDecoderPropertyID_WMAParameters = 4171,
	/** ::RMuint32, (R) @par 
		Enum Default; */
	RMAudioDecoderPropertyID_CurrentPTS = 6143,
	/** ::RMuint32, (R) @par 
		Enum Default; */
	RMAudioDecoderPropertyID_Skip = 4172,
	/** ::RMuint32, (W) @par 
		param: PTS delay */
	RMAudioDecoderPropertyID_PreFillBuffer = 4173,
	/** AudioDecoder_MixerWeight_type, (W) @par 
		Audio Decoder Mixing Weights */
	RMAudioDecoderPropertyID_MixerWeight = 4174,
	/** AudioDecoder_DRAMSizeX_in_type and AudioDecoder_DRAMSizeX_out_type, (R/W Exchange) @par 
		Enum Default; */
	RMAudioDecoderPropertyID_DRAMSizeX = 4175,
	/** AudioDecoder_OpenX_type, (W) @par 
		Enum Default; */
	RMAudioDecoderPropertyID_OpenX = 4176,
	/** ::RMuint32, (R) @par 
		gbus address of bitstream fifo container. It points to a gbus_fifo structure or a gbus_fifo_eraser structure, depending if EMHWLIB_USE_ERASER_FIFO was set FALSE/TRUE in ProtectedFlags at OpenX. */
	RMAudioDecoderPropertyID_BtsFIFO = 4177,
	/** ::RMuint32, (R) @par 
		gbus address of pts fifo container. It points to a gbus_entry_fifo structure with entry size of APTS_FIFO_ENTRY_SIZE = 8 bytes, first RMuint32 is the byte counter and second RMuint32 is the pts expressed usually in 45K unit. */
	RMAudioDecoderPropertyID_PtsFIFO = 4612,
	/** AudioDecoder_SynchroniseAudioWithDisplayPTS_type, (W) @par 
		Enum Default; */
	RMAudioDecoderPropertyID_SynchroniseAudioWithDisplayPTS = 6145,
	/** AudioDecoder_AudioPlayTime_type, (W) @par 
		Enum Default; */
	RMAudioDecoderPropertyID_AudioPlayTime = 6187,
	/** AudioDecoder_AudioBDJPanning_type, (W) @par 
		BDJ panning parameter in (x, y) coordinate. */
	RMAudioDecoderPropertyID_AudioBDJPanning = 6199,
	/** AudioDecoder_AudioBDJGain_type, (W) @par 
		BDJ gain parameter [-51dB to +12dB], Note:-51=-OO, -50=-50dB and so on. */
	RMAudioDecoderPropertyID_AudioBDJGain = 6200,
	/** AudioDecoder_AudioControlPCMX_type, (R/W) @par 
		PCMX decoder control (0:nothing change, 1: to flush bts fifo, 2:EOS Signal). */
	RMAudioDecoderPropertyID_AudioControlPCMX = 6207,
	/** ::RMbool, (R/W) @par 
		To enable/disable audio synchronization with STC. */
	RMAudioDecoderPropertyID_SyncSTCEnable = 4593,
};

/** This module provides access to the Audio decoder settings */
enum RMAudioCapturePropertyID {
	/** AudioCapture_DRAMSize_in_type and AudioCapture_DRAMSize_out_type, (R/W Exchange) @par 
		Enum Default; */
	RMAudioCapturePropertyID_DRAMSize = 4179,
	/** AudioCapture_Open_type, (W) @par 
		Sets the audio capture Profile. The profile consist in defining the maximum number of resources (Memory, ...) the audio capture module will use.@note @li The CachedSize and UncachedSize values can be obtained using the ::RMAudioCapturePropertyID_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 capture profile, use the ::RMAudioCapturePropertyID_Close. You cannot free the memory used by the decoder before calling the ::RMAudioCapturePropertyID_Close property. */
	RMAudioCapturePropertyID_Open = 4180,
	/** ::RMuint32, (W) @par 
		Free resources (DRAM buffers...) allocated during previous call to ::RMAudioCapturePropertyID_Open.@note @li The application should call the close property after using the decoder or before next call to ::RMAudioCapturePropertyID_Open (When changing profile for instance). */
	RMAudioCapturePropertyID_Close = 4181,
	/** AudioCapture_Capture_enum, (W) @par 
		 */