FFmpeg
nvdec.h
Go to the documentation of this file.
1 /*
2  * HW decode acceleration through NVDEC
3  *
4  * Copyright (c) 2016 Anton Khirnov
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22 
23 #ifndef AVCODEC_NVDEC_H
24 #define AVCODEC_NVDEC_H
25 
27 
28 #include <stdint.h>
29 
30 #include "libavutil/buffer.h"
31 #include "libavutil/frame.h"
32 
33 #include "avcodec.h"
34 
35 #if defined(NVDECAPI_MAJOR_VERSION) && defined(NVDECAPI_MINOR_VERSION)
36 # define NVDECAPI_CHECK_VERSION(major, minor) \
37  ((major) < NVDECAPI_MAJOR_VERSION || ((major) == NVDECAPI_MAJOR_VERSION && (minor) <= NVDECAPI_MINOR_VERSION))
38 #else
39 /* version macros were added in SDK 8.1 ffnvcodec */
40 # define NVDECAPI_CHECK_VERSION(major, minor) \
41  ((major) < 8 || ((major) == 8 && (minor) <= 0))
42 #endif
43 
44 // SDK 13.0 compile time feature checks
45 #if NVDECAPI_CHECK_VERSION(13, 0)
46 #define NVDEC_HAVE_422_SUPPORT
47 #endif
48 
49 // SDK 13.1 compile time feature checks
50 #if NVDECAPI_CHECK_VERSION(13, 1)
51 #define NVDEC_HAVE_OPAQUE_OUTPUT_SUPPORT
52 #endif
53 
54 typedef struct NVDECFrame {
55  unsigned int idx;
56  unsigned int ref_idx;
57  unsigned int *idx_ref; ///< RefStruct reference
58  unsigned int *ref_idx_ref; ///< RefStruct reference
59  struct NVDECDecoder *decoder; ///< RefStruct reference
60 } NVDECFrame;
61 
62 typedef struct NVDECContext {
63  CUVIDPICPARAMS pic_params;
64 
66 
67  struct NVDECDecoder *decoder; ///< RefStruct reference
68 
69  const uint8_t *bitstream;
71  unsigned int bitstream_allocated;
73 
74  unsigned *slice_offsets;
75  int nb_slices;
77 
79 } NVDECContext;
80 
84 int ff_nvdec_start_frame_sep_ref(AVCodecContext *avctx, AVFrame *frame, int has_sep_ref);
87 int ff_nvdec_simple_decode_slice(AVCodecContext *avctx, const uint8_t *buffer,
88  uint32_t size);
90  AVBufferRef *hw_frames_ctx,
91  enum AVPixelFormat hw_format,
92  int dpb_size,
93  int supports_444);
95 
96 #ifdef NVDEC_HAVE_OPAQUE_OUTPUT_SUPPORT
97 void ff_nvdec_fill_cuarray_desc(CUDA_ARRAY3D_DESCRIPTOR *desc,
98  AVCodecContext *avctx,
99  cudaVideoSurfaceFormat output_format);
100 #endif
101 
102 #endif /* AVCODEC_NVDEC_H */
AVPixelFormat
AVPixelFormat
Pixel format.
Definition: pixfmt.h:71
ff_nvdec_decode_uninit
int ff_nvdec_decode_uninit(AVCodecContext *avctx)
Definition: nvdec.c:297
ff_nvdec_start_frame
int ff_nvdec_start_frame(AVCodecContext *avctx, AVFrame *frame)
Definition: nvdec.c:946
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:472
NVDECContext::decoder
struct NVDECDecoder * decoder
RefStruct reference.
Definition: nvdec.h:67
NVDECContext::bitstream_len
int bitstream_len
Definition: nvdec.h:70
ff_nvdec_simple_end_frame
int ff_nvdec_simple_end_frame(AVCodecContext *avctx)
Definition: nvdec.c:1051
NVDECContext::pic_params
CUVIDPICPARAMS pic_params
Definition: nvdec.h:63
NVDECFrame::idx_ref
unsigned int * idx_ref
RefStruct reference.
Definition: nvdec.h:57
ff_nvdec_get_ref_idx
int ff_nvdec_get_ref_idx(AVFrame *frame)
Definition: nvdec.c:1180
NVDECFrame::ref_idx
unsigned int ref_idx
Definition: nvdec.h:56
NVDECContext::bitstream
const uint8_t * bitstream
Definition: nvdec.h:69
NVDECContext::nb_slices
int nb_slices
Definition: nvdec.h:75
NVDECFrame
Definition: nvdec.h:54
AVRefStructPool
AVRefStructPool is an API for a thread-safe pool of objects managed via the RefStruct API.
Definition: refstruct.c:183
dpb_size
int dpb_size
Definition: h264_levels.c:111
NVDECContext::bitstream_allocated
unsigned int bitstream_allocated
Definition: nvdec.h:71
NVDECContext::decoder_pool
struct AVRefStructPool * decoder_pool
Definition: nvdec.h:65
ff_nvdec_frame_params
int ff_nvdec_frame_params(AVCodecContext *avctx, AVBufferRef *hw_frames_ctx, enum AVPixelFormat hw_format, int dpb_size, int supports_444)
Definition: nvdec.c:1083
NVDECFrame::ref_idx_ref
unsigned int * ref_idx_ref
RefStruct reference.
Definition: nvdec.h:58
NVDECFrame::idx
unsigned int idx
Definition: nvdec.h:55
size
int size
Definition: twinvq_data.h:10344
frame.h
buffer.h
NVDECContext::slice_offsets
unsigned * slice_offsets
Definition: nvdec.h:74
NVDECFrame::decoder
struct NVDECDecoder * decoder
RefStruct reference.
Definition: nvdec.h:59
ff_nvdec_decode_init
int ff_nvdec_decode_init(AVCodecContext *avctx)
Definition: nvdec.c:404
NVDECDecoder
Definition: nvdec.c:49
NVDECContext::supports_444
int supports_444
Definition: nvdec.h:78
ff_nvdec_start_frame_sep_ref
int ff_nvdec_start_frame_sep_ref(AVCodecContext *avctx, AVFrame *frame, int has_sep_ref)
Definition: nvdec.c:984
avcodec.h
ff_nvdec_end_frame
int ff_nvdec_end_frame(AVCodecContext *avctx)
Definition: nvdec.c:1014
ff_nvdec_simple_decode_slice
int ff_nvdec_simple_decode_slice(AVCodecContext *avctx, const uint8_t *buffer, uint32_t size)
Definition: nvdec.c:1061
frame
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several the filter must be ready for frames arriving randomly on any input any filter with several inputs will most likely require some kind of queuing mechanism It is perfectly acceptable to have a limited queue and to drop frames when the inputs are too unbalanced request_frame For filters that do not use the this method is called when a frame is wanted on an output For a it should directly call filter_frame on the corresponding output For a if there are queued frames already one of these frames should be pushed If the filter should request a frame on one of its repeatedly until at least one frame has been pushed Return or at least make progress towards producing a frame
Definition: filter_design.txt:265
AVCodecContext
main external API structure.
Definition: avcodec.h:443
buffer
the frame and frame reference mechanism is intended to as much as expensive copies of that data while still allowing the filters to produce correct results The data is stored in buffers represented by AVFrame structures Several references can point to the same frame buffer
Definition: filter_design.txt:49
output_format
static char * output_format
Definition: ffprobe.c:145
desc
const char * desc
Definition: libsvtav1.c:83
AVBufferRef
A reference to a data buffer.
Definition: buffer.h:82
NVDECContext::bitstream_internal
uint8_t * bitstream_internal
Definition: nvdec.h:72
NVDECContext::slice_offsets_allocated
unsigned int slice_offsets_allocated
Definition: nvdec.h:76
NVDECContext
Definition: nvdec.h:62