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

[sonos] Play notification while playing virtual line-in #10599

Merged
merged 4 commits into from
May 5, 2021
Merged

[sonos] Play notification while playing virtual line-in #10599

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3f1e971
[sonos] Play notification while playing virtual line-in
lolodomo Apr 27, 2021
16f0b3f
Add a log in case the notification feature is not yet implemented
lolodomo Apr 28, 2021
34b8ed2
Rename few methods for better meaning
lolodomo Apr 28, 2021
a867b8b
Merge remote-tracking branch 'origin/main' into sonos_vli
lolodomo May 3, 2021
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
92 changes: 63 additions & 29 deletions ...ing.sonos/src/main/java/org/openhab/binding/sonos/internal/handler/ZonePlayerHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ public class ZonePlayerHandler extends BaseThingHandler implements UpnpIOPartici

private static final String ANALOG_LINE_IN_URI = "x-rincon-stream:";
private static final String OPTICAL_LINE_IN_URI = "x-sonos-htastream:";
private static final String VIRTUAL_LINE_IN_URI = "x-sonos-vli:";
private static final String QUEUE_URI = "x-rincon-queue:";
private static final String GROUP_URI = "x-rincon:";
private static final String STREAM_URI = "x-sonosapi-stream:";
Expand Down Expand Up @@ -482,19 +483,19 @@ public void onValueReceived(@Nullable String variable, @Nullable String value, @
this.stateMap.put(variable, value);

// pre-process some variables, eg XML processing
if (service.equals(SERVICE_AV_TRANSPORT) && variable.equals("LastChange")) {
if (SERVICE_AV_TRANSPORT.equals(service) && "LastChange".equals(variable)) {
Map<String, String> parsedValues = SonosXMLParser.getAVTransportFromXML(value);
parsedValues.forEach((variable1, value1) -> {
// Update the transport state after the update of the media information
// to not break the notification mechanism
if (!variable1.equals("TransportState")) {
if (!"TransportState".equals(variable1)) {
onValueReceived(variable1, value1, service);
}
// Translate AVTransportURI/AVTransportURIMetaData to CurrentURI/CurrentURIMetaData
// for a compatibility with the result of the action GetMediaInfo
if (variable1.equals("AVTransportURI")) {
if ("AVTransportURI".equals(variable1)) {
onValueReceived("CurrentURI", value1, service);
} else if (variable1.equals("AVTransportURIMetaData")) {
} else if ("AVTransportURIMetaData".equals(variable1)) {
onValueReceived("CurrentURIMetaData", value1, service);
}
});
Expand All @@ -504,7 +505,7 @@ public void onValueReceived(@Nullable String variable, @Nullable String value, @
}
}

if (service.equals(SERVICE_RENDERING_CONTROL) && variable.equals("LastChange")) {
if (SERVICE_RENDERING_CONTROL.equals(service) && "LastChange".equals(variable)) {
Map<String, String> parsedValues = SonosXMLParser.getRenderingControlFromXML(value);
parsedValues.forEach((variable1, value1) -> {
onValueReceived(variable1, value1, service);
Expand Down Expand Up @@ -648,12 +649,12 @@ public void onValueReceived(@Nullable String variable, @Nullable String value, @
updateChannel(CURRENTALBUMARTURL);
break;
case "CurrentSleepTimerGeneration":
if (value.equals("0")) {
if ("0".equals(value)) {
updateState(SLEEPTIMER, new DecimalType(0));
}
break;
case "SleepTimerGeneration":
if (value.equals("0")) {
if ("0".equals(value)) {
updateState(SLEEPTIMER, new DecimalType(0));
} else {
updateSleepTimerDuration();
Expand Down Expand Up @@ -1747,14 +1748,12 @@ protected void restoreState() {
}

String transportState = state.transportState;
if (transportState != null) {
if (transportState.equals(STATE_PLAYING)) {
play();
} else if (transportState.equals(STATE_STOPPED)) {
stop();
} else if (transportState.equals(STATE_PAUSED_PLAYBACK)) {
pause();
}
if (STATE_PLAYING.equals(transportState)) {
play();
} else if (STATE_STOPPED.equals(transportState)) {
stop();
} else if (STATE_PAUSED_PLAYBACK.equals(transportState)) {
pause();
}
}
}
Expand Down Expand Up @@ -2583,13 +2582,17 @@ public void playNotificationSoundURI(Command notificationURL) {

if (isPlayingStream(currentURI) || isPlayingRadioStartedByAmazonEcho(currentURI)
|| isPlayingRadio(currentURI)) {
handleRadioStream(currentURI, notificationURL, coordinator);
handleNotifForRadioStream(currentURI, notificationURL, coordinator);
} else if (isPlayingLineIn(currentURI)) {
handleLineIn(currentURI, notificationURL, coordinator);
handleNotifForLineIn(currentURI, notificationURL, coordinator);
} else if (isPlayingVirtualLineIn(currentURI)) {
handleNotifForVirtualLineIn(currentURI, notificationURL, coordinator);
} else if (isPlayingQueue(currentURI)) {
handleSharedQueue(currentURI, notificationURL, coordinator);
handleNotifForSharedQueue(currentURI, notificationURL, coordinator);
} else if (isPlaylistEmpty(coordinator)) {
handleEmptyQueue(notificationURL, coordinator);
handleNotifForEmptyQueue(notificationURL, coordinator);
} else {
logger.debug("Notification feature not yet implemented while the current media is being played");
}
synchronized (notificationLock) {
notificationLock.notify();
Expand Down Expand Up @@ -2635,6 +2638,10 @@ private boolean isPlayingOpticalLineIn(@Nullable String currentURI) {
return currentURI != null && currentURI.startsWith(OPTICAL_LINE_IN_URI) && currentURI.endsWith(SPDIF);
}

private boolean isPlayingVirtualLineIn(@Nullable String currentURI) {
return currentURI != null && currentURI.startsWith(VIRTUAL_LINE_IN_URI);
}

/**
* Does a chain of predefined actions when a Notification sound is played by
* {@link ZonePlayerHandler#playNotificationSoundURI(Command)} in case
Expand All @@ -2645,7 +2652,7 @@ private boolean isPlayingOpticalLineIn(@Nullable String currentURI) {
* @param coordinator - {@link ZonePlayerHandler} coordinator for the SONOS device(s)
* @throws InterruptedException
*/
private void handleRadioStream(@Nullable String currentStreamURI, Command notificationURL,
private void handleNotifForRadioStream(@Nullable String currentStreamURI, Command notificationURL,
ZonePlayerHandler coordinator) throws InterruptedException {
String nextAction = coordinator.getTransportState();
SonosMetaData track = coordinator.getTrackMetadata();
Expand All @@ -2669,19 +2676,44 @@ private void handleRadioStream(@Nullable String currentStreamURI, Command notifi
* @param coordinator - {@link ZonePlayerHandler} coordinator for the SONOS device(s)
* @throws InterruptedException
*/
private void handleLineIn(@Nullable String currentLineInURI, Command notificationURL, ZonePlayerHandler coordinator)
throws InterruptedException {
private void handleNotifForLineIn(@Nullable String currentLineInURI, Command notificationURL,
ZonePlayerHandler coordinator) throws InterruptedException {
logger.debug("Handling notification while sound from line-in was being played");
String nextAction = coordinator.getTransportState();

handleNotificationSound(notificationURL, coordinator);
if (currentLineInURI != null) {
logger.debug("Restoring sound from line-in using {}", currentLineInURI);
logger.debug("Restoring sound from line-in using URI {}", currentLineInURI);
coordinator.setCurrentURI(currentLineInURI, "");
restoreLastTransportState(coordinator, nextAction);
}
}

/**
* Does a chain of predefined actions when a Notification sound is played by
* {@link ZonePlayerHandler#playNotificationSoundURI(Command)} in case
* virtual line in is currently loaded
*
* @param currentVirtualLineInURI - the currently loaded virtual line-in URI
* @param notificationURL - the notification url in the format of //host/folder/filename.mp3
* @param coordinator - {@link ZonePlayerHandler} coordinator for the SONOS device(s)
* @throws InterruptedException
*/
private void handleNotifForVirtualLineIn(@Nullable String currentVirtualLineInURI, Command notificationURL,
ZonePlayerHandler coordinator) throws InterruptedException {
logger.debug("Handling notification while sound from virtual line-in was being played");
String nextAction = coordinator.getTransportState();
String currentUriMetaData = coordinator.getCurrentURIMetadataAsString();

handleNotificationSound(notificationURL, coordinator);
if (currentVirtualLineInURI != null && currentUriMetaData != null) {
logger.debug("Restoring sound from virtual line-in using URI {} and metadata {}", currentVirtualLineInURI,
currentUriMetaData);
coordinator.setCurrentURI(currentVirtualLineInURI, currentUriMetaData);
restoreLastTransportState(coordinator, nextAction);
}
}

/**
* Does a chain of predefined actions when a Notification sound is played by
* {@link ZonePlayerHandler#playNotificationSoundURI(Command)} in case
Expand All @@ -2692,13 +2724,14 @@ private void handleLineIn(@Nullable String currentLineInURI, Command notificatio
* @param coordinator - {@link ZonePlayerHandler} coordinator for the SONOS device(s)
* @throws InterruptedException
*/
private void handleSharedQueue(@Nullable String currentQueueURI, Command notificationURL,
private void handleNotifForSharedQueue(@Nullable String currentQueueURI, Command notificationURL,
ZonePlayerHandler coordinator) throws InterruptedException {
String nextAction = coordinator.getTransportState();
String trackPosition = coordinator.getRefreshedPosition();
long currentTrackNumber = coordinator.getRefreshedCurrenTrackNr();
logger.debug("handleSharedQueue: currentQueueURI {} trackPosition {} currentTrackNumber {}", currentQueueURI,
trackPosition, currentTrackNumber);
logger.debug(
"Handling notification while playing queue: currentQueueURI {} trackPosition {} currentTrackNumber {}",
currentQueueURI, trackPosition, currentTrackNumber);

handleNotificationSound(notificationURL, coordinator);
String queueUri = QUEUE_URI + coordinator.getUDN() + "#0";
Expand Down Expand Up @@ -2766,7 +2799,8 @@ private void restoreLastTransportState(ZonePlayerHandler coordinator, @Nullable
* @param coordinator - {@link ZonePlayerHandler} coordinator for the SONOS device(s)
* @throws InterruptedException
*/
private void handleEmptyQueue(Command notificationURL, ZonePlayerHandler coordinator) throws InterruptedException {
private void handleNotifForEmptyQueue(Command notificationURL, ZonePlayerHandler coordinator)
throws InterruptedException {
String originalVolume = coordinator.getVolume();
coordinator.applyNotificationSoundVolume();
coordinator.playURI(notificationURL);
Expand Down Expand Up @@ -2951,7 +2985,7 @@ public void playTuneinStation(Command command) {
// search for the TuneIn music service based on its name
if (allServices != null) {
for (SonosMusicService service : allServices) {
if (service.getName().equals("TuneIn")) {
if ("TuneIn".equals(service.getName())) {
tuneinService = service;
break;
}
Expand Down Expand Up @@ -2999,7 +3033,7 @@ public void playTuneinStation(Command command) {

int idx = 0;
for (SonosMusicService service : services) {
if (!service.getName().equals("TuneIn")) {
if (!"TuneIn".equals(service.getName())) {
// Add the service type integer value from "AvailableServiceTypeList" to each service
// except TuneIn
if (idx < servicesTypes.length) {
Expand Down