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.

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

Added tooltip for echo cancellation #4174

Merged
merged 2 commits into from May 15, 2020

Conversation

Krzmbrzl
Copy link
Member

@Krzmbrzl Krzmbrzl commented May 14, 2020

This tooltip explains the difference between mixed and multichannel echo cancellation.

Most of the wording and the info comes from @fedetft

Fixes #4125

Updating 'mumble_en.ts'...
    Found 1773 source text(s) (1 new and 1772 already existing)
    Removed 1 obsolete entries
@Krzmbrzl Krzmbrzl merged commit 803ef7f into mumble-voip:master May 15, 2020
@toby63
Copy link
Contributor

toby63 commented May 15, 2020

Ok, a good start, but still some things could be improved:
Update: See below for newer version: #4174 (comment)

  • what is meant by "speaker outputs"?
    I know what it means, but others might not; also in the next sentence you use the term "audio channels", I think one term should be used.
    I suggest the term "audio output".

  • I assume "multichannel echo cancel" is better? That could be mentioned.

  • Overall: The explanation in Echo cancellation - explain difference #4125 (comment) might be used for this instead (as far as I understand it):

    • mixed echo cancel: for setups with audio outputs near to the microphone
    • multichannel echo cancel: for setups with audio outputs far away from the microphone

@streaps
Copy link

streaps commented May 16, 2020

I think "speaker" is important to mention. If you are using the a headphone for listening to the "audio output" echo might not be a problem at all. I understand an audio output as something where I can plug in a cable (physical or virtual) or a device. The thing that transmits sound over the air to the microphone is a speaker or multiple speakers.

I agree the explanation could be simpler with fewer technical terms.

I wonder how much CPU is used by the multichannel echo canceller. If it is negligible the recommendation (and the default setting) could be different.

@streaps
Copy link

streaps commented May 16, 2020

Okay, CPU usage is still a problem: #4177

@fedetft
Copy link
Contributor

fedetft commented May 16, 2020

See #4178 for reasons why I think echo cancellation should be enabled by default.

@streaps
Copy link

streaps commented May 16, 2020

Btw, it's called acoustic echo cancellation (AEC).

@toby63
Copy link
Contributor

toby63 commented May 16, 2020

@streaps

I think "speaker" is important to mention.

In general I agree, but I don't know if everyone understands speaker correctly...
Still I know no better alternative.

Regarding the tooltip, maybe we could use a combination of practical and technical description:

If enabled this tries to cancel out echo from the audio you send to others:
 * mixed echo cancel: for setups with loudspeakers near to the microphone (bundles all audio output, lesser cpu usage, less accurate)
 * multichannel echo cancel: for setups with (multiple) loudspeakers farther away from the microphone (processes audio outputs seperately, this is more accurate, but higher cpu usage)
In case of doubt: Try "mixed echo cancel" first.

Edit: added "loudspeaker" as replacement for speakers-

@streaps
Copy link

streaps commented May 17, 2020

maybe "loudspeaker" is less ambiguous than speaker in this case.

@Krzmbrzl
Copy link
Member Author

@streaps @toby63 I agree that the tooltip could probably be improved. I was just happy to have found an explanation so I immediately used that ^^

I think this would be an excellent place for you guys to create a PR of your own. After all it's your thoughts that are currently going into improving the tooltip. The relevant code are you can see from this PR :)
What do you think?

@toby63
Copy link
Contributor

toby63 commented May 17, 2020

Ok, will probably add a pull request, hope that works 😄.

Just in case I will post the result also here (only as text of course).

@Krzmbrzl
Copy link
Member Author

Krzmbrzl commented May 18, 2020

Just in case I will post the result also here (only as text of course).

I don't think that's necessary :)

@toby63
Copy link
Contributor

toby63 commented May 18, 2020

I just noticed something:
the tooltip will disappear after about 8-10 seconds.
It is also much longer than all other tooltips I have seen.

Maybe a better idea would be to add a button behind the echo cancel-options, like:
(?)
This would also be more "obvious" for users.

But it's your decision, if you want a tooltip I will release a pull request for it.

@Krzmbrzl
Copy link
Member Author

I agree that it is longer but we use tooltips everywhere else so I think it'd be kinda a break of style if we add an info button for this entry 🤔

@toby63
Copy link
Contributor

toby63 commented May 19, 2020

I think it'd be kinda a break of style if we add an info button for this entry thinking

I don't think so, you could still have a tooltip (just like before "describing the obvious" 😛)
And then in addition to that, a button that explains the function with a little detail.

I think you could (and maybe should) add also more of those buttons, to explain other audio options as well.
I think thats very convenient and as far as I remember I have also seen it in other programs.

@Krzmbrzl
Copy link
Member Author

We can do stuff like that once we have cleared the pipelines of more pressing issues. There are multiple issues about how the UI could be enhanced already but we just don't have the time to prioritize it....

@toby63
Copy link
Contributor

toby63 commented Jun 16, 2020

One question related to #4279:
Have you added this as an extended tooltip as well?

@Krzmbrzl
Copy link
Member Author

No - only normal tooltip

@Krzmbrzl Krzmbrzl deleted the echo-cancel-tooltip branch November 9, 2022 17:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Echo cancellation - explain difference
4 participants