Skip to content

Prepare for modules with multiple input/output pins#7014

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

Merged
kv2019i merged 2 commits into from
Feb 2, 2023
Merged

Prepare for modules with multiple input/output pins #7014

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
32c7890
topology2: widget-common: Add 2 new tokens for input/output audio for…
ranj063 Jan 31, 2023
d4f2db3
topology2: common: Add new class definitions for input/output audio f…
ranj063 Feb 1, 2023
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
137 changes: 137 additions & 0 deletions tools/topology/topology2/include/common/sink_audio_format.conf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
# Class definition for sink pin audio format object

@ujfalusiujfalusiFeb 2, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'm confused.
Don't we have support for pins other than index 0? I would thin that they somehow work and somehow they actually get audio format, no?

Isn't the problem lies that we have only one set of audio format definition, which is global for the whole module and for all of it's pins?

@ranj063ranj063Feb 2, 2023

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

@ujfalusi we dont. The only audio formats we use today are for pin 0 and always intput and output together in pairs. Clearly this wont work

# audio_format objects can be instantiated as:
#
# Object.Base.sink_audio_format."0" {
# in_rate 48000
# in_sample_container_size 16
# in_valid_bit_depth 16
# in_interleaving_style "interleaved"

# }
#

Class.Base."sink_audio_format" {

DefineAttribute."instance" {
}

DefineAttribute."pin_index" {
# Token set reference name
token_ref "sof_tkn_cavs_audio_format.word"
}

# input sampling rate
DefineAttribute."in_rate" {
# Token set reference name
token_ref "sof_tkn_cavs_audio_format.word"
}

# input bit depth
DefineAttribute."in_bit_depth" {
# Token set reference name
token_ref "sof_tkn_cavs_audio_format.word"
}

# input valid bit depth
DefineAttribute."in_valid_bit_depth" {
# Token set reference name
token_ref "sof_tkn_cavs_audio_format.word"
}

# input channel count
DefineAttribute."in_channels" {
# Token set reference name
token_ref "sof_tkn_cavs_audio_format.word"
constraints {
min 1
max 8
}
}

# input channel map
DefineAttribute."in_ch_map" {
# Token set reference name
token_ref "sof_tkn_cavs_audio_format.word"
}

# input channel config
DefineAttribute."in_ch_cfg" {
# Token set reference name
token_ref "sof_tkn_cavs_audio_format.word"
}

# input interleaving style
DefineAttribute."in_interleaving_style" {
type "string"
# Token set reference name
token_ref "sof_tkn_cavs_audio_format.word"
constraints {
!valid_values [
"interleaved"
"non-interleaved"
]
!tuple_values [
0
1
]
}
}

# input format config
DefineAttribute."in_fmt_cfg" {
# Token set reference name
token_ref "sof_tkn_cavs_audio_format.word"
}

# input sample_type
DefineAttribute."in_sample_type" {
type string
# Token set reference name
token_ref "sof_tkn_cavs_audio_format.word"
constraints {
!valid_values [
$SAMPLE_TYPE_MSB_INTEGER
$SAMPLE_TYPE_LSB_INTEGER
$SAMPLE_TYPE_SIGNED_INTEGER
$SAMPLE_TYPE_UNSIGNED_INTEGER
$SAMPLE_TYPE_FLOAT
]
}
}

#
# input buffer size
#
DefineAttribute."ibs" {
# Token set reference name and type
token_ref "sof_tkn_cavs_audio_format.word"
}

attributes {
!constructor [
"instance"
]

#
# audio_format objects instantiated within the same alsaconf node must have unique
# instance attribute values
#
unique "instance"
}

in_rate 48000
in_bit_depth 16
in_valid_bit_depth 16
in_channels 2
in_interleaving_style "interleaved"
in_sample_type $SAMPLE_TYPE_MSB_INTEGER
in_ch_cfg $CHANNEL_CONFIG_STEREO
in_ch_map $CHANNEL_MAP_STEREO

# math expression for computing input/output fmt_cfg
in_fmt_cfg "$[($in_channels | ($in_valid_bit_depth * 256)) | ($in_sample_type * 65536)]"

# math expression for computing input/put buffer sizes
# for 11.025 22.05, 44.1, 88.2 and 176.4khz, we need to round it to ceiling value
ibs "$[($in_channels * ($[($in_rate + 999)] / 1000)) * ($in_bit_depth / 8)]"
}
137 changes: 137 additions & 0 deletions tools/topology/topology2/include/common/source_audio_format.conf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
# Class definition for spirce pin audio format object
# audio_format objects can be instantiated as:
#
# Object.Base.source_audio_format."0" {
# out_rate 48000
# out_sample_container_size 16
# out_valid_bit_depth 16
# out_interleaving_style "interleaved"

# }
#

Class.Base."source_audio_format" {

DefineAttribute."instance" {
}

DefineAttribute."pin_index" {
# Token set reference name
token_ref "sof_tkn_cavs_audio_format.word"
}

# output sampling rate
DefineAttribute."out_rate" {
# Token set reference name
token_ref "sof_tkn_cavs_audio_format.word"
}

# output bit depth
DefineAttribute."out_bit_depth" {
# Token set reference name
token_ref "sof_tkn_cavs_audio_format.word"
}

# output valid bit depth
DefineAttribute."out_valid_bit_depth" {
# Token set reference name
token_ref "sof_tkn_cavs_audio_format.word"
}

# output channel count
DefineAttribute."out_channels" {
# Token set reference name
token_ref "sof_tkn_cavs_audio_format.word"
constraints {
min 1
max 8
}
}

# output channel map
DefineAttribute."out_ch_map" {
# Token set reference name
token_ref "sof_tkn_cavs_audio_format.word"
}

# output channel config
DefineAttribute."out_ch_cfg" {
# Token set reference name
token_ref "sof_tkn_cavs_audio_format.word"
}

# output interleaving style
DefineAttribute."out_interleaving_style" {
type "string"
# Token set reference name
token_ref "sof_tkn_cavs_audio_format.word"
constraints {
!valid_values [
"interleaved"
"non-interleaved"
]
!tuple_values [
0
1
]
}
}

# output format config
DefineAttribute."out_fmt_cfg" {
# Token set reference name
token_ref "sof_tkn_cavs_audio_format.word"
}

#
# output buffer size
#
DefineAttribute."obs" {
# Token set reference name and type
token_ref "sof_tkn_cavs_audio_format.word"
}

#output sample_type
DefineAttribute."out_sample_type" {
type string
# Token set reference name
token_ref "sof_tkn_cavs_audio_format.word"
constraints {
!valid_values [
$SAMPLE_TYPE_MSB_INTEGER
$SAMPLE_TYPE_LSB_INTEGER
$SAMPLE_TYPE_SIGNED_INTEGER
$SAMPLE_TYPE_UNSIGNED_INTEGER
$SAMPLE_TYPE_FLOAT
]
}
}

attributes {
!constructor [
"instance"
]

#
# output_audio_format objects instantiated within the same alsaconf node must have
# unique instance attribute values
#
unique "instance"
}

out_rate 48000
out_bit_depth 16
out_valid_bit_depth 16
out_channels 2
out_interleaving_style "interleaved"
out_sample_type $SAMPLE_TYPE_MSB_INTEGER
out_ch_cfg $CHANNEL_CONFIG_STEREO
out_ch_map $CHANNEL_MAP_STEREO

# math expression for computing output fmt_cfg
out_fmt_cfg "$[($out_channels | ($out_valid_bit_depth * 256)) | ($out_sample_type * 65536)]"

# math expression for computing input/put buffer sizes
# for 11.025 22.05, 44.1, 88.2 and 176.4khz, we need to round it to ceiling value
obs "$[($out_channels * ($[($out_rate + 999)] / 1000)) * ($out_bit_depth / 8)]"
}
3 changes: 3 additions & 0 deletions tools/topology/topology2/include/common/tokens.conf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,8 @@ Object.Base.VendorToken {
# the widget name that the queue is connected from/to.
sink_pin_binding_wname 413
src_pin_binding_wname 414
num_sink_audio_formats 415
num_source_audio_formats 416
}

"2" {
Expand DownExpand Up@@ -160,6 +162,7 @@ Object.Base.VendorToken {
in_interleaving_style 1906
in_fmt_cfg 1907
in_sample_type 1908
pin_index 1909

@plbossartplbossartFeb 1, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

does this belong in this PR? I don't see the link with input/output

@ranj063ranj063Feb 1, 2023

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

It's a token needed for the pin_index attributes in the new classes

# tokens up to 1929 reserved for future use
out_rate 1930
out_bit_depth 1931
Expand Down
2 changes: 2 additions & 0 deletions tools/topology/topology2/include/components/cavs/src_format.conf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
#src format array
num_audio_formats 42
num_sink_audio_formats 42
num_source_audio_formats 42

# 8khz input
Object.Base.audio_format.1 {
Expand Down
2 changes: 2 additions & 0 deletions tools/topology/topology2/include/components/cavs/src_passthrough_format.conf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
#src format array
num_audio_formats 42
num_sink_audio_formats 42
num_source_audio_formats 42

# 8khz input
Object.Base.audio_format.1 {
Expand Down
2 changes: 2 additions & 0 deletions tools/topology/topology2/include/components/copier.conf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -167,6 +167,8 @@ Class.Widget."copier" {
"copier_type"
"num_sink_pins"
"num_source_pins"
"num_sink_audio_formats"
"num_source_audio_formats"
]

#
Expand Down
2 changes: 2 additions & 0 deletions tools/topology/topology2/include/components/gain.conf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,8 @@ Class.Widget."gain" {
!mandatory [
"num_sink_pins"
"num_source_pins"
"num_sink_audio_formats"
"num_source_audio_formats"
]

#
Expand Down
3 changes: 3 additions & 0 deletions tools/topology/topology2/include/components/kpb.conf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -79,6 +79,9 @@ Class.Widget."kpb" {
type "effect"

num_audio_formats 1
num_sink_audio_formats 1
num_source_audio_formats 1

#UUID: D8218443-5FF3-4A4C-B388-6CFE07B9562E
uuid "43:84:21:d8:f3:5f:4c:4a:b3:88:6c:fe:07:b9:56:2e"
no_pm "true"
Expand Down
2 changes: 2 additions & 0 deletions tools/topology/topology2/include/components/micsel.conf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,8 @@ Class.Widget."micsel" {
payload_with_output_fmt 1

num_audio_formats 1
num_sink_audio_formats 1
num_source_audio_formats 1
#UUID: 32FE92C1-1E17-4FC2-9758-C7F3542E980A
uuid "c1:92:fe:32:17:1e:c2:4f:97:58:c7:f3:54:2e:98:0a"
no_pm "true"
Expand Down
2 changes: 2 additions & 0 deletions tools/topology/topology2/include/components/mixin.conf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -129,4 +129,6 @@ Class.Widget."mixin" {
cpc 910
num_sink_pins 1
num_source_pins 3
num_sink_audio_formats 2
num_source_audio_formats 2
}
2 changes: 2 additions & 0 deletions tools/topology/topology2/include/components/mixout.conf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -101,6 +101,8 @@ Class.Widget."mixout" {

# Only 32-bit depth format is supported by mixout
num_audio_formats 2
num_sink_audio_formats 2
num_source_audio_formats 2
# 32-bit 48KHz 2ch
Object.Base.audio_format.1 {
in_bit_depth 32
Expand Down
2 changes: 2 additions & 0 deletions tools/topology/topology2/include/components/src.conf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,8 @@ Class.Widget."src" {
!mandatory [
"format"
"rate_out"
"num_sink_audio_formats"
"num_source_audio_formats"
]

#
Expand Down
12 changes: 12 additions & 0 deletions tools/topology/topology2/include/components/widget-common.conf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -97,3 +97,15 @@ DefineAttribute."num_source_pins" {
# Token set reference name and type
token_ref "sof_tkn_comp.word"
}

# Number of supported sink(input) audio formats
DefineAttribute."num_sink_audio_formats" {
# Token set reference name and type
token_ref "sof_tkn_comp.word"
}

# Number of supported source(output) audio formats
DefineAttribute."num_source_audio_formats" {
# Token set reference name and type
token_ref "sof_tkn_comp.word"
}
2 changes: 2 additions & 0 deletions tools/topology/topology2/include/components/wov.conf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -68,6 +68,8 @@ Class.Widget."wov" {
!mandatory [
"no_pm"
"uuid"
"num_sink_audio_formats"
"num_source_audio_formats"
]

#
Expand Down
Loading