mirror of
https://github.com/obsproject/obs-studio.git
synced 2024-09-20 13:08:50 +02:00
41fad2d1a4
This Fixes a minor flaw with the API where data had to always be mutable to be usable by the API. Functions that do not modify the fundamental underlying data of a structure should be marked as constant, both for safety and to signify that the parameter is input only and will not be modified by the function using it.
200 lines
5.1 KiB
C
200 lines
5.1 KiB
C
/******************************************************************************
|
|
Copyright (C) 2013 by Hugh Bailey <obs.jim@gmail.com>
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 2 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program 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 General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
******************************************************************************/
|
|
|
|
#pragma once
|
|
|
|
#include "media-io-defs.h"
|
|
#include "../util/c99defs.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*
|
|
* Base audio output component. Use this to create an audio output track
|
|
* for the media.
|
|
*/
|
|
|
|
struct audio_output;
|
|
struct audio_line;
|
|
typedef struct audio_output audio_t;
|
|
typedef struct audio_line audio_line_t;
|
|
|
|
enum audio_format {
|
|
AUDIO_FORMAT_UNKNOWN,
|
|
|
|
AUDIO_FORMAT_U8BIT,
|
|
AUDIO_FORMAT_16BIT,
|
|
AUDIO_FORMAT_32BIT,
|
|
AUDIO_FORMAT_FLOAT,
|
|
|
|
AUDIO_FORMAT_U8BIT_PLANAR,
|
|
AUDIO_FORMAT_16BIT_PLANAR,
|
|
AUDIO_FORMAT_32BIT_PLANAR,
|
|
AUDIO_FORMAT_FLOAT_PLANAR,
|
|
};
|
|
|
|
enum speaker_layout {
|
|
SPEAKERS_UNKNOWN,
|
|
SPEAKERS_MONO,
|
|
SPEAKERS_STEREO,
|
|
SPEAKERS_2POINT1,
|
|
SPEAKERS_QUAD,
|
|
SPEAKERS_4POINT1,
|
|
SPEAKERS_5POINT1,
|
|
SPEAKERS_5POINT1_SURROUND,
|
|
SPEAKERS_7POINT1,
|
|
SPEAKERS_7POINT1_SURROUND,
|
|
SPEAKERS_SURROUND,
|
|
};
|
|
|
|
struct audio_data {
|
|
uint8_t *data[MAX_AV_PLANES];
|
|
uint32_t frames;
|
|
uint64_t timestamp;
|
|
float volume;
|
|
};
|
|
|
|
struct audio_output_info {
|
|
const char *name;
|
|
|
|
uint32_t samples_per_sec;
|
|
enum audio_format format;
|
|
enum speaker_layout speakers;
|
|
uint64_t buffer_ms;
|
|
};
|
|
|
|
struct audio_convert_info {
|
|
uint32_t samples_per_sec;
|
|
enum audio_format format;
|
|
enum speaker_layout speakers;
|
|
};
|
|
|
|
static inline uint32_t get_audio_channels(enum speaker_layout speakers)
|
|
{
|
|
switch (speakers) {
|
|
case SPEAKERS_MONO: return 1;
|
|
case SPEAKERS_STEREO: return 2;
|
|
case SPEAKERS_2POINT1: return 3;
|
|
case SPEAKERS_SURROUND:
|
|
case SPEAKERS_QUAD: return 4;
|
|
case SPEAKERS_4POINT1: return 5;
|
|
case SPEAKERS_5POINT1:
|
|
case SPEAKERS_5POINT1_SURROUND: return 6;
|
|
case SPEAKERS_7POINT1: return 8;
|
|
case SPEAKERS_7POINT1_SURROUND: return 8;
|
|
case SPEAKERS_UNKNOWN: return 0;
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
static inline size_t get_audio_bytes_per_channel(enum audio_format format)
|
|
{
|
|
switch (format) {
|
|
case AUDIO_FORMAT_U8BIT:
|
|
case AUDIO_FORMAT_U8BIT_PLANAR:
|
|
return 1;
|
|
|
|
case AUDIO_FORMAT_16BIT:
|
|
case AUDIO_FORMAT_16BIT_PLANAR:
|
|
return 2;
|
|
|
|
case AUDIO_FORMAT_FLOAT:
|
|
case AUDIO_FORMAT_FLOAT_PLANAR:
|
|
case AUDIO_FORMAT_32BIT:
|
|
case AUDIO_FORMAT_32BIT_PLANAR:
|
|
return 4;
|
|
|
|
case AUDIO_FORMAT_UNKNOWN:
|
|
return 0;
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
static inline bool is_audio_planar(enum audio_format format)
|
|
{
|
|
switch (format) {
|
|
case AUDIO_FORMAT_U8BIT:
|
|
case AUDIO_FORMAT_16BIT:
|
|
case AUDIO_FORMAT_32BIT:
|
|
case AUDIO_FORMAT_FLOAT:
|
|
return false;
|
|
|
|
case AUDIO_FORMAT_U8BIT_PLANAR:
|
|
case AUDIO_FORMAT_FLOAT_PLANAR:
|
|
case AUDIO_FORMAT_16BIT_PLANAR:
|
|
case AUDIO_FORMAT_32BIT_PLANAR:
|
|
return true;
|
|
|
|
case AUDIO_FORMAT_UNKNOWN:
|
|
return false;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
static inline size_t get_audio_planes(enum audio_format format,
|
|
enum speaker_layout speakers)
|
|
{
|
|
return (is_audio_planar(format) ? get_audio_channels(speakers) : 1);
|
|
}
|
|
|
|
static inline size_t get_audio_size(enum audio_format format,
|
|
enum speaker_layout speakers, uint32_t frames)
|
|
{
|
|
bool planar = is_audio_planar(format);
|
|
|
|
return (planar ? 1 : get_audio_channels(speakers)) *
|
|
get_audio_bytes_per_channel(format) *
|
|
frames;
|
|
}
|
|
|
|
#define AUDIO_OUTPUT_SUCCESS 0
|
|
#define AUDIO_OUTPUT_INVALIDPARAM -1
|
|
#define AUDIO_OUTPUT_FAIL -2
|
|
|
|
EXPORT int audio_output_open(audio_t **audio, struct audio_output_info *info);
|
|
EXPORT void audio_output_close(audio_t *audio);
|
|
|
|
EXPORT bool audio_output_connect(audio_t *video,
|
|
const struct audio_convert_info *conversion,
|
|
void (*callback)(void *param, struct audio_data *data),
|
|
void *param);
|
|
EXPORT void audio_output_disconnect(audio_t *video,
|
|
void (*callback)(void *param, struct audio_data *data),
|
|
void *param);
|
|
|
|
EXPORT bool audio_output_active(const audio_t *audio);
|
|
|
|
EXPORT size_t audio_output_get_block_size(const audio_t *audio);
|
|
EXPORT size_t audio_output_get_planes(const audio_t *audio);
|
|
EXPORT size_t audio_output_get_channels(const audio_t *audio);
|
|
EXPORT uint32_t audio_output_get_sample_rate(const audio_t *audio);
|
|
EXPORT const struct audio_output_info *audio_output_get_info(
|
|
const audio_t *audio);
|
|
|
|
EXPORT audio_line_t *audio_output_create_line(audio_t *audio, const char *name);
|
|
EXPORT void audio_line_destroy(audio_line_t *line);
|
|
EXPORT void audio_line_output(audio_line_t *line, const struct audio_data *data);
|
|
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|