source: multimedia/libdriv/pipewire.xml@ dcea4e3

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY pipewire-download-http "https://github.com/PipeWire/pipewire/archive/&pipewire-version;/pipewire-&pipewire-version;.tar.gz">
  <!ENTITY pipewire-download-ftp  " ">
  <!ENTITY pipewire-md5sum        "558660cd68f7119ba9477dd996e7d041">
  <!ENTITY pipewire-size          "412 KB">
  <!ENTITY pipewire-buildsize     "39 MB">
  <!ENTITY pipewire-time          "0.5 SBU">
]>

<sect1 id="pipewire" xreflabel="pipewire-&pipewire-version;">
  <?dbhtml filename="pipewire.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>Pipewire-&pipewire-version;</title>

  <indexterm zone="pipewire">
    <primary sortas="a-pipewire">pipewire</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Pipewire</title>

    <para>
      The <application>pipewire</application> package contains a server and
      user-space API to handle multimedia pipelines. This includes a universal
      API to connect to multimedia devices, as well as sharing multimedia
      files between applications.
    </para>

    &lfs84_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&pipewire-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&pipewire-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &pipewire-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &pipewire-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &pipewire-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &pipewire-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Pipewire Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="ffmpeg"/>,
      <xref linkend="gstreamer10"/>,
      <xref linkend="gst10-plugins-base"/>,
      <xref linkend="libva"/>,
      <xref linkend="sbc"/>,
      <xref linkend="sdl2"/>, and
      <xref linkend="v4l-utils"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="valgrind"/>,
      <xref linkend="doxygen"/> and
      <xref linkend="graphviz"/> (for documentation)
    </para>

    <para condition="html" role="usernotes">
      User Notes: <ulink url="&blfs-wiki;/pipewire"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of Pipewire</title>

    <para>
      Install <application>pipewire</application> by running the following
      commands:
    </para>

<screen><userinput>mkdir build &amp;&amp;
cd build &amp;&amp;

meson --prefix=/usr --sysconfdir=/etc .. &amp;&amp;
ninja</userinput></screen>

    <para>
      This package does not come with a test suite.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>ninja install</userinput></screen>
  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <option>-Ddocs=true</option>: This switch enables the generation of HTML
      documentation. The optional dependencies for documentation need to be
      installed for this to work.
    </para>

    <para>
      <option>-Dman=true</option>: This switch enables the generation of manual
      pages. The optional dependencies for documentation need to be installed
      for this to work.
    </para>
  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          pipewire,
          pipewire-cli,
          pipewire-monitor,
          spa-inspect, and
          spa-monitor
        </seg>
        <seg>
          libpipewire-2.0.so
        </seg>
        <seg>
          /etc/pipewire,
          /usr/include/pipewire, 
          /usr/include/spa,
          /usr/lib/pipewire-0.2, and
          /usr/lib/spa
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="pipewire-prog">
        <term><command>pipewire</command></term>
        <listitem>
          <para>
            is a service that allows access to multimedia devices and allows
            sharing of multimedia files between applications.
          </para>
          <indexterm zone="pipewire pipewire-prog">
            <primary sortas="b-pipewire">pipewire</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pipewire-cli">
        <term><command>pipewire-cli</command></term>
        <listitem>
          <para>
            allows you to interact with a pipewire instance.
          </para>
          <indexterm zone="pipewire pipewire-cli">
            <primary sortas="b-pipewire-cli">pipewire-cli</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pipewire-monitor">
        <term><command>pipewire-monitor</command></term>
        <listitem>
          <para>
            allows you to monitor pipewire instances.
          </para>
          <indexterm zone="pipewire pipewire-monitor">
            <primary sortas="b-pipewire-monitor">pipewire-monitor</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="spa-inspect">
        <term><command>spa-inspect</command></term>
        <listitem>
          <para>
            allows you to inspect pipewire plugins.
          </para>
          <indexterm zone="pipewire spa-inspect">
            <primary sortas="b-spa-inspect">spa-inspect</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="spa-monitor">
        <term><command>spa-monitor</command></term>
        <listitem>
          <para>
            allows you to monitor pipewire plugins.
          </para>
          <indexterm zone="pipewire spa-monitor">
            <primary sortas="b-spa-monitor">spa-monitor</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libpipewire">
        <term><filename class="libraryfile">libpipewire-0.2.so</filename></term>
        <listitem>
          <para>
            contains API functions for handling multimedia pipelines.
          </para>
          <indexterm zone="pipewire libpipewire">
            <primary sortas="c-libpipewire">libpipewire-0.2.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>