audio_check: checker functions for audio_format attributes

These functions are a wrapper for audio_valid_X().  On error, they
return a GError object.

4 files changed, 138 insertions, 12 deletions

diff --git a/Makefile.am b/Makefile.am
index 72e3a534..a61621b5 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -34,6 +34,7 @@ mpd_headers = \
 	src/ack.h \
 	src/audio.h \
 	src/audio_format.h \
+	src/audio_check.h \
 	src/audio_parser.h \
 	src/output_internal.h \
 	src/output_api.h \
@@ -207,6 +208,7 @@ src_mpd_SOURCES = \
 	$(FILTER_SRC) \
 	src/notify.c \
 	src/audio.c \
+	src/audio_check.c \
 	src/audio_parser.c \
 	src/command.c \
 	src/idle.c \
@@ -823,6 +825,7 @@ test_run_filter_SOURCES = test/run_filter.c \
 	src/pcm_volume.c src/pcm_convert.c src/pcm_byteswap.c \
 	src/pcm_format.c src/pcm_channels.c src/pcm_dither.c \
 	src/pcm_resample.c src/pcm_resample_fallback.c \
+	src/audio_check.c \
 	src/audio_parser.c \
 	$(FILTER_SRC)
 
@@ -836,6 +839,7 @@ test_run_encoder_SOURCES = test/run_encoder.c \
 	src/conf.c src/tokenizer.c \
 	src/utils.c \
 	src/tag.c src/tag_pool.c \
+	src/audio_check.c \
 	src/audio_parser.c \
 	$(ENCODER_SRC)
 test_run_encoder_LDADD = $(MPD_LIBS) \
@@ -844,6 +848,7 @@ test_run_encoder_LDADD = $(MPD_LIBS) \
 endif
 
 test_software_volume_SOURCES = test/software_volume.c \
+	src/audio_check.c \
 	src/audio_parser.c \
 	src/pcm_volume.c
 test_software_volume_LDADD = \
@@ -858,6 +863,7 @@ test_run_output_LDADD = $(MPD_LIBS) \
 	$(GLIB_LIBS)
 test_run_output_SOURCES = test/run_output.c \
 	src/conf.c src/tokenizer.c src/utils.c src/log.c \
+	src/audio_check.c \
 	src/audio_parser.c \
 	src/timer.c \
 	src/tag.c src/tag_pool.c \
diff --git a/src/audio_check.c b/src/audio_check.c
new file mode 100644
index 00000000..4046e886
--- /dev/null
+++ b/src/audio_check.c
@@ -0,0 +1,74 @@
+/*
+ * Copyright (C) 2003-2009 The Music Player Daemon Project
+ * http://www.musicpd.org
+ *
+ * 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, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#include "audio_check.h"
+#include "audio_format.h"
+
+#include <assert.h>
+
+bool
+audio_check_sample_rate(unsigned long sample_rate, GError **error_r)
+{
+	if (!audio_valid_sample_rate(sample_rate)) {
+		g_set_error(error_r, audio_format_quark(), 0,
+			    "Invalid sample rate: %lu", sample_rate);
+		return false;
+	}
+
+	return true;
+}
+
+bool
+audio_check_sample_format(unsigned sample_format, GError **error_r)
+{
+	if (!audio_valid_sample_format(sample_format)) {
+		g_set_error(error_r, audio_format_quark(), 0,
+			    "Invalid sample format: %u", sample_format);
+		return false;
+	}
+
+	return true;
+}
+
+bool
+audio_check_channel_count(unsigned channels, GError **error_r)
+{
+	if (!audio_valid_channel_count(channels)) {
+		g_set_error(error_r, audio_format_quark(), 0,
+			    "Invalid channel count: %u", channels);
+		return false;
+	}
+
+	return true;
+}
+
+bool
+audio_format_init_checked(struct audio_format *af, unsigned long sample_rate,
+			  unsigned sample_format, unsigned channels,
+			  GError **error_r)
+{
+	if (audio_check_sample_rate(sample_rate, error_r) &&
+	    audio_check_sample_format(sample_format, error_r) &&
+	    audio_check_channel_count(channels, error_r)) {
+		audio_format_init(af, sample_rate, sample_format, channels);
+		assert(audio_format_valid(af));
+		return true;
+	} else
+		return false;
+}
diff --git a/src/audio_check.h b/src/audio_check.h
new file mode 100644
index 00000000..a11fbe3d
--- /dev/null
+++ b/src/audio_check.h
@@ -0,0 +1,54 @@
+/*
+ * Copyright (C) 2003-2009 The Music Player Daemon Project
+ * http://www.musicpd.org
+ *
+ * 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, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#ifndef MPD_AUDIO_CHECK_H
+#define MPD_AUDIO_CHECK_H
+
+#include <glib.h>
+#include <stdbool.h>
+
+struct audio_format;
+
+/**
+ * The GLib quark used for errors reported by this library.
+ */
+static inline GQuark
+audio_format_quark(void)
+{
+	return g_quark_from_static_string("audio_format");
+}
+
+bool
+audio_check_sample_rate(unsigned long sample_rate, GError **error_r);
+
+bool
+audio_check_sample_format(unsigned sample_format, GError **error_r);
+
+bool
+audio_check_channel_count(unsigned sample_format, GError **error_r);
+
+/**
+ * Wrapper for audio_format_init(), which checks all attributes.
+ */
+bool
+audio_format_init_checked(struct audio_format *af, unsigned long sample_rate,
+			  unsigned sample_format, unsigned channels,
+			  GError **error_r);
+
+#endif
diff --git a/src/audio_parser.c b/src/audio_parser.c
index 5795c35d..df87be32 100644
--- a/src/audio_parser.c
+++ b/src/audio_parser.c
@@ -25,6 +25,7 @@
 #include "config.h"
 #include "audio_parser.h"
 #include "audio_format.h"
+#include "audio_check.h"
 
 #include <stdlib.h>
 
@@ -55,11 +56,8 @@ parse_sample_rate(const char *src, bool mask, uint32_t *sample_rate_r,
 		g_set_error(error_r, audio_parser_quark(), 0,
 			    "Failed to parse the sample rate");
 		return false;
-	} else if (!audio_valid_sample_rate(value)) {
-		g_set_error(error_r, audio_parser_quark(), 0,
-			    "Invalid sample rate: %lu", value);
+	} else if (!audio_check_sample_rate(value, error_r))
 		return false;
-	}
 
 	*sample_rate_r = value;
 	*endptr_r = endptr;
@@ -84,11 +82,8 @@ parse_sample_format(const char *src, bool mask, uint8_t *bits_r,
 		g_set_error(error_r, audio_parser_quark(), 0,
 			    "Failed to parse the sample format");
 		return false;
-	} else if (!audio_valid_sample_format(value)) {
-		g_set_error(error_r, audio_parser_quark(), 0,
-			    "Invalid sample format: %lu", value);
+	} else if (!audio_check_sample_format(value, error_r))
 		return false;
-	}
 
 	*bits_r = value;
 	*endptr_r = endptr;
@@ -113,11 +108,8 @@ parse_channel_count(const char *src, bool mask, uint8_t *channels_r,
 		g_set_error(error_r, audio_parser_quark(), 0,
 			    "Failed to parse the channel count");
 		return false;
-	} else if (!audio_valid_channel_count(value)) {
-		g_set_error(error_r, audio_parser_quark(), 0,
-			    "Invalid channel count: %lu", value);
+	} else if (!audio_check_channel_count(value, error_r))
 		return false;
-	}
 
 	*channels_r = value;
 	*endptr_r = endptr;