ar_util/api/ar_util_data_log.h
Structures
ar_data_log_pcm_info_t
PCM data format information for the logging utility user.
Members
uint32_t
PCM sampling rate.
uint16_t
Number of channels in the PCM stream.
uint8_t
Bits per sample for the PCM data.
uint8_t
Specifies whether the data is interleaved.
uint16_t *
Array of channel mappings.
ar_data_log_audio_fmt_info_t
Format of the data being logged: PCM or bitstream.
Members
ar_data_log_pcm_info_t
Format of the PCM data.
uint32_t
Format of the bitstream data.
ar_data_log_alloc_info_t
Members
uint32_t
The log code used for logging.
uint32_t
The length of the buffer to log.
ar_log_pkt_type_t
The type of packet to use for logging data.
ar_data_log_commit_info_t
Members
uint32_t
The session id for the log packet.
uint32_t
The log tap point id.
uint32_t
The length of the buffer to log.
ar_log_pkt_type_t
The type of packet to use for logging data.
void *
Pointer to the packet info structure that is determined by pkt_type.
void *
Pointer to the data section of the log packet.
ar_data_log_submit_info_t
Members
uint16_t
The log code used for logging.
uint32_t
The session id for the log packet.
uint32_t
The log tap point id.
ar_log_pkt_type_t
The type of packet to use for logging data.
void *
Pointer to the packet info structure that is determined by pkt_type.
uint32_t
The length of the buffer to log.
int8_t *
Pointer to the buffer to be logged.
ar_data_log_pcm_pkt_info_t
Additional packet information for PCM/Bitstream packets used in conjunction with the pkt_info field in ar_data_log_submit_info_t and ar_data_log_commit_info_t
Members
uint64_t
Timestamp in microseconds.
ar_data_log_audio_fmt_info_t
Pointer to the data packet information.
uint32_t *
Reference to sequence number variable shared by client.
ar_data_log_generic_pkt_info_t
Members
uint64_t
Timestamp in microseconds.
uint32_t
Used to distinguish the logging source of a packet or set of packets.
ar_data_log_generic_fmt_t
Specifies the command format to use in the generic log packet.
ar_data_log_blob_fmt_t
Members
uint32_t
The length in bytes of the data that follows this header.
uint8_t
The data.
Functions
ar_data_log_init
Initializes the data logging utility.
ar_data_log_deinit
Deitializes the data logging utility.
ar_data_log_code_status
Checks whether the log code is enabled.
ar_data_log_get_max_packet_size
Returns the max log packet size.
\dependencies None
ar_data_log_alloc
Allocates a data log packet.
ar_data_log_alloc_info_t *
Contains the info needed to allocate a log packet
ar_data_log_commit
Commits a packet for logging.
The log header is populated by this call. The client fills in the data portion of the packet.
ar_data_log_commit_info_t *
A pointer to the commit info structure that contains info needed to commit a packet.
ar_data_log_submit
Segments a buffer into log packets and commits each packet for data logging.
Log packet allocation and disposal are automatically taken care of.
ar_data_log_submit_info_t *
A pointer to the submit info structure that contains the buffer to log as well as info for creating the log packet
ar_data_log_free
Releases the memory allocated for a log packet.
: pointer to the payload of the data log packet
ar_log_pkt_type_t
: the type of packet that needs to be freed