ni_log.h

Go to the documentation of this file.

/*******************************************************************************
 *
 * Copyright (C) 2022 NETINT Technologies
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 ******************************************************************************/
 
/*!*****************************************************************************
 *  \file   ni_log.h
 *
 *  \brief  Logging definitions
 ******************************************************************************/
 
#pragma once
 
#include <stdarg.h>
#include <stdint.h>
 
#ifdef LIBXCODER_OBJS_BUILD
#include "../build/xcoder_auto_headers.h"
#endif
 
#ifdef _WIN32
  #ifdef XCODER_DLL
    #ifdef LIB_EXPORTS
      #define LIB_API_LOG __declspec(dllexport)
    #else
      #define LIB_API_LOG __declspec(dllimport)
    #endif
  #else
    #define LIB_API_LOG
  #endif
#elif __linux__ || __APPLE__
  #define LIB_API_LOG
#endif
 
#define NI_ERRNO_LEN 256
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum
{
    NI_LOG_INVALID = -1, // invalid selection
    NI_LOG_NONE    = 0,  // display no logging
    NI_LOG_FATAL   = 1,  // log messages immediately prior to program exit
    NI_LOG_ERROR   = 2,  // error messages
    NI_LOG_INFO    = 3,  // info and warning messages
    NI_LOG_DEBUG   = 4,  // very verbose messages about program execution
    NI_LOG_TRACE   = 5   // most verbose messages (eg. function enter/exit, NVMe
                         // transactions, read/write polling retries)
} ni_log_level_t;
 
/*!*************************************/
// libxcoder logging utility
/*!*****************************************************************************
 *  \brief  Default ni_log() callback
 *
 *  \param[in] level  log level
 *  \param[in] fmt    printf format specifier
 *  \param[in] vl     variadric args list
 *
 *  \return
 ******************************************************************************/
LIB_API_LOG void ni_log_default_callback(int level, const char* fmt,
                                         va_list vl);
 
/*!*****************************************************************************
 *  \brief  Set ni_log() callback
 *
 *  \param[in] callback
 *
 *  \return
 ******************************************************************************/
LIB_API_LOG void ni_log_set_callback(void (*log_callback)(int, const char*,
                                     va_list));
 
/*!*****************************************************************************
 *  \brief  print log message using ni_log_callback
 *
 *  \param[in] level  log level
 *  \param[in] format printf format specifier
 *  \param[in] ...    additional arguments
 *
 *  \return
 ******************************************************************************/
LIB_API_LOG void ni_log(ni_log_level_t level, const char *fmt, ...);
 
/*!*****************************************************************************
 *  \brief  Set ni_log_level
 *
 *  \param  level log level
 *
 *  \return
 ******************************************************************************/
LIB_API_LOG void ni_log_set_level(ni_log_level_t level);
 
/*!*****************************************************************************
 *  \brief Get ni_log_level
 *
 *  \return ni_log_level
 ******************************************************************************/
LIB_API_LOG ni_log_level_t ni_log_get_level(void);
 
/*!*****************************************************************************
 *  \brief Convert ffmpeg log level integer to appropriate ni_log_level_t
 *
 *  \param fflog_level integer representation of FFmpeg log level
 *
 *  \return ni_log_level
 ******************************************************************************/
LIB_API_LOG ni_log_level_t ff_to_ni_log_level(int fflog_level);
 
/*!*****************************************************************************
 *  \brief Convert terminal arg string to ni_log_level_t
 *
 *  \param log_str character pointer of log level arg in terminal
 *
 *  \return ni_log_level
 ******************************************************************************/
LIB_API_LOG ni_log_level_t arg_to_ni_log_level(const char *fflog_level);
 
/*!*****************************************************************************
 *  \brief Get time for logs with microsecond timestamps
 *
 *
 *  \return microsecond timestamp
 ******************************************************************************/
LIB_API_LOG uint64_t ni_log_get_utime();
 
/*!*****************************************************************************
 *  \brief  print log message and additional information using ni_log_callback,
 *  \param[in] p_context a pointer to ni_session_context_t if p_context != NULL
 *                       session_id/E2EID will be printed as extra information
 *  \param[in] level  log level, if log_level == NI_LOG_ERROR timastamp will be
 *                    printed as extra information
 *  \param[in] format printf format specifier
 *  \param[in] ...    additional arguments
 *
 *  \return
 ******************************************************************************/
LIB_API_LOG void ni_log2(const void *p_context, ni_log_level_t level, const char *fmt, ...);
 
/*!*****************************************************************************
 *  \brief set whether to use a lock or not in ni_log2
 *
 *  \param[in] on whether to use a lock,
 *                1-->use a lock,
 *                0-->use extra buf(no lock)
 *  \return
 ******************************************************************************/
void ni_log2_with_mutex(int on);
 
#ifdef _ANDROID
/*!******************************************************************************
 *  \brief  Set ni_log_tag
 *
 *  \param  log tag
 *
 *  \return
 *******************************************************************************/
LIB_API_LOG void ni_log_set_log_tag(const char *log_tag);
#endif
 
#ifdef __cplusplus
}
#endif