encoder: add rate control API.

Add gst_vaapi_encoder_set_rate_control() interface to request a new
rate control mode for encoding. Changing the rate control mode is
only valid prior to encoding the very first frame. Afterwards, an
error ("operation-failed") is issued.

https://bugzilla.gnome.org/show_bug.cgi?id=719529
This commit is contained in:
Gwenole Beauchesne 2014-01-06 15:10:36 +01:00
parent 076d75aeb8
commit a24c52e4d0
11 changed files with 186 additions and 38 deletions

View file

@ -25,6 +25,7 @@
#include "gstvaapiencoder_priv.h"
#include "gstvaapicontext.h"
#include "gstvaapidisplay_priv.h"
#include "gstvaapiutils.h"
#define DEBUG 1
#include "gstvaapidebug.h"
@ -180,6 +181,7 @@ gst_vaapi_encoder_put_frame (GstVaapiEncoder * encoder,
gst_vaapi_coded_buffer_proxy_set_user_data (codedbuf_proxy,
picture, (GDestroyNotify) gst_vaapi_enc_picture_unref);
g_async_queue_push (encoder->codedbuf_queue, codedbuf_proxy);
encoder->num_codedbuf_queued++;
/* Try again with any pending reordered frame now available for encoding */
frame = NULL;
@ -388,6 +390,107 @@ error:
return NULL;
}
/* Determine the supported rate control modes */
static gboolean
get_rate_control_mask (GstVaapiEncoder * encoder)
{
const GstVaapiEncoderClassData *const cdata =
GST_VAAPI_ENCODER_GET_CLASS (encoder)->class_data;
GstVaapiProfile profile;
GArray *profiles;
guint i, rate_control_mask = 0;
if (encoder->rate_control_mask)
return encoder->rate_control_mask;
profiles = gst_vaapi_display_get_encode_profiles (encoder->display);
if (!profiles)
goto cleanup;
// Pick a profile matching the class codec
for (i = 0; i < profiles->len; i++) {
profile = g_array_index (profiles, GstVaapiProfile, i);
if (gst_vaapi_profile_get_codec (profile) == cdata->codec)
break;
}
if (i != profiles->len) {
VAConfigAttrib attrib;
VAStatus status;
attrib.type = VAConfigAttribRateControl;
GST_VAAPI_DISPLAY_LOCK (encoder->display);
status =
vaGetConfigAttributes (GST_VAAPI_DISPLAY_VADISPLAY (encoder->display),
gst_vaapi_profile_get_va_profile (profile), VAEntrypointEncSlice,
&attrib, 1);
GST_VAAPI_DISPLAY_UNLOCK (encoder->display);
if (vaapi_check_status (status, "vaGetConfigAttributes()")) {
for (i = 0; i < 32; i++) {
if (!(attrib.value & (1 << i)))
continue;
rate_control_mask |= 1 << to_GstVaapiRateControl (1 << i);
}
}
}
g_array_unref (profiles);
GST_INFO ("supported rate controls: 0x%08x", rate_control_mask);
cleanup:
encoder->rate_control_mask = cdata->rate_control_mask & rate_control_mask;
return encoder->rate_control_mask;
}
/**
* gst_vaapi_encoder_set_rate_control:
* @encoder: a #GstVaapiEncoder
* @rate_control: the requested rate control
*
* Notifies the @encoder to use the supplied @rate_control mode.
*
* If the underlying encoder does not support that rate control mode,
* then @GST_VAAPI_ENCODER_STATUS_ERROR_UNSUPPORTED_RATE_CONTROL is
* returned.
*
* The rate control mode can only be specified before the first frame
* is to be encoded. Afterwards, any change to this parameter is
* invalid and @GST_VAAPI_ENCODER_STATUS_ERROR_OPERATION_FAILED is
* returned.
*
* Return value: a #GstVaapiEncoderStatus
*/
GstVaapiEncoderStatus
gst_vaapi_encoder_set_rate_control (GstVaapiEncoder * encoder,
GstVaapiRateControl rate_control)
{
guint32 rate_control_mask;
g_return_val_if_fail (encoder != NULL,
GST_VAAPI_ENCODER_STATUS_ERROR_INVALID_PARAMETER);
if (encoder->rate_control != rate_control && encoder->num_codedbuf_queued > 0)
goto error_operation_failed;
rate_control_mask = get_rate_control_mask (encoder);
if (!(rate_control_mask & (1U << rate_control)))
goto error_unsupported_rate_control;
encoder->rate_control = rate_control;
return GST_VAAPI_ENCODER_STATUS_SUCCESS;
/* ERRORS */
error_operation_failed:
{
GST_ERROR ("could not change rate control mode after encoding started");
return GST_VAAPI_ENCODER_STATUS_ERROR_OPERATION_FAILED;
}
error_unsupported_rate_control:
{
GST_ERROR ("unsupported rate control mode (%d)", rate_control);
return GST_VAAPI_ENCODER_STATUS_ERROR_UNSUPPORTED_RATE_CONTROL;
}
}
/* Base encoder initialization (internal) */
static gboolean
gst_vaapi_encoder_init (GstVaapiEncoder * encoder, GstVaapiDisplay * display)

View file

@ -40,6 +40,11 @@ typedef struct _GstVaapiEncoder GstVaapiEncoder;
* hold the encoded picture.
* @GST_VAAPI_ENCODER_STATUS_ERROR_UNKNOWN: Unknown error.
* @GST_VAAPI_ENCODER_STATUS_ERROR_ALLOCATION_FAILED: No memory left.
* @GST_VAAPI_ENCODER_STATUS_ERROR_OPERATION_FAILED: The requested
* operation failed to execute properly. e.g. invalid point in time to
* execute the operation.
* @GST_VAAPI_ENCODER_STATUS_ERROR_UNSUPPORTED_RATE_CONTROL:
* Unsupported rate control value.
* @GST_VAAPI_ENCODER_STATUS_ERROR_INVALID_PARAMETER: Invalid parameter.
* @GST_VAAPI_ENCODER_STATUS_ERROR_INVALID_BUFFER: Invalid buffer.
* @GST_VAAPI_ENCODER_STATUS_ERROR_INVALID_SURFACE: Invalid surface.
@ -55,6 +60,8 @@ typedef enum
GST_VAAPI_ENCODER_STATUS_ERROR_UNKNOWN = -1,
GST_VAAPI_ENCODER_STATUS_ERROR_ALLOCATION_FAILED = -2,
GST_VAAPI_ENCODER_STATUS_ERROR_OPERATION_FAILED = -3,
GST_VAAPI_ENCODER_STATUS_ERROR_UNSUPPORTED_RATE_CONTROL = -4,
GST_VAAPI_ENCODER_STATUS_ERROR_INVALID_PARAMETER = -100,
GST_VAAPI_ENCODER_STATUS_ERROR_INVALID_BUFFER = -101,
GST_VAAPI_ENCODER_STATUS_ERROR_INVALID_SURFACE = -102,
@ -79,6 +86,10 @@ GstCaps *
gst_vaapi_encoder_set_format (GstVaapiEncoder * encoder,
GstVideoCodecState * state, GstCaps * ref_caps);
GstVaapiEncoderStatus
gst_vaapi_encoder_set_rate_control (GstVaapiEncoder * encoder,
GstVaapiRateControl rate_control);
GstVaapiEncoderStatus
gst_vaapi_encoder_put_frame (GstVaapiEncoder * encoder,
GstVideoCodecFrame * frame);

View file

@ -36,6 +36,17 @@
#define DEBUG 1
#include "gstvaapidebug.h"
/* Define default rate control mode ("constant-qp") */
#define DEFAULT_RATECONTROL GST_VAAPI_RATECONTROL_CQP
/* Supported set of VA rate controls, within this implementation */
#define SUPPORTED_RATECONTROLS \
(GST_VAAPI_RATECONTROL_MASK (NONE) | \
GST_VAAPI_RATECONTROL_MASK (CQP) | \
GST_VAAPI_RATECONTROL_MASK (CBR) | \
GST_VAAPI_RATECONTROL_MASK (VBR) | \
GST_VAAPI_RATECONTROL_MASK (VBR_CONSTRAINED))
#define GST_VAAPI_ENCODER_H264_NAL_REF_IDC_NONE 0
#define GST_VAAPI_ENCODER_H264_NAL_REF_IDC_LOW 1
#define GST_VAAPI_ENCODER_H264_NAL_REF_IDC_MEDIUM 2
@ -1690,6 +1701,8 @@ gst_vaapi_encoder_h264_init (GstVaapiEncoder * base)
{
GstVaapiEncoderH264 *encoder = GST_VAAPI_ENCODER_H264 (base);
base->rate_control = DEFAULT_RATECONTROL;
/* init attributes */
encoder->profile = 0;
encoder->level = 0;
@ -1756,6 +1769,8 @@ gst_vaapi_encoder_h264_finalize (GstVaapiEncoder * base)
}
GST_VAAPI_ENCODER_DEFINE_CLASS_DATA (H264);
static inline const GstVaapiEncoderClass *
gst_vaapi_encoder_h264_class (void)
{

View file

@ -37,6 +37,14 @@
#define DEBUG 1
#include "gstvaapidebug.h"
/* Define default rate control mode ("constant-qp") */
#define DEFAULT_RATECONTROL GST_VAAPI_RATECONTROL_CQP
/* Supported set of VA rate controls, within this implementation */
#define SUPPORTED_RATECONTROLS \
(GST_VAAPI_RATECONTROL_MASK (NONE) | \
GST_VAAPI_RATECONTROL_MASK (CQP) | \
GST_VAAPI_RATECONTROL_MASK (CBR))
static gboolean
gst_bit_writer_write_sps (GstBitWriter * bitwriter,
@ -720,6 +728,8 @@ gst_vaapi_encoder_mpeg2_init (GstVaapiEncoder * base)
{
GstVaapiEncoderMpeg2 *encoder = GST_VAAPI_ENCODER_MPEG2 (base);
base->rate_control = DEFAULT_RATECONTROL;
/* re-ordering */
g_queue_init (&encoder->b_frames);
encoder->dump_frames = FALSE;
@ -778,6 +788,8 @@ gst_vaapi_encoder_mpeg2_finalize (GstVaapiEncoder * base)
g_queue_clear (&encoder->b_frames);
}
GST_VAAPI_ENCODER_DEFINE_CLASS_DATA (MPEG2);
static inline const GstVaapiEncoderClass *
gst_vaapi_encoder_mpeg2_class (void)
{

View file

@ -48,7 +48,6 @@ typedef enum
#define GST_VAAPI_ENCODER_MPEG2_DEFAULT_PROFILE GST_ENCODER_MPEG2_PROFILE_MAIN
#define GST_VAAPI_ENCODER_MPEG2_DEFAULT_LEVEL GST_VAAPI_ENCODER_MPEG2_LEVEL_HIGH
#define GST_VAAPI_ENCODER_MPEG2_DEFAULT_RATE_CONTROL GST_VAAPI_RATECONTROL_CQP
#define GST_VAAPI_ENCODER_MPEG2_MIN_CQP 2
#define GST_VAAPI_ENCODER_MPEG2_MAX_CQP 62

View file

@ -61,8 +61,17 @@ G_BEGIN_DECLS
#define GST_VAAPI_ENCODER_HEIGHT(encoder) (GST_VAAPI_ENCODER_CAST(encoder)->video_info.height)
#define GST_VAAPI_ENCODER_FPS_N(encoder) (GST_VAAPI_ENCODER_CAST(encoder)->video_info.fps_n)
#define GST_VAAPI_ENCODER_FPS_D(encoder) (GST_VAAPI_ENCODER_CAST(encoder)->video_info.fps_d)
/**
* GST_VAAPI_ENCODER_RATE_CONTROL:
* @encoder: a #GstVaapiEncoder
*
* Macro that evaluates to the rate control.
* This is an internal macro that does not do any run-time type check.
*/
#undef GST_VAAPI_ENCODER_RATE_CONTROL
#define GST_VAAPI_ENCODER_RATE_CONTROL(encoder) \
(GST_VAAPI_ENCODER_CAST(encoder)->rate_control)
(GST_VAAPI_ENCODER_CAST (encoder)->rate_control)
#define GST_VAAPI_ENCODER_CHECK_STATUS(exp, err_num, err_reason, ...) \
if (!(exp)) { \
@ -72,6 +81,7 @@ G_BEGIN_DECLS
}
typedef struct _GstVaapiEncoderClass GstVaapiEncoderClass;
typedef struct _GstVaapiEncoderClassData GstVaapiEncoderClassData;
struct _GstVaapiEncoder
{
@ -87,6 +97,7 @@ struct _GstVaapiEncoder
VAContextID va_context;
GstVideoInfo video_info;
GstVaapiRateControl rate_control;
guint32 rate_control_mask;
GMutex mutex;
GCond surface_free;
@ -94,13 +105,32 @@ struct _GstVaapiEncoder
guint codedbuf_size;
GstVaapiVideoPool *codedbuf_pool;
GAsyncQueue *codedbuf_queue;
guint32 num_codedbuf_queued;
};
struct _GstVaapiEncoderClassData
{
/*< private >*/
GstVaapiCodec codec;
GstVaapiRateControl default_rate_control;
guint32 rate_control_mask;
};
#define GST_VAAPI_ENCODER_DEFINE_CLASS_DATA(CODEC) \
static const GstVaapiEncoderClassData g_class_data = { \
.codec = G_PASTE (GST_VAAPI_CODEC_, CODEC), \
.default_rate_control = DEFAULT_RATECONTROL, \
.rate_control_mask = SUPPORTED_RATECONTROLS, \
}
struct _GstVaapiEncoderClass
{
/*< private >*/
GstVaapiMiniObjectClass parent_class;
const GstVaapiEncoderClassData *class_data;
gboolean (*init) (GstVaapiEncoder * encoder);
void (*finalize) (GstVaapiEncoder * encoder);
@ -135,6 +165,7 @@ struct _GstVaapiEncoderClass
#define GST_VAAPI_ENCODER_CLASS_INIT(CODEC, codec) \
GST_VAAPI_ENCODER_CLASS_INIT_BASE (CODEC), \
.class_data = &g_class_data, \
GST_VAAPI_ENCODER_CLASS_HOOK (codec, init), \
GST_VAAPI_ENCODER_CLASS_HOOK (codec, finalize), \
GST_VAAPI_ENCODER_CLASS_HOOK (codec, set_format), \

View file

@ -144,6 +144,10 @@ typedef enum {
GST_VAAPI_RATECONTROL_VBR_CONSTRAINED,
} GstVaapiRateControl;
/* Define a mask for GstVaapiRateControl */
#define GST_VAAPI_RATECONTROL_MASK(RC) \
(1 << G_PASTE(GST_VAAPI_RATECONTROL_,RC))
G_END_DECLS
#endif /* GST_VAAPI_TYPES_H */

View file

@ -302,6 +302,7 @@ static gboolean
ensure_encoder (GstVaapiEncode * encode)
{
GstVaapiEncodeClass *klass = GST_VAAPIENCODE_GET_CLASS (encode);
GstVaapiEncoderStatus status;
g_return_val_if_fail (klass->create_encoder, FALSE);
@ -312,6 +313,11 @@ ensure_encoder (GstVaapiEncode * encode)
GST_VAAPI_PLUGIN_BASE_DISPLAY (encode));
if (!encode->encoder)
return FALSE;
status = gst_vaapi_encoder_set_rate_control (encode->encoder,
encode->rate_control);
if (status != GST_VAAPI_ENCODER_STATUS_SUCCESS)
return FALSE;
return TRUE;
}
@ -552,15 +558,6 @@ gst_vaapiencode_propose_allocation (GstVideoEncoder * venc, GstQuery * query)
}
#endif
static inline gboolean
check_ratecontrol (GstVaapiEncode * encode, GstVaapiRateControl rate_control)
{
GstVaapiEncodeClass *const klass = GST_VAAPIENCODE_GET_CLASS (encode);
return !klass->check_ratecontrol || klass->check_ratecontrol (encode,
rate_control);
}
static void
gst_vaapiencode_set_property (GObject * object, guint prop_id,
const GValue * value, GParamSpec * pspec)
@ -569,15 +566,8 @@ gst_vaapiencode_set_property (GObject * object, guint prop_id,
switch (prop_id) {
case PROP_RATE_CONTROL:
{
GstVaapiRateControl rate_control = g_value_get_enum (value);
if (check_ratecontrol (encode, rate_control)) {
encode->rate_control = rate_control;
} else {
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
}
encode->rate_control = g_value_get_enum (value);
break;
}
case PROP_BITRATE:
encode->bitrate = g_value_get_uint (value);
break;
@ -677,7 +667,7 @@ gst_vaapiencode_class_init (GstVaapiEncodeClass * klass)
"Rate Control",
"Rate control mode",
GST_VAAPI_TYPE_RATE_CONTROL,
GST_VAAPI_RATECONTROL_NONE,
GST_VAAPI_RATECONTROL_CQP,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
g_object_class_install_property (object_class,

View file

@ -70,8 +70,6 @@ struct _GstVaapiEncodeClass
/*< private >*/
GstVaapiPluginBaseClass parent_class;
gboolean (*check_ratecontrol) (GstVaapiEncode * encode,
GstVaapiRateControl rate_control);
GstVaapiEncoder * (*create_encoder) (GstVaapiEncode * encode,
GstVaapiDisplay * display);
GstFlowReturn (*allocate_buffer) (GstVaapiEncode * encode,

View file

@ -173,7 +173,6 @@ gst_vaapiencode_h264_create_encoder (GstVaapiEncode * base,
encoder->profile = GST_VAAPI_PROFILE_UNKNOWN;
encoder->level = GST_VAAPI_ENCODER_H264_DEFAULT_LEVEL;
GST_VAAPI_ENCODER_RATE_CONTROL (encoder) = base_encode->rate_control;
encoder->bitrate = base_encode->bitrate;
encoder->intra_period = encode->intra_period;
encoder->init_qp = encode->init_qp;

View file

@ -93,9 +93,6 @@ enum
static void
gst_vaapiencode_mpeg2_init (GstVaapiEncodeMpeg2 * encode)
{
GstVaapiEncode *const base_encode = GST_VAAPIENCODE_CAST (encode);
base_encode->rate_control = GST_VAAPI_ENCODER_MPEG2_DEFAULT_RATE_CONTROL;
encode->quantizer = GST_VAAPI_ENCODER_MPEG2_DEFAULT_CQP;
encode->intra_period = GST_VAAPI_ENCODER_MPEG2_DEFAULT_GOP_SIZE;
encode->ip_period = GST_VAAPI_ENCODER_MPEG2_DEFAULT_MAX_BFRAMES;
@ -167,7 +164,6 @@ gst_vaapiencode_mpeg2_create_encoder (GstVaapiEncode * base,
encoder->profile = GST_VAAPI_ENCODER_MPEG2_DEFAULT_PROFILE;
encoder->level = GST_VAAPI_ENCODER_MPEG2_DEFAULT_LEVEL;
GST_VAAPI_ENCODER_RATE_CONTROL (encoder) = base_encode->rate_control;
encoder->bitrate = base_encode->bitrate;
encoder->cqp = encode->quantizer;
encoder->intra_period = encode->intra_period;
@ -175,15 +171,6 @@ gst_vaapiencode_mpeg2_create_encoder (GstVaapiEncode * base,
return base_encoder;
}
static gboolean
gst_vaapiencode_mpeg2_check_ratecontrol (GstVaapiEncode * encode,
GstVaapiRateControl rate_control)
{
/* XXX: get information from GstVaapiEncoder object */
return rate_control == GST_VAAPI_RATECONTROL_CQP ||
rate_control == GST_VAAPI_RATECONTROL_CBR;
}
static void
gst_vaapiencode_mpeg2_class_init (GstVaapiEncodeMpeg2Class * klass)
{
@ -199,7 +186,6 @@ gst_vaapiencode_mpeg2_class_init (GstVaapiEncodeMpeg2Class * klass)
object_class->get_property = gst_vaapiencode_mpeg2_get_property;
encode_class->create_encoder = gst_vaapiencode_mpeg2_create_encoder;
encode_class->check_ratecontrol = gst_vaapiencode_mpeg2_check_ratecontrol;
gst_element_class_set_static_metadata (element_class,
"VA-API MPEG-2 encoder",