baseline for v0.9.0

.gitignore

@@ -30,3 +30,5 @@
 *.exe
 *.out
 *.app
+
+build/

CMakeLists.txt

@@ -0,0 +1,59 @@
+cmake_minimum_required(VERSION 3.16)
+
+project (libflute VERSION 0.9.0)
+
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED True)
+
+set(CMAKE_CXX_FLAGS_DEBUG_INIT "-Wall -Wextra -Werror -g3")
+set(CMAKE_CXX_FLAGS_RELEASE_INIT "-Wall -O3")
+
+find_package(Boost REQUIRED)
+find_package(spdlog REQUIRED)
+find_package(PkgConfig REQUIRED)
+find_package(OpenSSL REQUIRED)
+pkg_check_modules(TINYXML REQUIRED IMPORTED_TARGET tinyxml2)
+
+add_subdirectory(examples)
+
+include_directories(
+    "${PROJECT_BINARY_DIR}"
+    ${PROJECT_SOURCE_DIR}/src
+
+    SYSTEM
+    ${PROJECT_SOURCE_DIR}/utils
+    ${SPDLOG_INCLUDEDIR}
+    PkgConfig::TINYXML
+    )
+
+configure_file("include/Version.h.in" "Version.h")
+
+link_directories(
+    )
+
+set(CMAKE_CXX_CLANG_TIDY clang-tidy --format-style=google --checks=clang-diagnostic-*,clang-analyzer-*,-*,bugprone*,modernize*,performance*,-modernize-use-trailing-return-type,-modernize-avoid-c-arrays,-modernize-avoid-bind)
+
+add_library(flute "")
+target_sources(flute
+  PRIVATE
+    src/Receiver.cpp src/Transmitter.cpp src/Transmitter.h src/Receiver.h src/AlcPacket.cpp src/File.cpp src/EncodingSymbol.cpp src/FileDeliveryTable.cpp
+    utils/base64.cpp
+  PUBLIC
+    src/Receiver.h src/File.h 
+  )
+target_include_directories(flute
+  PUBLIC
+    ${CMAKE_CURRENT_LIST_DIR}/src/
+  )
+
+#add_library(flute src/Receiver.cpp src/Receiver.h src/AlcPacket.cpp src/File.cpp src/EncodingSymbol.cpp src/FileDeliveryTable.cpp)
+
+target_link_libraries( flute
+    LINK_PUBLIC
+    spdlog::spdlog
+    z
+    pthread
+    crypto
+    PkgConfig::TINYXML
+)
+

examples/CMakeLists.txt

@@ -0,0 +1,34 @@
+cmake_minimum_required(VERSION 3.16)
+
+include(FindPkgConfig)
+
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED True)
+
+set(CMAKE_CXX_FLAGS_DEBUG_INIT "-Wall -Wextra -Werror -g3")
+set(CMAKE_CXX_FLAGS_RELEASE_INIT "-Wall -O3")
+
+find_package(Boost REQUIRED)
+find_package(spdlog REQUIRED)
+find_package(PkgConfig REQUIRED)
+
+include_directories(
+    "${PROJECT_BINARY_DIR}"
+    ${PROJECT_SOURCE_DIR}/include
+    ${PROJECT_SOURCE_DIR}/src
+
+    SYSTEM
+    ${SPDLOG_INCLUDEDIR}
+    )
+
+set(CMAKE_CXX_CLANG_TIDY clang-tidy --format-style=google --checks=clang-diagnostic-*,clang-analyzer-*,-*,bugprone*,modernize*,performance*)
+
+add_executable(flute-transmitter flute-transmitter.cpp)
+
+target_link_libraries( flute-transmitter
+    LINK_PUBLIC
+    spdlog::spdlog
+    config++
+    flute
+    pthread
+)

examples/flute-transmitter.cpp

@@ -0,0 +1,177 @@
+
+#include <cstdio>
+#include <iostream>
+#include <argp.h>
+
+#include <cstdlib>
+
+#include <fstream>
+#include <string>
+#include <filesystem>
+#include <libconfig.h++>
+#include <boost/asio.hpp>
+
+#include "spdlog/async.h"
+#include "spdlog/spdlog.h"
+#include "spdlog/sinks/syslog_sink.h"
+
+#include "Transmitter.h"
+
+
+using libconfig::Config;
+using libconfig::FileIOException;
+using libconfig::ParseException;
+
+using std::placeholders::_1;
+using std::placeholders::_2;
+using std::placeholders::_3;
+
+static void print_version(FILE *stream, struct argp_state *state);
+void (*argp_program_version_hook)(FILE *, struct argp_state *) = print_version;
+const char *argp_program_bug_address = "Austrian Broadcasting Services <[email protected]>";
+static char doc[] = "FLUTE/ALC transmitter demo";  // NOLINT
+
+static struct argp_option options[] = {  // NOLINT
+    {"target", 'm', "IP", 0, "Target multicast address (default: 238.1.1.95)", 0},
+    {"port", 'p', "IP", 0, "Target port (default: 40085)", 0},
+    {"mtu", 't', "IP", 0, "Path MTU to size ALC packets for (default: 1500)", 0},
+    {"log-level", 'l', "LEVEL", 0,
+     "Log verbosity: 0 = trace, 1 = debug, 2 = info, 3 = warn, 4 = error, 5 = "
+     "critical, 6 = none. Default: 2.",
+     0},
+    {nullptr, 0, nullptr, 0, nullptr, 0}};
+
+/**
+ * Holds all options passed on the command line
+ */
+struct ft_arguments {
+  const char *mcast_target = {};
+  unsigned short mcast_port = 40085;
+  unsigned short mtu = 1500;
+  unsigned log_level = 2;        /**< log level */
+  char **files;
+};
+
+/**
+ * Parses the command line options into the arguments struct.
+ */
+static auto parse_opt(int key, char *arg, struct argp_state *state) -> error_t {
+  auto arguments = static_cast<struct ft_arguments *>(state->input);
+  switch (key) {
+    case 'c':
+      arguments->mcast_target = arg;
+      break;
+    case 'p':
+      arguments->mcast_port = static_cast<unsigned short>(strtoul(arg, nullptr, 10));
+      break;
+    case 't':
+      arguments->mtu = static_cast<unsigned short>(strtoul(arg, nullptr, 10));
+      break;
+    case 'l':
+      arguments->log_level = static_cast<unsigned>(strtoul(arg, nullptr, 10));
+      break;
+    case ARGP_KEY_NO_ARGS:
+      argp_usage (state);
+    case ARGP_KEY_ARG:
+      arguments->files = &state->argv[state->next-1];
+      state->next = state->argc;
+      break;
+    default:
+      return ARGP_ERR_UNKNOWN;
+  }
+  return 0;
+}
+
+static char args_doc[] = "[FILE...]";
+static struct argp argp = {options, parse_opt, args_doc, doc,
+                           nullptr, nullptr,   nullptr};
+
+/**
+ * Print the program version in MAJOR.MINOR.PATCH format.
+ */
+void print_version(FILE *stream, struct argp_state * /*state*/) {
+  fprintf(stream, "1.0.0\n");
+}
+
+
+
+/**
+ *  Main entry point for the program.
+ *  
+ * @param argc  Command line agument count
+ * @param argv  Command line arguments
+ * @return 0 on clean exit, -1 on failure
+ */
+auto main(int argc, char **argv) -> int {
+  struct ft_arguments arguments;
+  /* Default values */
+  arguments.mcast_target = "238.1.1.95";
+
+  argp_parse(&argp, argc, argv, 0, nullptr, &arguments);
+
+  // Set up logging
+  std::string ident = "flute-transmitter";
+  auto syslog_logger = spdlog::syslog_logger_mt("syslog", ident, LOG_PID | LOG_PERROR | LOG_CONS );
+
+  spdlog::set_level(
+      static_cast<spdlog::level::level_enum>(arguments.log_level));
+  spdlog::set_pattern("[%H:%M:%S.%f %z] [%^%l%$] [thr %t] %v");
+
+  spdlog::set_default_logger(syslog_logger);
+  spdlog::info("FLTUE transmitter demo starting up");
+
+
+  struct FsFile {
+    std::string location;
+    char* buffer;
+    size_t len;
+    uint32_t toi;
+  };
+  std::vector<FsFile> files;
+
+  // read the file contents into buffers
+  for (int j = 0; arguments.files[j]; j++) {
+    std::string location = arguments.files[j];
+    std::ifstream file(arguments.files[j], std::ios::binary | std::ios::ate);
+    std::streamsize size = file.tellg();
+    file.seekg(0, std::ios::beg);
+
+    char* buffer = (char*)malloc(size);
+    file.read(buffer, size);
+    files.push_back(FsFile{ arguments.files[j], buffer, (size_t)size});
+  }
+
+  boost::asio::io_service io;
+  LibFlute::Transmitter transmitter(
+      arguments.mcast_target,
+      arguments.mcast_port,
+      0,
+      arguments.mtu,
+      io);
+
+  transmitter.register_completion_callback(
+      [&files](uint32_t toi) {
+        for (auto& file : files) {
+          if (file.toi == toi) { 
+            spdlog::info("{} (TOI {}) has been transmitted",
+              file.location, file.toi);
+          }
+        }
+      });
+
+  for (auto& file : files) {
+    file.toi = transmitter.send( file.location,
+        "application/octet-stream",
+        transmitter.seconds_since_epoch() + 60, // 1 minute from now
+        file.buffer,
+        file.len
+        );
+    spdlog::info("Queued {} ({} bytes) for transmission, TOI is {}",
+        file.location, file.len, file.toi);
+  }
+
+  io.run();
+
+exit:
+  return 0;
+}

include/Version.h.in

@@ -0,0 +1,3 @@
+#define VERSION_MAJOR @gw_VERSION_MAJOR@
+#define VERSION_MINOR @gw_VERSION_MINOR@
+#define VERSION_PATCH @gw_VERSION_PATCH@