mirror of
https://gitlab.freedesktop.org/pipewire/pipewire
synced 2024-10-06 16:09:43 +00:00
docs: add some more docs
This commit is contained in:
parent
da9d17e73e
commit
12afb23938
36
doc/overview.md
Normal file
36
doc/overview.md
Normal file
|
@ -0,0 +1,36 @@
|
|||
# PipeWire Overview
|
||||
|
||||
PipeWire is a new low-level multimedia framework designed from scratch that
|
||||
aims to provide
|
||||
|
||||
* graph based processing
|
||||
* support for out-of-process processing graphs with minimal overhead
|
||||
* flexible and extensible media format negotiation and buffer allocation
|
||||
* Hard real-time capable plugins
|
||||
* achieve very low-latency for both audio and video processing
|
||||
|
||||
The framework is used to build a modular daemon that can be configured to:
|
||||
|
||||
* be a low-latency audio server with features like pulseaudio and/or jack
|
||||
* a video capture server that can manage hardware video capture devices and
|
||||
provide access to them
|
||||
* a central hub where video can be made available for other applications
|
||||
such as the gnome-shell screencast API.
|
||||
|
||||
## Components
|
||||
|
||||
Currently PipeWire ships with the following components:
|
||||
|
||||
* a PipeWire daemon that implements the IPC and graph processing
|
||||
* an example session manager that manages objects in the PipeWire
|
||||
daemon.
|
||||
* a set of tools to introspect and use the PipeWire daemon.
|
||||
* a library to develop PipeWire applications and plugins.
|
||||
|
||||
### The PipeWire daemon
|
||||
|
||||
### The example session manager
|
||||
|
||||
### Tools
|
||||
|
||||
### Application development
|
45
doc/tutorial1.md
Normal file
45
doc/tutorial1.md
Normal file
|
@ -0,0 +1,45 @@
|
|||
# Tutorial 1
|
||||
|
||||
In this tutorial we show the basics of a simple PipeWire application.
|
||||
Use this tutorial to get started and help you set up your development
|
||||
environment.
|
||||
|
||||
## Initialization
|
||||
|
||||
Let get started with the simplest application.
|
||||
|
||||
```c
|
||||
#include <pipewire/pipewire.h>
|
||||
|
||||
int main(int argc, char *argv[])
|
||||
{
|
||||
pw_init(&argc, &argv);
|
||||
|
||||
fprintf(stdout, "Compiled with libpipewire %s\n"
|
||||
"Linked with libpipewire %s\n",
|
||||
pw_get_headers_version(),
|
||||
pw_get_library_version());
|
||||
return 0;
|
||||
}
|
||||
```
|
||||
|
||||
Before you can use any PipeWire functions, you need to call `pw_init()`.
|
||||
|
||||
## Compilation
|
||||
|
||||
To compile the simple test application, copy it into a test1.c file and
|
||||
use:
|
||||
|
||||
```
|
||||
gcc -Wall test1.c -o test1 $(pkg-config --cflags --libs libpipewire-0.3)
|
||||
```
|
||||
|
||||
then run it with:
|
||||
|
||||
```
|
||||
# ./test1
|
||||
Compiled with libpipewire 0.3.5
|
||||
Linked with libpipewire 0.3.5
|
||||
#
|
||||
```
|
||||
|
67
doc/tutorial2.md
Normal file
67
doc/tutorial2.md
Normal file
|
@ -0,0 +1,67 @@
|
|||
# Tutorial 2
|
||||
|
||||
In this tutorial we show how to connect to a PipeWire daemon and
|
||||
enumerate the objects that it has.
|
||||
|
||||
## Initialization
|
||||
|
||||
Let take a look at the following application to start.
|
||||
|
||||
```c
|
||||
#include <pipewire/pipewire.h>
|
||||
|
||||
static void registry_event_global(void *data, uint32_t id,
|
||||
uint32_t permissions, const char *type, uint32_t version,
|
||||
const struct spa_dict *props)
|
||||
{
|
||||
printf("object: id:%u type:%s/%d\n", id, type, version);
|
||||
}
|
||||
|
||||
static const struct pw_registry_events registry_events = {
|
||||
PW_VERSION_REGISTRY_EVENTS,
|
||||
.global = registry_event_global,
|
||||
};
|
||||
|
||||
int main(int argc, char *argv[])
|
||||
{
|
||||
struct pw_main_loop *loop;
|
||||
struct pw_context *context;
|
||||
struct pw_core *core;
|
||||
struct pw_registry *registry;
|
||||
struct spa_hook registry_listener;
|
||||
|
||||
pw_init(&argc, &argv);
|
||||
|
||||
loop = pw_main_loop_new(NULL /* properties */);
|
||||
context = pw_context_new(pw_main_loop_get_loop(loop),
|
||||
NULL /* properties */,
|
||||
0 /* user_data size */);
|
||||
|
||||
core = pw_context_connect(context,
|
||||
NULL /* properties */,
|
||||
0 /* user_data size */);
|
||||
|
||||
registry = pw_core_get_registry(core, PW_VERSION_REGISTRY,
|
||||
0 /* user_data size */);
|
||||
|
||||
spa_zero(registry_listener);
|
||||
pw_registry_add_listener(registry, ®istry_listener,
|
||||
®istry_events, NULL);
|
||||
|
||||
pw_main_loop_run(loop);
|
||||
|
||||
pw_proxy_destroy((struct pw_proxy*)registry);
|
||||
pw_core_disconnect(core);
|
||||
pw_context_destroy(context);
|
||||
pw_main_loop_destroy(loop);
|
||||
|
||||
return 0;
|
||||
}
|
||||
```
|
||||
|
||||
To compile the simple test application, copy it into a test2.c file and
|
||||
use:
|
||||
|
||||
```
|
||||
gcc -Wall test2.c -o test2 $(pkg-config --cflags --libs libpipewire-0.3)
|
||||
```
|
Loading…
Reference in a new issue