source: multimedia/libdriv/x265.xml@ 875b3b57

<?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 x265-download-http "&sources-anduin-http;/x265/x265-&x265-version;.tar.xz">
  <!ENTITY x265-download-ftp  " ">
  <!ENTITY x265-md5sum        "e735837f5e3fa95889e0a72eca39fccf">
  <!ENTITY x265-size          "1.0 MB">
  <!ENTITY x265-buildsize     "52 MB">
  <!ENTITY x265-time          "0.9 SBU (using parallelism=4)">
]>

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


  <title>x265-&x265-version;</title>

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

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

    <para>
      <application>x265</application> package provides a library for encoding
      video streams into the H.265/HEVC format.
    </para>

    &lfs120_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="cmake"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="nasm"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <ulink url="https://github.com/numactl/numactl">numactl</ulink>
    </para>


  </sect2>

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

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

<!-- the default build is Release, no need to specify that -->
<screen><userinput>mkdir bld &amp;&amp;
cd    bld &amp;&amp;

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DGIT_ARCHETYPE=1           \
      -Wno-dev ../source          &amp;&amp;
make</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>make install &amp;&amp;
rm -vf /usr/lib/libx265.a </userinput></screen>

  </sect2>

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

      <para>
        <parameter>-DGIT_ARCHETYPE=1</parameter>: Upstream no longer provides
        releases. BLFS is using a git snapshot, but if the builder has not
        installed <application>git</application> the build will not install
        the shared library or the pkgconfig file without this switch.
      </para>

      <para>
        <parameter>-Wno-dev</parameter>: This switch is used to suppress warnings
        intended for the package's developers.
      </para>

      <para>
        <command>rm -vf /usr/lib/libx265.a</command>: BLFS does not recommend
        using static libraries.
      </para>
  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          x265
        </seg>
        <seg>
          libx265.so
        </seg>
        <seg>
          None
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libx265">
        <term><filename class="libraryfile">libx265.so</filename></term>
        <listitem>
          <para>
            provides the functions used to encode video streams into the
            H.265/HEVC format
          </para>
          <indexterm zone="x265 libx265">
            <primary sortas="c-libx265">libx265.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>