Skip to content

Commit

Permalink
Proofread (up to Getting Started -> Posix)
Browse files Browse the repository at this point in the history
  • Loading branch information
bennylp committed Feb 10, 2023
1 parent a3b74a7 commit b34f23c
Show file tree
Hide file tree
Showing 20 changed files with 140 additions and 112 deletions.
8 changes: 7 additions & 1 deletion docs/source/api/pjmedia/pjmedia-audiodev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,8 @@ And rebuild the Visual Studio project.

WASAPI (Windows Audio Session API)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

WASAPI will be used by following the instructions in
:any:`Getting started for Windows Phone</get-started/windows-phone/build_instructions>`.


No longer supported devices:
Expand Down Expand Up @@ -205,10 +206,15 @@ Follow these guides below to enable PA support in PJMEDIA:

Blackberry BB10
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
See https://trac.pjsip.org/repos/wiki/Getting-Started/BB10


Nokia APS/VAS
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
See https://trac.pjsip.org/repos/wiki/APS


Symbian MMF
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
See https://trac.pjsip.org/repos/wiki/Getting-Started/Symbian

2 changes: 1 addition & 1 deletion docs/source/api/pjnath/ref.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Traversal Using Relays around NAT

uPnP
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Universal Plug and Play support.
Universal Plug and Play support for SIP UDP and media UDP transports.

- See ticket :pr:`3184` for build and use instructions.
- :doc:`uPnP API reference </api/generated/pjnath/group/group__PJNATH__UPNP>`
Expand Down
8 changes: 4 additions & 4 deletions docs/source/common/common_audiodev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
This file is shared by both the Features (Datasheet) page and PJMEDIA API
reference page.
PJMEDIA-Audiodev supports the following platforms/devices:
:any:`PJMEDIA-Audiodev </api/pjmedia/pjmedia-audiodev>` supports the following platforms/devices:

- :ref:`alsa`
- :ref:`opensl`
Expand All @@ -18,7 +18,7 @@ PJMEDIA-Audiodev supports the following platforms/devices:

Older devices that are no longer supported:

- Blackberry BB10
- Symbian audio streaming/multimedia framework (MMF) implementation
- Nokia Audio Proxy Server (APS) implementation
- `Blackberry BB10 <https://trac.pjsip.org/repos/wiki/Getting-Started/BB10>`__
- `Symbian audio streaming/multimedia framework (MMF) <https://trac.pjsip.org/repos/wiki/Getting-Started/Symbian>`__
- `Nokia Audio Proxy Server (APS) <https://trac.pjsip.org/repos/wiki/APS>`__
- null-audio implementation
10 changes: 5 additions & 5 deletions docs/source/common/common_os_list.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,16 @@

- Community supported:

- `MinGW-w64 <https://github.com/pjsip/pjproject/pull/2598>`_
- `Embox RTOS <https://github.com/pjsip/pjproject/pull/2643>`_
- `MinGW-w64 <https://github.com/pjsip/pjproject/pull/2598>`__
- `Embox RTOS <https://github.com/pjsip/pjproject/pull/2643>`__
- OpenBSD
- FreeBSD
- Solaris
- RTEMS

- Deprecated platforms:

- Windows Mobile/Windows CE
- Symbian S60 3rd Edition and 5th Edition
- BlackBerry (BB10)
- `Windows Mobile/Windows CE <https://trac.pjsip.org/repos/wiki/Getting-Started/Windows-Mobile>`__
- `Symbian S60 3rd Edition and 5th Edition <https://trac.pjsip.org/repos/wiki/Getting-Started/Symbian>`__
- `BlackBerry (BB10) <https://trac.pjsip.org/repos/wiki/Getting-Started/BB10>`__

13 changes: 6 additions & 7 deletions docs/source/common/common_pjmedia.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ as well as getting involved in negotiation of suitable transport in SDP. Media t
can also be chained in a pipeline (for example, SRTP+ICE).

- :doc:`Media Transport API </api/generated/pjmedia/group/group__PJMEDIA__TRANSPORT>`
- :doc:`SRTP - Secure RTP (SDES and DTLS) </api/generated/pjmedia/group/group__PJMEDIA__TRANSPORT__SRTP>`
- :any:`SRTP - Secure RTP (SDES and DTLS) </specific-guides/security/srtp>`
- :doc:`ICE - Interactive Connectivity Establishment </api/generated/pjmedia/group/group__PJMEDIA__TRANSPORT__ICE>`
- :doc:`UDP </api/generated/pjmedia/group/group__PJMEDIA__TRANSPORT__UDP>`
- :doc:`Loopback </api/generated/pjmedia/group/group__PJMEDIA__TRANSPORT__LOOP>`
Expand Down Expand Up @@ -104,7 +104,6 @@ Codec Framework
- :doc:`Codec Registration </api/generated/pjmedia/group/group__PJMEDIA__CODEC__REGISTER__ALL>`
- :doc:`Codec constants </api/generated/pjmedia/group/group__pjmedia__codec__types>`
- :doc:`Audio Codec Framework </api/generated/pjmedia/group/group__PJMEDIA__CODEC>`
- :doc:`G.711 </api/generated/pjmedia/group/group__PJMED__G711>`
- :doc:`Video Codec Framework </api/generated/pjmedia/group/group__PJMEDIA__VID__CODEC>`

.. note::
Expand All @@ -119,19 +118,19 @@ SDP
- `SDP SSRC attribute <https://github.com/pjsip/pjproject/issues/2098>`__
(:rfc:`5576`)
- `RTP and RTCP multiplexing <https://github.com/pjsip/pjproject/issues/2087>`_
`(RFC 5761) <https://datatracker.ietf.org/doc/html/rfc5761>`_
(:rfc:`5761`)

RTP and RTCP
^^^^^^^^^^^^^^^^^^^^^^^^^^^
- :doc:`RTP Session and Encapsulation </api/generated/pjmedia/group/group__PJMED__RTP>`
`(RFC 3350) <https://datatracker.ietf.org/doc/html/rfc3350>`_
(:rfc:`3350`)
- :doc:`RTCP Session and Encapsulation </api/generated/pjmedia/group/group__PJMED__RTCP>`
`(RFC 3350) <https://datatracker.ietf.org/doc/html/rfc3350>`_
(:rfc:`3350`)
- `RTP and RTCP multiplexing <https://github.com/pjsip/pjproject/issues/2087>`_
`(RFC 5761) <https://datatracker.ietf.org/doc/html/rfc5761>`_
(:rfc:`5761`)
- :doc:`RTCP Feedback mechanism </specific-guides/media/rtcp_fb>`
- :doc:`RTCP XR </api/generated/pjmedia/group/group__PJMED__RTCP__XR>`
`(RFC 3611) <https://datatracker.ietf.org/doc/html/rfc3611>`_
(:rfc:`3611`)
- `SSRC synchronization via SDP <https://github.com/pjsip/pjproject/issues/2098>`__
(:rfc:`5576`)
- `RTCP CNAME guideline <https://github.com/pjsip/pjproject/issues/2098>`__
Expand Down
1 change: 1 addition & 0 deletions docs/source/common/common_video_codec_list.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
- :ref:`amediacodec`
- :ref:`ffmpeg`
- :ref:`openh264`
- :ref:`native H.264 for Mac and iOS <videotoolbox>`
- :ref:`libvpx`

14 changes: 4 additions & 10 deletions docs/source/common/common_video_features.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,9 @@
- :ref:`guide_vidconf`
- :ref:`AVI streaming <avi_device>`
- Sending/receiving missing video keyframe indication using the following techniques:

* SIP INFO with XML Schema for Media Control (`RFC 5168 <https://datatracker.ietf.org/doc/html/rfc5168#section-7.1>`__), using:

- Full Intra Request (`RFC 5104 section 3.5.1 <https://datatracker.ietf.org/doc/html/rfc5104#section-3.5.1>`__)
- Picture Loss Indication feedback (`RFC 4585 section 6.3.1 <https://datatracker.ietf.org/doc/html/rfc4585#section-6.3.1>`__)
- See `issue #1234 <https://github.com/pjsip/pjproject/issues/1234>`__ for more info
- :ref:`Sending/receiving missing video keyframe indication <vid_key>`
- :doc:`Video source duplicator </api/generated/pjmedia/group/group__PJMEDIA__VID__TEE>`

* RTCP Picture Loss Indication feedback (`RFC 4585 section 6.3.1 <https://datatracker.ietf.org/doc/html/rfc4585#section-6.3.1>`__):

- See `issue #1437 <https://github.com/pjsip/pjproject/issues/1437>`__ for more info
.. tip::

- :doc:`Video source duplicator </api/generated/pjmedia/group/group__PJMEDIA__VID__TEE>`
See also :any:`Video User's Guide </specific-guides/video/video_users_guide>`
20 changes: 11 additions & 9 deletions docs/source/get-started/android/build_instructions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,19 +91,21 @@ Video Support
Features
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Video on Android will be supported since PJSIP version 2.4. It has the following
features:
Video on Android has been supported since PJSIP version 2.4. Some of the highlighted
features include:

* native capture
* native OpenGL ES 2.0 renderer (requires Android 2.2 (API level 8) or higher).
* H.264 codec (via OpenH264 library or AMediaCodec, see below)
* :ref:`native capture <android_cam>`
* :ref:`native OpenGL ES 2.0 renderer <opengl>` (requires Android 2.2 (API level 8) or higher).
* :ref:`native AMR-NB/WB codecs <amediacodec>`
* :ref:`native H264 AVC and VP8/VP9 codecs <amediacodec>`
* :ref:`openh264`

Requirements
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**OpenH264 (this is recommended if you need H264 codec)**
**OpenH264 (optional)**

#. For general information see :ref:`openh264`
#. For general information on OpenH264 integration see :ref:`openh264`
#. Copy all library .so files into your Android application project directory,
for example:

Expand All @@ -128,7 +130,7 @@ See :ref:`amediacodec`
Configuring
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

To enable video, append this into ``config_site.h``:
To enable video, append this into :any:`config_site.h`:

.. code-block:: c
Expand Down Expand Up @@ -181,7 +183,7 @@ in ``PjCameraInfo2`` before using the camera, e.g:
Using Video API
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Please check :doc:`Video User's Guide </pjsua2/using/media_video>`.
Please check :doc:`Working with Video </pjsua2/using/media_video>` (PJSUA2 Guide).

Video capture orientation support
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
6 changes: 3 additions & 3 deletions docs/source/get-started/android/issues.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Important Issue(s) when Developing Android Apps
Common issues when developing Android apps
***********************************************

* **Unable to Make or Receive Call (Problem with sending and receiving large (INVITE) requests over TCP)**

The issue is documented in :pr:`1488`. The solution is to try using port other
The issue is documented in :issue:`1488`. The solution is to try using port other
than 5060 in **both** client and server, and/or reducing the SIP message size.

* **Garbage Collector May Crash Your App (Pjsua2 API)**
Expand All @@ -22,7 +22,7 @@ Important Issue(s) when Developing Android Apps
Currently, the only workaround is to use PJSIP's Android JNI sound device instead
(one way to do this is by defining
``PJMEDIA_AUDIO_DEV_HAS_ANDROID_JNI`` to 1 and ``PJMEDIA_AUDIO_DEV_HAS_OPENSL`` to 0).
:c:macro:`PJMEDIA_AUDIO_DEV_HAS_ANDROID_JNI` to 1 and :c:macro:`PJMEDIA_AUDIO_DEV_HAS_OPENSL` to 0).

* **Bad audio recording quality on some devices**

Expand Down
8 changes: 5 additions & 3 deletions docs/source/get-started/guidelines-api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,13 @@ Let's have a look at the libraries architecture again:

PJSIP, PJMEDIA, and PJNATH Level
--------------------------------
At the lowest level we have the individual **C** libraries, which
At the lower level there are collection of **C** libraries, which
consist of :doc:`PJSIP </api/pjsip/index>`, :doc:`PJMEDIA </api/pjmedia/index>`, and
:doc:`PJNATH </api/pjnath/index>`, with :doc:`PJLIB-UTIL </api/pjlib-util/index>` and
:doc:`PJLIB </api/pjlib/index>` as support libraries. This level provides the most flexibility, but
it's also the hardest to use. The only reason you'd want to use this level is if:
it's also more low level.

Some of the reasons for wanting to use libraries at this level are:

#. You only need the individual library (say, PJNATH)
#. You need to be very very tight in footprint (say when things need to be measured in Kilobytes instead
Expand Down Expand Up @@ -78,7 +80,7 @@ information. Thanks to SWIG, other language bindings may be generated relatively
The PJSUA2 API for non-native code is effectively the same as PJSUA2 C++ API. You can peek at the
:doc:`Hello world </pjsua2/hello_world>` section to see how these look like. However, unlike C++,
you cannot access PJSUA-LIB and the underlying C libraries from the scripting language, hence you are
limited to what pjsua2 provides.
limited to what PJSUA2 provides.

You can use this API if native application development is not available in target platform (such as Android),
or if you prefer to develop with non-native code instead of C/C++.
12 changes: 8 additions & 4 deletions docs/source/get-started/guidelines-development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ Coding Style
Below is the PJSIP coding style. You need to follow it if you are submitting
patches to PJSIP:

* Indent by 4 characters and use spaces only.
* Indent by 4 characters and **use spaces only**.
* All public API in header file must be documented in Doxygen format.
* Use `K & R style <http://en.wikipedia.org/wiki/1_true_brace_style#K.26R_style>`__,
which is the only correct style anyway.

The PJSIP distribution includes an ``.editorconfig`` file to set indentation to
The PJSIP distribution includes an :source:`.editorconfig` file to set indentation to
4 spaces. Check https://editorconfig.org/ to see if your editor supports it or
if a plugin needs to be downloaded.

Expand All @@ -47,8 +47,12 @@ Deployment

config_site.h
---------------------
You need to create ``pjlib/include/pj/config_site.h`` file. This file contains compile-time
customizations for your application.
Depending on the platform, you may need to create ``pjlib/include/pj/config_site.h`` file.
This file contains compile-time customizations that are specific for your application, hence this
file is not included in PJSIP distribution.

If you're using GNU make build system, the ``./configure`` script will create an empty
``config_site.h`` if it doesn't exist.

It is recommended to start with default settings in :source:`pjlib/include/pj/config_site_sample.h`,
by including this file in your ``config_site.h``, i.e.:
Expand Down
12 changes: 9 additions & 3 deletions docs/source/get-started/guidelines-platform.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Detailed iPhone/iOS guide is in :doc:`Getting Started for iPhone/iOS </get-star

Windows Desktop
----------------
Windows is supported from Windows 2000 up to the recent Windows 10 and beyond. All features are expected
Windows is supported from Windows 2000 up to Windows 10 and beyond. All features are expected
to work. 64bit is supported. Development is based on Visual Studio. Considerations for
this platform include:

Expand Down Expand Up @@ -118,7 +118,8 @@ Symbian
-------
.. note::

Symbian is no longer supported
Symbian is no longer supported. For historical information see
https://trac.pjsip.org/repos/wiki/Getting-Started/Symbian

Symbian has been supported for a long time. In general all features (excluding video) are expected to
work, but we're not going to do Symbian specific development anymore. Other considerations for Symbian:
Expand All @@ -131,7 +132,7 @@ BlackBerry 10
-------------
.. note::

BB10 is no longer supported
BB10 is no longer supported. For historical information see https://trac.pjsip.org/repos/wiki/Getting-Started/BB10

BlackBerry 10 (BB10) is supported since PJSIP version 2.2. Some considerations for BB10 platform include:

Expand All @@ -141,6 +142,11 @@ BlackBerry 10 (BB10) is supported since PJSIP version 2.2. Some considerations f

Windows Mobile
--------------
.. note::

Windows Mobile is no longer supported. For historical information see
https://trac.pjsip.org/repos/wiki/Getting-Started/Windows-Mobile

This is the old Windows Mobile platform that is based on WinCE. This platform has been supported for a
long time. We expect all features except video to work, but there may be some errors every now and then
because this target is not actively maintained. No new development will be done for this platform.
Expand Down

0 comments on commit b34f23c

Please sign in to comment.