gstreamer/sys/d3d11/gstd3d11decoder.h

/* GStreamer
 * Copyright (C) 2019 Seungha Yang <seungha.yang@navercorp.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

#ifndef __GST_D3D11_DECODER_H__
#define __GST_D3D11_DECODER_H__

#include <gst/gst.h>
#include <gst/video/video.h>
#include "gstd3d11_fwd.h"
#include "gstd3d11device.h"
#include "gstd3d11utils.h"

G_BEGIN_DECLS

#define GST_TYPE_D3D11_DECODER \
  (gst_d3d11_decoder_get_type())
#define GST_D3D11_DECODER(obj) \
  (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_D3D11_DECODER,GstD3D11Decoder))
#define GST_D3D11_DECODER_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_D3D11_DECODER,GstD3D11DecoderClass))
#define GST_D3D11_DECODER_GET_CLASS(obj) \
  (G_TYPE_INSTANCE_GET_CLASS((obj),GST_TYPE_D3D11_DECODER,GstD3D11DecoderClass))
#define GST_IS_D3D11_DECODER(obj) \
  (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_D3D11_DECODER))
#define GST_IS_D3D11_DECODER_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_D3D11_DECODER))

#define GST_D3D11_VIDEO_DECODER_ERROR_FROM_ERROR(el, err) G_STMT_START {  \
  gchar *__dbg = g_strdup (err->message); \
  GstVideoDecoder *__dec = GST_VIDEO_DECODER (el);  \
  GST_WARNING_OBJECT (el, "error: %s", __dbg);  \
  _gst_video_decoder_error (__dec, 1, \
    err->domain, err->code, \
    NULL, __dbg, __FILE__, GST_FUNCTION, __LINE__); \
  g_clear_error (&err); \
} G_STMT_END

typedef struct _GstD3D11DecoderOutputView GstD3D11DecoderOutputView;

struct _GstD3D11DecoderOutputView
{
  GstD3D11Device *device;
  ID3D11VideoDecoderOutputView *handle;
  guint view_id;
};

typedef enum
{
  GST_D3D11_CODEC_NONE,
  GST_D3D11_CODEC_H264,
  GST_D3D11_CODEC_VP9,
  GST_D3D11_CODEC_H265,

  /* the last of supported codec */
  GST_D3D11_CODEC_LAST
} GstD3D11Codec;

typedef struct
{
  GstCaps *sink_caps;
  GstCaps *src_caps;
  guint adapter;
  guint device_id;
  guint vendor_id;
  gchar *description;
} GstD3D11DecoderClassData;

/* use our struct for DXVA_Status_* (including DXVA_PicEntry_*) to query
 * decoding status. Microsoft defines the struct per codec but their ABI are
 * compatible each other and mingw header does not define some structs */

/* DXVA_PicEntry_*, from dxva.h */
typedef struct
{
  union {
    struct {
      UCHAR  Index7Bits      : 7;
      UCHAR  AssociatedFlag  : 1;
    };
    UCHAR  bPicEntry;
  };
} GstDXVAPicEntry;

/* DXVA_Status_*, from dxva.h */
typedef struct
{
  UINT StatusReportFeedbackNumber;
  GstDXVAPicEntry CurrPic; /* flag is bot field flag */
  UCHAR  field_pic_flag;
  UCHAR  bDXVA_Func;
  UCHAR  bBufType;
  UCHAR  bStatus;
  UCHAR  bReserved8Bits;
  USHORT wNumMbsAffected;
} GstDXVAStatus;

struct _GstD3D11Decoder
{
  GstObject parent;

  /* TRUE if decoder was successfully opened ever */
  gboolean opened;

  /*< private >*/
  GstD3D11DecoderPrivate *priv;
  gpointer padding[GST_PADDING_LARGE];
};

struct _GstD3D11DecoderClass
{
  GstObjectClass parent_class;
};

GType gst_d3d11_decoder_get_type (void);

GstD3D11Decoder * gst_d3d11_decoder_new (GstD3D11Device * device);

gboolean          gst_d3d11_decoder_open (GstD3D11Decoder * decoder,
                                          GstD3D11Codec codec,
                                          GstVideoInfo * info,
                                          guint codec_width,
                                          guint codec_height,
                                          guint pool_size,
                                          const GUID ** decoder_profiles,
                                          guint profile_size);

void              gst_d3d11_decoder_reset (GstD3D11Decoder * decoder);

gboolean          gst_d3d11_decoder_begin_frame (GstD3D11Decoder * decoder,
                                                 GstD3D11DecoderOutputView * output_view,
                                                 guint content_key_size,
                                                 gconstpointer content_key);

gboolean          gst_d3d11_decoder_end_frame (GstD3D11Decoder * decoder);

gboolean          gst_d3d11_decoder_get_decoder_buffer (GstD3D11Decoder * decoder,
                                                        D3D11_VIDEO_DECODER_BUFFER_TYPE type,
                                                        guint * buffer_size,
                                                        gpointer * buffer);

gboolean          gst_d3d11_decoder_release_decoder_buffer (GstD3D11Decoder * decoder,
                                                            D3D11_VIDEO_DECODER_BUFFER_TYPE type);

gboolean          gst_d3d11_decoder_submit_decoder_buffers (GstD3D11Decoder * decoder,
                                                            guint buffer_count,
                                                            const D3D11_VIDEO_DECODER_BUFFER_DESC * buffers);

GstBuffer *       gst_d3d11_decoder_get_output_view_buffer (GstD3D11Decoder * decoder);

GstD3D11DecoderOutputView * gst_d3d11_decoder_get_output_view_from_buffer (GstD3D11Decoder * decoder,
                                                                           GstBuffer * buffer);

guint             gst_d3d11_decoder_get_output_view_index (GstD3D11Decoder * decoder,
                                                           ID3D11VideoDecoderOutputView * view_handle);

gboolean          gst_d3d11_decoder_copy_decoder_buffer (GstD3D11Decoder * decoder,
                                                         GstVideoInfo * info,
                                                         GstBuffer * decoder_buffer,
                                                         GstBuffer * output);

gboolean          gst_d3d11_decoder_get_status_report   (GstD3D11Decoder * decoder,
                                                         GstDXVAStatus * status,
                                                         GError ** error);

/* Utils for class registration */
gboolean          gst_d3d11_decoder_util_is_legacy_device (GstD3D11Device * device);

gboolean          gst_d3d11_decoder_get_supported_decoder_profile (GstD3D11Decoder * decoder,
                                                                   const GUID ** decoder_profiles,
                                                                   guint profile_size,
                                                                   GUID * selected_profile);

gboolean          gst_d3d11_decoder_supports_format (GstD3D11Decoder * decoder,
                                                     const GUID * decoder_profile,
                                                     DXGI_FORMAT format);

gboolean          gst_d3d11_decoder_supports_resolution (GstD3D11Decoder * decoder,
                                                         const GUID * decoder_profile,
                                                         DXGI_FORMAT format,
                                                         guint width,
                                                         guint height);

GstD3D11DecoderClassData * gst_d3d11_decoder_class_data_new (GstD3D11Device * device,
                                                             GstCaps * sink_caps,
                                                             GstCaps * src_caps);

void              gst_d3d11_decoder_class_data_free (GstD3D11DecoderClassData * data);

G_END_DECLS

#endif /* __GST_D3D11_DECODER_H__ */