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_CPP_COMMON_H_
#define SACN_CPP_COMMON_H_
 
#include "etcpal/cpp/error.h"
#include "etcpal/cpp/log.h"
#include "etcpal/cpp/uuid.h"
#include "sacn/common.h"
 
namespace sacn
{
enum class McastMode
{
  kEnabledOnAllInterfaces,
  kDisabledOnAllInterfaces
};
 
using RemoteSourceHandle = sacn_remote_source_t;
constexpr RemoteSourceHandle kInvalidRemoteSourceHandle = kSacnRemoteSourceInvalid;
 
constexpr uint16_t kMinimumUniverse = kSacnMinimumUniverse;
constexpr uint16_t kMaximumUniverse = kSacnMaximumUniverse;
 
class NotifyHandler
{
public:
  NotifyHandler()          = default;
  virtual ~NotifyHandler() = default;
 
  NotifyHandler(const NotifyHandler& other) = default;
 
  NotifyHandler& operator=(const NotifyHandler& other) = default;
 
  NotifyHandler(NotifyHandler&& other) = default;
 
  NotifyHandler& operator=(NotifyHandler&& other) = default;
 
  virtual void HandleUnicastSendError(const SacnSocketErrorInfo& err_info) { ETCPAL_UNUSED_ARG(err_info); }
 
  virtual void HandleMulticastSendError(const SacnSocketErrorInfo& err_info) { ETCPAL_UNUSED_ARG(err_info); }
};
 
struct LibrarySettings
{
  NotifyHandler* notify_handler{nullptr};
 
  SacnSendSocketConfig send_socket_config{SACN_SEND_SOCKET_CONFIG_DEFAULT_VALUES};
 
  LibrarySettings() = default;
};
 
namespace internal
{
extern "C" inline void CommonCbUnicastSendError(const SacnSocketErrorInfo* err_info, void* context)
{
  if (err_info && context)
    static_cast<NotifyHandler*>(context)->HandleUnicastSendError(*err_info);
}
 
extern "C" inline void CommonCbMulticastSendError(const SacnSocketErrorInfo* err_info, void* context)
{
  if (err_info && context)
    static_cast<NotifyHandler*>(context)->HandleMulticastSendError(*err_info);
}
 
inline SacnCommonCallbacks GetCommonCallbacks(NotifyHandler* notify_handler)
{
  SacnCommonCallbacks callbacks = {internal::CommonCbUnicastSendError, internal::CommonCbMulticastSendError,
                                   notify_handler};
  return callbacks;
}
 
};  // namespace internal
 
inline etcpal::Error Init(sacn_features_t features = SACN_FEATURES_ALL, const LibrarySettings& settings = {})
{
  SacnNetintConfig netint_config   = SACN_NETINT_CONFIG_DEFAULT_INIT;
  netint_config.send_socket_config = settings.send_socket_config;
 
  auto callbacks = internal::GetCommonCallbacks(settings.notify_handler);
  return sacn_init_features_with_cb(nullptr, &netint_config, features, settings.notify_handler ? &callbacks : nullptr);
}
 
inline etcpal::Error Init(const EtcPalLogParams* log_params,
                          sacn_features_t        features = SACN_FEATURES_ALL,
                          const LibrarySettings& settings = {})
{
  SacnNetintConfig netint_config   = SACN_NETINT_CONFIG_DEFAULT_INIT;
  netint_config.send_socket_config = settings.send_socket_config;
 
  auto callbacks = internal::GetCommonCallbacks(settings.notify_handler);
  return sacn_init_features_with_cb(log_params, &netint_config, features,
                                    settings.notify_handler ? &callbacks : nullptr);
}
 
inline etcpal::Error Init(const EtcPalLogParams* log_params,
                          McastMode              mcast_mode,
                          sacn_features_t        features = SACN_FEATURES_ALL,
                          const LibrarySettings& settings = {})
{
  SacnNetintConfig netint_config   = SACN_NETINT_CONFIG_DEFAULT_INIT;
  netint_config.send_socket_config = settings.send_socket_config;
 
  if (mcast_mode == McastMode::kDisabledOnAllInterfaces)
    netint_config.no_netints = true;
 
  auto callbacks = internal::GetCommonCallbacks(settings.notify_handler);
  return sacn_init_features_with_cb(log_params, &netint_config, features,
                                    settings.notify_handler ? &callbacks : nullptr);
}
 
inline etcpal::Error Init(const EtcPalLogParams*           log_params,
                          std::vector<SacnMcastInterface>& sys_netints,
                          sacn_features_t                  features = SACN_FEATURES_ALL,
                          const LibrarySettings&           settings = {})
{
  SacnNetintConfig netint_config   = SACN_NETINT_CONFIG_DEFAULT_INIT;
  netint_config.netints            = sys_netints.data();
  netint_config.num_netints        = sys_netints.size();
  netint_config.send_socket_config = settings.send_socket_config;
 
  auto callbacks = internal::GetCommonCallbacks(settings.notify_handler);
  return sacn_init_features_with_cb(log_params, &netint_config, features,
                                    settings.notify_handler ? &callbacks : nullptr);
}
 
inline etcpal::Error Init(std::vector<SacnMcastInterface>& sys_netints,
                          sacn_features_t                  features = SACN_FEATURES_ALL,
                          const LibrarySettings&           settings = {})
{
  SacnNetintConfig netint_config   = SACN_NETINT_CONFIG_DEFAULT_INIT;
  netint_config.netints            = sys_netints.data();
  netint_config.num_netints        = sys_netints.size();
  netint_config.send_socket_config = settings.send_socket_config;
 
  auto callbacks = internal::GetCommonCallbacks(settings.notify_handler);
  return sacn_init_features_with_cb(nullptr, &netint_config, features, settings.notify_handler ? &callbacks : nullptr);
}
 
inline etcpal::Error Init(const etcpal::Logger&  logger,
                          McastMode              mcast_mode = McastMode::kEnabledOnAllInterfaces,
                          sacn_features_t        features   = SACN_FEATURES_ALL,
                          const LibrarySettings& settings   = {})
{
  SacnNetintConfig netint_config   = SACN_NETINT_CONFIG_DEFAULT_INIT;
  netint_config.send_socket_config = settings.send_socket_config;
 
  if (mcast_mode == McastMode::kDisabledOnAllInterfaces)
    netint_config.no_netints = true;
 
  auto callbacks = internal::GetCommonCallbacks(settings.notify_handler);
  return sacn_init_features_with_cb(&logger.log_params(), &netint_config, features,
                                    settings.notify_handler ? &callbacks : nullptr);
}
 
inline etcpal::Error Init(const etcpal::Logger& logger, sacn_features_t features, const LibrarySettings& settings = {})
{
  SacnNetintConfig netint_config   = SACN_NETINT_CONFIG_DEFAULT_INIT;
  netint_config.send_socket_config = settings.send_socket_config;
 
  auto callbacks = internal::GetCommonCallbacks(settings.notify_handler);
  return sacn_init_features_with_cb(&logger.log_params(), &netint_config, features,
                                    settings.notify_handler ? &callbacks : nullptr);
}
 
inline etcpal::Error Init(const etcpal::Logger&            logger,
                          std::vector<SacnMcastInterface>& sys_netints,
                          sacn_features_t                  features = SACN_FEATURES_ALL,
                          const LibrarySettings&           settings = {})
{
  SacnNetintConfig netint_config   = SACN_NETINT_CONFIG_DEFAULT_INIT;
  netint_config.netints            = sys_netints.data();
  netint_config.num_netints        = sys_netints.size();
  netint_config.send_socket_config = settings.send_socket_config;
 
  auto callbacks = internal::GetCommonCallbacks(settings.notify_handler);
  return sacn_init_features_with_cb(&logger.log_params(), &netint_config, features,
                                    settings.notify_handler ? &callbacks : nullptr);
}
 
inline void Deinit(sacn_features_t features = SACN_FEATURES_ALL)
{
  sacn_deinit_features(features);
}
 
inline RemoteSourceHandle GetRemoteSourceHandle(const etcpal::Uuid& source_cid)
{
  return sacn_get_remote_source_handle(&source_cid.get());
}
 
inline etcpal::Expected<etcpal::Uuid> GetRemoteSourceCid(RemoteSourceHandle source_handle)
{
  EtcPalUuid     cid;
  etcpal_error_t error         = sacn_get_remote_source_cid(source_handle, &cid);
  etcpal::Uuid   cid_to_return = cid;
 
  if (error == kEtcPalErrOk)
    return cid_to_return;
 
  return error;
}
 
};  // namespace sacn
 
#endif  // SACN_CPP_COMMON_H_