o3de/Gems/AudioSystem/Code/Include/Engine/AudioLogger.h

/*
* All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
* its licensors.
*
* For complete copyright and license terms please see the LICENSE at the root of this
* distribution (the "License"). All use of this software is governed by the License,
* or, if provided, by the license below or the license accompanying this file. Do not
* remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*
*/
// Original file Copyright Crytek GMBH or its affiliates, used under license.

#pragma once

#include <AzCore/Module/Environment.h>
#include <IAudioInterfacesCommonData.h>

namespace Audio
{
    ///////////////////////////////////////////////////////////////////////////////////////////////////
    enum EAudioLogType
    {
        eALT_ASSERT,
        eALT_ERROR,
        eALT_WARNING,
        eALT_COMMENT,
        eALT_ALWAYS,
    };

    enum EAudioLoggingOptions
    {
        eALO_NONE     = 0,
        eALO_ERRORS   = AUDIO_BIT(6), // a
        eALO_WARNINGS = AUDIO_BIT(7), // b
        eALO_COMMENTS = AUDIO_BIT(8), // c
    };

    namespace Log
    {
#if defined(ENABLE_AUDIO_LOGGING)
        // Eventually will get rid of the CAudioLogger class and objects and convert
        // all audio log calls to use Audio::Log::Print.
        // Audio::Log::Print will take variadic arguments, but for now format the
        // arguments in CAudioLogger::Log and call this PrintMsg.
        inline void PrintMsg(const EAudioLogType type, const char* const message)
        {
            EAudioLoggingOptions logLevel = eALO_NONE;

            auto verbosityVar = AZ::Environment::FindVariable<int*>("AudioLogVerbosity");
            if (verbosityVar.IsConstructed())
            {
                logLevel = static_cast<EAudioLoggingOptions>(*(verbosityVar.Get()));
            }

            if (logLevel == eALO_NONE)
            {
                return;
            }

            static constexpr const char* AudioWindow = "Audio";

            switch (type)
            {
                case eALT_ASSERT:
                {
                    AZ_Assert(false, message);
                    break;
                }
                case eALT_ERROR:
                {
                    if (logLevel & eALO_ERRORS)
                    {
                        AZ_Error(AudioWindow, false, message);
                    }
                    break;
                }
                case eALT_WARNING:
                {
                    if (logLevel & eALO_WARNINGS)
                    {
                        AZ_Warning(AudioWindow, false, message);
                    }
                    break;
                }
                case eALT_COMMENT:
                {
                    if (logLevel & eALO_COMMENTS)
                    {
                        AZ_TracePrintf(AudioWindow, message);
                    }
                    break;
                }
                case eALT_ALWAYS:
                {
                    AZ_Printf(AudioWindow, message);
                    break;
                }
                default:
                {
                    break;
                }
            }
        }
#endif
    }

    ///////////////////////////////////////////////////////////////////////////////////////////////////
    // <title CAudioLogger>
    // Summary:
    //      A simple logger wrapper that uses independent verbosity
    ///////////////////////////////////////////////////////////////////////////////////////////////////
    class CAudioLogger
    {
    public:
        CAudioLogger() = default;
        ~CAudioLogger() = default;

        CAudioLogger(const CAudioLogger&) = delete;
        CAudioLogger& operator=(const CAudioLogger&) = delete;

        ///////////////////////////////////////////////////////////////////////////////////////////////
        // <title Log>
        // Summary:
        //      Log a message
        // Arguments:
        //      type        - log message type (e.g. eALT_ERROR, eALT_WARNING, eALT_COMMENT, etc)
        //      format, ... - printf-style format string and its arguments
        ///////////////////////////////////////////////////////////////////////////////////////////////
        void Log([[maybe_unused]] const EAudioLogType type, [[maybe_unused]] const char* const format, ...) const
        {
        #if defined(ENABLE_AUDIO_LOGGING)
            if (format && format[0] != '\0')
            {
                const size_t BUFFER_LEN = 1024;
                char buffer[BUFFER_LEN];

                va_list argList;
                va_start(argList, format);
                azvsnprintf(buffer, BUFFER_LEN, format, argList);
                va_end(argList);

                buffer[BUFFER_LEN - 1] = '\0';

                Audio::Log::PrintMsg(type, buffer);
            }
        #endif // ENABLE_AUDIO_LOGGING
        }
    };

} // namespace Audio