Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

CTC topology #8840

Merged
merged 1 commit into from
Aug 19, 2024
Merged

CTC topology #8840

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 100 additions & 0 deletions tools/topology/topology2/cavs-mixin-mixout-ctc-ssp.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
#
# Pipeline definitions
#
# PCM0 ---> gain ----> Mixin ----> Mixout ----> gain ----> CTC ----> SSP0
# PCM1 ---> gain ----> Mixin ----> Mixout ----> gain ----> CTC ----> SSP1
eddy1021 marked this conversation as resolved.
Show resolved Hide resolved
#
# The gain before mixin is for the different routes(e.g., deepbuffer, headset).

# Pipeline ID:1 PCM ID: 0
Object.Pipeline {
# playback pipelines
host-copier-gain-mixin-playback [
{
index $HEADSET_HOST_PIPELINE_ID

Object.Widget.host-copier.1 {
stream_name '$HEADSET_PLAYBACK_PCM_STREAM_NAME'
pcm_id $HEADSET_PCM_ID
}
Object.Widget.gain.1 {
Object.Control.mixer.1 {
name 'Pre Mixer $HEADSET_PCM_NAME Playback Volume'
}
}
}
{
index $SPEAKER_HOST_PIPELINE_ID

Object.Widget.host-copier.1 {
stream_name '$SPEAKER_PLAYBACK_PCM_STREAM_NAME'
pcm_id $SPEAKER_PCM_ID
}
Object.Widget.gain.1 {
Object.Control.mixer.1 {
name 'Pre Mixer $SPEAKER_PCM_NAME Playback Volume'
}
}
}
]

mixout-gain-ctc-dai-copier-playback [
eddy1021 marked this conversation as resolved.
Show resolved Hide resolved
{
index $HEADSET_DAI_PIPELINE_ID

Object.Widget.dai-copier.1 {
dai_index $HEADSET_SSP_DAI_INDEX
dai_type "SSP"
copier_type "SSP"
stream_name "$HEADSET_CODEC_NAME"
node_type $I2S_LINK_OUTPUT_CLASS
}

Object.Widget.gain.1 {
Object.Control.mixer.1 {
name 'Post Mixer $HEADSET_PCM_NAME Playback Volume'
}
}
}
{
index $SPEAKER_DAI_PIPELINE_ID

Object.Widget.dai-copier.1 {
dai_index $SPEAKER_SSP_DAI_INDEX
dai_type "SSP"
copier_type "SSP"
stream_name "$SPEAKER_CODEC_NAME"
node_type $I2S_LINK_OUTPUT_CLASS
}
Object.Widget.gain.1 {
Object.Control.mixer.1 {
name 'Post Mixer $SPEAKER_PCM_NAME Playback Volume'
}
}
Object.Widget.ctc.1 {
Object.Control.bytes."1" {
name 'CTC.0'
}
}
}
]
}

Object.Base.route [
{
source "gain.$HEADSET_DAI_PIPELINE_ID.1"
sink "dai-copier.SSP.$HEADSET_CODEC_NAME.playback"
}
{
source "mixin.$HEADSET_HOST_PIPELINE_ID.1"
sink "mixout.$HEADSET_DAI_PIPELINE_ID.1"
}
{
source "ctc.$SPEAKER_DAI_PIPELINE_ID.1"
sink "dai-copier.SSP.$SPEAKER_CODEC_NAME.playback"
}
{
source "mixin.$SPEAKER_HOST_PIPELINE_ID.1"
sink "mixout.$SPEAKER_DAI_PIPELINE_ID.1"
}
]
8 changes: 8 additions & 0 deletions tools/topology/topology2/cavs-rt5682.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
<host-copier-gain-mixin-playback.conf>
<mixout-gain-dai-copier-playback.conf>
<mixout-gain-eqiir-dts-dai-copier-playback.conf>
<mixout-gain-ctc-dai-copier-playback.conf>
<deepbuffer-playback.conf>
<dai-copier-be.conf>
<dai-copier-eqiir-module-copier-capture.conf>
Expand Down Expand Up @@ -48,6 +49,7 @@
<output_pin_binding.conf>
<input_audio_format.conf>
<output_audio_format.conf>
<ctc.conf>

Define {
MCLK 24576000
Expand Down Expand Up @@ -161,6 +163,7 @@ IncludeByKey.INCLUDE_BT_OFFLOAD {
IncludeByKey.PLAYBACK_PIPELINE_SRC {
"volume" "cavs-mixin-mixout-ssp.conf"
"dts" "cavs-mixin-mixout-eqiir-dts-ssp.conf"
"ctc" "cavs-mixin-mixout-ctc-ssp.conf"
}


Expand Down Expand Up @@ -321,6 +324,11 @@ Object.PCM.pcm [
Object.PCM.pcm_caps.1 {
name "$SPEAKER_PLAYBACK_PCM_STREAM_NAME"
formats 'S16_LE,S24_LE,S32_LE'
periods_max 16
period_size_min 192
period_size_max 16384
buffer_size_min 65536
buffer_size_max 65536
}
}
]
Expand Down
15 changes: 15 additions & 0 deletions tools/topology/topology2/development/tplg-targets.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,4 +230,19 @@ SPK_ID=6,SPEAKER_SSP_DAI_INDEX=0,HEADSET_CODEC_NAME=SSP2-Codec,SPEAKER_CODEC_NAM
BT_NAME=SSP1-BT,BT_INDEX=1,BT_ID=7,BT_PCM_NAME=Bluetooth,INCLUDE_ECHO_REF=true,\
GOOGLE_RTC_AEC_SUPPORT=1,DEEP_BUF_SPK=true,PLAYBACK_PIPELINE_SRC=volume,\
SSP_SPK_FMT_24=true,SSP_HS_FMT_24=true"

# mtl-rt1019 with CTC
"cavs-rt5682\;sof-mtl-rt1019-rt5682-ctc\;PLATFORM=mtl,NUM_DMICS=4,PDM1_MIC_A_ENABLE=1,\
PDM1_MIC_B_ENABLE=1,DMIC0_PCM_ID=99,SPK_ID=6,PREPROCESS_PLUGINS=nhlt,\
NHLT_BIN=nhlt-sof-max98357a-rt5682.bin,DEEPBUFFER_FW_DMA_MS=10,HEADSET_SSP_DAI_INDEX=2,\
SPEAKER_SSP_DAI_INDEX=0,HEADSET_CODEC_NAME=SSP2-Codec,SPEAKER_CODEC_NAME=SSP0-Codec,\
INCLUDE_ECHO_REF=true,INCLUDE_BT_OFFLOAD=false,PLAYBACK_PIPELINE_SRC=ctc"

# mtl-rt5650 with CTC
"cavs-rt5682\;sof-mtl-rt5650-ctc\;PLATFORM=mtl,NUM_DMICS=4,PDM1_MIC_A_ENABLE=1,\
PDM1_MIC_B_ENABLE=1,DMIC0_PCM_ID=99,PREPROCESS_PLUGINS=nhlt,\
NHLT_BIN=nhlt-sof-mtl-rt5650-dts.bin,DEEPBUFFER_FW_DMA_MS=10,HEADSET_SSP_DAI_INDEX=2,\
SPK_ID=6,SPEAKER_SSP_DAI_INDEX=0,HEADSET_CODEC_NAME=SSP2-Codec,SPEAKER_CODEC_NAME=SSP0-Codec,\
BT_NAME=SSP1-BT,BT_INDEX=1,BT_ID=7,BT_PCM_NAME=Bluetooth,INCLUDE_ECHO_REF=true,\
DEEP_BUF_SPK=true,PLAYBACK_PIPELINE_SRC=ctc,SSP_SPK_FMT_24=true,SSP_HS_FMT_24=true"
)
85 changes: 85 additions & 0 deletions tools/topology/topology2/include/components/ctc.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
#
# Common widget ctc
#
# A generic ctc widget. All attributes defined herein are namespaced
# by alsatplg to "Object.Widget.ctc.N.attribute_name"
#
# Usage: this component can be used by instantiating it in the parent object. i.e.
#
# Object.Widget.ctc."N" {
# index 1
# type "effect"
# }
#
# Where N is the unique instance number for the parent object.

Class.Widget."ctc" {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lgirdwood @ranj063 is there a way to set a min/max channel in widgets? I don't see anything in widget common. Might be useful for validation when pipelines define channels outside the range their components support.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding @singalsu too

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PCM has channels_min and channels_max but I don't know if it would here. In my experience when channels count can be other than default 2, it's better to list for the instances explicitly the in and out formats with possible channels counts (and all rates if non-48 kHz is possible). There's an arrays combiner than can help when there's many combinations.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense but is there a way to define that at the widget level.

E.g. dev A makes comp 1
Dev B makes pipeline with comp 1
Dev B fails to notice restrictions on formats

If format restrictions were part of the widget definition then it would be easy to identify if all widget formats were a superset of the pipelines set of supported formats. If they were a subset then the build would fail. Just a thought on finding bugs before runtime.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cujomalainey audio formats are always part of individual widgets. A pipeline does not define a superset of audio formats at all. But its an interesting idea to identify discrepancies in audio formats across widgets within the same pipeline and fail during topology build. Let me give it a thought.

#
# Pipeline ID for the CTC widget object
#
DefineAttribute."index" {
type "integer"
}

#
# Unique instance for CTC widget
#
DefineAttribute."instance" {
type "integer"
}

#include common component definition
<include/components/widget-common.conf>

# Attribute categories
attributes {
#
# The CTC widget name would be constructed using the index and instance attributes.
#
!constructor [
"index"
"instance"
]

#
# mandatory attributes that must be provided when the class is instantiated
#
!mandatory [
"uuid"
"num_input_audio_formats"
"num_output_audio_formats"
]

#
# immutable attributes cannot be modified in the object instance
#
!immutable [
"uuid"
"type"
]

#
# deprecated attributes should not be added in the object instance
#
!deprecated [
"preload_count"
]

#
# DTS widget objects instantiated within the same alsaconf node must have unique
# instance attribute
#
unique "instance"
}

Object.Control.bytes."1" {
max 4124
}

# Default attribute values for CTC widget
uuid "bc:1b:0e:bf:6a:dc:fe:45:bc:90:25:54:cb:13:7a:b4"
type "effect"
no_pm "true"
num_input_pins 1
num_output_pins 1
}
71 changes: 71 additions & 0 deletions tools/topology/topology2/include/pipelines/cavs/mixout-gain-ctc-dai-copier-playback.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
#
eddy1021 marked this conversation as resolved.
Show resolved Hide resolved
# BE playback pipeline: mixout-gain-ctc-dai-copier.
# This pipeline is an extension of the mixout-gain-dai-copier-playback pipeline class.
#
# All attributes defined herein are namespaced
# by alsatplg to "Object.Pipeline.mixout-gain-ctc-dai-copier-playback.N.attribute_name"
#
# Usage: mixout-gain-ctc-dai-copier-playback pipeline object can be instantiated as:
#
# Object.Pipeline.mixout-gain-ctc-dai-copier-playback."N" {
# period 1000
# time_domain "timer"
# }
#
# Where N is the unique pipeline ID within the same alsaconf node.
#

<include/common/input_audio_format.conf>
<include/common/output_audio_format.conf>
<include/components/dai-copier.conf>
<include/components/gain.conf>
<include/components/mixout.conf>
<include/components/pipeline.conf>
<include/components/ctc.conf>
<platform/intel/efx-default.conf>
<include/pipelines/cavs/mixout-gain-dai-copier-playback.conf>

Class.Pipeline."mixout-gain-ctc-dai-copier-playback" {
SubTreeCopy.baseclass {
# this class extends the mixout-gain-dai-copier-playback class definition
source "Class.Pipeline.mixout-gain-dai-copier-playback"

# target node is not defined which means that the new subtree will be copied to
# the parent node containing the SubTreeCopy node i.e in this case the
# Class.Pipeline.mixout-gain-ctc-dai-copier-playback {} node.

# default copy type is to extend the base class ie the widgets and routes
# will be added to the existing list of widgets/routes in the base class

tree {
Object.Widget {
ctc."1" {
num_input_audio_formats 1
num_output_audio_formats 1

Object.Base.input_audio_format [
{
in_bit_depth 32
in_valid_bit_depth 32
}
]
Object.Base.output_audio_format [
{
out_bit_depth 32
out_valid_bit_depth 32
}
]
}
}

Object.Base {
! route [
{
source gain.$index.1
sink ctc.$index.1
}
]
}
}
}
}