vdpau.h 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176
  1. /*
  2. * The Video Decode and Presentation API for UNIX (VDPAU) is used for
  3. * hardware-accelerated decoding of MPEG-1/2, H.264 and VC-1.
  4. *
  5. * Copyright (C) 2008 NVIDIA
  6. *
  7. * This file is part of FFmpeg.
  8. *
  9. * FFmpeg is free software; you can redistribute it and/or
  10. * modify it under the terms of the GNU Lesser General Public
  11. * License as published by the Free Software Foundation; either
  12. * version 2.1 of the License, or (at your option) any later version.
  13. *
  14. * FFmpeg is distributed in the hope that it will be useful,
  15. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17. * Lesser General Public License for more details.
  18. *
  19. * You should have received a copy of the GNU Lesser General Public
  20. * License along with FFmpeg; if not, write to the Free Software
  21. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  22. */
  23. #ifndef AVCODEC_VDPAU_H
  24. #define AVCODEC_VDPAU_H
  25. /**
  26. * @file
  27. * @ingroup lavc_codec_hwaccel_vdpau
  28. * Public libavcodec VDPAU header.
  29. */
  30. /**
  31. * @defgroup lavc_codec_hwaccel_vdpau VDPAU Decoder and Renderer
  32. * @ingroup lavc_codec_hwaccel
  33. *
  34. * VDPAU hardware acceleration has two modules
  35. * - VDPAU decoding
  36. * - VDPAU presentation
  37. *
  38. * The VDPAU decoding module parses all headers using FFmpeg
  39. * parsing mechanisms and uses VDPAU for the actual decoding.
  40. *
  41. * As per the current implementation, the actual decoding
  42. * and rendering (API calls) are done as part of the VDPAU
  43. * presentation (vo_vdpau.c) module.
  44. *
  45. * @{
  46. */
  47. #include <vdpau/vdpau.h>
  48. #include "libavutil/avconfig.h"
  49. #include "libavutil/attributes.h"
  50. #include "avcodec.h"
  51. #include "version.h"
  52. struct AVCodecContext;
  53. struct AVFrame;
  54. typedef int (*AVVDPAU_Render2)(struct AVCodecContext *, struct AVFrame *,
  55. const VdpPictureInfo *, uint32_t,
  56. const VdpBitstreamBuffer *);
  57. /**
  58. * This structure is used to share data between the libavcodec library and
  59. * the client video application.
  60. * The user shall allocate the structure via the av_alloc_vdpau_hwaccel
  61. * function and make it available as
  62. * AVCodecContext.hwaccel_context. Members can be set by the user once
  63. * during initialization or through each AVCodecContext.get_buffer()
  64. * function call. In any case, they must be valid prior to calling
  65. * decoding functions.
  66. *
  67. * The size of this structure is not a part of the public ABI and must not
  68. * be used outside of libavcodec. Use av_vdpau_alloc_context() to allocate an
  69. * AVVDPAUContext.
  70. */
  71. typedef struct AVVDPAUContext {
  72. /**
  73. * VDPAU decoder handle
  74. *
  75. * Set by user.
  76. */
  77. VdpDecoder decoder;
  78. /**
  79. * VDPAU decoder render callback
  80. *
  81. * Set by the user.
  82. */
  83. VdpDecoderRender *render;
  84. AVVDPAU_Render2 render2;
  85. } AVVDPAUContext;
  86. /**
  87. * @brief allocation function for AVVDPAUContext
  88. *
  89. * Allows extending the struct without breaking API/ABI
  90. */
  91. AVVDPAUContext *av_alloc_vdpaucontext(void);
  92. AVVDPAU_Render2 av_vdpau_hwaccel_get_render2(const AVVDPAUContext *);
  93. void av_vdpau_hwaccel_set_render2(AVVDPAUContext *, AVVDPAU_Render2);
  94. /**
  95. * Associate a VDPAU device with a codec context for hardware acceleration.
  96. * This function is meant to be called from the get_format() codec callback,
  97. * or earlier. It can also be called after avcodec_flush_buffers() to change
  98. * the underlying VDPAU device mid-stream (e.g. to recover from non-transparent
  99. * display preemption).
  100. *
  101. * @note get_format() must return AV_PIX_FMT_VDPAU if this function completes
  102. * successfully.
  103. *
  104. * @param avctx decoding context whose get_format() callback is invoked
  105. * @param device VDPAU device handle to use for hardware acceleration
  106. * @param get_proc_address VDPAU device driver
  107. * @param flags zero of more OR'd AV_HWACCEL_FLAG_* flags
  108. *
  109. * @return 0 on success, an AVERROR code on failure.
  110. */
  111. int av_vdpau_bind_context(AVCodecContext *avctx, VdpDevice device,
  112. VdpGetProcAddress *get_proc_address, unsigned flags);
  113. /**
  114. * Gets the parameters to create an adequate VDPAU video surface for the codec
  115. * context using VDPAU hardware decoding acceleration.
  116. *
  117. * @note Behavior is undefined if the context was not successfully bound to a
  118. * VDPAU device using av_vdpau_bind_context().
  119. *
  120. * @param avctx the codec context being used for decoding the stream
  121. * @param type storage space for the VDPAU video surface chroma type
  122. * (or NULL to ignore)
  123. * @param width storage space for the VDPAU video surface pixel width
  124. * (or NULL to ignore)
  125. * @param height storage space for the VDPAU video surface pixel height
  126. * (or NULL to ignore)
  127. *
  128. * @return 0 on success, a negative AVERROR code on failure.
  129. */
  130. int av_vdpau_get_surface_parameters(AVCodecContext *avctx, VdpChromaType *type,
  131. uint32_t *width, uint32_t *height);
  132. /**
  133. * Allocate an AVVDPAUContext.
  134. *
  135. * @return Newly-allocated AVVDPAUContext or NULL on failure.
  136. */
  137. AVVDPAUContext *av_vdpau_alloc_context(void);
  138. #if FF_API_VDPAU_PROFILE
  139. /**
  140. * Get a decoder profile that should be used for initializing a VDPAU decoder.
  141. * Should be called from the AVCodecContext.get_format() callback.
  142. *
  143. * @deprecated Use av_vdpau_bind_context() instead.
  144. *
  145. * @param avctx the codec context being used for decoding the stream
  146. * @param profile a pointer into which the result will be written on success.
  147. * The contents of profile are undefined if this function returns
  148. * an error.
  149. *
  150. * @return 0 on success (non-negative), a negative AVERROR on failure.
  151. */
  152. attribute_deprecated
  153. int av_vdpau_get_profile(AVCodecContext *avctx, VdpDecoderProfile *profile);
  154. #endif
  155. /* @}*/
  156. #endif /* AVCODEC_VDPAU_H */