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])
180 if (pSystemBuffer->iWidth < WINPR_ASSERTING_INT_CAST(int64_t, h264->width))
182 if (pSystemBuffer->iHeight < WINPR_ASSERTING_INT_CAST(int64_t, h264->height))
187static int openh264_compress(H264_CONTEXT* WINPR_RESTRICT h264,
188 const BYTE** WINPR_RESTRICT pYUVData,
189 const UINT32* WINPR_RESTRICT iStride, BYTE** WINPR_RESTRICT ppDstData,
190 UINT32* WINPR_RESTRICT pDstSize)
193 SFrameBSInfo info = WINPR_C_ARRAY_INIT;
194 SSourcePicture pic = WINPR_C_ARRAY_INIT;
196 H264_CONTEXT_OPENH264* sys =
nullptr;
199 WINPR_ASSERT(pYUVData);
200 WINPR_ASSERT(iStride);
201 WINPR_ASSERT(ppDstData);
202 WINPR_ASSERT(pDstSize);
204 sys = &((H264_CONTEXT_OPENH264*)h264->pSystemData)[0];
210 if (!pYUVData[0] || !pYUVData[1] || !pYUVData[2])
213 if ((h264->width > INT_MAX) || (h264->height > INT_MAX))
216 if ((h264->FrameRate > INT_MAX) || (h264->NumberOfThreads > INT_MAX) ||
217 (h264->BitRate > INT_MAX) || (h264->QP > INT_MAX))
220 WINPR_ASSERT(sys->pEncoder);
221 if ((sys->EncParamExt.iPicWidth != (
int)h264->width) ||
222 (sys->EncParamExt.iPicHeight != (
int)h264->height))
224 WINPR_ASSERT((*sys->pEncoder)->GetDefaultParams);
225 status = (*sys->pEncoder)->GetDefaultParams(sys->pEncoder, &sys->EncParamExt);
229 WLog_Print(h264->log, WLOG_ERROR,
230 "Failed to get OpenH264 default parameters (status=%d)", status);
234 EUsageType usageType = SCREEN_CONTENT_REAL_TIME;
236 switch (h264->UsageType)
238 case H264_CAMERA_VIDEO_NON_REAL_TIME:
239 usageType = CAMERA_VIDEO_NON_REAL_TIME;
241 case H264_CAMERA_VIDEO_REAL_TIME:
242 usageType = CAMERA_VIDEO_REAL_TIME;
244 case H264_SCREEN_CONTENT_NON_REAL_TIME:
245 usageType = SCREEN_CONTENT_NON_REAL_TIME;
247 case H264_SCREEN_CONTENT_REAL_TIME:
252 sys->EncParamExt.iUsageType = usageType;
253 sys->EncParamExt.iPicWidth = WINPR_ASSERTING_INT_CAST(
int, h264->width);
254 sys->EncParamExt.iPicHeight = WINPR_ASSERTING_INT_CAST(
int, h264->height);
255 sys->EncParamExt.fMaxFrameRate = WINPR_ASSERTING_INT_CAST(
short, h264->FrameRate);
256 sys->EncParamExt.iMaxBitrate = UNSPECIFIED_BIT_RATE;
257 sys->EncParamExt.bEnableDenoise = 0;
258 sys->EncParamExt.bEnableLongTermReference = 0;
259 sys->EncParamExt.iSpatialLayerNum = 1;
260 sys->EncParamExt.iMultipleThreadIdc =
261 WINPR_ASSERTING_INT_CAST(
unsigned short, h264->NumberOfThreads);
262 sys->EncParamExt.sSpatialLayers[0].fFrameRate =
263 WINPR_ASSERTING_INT_CAST(
short, h264->FrameRate);
264 sys->EncParamExt.sSpatialLayers[0].iVideoWidth = sys->EncParamExt.iPicWidth;
265 sys->EncParamExt.sSpatialLayers[0].iVideoHeight = sys->EncParamExt.iPicHeight;
266 sys->EncParamExt.sSpatialLayers[0].iMaxSpatialBitrate = sys->EncParamExt.iMaxBitrate;
268 switch (h264->RateControlMode)
270 case H264_RATECONTROL_VBR:
271 sys->EncParamExt.iRCMode = RC_BITRATE_MODE;
272 sys->EncParamExt.iTargetBitrate = (int)h264->BitRate;
273 sys->EncParamExt.sSpatialLayers[0].iSpatialBitrate =
274 sys->EncParamExt.iTargetBitrate;
275 sys->EncParamExt.bEnableFrameSkip = 1;
278 case H264_RATECONTROL_CQP:
279 sys->EncParamExt.iRCMode = RC_OFF_MODE;
280 sys->EncParamExt.sSpatialLayers[0].iDLayerQp = (int)h264->QP;
281 sys->EncParamExt.bEnableFrameSkip = 0;
287 if (sys->EncParamExt.iMultipleThreadIdc > 1)
289#if (OPENH264_MAJOR == 1) && (OPENH264_MINOR <= 5)
290 sys->EncParamExt.sSpatialLayers[0].sSliceCfg.uiSliceMode = SM_AUTO_SLICE;
292 sys->EncParamExt.sSpatialLayers[0].sSliceArgument.uiSliceMode = SM_FIXEDSLCNUM_SLICE;
296 WINPR_ASSERT((*sys->pEncoder)->InitializeExt);
297 status = (*sys->pEncoder)->InitializeExt(sys->pEncoder, &sys->EncParamExt);
301 WLog_Print(h264->log, WLOG_ERROR,
"Failed to initialize OpenH264 encoder (status=%d)",
306 WINPR_ASSERT((*sys->pEncoder)->GetOption);
309 ->GetOption(sys->pEncoder, ENCODER_OPTION_SVC_ENCODE_PARAM_EXT, &sys->EncParamExt);
313 WLog_Print(h264->log, WLOG_ERROR,
314 "Failed to get initial OpenH264 encoder parameters (status=%d)", status);
320 switch (h264->RateControlMode)
322 case H264_RATECONTROL_VBR:
323 if (sys->EncParamExt.iTargetBitrate != (
int)h264->BitRate)
325 SBitrateInfo bitrate = WINPR_C_ARRAY_INIT;
327 sys->EncParamExt.iTargetBitrate = (int)h264->BitRate;
328 bitrate.iLayer = SPATIAL_LAYER_ALL;
329 bitrate.iBitrate = (int)h264->BitRate;
331 WINPR_ASSERT((*sys->pEncoder)->SetOption);
332 status = (*sys->pEncoder)
333 ->SetOption(sys->pEncoder, ENCODER_OPTION_BITRATE, &bitrate);
337 WLog_Print(h264->log, WLOG_ERROR,
338 "Failed to set encoder bitrate (status=%d)", status);
343 if ((uint32_t)sys->EncParamExt.fMaxFrameRate != h264->FrameRate)
345 sys->EncParamExt.fMaxFrameRate =
346 WINPR_ASSERTING_INT_CAST(
float, h264->FrameRate);
348 WINPR_ASSERT((*sys->pEncoder)->SetOption);
349 status = (*sys->pEncoder)
350 ->SetOption(sys->pEncoder, ENCODER_OPTION_FRAME_RATE,
351 &sys->EncParamExt.fMaxFrameRate);
355 WLog_Print(h264->log, WLOG_ERROR,
356 "Failed to set encoder framerate (status=%d)", status);
363 case H264_RATECONTROL_CQP:
364 if (sys->EncParamExt.sSpatialLayers[0].iDLayerQp != (
int)h264->QP)
366 sys->EncParamExt.sSpatialLayers[0].iDLayerQp = (int)h264->QP;
368 WINPR_ASSERT((*sys->pEncoder)->SetOption);
369 status = (*sys->pEncoder)
370 ->SetOption(sys->pEncoder, ENCODER_OPTION_SVC_ENCODE_PARAM_EXT,
375 WLog_Print(h264->log, WLOG_ERROR,
376 "Failed to set encoder parameters (status=%d)", status);
387 pic.iPicWidth = (int)h264->width;
388 pic.iPicHeight = (int)h264->height;
389 pic.iColorFormat = videoFormatI420;
390 pic.iStride[0] = (int)iStride[0];
391 pic.iStride[1] = (int)iStride[1];
392 pic.iStride[2] = (int)iStride[2];
393 pic.pData[0] = WINPR_CAST_CONST_PTR_AWAY(pYUVData[0], BYTE*);
394 pic.pData[1] = WINPR_CAST_CONST_PTR_AWAY(pYUVData[1], BYTE*);
395 pic.pData[2] = WINPR_CAST_CONST_PTR_AWAY(pYUVData[2], BYTE*);
397 WINPR_ASSERT((*sys->pEncoder)->EncodeFrame);
398 status = (*sys->pEncoder)->EncodeFrame(sys->pEncoder, &pic, &info);
402 WLog_Print(h264->log, WLOG_ERROR,
"Failed to encode frame (status=%d)", status);
406 *ppDstData = info.sLayerInfo[0].pBsBuf;
409 for (
int i = 0; i < info.iLayerNum; i++)
411 for (
int j = 0; j < info.sLayerInfo[i].iNalCount; j++)
413 const int val = info.sLayerInfo[i].pNalLengthInByte[j];
414 *pDstSize += WINPR_ASSERTING_INT_CAST(uint32_t, val);
421static void openh264_uninit(H264_CONTEXT* h264)
423 H264_CONTEXT_OPENH264* sysContexts =
nullptr;
427 sysContexts = (H264_CONTEXT_OPENH264*)h264->pSystemData;
431 for (UINT32 x = 0; x < h264->numSystemData; x++)
433 H264_CONTEXT_OPENH264* sys = &sysContexts[x];
437 (*sys->pDecoder)->Uninitialize(sys->pDecoder);
438 sysContexts->WelsDestroyDecoder(sys->pDecoder);
439 sys->pDecoder =
nullptr;
444 (*sys->pEncoder)->Uninitialize(sys->pEncoder);
445 sysContexts->WelsDestroySVCEncoder(sys->pEncoder);
446 sys->pEncoder =
nullptr;
450#if defined(WITH_OPENH264_LOADING)
451 if (sysContexts->lib)
452 FreeLibrary(sysContexts->lib);
454 free(h264->pSystemData);
455 h264->pSystemData =
nullptr;
459#if defined(WITH_OPENH264_LOADING)
460static BOOL openh264_load_functionpointers(H264_CONTEXT* h264,
const char* name)
462 H264_CONTEXT_OPENH264* sysContexts;
469 sysContexts = h264->pSystemData;
474 sysContexts->lib = LoadLibraryA(name);
476 if (!sysContexts->lib)
479 sysContexts->WelsGetCodecVersionEx =
480 GetProcAddressAs(sysContexts->lib,
"WelsGetCodecVersionEx", pWelsGetCodecVersionEx);
481 sysContexts->WelsCreateDecoder =
482 GetProcAddressAs(sysContexts->lib,
"WelsCreateDecoder", pWelsCreateDecoder);
483 sysContexts->WelsDestroyDecoder =
484 GetProcAddressAs(sysContexts->lib,
"WelsDestroyDecoder", pWelsDestroyDecoder);
485 sysContexts->WelsCreateSVCEncoder =
486 GetProcAddressAs(sysContexts->lib,
"WelsCreateSVCEncoder", pWelsCreateSVCEncoder);
487 sysContexts->WelsDestroySVCEncoder =
488 GetProcAddressAs(sysContexts->lib,
"WelsDestroySVCEncoder", pWelsDestroySVCEncoder);
490 if (!sysContexts->WelsCreateDecoder || !sysContexts->WelsDestroyDecoder ||
491 !sysContexts->WelsCreateSVCEncoder || !sysContexts->WelsDestroySVCEncoder ||
492 !sysContexts->WelsGetCodecVersionEx)
494 FreeLibrary(sysContexts->lib);
495 sysContexts->lib =
nullptr;
499 sysContexts->WelsGetCodecVersionEx(&sysContexts->version);
500 WLog_Print(h264->log, WLOG_DEBUG,
"loaded %s %u.%u.%u", name, sysContexts->version.uMajor,
501 sysContexts->version.uMinor, sysContexts->version.uRevision);
503 if ((sysContexts->version.uMajor < 1) ||
504 ((sysContexts->version.uMajor == 1) && (sysContexts->version.uMinor < 6)))
507 h264->log, WLOG_ERROR,
508 "OpenH264 %s %u.%u.%u is too old, need at least version 1.6.0 for dynamic loading",
509 name, sysContexts->version.uMajor, sysContexts->version.uMinor,
510 sysContexts->version.uRevision);
511 FreeLibrary(sysContexts->lib);
512 sysContexts->lib =
nullptr;
520static BOOL openh264_init(H264_CONTEXT* h264)
522#if defined(WITH_OPENH264_LOADING)
523 BOOL success = FALSE;
526 H264_CONTEXT_OPENH264* sysContexts =
nullptr;
527 static int traceLevel = WELS_LOG_DEBUG;
528#if (OPENH264_MAJOR == 1) && (OPENH264_MINOR <= 5)
529 static EVideoFormatType videoFormat = videoFormatI420;
531 static WelsTraceCallback traceCallback = openh264_trace_callback;
535 h264->numSystemData = 1;
537 (H264_CONTEXT_OPENH264*)calloc(h264->numSystemData,
sizeof(H264_CONTEXT_OPENH264));
542 h264->pSystemData = (
void*)sysContexts;
543#if defined(WITH_OPENH264_LOADING)
545 for (
size_t i = 0; i < ARRAYSIZE(openh264_library_names); i++)
547 const char* current = openh264_library_names[i];
548 success = openh264_load_functionpointers(h264, current);
558 sysContexts->WelsGetCodecVersionEx = WelsGetCodecVersionEx;
559 sysContexts->WelsCreateDecoder = WelsCreateDecoder;
560 sysContexts->WelsDestroyDecoder = WelsDestroyDecoder;
561 sysContexts->WelsCreateSVCEncoder = WelsCreateSVCEncoder;
562 sysContexts->WelsDestroySVCEncoder = WelsDestroySVCEncoder;
565 for (UINT32 x = 0; x < h264->numSystemData; x++)
567 SDecodingParam sDecParam = WINPR_C_ARRAY_INIT;
568 H264_CONTEXT_OPENH264* sys = &sysContexts[x];
570 if (h264->Compressor)
572#if defined(WITH_OPENH264_LOADING)
573 if (sysContexts->version.uMajor != OPENH264_MAJOR ||
574 sysContexts->version.uMinor != OPENH264_MINOR)
576 WLog_Print(h264->log, WLOG_WARN,
577 "OpenH264 encoder ABI mismatch: runtime %d.%d.%d vs compiled %d.%d.%d",
578 sysContexts->version.uMajor, sysContexts->version.uMinor,
579 sysContexts->version.uRevision, OPENH264_MAJOR, OPENH264_MINOR,
584 const int rc = sysContexts->WelsCreateSVCEncoder(&sys->pEncoder);
587 WLog_Print(h264->log, WLOG_ERROR,
"Failed to create OpenH264 encoder: %d", rc);
592 WLog_Print(h264->log, WLOG_ERROR,
"Failed to create OpenH264 encoder");
598 const long rc = sysContexts->WelsCreateDecoder(&sys->pDecoder);
601 WLog_Print(h264->log, WLOG_ERROR,
"Failed to create OpenH264 decoder: %ld", rc);
606 WLog_Print(h264->log, WLOG_ERROR,
"Failed to create OpenH264 decoder");
610#if (OPENH264_MAJOR == 1) && (OPENH264_MINOR <= 5)
611 sDecParam.eOutputColorFormat = videoFormatI420;
613 sDecParam.eEcActiveIdc = ERROR_CON_FRAME_COPY;
614 sDecParam.sVideoProperty.eVideoBsType = VIDEO_BITSTREAM_AVC;
615 status = (*sys->pDecoder)->Initialize(sys->pDecoder, &sDecParam);
619 WLog_Print(h264->log, WLOG_ERROR,
620 "Failed to initialize OpenH264 decoder (status=%ld)", status);
624#if (OPENH264_MAJOR == 1) && (OPENH264_MINOR <= 5)
626 (*sys->pDecoder)->SetOption(sys->pDecoder, DECODER_OPTION_DATAFORMAT, &videoFormat);
631 WLog_Print(h264->log, WLOG_ERROR,
632 "Failed to set data format option on OpenH264 decoder (status=%ld)",
637 if (WLog_GetLogLevel(h264->log) == WLOG_TRACE)
639 status = (*sys->pDecoder)
640 ->SetOption(sys->pDecoder, DECODER_OPTION_TRACE_LEVEL, &traceLevel);
644 WLog_Print(h264->log, WLOG_ERROR,
645 "Failed to set trace level option on OpenH264 decoder (status=%ld)",
650 status = (*sys->pDecoder)
651 ->SetOption(sys->pDecoder, DECODER_OPTION_TRACE_CALLBACK_CONTEXT,
656 WLog_Print(h264->log, WLOG_ERROR,
657 "Failed to set trace callback context option on OpenH264 decoder "
663 status = (*sys->pDecoder)
664 ->SetOption(sys->pDecoder, DECODER_OPTION_TRACE_CALLBACK,
665 (
void*)&traceCallback);
670 h264->log, WLOG_ERROR,
671 "Failed to set trace callback option on OpenH264 decoder (status=%ld)",
679 h264->hwAccel = FALSE;
682 openh264_uninit(h264);
686const H264_CONTEXT_SUBSYSTEM g_Subsystem_OpenH264 = {
"OpenH264", openh264_init, openh264_uninit,
687 openh264_decompress, openh264_compress };