mirror of
https://github.com/go-gst/go-gst.git
synced 2025-10-05 16:06:55 +08:00
322 lines
12 KiB
Go
322 lines
12 KiB
Go
package main
|
|
|
|
//go:generate go run . -o ./pkg/
|
|
|
|
import (
|
|
"encoding/xml"
|
|
"fmt"
|
|
"log"
|
|
"slices"
|
|
"strings"
|
|
|
|
"github.com/diamondburned/gotk4/gir"
|
|
"github.com/diamondburned/gotk4/gir/cmd/gir-generate/gendata"
|
|
"github.com/diamondburned/gotk4/gir/cmd/gir-generate/genmain"
|
|
"github.com/diamondburned/gotk4/gir/girgen/file"
|
|
"github.com/diamondburned/gotk4/gir/girgen/generators"
|
|
"github.com/diamondburned/gotk4/gir/girgen/strcases"
|
|
"github.com/diamondburned/gotk4/gir/girgen/types"
|
|
"github.com/diamondburned/gotk4/gir/girgen/typesystem"
|
|
)
|
|
|
|
const Module = "github.com/go-gst/go-gst/pkg"
|
|
|
|
var Data = genmain.Overlay(
|
|
gendata.Main,
|
|
genmain.Data{
|
|
Module: Module,
|
|
Packages: []genmain.Package{
|
|
// {Name: "gst-editing-services-1.0", Namespaces: []string{"GES-1"}},
|
|
{Name: "gstreamer-1.0", Namespaces: []string{"Gst-1"}},
|
|
{Name: "gstreamer-base-1.0", Namespaces: []string{"GstBase-1"}},
|
|
{Name: "gstreamer-allocators-1.0", Namespaces: []string{"GstAllocators-1"}},
|
|
// {Name: "gstreamer-analytics-1.0", Namespaces: []string{"GstAnalytics-1"}},
|
|
{Name: "gstreamer-app-1.0", Namespaces: []string{"GstApp-1"}},
|
|
{Name: "gstreamer-audio-1.0", Namespaces: []string{"GstAudio-1"}},
|
|
// {Name: "gstreamer-bad-audio-1.0", Namespaces: []string{"GstBadAudio-1"}},
|
|
// {Name: "gstreamer-bad-base-camerabinsrc-1.0", Namespaces: []string{"GstBadBaseCameraBin-1"}},
|
|
{Name: "gstreamer-check-1.0", Namespaces: []string{"GstCheck-1"}},
|
|
// {Name: "gstreamer-codecs-1.0", Namespaces: []string{"GstCodecs-1"}},
|
|
{Name: "gstreamer-controller-1.0", Namespaces: []string{"GstController-1"}},
|
|
// {Name: "gstreamer-cuda-1.0", Namespaces: []string{"GstCuda-1"}},
|
|
// {Name: "gstreamer-insertbin-1.0", Namespaces: []string{"GstInsertBin-1"}},
|
|
{Name: "gstreamer-mpegts-1.0", Namespaces: []string{"GstMpegts-1"}},
|
|
// {Name: "gstreamer-mse-1.0", Namespaces: []string{"GstMse-1"}},
|
|
{Name: "gstreamer-net-1.0", Namespaces: []string{"GstNet-1"}},
|
|
// {Name: "gstreamer-rtsp-server-1.0", Namespaces: []string{"GstRtspServer-1"}},
|
|
{Name: "gstreamer-sdp-1.0", Namespaces: []string{"GstSdp-1"}},
|
|
{Name: "gstreamer-rtp-1.0", Namespaces: []string{"GstRtp-1"}},
|
|
{Name: "gstreamer-rtsp-1.0", Namespaces: []string{"GstRtsp-1"}},
|
|
{Name: "gstreamer-tag-1.0", Namespaces: []string{"GstTag-1"}},
|
|
// {Name: "gstreamer-transcoder-1.0", Namespaces: []string{"GstTranscoder-1"}},
|
|
// {Name: "gstreamer-va-1.0", Namespaces: []string{"GstVa-1"}},
|
|
// {Name: "gstreamer-validate-1.0", Namespaces: []string{"GstValidate-1"}},
|
|
{Name: "gstreamer-video-1.0", Namespaces: []string{"GstVideo-1"}},
|
|
// {Name: "gstreamer-vulkan-1.0", Namespaces: []string{"GstVulkan-1"}},
|
|
{Name: "gstreamer-webrtc-1.0", Namespaces: []string{"GstWebRTC-1"}},
|
|
{Name: "gstreamer-gl-1.0", Namespaces: []string{"GstGL-1"}},
|
|
{Name: "gstreamer-pbutils-1.0", Namespaces: []string{"GstPbutils-1"}},
|
|
{Name: "gstreamer-play-1.0", Namespaces: []string{"GstPlay-1"}},
|
|
{Name: "gstreamer-player-1.0", Namespaces: []string{"GstPlayer-1"}},
|
|
},
|
|
Preprocessors: []types.Preprocessor{
|
|
types.MustIntrospect("Gst-1.Message.copy"),
|
|
|
|
// Enum has a member of same name:
|
|
types.TypeRenamer("Gst-1.BufferCopyFlags", "BufferCopyFlagsType"),
|
|
|
|
// a member of the enum is generated twice:
|
|
DedupBitfieldMembers("GstVideo-1.VideoBufferFlags"),
|
|
DedupBitfieldMembers("GstVideo-1.VideoFrameFlags"),
|
|
DedupBitfieldMembers("GstVideo-1.NavigationModifierType"),
|
|
|
|
// the member names do not have a GST prefix, which creates collisions:
|
|
FixCutoffEnumMemberNames("GstMpegts-1.DVBTeletextType"),
|
|
|
|
MiniObjectExtenderBorrows(),
|
|
|
|
// collides with the base src extenders that actually provide a clock instead of returning the provided one
|
|
types.RenameCallable("Gst-1.Element.provide_clock", "ProvidedClock"),
|
|
|
|
// collides with base src set caps
|
|
types.RenameCallable("GstApp-1.AppSrc.set_caps", "AppSrcSetCaps"),
|
|
|
|
// collides with extending audio base payloader push
|
|
types.RenameCallable("GstRtp-1.RTPBasePayload.push", "PushBuffer"),
|
|
|
|
// collides with extending audio base payloader push
|
|
types.RenameCallable("GstAllocators-1.DRMDumbAllocator.alloc", "DRMAlloc"),
|
|
|
|
// otherwise clashes with control binding class extension
|
|
types.RenameCallable("Gst-1.Object.get_control_binding", "CurrentControlBinding"),
|
|
// Collides with GstObject:
|
|
types.RenameCallable("Gst-1.ControlBinding.sync_values", "SyncControlBindingValues"),
|
|
|
|
// Collides with method of the same name
|
|
types.TypeRenamer("GstVideo-1.VideoChromaResample", "VideoChromaResampler"),
|
|
|
|
types.PreprocessorFunc(func(r gir.Repositories) {
|
|
t := r.FindFullType("GstVideo-1.VideoTimeCode").Type.(*gir.Record)
|
|
|
|
// FIXME: the get_type function requires gst_init(), thus crashes if called
|
|
// during init
|
|
t.GLibGetType = ""
|
|
}),
|
|
|
|
// String() is more go like than ToString()
|
|
types.RenameCallable("Gst-1.Caps.to_string", "string"),
|
|
},
|
|
Config: typesystem.Config{
|
|
Namespaces: map[string]typesystem.NamespaceConfig{
|
|
"Gst-1": {
|
|
ManualTypes: []typesystem.Type{
|
|
&typesystem.Alias{
|
|
BaseType: typesystem.BaseType{
|
|
GirName: "ClockTime",
|
|
GoTyp: "ClockTime",
|
|
CGoTyp: "C.GstClockTime",
|
|
CTyp: "GstClockTime",
|
|
},
|
|
AliasedType: typesystem.CouldBeForeign[typesystem.Type]{
|
|
Type: typesystem.Guint64,
|
|
},
|
|
},
|
|
},
|
|
IgnoredDefinitions: []typesystem.IgnoreFunc{
|
|
// Collide and use an out array of values. TODO: manually implement
|
|
typesystem.IgnoreMatching("Object.get_g_value_array"),
|
|
typesystem.IgnoreMatching("ControlBinding.get_g_value_array"),
|
|
|
|
// Manually implemented:
|
|
typesystem.IgnoreMatching("Object.get_value"),
|
|
typesystem.IgnoreMatching("ControlBinding.get_value"), // TODO
|
|
|
|
typesystem.IgnoreMatching("ElementFactory.make_with_properties"),
|
|
typesystem.IgnoreMatching("Message.parse_property_notify"),
|
|
typesystem.IgnoreMatching("Message.new_property_notify"),
|
|
typesystem.IgnoreMatching("Message.get_stream_status_object"),
|
|
typesystem.IgnoreMatching("Structure.get_value"),
|
|
typesystem.IgnoreMatching("Structure.set_value"),
|
|
typesystem.IgnoreMatching("Structure.id_get_value"),
|
|
typesystem.IgnoreMatching("Structure.id_take_value"),
|
|
typesystem.IgnoreMatching("Structure.take_value"),
|
|
typesystem.IgnoreMatching("ChildProxy.set_property"),
|
|
typesystem.IgnoreMatching("ChildProxy.get_property"),
|
|
typesystem.IgnoreMatching("Iterator.next"),
|
|
typesystem.IgnoreMatching("TagList.get_value_index"),
|
|
|
|
// we have bindings for parse_launch(_full), if we need the v variants,
|
|
// then manually implement them
|
|
typesystem.IgnoreMatching("parse_launchv"),
|
|
typesystem.IgnoreMatching("parse_launchv_full"),
|
|
|
|
// gobject.NewValue handles this already.
|
|
typesystem.IgnoreMatching("util_set_value_from_string"),
|
|
|
|
// Buffer mapping is manually implemented:
|
|
typesystem.IgnoreMatching("Buffer.map"),
|
|
typesystem.IgnoreMatching("Buffer.unmap"),
|
|
typesystem.IgnoreMatching("MapInfo"),
|
|
|
|
// Requires a gvalue arg, manually implemented:
|
|
typesystem.IgnoreMatching("TagSetter.add_tag_value"),
|
|
},
|
|
},
|
|
"GstBase-1": {
|
|
IgnoredDefinitions: []typesystem.IgnoreFunc{
|
|
// has unexported free function that crashes the linker when compiling the examples:
|
|
typesystem.IgnoreMatching("TypeFindData"),
|
|
},
|
|
},
|
|
"GstVideo-1": {
|
|
IgnoredDefinitions: []typesystem.IgnoreFunc{
|
|
// must be implemented manually
|
|
typesystem.IgnoreMatching("VideoCodecFrame.set_user_data"),
|
|
typesystem.IgnoreMatching("VideoCodecFrame.get_user_data"),
|
|
// returns a gconstpointer to an array, manually implemented instead
|
|
typesystem.IgnoreMatching("VideoFormat.get_palette"),
|
|
},
|
|
},
|
|
"GstPbutils-1": {
|
|
IgnoredDefinitions: []typesystem.IgnoreFunc{
|
|
// Resolve to ObjectClass:
|
|
typesystem.IgnoreMatching("DiscovererAudioInfoClass"),
|
|
typesystem.IgnoreMatching("DiscovererContainerInfoClass"),
|
|
typesystem.IgnoreMatching("DiscovererInfoClass"),
|
|
typesystem.IgnoreMatching("DiscovererStreamInfoClass"),
|
|
typesystem.IgnoreMatching("DiscovererSubtitleInfoClass"),
|
|
typesystem.IgnoreMatching("DiscovererVideoInfoClass"),
|
|
typesystem.IgnoreMatching("EncodingTargetClass"),
|
|
},
|
|
},
|
|
},
|
|
},
|
|
Postprocessors: []typesystem.PostProcessor{
|
|
typesystem.MarkAsManuallyExtended("Gst-1", "Object"),
|
|
typesystem.MarkAsManuallyExtended("Gst-1", "Element"),
|
|
typesystem.MarkAsManuallyExtended("Gst-1", "Bin"),
|
|
typesystem.MarkAsManuallyExtended("Gst-1", "Bus"),
|
|
typesystem.MarkAsManuallyExtended("Gst-1", "ChildProxy"),
|
|
typesystem.MarkAsManuallyExtended("Gst-1", "TagSetter"),
|
|
func(r *typesystem.Registry) error {
|
|
// this is needed to fix gstreamer <= 1.24.10. Remove once upgraded in the flake
|
|
webrtc := r.FindNamespaceByName("GstWebRTC-1")
|
|
|
|
webrtc.Packages = append(webrtc.Packages, "gstreamer-sdp-1.0")
|
|
webrtc.CIncludes = append(webrtc.CIncludes, "gst/webrtc/sctptransport.h")
|
|
|
|
return nil
|
|
},
|
|
},
|
|
GeneratorHooks: []genmain.GeneratorHook{
|
|
genmain.AddGeneratorToPackage("gstmpegts", &GstUseUnstableAPI{}),
|
|
genmain.AddGeneratorToPackage("gstwebrtc", &GstUseUnstableAPI{}),
|
|
},
|
|
},
|
|
)
|
|
|
|
func main() {
|
|
genmain.Run(Data)
|
|
}
|
|
|
|
var borrowedTypes = []string{
|
|
"Gst-1.MiniObject", "Gst-1.Structure", "Gst-1.Caps", "Gst-1.Buffer", "Gst-1.BufferList", "Gst-1.Memory", "Gst-1.Message", "Gst-1.Query", "Gst-1.Sample",
|
|
}
|
|
|
|
// gst.MiniObject extenders must not take a ref on these methods, or they are made readonly
|
|
func MiniObjectExtenderBorrows() types.Preprocessor {
|
|
return types.PreprocessorFunc(func(repos gir.Repositories) {
|
|
for _, fulltype := range borrowedTypes {
|
|
res := repos.FindFullType(fulltype)
|
|
if res == nil {
|
|
log.Fatalf("fulltype %s not found", fulltype)
|
|
}
|
|
|
|
switch typ := res.Type.(type) {
|
|
case *gir.Record:
|
|
for i, m := range typ.Methods {
|
|
if m.ReturnValue.TransferOwnership.TransferOwnership == "none" && slices.ContainsFunc(borrowedTypes, func(typ string) bool {
|
|
return strings.SplitN(typ, ".", 2)[1] == m.ReturnValue.Type.Name
|
|
}) {
|
|
log.Printf("marking function as borrowing: %s", m.Name)
|
|
typ.Methods[i].ReturnValue.TransferOwnership.TransferOwnership = "borrow"
|
|
}
|
|
}
|
|
default:
|
|
log.Fatalf("unhandled type for %s", fulltype)
|
|
}
|
|
}
|
|
})
|
|
}
|
|
|
|
func MarkReturnAsBorrowed(fulltype string) types.Preprocessor {
|
|
return types.ModifyCallable(fulltype, func(c *gir.CallableAttrs) {
|
|
c.ReturnValue.TransferOwnership.TransferOwnership = "borrow"
|
|
})
|
|
}
|
|
|
|
func DedupBitfieldMembers(fulltype string) types.Preprocessor {
|
|
return types.PreprocessorFunc(func(repos gir.Repositories) {
|
|
bf := repos.FindFullType(fulltype).Type.(*gir.Bitfield)
|
|
|
|
oldmembers := bf.Members
|
|
|
|
bf.Members = nil
|
|
|
|
seen := make(map[string]struct{})
|
|
|
|
for _, m := range oldmembers {
|
|
if _, ok := seen[m.CIdentifier]; ok {
|
|
continue
|
|
}
|
|
|
|
seen[m.CIdentifier] = struct{}{}
|
|
|
|
bf.Members = append(bf.Members, m)
|
|
}
|
|
})
|
|
}
|
|
|
|
// FixCutoffEnumMemberNames adds a namespace prefix, that will later be cut off by FormatMember. It also regenerates the name from the C identifier
|
|
func FixCutoffEnumMemberNames(fulltype string) types.Preprocessor {
|
|
return types.MapMembers(fulltype, func(member gir.Member) gir.Member {
|
|
newname := strcases.SnakeToGo(true, strings.ToLower(member.CIdentifier))
|
|
|
|
nameAttr := xml.Name{Local: "name"}
|
|
for i, attr := range member.Names {
|
|
if attr.Name == nameAttr {
|
|
attr.Value = newname
|
|
}
|
|
|
|
member.Names[i] = attr
|
|
}
|
|
|
|
member.CIdentifier = "gst_" + member.CIdentifier
|
|
|
|
return member
|
|
})
|
|
}
|
|
|
|
// GstUseUnstableAPI defines the C macro to suppress compilation warnings, but also creates
|
|
// an init func that logs a warning message that can be opt-outted out by the user.
|
|
type GstUseUnstableAPI struct{}
|
|
|
|
// Generate implements generators.Generator.
|
|
func (g *GstUseUnstableAPI) Generate(w *file.Package) {
|
|
w.DefineC("GST_USE_UNSTABLE_API // APIs in this package are unstable")
|
|
|
|
w.GoImport("log")
|
|
|
|
fmt.Fprintln(w.Go(), "// SuppressUnstableWarning should be overwritten by the user to suppress the warning")
|
|
fmt.Fprintln(w.Go(), "var SuppressUnstableWarning = false")
|
|
fmt.Fprintln(w.Go(), "func init() {")
|
|
w.Go().Indent()
|
|
fmt.Fprintln(w.Go(), "if !SuppressUnstableWarning {")
|
|
fmt.Fprintln(w.Go(), "\tlog.Println(\"Warning: using unstable API\")")
|
|
fmt.Fprintln(w.Go(), "}")
|
|
w.Go().Unindent()
|
|
fmt.Fprintln(w.Go(), "}")
|
|
}
|
|
|
|
var _ generators.Generator = &GstUseUnstableAPI{}
|