21#include <freerdp/config.h>
23#include <winpr/winpr.h>
24#include <winpr/library.h>
25#include <winpr/assert.h>
26#include <winpr/cast.h>
28#include <freerdp/log.h>
29#include <freerdp/codec/h264.h>
31#include <wels/codec_def.h>
32#include <wels/codec_api.h>
33#include <wels/codec_ver.h>
37typedef void (*pWelsGetCodecVersionEx)(OpenH264Version* pVersion);
39typedef long (*pWelsCreateDecoder)(ISVCDecoder** ppDecoder);
40typedef void (*pWelsDestroyDecoder)(ISVCDecoder* pDecoder);
42typedef int (*pWelsCreateSVCEncoder)(ISVCEncoder** ppEncoder);
43typedef void (*pWelsDestroySVCEncoder)(ISVCEncoder* pEncoder);
47#if defined(WITH_OPENH264_LOADING)
49 OpenH264Version version;
51 pWelsGetCodecVersionEx WelsGetCodecVersionEx;
52 WINPR_ATTR_NODISCARD pWelsCreateDecoder WelsCreateDecoder;
53 pWelsDestroyDecoder WelsDestroyDecoder;
54 WINPR_ATTR_NODISCARD pWelsCreateSVCEncoder WelsCreateSVCEncoder;
55 pWelsDestroySVCEncoder WelsDestroySVCEncoder;
56 ISVCDecoder* pDecoder;
57 ISVCEncoder* pEncoder;
58 SEncParamExt EncParamExt;
59} H264_CONTEXT_OPENH264;
61#if defined(WITH_OPENH264_LOADING)
62static const char* openh264_library_names[] = {
65#elif defined(__APPLE__)
68 "libopenh264.so.7",
"libopenh264.so.2.5.0",
"libopenh264.so.2.4.1",
"libopenh264.so.2.4.0",
69 "libopenh264.so.2.3.1",
"libopenh264.so.2.3.0",
"libopenh264.so",
75static void openh264_trace_callback(
void* ctx,
int level,
const char* message)
77 H264_CONTEXT* h264 = ctx;
79 WLog_Print(h264->log, WLOG_TRACE,
"%d - %s", level, message);
82static int openh264_decompress(H264_CONTEXT* WINPR_RESTRICT h264,
83 const BYTE* WINPR_RESTRICT pSrcData, UINT32 SrcSize)
85 DECODING_STATE state = dsInvalidArgument;
86 SBufferInfo sBufferInfo = WINPR_C_ARRAY_INIT;
87 SSysMEMBuffer* pSystemBuffer =
nullptr;
88 H264_CONTEXT_OPENH264* sys =
nullptr;
89 UINT32* iStride =
nullptr;
90 BYTE** pYUVData =
nullptr;
93 WINPR_ASSERT(pSrcData || (SrcSize == 0));
95 sys = (H264_CONTEXT_OPENH264*)h264->pSystemData;
98 iStride = h264->iStride;
99 WINPR_ASSERT(iStride);
101 pYUVData = h264->pYUVData;
102 WINPR_ASSERT(pYUVData);
110 pYUVData[0] =
nullptr;
111 pYUVData[1] =
nullptr;
112 pYUVData[2] =
nullptr;
114 WINPR_ASSERT(sys->pDecoder);
115 state = (*sys->pDecoder)
116 ->DecodeFrame2(sys->pDecoder, pSrcData, WINPR_ASSERTING_INT_CAST(
int, SrcSize),
117 pYUVData, &sBufferInfo);
119 if (sBufferInfo.iBufferStatus != 1)
121 if (state == dsNoParamSets)
125 (*sys->pDecoder)->DecodeFrame2(sys->pDecoder,
nullptr, 0, pYUVData, &sBufferInfo);
127 else if (state == dsErrorFree)
131 (*sys->pDecoder)->DecodeFrame2(sys->pDecoder,
nullptr, 0, pYUVData, &sBufferInfo);
135 WLog_Print(h264->log, WLOG_WARN,
"DecodeFrame2 state: 0x%04X iBufferStatus: %d", state,
136 sBufferInfo.iBufferStatus);
141 if (state != dsErrorFree)
143 WLog_Print(h264->log, WLOG_WARN,
"DecodeFrame2 state: 0x%02X", state);
147#if OPENH264_MAJOR >= 2
148 state = (*sys->pDecoder)->FlushFrame(sys->pDecoder, pYUVData, &sBufferInfo);
149 if (state != dsErrorFree)
151 WLog_Print(h264->log, WLOG_WARN,
"FlushFrame state: 0x%02X", state);
156 pSystemBuffer = &sBufferInfo.UsrData.sSystemBuffer;
157 iStride[0] = WINPR_ASSERTING_INT_CAST(uint32_t, pSystemBuffer->iStride[0]);
158 iStride[1] = WINPR_ASSERTING_INT_CAST(uint32_t, pSystemBuffer->iStride[1]);
159 iStride[2] = WINPR_ASSERTING_INT_CAST(uint32_t, pSystemBuffer->iStride[1]);
161 if (sBufferInfo.iBufferStatus != 1)
163 WLog_Print(h264->log, WLOG_WARN,
"DecodeFrame2 iBufferStatus: %d",
164 sBufferInfo.iBufferStatus);
168 if (state != dsErrorFree)
170 WLog_Print(h264->log, WLOG_WARN,
"DecodeFrame2 state: 0x%02X", state);
174 if (pSystemBuffer->iFormat != videoFormatI420)
177 if (!pYUVData[0] || !pYUVData[1] || !pYUVData[2])
183static int openh264_compress(H264_CONTEXT* WINPR_RESTRICT h264,
184 const BYTE** WINPR_RESTRICT pYUVData,
185 const UINT32* WINPR_RESTRICT iStride, BYTE** WINPR_RESTRICT ppDstData,
186 UINT32* WINPR_RESTRICT pDstSize)
189 SFrameBSInfo info = WINPR_C_ARRAY_INIT;
190 SSourcePicture pic = WINPR_C_ARRAY_INIT;
192 H264_CONTEXT_OPENH264* sys =
nullptr;
195 WINPR_ASSERT(pYUVData);
196 WINPR_ASSERT(iStride);
197 WINPR_ASSERT(ppDstData);
198 WINPR_ASSERT(pDstSize);
200 sys = &((H264_CONTEXT_OPENH264*)h264->pSystemData)[0];
206 if (!pYUVData[0] || !pYUVData[1] || !pYUVData[2])
209 if ((h264->width > INT_MAX) || (h264->height > INT_MAX))
212 if ((h264->FrameRate > INT_MAX) || (h264->NumberOfThreads > INT_MAX) ||
213 (h264->BitRate > INT_MAX) || (h264->QP > INT_MAX))
216 WINPR_ASSERT(sys->pEncoder);
217 if ((sys->EncParamExt.iPicWidth != (
int)h264->width) ||
218 (sys->EncParamExt.iPicHeight != (
int)h264->height))
220 WINPR_ASSERT((*sys->pEncoder)->GetDefaultParams);
221 status = (*sys->pEncoder)->GetDefaultParams(sys->pEncoder, &sys->EncParamExt);
225 WLog_Print(h264->log, WLOG_ERROR,
226 "Failed to get OpenH264 default parameters (status=%d)", status);
230 EUsageType usageType = SCREEN_CONTENT_REAL_TIME;
232 switch (h264->UsageType)
234 case H264_CAMERA_VIDEO_NON_REAL_TIME:
235 usageType = CAMERA_VIDEO_NON_REAL_TIME;
237 case H264_CAMERA_VIDEO_REAL_TIME:
238 usageType = CAMERA_VIDEO_REAL_TIME;
240 case H264_SCREEN_CONTENT_NON_REAL_TIME:
241 usageType = SCREEN_CONTENT_NON_REAL_TIME;
243 case H264_SCREEN_CONTENT_REAL_TIME:
248 sys->EncParamExt.iUsageType = usageType;
249 sys->EncParamExt.iPicWidth = WINPR_ASSERTING_INT_CAST(
int, h264->width);
250 sys->EncParamExt.iPicHeight = WINPR_ASSERTING_INT_CAST(
int, h264->height);
251 sys->EncParamExt.fMaxFrameRate = WINPR_ASSERTING_INT_CAST(
short, h264->FrameRate);
252 sys->EncParamExt.iMaxBitrate = UNSPECIFIED_BIT_RATE;
253 sys->EncParamExt.bEnableDenoise = 0;
254 sys->EncParamExt.bEnableLongTermReference = 0;
255 sys->EncParamExt.iSpatialLayerNum = 1;
256 sys->EncParamExt.iMultipleThreadIdc =
257 WINPR_ASSERTING_INT_CAST(
unsigned short, h264->NumberOfThreads);
258 sys->EncParamExt.sSpatialLayers[0].fFrameRate =
259 WINPR_ASSERTING_INT_CAST(
short, h264->FrameRate);
260 sys->EncParamExt.sSpatialLayers[0].iVideoWidth = sys->EncParamExt.iPicWidth;
261 sys->EncParamExt.sSpatialLayers[0].iVideoHeight = sys->EncParamExt.iPicHeight;
262 sys->EncParamExt.sSpatialLayers[0].iMaxSpatialBitrate = sys->EncParamExt.iMaxBitrate;
264 switch (h264->RateControlMode)
266 case H264_RATECONTROL_VBR:
267 sys->EncParamExt.iRCMode = RC_BITRATE_MODE;
268 sys->EncParamExt.iTargetBitrate = (int)h264->BitRate;
269 sys->EncParamExt.sSpatialLayers[0].iSpatialBitrate =
270 sys->EncParamExt.iTargetBitrate;
271 sys->EncParamExt.bEnableFrameSkip = 1;
274 case H264_RATECONTROL_CQP:
275 sys->EncParamExt.iRCMode = RC_OFF_MODE;
276 sys->EncParamExt.sSpatialLayers[0].iDLayerQp = (int)h264->QP;
277 sys->EncParamExt.bEnableFrameSkip = 0;
283 if (sys->EncParamExt.iMultipleThreadIdc > 1)
285#if (OPENH264_MAJOR == 1) && (OPENH264_MINOR <= 5)
286 sys->EncParamExt.sSpatialLayers[0].sSliceCfg.uiSliceMode = SM_AUTO_SLICE;
288 sys->EncParamExt.sSpatialLayers[0].sSliceArgument.uiSliceMode = SM_FIXEDSLCNUM_SLICE;
292 WINPR_ASSERT((*sys->pEncoder)->InitializeExt);
293 status = (*sys->pEncoder)->InitializeExt(sys->pEncoder, &sys->EncParamExt);
297 WLog_Print(h264->log, WLOG_ERROR,
"Failed to initialize OpenH264 encoder (status=%d)",
302 WINPR_ASSERT((*sys->pEncoder)->GetOption);
305 ->GetOption(sys->pEncoder, ENCODER_OPTION_SVC_ENCODE_PARAM_EXT, &sys->EncParamExt);
309 WLog_Print(h264->log, WLOG_ERROR,
310 "Failed to get initial OpenH264 encoder parameters (status=%d)", status);
316 switch (h264->RateControlMode)
318 case H264_RATECONTROL_VBR:
319 if (sys->EncParamExt.iTargetBitrate != (
int)h264->BitRate)
321 SBitrateInfo bitrate = WINPR_C_ARRAY_INIT;
323 sys->EncParamExt.iTargetBitrate = (int)h264->BitRate;
324 bitrate.iLayer = SPATIAL_LAYER_ALL;
325 bitrate.iBitrate = (int)h264->BitRate;
327 WINPR_ASSERT((*sys->pEncoder)->SetOption);
328 status = (*sys->pEncoder)
329 ->SetOption(sys->pEncoder, ENCODER_OPTION_BITRATE, &bitrate);
333 WLog_Print(h264->log, WLOG_ERROR,
334 "Failed to set encoder bitrate (status=%d)", status);
339 if ((uint32_t)sys->EncParamExt.fMaxFrameRate != h264->FrameRate)
341 sys->EncParamExt.fMaxFrameRate =
342 WINPR_ASSERTING_INT_CAST(
float, h264->FrameRate);
344 WINPR_ASSERT((*sys->pEncoder)->SetOption);
345 status = (*sys->pEncoder)
346 ->SetOption(sys->pEncoder, ENCODER_OPTION_FRAME_RATE,
347 &sys->EncParamExt.fMaxFrameRate);
351 WLog_Print(h264->log, WLOG_ERROR,
352 "Failed to set encoder framerate (status=%d)", status);
359 case H264_RATECONTROL_CQP:
360 if (sys->EncParamExt.sSpatialLayers[0].iDLayerQp != (
int)h264->QP)
362 sys->EncParamExt.sSpatialLayers[0].iDLayerQp = (int)h264->QP;
364 WINPR_ASSERT((*sys->pEncoder)->SetOption);
365 status = (*sys->pEncoder)
366 ->SetOption(sys->pEncoder, ENCODER_OPTION_SVC_ENCODE_PARAM_EXT,
371 WLog_Print(h264->log, WLOG_ERROR,
372 "Failed to set encoder parameters (status=%d)", status);
383 pic.iPicWidth = (int)h264->width;
384 pic.iPicHeight = (int)h264->height;
385 pic.iColorFormat = videoFormatI420;
386 pic.iStride[0] = (int)iStride[0];
387 pic.iStride[1] = (int)iStride[1];
388 pic.iStride[2] = (int)iStride[2];
389 pic.pData[0] = WINPR_CAST_CONST_PTR_AWAY(pYUVData[0], BYTE*);
390 pic.pData[1] = WINPR_CAST_CONST_PTR_AWAY(pYUVData[1], BYTE*);
391 pic.pData[2] = WINPR_CAST_CONST_PTR_AWAY(pYUVData[2], BYTE*);
393 WINPR_ASSERT((*sys->pEncoder)->EncodeFrame);
394 status = (*sys->pEncoder)->EncodeFrame(sys->pEncoder, &pic, &info);
398 WLog_Print(h264->log, WLOG_ERROR,
"Failed to encode frame (status=%d)", status);
402 *ppDstData = info.sLayerInfo[0].pBsBuf;
405 for (
int i = 0; i < info.iLayerNum; i++)
407 for (
int j = 0; j < info.sLayerInfo[i].iNalCount; j++)
409 const int val = info.sLayerInfo[i].pNalLengthInByte[j];
410 *pDstSize += WINPR_ASSERTING_INT_CAST(uint32_t, val);
417static void openh264_uninit(H264_CONTEXT* h264)
419 H264_CONTEXT_OPENH264* sysContexts =
nullptr;
423 sysContexts = (H264_CONTEXT_OPENH264*)h264->pSystemData;
427 for (UINT32 x = 0; x < h264->numSystemData; x++)
429 H264_CONTEXT_OPENH264* sys = &sysContexts[x];
433 (*sys->pDecoder)->Uninitialize(sys->pDecoder);
434 sysContexts->WelsDestroyDecoder(sys->pDecoder);
435 sys->pDecoder =
nullptr;
440 (*sys->pEncoder)->Uninitialize(sys->pEncoder);
441 sysContexts->WelsDestroySVCEncoder(sys->pEncoder);
442 sys->pEncoder =
nullptr;
446#if defined(WITH_OPENH264_LOADING)
447 if (sysContexts->lib)
448 FreeLibrary(sysContexts->lib);
450 free(h264->pSystemData);
451 h264->pSystemData =
nullptr;
455#if defined(WITH_OPENH264_LOADING)
456static BOOL openh264_load_functionpointers(H264_CONTEXT* h264,
const char* name)
458 H264_CONTEXT_OPENH264* sysContexts;
465 sysContexts = h264->pSystemData;
470 sysContexts->lib = LoadLibraryA(name);
472 if (!sysContexts->lib)
475 sysContexts->WelsGetCodecVersionEx =
476 GetProcAddressAs(sysContexts->lib,
"WelsGetCodecVersionEx", pWelsGetCodecVersionEx);
477 sysContexts->WelsCreateDecoder =
478 GetProcAddressAs(sysContexts->lib,
"WelsCreateDecoder", pWelsCreateDecoder);
479 sysContexts->WelsDestroyDecoder =
480 GetProcAddressAs(sysContexts->lib,
"WelsDestroyDecoder", pWelsDestroyDecoder);
481 sysContexts->WelsCreateSVCEncoder =
482 GetProcAddressAs(sysContexts->lib,
"WelsCreateSVCEncoder", pWelsCreateSVCEncoder);
483 sysContexts->WelsDestroySVCEncoder =
484 GetProcAddressAs(sysContexts->lib,
"WelsDestroySVCEncoder", pWelsDestroySVCEncoder);
486 if (!sysContexts->WelsCreateDecoder || !sysContexts->WelsDestroyDecoder ||
487 !sysContexts->WelsCreateSVCEncoder || !sysContexts->WelsDestroySVCEncoder ||
488 !sysContexts->WelsGetCodecVersionEx)
490 FreeLibrary(sysContexts->lib);
491 sysContexts->lib =
nullptr;
495 sysContexts->WelsGetCodecVersionEx(&sysContexts->version);
496 WLog_Print(h264->log, WLOG_DEBUG,
"loaded %s %u.%u.%u", name, sysContexts->version.uMajor,
497 sysContexts->version.uMinor, sysContexts->version.uRevision);
499 if ((sysContexts->version.uMajor < 1) ||
500 ((sysContexts->version.uMajor == 1) && (sysContexts->version.uMinor < 6)))
503 h264->log, WLOG_ERROR,
504 "OpenH264 %s %u.%u.%u is too old, need at least version 1.6.0 for dynamic loading",
505 name, sysContexts->version.uMajor, sysContexts->version.uMinor,
506 sysContexts->version.uRevision);
507 FreeLibrary(sysContexts->lib);
508 sysContexts->lib =
nullptr;
516static BOOL openh264_init(H264_CONTEXT* h264)
518#if defined(WITH_OPENH264_LOADING)
519 BOOL success = FALSE;
522 H264_CONTEXT_OPENH264* sysContexts =
nullptr;
523 static int traceLevel = WELS_LOG_DEBUG;
524#if (OPENH264_MAJOR == 1) && (OPENH264_MINOR <= 5)
525 static EVideoFormatType videoFormat = videoFormatI420;
527 static WelsTraceCallback traceCallback = openh264_trace_callback;
531 h264->numSystemData = 1;
533 (H264_CONTEXT_OPENH264*)calloc(h264->numSystemData,
sizeof(H264_CONTEXT_OPENH264));
538 h264->pSystemData = (
void*)sysContexts;
539#if defined(WITH_OPENH264_LOADING)
541 for (
size_t i = 0; i < ARRAYSIZE(openh264_library_names); i++)
543 const char* current = openh264_library_names[i];
544 success = openh264_load_functionpointers(h264, current);
554 sysContexts->WelsGetCodecVersionEx = WelsGetCodecVersionEx;
555 sysContexts->WelsCreateDecoder = WelsCreateDecoder;
556 sysContexts->WelsDestroyDecoder = WelsDestroyDecoder;
557 sysContexts->WelsCreateSVCEncoder = WelsCreateSVCEncoder;
558 sysContexts->WelsDestroySVCEncoder = WelsDestroySVCEncoder;
561 for (UINT32 x = 0; x < h264->numSystemData; x++)
563 SDecodingParam sDecParam = WINPR_C_ARRAY_INIT;
564 H264_CONTEXT_OPENH264* sys = &sysContexts[x];
566 if (h264->Compressor)
568#if defined(WITH_OPENH264_LOADING)
569 if (sysContexts->version.uMajor != OPENH264_MAJOR ||
570 sysContexts->version.uMinor != OPENH264_MINOR)
572 WLog_Print(h264->log, WLOG_WARN,
573 "OpenH264 encoder ABI mismatch: runtime %d.%d.%d vs compiled %d.%d.%d",
574 sysContexts->version.uMajor, sysContexts->version.uMinor,
575 sysContexts->version.uRevision, OPENH264_MAJOR, OPENH264_MINOR,
580 const int rc = sysContexts->WelsCreateSVCEncoder(&sys->pEncoder);
583 WLog_Print(h264->log, WLOG_ERROR,
"Failed to create OpenH264 encoder: %d", rc);
588 WLog_Print(h264->log, WLOG_ERROR,
"Failed to create OpenH264 encoder");
594 const long rc = sysContexts->WelsCreateDecoder(&sys->pDecoder);
597 WLog_Print(h264->log, WLOG_ERROR,
"Failed to create OpenH264 decoder: %ld", rc);
602 WLog_Print(h264->log, WLOG_ERROR,
"Failed to create OpenH264 decoder");
606#if (OPENH264_MAJOR == 1) && (OPENH264_MINOR <= 5)
607 sDecParam.eOutputColorFormat = videoFormatI420;
609 sDecParam.eEcActiveIdc = ERROR_CON_FRAME_COPY;
610 sDecParam.sVideoProperty.eVideoBsType = VIDEO_BITSTREAM_AVC;
611 status = (*sys->pDecoder)->Initialize(sys->pDecoder, &sDecParam);
615 WLog_Print(h264->log, WLOG_ERROR,
616 "Failed to initialize OpenH264 decoder (status=%ld)", status);
620#if (OPENH264_MAJOR == 1) && (OPENH264_MINOR <= 5)
622 (*sys->pDecoder)->SetOption(sys->pDecoder, DECODER_OPTION_DATAFORMAT, &videoFormat);
627 WLog_Print(h264->log, WLOG_ERROR,
628 "Failed to set data format option on OpenH264 decoder (status=%ld)",
633 if (WLog_GetLogLevel(h264->log) == WLOG_TRACE)
635 status = (*sys->pDecoder)
636 ->SetOption(sys->pDecoder, DECODER_OPTION_TRACE_LEVEL, &traceLevel);
640 WLog_Print(h264->log, WLOG_ERROR,
641 "Failed to set trace level option on OpenH264 decoder (status=%ld)",
646 status = (*sys->pDecoder)
647 ->SetOption(sys->pDecoder, DECODER_OPTION_TRACE_CALLBACK_CONTEXT,
652 WLog_Print(h264->log, WLOG_ERROR,
653 "Failed to set trace callback context option on OpenH264 decoder "
659 status = (*sys->pDecoder)
660 ->SetOption(sys->pDecoder, DECODER_OPTION_TRACE_CALLBACK,
661 (
void*)&traceCallback);
666 h264->log, WLOG_ERROR,
667 "Failed to set trace callback option on OpenH264 decoder (status=%ld)",
675 h264->hwAccel = FALSE;
678 openh264_uninit(h264);
682const H264_CONTEXT_SUBSYSTEM g_Subsystem_OpenH264 = {
"OpenH264", openh264_init, openh264_uninit,
683 openh264_decompress, openh264_compress };