Maestro Audio Framework v 1.7
NXP Semiconductors
Loading...
Searching...
No Matches
streamer_message.h File Reference

This file includes definitions for messages used by the Streamer library. More...

Macros

#define BLD_MESSAGE(msg, type)   ((uint32_t)(((uint32_t)(msg) << 24) | ((uint32_t)(type))))
 Build a message.
 
#define MESSAGE_ID(msg)   (uint32_t)((msg) >> 24)
 Get message ID.
 
#define MESSAGE_TYPE(msg)   (uint32_t)((msg)&0xFFF)
 Get message type.
 
#define MSG_NULL   (uint32_t)0
 Null message.
 
#define MSG_EOS   BLD_MESSAGE(MESSAGE_EOS, 0)
 End of stream message from the pipeline.
 
#define MSG_ERROR_AUDIO   BLD_MESSAGE(MESSAGE_ERROR, ERROR_AUDIO_FATAL)
 Actual error type will be decoder dependent passed on in message data field.
 
#define MSG_WARNING_AUDIO   BLD_MESSAGE(MESSAGE_ERROR, WARNING_AUDIO)
 Actual warning type will be decoder dependent passed on in message data field.
 
#define MSG_INFO_AUDIO_BITRATE   BLD_MESSAGE(MESSAGE_INFO, INFO_AUDIO_BITRATE)
 Message data will contain the bitrate in bits per second.
 
#define MSG_INFO_AUDIO_CHANNELS   BLD_MESSAGE(MESSAGE_INFO, INFO_AUDIO_CHANNELS)
 Message data will contain the number of channels supported.
 
#define MSG_INFO_AUDIO_SAMPLERATE   BLD_MESSAGE(MESSAGE_INFO, INFO_AUDIO_SAMPLERATE)
 Message data will contain the audio sampling rate in Hz.
 
#define MSG_INFO_AUDIO_TYPE   BLD_MESSAGE(MESSAGE_INFO, INFO_AUDIO_TYPE)
 Message data will contain the type of audio. Audio type depends on the decoders supported.
 
#define MSG_INFO_CODEC_INFO   BLD_MESSAGE(MESSAGE_INFO, INFO_CODEC_INFO)
 Message data will contain the pointer to a string of codec info.
 
#define MSG_INFO_DURATION   BLD_MESSAGE(MESSAGE_INFO, INFO_DURATION)
 Message data will contain the total duration of playback in milliseconds.
 
#define MSG_INFO_ALBUM   BLD_MESSAGE(MESSAGE_INFO, INFO_ALBUM)
 Nothing in message data. get tag function should be called to get the required tag.
 
#define MSG_INFO_ARTIST   BLD_MESSAGE(MESSAGE_INFO, INFO_ARTIST)
 Nothing in message data. get tag function should be called to get the required tag.
 
#define MSG_INFO_TITLE   BLD_MESSAGE(MESSAGE_INFO, INFO_TITLE)
 Nothing in message data. get tag function should be called to get the required tag.
 
#define MSG_INFO_GENRE   BLD_MESSAGE(MESSAGE_INFO, INFO_GENRE)
 Nothing in message data. get tag function should be called to get the required tag.
 
#define MSG_INFO_YEAR   BLD_MESSAGE(MESSAGE_INFO, INFO_YEAR)
 Nothing in message data. get tag function should be called to get the required tag.
 
#define MSG_INFO_TRACK   BLD_MESSAGE(MESSAGE_INFO, INFO_TRACK)
 Nothing in message data. get tag function should be called to get the required tag.
 
#define MSG_INFO_ALBUMART   BLD_MESSAGE(MESSAGE_INFO, INFO_ALBUMART_IMAGE)
 Message data will contain the total duration of playback in milliseconds.
 
#define MSG_INFO_POSITION   BLD_MESSAGE(MESSAGE_INFO, INFO_POSITION)
 Message data will contain the current time of playback in milliseconds.
 
#define MSG_STREAM_INFO_UPDATED   BLD_MESSAGE(MESSAGE_INFO, INFO_STREAM_INFO_UPDATE)
 Nothing in message data. indicate that all stream information is updated.
 
#define MSG_META_INFO_UPDATED   BLD_MESSAGE(MESSAGE_INFO, INFO_META_INFO_UPDATE)
 Nothing in message data. indicate that all metadata information is updated.
 
#define MSG_STREAM_ERROR   BLD_MESSAGE(MESSAGE_INFO, INFO_ERROR)
 Message data will contain the error type.
 

Macro Definition Documentation

◆ BLD_MESSAGE

#define BLD_MESSAGE ( msg,
type )   ((uint32_t)(((uint32_t)(msg) << 24) | ((uint32_t)(type))))
Parameters
msgMessage id
typemessage type

Max ID of message is 8. Each ID can have 24 types. Bits 31-24: Message ID Bits 23-0: Message type