go-gst/gst/gst_element_factory.go

package gst

// #include "gst.go.h"
import "C"

import (
	"fmt"
	"unsafe"

	"github.com/go-gst/go-glib/glib"
)

// NewElement creates a new element using the factory of the given name.
func NewElement(factory string) (*Element, error) {
	return NewElementWithName(factory, "")
}

// NewElementWithName creates a new element and sets it's name to the given value.
func NewElementWithName(factory string, name string) (*Element, error) {
	elemName := C.CString(factory)
	defer C.free(unsafe.Pointer(elemName))
	var elem *C.GstElement
	if name == "" {
		elem = C.gst_element_factory_make((*C.gchar)(elemName), nil)
	} else {
		cname := C.CString(name)
		defer C.free(unsafe.Pointer(cname))
		elem = C.gst_element_factory_make((*C.gchar)(elemName), (*C.gchar)(cname))
	}
	if elem == nil {
		return nil, fmt.Errorf("could not create element: %s", factory)
	}
	return wrapElement(glib.TransferNone(unsafe.Pointer(elem))), nil
}

// Create a new element of the type defined by the given elementfactory. The supplied list of properties, will be passed at object construction.
//
// this function is needed for gstreamer props that have the "Construct Only" flag, e.g.:
// https://gstreamer.freedesktop.org/documentation/audio/gstaudioaggregator.html?gi-language=c#GstAudioAggregator:force-live
func NewElementWithProperties(factory string, properties map[string]interface{}) (*Element, error) {
	props := make([]*C.char, 0)
	values := make([]C.GValue, 0)

	for p, v := range properties {
		cpropName := C.CString(p)
		defer C.free(unsafe.Pointer(cpropName))

		props = append(props, cpropName)

		cValue, err := glib.GValue(v)

		if err != nil {
			return nil, err
		}

		values = append(values, *(*C.GValue)(cValue.Unsafe()))
	}

	cfactory := C.CString(factory)
	defer C.free(unsafe.Pointer(cfactory))

	n := C.uint(len(properties))

	var elem *C.GstElement

	if n > 0 {
		elem = C.gst_element_factory_make_with_properties(cfactory, n, &props[0], &values[0])
	} else {
		elem = C.gst_element_factory_make_with_properties(cfactory, n, nil, nil)
	}

	if elem == nil {
		return nil, fmt.Errorf("could not create element: %s", factory)
	}
	return wrapElement(glib.TransferNone(unsafe.Pointer(elem))), nil
}

// NewElementMany is a convenience wrapper around building many GstElements in a
// single function call. It returns an error if the creation of any element fails. A
// slice in the order the names were given is returned.
func NewElementMany(elemNames ...string) ([]*Element, error) {
	elems := make([]*Element, len(elemNames))
	for idx, name := range elemNames {
		elem, err := NewElement(name)
		if err != nil {
			return nil, err
		}
		elems[idx] = elem
	}
	return elems, nil
}

// ElementFactory wraps the GstElementFactory
type ElementFactory struct{ *PluginFeature }

// Find returns the factory for the given plugin, or nil if it doesn't exist. Unref after usage.
func Find(name string) *ElementFactory {
	cName := C.CString(name)
	defer C.free(unsafe.Pointer(cName))
	factory := C.gst_element_factory_find((*C.gchar)(cName))
	if factory == nil {
		return nil
	}
	return wrapElementFactory(glib.TransferFull(unsafe.Pointer(factory)))
}

// Instance returns the C GstFactory instance
func (e *ElementFactory) Instance() *C.GstElementFactory { return C.toGstElementFactory(e.Unsafe()) }

// CanSinkAllCaps checks if the factory can sink all possible capabilities.
func (e *ElementFactory) CanSinkAllCaps(caps *Caps) bool {
	return gobool(C.gst_element_factory_can_sink_all_caps((*C.GstElementFactory)(e.Instance()), (*C.GstCaps)(caps.Instance())))
}

// CanSinkAnyCaps checks if the factory can sink any possible capability.
func (e *ElementFactory) CanSinkAnyCaps(caps *Caps) bool {
	return gobool(C.gst_element_factory_can_sink_any_caps((*C.GstElementFactory)(e.Instance()), (*C.GstCaps)(caps.Instance())))
}

// CanSourceAllCaps checks if the factory can src all possible capabilities.
func (e *ElementFactory) CanSourceAllCaps(caps *Caps) bool {
	return gobool(C.gst_element_factory_can_src_all_caps((*C.GstElementFactory)(e.Instance()), (*C.GstCaps)(caps.Instance())))
}

// CanSourceAnyCaps checks if the factory can src any possible capability.
func (e *ElementFactory) CanSourceAnyCaps(caps *Caps) bool {
	return gobool(C.gst_element_factory_can_src_any_caps((*C.GstElementFactory)(e.Instance()), (*C.GstCaps)(caps.Instance())))
}

// GetMetadata gets the metadata on this factory with key.
func (e *ElementFactory) GetMetadata(key string) string {
	ckey := C.CString(key)
	defer C.free(unsafe.Pointer(ckey))
	res := C.gst_element_factory_get_metadata((*C.GstElementFactory)(e.Instance()), (*C.gchar)(ckey))
	defer C.free(unsafe.Pointer(res))
	return C.GoString(res)
}

// GetMetadataKeys gets the available keys for the metadata on this factory.
func (e *ElementFactory) GetMetadataKeys() []string {
	keys := C.gst_element_factory_get_metadata_keys((*C.GstElementFactory)(e.Instance()))
	if keys == nil {
		return nil
	}
	defer C.g_strfreev(keys)
	size := C.sizeOfGCharArray(keys)
	return goStrings(size, keys)
}