@@ -181,7 +181,7 @@ typedef struct DynamicRangeControl {
} DynamicRangeControl;
/**
- * main AAC decoding context
+ * main AAC decoding @ref context "context"
*/
typedef struct AACDecContext {
const struct AVClass *class;
@@ -193,7 +193,7 @@ typedef struct AACPCEInfo {
} AACPCEInfo;
/**
- * AAC encoder context
+ * AAC encoder @ref context "context"
*/
typedef struct AACEncContext {
AVClass *av_class;
@@ -151,7 +151,7 @@ typedef struct AC3Block {
} AC3Block;
/**
- * AC-3 encoder private context.
+ * AC-3 encoder private @ref context "context"
*/
typedef struct AC3EncodeContext {
AVClass *av_class; ///< AVClass used for AVOption
@@ -43,7 +43,7 @@ typedef struct AmfTraceWriter {
} AmfTraceWriter;
/**
-* AMF encoder context
+* AMF encoder @ref context "context"
*/
typedef struct AmfContext {
@@ -39,7 +39,7 @@ typedef struct AtracGainInfo {
} AtracGainInfo;
/**
- * Gain compensation context structure.
+ * Gain compensation @ref context "context"
*/
typedef struct AtracGCContext {
float gain_tab1[16]; ///< gain compensation level table
@@ -430,7 +430,8 @@ typedef struct RcOverride{
#define AV_GET_ENCODE_BUFFER_FLAG_REF (1 << 0)
/**
- * main external API structure.
+ * @ref context "Context" for an encode or decode session
+ *
* New fields can be added to the end with minor version bumps.
* Removal, reordering and changes to existing fields require a major
* version bump.
@@ -56,7 +56,7 @@
*/
/**
- * The bitstream filter state.
+ * Bitstream filter @ref context "context"
*
* This struct must be allocated with av_bsf_alloc() and freed with
* av_bsf_free().
@@ -46,8 +46,7 @@
*/
/**
- * This structure is used to provides the necessary configurations and data
- * to the Direct3D11 FFmpeg HWAccel implementation.
+ * @ref context "Context" for the Direct3D11 FFmpeg HWAccel implementation
*
* The application must make it available as AVCodecContext.hwaccel_context.
*
@@ -26,7 +26,7 @@
#include "libavcodec/avcodec.h"
/**
- * This structure holds a reference to a android/view/Surface object that will
+ * @ref context "Context" for the android/view/Surface object that will
* be used as output by the decoder.
*
*/
@@ -26,8 +26,10 @@
#include "libavutil/buffer.h"
/**
- * This struct is used for communicating QSV parameters between libavcodec and
- * the caller. It is managed by the caller and must be assigned to
+ * @ref context "Context" for communicating QSV parameters between libavcodec
+ * and the caller.
+ *
+ * It is managed by the caller and must be assigned to
* AVCodecContext.hwaccel_context.
* - decoding: hwaccel_context must be set on return from the get_format()
* callback
@@ -116,7 +116,7 @@ typedef struct SBRData {
typedef struct SpectralBandReplication SpectralBandReplication;
/**
- * aacsbr functions pointers
+ * aacsbr functions pointer @ref context "context"
*/
typedef struct AACSBRContext {
int (*sbr_lf_gen)(SpectralBandReplication *sbr,
@@ -64,8 +64,9 @@ typedef int (*AVVDPAU_Render2)(struct AVCodecContext *, struct AVFrame *,
const VdpBitstreamBuffer *);
/**
- * This structure is used to share data between the libavcodec library and
+ * @ref context "Context" to share data between the libavcodec library and
* the client video application.
+ *
* This structure will be allocated and stored in AVCodecContext.hwaccel_context
* by av_vdpau_bind_context(). Members can be set by the user once
* during initialization or through each AVCodecContext.get_buffer()
@@ -49,8 +49,9 @@
#include "libavutil/attributes.h"
/**
- * This struct holds all the information that needs to be passed
- * between the caller and libavcodec for initializing Videotoolbox decoding.
+ * @ref context "Context" for information passed between the caller and libavcodec
+ * for initializing Videotoolbox decoding.
+ *
* Its size is not a part of the public ABI, it must be allocated with
* av_videotoolbox_alloc_context() and freed with av_free().
*/
@@ -403,7 +403,7 @@ unsigned avfilter_filter_pad_count(const AVFilter *filter, int is_output);
*/
#define AVFILTER_THREAD_SLICE (1 << 0)
-/** An instance of a filter */
+/** @ref context "Context" for a filter */
struct AVFilterContext {
const AVClass *av_class; ///< needed for av_log() and filters common options
@@ -1241,7 +1241,8 @@ enum AVDurationEstimationMethod {
};
/**
- * Format I/O context.
+ * Format I/O @ref context "context"
+ *
* New fields can be added to the end with minor version bumps.
* Removal, reordering and changes to existing fields require a major
* version bump.
@@ -146,7 +146,8 @@ enum AVIODataMarkerType {
};
/**
- * Bytestream IO Context.
+ * Bytestream I/O @ref context "context"
+ *
* New public fields can be added with minor version bumps.
* Removal, reordering and changes to existing public fields require
* a major version bump.
@@ -41,12 +41,13 @@ enum AVHWDeviceType {
};
/**
- * This struct aggregates all the (hardware/vendor-specific) "high-level" state,
- * i.e. state that is not tied to a concrete processing configuration.
- * E.g., in an API that supports hardware-accelerated encoding and decoding,
- * this struct will (if possible) wrap the state that is common to both encoding
- * and decoding and from which specific instances of encoders or decoders can be
- * derived.
+ * @ref context "Context" for (hardware/vendor-specific) "high-level" state.
+ *
+ * "High-level state" is anything that is not tied to a concrete processing
+ * configuration. E.g., in an API that supports hardware-accelerated encoding
+ * and decoding, this struct will (if possible) wrap the state that is common
+ * to both encoding and decoding and from which specific instances of encoders
+ * or decoders can be derived.
*
* This struct is reference-counted with the AVBuffer mechanism. The
* av_hwdevice_ctx_alloc() constructor yields a reference, whose data field
@@ -103,9 +104,11 @@ typedef struct AVHWDeviceContext {
} AVHWDeviceContext;
/**
- * This struct describes a set or pool of "hardware" frames (i.e. those with
- * data not located in normal system memory). All the frames in the pool are
- * assumed to be allocated in the same way and interchangeable.
+ * @ref context "context" for a pool of "hardware" frames (those with
+ * data not located in normal system memory)
+ *
+ * All the frames in the pool are assumed to be allocated in the same way and
+ * interchangeable.
*
* This struct is reference-counted with the AVBuffer mechanism and tied to a
* given AVHWDeviceContext instance. The av_hwframe_ctx_alloc() constructor
@@ -37,7 +37,7 @@
typedef struct AVCUDADeviceContextInternal AVCUDADeviceContextInternal;
/**
- * This struct is allocated as AVHWDeviceContext.hwctx
+ * This @ref context "context" is allocated as AVHWDeviceContext.hwctx
*/
typedef struct AVCUDADeviceContext {
CUcontext cuda_ctx;
@@ -40,7 +40,7 @@
#include <stdint.h>
/**
- * This struct is allocated as AVHWDeviceContext.hwctx
+ * This @ref context "context" is allocated as AVHWDeviceContext.hwctx
*/
typedef struct AVD3D11VADeviceContext {
/**
@@ -126,7 +126,7 @@ typedef struct AVD3D11FrameDescriptor {
} AVD3D11FrameDescriptor;
/**
- * This struct is allocated as AVHWFramesContext.hwctx
+ * This @ref context "context" is allocated as AVHWFramesContext.hwctx
*/
typedef struct AVD3D11VAFramesContext {
/**
@@ -37,7 +37,7 @@
#include <d3d12video.h>
/**
- * @brief This struct is allocated as AVHWDeviceContext.hwctx
+ * @brief This @ref context "context" is allocated as AVHWDeviceContext.hwctx
*
*/
typedef struct AVD3D12VADeviceContext {
@@ -78,7 +78,7 @@ typedef struct AVD3D12VADeviceContext {
} AVD3D12VADeviceContext;
/**
- * @brief This struct is used to sync d3d12 execution
+ * @brief This @ref context "context" is used to sync d3d12 execution
*
*/
typedef struct AVD3D12VASyncContext {
@@ -120,7 +120,7 @@ typedef struct AVD3D12VAFrame {
} AVD3D12VAFrame;
/**
- * @brief This struct is allocated as AVHWFramesContext.hwctx
+ * @brief This @ref context "context" is allocated as AVHWFramesContext.hwctx
*
*/
typedef struct AVD3D12VAFramesContext {
@@ -152,7 +152,7 @@ typedef struct AVDRMFrameDescriptor {
/**
* DRM device.
*
- * Allocated as AVHWDeviceContext.hwctx.
+ * This @ref context "context" is allocated as AVHWDeviceContext.hwctx.
*/
typedef struct AVDRMDeviceContext {
/**
@@ -34,14 +34,14 @@
#include <dxva2api.h>
/**
- * This struct is allocated as AVHWDeviceContext.hwctx
+ * This @ref context "context" is allocated as AVHWDeviceContext.hwctx
*/
typedef struct AVDXVA2DeviceContext {
IDirect3DDeviceManager9 *devmgr;
} AVDXVA2DeviceContext;
/**
- * This struct is allocated as AVHWFramesContext.hwctx
+ * This @ref context "context" is allocated as AVHWFramesContext.hwctx
*/
typedef struct AVDXVA2FramesContext {
/**
@@ -22,7 +22,7 @@
/**
* MediaCodec details.
*
- * Allocated as AVHWDeviceContext.hwctx
+ * This @ref context "context" is allocated as AVHWDeviceContext.hwctx
*/
typedef struct AVMediaCodecDeviceContext {
/**
@@ -58,7 +58,7 @@ typedef struct AVOpenCLFrameDescriptor {
/**
* OpenCL device details.
*
- * Allocated as AVHWDeviceContext.hwctx
+ * This @ref context "context" is allocated as AVHWDeviceContext.hwctx
*/
typedef struct AVOpenCLDeviceContext {
/**
@@ -84,7 +84,7 @@ typedef struct AVOpenCLDeviceContext {
/**
* OpenCL-specific data associated with a frame pool.
*
- * Allocated as AVHWFramesContext.hwctx.
+ * This @ref context "context" is allocated as AVHWFramesContext.hwctx.
*/
typedef struct AVOpenCLFramesContext {
/**
@@ -30,7 +30,7 @@
*/
/**
- * This struct is allocated as AVHWDeviceContext.hwctx
+ * This @ref context "context" is allocated as AVHWDeviceContext.hwctx
*/
typedef struct AVQSVDeviceContext {
mfxSession session;
@@ -48,7 +48,7 @@ typedef struct AVQSVDeviceContext {
} AVQSVDeviceContext;
/**
- * This struct is allocated as AVHWFramesContext.hwctx
+ * This @ref context "context" is allocated as AVHWFramesContext.hwctx
*/
typedef struct AVQSVFramesContext {
mfxFrameSurface1 *surfaces;
@@ -63,7 +63,7 @@ enum {
/**
* VAAPI connection details.
*
- * Allocated as AVHWDeviceContext.hwctx
+ * This @ref context "context" is allocated as AVHWDeviceContext.hwctx
*/
typedef struct AVVAAPIDeviceContext {
/**
@@ -83,7 +83,7 @@ typedef struct AVVAAPIDeviceContext {
/**
* VAAPI-specific data associated with a frame pool.
*
- * Allocated as AVHWFramesContext.hwctx.
+ * This @ref context "context" is allocated as AVHWFramesContext.hwctx.
*/
typedef struct AVVAAPIFramesContext {
/**
@@ -105,7 +105,7 @@ typedef struct AVVAAPIFramesContext {
/**
* VAAPI hardware pipeline configuration details.
*
- * Allocated with av_hwdevice_hwconfig_alloc().
+ * This struct is allocated with av_hwdevice_hwconfig_alloc().
*/
typedef struct AVVAAPIHWConfig {
/**
@@ -30,7 +30,7 @@
*/
/**
- * This struct is allocated as AVHWDeviceContext.hwctx
+ * This @ref context "context" is allocated as AVHWDeviceContext.hwctx
*/
typedef struct AVVDPAUDeviceContext {
VdpDevice device;
@@ -39,7 +39,7 @@ typedef struct AVVkFrame AVVkFrame;
*/
/**
- * Main Vulkan context, allocated as AVHWDeviceContext.hwctx.
+ * Main Vulkan @ref context "context", allocated as AVHWDeviceContext.hwctx.
* All of these can be set before init to change what the context uses
*/
typedef struct AVVulkanDeviceContext {
@@ -172,7 +172,7 @@ typedef enum AVVkFrameFlags {
} AVVkFrameFlags;
/**
- * Allocated as AVHWFramesContext.hwctx, used to set pool-specific options
+ * This @ref context "context" is allocated as AVHWFramesContext.hwctx, used to set pool-specific options
*/
typedef struct AVVulkanFramesContext {
/**