InMemoryEqualizerConfiguration.h

Go to the documentation of this file.

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

#ifndef ACSDKEQUALIZERIMPLEMENTATIONS_INMEMORYEQUALIZERCONFIGURATION_H_
#define ACSDKEQUALIZERIMPLEMENTATIONS_INMEMORYEQUALIZERCONFIGURATION_H_

#include <memory>
#include <mutex>

#include <acsdkEqualizerInterfaces/EqualizerConfigurationInterface.h>

namespace alexaClientSDK {
namespace acsdkEqualizer {

class InMemoryEqualizerConfiguration : public acsdkEqualizerInterfaces::EqualizerConfigurationInterface {
public:
    ~InMemoryEqualizerConfiguration() override = default;

    static std::shared_ptr<InMemoryEqualizerConfiguration> create(
        int minBandLevel,
        int maxBandLevel,
        int defaultDelta,
        const std::set<acsdkEqualizerInterfaces::EqualizerBand>& bandsSupported,
        const std::set<acsdkEqualizerInterfaces::EqualizerMode>& modesSupported,
        acsdkEqualizerInterfaces::EqualizerState defaultState);

    static std::shared_ptr<InMemoryEqualizerConfiguration> createDisabled();

    static std::shared_ptr<InMemoryEqualizerConfiguration> createDefault();

    bool isEnabled() const override;

    std::set<acsdkEqualizerInterfaces::EqualizerBand> getSupportedBands() const override;

    std::set<acsdkEqualizerInterfaces::EqualizerMode> getSupportedModes() const override;

    int getMinBandLevel() const override;

    int getMaxBandLevel() const override;

    int getDefaultBandDelta() const override;

    acsdkEqualizerInterfaces::EqualizerState getDefaultState() const override;

    bool isBandSupported(acsdkEqualizerInterfaces::EqualizerBand band) const override;

    bool isModeSupported(acsdkEqualizerInterfaces::EqualizerMode mode) const override;

protected:
    InMemoryEqualizerConfiguration(
        int minBandLevel,
        int maxBandLevel,
        int defaultDelta,
        const std::set<acsdkEqualizerInterfaces::EqualizerBand>& bandsSupported,
        const std::set<acsdkEqualizerInterfaces::EqualizerMode>& modesSupported,
        acsdkEqualizerInterfaces::EqualizerState defaultState);

    InMemoryEqualizerConfiguration();

    bool validateConfiguration();

    bool validateBandLevelMap(const acsdkEqualizerInterfaces::EqualizerBandLevelMap& bandLevelMap, bool validateValues);

private:
    int m_maxBandLevel;

    int m_minBandLevel;

    int m_defaultDelta;

    std::set<acsdkEqualizerInterfaces::EqualizerBand> m_bandsSupported;

    std::set<acsdkEqualizerInterfaces::EqualizerMode> m_modesSupported;

    acsdkEqualizerInterfaces::EqualizerState m_defaultState;

    bool m_isEnabled;
};

}  // namespace acsdkEqualizer
}  // namespace alexaClientSDK

#endif  // ACSDKEQUALIZERIMPLEMENTATIONS_INMEMORYEQUALIZERCONFIGURATION_H_