2009-03-13 18:43:16 +01:00
|
|
|
/*
|
2011-01-29 10:13:54 +01:00
|
|
|
* Copyright (C) 2003-2011 The Music Player Daemon Project
|
2009-03-13 18:43:16 +01:00
|
|
|
* http://www.musicpd.org
|
2008-08-26 08:27:06 +02:00
|
|
|
*
|
|
|
|
* 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.
|
2009-03-13 18:43:16 +01:00
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License along
|
|
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
2008-08-26 08:27:06 +02:00
|
|
|
*/
|
|
|
|
|
2008-10-31 09:19:53 +01:00
|
|
|
#ifndef MPD_AUDIO_FORMAT_H
|
|
|
|
#define MPD_AUDIO_FORMAT_H
|
2008-08-26 08:27:06 +02:00
|
|
|
|
2011-10-10 09:05:58 +02:00
|
|
|
#include <glib.h>
|
2008-09-29 15:53:53 +02:00
|
|
|
#include <stdint.h>
|
2008-10-08 11:03:39 +02:00
|
|
|
#include <stdbool.h>
|
2011-03-16 23:37:41 +01:00
|
|
|
#include <assert.h>
|
2008-08-26 08:27:06 +02:00
|
|
|
|
2009-11-10 17:11:34 +01:00
|
|
|
enum sample_format {
|
|
|
|
SAMPLE_FORMAT_UNDEFINED = 0,
|
|
|
|
|
|
|
|
SAMPLE_FORMAT_S8,
|
|
|
|
SAMPLE_FORMAT_S16,
|
|
|
|
|
2010-01-15 09:23:36 +01:00
|
|
|
/**
|
|
|
|
* Signed 24 bit integer samples, without padding.
|
|
|
|
*/
|
|
|
|
SAMPLE_FORMAT_S24,
|
|
|
|
|
2009-11-10 17:11:34 +01:00
|
|
|
/**
|
|
|
|
* Signed 24 bit integer samples, packed in 32 bit integers
|
|
|
|
* (the most significant byte is filled with the sign bit).
|
|
|
|
*/
|
|
|
|
SAMPLE_FORMAT_S24_P32,
|
|
|
|
|
|
|
|
SAMPLE_FORMAT_S32,
|
|
|
|
};
|
|
|
|
|
2011-10-04 20:41:05 +02:00
|
|
|
static const unsigned MAX_CHANNELS = 8;
|
|
|
|
|
2009-07-22 15:56:48 +02:00
|
|
|
/**
|
|
|
|
* This structure describes the format of a raw PCM stream.
|
|
|
|
*/
|
2008-09-07 19:19:55 +02:00
|
|
|
struct audio_format {
|
2009-07-22 15:56:48 +02:00
|
|
|
/**
|
|
|
|
* The sample rate in Hz. A better name for this attribute is
|
|
|
|
* "frame rate", because technically, you have two samples per
|
|
|
|
* frame in stereo sound.
|
|
|
|
*/
|
2008-10-10 14:40:54 +02:00
|
|
|
uint32_t sample_rate;
|
2009-07-22 15:56:48 +02:00
|
|
|
|
|
|
|
/**
|
2009-11-10 17:11:34 +01:00
|
|
|
* The format samples are stored in. See the #sample_format
|
|
|
|
* enum for valid values.
|
2009-07-22 15:56:48 +02:00
|
|
|
*/
|
2009-11-10 17:11:34 +01:00
|
|
|
uint8_t format;
|
2009-07-22 15:56:48 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* The number of channels. Only mono (1) and stereo (2) are
|
|
|
|
* fully supported currently.
|
|
|
|
*/
|
2008-10-10 14:03:33 +02:00
|
|
|
uint8_t channels;
|
2009-07-22 15:56:48 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* If zero, then samples are stored in host byte order. If
|
|
|
|
* nonzero, then samples are stored in the reverse host byte
|
|
|
|
* order.
|
|
|
|
*/
|
2011-10-10 09:14:01 +02:00
|
|
|
bool reverse_endian;
|
2008-09-07 19:19:55 +02:00
|
|
|
};
|
2008-08-26 08:27:06 +02:00
|
|
|
|
2009-11-10 17:57:14 +01:00
|
|
|
/**
|
|
|
|
* Buffer for audio_format_string().
|
|
|
|
*/
|
|
|
|
struct audio_format_string {
|
|
|
|
char buffer[24];
|
|
|
|
};
|
|
|
|
|
2009-07-22 15:56:48 +02:00
|
|
|
/**
|
|
|
|
* Clears the #audio_format object, i.e. sets all attributes to an
|
|
|
|
* undefined (invalid) value.
|
|
|
|
*/
|
2008-09-10 11:43:27 +02:00
|
|
|
static inline void audio_format_clear(struct audio_format *af)
|
|
|
|
{
|
2008-10-10 14:40:54 +02:00
|
|
|
af->sample_rate = 0;
|
2009-11-10 17:11:34 +01:00
|
|
|
af->format = SAMPLE_FORMAT_UNDEFINED;
|
2008-09-10 11:43:27 +02:00
|
|
|
af->channels = 0;
|
2011-10-10 09:14:01 +02:00
|
|
|
af->reverse_endian = false;
|
2008-09-10 11:43:27 +02:00
|
|
|
}
|
|
|
|
|
2009-07-22 15:56:48 +02:00
|
|
|
/**
|
|
|
|
* Initializes an #audio_format object, i.e. sets all
|
|
|
|
* attributes to valid values.
|
|
|
|
*/
|
2009-07-19 17:24:43 +02:00
|
|
|
static inline void audio_format_init(struct audio_format *af,
|
|
|
|
uint32_t sample_rate,
|
2009-11-10 17:11:34 +01:00
|
|
|
enum sample_format format, uint8_t channels)
|
2009-07-19 17:24:43 +02:00
|
|
|
{
|
|
|
|
af->sample_rate = sample_rate;
|
2009-11-10 17:11:34 +01:00
|
|
|
af->format = (uint8_t)format;
|
2009-07-19 17:24:43 +02:00
|
|
|
af->channels = channels;
|
2011-10-10 09:14:01 +02:00
|
|
|
af->reverse_endian = false;
|
2009-07-19 17:24:43 +02:00
|
|
|
}
|
|
|
|
|
2009-07-22 15:56:48 +02:00
|
|
|
/**
|
|
|
|
* Checks whether the specified #audio_format object has a defined
|
|
|
|
* value.
|
|
|
|
*/
|
2008-10-08 11:03:39 +02:00
|
|
|
static inline bool audio_format_defined(const struct audio_format *af)
|
2008-09-10 11:43:27 +02:00
|
|
|
{
|
2008-10-10 14:40:54 +02:00
|
|
|
return af->sample_rate != 0;
|
2008-09-10 11:43:27 +02:00
|
|
|
}
|
|
|
|
|
2009-10-21 23:01:04 +02:00
|
|
|
/**
|
|
|
|
* Checks whether the specified #audio_format object is full, i.e. all
|
|
|
|
* attributes are defined. This is more complete than
|
|
|
|
* audio_format_defined(), but slower.
|
|
|
|
*/
|
|
|
|
static inline bool
|
|
|
|
audio_format_fully_defined(const struct audio_format *af)
|
|
|
|
{
|
2009-11-10 17:11:34 +01:00
|
|
|
return af->sample_rate != 0 && af->format != SAMPLE_FORMAT_UNDEFINED &&
|
|
|
|
af->channels != 0;
|
2009-10-21 23:01:04 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Checks whether the specified #audio_format object has at least one
|
|
|
|
* defined value.
|
|
|
|
*/
|
|
|
|
static inline bool
|
|
|
|
audio_format_mask_defined(const struct audio_format *af)
|
|
|
|
{
|
2009-11-10 17:11:34 +01:00
|
|
|
return af->sample_rate != 0 || af->format != SAMPLE_FORMAT_UNDEFINED ||
|
|
|
|
af->channels != 0;
|
2009-10-21 23:01:04 +02:00
|
|
|
}
|
|
|
|
|
2009-02-11 18:00:48 +01:00
|
|
|
/**
|
|
|
|
* Checks whether the sample rate is valid.
|
|
|
|
*
|
|
|
|
* @param sample_rate the sample rate in Hz
|
|
|
|
*/
|
|
|
|
static inline bool
|
|
|
|
audio_valid_sample_rate(unsigned sample_rate)
|
|
|
|
{
|
|
|
|
return sample_rate > 0 && sample_rate < (1 << 30);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Checks whether the sample format is valid.
|
|
|
|
*
|
|
|
|
* @param bits the number of significant bits per sample
|
|
|
|
*/
|
|
|
|
static inline bool
|
2009-11-10 17:11:34 +01:00
|
|
|
audio_valid_sample_format(enum sample_format format)
|
2009-02-11 18:00:48 +01:00
|
|
|
{
|
2009-11-10 17:11:34 +01:00
|
|
|
switch (format) {
|
|
|
|
case SAMPLE_FORMAT_S8:
|
|
|
|
case SAMPLE_FORMAT_S16:
|
2010-01-15 09:23:36 +01:00
|
|
|
case SAMPLE_FORMAT_S24:
|
2009-11-10 17:11:34 +01:00
|
|
|
case SAMPLE_FORMAT_S24_P32:
|
|
|
|
case SAMPLE_FORMAT_S32:
|
|
|
|
return true;
|
|
|
|
|
|
|
|
case SAMPLE_FORMAT_UNDEFINED:
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
|
|
|
return false;
|
2009-02-11 18:00:48 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Checks whether the number of channels is valid.
|
|
|
|
*/
|
|
|
|
static inline bool
|
|
|
|
audio_valid_channel_count(unsigned channels)
|
|
|
|
{
|
2011-10-04 20:41:05 +02:00
|
|
|
return channels >= 1 && channels <= MAX_CHANNELS;
|
2009-02-11 18:00:48 +01:00
|
|
|
}
|
|
|
|
|
2008-11-21 20:27:05 +01:00
|
|
|
/**
|
|
|
|
* Returns false if the format is not valid for playback with MPD.
|
|
|
|
* This function performs some basic validity checks.
|
|
|
|
*/
|
2011-10-10 09:05:58 +02:00
|
|
|
G_GNUC_PURE
|
2008-11-21 20:27:05 +01:00
|
|
|
static inline bool audio_format_valid(const struct audio_format *af)
|
|
|
|
{
|
2009-02-11 18:00:48 +01:00
|
|
|
return audio_valid_sample_rate(af->sample_rate) &&
|
2009-11-10 17:11:34 +01:00
|
|
|
audio_valid_sample_format((enum sample_format)af->format) &&
|
2009-02-11 18:00:48 +01:00
|
|
|
audio_valid_channel_count(af->channels);
|
2008-11-21 20:27:05 +01:00
|
|
|
}
|
|
|
|
|
2009-10-21 23:01:04 +02:00
|
|
|
/**
|
|
|
|
* Returns false if the format mask is not valid for playback with
|
|
|
|
* MPD. This function performs some basic validity checks.
|
|
|
|
*/
|
2011-10-10 09:05:58 +02:00
|
|
|
G_GNUC_PURE
|
2009-10-21 23:01:04 +02:00
|
|
|
static inline bool audio_format_mask_valid(const struct audio_format *af)
|
|
|
|
{
|
|
|
|
return (af->sample_rate == 0 ||
|
|
|
|
audio_valid_sample_rate(af->sample_rate)) &&
|
2009-11-10 17:11:34 +01:00
|
|
|
(af->format == SAMPLE_FORMAT_UNDEFINED ||
|
|
|
|
audio_valid_sample_format((enum sample_format)af->format)) &&
|
2009-10-21 23:01:04 +02:00
|
|
|
(af->channels == 0 || audio_valid_channel_count(af->channels));
|
|
|
|
}
|
|
|
|
|
2008-10-08 11:03:39 +02:00
|
|
|
static inline bool audio_format_equals(const struct audio_format *a,
|
|
|
|
const struct audio_format *b)
|
2008-09-09 10:05:15 +02:00
|
|
|
{
|
2008-10-10 14:40:54 +02:00
|
|
|
return a->sample_rate == b->sample_rate &&
|
2009-11-10 17:11:34 +01:00
|
|
|
a->format == b->format &&
|
2009-07-19 17:42:19 +02:00
|
|
|
a->channels == b->channels &&
|
|
|
|
a->reverse_endian == b->reverse_endian;
|
2008-09-09 10:05:15 +02:00
|
|
|
}
|
|
|
|
|
2011-10-10 09:06:28 +02:00
|
|
|
void
|
2009-10-21 23:01:04 +02:00
|
|
|
audio_format_mask_apply(struct audio_format *af,
|
2011-10-10 09:06:28 +02:00
|
|
|
const struct audio_format *mask);
|
2009-10-21 23:01:04 +02:00
|
|
|
|
2011-10-10 09:05:58 +02:00
|
|
|
G_GNUC_CONST
|
2011-10-08 15:03:43 +02:00
|
|
|
static inline unsigned
|
|
|
|
sample_format_size(enum sample_format format)
|
2008-09-23 23:59:54 +02:00
|
|
|
{
|
2011-10-08 15:03:43 +02:00
|
|
|
switch (format) {
|
2009-11-10 17:11:34 +01:00
|
|
|
case SAMPLE_FORMAT_S8:
|
2008-09-23 23:59:54 +02:00
|
|
|
return 1;
|
2009-11-10 17:11:34 +01:00
|
|
|
|
|
|
|
case SAMPLE_FORMAT_S16:
|
2008-09-23 23:59:54 +02:00
|
|
|
return 2;
|
2009-11-10 17:11:34 +01:00
|
|
|
|
2010-01-15 09:23:36 +01:00
|
|
|
case SAMPLE_FORMAT_S24:
|
|
|
|
return 3;
|
|
|
|
|
2009-11-10 17:11:34 +01:00
|
|
|
case SAMPLE_FORMAT_S24_P32:
|
|
|
|
case SAMPLE_FORMAT_S32:
|
2008-09-23 23:59:54 +02:00
|
|
|
return 4;
|
2009-11-10 17:11:34 +01:00
|
|
|
|
|
|
|
case SAMPLE_FORMAT_UNDEFINED:
|
2011-10-08 15:03:43 +02:00
|
|
|
return 0;
|
2009-11-10 17:11:34 +01:00
|
|
|
}
|
|
|
|
|
2011-10-08 15:03:43 +02:00
|
|
|
assert(false);
|
2009-11-10 17:11:34 +01:00
|
|
|
return 0;
|
2008-09-23 23:59:54 +02:00
|
|
|
}
|
|
|
|
|
2011-10-08 15:03:43 +02:00
|
|
|
/**
|
|
|
|
* Returns the size of each (mono) sample in bytes.
|
|
|
|
*/
|
2011-10-10 09:05:58 +02:00
|
|
|
G_GNUC_PURE
|
2011-10-08 15:03:43 +02:00
|
|
|
static inline unsigned audio_format_sample_size(const struct audio_format *af)
|
|
|
|
{
|
|
|
|
return sample_format_size((enum sample_format)af->format);
|
|
|
|
}
|
|
|
|
|
2009-07-22 15:56:48 +02:00
|
|
|
/**
|
|
|
|
* Returns the size of each full frame in bytes.
|
|
|
|
*/
|
2011-10-10 09:05:58 +02:00
|
|
|
G_GNUC_PURE
|
2008-10-10 14:41:37 +02:00
|
|
|
static inline unsigned
|
|
|
|
audio_format_frame_size(const struct audio_format *af)
|
|
|
|
{
|
|
|
|
return audio_format_sample_size(af) * af->channels;
|
|
|
|
}
|
|
|
|
|
2009-07-22 15:56:48 +02:00
|
|
|
/**
|
|
|
|
* Returns the floating point factor which converts a time span to a
|
|
|
|
* storage size in bytes.
|
|
|
|
*/
|
2011-10-10 09:05:58 +02:00
|
|
|
G_GNUC_PURE
|
2008-09-07 19:19:55 +02:00
|
|
|
static inline double audio_format_time_to_size(const struct audio_format *af)
|
2008-08-26 08:27:09 +02:00
|
|
|
{
|
2008-10-10 14:41:37 +02:00
|
|
|
return af->sample_rate * audio_format_frame_size(af);
|
2008-08-26 08:27:09 +02:00
|
|
|
}
|
|
|
|
|
2009-11-10 17:11:34 +01:00
|
|
|
/**
|
|
|
|
* Renders a #sample_format enum into a string, e.g. for printing it
|
|
|
|
* in a log file.
|
|
|
|
*
|
|
|
|
* @param format a #sample_format enum value
|
|
|
|
* @return the string
|
|
|
|
*/
|
2011-10-10 09:05:58 +02:00
|
|
|
G_GNUC_PURE G_GNUC_MALLOC
|
2009-11-10 17:11:34 +01:00
|
|
|
const char *
|
|
|
|
sample_format_to_string(enum sample_format format);
|
|
|
|
|
2009-11-10 17:57:14 +01:00
|
|
|
/**
|
|
|
|
* Renders the #audio_format object into a string, e.g. for printing
|
|
|
|
* it in a log file.
|
|
|
|
*
|
|
|
|
* @param af the #audio_format object
|
|
|
|
* @param s a buffer to print into
|
|
|
|
* @return the string, or NULL if the #audio_format object is invalid
|
|
|
|
*/
|
2011-10-10 09:05:58 +02:00
|
|
|
G_GNUC_PURE G_GNUC_MALLOC
|
2009-11-10 17:57:14 +01:00
|
|
|
const char *
|
|
|
|
audio_format_to_string(const struct audio_format *af,
|
|
|
|
struct audio_format_string *s);
|
|
|
|
|
2008-08-26 08:27:06 +02:00
|
|
|
#endif
|