1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY pipewire-download-http "https://github.com/PipeWire/pipewire/archive/&pipewire-version;/pipewire-&pipewire-version;.tar.gz">
|
---|
8 | <!ENTITY pipewire-download-ftp " ">
|
---|
9 | <!ENTITY pipewire-md5sum "558660cd68f7119ba9477dd996e7d041">
|
---|
10 | <!ENTITY pipewire-size "412 KB">
|
---|
11 | <!ENTITY pipewire-buildsize "39 MB">
|
---|
12 | <!ENTITY pipewire-time "0.5 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="pipewire" xreflabel="pipewire-&pipewire-version;">
|
---|
16 | <?dbhtml filename="pipewire.html"?>
|
---|
17 |
|
---|
18 | <sect1info>
|
---|
19 | <othername>$LastChangedBy$</othername>
|
---|
20 | <date>$Date$</date>
|
---|
21 | </sect1info>
|
---|
22 |
|
---|
23 | <title>Pipewire-&pipewire-version;</title>
|
---|
24 |
|
---|
25 | <indexterm zone="pipewire">
|
---|
26 | <primary sortas="a-pipewire">pipewire</primary>
|
---|
27 | </indexterm>
|
---|
28 |
|
---|
29 | <sect2 role="package">
|
---|
30 | <title>Introduction to Pipewire</title>
|
---|
31 |
|
---|
32 | <para>
|
---|
33 | The <application>pipewire</application> package contains a server and
|
---|
34 | user-space API to handle multimedia pipelines. This includes a universal
|
---|
35 | API to connect to multimedia devices, as well as sharing multimedia
|
---|
36 | files between applications.
|
---|
37 | </para>
|
---|
38 |
|
---|
39 | &lfs84_checked;
|
---|
40 |
|
---|
41 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
42 | <itemizedlist spacing="compact">
|
---|
43 | <listitem>
|
---|
44 | <para>
|
---|
45 | Download (HTTP): <ulink url="&pipewire-download-http;"/>
|
---|
46 | </para>
|
---|
47 | </listitem>
|
---|
48 | <listitem>
|
---|
49 | <para>
|
---|
50 | Download (FTP): <ulink url="&pipewire-download-ftp;"/>
|
---|
51 | </para>
|
---|
52 | </listitem>
|
---|
53 | <listitem>
|
---|
54 | <para>
|
---|
55 | Download MD5 sum: &pipewire-md5sum;
|
---|
56 | </para>
|
---|
57 | </listitem>
|
---|
58 | <listitem>
|
---|
59 | <para>
|
---|
60 | Download size: &pipewire-size;
|
---|
61 | </para>
|
---|
62 | </listitem>
|
---|
63 | <listitem>
|
---|
64 | <para>
|
---|
65 | Estimated disk space required: &pipewire-buildsize;
|
---|
66 | </para>
|
---|
67 | </listitem>
|
---|
68 | <listitem>
|
---|
69 | <para>
|
---|
70 | Estimated build time: &pipewire-time;
|
---|
71 | </para>
|
---|
72 | </listitem>
|
---|
73 | </itemizedlist>
|
---|
74 |
|
---|
75 | <bridgehead renderas="sect3">Pipewire Dependencies</bridgehead>
|
---|
76 |
|
---|
77 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
78 | <para role="required">
|
---|
79 | <xref linkend="ffmpeg"/>,
|
---|
80 | <xref linkend="gstreamer10"/>,
|
---|
81 | <xref linkend="gst10-plugins-base"/>,
|
---|
82 | <xref linkend="libva"/>,
|
---|
83 | <xref linkend="sbc"/>,
|
---|
84 | <xref linkend="sdl2"/>, and
|
---|
85 | <xref linkend="v4l-utils"/>
|
---|
86 | </para>
|
---|
87 |
|
---|
88 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
89 | <para role="optional">
|
---|
90 | <xref linkend="valgrind"/>,
|
---|
91 | <xref linkend="doxygen"/> and
|
---|
92 | <xref linkend="graphviz"/> (for documentation)
|
---|
93 | </para>
|
---|
94 |
|
---|
95 | <para condition="html" role="usernotes">
|
---|
96 | User Notes: <ulink url="&blfs-wiki;/pipewire"/>
|
---|
97 | </para>
|
---|
98 | </sect2>
|
---|
99 |
|
---|
100 | <sect2 role="installation">
|
---|
101 | <title>Installation of Pipewire</title>
|
---|
102 |
|
---|
103 | <para>
|
---|
104 | Install <application>pipewire</application> by running the following
|
---|
105 | commands:
|
---|
106 | </para>
|
---|
107 |
|
---|
108 | <screen><userinput>mkdir build &&
|
---|
109 | cd build &&
|
---|
110 |
|
---|
111 | meson --prefix=/usr --sysconfdir=/etc .. &&
|
---|
112 | ninja</userinput></screen>
|
---|
113 |
|
---|
114 | <para>
|
---|
115 | This package does not come with a test suite.
|
---|
116 | </para>
|
---|
117 |
|
---|
118 | <para>
|
---|
119 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
120 | </para>
|
---|
121 |
|
---|
122 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
123 | </sect2>
|
---|
124 |
|
---|
125 | <sect2 role="commands">
|
---|
126 | <title>Command Explanations</title>
|
---|
127 |
|
---|
128 | <para>
|
---|
129 | <option>-Ddocs=true</option>: This switch enables the generation of HTML
|
---|
130 | documentation. The optional dependencies for documentation need to be
|
---|
131 | installed for this to work.
|
---|
132 | </para>
|
---|
133 |
|
---|
134 | <para>
|
---|
135 | <option>-Dman=true</option>: This switch enables the generation of manual
|
---|
136 | pages. The optional dependencies for documentation need to be installed
|
---|
137 | for this to work.
|
---|
138 | </para>
|
---|
139 | </sect2>
|
---|
140 |
|
---|
141 | <sect2 role="content">
|
---|
142 | <title>Contents</title>
|
---|
143 |
|
---|
144 | <segmentedlist>
|
---|
145 | <segtitle>Installed Programs</segtitle>
|
---|
146 | <segtitle>Installed Libraries</segtitle>
|
---|
147 | <segtitle>Installed Directories</segtitle>
|
---|
148 |
|
---|
149 | <seglistitem>
|
---|
150 | <seg>
|
---|
151 | pipewire,
|
---|
152 | pipewire-cli,
|
---|
153 | pipewire-monitor,
|
---|
154 | spa-inspect, and
|
---|
155 | spa-monitor
|
---|
156 | </seg>
|
---|
157 | <seg>
|
---|
158 | libpipewire-2.0.so
|
---|
159 | </seg>
|
---|
160 | <seg>
|
---|
161 | /etc/pipewire,
|
---|
162 | /usr/include/pipewire,
|
---|
163 | /usr/include/spa,
|
---|
164 | /usr/lib/pipewire-0.2, and
|
---|
165 | /usr/lib/spa
|
---|
166 | </seg>
|
---|
167 | </seglistitem>
|
---|
168 | </segmentedlist>
|
---|
169 |
|
---|
170 | <variablelist>
|
---|
171 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
172 | <?dbfo list-presentation="list"?>
|
---|
173 | <?dbhtml list-presentation="table"?>
|
---|
174 |
|
---|
175 | <varlistentry id="pipewire-prog">
|
---|
176 | <term><command>pipewire</command></term>
|
---|
177 | <listitem>
|
---|
178 | <para>
|
---|
179 | is a service that allows access to multimedia devices and allows
|
---|
180 | sharing of multimedia files between applications.
|
---|
181 | </para>
|
---|
182 | <indexterm zone="pipewire pipewire-prog">
|
---|
183 | <primary sortas="b-pipewire">pipewire</primary>
|
---|
184 | </indexterm>
|
---|
185 | </listitem>
|
---|
186 | </varlistentry>
|
---|
187 |
|
---|
188 | <varlistentry id="pipewire-cli">
|
---|
189 | <term><command>pipewire-cli</command></term>
|
---|
190 | <listitem>
|
---|
191 | <para>
|
---|
192 | allows you to interact with a pipewire instance.
|
---|
193 | </para>
|
---|
194 | <indexterm zone="pipewire pipewire-cli">
|
---|
195 | <primary sortas="b-pipewire-cli">pipewire-cli</primary>
|
---|
196 | </indexterm>
|
---|
197 | </listitem>
|
---|
198 | </varlistentry>
|
---|
199 |
|
---|
200 | <varlistentry id="pipewire-monitor">
|
---|
201 | <term><command>pipewire-monitor</command></term>
|
---|
202 | <listitem>
|
---|
203 | <para>
|
---|
204 | allows you to monitor pipewire instances.
|
---|
205 | </para>
|
---|
206 | <indexterm zone="pipewire pipewire-monitor">
|
---|
207 | <primary sortas="b-pipewire-monitor">pipewire-monitor</primary>
|
---|
208 | </indexterm>
|
---|
209 | </listitem>
|
---|
210 | </varlistentry>
|
---|
211 |
|
---|
212 | <varlistentry id="spa-inspect">
|
---|
213 | <term><command>spa-inspect</command></term>
|
---|
214 | <listitem>
|
---|
215 | <para>
|
---|
216 | allows you to inspect pipewire plugins.
|
---|
217 | </para>
|
---|
218 | <indexterm zone="pipewire spa-inspect">
|
---|
219 | <primary sortas="b-spa-inspect">spa-inspect</primary>
|
---|
220 | </indexterm>
|
---|
221 | </listitem>
|
---|
222 | </varlistentry>
|
---|
223 |
|
---|
224 | <varlistentry id="spa-monitor">
|
---|
225 | <term><command>spa-monitor</command></term>
|
---|
226 | <listitem>
|
---|
227 | <para>
|
---|
228 | allows you to monitor pipewire plugins.
|
---|
229 | </para>
|
---|
230 | <indexterm zone="pipewire spa-monitor">
|
---|
231 | <primary sortas="b-spa-monitor">spa-monitor</primary>
|
---|
232 | </indexterm>
|
---|
233 | </listitem>
|
---|
234 | </varlistentry>
|
---|
235 |
|
---|
236 | <varlistentry id="libpipewire">
|
---|
237 | <term><filename class="libraryfile">libpipewire-0.2.so</filename></term>
|
---|
238 | <listitem>
|
---|
239 | <para>
|
---|
240 | contains API functions for handling multimedia pipelines.
|
---|
241 | </para>
|
---|
242 | <indexterm zone="pipewire libpipewire">
|
---|
243 | <primary sortas="c-libpipewire">libpipewire-0.2.so</primary>
|
---|
244 | </indexterm>
|
---|
245 | </listitem>
|
---|
246 | </varlistentry>
|
---|
247 | </variablelist>
|
---|
248 | </sect2>
|
---|
249 | </sect1>
|
---|