common.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright 2022 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/uuid.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define SACN_SOURCE_NAME_MAX_LEN 64
 
#define DMX_ADDRESS_COUNT 512
 
typedef uint16_t sacn_remote_source_t;
#define SACN_REMOTE_SOURCE_INVALID ((sacn_remote_source_t)-1)
 
#define SACN_STARTCODE_DMX 0x00u
#define SACN_STARTCODE_PRIORITY 0xddu
 
typedef enum
{
  kSacnIpV4Only,
  kSacnIpV6Only,
  kSacnIpV4AndIpV6
} sacn_ip_support_t;
 
typedef struct SacnMcastInterface
{
  EtcPalMcastNetintId iface;
 
  etcpal_error_t status;
} SacnMcastInterface;
 
typedef struct SacnNetintConfig
{
  SacnMcastInterface* netints;
  size_t num_netints;
} SacnNetintConfig;
 
etcpal_error_t sacn_init(const EtcPalLogParams* log_params, const SacnNetintConfig* sys_netint_config);
void sacn_deinit(void);
 
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_ */