stream_ops.go RawHistoryFolder

1package out
2
3import "unsafe"
4
5// PlaybackFormat describes the audio format used when connecting a playback
6// stream.
7type PlaybackFormat struct {
8	SampleRate      int
9	Channels        int
10	FramesPerBuffer int
11}
12
13// StreamOps defines the outbound interface for PipeWire stream lifecycle
14// operations that the player needs. This abstracts the raw C API so the
15// player can be tested without a real PipeWire daemon.
16type StreamOps interface {
17	// CreatePlaybackStream creates a new playback stream attached to the given
18	// main loop. The onProcess callback is invoked by PipeWire each time the
19	// stream needs more audio data. Returns the stream pointer or an error.
20	CreatePlaybackStream(loopPtr unsafe.Pointer, name string, onProcess func()) (streamPtr unsafe.Pointer, err error)
21
22	// ConnectPlaybackStream connects the stream for playback output using the
23	// supplied format.
24	ConnectPlaybackStream(streamPtr unsafe.Pointer, format PlaybackFormat) error
25
26	// SetStreamActive activates or deactivates the stream.
27	SetStreamActive(streamPtr unsafe.Pointer, active bool) error
28
29	// DequeueBuffer dequeues a buffer from the stream for writing.
30	// Returns nil if no buffer is available.
31	DequeueBuffer(streamPtr unsafe.Pointer) unsafe.Pointer
32
33	// QueueBuffer queues a filled buffer back to the stream.
34	QueueBuffer(streamPtr unsafe.Pointer, bufPtr unsafe.Pointer) error
35
36	// DisconnectStream disconnects the stream.
37	// Returns an error if the operation fails.
38	DisconnectStream(streamPtr unsafe.Pointer) error
39
40	// DestroyStream destroys the stream and frees its resources.
41	DestroyStream(streamPtr unsafe.Pointer)
42
43	// CreateMainLoop creates a new PipeWire main loop.
44	// Returns the loop pointer or an error.
45	CreateMainLoop() (loopPtr unsafe.Pointer, err error)
46
47	// RunMainLoop runs the main loop (blocks until quit).
48	// Returns an error if the loop fails to run.
49	RunMainLoop(loopPtr unsafe.Pointer) error
50
51	// QuitMainLoop signals the main loop to stop.
52	QuitMainLoop(loopPtr unsafe.Pointer)
53
54	// DestroyMainLoop destroys the main loop.
55	DestroyMainLoop(loopPtr unsafe.Pointer)
56}