Added decoding of only keyframes when no video encoding is present

AirenSoft · Nov 12, 2024 · 4dff75a · 4dff75a
1 parent 3b3b338
commit 4dff75a
Show file tree

Hide file tree

Showing 22 changed files with 291 additions and 30 deletions.
diff --git a/misc/conf_examples/Server.xml b/misc/conf_examples/Server.xml
@@ -310,9 +310,14 @@
 					<Type>live</Type>
 					<OutputProfiles>
 
-						<!--  This option is deprecated. Please use the 'HWAccels' option. -->
 						<!-- 
-							<HardwareAcceleration>false</HardwareAcceleration>
+						Common setting for decoders. Decodes is optional.
+
+						<Decodes>
+							To reduce resource usage, only keyframes are decoded.
+							It is only activated when image encoding and video bypass are enabled.
+							<KeyframeOnlyIfNeed>false</KeyframeOnlyIfNeed>
+						</Decodes>
 						-->
 
 						<!-- Enable this configuration if you want to hardware acceleration using GPU -->

diff --git a/src/projects/base/info/video_track.cpp b/src/projects/base/info/video_track.cpp
@@ -260,3 +260,13 @@ int32_t VideoTrack::GetSkipFramesByConfig() const
 {
 	return _skip_frames_conf;
 }
+
+bool VideoTrack::IsKeyframeDecodeOnly() const
+{
+	return _keyframe_decode_only;
+}
+
+void VideoTrack::SetKeyframeDecodeOnly(bool keyframe_decode_only)
+{
+	_keyframe_decode_only = keyframe_decode_only;
+}
diff --git a/src/projects/base/info/video_track.h b/src/projects/base/info/video_track.h
@@ -90,6 +90,10 @@ class VideoTrack
 	void SetSkipFramesByConfig(int32_t skip_frames);
 	int32_t GetSkipFramesByConfig() const;
 
+	// decoder only parameter
+	bool IsKeyframeDecodeOnly() const;
+	void SetKeyframeDecodeOnly(bool keyframe_decode_only);
+
 protected:
 
 	// framerate (measurement)
@@ -148,4 +152,8 @@ class VideoTrack
 	// -1 : No SkipFrame
 	// 0 ~ 120 : minimum value of SkipFrames. it is automatically calculated and the SkipFrames value is changed.
 	int32_t _skip_frames_conf = -1;
+
+	// @decoder
+	// Keyframe Decode Only (set by user)
+	bool _keyframe_decode_only = false;
 };
diff --git a/src/projects/config/items/virtual_hosts/applications/application.h b/src/projects/config/items/virtual_hosts/applications/application.h
@@ -84,10 +84,12 @@ namespace cfg
 						return CreateConfigErrorPtr("Unknown type: %s", _type.CStr());
 					});
 
+					// TODO: Deprecated
 					Register<Optional>("Decodes", &_decodes);
 					Register<Optional>("OutputProfiles", &_output_profiles);
 					Register<Optional>("Providers", &_providers);
 					Register<Optional>("Publishers", &_publishers);
+					// TODO: Deprecated
 					Register<Optional>("PersistentStreams", &_persistent_streams);
 					Register<Optional>("TranscodeWebhook", &_transcode_webhook);
 				}

diff --git a/src/projects/config/items/virtual_hosts/applications/output_profiles/decodes/decodes.h b/src/projects/config/items/virtual_hosts/applications/output_profiles/decodes/decodes.h
@@ -0,0 +1,36 @@
+//=============================================================================
+//
+//  OvenMediaEngine
+//
+//  Created by Hyunjun Jang
+//  Copyright (c) 2019 AirenSoft. All rights reserved.
+//
+//==============================================================================
+#pragma once
+
+namespace cfg
+{
+	namespace vhost
+	{
+		namespace app
+		{
+			namespace oprf
+			{
+				struct Decodes : public Item
+				{
+				public:
+					// Informal Option 
+					CFG_DECLARE_CONST_REF_GETTER_OF(IsKeyframeOnlyIfNeed, _keyframe_only_if_need);
+
+				protected:
+					void MakeList() override
+					{
+						Register<Optional>("KeyframeOnlyIfNeed", &_keyframe_only_if_need);
+					}
+
+					bool _keyframe_only_if_need = false;
+				};
+			}  // namespace dec
+		}	   // namespace app
+	}		   // namespace vhost
+}  // namespace cfg
diff --git a/src/projects/config/items/virtual_hosts/applications/output_profiles/output_profiles.h b/src/projects/config/items/virtual_hosts/applications/output_profiles/output_profiles.h
@@ -10,6 +10,7 @@
 
 #include "./output_profile.h"
 #include "./hwaccels/hwaccels.h"
+#include "./decodes/decodes.h"
 
 namespace cfg
 {
@@ -25,11 +26,12 @@ namespace cfg
 					bool _hwaccel = false;
 					HWAccels _hwaccels;
 					std::vector<OutputProfile> _output_profiles;
-
+					Decodes _decodes;
 				public:
 					CFG_DECLARE_CONST_REF_GETTER_OF(IsHardwareAcceleration, _hwaccel);
 					CFG_DECLARE_CONST_REF_GETTER_OF(GetHWAccels, _hwaccels);
 					CFG_DECLARE_CONST_REF_GETTER_OF(GetOutputProfileList, _output_profiles);
+					CFG_DECLARE_CONST_REF_GETTER_OF(GetDecodes, _decodes);
 
 				protected:
 					void MakeList() override
@@ -44,6 +46,7 @@ namespace cfg
 						);
 						Register<Optional>({"HWAccels", "hwaccels"}, &_hwaccels);
 						Register<Optional>("OutputProfile", &_output_profiles);
+						Register<Optional>({"Decodes", "decodes"}, &_decodes);
 					}
 				};
 			}  // namespace oprf

diff --git a/src/projects/transcoder/codec/decoder/decoder_avc.cpp b/src/projects/transcoder/codec/decoder/decoder_avc.cpp
@@ -153,6 +153,17 @@ void DecoderAVC::CodecThread()
 					_pkt->duration = duration;
 				}
 
+				// Keyframe Decode Only
+				// If set to decode only key frames, non-keyframe packets are dropped.
+				if(GetRefTrack()->IsKeyframeDecodeOnly() == true)
+				{
+					// Drop non-keyframe packets
+					if (!(_pkt->flags & AV_PKT_FLAG_KEY))
+					{
+						break;
+					}
+				}
+
 				int ret = ::avcodec_send_packet(_context, _pkt);
 				if (ret == AVERROR(EAGAIN))
 				{

diff --git a/src/projects/transcoder/codec/decoder/decoder_avc_nilogan.cpp b/src/projects/transcoder/codec/decoder/decoder_avc_nilogan.cpp
@@ -171,8 +171,18 @@ void DecoderAVCxNILOGAN::CodecThread()
 					_pkt->duration = duration;
 				}
 
-				int ret = ::avcodec_send_packet(_context, _pkt);
+				// Keyframe Decode Only
+				// If set to decode only key frames, non-keyframe packets are dropped.
+				if(GetRefTrack()->IsKeyframeDecodeOnly() == true)
+				{
+					// Drop non-keyframe packets
+					if (!(_pkt->flags & AV_PKT_FLAG_KEY))
+					{
+						break;
+					}
+				}
 
+				int ret = ::avcodec_send_packet(_context, _pkt);
 				if (ret == AVERROR(EAGAIN))
 				{
 					// Need more data

diff --git a/src/projects/transcoder/codec/decoder/decoder_avc_nv.cpp b/src/projects/transcoder/codec/decoder/decoder_avc_nv.cpp
@@ -160,8 +160,18 @@ void DecoderAVCxNV::CodecThread()
 					_pkt->duration = duration;
 				}
 
-				int ret = ::avcodec_send_packet(_context, _pkt);
+				// Keyframe Decode Only
+				// If set to decode only key frames, non-keyframe packets are dropped.
+				if(GetRefTrack()->IsKeyframeDecodeOnly() == true)
+				{
+					// Drop non-keyframe packets
+					if (!(_pkt->flags & AV_PKT_FLAG_KEY))
+					{
+						break;
+					}
+				}
 
+				int ret = ::avcodec_send_packet(_context, _pkt);
 				if (ret == AVERROR(EAGAIN))
 				{
 					// Need more data

diff --git a/src/projects/transcoder/codec/decoder/decoder_avc_qsv.cpp b/src/projects/transcoder/codec/decoder/decoder_avc_qsv.cpp
@@ -103,8 +103,18 @@ void DecoderAVCxQSV::CodecThread()
 					_pkt->duration = duration;
 				}
 
-				int ret = ::avcodec_send_packet(_context, _pkt);
+				// Keyframe Decode Only
+				// If set to decode only key frames, non-keyframe packets are dropped.
+				if(GetRefTrack()->IsKeyframeDecodeOnly() == true)
+				{
+					// Drop non-keyframe packets
+					if (!(_pkt->flags & AV_PKT_FLAG_KEY))
+					{
+						break;
+					}
+				}
 
+				int ret = ::avcodec_send_packet(_context, _pkt);
 				if (ret == AVERROR(EAGAIN))
 				{
 					// Need more data

diff --git a/src/projects/transcoder/codec/decoder/decoder_avc_xma.cpp b/src/projects/transcoder/codec/decoder/decoder_avc_xma.cpp
@@ -178,8 +178,18 @@ void DecoderAVCxXMA::CodecThread()
 					_pkt->duration = duration;
 				}
 
-				int ret = ::avcodec_send_packet(_context, _pkt);
+				// Keyframe Decode Only
+				// If set to decode only key frames, non-keyframe packets are dropped.
+				if(GetRefTrack()->IsKeyframeDecodeOnly() == true)
+				{
+					// Drop non-keyframe packets
+					if (!(_pkt->flags & AV_PKT_FLAG_KEY))
+					{
+						break;
+					}
+				}
 
+				int ret = ::avcodec_send_packet(_context, _pkt);
 				if (ret == AVERROR(EAGAIN))
 				{
 					// Need more data

diff --git a/src/projects/transcoder/codec/decoder/decoder_hevc.cpp b/src/projects/transcoder/codec/decoder/decoder_hevc.cpp
@@ -144,8 +144,18 @@ void DecoderHEVC::CodecThread()
 					_pkt->duration = duration;
 				}
 
-				int ret = ::avcodec_send_packet(_context, _pkt);
+				// Keyframe Decode Only
+				// If set to decode only key frames, non-keyframe packets are dropped.
+				if(GetRefTrack()->IsKeyframeDecodeOnly() == true)
+				{
+					// Drop non-keyframe packets
+					if (!(_pkt->flags & AV_PKT_FLAG_KEY))
+					{
+						break;
+					}
+				}
 
+				int ret = ::avcodec_send_packet(_context, _pkt);
 				if (ret == AVERROR(EAGAIN))
 				{
 					// Need more data

diff --git a/src/projects/transcoder/codec/decoder/decoder_hevc_nilogan.cpp b/src/projects/transcoder/codec/decoder/decoder_hevc_nilogan.cpp
@@ -134,8 +134,18 @@ void DecoderHEVCxNILOGAN::CodecThread()
 					_pkt->duration = duration;
 				}
 
-				int ret = ::avcodec_send_packet(_context, _pkt);
+				// Keyframe Decode Only
+				// If set to decode only key frames, non-keyframe packets are dropped.
+				if(GetRefTrack()->IsKeyframeDecodeOnly() == true)
+				{
+					// Drop non-keyframe packets
+					if (!(_pkt->flags & AV_PKT_FLAG_KEY))
+					{
+						break;
+					}
+				}
 
+				int ret = ::avcodec_send_packet(_context, _pkt);
 				if (ret == AVERROR(EAGAIN))
 				{
 					// Need more data

diff --git a/src/projects/transcoder/codec/decoder/decoder_hevc_nv.cpp b/src/projects/transcoder/codec/decoder/decoder_hevc_nv.cpp
@@ -149,8 +149,18 @@ void DecoderHEVCxNV::CodecThread()
 					_pkt->duration = duration;
 				}
 
-				int ret = ::avcodec_send_packet(_context, _pkt);
+				// Keyframe Decode Only
+				// If set to decode only key frames, non-keyframe packets are dropped.
+				if(GetRefTrack()->IsKeyframeDecodeOnly() == true)
+				{
+					// Drop non-keyframe packets
+					if (!(_pkt->flags & AV_PKT_FLAG_KEY))
+					{
+						break;
+					}
+				}
 
+				int ret = ::avcodec_send_packet(_context, _pkt);
 				if (ret == AVERROR(EAGAIN))
 				{
 					// Need more data

diff --git a/src/projects/transcoder/codec/decoder/decoder_hevc_qsv.cpp b/src/projects/transcoder/codec/decoder/decoder_hevc_qsv.cpp
@@ -100,8 +100,18 @@ void DecoderHEVCxQSV::CodecThread()
 					_pkt->duration = duration;
 				}
 
-				int ret = ::avcodec_send_packet(_context, _pkt);
+				// Keyframe Decode Only
+				// If set to decode only key frames, non-keyframe packets are dropped.
+				if(GetRefTrack()->IsKeyframeDecodeOnly() == true)
+				{
+					// Drop non-keyframe packets
+					if (!(_pkt->flags & AV_PKT_FLAG_KEY))
+					{
+						break;
+					}
+				}
 
+				int ret = ::avcodec_send_packet(_context, _pkt);
 				if (ret == AVERROR(EAGAIN))
 				{
 					// Need more data

diff --git a/src/projects/transcoder/codec/decoder/decoder_hevc_xma.cpp b/src/projects/transcoder/codec/decoder/decoder_hevc_xma.cpp
@@ -179,8 +179,18 @@ void DecoderHEVCxXMA::CodecThread()
 					_pkt->duration = duration;
 				}
 
-				int ret = ::avcodec_send_packet(_context, _pkt);
+				// Keyframe Decode Only
+				// If set to decode only key frames, non-keyframe packets are dropped.
+				if(GetRefTrack()->IsKeyframeDecodeOnly() == true)
+				{
+					// Drop non-keyframe packets
+					if (!(_pkt->flags & AV_PKT_FLAG_KEY))
+					{
+						break;
+					}
+				}
 
+				int ret = ::avcodec_send_packet(_context, _pkt);
 				if (ret == AVERROR(EAGAIN))
 				{
 					// Need more data

diff --git a/src/projects/transcoder/codec/decoder/decoder_vp8.cpp b/src/projects/transcoder/codec/decoder/decoder_vp8.cpp
@@ -142,8 +142,18 @@ void DecoderVP8::CodecThread()
 					_pkt->duration = duration;
 				}
 
-				int ret = ::avcodec_send_packet(_context, _pkt);
+				// Keyframe Decode Only
+				// If set to decode only key frames, non-keyframe packets are dropped.
+				if(GetRefTrack()->IsKeyframeDecodeOnly() == true)
+				{
+					// Drop non-keyframe packets
+					if (!(_pkt->flags & AV_PKT_FLAG_KEY))
+					{
+						break;
+					}
+				}
 
+				int ret = ::avcodec_send_packet(_context, _pkt);
 				if (ret == AVERROR(EAGAIN))
 				{
 					// Need more data

diff --git a/src/projects/transcoder/codec/encoder/encoder_png.cpp b/src/projects/transcoder/codec/encoder/encoder_png.cpp
@@ -23,6 +23,9 @@ bool EncoderPNG::SetCodecParams()
 	_codec_context->width = GetRefTrack()->GetWidth();
 	_codec_context->height = GetRefTrack()->GetHeight();
 
+	// Set the compression level
+	_codec_context->compression_level = 1;
+
 	_bitstream_format = cmn::BitstreamFormat::PNG;
 
 	_packet_type = cmn::PacketType::RAW;