audioconvert: add some additional channel and channel layout macros
[libav.git] / libavutil / audioconvert.h
CommitLineData
176a6157
SS
1/*
2 * Copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
3 * Copyright (c) 2008 Peter Ross
4 *
2912e87a 5 * This file is part of Libav.
176a6157 6 *
2912e87a 7 * Libav is free software; you can redistribute it and/or
176a6157
SS
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
11 *
2912e87a 12 * Libav is distributed in the hope that it will be useful,
176a6157
SS
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
2912e87a 18 * License along with Libav; if not, write to the Free Software
176a6157
SS
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
737eb597
RT
22#ifndef AVUTIL_AUDIOCONVERT_H
23#define AVUTIL_AUDIOCONVERT_H
24
25#include <stdint.h>
176a6157
SS
26
27/**
28 * @file
29 * audio conversion routines
30 */
31
757cd8d8
LB
32/**
33 * @addtogroup lavu_audio
34 * @{
35 */
36
37/**
38 * @defgroup channel_masks Audio channel masks
39 * @{
40 */
176a6157
SS
41#define AV_CH_FRONT_LEFT 0x00000001
42#define AV_CH_FRONT_RIGHT 0x00000002
43#define AV_CH_FRONT_CENTER 0x00000004
44#define AV_CH_LOW_FREQUENCY 0x00000008
45#define AV_CH_BACK_LEFT 0x00000010
46#define AV_CH_BACK_RIGHT 0x00000020
47#define AV_CH_FRONT_LEFT_OF_CENTER 0x00000040
48#define AV_CH_FRONT_RIGHT_OF_CENTER 0x00000080
49#define AV_CH_BACK_CENTER 0x00000100
50#define AV_CH_SIDE_LEFT 0x00000200
51#define AV_CH_SIDE_RIGHT 0x00000400
52#define AV_CH_TOP_CENTER 0x00000800
53#define AV_CH_TOP_FRONT_LEFT 0x00001000
54#define AV_CH_TOP_FRONT_CENTER 0x00002000
55#define AV_CH_TOP_FRONT_RIGHT 0x00004000
56#define AV_CH_TOP_BACK_LEFT 0x00008000
57#define AV_CH_TOP_BACK_CENTER 0x00010000
58#define AV_CH_TOP_BACK_RIGHT 0x00020000
59#define AV_CH_STEREO_LEFT 0x20000000 ///< Stereo downmix.
60#define AV_CH_STEREO_RIGHT 0x40000000 ///< See AV_CH_STEREO_LEFT.
b2890f5e
JR
61#define AV_CH_WIDE_LEFT 0x0000000080000000ULL
62#define AV_CH_WIDE_RIGHT 0x0000000100000000ULL
63#define AV_CH_SURROUND_DIRECT_LEFT 0x0000000200000000ULL
64#define AV_CH_SURROUND_DIRECT_RIGHT 0x0000000400000000ULL
176a6157
SS
65
66/** Channel mask value used for AVCodecContext.request_channel_layout
67 to indicate that the user requests the channel order of the decoder output
68 to be the native codec channel order. */
cc276c85 69#define AV_CH_LAYOUT_NATIVE 0x8000000000000000ULL
176a6157 70
757cd8d8
LB
71/**
72 * @}
73 * @defgroup channel_mask_c Audio channel convenience macros
74 * @{
75 * */
176a6157
SS
76#define AV_CH_LAYOUT_MONO (AV_CH_FRONT_CENTER)
77#define AV_CH_LAYOUT_STEREO (AV_CH_FRONT_LEFT|AV_CH_FRONT_RIGHT)
b2890f5e 78#define AV_CH_LAYOUT_2POINT1 (AV_CH_LAYOUT_STEREO|AV_CH_LOW_FREQUENCY)
176a6157
SS
79#define AV_CH_LAYOUT_2_1 (AV_CH_LAYOUT_STEREO|AV_CH_BACK_CENTER)
80#define AV_CH_LAYOUT_SURROUND (AV_CH_LAYOUT_STEREO|AV_CH_FRONT_CENTER)
b2890f5e 81#define AV_CH_LAYOUT_3POINT1 (AV_CH_LAYOUT_SURROUND|AV_CH_LOW_FREQUENCY)
176a6157 82#define AV_CH_LAYOUT_4POINT0 (AV_CH_LAYOUT_SURROUND|AV_CH_BACK_CENTER)
b2890f5e 83#define AV_CH_LAYOUT_4POINT1 (AV_CH_LAYOUT_4POINT0|AV_CH_LOW_FREQUENCY)
176a6157
SS
84#define AV_CH_LAYOUT_2_2 (AV_CH_LAYOUT_STEREO|AV_CH_SIDE_LEFT|AV_CH_SIDE_RIGHT)
85#define AV_CH_LAYOUT_QUAD (AV_CH_LAYOUT_STEREO|AV_CH_BACK_LEFT|AV_CH_BACK_RIGHT)
86#define AV_CH_LAYOUT_5POINT0 (AV_CH_LAYOUT_SURROUND|AV_CH_SIDE_LEFT|AV_CH_SIDE_RIGHT)
87#define AV_CH_LAYOUT_5POINT1 (AV_CH_LAYOUT_5POINT0|AV_CH_LOW_FREQUENCY)
88#define AV_CH_LAYOUT_5POINT0_BACK (AV_CH_LAYOUT_SURROUND|AV_CH_BACK_LEFT|AV_CH_BACK_RIGHT)
89#define AV_CH_LAYOUT_5POINT1_BACK (AV_CH_LAYOUT_5POINT0_BACK|AV_CH_LOW_FREQUENCY)
b2890f5e
JR
90#define AV_CH_LAYOUT_6POINT0 (AV_CH_LAYOUT_5POINT0|AV_CH_BACK_CENTER)
91#define AV_CH_LAYOUT_6POINT0_FRONT (AV_CH_LAYOUT_2_2|AV_CH_FRONT_LEFT_OF_CENTER|AV_CH_FRONT_RIGHT_OF_CENTER)
92#define AV_CH_LAYOUT_HEXAGONAL (AV_CH_LAYOUT_5POINT0_BACK|AV_CH_BACK_CENTER)
93#define AV_CH_LAYOUT_6POINT1 (AV_CH_LAYOUT_5POINT1|AV_CH_BACK_CENTER)
94#define AV_CH_LAYOUT_6POINT1_BACK (AV_CH_LAYOUT_5POINT1_BACK|AV_CH_BACK_CENTER)
95#define AV_CH_LAYOUT_6POINT1_FRONT (AV_CH_LAYOUT_6POINT0_FRONT|AV_CH_LOW_FREQUENCY)
176a6157 96#define AV_CH_LAYOUT_7POINT0 (AV_CH_LAYOUT_5POINT0|AV_CH_BACK_LEFT|AV_CH_BACK_RIGHT)
b2890f5e 97#define AV_CH_LAYOUT_7POINT0_FRONT (AV_CH_LAYOUT_5POINT0|AV_CH_FRONT_LEFT_OF_CENTER|AV_CH_FRONT_RIGHT_OF_CENTER)
176a6157 98#define AV_CH_LAYOUT_7POINT1 (AV_CH_LAYOUT_5POINT1|AV_CH_BACK_LEFT|AV_CH_BACK_RIGHT)
1d2449a6 99#define AV_CH_LAYOUT_7POINT1_WIDE (AV_CH_LAYOUT_5POINT1|AV_CH_FRONT_LEFT_OF_CENTER|AV_CH_FRONT_RIGHT_OF_CENTER)
b2890f5e 100#define AV_CH_LAYOUT_OCTAGONAL (AV_CH_LAYOUT_5POINT0|AV_CH_BACK_LEFT|AV_CH_BACK_CENTER|AV_CH_BACK_RIGHT)
176a6157
SS
101#define AV_CH_LAYOUT_STEREO_DOWNMIX (AV_CH_STEREO_LEFT|AV_CH_STEREO_RIGHT)
102
103/**
757cd8d8
LB
104 * @}
105 */
106
107/**
176a6157
SS
108 * Return a channel layout id that matches name, 0 if no match.
109 */
cc276c85 110uint64_t av_get_channel_layout(const char *name);
176a6157
SS
111
112/**
113 * Return a description of a channel layout.
8b69c2f4 114 * If nb_channels is <= 0, it is guessed from the channel_layout.
176a6157
SS
115 *
116 * @param buf put here the string containing the channel layout
117 * @param buf_size size in bytes of the buffer
118 */
cc276c85 119void av_get_channel_layout_string(char *buf, int buf_size, int nb_channels, uint64_t channel_layout);
176a6157
SS
120
121/**
122 * Return the number of channels in the channel layout.
123 */
cc276c85 124int av_get_channel_layout_nb_channels(uint64_t channel_layout);
176a6157 125
757cd8d8
LB
126/**
127 * @}
128 */
129
737eb597 130#endif /* AVUTIL_AUDIOCONVERT_H */