opts.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright 2024 ETC Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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.
 ******************************************************************************
 * This file is a part of sACN. For more information, go to:
 * https://github.com/ETCLabs/sACN
 *****************************************************************************/
 
#ifndef SACN_PRIVATE_OPTS_H_
#define SACN_PRIVATE_OPTS_H_
 
#if SACN_HAVE_CONFIG_H
/* User configuration options. Any non-defined ones will get their defaults in this file. */
#include "sacn_config.h"
#endif
 
#include "etcpal/thread.h"
 
/* Some option hints based on well-known compile definitions */
 
/* Are we being compiled for a full-featured OS? */
#if defined(_WIN32) || defined(__APPLE__) || defined(__linux__) || defined(__unix__) || defined(_POSIX_VERSION)
#define SACN_FULL_OS_AVAILABLE_HINT 1
#else
#define SACN_FULL_OS_AVAILABLE_HINT 0
#endif
 
/*************************** sACN Global Options *****************************/
 
#ifndef SACN_DYNAMIC_MEM
#define SACN_DYNAMIC_MEM SACN_FULL_OS_AVAILABLE_HINT
#endif
 
#ifndef SACN_LOGGING_ENABLED
#define SACN_LOGGING_ENABLED 1
#endif
 
#ifndef SACN_LOG_MSG_PREFIX
#define SACN_LOG_MSG_PREFIX "sACN: "
#endif
 
/* Assertion failure handler */
bool sacn_assert_verify_fail(const char* exp, const char* file, const char* func, const int line);
 
#ifndef SACN_ASSERT_VERIFY
#define SACN_ASSERT_VERIFY(exp) ((exp) ? true : sacn_assert_verify_fail(#exp, __FILE__, __func__, __LINE__))
#endif
 
#ifndef SACN_ASSERT
#include <assert.h>
#define SACN_ASSERT(expr) assert(expr)
#endif
 
#ifndef SACN_ETC_PRIORITY_EXTENSION
#define SACN_ETC_PRIORITY_EXTENSION 1
#endif
 
#ifndef SACN_LOOPBACK
#define SACN_LOOPBACK 1
#endif
 
#ifndef SACN_MAX_NETINTS
#define SACN_MAX_NETINTS 2
#endif
 
/*************************** sACN Receive Options ****************************/
 
#ifndef SACN_RECEIVER_THREAD_PRIORITY
#define SACN_RECEIVER_THREAD_PRIORITY ETCPAL_THREAD_DEFAULT_PRIORITY
#endif
 
#ifndef SACN_RECEIVER_THREAD_STACK
#define SACN_RECEIVER_THREAD_STACK ETCPAL_THREAD_DEFAULT_STACK
#endif
 
#ifndef SACN_RECEIVER_THREAD_NAME
#define SACN_RECEIVER_THREAD_NAME "sACN Receive Thread"
#endif
 
/* Infinite read blocks are not supported due to the potential for hangs on shutdown. */
#if defined(SACN_RECEIVER_READ_TIMEOUT_MS) && SACN_RECEIVER_READ_TIMEOUT_MS < 0
#undef SACN_RECEIVER_READ_TIMEOUT_MS /* It will get the default value below */
#endif
 
#ifndef SACN_RECEIVER_READ_TIMEOUT_MS
#define SACN_RECEIVER_READ_TIMEOUT_MS 100
#endif
 
#ifndef SACN_RECEIVER_MAX_UNIVERSES
#define SACN_RECEIVER_MAX_UNIVERSES 1
#endif
 
#ifndef SACN_RECEIVER_MAX_SOURCES_PER_UNIVERSE
#define SACN_RECEIVER_MAX_SOURCES_PER_UNIVERSE 4
#endif
 
#ifndef SACN_RECEIVER_TOTAL_MAX_SOURCES
#define SACN_RECEIVER_TOTAL_MAX_SOURCES (SACN_RECEIVER_MAX_UNIVERSES * SACN_RECEIVER_MAX_SOURCES_PER_UNIVERSE)
#endif
 
#ifndef SACN_RECEIVER_LIMIT_BIND
#define SACN_RECEIVER_LIMIT_BIND (!_WIN32 && !__APPLE__)
#endif
 
#ifdef SACN_RECEIVER_SOCKET_PER_NIC
#if !SACN_RECEIVER_SOCKET_PER_NIC && _WIN32
#error "Error: SACN_RECEIVER_SOCKET_PER_NIC was set to 0 on Windows, which is not supported due to performance issues."
#endif
#else
#define SACN_RECEIVER_SOCKET_PER_NIC (_WIN32)
#endif
 
#ifndef SACN_RECEIVER_MAX_SUBS_PER_SOCKET
#define SACN_RECEIVER_MAX_SUBS_PER_SOCKET 20
#endif
 
/* TODO investigate. Windows value was 110592 */
#ifndef SACN_RECEIVER_SOCKET_RCVBUF_SIZE
#define SACN_RECEIVER_SOCKET_RCVBUF_SIZE 32768
#endif
#ifndef SACN_RECEIVER_ENABLE_SO_REUSEPORT
#define SACN_RECEIVER_ENABLE_SO_REUSEPORT 1
#endif
 
#ifndef SACN_RECEIVER_ENABLE_SO_RCVBUF
#define SACN_RECEIVER_ENABLE_SO_RCVBUF 1
#endif
 
#undef SACN_RECEIVER_MAX_THREADS
#define SACN_RECEIVER_MAX_THREADS 1
 
#undef SACN_RECEIVER_MAX_FOOTPRINT
#define SACN_RECEIVER_MAX_FOOTPRINT 512
 
/***************************** sACN Send Options *****************************/
 
#ifndef SACN_SOURCE_THREAD_PRIORITY
#define SACN_SOURCE_THREAD_PRIORITY ETCPAL_THREAD_DEFAULT_PRIORITY
#endif
 
#ifndef SACN_SOURCE_THREAD_STACK
#define SACN_SOURCE_THREAD_STACK ETCPAL_THREAD_DEFAULT_STACK
#endif
 
#ifndef SACN_SOURCE_THREAD_NAME
#define SACN_SOURCE_THREAD_NAME "sACN Source Thread"
#endif
 
/* TODO investigate. Windows value was 20 */
#ifndef SACN_SOURCE_MULTICAST_TTL
#define SACN_SOURCE_MULTICAST_TTL 64
#endif
#ifndef SACN_SOURCE_SOCKET_SNDBUF_SIZE
#define SACN_SOURCE_SOCKET_SNDBUF_SIZE 115000
#endif
 
#ifndef SACN_SOURCE_MAX_SOURCES
#define SACN_SOURCE_MAX_SOURCES 1
#endif
 
#ifndef SACN_SOURCE_MAX_UNIVERSES_PER_SOURCE
#define SACN_SOURCE_MAX_UNIVERSES_PER_SOURCE 4
#endif
 
#ifndef SACN_MAX_UNICAST_DESTINATIONS_PER_UNIVERSE
#define SACN_MAX_UNICAST_DESTINATIONS_PER_UNIVERSE 4
#endif
 
/***************************** sACN DMX Merger Options *****************************/
 
#ifdef SACN_DMX_MERGER_MAX_MERGERS
#define SACN_DMX_MERGER_DEFAULT_MAX_MERGERS 0
#else
#define SACN_DMX_MERGER_MAX_MERGERS SACN_RECEIVER_MAX_UNIVERSES
#define SACN_DMX_MERGER_DEFAULT_MAX_MERGERS 1
#endif
 
#ifndef SACN_DMX_MERGER_MAX_SOURCES_PER_MERGER
#define SACN_DMX_MERGER_MAX_SOURCES_PER_MERGER SACN_RECEIVER_MAX_SOURCES_PER_UNIVERSE
#endif
 
#undef SACN_DMX_MERGER_MAX_SLOTS
#define SACN_DMX_MERGER_MAX_SLOTS 512
 
#ifndef SACN_DMX_MERGER_DISABLE_INTERNAL_PAP_BUFFER
#define SACN_DMX_MERGER_DISABLE_INTERNAL_PAP_BUFFER 0
#endif
 
#ifndef SACN_DMX_MERGER_DISABLE_INTERNAL_OWNER_BUFFER
#define SACN_DMX_MERGER_DISABLE_INTERNAL_OWNER_BUFFER 0
#endif
 
/***************************** sACN Merge Receiver Options *****************************/
 
#ifndef SACN_MERGE_RECEIVER_ENABLE_IN_STATIC_MEMORY_MODE
#define SACN_MERGE_RECEIVER_ENABLE_IN_STATIC_MEMORY_MODE                                \
  ((SACN_RECEIVER_MAX_UNIVERSES > 0) && (SACN_RECEIVER_MAX_SOURCES_PER_UNIVERSE > 0) && \
   (SACN_RECEIVER_TOTAL_MAX_SOURCES > 0) && (SACN_DMX_MERGER_MAX_MERGERS > 0) &&        \
   (SACN_DMX_MERGER_MAX_SOURCES_PER_MERGER > 0))
#endif
 
#if !SACN_DYNAMIC_MEM && SACN_MERGE_RECEIVER_ENABLE_IN_STATIC_MEMORY_MODE &&                \
    ((SACN_RECEIVER_MAX_UNIVERSES <= 0) || (SACN_RECEIVER_MAX_SOURCES_PER_UNIVERSE <= 0) || \
     (SACN_RECEIVER_TOTAL_MAX_SOURCES <= 0))
#error "Error: SACN_MERGE_RECEIVER_ENABLE_IN_STATIC_MEMORY_MODE was set to 1, but the sACN Receiver API is disabled!"
#endif
 
#if !SACN_DYNAMIC_MEM && SACN_MERGE_RECEIVER_ENABLE_IN_STATIC_MEMORY_MODE && \
    ((SACN_DMX_MERGER_MAX_MERGERS <= 0) || (SACN_DMX_MERGER_MAX_SOURCES_PER_MERGER <= 0))
#error "Error: SACN_MERGE_RECEIVER_ENABLE_IN_STATIC_MEMORY_MODE was set to 1, but the sACN DMX Merger API is disabled!"
#endif
 
#ifndef SACN_MERGE_RECEIVER_ENABLE_SAMPLING_MERGER
#define SACN_MERGE_RECEIVER_ENABLE_SAMPLING_MERGER 1
#endif
 
#if SACN_MERGE_RECEIVER_ENABLE_SAMPLING_MERGER && SACN_DMX_MERGER_DEFAULT_MAX_MERGERS
#undef SACN_DMX_MERGER_MAX_MERGERS
#define SACN_DMX_MERGER_MAX_MERGERS (SACN_RECEIVER_MAX_UNIVERSES * 2)
#endif
 
/***************************** sACN Source Detector Options *****************************/
 
#ifndef SACN_SOURCE_DETECTOR_MAX_SOURCES
#define SACN_SOURCE_DETECTOR_MAX_SOURCES 5
#endif
 
#ifndef SACN_SOURCE_DETECTOR_MAX_UNIVERSES_PER_SOURCE
#define SACN_SOURCE_DETECTOR_MAX_UNIVERSES_PER_SOURCE 5
#endif
 
#endif /* SACN_PRIVATE_OPTS_H_ */