@@ -253,7 +253,7 @@ typedef struct AACDecDSP {
} AACDecDSP;
/**
- * main AAC decoding context
+ * Context for decoding AAC
*/
struct AACDecContext {
const struct AVClass *class;
@@ -207,7 +207,7 @@ typedef struct AACPCEInfo {
} AACPCEInfo;
/**
- * AAC encoder context
+ * Context for encoding AAC
*/
typedef struct AACEncContext {
AVClass *av_class;
@@ -153,7 +153,7 @@ typedef struct AC3Block {
struct PutBitContext;
/**
- * AC-3 encoder private context.
+ * Private context for encoding AC-3
*/
typedef struct AC3EncodeContext {
AVClass *av_class; ///< AVClass used for AVOption
@@ -43,7 +43,7 @@ typedef struct AmfTraceWriter {
} AmfTraceWriter;
/**
-* AMF encoder context
+* Context for encoding AMF
*/
typedef struct AmfContext {
@@ -39,7 +39,7 @@ typedef struct AtracGainInfo {
} AtracGainInfo;
/**
- * Gain compensation context structure.
+ * Context for gain compensation
*/
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.
+ * 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.
+ * Context for bitstream filtering
*
* This struct must be allocated with av_bsf_alloc() and freed with
* av_bsf_free().
@@ -214,7 +214,7 @@ typedef void (*CBSTraceWriteCallback)(void *trace_context,
int64_t value);
/**
- * Context structure for coded bitstream operations.
+ * Context for coded bitstream operations
*/
typedef struct CodedBitstreamContext {
/**
@@ -46,8 +46,7 @@
*/
/**
- * This structure is used to provides the necessary configurations and data
- * to the Direct3D11 FFmpeg HWAccel implementation.
+ * Context for the Direct3D11 FFmpeg HWAccel implementation
*
* The application must make it available as AVCodecContext.hwaccel_context.
*
@@ -26,8 +26,8 @@
#include "libavcodec/avcodec.h"
/**
- * This structure holds a reference to a android/view/Surface object that will
- * be used as output by the decoder.
+ * Context for the android/view/Surface object that will
+ * be used as output by the decoder
*
* @see
* - @ref Context
@@ -69,7 +69,7 @@ typedef struct ThreadFrameProgress {
} ThreadFrameProgress;
/**
- * Context used by codec threads and stored in their AVCodecInternal thread_ctx.
+ * Context used by codec threads and allocated as AVCodecInternal.thread_ctx
*/
typedef struct PerThreadContext {
struct FrameThreadContext *parent;
@@ -113,7 +113,7 @@ typedef struct PerThreadContext {
} PerThreadContext;
/**
- * Context stored in the client AVCodecInternal thread_ctx.
+ * Context allocated as AVCodecInternal.thread_ctx
*/
typedef struct FrameThreadContext {
PerThreadContext *threads; ///< The contexts for each thread.
@@ -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
+ * 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
+ * Context for aacsbr functions
*/
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
- * the client video application.
+ * 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.
+ * 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().
*
@@ -404,7 +404,7 @@ unsigned avfilter_filter_pad_count(const AVFilter *filter, int is_output);
#define AVFILTER_THREAD_SLICE (1 << 0)
/**
- * An instance of a filter
+ * Context for a filter
*
* @see
* - @ref Context
@@ -1241,7 +1241,8 @@ enum AVDurationEstimationMethod {
};
/**
- * Format I/O context.
+ * Context for format I/O
+ *
* 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.
+ * Context for bytestream I/O
+ *
* New public fields can be added with minor version bumps.
* Removal, reordering and changes to existing public fields require
* a major version bump.
@@ -39,7 +39,7 @@
*/
/**
- * Context for an Audio FIFO Buffer.
+ * Context for an Audio FIFO Buffer
*
* - Operates at the sample level rather than the byte level.
* - Supports multiple channels with either planar or packed sample format.
@@ -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.
+ * 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
@@ -106,9 +107,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.
+ * 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
+ * Context allocated as AVHWDeviceContext.hwctx
*
* @see
* - @ref Context
@@ -40,7 +40,7 @@
#include <stdint.h>
/**
- * This struct is allocated as AVHWDeviceContext.hwctx
+ * Context allocated as AVHWDeviceContext.hwctx
*
* @see
* - @ref Context
@@ -129,7 +129,7 @@ typedef struct AVD3D11FrameDescriptor {
} AVD3D11FrameDescriptor;
/**
- * This struct is allocated as AVHWFramesContext.hwctx
+ * Context allocated as AVHWFramesContext.hwctx
*
* @see
* - @ref Context
@@ -37,7 +37,7 @@
#include <d3d12video.h>
/**
- * @brief This struct is allocated as AVHWDeviceContext.hwctx
+ * @brief Context allocated as AVHWDeviceContext.hwctx
*
* @see
* - @ref Context
@@ -80,7 +80,7 @@ typedef struct AVD3D12VADeviceContext {
} AVD3D12VADeviceContext;
/**
- * @brief This struct is used to sync d3d12 execution
+ * @brief Context for syncing d3d12 execution
*
* @see
* - @ref Context
@@ -124,7 +124,7 @@ typedef struct AVD3D12VAFrame {
} AVD3D12VAFrame;
/**
- * @brief This struct is allocated as AVHWFramesContext.hwctx
+ * @brief Context allocated as AVHWFramesContext.hwctx
*
* @see
* - @ref Context
@@ -152,7 +152,7 @@ typedef struct AVDRMFrameDescriptor {
/**
* DRM device.
*
- * Allocated as AVHWDeviceContext.hwctx.
+ * Context allocated as AVHWDeviceContext.hwctx
*
* @see
* - @ref Context
@@ -34,7 +34,7 @@
#include <dxva2api.h>
/**
- * This struct is allocated as AVHWDeviceContext.hwctx
+ * Context allocated as AVHWDeviceContext.hwctx
*
* @see
* - @ref Context
@@ -44,7 +44,7 @@ typedef struct AVDXVA2DeviceContext {
} AVDXVA2DeviceContext;
/**
- * This struct is allocated as AVHWFramesContext.hwctx
+ * Context allocated as AVHWFramesContext.hwctx
*
* @see
* - @ref Context
@@ -22,7 +22,7 @@
/**
* MediaCodec details.
*
- * Allocated as AVHWDeviceContext.hwctx
+ * Context allocated as AVHWDeviceContext.hwctx
*
* @see
* - @ref Context
@@ -58,7 +58,7 @@ typedef struct AVOpenCLFrameDescriptor {
/**
* OpenCL device details.
*
- * Allocated as AVHWDeviceContext.hwctx
+ * Context allocated as AVHWDeviceContext.hwctx
*
* @see
* - @ref Context
@@ -87,7 +87,7 @@ typedef struct AVOpenCLDeviceContext {
/**
* OpenCL-specific data associated with a frame pool.
*
- * Allocated as AVHWFramesContext.hwctx.
+ * Context allocated as AVHWFramesContext.hwctx
*
* @see
* - @ref Context
@@ -30,7 +30,7 @@
*/
/**
- * This struct is allocated as AVHWDeviceContext.hwctx
+ * Context allocated as AVHWDeviceContext.hwctx
*
* @see
* - @ref Context
@@ -51,7 +51,7 @@ typedef struct AVQSVDeviceContext {
} AVQSVDeviceContext;
/**
- * This struct is allocated as AVHWFramesContext.hwctx
+ * Context allocated as AVHWFramesContext.hwctx
*
* @see
* - @ref Context
@@ -63,7 +63,7 @@ enum {
/**
* VAAPI connection details.
*
- * Allocated as AVHWDeviceContext.hwctx
+ * Context allocated as AVHWDeviceContext.hwctx
*
* @see
* - @ref Context
@@ -86,7 +86,7 @@ typedef struct AVVAAPIDeviceContext {
/**
* VAAPI-specific data associated with a frame pool.
*
- * Allocated as AVHWFramesContext.hwctx.
+ * Context allocated as AVHWFramesContext.hwctx
*
* @see
* - @ref Context
@@ -30,7 +30,7 @@
*/
/**
- * This struct is allocated as AVHWDeviceContext.hwctx
+ * Context allocated as AVHWDeviceContext.hwctx
*
* @see
* - @ref Context
@@ -39,7 +39,8 @@ typedef struct AVVkFrame AVVkFrame;
*/
/**
- * Main Vulkan context, allocated as AVHWDeviceContext.hwctx.
+ * Context for Vulkan, allocated as AVHWDeviceContext.hwctx
+ *
* All of these can be set before init to change what the context uses
*
* @see
@@ -175,7 +176,7 @@ typedef enum AVVkFrameFlags {
} AVVkFrameFlags;
/**
- * Allocated as AVHWFramesContext.hwctx, used to set pool-specific options
+ * Context allocated as AVHWFramesContext.hwctx, used to set pool-specific options
*
* @see
* - @ref Context
@@ -25,7 +25,8 @@
#include <stdint.h>
/**
- * Context structure for the Lagged Fibonacci PRNG.
+ * Context structure for the Lagged Fibonacci PRNG
+ *
* The exact layout, types and content of this struct may change and should
* not be accessed directly. Only its `sizeof()` is guaranteed to stay the same
* to allow easy instanciation.