source.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_SOURCE_H_
#define SACN_SOURCE_H_
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include "etcpal/error.h"
#include "etcpal/inet.h"
#include "etcpal/uuid.h"
#include "sacn/common.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef int sacn_source_t;
static const sacn_source_t kSacnSourceInvalid = -1;
 
enum
{
  kSacnSourceInfiniteUniverses = 0,
  kSacnSourceKeepAliveIntervalDefault = 800,
  kSacnSourcePapKeepAliveIntervalDefault = 1000
};
 
typedef enum
{
  kSacnSourceTickModeProcessLevelsOnly,
  kSacnSourceTickModeProcessPapOnly,
  kSacnSourceTickModeProcessLevelsAndPap
} sacn_source_tick_mode_t;
 
typedef struct SacnSourceConfig
{
  /********* Required values **********/
 
  EtcPalUuid cid;
  const char* name;
 
  /********* Optional values **********/
 
  size_t universe_count_max;
 
  bool manually_process_source;
 
  sacn_ip_support_t ip_supported;
 
  int keep_alive_interval;
 
  int pap_keep_alive_interval;
} SacnSourceConfig;
 
#define SACN_SOURCE_CONFIG_DEFAULT_INIT \
  {kEtcPalNullUuid,                     \
   NULL,                                \
   kSacnSourceInfiniteUniverses,        \
   false,                               \
   kSacnIpV4AndIpV6,                    \
   kSacnSourceKeepAliveIntervalDefault, \
   kSacnSourcePapKeepAliveIntervalDefault}
 
void sacn_source_config_init(SacnSourceConfig* config);
 
typedef struct SacnSourceUniverseConfig
{
  /********* Required values **********/
 
  uint16_t universe;
 
  /********* Optional values **********/
 
  uint8_t priority;
 
  bool send_preview;
 
  bool send_unicast_only;
 
  const EtcPalIpAddr* unicast_destinations;
  size_t num_unicast_destinations;
 
  uint16_t sync_universe;
 
} SacnSourceUniverseConfig;
 
#define SACN_SOURCE_UNIVERSE_CONFIG_DEFAULT_INIT {0, 100, false, false, NULL, 0, 0}
 
void sacn_source_universe_config_init(SacnSourceUniverseConfig* config);
 
typedef struct SacnSourceUniverseNetintList
{
  sacn_source_t handle;
  uint16_t universe;
 
  SacnMcastInterface* netints;
  size_t num_netints;
  bool no_netints;
} SacnSourceUniverseNetintList;
 
etcpal_error_t sacn_source_create(const SacnSourceConfig* config, sacn_source_t* handle);
void           sacn_source_destroy(sacn_source_t handle);
 
etcpal_error_t sacn_source_change_name(sacn_source_t handle, const char* new_name);
 
etcpal_error_t sacn_source_add_universe(sacn_source_t                   handle,
                                        const SacnSourceUniverseConfig* config,
                                        const SacnNetintConfig*         netint_config);
void           sacn_source_remove_universe(sacn_source_t handle, uint16_t universe);
size_t         sacn_source_get_universes(sacn_source_t handle, uint16_t* universes, size_t universes_size);
 
etcpal_error_t sacn_source_add_unicast_destination(sacn_source_t handle, uint16_t universe, const EtcPalIpAddr* dest);
void   sacn_source_remove_unicast_destination(sacn_source_t handle, uint16_t universe, const EtcPalIpAddr* dest);
size_t sacn_source_get_unicast_destinations(sacn_source_t handle,
                                            uint16_t      universe,
                                            EtcPalIpAddr* destinations,
                                            size_t        destinations_size);
 
etcpal_error_t sacn_source_change_priority(sacn_source_t handle, uint16_t universe, uint8_t new_priority);
etcpal_error_t sacn_source_change_preview_flag(sacn_source_t handle, uint16_t universe, bool new_preview_flag);
etcpal_error_t sacn_source_change_synchronization_universe(sacn_source_t handle,
                                                           uint16_t      universe,
                                                           uint16_t      new_sync_universe);
 
etcpal_error_t sacn_source_send_now(sacn_source_t  handle,
                                    uint16_t       universe,
                                    uint8_t        start_code,
                                    const uint8_t* buffer,
                                    size_t         buflen);
etcpal_error_t sacn_source_send_synchronization(sacn_source_t handle, uint16_t universe);
 
void sacn_source_update_levels(sacn_source_t  handle,
                               uint16_t       universe,
                               const uint8_t* new_levels,
                               size_t         new_levels_size);
void sacn_source_update_levels_and_pap(sacn_source_t  handle,
                                       uint16_t       universe,
                                       const uint8_t* new_levels,
                                       size_t         new_levels_size,
                                       const uint8_t* new_priorities,
                                       size_t         new_priorities_size);
void sacn_source_update_levels_and_force_sync(sacn_source_t  handle,
                                              uint16_t       universe,
                                              const uint8_t* new_levels,
                                              size_t         new_levels_size);
void sacn_source_update_levels_and_pap_and_force_sync(sacn_source_t  handle,
                                                      uint16_t       universe,
                                                      const uint8_t* new_levels,
                                                      size_t         new_levels_size,
                                                      const uint8_t* new_priorities,
                                                      size_t         new_priorities_size);
 
int sacn_source_process_manual(sacn_source_tick_mode_t tick_mode);
 
etcpal_error_t sacn_source_reset_networking(const SacnNetintConfig* sys_netint_config);
etcpal_error_t sacn_source_reset_networking_per_universe(const SacnNetintConfig*             sys_netint_config,
                                                         const SacnSourceUniverseNetintList* per_universe_netint_lists,
                                                         size_t num_per_universe_netint_lists);
 
size_t sacn_source_get_network_interfaces(sacn_source_t        handle,
                                          uint16_t             universe,
                                          EtcPalMcastNetintId* netints,
                                          size_t               netints_size);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SACN_SOURCE_H_ */