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.PadTemplate; 26 27 private import glib.ConstructionException; 28 private import glib.Str; 29 private import gobject.ObjectG; 30 private import gobject.Signals; 31 private import gstreamer.Caps; 32 private import gstreamer.ObjectGst; 33 private import gstreamer.Pad; 34 private import gstreamer.c.functions; 35 public import gstreamer.c.types; 36 public import gstreamerc.gstreamertypes; 37 private import std.algorithm; 38 39 40 /** 41 * Padtemplates describe the possible media types a pad or an elementfactory can 42 * handle. This allows for both inspection of handled types before loading the 43 * element plugin as well as identifying pads on elements that are not yet 44 * created (request or sometimes pads). 45 * 46 * Pad and PadTemplates have #GstCaps attached to it to describe the media type 47 * they are capable of dealing with. gst_pad_template_get_caps() or 48 * GST_PAD_TEMPLATE_CAPS() are used to get the caps of a padtemplate. It's not 49 * possible to modify the caps of a padtemplate after creation. 50 * 51 * PadTemplates have a #GstPadPresence property which identifies the lifetime 52 * of the pad and that can be retrieved with GST_PAD_TEMPLATE_PRESENCE(). Also 53 * the direction of the pad can be retrieved from the #GstPadTemplate with 54 * GST_PAD_TEMPLATE_DIRECTION(). 55 * 56 * The GST_PAD_TEMPLATE_NAME_TEMPLATE () is important for GST_PAD_REQUEST pads 57 * because it has to be used as the name in the gst_element_get_request_pad() 58 * call to instantiate a pad from this template. 59 * 60 * Padtemplates can be created with gst_pad_template_new() or with 61 * gst_static_pad_template_get (), which creates a #GstPadTemplate from a 62 * #GstStaticPadTemplate that can be filled with the 63 * convenient GST_STATIC_PAD_TEMPLATE() macro. 64 * 65 * A padtemplate can be used to create a pad (see gst_pad_new_from_template() 66 * or gst_pad_new_from_static_template ()) or to add to an element class 67 * (see gst_element_class_add_static_pad_template ()). 68 * 69 * The following code example shows the code to create a pad from a padtemplate. 70 * |[<!-- language="C" --> 71 * GstStaticPadTemplate my_template = 72 * GST_STATIC_PAD_TEMPLATE ( 73 * "sink", // the name of the pad 74 * GST_PAD_SINK, // the direction of the pad 75 * GST_PAD_ALWAYS, // when this pad will be present 76 * GST_STATIC_CAPS ( // the capabilities of the padtemplate 77 * "audio/x-raw, " 78 * "channels = (int) [ 1, 6 ]" 79 * ) 80 * ); 81 * void 82 * my_method (void) 83 * { 84 * GstPad *pad; 85 * pad = gst_pad_new_from_static_template (&my_template, "sink"); 86 * ... 87 * } 88 * ]| 89 * 90 * The following example shows you how to add the padtemplate to an 91 * element class, this is usually done in the class_init of the class: 92 * |[<!-- language="C" --> 93 * static void 94 * my_element_class_init (GstMyElementClass *klass) 95 * { 96 * GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass); 97 * 98 * gst_element_class_add_static_pad_template (gstelement_class, &my_template); 99 * } 100 * ]| 101 */ 102 public class PadTemplate : ObjectGst 103 { 104 /** the main Gtk struct */ 105 protected GstPadTemplate* gstPadTemplate; 106 107 /** Get the main Gtk struct */ 108 public GstPadTemplate* getPadTemplateStruct(bool transferOwnership = false) 109 { 110 if (transferOwnership) 111 ownedRef = false; 112 return gstPadTemplate; 113 } 114 115 /** the main Gtk struct as a void* */ 116 protected override void* getStruct() 117 { 118 return cast(void*)gstPadTemplate; 119 } 120 121 /** 122 * Sets our main struct and passes it to the parent class. 123 */ 124 public this (GstPadTemplate* gstPadTemplate, bool ownedRef = false) 125 { 126 this.gstPadTemplate = gstPadTemplate; 127 super(cast(GstObject*)gstPadTemplate, ownedRef); 128 } 129 130 131 /** */ 132 public static GType getType() 133 { 134 return gst_pad_template_get_type(); 135 } 136 137 /** 138 * Creates a new pad template with a name according to the given template 139 * and with the given arguments. 140 * 141 * Params: 142 * nameTemplate = the name template. 143 * direction = the #GstPadDirection of the template. 144 * presence = the #GstPadPresence of the pad. 145 * caps = a #GstCaps set for the template. 146 * 147 * Returns: a new #GstPadTemplate. 148 * 149 * Throws: ConstructionException GTK+ fails to create the object. 150 */ 151 public this(string nameTemplate, GstPadDirection direction, GstPadPresence presence, Caps caps) 152 { 153 auto p = gst_pad_template_new(Str.toStringz(nameTemplate), direction, presence, (caps is null) ? null : caps.getCapsStruct()); 154 155 if(p is null) 156 { 157 throw new ConstructionException("null returned by new"); 158 } 159 160 this(cast(GstPadTemplate*) p); 161 } 162 163 /** 164 * Gets the capabilities of the pad template. 165 * 166 * Returns: the #GstCaps of the pad template. 167 * Unref after usage. 168 */ 169 public Caps getCaps() 170 { 171 auto p = gst_pad_template_get_caps(gstPadTemplate); 172 173 if(p is null) 174 { 175 return null; 176 } 177 178 return ObjectG.getDObject!(Caps)(cast(GstCaps*) p, true); 179 } 180 181 /** 182 * Emit the pad-created signal for this template when created by this pad. 183 * 184 * Params: 185 * pad = the #GstPad that created it 186 */ 187 public void padCreated(Pad pad) 188 { 189 gst_pad_template_pad_created(gstPadTemplate, (pad is null) ? null : pad.getPadStruct()); 190 } 191 192 protected class OnPadCreatedDelegateWrapper 193 { 194 void delegate(Pad, PadTemplate) dlg; 195 gulong handlerId; 196 197 this(void delegate(Pad, PadTemplate) dlg) 198 { 199 this.dlg = dlg; 200 onPadCreatedListeners ~= this; 201 } 202 203 void remove(OnPadCreatedDelegateWrapper source) 204 { 205 foreach(index, wrapper; onPadCreatedListeners) 206 { 207 if (wrapper.handlerId == source.handlerId) 208 { 209 onPadCreatedListeners[index] = null; 210 onPadCreatedListeners = std.algorithm.remove(onPadCreatedListeners, index); 211 break; 212 } 213 } 214 } 215 } 216 OnPadCreatedDelegateWrapper[] onPadCreatedListeners; 217 218 /** 219 * This signal is fired when an element creates a pad from this template. 220 * 221 * Params: 222 * pad = the pad that was created. 223 */ 224 gulong addOnPadCreated(void delegate(Pad, PadTemplate) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0) 225 { 226 auto wrapper = new OnPadCreatedDelegateWrapper(dlg); 227 wrapper.handlerId = Signals.connectData( 228 this, 229 "pad-created", 230 cast(GCallback)&callBackPadCreated, 231 cast(void*)wrapper, 232 cast(GClosureNotify)&callBackPadCreatedDestroy, 233 connectFlags); 234 return wrapper.handlerId; 235 } 236 237 extern(C) static void callBackPadCreated(GstPadTemplate* padtemplateStruct, GstPad* pad, OnPadCreatedDelegateWrapper wrapper) 238 { 239 wrapper.dlg(ObjectG.getDObject!(Pad)(pad), wrapper.outer); 240 } 241 242 extern(C) static void callBackPadCreatedDestroy(OnPadCreatedDelegateWrapper wrapper, GClosure* closure) 243 { 244 wrapper.remove(wrapper); 245 } 246 }