Commit 063910f5 authored by Sebastien Zwickert's avatar Sebastien Zwickert Committed by Diego Biurrun

vda: cosmetics: fix Doxygen comment formatting

Signed-off-by: 's avatarDiego Biurrun <diego@biurrun.de>
parent 694be29f
...@@ -60,27 +60,27 @@ ...@@ -60,27 +60,27 @@
*/ */
typedef struct vda_frame { typedef struct vda_frame {
/** /**
* The PTS of the frame. * The PTS of the frame.
* *
* - encoding: unused * - encoding: unused
* - decoding: Set/Unset by libavcodec. * - decoding: Set/Unset by libavcodec.
*/ */
int64_t pts; int64_t pts;
/** /**
* The CoreVideo buffer that contains the decoded data. * The CoreVideo buffer that contains the decoded data.
* *
* - encoding: unused * - encoding: unused
* - decoding: Set/Unset by libavcodec. * - decoding: Set/Unset by libavcodec.
*/ */
CVPixelBufferRef cv_buffer; CVPixelBufferRef cv_buffer;
/** /**
* A pointer to the next frame. * A pointer to the next frame.
* *
* - encoding: unused * - encoding: unused
* - decoding: Set/Unset by libavcodec. * - decoding: Set/Unset by libavcodec.
*/ */
struct vda_frame *next_frame; struct vda_frame *next_frame;
} vda_frame; } vda_frame;
#endif #endif
...@@ -93,96 +93,96 @@ typedef struct vda_frame { ...@@ -93,96 +93,96 @@ typedef struct vda_frame {
*/ */
struct vda_context { struct vda_context {
/** /**
* VDA decoder object. * VDA decoder object.
* *
* - encoding: unused * - encoding: unused
* - decoding: Set/Unset by libavcodec. * - decoding: Set/Unset by libavcodec.
*/ */
VDADecoder decoder; VDADecoder decoder;
/** /**
* The Core Video pixel buffer that contains the current image data. * The Core Video pixel buffer that contains the current image data.
* *
* encoding: unused * encoding: unused
* decoding: Set by libavcodec. Unset by user. * decoding: Set by libavcodec. Unset by user.
*/ */
CVPixelBufferRef cv_buffer; CVPixelBufferRef cv_buffer;
/** /**
* Use the hardware decoder in synchronous mode. * Use the hardware decoder in synchronous mode.
* *
* encoding: unused * encoding: unused
* decoding: Set by user. * decoding: Set by user.
*/ */
int use_sync_decoding; int use_sync_decoding;
#if FF_API_VDA_ASYNC #if FF_API_VDA_ASYNC
/** /**
* VDA frames queue ordered by presentation timestamp. * VDA frames queue ordered by presentation timestamp.
* *
* @deprecated Use synchronous decoding mode. * @deprecated Use synchronous decoding mode.
* *
* - encoding: unused * - encoding: unused
* - decoding: Set/Unset by libavcodec. * - decoding: Set/Unset by libavcodec.
*/ */
vda_frame *queue; vda_frame *queue;
/** /**
* Mutex for locking queue operations. * Mutex for locking queue operations.
* *
* @deprecated Use synchronous decoding mode. * @deprecated Use synchronous decoding mode.
* *
* - encoding: unused * - encoding: unused
* - decoding: Set/Unset by libavcodec. * - decoding: Set/Unset by libavcodec.
*/ */
pthread_mutex_t queue_mutex; pthread_mutex_t queue_mutex;
#endif #endif
/** /**
* The frame width. * The frame width.
* *
* - encoding: unused * - encoding: unused
* - decoding: Set/Unset by user. * - decoding: Set/Unset by user.
*/ */
int width; int width;
/** /**
* The frame height. * The frame height.
* *
* - encoding: unused * - encoding: unused
* - decoding: Set/Unset by user. * - decoding: Set/Unset by user.
*/ */
int height; int height;
/** /**
* The frame format. * The frame format.
* *
* - encoding: unused * - encoding: unused
* - decoding: Set/Unset by user. * - decoding: Set/Unset by user.
*/ */
int format; int format;
/** /**
* The pixel format for output image buffers. * The pixel format for output image buffers.
* *
* - encoding: unused * - encoding: unused
* - decoding: Set/Unset by user. * - decoding: Set/Unset by user.
*/ */
OSType cv_pix_fmt_type; OSType cv_pix_fmt_type;
/** /**
* The current bitstream buffer. * The current bitstream buffer.
*/ */
uint8_t *priv_bitstream; uint8_t *priv_bitstream;
/** /**
* The current size of the bitstream. * The current size of the bitstream.
*/ */
int priv_bitstream_size; int priv_bitstream_size;
/** /**
* The reference size used for fast reallocation. * The reference size used for fast reallocation.
*/ */
int priv_allocated_size; int priv_allocated_size;
}; };
...@@ -196,17 +196,17 @@ int ff_vda_destroy_decoder(struct vda_context *vda_ctx); ...@@ -196,17 +196,17 @@ int ff_vda_destroy_decoder(struct vda_context *vda_ctx);
#if FF_API_VDA_ASYNC #if FF_API_VDA_ASYNC
/** /**
* Return the top frame of the queue. * Return the top frame of the queue.
* *
* @deprecated Use synchronous decoding mode. * @deprecated Use synchronous decoding mode.
*/ */
vda_frame *ff_vda_queue_pop(struct vda_context *vda_ctx); vda_frame *ff_vda_queue_pop(struct vda_context *vda_ctx);
/** /**
* Release the given frame. * Release the given frame.
* *
* @deprecated Use synchronous decoding mode. * @deprecated Use synchronous decoding mode.
*/ */
void ff_vda_release_vda_frame(vda_frame *frame); void ff_vda_release_vda_frame(vda_frame *frame);
#endif #endif
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment