source: multimedia/libdriv/x265.xml@ 0553fd4

<?xml version="1.0" encoding="UTF-8"?>
<!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 "https://bitbucket.org/multicoreware/x265_git/downloads/x265_&x265-version;.tar.gz">
  <!ENTITY x265-download-ftp  " ">
  <!ENTITY x265-md5sum        "44e0082a7635eab2488bebd18875a09a">
  <!ENTITY x265-size          "1.6 MB">
  <!ENTITY x265-buildsize     "45 MB">
  <!ENTITY x265-time          "0.5 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>

    &lfs122_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 -D CMAKE_INSTALL_PREFIX=/usr \
      -D GIT_ARCHETYPE=1           \
      -W no-dev ../source          &amp;&amp;
make</userinput></screen>

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

    <para>
      To install the package, first remove any old library versions.
      After installation, remove a static library.
      As the &root; 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>-W no-dev</parameter>: This switch is used to suppress warnings
        intended for the package developers.
      </para>

      <para>
        <parameter>-D GIT_ARCHETYPE=1</parameter>: This switch is needed
        because the build system will not generate a pkg-config file or install
        a shared library unless <xref linkend="git"/> is installed. Git isn't
        required for anything else in this package, so this switch is used to
        work around it for users who do not want to install Git as a build
        dependency.
      </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>