xref: /third_party/ffmpeg/libavcodec/vaapi.h (revision cabdff1a)
1/*
2 * Video Acceleration API (shared data between FFmpeg and the video player)
3 * HW decode acceleration for MPEG-2, MPEG-4, H.264 and VC-1
4 *
5 * Copyright (C) 2008-2009 Splitted-Desktop Systems
6 *
7 * This file is part of FFmpeg.
8 *
9 * FFmpeg is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
13 *
14 * FFmpeg is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17 * Lesser General Public License for more details.
18 *
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with FFmpeg; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 */
23
24#ifndef AVCODEC_VAAPI_H
25#define AVCODEC_VAAPI_H
26
27/**
28 * @file
29 * @ingroup lavc_codec_hwaccel_vaapi
30 * Public libavcodec VA API header.
31 */
32
33#include <stdint.h>
34#include "libavutil/attributes.h"
35#include "version.h"
36
37#if FF_API_STRUCT_VAAPI_CONTEXT
38
39/**
40 * @defgroup lavc_codec_hwaccel_vaapi VA API Decoding
41 * @ingroup lavc_codec_hwaccel
42 * @{
43 */
44
45/**
46 * This structure is used to share data between the FFmpeg library and
47 * the client video application.
48 * This shall be zero-allocated and available as
49 * AVCodecContext.hwaccel_context. All user members can be set once
50 * during initialization or through each AVCodecContext.get_buffer()
51 * function call. In any case, they must be valid prior to calling
52 * decoding functions.
53 *
54 * Deprecated: use AVCodecContext.hw_frames_ctx instead.
55 */
56struct attribute_deprecated vaapi_context {
57    /**
58     * Window system dependent data
59     *
60     * - encoding: unused
61     * - decoding: Set by user
62     */
63    void *display;
64
65    /**
66     * Configuration ID
67     *
68     * - encoding: unused
69     * - decoding: Set by user
70     */
71    uint32_t config_id;
72
73    /**
74     * Context ID (video decode pipeline)
75     *
76     * - encoding: unused
77     * - decoding: Set by user
78     */
79    uint32_t context_id;
80};
81
82/* @} */
83
84#endif /* FF_API_STRUCT_VAAPI_CONTEXT */
85
86#endif /* AVCODEC_VAAPI_H */
87