new codename, reset version to git

[paraslash.git] / write_common.c

diff --git a/write_common.c b/write_common.c
index b73ba9a11a753244bf23dc6d5f4a2e05985197cb..93562d0d25781cf157d0c38ce5377bd8d99f2c2a 100644 (file)
--- a/write_common.c
+++ b/write_common.c
@@ -159,18 +159,37 @@ static void get_btr_value(struct btr_node *btrn, const char *cmd,
        free(buf);
 }
 
-/*
+/**
  * 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.
  */
 void get_btr_sample_rate(struct btr_node *btrn, int32_t *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.
+ */
+void get_btr_sample_format(struct btr_node *btrn, int32_t *result)
+{
+       get_btr_value(btrn, "sample_format", result);
+}