Merge remote-tracking branch 'qatar/master'

[ffmpeg] / libavutil / audioconvert.h

diff --git a/libavutil/audioconvert.h b/libavutil/audioconvert.h
index 134c6107c9d1e75ebf54fcfd0b21681c195d76de..4e0e98c9b4efe582aa9b0ee403ae097a0d323191 100644 (file)
--- a/libavutil/audioconvert.h
+++ b/libavutil/audioconvert.h
@@ -75,6 +75,18 @@
 
 /**
  * Return a channel layout id that matches name, 0 if no match.
+ * name can be one or several of the following notations,
+ * separated by '+' or '|':
+ * - the name of an usual channel layout (mono, stereo, 4.0, quad, 5.0,
+ *   5.0(side), 5.1, 5.1(side), 7.1, 7.1(wide), downmix);
+ * - the name of a single channel (FL, FR, FC, LFE, BL, BR, FLC, FRC, BC,
+ *   SL, SR, TC, TFL, TFC, TFR, TBL, TBC, TBR, DL, DR);
+ * - a number of channels, in decimal, optionnally followed by 'c', yielding
+ *   the default channel layout for that number of channels (@see
+ *   av_get_default_channel_layout);
+ * - a channel layout mask, in hexadecimal starting with "0x" (see the
+ *   AV_CH_* macros).
+ + Example: "stereo+FC" = "2+FC" = "2c+1c" = "0x7"
  */
 int64_t av_get_channel_layout(const char *name);
 
@@ -92,4 +104,9 @@ void av_get_channel_layout_string(char *buf, int buf_size, int nb_channels, int6
  */
 int av_get_channel_layout_nb_channels(int64_t channel_layout);
 
+/**
+ * Return default channel layout for a given number of channels.
+ */
+int64_t av_get_default_channel_layout(int nb_channels);
+
 #endif /* AVUTIL_AUDIOCONVERT_H */