File size: 16,964 Bytes
ea55f45
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
/*

 * This copyright notice applies to this header file only:

 *

 * Copyright (c) 2010-2024 NVIDIA Corporation

 *

 * Permission is hereby granted, free of charge, to any person

 * obtaining a copy of this software and associated documentation

 * files (the "Software"), to deal in the Software without

 * restriction, including without limitation the rights to use,

 * copy, modify, merge, publish, distribute, sublicense, and/or sell

 * copies of the software, and to permit persons to whom the

 * software is furnished to do so, subject to the following

 * conditions:

 *

 * The above copyright notice and this permission notice shall be

 * included in all copies or substantial portions of the Software.

 *

 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES

 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,

 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR

 * OTHER DEALINGS IN THE SOFTWARE.

 */

#pragma once

#include <assert.h>
#include <stdint.h>
#include <mutex>
#include <vector>
#include <string>
#include <iostream>
#include <sstream>
#include <string.h>
#include "../../../Interface/nvcuvid.h"
#include "../Utils/NvCodecUtils.h"
#include <map>

#define MAX_FRM_CNT 32

typedef enum{
    SEI_TYPE_TIME_CODE_H264 = 1,
    SEI_TYPE_USER_DATA_REGISTERED = 4,
    SEI_TYPE_USER_DATA_UNREGISTERED = 5,
    SEI_TYPE_TIME_CODE = 136,
    SEI_TYPE_MASTERING_DISPLAY_COLOR_VOLUME = 137,
    SEI_TYPE_CONTENT_LIGHT_LEVEL_INFO = 144,
    SEI_TYPE_ALTERNATIVE_TRANSFER_CHARACTERISTICS = 147
} SEI_H264_HEVC_MPEG2_PAYLOAD_TYPE;

/**

* @brief Exception class for error reporting from the decode API.

*/
class NVDECException : public std::exception
{
public:
    NVDECException(const std::string& errorStr, const CUresult errorCode)
        : m_errorString(errorStr), m_errorCode(errorCode) {}

    virtual ~NVDECException() throw() {}
    virtual const char* what() const throw() { return m_errorString.c_str(); }
    CUresult  getErrorCode() const { return m_errorCode; }
    const std::string& getErrorString() const { return m_errorString; }
    static NVDECException makeNVDECException(const std::string& errorStr, const CUresult errorCode,

        const std::string& functionName, const std::string& fileName, int lineNo);
private:
    std::string m_errorString;
    CUresult m_errorCode;
};

inline NVDECException NVDECException::makeNVDECException(const std::string& errorStr, const CUresult errorCode, const std::string& functionName,

    const std::string& fileName, int lineNo)
{
    std::ostringstream errorLog;
    errorLog << functionName << " : " << errorStr << " at " << fileName << ":" << lineNo << std::endl;
    NVDECException exception(errorLog.str(), errorCode);
    return exception;
}

#define NVDEC_THROW_ERROR( errorStr, errorCode )                                                         \
    do                                                                                                   \
    {                                                                                                    \
        throw NVDECException::makeNVDECException(errorStr, errorCode, __FUNCTION__, __FILE__, __LINE__); \
    } while (0)


#define NVDEC_API_CALL( cuvidAPI )                                                                                 \
    do                                                                                                             \
    {                                                                                                              \
        CUresult errorCode = cuvidAPI;                                                                             \
        if( errorCode != CUDA_SUCCESS)                                                                             \
        {                                                                                                          \
            std::ostringstream errorLog;                                                                           \
            errorLog << #cuvidAPI << " returned error " << errorCode;                                              \
            throw NVDECException::makeNVDECException(errorLog.str(), errorCode, __FUNCTION__, __FILE__, __LINE__); \
        }                                                                                                          \
    } while (0)

struct Rect {
    int l, t, r, b;
};

struct Dim {
    int w, h;
};

/**

* @brief Base class for decoder interface.

*/
class NvDecoder {

public:
    /**

    *  @brief This function is used to initialize the decoder session.

    *  Application must call this function to initialize the decoder, before

    *  starting to decode any frames.

    */
    NvDecoder(CUcontext cuContext, bool bUseDeviceFrame, cudaVideoCodec eCodec, bool bLowLatency = false,
              bool bDeviceFramePitched = false, const Rect *pCropRect = NULL, const Dim *pResizeDim = NULL,
              bool extract_user_SEI_Message = false, int maxWidth = 0, int maxHeight = 0, unsigned int clkRate = 1000,
              bool force_zero_latency = false, unsigned int initial_dec_surfaces = 0, CUstream custream=NULL);
    ~NvDecoder();

    /**

    *  @brief  This function is used to get the current CUDA context.

    */
    CUcontext GetContext() { return m_cuContext; }

    /**

    *  @brief  This function is used to get the output frame width.

    *  NV12/P016/NV16/P216 output format width is 2 byte aligned because of U and V interleave

    */
    int GetWidth() { assert(m_nWidth); return (m_eOutputFormat == cudaVideoSurfaceFormat_NV12 || m_eOutputFormat == cudaVideoSurfaceFormat_P016
                                               || m_eOutputFormat == cudaVideoSurfaceFormat_NV16 || m_eOutputFormat == cudaVideoSurfaceFormat_P216) 
                                                ? (m_nWidth + 1) & ~1 : m_nWidth; }

    /**

    *  @brief  This function is used to get the actual decode width

    */
    int GetDecodeWidth() { assert(m_nWidth); return m_nWidth; }

    /**

    *  @brief  This function is used to get the output frame height (Luma height).

    */
    int GetHeight() { assert(m_nLumaHeight); return m_nLumaHeight; }

    /**

    *  @brief  This function is used to get the current chroma height.

    */
    int GetChromaHeight() { assert(m_nChromaHeight); return m_nChromaHeight; }

    /**

    *  @brief  This function is used to get the number of chroma planes.

    */
    int GetNumChromaPlanes() { assert(m_nNumChromaPlanes); return m_nNumChromaPlanes; }
    
    /**

    *   @brief  This function is used to get the current frame size based on pixel format.

    */
    int GetFrameSize() { assert(m_nWidth); return GetWidth() * (m_nLumaHeight + (m_nChromaHeight * m_nNumChromaPlanes)) * m_nBPP; }

    /**

    *   @brief  This function is used to get the current frame Luma plane size.

    */
    int GetLumaPlaneSize() { assert(m_nWidth); return GetWidth() * m_nLumaHeight * m_nBPP; }

    /**

    *   @brief  This function is used to get the current frame chroma plane size.

    */
    int GetChromaPlaneSize() { assert(m_nWidth); return GetWidth() *  (m_nChromaHeight * m_nNumChromaPlanes) * m_nBPP; }

    /**

    *  @brief  This function is used to get the pitch of the device buffer holding the decoded frame.

    */
    int GetDeviceFramePitch() { assert(m_nWidth); return m_nDeviceFramePitch ? (int)m_nDeviceFramePitch : GetWidth() * m_nBPP; }

    /**

    *   @brief  This function is used to get the bit depth associated with the pixel format.

    */
    int GetBitDepth() { assert(m_nWidth); return m_nBitDepthMinus8 + 8; }

    /**

    *   @brief  This function is used to get the bytes used per pixel.

    */
    int GetBPP() { assert(m_nWidth); return m_nBPP; }

    /**

    *   @brief  This function is used to get the YUV chroma format

    */
    cudaVideoSurfaceFormat GetOutputFormat() { return m_eOutputFormat; }

    /**

    *   @brief This function is used to get the output surface chroma format

    */
    cudaVideoChromaFormat GetOutputChromaFormat() { return GetChromaFormat(m_eOutputFormat); }
    
    /**

    *   @brief  This function is used to get information about the video stream (codec, display parameters etc)

    */
    CUVIDEOFORMAT GetVideoFormatInfo() { assert(m_nWidth); return m_videoFormat; }

    /**

    *   @brief This function is used to get the chroma format from surface format

    */
    cudaVideoChromaFormat GetChromaFormat(cudaVideoSurfaceFormat);

    /**

    *   @brief  This function is used to get codec string from codec id

    */
    const char *GetCodecString(cudaVideoCodec eCodec);

    /**

    *   @brief  This function is used to print information about the video stream

    */
    std::string GetVideoInfo() const { return m_videoInfo.str(); }

    /**

    *   @brief  This function decodes a frame and returns the number of frames that are available for

    *   display. All frames that are available for display should be read before making a subsequent decode call.

    *   @param  pData - pointer to the data buffer that is to be decoded

    *   @param  nSize - size of the data buffer in bytes

    *   @param  nFlags - CUvideopacketflags for setting decode options

    *   @param  nTimestamp - presentation timestamp

    */
    int Decode(const uint8_t *pData, int nSize, int nFlags = 0, int64_t nTimestamp = 0);

    /**

    *   @brief  This function returns a decoded frame and timestamp. This function should be called in a loop for

    *   fetching all the frames that are available for display.

    */
    uint8_t* GetFrame(int64_t* pTimestamp = nullptr);


    /**

    *   @brief  This function decodes a frame and returns the locked frame buffers

    *   This makes the buffers available for use by the application without the buffers

    *   getting overwritten, even if subsequent decode calls are made. The frame buffers

    *   remain locked, until UnlockFrame() is called

    */
    uint8_t* GetLockedFrame(int64_t* pTimestamp = nullptr);

    /**

    *   @brief  This function unlocks the frame buffer and makes the frame buffers available for write again

    *   @param  ppFrame - pointer to array of frames that are to be unlocked	

    *   @param  nFrame - number of frames to be unlocked

    */
    void UnlockFrame(uint8_t **pFrame);

    /**

    *   @brief  This function allows app to set decoder reconfig params

    *   @param  pCropRect - cropping rectangle coordinates

    *   @param  pResizeDim - width and height of resized output

    */
    int setReconfigParams(const Rect * pCropRect, const Dim * pResizeDim);

    /**

    *   @brief  This function allows app to set operating point for AV1 SVC clips

    *   @param  opPoint - operating point of an AV1 scalable bitstream

    *   @param  bDispAllLayers - Output all decoded frames of an AV1 scalable bitstream

    */
    void SetOperatingPoint(const uint32_t opPoint, const bool bDispAllLayers) { m_nOperatingPoint = opPoint; m_bDispAllLayers = bDispAllLayers; }

    // start a timer
    void   startTimer() { m_stDecode_time.Start(); }

    // stop the timer
    double stopTimer() { return m_stDecode_time.Stop(); }


protected:
    /**

    *   @brief  This function gets called when a sequence is ready to be decoded. The function also gets called

        when there is format change

    */
    virtual int HandleVideoSequence(CUVIDEOFORMAT *pVideoFormat);


private:
    /**

    *   @brief  Callback function to be registered for getting a callback when decoding of sequence starts

    */
    static int CUDAAPI HandleVideoSequenceProc(void *pUserData, CUVIDEOFORMAT *pVideoFormat) { return ((NvDecoder *)pUserData)->HandleVideoSequence(pVideoFormat); }

    /**

    *   @brief  Callback function to be registered for getting a callback when a decoded frame is ready to be decoded

    */
    static int CUDAAPI HandlePictureDecodeProc(void *pUserData, CUVIDPICPARAMS *pPicParams) { return ((NvDecoder *)pUserData)->HandlePictureDecode(pPicParams); }

    /**

    *   @brief  Callback function to be registered for getting a callback when a decoded frame is available for display

    */
    static int CUDAAPI HandlePictureDisplayProc(void *pUserData, CUVIDPARSERDISPINFO *pDispInfo) { return ((NvDecoder *)pUserData)->HandlePictureDisplay(pDispInfo); }

    /**

    *   @brief  Callback function to be registered for getting a callback to get operating point when AV1 SVC sequence header start.

    */
    static int CUDAAPI HandleOperatingPointProc(void *pUserData, CUVIDOPERATINGPOINTINFO *pOPInfo) { return ((NvDecoder *)pUserData)->GetOperatingPoint(pOPInfo); }

    /**

    *   @brief  Callback function to be registered for getting a callback when all the unregistered user SEI Messages are parsed for a frame.

    */
    static int CUDAAPI HandleSEIMessagesProc(void *pUserData, CUVIDSEIMESSAGEINFO *pSEIMessageInfo) { return ((NvDecoder *)pUserData)->GetSEIMessage(pSEIMessageInfo); } 

    /**

    *   @brief  This function gets called when a picture is ready to be decoded. cuvidDecodePicture is called from this function

    *   to decode the picture

    */
    int HandlePictureDecode(CUVIDPICPARAMS *pPicParams);

    /**

    *   @brief  This function gets called after a picture is decoded and available for display. Frames are fetched and stored in 

        internal buffer

    */
    int HandlePictureDisplay(CUVIDPARSERDISPINFO *pDispInfo);

    /**

    *   @brief  This function gets called when AV1 sequence encounter more than one operating points

    */
    int GetOperatingPoint(CUVIDOPERATINGPOINTINFO *pOPInfo);

    /**

    *   @brief  This function gets called when all unregistered user SEI messages are parsed for a frame

    */
    int GetSEIMessage(CUVIDSEIMESSAGEINFO *pSEIMessageInfo);
 
    /**

    *   @brief  This function reconfigure decoder if there is a change in sequence params.

    */
    int ReconfigureDecoder(CUVIDEOFORMAT *pVideoFormat);

private:
    CUcontext m_cuContext = NULL;
    CUvideoctxlock m_ctxLock;
    CUvideoparser m_hParser = NULL;
    CUvideodecoder m_hDecoder = NULL;
    bool m_bUseDeviceFrame;
    // dimension of the output
    unsigned int m_nWidth = 0, m_nLumaHeight = 0, m_nChromaHeight = 0;
    unsigned int m_nNumChromaPlanes = 0;
    // height of the mapped surface 
    int m_nSurfaceHeight = 0;
    int m_nSurfaceWidth = 0;
    cudaVideoCodec m_eCodec = cudaVideoCodec_NumCodecs;
    cudaVideoChromaFormat m_eChromaFormat = cudaVideoChromaFormat_420;
    cudaVideoSurfaceFormat m_eOutputFormat = cudaVideoSurfaceFormat_NV12;
    int m_nBitDepthMinus8 = 0;
    int m_nBPP = 1;
    CUVIDEOFORMAT m_videoFormat = {};
    Rect m_displayRect = {};
    // stock of frames
    std::vector<uint8_t *> m_vpFrame;
    // timestamps of decoded frames
    std::vector<int64_t> m_vTimestamp;
    int m_nDecodedFrame = 0, m_nDecodedFrameReturned = 0;
    int m_nDecodePicCnt = 0, m_nPicNumInDecodeOrder[MAX_FRM_CNT];
    CUVIDSEIMESSAGEINFO *m_pCurrSEIMessage = NULL;
    CUVIDSEIMESSAGEINFO m_SEIMessagesDisplayOrder[MAX_FRM_CNT][2];
    FILE *m_fpSEI = NULL;
    bool m_bEndDecodeDone = false;
    std::mutex m_mtxVPFrame;
    int m_nFrameAlloc = 0;
    CUstream m_cuvidStream = 0;
    bool m_bExternalStream = 0;
    bool m_bDeviceFramePitched = false;
    size_t m_nDeviceFramePitch = 0;
    Rect m_cropRect = {};
    Dim m_resizeDim = {};

    std::ostringstream m_videoInfo;
    unsigned int m_nMaxWidth = 0, m_nMaxHeight = 0;
    bool m_bReconfigExternal = false;
    bool m_bReconfigExtPPChange = false;
    bool m_bNumSurfacesChange = false;
    StopWatch m_stDecode_time;

    unsigned int m_nOperatingPoint = 0;
    bool  m_bDispAllLayers = false;
    // In H.264, there is an inherent display latency for video contents
    // which do not have num_reorder_frames=0 in the VUI. This applies to
    // All-Intra and IPPP sequences as well. If the user wants zero display
    // latency for All-Intra and IPPP sequences, the below flag will enable
    // the display callback immediately after the decode callback.
    bool m_bForce_zero_latency = false;
    bool m_bExtractSEIMessage = false;

    // Memory optimization : Allocate less number of decode surfaces,
    // increase the surfaces through ReconfigureDecoder api if needed
    bool m_bMemoryOptimize = false;
    int m_nNumDecSurfaces = 0;
};