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.BufferList; 26 27 private import glib.ConstructionException; 28 private import gobject.ObjectG; 29 private import gstreamer.Buffer; 30 private import gstreamerc.gstreamer; 31 public import gstreamerc.gstreamertypes; 32 33 34 /** 35 * Buffer lists are an object containing a list of buffers. 36 * 37 * Buffer lists are created with gst_buffer_list_new() and filled with data 38 * using a gst_buffer_list_insert(). 39 * 40 * Buffer lists can be pushed on a srcpad with gst_pad_push_list(). This is 41 * interesting when multiple buffers need to be pushed in one go because it 42 * can reduce the amount of overhead for pushing each buffer individually. 43 */ 44 public class BufferList 45 { 46 /** the main Gtk struct */ 47 protected GstBufferList* gstBufferList; 48 protected bool ownedRef; 49 50 /** Get the main Gtk struct */ 51 public GstBufferList* getBufferListStruct(bool transferOwnership = false) 52 { 53 if (transferOwnership) 54 ownedRef = false; 55 return gstBufferList; 56 } 57 58 /** the main Gtk struct as a void* */ 59 protected void* getStruct() 60 { 61 return cast(void*)gstBufferList; 62 } 63 64 /** 65 * Sets our main struct and passes it to the parent class. 66 */ 67 public this (GstBufferList* gstBufferList, bool ownedRef = false) 68 { 69 this.gstBufferList = gstBufferList; 70 this.ownedRef = ownedRef; 71 } 72 73 74 /** */ 75 public static GType getType() 76 { 77 return gst_buffer_list_get_type(); 78 } 79 80 /** 81 * Creates a new, empty #GstBufferList. The caller is responsible for unreffing 82 * the returned #GstBufferList. 83 * 84 * Free-function: gst_buffer_list_unref 85 * 86 * Returns: the new #GstBufferList. gst_buffer_list_unref() 87 * after usage. 88 * 89 * Throws: ConstructionException GTK+ fails to create the object. 90 */ 91 public this() 92 { 93 auto p = gst_buffer_list_new(); 94 95 if(p is null) 96 { 97 throw new ConstructionException("null returned by new"); 98 } 99 100 this(cast(GstBufferList*) p); 101 } 102 103 /** 104 * Creates a new, empty #GstBufferList. The caller is responsible for unreffing 105 * the returned #GstBufferList. The list will have @size space preallocated so 106 * that memory reallocations can be avoided. 107 * 108 * Free-function: gst_buffer_list_unref 109 * 110 * Params: 111 * size = an initial reserved size 112 * 113 * Returns: the new #GstBufferList. gst_buffer_list_unref() 114 * after usage. 115 * 116 * Throws: ConstructionException GTK+ fails to create the object. 117 */ 118 public this(uint size) 119 { 120 auto p = gst_buffer_list_new_sized(size); 121 122 if(p is null) 123 { 124 throw new ConstructionException("null returned by new_sized"); 125 } 126 127 this(cast(GstBufferList*) p); 128 } 129 130 /** 131 * Create a copy of the given buffer list. This will make a newly allocated 132 * copy of the buffer that the source buffer list contains. 133 * 134 * Returns: a new copy of @list. 135 * 136 * Since: 1.6 137 */ 138 public BufferList copyDeep() 139 { 140 auto p = gst_buffer_list_copy_deep(gstBufferList); 141 142 if(p is null) 143 { 144 return null; 145 } 146 147 return ObjectG.getDObject!(BufferList)(cast(GstBufferList*) p, true); 148 } 149 150 /** 151 * Call @func with @data for each buffer in @list. 152 * 153 * @func can modify the passed buffer pointer or its contents. The return value 154 * of @func define if this function returns or if the remaining buffers in 155 * the list should be skipped. 156 * 157 * Params: 158 * func = a #GstBufferListFunc to call 159 * userData = user data passed to @func 160 * 161 * Returns: %TRUE when @func returned %TRUE for each buffer in @list or when 162 * @list is empty. 163 */ 164 public bool foreac(GstBufferListFunc func, void* userData) 165 { 166 return gst_buffer_list_foreach(gstBufferList, func, userData) != 0; 167 } 168 169 /** 170 * Get the buffer at @idx. 171 * 172 * Params: 173 * idx = the index 174 * 175 * Returns: the buffer at @idx in @group 176 * or %NULL when there is no buffer. The buffer remains valid as 177 * long as @list is valid and buffer is not removed from the list. 178 */ 179 public Buffer get(uint idx) 180 { 181 auto p = gst_buffer_list_get(gstBufferList, idx); 182 183 if(p is null) 184 { 185 return null; 186 } 187 188 return ObjectG.getDObject!(Buffer)(cast(GstBuffer*) p); 189 } 190 191 /** 192 * Insert @buffer at @idx in @list. Other buffers are moved to make room for 193 * this new buffer. 194 * 195 * A -1 value for @idx will append the buffer at the end. 196 * 197 * Params: 198 * idx = the index 199 * buffer = a #GstBuffer 200 */ 201 public void insert(int idx, Buffer buffer) 202 { 203 gst_buffer_list_insert(gstBufferList, idx, (buffer is null) ? null : buffer.getBufferStruct()); 204 } 205 206 /** 207 * Returns the number of buffers in @list. 208 * 209 * Returns: the number of buffers in the buffer list 210 */ 211 public uint length() 212 { 213 return gst_buffer_list_length(gstBufferList); 214 } 215 216 /** 217 * Remove @length buffers starting from @idx in @list. The following buffers 218 * are moved to close the gap. 219 * 220 * Params: 221 * idx = the index 222 * length = the amount to remove 223 */ 224 public void remove(uint idx, uint length) 225 { 226 gst_buffer_list_remove(gstBufferList, idx, length); 227 } 228 }