/* GStreamer NVENC plugin * Copyright (C) 2015 Centricular Ltd * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Library General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Library General Public License for more details. * * You should have received a copy of the GNU Library General Public * License along with this library; if not, write to the * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, * Boston, MA 02110-1301, USA. */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #include "gstnvh264enc.h" #include #include #if HAVE_GST_GL #include #include #include #define GST_USE_UNSTABLE_API #include #endif #define parent_class gst_nv_h264_enc_parent_class G_DEFINE_TYPE (GstNvH264Enc, gst_nv_h264_enc, GST_TYPE_NV_BASE_ENC); /* *INDENT-OFF* */ static GstStaticPadTemplate src_factory = GST_STATIC_PAD_TEMPLATE ("src", GST_PAD_SRC, GST_PAD_ALWAYS, GST_STATIC_CAPS ("video/x-h264, " "width = (int) [ 1, 4096 ], height = (int) [ 1, 2160 ], " "framerate = (fraction) [0/1, MAX], " "stream-format = (string) byte-stream, " // TODO: avc support "alignment = (string) au, " "profile = (string) { high, main, baseline }") // TODO: a couple of others ); /* *INDENT-ON* */ static gboolean gst_nv_h264_enc_open (GstVideoEncoder * enc); static gboolean gst_nv_h264_enc_close (GstVideoEncoder * enc); static GstCaps *gst_nv_h264_enc_getcaps (GstVideoEncoder * enc, GstCaps * filter); static gboolean gst_nv_h264_enc_set_src_caps (GstNvBaseEnc * nvenc, GstVideoCodecState * state); static gboolean gst_nv_h264_enc_initialize_encoder (GstNvBaseEnc * nvenc, GstVideoCodecState * old_state, GstVideoCodecState * state); static gboolean gst_nv_h264_enc_set_pic_params (GstNvBaseEnc * nvenc, GstVideoCodecFrame * frame, NV_ENC_PIC_PARAMS * pic_params); static void gst_nv_h264_enc_set_property (GObject * object, guint prop_id, const GValue * value, GParamSpec * pspec); static void gst_nv_h264_enc_get_property (GObject * object, guint prop_id, GValue * value, GParamSpec * pspec); static void gst_nv_h264_enc_finalize (GObject * obj); static void gst_nv_h264_enc_class_init (GstNvH264EncClass * klass) { GObjectClass *gobject_class = G_OBJECT_CLASS (klass); GstElementClass *element_class = GST_ELEMENT_CLASS (klass); GstVideoEncoderClass *videoenc_class = GST_VIDEO_ENCODER_CLASS (klass); GstNvBaseEncClass *nvenc_class = GST_NV_BASE_ENC_CLASS (klass); gobject_class->set_property = gst_nv_h264_enc_set_property; gobject_class->get_property = gst_nv_h264_enc_get_property; gobject_class->finalize = gst_nv_h264_enc_finalize; videoenc_class->open = GST_DEBUG_FUNCPTR (gst_nv_h264_enc_open); videoenc_class->close = GST_DEBUG_FUNCPTR (gst_nv_h264_enc_close); videoenc_class->getcaps = GST_DEBUG_FUNCPTR (gst_nv_h264_enc_getcaps); nvenc_class->codec_id = NV_ENC_CODEC_H264_GUID; nvenc_class->initialize_encoder = gst_nv_h264_enc_initialize_encoder; nvenc_class->set_src_caps = gst_nv_h264_enc_set_src_caps; nvenc_class->set_pic_params = gst_nv_h264_enc_set_pic_params; gst_element_class_add_pad_template (element_class, gst_static_pad_template_get (&src_factory)); gst_element_class_set_static_metadata (element_class, "NVENC H.264 Video Encoder", "Codec/Encoder/Video", "Encode H.264 video streams using NVIDIA's hardware-accelerated NVENC encoder API", "Tim-Philipp Müller \n" "Matthew Waters "); } static void gst_nv_h264_enc_init (GstNvH264Enc * nvenc) { } static void gst_nv_h264_enc_finalize (GObject * obj) { G_OBJECT_CLASS (gst_nv_h264_enc_parent_class)->finalize (obj); } static gboolean _get_supported_profiles (GstNvH264Enc * nvenc) { NVENCSTATUS nv_ret; GUID profile_guids[64]; GValue list = G_VALUE_INIT; GValue val = G_VALUE_INIT; guint i, n, n_profiles; nv_ret = NvEncGetEncodeProfileGUIDCount (GST_NV_BASE_ENC (nvenc)->encoder, NV_ENC_CODEC_H264_GUID, &n); if (nv_ret != NV_ENC_SUCCESS) return FALSE; nv_ret = NvEncGetEncodeProfileGUIDs (GST_NV_BASE_ENC (nvenc)->encoder, NV_ENC_CODEC_H264_GUID, profile_guids, G_N_ELEMENTS (profile_guids), &n); if (nv_ret != NV_ENC_SUCCESS) return FALSE; n_profiles = 0; g_value_init (&list, GST_TYPE_LIST); for (i = 0; i < n; i++) { g_value_init (&val, G_TYPE_STRING); if (gst_nvenc_cmp_guid (profile_guids[i], NV_ENC_H264_PROFILE_BASELINE_GUID)) { g_value_set_static_string (&val, "baseline"); gst_value_list_append_value (&list, &val); n_profiles++; } else if (gst_nvenc_cmp_guid (profile_guids[i], NV_ENC_H264_PROFILE_MAIN_GUID)) { g_value_set_static_string (&val, "main"); gst_value_list_append_value (&list, &val); n_profiles++; } else if (gst_nvenc_cmp_guid (profile_guids[i], NV_ENC_H264_PROFILE_HIGH_GUID)) { g_value_set_static_string (&val, "high"); gst_value_list_append_value (&list, &val); n_profiles++; } /* TODO: map HIGH_444, STEREO, CONSTRAINED_HIGH, SVC_TEMPORAL_SCALABILITY */ g_value_unset (&val); } if (n_profiles == 0) return FALSE; GST_OBJECT_LOCK (nvenc); g_free (nvenc->supported_profiles); nvenc->supported_profiles = g_memdup (&list, sizeof (GValue)); GST_OBJECT_UNLOCK (nvenc); return TRUE; } static gboolean gst_nv_h264_enc_open (GstVideoEncoder * enc) { GstNvH264Enc *nvenc = GST_NV_H264_ENC (enc); if (!GST_VIDEO_ENCODER_CLASS (gst_nv_h264_enc_parent_class)->open (enc)) return FALSE; /* Check if H.264 is supported */ { uint32_t i, num = 0; GUID guids[16]; NvEncGetEncodeGUIDs (GST_NV_BASE_ENC (nvenc)->encoder, guids, G_N_ELEMENTS (guids), &num); for (i = 0; i < num; ++i) { if (gst_nvenc_cmp_guid (guids[i], NV_ENC_CODEC_H264_GUID)) break; } GST_INFO_OBJECT (enc, "H.264 encoding %ssupported", (i == num) ? "un" : ""); if (i == num) { gst_nv_h264_enc_close (enc); return FALSE; } } /* query supported input formats */ if (!_get_supported_profiles (nvenc)) { GST_WARNING_OBJECT (nvenc, "No supported encoding profiles"); gst_nv_h264_enc_close (enc); return FALSE; } return TRUE; } static gboolean gst_nv_h264_enc_close (GstVideoEncoder * enc) { GstNvH264Enc *nvenc = GST_NV_H264_ENC (enc); GST_OBJECT_LOCK (nvenc); g_free (nvenc->supported_profiles); nvenc->supported_profiles = NULL; GST_OBJECT_UNLOCK (nvenc); return GST_VIDEO_ENCODER_CLASS (gst_nv_h264_enc_parent_class)->close (enc); } static GValue * _get_interlace_modes (GstNvH264Enc * nvenc) { NV_ENC_CAPS_PARAM caps_param = { 0, }; GValue *list = g_new0 (GValue, 1); GValue val = G_VALUE_INIT; g_value_init (list, GST_TYPE_LIST); g_value_init (&val, G_TYPE_STRING); g_value_set_static_string (&val, "progressive"); gst_value_list_append_value (list, &val); caps_param.version = NV_ENC_CAPS_PARAM_VER; caps_param.capsToQuery = NV_ENC_CAPS_SUPPORT_FIELD_ENCODING; if (NvEncGetEncodeCaps (GST_NV_BASE_ENC (nvenc)->encoder, NV_ENC_CODEC_H264_GUID, &caps_param, &nvenc->interlace_modes) != NV_ENC_SUCCESS) nvenc->interlace_modes = 0; if (nvenc->interlace_modes >= 1) { g_value_set_static_string (&val, "interleaved"); gst_value_list_append_value (list, &val); g_value_set_static_string (&val, "mixed"); gst_value_list_append_value (list, &val); } /* TODO: figure out what nvenc frame based interlacing means in gst terms */ return list; } static GstCaps * gst_nv_h264_enc_getcaps (GstVideoEncoder * enc, GstCaps * filter) { GstNvH264Enc *nvenc = GST_NV_H264_ENC (enc); GstCaps *supported_incaps = NULL; GstCaps *template_caps, *caps; GValue *input_formats = GST_NV_BASE_ENC (enc)->input_formats; GST_OBJECT_LOCK (nvenc); if (input_formats != NULL) { GValue *val; template_caps = gst_pad_get_pad_template_caps (enc->sinkpad); supported_incaps = gst_caps_copy (template_caps); gst_caps_set_value (supported_incaps, "format", input_formats); val = _get_interlace_modes (nvenc); gst_caps_set_value (supported_incaps, "interlace-mode", val); g_free (val); GST_LOG_OBJECT (enc, "codec input caps %" GST_PTR_FORMAT, supported_incaps); GST_LOG_OBJECT (enc, " template caps %" GST_PTR_FORMAT, template_caps); caps = gst_caps_intersect (template_caps, supported_incaps); gst_caps_unref (template_caps); gst_caps_unref (supported_incaps); supported_incaps = caps; GST_LOG_OBJECT (enc, " supported caps %" GST_PTR_FORMAT, supported_incaps); } GST_OBJECT_UNLOCK (nvenc); caps = gst_video_encoder_proxy_getcaps (enc, supported_incaps, filter); if (supported_incaps) gst_caps_unref (supported_incaps); GST_DEBUG_OBJECT (nvenc, " returning caps %" GST_PTR_FORMAT, caps); return caps; } static gboolean gst_nv_h264_enc_set_profile_and_level (GstNvH264Enc * nvenc, GstCaps * caps) { #define N_BYTES_SPS 128 guint8 sps[N_BYTES_SPS]; NV_ENC_SEQUENCE_PARAM_PAYLOAD spp = { 0, }; GstStructure *s; const gchar *profile; GstCaps *allowed_caps; GstStructure *s2; const gchar *allowed_profile; NVENCSTATUS nv_ret; guint32 seq_size; spp.version = NV_ENC_SEQUENCE_PARAM_PAYLOAD_VER; spp.inBufferSize = N_BYTES_SPS; spp.spsId = 0; spp.ppsId = 0; spp.spsppsBuffer = &sps; spp.outSPSPPSPayloadSize = &seq_size; nv_ret = NvEncGetSequenceParams (GST_NV_BASE_ENC (nvenc)->encoder, &spp); if (nv_ret != NV_ENC_SUCCESS) { GST_ELEMENT_ERROR (nvenc, STREAM, ENCODE, ("Encode header failed."), ("NvEncGetSequenceParams return code=%d", nv_ret)); return FALSE; } if (seq_size < 8) { GST_ELEMENT_ERROR (nvenc, STREAM, ENCODE, ("Encode header failed."), ("NvEncGetSequenceParams returned incomplete data")); return FALSE; } /* skip nal header and identifier */ gst_codec_utils_h264_caps_set_level_and_profile (caps, &sps[5], 3); /* Constrained baseline is a strict subset of baseline. If downstream * wanted baseline and we produced constrained baseline, we can just * set the profile to baseline in the caps to make negotiation happy. * Same goes for baseline as subset of main profile and main as a subset * of high profile. */ s = gst_caps_get_structure (caps, 0); profile = gst_structure_get_string (s, "profile"); allowed_caps = gst_pad_get_allowed_caps (GST_VIDEO_ENCODER_SRC_PAD (nvenc)); if (allowed_caps == NULL) goto no_peer; if (!gst_caps_can_intersect (allowed_caps, caps)) { allowed_caps = gst_caps_make_writable (allowed_caps); allowed_caps = gst_caps_truncate (allowed_caps); s2 = gst_caps_get_structure (allowed_caps, 0); gst_structure_fixate_field_string (s2, "profile", profile); allowed_profile = gst_structure_get_string (s2, "profile"); if (!strcmp (allowed_profile, "high")) { if (!strcmp (profile, "constrained-baseline") || !strcmp (profile, "baseline") || !strcmp (profile, "main")) { gst_structure_set (s, "profile", G_TYPE_STRING, "high", NULL); GST_INFO_OBJECT (nvenc, "downstream requested high profile, but " "encoder will now output %s profile (which is a subset), due " "to how it's been configured", profile); } } else if (!strcmp (allowed_profile, "main")) { if (!strcmp (profile, "constrained-baseline") || !strcmp (profile, "baseline")) { gst_structure_set (s, "profile", G_TYPE_STRING, "main", NULL); GST_INFO_OBJECT (nvenc, "downstream requested main profile, but " "encoder will now output %s profile (which is a subset), due " "to how it's been configured", profile); } } else if (!strcmp (allowed_profile, "baseline")) { if (!strcmp (profile, "constrained-baseline")) gst_structure_set (s, "profile", G_TYPE_STRING, "baseline", NULL); } } gst_caps_unref (allowed_caps); no_peer: return TRUE; #undef N_BYTES_SPS } static gboolean gst_nv_h264_enc_set_src_caps (GstNvBaseEnc * nvenc, GstVideoCodecState * state) { GstNvH264Enc *h264enc = GST_NV_H264_ENC (nvenc); GstVideoCodecState *out_state; GstStructure *s; GstCaps *out_caps; out_caps = gst_caps_new_empty_simple ("video/x-h264"); s = gst_caps_get_structure (out_caps, 0); /* TODO: add support for avc format as well */ gst_structure_set (s, "stream-format", G_TYPE_STRING, "byte-stream", "alignment", G_TYPE_STRING, "au", NULL); if (!gst_nv_h264_enc_set_profile_and_level (h264enc, out_caps)) { gst_caps_unref (out_caps); return FALSE; } out_state = gst_video_encoder_set_output_state (GST_VIDEO_ENCODER (nvenc), out_caps, state); GST_INFO_OBJECT (nvenc, "output caps: %" GST_PTR_FORMAT, out_state->caps); /* encoder will keep it around for us */ gst_video_codec_state_unref (out_state); /* TODO: would be nice to also send some tags with the codec name */ return TRUE; } static gboolean gst_nv_h264_enc_initialize_encoder (GstNvBaseEnc * nvenc, GstVideoCodecState * old_state, GstVideoCodecState * state) { GstNvH264Enc *h264enc = GST_NV_H264_ENC (nvenc); NV_ENC_RECONFIGURE_PARAMS reconfigure_params = { 0, }; NV_ENC_INITIALIZE_PARAMS init_params = { 0, }; NV_ENC_INITIALIZE_PARAMS *params; NV_ENC_PRESET_CONFIG preset_config = { 0, }; NVENCSTATUS nv_ret; GstVideoInfo *info = &state->info; GstCaps *allowed_caps, *template_caps; GUID selected_profile = NV_ENC_CODEC_PROFILE_AUTOSELECT_GUID; int level_idc = NV_ENC_LEVEL_AUTOSELECT; /* TODO: support reconfiguration */ if (old_state) { reconfigure_params.version = NV_ENC_RECONFIGURE_PARAMS_VER; params = &reconfigure_params.reInitEncodeParams; } else { params = &init_params; } template_caps = gst_static_pad_template_get_caps (&src_factory); allowed_caps = gst_pad_get_allowed_caps (GST_VIDEO_ENCODER_SRC_PAD (h264enc)); if (template_caps == allowed_caps) { GST_INFO_OBJECT (h264enc, "downstream has ANY caps"); } else if (allowed_caps) { GstStructure *s; const gchar *profile; const gchar *level; if (gst_caps_is_empty (allowed_caps)) { gst_caps_unref (allowed_caps); gst_caps_unref (template_caps); return FALSE; } allowed_caps = gst_caps_make_writable (allowed_caps); allowed_caps = gst_caps_fixate (allowed_caps); s = gst_caps_get_structure (allowed_caps, 0); profile = gst_structure_get_string (s, "profile"); if (profile) { if (!strcmp (profile, "baseline")) { selected_profile = NV_ENC_H264_PROFILE_BASELINE_GUID; } else if (g_str_has_prefix (profile, "high-4:4:4")) { selected_profile = NV_ENC_H264_PROFILE_HIGH_444_GUID; } else if (g_str_has_prefix (profile, "high-10")) { g_assert_not_reached (); } else if (g_str_has_prefix (profile, "high-4:2:2")) { g_assert_not_reached (); } else if (g_str_has_prefix (profile, "high")) { selected_profile = NV_ENC_H264_PROFILE_HIGH_GUID; } else if (g_str_has_prefix (profile, "main")) { selected_profile = NV_ENC_H264_PROFILE_MAIN_GUID; } else { g_assert_not_reached (); } } level = gst_structure_get_string (s, "level"); if (level) /* matches values stored in NV_ENC_LEVEL */ level_idc = gst_codec_utils_h264_get_level_idc (level); gst_caps_unref (allowed_caps); } gst_caps_unref (template_caps); params->version = NV_ENC_INITIALIZE_PARAMS_VER; params->encodeGUID = NV_ENC_CODEC_H264_GUID; params->encodeWidth = GST_VIDEO_INFO_WIDTH (info); params->encodeHeight = GST_VIDEO_INFO_HEIGHT (info); /* FIXME: make this a property */ params->presetGUID = NV_ENC_PRESET_HP_GUID; // _DEFAULT params->enablePTD = 1; if (!old_state) { /* this sets the required buffer size and the maximum allowed size on * subsequent reconfigures */ /* FIXME: propertise this */ params->maxEncodeWidth = GST_VIDEO_INFO_WIDTH (info); params->maxEncodeHeight = GST_VIDEO_INFO_HEIGHT (info); gst_nv_base_enc_set_max_encode_size (GST_NV_BASE_ENC (h264enc), params->maxEncodeWidth, params->maxEncodeHeight); } else { guint max_width, max_height; gst_nv_base_enc_get_max_encode_size (GST_NV_BASE_ENC (h264enc), &max_width, &max_height); if (GST_VIDEO_INFO_WIDTH (info) > max_width || GST_VIDEO_INFO_HEIGHT (info) > max_height) { GST_ELEMENT_ERROR (h264enc, STREAM, FORMAT, ("%s", "Requested stream " "size is larger than the maximum configured size"), (NULL)); return FALSE; } } preset_config.version = NV_ENC_PRESET_CONFIG_VER; preset_config.presetCfg.version = NV_ENC_CONFIG_VER; nv_ret = NvEncGetEncodePresetConfig (GST_NV_BASE_ENC (h264enc)->encoder, params->encodeGUID, params->presetGUID, &preset_config); if (nv_ret != NV_ENC_SUCCESS) { GST_ELEMENT_ERROR (h264enc, LIBRARY, SETTINGS, (NULL), ("Failed to get encode preset configuration: %d", nv_ret)); return FALSE; } params->encodeConfig = &preset_config.presetCfg; /* override some defaults */ GST_LOG_OBJECT (h264enc, "setting parameters"); preset_config.presetCfg.version = NV_ENC_CONFIG_VER; preset_config.presetCfg.profileGUID = selected_profile; preset_config.presetCfg.encodeCodecConfig.h264Config.level = level_idc; preset_config.presetCfg.encodeCodecConfig.h264Config.chromaFormatIDC = 1; if (GST_VIDEO_INFO_FORMAT (info) == GST_VIDEO_FORMAT_Y444) { GST_DEBUG_OBJECT (h264enc, "have Y444 input, setting config accordingly"); preset_config.presetCfg.encodeCodecConfig. h264Config.separateColourPlaneFlag = 1; preset_config.presetCfg.encodeCodecConfig.h264Config.chromaFormatIDC = 3; } /* FIXME: make property */ preset_config.presetCfg.encodeCodecConfig.h264Config.outputAUD = 1; if (GST_VIDEO_INFO_IS_INTERLACED (info)) { if (GST_VIDEO_INFO_INTERLACE_MODE (info) == GST_VIDEO_INTERLACE_MODE_INTERLEAVED || GST_VIDEO_INFO_INTERLACE_MODE (info) == GST_VIDEO_INTERLACE_MODE_MIXED) { preset_config.presetCfg.frameFieldMode = NV_ENC_PARAMS_FRAME_FIELD_MODE_FIELD; } } if (info->fps_d > 0 && info->fps_n > 0) { params->frameRateNum = info->fps_n; params->frameRateDen = info->fps_d; } else { GST_FIXME_OBJECT (h264enc, "variable framerate"); } if (old_state) { nv_ret = NvEncReconfigureEncoder (GST_NV_BASE_ENC (h264enc)->encoder, &reconfigure_params); } else { nv_ret = NvEncInitializeEncoder (GST_NV_BASE_ENC (h264enc)->encoder, params); } if (nv_ret != NV_ENC_SUCCESS) { GST_ELEMENT_ERROR (h264enc, LIBRARY, SETTINGS, (NULL), ("Failed to %sinit encoder: %d", old_state ? "re" : "", nv_ret)); return FALSE; } GST_INFO_OBJECT (h264enc, "configured encoder"); return TRUE; } static gboolean gst_nv_h264_enc_set_pic_params (GstNvBaseEnc * enc, GstVideoCodecFrame * frame, NV_ENC_PIC_PARAMS * pic_params) { /* encode whole picture in one single slice */ pic_params->codecPicParams.h264PicParams.sliceMode = 0; pic_params->codecPicParams.h264PicParams.sliceModeData = 0; return TRUE; } static void gst_nv_h264_enc_set_property (GObject * object, guint prop_id, const GValue * value, GParamSpec * pspec) { switch (prop_id) { default: G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); break; } } static void gst_nv_h264_enc_get_property (GObject * object, guint prop_id, GValue * value, GParamSpec * pspec) { switch (prop_id) { default: G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); break; } }