sys/msdk/gstmsdkh265enc.c

   1 /* GStreamer Intel MSDK plugin
   2  * Copyright (c) 2016, Oblong Industries, Inc.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are met:
   7  *
   8  * 1. Redistributions of source code must retain the above copyright notice,
   9  *    this list of conditions and the following disclaimer.
  10  *
  11  * 2. Redistributions in binary form must reproduce the above copyright notice,
  12  *    this list of conditions and the following disclaimer in the documentation
  13  *    and/or other materials provided with the distribution.
  14  *
  15  * 3. Neither the name of the copyright holder nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  21  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  22  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
  23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  24  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  25  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  26  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  27  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  28  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  29  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #ifdef HAVE_CONFIG_H
  33 #  include <config.h>
  34 #endif
  35
  36 #include <mfxplugin.h>
  37
  38 #include <gst/allocators/gstdmabuf.h>
  39
  40 #include "gstmsdkh265enc.h"
  41
  42 GST_DEBUG_CATEGORY_EXTERN (gst_msdkh265enc_debug);
  43 #define GST_CAT_DEFAULT gst_msdkh265enc_debug
  44
  45 enum
  46 {
  47   PROP_LOW_POWER = GST_MSDKENC_PROP_MAX,
  48 };
  49
  50 #define PROP_LOWPOWER_DEFAULT           FALSE
  51
  52 #define COMMON_FORMAT "{ NV12, I420, YV12, YUY2, UYVY, BGRA, P010_10LE }"
  53
  54 static GstStaticPadTemplate sink_factory = GST_STATIC_PAD_TEMPLATE ("sink",
  55     GST_PAD_SINK,
  56     GST_PAD_ALWAYS,
  57     GST_STATIC_CAPS (GST_MSDK_CAPS_STR (COMMON_FORMAT, "NV12")));
  58
  59 static GstStaticPadTemplate src_factory = GST_STATIC_PAD_TEMPLATE ("src",
  60     GST_PAD_SRC,
  61     GST_PAD_ALWAYS,
  62     GST_STATIC_CAPS ("video/x-h265, "
  63         "framerate = (fraction) [0/1, MAX], "
  64         "width = (int) [ 1, MAX ], height = (int) [ 1, MAX ], "
  65         "stream-format = (string) byte-stream , alignment = (string) au , "
  66         "profile = (string) { main, main-10 } ")
  67     );
  68
  69 #define gst_msdkh265enc_parent_class parent_class
  70 G_DEFINE_TYPE (GstMsdkH265Enc, gst_msdkh265enc, GST_TYPE_MSDKENC);
  71
  72 static gboolean
  73 gst_msdkh265enc_set_format (GstMsdkEnc * encoder)
  74 {
  75   return TRUE;
  76 }
  77
  78 static gboolean
  79 gst_msdkh265enc_configure (GstMsdkEnc * encoder)
  80 {
  81   GstMsdkH265Enc *h265enc = GST_MSDKH265ENC (encoder);
  82   mfxSession session;
  83   mfxStatus status;
  84   const mfxPluginUID *uid;
  85
  86   session = gst_msdk_context_get_session (encoder->context);
  87
  88   if (encoder->hardware)
  89     uid = &MFX_PLUGINID_HEVCE_HW;
  90   else
  91     uid = &MFX_PLUGINID_HEVCE_SW;
  92
  93   status = MFXVideoUSER_Load (session, uid, 1);
  94   if (status < MFX_ERR_NONE) {
  95     GST_ERROR_OBJECT (h265enc, "Media SDK Plugin load failed (%s)",
  96         msdk_status_to_string (status));
  97     return FALSE;
  98   } else if (status > MFX_ERR_NONE) {
  99     GST_WARNING_OBJECT (h265enc, "Media SDK Plugin load warning: %s",
 100         msdk_status_to_string (status));
 101   }
 102
 103   encoder->param.mfx.CodecId = MFX_CODEC_HEVC;
 104
 105   switch (encoder->param.mfx.FrameInfo.FourCC) {
 106     case MFX_FOURCC_P010:
 107       encoder->param.mfx.CodecProfile = MFX_PROFILE_HEVC_MAIN10;
 108       break;
 109     default:
 110       encoder->param.mfx.CodecProfile = MFX_PROFILE_HEVC_MAIN;
 111   }
 112
 113   /* IdrInterval field of MediaSDK HEVC encoder behaves differently
 114    * than other encoders. IdrInteval == 1 indicate every
 115    * I-frame should be an IDR, IdrInteval == 2 means every other
 116    * I-frame is an IDR etc. So we generalize the behaviour of property
 117    * "i-frames" by incrementing the value by one in each case*/
 118   encoder->param.mfx.IdrInterval += 1;
 119
 120   /* Enable Extended coding options */
 121   gst_msdkenc_ensure_extended_coding_options (encoder);
 122
 123   encoder->param.mfx.LowPower =
 124       (h265enc->lowpower ? MFX_CODINGOPTION_ON : MFX_CODINGOPTION_OFF);
 125
 126   return TRUE;
 127 }
 128
 129 static inline const gchar *
 130 level_to_string (gint level)
 131 {
 132   switch (level) {
 133     case MFX_LEVEL_HEVC_1:
 134       return "1";
 135     case MFX_LEVEL_HEVC_2:
 136       return "2";
 137     case MFX_LEVEL_HEVC_21:
 138       return "2.1";
 139     case MFX_LEVEL_HEVC_3:
 140       return "3";
 141     case MFX_LEVEL_HEVC_31:
 142       return "3.1";
 143     case MFX_LEVEL_HEVC_4:
 144       return "4";
 145     case MFX_LEVEL_HEVC_41:
 146       return "4.1";
 147     case MFX_LEVEL_HEVC_5:
 148       return "5";
 149     case MFX_LEVEL_HEVC_51:
 150       return "5.1";
 151     case MFX_LEVEL_HEVC_52:
 152       return "5.2";
 153     case MFX_LEVEL_HEVC_6:
 154       return "6";
 155     case MFX_LEVEL_HEVC_61:
 156       return "6.1";
 157     case MFX_LEVEL_HEVC_62:
 158       return "6.2";
 159     default:
 160       break;
 161   }
 162
 163   return NULL;
 164 }
 165
 166 static GstCaps *
 167 gst_msdkh265enc_set_src_caps (GstMsdkEnc * encoder)
 168 {
 169   GstCaps *caps;
 170   GstStructure *structure;
 171   const gchar *level;
 172
 173   caps = gst_caps_new_empty_simple ("video/x-h265");
 174   structure = gst_caps_get_structure (caps, 0);
 175
 176   gst_structure_set (structure, "stream-format", G_TYPE_STRING, "byte-stream",
 177       NULL);
 178
 179   gst_structure_set (structure, "alignment", G_TYPE_STRING, "au", NULL);
 180
 181   switch (encoder->param.mfx.FrameInfo.FourCC) {
 182     case MFX_FOURCC_P010:
 183       gst_structure_set (structure, "profile", G_TYPE_STRING, "main-10", NULL);
 184       break;
 185     default:
 186       gst_structure_set (structure, "profile", G_TYPE_STRING, "main", NULL);
 187       break;
 188   }
 189
 190   level = level_to_string (encoder->param.mfx.CodecLevel);
 191   if (level)
 192     gst_structure_set (structure, "level", G_TYPE_STRING, level, NULL);
 193
 194   return caps;
 195 }
 196
 197 static void
 198 gst_msdkh265enc_set_property (GObject * object, guint prop_id,
 199     const GValue * value, GParamSpec * pspec)
 200 {
 201   GstMsdkH265Enc *thiz = GST_MSDKH265ENC (object);
 202
 203   if (gst_msdkenc_set_common_property (object, prop_id, value, pspec))
 204     return;
 205
 206   GST_OBJECT_LOCK (thiz);
 207
 208   switch (prop_id) {
 209     case PROP_LOW_POWER:
 210       thiz->lowpower = g_value_get_boolean (value);
 211       break;
 212     default:
 213       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 214       break;
 215   }
 216   GST_OBJECT_UNLOCK (thiz);
 217 }
 218
 219 static void
 220 gst_msdkh265enc_get_property (GObject * object, guint prop_id, GValue * value,
 221     GParamSpec * pspec)
 222 {
 223   GstMsdkH265Enc *thiz = GST_MSDKH265ENC (object);
 224
 225   if (gst_msdkenc_get_common_property (object, prop_id, value, pspec))
 226     return;
 227
 228   GST_OBJECT_LOCK (thiz);
 229   switch (prop_id) {
 230     case PROP_LOW_POWER:
 231       g_value_set_boolean (value, thiz->lowpower);
 232       break;
 233     default:
 234       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 235       break;
 236   }
 237   GST_OBJECT_UNLOCK (thiz);
 238 }
 239
 240 static void
 241 gst_msdkh265enc_class_init (GstMsdkH265EncClass * klass)
 242 {
 243   GObjectClass *gobject_class;
 244   GstElementClass *element_class;
 245   GstMsdkEncClass *encoder_class;
 246
 247   gobject_class = G_OBJECT_CLASS (klass);
 248   element_class = GST_ELEMENT_CLASS (klass);
 249   encoder_class = GST_MSDKENC_CLASS (klass);
 250
 251   gobject_class->set_property = gst_msdkh265enc_set_property;
 252   gobject_class->get_property = gst_msdkh265enc_get_property;
 253
 254   encoder_class->set_format = gst_msdkh265enc_set_format;
 255   encoder_class->configure = gst_msdkh265enc_configure;
 256   encoder_class->set_src_caps = gst_msdkh265enc_set_src_caps;
 257
 258   gst_msdkenc_install_common_properties (encoder_class);
 259
 260   g_object_class_install_property (gobject_class, PROP_LOW_POWER,
 261       g_param_spec_boolean ("low-power", "Low power", "Enable low power mode",
 262           PROP_LOWPOWER_DEFAULT, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 263
 264   gst_element_class_set_static_metadata (element_class,
 265       "Intel MSDK H265 encoder",
 266       "Codec/Encoder/Video/Hardware",
 267       "H265 video encoder based on Intel Media SDK",
 268       "Josep Torra <jtorra@oblong.com>");
 269
 270   gst_element_class_add_static_pad_template (element_class, &sink_factory);
 271   gst_element_class_add_static_pad_template (element_class, &src_factory);
 272 }
 273
 274 static void
 275 gst_msdkh265enc_init (GstMsdkH265Enc * thiz)
 276 {
 277   GstMsdkEnc *msdk_enc = (GstMsdkEnc *) thiz;
 278   thiz->lowpower = PROP_LOWPOWER_DEFAULT;
 279   msdk_enc->num_extra_frames = 1;
 280 }