1 /* 2 * This file is part of gtkD. 3 * 4 * gtkD is free software; you can redistribute it and/or modify 5 * it under the terms of the GNU Lesser General Public License 6 * as published by the Free Software Foundation; either version 3 7 * of the License, or (at your option) any later version, with 8 * some exceptions, please read the COPYING file. 9 * 10 * gtkD is distributed in the hope that it will be useful, 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 * GNU Lesser General Public License for more details. 14 * 15 * You should have received a copy of the GNU Lesser General Public License 16 * along with gtkD; if not, write to the Free Software 17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA 18 */ 19 20 // generated automatically - do not change 21 // find conversion definition on APILookup.txt 22 // implement new conversion functionalities on the wrap.utils pakage 23 24 25 module gstreamer.Allocator; 26 27 private import glib.Str; 28 private import gobject.ObjectG; 29 private import gstreamer.AllocationParams; 30 private import gstreamer.Memory; 31 private import gstreamer.ObjectGst; 32 private import gstreamer.c.functions; 33 public import gstreamer.c.types; 34 35 36 /** 37 * Memory is usually created by allocators with a gst_allocator_alloc() 38 * method call. When %NULL is used as the allocator, the default allocator will 39 * be used. 40 * 41 * New allocators can be registered with gst_allocator_register(). 42 * Allocators are identified by name and can be retrieved with 43 * gst_allocator_find(). gst_allocator_set_default() can be used to change the 44 * default allocator. 45 * 46 * New memory can be created with gst_memory_new_wrapped() that wraps the memory 47 * allocated elsewhere. 48 */ 49 public class Allocator : ObjectGst 50 { 51 /** the main Gtk struct */ 52 protected GstAllocator* gstAllocator; 53 54 /** Get the main Gtk struct */ 55 public GstAllocator* getAllocatorStruct(bool transferOwnership = false) 56 { 57 if (transferOwnership) 58 ownedRef = false; 59 return gstAllocator; 60 } 61 62 /** the main Gtk struct as a void* */ 63 protected override void* getStruct() 64 { 65 return cast(void*)gstAllocator; 66 } 67 68 /** 69 * Sets our main struct and passes it to the parent class. 70 */ 71 public this (GstAllocator* gstAllocator, bool ownedRef = false) 72 { 73 this.gstAllocator = gstAllocator; 74 super(cast(GstObject*)gstAllocator, ownedRef); 75 } 76 77 78 /** */ 79 public static GType getType() 80 { 81 return gst_allocator_get_type(); 82 } 83 84 /** 85 * Find a previously registered allocator with @name. When @name is %NULL, the 86 * default allocator will be returned. 87 * 88 * Params: 89 * name = the name of the allocator 90 * 91 * Returns: a #GstAllocator or %NULL when 92 * the allocator with @name was not registered. Use gst_object_unref() 93 * to release the allocator after usage. 94 */ 95 public static Allocator find(string name) 96 { 97 auto __p = gst_allocator_find(Str.toStringz(name)); 98 99 if(__p is null) 100 { 101 return null; 102 } 103 104 return ObjectG.getDObject!(Allocator)(cast(GstAllocator*) __p, true); 105 } 106 107 /** 108 * Registers the memory @allocator with @name. This function takes ownership of 109 * @allocator. 110 * 111 * Params: 112 * name = the name of the allocator 113 * allocator = #GstAllocator 114 */ 115 public static void register(string name, Allocator allocator) 116 { 117 gst_allocator_register(Str.toStringz(name), (allocator is null) ? null : allocator.getAllocatorStruct()); 118 } 119 120 /** 121 * Use @allocator to allocate a new memory block with memory that is at least 122 * @size big. 123 * 124 * The optional @params can specify the prefix and padding for the memory. If 125 * %NULL is passed, no flags, no extra prefix/padding and a default alignment is 126 * used. 127 * 128 * The prefix/padding will be filled with 0 if flags contains 129 * #GST_MEMORY_FLAG_ZERO_PREFIXED and #GST_MEMORY_FLAG_ZERO_PADDED respectively. 130 * 131 * When @allocator is %NULL, the default allocator will be used. 132 * 133 * The alignment in @params is given as a bitmask so that @align + 1 equals 134 * the amount of bytes to align to. For example, to align to 8 bytes, 135 * use an alignment of 7. 136 * 137 * Params: 138 * size = size of the visible memory area 139 * params = optional parameters 140 * 141 * Returns: a new #GstMemory. 142 */ 143 public Memory alloc(size_t size, AllocationParams params) 144 { 145 auto __p = gst_allocator_alloc(gstAllocator, size, (params is null) ? null : params.getAllocationParamsStruct()); 146 147 if(__p is null) 148 { 149 return null; 150 } 151 152 return ObjectG.getDObject!(Memory)(cast(GstMemory*) __p, true); 153 } 154 155 /** 156 * Free @memory that was previously allocated with gst_allocator_alloc(). 157 * 158 * Params: 159 * memory = the memory to free 160 */ 161 public void free(Memory memory) 162 { 163 gst_allocator_free(gstAllocator, (memory is null) ? null : memory.getMemoryStruct()); 164 } 165 166 /** 167 * Set the default allocator. This function takes ownership of @allocator. 168 */ 169 public void setDefault() 170 { 171 gst_allocator_set_default(gstAllocator); 172 } 173 }