#include <vulkan/vulkan.h>
+#include "pixfmt.h"
+#include "frame.h"
+
/**
* @file
* API-specific header for AV_HWDEVICE_TYPE_VULKAN.
int queue_family_comp_index;
int nb_comp_queues;
/**
- * Enabled instance extensions. By default, VK_KHR_surface is enabled if found.
+ * Enabled instance extensions.
* If supplying your own device context, set this to an array of strings, with
* each entry containing the specified Vulkan extension string to enable.
* Duplicates are possible and accepted.
int nb_enabled_inst_extensions;
/**
* Enabled device extensions. By default, VK_KHR_external_memory_fd,
- * VK_EXT_external_memory_dma_buf, VK_EXT_image_drm_format_modifier and
- * VK_KHR_external_semaphore_fd are enabled if found.
+ * VK_EXT_external_memory_dma_buf, VK_EXT_image_drm_format_modifier,
+ * VK_KHR_external_semaphore_fd and VK_EXT_external_memory_host are enabled if found.
* If supplying your own device context, these fields takes the same format as
* the above fields, with the same conditions that duplicates are possible
* and accepted, and that NULL and 0 respectively means no extensions are enabled.
*/
typedef struct AVVulkanFramesContext {
/**
- * Controls the tiling of output frames.
+ * Controls the tiling of allocated frames.
*/
VkImageTiling tiling;
/**
- * Defines extra usage of output frames. This is bitwise OR'd with the
- * standard usage flags (SAMPLED, STORAGE, TRANSFER_SRC and TRANSFER_DST).
+ * Defines extra usage of output frames. If left as 0, the following bits
+ * are set: TRANSFER_SRC, TRANSFER_DST. SAMPLED and STORAGE.
*/
VkImageUsageFlagBits usage;
/**
- * Extension data for image creation. By default, if the extension is
- * available, this will be chained to a VkImageFormatListCreateInfoKHR.
+ * Extension data for image creation.
*/
void *create_pnext;
/**
* Extension data for memory allocation. Must have as many entries as
* the number of planes of the sw_format.
* This will be chained to VkExportMemoryAllocateInfo, which is used
- * to make all pool images exportable to other APIs.
+ * to make all pool images exportable to other APIs if the necessary
+ * extensions are present in enabled_dev_extensions.
*/
void *alloc_pnext[AV_NUM_DATA_POINTERS];
} AVVulkanFramesContext;
VkImage img[AV_NUM_DATA_POINTERS];
/**
- * Same tiling must be used for all images.
+ * The same tiling must be used for all images in the frame.
*/
VkImageTiling tiling;
VkImageLayout layout[AV_NUM_DATA_POINTERS];
/**
- * Per-image semaphores. Must not be freed manually. Must be waited on
+ * Synchronization semaphores. Must not be freed manually. Must be waited on
* and signalled at every queue submission.
+ * Could be less than the amount of images: either one per VkDeviceMemory
+ * or one for the entire frame. All others will be set to VK_NULL_HANDLE.
*/
VkSemaphore sem[AV_NUM_DATA_POINTERS];
/**
* Returns the format of each image up to the number of planes for a given sw_format.
+ * Returns NULL on unsupported formats.
*/
const VkFormat *av_vkfmt_from_pixfmt(enum AVPixelFormat p);