summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDave Robillard <dave@drobilla.net>2009-08-12 01:07:57 -0400
committerDave Robillard <dave@drobilla.net>2009-08-12 01:07:57 -0400
commit882524e727a1c378be79f0425298243c24aa3adf (patch)
tree5604b1557adff139b2ed5d26b1bf3dc3e4340cdf
parent47b7c2a9690bd34213cb1bc2d48851874af9d850 (diff)
downloadgst-plugins-bad-882524e727a1c378be79f0425298243c24aa3adf.tar.gz
gst-plugins-bad-882524e727a1c378be79f0425298243c24aa3adf.tar.bz2
gst-plugins-bad-882524e727a1c378be79f0425298243c24aa3adf.zip
Make mono warning visible in public documentation.
-rw-r--r--ext/lv2/gstlv2.c14
1 files changed, 9 insertions, 5 deletions
diff --git a/ext/lv2/gstlv2.c b/ext/lv2/gstlv2.c
index ecf3fbec..7c6e1c3b 100644
--- a/ext/lv2/gstlv2.c
+++ b/ext/lv2/gstlv2.c
@@ -90,16 +90,20 @@ static GstPlugin *gst_lv2_plugin;
GST_DEBUG_CATEGORY_STATIC (lv2_debug);
#define GST_CAT_DEFAULT lv2_debug
-/** Convert an LV2 port role to a Gst channel positon */
+/** Convert an LV2 port role to a Gst channel positon
+ * WARNING: If the group has only a single port,
+ * GST_AUDIO_CHANNEL_POSITION_FRONT_CENTER will be returned for pg:centerRole
+ * (which is used by LV2 for mono groups), but this is not correct. In this
+ * case the value must be changed to GST_AUDIO_CHANNEL_POSITION_FRONT_MONO
+ * (this can't be done by this function because this information isn't known
+ * at the time it is used).
+ */
static GstAudioChannelPosition
gst_lv2_role_to_position (SLV2Value role)
{
/* Front. Mono and left/right are mututally exclusive */
if (slv2_value_equals (role, center_role)) {
- /** WARNING: If the group has only a single port, this must be changed to
- * GST_AUDIO_CHANNEL_POSITION_FRONT_MONO. This can't be done by this
- * function because this information isn't known at the time it is used.
- */
+
return GST_AUDIO_CHANNEL_POSITION_FRONT_CENTER;
} else if (slv2_value_equals (role, left_role)) {
return GST_AUDIO_CHANNEL_POSITION_FRONT_LEFT;