EncodingSymbol.h

Go to the documentation of this file.

// libflute - FLUTE/ALC library
//
// Copyright (C) 2021 Klaus Kühnhammer (Österreichische Rundfunksender GmbH & Co KG)
//
// Licensed under the License terms and conditions for use, reproduction, and
// distribution of 5G-MAG software (the “License”).  You may not use this file
// except in compliance with the License.  You may obtain a copy of the License at
// https://www.5g-mag.com/reference-tools.  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.
//
#pragma once
#include <stddef.h>
#include <stdint.h>
#include <vector>
#include "flute_types.h"
 
namespace LibFlute {
  class EncodingSymbol {
    public:
      static std::vector<EncodingSymbol> from_payload(char* encoded_data, size_t data_len, const FecOti& fec_oti, ContentEncoding encoding);
 
      static size_t to_payload(const std::vector<EncodingSymbol>&, char* encoded_data, size_t data_len, const FecOti& fec_oti, ContentEncoding encoding);
 
      EncodingSymbol(uint32_t id, uint32_t source_block_number, char* encoded_data, size_t data_len, FecScheme fec_scheme)
        : _id(id)
        , _source_block_number(source_block_number)
        , _fec_scheme(fec_scheme)
        , _encoded_data(encoded_data)
        , _data_len(data_len)
      {};
 
      virtual ~EncodingSymbol() {};
 
      uint32_t id() const { return _id; };
 
      uint32_t source_block_number() const { return _source_block_number; };
 
      void decode_to(char* buffer, size_t max_length) const;
 
      size_t encode_to(char* buffer, size_t max_length) const;
 
      size_t len() const { return _data_len; };
 
    private:
      uint32_t _id = 0;
      uint32_t _source_block_number = 0;
      FecScheme _fec_scheme;
      char* _encoded_data;
      size_t _data_len;
  };
};