GstAllocators-1.0.gir 8.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204
  1. <?xml version="1.0"?>
  2. <!-- This file was automatically generated from C sources - DO NOT EDIT!
  3. To affect the contents of this file, edit the original C definitions,
  4. and/or use gtk-doc annotations. -->
  5. <repository version="1.2"
  6. xmlns="http://www.gtk.org/introspection/core/1.0"
  7. xmlns:c="http://www.gtk.org/introspection/c/1.0"
  8. xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
  9. <include name="Gst" version="1.0"/>
  10. <package name="gstreamer-allocators-1.0"/>
  11. <c:include name="gst/allocators/allocators.h"/>
  12. <namespace name="GstAllocators"
  13. version="1.0"
  14. shared-library="libgstallocators-1.0.so.0"
  15. c:identifier-prefixes="Gst"
  16. c:symbol-prefixes="gst">
  17. <constant name="ALLOCATOR_DMABUF"
  18. value="dmabuf"
  19. c:type="GST_ALLOCATOR_DMABUF">
  20. <type name="utf8" c:type="gchar*"/>
  21. </constant>
  22. <constant name="ALLOCATOR_FD" value="fd" c:type="GST_ALLOCATOR_FD">
  23. <type name="utf8" c:type="gchar*"/>
  24. </constant>
  25. <class name="FdAllocator"
  26. c:symbol-prefix="fd_allocator"
  27. c:type="GstFdAllocator"
  28. version="1.6"
  29. parent="Gst.Allocator"
  30. glib:type-name="GstFdAllocator"
  31. glib:get-type="gst_fd_allocator_get_type"
  32. glib:type-struct="FdAllocatorClass">
  33. <doc xml:space="preserve">Base class for allocators with fd-backed memory</doc>
  34. <constructor name="new"
  35. c:identifier="gst_fd_allocator_new"
  36. version="1.6">
  37. <doc xml:space="preserve">Return a new fd allocator.</doc>
  38. <return-value transfer-ownership="full">
  39. <doc xml:space="preserve">a new fd allocator, or NULL if the allocator
  40. isn't available. Use gst_object_unref() to release the allocator after
  41. usage</doc>
  42. <type name="Gst.Allocator" c:type="GstAllocator*"/>
  43. </return-value>
  44. </constructor>
  45. <function name="alloc"
  46. c:identifier="gst_fd_allocator_alloc"
  47. version="1.6">
  48. <doc xml:space="preserve">Return a %GstMemory that wraps a generic file descriptor.</doc>
  49. <return-value transfer-ownership="full">
  50. <doc xml:space="preserve">a GstMemory based on @allocator.
  51. When the buffer will be released the allocator will close the @fd.
  52. The memory is only mmapped on gst_buffer_mmap() request.</doc>
  53. <type name="Gst.Memory" c:type="GstMemory*"/>
  54. </return-value>
  55. <parameters>
  56. <parameter name="allocator" transfer-ownership="none">
  57. <doc xml:space="preserve">allocator to be used for this memory</doc>
  58. <type name="Gst.Allocator" c:type="GstAllocator*"/>
  59. </parameter>
  60. <parameter name="fd" transfer-ownership="none">
  61. <doc xml:space="preserve">file descriptor</doc>
  62. <type name="gint" c:type="gint"/>
  63. </parameter>
  64. <parameter name="size" transfer-ownership="none">
  65. <doc xml:space="preserve">memory size</doc>
  66. <type name="gsize" c:type="gsize"/>
  67. </parameter>
  68. <parameter name="flags" transfer-ownership="none">
  69. <doc xml:space="preserve">extra #GstFdMemoryFlags</doc>
  70. <type name="FdMemoryFlags" c:type="GstFdMemoryFlags"/>
  71. </parameter>
  72. </parameters>
  73. </function>
  74. <field name="parent">
  75. <type name="Gst.Allocator" c:type="GstAllocator"/>
  76. </field>
  77. </class>
  78. <record name="FdAllocatorClass"
  79. c:type="GstFdAllocatorClass"
  80. glib:is-gtype-struct-for="FdAllocator">
  81. <field name="parent_class">
  82. <type name="Gst.AllocatorClass" c:type="GstAllocatorClass"/>
  83. </field>
  84. </record>
  85. <bitfield name="FdMemoryFlags" version="1.6" c:type="GstFdMemoryFlags">
  86. <doc xml:space="preserve">Various flags to control the operation of the fd backed memory.</doc>
  87. <member name="none" value="0" c:identifier="GST_FD_MEMORY_FLAG_NONE">
  88. <doc xml:space="preserve">no flag</doc>
  89. </member>
  90. <member name="keep_mapped"
  91. value="1"
  92. c:identifier="GST_FD_MEMORY_FLAG_KEEP_MAPPED">
  93. <doc xml:space="preserve">once the memory is mapped,
  94. keep it mapped until the memory is destroyed.</doc>
  95. </member>
  96. <member name="map_private"
  97. value="2"
  98. c:identifier="GST_FD_MEMORY_FLAG_MAP_PRIVATE">
  99. <doc xml:space="preserve">do a private mapping instead of
  100. the default shared mapping.</doc>
  101. </member>
  102. </bitfield>
  103. <function name="dmabuf_allocator_alloc"
  104. c:identifier="gst_dmabuf_allocator_alloc"
  105. version="1.2">
  106. <doc xml:space="preserve">Return a %GstMemory that wraps a dmabuf file descriptor.</doc>
  107. <return-value transfer-ownership="full">
  108. <doc xml:space="preserve">a GstMemory based on @allocator.
  109. When the buffer will be released dmabuf allocator will close the @fd.
  110. The memory is only mmapped on gst_buffer_mmap() request.</doc>
  111. <type name="Gst.Memory" c:type="GstMemory*"/>
  112. </return-value>
  113. <parameters>
  114. <parameter name="allocator" transfer-ownership="none">
  115. <doc xml:space="preserve">allocator to be used for this memory</doc>
  116. <type name="Gst.Allocator" c:type="GstAllocator*"/>
  117. </parameter>
  118. <parameter name="fd" transfer-ownership="none">
  119. <doc xml:space="preserve">dmabuf file descriptor</doc>
  120. <type name="gint" c:type="gint"/>
  121. </parameter>
  122. <parameter name="size" transfer-ownership="none">
  123. <doc xml:space="preserve">memory size</doc>
  124. <type name="gsize" c:type="gsize"/>
  125. </parameter>
  126. </parameters>
  127. </function>
  128. <function name="dmabuf_allocator_new"
  129. c:identifier="gst_dmabuf_allocator_new"
  130. version="1.2">
  131. <doc xml:space="preserve">Return a new dmabuf allocator.</doc>
  132. <return-value transfer-ownership="full">
  133. <doc xml:space="preserve">a new dmabuf allocator, or NULL if the allocator
  134. isn't available. Use gst_object_unref() to release the allocator after
  135. usage</doc>
  136. <type name="Gst.Allocator" c:type="GstAllocator*"/>
  137. </return-value>
  138. </function>
  139. <function name="dmabuf_memory_get_fd"
  140. c:identifier="gst_dmabuf_memory_get_fd"
  141. version="1.2">
  142. <doc xml:space="preserve">Return the file descriptor associated with @mem.</doc>
  143. <return-value transfer-ownership="none">
  144. <doc xml:space="preserve">the file descriptor associated with the memory, or -1. The file
  145. descriptor is still owned by the GstMemory. Use dup to take a copy
  146. if you intend to use it beyond the lifetime of this GstMemory.</doc>
  147. <type name="gint" c:type="gint"/>
  148. </return-value>
  149. <parameters>
  150. <parameter name="mem" transfer-ownership="none">
  151. <doc xml:space="preserve">the memory to get the file descriptor</doc>
  152. <type name="Gst.Memory" c:type="GstMemory*"/>
  153. </parameter>
  154. </parameters>
  155. </function>
  156. <function name="fd_memory_get_fd"
  157. c:identifier="gst_fd_memory_get_fd"
  158. version="1.6">
  159. <doc xml:space="preserve">Get the fd from @mem. Call gst_is_fd_memory() to check if @mem has
  160. an fd.</doc>
  161. <return-value transfer-ownership="none">
  162. <doc xml:space="preserve">the fd of @mem or -1 when there is no fd on @mem</doc>
  163. <type name="gint" c:type="gint"/>
  164. </return-value>
  165. <parameters>
  166. <parameter name="mem" transfer-ownership="none">
  167. <doc xml:space="preserve">#GstMemory</doc>
  168. <type name="Gst.Memory" c:type="GstMemory*"/>
  169. </parameter>
  170. </parameters>
  171. </function>
  172. <function name="is_dmabuf_memory"
  173. c:identifier="gst_is_dmabuf_memory"
  174. version="1.2">
  175. <doc xml:space="preserve">Check if @mem is dmabuf memory.</doc>
  176. <return-value transfer-ownership="none">
  177. <doc xml:space="preserve">%TRUE if @mem is dmabuf memory, otherwise %FALSE</doc>
  178. <type name="gboolean" c:type="gboolean"/>
  179. </return-value>
  180. <parameters>
  181. <parameter name="mem" transfer-ownership="none">
  182. <doc xml:space="preserve">the memory to be check</doc>
  183. <type name="Gst.Memory" c:type="GstMemory*"/>
  184. </parameter>
  185. </parameters>
  186. </function>
  187. <function name="is_fd_memory"
  188. c:identifier="gst_is_fd_memory"
  189. version="1.6">
  190. <doc xml:space="preserve">Check if @mem is memory backed by an fd</doc>
  191. <return-value transfer-ownership="none">
  192. <doc xml:space="preserve">%TRUE when @mem has an fd that can be retrieved with
  193. gst_fd_memory_get_fd().</doc>
  194. <type name="gboolean" c:type="gboolean"/>
  195. </return-value>
  196. <parameters>
  197. <parameter name="mem" transfer-ownership="none">
  198. <doc xml:space="preserve">#GstMemory</doc>
  199. <type name="Gst.Memory" c:type="GstMemory*"/>
  200. </parameter>
  201. </parameters>
  202. </function>
  203. </namespace>
  204. </repository>