movie_open_config.h

Go to the documentation of this file.

// SPDX-License-Identifier: BSD-3-Clause
// SPDX-FileCopyrightText: Czech Technical University in Prague
 
#pragma once
 
#include <memory>
#include <string>
#include <vector>
 
#include <cras_cpp_common/expected.hpp>
#include <movie_publisher/metadata_type.h>
#include <ros/duration.h>
 
namespace movie_publisher
{
 
class MovieMetadataProcessor;
 
struct MovieOpenConfig final
{
  explicit MovieOpenConfig(const cras::BoundParamHelperPtr& rosParams);
  ~MovieOpenConfig();
  MovieOpenConfig(const MovieOpenConfig& other);
  MovieOpenConfig& operator=(const MovieOpenConfig& other);
  MovieOpenConfig(MovieOpenConfig&& other) noexcept;
  MovieOpenConfig& operator=(MovieOpenConfig&& other) noexcept;
 
  std::string filenameOrURL() const;
  cras::expected<void, std::string> setFilenameOrURL(const std::string& data);
 
  bool extractMetadata() const;
  cras::expected<void, std::string> setExtractMetadata(bool data);
  const std::vector<std::shared_ptr<MovieMetadataProcessor>>& metadataProcessors() const;
  std::vector<std::shared_ptr<MovieMetadataProcessor>>& metadataProcessors();
  cras::expected<void, std::string> setMetadataProcessors(
    const std::vector<std::shared_ptr<MovieMetadataProcessor>>& data);
 
  std::string defaultEncoding() const;
  cras::expected<void, std::string> setDefaultEncoding(const std::string& data);
  cras::optional<std::string> forceEncoding() const;
  cras::expected<void, std::string> setForceEncoding(const cras::optional<std::string>& data);
  bool allowYUVFallback() const;
  cras::expected<void, std::string> setAllowYUVFallback(bool data);
  cras::optional<int> forceStreamIndex() const;
  cras::expected<void, std::string> setForceStreamIndex(const cras::optional<int>& data);
 
  std::string frameId() const;
  cras::expected<void, std::string> setFrameId(const std::string& data);
  std::string opticalFrameId() const;
  cras::expected<void, std::string> setOpticalFrameId(const std::string& data);
 
  TimestampSource timestampSource() const;
  cras::expected<void, std::string> setTimestampSource(TimestampSource data);
  ros::Duration timestampOffset() const;
  cras::expected<void, std::string> setTimestampOffset(const ros::Duration& data);
  size_t numThreads() const;
  cras::expected<void, std::string> setNumThreads(size_t data);
 
  cras::BoundParamHelperPtr rosParams() const;
  cras::expected<void, std::string> setRosParams(const cras::BoundParamHelperPtr& data);
 
  std::unordered_set<MetadataType> metadataTypes() const;
  cras::expected<void, std::string> setMetadataTypes(const std::unordered_set<MetadataType>& types);
 
  using Ptr = std::shared_ptr<MovieOpenConfig>;
  using ConstPtr = std::shared_ptr<const MovieOpenConfig>;
 
private:
  struct Impl;
  std::unique_ptr<Impl> data;  
};
 
}