compressed_codec.h

Go to the documentation of this file.

#pragma once

// SPDX-License-Identifier: BSD-3-Clause
// SPDX-FileCopyrightText: Czech Technical University in Prague

#include <memory>
#include <string>
#include <vector>

#include <dynamic_reconfigure/Config.h>
#include <sensor_msgs/CompressedImage.h>
#include <sensor_msgs/Image.h>

#include <compressed_image_transport/CompressedPublisherConfig.h>
#include <compressed_image_transport/CompressedSubscriberConfig.h>

#include <cras_cpp_common/c_api.h>
#include <cras_cpp_common/log_utils.h>
#include <cras_cpp_common/log_utils/node.h>
#include <image_transport_codecs/image_transport_codec.h>

namespace image_transport_codecs
{

class CompressedCodecPrivate;

class CompressedCodec : public image_transport_codecs::ImageTransportCodec
{
public:
  typedef cras::expected<sensor_msgs::CompressedImage, std::string> EncodeResult;

  explicit CompressedCodec(const cras::LogHelperPtr& logHelper = std::make_shared<cras::NodeLogHelper>());

  ~CompressedCodec() override;

  EncodeResult encode(const sensor_msgs::Image& raw,
                      const compressed_image_transport::CompressedPublisherConfig& config) const;

  ImageTransportCodec::DecodeResult decode(const sensor_msgs::CompressedImage& compressed,
                                           const compressed_image_transport::CompressedSubscriberConfig& config) const;

  ImageTransportCodec::DecodeResult decode(const sensor_msgs::CompressedImage& compressed) const;

  std::string getTransportName() const override;

  ImageTransportCodec::EncodeResult encode(const sensor_msgs::Image& raw,
                                           const dynamic_reconfigure::Config& config) const override;

  ImageTransportCodec::DecodeResult decode(const topic_tools::ShapeShifter& compressed,
                                           const dynamic_reconfigure::Config& config) const override;

  ImageTransportCodec::GetCompressedContentResult getCompressedImageContent(
    const topic_tools::ShapeShifter& compressed, const std::string& matchFormat) const override;

  ImageTransportCodec::GetCompressedContentResult getCompressedImageContent(
    const sensor_msgs::CompressedImage& compressed, const std::string& matchFormat) const;

  ImageTransportCodec::DecodeResult decompressJPEG(const std::vector<uint8_t>& data, const std::string& source_encoding,
                                                   const std_msgs::Header& header) const;

private:
  std::unique_ptr<CompressedCodecPrivate> data;  
};

}

// ////////
// C API //
// ////////

extern "C" bool compressedCodecEncode(
  sensor_msgs::Image::_height_type rawHeight,
  sensor_msgs::Image::_width_type rawWidth,
  const char* rawEncoding,
  sensor_msgs::Image::_is_bigendian_type rawIsBigEndian,
  sensor_msgs::Image::_step_type rawStep,
  size_t rawDataLength,
  const uint8_t rawData[],
  cras::allocator_t compressedFormatAllocator,
  cras::allocator_t compressedDataAllocator,
  const char* configFormat,
  int configJpegQuality,
#if COMPRESSED_HAS_JPEG_OPTIONS == 1
  bool configJpegProgressive,
  bool configJpegOptimize,
  int configJpegRestartInterval,
#endif
  int configPngLevel,
  cras::allocator_t errorStringAllocator,
  cras::allocator_t logMessagesAllocator
);

extern "C" bool compressedCodecDecode(
  const char* compressedFormat,
  size_t compressedDataLength,
  const uint8_t compressedData[],
  sensor_msgs::Image::_height_type& rawHeight,
  sensor_msgs::Image::_width_type& rawWidth,
  cras::allocator_t rawEncodingAllocator,
  sensor_msgs::Image::_is_bigendian_type& rawIsBigEndian,
  sensor_msgs::Image::_step_type& rawStep,
  cras::allocator_t rawDataAllocator,
  const char* configMode,
  cras::allocator_t errorStringAllocator,
  cras::allocator_t logMessagesAllocator
);

extern "C" bool compressed_codec_has_extra_jpeg_options();