Improve the source labels for MusicCast players

[micha91]

Breaking change

If you have any automation depending on the source state attribute of the media player entity, you will have to update these, because we want to show more user friendly values such as "Net Radio" instead of net_radio. Calling the select_source service will still be possible using the old source names.

Proposed change

In the MusicCast app and in the display of the devices, the network related sources are shown in a more user friendly way as the values, which are used in the API. With this PR we use these alternative labels. For devices supporting external sources such as HDMI sources, it is possible to rename these sources in the app. Because the user is completely free to label two sources in the same way, we ensure that the source labels do not conflict with other sources. If there are conflicts such as HDMI 1 and HDMI 2 both labeled with "Apple TV", we name one of the sources as "Apple TV (hdmi1)" and the other "Apple TV (hdmi2)". To enable users to write automations without having to care about the user defined source names, it is still possible to call the select_source service with the original source names.
In my opinion, it would be best to edit the media_player entity structure and the frontend to show these user defined labels only in the frontend and work with the original unique API defined values for service calls and states. However there was not enough positive feedback for that in the architecture discussion, so we go this way.

Type of change

• Dependency upgrade
• Bugfix (non-breaking change which fixes an issue)
• New integration (thank you!)
• New feature (which adds functionality to an existing integration)
• Deprecation (breaking change to happen in the future)
• Breaking change (fix/feature causing existing functionality to break)
• Code quality improvements to existing code or addition of tests

Additional information

• This PR fixes or closes issue: fixes Yamaha musiccast integration doesn't use configured source names #56525
• This PR is related to issue:
• Link to documentation pull request:

Checklist

• The code change is tested and works locally.
• Local tests pass. Your PR cannot be merged unless tests pass
• There is no commented out code in this PR.
• I have followed the development checklist
• The code has been formatted using Black (black --fast homeassistant tests)
• Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

• Documentation added/updated for www.home-assistant.io

If the code communicates with devices, web services, or third-party tools:

• The manifest file has all fields filled out correctly.
  Updated and included derived files by running: python3 -m script.hassfest.
• New or updated dependencies have been added to requirements_all.txt.
  Updated by running python3 -m script.gen_requirements_all.
• For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
• Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

• No score or internal
• 🥈 Silver
• 🥇 Gold
• 🏆 Platinum

To help with the load of incoming pull requests:

• I have reviewed two other open pull requests in this repository.

[probot-home-assistant]

Hey there @vigonotion, mind taking a look at this pull request as it has been labeled with an integration (yamaha_musiccast) you are listed as a code owner for? Thanks!
_{^{(message by CodeOwnersMention)}}

[frenck]

Calling the select_source service will still be possible using the old source names.

So it is not a breaking change?

[micha91]

Calling the select_source service will still be possible using the old source names.

So it is not a breaking change?

It is a breaking change for those who use the current source e.g. as a trigger by using a template such as {{is_state_attr('media_player.buro', 'source', 'airplay')}}. I just edited the text to hopefully clarify that.

[github-actions]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
Thank you for your contributions.

[KevinCathcart]

These changes all make sense. The only complicated part is the source mapping property and that looks to handle all the edge cases.

The other changes are simple and pretty obviously correct.

[github-actions]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
Thank you for your contributions.

[micha91]

I would still love to get this merged

[OzGav]

This looks good with no previous objections from others I think it should be approved.

[marcelveldt]

Sorry for the late final review. We're really swamped with PR's and trying to catch up reviewing them.

Adding a small test for this logic would even be better but overall this PR looks solid to be merged.

Thanks!