qsv: document AVQSVContext members
[ffmpeg.git] / libavcodec / qsv.h
1 /*
2  * Intel MediaSDK QSV public API
3  *
4  * This file is part of Libav.
5  *
6  * Libav is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * Libav is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with Libav; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 #ifndef AVCODEC_QSV_H
22 #define AVCODEC_QSV_H
23
24 #include <mfx/mfxvideo.h>
25
26 /**
27  * This struct is used for communicating QSV parameters between libavcodec and
28  * the caller. It is managed by the caller and must be assigned to
29  * AVCodecContext.hwaccel_context.
30  * - decoding: hwaccel_context must be set on return from the get_format()
31  *             callback
32  * - encoding: hwaccel_context must be set before avcodec_open2()
33  */
34 typedef struct AVQSVContext {
35     /**
36      * If non-NULL, the session to use for encoding or decoding.
37      * Otherwise, libavcodec will try to create an internal session.
38      */
39     mfxSession session;
40
41     /**
42      * The IO pattern to use.
43      */
44     int iopattern;
45
46     /**
47      * Extra buffers to pass to encoder or decoder initialization.
48      */
49     mfxExtBuffer **ext_buffers;
50     int         nb_ext_buffers;
51 } AVQSVContext;
52
53 /**
54  * Allocate a new context.
55  *
56  * It must be freed by the caller with av_free().
57  */
58 AVQSVContext *av_qsv_alloc_context(void);
59
60 #endif /* AVCODEC_QSV_H */