Stream

Header: stream/inc/Stream.h

Structures

`Stream`

Members

bool

uint32_t

std::vector< std::shared_ptr< Device > >

Session *

struct pal_stream_attributes *

bool

int

std::mutex

struct modifier_kv *

uint32_t

std::string

size_t

stream_state_t

uint32_t

bool

sem_t

std::mutex

std::shared_ptr< ResourceManager >

std::shared_ptr< PluginManager >

std::mutex

struct pal_volume_data *

call_translation_config *

pal_stream_callback

bool

std::vector< pal_device_id_t >

Functions

`connectToDefaultDevice`

protected

int connectToDefaultDevice(Stream *streamHandle, uint32_t dir)

`Stream`

 Stream()

`~Stream`

 ~Stream()

`isInitialized`

bool isInitialized() const

`open`

int32_t open()=0

`close`

int32_t close()=0

`start`

int32_t start()=0

`start_l`

int32_t start_l()

`stop`

int32_t stop()=0

`prepare`

int32_t prepare()=0

`drain`

int32_t drain(pal_drain_type_t type __unused)=0

`setVolume`

int32_t setVolume(struct pal_volume_data *volume)=0

`mute`

int32_t mute(bool state)=0

`mute_l`

int32_t mute_l(bool state)=0

`getDeviceMute`

int32_t getDeviceMute(pal_stream_direction_t dir, bool *state)

`setDeviceMute`

int32_t setDeviceMute(pal_stream_direction_t dir, bool state)

`pause`

int32_t pause()=0

`pause_l`

int32_t pause_l()=0

`resume`

int32_t resume()=0

`resume_l`

int32_t resume_l()=0

`flush`

int32_t flush()=0

`suspend`

int32_t suspend()=0

`read`

int32_t read(struct pal_buffer *buf)=0

`addRemoveEffect`

int32_t addRemoveEffect(pal_audio_effect_t effect, bool enable)=0

`setParameters`

int32_t setParameters(uint32_t param_id, void *payload)=0

`setParameters_l`

int32_t setParameters_l(uint32_t param_id, void *payload)

`write`

int32_t write(struct pal_buffer *buf)=0

`registerCallBack`

int32_t registerCallBack(pal_stream_callback cb, uint64_t cookie)=0

`getCallBack`

int32_t getCallBack(pal_stream_callback *cb)=0

`getParameters`

int32_t getParameters(uint32_t param_id, void **payload)=0

`setECRef`

int32_t setECRef(std::shared_ptr< Device > dev, bool is_enable)=0

`setECRef_l`

int32_t setECRef_l(std::shared_ptr< Device > dev, bool is_enable)=0

`ssrDownHandler`

int32_t ssrDownHandler()=0

`ssrUpHandler`

int32_t ssrUpHandler()=0

`isBitWidthSupported`

int32_t isBitWidthSupported(uint32_t bitWidth)=0

`isSampleRateSupported`

int32_t isSampleRateSupported(uint32_t sampleRate)=0

`isChannelSupported`

int32_t isChannelSupported(uint32_t numChannels)=0

`isStreamSupported`

bool isStreamSupported()

`createMmapBuffer`

int32_t createMmapBuffer(int32_t min_size_frames __unused, struct pal_mmap_buffer *info __unused)

`GetMmapPosition`

int32_t GetMmapPosition(struct pal_mmap_position *position __unused)

`GetNumEvents`

uint32_t GetNumEvents()

`GetOutputToken`

uint32_t GetOutputToken()

`GetPayloadSize`

uint32_t GetPayloadSize()

`GetSdzNumEvents`

uint32_t GetSdzNumEvents()

`GetSdzOutputToken`

uint32_t GetSdzOutputToken()

`GetSdzPayloadSize`

uint32_t GetSdzPayloadSize()

`GetMMAModelType`

uint32_t GetMMAModelType()

`setCustomParam`

int32_t setCustomParam(custom_payload_uc_info_t *uc_info, std::string param_str, void *param_payload, size_t payload_size)

`getCustomParam`

int32_t getCustomParam(custom_payload_uc_info_t *uc_info, std::string param_str, void *param_payload, size_t *payload_size)

`ConfigSupportLPI`

bool ConfigSupportLPI()

`checkStreamMatch`

bool checkStreamMatch(Stream *ref)

`IsStreamInBuffering`

bool IsStreamInBuffering()

`getVoteType`

vote_type_t getVoteType()

`getStreamAttributes`

int32_t getStreamAttributes(struct pal_stream_attributes *sattr)

`getStreamSelector`

const std::string & getStreamSelector() const

`getDevicePPSelector`

const std::string & getDevicePPSelector() const

`getStreamType`

int32_t getStreamType(pal_stream_type_t *streamType)

`getStreamDirection`

int32_t getStreamDirection(pal_stream_direction_t *dir)

`getRenderLatency`

uint32_t getRenderLatency()

`getLatency`

uint32_t getLatency()

`getAssociatedDevices`

int32_t getAssociatedDevices(std::vector< std::shared_ptr< Device > > &adevices)

`getAssociatedOutDevices`

int32_t getAssociatedOutDevices(std::vector< std::shared_ptr< Device > > &adevices)

`getAssociatedInDevices`

int32_t getAssociatedInDevices(std::vector< std::shared_ptr< Device > > &adevices)

`getPalDevices`

int32_t getPalDevices(std::vector< std::shared_ptr< Device > > &PalDevices)

`removePalDevice`

void removePalDevice(Stream *streamHandle, int palDevId)

`clearOutPalDevices`

void clearOutPalDevices(Stream *streamHandle)

`addPalDevice`

void addPalDevice(Stream *streamHandle, struct pal_device *dattr)

`getSoundCardId`

int32_t getSoundCardId()

`getAssociatedSession`

int32_t getAssociatedSession(Session **session)

`setBufInfo`

int32_t setBufInfo(pal_buffer_config *in_buffer_config, pal_buffer_config *out_buffer_config)

`getBufInfo`

int32_t getBufInfo(size_t *in_buf_size, size_t *in_buf_count, size_t *out_buf_size, size_t *out_buf_count)

`getMaxMetadataSz`

int32_t getMaxMetadataSz(size_t *in_max_metadata_sz, size_t *out_max_metadata_sz)

`getBufSize`

int32_t getBufSize(size_t *in_buf_size, size_t *out_buf_size)

`getVolumeData`

int32_t getVolumeData(struct pal_volume_data *vData)

`setGainLevel`

void setGainLevel(int level)

`getGainLevel`

int getGainLevel()

`setDutyCycleEnable`

void setDutyCycleEnable(bool enable)

`getDutyCycleEnable`

bool getDutyCycleEnable()

`setOrientation`

void setOrientation(int orientation)

`getOrientation`

int getOrientation()

`isStreamAudioOutFmtSupported`

bool isStreamAudioOutFmtSupported(pal_audio_fmt_t format)

`getTimestamp`

int32_t getTimestamp(struct pal_session_time *stime)

`disconnectStreamDevice`

int disconnectStreamDevice(Stream *streamHandle, pal_device_id_t dev_id)

`disconnectStreamDevice_l`

int disconnectStreamDevice_l(Stream *streamHandle, pal_device_id_t dev_id)

`connectStreamDevice`

int connectStreamDevice(Stream *streamHandle, struct pal_device *dattr)

`connectStreamDevice_l`

int connectStreamDevice_l(Stream *streamHandle, struct pal_device *dattr)

`switchDevice`

int switchDevice(Stream *streamHandle, uint32_t no_of_devices, struct pal_device *deviceArray)

`getEffectParameters`

int32_t getEffectParameters(void *effect_query, size_t *payload_size)

`getInstanceId`

uint32_t getInstanceId()

`setInstanceId`

void setInstanceId(uint32_t sid)

`initStreamSmph`

int initStreamSmph()

`deinitStreamSmph`

int deinitStreamSmph()

`postStreamSmph`

int postStreamSmph()

`waitStreamSmph`

int waitStreamSmph()

`checkStreamMatch`

bool checkStreamMatch(pal_device_id_t pal_device_id, pal_stream_type_t pal_stream_type)

`checkStreamMatch`

bool checkStreamMatch(pal_device_id_t pal_device_id, pal_stream_type_t pal_stream_type, char *address)

`isStreamSSRDownFeasibile`

bool isStreamSSRDownFeasibile()

`getCurState`

stream_state_t getCurState()

`isActive`

bool isActive()

`isAlive`

bool isAlive()

`isA2dpMuted`

bool isA2dpMuted()

`Resume`

int32_t Resume(bool is_internal=false)

`Pause`

int32_t Pause(bool is_internal=false)

`HandleConcurrentStream`

int32_t HandleConcurrentStream(bool active)

`DisconnectDevice`

int32_t DisconnectDevice(pal_device_id_t device_id)

`ConnectDevice`

int32_t ConnectDevice(pal_device_id_t device_id)

`getCallbackEventId`

uint32_t getCallbackEventId()

`HandleCallback`

void HandleCallback(uint64_t hdl, uint32_t event_id, void *data, uint32_t event_size)

`lockStreamMutex`

void lockStreamMutex()

`unlockStreamMutex`

void unlockStreamMutex()

`isMutexLockedbyRm`

bool isMutexLockedbyRm()

`lockGetParamMutex`

void lockGetParamMutex()

`unlockGetParamMutex`

void unlockGetParamMutex()

`setCachedState`

void setCachedState(stream_state_t state)

`clearmDevices`

void clearmDevices()

`removemDevice`

void removemDevice(int palDevId)

`addmDevice`

void addmDevice(struct pal_device *dattr)

`removeLastmDevice`

void removeLastmDevice()

`GetCurrentCaptureProfile`

std::shared_ptr< CaptureProfile > GetCurrentCaptureProfile()

`create`

Stream * create(struct pal_stream_attributes *sattr, struct pal_device *dattr, uint32_t no_of_devices, struct modifier_kv *modifiers, uint32_t no_of_modifiers)

`destroy`

int32_t destroy(Stream *s)

`handleStreamCreateFailure`

void handleStreamCreateFailure(struct pal_stream_attributes *attributes, pal_stream_callback cb, uint64_t cookie)

`mixerEventCallbackEntry`

void mixerEventCallbackEntry(uint64_t cookie, uint32_t event_id, void *payload, uint32_t payload_size)

Enumerations

`dataFlags`

Values

Name	Value	Description
`DATA_MODE_SHMEM`	= 0
`DATA_MODE_BLOCKING`
`DATA_MODE_NONBLOCKING`

`stream_state_t`

Values

Name	Value	Description
`STREAM_IDLE`	= 0
`STREAM_INIT`
`STREAM_OPENED`
`STREAM_STARTED`
`STREAM_PAUSED`
`STREAM_SUSPENDED`
`STREAM_STOPPED`

Macros

`BUF_SIZE_PLAYBACK`

#define BUF_SIZE_PLAYBACK 1024

`BUF_SIZE_CAPTURE`

#define BUF_SIZE_CAPTURE 960

`AUDIO_CAPTURE_PERIOD_DURATION_MSEC`

#define AUDIO_CAPTURE_PERIOD_DURATION_MSEC 20

`DEEP_BUFFER_OUTPUT_PERIOD_DURATION`

#define DEEP_BUFFER_OUTPUT_PERIOD_DURATION 40

`PCM_OFFLOAD_OUTPUT_PERIOD_DURATION`

#define PCM_OFFLOAD_OUTPUT_PERIOD_DURATION 80

`COMPRESS_OFFLOAD_FRAGMENT_SIZE`

#define COMPRESS_OFFLOAD_FRAGMENT_SIZE (32 * 1024)

`NO_OF_BUF`

#define NO_OF_BUF 4

`SSR_RECOVERY`

#define SSR_RECOVERY 10000

`VOLUME_RAMP_PERIOD`

#define VOLUME_RAMP_PERIOD (200*1000)

`MUTE_RAMP_PERIOD`

#define MUTE_RAMP_PERIOD (40*1000)

`DEFAULT_RAMP_PERIOD`

#define DEFAULT_RAMP_PERIOD 0x28

API Reference

Structures

Functions

connectToDefaultDevice

Stream

~Stream

isInitialized

open

close

start

start_l

stop

prepare

drain

setVolume

mute

mute_l

getDeviceMute

setDeviceMute

pause

pause_l

resume

resume_l

flush

suspend

read

addRemoveEffect

setParameters

setParameters_l

write

registerCallBack

getCallBack

getParameters

setECRef

setECRef_l

ssrDownHandler

ssrUpHandler

isBitWidthSupported

isSampleRateSupported

isChannelSupported

isStreamSupported

createMmapBuffer

GetMmapPosition

GetNumEvents

GetOutputToken

GetPayloadSize

GetSdzNumEvents

GetSdzOutputToken

GetSdzPayloadSize

GetMMAModelType

setCustomParam

getCustomParam

ConfigSupportLPI

checkStreamMatch

IsStreamInBuffering

getVoteType

getStreamAttributes

getStreamSelector

getDevicePPSelector

getStreamType

getStreamDirection

getRenderLatency

getLatency

getAssociatedDevices

getAssociatedOutDevices

getAssociatedInDevices

getPalDevices

removePalDevice

clearOutPalDevices

addPalDevice

getSoundCardId

getAssociatedSession

setBufInfo

getBufInfo

getMaxMetadataSz

getBufSize

getVolumeData

setGainLevel

getGainLevel

`Stream`

`connectToDefaultDevice`

`Stream`

`~Stream`

`isInitialized`

`open`

`close`

`start`

`start_l`

`stop`

`prepare`

`drain`

`setVolume`

`mute`

`mute_l`

`getDeviceMute`

`setDeviceMute`

`pause`

`pause_l`

`resume`

`resume_l`

`flush`

`suspend`

`read`

`addRemoveEffect`

`setParameters`

`setParameters_l`

`write`

`registerCallBack`

`getCallBack`

`getParameters`

`setECRef`

`setECRef_l`

`ssrDownHandler`

`ssrUpHandler`

`isBitWidthSupported`

`isSampleRateSupported`

`isChannelSupported`

`isStreamSupported`

`createMmapBuffer`

`GetMmapPosition`

`GetNumEvents`

`GetOutputToken`

`GetPayloadSize`

`GetSdzNumEvents`

`GetSdzOutputToken`

`GetSdzPayloadSize`

`GetMMAModelType`

`setCustomParam`

`getCustomParam`

`ConfigSupportLPI`

`checkStreamMatch`

`IsStreamInBuffering`

`getVoteType`

`getStreamAttributes`

`getStreamSelector`

`getDevicePPSelector`

`getStreamType`

`getStreamDirection`

`getRenderLatency`

`getLatency`

`getAssociatedDevices`

`getAssociatedOutDevices`

`getAssociatedInDevices`

`getPalDevices`

`removePalDevice`

`clearOutPalDevices`

`addPalDevice`

`getSoundCardId`

`getAssociatedSession`

`setBufInfo`

`getBufInfo`

`getMaxMetadataSz`

`getBufSize`

`getVolumeData`

`setGainLevel`

`getGainLevel`

`setDutyCycleEnable`

`getDutyCycleEnable`

`setOrientation`