qt: fix release order of QML components when using DirectComposition
[vlc.git] / modules / codec / qsv.c
1 /*****************************************************************************
2  * qsv.c: mpeg4-part10/mpeg2 video encoder using Intel Media SDK
3  *****************************************************************************
4  * Copyright (C) 2013 VideoLabs
5  *
6  * Authors: Julien 'Lta' BALLET <contact@lta.io>
7  *
8  * This program is free software; you can redistribute it and/or modify it
9  * under the terms of the GNU Lesser General Public License as published by
10  * the Free Software Foundation; either version 2.1 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
21  *****************************************************************************/
22
23 /*****************************************************************************
24  * Preamble
25  *****************************************************************************/
26 #ifdef HAVE_CONFIG_H
27 # include "config.h"
28 #endif
29
30 #include <vlc_common.h>
31 #include <vlc_plugin.h>
32 #include <vlc_picture.h>
33 #include <vlc_codec.h>
34 #include <vlc_picture_pool.h>
35
36 #include "vlc_fifo_helper.h"
37
38 #include <mfx/mfxvideo.h>
39 #include "../demux/mpeg/timestamps.h"
40
41 #define SOUT_CFG_PREFIX     "sout-qsv-"
42
43 #define QSV_HAVE_CO2 (MFX_VERSION_MAJOR > 1 || (MFX_VERSION_MAJOR == 1 && MFX_VERSION_MINOR >= 6))
44
45 /* Default wait on libavcodec */
46 #define QSV_SYNCPOINT_WAIT  (1000)
47 /* Encoder input synchronization busy wait loop time */
48 #define QSV_BUSYWAIT_TIME   VLC_HARD_MIN_SLEEP
49 /* The SDK doesn't have a default bitrate, so here's one. */
50 #define QSV_BITRATE_DEFAULT (842)
51
52 /*****************************************************************************
53  * Modules descriptor
54  *****************************************************************************/
55 static int      Open(vlc_object_t *);
56 static void     Close(vlc_object_t *);
57
58 #define SW_IMPL_TEXT N_("Enable software mode")
59 #define SW_IMPL_LONGTEXT N_("Allow the use of the Intel Media SDK software " \
60      "implementation of the codecs if no QuickSync Video hardware " \
61      "acceleration is present on the system.")
62
63 #define PROFILE_TEXT N_("Codec Profile")
64 #define PROFILE_LONGTEXT N_( \
65     "Specify the codec profile explicitly. If you don't, the codec will " \
66     "determine the correct profile from other sources, such as resolution " \
67     "and bitrate. E.g. 'high'")
68
69 #define LEVEL_TEXT N_("Codec Level")
70 #define LEVEL_LONGTEXT N_( \
71     "Specify the codec level explicitly. If you don't, the codec will " \
72     "determine the correct profile from other sources, such as resolution " \
73     "and bitrate. E.g. '4.2' for mpeg4-part10 or 'low' for mpeg2")
74
75 #define GOP_SIZE_TEXT N_("Group of Picture size")
76 #define GOP_SIZE_LONGTEXT N_( \
77     "Number of pictures within the current GOP (Group of Pictures); if " \
78     "GopPicSize=0, then the GOP size is unspecified. If GopPicSize=1, " \
79     "only I-frames are used.")
80
81 #define GOP_REF_DIST_TEXT N_("Group of Picture Reference Distance")
82 #define GOP_REF_DIST_LONGTEXT N_( \
83     "Distance between I- or P- key frames; if it is zero, the GOP " \
84     "structure is unspecified. Note: If GopRefDist = 1, there are no B-" \
85     "frames used.")
86
87 #define TARGET_USAGE_TEXT N_("Target Usage")
88 #define TARGET_USAGE_LONGTEXT N_("The target usage allow to choose between " \
89     "different trade-offs between quality and speed. Allowed values are: " \
90     "'speed', 'balanced' and 'quality'.")
91
92 #define IDR_INTERVAL_TEXT N_("IDR interval")
93 #define IDR_INTERVAL_LONGTEXT N_( \
94     "For H.264, IdrInterval specifies IDR-frame interval in terms of I-" \
95     "frames; if IdrInterval=0, then every I-frame is an IDR-frame. If " \
96     "IdrInterval=1, then every other I-frame is an IDR-frame, etc. " \
97     "For MPEG2, IdrInterval defines sequence header interval in terms " \
98     "of I-frames. If IdrInterval=N, SDK inserts the sequence header " \
99     "before every Nth I-frame. If IdrInterval=0 (default), SDK inserts " \
100     "the sequence header once at the beginning of the stream.")
101
102 #define RATE_CONTROL_TEXT N_("Rate Control Method")
103 #define RATE_CONTROL_LONGTEXT N_( \
104     "The rate control method to use when encoding. Can be one of " \
105     "'cbr', 'vbr', 'qp', 'avbr'. 'qp' mode isn't supported for mpeg2.")
106
107 #define QP_TEXT N_("Quantization parameter")
108 #define QP_LONGTEXT N_("Quantization parameter for all types of frames. " \
109     "This parameters sets qpi, qpp and qpb. It has less precedence than " \
110     "the forementionned parameters. Used only if rc_method is 'qp'.")
111
112 #define QPI_TEXT N_("Quantization parameter for I-frames")
113 #define QPI_LONGTEXT N_("Quantization parameter for I-frames. This parameter " \
114     "overrides any qp set globally. Used only if rc_method is 'qp'.")
115
116 #define QPP_TEXT N_("Quantization parameter for P-frames")
117 #define QPP_LONGTEXT N_("Quantization parameter for P-frames. This parameter " \
118     "overrides any qp set globally. Used only if rc_method is 'qp'.")
119
120 #define QPB_TEXT N_("Quantization parameter for B-frames")
121 #define QPB_LONGTEXT N_("Quantization parameter for B-frames. This parameter " \
122     "overrides any qp set globally. Used only if rc_method is 'qp'.")
123
124 #define MAX_BITRATE_TEXT N_("Maximum Bitrate")
125 #define MAX_BITRATE_LONGTEXT N_("Defines the maximum bitrate in kbps " \
126     "(1000 bits/s) for VBR rate control method. If not set, this parameter" \
127     " is computed from other sources such as bitrate, profile, level, etc.")
128
129 #define ACCURACY_TEXT N_("Accuracy of RateControl")
130 #define ACCURACY_LONGTEXT N_("Tolerance in percentage of the 'avbr' " \
131     " (Average Variable BitRate) method. (e.g. 10 with a bitrate of 800 " \
132     " kbps means the encoder tries not to  go above 880 kbps and under " \
133     " 730 kbps. The targeted accuracy is only reached after a certained " \
134     " convergence period. See the convergence parameter")
135
136 #define CONVERGENCE_TEXT N_("Convergence time of 'avbr' RateControl")
137 #define CONVERGENCE_LONGTEXT N_("Number of 100 frames before the " \
138     "'avbr' rate control method reaches the requested bitrate with " \
139     "the requested accuracy. See the accuracy parameter.")
140
141 #define NUM_SLICE_TEXT N_("Number of slices per frame")
142 #define NUM_SLICE_LONGTEXT N_("Number of slices in each video frame; "\
143     "each slice contains one or more macro-block rows. If numslice is " \
144     "not set, the encoder may choose any slice partitioning allowed " \
145     "by the codec standard.")
146
147 #define NUM_REF_FRAME_TEXT N_("Number of reference frames")
148 #define NUM_REF_FRAME_LONGTEXT N_("Number of reference frames")
149
150 #define ASYNC_DEPTH_TEXT N_("Number of parallel operations")
151 #define ASYNC_DEPTH_LONGTEXT N_("Defines the number of parallel " \
152      "encoding operations before we synchronise the result. Higher " \
153      "numbers may result on better throughput depending on hardware. " \
154      "MPEG2 needs at least 1 here.")
155
156 static const int profile_h264_list[] =
157       { MFX_PROFILE_UNKNOWN, MFX_PROFILE_AVC_CONSTRAINED_BASELINE, MFX_PROFILE_AVC_MAIN,
158       MFX_PROFILE_AVC_EXTENDED, MFX_PROFILE_AVC_HIGH };
159 static const char *const profile_h264_text[] =
160     { "decide", "baseline", "main", "extended", "high" };
161
162 static const int profile_mpeg2_list[] =
163     { MFX_PROFILE_UNKNOWN, MFX_PROFILE_MPEG2_SIMPLE, MFX_PROFILE_MPEG2_MAIN,
164       MFX_PROFILE_MPEG2_HIGH };
165 static const char *const profile_mpeg2_text[] =
166     { "decide", "simple", "main", "high" };
167
168 static const int level_h264_list[] =
169     { MFX_LEVEL_UNKNOWN, MFX_LEVEL_AVC_1, MFX_LEVEL_AVC_1b, MFX_LEVEL_AVC_12,
170       MFX_LEVEL_AVC_13, MFX_LEVEL_AVC_2, MFX_LEVEL_AVC_21, MFX_LEVEL_AVC_22,
171       MFX_LEVEL_AVC_3, MFX_LEVEL_AVC_31, MFX_LEVEL_AVC_32, MFX_LEVEL_AVC_4,
172       MFX_LEVEL_AVC_41, MFX_LEVEL_AVC_42, MFX_LEVEL_AVC_5, MFX_LEVEL_AVC_51,
173       MFX_LEVEL_AVC_52};
174 static const char *const level_h264_text[] =
175     { "decide", "1", "1.1b", "1.2", "1.3", "2", "2.1", "2.2", "3", "3.1",
176       "3.2", "4", "4.1",   "4.2",   "5", "5.1", "5.2" };
177
178 static const int level_mpeg2_list[] =
179     { MFX_LEVEL_UNKNOWN, MFX_LEVEL_MPEG2_LOW, MFX_LEVEL_MPEG2_MAIN,
180       MFX_LEVEL_MPEG2_HIGH, MFX_LEVEL_MPEG2_HIGH1440 };
181 static const char *const level_mpeg2_text[] =
182     { "decide", "low", "main", "high", "high1440" };
183
184 static const int target_usage_list[] =
185     { MFX_TARGETUSAGE_UNKNOWN, MFX_TARGETUSAGE_BEST_QUALITY, MFX_TARGETUSAGE_BALANCED,
186       MFX_TARGETUSAGE_BEST_SPEED };
187 static const char *const target_usage_text[] =
188     { "decide", "quality", "balanced", "speed" };
189
190 static const int rc_method_list[] =
191     { MFX_RATECONTROL_CBR, MFX_RATECONTROL_VBR,
192       MFX_RATECONTROL_CQP, MFX_RATECONTROL_AVBR};
193 static const char *const rc_method_text[] =
194     { "cbr", "vbr", "qp", "avbr" };
195
196 vlc_module_begin ()
197     set_category(CAT_INPUT)
198     set_subcategory(SUBCAT_INPUT_VCODEC)
199     set_description(N_("Intel QuickSync Video encoder for MPEG4-Part10/MPEG2 (aka H.264/H.262)"))
200     set_shortname("qsv")
201     set_capability("encoder", 0)
202     set_callbacks(Open, Close)
203
204     add_bool(SOUT_CFG_PREFIX "software", false, SW_IMPL_TEXT, SW_IMPL_LONGTEXT, true)
205
206     add_string(SOUT_CFG_PREFIX "h264-profile", "unspecified" , PROFILE_TEXT, PROFILE_LONGTEXT, false)
207         change_string_list(profile_h264_text, profile_h264_text)
208
209     add_string(SOUT_CFG_PREFIX "h264-level", "unspecified", LEVEL_TEXT, LEVEL_LONGTEXT, false)
210         change_string_list(level_h264_text, level_h264_text)
211
212     add_string(SOUT_CFG_PREFIX "mpeg2-profile", "unspecified", PROFILE_TEXT, PROFILE_LONGTEXT, false)
213         change_string_list(profile_mpeg2_text, profile_mpeg2_text)
214
215     add_string(SOUT_CFG_PREFIX "mpeg2-level", "unspecified", LEVEL_TEXT, LEVEL_LONGTEXT, false)
216         change_string_list(level_mpeg2_text, level_mpeg2_text)
217
218     add_integer(SOUT_CFG_PREFIX "gop-size", 32, GOP_SIZE_TEXT, GOP_SIZE_LONGTEXT, true)
219     add_integer(SOUT_CFG_PREFIX "gop-refdist", 4, GOP_REF_DIST_TEXT, GOP_REF_DIST_LONGTEXT, true)
220     add_integer(SOUT_CFG_PREFIX "idr-interval", 0, IDR_INTERVAL_TEXT, IDR_INTERVAL_LONGTEXT, true)
221
222     add_string(SOUT_CFG_PREFIX "target-usage", "quality", TARGET_USAGE_TEXT, TARGET_USAGE_LONGTEXT, false)
223         change_string_list(target_usage_text, target_usage_text)
224
225     add_string(SOUT_CFG_PREFIX "rc-method", "vbr", RATE_CONTROL_TEXT, RATE_CONTROL_LONGTEXT, true)
226         change_string_list(rc_method_text, rc_method_text)
227
228     add_integer(SOUT_CFG_PREFIX "qp", 0, QP_TEXT, QP_LONGTEXT, true)
229         change_integer_range(0, 51)
230     add_integer(SOUT_CFG_PREFIX "qpi", 0, QPI_TEXT, QPI_LONGTEXT, true)
231         change_integer_range(0, 51)
232     add_integer(SOUT_CFG_PREFIX "qpp", 0, QPP_TEXT, QPP_LONGTEXT, true)
233         change_integer_range(0, 51)
234     add_integer(SOUT_CFG_PREFIX "qpb", 0, QPB_TEXT, QPB_LONGTEXT, true)
235         change_integer_range(0, 51)
236
237     add_integer(SOUT_CFG_PREFIX "bitrate-max", 0, MAX_BITRATE_TEXT, MAX_BITRATE_LONGTEXT, true)
238
239     add_integer(SOUT_CFG_PREFIX "accuracy", 0, ACCURACY_TEXT, ACCURACY_LONGTEXT, true)
240         change_integer_range(0, 100)
241
242     add_integer(SOUT_CFG_PREFIX "convergence", 0, CONVERGENCE_TEXT, CONVERGENCE_LONGTEXT, true)
243
244     add_integer(SOUT_CFG_PREFIX "num-slice", 0, NUM_SLICE_TEXT, NUM_SLICE_LONGTEXT, true)
245     add_integer(SOUT_CFG_PREFIX "num-ref-frame", 0, NUM_REF_FRAME_TEXT, NUM_REF_FRAME_LONGTEXT, true)
246
247     add_integer(SOUT_CFG_PREFIX "async-depth", 4, ASYNC_DEPTH_TEXT, ASYNC_DEPTH_LONGTEXT, true)
248         change_integer_range(1, 32)
249
250 vlc_module_end ()
251
252 /*****************************************************************************
253  * Local prototypes
254  *****************************************************************************/
255 static const char *const sout_options[] = {
256     "software", "h264-profile", "h264-level", "mpeg2-profile", "mpeg2-level",
257     "gop-size", "gop-refdist", "target-usage", "rc-method", "qp", "qpi", "qpp",
258     "qpb", "bitrate-max", "accuracy", "convergence", "num-slice",
259     "num-ref-frame", "async-depth",
260     NULL
261 };
262
263 // Frame pool for QuickSync video encoder with Intel Media SDK's format frames.
264 typedef struct _QSVFrame
265 {
266     struct _QSVFrame  *next;
267     picture_t         *pic;
268     mfxFrameSurface1  surface;
269     mfxEncodeCtrl     enc_ctrl;
270     int               used;
271 } QSVFrame;
272
273 typedef struct async_task_t
274 {
275     fifo_item_t      fifo;
276     mfxBitstream     bs;                  // Intel's bitstream structure.
277     mfxSyncPoint     *syncp;              // Async Task Sync Point.
278     block_t          *block;              // VLC's block structure to be returned by Encode.
279 } async_task_t;
280
281 TYPED_FIFO(async_task_t, async_task_t)
282
283 typedef struct
284 {
285     mfxSession       session;             // Intel Media SDK Session.
286     mfxVideoParam    params;              // Encoding parameters.
287     QSVFrame         *work_frames;        // IntelMediaSDK's frame pool.
288     uint64_t         dts_warn_counter;    // DTS warning counter for rate-limiting of msg;
289     uint64_t         busy_warn_counter;   // Device Busy warning counter for rate-limiting of msg;
290     uint64_t         async_depth;         // Number of parallel encoding operations.
291     fifo_t           packets;             // FIFO of queued packets
292     vlc_tick_t       offset_pts;          // The pts of the first frame, to avoid conversion overflow.
293     vlc_tick_t       last_dts;            // The dts of the last frame, to interpolate over buggy dts
294
295     picture_pool_t   *input_pool;         // pool of pictures to feed the decoder
296                                           //  as it doesn't like constantly changing buffers
297 } encoder_sys_t;
298
299 static block_t *Encode(encoder_t *, picture_t *);
300
301
302 static void clear_unused_frames(encoder_sys_t *sys)
303 {
304     QSVFrame *cur = sys->work_frames;
305     while (cur) {
306         if (cur->used && !cur->surface.Data.Locked) {
307             picture_Release(cur->pic);
308             cur->used = 0;
309         }
310         cur = cur->next;
311     }
312 }
313
314 /*
315  * Finds an unlocked frame, releases the associated picture if
316  * necessary associates the new picture with it and return the frame.
317  * Returns 0 if there's an error.
318  */
319 static int get_free_frame(encoder_sys_t *sys, QSVFrame **out)
320 {
321     QSVFrame *frame, **last;
322
323     clear_unused_frames(sys);
324
325     frame = sys->work_frames;
326     last  = &sys->work_frames;
327     while (frame) {
328         if (!frame->used) {
329             *out = frame;
330             frame->used = 1;
331             return VLC_SUCCESS;
332         }
333
334         last  = &frame->next;
335         frame = frame->next;
336     }
337
338     frame = calloc(1,sizeof(QSVFrame));
339     if (unlikely(frame==NULL))
340         return VLC_ENOMEM;
341     *last = frame;
342
343     *out = frame;
344     frame->used = 1;
345
346     return VLC_SUCCESS;
347 }
348
349 static uint64_t qsv_params_get_value(const char *const *text,
350                                      const int *list,
351                                      size_t size, char *sel)
352 {
353     size_t result = 0;
354
355     if (unlikely(!sel))
356         return list[0];
357
358     size /= sizeof(list[0]);
359     for (size_t i = 0; i < size; i++)
360         if (!strcmp(sel, text[i])) {
361             result = i;
362             break;
363         }
364
365     // sel comes from var_InheritString and must be freed.
366     free(sel);
367     // Returns the found item, or the default/first one if not found.
368     return list[result];
369 }
370
371 static int Open(vlc_object_t *this)
372 {
373     encoder_t *enc = (encoder_t *)this;
374     encoder_sys_t *sys = NULL;
375
376     mfxStatus sts = MFX_ERR_NONE;
377     mfxFrameAllocRequest alloc_request = { 0 };
378     uint8_t sps_buf[128];
379     uint8_t pps_buf[128];
380     mfxExtCodingOptionSPSPPS headers;
381     mfxExtCodingOption co = {
382         .Header.BufferId = MFX_EXTBUFF_CODING_OPTION,
383         .Header.BufferSz = sizeof(co),
384         .PicTimingSEI = MFX_CODINGOPTION_ON,
385     };
386 #if QSV_HAVE_CO2
387     mfxExtCodingOption2 co2 = {
388         .Header.BufferId = MFX_EXTBUFF_CODING_OPTION2,
389         .Header.BufferSz = sizeof(co2),
390     };
391 #endif
392     mfxExtBuffer *init_params[] =
393     {
394         (mfxExtBuffer*)&co,
395 #if QSV_HAVE_CO2
396         (mfxExtBuffer*)&co2,
397 #endif
398     };
399     mfxExtBuffer *extended_params[] = {
400         (mfxExtBuffer*)&headers,
401         (mfxExtBuffer*)&co,
402 #if QSV_HAVE_CO2
403         (mfxExtBuffer*)&co2,
404 #endif
405     };
406     mfxVersion    ver = { { 1, 1 } };
407     mfxIMPL       impl;
408     mfxVideoParam param_out = { 0 };
409
410     uint8_t *p_extra;
411     size_t i_extra;
412
413     if (enc->fmt_out.i_codec != VLC_CODEC_H264 &&
414         enc->fmt_out.i_codec != VLC_CODEC_MPGV && !enc->obj.force)
415         return VLC_EGENERIC;
416
417     if (!enc->fmt_in.video.i_visible_height || !enc->fmt_in.video.i_visible_width ||
418         !enc->fmt_in.video.i_frame_rate || !enc->fmt_in.video.i_frame_rate_base) {
419         msg_Err(enc, "Framerate and picture dimensions must be non-zero");
420         return VLC_EGENERIC;
421     }
422
423     /* Allocate the memory needed to store the decoder's structure */
424     sys = calloc(1, sizeof(encoder_sys_t));
425     if (unlikely(!sys))
426         return VLC_ENOMEM;
427
428     /* Initialize dispatcher, it will loads the actual SW/HW Implementation */
429     sts = MFXInit(MFX_IMPL_AUTO_ANY, &ver, &sys->session);
430
431     if (sts != MFX_ERR_NONE) {
432         if (sts == MFX_ERR_UNSUPPORTED)
433             msg_Err(enc, "Intel Media SDK implementation not supported, is your card plugged?");
434         else
435             msg_Err(enc, "Unable to find an Intel Media SDK implementation (%d).", sts);
436         free(sys);
437         return VLC_EGENERIC;
438     }
439
440     enc->p_sys = sys;
441
442     config_ChainParse(enc, SOUT_CFG_PREFIX, sout_options, enc->p_cfg);
443
444     /* Checking if we are on software and are allowing it */
445     MFXQueryIMPL(sys->session, &impl);
446     if (!var_InheritBool(enc, SOUT_CFG_PREFIX "software") && (impl & MFX_IMPL_SOFTWARE)) {
447         msg_Err(enc, "No hardware implementation found and software mode disabled");
448         goto error;
449     }
450
451     msg_Dbg(enc, "Using Intel QuickSync Video %s implementation",
452         impl & MFX_IMPL_HARDWARE ? "hardware" : "software");
453
454     /* Input picture format description */
455     sys->params.mfx.FrameInfo.FrameRateExtN = enc->fmt_in.video.i_frame_rate;
456     sys->params.mfx.FrameInfo.FrameRateExtD = enc->fmt_in.video.i_frame_rate_base;
457     sys->params.mfx.FrameInfo.FourCC        = MFX_FOURCC_NV12;
458     sys->params.mfx.FrameInfo.ChromaFormat  = MFX_CHROMAFORMAT_YUV420;
459     sys->params.mfx.FrameInfo.Width         = vlc_align(enc->fmt_in.video.i_width, 16);
460     sys->params.mfx.FrameInfo.Height        = vlc_align(enc->fmt_in.video.i_height, 32);
461     sys->params.mfx.FrameInfo.CropW         = enc->fmt_in.video.i_visible_width;
462     sys->params.mfx.FrameInfo.CropH         = enc->fmt_in.video.i_visible_height;
463     sys->params.mfx.FrameInfo.PicStruct     = MFX_PICSTRUCT_PROGRESSIVE;
464     sys->params.mfx.FrameInfo.AspectRatioH  = enc->fmt_in.video.i_sar_num;
465     sys->params.mfx.FrameInfo.AspectRatioW  = enc->fmt_in.video.i_sar_den;
466     sys->params.mfx.FrameInfo.BitDepthChroma = 8; /* for VLC_CODEC_NV12 */
467     sys->params.mfx.FrameInfo.BitDepthLuma   = 8; /* for VLC_CODEC_NV12 */
468
469     /* Parsing options common to all RC methods and codecs */
470     sys->params.IOPattern       = MFX_IOPATTERN_IN_SYSTEM_MEMORY;
471     sys->params.AsyncDepth      = var_InheritInteger(enc, SOUT_CFG_PREFIX "async-depth");
472     sys->params.mfx.GopOptFlag  = 1; /* TODO */
473     sys->params.mfx.GopPicSize  = var_InheritInteger(enc, SOUT_CFG_PREFIX "gop-size");
474     sys->params.mfx.GopRefDist  = var_InheritInteger(enc, SOUT_CFG_PREFIX "gop-refdist");
475     sys->params.mfx.IdrInterval = var_InheritInteger(enc, SOUT_CFG_PREFIX "idr-interval");
476     sys->params.mfx.NumSlice    = var_InheritInteger(enc, SOUT_CFG_PREFIX "num-slice");
477     sys->params.mfx.NumRefFrame = var_InheritInteger(enc, SOUT_CFG_PREFIX "num-ref-frame");
478     sys->params.mfx.TargetUsage = qsv_params_get_value(target_usage_text,
479         target_usage_list, sizeof(target_usage_list),
480         var_InheritString(enc, SOUT_CFG_PREFIX "target-usage"));
481
482     if (enc->fmt_out.i_codec == VLC_CODEC_H264) {
483         sys->params.mfx.CodecId = MFX_CODEC_AVC;
484         sys->params.mfx.CodecProfile = qsv_params_get_value(profile_h264_text,
485             profile_h264_list, sizeof(profile_h264_list),
486             var_InheritString(enc, SOUT_CFG_PREFIX "h264-profile"));
487         sys->params.mfx.CodecLevel = qsv_params_get_value(level_h264_text,
488             level_h264_list, sizeof(level_h264_list),
489             var_InheritString(enc, SOUT_CFG_PREFIX "h264-level"));
490         msg_Dbg(enc, "Encoder in H264 mode, with profile %d and level %d",
491             sys->params.mfx.CodecProfile, sys->params.mfx.CodecLevel);
492
493     } else {
494         sys->params.mfx.CodecId = MFX_CODEC_MPEG2;
495         sys->params.mfx.CodecProfile = qsv_params_get_value(profile_mpeg2_text,
496             profile_mpeg2_list, sizeof(profile_mpeg2_list),
497             var_InheritString(enc, SOUT_CFG_PREFIX "mpeg2-profile"));
498         sys->params.mfx.CodecLevel = qsv_params_get_value(level_mpeg2_text,
499             level_mpeg2_list, sizeof(level_mpeg2_list),
500             var_InheritString(enc, SOUT_CFG_PREFIX "mpeg2-level"));
501         msg_Dbg(enc, "Encoder in MPEG2 mode, with profile %d and level %d",
502             sys->params.mfx.CodecProfile, sys->params.mfx.CodecLevel);
503     }
504     param_out.mfx.CodecId = sys->params.mfx.CodecId;
505
506     char *psz_rc = var_InheritString(enc, SOUT_CFG_PREFIX "rc-method");
507     msg_Dbg(enc, "Encoder using '%s' Rate Control method", psz_rc );
508     sys->params.mfx.RateControlMethod = qsv_params_get_value(rc_method_text,
509         rc_method_list, sizeof(rc_method_list), psz_rc );
510
511     if (sys->params.mfx.RateControlMethod == MFX_RATECONTROL_CQP) {
512         sys->params.mfx.QPI = sys->params.mfx.QPB = sys->params.mfx.QPP =
513             var_InheritInteger(enc, SOUT_CFG_PREFIX "qp");
514         sys->params.mfx.QPI = var_InheritInteger(enc, SOUT_CFG_PREFIX "qpi");
515         sys->params.mfx.QPB = var_InheritInteger(enc, SOUT_CFG_PREFIX "qpb");
516         sys->params.mfx.QPP = var_InheritInteger(enc, SOUT_CFG_PREFIX "qpp");
517     } else {
518         if (!enc->fmt_out.i_bitrate) {
519             msg_Warn(enc, "No bitrate specified, using default %d",
520                 QSV_BITRATE_DEFAULT);
521             sys->params.mfx.TargetKbps = QSV_BITRATE_DEFAULT;
522         } else
523             sys->params.mfx.TargetKbps = enc->fmt_out.i_bitrate / 1000;
524
525         if (sys->params.mfx.RateControlMethod == MFX_RATECONTROL_AVBR) {
526             sys->params.mfx.Accuracy = var_InheritInteger(enc, SOUT_CFG_PREFIX "accuracy");
527             sys->params.mfx.Convergence = var_InheritInteger(enc, SOUT_CFG_PREFIX "convergence");
528         } else if (sys->params.mfx.RateControlMethod == MFX_RATECONTROL_VBR)
529             sys->params.mfx.MaxKbps = var_InheritInteger(enc, SOUT_CFG_PREFIX "bitrate-max");
530     }
531
532     sts = MFXVideoENCODE_Query(sys->session, &sys->params, &param_out);
533     if ( sts < MFX_ERR_NONE )
534     {
535         msg_Err(enc, "Unsupported encoding parameters (%d)", sts);
536         goto error;
537     }
538
539     if ( sys->params.mfx.RateControlMethod != param_out.mfx.RateControlMethod )
540     {
541         msg_Err(enc, "Unsupported control method %d got %d", sys->params.mfx.RateControlMethod, param_out.mfx.RateControlMethod);
542         goto error;
543     }
544
545     if (MFXVideoENCODE_Query(sys->session, &sys->params, &sys->params) < 0)
546     {
547         msg_Err(enc, "Error querying encoder params");
548         goto error;
549     }
550
551     /* Request number of surface needed and creating frame pool */
552     if (MFXVideoENCODE_QueryIOSurf(sys->session, &sys->params, &alloc_request)!= MFX_ERR_NONE)
553     {
554         msg_Err(enc, "Failed to query for allocation");
555         goto error;
556     }
557
558     enc->fmt_in.video.i_chroma = VLC_CODEC_NV12;
559     video_format_t pool_fmt = enc->fmt_in.video;
560     pool_fmt.i_width  = sys->params.mfx.FrameInfo.Width;
561     pool_fmt.i_height = sys->params.mfx.FrameInfo.Height;
562     sys->input_pool = picture_pool_NewFromFormat( &pool_fmt, 18 );
563     if (sys->input_pool == NULL)
564     {
565         msg_Err(enc, "Failed to create the internal pool");
566         goto error;
567     }
568
569     sys->params.ExtParam    = (mfxExtBuffer**)&init_params;
570     sys->params.NumExtParam =
571 #if QSV_HAVE_CO2
572             2;
573 #else
574             1;
575 #endif
576
577     /* Initializing MFX_Encoder */
578     sts = MFXVideoENCODE_Init(sys->session, &sys->params);
579     if (sts == MFX_ERR_NONE)
580         msg_Dbg(enc, "Successfuly initialized video encoder");
581     else if (sts < MFX_ERR_NONE) {
582         msg_Err(enc, "Unable to initialize video encoder error (%d). " \
583             " Most likely because of provided encoding parameters", sts);
584         goto error;
585     } else
586         msg_Warn(enc, "Video encoder initialization : %d. The stream might be corrupted/invalid", sts);
587
588     /* Querying PPS/SPS Headers, BufferSizeInKB, ... */
589     memset(&headers, 0, sizeof(headers));
590     headers.Header.BufferId = MFX_EXTBUFF_CODING_OPTION_SPSPPS;
591     headers.Header.BufferSz = sizeof(headers);
592     headers.PPSBufSize      = sizeof(pps_buf);
593     headers.SPSBufSize      = sizeof(sps_buf);
594     headers.SPSBuffer       = sps_buf;
595     headers.PPSBuffer       = pps_buf;
596     sys->params.ExtParam    = (mfxExtBuffer **)&extended_params;
597     sys->params.NumExtParam =
598 #if QSV_HAVE_CO2
599             3;
600 #else
601             2;
602 #endif
603
604     MFXVideoENCODE_GetVideoParam(sys->session, &sys->params);
605
606     i_extra = headers.SPSBufSize + headers.PPSBufSize;
607     p_extra = malloc(i_extra);
608
609     if (unlikely(!p_extra))
610         goto nomem;
611
612     memcpy(p_extra, headers.SPSBuffer, headers.SPSBufSize);
613     memcpy(p_extra + headers.SPSBufSize, headers.PPSBuffer, headers.PPSBufSize);
614     enc->fmt_out.p_extra = p_extra;
615     enc->fmt_out.i_extra = i_extra;
616
617     sys->async_depth = sys->params.AsyncDepth;
618     async_task_t_fifo_Init(&sys->packets);
619
620     /* Vlc module configuration */
621     enc->fmt_in.i_codec                = VLC_CODEC_NV12; // Intel Media SDK requirement
622     enc->fmt_in.video.i_bits_per_pixel = 12;
623     enc->fmt_in.video.i_width          = sys->params.mfx.FrameInfo.Width;
624     enc->fmt_in.video.i_height         = sys->params.mfx.FrameInfo.Height;
625
626     enc->pf_encode_video = Encode;
627
628     return VLC_SUCCESS;
629
630  error:
631     Close(this);
632     enc->p_sys = NULL;
633     return VLC_EGENERIC;
634  nomem:
635     Close(this);
636     enc->p_sys = NULL;
637     return VLC_ENOMEM;
638 }
639
640 static void Close(vlc_object_t *this)
641 {
642     encoder_t *enc = (encoder_t *)this;
643     encoder_sys_t *sys = enc->p_sys;
644
645     MFXVideoENCODE_Close(sys->session);
646     MFXClose(sys->session);
647     /* if (enc->fmt_out.p_extra) */
648     /*     free(enc->fmt_out.p_extra); */
649     async_task_t_fifo_Release(&sys->packets);
650     if (sys->input_pool)
651         picture_pool_Release(sys->input_pool);
652     free(sys);
653 }
654
655 /*
656  * The behavior in the next function comes from x264.c
657  */
658 static void qsv_set_block_flags(block_t *block, uint16_t frame_type)
659 {
660     if (frame_type & MFX_FRAMETYPE_IDR)
661         block->i_flags = BLOCK_FLAG_TYPE_I;
662     else if ((frame_type & MFX_FRAMETYPE_P) || (frame_type & MFX_FRAMETYPE_I))
663         block->i_flags = BLOCK_FLAG_TYPE_P;
664     else if (frame_type & MFX_FRAMETYPE_B)
665         block->i_flags = BLOCK_FLAG_TYPE_B;
666     else
667         block->i_flags = BLOCK_FLAG_TYPE_PB;
668 }
669
670 /*
671  * Convert the Intel Media SDK's timestamps into VLC's format.
672  */
673 static void qsv_set_block_ts(encoder_t *enc, encoder_sys_t *sys, block_t *block, mfxBitstream *bs)
674 {
675     block->i_pts = FROM_SCALE_NZ(bs->TimeStamp) + sys->offset_pts;
676     block->i_dts = FROM_SCALE_NZ(bs->DecodeTimeStamp) + sys->offset_pts;
677
678     /* HW encoder (with old driver versions) and some parameters
679        combinations doesn't set the DecodeTimeStamp field so we warn
680        the user about it */
681     if (!bs->DecodeTimeStamp || bs->DecodeTimeStamp > (int64_t)bs->TimeStamp)
682         if (sys->dts_warn_counter++ % 16 == 0) // Rate limiting this message.
683             msg_Warn(enc, "Encode returning empty DTS or DTS > PTS. Your stream will be invalid. "
684                      " Please double-check they weren't any warning at encoder initialization "
685                      " and that you have the last version of Intel's drivers installed.");
686 }
687
688 static block_t *qsv_synchronize_block(encoder_t *enc, async_task_t *task)
689 {
690     encoder_sys_t *sys = enc->p_sys;
691     mfxStatus sts;
692
693     /* Synchronize and fill block_t. If the SyncOperation fails we leak :-/ (or we can segfault, ur choice) */
694     do {
695         sts = MFXVideoCORE_SyncOperation(sys->session, *task->syncp, QSV_SYNCPOINT_WAIT);
696     } while (sts == MFX_WRN_IN_EXECUTION);
697     if (sts != MFX_ERR_NONE) {
698         msg_Err(enc, "SyncOperation failed (%d), outputting garbage data. "
699                 "Updating your drivers and/or changing the encoding settings might resolve this", sts);
700         return NULL;
701     }
702     if (task->bs.DataLength == 0)
703     {
704         msg_Dbg(enc, "Empty encoded block");
705         return NULL;
706     }
707     block_t *block = task->block;
708     block->i_buffer = task->bs.DataLength;
709     block->p_buffer += task->bs.DataOffset;
710
711     qsv_set_block_ts(enc, sys, block, &task->bs);
712     qsv_set_block_flags(block, task->bs.FrameType);
713
714     /* msg_Dbg(enc, "block->i_pts = %lld, block->i_dts = %lld", block->i_pts, block->i_dts); */
715     /* msg_Dbg(enc, "FrameType = %#.4x, TimeStamp = %lld (pts %lld), DecodeTimeStamp = %lld syncp=0x%x",*/
716     /*         task->bs.FrameType, task->bs.TimeStamp, block->i_pts, task->bs.DecodeTimeStamp, *task->syncp); */
717
718     /* Copied from x264.c: This isn't really valid for streams with B-frames */
719     block->i_length = vlc_tick_from_samples( enc->fmt_in.video.i_frame_rate_base,
720                                              enc->fmt_in.video.i_frame_rate );
721
722     // Buggy DTS (value comes from experiments)
723     if (task->bs.DecodeTimeStamp < -10000)
724         block->i_dts = sys->last_dts + block->i_length;
725     sys->last_dts = block->i_dts;
726
727     task->bs.DataLength = task->bs.DataOffset = 0;
728     return block;
729 }
730
731 static int submit_frame(encoder_t *enc, picture_t *pic, QSVFrame **new_frame)
732 {
733     encoder_sys_t *sys = enc->p_sys;
734     QSVFrame *qf = NULL;
735     int ret = get_free_frame(sys, &qf);
736     if (ret != VLC_SUCCESS) {
737         msg_Warn(enc, "Unable to find an unlocked surface in the pool");
738         return ret;
739     }
740
741     qf->pic = picture_pool_Get( sys->input_pool );
742     if (unlikely(!qf->pic))
743     {
744         msg_Warn(enc, "Unable to find an unlocked surface in the pool");
745         qf->used = 0;
746         return ret;
747     }
748     picture_Copy( qf->pic, pic );
749
750     assert(qf->pic->p[0].p_pixels + (qf->pic->p[0].i_pitch * qf->pic->p[0].i_lines) == qf->pic->p[1].p_pixels);
751
752     qf->surface.Info = sys->params.mfx.FrameInfo;
753
754     // Specify picture structure at runtime.
755     if (pic->b_progressive)
756         qf->surface.Info.PicStruct = MFX_PICSTRUCT_PROGRESSIVE;
757     else if (pic->b_top_field_first)
758         qf->surface.Info.PicStruct = MFX_PICSTRUCT_FIELD_TFF;
759     else
760         qf->surface.Info.PicStruct = MFX_PICSTRUCT_FIELD_BFF;
761
762     //qf->surface.Data.Pitch = vlc_align(qf->surface.Info.Width, 16);
763
764     qf->surface.Data.PitchLow  = qf->pic->p[0].i_pitch;
765     qf->surface.Data.Y         = qf->pic->p[0].p_pixels;
766     qf->surface.Data.UV        = qf->pic->p[1].p_pixels;
767
768     qf->surface.Data.TimeStamp = TO_SCALE_NZ(pic->date - sys->offset_pts);
769
770     *new_frame = qf;
771
772     return VLC_SUCCESS;
773 }
774
775 static async_task_t *encode_frame(encoder_t *enc, picture_t *pic)
776 {
777     encoder_sys_t *sys = enc->p_sys;
778     mfxStatus sts = MFX_ERR_MEMORY_ALLOC;
779     QSVFrame *qsv_frame = NULL;
780     mfxFrameSurface1 *surf = NULL;
781     async_task_t *task = calloc(1, sizeof(*task));
782     if (unlikely(task == NULL))
783         goto done;
784
785     if (pic) {
786         /* To avoid qsv -> vlc timestamp conversion overflow, we use timestamp relative
787            to the first picture received. That way, vlc will overflow before us.
788            (Thanks to funman for the idea) */
789         if (!sys->offset_pts) // First frame
790             sys->offset_pts = pic->date;
791
792         if (submit_frame(enc, pic, &qsv_frame) != VLC_SUCCESS)
793         {
794             msg_Warn(enc, "Unable to find an unlocked surface in the pool");
795             goto done;
796         }
797     }
798
799     if (!(task->syncp = calloc(1, sizeof(*task->syncp)))) {
800         msg_Err(enc, "Unable to allocate syncpoint for encoder output");
801         goto done;
802     }
803
804     /* Allocate block_t and prepare mfxBitstream for encoder */
805     if (!(task->block = block_Alloc(sys->params.mfx.BufferSizeInKB * 1000))) {
806         msg_Err(enc, "Unable to allocate block for encoder output");
807         goto done;
808     }
809     memset(&task->bs, 0, sizeof(task->bs));
810     task->bs.MaxLength = task->block->i_buffer;
811     task->bs.Data = task->block->p_buffer;
812
813     if (qsv_frame) {
814         surf = &qsv_frame->surface;
815     }
816
817     for (;;) {
818         sts = MFXVideoENCODE_EncodeFrameAsync(sys->session, 0, surf, &task->bs, task->syncp);
819         if (sts != MFX_WRN_DEVICE_BUSY && sts != MFX_WRN_IN_EXECUTION)
820             break;
821         if (sys->busy_warn_counter++ % 16 == 0)
822             msg_Dbg(enc, "Device is busy, let's wait and retry %d", sts);
823         if (sts == MFX_WRN_DEVICE_BUSY)
824             vlc_tick_sleep(QSV_BUSYWAIT_TIME);
825     }
826
827     // msg_Dbg(enc, "Encode async status: %d, Syncpoint = %tx", sts, (ptrdiff_t)task->syncp);
828
829     if (sts == MFX_ERR_MORE_DATA)
830         if (pic)
831             msg_Dbg(enc, "Encoder feeding phase, more data is needed.");
832         else
833             msg_Dbg(enc, "Encoder is empty");
834     else if (sts < MFX_ERR_NONE) {
835         msg_Err(enc, "Encoder not ready or error (%d), trying a reset...", sts);
836         MFXVideoENCODE_Reset(sys->session, &sys->params);
837     }
838
839 done:
840     if (sts < MFX_ERR_NONE || (task != NULL && !task->syncp)) {
841         if (task->block != NULL)
842             block_Release(task->block);
843         free(task);
844         task = NULL;
845     }
846     return task;
847 }
848
849 /*
850  * The Encode function has 3 encoding phases :
851  *   - Feed : We feed the encoder until it stops to return MFX_MORE_DATA_NEEDED
852  *     and the async_tasks are all in use (honouring the AsyncDepth)
853  *   - Main encoding phase : synchronizing the oldest task each call.
854  *   - Empty : pic = 0, we empty the decoder. Synchronizing the remaining tasks.
855  */
856 static block_t *Encode(encoder_t *this, picture_t *pic)
857 {
858     encoder_t     *enc = (encoder_t *)this;
859     encoder_sys_t *sys = enc->p_sys;
860     async_task_t     *task;
861     block_t       *block = NULL;
862
863     if (likely(pic != NULL))
864     {
865         task = encode_frame( enc, pic );
866         if (likely(task != NULL))
867             async_task_t_fifo_Put(&sys->packets, task);
868     }
869
870     if ( async_task_t_fifo_GetCount(&sys->packets) == (sys->async_depth + 1) ||
871          (!pic && async_task_t_fifo_GetCount(&sys->packets)))
872     {
873         assert(async_task_t_fifo_Show(&sys->packets)->syncp != 0);
874         task = async_task_t_fifo_Get(&sys->packets);
875         block = qsv_synchronize_block( enc, task );
876         free(task->syncp);
877         free(task);
878     }
879
880     return block;
881 }