Point to SupportedAudioFormats wiki page where appropriate

I documented the supported PCM sample formats and compressed audio
encodings in the wiki, let's add some pointers to the new documentation.
This commit is contained in:
Tanu Kaskinen 2020-04-16 18:27:48 +03:00
parent 743fa02c5f
commit 36a4923f9b
6 changed files with 26 additions and 30 deletions

View file

@ -116,18 +116,9 @@ License along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
<p><opt>--format</opt><arg>=FORMAT</arg></p> <p><opt>--format</opt><arg>=FORMAT</arg></p>
<optdesc><p>Capture or play back audio with the specified sample <optdesc><p>Capture or play back audio with the specified sample
format. Specify one of <opt>u8</opt>, <opt>s16le</opt>, format. See
<opt>s16be</opt>, <opt>s32le</opt>, <opt>s32be</opt>, https://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/SupportedAudioFormats/
<opt>float32le</opt>, <opt>float32be</opt>, <opt>ulaw</opt>, for supported values. Defaults to s16ne.</p></optdesc>
<opt>alaw</opt>, <opt>s32le</opt>, <opt>s32be</opt>,
<opt>s24le</opt>, <opt>s24be</opt>, <opt>s24-32le</opt>,
<opt>s24-32be</opt>. Depending on the endianness of the CPU the
formats <opt>s16ne</opt>, <opt>s16re</opt>, <opt>s32ne</opt>,
<opt>s32re</opt>, <opt>float32ne</opt>, <opt>float32re</opt>,
<opt>s32ne</opt>, <opt>s32re</opt>, <opt>s24ne</opt>,
<opt>s24re</opt>, <opt>s24-32ne</opt>, <opt>s24-32re</opt> (for
native, resp. reverse endian) are available as aliases. Defaults
to s16ne.</p></optdesc>
</option> </option>
<option> <option>

View file

@ -243,11 +243,15 @@ License along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
<option> <option>
<p><opt>set-sink-formats</opt> <arg>SINK</arg> <arg>FORMATS</arg></p> <p><opt>set-sink-formats</opt> <arg>SINK</arg> <arg>FORMATS</arg></p>
<optdesc><p>Set the supported formats of the specified sink (identified by its numerical index) if supported by the sink. <optdesc><p>Set the supported formats of the specified sink (identified
<arg>FORMATS</arg> is specified as a semi-colon (;) separated list of formats in the form by its numerical index) if supported by the sink. <arg>FORMATS</arg> is
'encoding[, key1=value1, key2=value2, ...]' (for example, AC3 at 32000, 44100 and 48000 Hz would be specified as specified as a semi-colon (;) separated list of formats in the form
'ac3-iec61937, format.rate = "[ 32000, 44100, 48000 ]"'). 'encoding[, key1=value1, key2=value2, ...]' (for example, AC3 at 32000,
</p></optdesc> </option> 44100 and 48000 Hz would be specified as
'ac3-iec61937, format.rate = "[ 32000, 44100, 48000 ]"'). See
https://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/SupportedAudioFormats/
for possible encodings. </p></optdesc>
</option>
<option> <option>
<p><opt>subscribe</opt></p> <p><opt>subscribe</opt></p>

View file

@ -490,16 +490,9 @@ License along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
<option> <option>
<p><opt>default-sample-format=</opt> The default sampling <p><opt>default-sample-format=</opt> The default sampling
format. Specify one of <opt>u8</opt>, <opt>s16le</opt>, format. See
<opt>s16be</opt>, <opt>s24le</opt>, <opt>s24be</opt>, https://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/SupportedAudioFormats/
<opt>s24-32le</opt>, <opt>s24-32be</opt>, <opt>s32le</opt>, for possible values.</p>
<opt>s32be</opt>, <opt>float32le</opt>, <opt>float32be</opt>,
<opt>ulaw</opt>, <opt>alaw</opt>. Depending on the endianness of
the CPU the formats <opt>s16ne</opt>, <opt>s16re</opt>,
<opt>s24ne</opt>, <opt>s24re</opt>, <opt>s24-32ne</opt>,
<opt>s24-32re</opt>, <opt>s32ne</opt>, <opt>s32re</opt>,
<opt>float32ne</opt>, <opt>float32re</opt> (for native,
resp. reverse endian) are available as aliases.</p>
</option> </option>
<option> <option>

View file

@ -62,6 +62,10 @@ typedef enum pa_encoding {
PA_ENCODING_DTSHD_IEC61937, PA_ENCODING_DTSHD_IEC61937,
/**< DTS-HD Master Audio encapsulated in IEC 61937 header/padding. \since 13.0 */ /**< DTS-HD Master Audio encapsulated in IEC 61937 header/padding. \since 13.0 */
/* Remeber to update
* https://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/SupportedAudioFormats/
* when adding new encodings! */
PA_ENCODING_MAX, PA_ENCODING_MAX,
/**< Valid encoding types must be less than this value */ /**< Valid encoding types must be less than this value */

View file

@ -171,6 +171,10 @@ typedef enum pa_sample_format {
PA_SAMPLE_S24_32BE, PA_SAMPLE_S24_32BE,
/**< Signed 24 Bit PCM in LSB of 32 Bit words, big endian. \since 0.9.15 */ /**< Signed 24 Bit PCM in LSB of 32 Bit words, big endian. \since 0.9.15 */
/* Remeber to update
* https://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/SupportedAudioFormats/
* when adding new formats! */
PA_SAMPLE_MAX, PA_SAMPLE_MAX,
/**< Upper limit of valid sample types */ /**< Upper limit of valid sample types */

View file

@ -686,9 +686,9 @@ static void help(const char *argv0) {
" --stream-name=NAME How to call this stream on the server\n" " --stream-name=NAME How to call this stream on the server\n"
" --volume=VOLUME Specify the initial (linear) volume in range 0...65536\n" " --volume=VOLUME Specify the initial (linear) volume in range 0...65536\n"
" --rate=SAMPLERATE The sample rate in Hz (defaults to 44100)\n" " --rate=SAMPLERATE The sample rate in Hz (defaults to 44100)\n"
" --format=SAMPLEFORMAT The sample type, one of s16le, s16be, u8, float32le,\n" " --format=SAMPLEFORMAT The sample format, see\n"
" float32be, ulaw, alaw, s32le, s32be, s24le, s24be,\n" " https://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/SupportedAudioFormats/\n"
" s24-32le, s24-32be (defaults to s16ne)\n" " for possible values (defaults to s16ne)\n"
" --channels=CHANNELS The number of channels, 1 for mono, 2 for stereo\n" " --channels=CHANNELS The number of channels, 1 for mono, 2 for stereo\n"
" (defaults to 2)\n" " (defaults to 2)\n"
" --channel-map=CHANNELMAP Channel map to use instead of the default\n" " --channel-map=CHANNELMAP Channel map to use instead of the default\n"