mirror of
https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git
synced 2025-11-09 13:29:59 -05:00
5effc83479
FSF addresses used in PA sources are no longer valid and rpmlint generates numerous warnings during packaging because of this. This patch changes all FSF addresses to FSF web page according to the GPL how-to: https://www.gnu.org/licenses/gpl-howto.en.html Done automatically by sed-ing through sources.
79 lines
4 KiB
C
79 lines
4 KiB
C
#ifndef foocoreformathfoo
|
|
#define foocoreformathfoo
|
|
|
|
/***
|
|
This file is part of PulseAudio.
|
|
|
|
PulseAudio is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU Lesser General Public License as published
|
|
by the Free Software Foundation; either version 2.1 of the License,
|
|
or (at your option) any later version.
|
|
|
|
PulseAudio is distributed in the hope that it will be useful, but
|
|
WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public License
|
|
along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
|
|
***/
|
|
|
|
#include <pulse/format.h>
|
|
|
|
#include <stdbool.h>
|
|
|
|
/* Gets the sample format stored in the format info. Returns a negative error
|
|
* code on failure. If the sample format property is not set at all, returns
|
|
* -PA_ERR_NOENTITY. */
|
|
int pa_format_info_get_sample_format(const pa_format_info *f, pa_sample_format_t *sf);
|
|
|
|
/* Gets the sample rate stored in the format info. Returns a negative error
|
|
* code on failure. If the sample rate property is not set at all, returns
|
|
* -PA_ERR_NOENTITY. */
|
|
int pa_format_info_get_rate(const pa_format_info *f, uint32_t *rate);
|
|
|
|
/* Gets the channel count stored in the format info. Returns a negative error
|
|
* code on failure. If the channels property is not set at all, returns
|
|
* -PA_ERR_NOENTITY. */
|
|
int pa_format_info_get_channels(const pa_format_info *f, uint8_t *channels);
|
|
|
|
/* Gets the channel map stored in the format info. Returns a negative error
|
|
* code on failure. If the channel map property is not set at all, returns
|
|
* -PA_ERR_NOENTITY. */
|
|
int pa_format_info_get_channel_map(const pa_format_info *f, pa_channel_map *map);
|
|
|
|
/* Convert a sample spec and an optional channel map to a new PCM format info
|
|
* object (remember to free it). If map is NULL, then the channel map will be
|
|
* left unspecified. If some fields of the sample spec should be ignored, pass
|
|
* false for set_format, set_rate and set_channels as appropriate, then those
|
|
* fields will be left unspecified. This function returns NULL if the input is
|
|
* invalid (for example, setting the sample rate was requested, but the rate
|
|
* in ss is invalid).
|
|
*
|
|
* pa_format_info_from_sample_spec() exists too. This "version 2" was created,
|
|
* because the original function doesn't provide the possibility of ignoring
|
|
* some of the sample spec fields. That functionality can't be added to the
|
|
* original function, because the function is a part of the public API and
|
|
* adding parameters to it would break the API. */
|
|
pa_format_info *pa_format_info_from_sample_spec2(const pa_sample_spec *ss, const pa_channel_map *map, bool set_format,
|
|
bool set_rate, bool set_channels);
|
|
|
|
/* Convert the format info into a sample spec and a channel map. If the format
|
|
* info doesn't contain some information, the fallback sample spec and channel
|
|
* map are used to populate the output.
|
|
*
|
|
* pa_format_info_to_sample_spec() exists too. This "version 2" was created,
|
|
* because the original function doesn't provide the possibility of specifying
|
|
* a fallback sample spec and channel map. That functionality can't be added to
|
|
* the original function, because the function is part of the public API and
|
|
* adding parameters to it would break the API. */
|
|
int pa_format_info_to_sample_spec2(const pa_format_info *f, pa_sample_spec *ss, pa_channel_map *map,
|
|
const pa_sample_spec *fallback_ss, const pa_channel_map *fallback_map);
|
|
|
|
/* For compressed formats. Converts the format info into a sample spec and a
|
|
* channel map that an ALSA device can use as its configuration parameters when
|
|
* playing back the compressed data. That is, the returned sample spec doesn't
|
|
* describe the audio content, but the device parameters. */
|
|
int pa_format_info_to_sample_spec_fake(const pa_format_info *f, pa_sample_spec *ss, pa_channel_map *map);
|
|
|
|
#endif
|