dmx_merger.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_DMX_MERGER_H_
#define SACN_DMX_MERGER_H_
 
#include <stdbool.h>
#include <stdint.h>
#include "etcpal/error.h"
#include "sacn/common.h"
#include "sacn/receiver.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef int sacn_dmx_merger_t;
 
#define SACN_DMX_MERGER_INVALID -1
 
typedef uint16_t sacn_dmx_merger_source_t;
 
#define SACN_DMX_MERGER_SOURCE_INVALID ((sacn_dmx_merger_source_t)-1)
 
typedef struct SacnDmxMergerConfig
{
  /********* Required values **********/
 
  uint8_t* levels;
 
  /********* Optional values **********/
 
  uint8_t* per_address_priorities;
 
  bool* per_address_priorities_active;
 
  uint8_t* universe_priority;
 
  sacn_dmx_merger_source_t* owners;
 
  int source_count_max;
 
} SacnDmxMergerConfig;
 
#define SACN_DMX_MERGER_CONFIG_INIT                              \
  {                                                              \
    NULL, NULL, NULL, NULL, NULL, SACN_RECEIVER_INFINITE_SOURCES \
  }
 
#define SACN_DMX_MERGER_SOURCE_IS_VALID(owners_array, slot_index) \
  (owners_array[slot_index] != SACN_DMX_MERGER_SOURCE_INVALID)
 
typedef struct SacnDmxMergerSource
{
  sacn_dmx_merger_source_t id;
 
  uint8_t levels[DMX_ADDRESS_COUNT];
 
  size_t valid_level_count;
 
  uint8_t universe_priority;
 
  uint8_t address_priority[DMX_ADDRESS_COUNT];
 
  bool using_universe_priority;
 
} SacnDmxMergerSource;
 
etcpal_error_t sacn_dmx_merger_create(const SacnDmxMergerConfig* config, sacn_dmx_merger_t* handle);
etcpal_error_t sacn_dmx_merger_destroy(sacn_dmx_merger_t handle);
 
etcpal_error_t sacn_dmx_merger_add_source(sacn_dmx_merger_t merger, sacn_dmx_merger_source_t* source_id);
etcpal_error_t sacn_dmx_merger_remove_source(sacn_dmx_merger_t merger, sacn_dmx_merger_source_t source);
const SacnDmxMergerSource* sacn_dmx_merger_get_source(sacn_dmx_merger_t merger, sacn_dmx_merger_source_t source);
 
etcpal_error_t sacn_dmx_merger_update_levels(sacn_dmx_merger_t merger, sacn_dmx_merger_source_t source,
                                             const uint8_t* new_levels, size_t new_levels_count);
etcpal_error_t sacn_dmx_merger_update_pap(sacn_dmx_merger_t merger, sacn_dmx_merger_source_t source, const uint8_t* pap,
                                          size_t pap_count);
etcpal_error_t sacn_dmx_merger_update_universe_priority(sacn_dmx_merger_t merger, sacn_dmx_merger_source_t source,
                                                        uint8_t universe_priority);
etcpal_error_t sacn_dmx_merger_remove_pap(sacn_dmx_merger_t merger, sacn_dmx_merger_source_t source);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SACN_DMX_MERGER_H_ */