gstreamer/gst-libs/gst/vaapi/video-format.c

/*
 *  video-format.h - Video format helpers for VA-API
 *
 *  Copyright (C) 2010-2011 Splitted-Desktop Systems
 *  Copyright (C) 2011-2013 Intel Corporation
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public License
 *  as published by the Free Software Foundation; either version 2.1
 *  of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free
 *  Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 *  Boston, MA 02110-1301 USA
 */

/**
 * SECTION:videoformat
 * @short_description: Video format helpers for VA-API
 */

#include "sysdeps.h"
#include <gst/video/video.h>
#include "gstvaapicompat.h"
#include "gstvaapisurface.h"
#include "video-format.h"

typedef struct _GstVideoFormatMap GstVideoFormatMap;
struct _GstVideoFormatMap {
    GstVideoFormat      format;
    GstVaapiChromaType  chroma_type;
    const char         *caps_str;
    VAImageFormat       va_format;
};

#if GST_CHECK_VERSION(1,0,0)
# define GST_VIDEO_CAPS_MAKE_YUV(FORMAT) \
    GST_VIDEO_CAPS_MAKE(#FORMAT)
# define GST_VIDEO_CAPS_MAKE_RGB(FORMAT) \
    GST_VIDEO_CAPS_MAKE(#FORMAT)
#else
# define GST_VIDEO_CAPS_MAKE_YUV(FORMAT) \
    GST_VIDEO_CAPS_YUV(#FORMAT)
# define GST_VIDEO_CAPS_MAKE_RGB(FORMAT) \
    GST_VIDEO_CAPS_##FORMAT
#endif

#define DEF_YUV(FORMAT, FOURCC, ENDIAN, BPP, SUB)                       \
    { G_PASTE(GST_VIDEO_FORMAT_,FORMAT),                                \
      G_PASTE(GST_VAAPI_CHROMA_TYPE_YUV,SUB),                           \
      GST_VIDEO_CAPS_MAKE_YUV(FORMAT),                                  \
      { VA_FOURCC FOURCC, VA_##ENDIAN##_FIRST, BPP, }, }

#define DEF_RGB(FORMAT, FOURCC, ENDIAN, BPP, DEPTH, R,G,B,A)            \
    { G_PASTE(GST_VIDEO_FORMAT_,FORMAT),                                \
      G_PASTE(GST_VAAPI_CHROMA_TYPE_RGB,BPP),                           \
      GST_VIDEO_CAPS_MAKE_RGB(FORMAT),                                  \
      { VA_FOURCC FOURCC, VA_##ENDIAN##_FIRST, BPP, DEPTH, R,G,B,A }, }

/* Image formats, listed in HW order preference */
static const GstVideoFormatMap gst_vaapi_video_formats[] = {
    DEF_YUV(NV12, ('N','V','1','2'), LSB, 12, 420),
    DEF_YUV(YV12, ('Y','V','1','2'), LSB, 12, 420),
    DEF_YUV(I420, ('I','4','2','0'), LSB, 12, 420),
    DEF_YUV(YUY2, ('Y','U','Y','2'), LSB, 16, 422),
    DEF_YUV(UYVY, ('U','Y','V','Y'), LSB, 16, 422),
    DEF_YUV(AYUV, ('A','Y','U','V'), LSB, 32, 444),
#if G_BYTE_ORDER == G_BIG_ENDIAN
    DEF_RGB(ARGB, ('A','R','G','B'), MSB, 32,
            32, 0x00ff0000, 0x0000ff00, 0x000000ff, 0xff000000),
    DEF_RGB(ABGR, ('A','B','G','R'), MSB, 32,
            32, 0x000000ff, 0x0000ff00, 0x00ff0000, 0xff000000),
    DEF_RGB(xRGB, ('X','R','G','B'), MSB, 32,
            24, 0x00ff0000, 0x0000ff00, 0x000000ff, 0x00000000),
    DEF_RGB(xBGR, ('X','B','G','R'), MSB, 32,
            24, 0x000000ff, 0x0000ff00, 0x00ff0000, 0x00000000),
#elif G_BYTE_ORDER == G_LITTLE_ENDIAN
    DEF_RGB(BGRA, ('B','G','R','A'), LSB, 32,
            32, 0x00ff0000, 0x0000ff00, 0x000000ff, 0xff000000),
    DEF_RGB(RGBA, ('R','G','B','A'), LSB, 32,
            32, 0x000000ff, 0x0000ff00, 0x00ff0000, 0xff000000),
    DEF_RGB(BGRx, ('B','G','R','X'), LSB, 32,
            24, 0x00ff0000, 0x0000ff00, 0x000000ff, 0x00000000),
    DEF_RGB(RGBx, ('R','G','B','X'), LSB, 32,
            24, 0x000000ff, 0x0000ff00, 0x00ff0000, 0x00000000),
#endif
    DEF_YUV(GRAY8, ('Y','8','0','0'), LSB, 8, 400),
    { 0, }
};

#undef DEF_RGB
#undef DEF_YUV

static inline gboolean
va_format_is_rgb(const VAImageFormat *va_format)
{
    return va_format->depth != 0;
}

static inline gboolean
va_format_is_yuv(const VAImageFormat *va_format)
{
    return va_format->depth == 0;
}

static inline gboolean
va_format_is_same_rgb(const VAImageFormat *fmt1, const VAImageFormat *fmt2)
{
    return (fmt1->byte_order == fmt2->byte_order &&
            fmt1->red_mask   == fmt2->red_mask   &&
            fmt1->green_mask == fmt2->green_mask &&
            fmt1->blue_mask  == fmt2->blue_mask  &&
            fmt1->alpha_mask == fmt2->alpha_mask);
}

static inline gboolean
va_format_is_same(const VAImageFormat *fmt1, const VAImageFormat *fmt2)
{
    if (fmt1->fourcc != fmt2->fourcc)
        return FALSE;
    return va_format_is_rgb(fmt1) ? va_format_is_same_rgb(fmt1, fmt2) : TRUE;
}

static const GstVideoFormatMap *
get_map(GstVideoFormat format)
{
    const GstVideoFormatMap *m;

    for (m = gst_vaapi_video_formats; m->format; m++) {
        if (m->format == format)
            return m;
    }
    return NULL;
}

/**
 * gst_vaapi_video_format_from_string:
 * @str: a string representation of #GstVideoFormat
 *
 * Returns the #GstVideoFormat represented as the string @str.
 *
 * Return value: #GstVideoFormat for the string representation of
 *   video format in @str.
 */
GstVideoFormat
gst_vaapi_video_format_from_string(const gchar *str)
{
#if GST_CHECK_VERSION(1,0,0)
    return gst_video_format_from_string(str);
#else
    GstVideoFormat format = GST_VIDEO_FORMAT_UNKNOWN;

    do {
        /* Validate input string */
        if (!str)
            break;

        /* Fast path: assume this represents a common fourcc value */
        const guint32 fourcc = GST_MAKE_FOURCC(str[0], str[1], str[2], str[3]);
        format = gst_video_format_from_fourcc(fourcc);
        if (format != GST_VIDEO_FORMAT_UNKNOWN)
            break;

        /* Slow path: check through all registered enum values */
        GEnumClass * const enum_class =
            g_type_class_ref(GST_TYPE_VIDEO_FORMAT);
        if (!enum_class)
            break;

        gchar * const video_format_str =
            g_strdup_printf("GST_VIDEO_FORMAT_%s", str);
        if (video_format_str) {
            const GEnumValue * const enum_value =
                g_enum_get_value_by_name(enum_class, video_format_str);

            if (enum_value)
                format = enum_value->value;
            g_free(video_format_str);
        }
        g_type_class_unref(enum_class);
    } while (0);
    return format;
#endif
}

/**
 * gst_vaapi_video_format_to_string:
 * @format: a #GstVideoFormat
 *
 * Returns the string representation of the @format argument.
 *
 * Return value: string representation of @format, or %NULL if unknown
 *   or unsupported.
 */
const gchar *
gst_vaapi_video_format_to_string(GstVideoFormat format)
{
    return gst_video_format_to_string(format);
}

/**
 * gst_vaapi_video_format_is_rgb:
 * @format: a #GstVideoFormat
 *
 * Checks whether the format is an RGB format.
 *
 * Return value: %TRUE if @format is RGB format
 */
gboolean
gst_vaapi_video_format_is_rgb(GstVideoFormat format)
{
    const GstVideoFormatMap * const m = get_map(format);

    return m && va_format_is_rgb(&m->va_format);
}

/**
 * gst_vaapi_video_format_is_yuv:
 * @format: a #GstVideoFormat
 *
 * Checks whether the format is an YUV format.
 *
 * Return value: %TRUE if @format is YUV format
 */
gboolean
gst_vaapi_video_format_is_yuv(GstVideoFormat format)
{
    const GstVideoFormatMap * const m = get_map(format);

    return m && va_format_is_yuv(&m->va_format);
}

/**
 * gst_vaapi_video_format_from_caps:
 * @caps: a #GstCaps
 *
 * Converts @caps into the corresponding #GstVideoFormat. If the
 * image format cannot be represented by #GstVideoFormat, then
 * zero is returned.
 *
 * Return value: the #GstVideoFormat describing the @caps
 */
GstVideoFormat
gst_vaapi_video_format_from_caps(GstCaps *caps)
{
    GstStructure *structure;

    if (!caps)
        return 0;

    structure = gst_caps_get_structure(caps, 0);
    if (!structure)
        return 0;
    return gst_vaapi_video_format_from_structure(structure);
}

/**
 * gst_vaapi_video_format_from_structure:
 * @structure: a #GstStructure
 *
 * Converts @structure into the corresponding #GstVideoFormat. If
 * the image format cannot be represented by #GstVideoFormat,
 * then zero is returned.
 *
 * Return value: the #GstVideoFormat describing the @structure
 */
GstVideoFormat
gst_vaapi_video_format_from_structure(GstStructure *structure)
{
#if GST_CHECK_VERSION(1,0,0)
    const gchar * format = gst_structure_get_string(structure, "format");
    if (format)
        return gst_video_format_from_string(format);
    return GST_VIDEO_FORMAT_UNKNOWN;
#else
    const GstVideoFormatMap *m;
    VAImageFormat *va_format, va_formats[2];
    gint endian, rmask, gmask, bmask, amask = 0;
    guint32 fourcc;

    /* Check for YUV format */
    if (gst_structure_get_fourcc(structure, "format", &fourcc))
        return gst_video_format_from_fourcc(fourcc);

    /* Check for RGB format */
    gst_structure_get_int(structure, "endianness", &endian);
    gst_structure_get_int(structure, "red_mask",   &rmask);
    gst_structure_get_int(structure, "green_mask", &gmask);
    gst_structure_get_int(structure, "blue_mask",  &bmask);
    gst_structure_get_int(structure, "alpha_mask", &amask);

    va_format = &va_formats[0];
    va_format->byte_order = endian == G_BIG_ENDIAN ? VA_MSB_FIRST : VA_LSB_FIRST;
    va_format->red_mask   = rmask;
    va_format->green_mask = gmask;
    va_format->blue_mask  = bmask;
    va_format->alpha_mask = amask;

    va_format = &va_formats[1];
    va_format->byte_order = endian == G_BIG_ENDIAN ? VA_LSB_FIRST : VA_MSB_FIRST;
    va_format->red_mask   = GUINT32_SWAP_LE_BE(rmask);
    va_format->green_mask = GUINT32_SWAP_LE_BE(gmask);
    va_format->blue_mask  = GUINT32_SWAP_LE_BE(bmask);
    va_format->alpha_mask = GUINT32_SWAP_LE_BE(amask);

    for (m = gst_vaapi_video_formats; m->format; m++) {
        if (va_format_is_rgb(&m->va_format) &&
            (va_format_is_same_rgb(&m->va_format, &va_formats[0]) ||
             va_format_is_same_rgb(&m->va_format, &va_formats[1])))
            return m->format;
    }
    return GST_VIDEO_FORMAT_UNKNOWN;
#endif
}

/**
 * gst_vaapi_video_format_to_caps:
 * @format: a #GstVideoFormat
 *
 * Converts a #GstVideoFormat into the corresponding #GstCaps. If
 * no matching caps were found, %NULL is returned.
 *
 * Return value: the newly allocated #GstCaps, or %NULL if none was found
 */
GstCaps *
gst_vaapi_video_format_to_caps(GstVideoFormat format)
{
    const GstVideoFormatMap * const m = get_map(format);

    return m ? gst_caps_from_string(m->caps_str) : NULL;
}

/**
 * gst_vaapi_video_format_from_va_fourcc:
 * @fourcc: a FOURCC value
 *
 * Converts a VA fourcc into the corresponding #GstVideoFormat. If no
 * matching fourcc was found, then zero is returned.
 *
 * Return value: the #GstVideoFormat corresponding to the VA @fourcc
 */
GstVideoFormat
gst_vaapi_video_format_from_va_fourcc(guint32 fourcc)
{
    const GstVideoFormatMap *m;

    /* Note: VA fourcc values are now standardized and shall represent
       a unique format. The associated VAImageFormat is just a hint to
       determine RGBA component ordering */
    for (m = gst_vaapi_video_formats; m->format; m++) {
        if (m->va_format.fourcc == fourcc)
            return m->format;
    }
    return GST_VIDEO_FORMAT_UNKNOWN;
}

/**
 * gst_vaapi_video_format_from_va_format:
 * @va_format: a #VAImageFormat
 *
 * Converts a VA image format into the corresponding #GstVideoFormat.
 * If the image format cannot be represented by #GstVideoFormat,
 * then zero is returned.
 *
 * Return value: the #GstVideoFormat describing the @va_format
 */
GstVideoFormat
gst_vaapi_video_format_from_va_format(const VAImageFormat *va_format)
{
    const GstVideoFormatMap *m;

    for (m = gst_vaapi_video_formats; m->format; m++) {
        if (va_format_is_same(&m->va_format, va_format))
            return m->format;
    }
    return GST_VIDEO_FORMAT_UNKNOWN;
}

/**
 * gst_vaapi_video_format_to_va_format:
 * @format: a #GstVideoFormat
 *
 * Converts a #GstVideoFormat into the corresponding VA image
 * format. If no matching VA image format was found, %NULL is returned
 * and this error must be reported to be fixed.
 *
 * Return value: the VA image format, or %NULL if none was found
 */
const VAImageFormat *
gst_vaapi_video_format_to_va_format(GstVideoFormat format)
{
    const GstVideoFormatMap * const m = get_map(format);

    return m ? &m->va_format : NULL;
}

/**
 * gst_vaapi_video_format_get_chroma_type:
 * @format: a #GstVideoFormat
 *
 * Converts a #GstVideoFormat into the corresponding #GstVaapiChromaType
 * format.
 *
 * Return value: the #GstVaapiChromaType format, or zero if no match
 *   was found.
 */
guint
gst_vaapi_video_format_get_chroma_type(GstVideoFormat format)
{
    const GstVideoFormatMap * const m = get_map(format);

    return m ? m->chroma_type : 0;
}

/**
 * gst_vaapi_video_format_get_score:
 * @format: a #GstVideoFormat
 *
 * Determines how "native" is this @format. The lower is the returned
 * score, the best format this is for the underlying hardware.
 *
 * Return value: the @format score, or %G_MAXUINT if none was found
 */
guint
gst_vaapi_video_format_get_score(GstVideoFormat format)
{
    const GstVideoFormatMap * const m = get_map(format);

    return m ? (m - &gst_vaapi_video_formats[0]) : G_MAXUINT;
}