Add some Debian/Ubuntu specific installation instructions

pjsip · Feb 16, 2023 · 2a96c49 · 2a96c49
1 parent 8c269f1
commit 2a96c49
Show file tree

Hide file tree

Showing 5 changed files with 59 additions and 7 deletions.
diff --git a/docs/source/api/pjmedia/pjmedia-codec.rst b/docs/source/api/pjmedia/pjmedia-codec.rst
@@ -138,7 +138,7 @@ Linear/PCM 8/16bit mono/stereo
 
 OpenCore AMR NB/WB
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-- Installation: :ref:`guide_opencore_amr`
+- Installation: :any:`/specific-guides/audio/opencore-amr`
 - Code documentation: :doc:`OpenCore AMR NB/WB</api/generated/pjmedia/group/group__PJMED__OC__AMR>`
 
 .. _openh264:
@@ -150,10 +150,19 @@ Provides video codec H.264, alternatively you can use ffmpeg (together with
 libx264).
 
 - Supports Windows, Posix (Mac OS X, Linux), iOS, Android.
+- You may install from the binaries packages if they are available for your platform.
+
+  - Debian/Ubuntu:
+
+    .. code-block:: shell
+
+       $ sudo apt-get install libopenh264-dev
+
+  See https://www.openh264.org/ for installation instructions for other platforms.
 - OpenH264 may be detected and enabled by the ``configure`` script, either 
   automatically or manually via ``--with-openh264`` option. It may be forcefully 
   disabled by defining ``PJMEDIA_HAS_OPENH264_CODEC`` to 0 in ``config_site.h``
-- Detailed instructions: :issue:`1947`
+- More detailed instructions: see issue :issue:`1947`
 - Code documentation: :doc:`OpenH264 </api/generated/pjmedia/group/group__PJMEDIA__CODEC__OPENH264>`
 
 
@@ -164,7 +173,15 @@ Opus
 Opus is a totally open, royalty-free, highly versatile audio codec.
 
 - Supports Windows, Posix (Mac OS X, Linux), iOS, Android.
-- Build instructions: https://github.com/pjsip/pjproject/issues/1904
+- You may install from the binaries packages if they are available for your platform.
+
+  - Debian/Ubuntu:
+
+    .. code-block:: shell
+
+        $ sudo apt-get install libopus-dev
+
+- Build instructions: see issue :issue:`1904`
 - Code documentation: :doc:`OPUS </api/generated/pjmedia/group/group__PJMED__OPUS>`
 
 .. _passthrough:
@@ -203,6 +220,14 @@ Speex
 
 VP8 and VP9 (libvpx)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+- On Debian/Ubuntu it is provided by *libvpx-dev*:
+  package:
+
+  .. code-block:: shell
+
+    $ sudo apt-get install libvpx-dev
+
+  See `webm website <https://www.webmproject.org/code/>`__ for installation instructions for other platforms.
 - Build instructions: :issue:`2253`
 - Code documentation: :doc:`VP8 and VP9 </api/generated/pjmedia/group/group__PJMEDIA__CODEC__VPX>`
 
diff --git a/docs/source/common/common_codecs.rst b/docs/source/common/common_codecs.rst
@@ -18,7 +18,7 @@ Audio Codecs
 - :ref:`ilbc`
 - :ref:`ipp` (G.722.1, G.723.1, G.726, G.728, G.729, AMR, and AMR-WB)
 - :ref:`l16`
-- :ref:`opencore_amr`
+- :any:`/specific-guides/audio/opencore-amr`
 - :ref:`opus`
 - :ref:`l16`
 - :ref:`passthrough`

diff --git a/docs/source/specific-guides/audio/opencore-amr.rst b/docs/source/specific-guides/audio/opencore-amr.rst
@@ -16,8 +16,22 @@ This instruction applies for **all platforms** that OpenCORE supports, **includi
 
 We tested building the OpenCORE libraries for Linux, MacOS X, Windows (MinGW), and BlackBerry 10 (BB10).
 
-Building and installing OpenCORE AMR library
+Installing OpenCore binaries
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+You may install from the binaries packages if they are available for your platform.
+
+**Debian/Ubuntu:**
+
+.. code-block:: shell
+
+   $ sudo apt-get install libopencore-amrnb-dev libopencore-amrwb-dev libvo-amrwbenc-dev
+
+
+Building and installing from source
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+If binaries are not available or preferred, you must build and install OpenCore libraries
+from the source:
+
  #. Download the latest `opencore-amr <http://sourceforge.net/projects/opencore-amr/files/opencore-amr/>`__ tarball. We tested with version 0.1.3.
  #. Unpack the tarballs to a directory:
 
@@ -94,7 +108,8 @@ Adding AMR Support in PJSIP
 ----------------------------------
 Make Build System (MacOS X, Linux, BB10, etc.)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-#. In the pjproject directory, run ``configure`` script, specifying the installation directory of OpenCORE codec to the ``--with-opencore-amr`` option:
+#. In the pjproject directory, run ``configure`` script, optionally specifying the installation
+   directory of OpenCORE codec with ``--with-opencore-amr`` option:
 
    .. code-block:: shell
 

diff --git a/docs/source/specific-guides/security/ssl.rst b/docs/source/specific-guides/security/ssl.rst
@@ -26,9 +26,15 @@ Installing  OpenSSL
 For OpenSSL installation, refer to the following guides:
 
 - :any:`windows_openssl` (for Windows)
-- :any:`posix_openssl` (for MacOS X, Linux, Unix)
 - :any:`ios_openssl` (for iOS/iPhone)
 - :any:`android_openssl` (for Android)
+- For Debian/Ubuntu:
+
+  .. code-block:: shell
+
+     $ sudo apt-get install libssl-dev
+
+- Note that native SSL backend is available for Mac/iOS, see :pr:`2482`.
 - (deprecated) *BB10: using bundled OpenSSL*
 - (deprecated) TLS support on Symbian is implemented natively using CSecureSocket,
   hence it doesn’t require OpenSSL development kit. Please see *Configuring TLS on Symbian* for the

diff --git a/docs/source/specific-guides/video/features.rst b/docs/source/specific-guides/video/features.rst
@@ -0,0 +1,6 @@
+Features
+===================
+See the following pages:
+
+- :any:`Video features (Overview section) </overview/features_video>`
+- :any:`Devices (Overview section) </overview/features_media_devs>`