Peter Hutterer
6f43aba91d
doc: check if the media_session_sources variable exists
...
When building with -Dexamples=disabled, the whole src/examples is
skipped, so we never declare that variable.
Fixes #1551
2021-09-22 13:58:11 +10:00
Peter Hutterer
e1672f9762
pipewire: allow for log level names in PIPEWIRE_DEBUG
...
Allow one of "XEWIDT" to refer to none, errors, warnings, info, debug
and trace, respectively because they're immediately recognizable. Well,
except maybe the X.
PIPEWIRE_DEBUG="I" is equivalent to PIPEWIRE_DEBUG="3" for example.
2021-09-10 07:38:20 +00:00
Wim Taymans
954befccff
doc: define HAVE_DOT to generate dot files
...
Fixes #1585
2021-09-09 13:01:29 +02:00
Peter Hutterer
0596b388fe
doc: fix example for the PIPEWIRE_DEBUG format
2021-09-09 09:31:52 +10:00
Peter Hutterer
2306124f49
doc: fix listing of the new No DSP media-session module
...
And copy the text from the comment into the public documentation, better
than just having an empty page there.
2021-09-07 07:52:45 +00:00
Peter Hutterer
7d13c7750d
doc: document the portal negotation process with graphs
...
This is a multi-step process involving 4 processes and two modules.
Let's add some graphs to make this slightly easier to comprehend for
those not familiar with how portals work.
2021-09-06 07:29:28 +00:00
Peter Hutterer
83ed6e0be3
doc: swap two @ doxygen tags for the backslash ones
2021-09-06 07:29:28 +00:00
columbarius
63521c1063
doc: add section about v4l2 dmabuf sharing
2021-09-03 09:34:26 +00:00
Simon Ser
7a618390ec
doc: add warning about mapping DMA-BUFs
...
A list of reasons why DMA-BUFs have to be treated specially. This
should make it clearer why mmaping DMA-BUFs should be avoided and hint
clients on how treat them correctly
Co-authored-by: columbarius <co1umbarius@protonmail.com>
2021-09-03 09:34:26 +00:00
columbarius
112d50c8b9
doc: clarify format negotiation
...
Describing different behaviour for modifier-less and modifier-aware case
and how a EnumFormat with modifier should be fixated. Also adding a Note
about `SPA_PARAM_BUFFERS_blocks`, which is important for multiplane
DMA-BUFS.
2021-09-03 09:34:26 +00:00
Nils Tonnätt
dd12910769
Revert "[Meson] Fix all deprecation warnings"
...
This reverts commit f7e1175ef0
.
2021-08-08 19:18:40 +00:00
Nils Tonnätt
f7e1175ef0
[Meson] Fix all deprecation warnings
2021-08-06 07:56:16 +00:00
Pauli Virtanen
76bae0cac4
media-session: add bluez-autoswitch module
...
Add module that switches bluez device profile to HFP/HSP if an input
stream (non-monitor, autoconnect) appears, and the current default
output device is bluez one that does not have input route.
When all input streams are gone, switch all changed profiles back.
Pending restore state is saved to session manager state files, in order
to restore it if e.g. devices get disconnected. This usually is not
currently necessary since the bluez5 plugin prefers to connect to A2DP
over HFP, but might matter in future with backchannel-enabled A2DP
codecs.
2021-08-05 11:27:06 +00:00
Peter Hutterer
127781cfc8
doc: ignore all function attributes in doxygen
2021-08-05 09:51:40 +00:00
Peter Hutterer
d8f6033b9d
spa: document the spa_interface and how it works
2021-08-05 09:51:40 +00:00
Peter Hutterer
1be939c672
doc: add a meson example to the tutorial
...
The vast majority of users will want to build with a build system, so
let's add a minimal example there to avoid guesswork.
2021-08-05 09:51:40 +00:00
Wim Taymans
4841156b74
doc: clarify JSON usage
...
Mention that the config format can be pure JSON or with some
simplifications and additions.
2021-08-04 11:47:31 +02:00
Peter Hutterer
f0baffbc84
doc: ignore SPA_EXPORT and SPA_PRINTF_FUNC
...
This caused doxygen to include a rather random assortment of variables
and link to them from various pages (e.g. "arg", "res", "buffer", NAME,
etc.)
2021-08-04 07:49:53 +00:00
Peter Hutterer
5561531751
doc: document the core/implementation API split a bit better
...
Still missing a proper review of the linked objects, but at least this
now explains why those two are split.
2021-08-04 07:49:53 +00:00
Peter Hutterer
3370a56e3e
doc: move the error reporting blurb to the library page
...
Let's keep the daemon page higher-level and leave API behaviors
elsewhere.
2021-08-04 07:49:53 +00:00
Peter Hutterer
710caf9d75
doc: fix a subsection name
2021-08-04 07:49:53 +00:00
Peter Hutterer
4c760e473d
doc: add a nice graph to illustrate how the daemon a bit
2021-08-04 07:49:53 +00:00
Peter Hutterer
13ffc549c9
doc: add basic docs for the session manager
2021-08-04 07:49:53 +00:00
Peter Hutterer
fc85b33e80
doc: drop the header priority in media-session.dox
...
This way the two subheaders won't show up in the sidebar
2021-08-02 08:27:51 +00:00
Peter Hutterer
310b4611c8
media-session: add stub docs for all media-session modules
...
Same basic approach as for the pipewire modules
2021-08-02 08:27:51 +00:00
Peter Hutterer
602bed7a98
doc: add minimal documentation for the alsa endpoint SM module
2021-08-02 08:27:51 +00:00
Peter Hutterer
c2fef6caa2
doc: format the objects design page
...
Mostly replacing the lists so they actually render as lists
2021-08-02 08:27:51 +00:00
Peter Hutterer
25d15765b7
doc: better output formatting for the midi page
2021-08-02 08:27:51 +00:00
Peter Hutterer
8d39940350
doc: some more polishing of the access docs
2021-08-02 08:27:51 +00:00
Peter Hutterer
82e427745d
doc: structure the portal documentation a bit better
2021-07-30 07:24:24 +00:00
Peter Hutterer
0261b78870
doc: expand the module doc a bit
...
Makes it feel slightly more complete, even if the example modules are
currently undocumented.
2021-07-30 07:24:24 +00:00
Peter Hutterer
c753f45598
doc: remove the PipeWire prefix from the nested pages
...
They're structured below PipeWire in the doxygen output, so we don't
need this as part of the header.
2021-07-30 07:24:24 +00:00
Simon Ser
6773ea7e5e
doc: add DMA-BUF docs
2021-07-29 19:18:49 +00:00
Peter Hutterer
4496aed5a6
doc: revamp the pipewire-access page
...
Rewording, linking to the various things, etc.
2021-07-29 16:06:36 +10:00
Peter Hutterer
d1c80183d9
doc: add a media-session header file with the access-flatpak module
...
This adds a new top-level documentation entry for pipewire-media-session
with a list of modules (currently only one). Similar setup to the
pipewire modules, it allows us to document all modules in-place.
2021-07-29 16:06:36 +10:00
Peter Hutterer
c03fedbac2
doc: reword the Design page
2021-07-29 14:43:40 +10:00
Peter Hutterer
6da0ee6cb5
doc: move the overview page out to its own page
...
This is a good first (top) page to have in the docs, let's move it out
from the pipewire heading.
This doesn't change any of the links and the renaming isn't required
(subpage controls whether it's a top-level item and the meson.build
order decides its spot in he list). Still, better to have the filenames
represent the layout.
2021-07-29 14:33:09 +10:00
Peter Hutterer
85435cd525
doc: improve the pipewire-audio page for readability
...
Typos, some header changes, etc.
2021-07-29 14:26:01 +10:00
Peter Hutterer
7871f33da6
doc: remove the Pipewire prefix from some of the doc pages
2021-07-29 14:26:01 +10:00
Peter Hutterer
f0152b6a0a
doc: add the new documentation pages to the docs
...
And make them a subpage of the Pipewire topic
2021-07-29 14:25:01 +10:00
Wim Taymans
ab99f4d027
doc: add general audio configuration
2021-07-26 09:35:05 +02:00
Wim Taymans
0346c616e2
doc: add midi doc
...
Reorganize the docs a little. First a short intro, then list the use
cases, then the responsabilities of the various components, then
the implementation in various places.
2021-07-23 11:05:59 +02:00
Wim Taymans
762e549027
doc: add portal document
2021-07-23 09:57:45 +02:00
Wim Taymans
79233aee52
doc: document access control
...
A first stab at the basics of access control documentation and the
use cases solved by the session manager.
2021-07-22 14:52:57 +02:00
Peter Hutterer
765bd417de
doc: link the most recent modules as subpages
...
This sorts them correctly in the navigation bar
2021-07-05 08:57:41 +00:00
Peter Hutterer
d6bb69f2bd
doc: add the configuration file format to the online documentation
...
Mostly copied from the man page but with a more applicable example.
2021-07-05 08:57:41 +00:00
Niklāvs Koļesņikovs
0436793299
doc/meson.build: pruning of unused find_program()
2021-06-29 17:23:37 +00:00
Niklāvs Koļesņikovs
e062c4d8de
meson.build: adds summary() to optional programs
2021-06-29 17:23:37 +00:00
Peter Hutterer
f181232a61
doc: add the documentation infrastructure for pipewire modules
...
All empty pages for now but at least this makes them show up in the
documentation.
2021-06-25 08:42:24 +00:00
Peter Hutterer
9956637ce5
doc: drop unused variable from meson.build
2021-06-25 08:42:24 +00:00