2 * This copyright notice applies to this header file only:
4 * Copyright (c) 2010-2016 NVIDIA Corporation
6 * Permission is hereby granted, free of charge, to any person
7 * obtaining a copy of this software and associated documentation
8 * files (the "Software"), to deal in the Software without
9 * restriction, including without limitation the rights to use,
10 * copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the software, and to permit persons to whom the
12 * software is furnished to do so, subject to the following
15 * The above copyright notice and this permission notice shall be
16 * included in all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
19 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
20 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
21 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
22 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
23 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
24 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25 * OTHER DEALINGS IN THE SOFTWARE.
30 * NvCuvid API provides Video Decoding interface to NVIDIA GPU devices.
32 * This file contains the interface constants, structure definitions and function prototypes.
35 #if !defined(__NVCUVID_H__)
38 #include "compat/cuda/dynlink_cuviddec.h"
40 #if defined(__cplusplus)
42 #endif /* __cplusplus */
44 ////////////////////////////////////////////////////////////////////////////////////////////////
46 // High-level helper APIs for video sources
49 typedef void *CUvideosource;
50 typedef void *CUvideoparser;
51 typedef long long CUvideotimestamp;
54 * \addtogroup VIDEO_PARSER Video Parser
59 * \enum cudaVideoState
63 cudaVideoState_Error = -1, /**< Error state (invalid source) */
64 cudaVideoState_Stopped = 0, /**< Source is stopped (or reached end-of-stream) */
65 cudaVideoState_Started = 1 /**< Source is running and delivering data */
69 * \enum cudaAudioCodec
73 cudaAudioCodec_MPEG1=0, /**< MPEG-1 Audio */
74 cudaAudioCodec_MPEG2, /**< MPEG-2 Audio */
75 cudaAudioCodec_MP3, /**< MPEG-1 Layer III Audio */
76 cudaAudioCodec_AC3, /**< Dolby Digital (AC3) Audio */
77 cudaAudioCodec_LPCM /**< PCM Audio */
81 * \struct CUVIDEOFORMAT
86 cudaVideoCodec codec; /**< Compression format */
88 * frame rate = numerator / denominator (for example: 30000/1001)
91 unsigned int numerator; /**< frame rate numerator (0 = unspecified or variable frame rate) */
92 unsigned int denominator; /**< frame rate denominator (0 = unspecified or variable frame rate) */
94 unsigned char progressive_sequence; /**< 0=interlaced, 1=progressive */
95 unsigned char bit_depth_luma_minus8; /**< high bit depth Luma */
96 unsigned char bit_depth_chroma_minus8; /**< high bit depth Chroma */
97 unsigned char reserved1; /**< Reserved for future use */
98 unsigned int coded_width; /**< coded frame width */
99 unsigned int coded_height; /**< coded frame height */
101 * area of the frame that should be displayed
103 * coded_width = 1920, coded_height = 1088
104 * display_area = { 0,0,1920,1080 }
107 int left; /**< left position of display rect */
108 int top; /**< top position of display rect */
109 int right; /**< right position of display rect */
110 int bottom; /**< bottom position of display rect */
112 cudaVideoChromaFormat chroma_format; /**< Chroma format */
113 unsigned int bitrate; /**< video bitrate (bps, 0=unknown) */
115 * Display Aspect Ratio = x:y (4:3, 16:9, etc)
120 } display_aspect_ratio;
122 * Video Signal Description
125 unsigned char video_format : 3;
126 unsigned char video_full_range_flag : 1;
127 unsigned char reserved_zero_bits : 4;
128 unsigned char color_primaries;
129 unsigned char transfer_characteristics;
130 unsigned char matrix_coefficients;
131 } video_signal_description;
132 unsigned int seqhdr_data_length; /**< Additional bytes following (CUVIDEOFORMATEX) */
136 * \struct CUVIDEOFORMATEX
137 * Video format including raw sequence header information
141 CUVIDEOFORMAT format;
142 unsigned char raw_seqhdr_data[1024];
146 * \struct CUAUDIOFORMAT
151 cudaAudioCodec codec; /**< Compression format */
152 unsigned int channels; /**< number of audio channels */
153 unsigned int samplespersec; /**< sampling frequency */
154 unsigned int bitrate; /**< For uncompressed, can also be used to determine bits per sample */
155 unsigned int reserved1; /**< Reserved for future use */
156 unsigned int reserved2; /**< Reserved for future use */
161 * \enum CUvideopacketflags
165 CUVID_PKT_ENDOFSTREAM = 0x01, /**< Set when this is the last packet for this stream */
166 CUVID_PKT_TIMESTAMP = 0x02, /**< Timestamp is valid */
167 CUVID_PKT_DISCONTINUITY = 0x04 /**< Set when a discontinuity has to be signalled */
168 } CUvideopacketflags;
171 * \struct CUVIDSOURCEDATAPACKET
174 typedef struct _CUVIDSOURCEDATAPACKET
176 tcu_ulong flags; /**< Combination of CUVID_PKT_XXX flags */
177 tcu_ulong payload_size; /**< number of bytes in the payload (may be zero if EOS flag is set) */
178 const unsigned char *payload; /**< Pointer to packet payload data (may be NULL if EOS flag is set) */
179 CUvideotimestamp timestamp; /**< Presentation timestamp (10MHz clock), only valid if CUVID_PKT_TIMESTAMP flag is set */
180 } CUVIDSOURCEDATAPACKET;
182 // Callback for packet delivery
183 typedef int (CUDAAPI *PFNVIDSOURCECALLBACK)(void *, CUVIDSOURCEDATAPACKET *);
186 * \struct CUVIDSOURCEPARAMS
189 typedef struct _CUVIDSOURCEPARAMS
191 unsigned int ulClockRate; /**< Timestamp units in Hz (0=default=10000000Hz) */
192 unsigned int uReserved1[7]; /**< Reserved for future use - set to zero */
193 void *pUserData; /**< Parameter passed in to the data handlers */
194 PFNVIDSOURCECALLBACK pfnVideoDataHandler; /**< Called to deliver audio packets */
195 PFNVIDSOURCECALLBACK pfnAudioDataHandler; /**< Called to deliver video packets */
196 void *pvReserved2[8]; /**< Reserved for future use - set to NULL */
200 * \enum CUvideosourceformat_flags
201 * CUvideosourceformat_flags
204 CUVID_FMT_EXTFORMATINFO = 0x100 /**< Return extended format structure (CUVIDEOFORMATEX) */
205 } CUvideosourceformat_flags;
207 #if !defined(__APPLE__)
209 * \fn CUresult CUDAAPI cuvidCreateVideoSource(CUvideosource *pObj, const char *pszFileName, CUVIDSOURCEPARAMS *pParams)
210 * Create Video Source
212 typedef CUresult CUDAAPI tcuvidCreateVideoSource(CUvideosource *pObj, const char *pszFileName, CUVIDSOURCEPARAMS *pParams);
215 * \fn CUresult CUDAAPI cuvidCreateVideoSourceW(CUvideosource *pObj, const wchar_t *pwszFileName, CUVIDSOURCEPARAMS *pParams)
216 * Create Video Source
218 typedef CUresult CUDAAPI tcuvidCreateVideoSourceW(CUvideosource *pObj, const wchar_t *pwszFileName, CUVIDSOURCEPARAMS *pParams);
221 * \fn CUresult CUDAAPI cuvidDestroyVideoSource(CUvideosource obj)
222 * Destroy Video Source
224 typedef CUresult CUDAAPI tcuvidDestroyVideoSource(CUvideosource obj);
227 * \fn CUresult CUDAAPI cuvidSetVideoSourceState(CUvideosource obj, cudaVideoState state)
228 * Set Video Source state
230 typedef CUresult CUDAAPI tcuvidSetVideoSourceState(CUvideosource obj, cudaVideoState state);
233 * \fn cudaVideoState CUDAAPI cuvidGetVideoSourceState(CUvideosource obj)
234 * Get Video Source state
236 typedef cudaVideoState CUDAAPI tcuvidGetVideoSourceState(CUvideosource obj);
239 * \fn CUresult CUDAAPI cuvidGetSourceVideoFormat(CUvideosource obj, CUVIDEOFORMAT *pvidfmt, unsigned int flags)
240 * Get Video Source Format
242 typedef CUresult CUDAAPI tcuvidGetSourceVideoFormat(CUvideosource obj, CUVIDEOFORMAT *pvidfmt, unsigned int flags);
245 * \fn CUresult CUDAAPI cuvidGetSourceAudioFormat(CUvideosource obj, CUAUDIOFORMAT *paudfmt, unsigned int flags)
246 * Set Video Source state
248 typedef CUresult CUDAAPI tcuvidGetSourceAudioFormat(CUvideosource obj, CUAUDIOFORMAT *paudfmt, unsigned int flags);
253 * \struct CUVIDPARSERDISPINFO
255 typedef struct _CUVIDPARSERDISPINFO
257 int picture_index; /**< */
258 int progressive_frame; /**< */
259 int top_field_first; /**< */
260 int repeat_first_field; /**< Number of additional fields (1=ivtc, 2=frame doubling, 4=frame tripling, -1=unpaired field) */
261 CUvideotimestamp timestamp; /**< */
262 } CUVIDPARSERDISPINFO;
266 // The parser will call these synchronously from within cuvidParseVideoData(), whenever a picture is ready to
267 // be decoded and/or displayed.
269 typedef int (CUDAAPI *PFNVIDSEQUENCECALLBACK)(void *, CUVIDEOFORMAT *);
270 typedef int (CUDAAPI *PFNVIDDECODECALLBACK)(void *, CUVIDPICPARAMS *);
271 typedef int (CUDAAPI *PFNVIDDISPLAYCALLBACK)(void *, CUVIDPARSERDISPINFO *);
274 * \struct CUVIDPARSERPARAMS
276 typedef struct _CUVIDPARSERPARAMS
278 cudaVideoCodec CodecType; /**< cudaVideoCodec_XXX */
279 unsigned int ulMaxNumDecodeSurfaces; /**< Max # of decode surfaces (parser will cycle through these) */
280 unsigned int ulClockRate; /**< Timestamp units in Hz (0=default=10000000Hz) */
281 unsigned int ulErrorThreshold; /**< % Error threshold (0-100) for calling pfnDecodePicture (100=always call pfnDecodePicture even if picture bitstream is fully corrupted) */
282 unsigned int ulMaxDisplayDelay; /**< Max display queue delay (improves pipelining of decode with display) - 0=no delay (recommended values: 2..4) */
283 unsigned int uReserved1[5]; /**< Reserved for future use - set to 0 */
284 void *pUserData; /**< User data for callbacks */
285 PFNVIDSEQUENCECALLBACK pfnSequenceCallback; /**< Called before decoding frames and/or whenever there is a format change */
286 PFNVIDDECODECALLBACK pfnDecodePicture; /**< Called when a picture is ready to be decoded (decode order) */
287 PFNVIDDISPLAYCALLBACK pfnDisplayPicture; /**< Called whenever a picture is ready to be displayed (display order) */
288 void *pvReserved2[7]; /**< Reserved for future use - set to NULL */
289 CUVIDEOFORMATEX *pExtVideoInfo; /**< [Optional] sequence header data from system layer */
293 * \fn CUresult CUDAAPI cuvidCreateVideoParser(CUvideoparser *pObj, CUVIDPARSERPARAMS *pParams)
295 typedef CUresult CUDAAPI tcuvidCreateVideoParser(CUvideoparser *pObj, CUVIDPARSERPARAMS *pParams);
298 * \fn CUresult CUDAAPI cuvidParseVideoData(CUvideoparser obj, CUVIDSOURCEDATAPACKET *pPacket)
300 typedef CUresult CUDAAPI tcuvidParseVideoData(CUvideoparser obj, CUVIDSOURCEDATAPACKET *pPacket);
303 * \fn CUresult CUDAAPI cuvidDestroyVideoParser(CUvideoparser obj)
305 typedef CUresult CUDAAPI tcuvidDestroyVideoParser(CUvideoparser obj);
307 /** @} */ /* END VIDEO_PARSER */
308 ////////////////////////////////////////////////////////////////////////////////////////////////
310 #if defined(__cplusplus)
312 #endif /* __cplusplus */
314 #endif // __NVCUVID_H__