/*

 * Copyright (C) 2003 Ivan Kalvachev

 *

 * This file is part of Libav.

 *

 * 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.

 *

 * 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 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 <X11/extensions/XvMC.h>

#include "avcodec.h"

/**

 * @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 {

    /** The field contains the special constant value AV_XVMC_ID.

        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().

        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() and freed by XvMCDestroyMacroBlocks().

        - application - set the pointer during initialization

        - libavcodec  - fills description data into the array

    */

    XvMCMacroBlock* mv_blocks;

    /** Number of macroblock descriptions that can be stored in the mv_blocks

        array.

        - application - set during initialization

        - libavcodec  - unchanged

    */

    int             allocated_mv_blocks;

    /** Number of blocks that can be stored at once in the data_blocks array.

        - application - set during initialization

        - libavcodec  - unchanged

    */

    int             allocated_data_blocks;

    /** 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 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 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 ff_draw_horiz_band(),

    needed by the XvMCRenderSurface function. */

//@{

    /** Pointer to the surface used as past reference

        - application - unchanged

        - libavcodec  - set

    */

    XvMCSurface*    p_past_surface;

    /** Pointer to the surface used as future reference

        - application - unchanged

        - libavcodec  - set

    */

    XvMCSurface*    p_future_surface;

    /** top/bottom field or frame

        - application - unchanged

        - libavcodec  - set

    */

    unsigned int    picture_structure;

    /** XVMC_SECOND_FIELD - 1st or 2nd field in the sequence

        - application - unchanged

        - libavcodec  - set

    */

    unsigned int    flags;

//}@

    /** 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 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;

    /** 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;

};

/**

 * @}

 */

#endif /* AVCODEC_XVMC_H */