yading@11: /* yading@11: * Copyright (c) 2006 Michael Niedermayer yading@11: * Copyright (c) 2008 Peter Ross yading@11: * yading@11: * This file is part of FFmpeg. yading@11: * yading@11: * FFmpeg is free software; you can redistribute it and/or yading@11: * modify it under the terms of the GNU Lesser General Public yading@11: * License as published by the Free Software Foundation; either yading@11: * version 2.1 of the License, or (at your option) any later version. yading@11: * yading@11: * FFmpeg is distributed in the hope that it will be useful, yading@11: * but WITHOUT ANY WARRANTY; without even the implied warranty of yading@11: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU yading@11: * Lesser General Public License for more details. yading@11: * yading@11: * You should have received a copy of the GNU Lesser General Public yading@11: * License along with FFmpeg; if not, write to the Free Software yading@11: * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA yading@11: */ yading@11: yading@11: #ifndef AVUTIL_CHANNEL_LAYOUT_H yading@11: #define AVUTIL_CHANNEL_LAYOUT_H yading@11: yading@11: #include yading@11: yading@11: /** yading@11: * @file yading@11: * audio channel layout utility functions yading@11: */ yading@11: yading@11: /** yading@11: * @addtogroup lavu_audio yading@11: * @{ yading@11: */ yading@11: yading@11: /** yading@11: * @defgroup channel_masks Audio channel masks yading@11: * yading@11: * A channel layout is a 64-bits integer with a bit set for every channel. yading@11: * The number of bits set must be equal to the number of channels. yading@11: * The value 0 means that the channel layout is not known. yading@11: * @note this data structure is not powerful enough to handle channels yading@11: * combinations that have the same channel multiple times, such as yading@11: * dual-mono. yading@11: * yading@11: * @{ yading@11: */ yading@11: #define AV_CH_FRONT_LEFT 0x00000001 yading@11: #define AV_CH_FRONT_RIGHT 0x00000002 yading@11: #define AV_CH_FRONT_CENTER 0x00000004 yading@11: #define AV_CH_LOW_FREQUENCY 0x00000008 yading@11: #define AV_CH_BACK_LEFT 0x00000010 yading@11: #define AV_CH_BACK_RIGHT 0x00000020 yading@11: #define AV_CH_FRONT_LEFT_OF_CENTER 0x00000040 yading@11: #define AV_CH_FRONT_RIGHT_OF_CENTER 0x00000080 yading@11: #define AV_CH_BACK_CENTER 0x00000100 yading@11: #define AV_CH_SIDE_LEFT 0x00000200 yading@11: #define AV_CH_SIDE_RIGHT 0x00000400 yading@11: #define AV_CH_TOP_CENTER 0x00000800 yading@11: #define AV_CH_TOP_FRONT_LEFT 0x00001000 yading@11: #define AV_CH_TOP_FRONT_CENTER 0x00002000 yading@11: #define AV_CH_TOP_FRONT_RIGHT 0x00004000 yading@11: #define AV_CH_TOP_BACK_LEFT 0x00008000 yading@11: #define AV_CH_TOP_BACK_CENTER 0x00010000 yading@11: #define AV_CH_TOP_BACK_RIGHT 0x00020000 yading@11: #define AV_CH_STEREO_LEFT 0x20000000 ///< Stereo downmix. yading@11: #define AV_CH_STEREO_RIGHT 0x40000000 ///< See AV_CH_STEREO_LEFT. yading@11: #define AV_CH_WIDE_LEFT 0x0000000080000000ULL yading@11: #define AV_CH_WIDE_RIGHT 0x0000000100000000ULL yading@11: #define AV_CH_SURROUND_DIRECT_LEFT 0x0000000200000000ULL yading@11: #define AV_CH_SURROUND_DIRECT_RIGHT 0x0000000400000000ULL yading@11: #define AV_CH_LOW_FREQUENCY_2 0x0000000800000000ULL yading@11: yading@11: /** Channel mask value used for AVCodecContext.request_channel_layout yading@11: to indicate that the user requests the channel order of the decoder output yading@11: to be the native codec channel order. */ yading@11: #define AV_CH_LAYOUT_NATIVE 0x8000000000000000ULL yading@11: yading@11: /** yading@11: * @} yading@11: * @defgroup channel_mask_c Audio channel convenience macros yading@11: * @{ yading@11: * */ yading@11: #define AV_CH_LAYOUT_MONO (AV_CH_FRONT_CENTER) yading@11: #define AV_CH_LAYOUT_STEREO (AV_CH_FRONT_LEFT|AV_CH_FRONT_RIGHT) yading@11: #define AV_CH_LAYOUT_2POINT1 (AV_CH_LAYOUT_STEREO|AV_CH_LOW_FREQUENCY) yading@11: #define AV_CH_LAYOUT_2_1 (AV_CH_LAYOUT_STEREO|AV_CH_BACK_CENTER) yading@11: #define AV_CH_LAYOUT_SURROUND (AV_CH_LAYOUT_STEREO|AV_CH_FRONT_CENTER) yading@11: #define AV_CH_LAYOUT_3POINT1 (AV_CH_LAYOUT_SURROUND|AV_CH_LOW_FREQUENCY) yading@11: #define AV_CH_LAYOUT_4POINT0 (AV_CH_LAYOUT_SURROUND|AV_CH_BACK_CENTER) yading@11: #define AV_CH_LAYOUT_4POINT1 (AV_CH_LAYOUT_4POINT0|AV_CH_LOW_FREQUENCY) yading@11: #define AV_CH_LAYOUT_2_2 (AV_CH_LAYOUT_STEREO|AV_CH_SIDE_LEFT|AV_CH_SIDE_RIGHT) yading@11: #define AV_CH_LAYOUT_QUAD (AV_CH_LAYOUT_STEREO|AV_CH_BACK_LEFT|AV_CH_BACK_RIGHT) yading@11: #define AV_CH_LAYOUT_5POINT0 (AV_CH_LAYOUT_SURROUND|AV_CH_SIDE_LEFT|AV_CH_SIDE_RIGHT) yading@11: #define AV_CH_LAYOUT_5POINT1 (AV_CH_LAYOUT_5POINT0|AV_CH_LOW_FREQUENCY) yading@11: #define AV_CH_LAYOUT_5POINT0_BACK (AV_CH_LAYOUT_SURROUND|AV_CH_BACK_LEFT|AV_CH_BACK_RIGHT) yading@11: #define AV_CH_LAYOUT_5POINT1_BACK (AV_CH_LAYOUT_5POINT0_BACK|AV_CH_LOW_FREQUENCY) yading@11: #define AV_CH_LAYOUT_6POINT0 (AV_CH_LAYOUT_5POINT0|AV_CH_BACK_CENTER) yading@11: #define AV_CH_LAYOUT_6POINT0_FRONT (AV_CH_LAYOUT_2_2|AV_CH_FRONT_LEFT_OF_CENTER|AV_CH_FRONT_RIGHT_OF_CENTER) yading@11: #define AV_CH_LAYOUT_HEXAGONAL (AV_CH_LAYOUT_5POINT0_BACK|AV_CH_BACK_CENTER) yading@11: #define AV_CH_LAYOUT_6POINT1 (AV_CH_LAYOUT_5POINT1|AV_CH_BACK_CENTER) yading@11: #define AV_CH_LAYOUT_6POINT1_BACK (AV_CH_LAYOUT_5POINT1_BACK|AV_CH_BACK_CENTER) yading@11: #define AV_CH_LAYOUT_6POINT1_FRONT (AV_CH_LAYOUT_6POINT0_FRONT|AV_CH_LOW_FREQUENCY) yading@11: #define AV_CH_LAYOUT_7POINT0 (AV_CH_LAYOUT_5POINT0|AV_CH_BACK_LEFT|AV_CH_BACK_RIGHT) yading@11: #define AV_CH_LAYOUT_7POINT0_FRONT (AV_CH_LAYOUT_5POINT0|AV_CH_FRONT_LEFT_OF_CENTER|AV_CH_FRONT_RIGHT_OF_CENTER) yading@11: #define AV_CH_LAYOUT_7POINT1 (AV_CH_LAYOUT_5POINT1|AV_CH_BACK_LEFT|AV_CH_BACK_RIGHT) yading@11: #define AV_CH_LAYOUT_7POINT1_WIDE (AV_CH_LAYOUT_5POINT1|AV_CH_FRONT_LEFT_OF_CENTER|AV_CH_FRONT_RIGHT_OF_CENTER) yading@11: #define AV_CH_LAYOUT_7POINT1_WIDE_BACK (AV_CH_LAYOUT_5POINT1_BACK|AV_CH_FRONT_LEFT_OF_CENTER|AV_CH_FRONT_RIGHT_OF_CENTER) yading@11: #define AV_CH_LAYOUT_OCTAGONAL (AV_CH_LAYOUT_5POINT0|AV_CH_BACK_LEFT|AV_CH_BACK_CENTER|AV_CH_BACK_RIGHT) yading@11: #define AV_CH_LAYOUT_STEREO_DOWNMIX (AV_CH_STEREO_LEFT|AV_CH_STEREO_RIGHT) yading@11: yading@11: enum AVMatrixEncoding { yading@11: AV_MATRIX_ENCODING_NONE, yading@11: AV_MATRIX_ENCODING_DOLBY, yading@11: AV_MATRIX_ENCODING_DPLII, yading@11: AV_MATRIX_ENCODING_NB yading@11: }; yading@11: yading@11: /** yading@11: * @} yading@11: */ yading@11: yading@11: /** yading@11: * Return a channel layout id that matches name, or 0 if no match is found. yading@11: * yading@11: * name can be one or several of the following notations, yading@11: * separated by '+' or '|': yading@11: * - the name of an usual channel layout (mono, stereo, 4.0, quad, 5.0, yading@11: * 5.0(side), 5.1, 5.1(side), 7.1, 7.1(wide), downmix); yading@11: * - the name of a single channel (FL, FR, FC, LFE, BL, BR, FLC, FRC, BC, yading@11: * SL, SR, TC, TFL, TFC, TFR, TBL, TBC, TBR, DL, DR); yading@11: * - a number of channels, in decimal, optionally followed by 'c', yielding yading@11: * the default channel layout for that number of channels (@see yading@11: * av_get_default_channel_layout); yading@11: * - a channel layout mask, in hexadecimal starting with "0x" (see the yading@11: * AV_CH_* macros). yading@11: * yading@11: * Example: "stereo+FC" = "2+FC" = "2c+1c" = "0x7" yading@11: */ yading@11: uint64_t av_get_channel_layout(const char *name); yading@11: yading@11: /** yading@11: * Return a description of a channel layout. yading@11: * If nb_channels is <= 0, it is guessed from the channel_layout. yading@11: * yading@11: * @param buf put here the string containing the channel layout yading@11: * @param buf_size size in bytes of the buffer yading@11: */ yading@11: void av_get_channel_layout_string(char *buf, int buf_size, int nb_channels, uint64_t channel_layout); yading@11: yading@11: struct AVBPrint; yading@11: /** yading@11: * Append a description of a channel layout to a bprint buffer. yading@11: */ yading@11: void av_bprint_channel_layout(struct AVBPrint *bp, int nb_channels, uint64_t channel_layout); yading@11: yading@11: /** yading@11: * Return the number of channels in the channel layout. yading@11: */ yading@11: int av_get_channel_layout_nb_channels(uint64_t channel_layout); yading@11: yading@11: /** yading@11: * Return default channel layout for a given number of channels. yading@11: */ yading@11: int64_t av_get_default_channel_layout(int nb_channels); yading@11: yading@11: /** yading@11: * Get the index of a channel in channel_layout. yading@11: * yading@11: * @param channel a channel layout describing exactly one channel which must be yading@11: * present in channel_layout. yading@11: * yading@11: * @return index of channel in channel_layout on success, a negative AVERROR yading@11: * on error. yading@11: */ yading@11: int av_get_channel_layout_channel_index(uint64_t channel_layout, yading@11: uint64_t channel); yading@11: yading@11: /** yading@11: * Get the channel with the given index in channel_layout. yading@11: */ yading@11: uint64_t av_channel_layout_extract_channel(uint64_t channel_layout, int index); yading@11: yading@11: /** yading@11: * Get the name of a given channel. yading@11: * yading@11: * @return channel name on success, NULL on error. yading@11: */ yading@11: const char *av_get_channel_name(uint64_t channel); yading@11: yading@11: /** yading@11: * Get the description of a given channel. yading@11: * yading@11: * @param channel a channel layout with a single channel yading@11: * @return channel description on success, NULL on error yading@11: */ yading@11: const char *av_get_channel_description(uint64_t channel); yading@11: yading@11: /** yading@11: * Get the value and name of a standard channel layout. yading@11: * yading@11: * @param[in] index index in an internal list, starting at 0 yading@11: * @param[out] layout channel layout mask yading@11: * @param[out] name name of the layout yading@11: * @return 0 if the layout exists, yading@11: * <0 if index is beyond the limits yading@11: */ yading@11: int av_get_standard_channel_layout(unsigned index, uint64_t *layout, yading@11: const char **name); yading@11: yading@11: /** yading@11: * @} yading@11: */ yading@11: yading@11: #endif /* AVUTIL_CHANNEL_LAYOUT_H */