vart_videoframe.hpp

Go to the documentation of this file.

/*
 * Copyright 2024-2026 Advanced Micro Devices 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.
 */
 
#pragma once
 
#include <xrt/xrt_bo.h>
#include <vector>
#include "vart_device.hpp"
#include "vart_memory_types.hpp"
#include "vart_videoframe_types.hpp"
 
namespace vart {
 
class VideoFrameImplBase;
 
class VideoFrame {
 public:
  VideoFrame(VideoFrameImplType type, size_t size, uint8_t mbank_idx, VideoInfo& vinfo, std::shared_ptr<Device> device);
 
  VideoFrame(VideoFrameImplType type,
             std::vector<uint8_t*>& data_vec,
             VideoInfo& vinfo,
             std::shared_ptr<Device> device);
 
  VideoFrame(VideoFrameImplType type,
             uint8_t mbank_idx,
             std::vector<xrt::bo*>& bo_vec,
             VideoInfo& vinfo,
             std::shared_ptr<Device> device);
 
  VideoFrame(VideoFrameImplType type, int dma_buf_fd, VideoInfo& vinfo, std::shared_ptr<Device> device);
 
  ~VideoFrame() = default;
 
  const VideoFrameMapInfo& map(DataMapFlags map_flags);
 
  void unmap();
 
  const VideoInfo& get_video_info() const;
 
  std::shared_ptr<Device> get_device_handle() const;
 
  const std::shared_ptr<VideoFrameImplBase>& get_pimpl_handle() const;
 
  int export_buffer() const;
 
 private:
  std::shared_ptr<VideoFrameImplBase> pimpl;  
};
}  // namespace vart