msdk: encoder: h265: generalize the behavior of "i-frames" property
[platform/upstream/gstreamer.git] / 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 #ifdef HAVE_LIBMFX
37 #  include <mfx/mfxplugin.h>
38 #else
39 #  include "mfxplugin.h"
40 #endif
41
42 #include "gstmsdkh265enc.h"
43
44 GST_DEBUG_CATEGORY_EXTERN (gst_msdkh265enc_debug);
45 #define GST_CAT_DEFAULT gst_msdkh265enc_debug
46
47 static GstStaticPadTemplate src_factory = GST_STATIC_PAD_TEMPLATE ("src",
48     GST_PAD_SRC,
49     GST_PAD_ALWAYS,
50     GST_STATIC_CAPS ("video/x-h265, "
51         "framerate = (fraction) [0/1, MAX], "
52         "width = (int) [ 1, MAX ], height = (int) [ 1, MAX ], "
53         "stream-format = (string) byte-stream , alignment = (string) au , "
54         "profile = (string) main")
55     );
56
57 #define gst_msdkh265enc_parent_class parent_class
58 G_DEFINE_TYPE (GstMsdkH265Enc, gst_msdkh265enc, GST_TYPE_MSDKENC);
59
60 static gboolean
61 gst_msdkh265enc_set_format (GstMsdkEnc * encoder)
62 {
63   return TRUE;
64 }
65
66 static gboolean
67 gst_msdkh265enc_configure (GstMsdkEnc * encoder)
68 {
69   GstMsdkH265Enc *h265enc = GST_MSDKH265ENC (encoder);
70   mfxSession session;
71   mfxStatus status;
72   const mfxPluginUID *uid;
73
74   session = gst_msdk_context_get_session (encoder->context);
75
76   if (encoder->hardware)
77     uid = &MFX_PLUGINID_HEVCE_HW;
78   else
79     uid = &MFX_PLUGINID_HEVCE_SW;
80
81   status = MFXVideoUSER_Load (session, uid, 1);
82   if (status < MFX_ERR_NONE) {
83     GST_ERROR_OBJECT (h265enc, "Media SDK Plugin load failed (%s)",
84         msdk_status_to_string (status));
85     return FALSE;
86   } else if (status > MFX_ERR_NONE) {
87     GST_WARNING_OBJECT (h265enc, "Media SDK Plugin load warning: %s",
88         msdk_status_to_string (status));
89   }
90
91   encoder->param.mfx.CodecId = MFX_CODEC_HEVC;
92   encoder->param.mfx.CodecProfile = MFX_PROFILE_HEVC_MAIN;
93
94   /* IdrInterval field of MediaSDK HEVC encoder behaves differently
95    * than other encoders. IdrInteval == 1 indicate every
96    * I-frame should be an IDR, IdrInteval == 2 means every other
97    * I-frame is an IDR etc. So we generalize the behaviour of property
98    * "i-frames" by incrementing the value by one in each case*/
99   encoder->param.mfx.IdrInterval += 1;
100
101   return TRUE;
102 }
103
104 static inline const gchar *
105 level_to_string (gint level)
106 {
107   switch (level) {
108     case MFX_LEVEL_HEVC_1:
109       return "1";
110     case MFX_LEVEL_HEVC_2:
111       return "2";
112     case MFX_LEVEL_HEVC_21:
113       return "2.1";
114     case MFX_LEVEL_HEVC_3:
115       return "3";
116     case MFX_LEVEL_HEVC_31:
117       return "3.1";
118     case MFX_LEVEL_HEVC_4:
119       return "4";
120     case MFX_LEVEL_HEVC_41:
121       return "4.1";
122     case MFX_LEVEL_HEVC_5:
123       return "5";
124     case MFX_LEVEL_HEVC_51:
125       return "5.1";
126     case MFX_LEVEL_HEVC_52:
127       return "5.2";
128     case MFX_LEVEL_HEVC_6:
129       return "6";
130     case MFX_LEVEL_HEVC_61:
131       return "6.1";
132     case MFX_LEVEL_HEVC_62:
133       return "6.2";
134     default:
135       break;
136   }
137
138   return NULL;
139 }
140
141 static GstCaps *
142 gst_msdkh265enc_set_src_caps (GstMsdkEnc * encoder)
143 {
144   GstCaps *caps;
145   GstStructure *structure;
146   const gchar *level;
147
148   caps = gst_caps_new_empty_simple ("video/x-h265");
149   structure = gst_caps_get_structure (caps, 0);
150
151   gst_structure_set (structure, "stream-format", G_TYPE_STRING, "byte-stream",
152       NULL);
153
154   gst_structure_set (structure, "alignment", G_TYPE_STRING, "au", NULL);
155
156   gst_structure_set (structure, "profile", G_TYPE_STRING, "main", NULL);
157
158   level = level_to_string (encoder->param.mfx.CodecLevel);
159   if (level)
160     gst_structure_set (structure, "level", G_TYPE_STRING, level, NULL);
161
162   return caps;
163 }
164
165 static void
166 gst_msdkh265enc_set_property (GObject * object, guint prop_id,
167     const GValue * value, GParamSpec * pspec)
168 {
169   GstMsdkH265Enc *thiz = GST_MSDKH265ENC (object);
170
171   if (!gst_msdkenc_set_common_property (object, prop_id, value, pspec))
172     GST_WARNING_OBJECT (thiz, "Failed to set common encode property");
173 }
174
175 static void
176 gst_msdkh265enc_get_property (GObject * object, guint prop_id, GValue * value,
177     GParamSpec * pspec)
178 {
179   GstMsdkH265Enc *thiz = GST_MSDKH265ENC (object);
180
181   if (!gst_msdkenc_get_common_property (object, prop_id, value, pspec))
182     GST_WARNING_OBJECT (thiz, "Failed to get common encode property");
183 }
184
185 static void
186 gst_msdkh265enc_class_init (GstMsdkH265EncClass * klass)
187 {
188   GObjectClass *gobject_class;
189   GstElementClass *element_class;
190   GstMsdkEncClass *encoder_class;
191
192   gobject_class = G_OBJECT_CLASS (klass);
193   element_class = GST_ELEMENT_CLASS (klass);
194   encoder_class = GST_MSDKENC_CLASS (klass);
195
196   gobject_class->set_property = gst_msdkh265enc_set_property;
197   gobject_class->get_property = gst_msdkh265enc_get_property;
198
199   encoder_class->set_format = gst_msdkh265enc_set_format;
200   encoder_class->configure = gst_msdkh265enc_configure;
201   encoder_class->set_src_caps = gst_msdkh265enc_set_src_caps;
202
203   gst_msdkenc_install_common_properties (encoder_class);
204
205   gst_element_class_set_static_metadata (element_class,
206       "Intel MSDK H265 encoder",
207       "Codec/Encoder/Video",
208       "H265 video encoder based on Intel Media SDK",
209       "Josep Torra <jtorra@oblong.com>");
210
211   gst_element_class_add_static_pad_template (element_class, &src_factory);
212 }
213
214 static void
215 gst_msdkh265enc_init (GstMsdkH265Enc * thiz)
216 {
217 }