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

   1 /**
   2  * Copyright (c) 2010-2022 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;
  14
  15 import static org.openhab.binding.upnpcontrol.internal.UpnpControlBindingConstants.*;
  16
  17 import java.util.Map;
  18 import java.util.function.Function;
  19 import java.util.stream.Collectors;
  20 import java.util.stream.Stream;
  21
  22 import org.eclipse.jdt.annotation.NonNullByDefault;
  23 import org.eclipse.jdt.annotation.Nullable;
  24
  25 /**
  26  * This enum contains default openHAB channel configurations for optional channels as defined in the UPnP standard.
  27  * Vendor specific channels are not part of this.
  28  *
  29  * @author Mark Herwege - Initial contribution
  30  *
  31  */
  32 @NonNullByDefault
  33 public enum UpnpChannelName {
  34
  35     // Volume channels
  36     LF_VOLUME("LFvolume", "Left Front Volume", "Left front volume, will be left volume with stereo sound",
  37             ITEM_TYPE_VOLUME, CHANNEL_TYPE_VOLUME),
  38     RF_VOLUME("RFvolume", "Right Front Volume", "Right front volume, will be left volume with stereo sound",
  39             ITEM_TYPE_VOLUME, CHANNEL_TYPE_VOLUME),
  40     CF_VOLUME("CFvolume", "Center Front Volume", "Center front volume", ITEM_TYPE_VOLUME, CHANNEL_TYPE_VOLUME),
  41     LFE_VOLUME("LFEvolume", "Frequency Enhancement Volume", "Low frequency enhancement volume (subwoofer)",
  42             ITEM_TYPE_VOLUME, CHANNEL_TYPE_VOLUME),
  43     LS_VOLUME("LSvolume", "Left Surround Volume", "Left surround volume", ITEM_TYPE_VOLUME, CHANNEL_TYPE_VOLUME),
  44     RS_VOLUME("RSvolume", "Right Surround Volume", "Right surround volume", ITEM_TYPE_VOLUME, CHANNEL_TYPE_VOLUME),
  45     LFC_VOLUME("LFCvolume", "Left of Center Volume", "Left of center (in front) volume", ITEM_TYPE_VOLUME,
  46             CHANNEL_TYPE_VOLUME),
  47     RFC_VOLUME("RFCvolume", "Right of Center Volume", "Right of center (in front) volume", ITEM_TYPE_VOLUME,
  48             CHANNEL_TYPE_VOLUME),
  49     SD_VOLUME("SDvolume", "Surround Volume", "Surround (rear) volume", ITEM_TYPE_VOLUME, CHANNEL_TYPE_VOLUME),
  50     SL_VOLUME("SLvolume", "Side Left Volume", "Side left (left wall) volume", ITEM_TYPE_VOLUME, CHANNEL_TYPE_VOLUME),
  51     SR_VOLUME("SRvolume", "Side Right Volume", "Side right (right wall) volume", ITEM_TYPE_VOLUME, CHANNEL_TYPE_VOLUME),
  52     T_VOLUME("Tvolume", "Top Volume", "Top (overhead) volume", ITEM_TYPE_VOLUME, CHANNEL_TYPE_VOLUME),
  53     B_VOLUME("Bvolume", "Bottom Volume", "Bottom volume", ITEM_TYPE_VOLUME, CHANNEL_TYPE_VOLUME),
  54     BC_VOLUME("BCvolume", "Back Center Volume", "Back center volume", ITEM_TYPE_VOLUME, CHANNEL_TYPE_VOLUME),
  55     BL_VOLUME("BLvolume", "Back Left Volume", "Back Left Volume", ITEM_TYPE_VOLUME, CHANNEL_TYPE_VOLUME),
  56     BR_VOLUME("BRvolume", "Back Right Volume", "Back right volume", ITEM_TYPE_VOLUME, CHANNEL_TYPE_VOLUME),
  57
  58     // Mute channels
  59     LF_MUTE("LFmute", "Left Front Mute", "Left front mute, will be left mute with stereo sound", ITEM_TYPE_MUTE,
  60             CHANNEL_TYPE_MUTE),
  61     RF_MUTE("RFmute", "Right Front Mute", "Right front mute, will be left mute with stereo sound", ITEM_TYPE_MUTE,
  62             CHANNEL_TYPE_MUTE),
  63     CF_MUTE("CFmute", "Center Front Mute", "Center front mute", ITEM_TYPE_MUTE, CHANNEL_TYPE_MUTE),
  64     LFE_MUTE("LFEmute", "Frequency Enhancement Mute", "Low frequency enhancement mute (subwoofer)", ITEM_TYPE_MUTE,
  65             CHANNEL_TYPE_MUTE),
  66     LS_MUTE("LSmute", "Left Surround Mute", "Left surround mute", ITEM_TYPE_MUTE, CHANNEL_TYPE_MUTE),
  67     RS_MUTE("RSmute", "Right Surround Mute", "Right surround mute", ITEM_TYPE_MUTE, CHANNEL_TYPE_MUTE),
  68     LFC_MUTE("LFCmute", "Left of Center Mute", "Left of center (in front) mute", ITEM_TYPE_MUTE, CHANNEL_TYPE_MUTE),
  69     RFC_MUTE("RFCmute", "Right of Center Mute", "Right of center (in front) mute", ITEM_TYPE_MUTE, CHANNEL_TYPE_MUTE),
  70     SD_MUTE("SDmute", "Surround Mute", "Surround (rear) mute", ITEM_TYPE_MUTE, CHANNEL_TYPE_MUTE),
  71     SL_MUTE("SLmute", "Side Left Mute", "Side left (left wall) mute", ITEM_TYPE_MUTE, CHANNEL_TYPE_MUTE),
  72     SR_MUTE("SRmute", "Side Right Mute", "Side right (right wall) mute", ITEM_TYPE_MUTE, CHANNEL_TYPE_MUTE),
  73     T_MUTE("Tmute", "Top Mute", "Top (overhead) mute", ITEM_TYPE_MUTE, CHANNEL_TYPE_MUTE),
  74     B_MUTE("Bmute", "Bottom Mute", "Bottom mute", ITEM_TYPE_MUTE, CHANNEL_TYPE_MUTE),
  75     BC_MUTE("BCmute", "Back Center Mute", "Back center mute", ITEM_TYPE_MUTE, CHANNEL_TYPE_MUTE),
  76     BL_MUTE("BLmute", "Back Left Mute", "Back Left Mute", ITEM_TYPE_MUTE, CHANNEL_TYPE_MUTE),
  77     BR_MUTE("BRmute", "Back Right Mute", "Back right mute", ITEM_TYPE_MUTE, CHANNEL_TYPE_MUTE),
  78
  79     // Loudness channels
  80     LOUDNESS("loudness", "Loudness", "Master loudness", ITEM_TYPE_LOUDNESS, CHANNEL_TYPE_LOUDNESS),
  81     LF_LOUDNESS("LFloudness", "Left Front Loudness", "Left front loudness", ITEM_TYPE_LOUDNESS, CHANNEL_TYPE_LOUDNESS),
  82     RF_LOUDNESS("RFloudness", "Right Front Loudness", "Right front loudness", ITEM_TYPE_LOUDNESS,
  83             CHANNEL_TYPE_LOUDNESS),
  84     CF_LOUDNESS("CFloudness", "Center Front Loudness", "Center front loudness", ITEM_TYPE_LOUDNESS,
  85             CHANNEL_TYPE_LOUDNESS),
  86     LFE_LOUDNESS("LFEloudness", "Frequency Enhancement Loudness", "Low frequency enhancement loudness (subwoofer)",
  87             ITEM_TYPE_LOUDNESS, CHANNEL_TYPE_LOUDNESS),
  88     LS_LOUDNESS("LSloudness", "Left Surround Loudness", "Left surround loudness", ITEM_TYPE_LOUDNESS,
  89             CHANNEL_TYPE_LOUDNESS),
  90     RS_LOUDNESS("RSloudness", "Right Surround Loudness", "Right surround loudness", ITEM_TYPE_LOUDNESS,
  91             CHANNEL_TYPE_LOUDNESS),
  92     LFC_LOUDNESS("LFCloudness", "Left of Center Loudness", "Left of center (in front) loudness", ITEM_TYPE_LOUDNESS,
  93             CHANNEL_TYPE_LOUDNESS),
  94     RFC_LOUDNESS("RFCloudness", "Right of Center Loudness", "Right of center (in front) loudness", ITEM_TYPE_LOUDNESS,
  95             CHANNEL_TYPE_LOUDNESS),
  96     SD_LOUDNESS("SDloudness", "Surround Loudness", "Surround (rear) loudness", ITEM_TYPE_LOUDNESS,
  97             CHANNEL_TYPE_LOUDNESS),
  98     SL_LOUDNESS("SLloudness", "Side Left Loudness", "Side left (left wall) loudness", ITEM_TYPE_LOUDNESS,
  99             CHANNEL_TYPE_LOUDNESS),
 100     SR_LOUDNESS("SRloudness", "Side Right Loudness", "Side right (right wall) loudness", ITEM_TYPE_LOUDNESS,
 101             CHANNEL_TYPE_LOUDNESS),
 102     T_LOUDNESS("Tloudness", "Top Loudness", "Top (overhead) loudness", ITEM_TYPE_LOUDNESS, CHANNEL_TYPE_LOUDNESS),
 103     B_LOUDNESS("Bloudness", "Bottom Loudness", "Bottom loudness", ITEM_TYPE_LOUDNESS, CHANNEL_TYPE_LOUDNESS),
 104     BC_LOUDNESS("BCloudness", "Back Center Loudness", "Back center loudness", ITEM_TYPE_LOUDNESS,
 105             CHANNEL_TYPE_LOUDNESS),
 106     BL_LOUDNESS("BLloudness", "Back Left Loudness", "Back Left Loudness", ITEM_TYPE_LOUDNESS, CHANNEL_TYPE_LOUDNESS),
 107     BR_LOUDNESS("BRloudness", "Back Right Loudness", "Back right loudness", ITEM_TYPE_LOUDNESS, CHANNEL_TYPE_LOUDNESS);
 108
 109     private static final Map<String, UpnpChannelName> UPNP_CHANNEL_NAME_MAP = Stream.of(UpnpChannelName.values())
 110             .collect(Collectors.toMap(UpnpChannelName::getChannelId, Function.identity()));
 111
 112     private final String channelId;
 113     private final String label;
 114     private final String description;
 115     private final String itemType;
 116     private final String channelType;
 117
 118     UpnpChannelName(final String channelId, final String label, final String description, final String itemType,
 119             final String channelType) {
 120         this.channelId = channelId;
 121         this.label = label;
 122         this.description = description;
 123         this.itemType = itemType;
 124         this.channelType = channelType;
 125     }
 126
 127     /**
 128      * @return The name of the Channel
 129      */
 130     public String getChannelId() {
 131         return channelId;
 132     }
 133
 134     /**
 135      * @return The label for the Channel
 136      */
 137     public String getLabel() {
 138         return label;
 139     }
 140
 141     /**
 142      * @return The description for the Channel
 143      */
 144     public String getDescription() {
 145         return description;
 146     }
 147
 148     /**
 149      * @return The item type for the Channel
 150      */
 151     public String getItemType() {
 152         return itemType;
 153     }
 154
 155     /**
 156      * @return The channel type for the Channel
 157      */
 158     public String getChannelType() {
 159         return channelType;
 160     }
 161
 162     /**
 163      * Returns the UPnP Channel enum for the given channel id or null if there is no enum available for the given
 164      * channel.
 165      *
 166      * @param channelId Channel to find
 167      * @return The UPnP Channel enum or null if there is none.
 168      */
 169     public static @Nullable UpnpChannelName channelIdToUpnpChannelName(final String channelId) {
 170         return UPNP_CHANNEL_NAME_MAP.get(channelId);
 171     }
 172 }