audiosettings.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2013 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1

 
#ifndef SWIFT_MISC_AUDIO_SETTINGS_H
#define SWIFT_MISC_AUDIO_SETTINGS_H
 
#include <QMetaType>
#include <QString>
 
#include "misc/audio/notificationsounds.h"
#include "misc/metaclass.h"
#include "misc/settingscache.h"
#include "misc/statusmessage.h"
#include "misc/swiftmiscexport.h"
#include "misc/valueobject.h"
 
SWIFT_DECLARE_VALUEOBJECT_MIXINS(swift::misc::audio, CSettings)
 
namespace swift::misc::audio
{
    class SWIFT_MISC_EXPORT CSettings : public CValueObject<CSettings>
    {
    public:
        static constexpr int InMax = 100;
        static constexpr int InMin = 0;
        static constexpr int OutMax = 100;
        static constexpr int OutMin = 0;

        static int fixOutVolume(int v);
        static int fixInVolume(int v);

        CSettings() = default;

        bool isNotificationFlagSet(CNotificationSounds::NotificationFlag notification) const;

        void setNotificationFlag(CNotificationSounds::NotificationFlag notification, bool value);

        CNotificationSounds::Notification getNotification() const
        {
            return static_cast<CNotificationSounds::Notification>(m_notification);
        }

        void setNotification(CNotificationSounds::Notification notification)
        {
            m_notification = static_cast<int>(notification);
        }

        bool textMessagePrivate() const
        {
            return this->isNotificationFlagSet(CNotificationSounds::NotificationTextMessagePrivate);
        }
        bool textMessageSupervisor() const
        {
            return this->isNotificationFlagSet(CNotificationSounds::NotificationTextMessageSupervisor);
        }
        bool textCallsignMentioned() const
        {
            return this->isNotificationFlagSet(CNotificationSounds::NotificationTextCallsignMentioned);
        }
        bool pttClickDown() const { return this->isNotificationFlagSet(CNotificationSounds::PTTClickKeyDown); }
        bool pttClickUp() const { return this->isNotificationFlagSet(CNotificationSounds::PTTClickKeyUp); }
 
        bool afvClicked() const { return this->isNotificationFlagSet(CNotificationSounds::AFVClicked); }
        bool afvBlocked() const { return this->isNotificationFlagSet(CNotificationSounds::AFVBlocked); }

        void setNotificationSoundDirectory(const QString &dir);

        const QString &getNotificationSoundDirectory() const { return m_notificationSoundDir; }

        const QString &getNotificationSoundDirectoryOrDefault() const;

        QString getNotificationFilePath(const QString &fileName) const;

        void setNotificationVolume(int volume);

        int getNotificationVolume() const { return m_notificationVolume; }

        void setOutVolume(int volume);

        int getOutVolume() const { return m_outVolume; }

        void setOutVolumeCom1(int volume);

        int getOutVolumeCom1() const { return m_outVolumeCom1; }

        void setOutVolumeCom2(int volume);

        int getOutVolumeCom2() const { return m_outVolumeCom2; }

        void setInVolume(int volume);

        int getInVolume() const { return m_inVolume; }

        bool isAudioEffectsEnabled() const { return m_audioEffects; }

        void setAudioEffectsEnabled(bool enabled) { m_audioEffects = enabled; }

        QString convertToQString(bool i18n = false) const;
 
    private:
        QString m_notificationSoundDir;
        int m_notification = static_cast<int>(
            CNotificationSounds::DefaultNotifications); 
        int m_notificationVolume = 90; 
        int m_outVolume = 40; 
        int m_outVolumeCom1 = 100; 
        int m_outVolumeCom2 = 100; 
        int m_inVolume = 50; 
        bool m_audioEffects = true; 
 
        SWIFT_METACLASS(
            CSettings,
            SWIFT_METAMEMBER(notificationSoundDir),
            SWIFT_METAMEMBER(notification),
            SWIFT_METAMEMBER(notificationVolume),
            SWIFT_METAMEMBER(outVolume),
            SWIFT_METAMEMBER(outVolumeCom1),
            SWIFT_METAMEMBER(outVolumeCom2),
            SWIFT_METAMEMBER(inVolume),
            SWIFT_METAMEMBER(audioEffects));
    };

    struct TSettings : public TSettingTrait<CSettings>
    {
        static const char *key() { return "audio/%Application%/setup"; }

        static const QString &humanReadable()
        {
            static const QString name("Audio");
            return name;
        }

        static bool isValid(const swift::misc::audio::CSettings &value, QString &)
        {
            Q_UNUSED(value)
            return true;
        }
    };
} // namespace swift::misc::audio
 
Q_DECLARE_METATYPE(swift::misc::audio::CSettings)
 
#endif // SWIFT_MISC_AUDIO_SETTINGS_H