libavformat/mov_chan.h

   1 /*
   2  * Copyright (c) 2011 Justin Ruggles
   3  *
   4  * This file is part of FFmpeg.
   5  *
   6  * FFmpeg 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  * FFmpeg 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 FFmpeg; 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 "libavutil/channel_layout.h"
  32 #include "libavcodec/codec_id.h"
  33 #include "libavcodec/codec_par.h"
  34 #include "avformat.h"
  35
  36 /**
  37  * Channel Layout Tag
  38  * This tells which channels are present in the audio stream and the order in
  39  * which they appear.
  40  *
  41  * @note We're using the channel layout tag to indicate channel order
  42  *       when the value is greater than 0x10000. The Apple documentation has
  43  *       some contradictions as to how this is actually supposed to be handled.
  44  *
  45  *       Core Audio File Format Spec:
  46  *           "The high 16 bits indicates a specific ordering of the channels."
  47  *       Core Audio Data Types Reference:
  48  *           "These identifiers specify the channels included in a layout but
  49  *            do not specify a particular ordering of those channels."
  50  */
  51 enum MovChannelLayoutTag {
  52 #define MOV_CH_LAYOUT_UNKNOWN             0xFFFF0000
  53     MOV_CH_LAYOUT_USE_DESCRIPTIONS      = (  0 << 16) | 0,
  54     MOV_CH_LAYOUT_USE_BITMAP            = (  1 << 16) | 0,
  55     MOV_CH_LAYOUT_DISCRETEINORDER       = (147 << 16) | 0,
  56     MOV_CH_LAYOUT_MONO                  = (100 << 16) | 1,
  57     MOV_CH_LAYOUT_STEREO                = (101 << 16) | 2,
  58     MOV_CH_LAYOUT_STEREOHEADPHONES      = (102 << 16) | 2,
  59     MOV_CH_LAYOUT_MATRIXSTEREO          = (103 << 16) | 2,
  60     MOV_CH_LAYOUT_MIDSIDE               = (104 << 16) | 2,
  61     MOV_CH_LAYOUT_XY                    = (105 << 16) | 2,
  62     MOV_CH_LAYOUT_BINAURAL              = (106 << 16) | 2,
  63     MOV_CH_LAYOUT_AMBISONIC_B_FORMAT    = (107 << 16) | 4,
  64     MOV_CH_LAYOUT_QUADRAPHONIC          = (108 << 16) | 4,
  65     MOV_CH_LAYOUT_PENTAGONAL            = (109 << 16) | 5,
  66     MOV_CH_LAYOUT_HEXAGONAL             = (110 << 16) | 6,
  67     MOV_CH_LAYOUT_OCTAGONAL             = (111 << 16) | 8,
  68     MOV_CH_LAYOUT_CUBE                  = (112 << 16) | 8,
  69     MOV_CH_LAYOUT_MPEG_3_0_A            = (113 << 16) | 3,
  70     MOV_CH_LAYOUT_MPEG_3_0_B            = (114 << 16) | 3,
  71     MOV_CH_LAYOUT_MPEG_4_0_A            = (115 << 16) | 4,
  72     MOV_CH_LAYOUT_MPEG_4_0_B            = (116 << 16) | 4,
  73     MOV_CH_LAYOUT_MPEG_5_0_A            = (117 << 16) | 5,
  74     MOV_CH_LAYOUT_MPEG_5_0_B            = (118 << 16) | 5,
  75     MOV_CH_LAYOUT_MPEG_5_0_C            = (119 << 16) | 5,
  76     MOV_CH_LAYOUT_MPEG_5_0_D            = (120 << 16) | 5,
  77     MOV_CH_LAYOUT_MPEG_5_1_A            = (121 << 16) | 6,
  78     MOV_CH_LAYOUT_MPEG_5_1_B            = (122 << 16) | 6,
  79     MOV_CH_LAYOUT_MPEG_5_1_C            = (123 << 16) | 6,
  80     MOV_CH_LAYOUT_MPEG_5_1_D            = (124 << 16) | 6,
  81     MOV_CH_LAYOUT_MPEG_6_1_A            = (125 << 16) | 7,
  82     MOV_CH_LAYOUT_MPEG_7_1_A            = (126 << 16) | 8,
  83     MOV_CH_LAYOUT_MPEG_7_1_B            = (127 << 16) | 8,
  84     MOV_CH_LAYOUT_MPEG_7_1_C            = (128 << 16) | 8,
  85     MOV_CH_LAYOUT_EMAGIC_DEFAULT_7_1    = (129 << 16) | 8,
  86     MOV_CH_LAYOUT_SMPTE_DTV             = (130 << 16) | 8,
  87     MOV_CH_LAYOUT_ITU_2_1               = (131 << 16) | 3,
  88     MOV_CH_LAYOUT_ITU_2_2               = (132 << 16) | 4,
  89     MOV_CH_LAYOUT_DVD_4                 = (133 << 16) | 3,
  90     MOV_CH_LAYOUT_DVD_5                 = (134 << 16) | 4,
  91     MOV_CH_LAYOUT_DVD_6                 = (135 << 16) | 5,
  92     MOV_CH_LAYOUT_DVD_10                = (136 << 16) | 4,
  93     MOV_CH_LAYOUT_DVD_11                = (137 << 16) | 5,
  94     MOV_CH_LAYOUT_DVD_18                = (138 << 16) | 5,
  95     MOV_CH_LAYOUT_AUDIOUNIT_6_0         = (139 << 16) | 6,
  96     MOV_CH_LAYOUT_AUDIOUNIT_7_0         = (140 << 16) | 7,
  97     MOV_CH_LAYOUT_AUDIOUNIT_7_0_FRONT   = (148 << 16) | 7,
  98     MOV_CH_LAYOUT_AAC_6_0               = (141 << 16) | 6,
  99     MOV_CH_LAYOUT_AAC_6_1               = (142 << 16) | 7,
 100     MOV_CH_LAYOUT_AAC_7_0               = (143 << 16) | 7,
 101     MOV_CH_LAYOUT_AAC_OCTAGONAL         = (144 << 16) | 8,
 102     MOV_CH_LAYOUT_TMH_10_2_STD          = (145 << 16) | 16,
 103     MOV_CH_LAYOUT_TMH_10_2_FULL         = (146 << 16) | 21,
 104     MOV_CH_LAYOUT_AC3_1_0_1             = (149 << 16) | 2,
 105     MOV_CH_LAYOUT_AC3_3_0               = (150 << 16) | 3,
 106     MOV_CH_LAYOUT_AC3_3_1               = (151 << 16) | 4,
 107     MOV_CH_LAYOUT_AC3_3_0_1             = (152 << 16) | 4,
 108     MOV_CH_LAYOUT_AC3_2_1_1             = (153 << 16) | 4,
 109     MOV_CH_LAYOUT_AC3_3_1_1             = (154 << 16) | 5,
 110     MOV_CH_LAYOUT_EAC3_6_0_A            = (155 << 16) | 6,
 111     MOV_CH_LAYOUT_EAC3_7_0_A            = (156 << 16) | 7,
 112     MOV_CH_LAYOUT_EAC3_6_1_A            = (157 << 16) | 7,
 113     MOV_CH_LAYOUT_EAC3_6_1_B            = (158 << 16) | 7,
 114     MOV_CH_LAYOUT_EAC3_6_1_C            = (159 << 16) | 7,
 115     MOV_CH_LAYOUT_EAC3_7_1_A            = (160 << 16) | 8,
 116     MOV_CH_LAYOUT_EAC3_7_1_B            = (161 << 16) | 8,
 117     MOV_CH_LAYOUT_EAC3_7_1_C            = (162 << 16) | 8,
 118     MOV_CH_LAYOUT_EAC3_7_1_D            = (163 << 16) | 8,
 119     MOV_CH_LAYOUT_EAC3_7_1_E            = (164 << 16) | 8,
 120     MOV_CH_LAYOUT_EAC3_7_1_F            = (165 << 16) | 8,
 121     MOV_CH_LAYOUT_EAC3_7_1_G            = (166 << 16) | 8,
 122     MOV_CH_LAYOUT_EAC3_7_1_H            = (167 << 16) | 8,
 123     MOV_CH_LAYOUT_DTS_3_1               = (168 << 16) | 4,
 124     MOV_CH_LAYOUT_DTS_4_1               = (169 << 16) | 5,
 125     MOV_CH_LAYOUT_DTS_6_0_A             = (170 << 16) | 6,
 126     MOV_CH_LAYOUT_DTS_6_0_B             = (171 << 16) | 6,
 127     MOV_CH_LAYOUT_DTS_6_0_C             = (172 << 16) | 6,
 128     MOV_CH_LAYOUT_DTS_6_1_A             = (173 << 16) | 7,
 129     MOV_CH_LAYOUT_DTS_6_1_B             = (174 << 16) | 7,
 130     MOV_CH_LAYOUT_DTS_6_1_C             = (175 << 16) | 7,
 131     MOV_CH_LAYOUT_DTS_6_1_D             = (182 << 16) | 7,
 132     MOV_CH_LAYOUT_DTS_7_0               = (176 << 16) | 7,
 133     MOV_CH_LAYOUT_DTS_7_1               = (177 << 16) | 8,
 134     MOV_CH_LAYOUT_DTS_8_0_A             = (178 << 16) | 8,
 135     MOV_CH_LAYOUT_DTS_8_0_B             = (179 << 16) | 8,
 136     MOV_CH_LAYOUT_DTS_8_1_A             = (180 << 16) | 9,
 137     MOV_CH_LAYOUT_DTS_8_1_B             = (181 << 16) | 9,
 138 };
 139
 140 /**
 141  * Get the channel layout tag for the specified codec id and channel layout.
 142  * If the layout tag was not found, use a channel bitmap if possible.
 143  *
 144  * @param[in]  codec_id        codec id
 145  * @param[in]  channel_layout  channel layout
 146  * @param[out] bitmap          channel bitmap
 147  * @return                     channel layout tag
 148  */
 149 int ff_mov_get_channel_layout_tag(const AVCodecParameters *par,
 150                                        uint32_t *layout,
 151                                        uint32_t *bitmap,
 152                                        uint32_t **pchannel_desc);
 153
 154 /**
 155  * Read 'chan' tag from the input stream.
 156  *
 157  * @param s     AVFormatContext
 158  * @param pb    AVIOContext
 159  * @param st    The stream to set codec values for
 160  * @param size  Remaining size in the 'chan' tag
 161  * @return      0 if ok, or negative AVERROR code on failure
 162  */
 163 int ff_mov_read_chan(AVFormatContext *s, AVIOContext *pb, AVStream *st,
 164                      int64_t size);
 165
 166 /**
 167  * Get ISO/IEC 23001-8 ChannelConfiguration from AVChannelLayout.
 168  *
 169  */
 170 int ff_mov_get_channel_config_from_layout(const AVChannelLayout *layout, int *config);
 171
 172 /**
 173  * Get AVChannelLayout from ISO/IEC 23001-8 ChannelConfiguration.
 174  *
 175  * @return 0 for success, -1 for doesn't match, layout is untouched on failure
 176  */
 177
 178 int ff_mov_get_channel_layout_from_config(int config, AVChannelLayout *layout);
 179
 180 /**
 181  * Get ISO/IEC 23001-8 OutputChannelPosition from AVChannelLayout.
 182  */
 183 int ff_mov_get_channel_positions_from_layout(const AVChannelLayout *layout,
 184                                              uint8_t *position, int position_num);
 185
 186 /**
 187  * Get AVChannelLayout from ISO/IEC 23001-8 OutputChannelPosition.
 188  */
 189 int ff_mov_get_layout_from_channel_positions(const uint8_t *position, int position_num,
 190                                              AVChannelLayout *layout);
 191
 192 #endif /* AVFORMAT_MOV_CHAN_H */