common.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_COMMON_H_
#define SACN_COMMON_H_
 
#include <stdbool.h>
#include <stdint.h>
#include "etcpal/error.h"
#include "etcpal/inet.h"
#include "etcpal/log.h"
#include "etcpal/socket.h"
#include "etcpal/uuid.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef uint16_t sacn_remote_source_t;
static const sacn_remote_source_t kSacnRemoteSourceInvalid = 0xFFFF;
 
enum
{
  kSacnSourceNameMaxLen = 64,
  kSacnDmxAddressCount = 512,
  kSacnStartcodeDmx = 0x00u,
  kSacnStartcodePriority = 0xddu,
  kSacnMinimumUniverse = 1,
  kSacnMaximumUniverse = 63999
};
 
typedef enum
{
  kSacnIpV4Only,
  kSacnIpV6Only,
  kSacnIpV4AndIpV6
} sacn_ip_support_t;
 
typedef struct SacnMcastInterface
{
  EtcPalMcastNetintId iface;
 
  etcpal_error_t status;
} SacnMcastInterface;
 
typedef struct SacnSendSocketConfig
{
  int               unicast_sndtimeo_ms;   
  int               multicast_sndtimeo_ms; 
  sacn_ip_support_t unicast_ip_support;    
} SacnSendSocketConfig;
 
typedef struct SacnNetintConfig
{
  SacnMcastInterface* netints;
  size_t num_netints;
  bool no_netints;
  SacnSendSocketConfig send_socket_config;
} SacnNetintConfig;
 
typedef struct SacnSocketErrorInfo
{
  etcpal_error_t error;
  etcpal_socket_t socket;
  const void* message;
  size_t length;
  int flags;
  const EtcPalSockAddr* dest_addr;
} SacnSocketErrorInfo;
 
typedef void (*SacnUnicastSendErrorCallback)(const SacnSocketErrorInfo* err_info, void* context);
 
typedef void (*SacnMulticastSendErrorCallback)(const SacnSocketErrorInfo* err_info, void* context);
 
typedef struct SacnCommonCallbacks
{
  SacnUnicastSendErrorCallback   unicast_send_error;   
  SacnMulticastSendErrorCallback multicast_send_error; 
  void*                          context; 
} SacnCommonCallbacks;
 
#define SACN_SEND_SOCKET_CONFIG_DEFAULT_VALUES 0, 0, kSacnIpV4AndIpV6
 
#define SACN_SEND_SOCKET_CONFIG_DEFAULT_INIT {SACN_SEND_SOCKET_CONFIG_DEFAULT_VALUES}
 
#define SACN_NETINT_CONFIG_DEFAULT_INIT {NULL, 0, false, SACN_SEND_SOCKET_CONFIG_DEFAULT_INIT}
 
typedef uint32_t sacn_features_t;
 
#define SACN_FEATURE_DMX_MERGER ((sacn_features_t)(1u << 0)) 
// NOLINTNEXTLINE(cppcoreguidelines-macro-to-enum,modernize-macro-to-enum)
#define SACN_FEATURES_ALL 0xffffffffu 
etcpal_error_t sacn_init(const EtcPalLogParams* log_params, const SacnNetintConfig* sys_netint_config);
etcpal_error_t sacn_init_with_cb(const EtcPalLogParams*     log_params,
                                 const SacnNetintConfig*    sys_netint_config,
                                 const SacnCommonCallbacks* callbacks);
etcpal_error_t sacn_init_features(const EtcPalLogParams*  log_params,
                                  const SacnNetintConfig* sys_netint_config,
                                  sacn_features_t         features);
etcpal_error_t sacn_init_features_with_cb(const EtcPalLogParams*     log_params,
                                          const SacnNetintConfig*    sys_netint_config,
                                          sacn_features_t            features,
                                          const SacnCommonCallbacks* callbacks);
void           sacn_deinit(void);
void           sacn_deinit_features(sacn_features_t features);
 
sacn_remote_source_t sacn_get_remote_source_handle(const EtcPalUuid* source_cid);
etcpal_error_t       sacn_get_remote_source_cid(sacn_remote_source_t source_handle, EtcPalUuid* source_cid);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SACN_COMMON_H_ */