/usr/include/d/gtkd-3/gstreamer/BufferPool.d is in libgstreamerd-3-dev 3.7.5-2build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 | /*
* This file is part of gtkD.
*
* gtkD 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 3
* of the License, or (at your option) any later version, with
* some exceptions, please read the COPYING file.
*
* gtkD 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 gtkD; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
*/
// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage
module gstreamer.BufferPool;
private import glib.ConstructionException;
private import glib.MemorySlice;
private import glib.Str;
private import gobject.ObjectG;
private import gstreamer.AllocationParams;
private import gstreamer.Allocator;
private import gstreamer.Buffer;
private import gstreamer.Caps;
private import gstreamer.ObjectGst;
private import gstreamer.Structure;
private import gstreamer.c.functions;
public import gstreamer.c.types;
public import gstreamerc.gstreamertypes;
/**
* A #GstBufferPool is an object that can be used to pre-allocate and recycle
* buffers of the same size and with the same properties.
*
* A #GstBufferPool is created with gst_buffer_pool_new().
*
* Once a pool is created, it needs to be configured. A call to
* gst_buffer_pool_get_config() returns the current configuration structure from
* the pool. With gst_buffer_pool_config_set_params() and
* gst_buffer_pool_config_set_allocator() the bufferpool parameters and
* allocator can be configured. Other properties can be configured in the pool
* depending on the pool implementation.
*
* A bufferpool can have extra options that can be enabled with
* gst_buffer_pool_config_add_option(). The available options can be retrieved
* with gst_buffer_pool_get_options(). Some options allow for additional
* configuration properties to be set.
*
* After the configuration structure has been configured,
* gst_buffer_pool_set_config() updates the configuration in the pool. This can
* fail when the configuration structure is not accepted.
*
* After the a pool has been configured, it can be activated with
* gst_buffer_pool_set_active(). This will preallocate the configured resources
* in the pool.
*
* When the pool is active, gst_buffer_pool_acquire_buffer() can be used to
* retrieve a buffer from the pool.
*
* Buffers allocated from a bufferpool will automatically be returned to the
* pool with gst_buffer_pool_release_buffer() when their refcount drops to 0.
*
* The bufferpool can be deactivated again with gst_buffer_pool_set_active().
* All further gst_buffer_pool_acquire_buffer() calls will return an error. When
* all buffers are returned to the pool they will be freed.
*
* Use gst_object_unref() to release the reference to a bufferpool. If the
* refcount of the pool reaches 0, the pool will be freed.
*/
public class BufferPool : ObjectGst
{
/** the main Gtk struct */
protected GstBufferPool* gstBufferPool;
/** Get the main Gtk struct */
public GstBufferPool* getBufferPoolStruct(bool transferOwnership = false)
{
if (transferOwnership)
ownedRef = false;
return gstBufferPool;
}
/** the main Gtk struct as a void* */
protected override void* getStruct()
{
return cast(void*)gstBufferPool;
}
protected override void setStruct(GObject* obj)
{
gstBufferPool = cast(GstBufferPool*)obj;
super.setStruct(obj);
}
/**
* Sets our main struct and passes it to the parent class.
*/
public this (GstBufferPool* gstBufferPool, bool ownedRef = false)
{
this.gstBufferPool = gstBufferPool;
super(cast(GstObject*)gstBufferPool, ownedRef);
}
/** */
public static GType getType()
{
return gst_buffer_pool_get_type();
}
/**
* Creates a new #GstBufferPool instance.
*
* Returns: a new #GstBufferPool instance
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this()
{
auto p = gst_buffer_pool_new();
if(p is null)
{
throw new ConstructionException("null returned by new");
}
this(cast(GstBufferPool*) p);
}
/**
* Enabled the option in @config. This will instruct the @bufferpool to enable
* the specified option on the buffers that it allocates.
*
* The supported options by @pool can be retrieved with gst_buffer_pool_get_options().
*
* Params:
* config = a #GstBufferPool configuration
* option = an option to add
*/
public static void configAddOption(Structure config, string option)
{
gst_buffer_pool_config_add_option((config is null) ? null : config.getStructureStruct(), Str.toStringz(option));
}
/**
* Get the @allocator and @params from @config.
*
* Params:
* config = a #GstBufferPool configuration
* allocator = a #GstAllocator, or %NULL
* params = #GstAllocationParams, or %NULL
*
* Returns: %TRUE, if the values are set.
*/
public static bool configGetAllocator(Structure config, ref Allocator allocator, out AllocationParams params)
{
GstAllocator* outallocator = allocator.getAllocatorStruct();
GstAllocationParams* outparams = sliceNew!GstAllocationParams();
auto p = gst_buffer_pool_config_get_allocator((config is null) ? null : config.getStructureStruct(), &outallocator, outparams) != 0;
allocator = ObjectG.getDObject!(Allocator)(outallocator);
params = ObjectG.getDObject!(AllocationParams)(outparams, true);
return p;
}
/**
* Parse an available @config and get the option at @index of the options API
* array.
*
* Params:
* config = a #GstBufferPool configuration
* index = position in the option array to read
*
* Returns: a #gchar of the option at @index.
*/
public static string configGetOption(Structure config, uint index)
{
return Str.toString(gst_buffer_pool_config_get_option((config is null) ? null : config.getStructureStruct(), index));
}
/**
* Get the configuration values from @config.
*
* Params:
* config = a #GstBufferPool configuration
* caps = the caps of buffers
* size = the size of each buffer, not including prefix and padding
* minBuffers = the minimum amount of buffers to allocate.
* maxBuffers = the maximum amount of buffers to allocate or 0 for unlimited.
*
* Returns: %TRUE if all parameters could be fetched.
*/
public static bool configGetParams(Structure config, out Caps caps, out uint size, out uint minBuffers, out uint maxBuffers)
{
GstCaps* outcaps = null;
auto p = gst_buffer_pool_config_get_params((config is null) ? null : config.getStructureStruct(), &outcaps, &size, &minBuffers, &maxBuffers) != 0;
caps = ObjectG.getDObject!(Caps)(outcaps);
return p;
}
/**
* Check if @config contains @option.
*
* Params:
* config = a #GstBufferPool configuration
* option = an option
*
* Returns: %TRUE if the options array contains @option.
*/
public static bool configHasOption(Structure config, string option)
{
return gst_buffer_pool_config_has_option((config is null) ? null : config.getStructureStruct(), Str.toStringz(option)) != 0;
}
/**
* Retrieve the number of values currently stored in the options array of the
* @config structure.
*
* Params:
* config = a #GstBufferPool configuration
*
* Returns: the options array size as a #guint.
*/
public static uint configNOptions(Structure config)
{
return gst_buffer_pool_config_n_options((config is null) ? null : config.getStructureStruct());
}
/**
* Set the @allocator and @params on @config.
*
* One of @allocator and @params can be %NULL, but not both. When @allocator
* is %NULL, the default allocator of the pool will use the values in @param
* to perform its allocation. When @param is %NULL, the pool will use the
* provided @allocator with its default #GstAllocationParams.
*
* A call to gst_buffer_pool_set_config() can update the allocator and params
* with the values that it is able to do. Some pools are, for example, not able
* to operate with different allocators or cannot allocate with the values
* specified in @params. Use gst_buffer_pool_get_config() to get the currently
* used values.
*
* Params:
* config = a #GstBufferPool configuration
* allocator = a #GstAllocator
* params = #GstAllocationParams
*/
public static void configSetAllocator(Structure config, Allocator allocator, AllocationParams params)
{
gst_buffer_pool_config_set_allocator((config is null) ? null : config.getStructureStruct(), (allocator is null) ? null : allocator.getAllocatorStruct(), (params is null) ? null : params.getAllocationParamsStruct());
}
/**
* Configure @config with the given parameters.
*
* Params:
* config = a #GstBufferPool configuration
* caps = caps for the buffers
* size = the size of each buffer, not including prefix and padding
* minBuffers = the minimum amount of buffers to allocate.
* maxBuffers = the maximum amount of buffers to allocate or 0 for unlimited.
*/
public static void configSetParams(Structure config, Caps caps, uint size, uint minBuffers, uint maxBuffers)
{
gst_buffer_pool_config_set_params((config is null) ? null : config.getStructureStruct(), (caps is null) ? null : caps.getCapsStruct(), size, minBuffers, maxBuffers);
}
/**
* Validate that changes made to @config are still valid in the context of the
* expected parameters. This function is a helper that can be used to validate
* changes made by a pool to a config when gst_buffer_pool_set_config()
* returns %FALSE. This expects that @caps haven't changed and that
* @min_buffers aren't lower then what we initially expected.
* This does not check if options or allocator parameters are still valid,
* won't check if size have changed, since changing the size is valid to adapt
* padding.
*
* Params:
* config = a #GstBufferPool configuration
* caps = the excepted caps of buffers
* size = the expected size of each buffer, not including prefix and padding
* minBuffers = the expected minimum amount of buffers to allocate.
* maxBuffers = the expect maximum amount of buffers to allocate or 0 for unlimited.
*
* Returns: %TRUE, if the parameters are valid in this context.
*
* Since: 1.4
*/
public static bool configValidateParams(Structure config, Caps caps, uint size, uint minBuffers, uint maxBuffers)
{
return gst_buffer_pool_config_validate_params((config is null) ? null : config.getStructureStruct(), (caps is null) ? null : caps.getCapsStruct(), size, minBuffers, maxBuffers) != 0;
}
/**
* Acquire a buffer from @pool. @buffer should point to a memory location that
* can hold a pointer to the new buffer.
*
* @params can be %NULL or contain optional parameters to influence the
* allocation.
*
* Params:
* buffer = a location for a #GstBuffer
* params = parameters.
*
* Returns: a #GstFlowReturn such as %GST_FLOW_FLUSHING when the pool is
* inactive.
*/
public GstFlowReturn acquireBuffer(out Buffer buffer, GstBufferPoolAcquireParams* params)
{
GstBuffer* outbuffer = null;
auto p = gst_buffer_pool_acquire_buffer(gstBufferPool, &outbuffer, params);
buffer = ObjectG.getDObject!(Buffer)(outbuffer);
return p;
}
/**
* Get a copy of the current configuration of the pool. This configuration
* can either be modified and used for the gst_buffer_pool_set_config() call
* or it must be freed after usage.
*
* Returns: a copy of the current configuration of @pool. use
* gst_structure_free() after usage or gst_buffer_pool_set_config().
*/
public Structure getConfig()
{
auto p = gst_buffer_pool_get_config(gstBufferPool);
if(p is null)
{
return null;
}
return ObjectG.getDObject!(Structure)(cast(GstStructure*) p, true);
}
/**
* Get a %NULL terminated array of string with supported bufferpool options for
* @pool. An option would typically be enabled with
* gst_buffer_pool_config_add_option().
*
* Returns: a %NULL terminated array
* of strings.
*/
public string[] getOptions()
{
return Str.toStringArray(gst_buffer_pool_get_options(gstBufferPool));
}
/**
* Check if the bufferpool supports @option.
*
* Params:
* option = an option
*
* Returns: %TRUE if the buffer pool contains @option.
*/
public bool hasOption(string option)
{
return gst_buffer_pool_has_option(gstBufferPool, Str.toStringz(option)) != 0;
}
/**
* Check if @pool is active. A pool can be activated with the
* gst_buffer_pool_set_active() call.
*
* Returns: %TRUE when the pool is active.
*/
public bool isActive()
{
return gst_buffer_pool_is_active(gstBufferPool) != 0;
}
/**
* Release @buffer to @pool. @buffer should have previously been allocated from
* @pool with gst_buffer_pool_acquire_buffer().
*
* This function is usually called automatically when the last ref on @buffer
* disappears.
*
* Params:
* buffer = a #GstBuffer
*/
public void releaseBuffer(Buffer buffer)
{
gst_buffer_pool_release_buffer(gstBufferPool, (buffer is null) ? null : buffer.getBufferStruct());
}
/**
* Control the active state of @pool. When the pool is inactive, new calls to
* gst_buffer_pool_acquire_buffer() will return with %GST_FLOW_FLUSHING.
*
* Activating the bufferpool will preallocate all resources in the pool based on
* the configuration of the pool.
*
* Deactivating will free the resources again when there are no outstanding
* buffers. When there are outstanding buffers, they will be freed as soon as
* they are all returned to the pool.
*
* Params:
* active = the new active state
*
* Returns: %FALSE when the pool was not configured or when preallocation of the
* buffers failed.
*/
public bool setActive(bool active)
{
return gst_buffer_pool_set_active(gstBufferPool, active) != 0;
}
/**
* Set the configuration of the pool. If the pool is already configured, and
* the configuration haven't change, this function will return %TRUE. If the
* pool is active, this method will return %FALSE and active configuration
* will remain. Buffers allocated form this pool must be returned or else this
* function will do nothing and return %FALSE.
*
* @config is a #GstStructure that contains the configuration parameters for
* the pool. A default and mandatory set of parameters can be configured with
* gst_buffer_pool_config_set_params(), gst_buffer_pool_config_set_allocator()
* and gst_buffer_pool_config_add_option().
*
* If the parameters in @config can not be set exactly, this function returns
* %FALSE and will try to update as much state as possible. The new state can
* then be retrieved and refined with gst_buffer_pool_get_config().
*
* This function takes ownership of @config.
*
* Params:
* config = a #GstStructure
*
* Returns: %TRUE when the configuration could be set.
*/
public bool setConfig(Structure config)
{
return gst_buffer_pool_set_config(gstBufferPool, (config is null) ? null : config.getStructureStruct(true)) != 0;
}
/**
* Enable or disable the flushing state of a @pool without freeing or
* allocating buffers.
*
* Params:
* flushing = whether to start or stop flushing
*
* Since: 1.4
*/
public void setFlushing(bool flushing)
{
gst_buffer_pool_set_flushing(gstBufferPool, flushing);
}
}
|