diff --git a/src/guacenc/ffmpeg-compat.h b/src/guacenc/ffmpeg-compat.h index e0542a43..a5cfb2f5 100644 --- a/src/guacenc/ffmpeg-compat.h +++ b/src/guacenc/ffmpeg-compat.h @@ -89,43 +89,43 @@ int guacenc_avcodec_encode_video(guacenc_video* video, AVFrame* frame); /** - * Creates and sets up the AVCodecContext for the appropriate version - * of libavformat installed. The AVCodecContext will be built, but - * the AVStream will also be affected by having its time_base field - * set to the value passed into this function. + * Creates and sets up the AVCodecContext for the appropriate version of + * libavformat installed. The AVCodecContext will be built, but the AVStream + * will also be affected by having its time_base field set to the value passed + * into this function. * * @param stream - * The open AVStream + * The open AVStream. * * @param codec - * The codec used on the AVStream + * The codec used on the AVStream. * * @param bitrate * The target bitrate for the encoded video * * @param width - * The target width for the encoded video + * The target width for the encoded video. * * @param height - * The target width for the encoded video + * The target height for the encoded video. * * @param gop_size - * The size of the Group of Pictures + * The size of the Group of Pictures. * * @param qmax - * The max value of the quantizer + * The max value of the quantizer. * * @param qmin - * The min value of the quantizer + * The min value of the quantizer. * * @param pix_fmt - * The target pixel format for the encoded video + * The target pixel format for the encoded video. * * @param time_base - * The target time base for the encoded video + * The target time base for the encoded video. * * @return - * The pointer to the configured AVCodecContext + * The pointer to the configured AVCodecContext. * */ 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); /** - * A wrapper for avcodec_open2(). Because libavformat ver - * 57.33.100 and greater use stream->codecpar rather than - * stream->codec to handle information to the codec, - * there needs to be an additional step in that version. - * So this wrapper handles that. Otherwise, it's the - * same as avcodec_open2(). + * A wrapper for avcodec_open2(). Because libavformat ver 57.33.100 and greater + * use stream->codecpar rather than stream->codec to handle information to the + * codec, there needs to be an additional step in that version. So this + * wrapper handles that. Otherwise, it's the same as avcodec_open2(). * * @param avcodec_context * The context to initialize. * * @param codec - * The codec to open this context for. If a non-NULL codec has - * been previously passed to avcodec_alloc_context3() or - * for this context, then this parameter MUST be either NULL or - * equal to the previously passed codec. + * The codec to open this context for. If a non-NULL codec has been + * previously passed to avcodec_alloc_context3() or for this context, then + * this parameter MUST be either NULL or equal to the previously passed + * codec. * * @param options - * A dictionary filled with AVCodecContext and codec-private - * options. On return this object will be filled with options - * that were not found. + * A dictionary filled with AVCodecContext and codec-private options. On + * return this object will be filled with options that were not found. * * @param stream * The stream for the codec context. * * @return - * Zero on success, a negative value on error + * Zero on success, a negative value on error. */ int guacenc_open_avcodec(AVCodecContext *avcodec_context, AVCodec *codec, AVDictionary **options,