GUACAMOLE-465: Reformat/reflow comments to match established style.
This commit is contained in:
parent
fe0658dd36
commit
81601d99fe
@ -89,43 +89,43 @@
|
|||||||
int guacenc_avcodec_encode_video(guacenc_video* video, AVFrame* frame);
|
int guacenc_avcodec_encode_video(guacenc_video* video, AVFrame* frame);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates and sets up the AVCodecContext for the appropriate version
|
* Creates and sets up the AVCodecContext for the appropriate version of
|
||||||
* of libavformat installed. The AVCodecContext will be built, but
|
* libavformat installed. The AVCodecContext will be built, but the AVStream
|
||||||
* the AVStream will also be affected by having its time_base field
|
* will also be affected by having its time_base field set to the value passed
|
||||||
* set to the value passed into this function.
|
* into this function.
|
||||||
*
|
*
|
||||||
* @param stream
|
* @param stream
|
||||||
* The open AVStream
|
* The open AVStream.
|
||||||
*
|
*
|
||||||
* @param codec
|
* @param codec
|
||||||
* The codec used on the AVStream
|
* The codec used on the AVStream.
|
||||||
*
|
*
|
||||||
* @param bitrate
|
* @param bitrate
|
||||||
* The target bitrate for the encoded video
|
* The target bitrate for the encoded video
|
||||||
*
|
*
|
||||||
* @param width
|
* @param width
|
||||||
* The target width for the encoded video
|
* The target width for the encoded video.
|
||||||
*
|
*
|
||||||
* @param height
|
* @param height
|
||||||
* The target width for the encoded video
|
* The target height for the encoded video.
|
||||||
*
|
*
|
||||||
* @param gop_size
|
* @param gop_size
|
||||||
* The size of the Group of Pictures
|
* The size of the Group of Pictures.
|
||||||
*
|
*
|
||||||
* @param qmax
|
* @param qmax
|
||||||
* The max value of the quantizer
|
* The max value of the quantizer.
|
||||||
*
|
*
|
||||||
* @param qmin
|
* @param qmin
|
||||||
* The min value of the quantizer
|
* The min value of the quantizer.
|
||||||
*
|
*
|
||||||
* @param pix_fmt
|
* @param pix_fmt
|
||||||
* The target pixel format for the encoded video
|
* The target pixel format for the encoded video.
|
||||||
*
|
*
|
||||||
* @param time_base
|
* @param time_base
|
||||||
* The target time base for the encoded video
|
* The target time base for the encoded video.
|
||||||
*
|
*
|
||||||
* @return
|
* @return
|
||||||
* The pointer to the configured AVCodecContext
|
* The pointer to the configured AVCodecContext.
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
AVCodecContext* guacenc_build_avcodeccontext(AVStream* stream, AVCodec* codec,
|
AVCodecContext* guacenc_build_avcodeccontext(AVStream* stream, AVCodec* codec,
|
||||||
@ -133,32 +133,29 @@ AVCodecContext* guacenc_build_avcodeccontext(AVStream* stream, AVCodec* codec,
|
|||||||
int pix_fmt, AVRational time_base);
|
int pix_fmt, AVRational time_base);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A wrapper for avcodec_open2(). Because libavformat ver
|
* A wrapper for avcodec_open2(). Because libavformat ver 57.33.100 and greater
|
||||||
* 57.33.100 and greater use stream->codecpar rather than
|
* use stream->codecpar rather than stream->codec to handle information to the
|
||||||
* stream->codec to handle information to the codec,
|
* codec, there needs to be an additional step in that version. So this
|
||||||
* there needs to be an additional step in that version.
|
* wrapper handles that. Otherwise, it's the same as avcodec_open2().
|
||||||
* So this wrapper handles that. Otherwise, it's the
|
|
||||||
* same as avcodec_open2().
|
|
||||||
*
|
*
|
||||||
* @param avcodec_context
|
* @param avcodec_context
|
||||||
* The context to initialize.
|
* The context to initialize.
|
||||||
*
|
*
|
||||||
* @param codec
|
* @param codec
|
||||||
* The codec to open this context for. If a non-NULL codec has
|
* The codec to open this context for. If a non-NULL codec has been
|
||||||
* been previously passed to avcodec_alloc_context3() or
|
* previously passed to avcodec_alloc_context3() or for this context, then
|
||||||
* for this context, then this parameter MUST be either NULL or
|
* this parameter MUST be either NULL or equal to the previously passed
|
||||||
* equal to the previously passed codec.
|
* codec.
|
||||||
*
|
*
|
||||||
* @param options
|
* @param options
|
||||||
* A dictionary filled with AVCodecContext and codec-private
|
* A dictionary filled with AVCodecContext and codec-private options. On
|
||||||
* options. On return this object will be filled with options
|
* return this object will be filled with options that were not found.
|
||||||
* that were not found.
|
|
||||||
*
|
*
|
||||||
* @param stream
|
* @param stream
|
||||||
* The stream for the codec context.
|
* The stream for the codec context.
|
||||||
*
|
*
|
||||||
* @return
|
* @return
|
||||||
* Zero on success, a negative value on error
|
* Zero on success, a negative value on error.
|
||||||
*/
|
*/
|
||||||
int guacenc_open_avcodec(AVCodecContext *avcodec_context,
|
int guacenc_open_avcodec(AVCodecContext *avcodec_context,
|
||||||
AVCodec *codec, AVDictionary **options,
|
AVCodec *codec, AVDictionary **options,
|
||||||
|
Loading…
Reference in New Issue
Block a user