Merge remote branch 'refs/remotes/fml/master'

[paraslash.git] / write_common.c

diff --git a/write_common.c b/write_common.c
index 0d30eb8018583b278d79ef6df40a02bb2d771053..93562d0d25781cf157d0c38ce5377bd8d99f2c2a 100644 (file)
--- a/write_common.c
+++ b/write_common.c
@@ -147,30 +147,49 @@ void print_writer_helps(int detailed)
        }
 }
 
-static int get_btr_value(struct btr_node *btrn, const char *key, int32_t *result)
+static void get_btr_value(struct btr_node *btrn, const char *cmd,
+               int32_t *result)
 {
        char *buf = NULL;
-       int ret = btr_exec_up(btrn, key, &buf);
+       int ret = btr_exec_up(btrn, cmd, &buf);
 
-       if (ret < 0)
-               return ret;
+       assert(ret >= 0);
        ret = para_atoi32(buf, result);
+       assert(ret >= 0);
        free(buf);
-       return ret;
 }
 
-/*
+/**
  * Ask parent btr nodes for the sample rate of the current stream.
+ *
+ * \param btrn Where to start the search.
+ * \param result Filled in by this function.
+ *
+ * This function is assumed to succeed and terminates on errors.
  */
-int get_btr_sample_rate(struct btr_node *btrn, int32_t *result)
+void get_btr_sample_rate(struct btr_node *btrn, int32_t *result)
 {
-       return get_btr_value(btrn, "sample_rate", result);
+       get_btr_value(btrn, "sample_rate", result);
 }
 
-/*
+/**
  * Ask parent btr nodes for the channel count of the current stream.
+ *
+ * \param btrn See \ref get_btr_sample_rate.
+ * \param result See \ref get_btr_sample_rate.
+ */
+void get_btr_channels(struct btr_node *btrn, int32_t *result)
+{
+       get_btr_value(btrn, "channels", result);
+}
+
+/**
+ * Ask parent btr nodes for the number of bits per sample and the byte sex.
+ *
+ * \param btrn See \ref get_btr_sample_rate.
+ * \param result Contains the sample format as an enum sample_format type.
  */
-int get_btr_channels(struct btr_node *btrn, int32_t *result)
+void get_btr_sample_format(struct btr_node *btrn, int32_t *result)
 {
-       return get_btr_value(btrn, "channels", result);
+       get_btr_value(btrn, "sample_format", result);
 }