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 <gst/allocators/gstdmabuf.h>
  37
  38 #include "gstmsdkh265enc.h"
  39
  40 GST_DEBUG_CATEGORY_EXTERN (gst_msdkh265enc_debug);
  41 #define GST_CAT_DEFAULT gst_msdkh265enc_debug
  42
  43 enum
  44 {
  45   PROP_LOW_POWER = GST_MSDKENC_PROP_MAX,
  46   PROP_TILE_ROW,
  47   PROP_TILE_COL,
  48 };
  49
  50 #define PROP_LOWPOWER_DEFAULT           FALSE
  51 #define PROP_TILE_ROW_DEFAULT           1
  52 #define PROP_TILE_COL_DEFAULT           1
  53
  54 #define RAW_FORMATS "NV12, I420, YV12, YUY2, UYVY, BGRA, P010_10LE, VUYA"
  55
  56 #if (MFX_VERSION >= 1027)
  57 #define COMMON_FORMAT "{ " RAW_FORMATS ", Y410 }"
  58 #else
  59 #define COMMON_FORMAT "{ " RAW_FORMATS " }"
  60 #endif
  61
  62 static GstStaticPadTemplate sink_factory = GST_STATIC_PAD_TEMPLATE ("sink",
  63     GST_PAD_SINK,
  64     GST_PAD_ALWAYS,
  65     GST_STATIC_CAPS (GST_MSDK_CAPS_STR (COMMON_FORMAT,
  66             "{ NV12, P010_10LE }")));
  67
  68 static GstStaticPadTemplate src_factory = GST_STATIC_PAD_TEMPLATE ("src",
  69     GST_PAD_SRC,
  70     GST_PAD_ALWAYS,
  71     GST_STATIC_CAPS ("video/x-h265, "
  72         "framerate = (fraction) [0/1, MAX], "
  73         "width = (int) [ 1, MAX ], height = (int) [ 1, MAX ], "
  74         "stream-format = (string) byte-stream , alignment = (string) au , "
  75         "profile = (string) { main, main-10, main-444, main-444-10 } ")
  76     );
  77
  78 #define gst_msdkh265enc_parent_class parent_class
  79 G_DEFINE_TYPE (GstMsdkH265Enc, gst_msdkh265enc, GST_TYPE_MSDKENC);
  80
  81 static gboolean
  82 gst_msdkh265enc_set_format (GstMsdkEnc * encoder)
  83 {
  84   return TRUE;
  85 }
  86
  87 static gboolean
  88 gst_msdkh265enc_configure (GstMsdkEnc * encoder)
  89 {
  90   GstMsdkH265Enc *h265enc = GST_MSDKH265ENC (encoder);
  91   mfxSession session;
  92   const mfxPluginUID *uid;
  93
  94   session = gst_msdk_context_get_session (encoder->context);
  95
  96   if (encoder->hardware)
  97     uid = &MFX_PLUGINID_HEVCE_HW;
  98   else
  99     uid = &MFX_PLUGINID_HEVCE_SW;
 100
 101   if (!gst_msdk_load_plugin (session, uid, 1, "msdkh265enc"))
 102     return FALSE;
 103
 104   encoder->param.mfx.CodecId = MFX_CODEC_HEVC;
 105
 106   switch (encoder->param.mfx.FrameInfo.FourCC) {
 107     case MFX_FOURCC_P010:
 108       encoder->param.mfx.CodecProfile = MFX_PROFILE_HEVC_MAIN10;
 109       break;
 110     case MFX_FOURCC_AYUV:
 111 #if (MFX_VERSION >= 1027)
 112     case MFX_FOURCC_Y410:
 113 #endif
 114       encoder->param.mfx.CodecProfile = MFX_PROFILE_HEVC_REXT;
 115       break;
 116     default:
 117       encoder->param.mfx.CodecProfile = MFX_PROFILE_HEVC_MAIN;
 118   }
 119
 120   /* IdrInterval field of MediaSDK HEVC encoder behaves differently
 121    * than other encoders. IdrInteval == 1 indicate every
 122    * I-frame should be an IDR, IdrInteval == 2 means every other
 123    * I-frame is an IDR etc. So we generalize the behaviour of property
 124    * "i-frames" by incrementing the value by one in each case*/
 125   encoder->param.mfx.IdrInterval += 1;
 126
 127   /* Enable Extended coding options */
 128   gst_msdkenc_ensure_extended_coding_options (encoder);
 129
 130   if (h265enc->num_tile_rows > 1 || h265enc->num_tile_cols > 1) {
 131     h265enc->ext_tiles.Header.BufferId = MFX_EXTBUFF_HEVC_TILES;
 132     h265enc->ext_tiles.Header.BufferSz = sizeof (h265enc->ext_tiles);
 133     h265enc->ext_tiles.NumTileRows = h265enc->num_tile_rows;
 134     h265enc->ext_tiles.NumTileColumns = h265enc->num_tile_cols;
 135
 136     gst_msdkenc_add_extra_param (encoder,
 137         (mfxExtBuffer *) & h265enc->ext_tiles);
 138
 139     /* Set a valid value to NumSlice */
 140     if (encoder->param.mfx.NumSlice == 0)
 141       encoder->param.mfx.NumSlice =
 142           h265enc->num_tile_rows * h265enc->num_tile_cols;
 143   }
 144
 145   encoder->param.mfx.LowPower =
 146       (h265enc->lowpower ? MFX_CODINGOPTION_ON : MFX_CODINGOPTION_OFF);
 147
 148   return TRUE;
 149 }
 150
 151 static inline const gchar *
 152 level_to_string (gint level)
 153 {
 154   switch (level) {
 155     case MFX_LEVEL_HEVC_1:
 156       return "1";
 157     case MFX_LEVEL_HEVC_2:
 158       return "2";
 159     case MFX_LEVEL_HEVC_21:
 160       return "2.1";
 161     case MFX_LEVEL_HEVC_3:
 162       return "3";
 163     case MFX_LEVEL_HEVC_31:
 164       return "3.1";
 165     case MFX_LEVEL_HEVC_4:
 166       return "4";
 167     case MFX_LEVEL_HEVC_41:
 168       return "4.1";
 169     case MFX_LEVEL_HEVC_5:
 170       return "5";
 171     case MFX_LEVEL_HEVC_51:
 172       return "5.1";
 173     case MFX_LEVEL_HEVC_52:
 174       return "5.2";
 175     case MFX_LEVEL_HEVC_6:
 176       return "6";
 177     case MFX_LEVEL_HEVC_61:
 178       return "6.1";
 179     case MFX_LEVEL_HEVC_62:
 180       return "6.2";
 181     default:
 182       break;
 183   }
 184
 185   return NULL;
 186 }
 187
 188 static GstCaps *
 189 gst_msdkh265enc_set_src_caps (GstMsdkEnc * encoder)
 190 {
 191   GstCaps *caps;
 192   GstStructure *structure;
 193   const gchar *level;
 194
 195   caps = gst_caps_new_empty_simple ("video/x-h265");
 196   structure = gst_caps_get_structure (caps, 0);
 197
 198   gst_structure_set (structure, "stream-format", G_TYPE_STRING, "byte-stream",
 199       NULL);
 200
 201   gst_structure_set (structure, "alignment", G_TYPE_STRING, "au", NULL);
 202
 203   switch (encoder->param.mfx.FrameInfo.FourCC) {
 204     case MFX_FOURCC_P010:
 205       gst_structure_set (structure, "profile", G_TYPE_STRING, "main-10", NULL);
 206       break;
 207     case MFX_FOURCC_AYUV:
 208       gst_structure_set (structure, "profile", G_TYPE_STRING, "main-444", NULL);
 209       break;
 210 #if (MFX_VERSION >= 1027)
 211     case MFX_FOURCC_Y410:
 212       gst_structure_set (structure, "profile", G_TYPE_STRING, "main-444-10",
 213           NULL);
 214       break;
 215 #endif
 216     default:
 217       gst_structure_set (structure, "profile", G_TYPE_STRING, "main", NULL);
 218       break;
 219   }
 220
 221   level = level_to_string (encoder->param.mfx.CodecLevel);
 222   if (level)
 223     gst_structure_set (structure, "level", G_TYPE_STRING, level, NULL);
 224
 225   return caps;
 226 }
 227
 228 static void
 229 gst_msdkh265enc_set_property (GObject * object, guint prop_id,
 230     const GValue * value, GParamSpec * pspec)
 231 {
 232   GstMsdkH265Enc *thiz = GST_MSDKH265ENC (object);
 233
 234   if (gst_msdkenc_set_common_property (object, prop_id, value, pspec))
 235     return;
 236
 237   GST_OBJECT_LOCK (thiz);
 238
 239   switch (prop_id) {
 240     case PROP_LOW_POWER:
 241       thiz->lowpower = g_value_get_boolean (value);
 242       break;
 243
 244     case PROP_TILE_ROW:
 245       thiz->num_tile_rows = g_value_get_uint (value);
 246       break;
 247
 248     case PROP_TILE_COL:
 249       thiz->num_tile_cols = g_value_get_uint (value);
 250       break;
 251
 252     default:
 253       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 254       break;
 255   }
 256   GST_OBJECT_UNLOCK (thiz);
 257 }
 258
 259 static void
 260 gst_msdkh265enc_get_property (GObject * object, guint prop_id, GValue * value,
 261     GParamSpec * pspec)
 262 {
 263   GstMsdkH265Enc *thiz = GST_MSDKH265ENC (object);
 264
 265   if (gst_msdkenc_get_common_property (object, prop_id, value, pspec))
 266     return;
 267
 268   GST_OBJECT_LOCK (thiz);
 269   switch (prop_id) {
 270     case PROP_LOW_POWER:
 271       g_value_set_boolean (value, thiz->lowpower);
 272       break;
 273
 274     case PROP_TILE_ROW:
 275       g_value_set_uint (value, thiz->num_tile_rows);
 276       break;
 277
 278     case PROP_TILE_COL:
 279       g_value_set_uint (value, thiz->num_tile_cols);
 280       break;
 281
 282     default:
 283       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 284       break;
 285   }
 286   GST_OBJECT_UNLOCK (thiz);
 287 }
 288
 289 static gboolean
 290 gst_msdkh265enc_need_reconfig (GstMsdkEnc * encoder, GstVideoCodecFrame * frame)
 291 {
 292   GstMsdkH265Enc *h265enc = GST_MSDKH265ENC (encoder);
 293
 294   return gst_msdkenc_get_roi_params (encoder, frame, h265enc->roi);
 295 }
 296
 297 static void
 298 gst_msdkh265enc_set_extra_params (GstMsdkEnc * encoder,
 299     GstVideoCodecFrame * frame)
 300 {
 301   GstMsdkH265Enc *h265enc = GST_MSDKH265ENC (encoder);
 302
 303   if (h265enc->roi[0].NumROI)
 304     gst_msdkenc_add_extra_param (encoder, (mfxExtBuffer *) & h265enc->roi[0]);
 305 }
 306
 307 static void
 308 gst_msdkh265enc_class_init (GstMsdkH265EncClass * klass)
 309 {
 310   GObjectClass *gobject_class;
 311   GstElementClass *element_class;
 312   GstMsdkEncClass *encoder_class;
 313
 314   gobject_class = G_OBJECT_CLASS (klass);
 315   element_class = GST_ELEMENT_CLASS (klass);
 316   encoder_class = GST_MSDKENC_CLASS (klass);
 317
 318   gobject_class->set_property = gst_msdkh265enc_set_property;
 319   gobject_class->get_property = gst_msdkh265enc_get_property;
 320
 321   encoder_class->set_format = gst_msdkh265enc_set_format;
 322   encoder_class->configure = gst_msdkh265enc_configure;
 323   encoder_class->set_src_caps = gst_msdkh265enc_set_src_caps;
 324   encoder_class->need_reconfig = gst_msdkh265enc_need_reconfig;
 325   encoder_class->set_extra_params = gst_msdkh265enc_set_extra_params;
 326
 327   gst_msdkenc_install_common_properties (encoder_class);
 328
 329   g_object_class_install_property (gobject_class, PROP_LOW_POWER,
 330       g_param_spec_boolean ("low-power", "Low power", "Enable low power mode",
 331           PROP_LOWPOWER_DEFAULT, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 332
 333   g_object_class_install_property (gobject_class, PROP_TILE_ROW,
 334       g_param_spec_uint ("num-tile-rows", "number of rows for tiled encoding",
 335           "number of rows for tiled encoding",
 336           1, 8192, PROP_TILE_ROW_DEFAULT,
 337           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 338
 339   g_object_class_install_property (gobject_class, PROP_TILE_COL,
 340       g_param_spec_uint ("num-tile-cols",
 341           "number of columns for tiled encoding",
 342           "number of columns for tiled encoding", 1, 8192,
 343           PROP_TILE_COL_DEFAULT, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 344
 345   gst_element_class_set_static_metadata (element_class,
 346       "Intel MSDK H265 encoder",
 347       "Codec/Encoder/Video/Hardware",
 348       "H265 video encoder based on Intel Media SDK",
 349       "Josep Torra <jtorra@oblong.com>");
 350
 351   gst_element_class_add_static_pad_template (element_class, &sink_factory);
 352   gst_element_class_add_static_pad_template (element_class, &src_factory);
 353 }
 354
 355 static void
 356 gst_msdkh265enc_init (GstMsdkH265Enc * thiz)
 357 {
 358   GstMsdkEnc *msdk_enc = (GstMsdkEnc *) thiz;
 359   thiz->lowpower = PROP_LOWPOWER_DEFAULT;
 360   thiz->num_tile_rows = PROP_TILE_ROW_DEFAULT;
 361   thiz->num_tile_cols = PROP_TILE_COL_DEFAULT;
 362   msdk_enc->num_extra_frames = 1;
 363 }