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

   1 /**
   2  * Copyright (c) 2010-2021 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.pulseaudio.internal.handler;
  14
  15 import static org.openhab.binding.pulseaudio.internal.PulseaudioBindingConstants.*;
  16
  17 import java.io.IOException;
  18 import java.math.BigDecimal;
  19 import java.util.ArrayList;
  20 import java.util.Collections;
  21 import java.util.Hashtable;
  22 import java.util.List;
  23 import java.util.Map;
  24 import java.util.Set;
  25 import java.util.concurrent.ConcurrentHashMap;
  26 import java.util.concurrent.ScheduledFuture;
  27 import java.util.concurrent.TimeUnit;
  28 import java.util.stream.Collectors;
  29 import java.util.stream.Stream;
  30
  31 import org.openhab.binding.pulseaudio.internal.PulseAudioAudioSink;
  32 import org.openhab.binding.pulseaudio.internal.PulseaudioBindingConstants;
  33 import org.openhab.binding.pulseaudio.internal.items.AbstractAudioDeviceConfig;
  34 import org.openhab.binding.pulseaudio.internal.items.Sink;
  35 import org.openhab.binding.pulseaudio.internal.items.SinkInput;
  36 import org.openhab.core.audio.AudioSink;
  37 import org.openhab.core.config.core.Configuration;
  38 import org.openhab.core.library.types.DecimalType;
  39 import org.openhab.core.library.types.IncreaseDecreaseType;
  40 import org.openhab.core.library.types.OnOffType;
  41 import org.openhab.core.library.types.PercentType;
  42 import org.openhab.core.library.types.StringType;
  43 import org.openhab.core.thing.Bridge;
  44 import org.openhab.core.thing.ChannelUID;
  45 import org.openhab.core.thing.Thing;
  46 import org.openhab.core.thing.ThingStatus;
  47 import org.openhab.core.thing.ThingTypeUID;
  48 import org.openhab.core.thing.ThingUID;
  49 import org.openhab.core.thing.binding.BaseThingHandler;
  50 import org.openhab.core.thing.binding.ThingHandler;
  51 import org.openhab.core.types.Command;
  52 import org.openhab.core.types.RefreshType;
  53 import org.openhab.core.types.State;
  54 import org.openhab.core.types.UnDefType;
  55 import org.osgi.framework.BundleContext;
  56 import org.osgi.framework.ServiceRegistration;
  57 import org.slf4j.Logger;
  58 import org.slf4j.LoggerFactory;
  59
  60 /**
  61  * The {@link PulseaudioHandler} is responsible for handling commands, which are
  62  * sent to one of the channels.
  63  *
  64  * @author Tobias Bräutigam - Initial contribution
  65  */
  66 public class PulseaudioHandler extends BaseThingHandler implements DeviceStatusListener {
  67
  68     public static final Set<ThingTypeUID> SUPPORTED_THING_TYPES_UIDS = Collections
  69             .unmodifiableSet(Stream.of(SINK_THING_TYPE, COMBINED_SINK_THING_TYPE, SINK_INPUT_THING_TYPE,
  70                     SOURCE_THING_TYPE, SOURCE_OUTPUT_THING_TYPE).collect(Collectors.toSet()));
  71
  72     private int refresh = 60; // refresh every minute as default
  73     private ScheduledFuture<?> refreshJob;
  74
  75     private PulseaudioBridgeHandler bridgeHandler;
  76
  77     private final Logger logger = LoggerFactory.getLogger(PulseaudioHandler.class);
  78
  79     private String name;
  80
  81     private PulseAudioAudioSink audioSink;
  82
  83     private Integer savedVolume;
  84
  85     private Map<String, ServiceRegistration<AudioSink>> audioSinkRegistrations = new ConcurrentHashMap<>();
  86
  87     private BundleContext bundleContext;
  88
  89     public PulseaudioHandler(Thing thing, BundleContext bundleContext) {
  90         super(thing);
  91         this.bundleContext = bundleContext;
  92     }
  93
  94     @Override
  95     public void initialize() {
  96         Configuration config = getThing().getConfiguration();
  97         name = (String) config.get(DEVICE_PARAMETER_NAME);
  98
  99         // until we get an update put the Thing offline
 100         updateStatus(ThingStatus.OFFLINE);
 101         deviceOnlineWatchdog();
 102
 103         // if it's a SINK thing, then maybe we have to activate the audio sink
 104         if (PulseaudioBindingConstants.SINK_THING_TYPE.equals(thing.getThingTypeUID())) {
 105             // check the property to see if we it's enabled :
 106             Boolean sinkActivated = (Boolean) thing.getConfiguration()
 107                     .get(PulseaudioBindingConstants.DEVICE_PARAMETER_AUDIO_SINK_ACTIVATION);
 108             if (sinkActivated != null && sinkActivated) {
 109                 audioSinkSetup();
 110             }
 111         }
 112     }
 113
 114     private void audioSinkSetup() {
 115         final PulseaudioHandler thisHandler = this;
 116         scheduler.submit(new Runnable() {
 117             @Override
 118             public void run() {
 119                 // Register the sink as an audio sink in openhab
 120                 logger.trace("Registering an audio sink for pulse audio sink thing {}", thing.getUID());
 121                 PulseAudioAudioSink audioSink = new PulseAudioAudioSink(thisHandler, scheduler);
 122                 setAudioSink(audioSink);
 123                 try {
 124                     audioSink.connectIfNeeded();
 125                 } catch (IOException e) {
 126                     logger.warn("pulseaudio binding cannot connect to the module-simple-protocol-tcp on {} ({})",
 127                             getHost(), e.getMessage());
 128                 } catch (InterruptedException i) {
 129                     logger.info("Interrupted during sink audio connection: {}", i.getMessage());
 130                     return;
 131                 } finally {
 132                     audioSink.scheduleDisconnect();
 133                 }
 134                 @SuppressWarnings("unchecked")
 135                 ServiceRegistration<AudioSink> reg = (ServiceRegistration<AudioSink>) bundleContext
 136                         .registerService(AudioSink.class.getName(), audioSink, new Hashtable<>());
 137                 audioSinkRegistrations.put(thing.getUID().toString(), reg);
 138             }
 139         });
 140     }
 141
 142     @Override
 143     public void dispose() {
 144         if (refreshJob != null && !refreshJob.isCancelled()) {
 145             refreshJob.cancel(true);
 146             refreshJob = null;
 147         }
 148         updateStatus(ThingStatus.OFFLINE);
 149         bridgeHandler.unregisterDeviceStatusListener(this);
 150         bridgeHandler = null;
 151         logger.trace("Thing {} {} disposed.", getThing().getUID(), name);
 152         super.dispose();
 153
 154         if (audioSink != null) {
 155             audioSink.disconnect();
 156         }
 157
 158         // Unregister the potential pulse audio sink's audio sink
 159         ServiceRegistration<AudioSink> reg = audioSinkRegistrations.remove(getThing().getUID().toString());
 160         if (reg != null) {
 161             logger.trace("Unregistering the audio sync service for pulse audio sink thing {}", getThing().getUID());
 162             reg.unregister();
 163         }
 164     }
 165
 166     private void deviceOnlineWatchdog() {
 167         Runnable runnable = () -> {
 168             try {
 169                 PulseaudioBridgeHandler bridgeHandler = getPulseaudioBridgeHandler();
 170                 if (bridgeHandler != null) {
 171                     if (bridgeHandler.getDevice(name) == null) {
 172                         updateStatus(ThingStatus.OFFLINE);
 173                         bridgeHandler = null;
 174                     } else {
 175                         updateStatus(ThingStatus.ONLINE);
 176                     }
 177                 } else {
 178                     logger.debug("Bridge for pulseaudio device {} not found.", name);
 179                     updateStatus(ThingStatus.OFFLINE);
 180                 }
 181             } catch (Exception e) {
 182                 logger.debug("Exception occurred during execution: {}", e.getMessage(), e);
 183                 bridgeHandler = null;
 184             }
 185         };
 186
 187         refreshJob = scheduler.scheduleWithFixedDelay(runnable, 0, refresh, TimeUnit.SECONDS);
 188     }
 189
 190     private synchronized PulseaudioBridgeHandler getPulseaudioBridgeHandler() {
 191         if (this.bridgeHandler == null) {
 192             Bridge bridge = getBridge();
 193             if (bridge == null) {
 194                 logger.debug("Required bridge not defined for device {}.", name);
 195                 return null;
 196             }
 197             ThingHandler handler = bridge.getHandler();
 198             if (handler instanceof PulseaudioBridgeHandler) {
 199                 this.bridgeHandler = (PulseaudioBridgeHandler) handler;
 200                 this.bridgeHandler.registerDeviceStatusListener(this);
 201             } else {
 202                 logger.debug("No available bridge handler found for device {} bridge {} .", name, bridge.getUID());
 203                 return null;
 204             }
 205         }
 206         return this.bridgeHandler;
 207     }
 208
 209     @Override
 210     public void handleCommand(ChannelUID channelUID, Command command) {
 211         PulseaudioBridgeHandler bridge = getPulseaudioBridgeHandler();
 212         if (bridge == null) {
 213             logger.warn("pulseaudio server bridge handler not found. Cannot handle command without bridge.");
 214             return;
 215         }
 216         if (command instanceof RefreshType) {
 217             bridge.handleCommand(channelUID, command);
 218             return;
 219         }
 220
 221         AbstractAudioDeviceConfig device = bridge.getDevice(name);
 222         if (device == null) {
 223             logger.warn("device {} not found", name);
 224             updateStatus(ThingStatus.OFFLINE);
 225             bridgeHandler = null;
 226             return;
 227         } else {
 228             State updateState = UnDefType.UNDEF;
 229             if (channelUID.getId().equals(VOLUME_CHANNEL)) {
 230                 if (command instanceof IncreaseDecreaseType) {
 231                     // refresh to get the current volume level
 232                     bridge.getClient().update();
 233                     device = bridge.getDevice(name);
 234                     int oldVolume = device.getVolume();
 235                     int newVolume = oldVolume;
 236                     if (command.equals(IncreaseDecreaseType.INCREASE)) {
 237                         newVolume = Math.min(100, oldVolume + 5);
 238                     }
 239                     if (command.equals(IncreaseDecreaseType.DECREASE)) {
 240                         newVolume = Math.max(0, oldVolume - 5);
 241                     }
 242                     bridge.getClient().setVolumePercent(device, newVolume);
 243                     updateState = new PercentType(newVolume);
 244                     savedVolume = newVolume;
 245                 } else if (command instanceof PercentType) {
 246                     DecimalType volume = (DecimalType) command;
 247                     bridge.getClient().setVolumePercent(device, volume.intValue());
 248                     updateState = (PercentType) command;
 249                     savedVolume = volume.intValue();
 250                 } else if (command instanceof DecimalType) {
 251                     // set volume
 252                     DecimalType volume = (DecimalType) command;
 253                     bridge.getClient().setVolume(device, volume.intValue());
 254                     updateState = (DecimalType) command;
 255                     savedVolume = volume.intValue();
 256                 }
 257             } else if (channelUID.getId().equals(MUTE_CHANNEL)) {
 258                 if (command instanceof OnOffType) {
 259                     bridge.getClient().setMute(device, OnOffType.ON.equals(command));
 260                     updateState = (OnOffType) command;
 261                 }
 262             } else if (channelUID.getId().equals(SLAVES_CHANNEL)) {
 263                 if (device instanceof Sink && ((Sink) device).isCombinedSink()) {
 264                     if (command instanceof StringType) {
 265                         List<Sink> slaves = new ArrayList<>();
 266                         for (String slaveName : command.toString().split(",")) {
 267                             Sink slave = bridge.getClient().getSink(slaveName.trim());
 268                             if (slave != null) {
 269                                 slaves.add(slave);
 270                             }
 271                         }
 272                         if (!slaves.isEmpty()) {
 273                             bridge.getClient().setCombinedSinkSlaves(((Sink) device), slaves);
 274                         }
 275                     }
 276                 } else {
 277                     logger.error("{} is no combined sink", device);
 278                 }
 279             } else if (channelUID.getId().equals(ROUTE_TO_SINK_CHANNEL)) {
 280                 if (device instanceof SinkInput) {
 281                     Sink newSink = null;
 282                     if (command instanceof DecimalType) {
 283                         newSink = bridge.getClient().getSink(((DecimalType) command).intValue());
 284                     } else {
 285                         newSink = bridge.getClient().getSink(command.toString());
 286                     }
 287                     if (newSink != null) {
 288                         logger.debug("rerouting {} to {}", device, newSink);
 289                         bridge.getClient().moveSinkInput(((SinkInput) device), newSink);
 290                         updateState = new StringType(newSink.getPaName());
 291                     } else {
 292                         logger.error("no sink {} found", command.toString());
 293                     }
 294                 }
 295             }
 296             logger.trace("updating {} to {}", channelUID, updateState);
 297             if (!updateState.equals(UnDefType.UNDEF)) {
 298                 updateState(channelUID, updateState);
 299             }
 300         }
 301     }
 302
 303     /**
 304      * Use last checked volume for faster access
 305      *
 306      * @return
 307      */
 308     public int getLastVolume() {
 309         if (savedVolume == null) {
 310             PulseaudioBridgeHandler bridge = getPulseaudioBridgeHandler();
 311             AbstractAudioDeviceConfig device = bridge.getDevice(name);
 312             // refresh to get the current volume level
 313             bridge.getClient().update();
 314             device = bridge.getDevice(name);
 315             savedVolume = device.getVolume();
 316         }
 317         return savedVolume == null ? 50 : savedVolume;
 318     }
 319
 320     public void setVolume(int volume) {
 321         PulseaudioBridgeHandler bridge = getPulseaudioBridgeHandler();
 322         AbstractAudioDeviceConfig device = bridge.getDevice(name);
 323         bridge.getClient().setVolumePercent(device, volume);
 324         updateState(VOLUME_CHANNEL, new PercentType(volume));
 325         savedVolume = volume;
 326     }
 327
 328     @Override
 329     public void onDeviceStateChanged(ThingUID bridge, AbstractAudioDeviceConfig device) {
 330         if (device.getPaName().equals(name)) {
 331             updateStatus(ThingStatus.ONLINE);
 332             logger.debug("Updating states of {} id: {}", device, VOLUME_CHANNEL);
 333             savedVolume = device.getVolume();
 334             updateState(VOLUME_CHANNEL, new PercentType(savedVolume));
 335             updateState(MUTE_CHANNEL, device.isMuted() ? OnOffType.ON : OnOffType.OFF);
 336             updateState(STATE_CHANNEL,
 337                     device.getState() != null ? new StringType(device.getState().toString()) : new StringType("-"));
 338             if (device instanceof SinkInput) {
 339                 updateState(ROUTE_TO_SINK_CHANNEL,
 340                         ((SinkInput) device).getSink() != null
 341                                 ? new StringType(((SinkInput) device).getSink().getPaName())
 342                                 : new StringType("-"));
 343             }
 344             if (device instanceof Sink && ((Sink) device).isCombinedSink()) {
 345                 updateState(SLAVES_CHANNEL, new StringType(String.join(",", ((Sink) device).getCombinedSinkNames())));
 346             }
 347         }
 348     }
 349
 350     public String getHost() {
 351         Bridge bridge = getBridge();
 352         if (bridge != null) {
 353             return (String) bridge.getConfiguration().get(PulseaudioBindingConstants.BRIDGE_PARAMETER_HOST);
 354         } else {
 355             logger.error("A bridge must be configured for this pulseaudio thing");
 356             return "null";
 357         }
 358     }
 359
 360     /**
 361      * This method will scan the pulseaudio server to find the port on which the module/sink is listening
 362      * If no module is listening, then it will command the module to load on the pulse audio server,
 363      *
 364      * @return the port on which the pulseaudio server is listening for this sink
 365      * @throws InterruptedException when interrupted during the loading module wait
 366      */
 367     public int getSimpleTcpPort() throws InterruptedException {
 368         Integer simpleTcpPortPref = ((BigDecimal) getThing().getConfiguration()
 369                 .get(PulseaudioBindingConstants.DEVICE_PARAMETER_AUDIO_SINK_PORT)).intValue();
 370
 371         PulseaudioBridgeHandler bridgeHandler = getPulseaudioBridgeHandler();
 372         AbstractAudioDeviceConfig device = bridgeHandler.getDevice(name);
 373         return getPulseaudioBridgeHandler().getClient().loadModuleSimpleProtocolTcpIfNeeded(device, simpleTcpPortPref)
 374                 .orElse(simpleTcpPortPref);
 375     }
 376
 377     public int getIdleTimeout() {
 378         return ((BigDecimal) getThing().getConfiguration()
 379                 .get(PulseaudioBindingConstants.DEVICE_PARAMETER_AUDIO_SINK_IDLE_TIMEOUT)).intValue();
 380     }
 381
 382     @Override
 383     public void onDeviceRemoved(PulseaudioBridgeHandler bridge, AbstractAudioDeviceConfig device) {
 384         if (device.getPaName().equals(name)) {
 385             bridgeHandler.unregisterDeviceStatusListener(this);
 386             bridgeHandler = null;
 387             audioSink.disconnect();
 388             audioSink = null;
 389             updateStatus(ThingStatus.OFFLINE);
 390         }
 391     }
 392
 393     @Override
 394     public void onDeviceAdded(Bridge bridge, AbstractAudioDeviceConfig device) {
 395         logger.trace("new device discovered {} by {}", device, bridge);
 396     }
 397
 398     public void setAudioSink(PulseAudioAudioSink audioSink) {
 399         this.audioSink = audioSink;
 400     }
 401 }