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 with the
 487      * {@link org.openhab.binding.upnpcontrol.internal.audiosink.UpnpAudioSink#getVolume UpnpAudioSink.getVolume}
 488      * method.
 489      *
 490      * @return current volume
 491      */
 492     public PercentType getCurrentVolume() {
 493         return soundVolume;
 494     }
 495
 496     /**
 497      * Invoke GetVolume on UPnP Rendering Control.
 498      * Result is received in {@link #onValueReceived}.
 499      *
 500      * @param channel
 501      */
 502     protected void getVolume(String channel) {
 503         Map<String, String> inputs = new HashMap<>();
 504         inputs.put(INSTANCE_ID, Integer.toString(rcsId));
 505         inputs.put("Channel", channel);
 506
 507         invokeAction(RENDERING_CONTROL, "GetVolume", inputs);
 508     }
 509
 510     /**
 511      * Invoke SetVolume on UPnP Rendering Control.
 512      *
 513      * @param channel
 514      * @param volume
 515      */
 516     protected void setVolume(String channel, PercentType volume) {
 517         UpnpRenderingControlConfiguration config = renderingControlConfiguration;
 518
 519         long newVolume = volume.intValue() * config.maxvolume / 100;
 520         Map<String, String> inputs = new HashMap<>();
 521         inputs.put(INSTANCE_ID, Integer.toString(rcsId));
 522         inputs.put("Channel", channel);
 523         inputs.put("DesiredVolume", String.valueOf(newVolume));
 524
 525         invokeAction(RENDERING_CONTROL, "SetVolume", inputs);
 526     }
 527
 528     /**
 529      * Invoke SetVolume for Master channel on UPnP Rendering Control.
 530      *
 531      * @param volume
 532      */
 533     public void setVolume(PercentType volume) {
 534         setVolume(UPNP_MASTER, volume);
 535     }
 536
 537     /**
 538      * Invoke getMute on UPnP Rendering Control.
 539      * Result is received in {@link #onValueReceived}.
 540      *
 541      * @param channel
 542      */
 543     protected void getMute(String channel) {
 544         Map<String, String> inputs = new HashMap<>();
 545         inputs.put(INSTANCE_ID, Integer.toString(rcsId));
 546         inputs.put("Channel", channel);
 547
 548         invokeAction(RENDERING_CONTROL, "GetMute", inputs);
 549     }
 550
 551     /**
 552      * Invoke SetMute on UPnP Rendering Control.
 553      *
 554      * @param channel
 555      * @param mute
 556      */
 557     protected void setMute(String channel, OnOffType mute) {
 558         Map<String, String> inputs = new HashMap<>();
 559         inputs.put(INSTANCE_ID, Integer.toString(rcsId));
 560         inputs.put("Channel", channel);
 561         inputs.put("DesiredMute", mute == OnOffType.ON ? "1" : "0");
 562
 563         invokeAction(RENDERING_CONTROL, "SetMute", inputs);
 564     }
 565
 566     /**
 567      * Invoke getMute on UPnP Rendering Control.
 568      * Result is received in {@link #onValueReceived}.
 569      *
 570      * @param channel
 571      */
 572     protected void getLoudness(String channel) {
 573         Map<String, String> inputs = new HashMap<>();
 574         inputs.put(INSTANCE_ID, Integer.toString(rcsId));
 575         inputs.put("Channel", channel);
 576
 577         invokeAction(RENDERING_CONTROL, "GetLoudness", inputs);
 578     }
 579
 580     /**
 581      * Invoke SetMute on UPnP Rendering Control.
 582      *
 583      * @param channel
 584      * @param mute
 585      */
 586     protected void setLoudness(String channel, OnOffType mute) {
 587         Map<String, String> inputs = new HashMap<>();
 588         inputs.put(INSTANCE_ID, Integer.toString(rcsId));
 589         inputs.put("Channel", channel);
 590         inputs.put("DesiredLoudness", mute == OnOffType.ON ? "1" : "0");
 591
 592         invokeAction(RENDERING_CONTROL, "SetLoudness", inputs);
 593     }
 594
 595     /**
 596      * Called from server handler for renderer to be able to send back status to server handler
 597      *
 598      * @param handler
 599      */
 600     protected void setServerHandler(UpnpServerHandler handler) {
 601         logger.debug("Set server handler {} on renderer {}", handler.getThing().getLabel(), thing.getLabel());
 602         serverHandlers.add(handler);
 603     }
 604
 605     /**
 606      * Should be called from server handler when server stops serving this renderer
 607      */
 608     protected void unsetServerHandler() {
 609         logger.debug("Unset server handler on renderer {}", thing.getLabel());
 610         for (UpnpServerHandler handler : serverHandlers) {
 611             Thing serverThing = handler.getThing();
 612             Channel serverChannel;
 613             for (String channel : SERVER_CONTROL_CHANNELS) {
 614                 if ((serverChannel = serverThing.getChannel(channel)) != null) {
 615                     handler.updateServerState(serverChannel.getUID(), UnDefType.UNDEF);
 616                 }
 617             }
 618
 619             serverHandlers.remove(handler);
 620         }
 621     }
 622
 623     @Override
 624     protected void updateState(ChannelUID channelUID, State state) {
 625         // override to be able to propagate channel state updates to corresponding channels on the server
 626         if (SERVER_CONTROL_CHANNELS.contains(channelUID.getId())) {
 627             for (UpnpServerHandler handler : serverHandlers) {
 628                 Thing serverThing = handler.getThing();
 629                 Channel serverChannel = serverThing.getChannel(channelUID.getId());
 630                 if (serverChannel != null) {
 631                     logger.debug("Update server {} channel {} with state {} from renderer {}", serverThing.getLabel(),
 632                             state, channelUID, thing.getLabel());
 633                     handler.updateServerState(serverChannel.getUID(), state);
 634                 }
 635             }
 636         }
 637         super.updateState(channelUID, state);
 638     }
 639
 640     @Override
 641     public void handleCommand(ChannelUID channelUID, Command command) {
 642         logger.debug("Handle command {} for channel {} on renderer {}", command, channelUID, thing.getLabel());
 643
 644         String id = channelUID.getId();
 645
 646         if (id.endsWith("volume")) {
 647             handleCommandVolume(command, id);
 648         } else if (id.endsWith("mute")) {
 649             handleCommandMute(command, id);
 650         } else if (id.endsWith("loudness")) {
 651             handleCommandLoudness(command, id);
 652         } else {
 653             switch (id) {
 654                 case STOP:
 655                     handleCommandStop(command);
 656                     break;
 657                 case CONTROL:
 658                     handleCommandControl(channelUID, command);
 659                     break;
 660                 case REPEAT:
 661                     handleCommandRepeat(channelUID, command);
 662                     break;
 663                 case SHUFFLE:
 664                     handleCommandShuffle(channelUID, command);
 665                 case ONLY_PLAY_ONE:
 666                     handleCommandOnlyPlayOne(channelUID, command);
 667                     break;
 668                 case URI:
 669                     handleCommandUri(channelUID, command);
 670                     break;
 671                 case FAVORITE_SELECT:
 672                     handleCommandFavoriteSelect(command);
 673                     break;
 674                 case FAVORITE:
 675                     handleCommandFavorite(channelUID, command);
 676                     break;
 677                 case FAVORITE_ACTION:
 678                     handleCommandFavoriteAction(command);
 679                     break;
 680                 case PLAYLIST_SELECT:
 681                     handleCommandPlaylistSelect(command);
 682                     break;
 683                 case TRACK_POSITION:
 684                     handleCommandTrackPosition(channelUID, command);
 685                     break;
 686                 case REL_TRACK_POSITION:
 687                     handleCommandRelTrackPosition(channelUID, command);
 688                     break;
 689                 default:
 690                     break;
 691             }
 692         }
 693     }
 694
 695     private void handleCommandVolume(Command command, String id) {
 696         if (command instanceof RefreshType) {
 697             getVolume("volume".equals(id) ? UPNP_MASTER : id.replace("volume", ""));
 698         } else if (command instanceof PercentType) {
 699             setVolume("volume".equals(id) ? UPNP_MASTER : id.replace("volume", ""), (PercentType) command);
 700         }
 701     }
 702
 703     private void handleCommandMute(Command command, String id) {
 704         if (command instanceof RefreshType) {
 705             getMute("mute".equals(id) ? UPNP_MASTER : id.replace("mute", ""));
 706         } else if (command instanceof OnOffType) {
 707             setMute("mute".equals(id) ? UPNP_MASTER : id.replace("mute", ""), (OnOffType) command);
 708         }
 709     }
 710
 711     private void handleCommandLoudness(Command command, String id) {
 712         if (command instanceof RefreshType) {
 713             getLoudness("loudness".equals(id) ? UPNP_MASTER : id.replace("loudness", ""));
 714         } else if (command instanceof OnOffType) {
 715             setLoudness("loudness".equals(id) ? UPNP_MASTER : id.replace("loudness", ""), (OnOffType) command);
 716         }
 717     }
 718
 719     private void handleCommandStop(Command command) {
 720         if (OnOffType.ON.equals(command)) {
 721             updateState(CONTROL, PlayPauseType.PAUSE);
 722             stop();
 723             updateState(TRACK_POSITION, new QuantityType<>(0, Units.SECOND));
 724         }
 725     }
 726
 727     private void handleCommandControl(ChannelUID channelUID, Command command) {
 728         String state;
 729         if (command instanceof RefreshType) {
 730             state = transportState;
 731             State newState = UnDefType.UNDEF;
 732             if ("PLAYING".equals(state)) {
 733                 newState = PlayPauseType.PLAY;
 734             } else if ("STOPPED".equals(state)) {
 735                 newState = PlayPauseType.PAUSE;
 736             } else if ("PAUSED_PLAYBACK".equals(state)) {
 737                 newState = PlayPauseType.PAUSE;
 738             }
 739             updateState(channelUID, newState);
 740         } else if (command instanceof PlayPauseType) {
 741             if (PlayPauseType.PLAY.equals(command)) {
 742                 if (registeredQueue) {
 743                     registeredQueue = false;
 744                     playingQueue = true;
 745                     oneplayed = false;
 746                     serve();
 747                 } else {
 748                     play();
 749                 }
 750             } else if (PlayPauseType.PAUSE.equals(command)) {
 751                 checkPaused();
 752                 pause();
 753             }
 754         } else if (command instanceof NextPreviousType) {
 755             if (NextPreviousType.NEXT.equals(command)) {
 756                 serveNext();
 757             } else if (NextPreviousType.PREVIOUS.equals(command)) {
 758                 servePrevious();
 759             }
 760         } else if (command instanceof RewindFastforwardType) {
 761             int pos = 0;
 762             if (RewindFastforwardType.FASTFORWARD.equals(command)) {
 763                 pos = Integer.min(trackDuration, trackPosition + config.seekStep);
 764             } else if (command == RewindFastforwardType.REWIND) {
 765                 pos = Integer.max(0, trackPosition - config.seekStep);
 766             }
 767             seek(String.format("%02d:%02d:%02d", pos / 3600, (pos % 3600) / 60, pos % 60));
 768         }
 769     }
 770
 771     private void handleCommandRepeat(ChannelUID channelUID, Command command) {
 772         if (command instanceof RefreshType) {
 773             updateState(channelUID, OnOffType.from(repeat));
 774         } else {
 775             repeat = (OnOffType.ON.equals(command));
 776             currentQueue.setRepeat(repeat);
 777             updateState(channelUID, OnOffType.from(repeat));
 778             logger.debug("Repeat set to {} for {}", repeat, thing.getLabel());
 779         }
 780     }
 781
 782     private void handleCommandShuffle(ChannelUID channelUID, Command command) {
 783         if (command instanceof RefreshType) {
 784             updateState(channelUID, OnOffType.from(shuffle));
 785         } else {
 786             shuffle = (OnOffType.ON.equals(command));
 787             currentQueue.setShuffle(shuffle);
 788             if (!playing) {
 789                 resetToStartQueue();
 790             }
 791             updateState(channelUID, OnOffType.from(shuffle));
 792             logger.debug("Shuffle set to {} for {}", shuffle, thing.getLabel());
 793         }
 794     }
 795
 796     private void handleCommandOnlyPlayOne(ChannelUID channelUID, Command command) {
 797         if (command instanceof RefreshType) {
 798             updateState(channelUID, OnOffType.from(onlyplayone));
 799         } else {
 800             onlyplayone = (OnOffType.ON.equals(command));
 801             oneplayed = (onlyplayone && playing) ? true : false;
 802             if (oneplayed) {
 803                 setNextURI("", "");
 804             } else {
 805                 UpnpEntry next = nextEntry;
 806                 if (next != null) {
 807                     setNextURI(next.getRes(), UpnpXMLParser.compileMetadataString(next));
 808                 }
 809             }
 810             updateState(channelUID, OnOffType.from(onlyplayone));
 811             logger.debug("OnlyPlayOne set to {} for {}", onlyplayone, thing.getLabel());
 812         }
 813     }
 814
 815     private void handleCommandUri(ChannelUID channelUID, Command command) {
 816         if (command instanceof RefreshType) {
 817             updateState(channelUID, StringType.valueOf(nowPlayingUri));
 818         } else if (command instanceof StringType) {
 819             setCurrentURI(command.toString(), "");
 820             play();
 821         }
 822     }
 823
 824     private void handleCommandFavoriteSelect(Command command) {
 825         if (command instanceof StringType) {
 826             favoriteName = command.toString();
 827             updateState(FAVORITE, StringType.valueOf(favoriteName));
 828             playFavorite();
 829         }
 830     }
 831
 832     private void handleCommandFavorite(ChannelUID channelUID, Command command) {
 833         if (command instanceof StringType) {
 834             favoriteName = command.toString();
 835             if (favoriteCommandOptionList.contains(new CommandOption(favoriteName, favoriteName))) {
 836                 playFavorite();
 837             }
 838         }
 839         updateState(channelUID, StringType.valueOf(favoriteName));
 840     }
 841
 842     private void handleCommandFavoriteAction(Command command) {
 843         if (command instanceof StringType) {
 844             switch (command.toString()) {
 845                 case SAVE:
 846                     handleCommandFavoriteSave();
 847                     break;
 848                 case DELETE:
 849                     handleCommandFavoriteDelete();
 850                     break;
 851             }
 852         }
 853     }
 854
 855     private void handleCommandFavoriteSave() {
 856         if (!favoriteName.isEmpty()) {
 857             UpnpFavorite favorite = new UpnpFavorite(favoriteName, nowPlayingUri, currentEntry);
 858             favorite.saveFavorite(favoriteName, bindingConfig.path);
 859             updateFavoritesList();
 860         }
 861     }
 862
 863     private void handleCommandFavoriteDelete() {
 864         if (!favoriteName.isEmpty()) {
 865             UpnpControlUtil.deleteFavorite(favoriteName, bindingConfig.path);
 866             updateFavoritesList();
 867             updateState(FAVORITE, UnDefType.UNDEF);
 868         }
 869     }
 870
 871     private void handleCommandPlaylistSelect(Command command) {
 872         if (command instanceof StringType) {
 873             String playlistName = command.toString();
 874             UpnpEntryQueue queue = new UpnpEntryQueue();
 875             queue.restoreQueue(playlistName, null, bindingConfig.path);
 876             registerQueue(queue);
 877             resetToStartQueue();
 878             playingQueue = true;
 879             serve();
 880         }
 881     }
 882
 883     private void handleCommandTrackPosition(ChannelUID channelUID, Command command) {
 884         if (command instanceof RefreshType) {
 885             updateState(channelUID, new QuantityType<>(trackPosition, Units.SECOND));
 886         } else if (command instanceof QuantityType<?>) {
 887             QuantityType<?> position = ((QuantityType<?>) command).toUnit(Units.SECOND);
 888             if (position != null) {
 889                 int pos = Integer.min(trackDuration, position.intValue());
 890                 seek(String.format("%02d:%02d:%02d", pos / 3600, (pos % 3600) / 60, pos % 60));
 891             }
 892         }
 893     }
 894
 895     private void handleCommandRelTrackPosition(ChannelUID channelUID, Command command) {
 896         if (command instanceof RefreshType) {
 897             int relPosition = (trackDuration != 0) ? (trackPosition * 100) / trackDuration : 0;
 898             updateState(channelUID, new PercentType(relPosition));
 899         } else if (command instanceof PercentType) {
 900             int pos = ((PercentType) command).intValue() * trackDuration / 100;
 901             seek(String.format("%02d:%02d:%02d", pos / 3600, (pos % 3600) / 60, pos % 60));
 902         }
 903     }
 904
 905     /**
 906      * Set the volume for notifications.
 907      *
 908      * @param volume
 909      */
 910     public void setNotificationVolume(PercentType volume) {
 911         notificationVolume = volume;
 912     }
 913
 914     /**
 915      * Play a notification. Previous state of the renderer will resume at the end of the notification, or after the
 916      * maximum notification duration as defined in the renderer parameters.
 917      *
 918      * @param URI for notification sound
 919      */
 920     public void playNotification(String URI) {
 921         synchronized (notificationLock) {
 922             if (URI.isEmpty()) {
 923                 logger.debug("UPnP device {} received empty notification URI", thing.getLabel());
 924                 return;
 925             }
 926
 927             notificationUri = URI;
 928
 929             logger.debug("UPnP device {} playing notification {}", thing.getLabel(), URI);
 930
 931             cancelTrackPositionRefresh();
 932             getPositionInfo();
 933
 934             cancelPlayingNotificationFuture();
 935
 936             if (config.maxNotificationDuration > 0) {
 937                 playingNotificationFuture = upnpScheduler.schedule(this::stop, config.maxNotificationDuration,
 938                         TimeUnit.SECONDS);
 939             }
 940             playingNotification = true;
 941
 942             setCurrentURI(URI, "");
 943             setNextURI("", "");
 944             PercentType volume = notificationVolume;
 945             setVolume(volume == null
 946                     ? new PercentType(Math.min(100,
 947                             Math.max(0, (100 + config.notificationVolumeAdjustment) * soundVolume.intValue() / 100)))
 948                     : volume);
 949
 950             CompletableFuture<Boolean> stopping = isStopping;
 951             try {
 952                 if (stopping != null) {
 953                     // wait for maximum 2.5s until the renderer stopped before playing
 954                     stopping.get(config.responseTimeout, TimeUnit.MILLISECONDS);
 955                 }
 956             } catch (InterruptedException | ExecutionException | TimeoutException e) {
 957                 logger.debug("Timeout exception, renderer {} didn't stop yet, trying to play anyway", thing.getLabel());
 958             }
 959             play();
 960         }
 961     }
 962
 963     private void cancelPlayingNotificationFuture() {
 964         ScheduledFuture<?> future = playingNotificationFuture;
 965         if (future != null) {
 966             future.cancel(true);
 967             playingNotificationFuture = null;
 968         }
 969     }
 970
 971     private void resumeAfterNotification() {
 972         synchronized (notificationLock) {
 973             logger.debug("UPnP device {} resume after playing notification", thing.getLabel());
 974
 975             setCurrentURI(nowPlayingUri, "");
 976             setVolume(soundVolume);
 977
 978             cancelPlayingNotificationFuture();
 979
 980             playingNotification = false;
 981             notificationVolume = null;
 982             notificationUri = "";
 983
 984             if (playing) {
 985                 int pos = posAtNotificationStart;
 986                 seek(String.format("%02d:%02d:%02d", pos / 3600, (pos % 3600) / 60, pos % 60));
 987                 play();
 988             }
 989             posAtNotificationStart = 0;
 990         }
 991     }
 992
 993     private void playFavorite() {
 994         UpnpFavorite favorite = new UpnpFavorite(favoriteName, bindingConfig.path);
 995         String uri = favorite.getUri();
 996         UpnpEntry entry = favorite.getUpnpEntry();
 997         if (!uri.isEmpty()) {
 998             String metadata = "";
 999             if (entry != null) {
1000                 metadata = UpnpXMLParser.compileMetadataString(entry);
1001             }
1002             setCurrentURI(uri, metadata);
1003             play();
1004         }
1005     }
1006
1007     void updateFavoritesList() {
1008         favoriteCommandOptionList = UpnpControlUtil.favorites(bindingConfig.path).stream()
1009                 .map(p -> (new CommandOption(p, p))).collect(Collectors.toList());
1010         updateCommandDescription(favoriteSelectChannelUID, favoriteCommandOptionList);
1011     }
1012
1013     @Override
1014     public void playlistsListChanged() {
1015         playlistCommandOptionList = UpnpControlUtil.playlists().stream().map(p -> (new CommandOption(p, p)))
1016                 .collect(Collectors.toList());
1017         updateCommandDescription(playlistSelectChannelUID, playlistCommandOptionList);
1018     }
1019
1020     @Override
1021     public void onStatusChanged(boolean status) {
1022         if (!status) {
1023             removeSubscriptions();
1024
1025             updateState(CONTROL, PlayPauseType.PAUSE);
1026             cancelTrackPositionRefresh();
1027         }
1028         super.onStatusChanged(status);
1029     }
1030
1031     @Override
1032     protected @Nullable String preProcessValueReceived(Map<String, String> inputs, @Nullable String variable,
1033             @Nullable String value, @Nullable String service, @Nullable String action) {
1034         if (variable == null) {
1035             return null;
1036         } else {
1037             switch (variable) {
1038                 case "CurrentVolume":
1039                     return (inputs.containsKey("Channel") ? inputs.get("Channel") : UPNP_MASTER) + "Volume";
1040                 case "CurrentMute":
1041                     return (inputs.containsKey("Channel") ? inputs.get("Channel") : UPNP_MASTER) + "Mute";
1042                 case "CurrentLoudness":
1043                     return (inputs.containsKey("Channel") ? inputs.get("Channel") : UPNP_MASTER) + "Loudness";
1044                 default:
1045                     return variable;
1046             }
1047         }
1048     }
1049
1050     @Override
1051     public void onValueReceived(@Nullable String variable, @Nullable String value, @Nullable String service) {
1052         if (logger.isTraceEnabled()) {
1053             logger.trace("UPnP device {} received variable {} with value {} from service {}", thing.getLabel(),
1054                     variable, value, service);
1055         } else {
1056             if (logger.isDebugEnabled() && !("AbsTime".equals(variable) || "RelCount".equals(variable)
1057                     || "RelTime".equals(variable) || "AbsCount".equals(variable) || "Track".equals(variable)
1058                     || "TrackDuration".equals(variable))) {
1059                 // don't log all variables received when updating the track position every second
1060                 logger.debug("UPnP device {} received variable {} with value {} from service {}", thing.getLabel(),
1061                         variable, value, service);
1062             }
1063         }
1064         if (variable == null) {
1065             return;
1066         }
1067
1068         if (variable.endsWith("Volume")) {
1069             onValueReceivedVolume(variable, value);
1070         } else if (variable.endsWith("Mute")) {
1071             onValueReceivedMute(variable, value);
1072         } else if (variable.endsWith("Loudness")) {
1073             onValueReceivedLoudness(variable, value);
1074         } else {
1075             switch (variable) {
1076                 case "LastChange":
1077                     onValueReceivedLastChange(value, service);
1078                     break;
1079                 case "CurrentTransportState":
1080                 case "TransportState":
1081                     onValueReceivedTransportState(value);
1082                     break;
1083                 case "CurrentTrackURI":
1084                 case "CurrentURI":
1085                     onValueReceivedCurrentURI(value);
1086                     break;
1087                 case "CurrentTrackMetaData":
1088                 case "CurrentURIMetaData":
1089                     onValueReceivedCurrentMetaData(value);
1090                     break;
1091                 case "NextAVTransportURIMetaData":
1092                 case "NextURIMetaData":
1093                     onValueReceivedNextMetaData(value);
1094                     break;
1095                 case "CurrentTrackDuration":
1096                 case "TrackDuration":
1097                     onValueReceivedDuration(value);
1098                     break;
1099                 case "RelTime":
1100                     onValueReceivedRelTime(value);
1101                     break;
1102                 default:
1103                     super.onValueReceived(variable, value, service);
1104                     break;
1105             }
1106         }
1107     }
1108
1109     private void onValueReceivedVolume(String variable, @Nullable String value) {
1110         if (value != null && !value.isEmpty()) {
1111             UpnpRenderingControlConfiguration config = renderingControlConfiguration;
1112
1113             long volume = Long.valueOf(value);
1114             volume = volume * 100 / config.maxvolume;
1115
1116             String upnpChannel = variable.replace("Volume", "volume").replace("Master", "");
1117             updateState(upnpChannel, new PercentType((int) volume));
1118
1119             if (!playingNotification && "volume".equals(upnpChannel)) {
1120                 soundVolume = new PercentType((int) volume);
1121             }
1122         }
1123     }
1124
1125     private void onValueReceivedMute(String variable, @Nullable String value) {
1126         if (value != null && !value.isEmpty()) {
1127             String upnpChannel = variable.replace("Mute", "mute").replace("Master", "");
1128             updateState(upnpChannel,
1129                     ("1".equals(value) || "true".equals(value.toLowerCase())) ? OnOffType.ON : OnOffType.OFF);
1130         }
1131     }
1132
1133     private void onValueReceivedLoudness(String variable, @Nullable String value) {
1134         if (value != null && !value.isEmpty()) {
1135             String upnpChannel = variable.replace("Loudness", "loudness").replace("Master", "");
1136             updateState(upnpChannel,
1137                     ("1".equals(value) || "true".equals(value.toLowerCase())) ? OnOffType.ON : OnOffType.OFF);
1138         }
1139     }
1140
1141     private void onValueReceivedLastChange(@Nullable String value, @Nullable String service) {
1142         // This is returned from a GENA subscription. The jupnp library does not allow receiving new GENA subscription
1143         // messages as long as this thread has not finished. As we may trigger long running processes based on this
1144         // result, we run it in a separate thread.
1145         upnpScheduler.submit(() -> {
1146             // pre-process some variables, eg XML processing
1147             if (value != null && !value.isEmpty()) {
1148                 if (AV_TRANSPORT.equals(service)) {
1149                     Map<String, String> parsedValues = UpnpXMLParser.getAVTransportFromXML(value);
1150                     for (Map.Entry<String, String> entrySet : parsedValues.entrySet()) {
1151                         switch (entrySet.getKey()) {
1152                             case "TransportState":
1153                                 // Update the transport state after the update of the media information
1154                                 // to not break the notification mechanism
1155                                 break;
1156                             case "AVTransportURI":
1157                                 onValueReceived("CurrentTrackURI", entrySet.getValue(), service);
1158                                 break;
1159                             case "AVTransportURIMetaData":
1160                                 onValueReceived("CurrentTrackMetaData", entrySet.getValue(), service);
1161                                 break;
1162                             default:
1163                                 onValueReceived(entrySet.getKey(), entrySet.getValue(), service);
1164                         }
1165                     }
1166                     if (parsedValues.containsKey("TransportState")) {
1167                         onValueReceived("TransportState", parsedValues.get("TransportState"), service);
1168                     }
1169                 } else if (RENDERING_CONTROL.equals(service)) {
1170                     Map<String, @Nullable String> parsedValues = UpnpXMLParser.getRenderingControlFromXML(value);
1171                     for (String parsedValue : parsedValues.keySet()) {
1172                         onValueReceived(parsedValue, parsedValues.get(parsedValue), RENDERING_CONTROL);
1173                     }
1174                 }
1175             }
1176         });
1177     }
1178
1179     private void onValueReceivedTransportState(@Nullable String value) {
1180         transportState = (value == null) ? "" : value;
1181
1182         if ("STOPPED".equals(value)) {
1183             CompletableFuture<Boolean> stopping = isStopping;
1184             if (stopping != null) {
1185                 stopping.complete(true); // We have received stop confirmation
1186                 isStopping = null;
1187             }
1188
1189             if (playingNotification) {
1190                 resumeAfterNotification();
1191                 return;
1192             }
1193
1194             cancelCheckPaused();
1195             updateState(CONTROL, PlayPauseType.PAUSE);
1196             cancelTrackPositionRefresh();
1197             // Only go to next for first STOP command, then wait until we received PLAYING before moving
1198             // to next (avoids issues with renderers sending multiple stop states)
1199             if (playing) {
1200                 playing = false;
1201
1202                 // playerStopped is true if stop came from openHAB. This allows us to identify if we played to the
1203                 // end of an entry, because STOP would come from the player and not from openHAB. We should then
1204                 // move to the next entry if the queue is not at the end already.
1205                 if (!playerStopped) {
1206                     if (Instant.now().toEpochMilli() >= expectedTrackend) {
1207                         // If we are receiving track duration info, we know when the track is expected to end. If we
1208                         // received STOP before track end, and it is not coming from openHAB, it must have been stopped
1209                         // from the renderer directly, and we do not want to play the next entry.
1210                         if (playingQueue) {
1211                             serveNext();
1212                         }
1213                     }
1214                 } else if (playingQueue) {
1215                     playingQueue = false;
1216                 }
1217             }
1218         } else if ("PLAYING".equals(value)) {
1219             if (playingNotification) {
1220                 return;
1221             }
1222
1223             playerStopped = false;
1224             playing = true;
1225             registeredQueue = false; // reset queue registration flag as we are playing something
1226             updateState(CONTROL, PlayPauseType.PLAY);
1227             scheduleTrackPositionRefresh();
1228         } else if ("PAUSED_PLAYBACK".equals(value)) {
1229             cancelCheckPaused();
1230             updateState(CONTROL, PlayPauseType.PAUSE);
1231         } else if ("NO_MEDIA_PRESENT".equals(value)) {
1232             updateState(CONTROL, UnDefType.UNDEF);
1233         }
1234     }
1235
1236     private void onValueReceivedCurrentURI(@Nullable String value) {
1237         CompletableFuture<Boolean> settingURI = isSettingURI;
1238         if (settingURI != null) {
1239             settingURI.complete(true); // We have received current URI, so can allow play to start
1240         }
1241
1242         UpnpEntry current = currentEntry;
1243         UpnpEntry next = nextEntry;
1244
1245         String uri = "";
1246         String currentUri = "";
1247         String nextUri = "";
1248         if (value != null) {
1249             uri = URLDecoder.decode(value.trim(), StandardCharsets.UTF_8);
1250         }
1251         if (current != null) {
1252             currentUri = URLDecoder.decode(current.getRes().trim(), StandardCharsets.UTF_8);
1253         }
1254         if (next != null) {
1255             nextUri = URLDecoder.decode(next.getRes(), StandardCharsets.UTF_8);
1256         }
1257
1258         if (playingNotification && uri.equals(notificationUri)) {
1259             // No need to update anything more if this is for playing a notification
1260             return;
1261         }
1262
1263         nowPlayingUri = uri;
1264         updateState(URI, StringType.valueOf(uri));
1265
1266         logger.trace("Renderer {} received URI: {}", thing.getLabel(), uri);
1267         logger.trace("Renderer {} current URI: {}, equal to received URI {}", thing.getLabel(), currentUri,
1268                 uri.equals(currentUri));
1269         logger.trace("Renderer {} next URI: {}", thing.getLabel(), nextUri);
1270
1271         if (!uri.equals(currentUri)) {
1272             if ((next != null) && uri.equals(nextUri)) {
1273                 // Renderer advanced to next entry independent of openHAB UPnP control point.
1274                 // Advance in the queue to keep proper position status.
1275                 // Make the next entry available to renderers that support it.
1276                 logger.trace("Renderer {} moved from '{}' to next entry '{}' in queue", thing.getLabel(), current,
1277                         next);
1278                 currentEntry = currentQueue.next();
1279                 nextEntry = currentQueue.get(currentQueue.nextIndex());
1280                 logger.trace("Renderer {} auto move forward, current queue index: {}", thing.getLabel(),
1281                         currentQueue.index());
1282
1283                 updateMetaDataState(next);
1284
1285                 // look one further to get next entry for next URI
1286                 next = nextEntry;
1287                 if ((next != null) && !onlyplayone) {
1288                     setNextURI(next.getRes(), UpnpXMLParser.compileMetadataString(next));
1289                 }
1290             } else {
1291                 // A new entry is being served that does not match the next entry in the queue. This can be because a
1292                 // sound or stream is being played through an action, or another control point started a new entry.
1293                 // We should clear the metadata in this case and wait for new metadata to arrive.
1294                 clearMetaDataState();
1295             }
1296         }
1297     }
1298
1299     private void onValueReceivedCurrentMetaData(@Nullable String value) {
1300         if (playingNotification) {
1301             // Don't update metadata when playing notification
1302             return;
1303         }
1304
1305         if (value != null && !value.isEmpty()) {
1306             List<UpnpEntry> list = UpnpXMLParser.getEntriesFromXML(value);
1307             if (!list.isEmpty()) {
1308                 updateMetaDataState(list.get(0));
1309                 return;
1310             }
1311         }
1312         clearMetaDataState();
1313     }
1314
1315     private void onValueReceivedNextMetaData(@Nullable String value) {
1316         if (value != null && !value.isEmpty() && !"NOT_IMPLEMENTED".equals(value)) {
1317             List<UpnpEntry> list = UpnpXMLParser.getEntriesFromXML(value);
1318             if (!list.isEmpty()) {
1319                 nextEntry = list.get(0);
1320             }
1321         }
1322     }
1323
1324     private void onValueReceivedDuration(@Nullable String value) {
1325         // track duration and track position have format H+:MM:SS[.F+] or H+:MM:SS[.F0/F1]. We are not
1326         // interested in the fractional seconds, so drop everything after . and calculate in seconds.
1327         if (value == null || "NOT_IMPLEMENTED".equals(value)) {
1328             trackDuration = 0;
1329             updateState(TRACK_DURATION, UnDefType.UNDEF);
1330             updateState(REL_TRACK_POSITION, UnDefType.UNDEF);
1331         } else {
1332             try {
1333                 trackDuration = Arrays.stream(value.split("\\.")[0].split(":")).mapToInt(n -> Integer.parseInt(n))
1334                         .reduce(0, (n, m) -> n * 60 + m);
1335                 updateState(TRACK_DURATION, new QuantityType<>(trackDuration, Units.SECOND));
1336             } catch (NumberFormatException e) {
1337                 logger.debug("Illegal format for track duration {}", value);
1338                 return;
1339             }
1340         }
1341         setExpectedTrackend();
1342     }
1343
1344     private void onValueReceivedRelTime(@Nullable String value) {
1345         if (value == null || "NOT_IMPLEMENTED".equals(value)) {
1346             trackPosition = 0;
1347             updateState(TRACK_POSITION, UnDefType.UNDEF);
1348             updateState(REL_TRACK_POSITION, UnDefType.UNDEF);
1349         } else {
1350             try {
1351                 trackPosition = Arrays.stream(value.split("\\.")[0].split(":")).mapToInt(n -> Integer.parseInt(n))
1352                         .reduce(0, (n, m) -> n * 60 + m);
1353                 updateState(TRACK_POSITION, new QuantityType<>(trackPosition, Units.SECOND));
1354                 int relPosition = (trackDuration != 0) ? trackPosition * 100 / trackDuration : 0;
1355                 updateState(REL_TRACK_POSITION, new PercentType(relPosition));
1356             } catch (NumberFormatException e) {
1357                 logger.trace("Illegal format for track position {}", value);
1358                 return;
1359             }
1360         }
1361
1362         if (playingNotification) {
1363             posAtNotificationStart = trackPosition;
1364         }
1365
1366         setExpectedTrackend();
1367     }
1368
1369     @Override
1370     protected void updateProtocolInfo(String value) {
1371         sink.clear();
1372         supportedAudioFormats.clear();
1373         audioSupport = false;
1374
1375         sink.addAll(Arrays.asList(value.split(",")));
1376
1377         for (String protocol : sink) {
1378             Matcher matcher = PROTOCOL_PATTERN.matcher(protocol);
1379             if (matcher.find()) {
1380                 String format = matcher.group(1);
1381                 switch (format) {
1382                     case "audio/mpeg3":
1383                     case "audio/mp3":
1384                     case "audio/mpeg":
1385                         supportedAudioFormats.add(AudioFormat.MP3);
1386                         break;
1387                     case "audio/wav":
1388                     case "audio/wave":
1389                         supportedAudioFormats.add(AudioFormat.WAV);
1390                         break;
1391                 }
1392                 audioSupport = audioSupport || Pattern.matches("audio.*", format);
1393             }
1394         }
1395
1396         if (audioSupport) {
1397             logger.debug("Renderer {} supports audio", thing.getLabel());
1398             registerAudioSink();
1399         }
1400     }
1401
1402     private void clearCurrentEntry() {
1403         clearMetaDataState();
1404
1405         trackDuration = 0;
1406         updateState(TRACK_DURATION, UnDefType.UNDEF);
1407         trackPosition = 0;
1408         updateState(TRACK_POSITION, UnDefType.UNDEF);
1409         updateState(REL_TRACK_POSITION, UnDefType.UNDEF);
1410
1411         currentEntry = null;
1412     }
1413
1414     /**
1415      * Register a new queue with media entries to the renderer. Set the next position at the first entry in the list.
1416      * If the renderer is currently playing, set the first entry in the list as the next media. If not playing, set it
1417      * as current media.
1418      *
1419      * @param queue
1420      */
1421     protected void registerQueue(UpnpEntryQueue queue) {
1422         if (currentQueue.equals(queue)) {
1423             // We get the same queue, so do nothing
1424             return;
1425         }
1426
1427         logger.debug("Registering queue on renderer {}", thing.getLabel());
1428
1429         registeredQueue = true;
1430         currentQueue = queue;
1431         currentQueue.setRepeat(repeat);
1432         currentQueue.setShuffle(shuffle);
1433         if (playingQueue) {
1434             nextEntry = currentQueue.get(currentQueue.nextIndex());
1435             UpnpEntry next = nextEntry;
1436             if ((next != null) && !onlyplayone) {
1437                 // make the next entry available to renderers that support it
1438                 logger.trace("Renderer {} still playing, set new queue as next entry", thing.getLabel());
1439                 setNextURI(next.getRes(), UpnpXMLParser.compileMetadataString(next));
1440             }
1441         } else {
1442             resetToStartQueue();
1443         }
1444     }
1445
1446     /**
1447      * Move to next position in queue and start playing.
1448      */
1449     private void serveNext() {
1450         if (currentQueue.hasNext()) {
1451             currentEntry = currentQueue.next();
1452             nextEntry = currentQueue.get(currentQueue.nextIndex());
1453             logger.debug("Serve next media '{}' from queue on renderer {}", currentEntry, thing.getLabel());
1454             logger.trace("Serve next, current queue index: {}", currentQueue.index());
1455
1456             serve();
1457         } else {
1458             logger.debug("Cannot serve next, end of queue on renderer {}", thing.getLabel());
1459             resetToStartQueue();
1460         }
1461     }
1462
1463     /**
1464      * Move to previous position in queue and start playing.
1465      */
1466     private void servePrevious() {
1467         if (currentQueue.hasPrevious()) {
1468             currentEntry = currentQueue.previous();
1469             nextEntry = currentQueue.get(currentQueue.nextIndex());
1470             logger.debug("Serve previous media '{}' from queue on renderer {}", currentEntry, thing.getLabel());
1471             logger.trace("Serve previous, current queue index: {}", currentQueue.index());
1472
1473             serve();
1474         } else {
1475             logger.debug("Cannot serve previous, already at start of queue on renderer {}", thing.getLabel());
1476             resetToStartQueue();
1477         }
1478     }
1479
1480     private void resetToStartQueue() {
1481         logger.trace("Reset to start queue on renderer {}", thing.getLabel());
1482
1483         playingQueue = false;
1484         registeredQueue = true;
1485
1486         stop();
1487
1488         currentQueue.resetIndex(); // reset to beginning of queue
1489         currentEntry = currentQueue.next();
1490         nextEntry = currentQueue.get(currentQueue.nextIndex());
1491         logger.trace("Reset queue, current queue index: {}", currentQueue.index());
1492         UpnpEntry current = currentEntry;
1493         if (current != null) {
1494             clearMetaDataState();
1495             updateMetaDataState(current);
1496             setCurrentURI(current.getRes(), UpnpXMLParser.compileMetadataString(current));
1497         } else {
1498             clearCurrentEntry();
1499         }
1500
1501         UpnpEntry next = nextEntry;
1502         if (onlyplayone) {
1503             setNextURI("", "");
1504         } else if (next != null) {
1505             setNextURI(next.getRes(), UpnpXMLParser.compileMetadataString(next));
1506         }
1507     }
1508
1509     /**
1510      * Serve media from a queue and play immediately when already playing.
1511      *
1512      * @param media
1513      */
1514     private void serve() {
1515         logger.trace("Serve media on renderer {}", thing.getLabel());
1516
1517         UpnpEntry entry = currentEntry;
1518         if (entry != null) {
1519             clearMetaDataState();
1520             String res = entry.getRes();
1521             if (res.isEmpty()) {
1522                 logger.debug("Renderer {} cannot serve media '{}', no URI", thing.getLabel(), currentEntry);
1523                 playingQueue = false;
1524                 return;
1525             }
1526             updateMetaDataState(entry);
1527             setCurrentURI(res, UpnpXMLParser.compileMetadataString(entry));
1528
1529             if ((playingQueue || playing) && !(onlyplayone && oneplayed)) {
1530                 logger.trace("Ready to play '{}' from queue", currentEntry);
1531
1532                 trackDuration = 0;
1533                 trackPosition = 0;
1534                 expectedTrackend = 0;
1535                 play();
1536
1537                 oneplayed = true;
1538                 playingQueue = true;
1539             }
1540
1541             // make the next entry available to renderers that support it
1542             if (!onlyplayone) {
1543                 UpnpEntry next = nextEntry;
1544                 if (next != null) {
1545                     setNextURI(next.getRes(), UpnpXMLParser.compileMetadataString(next));
1546                 }
1547             }
1548         }
1549     }
1550
1551     /**
1552      * Called before handling a pause CONTROL command. If we do not received PAUSED_PLAYBACK or STOPPED back within
1553      * timeout, we will revert to playing state. This takes care of renderers that cannot pause playback.
1554      */
1555     private void checkPaused() {
1556         paused = upnpScheduler.schedule(this::resetPaused, config.responseTimeout, TimeUnit.MILLISECONDS);
1557     }
1558
1559     private void resetPaused() {
1560         updateState(CONTROL, PlayPauseType.PLAY);
1561     }
1562
1563     private void cancelCheckPaused() {
1564         ScheduledFuture<?> future = paused;
1565         if (future != null) {
1566             future.cancel(true);
1567             paused = null;
1568         }
1569     }
1570
1571     private void setExpectedTrackend() {
1572         expectedTrackend = Instant.now().toEpochMilli() + (trackDuration - trackPosition) * 1000
1573                 - config.responseTimeout;
1574     }
1575
1576     /**
1577      * Update the current track position every second if the channel is linked.
1578      */
1579     private void scheduleTrackPositionRefresh() {
1580         if (playingNotification) {
1581             return;
1582         }
1583
1584         cancelTrackPositionRefresh();
1585         if (!(isLinked(TRACK_POSITION) || isLinked(REL_TRACK_POSITION))) {
1586             // only get it once, so we can use the track end to correctly identify STOP pressed directly on renderer
1587             getPositionInfo();
1588         } else {
1589             if (trackPositionRefresh == null) {
1590                 trackPositionRefresh = upnpScheduler.scheduleWithFixedDelay(this::getPositionInfo, 1, 1,
1591                         TimeUnit.SECONDS);
1592             }
1593         }
1594     }
1595
1596     private void cancelTrackPositionRefresh() {
1597         ScheduledFuture<?> refresh = trackPositionRefresh;
1598
1599         if (refresh != null) {
1600             refresh.cancel(true);
1601         }
1602         trackPositionRefresh = null;
1603
1604         trackPosition = 0;
1605         updateState(TRACK_POSITION, new QuantityType<>(trackPosition, Units.SECOND));
1606         int relPosition = (trackDuration != 0) ? trackPosition / trackDuration : 0;
1607         updateState(REL_TRACK_POSITION, new PercentType(relPosition));
1608     }
1609
1610     /**
1611      * Update metadata channels for media with data received from the Media Server or AV Transport.
1612      *
1613      * @param media
1614      */
1615     private void updateMetaDataState(UpnpEntry media) {
1616         // We don't want to update metadata if the metadata from the AVTransport is less complete than in the current
1617         // entry.
1618         boolean isCurrent = false;
1619         UpnpEntry entry = null;
1620         if (playingQueue) {
1621             entry = currentEntry;
1622         }
1623
1624         logger.trace("Renderer {}, received media ID: {}", thing.getLabel(), media.getId());
1625
1626         if ((entry != null) && entry.getId().equals(media.getId())) {
1627             logger.trace("Current ID: {}", entry.getId());
1628
1629             isCurrent = true;
1630         } else {
1631             // Sometimes we receive the media URL without the ID, then compare on URL
1632             String mediaRes = media.getRes().trim();
1633             String entryRes = (entry != null) ? entry.getRes().trim() : "";
1634
1635             String mediaUrl = URLDecoder.decode(mediaRes, StandardCharsets.UTF_8);
1636             String entryUrl = URLDecoder.decode(entryRes, StandardCharsets.UTF_8);
1637             isCurrent = mediaUrl.equals(entryUrl);
1638
1639             logger.trace("Current queue res: {}", entryRes);
1640             logger.trace("Updated media res: {}", mediaRes);
1641         }
1642
1643         logger.trace("Received meta data is for current entry: {}", isCurrent);
1644
1645         if (!(isCurrent && media.getTitle().isEmpty())) {
1646             updateState(TITLE, StringType.valueOf(media.getTitle()));
1647         }
1648         if (!(isCurrent && (media.getAlbum().isEmpty() || media.getAlbum().matches("Unknown.*")))) {
1649             updateState(ALBUM, StringType.valueOf(media.getAlbum()));
1650         }
1651         if (!(isCurrent
1652                 && (media.getAlbumArtUri().isEmpty() || media.getAlbumArtUri().contains("DefaultAlbumCover")))) {
1653             if (media.getAlbumArtUri().isEmpty() || media.getAlbumArtUri().contains("DefaultAlbumCover")) {
1654                 updateState(ALBUM_ART, UnDefType.UNDEF);
1655             } else {
1656                 State albumArt = HttpUtil.downloadImage(media.getAlbumArtUri());
1657                 if (albumArt == null) {
1658                     logger.debug("Failed to download the content of album art from URL {}", media.getAlbumArtUri());
1659                     if (!isCurrent) {
1660                         updateState(ALBUM_ART, UnDefType.UNDEF);
1661                     }
1662                 } else {
1663                     updateState(ALBUM_ART, albumArt);
1664                 }
1665             }
1666         }
1667         if (!(isCurrent && (media.getCreator().isEmpty() || media.getCreator().matches("Unknown.*")))) {
1668             updateState(CREATOR, StringType.valueOf(media.getCreator()));
1669         }
1670         if (!(isCurrent && (media.getArtist().isEmpty() || media.getArtist().matches("Unknown.*")))) {
1671             updateState(ARTIST, StringType.valueOf(media.getArtist()));
1672         }
1673         if (!(isCurrent && (media.getPublisher().isEmpty() || media.getPublisher().matches("Unknown.*")))) {
1674             updateState(PUBLISHER, StringType.valueOf(media.getPublisher()));
1675         }
1676         if (!(isCurrent && (media.getGenre().isEmpty() || media.getGenre().matches("Unknown.*")))) {
1677             updateState(GENRE, StringType.valueOf(media.getGenre()));
1678         }
1679         if (!(isCurrent && (media.getOriginalTrackNumber() == null))) {
1680             Integer trackNumber = media.getOriginalTrackNumber();
1681             State trackNumberState = (trackNumber != null) ? new DecimalType(trackNumber) : UnDefType.UNDEF;
1682             updateState(TRACK_NUMBER, trackNumberState);
1683         }
1684     }
1685
1686     private void clearMetaDataState() {
1687         updateState(TITLE, UnDefType.UNDEF);
1688         updateState(ALBUM, UnDefType.UNDEF);
1689         updateState(ALBUM_ART, UnDefType.UNDEF);
1690         updateState(CREATOR, UnDefType.UNDEF);
1691         updateState(ARTIST, UnDefType.UNDEF);
1692         updateState(PUBLISHER, UnDefType.UNDEF);
1693         updateState(GENRE, UnDefType.UNDEF);
1694         updateState(TRACK_NUMBER, UnDefType.UNDEF);
1695     }
1696
1697     /**
1698      * @return Audio formats supported by the renderer.
1699      */
1700     public Set<AudioFormat> getSupportedAudioFormats() {
1701         return supportedAudioFormats;
1702     }
1703
1704     private void registerAudioSink() {
1705         if (audioSinkRegistered) {
1706             logger.debug("Audio Sink already registered for renderer {}", thing.getLabel());
1707             return;
1708         } else if (!upnpIOService.isRegistered(this)) {
1709             logger.debug("Audio Sink registration for renderer {} failed, no service", thing.getLabel());
1710             return;
1711         }
1712         logger.debug("Registering Audio Sink for renderer {}", thing.getLabel());
1713         audioSinkReg.registerAudioSink(this);
1714         audioSinkRegistered = true;
1715     }
1716
1717     /**
1718      * @return UPnP sink definitions supported by the renderer.
1719      */
1720     protected List<String> getSink() {
1721         return sink;
1722     }
1723 }