git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2023 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   7  * This program and the accompanying materials are made available under the
   8  * terms of the Eclipse Public License 2.0 which is available at
   9  * http://www.eclipse.org/legal/epl-2.0
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.binding.upnpcontrol.internal.handler;
  14
  15 import static org.openhab.binding.upnpcontrol.internal.UpnpControlBindingConstants.*;
  16
  17 import java.net.URLDecoder;
  18 import java.nio.charset.StandardCharsets;
  19 import java.time.Instant;
  20 import java.util.ArrayList;
  21 import java.util.Arrays;
  22 import java.util.Collections;
  23 import java.util.HashMap;
  24 import java.util.HashSet;
  25 import java.util.List;
  26 import java.util.Map;
  27 import java.util.Set;
  28 import java.util.concurrent.CompletableFuture;
  29 import java.util.concurrent.ConcurrentHashMap;
  30 import java.util.concurrent.ExecutionException;
  31 import java.util.concurrent.ScheduledFuture;
  32 import java.util.concurrent.TimeUnit;
  33 import java.util.concurrent.TimeoutException;
  34 import java.util.regex.Matcher;
  35 import java.util.regex.Pattern;
  36 import java.util.stream.Collectors;
  37
  38 import org.eclipse.jdt.annotation.NonNullByDefault;
  39 import org.eclipse.jdt.annotation.Nullable;
  40 import org.jupnp.model.meta.RemoteDevice;
  41 import org.openhab.binding.upnpcontrol.internal.UpnpChannelName;
  42 import org.openhab.binding.upnpcontrol.internal.UpnpDynamicCommandDescriptionProvider;
  43 import org.openhab.binding.upnpcontrol.internal.UpnpDynamicStateDescriptionProvider;
  44 import org.openhab.binding.upnpcontrol.internal.audiosink.UpnpAudioSinkReg;
  45 import org.openhab.binding.upnpcontrol.internal.config.UpnpControlBindingConfiguration;
  46 import org.openhab.binding.upnpcontrol.internal.config.UpnpControlRendererConfiguration;
  47 import org.openhab.binding.upnpcontrol.internal.queue.UpnpEntry;
  48 import org.openhab.binding.upnpcontrol.internal.queue.UpnpEntryQueue;
  49 import org.openhab.binding.upnpcontrol.internal.queue.UpnpFavorite;
  50 import org.openhab.binding.upnpcontrol.internal.services.UpnpRenderingControlConfiguration;
  51 import org.openhab.binding.upnpcontrol.internal.util.UpnpControlUtil;
  52 import org.openhab.binding.upnpcontrol.internal.util.UpnpXMLParser;
  53 import org.openhab.core.audio.AudioFormat;
  54 import org.openhab.core.io.net.http.HttpUtil;
  55 import org.openhab.core.io.transport.upnp.UpnpIOService;
  56 import org.openhab.core.library.types.DecimalType;
  57 import org.openhab.core.library.types.NextPreviousType;
  58 import org.openhab.core.library.types.OnOffType;
  59 import org.openhab.core.library.types.PercentType;
  60 import org.openhab.core.library.types.PlayPauseType;
  61 import org.openhab.core.library.types.QuantityType;
  62 import org.openhab.core.library.types.RewindFastforwardType;
  63 import org.openhab.core.library.types.StringType;
  64 import org.openhab.core.library.unit.Units;
  65 import org.openhab.core.thing.Channel;
  66 import org.openhab.core.thing.ChannelUID;
  67 import org.openhab.core.thing.Thing;
  68 import org.openhab.core.thing.ThingStatus;
  69 import org.openhab.core.thing.ThingStatusDetail;
  70 import org.openhab.core.types.Command;
  71 import org.openhab.core.types.CommandOption;
  72 import org.openhab.core.types.RefreshType;
  73 import org.openhab.core.types.State;
  74 import org.openhab.core.types.UnDefType;
  75 import org.slf4j.Logger;
  76 import org.slf4j.LoggerFactory;
  77
  78 /**
  79  * The {@link UpnpRendererHandler} is responsible for handling commands sent to the UPnP Renderer. It extends
  80  * {@link UpnpHandler} with UPnP renderer specific logic. It implements UPnP AVTransport and RenderingControl service
  81  * actions.
  82  *
  83  * @author Mark Herwege - Initial contribution
  84  * @author Karel Goderis - Based on UPnP logic in Sonos binding
  85  */
  86 @NonNullByDefault
  87 public class UpnpRendererHandler extends UpnpHandler {
  88
  89     private final Logger logger = LoggerFactory.getLogger(UpnpRendererHandler.class);
  90
  91     // UPnP constants
  92     static final String RENDERING_CONTROL = "RenderingControl";
  93     static final String AV_TRANSPORT = "AVTransport";
  94     static final String INSTANCE_ID = "InstanceID";
  95
  96     private volatile boolean audioSupport;
  97     protected volatile Set<AudioFormat> supportedAudioFormats = new HashSet<>();
  98     private volatile boolean audioSinkRegistered;
  99
 100     private volatile UpnpAudioSinkReg audioSinkReg;
 101
 102     private volatile Set<UpnpServerHandler> serverHandlers = ConcurrentHashMap.newKeySet();
 103
 104     protected @NonNullByDefault({}) UpnpControlRendererConfiguration config;
 105     private UpnpRenderingControlConfiguration renderingControlConfiguration = new UpnpRenderingControlConfiguration();
 106
 107     private volatile List<CommandOption> favoriteCommandOptionList = List.of();
 108     private volatile List<CommandOption> playlistCommandOptionList = List.of();
 109
 110     private @NonNullByDefault({}) ChannelUID favoriteSelectChannelUID;
 111     private @NonNullByDefault({}) ChannelUID playlistSelectChannelUID;
 112
 113     private volatile PercentType soundVolume = new PercentType();
 114     private @Nullable volatile PercentType notificationVolume;
 115     private volatile List<String> sink = new ArrayList<>();
 116
 117     private volatile String favoriteName = ""; // Currently selected favorite
 118
 119     private volatile boolean repeat;
 120     private volatile boolean shuffle;
 121     private volatile boolean onlyplayone; // Set to true if we only want to play one at a time
 122
 123     // Queue as received from server and current and next media entries for playback
 124     private volatile UpnpEntryQueue currentQueue = new UpnpEntryQueue();
 125     volatile @Nullable UpnpEntry currentEntry = null;
 126     volatile @Nullable UpnpEntry nextEntry = null;
 127
 128     // Group of fields representing current state of player
 129     private volatile String nowPlayingUri = ""; // Used to block waiting for setting URI when it is the same as current
 130                                                 // as some players will not send URI update when it is the same as
 131                                                 // previous
 132     private volatile String transportState = ""; // Current transportState to be able to refresh the control
 133     volatile boolean playerStopped; // Set if the player is stopped from OH command or code, allows to identify
 134                                     // if STOP came from other source when receiving STOP state from GENA event
 135     volatile boolean playing; // Set to false when a STOP is received, so we can filter two consecutive STOPs
 136                               // and not play next entry second time
 137     private volatile @Nullable ScheduledFuture<?> paused; // Set when a pause command is given, to compensate for
 138                                                           // renderers that cannot pause playback
 139     private volatile @Nullable CompletableFuture<Boolean> isSettingURI; // Set to wait for setting URI before starting
 140                                                                         // to play or seeking
 141     private volatile @Nullable CompletableFuture<Boolean> isStopping; // Set when stopping to be able to wait for stop
 142                                                                       // confirmation for subsequent actions that need
 143                                                                       // the player to be stopped
 144     volatile boolean registeredQueue; // Set when registering a new queue. This allows to decide if we just
 145                                       // need to play URI, or serve the first entry in a queue when a play
 146                                       // command is given.
 147     volatile boolean playingQueue; // Identifies if we are playing a queue received from a server. If so, a new
 148                                    // queue received will be played after the currently playing entry
 149     private volatile boolean oneplayed; // Set to true when the one entry is being played, allows to check if stop is
 150                                         // needed when only playing one
 151     volatile boolean playingNotification; // Set when playing a notification
 152     private volatile @Nullable ScheduledFuture<?> playingNotificationFuture; // Set when playing a notification, allows
 153                                                                              // timing out notification
 154     private volatile String notificationUri = ""; // Used to check if the received URI is from the notification
 155     private final Object notificationLock = new Object();
 156
 157     // Track position and duration fields
 158     private volatile int trackDuration = 0;
 159     private volatile int trackPosition = 0;
 160     private volatile long expectedTrackend = 0;
 161     private volatile @Nullable ScheduledFuture<?> trackPositionRefresh;
 162     private volatile int posAtNotificationStart = 0;
 163
 164     public UpnpRendererHandler(Thing thing, UpnpIOService upnpIOService, UpnpAudioSinkReg audioSinkReg,
 165             UpnpDynamicStateDescriptionProvider upnpStateDescriptionProvider,
 166             UpnpDynamicCommandDescriptionProvider upnpCommandDescriptionProvider,
 167             UpnpControlBindingConfiguration configuration) {
 168         super(thing, upnpIOService, configuration, upnpStateDescriptionProvider, upnpCommandDescriptionProvider);
 169
 170         serviceSubscriptions.add(AV_TRANSPORT);
 171         serviceSubscriptions.add(RENDERING_CONTROL);
 172
 173         this.audioSinkReg = audioSinkReg;
 174     }
 175
 176     @Override
 177     public void initialize() {
 178         super.initialize();
 179         config = getConfigAs(UpnpControlRendererConfiguration.class);
 180         if (config.seekStep < 1) {
 181             config.seekStep = 1;
 182         }
 183         logger.debug("Initializing handler for media renderer device {}", thing.getLabel());
 184
 185         Channel favoriteSelectChannel = thing.getChannel(FAVORITE_SELECT);
 186         if (favoriteSelectChannel != null) {
 187             favoriteSelectChannelUID = favoriteSelectChannel.getUID();
 188         } else {
 189             String msg = String.format("@text/offline.channel-undefined [ \"%s\" ]", FAVORITE_SELECT);
 190             updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, msg);
 191             return;
 192         }
 193         Channel playlistSelectChannel = thing.getChannel(PLAYLIST_SELECT);
 194         if (playlistSelectChannel != null) {
 195             playlistSelectChannelUID = playlistSelectChannel.getUID();
 196         } else {
 197             String msg = String.format("@text/offline.channel-undefined [ \"%s\" ]", PLAYLIST_SELECT);
 198             updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, msg);
 199             return;
 200         }
 201
 202         initDevice();
 203     }
 204
 205     @Override
 206     public void dispose() {
 207         logger.debug("Disposing handler for media renderer device {}", thing.getLabel());
 208
 209         cancelTrackPositionRefresh();
 210         resetPaused();
 211         CompletableFuture<Boolean> settingURI = isSettingURI;
 212         if (settingURI != null) {
 213             settingURI.complete(false);
 214         }
 215
 216         super.dispose();
 217     }
 218
 219     @Override
 220     protected void initJob() {
 221         synchronized (jobLock) {
 222             if (!upnpIOService.isRegistered(this)) {
 223                 String msg = String.format("@text/offline.device-not-registered [ \"%s\" ]", getUDN());
 224                 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR, msg);
 225                 return;
 226             }
 227
 228             if (!ThingStatus.ONLINE.equals(thing.getStatus())) {
 229                 getProtocolInfo();
 230
 231                 getCurrentConnectionInfo();
 232                 if (!checkForConnectionIds()) {
 233                     String msg = String.format("@text/offline.no-connection-ids [ \"%s\" ]", getUDN());
 234                     updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR, msg);
 235                     return;
 236                 }
 237
 238                 getTransportState();
 239
 240                 updateFavoritesList();
 241                 playlistsListChanged();
 242
 243                 RemoteDevice device = getDevice();
 244                 if (device != null) { // The handler factory will update the device config later when it has not been
 245                                       // set yet
 246                     updateDeviceConfig(device);
 247                 }
 248
 249                 updateStatus(ThingStatus.ONLINE);
 250             }
 251
 252             if (!upnpSubscribed) {
 253                 addSubscriptions();
 254             }
 255         }
 256     }
 257
 258     @Override
 259     public void updateDeviceConfig(RemoteDevice device) {
 260         super.updateDeviceConfig(device);
 261
 262         UpnpRenderingControlConfiguration config = new UpnpRenderingControlConfiguration(device);
 263         renderingControlConfiguration = config;
 264         for (String audioChannel : config.audioChannels) {
 265             createAudioChannels(audioChannel);
 266         }
 267
 268         updateChannels();
 269     }
 270
 271     private void createAudioChannels(String audioChannel) {
 272         UpnpRenderingControlConfiguration config = renderingControlConfiguration;
 273         if (config.volume && !UPNP_MASTER.equals(audioChannel)) {
 274             String name = audioChannel + "volume";
 275             if (UpnpChannelName.channelIdToUpnpChannelName(name) != null) {
 276                 createChannel(UpnpChannelName.channelIdToUpnpChannelName(name));
 277             } else {
 278                 String label = String.format("@text/channel.upnpcontrol.vendorvolume.label [ \"%s\" ]", audioChannel);
 279                 createChannel(name, label, "@text/channel.upnpcontrol.vendorvolume.description", ITEM_TYPE_VOLUME,
 280                         CHANNEL_TYPE_VOLUME);
 281             }
 282         }
 283         if (config.mute && !UPNP_MASTER.equals(audioChannel)) {
 284             String name = audioChannel + "mute";
 285             if (UpnpChannelName.channelIdToUpnpChannelName(name) != null) {
 286                 createChannel(UpnpChannelName.channelIdToUpnpChannelName(name));
 287             } else {
 288                 String label = String.format("@text/channel.upnpcontrol.vendormute.label [ \"%s\" ]", audioChannel);
 289                 createChannel(name, label, "@text/channel.upnpcontrol.vendormute.description", ITEM_TYPE_MUTE,
 290                         CHANNEL_TYPE_MUTE);
 291             }
 292         }
 293         if (config.loudness) {
 294             String name = (UPNP_MASTER.equals(audioChannel) ? "" : audioChannel) + "loudness";
 295             if (UpnpChannelName.channelIdToUpnpChannelName(name) != null) {
 296                 createChannel(UpnpChannelName.channelIdToUpnpChannelName(name));
 297             } else {
 298                 String label = String.format("@text/channel.upnpcontrol.vendorloudness.label [ \"%s\" ]", audioChannel);
 299                 createChannel(name, label, "@text/channel.upnpcontrol.vendorloudness.description", ITEM_TYPE_LOUDNESS,
 300                         CHANNEL_TYPE_LOUDNESS);
 301             }
 302         }
 303     }
 304
 305     /**
 306      * Invoke Stop on UPnP AV Transport.
 307      */
 308     public void stop() {
 309         playerStopped = true;
 310
 311         if (playing) {
 312             CompletableFuture<Boolean> stopping = isStopping;
 313             if (stopping != null) {
 314                 stopping.complete(false);
 315             }
 316             isStopping = new CompletableFuture<Boolean>(); // set this so we can check if stop confirmation has been
 317                                                            // received
 318         }
 319
 320         Map<String, String> inputs = Collections.singletonMap(INSTANCE_ID, Integer.toString(avTransportId));
 321
 322         invokeAction(AV_TRANSPORT, "Stop", inputs);
 323     }
 324
 325     /**
 326      * Invoke Play on UPnP AV Transport.
 327      */
 328     public void play() {
 329         CompletableFuture<Boolean> settingURI = isSettingURI;
 330         boolean uriSet = true;
 331         try {
 332             if (settingURI != null) {
 333                 // wait for maximum 2.5s until the media URI is set before playing
 334                 uriSet = settingURI.get(config.responseTimeout, TimeUnit.MILLISECONDS);
 335             }
 336         } catch (InterruptedException | ExecutionException | TimeoutException e) {
 337             logger.debug("Timeout exception, media URI not yet set in renderer {}, trying to play anyway",
 338                     thing.getLabel());
 339         }
 340
 341         if (uriSet) {
 342             Map<String, String> inputs = new HashMap<>();
 343             inputs.put(INSTANCE_ID, Integer.toString(avTransportId));
 344             inputs.put("Speed", "1");
 345
 346             invokeAction(AV_TRANSPORT, "Play", inputs);
 347         } else {
 348             logger.debug("Cannot play, cancelled setting URI in the renderer {}", thing.getLabel());
 349         }
 350     }
 351
 352     /**
 353      * Invoke Pause on UPnP AV Transport.
 354      */
 355     protected void pause() {
 356         Map<String, String> inputs = Collections.singletonMap(INSTANCE_ID, Integer.toString(avTransportId));
 357
 358         invokeAction(AV_TRANSPORT, "Pause", inputs);
 359     }
 360
 361     /**
 362      * Invoke Next on UPnP AV Transport.
 363      */
 364     protected void next() {
 365         Map<String, String> inputs = Collections.singletonMap(INSTANCE_ID, Integer.toString(avTransportId));
 366
 367         invokeAction(AV_TRANSPORT, "Next", inputs);
 368     }
 369
 370     /**
 371      * Invoke Previous on UPnP AV Transport.
 372      */
 373     protected void previous() {
 374         Map<String, String> inputs = Collections.singletonMap(INSTANCE_ID, Integer.toString(avTransportId));
 375
 376         invokeAction(AV_TRANSPORT, "Previous", inputs);
 377     }
 378
 379     /**
 380      * Invoke Seek on UPnP AV Transport.
 381      *
 382      * @param seekTarget relative position in current track, format HH:mm:ss
 383      */
 384     protected void seek(String seekTarget) {
 385         CompletableFuture<Boolean> settingURI = isSettingURI;
 386         boolean uriSet = true;
 387         try {
 388             if (settingURI != null) {
 389                 // wait for maximum 2.5s until the media URI is set before seeking
 390                 uriSet = settingURI.get(config.responseTimeout, TimeUnit.MILLISECONDS);
 391             }
 392         } catch (InterruptedException | ExecutionException | TimeoutException e) {
 393             logger.debug("Timeout exception, media URI not yet set in renderer {}, skipping seek", thing.getLabel());
 394             return;
 395         }
 396
 397         if (uriSet) {
 398             Map<String, String> inputs = new HashMap<>();
 399             inputs.put(INSTANCE_ID, Integer.toString(avTransportId));
 400             inputs.put("Unit", "REL_TIME");
 401             inputs.put("Target", seekTarget);
 402
 403             invokeAction(AV_TRANSPORT, "Seek", inputs);
 404         } else {
 405             logger.debug("Cannot seek, cancelled setting URI in the renderer {}", thing.getLabel());
 406         }
 407     }
 408
 409     /**
 410      * Invoke SetAVTransportURI on UPnP AV Transport.
 411      *
 412      * @param URI
 413      * @param URIMetaData
 414      */
 415     public void setCurrentURI(String URI, String URIMetaData) {
 416         String uri = "";
 417         uri = URLDecoder.decode(URI.trim(), StandardCharsets.UTF_8);
 418         // Some renderers don't send a URI Last Changed event when the same URI is requested, so don't wait for it
 419         // before starting to play
 420         if (!uri.equals(nowPlayingUri) && !playingNotification) {
 421             CompletableFuture<Boolean> settingURI = isSettingURI;
 422             if (settingURI != null) {
 423                 settingURI.complete(false);
 424             }
 425             isSettingURI = new CompletableFuture<Boolean>(); // set this so we don't start playing when not finished
 426                                                              // setting URI
 427         } else {
 428             logger.debug("New URI {} is same as previous on renderer {}", nowPlayingUri, thing.getLabel());
 429         }
 430
 431         Map<String, String> inputs = new HashMap<>();
 432         inputs.put(INSTANCE_ID, Integer.toString(avTransportId));
 433         inputs.put("CurrentURI", uri);
 434         inputs.put("CurrentURIMetaData", URIMetaData);
 435
 436         invokeAction(AV_TRANSPORT, "SetAVTransportURI", inputs);
 437     }
 438
 439     /**
 440      * Invoke SetNextAVTransportURI on UPnP AV Transport.
 441      *
 442      * @param nextURI
 443      * @param nextURIMetaData
 444      */
 445     protected void setNextURI(String nextURI, String nextURIMetaData) {
 446         Map<String, String> inputs = new HashMap<>();
 447         inputs.put(INSTANCE_ID, Integer.toString(avTransportId));
 448         inputs.put("NextURI", nextURI);
 449         inputs.put("NextURIMetaData", nextURIMetaData);
 450
 451         invokeAction(AV_TRANSPORT, "SetNextAVTransportURI", inputs);
 452     }
 453
 454     /**
 455      * Invoke GetTransportState on UPnP AV Transport.
 456      * Result is received in {@link onValueReceived}.
 457      */
 458     protected void getTransportState() {
 459         Map<String, String> inputs = Collections.singletonMap(INSTANCE_ID, Integer.toString(avTransportId));
 460
 461         invokeAction(AV_TRANSPORT, "GetTransportInfo", inputs);
 462     }
 463
 464     /**
 465      * Invoke getPositionInfo on UPnP AV Transport.
 466      * Result is received in {@link onValueReceived}.
 467      */
 468     protected void getPositionInfo() {
 469         Map<String, String> inputs = Collections.singletonMap(INSTANCE_ID, Integer.toString(avTransportId));
 470
 471         invokeAction(AV_TRANSPORT, "GetPositionInfo", inputs);
 472     }
 473
 474     /**
 475      * Invoke GetMediaInfo on UPnP AV Transport.
 476      * Result is received in {@link onValueReceived}.
 477      */
 478     protected void getMediaInfo() {
 479         Map<String, String> inputs = Collections.singletonMap(INSTANCE_ID, Integer.toString(avTransportId));
 480
 481         invokeAction(AV_TRANSPORT, "smarthome:audio stream http://icecast.vrtcdn.be/stubru_tijdloze-high.mp3", inputs);
 482     }
 483
 484     /**
 485      * Retrieves the current volume known to the control point, gets updated by GENA events or after UPnP Rendering
 486      * Control GetVolume call. This method is used to retrieve volume by {@link UpnpAudioSink.getVolume}.
 487      *
 488      * @return current volume
 489      */
 490     public PercentType getCurrentVolume() {
 491         return soundVolume;
 492     }
 493
 494     /**
 495      * Invoke GetVolume on UPnP Rendering Control.
 496      * Result is received in {@link onValueReceived}.
 497      *
 498      * @param channel
 499      */
 500     protected void getVolume(String channel) {
 501         Map<String, String> inputs = new HashMap<>();
 502         inputs.put(INSTANCE_ID, Integer.toString(rcsId));
 503         inputs.put("Channel", channel);
 504
 505         invokeAction(RENDERING_CONTROL, "GetVolume", inputs);
 506     }
 507
 508     /**
 509      * Invoke SetVolume on UPnP Rendering Control.
 510      *
 511      * @param channel
 512      * @param volume
 513      */
 514     protected void setVolume(String channel, PercentType volume) {
 515         UpnpRenderingControlConfiguration config = renderingControlConfiguration;
 516
 517         long newVolume = volume.intValue() * config.maxvolume / 100;
 518         Map<String, String> inputs = new HashMap<>();
 519         inputs.put(INSTANCE_ID, Integer.toString(rcsId));
 520         inputs.put("Channel", channel);
 521         inputs.put("DesiredVolume", String.valueOf(newVolume));
 522
 523         invokeAction(RENDERING_CONTROL, "SetVolume", inputs);
 524     }
 525
 526     /**
 527      * Invoke SetVolume for Master channel on UPnP Rendering Control.
 528      *
 529      * @param volume
 530      */
 531     public void setVolume(PercentType volume) {
 532         setVolume(UPNP_MASTER, volume);
 533     }
 534
 535     /**
 536      * Invoke getMute on UPnP Rendering Control.
 537      * Result is received in {@link onValueReceived}.
 538      *
 539      * @param channel
 540      */
 541     protected void getMute(String channel) {
 542         Map<String, String> inputs = new HashMap<>();
 543         inputs.put(INSTANCE_ID, Integer.toString(rcsId));
 544         inputs.put("Channel", channel);
 545
 546         invokeAction(RENDERING_CONTROL, "GetMute", inputs);
 547     }
 548
 549     /**
 550      * Invoke SetMute on UPnP Rendering Control.
 551      *
 552      * @param channel
 553      * @param mute
 554      */
 555     protected void setMute(String channel, OnOffType mute) {
 556         Map<String, String> inputs = new HashMap<>();
 557         inputs.put(INSTANCE_ID, Integer.toString(rcsId));
 558         inputs.put("Channel", channel);
 559         inputs.put("DesiredMute", mute == OnOffType.ON ? "1" : "0");
 560
 561         invokeAction(RENDERING_CONTROL, "SetMute", inputs);
 562     }
 563
 564     /**
 565      * Invoke getMute on UPnP Rendering Control.
 566      * Result is received in {@link onValueReceived}.
 567      *
 568      * @param channel
 569      */
 570     protected void getLoudness(String channel) {
 571         Map<String, String> inputs = new HashMap<>();
 572         inputs.put(INSTANCE_ID, Integer.toString(rcsId));
 573         inputs.put("Channel", channel);
 574
 575         invokeAction(RENDERING_CONTROL, "GetLoudness", inputs);
 576     }
 577
 578     /**
 579      * Invoke SetMute on UPnP Rendering Control.
 580      *
 581      * @param channel
 582      * @param mute
 583      */
 584     protected void setLoudness(String channel, OnOffType mute) {
 585         Map<String, String> inputs = new HashMap<>();
 586         inputs.put(INSTANCE_ID, Integer.toString(rcsId));
 587         inputs.put("Channel", channel);
 588         inputs.put("DesiredLoudness", mute == OnOffType.ON ? "1" : "0");
 589
 590         invokeAction(RENDERING_CONTROL, "SetLoudness", inputs);
 591     }
 592
 593     /**
 594      * Called from server handler for renderer to be able to send back status to server handler
 595      *
 596      * @param handler
 597      */
 598     protected void setServerHandler(UpnpServerHandler handler) {
 599         logger.debug("Set server handler {} on renderer {}", handler.getThing().getLabel(), thing.getLabel());
 600         serverHandlers.add(handler);
 601     }
 602
 603     /**
 604      * Should be called from server handler when server stops serving this renderer
 605      */
 606     protected void unsetServerHandler() {
 607         logger.debug("Unset server handler on renderer {}", thing.getLabel());
 608         for (UpnpServerHandler handler : serverHandlers) {
 609             Thing serverThing = handler.getThing();
 610             Channel serverChannel;
 611             for (String channel : SERVER_CONTROL_CHANNELS) {
 612                 if ((serverChannel = serverThing.getChannel(channel)) != null) {
 613                     handler.updateServerState(serverChannel.getUID(), UnDefType.UNDEF);
 614                 }
 615             }
 616
 617             serverHandlers.remove(handler);
 618         }
 619     }
 620
 621     @Override
 622     protected void updateState(ChannelUID channelUID, State state) {
 623         // override to be able to propagate channel state updates to corresponding channels on the server
 624         if (SERVER_CONTROL_CHANNELS.contains(channelUID.getId())) {
 625             for (UpnpServerHandler handler : serverHandlers) {
 626                 Thing serverThing = handler.getThing();
 627                 Channel serverChannel = serverThing.getChannel(channelUID.getId());
 628                 if (serverChannel != null) {
 629                     logger.debug("Update server {} channel {} with state {} from renderer {}", serverThing.getLabel(),
 630                             state, channelUID, thing.getLabel());
 631                     handler.updateServerState(serverChannel.getUID(), state);
 632                 }
 633             }
 634         }
 635         super.updateState(channelUID, state);
 636     }
 637
 638     @Override
 639     public void handleCommand(ChannelUID channelUID, Command command) {
 640         logger.debug("Handle command {} for channel {} on renderer {}", command, channelUID, thing.getLabel());
 641
 642         String id = channelUID.getId();
 643
 644         if (id.endsWith("volume")) {
 645             handleCommandVolume(command, id);
 646         } else if (id.endsWith("mute")) {
 647             handleCommandMute(command, id);
 648         } else if (id.endsWith("loudness")) {
 649             handleCommandLoudness(command, id);
 650         } else {
 651             switch (id) {
 652                 case STOP:
 653                     handleCommandStop(command);
 654                     break;
 655                 case CONTROL:
 656                     handleCommandControl(channelUID, command);
 657                     break;
 658                 case REPEAT:
 659                     handleCommandRepeat(channelUID, command);
 660                     break;
 661                 case SHUFFLE:
 662                     handleCommandShuffle(channelUID, command);
 663                 case ONLY_PLAY_ONE:
 664                     handleCommandOnlyPlayOne(channelUID, command);
 665                     break;
 666                 case URI:
 667                     handleCommandUri(channelUID, command);
 668                     break;
 669                 case FAVORITE_SELECT:
 670                     handleCommandFavoriteSelect(command);
 671                     break;
 672                 case FAVORITE:
 673                     handleCommandFavorite(channelUID, command);
 674                     break;
 675                 case FAVORITE_ACTION:
 676                     handleCommandFavoriteAction(command);
 677                     break;
 678                 case PLAYLIST_SELECT:
 679                     handleCommandPlaylistSelect(command);
 680                     break;
 681                 case TRACK_POSITION:
 682                     handleCommandTrackPosition(channelUID, command);
 683                     break;
 684                 case REL_TRACK_POSITION:
 685                     handleCommandRelTrackPosition(channelUID, command);
 686                     break;
 687                 default:
 688                     break;
 689             }
 690         }
 691     }
 692
 693     private void handleCommandVolume(Command command, String id) {
 694         if (command instanceof RefreshType) {
 695             getVolume("volume".equals(id) ? UPNP_MASTER : id.replace("volume", ""));
 696         } else if (command instanceof PercentType) {
 697             setVolume("volume".equals(id) ? UPNP_MASTER : id.replace("volume", ""), (PercentType) command);
 698         }
 699     }
 700
 701     private void handleCommandMute(Command command, String id) {
 702         if (command instanceof RefreshType) {
 703             getMute("mute".equals(id) ? UPNP_MASTER : id.replace("mute", ""));
 704         } else if (command instanceof OnOffType) {
 705             setMute("mute".equals(id) ? UPNP_MASTER : id.replace("mute", ""), (OnOffType) command);
 706         }
 707     }
 708
 709     private void handleCommandLoudness(Command command, String id) {
 710         if (command instanceof RefreshType) {
 711             getLoudness("loudness".equals(id) ? UPNP_MASTER : id.replace("loudness", ""));
 712         } else if (command instanceof OnOffType) {
 713             setLoudness("loudness".equals(id) ? UPNP_MASTER : id.replace("loudness", ""), (OnOffType) command);
 714         }
 715     }
 716
 717     private void handleCommandStop(Command command) {
 718         if (OnOffType.ON.equals(command)) {
 719             updateState(CONTROL, PlayPauseType.PAUSE);
 720             stop();
 721             updateState(TRACK_POSITION, new QuantityType<>(0, Units.SECOND));
 722         }
 723     }
 724
 725     private void handleCommandControl(ChannelUID channelUID, Command command) {
 726         String state;
 727         if (command instanceof RefreshType) {
 728             state = transportState;
 729             State newState = UnDefType.UNDEF;
 730             if ("PLAYING".equals(state)) {
 731                 newState = PlayPauseType.PLAY;
 732             } else if ("STOPPED".equals(state)) {
 733                 newState = PlayPauseType.PAUSE;
 734             } else if ("PAUSED_PLAYBACK".equals(state)) {
 735                 newState = PlayPauseType.PAUSE;
 736             }
 737             updateState(channelUID, newState);
 738         } else if (command instanceof PlayPauseType) {
 739             if (PlayPauseType.PLAY.equals(command)) {
 740                 if (registeredQueue) {
 741                     registeredQueue = false;
 742                     playingQueue = true;
 743                     oneplayed = false;
 744                     serve();
 745                 } else {
 746                     play();
 747                 }
 748             } else if (PlayPauseType.PAUSE.equals(command)) {
 749                 checkPaused();
 750                 pause();
 751             }
 752         } else if (command instanceof NextPreviousType) {
 753             if (NextPreviousType.NEXT.equals(command)) {
 754                 serveNext();
 755             } else if (NextPreviousType.PREVIOUS.equals(command)) {
 756                 servePrevious();
 757             }
 758         } else if (command instanceof RewindFastforwardType) {
 759             int pos = 0;
 760             if (RewindFastforwardType.FASTFORWARD.equals(command)) {
 761                 pos = Integer.min(trackDuration, trackPosition + config.seekStep);
 762             } else if (command == RewindFastforwardType.REWIND) {
 763                 pos = Integer.max(0, trackPosition - config.seekStep);
 764             }
 765             seek(String.format("%02d:%02d:%02d", pos / 3600, (pos % 3600) / 60, pos % 60));
 766         }
 767     }
 768
 769     private void handleCommandRepeat(ChannelUID channelUID, Command command) {
 770         if (command instanceof RefreshType) {
 771             updateState(channelUID, OnOffType.from(repeat));
 772         } else {
 773             repeat = (OnOffType.ON.equals(command));
 774             currentQueue.setRepeat(repeat);
 775             updateState(channelUID, OnOffType.from(repeat));
 776             logger.debug("Repeat set to {} for {}", repeat, thing.getLabel());
 777         }
 778     }
 779
 780     private void handleCommandShuffle(ChannelUID channelUID, Command command) {
 781         if (command instanceof RefreshType) {
 782             updateState(channelUID, OnOffType.from(shuffle));
 783         } else {
 784             shuffle = (OnOffType.ON.equals(command));
 785             currentQueue.setShuffle(shuffle);
 786             if (!playing) {
 787                 resetToStartQueue();
 788             }
 789             updateState(channelUID, OnOffType.from(shuffle));
 790             logger.debug("Shuffle set to {} for {}", shuffle, thing.getLabel());
 791         }
 792     }
 793
 794     private void handleCommandOnlyPlayOne(ChannelUID channelUID, Command command) {
 795         if (command instanceof RefreshType) {
 796             updateState(channelUID, OnOffType.from(onlyplayone));
 797         } else {
 798             onlyplayone = (OnOffType.ON.equals(command));
 799             oneplayed = (onlyplayone && playing) ? true : false;
 800             if (oneplayed) {
 801                 setNextURI("", "");
 802             } else {
 803                 UpnpEntry next = nextEntry;
 804                 if (next != null) {
 805                     setNextURI(next.getRes(), UpnpXMLParser.compileMetadataString(next));
 806                 }
 807             }
 808             updateState(channelUID, OnOffType.from(onlyplayone));
 809             logger.debug("OnlyPlayOne set to {} for {}", onlyplayone, thing.getLabel());
 810         }
 811     }
 812
 813     private void handleCommandUri(ChannelUID channelUID, Command command) {
 814         if (command instanceof RefreshType) {
 815             updateState(channelUID, StringType.valueOf(nowPlayingUri));
 816         } else if (command instanceof StringType) {
 817             setCurrentURI(command.toString(), "");
 818             play();
 819         }
 820     }
 821
 822     private void handleCommandFavoriteSelect(Command command) {
 823         if (command instanceof StringType) {
 824             favoriteName = command.toString();
 825             updateState(FAVORITE, StringType.valueOf(favoriteName));
 826             playFavorite();
 827         }
 828     }
 829
 830     private void handleCommandFavorite(ChannelUID channelUID, Command command) {
 831         if (command instanceof StringType) {
 832             favoriteName = command.toString();
 833             if (favoriteCommandOptionList.contains(new CommandOption(favoriteName, favoriteName))) {
 834                 playFavorite();
 835             }
 836         }
 837         updateState(channelUID, StringType.valueOf(favoriteName));
 838     }
 839
 840     private void handleCommandFavoriteAction(Command command) {
 841         if (command instanceof StringType) {
 842             switch (command.toString()) {
 843                 case SAVE:
 844                     handleCommandFavoriteSave();
 845                     break;
 846                 case DELETE:
 847                     handleCommandFavoriteDelete();
 848                     break;
 849             }
 850         }
 851     }
 852
 853     private void handleCommandFavoriteSave() {
 854         if (!favoriteName.isEmpty()) {
 855             UpnpFavorite favorite = new UpnpFavorite(favoriteName, nowPlayingUri, currentEntry);
 856             favorite.saveFavorite(favoriteName, bindingConfig.path);
 857             updateFavoritesList();
 858         }
 859     }
 860
 861     private void handleCommandFavoriteDelete() {
 862         if (!favoriteName.isEmpty()) {
 863             UpnpControlUtil.deleteFavorite(favoriteName, bindingConfig.path);
 864             updateFavoritesList();
 865             updateState(FAVORITE, UnDefType.UNDEF);
 866         }
 867     }
 868
 869     private void handleCommandPlaylistSelect(Command command) {
 870         if (command instanceof StringType) {
 871             String playlistName = command.toString();
 872             UpnpEntryQueue queue = new UpnpEntryQueue();
 873             queue.restoreQueue(playlistName, null, bindingConfig.path);
 874             registerQueue(queue);
 875             resetToStartQueue();
 876             playingQueue = true;
 877             serve();
 878         }
 879     }
 880
 881     private void handleCommandTrackPosition(ChannelUID channelUID, Command command) {
 882         if (command instanceof RefreshType) {
 883             updateState(channelUID, new QuantityType<>(trackPosition, Units.SECOND));
 884         } else if (command instanceof QuantityType<?>) {
 885             QuantityType<?> position = ((QuantityType<?>) command).toUnit(Units.SECOND);
 886             if (position != null) {
 887                 int pos = Integer.min(trackDuration, position.intValue());
 888                 seek(String.format("%02d:%02d:%02d", pos / 3600, (pos % 3600) / 60, pos % 60));
 889             }
 890         }
 891     }
 892
 893     private void handleCommandRelTrackPosition(ChannelUID channelUID, Command command) {
 894         if (command instanceof RefreshType) {
 895             int relPosition = (trackDuration != 0) ? (trackPosition * 100) / trackDuration : 0;
 896             updateState(channelUID, new PercentType(relPosition));
 897         } else if (command instanceof PercentType) {
 898             int pos = ((PercentType) command).intValue() * trackDuration / 100;
 899             seek(String.format("%02d:%02d:%02d", pos / 3600, (pos % 3600) / 60, pos % 60));
 900         }
 901     }
 902
 903     /**
 904      * Set the volume for notifications.
 905      *
 906      * @param volume
 907      */
 908     public void setNotificationVolume(PercentType volume) {
 909         notificationVolume = volume;
 910     }
 911
 912     /**
 913      * Play a notification. Previous state of the renderer will resume at the end of the notification, or after the
 914      * maximum notification duration as defined in the renderer parameters.
 915      *
 916      * @param URI for notification sound
 917      */
 918     public void playNotification(String URI) {
 919         synchronized (notificationLock) {
 920             if (URI.isEmpty()) {
 921                 logger.debug("UPnP device {} received empty notification URI", thing.getLabel());
 922                 return;
 923             }
 924
 925             notificationUri = URI;
 926
 927             logger.debug("UPnP device {} playing notification {}", thing.getLabel(), URI);
 928
 929             cancelTrackPositionRefresh();
 930             getPositionInfo();
 931
 932             cancelPlayingNotificationFuture();
 933
 934             if (config.maxNotificationDuration > 0) {
 935                 playingNotificationFuture = upnpScheduler.schedule(this::stop, config.maxNotificationDuration,
 936                         TimeUnit.SECONDS);
 937             }
 938             playingNotification = true;
 939
 940             setCurrentURI(URI, "");
 941             setNextURI("", "");
 942             PercentType volume = notificationVolume;
 943             setVolume(volume == null
 944                     ? new PercentType(Math.min(100,
 945                             Math.max(0, (100 + config.notificationVolumeAdjustment) * soundVolume.intValue() / 100)))
 946                     : volume);
 947
 948             CompletableFuture<Boolean> stopping = isStopping;
 949             try {
 950                 if (stopping != null) {
 951                     // wait for maximum 2.5s until the renderer stopped before playing
 952                     stopping.get(config.responseTimeout, TimeUnit.MILLISECONDS);
 953                 }
 954             } catch (InterruptedException | ExecutionException | TimeoutException e) {
 955                 logger.debug("Timeout exception, renderer {} didn't stop yet, trying to play anyway", thing.getLabel());
 956             }
 957             play();
 958         }
 959     }
 960
 961     private void cancelPlayingNotificationFuture() {
 962         ScheduledFuture<?> future = playingNotificationFuture;
 963         if (future != null) {
 964             future.cancel(true);
 965             playingNotificationFuture = null;
 966         }
 967     }
 968
 969     private void resumeAfterNotification() {
 970         synchronized (notificationLock) {
 971             logger.debug("UPnP device {} resume after playing notification", thing.getLabel());
 972
 973             setCurrentURI(nowPlayingUri, "");
 974             setVolume(soundVolume);
 975
 976             cancelPlayingNotificationFuture();
 977
 978             playingNotification = false;
 979             notificationVolume = null;
 980             notificationUri = "";
 981
 982             if (playing) {
 983                 int pos = posAtNotificationStart;
 984                 seek(String.format("%02d:%02d:%02d", pos / 3600, (pos % 3600) / 60, pos % 60));
 985                 play();
 986             }
 987             posAtNotificationStart = 0;
 988         }
 989     }
 990
 991     private void playFavorite() {
 992         UpnpFavorite favorite = new UpnpFavorite(favoriteName, bindingConfig.path);
 993         String uri = favorite.getUri();
 994         UpnpEntry entry = favorite.getUpnpEntry();
 995         if (!uri.isEmpty()) {
 996             String metadata = "";
 997             if (entry != null) {
 998                 metadata = UpnpXMLParser.compileMetadataString(entry);
 999             }
1000             setCurrentURI(uri, metadata);
1001             play();
1002         }
1003     }
1004
1005     void updateFavoritesList() {
1006         favoriteCommandOptionList = UpnpControlUtil.favorites(bindingConfig.path).stream()
1007                 .map(p -> (new CommandOption(p, p))).collect(Collectors.toList());
1008         updateCommandDescription(favoriteSelectChannelUID, favoriteCommandOptionList);
1009     }
1010
1011     @Override
1012     public void playlistsListChanged() {
1013         playlistCommandOptionList = UpnpControlUtil.playlists().stream().map(p -> (new CommandOption(p, p)))
1014                 .collect(Collectors.toList());
1015         updateCommandDescription(playlistSelectChannelUID, playlistCommandOptionList);
1016     }
1017
1018     @Override
1019     public void onStatusChanged(boolean status) {
1020         if (!status) {
1021             removeSubscriptions();
1022
1023             updateState(CONTROL, PlayPauseType.PAUSE);
1024             cancelTrackPositionRefresh();
1025         }
1026         super.onStatusChanged(status);
1027     }
1028
1029     @Override
1030     protected @Nullable String preProcessValueReceived(Map<String, String> inputs, @Nullable String variable,
1031             @Nullable String value, @Nullable String service, @Nullable String action) {
1032         if (variable == null) {
1033             return null;
1034         } else {
1035             switch (variable) {
1036                 case "CurrentVolume":
1037                     return (inputs.containsKey("Channel") ? inputs.get("Channel") : UPNP_MASTER) + "Volume";
1038                 case "CurrentMute":
1039                     return (inputs.containsKey("Channel") ? inputs.get("Channel") : UPNP_MASTER) + "Mute";
1040                 case "CurrentLoudness":
1041                     return (inputs.containsKey("Channel") ? inputs.get("Channel") : UPNP_MASTER) + "Loudness";
1042                 default:
1043                     return variable;
1044             }
1045         }
1046     }
1047
1048     @Override
1049     public void onValueReceived(@Nullable String variable, @Nullable String value, @Nullable String service) {
1050         if (logger.isTraceEnabled()) {
1051             logger.trace("UPnP device {} received variable {} with value {} from service {}", thing.getLabel(),
1052                     variable, value, service);
1053         } else {
1054             if (logger.isDebugEnabled() && !("AbsTime".equals(variable) || "RelCount".equals(variable)
1055                     || "RelTime".equals(variable) || "AbsCount".equals(variable) || "Track".equals(variable)
1056                     || "TrackDuration".equals(variable))) {
1057                 // don't log all variables received when updating the track position every second
1058                 logger.debug("UPnP device {} received variable {} with value {} from service {}", thing.getLabel(),
1059                         variable, value, service);
1060             }
1061         }
1062         if (variable == null) {
1063             return;
1064         }
1065
1066         if (variable.endsWith("Volume")) {
1067             onValueReceivedVolume(variable, value);
1068         } else if (variable.endsWith("Mute")) {
1069             onValueReceivedMute(variable, value);
1070         } else if (variable.endsWith("Loudness")) {
1071             onValueReceivedLoudness(variable, value);
1072         } else {
1073             switch (variable) {
1074                 case "LastChange":
1075                     onValueReceivedLastChange(value, service);
1076                     break;
1077                 case "CurrentTransportState":
1078                 case "TransportState":
1079                     onValueReceivedTransportState(value);
1080                     break;
1081                 case "CurrentTrackURI":
1082                 case "CurrentURI":
1083                     onValueReceivedCurrentURI(value);
1084                     break;
1085                 case "CurrentTrackMetaData":
1086                 case "CurrentURIMetaData":
1087                     onValueReceivedCurrentMetaData(value);
1088                     break;
1089                 case "NextAVTransportURIMetaData":
1090                 case "NextURIMetaData":
1091                     onValueReceivedNextMetaData(value);
1092                     break;
1093                 case "CurrentTrackDuration":
1094                 case "TrackDuration":
1095                     onValueReceivedDuration(value);
1096                     break;
1097                 case "RelTime":
1098                     onValueReceivedRelTime(value);
1099                     break;
1100                 default:
1101                     super.onValueReceived(variable, value, service);
1102                     break;
1103             }
1104         }
1105     }
1106
1107     private void onValueReceivedVolume(String variable, @Nullable String value) {
1108         if (value != null && !value.isEmpty()) {
1109             UpnpRenderingControlConfiguration config = renderingControlConfiguration;
1110
1111             long volume = Long.valueOf(value);
1112             volume = volume * 100 / config.maxvolume;
1113
1114             String upnpChannel = variable.replace("Volume", "volume").replace("Master", "");
1115             updateState(upnpChannel, new PercentType((int) volume));
1116
1117             if (!playingNotification && "volume".equals(upnpChannel)) {
1118                 soundVolume = new PercentType((int) volume);
1119             }
1120         }
1121     }
1122
1123     private void onValueReceivedMute(String variable, @Nullable String value) {
1124         if (value != null && !value.isEmpty()) {
1125             String upnpChannel = variable.replace("Mute", "mute").replace("Master", "");
1126             updateState(upnpChannel,
1127                     ("1".equals(value) || "true".equals(value.toLowerCase())) ? OnOffType.ON : OnOffType.OFF);
1128         }
1129     }
1130
1131     private void onValueReceivedLoudness(String variable, @Nullable String value) {
1132         if (value != null && !value.isEmpty()) {
1133             String upnpChannel = variable.replace("Loudness", "loudness").replace("Master", "");
1134             updateState(upnpChannel,
1135                     ("1".equals(value) || "true".equals(value.toLowerCase())) ? OnOffType.ON : OnOffType.OFF);
1136         }
1137     }
1138
1139     private void onValueReceivedLastChange(@Nullable String value, @Nullable String service) {
1140         // This is returned from a GENA subscription. The jupnp library does not allow receiving new GENA subscription
1141         // messages as long as this thread has not finished. As we may trigger long running processes based on this
1142         // result, we run it in a separate thread.
1143         upnpScheduler.submit(() -> {
1144             // pre-process some variables, eg XML processing
1145             if (value != null && !value.isEmpty()) {
1146                 if (AV_TRANSPORT.equals(service)) {
1147                     Map<String, String> parsedValues = UpnpXMLParser.getAVTransportFromXML(value);
1148                     for (Map.Entry<String, String> entrySet : parsedValues.entrySet()) {
1149                         switch (entrySet.getKey()) {
1150                             case "TransportState":
1151                                 // Update the transport state after the update of the media information
1152                                 // to not break the notification mechanism
1153                                 break;
1154                             case "AVTransportURI":
1155                                 onValueReceived("CurrentTrackURI", entrySet.getValue(), service);
1156                                 break;
1157                             case "AVTransportURIMetaData":
1158                                 onValueReceived("CurrentTrackMetaData", entrySet.getValue(), service);
1159                                 break;
1160                             default:
1161                                 onValueReceived(entrySet.getKey(), entrySet.getValue(), service);
1162                         }
1163                     }
1164                     if (parsedValues.containsKey("TransportState")) {
1165                         onValueReceived("TransportState", parsedValues.get("TransportState"), service);
1166                     }
1167                 } else if (RENDERING_CONTROL.equals(service)) {
1168                     Map<String, @Nullable String> parsedValues = UpnpXMLParser.getRenderingControlFromXML(value);
1169                     for (String parsedValue : parsedValues.keySet()) {
1170                         onValueReceived(parsedValue, parsedValues.get(parsedValue), RENDERING_CONTROL);
1171                     }
1172                 }
1173             }
1174         });
1175     }
1176
1177     private void onValueReceivedTransportState(@Nullable String value) {
1178         transportState = (value == null) ? "" : value;
1179
1180         if ("STOPPED".equals(value)) {
1181             CompletableFuture<Boolean> stopping = isStopping;
1182             if (stopping != null) {
1183                 stopping.complete(true); // We have received stop confirmation
1184                 isStopping = null;
1185             }
1186
1187             if (playingNotification) {
1188                 resumeAfterNotification();
1189                 return;
1190             }
1191
1192             cancelCheckPaused();
1193             updateState(CONTROL, PlayPauseType.PAUSE);
1194             cancelTrackPositionRefresh();
1195             // Only go to next for first STOP command, then wait until we received PLAYING before moving
1196             // to next (avoids issues with renderers sending multiple stop states)
1197             if (playing) {
1198                 playing = false;
1199
1200                 // playerStopped is true if stop came from openHAB. This allows us to identify if we played to the
1201                 // end of an entry, because STOP would come from the player and not from openHAB. We should then
1202                 // move to the next entry if the queue is not at the end already.
1203                 if (!playerStopped) {
1204                     if (Instant.now().toEpochMilli() >= expectedTrackend) {
1205                         // If we are receiving track duration info, we know when the track is expected to end. If we
1206                         // received STOP before track end, and it is not coming from openHAB, it must have been stopped
1207                         // from the renderer directly, and we do not want to play the next entry.
1208                         if (playingQueue) {
1209                             serveNext();
1210                         }
1211                     }
1212                 } else if (playingQueue) {
1213                     playingQueue = false;
1214                 }
1215             }
1216         } else if ("PLAYING".equals(value)) {
1217             if (playingNotification) {
1218                 return;
1219             }
1220
1221             playerStopped = false;
1222             playing = true;
1223             registeredQueue = false; // reset queue registration flag as we are playing something
1224             updateState(CONTROL, PlayPauseType.PLAY);
1225             scheduleTrackPositionRefresh();
1226         } else if ("PAUSED_PLAYBACK".equals(value)) {
1227             cancelCheckPaused();
1228             updateState(CONTROL, PlayPauseType.PAUSE);
1229         } else if ("NO_MEDIA_PRESENT".equals(value)) {
1230             updateState(CONTROL, UnDefType.UNDEF);
1231         }
1232     }
1233
1234     private void onValueReceivedCurrentURI(@Nullable String value) {
1235         CompletableFuture<Boolean> settingURI = isSettingURI;
1236         if (settingURI != null) {
1237             settingURI.complete(true); // We have received current URI, so can allow play to start
1238         }
1239
1240         UpnpEntry current = currentEntry;
1241         UpnpEntry next = nextEntry;
1242
1243         String uri = "";
1244         String currentUri = "";
1245         String nextUri = "";
1246         if (value != null) {
1247             uri = URLDecoder.decode(value.trim(), StandardCharsets.UTF_8);
1248         }
1249         if (current != null) {
1250             currentUri = URLDecoder.decode(current.getRes().trim(), StandardCharsets.UTF_8);
1251         }
1252         if (next != null) {
1253             nextUri = URLDecoder.decode(next.getRes(), StandardCharsets.UTF_8);
1254         }
1255
1256         if (playingNotification && uri.equals(notificationUri)) {
1257             // No need to update anything more if this is for playing a notification
1258             return;
1259         }
1260
1261         nowPlayingUri = uri;
1262         updateState(URI, StringType.valueOf(uri));
1263
1264         logger.trace("Renderer {} received URI: {}", thing.getLabel(), uri);
1265         logger.trace("Renderer {} current URI: {}, equal to received URI {}", thing.getLabel(), currentUri,
1266                 uri.equals(currentUri));
1267         logger.trace("Renderer {} next URI: {}", thing.getLabel(), nextUri);
1268
1269         if (!uri.equals(currentUri)) {
1270             if ((next != null) && uri.equals(nextUri)) {
1271                 // Renderer advanced to next entry independent of openHAB UPnP control point.
1272                 // Advance in the queue to keep proper position status.
1273                 // Make the next entry available to renderers that support it.
1274                 logger.trace("Renderer {} moved from '{}' to next entry '{}' in queue", thing.getLabel(), current,
1275                         next);
1276                 currentEntry = currentQueue.next();
1277                 nextEntry = currentQueue.get(currentQueue.nextIndex());
1278                 logger.trace("Renderer {} auto move forward, current queue index: {}", thing.getLabel(),
1279                         currentQueue.index());
1280
1281                 updateMetaDataState(next);
1282
1283                 // look one further to get next entry for next URI
1284                 next = nextEntry;
1285                 if ((next != null) && !onlyplayone) {
1286                     setNextURI(next.getRes(), UpnpXMLParser.compileMetadataString(next));
1287                 }
1288             } else {
1289                 // A new entry is being served that does not match the next entry in the queue. This can be because a
1290                 // sound or stream is being played through an action, or another control point started a new entry.
1291                 // We should clear the metadata in this case and wait for new metadata to arrive.
1292                 clearMetaDataState();
1293             }
1294         }
1295     }
1296
1297     private void onValueReceivedCurrentMetaData(@Nullable String value) {
1298         if (playingNotification) {
1299             // Don't update metadata when playing notification
1300             return;
1301         }
1302
1303         if (value != null && !value.isEmpty()) {
1304             List<UpnpEntry> list = UpnpXMLParser.getEntriesFromXML(value);
1305             if (!list.isEmpty()) {
1306                 updateMetaDataState(list.get(0));
1307                 return;
1308             }
1309         }
1310         clearMetaDataState();
1311     }
1312
1313     private void onValueReceivedNextMetaData(@Nullable String value) {
1314         if (value != null && !value.isEmpty() && !"NOT_IMPLEMENTED".equals(value)) {
1315             List<UpnpEntry> list = UpnpXMLParser.getEntriesFromXML(value);
1316             if (!list.isEmpty()) {
1317                 nextEntry = list.get(0);
1318             }
1319         }
1320     }
1321
1322     private void onValueReceivedDuration(@Nullable String value) {
1323         // track duration and track position have format H+:MM:SS[.F+] or H+:MM:SS[.F0/F1]. We are not
1324         // interested in the fractional seconds, so drop everything after . and calculate in seconds.
1325         if (value == null || "NOT_IMPLEMENTED".equals(value)) {
1326             trackDuration = 0;
1327             updateState(TRACK_DURATION, UnDefType.UNDEF);
1328             updateState(REL_TRACK_POSITION, UnDefType.UNDEF);
1329         } else {
1330             try {
1331                 trackDuration = Arrays.stream(value.split("\\.")[0].split(":")).mapToInt(n -> Integer.parseInt(n))
1332                         .reduce(0, (n, m) -> n * 60 + m);
1333                 updateState(TRACK_DURATION, new QuantityType<>(trackDuration, Units.SECOND));
1334             } catch (NumberFormatException e) {
1335                 logger.debug("Illegal format for track duration {}", value);
1336                 return;
1337             }
1338         }
1339         setExpectedTrackend();
1340     }
1341
1342     private void onValueReceivedRelTime(@Nullable String value) {
1343         if (value == null || "NOT_IMPLEMENTED".equals(value)) {
1344             trackPosition = 0;
1345             updateState(TRACK_POSITION, UnDefType.UNDEF);
1346             updateState(REL_TRACK_POSITION, UnDefType.UNDEF);
1347         } else {
1348             try {
1349                 trackPosition = Arrays.stream(value.split("\\.")[0].split(":")).mapToInt(n -> Integer.parseInt(n))
1350                         .reduce(0, (n, m) -> n * 60 + m);
1351                 updateState(TRACK_POSITION, new QuantityType<>(trackPosition, Units.SECOND));
1352                 int relPosition = (trackDuration != 0) ? trackPosition * 100 / trackDuration : 0;
1353                 updateState(REL_TRACK_POSITION, new PercentType(relPosition));
1354             } catch (NumberFormatException e) {
1355                 logger.trace("Illegal format for track position {}", value);
1356                 return;
1357             }
1358         }
1359
1360         if (playingNotification) {
1361             posAtNotificationStart = trackPosition;
1362         }
1363
1364         setExpectedTrackend();
1365     }
1366
1367     @Override
1368     protected void updateProtocolInfo(String value) {
1369         sink.clear();
1370         supportedAudioFormats.clear();
1371         audioSupport = false;
1372
1373         sink.addAll(Arrays.asList(value.split(",")));
1374
1375         for (String protocol : sink) {
1376             Matcher matcher = PROTOCOL_PATTERN.matcher(protocol);
1377             if (matcher.find()) {
1378                 String format = matcher.group(1);
1379                 switch (format) {
1380                     case "audio/mpeg3":
1381                     case "audio/mp3":
1382                     case "audio/mpeg":
1383                         supportedAudioFormats.add(AudioFormat.MP3);
1384                         break;
1385                     case "audio/wav":
1386                     case "audio/wave":
1387                         supportedAudioFormats.add(AudioFormat.WAV);
1388                         break;
1389                 }
1390                 audioSupport = audioSupport || Pattern.matches("audio.*", format);
1391             }
1392         }
1393
1394         if (audioSupport) {
1395             logger.debug("Renderer {} supports audio", thing.getLabel());
1396             registerAudioSink();
1397         }
1398     }
1399
1400     private void clearCurrentEntry() {
1401         clearMetaDataState();
1402
1403         trackDuration = 0;
1404         updateState(TRACK_DURATION, UnDefType.UNDEF);
1405         trackPosition = 0;
1406         updateState(TRACK_POSITION, UnDefType.UNDEF);
1407         updateState(REL_TRACK_POSITION, UnDefType.UNDEF);
1408
1409         currentEntry = null;
1410     }
1411
1412     /**
1413      * Register a new queue with media entries to the renderer. Set the next position at the first entry in the list.
1414      * If the renderer is currently playing, set the first entry in the list as the next media. If not playing, set it
1415      * as current media.
1416      *
1417      * @param queue
1418      */
1419     protected void registerQueue(UpnpEntryQueue queue) {
1420         if (currentQueue.equals(queue)) {
1421             // We get the same queue, so do nothing
1422             return;
1423         }
1424
1425         logger.debug("Registering queue on renderer {}", thing.getLabel());
1426
1427         registeredQueue = true;
1428         currentQueue = queue;
1429         currentQueue.setRepeat(repeat);
1430         currentQueue.setShuffle(shuffle);
1431         if (playingQueue) {
1432             nextEntry = currentQueue.get(currentQueue.nextIndex());
1433             UpnpEntry next = nextEntry;
1434             if ((next != null) && !onlyplayone) {
1435                 // make the next entry available to renderers that support it
1436                 logger.trace("Renderer {} still playing, set new queue as next entry", thing.getLabel());
1437                 setNextURI(next.getRes(), UpnpXMLParser.compileMetadataString(next));
1438             }
1439         } else {
1440             resetToStartQueue();
1441         }
1442     }
1443
1444     /**
1445      * Move to next position in queue and start playing.
1446      */
1447     private void serveNext() {
1448         if (currentQueue.hasNext()) {
1449             currentEntry = currentQueue.next();
1450             nextEntry = currentQueue.get(currentQueue.nextIndex());
1451             logger.debug("Serve next media '{}' from queue on renderer {}", currentEntry, thing.getLabel());
1452             logger.trace("Serve next, current queue index: {}", currentQueue.index());
1453
1454             serve();
1455         } else {
1456             logger.debug("Cannot serve next, end of queue on renderer {}", thing.getLabel());
1457             resetToStartQueue();
1458         }
1459     }
1460
1461     /**
1462      * Move to previous position in queue and start playing.
1463      */
1464     private void servePrevious() {
1465         if (currentQueue.hasPrevious()) {
1466             currentEntry = currentQueue.previous();
1467             nextEntry = currentQueue.get(currentQueue.nextIndex());
1468             logger.debug("Serve previous media '{}' from queue on renderer {}", currentEntry, thing.getLabel());
1469             logger.trace("Serve previous, current queue index: {}", currentQueue.index());
1470
1471             serve();
1472         } else {
1473             logger.debug("Cannot serve previous, already at start of queue on renderer {}", thing.getLabel());
1474             resetToStartQueue();
1475         }
1476     }
1477
1478     private void resetToStartQueue() {
1479         logger.trace("Reset to start queue on renderer {}", thing.getLabel());
1480
1481         playingQueue = false;
1482         registeredQueue = true;
1483
1484         stop();
1485
1486         currentQueue.resetIndex(); // reset to beginning of queue
1487         currentEntry = currentQueue.next();
1488         nextEntry = currentQueue.get(currentQueue.nextIndex());
1489         logger.trace("Reset queue, current queue index: {}", currentQueue.index());
1490         UpnpEntry current = currentEntry;
1491         if (current != null) {
1492             clearMetaDataState();
1493             updateMetaDataState(current);
1494             setCurrentURI(current.getRes(), UpnpXMLParser.compileMetadataString(current));
1495         } else {
1496             clearCurrentEntry();
1497         }
1498
1499         UpnpEntry next = nextEntry;
1500         if (onlyplayone) {
1501             setNextURI("", "");
1502         } else if (next != null) {
1503             setNextURI(next.getRes(), UpnpXMLParser.compileMetadataString(next));
1504         }
1505     }
1506
1507     /**
1508      * Serve media from a queue and play immediately when already playing.
1509      *
1510      * @param media
1511      */
1512     private void serve() {
1513         logger.trace("Serve media on renderer {}", thing.getLabel());
1514
1515         UpnpEntry entry = currentEntry;
1516         if (entry != null) {
1517             clearMetaDataState();
1518             String res = entry.getRes();
1519             if (res.isEmpty()) {
1520                 logger.debug("Renderer {} cannot serve media '{}', no URI", thing.getLabel(), currentEntry);
1521                 playingQueue = false;
1522                 return;
1523             }
1524             updateMetaDataState(entry);
1525             setCurrentURI(res, UpnpXMLParser.compileMetadataString(entry));
1526
1527             if ((playingQueue || playing) && !(onlyplayone && oneplayed)) {
1528                 logger.trace("Ready to play '{}' from queue", currentEntry);
1529
1530                 trackDuration = 0;
1531                 trackPosition = 0;
1532                 expectedTrackend = 0;
1533                 play();
1534
1535                 oneplayed = true;
1536                 playingQueue = true;
1537             }
1538
1539             // make the next entry available to renderers that support it
1540             if (!onlyplayone) {
1541                 UpnpEntry next = nextEntry;
1542                 if (next != null) {
1543                     setNextURI(next.getRes(), UpnpXMLParser.compileMetadataString(next));
1544                 }
1545             }
1546         }
1547     }
1548
1549     /**
1550      * Called before handling a pause CONTROL command. If we do not received PAUSED_PLAYBACK or STOPPED back within
1551      * timeout, we will revert to playing state. This takes care of renderers that cannot pause playback.
1552      */
1553     private void checkPaused() {
1554         paused = upnpScheduler.schedule(this::resetPaused, config.responseTimeout, TimeUnit.MILLISECONDS);
1555     }
1556
1557     private void resetPaused() {
1558         updateState(CONTROL, PlayPauseType.PLAY);
1559     }
1560
1561     private void cancelCheckPaused() {
1562         ScheduledFuture<?> future = paused;
1563         if (future != null) {
1564             future.cancel(true);
1565             paused = null;
1566         }
1567     }
1568
1569     private void setExpectedTrackend() {
1570         expectedTrackend = Instant.now().toEpochMilli() + (trackDuration - trackPosition) * 1000
1571                 - config.responseTimeout;
1572     }
1573
1574     /**
1575      * Update the current track position every second if the channel is linked.
1576      */
1577     private void scheduleTrackPositionRefresh() {
1578         if (playingNotification) {
1579             return;
1580         }
1581
1582         cancelTrackPositionRefresh();
1583         if (!(isLinked(TRACK_POSITION) || isLinked(REL_TRACK_POSITION))) {
1584             // only get it once, so we can use the track end to correctly identify STOP pressed directly on renderer
1585             getPositionInfo();
1586         } else {
1587             if (trackPositionRefresh == null) {
1588                 trackPositionRefresh = upnpScheduler.scheduleWithFixedDelay(this::getPositionInfo, 1, 1,
1589                         TimeUnit.SECONDS);
1590             }
1591         }
1592     }
1593
1594     private void cancelTrackPositionRefresh() {
1595         ScheduledFuture<?> refresh = trackPositionRefresh;
1596
1597         if (refresh != null) {
1598             refresh.cancel(true);
1599         }
1600         trackPositionRefresh = null;
1601
1602         trackPosition = 0;
1603         updateState(TRACK_POSITION, new QuantityType<>(trackPosition, Units.SECOND));
1604         int relPosition = (trackDuration != 0) ? trackPosition / trackDuration : 0;
1605         updateState(REL_TRACK_POSITION, new PercentType(relPosition));
1606     }
1607
1608     /**
1609      * Update metadata channels for media with data received from the Media Server or AV Transport.
1610      *
1611      * @param media
1612      */
1613     private void updateMetaDataState(UpnpEntry media) {
1614         // We don't want to update metadata if the metadata from the AVTransport is less complete than in the current
1615         // entry.
1616         boolean isCurrent = false;
1617         UpnpEntry entry = null;
1618         if (playingQueue) {
1619             entry = currentEntry;
1620         }
1621
1622         logger.trace("Renderer {}, received media ID: {}", thing.getLabel(), media.getId());
1623
1624         if ((entry != null) && entry.getId().equals(media.getId())) {
1625             logger.trace("Current ID: {}", entry.getId());
1626
1627             isCurrent = true;
1628         } else {
1629             // Sometimes we receive the media URL without the ID, then compare on URL
1630             String mediaRes = media.getRes().trim();
1631             String entryRes = (entry != null) ? entry.getRes().trim() : "";
1632
1633             String mediaUrl = URLDecoder.decode(mediaRes, StandardCharsets.UTF_8);
1634             String entryUrl = URLDecoder.decode(entryRes, StandardCharsets.UTF_8);
1635             isCurrent = mediaUrl.equals(entryUrl);
1636
1637             logger.trace("Current queue res: {}", entryRes);
1638             logger.trace("Updated media res: {}", mediaRes);
1639         }
1640
1641         logger.trace("Received meta data is for current entry: {}", isCurrent);
1642
1643         if (!(isCurrent && media.getTitle().isEmpty())) {
1644             updateState(TITLE, StringType.valueOf(media.getTitle()));
1645         }
1646         if (!(isCurrent && (media.getAlbum().isEmpty() || media.getAlbum().matches("Unknown.*")))) {
1647             updateState(ALBUM, StringType.valueOf(media.getAlbum()));
1648         }
1649         if (!(isCurrent
1650                 && (media.getAlbumArtUri().isEmpty() || media.getAlbumArtUri().contains("DefaultAlbumCover")))) {
1651             if (media.getAlbumArtUri().isEmpty() || media.getAlbumArtUri().contains("DefaultAlbumCover")) {
1652                 updateState(ALBUM_ART, UnDefType.UNDEF);
1653             } else {
1654                 State albumArt = HttpUtil.downloadImage(media.getAlbumArtUri());
1655                 if (albumArt == null) {
1656                     logger.debug("Failed to download the content of album art from URL {}", media.getAlbumArtUri());
1657                     if (!isCurrent) {
1658                         updateState(ALBUM_ART, UnDefType.UNDEF);
1659                     }
1660                 } else {
1661                     updateState(ALBUM_ART, albumArt);
1662                 }
1663             }
1664         }
1665         if (!(isCurrent && (media.getCreator().isEmpty() || media.getCreator().matches("Unknown.*")))) {
1666             updateState(CREATOR, StringType.valueOf(media.getCreator()));
1667         }
1668         if (!(isCurrent && (media.getArtist().isEmpty() || media.getArtist().matches("Unknown.*")))) {
1669             updateState(ARTIST, StringType.valueOf(media.getArtist()));
1670         }
1671         if (!(isCurrent && (media.getPublisher().isEmpty() || media.getPublisher().matches("Unknown.*")))) {
1672             updateState(PUBLISHER, StringType.valueOf(media.getPublisher()));
1673         }
1674         if (!(isCurrent && (media.getGenre().isEmpty() || media.getGenre().matches("Unknown.*")))) {
1675             updateState(GENRE, StringType.valueOf(media.getGenre()));
1676         }
1677         if (!(isCurrent && (media.getOriginalTrackNumber() == null))) {
1678             Integer trackNumber = media.getOriginalTrackNumber();
1679             State trackNumberState = (trackNumber != null) ? new DecimalType(trackNumber) : UnDefType.UNDEF;
1680             updateState(TRACK_NUMBER, trackNumberState);
1681         }
1682     }
1683
1684     private void clearMetaDataState() {
1685         updateState(TITLE, UnDefType.UNDEF);
1686         updateState(ALBUM, UnDefType.UNDEF);
1687         updateState(ALBUM_ART, UnDefType.UNDEF);
1688         updateState(CREATOR, UnDefType.UNDEF);
1689         updateState(ARTIST, UnDefType.UNDEF);
1690         updateState(PUBLISHER, UnDefType.UNDEF);
1691         updateState(GENRE, UnDefType.UNDEF);
1692         updateState(TRACK_NUMBER, UnDefType.UNDEF);
1693     }
1694
1695     /**
1696      * @return Audio formats supported by the renderer.
1697      */
1698     public Set<AudioFormat> getSupportedAudioFormats() {
1699         return supportedAudioFormats;
1700     }
1701
1702     private void registerAudioSink() {
1703         if (audioSinkRegistered) {
1704             logger.debug("Audio Sink already registered for renderer {}", thing.getLabel());
1705             return;
1706         } else if (!upnpIOService.isRegistered(this)) {
1707             logger.debug("Audio Sink registration for renderer {} failed, no service", thing.getLabel());
1708             return;
1709         }
1710         logger.debug("Registering Audio Sink for renderer {}", thing.getLabel());
1711         audioSinkReg.registerAudioSink(this);
1712         audioSinkRegistered = true;
1713     }
1714
1715     /**
1716      * @return UPnP sink definitions supported by the renderer.
1717      */
1718     protected List<String> getSink() {
1719         return sink;
1720     }
1721 }