X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=libavcodec%2Fxvmc.h;h=950ed1827646da31ccdb73b83b5713fc20f55e26;hb=4628443ca3534060888dd0015b229337eac13fd2;hp=54e35ee2da4101e012ef02d4ee46dcfa581680e8;hpb=058bcd7b6b92cf89602b8aecf2bfb8066ec2d9b4;p=ffmpeg diff --git a/libavcodec/xvmc.h b/libavcodec/xvmc.h index 54e35ee2da4..950ed182764 100644 --- a/libavcodec/xvmc.h +++ b/libavcodec/xvmc.h @@ -1,100 +1,111 @@ /* * Copyright (C) 2003 Ivan Kalvachev * - * This file is part of FFmpeg. + * This file is part of Libav. * - * FFmpeg is free software; you can redistribute it and/or + * Libav is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or (at your option) any later version. * - * FFmpeg is distributed in the hope that it will be useful, + * Libav is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public - * License along with FFmpeg; if not, write to the Free Software + * License along with Libav; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ #ifndef AVCODEC_XVMC_H #define AVCODEC_XVMC_H +/** + * @file + * @ingroup lavc_codec_hwaccel_xvmc + * Public libavcodec XvMC header. + */ + #include +#include "libavutil/attributes.h" +#include "version.h" #include "avcodec.h" -#if LIBAVCODEC_VERSION_MAJOR < 53 -#define AV_XVMC_STATE_DISPLAY_PENDING 1 /** the surface should be shown, the video driver manipulates this */ -#define AV_XVMC_STATE_PREDICTION 2 /** the surface is needed for prediction, the codec manipulates this */ -#define AV_XVMC_STATE_OSD_SOURCE 4 /** the surface is needed for subpicture rendering */ -#endif +#if FF_API_XVMC + +/** + * @defgroup lavc_codec_hwaccel_xvmc XvMC + * @ingroup lavc_codec_hwaccel + * + * @{ + */ + #define AV_XVMC_ID 0x1DC711C0 /**< special value to ensure that regular pixel routines haven't corrupted the struct the number is 1337 speak for the letters IDCT MCo (motion compensation) */ -struct xvmc_pix_fmt { -/** Set by the calling application. - Once set these values are not supposed to be modified. -*/ -//@{ +attribute_deprecated struct xvmc_pix_fmt { /** The field contains the special constant value AV_XVMC_ID. - It is used as test whenever the application knows the calling API, + It is used as a test that the application correctly uses the API, and that there is no corruption caused by pixel routines. - application - set during initialization - libavcodec - unchanged */ int xvmc_id; - /** Pointer to the block array allocated by XvMCCreateBlocks() - it contins differential pixel data (in MoCo mode) - or coefficients for IDCT. - - application - set during initialization - - libavcodec - unchanged + /** Pointer to the block array allocated by XvMCCreateBlocks(). + The array has to be freed by XvMCDestroyBlocks(). + Each group of 64 values represents one data block of differential + pixel information (in MoCo mode) or coefficients for IDCT. + - application - set the pointer during initialization + - libavcodec - fills coefficients/pixel data into the array */ short* data_blocks; - /** Pointer to the macroblock description array allocated by XvMCCreateMacroBlocks(). - - application - set during initialization - - libavcodec - unchanged + /** Pointer to the macroblock description array allocated by + XvMCCreateMacroBlocks() and freed by XvMCDestroyMacroBlocks(). + - application - set the pointer during initialization + - libavcodec - fills description data into the array */ XvMCMacroBlock* mv_blocks; - /** Number of all MB descriptions that could be stored in the mv_blocks array. + /** Number of macroblock descriptions that can be stored in the mv_blocks + array. - application - set during initialization - libavcodec - unchanged */ - int total_number_of_mv_blocks; + int allocated_mv_blocks; - /** Number of all blocks that could be stored at once in the data_blocks array. + /** Number of blocks that can be stored at once in the data_blocks array. - application - set during initialization - libavcodec - unchanged */ - int total_number_of_data_blocks; + int allocated_data_blocks; - /** Indicates that the hardware would interpret data_blocks as IDCT coefficients - and perform IDCT on them. + /** Indicate that the hardware would interpret data_blocks as IDCT + coefficients and perform IDCT on them. - application - set during initialization - libavcodec - unchanged */ int idct; - /** In MoCo mode it indicates that Intra MB are assumed to be in unsigned format - Same as XVMC_INTRA_UNSIGNED flag. + /** In MoCo mode it indicates that intra macroblocks are assumed to be in + unsigned format; same as the XVMC_INTRA_UNSIGNED flag. - application - set during initialization - libavcodec - unchanged */ int unsigned_intra; /** Pointer to the surface allocated by XvMCCreateSurface(). - It identifies the frame on the video hardware and its state. + It has to be freed by XvMCDestroySurface() on application exit. + It identifies the frame and its state on the video hardware. - application - set during initialization - libavcodec - unchanged */ XvMCSurface* p_surface; -//}@ -/** Set by the decoder before calling draw_horiz_band(), +/** Set by the decoder before calling ff_draw_horiz_band(), needed by the XvMCRenderSurface function. */ //@{ /** Pointer to the surface used as past reference @@ -122,39 +133,42 @@ struct xvmc_pix_fmt { unsigned int flags; //}@ - /** Offset in the mv array for the current slice. - Macroblocks described before that offset are assumed to be already passed to the hardware. - - application - zeros it on get_buffer(). - A successful draw_horiz_band() may increment it + /** Number of macroblock descriptions in the mv_blocks array + that have already been passed to the hardware. + - application - zeroes it on get_buffer(). + A successful ff_draw_horiz_band() may increment it with filled_mb_block_num or zero both. - libavcodec - unchanged */ int start_mv_blocks_num; - /** Number of mv blocks that are filled by libavcodec and have to be passed to the hardware. - - application - zeros it on get_buffer() or after successful draw_horiz_band() + /** Number of new macroblock descriptions in the mv_blocks array (after + start_mv_blocks_num) that are filled by libavcodec and have to be + passed to the hardware. + - application - zeroes it on get_buffer() or after successful + ff_draw_horiz_band(). - libavcodec - increment with one of each stored MB */ int filled_mv_blocks_num; - /** Offset to the next free data block. The mv_blocks hold a number pointing to the data blocks. - - application - zeroes it on get_buffer() and after successful draw_horizx_band() - - libvcodec - each macroblock increases it with the number of coded blocks in it. + /** Number of the next free data block; one data block consists of + 64 short values in the data_blocks array. + All blocks before this one have already been claimed by placing their + position into the corresponding block description structure field, + that are part of the mv_blocks array. + - application - zeroes it on get_buffer(). + A successful ff_draw_horiz_band() may zero it together + with start_mb_blocks_num. + - libavcodec - each decoded macroblock increases it by the number + of coded blocks it contains. */ int next_free_data_block_num; - -/** extensions may be placed here */ -#if LIBAVCODEC_VERSION_MAJOR < 53 -//@{ - /** State - used to work around limitations in the MPlayer video system. - 0 - Surface is not used. - 1 - Surface is still held in application to be displayed or is still visible. - 2 - Surface is still held in libavcodec buffer for prediction. - */ - int state; - void* p_osd_target_surface_render; ///< pointer to the surface where the subpicture is rendered -//}@ -#endif }; +/** + * @} + */ + +#endif /* FF_API_XVMC */ + #endif /* AVCODEC_XVMC_H */