mov: Support MOV_CH_LAYOUT_USE_DESCRIPTIONS for labeled descriptions.
[ffmpeg.git] / libavformat / mov_chan.h
1 /*
2  * Copyright (c) 2011 Justin Ruggles
3  *
4  * This file is part of Libav.
5  *
6  * Libav is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * Libav is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with Libav; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 /**
22  * mov 'chan' tag reading/writing.
23  * @author Justin Ruggles
24  */
25
26 #ifndef AVFORMAT_MOV_CHAN_H
27 #define AVFORMAT_MOV_CHAN_H
28
29 #include <stdint.h>
30
31 #include "libavcodec/avcodec.h"
32
33 /**
34  * Get the channel layout for the specified channel layout tag.
35  *
36  * @param[in]  tag     channel layout tag
37  * @param[out] bitmap  channel bitmap (only used if needed)
38  * @return             channel layout
39  */
40 uint64_t ff_mov_get_channel_layout(uint32_t tag, uint32_t bitmap);
41
42 /**
43  * Get the channel layout for the specified channel layout tag.
44  *
45  * @param[in]  tag     channel label
46  * @return             channel layout mask fragment
47  */
48 uint32_t ff_mov_get_channel_label(uint32_t label);
49
50 /**
51  * Get the channel layout tag for the specified codec id and channel layout.
52  * If the layout tag was not found, use a channel bitmap if possible.
53  *
54  * @param[in]  codec_id        codec id
55  * @param[in]  channel_layout  channel layout
56  * @param[out] bitmap          channel bitmap
57  * @return                     channel layout tag
58  */
59 uint32_t ff_mov_get_channel_layout_tag(enum CodecID codec_id,
60                                        uint64_t channel_layout,
61                                        uint32_t *bitmap);
62
63 #endif /* AVFORMAT_MOV_CHAN_H */