eb473d8a55fcb61b4838717028fa40318b21254c
[ffmpeg.git] / libavformat / mxf.h
1 /*
2  * MXF
3  * Copyright (c) 2006 SmartJog S.A., Baptiste Coudurier <baptiste dot coudurier at smartjog dot com>
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
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  *
12  * FFmpeg is distributed in the hope that it will be useful,
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
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21 #ifndef AVFORMAT_MXF_H
22 #define AVFORMAT_MXF_H
23
24 #include <stdint.h>
25 #include "libavutil/log.h"
26 #include "libavutil/pixfmt.h"
27 #include "libavutil/rational.h"
28
29 typedef uint8_t UID[16];
30
31 enum MXFMetadataSetType {
32     AnyType,
33     MaterialPackage,
34     SourcePackage,
35     SourceClip,
36     TimecodeComponent,
37     PulldownComponent,
38     Sequence,
39     MultipleDescriptor,
40     Descriptor,
41     Track,
42     CryptoContext,
43     Preface,
44     Identification,
45     ContentStorage,
46     SubDescriptor,
47     IndexTableSegment,
48     EssenceContainerData,
49     EssenceGroup,
50     TaggedValue,
51     TapeDescriptor,
52     AVCSubDescriptor,
53 };
54
55 enum MXFFrameLayout {
56     FullFrame = 0,
57     SeparateFields,
58     OneField,
59     MixedFields,
60     SegmentedFrame,
61 };
62
63 typedef struct MXFContentPackageRate {
64     int rate;
65     AVRational tb;
66 } MXFContentPackageRate;
67
68 typedef struct KLVPacket {
69     UID key;
70     int64_t offset;
71     uint64_t length;
72     int64_t next_klv;
73 } KLVPacket;
74
75 typedef enum {
76     NormalWrap = 0,
77     D10D11Wrap,
78     RawAWrap,
79     RawVWrap
80 } MXFWrappingIndicatorType;
81
82 typedef struct MXFLocalTagPair {
83     int local_tag;
84     UID uid;
85 } MXFLocalTagPair;
86
87 extern const uint8_t ff_mxf_random_index_pack_key[16];
88
89 #define FF_MXF_MasteringDisplay_PREFIX                  0x06,0x0e,0x2b,0x34,0x01,0x01,0x01,0x0e,0x04,0x20,0x04,0x01,0x01
90 #define FF_MXF_MasteringDisplayPrimaries                { FF_MXF_MasteringDisplay_PREFIX,0x01,0x00,0x00 }
91 #define FF_MXF_MasteringDisplayWhitePointChromaticity   { FF_MXF_MasteringDisplay_PREFIX,0x02,0x00,0x00 }
92 #define FF_MXF_MasteringDisplayMaximumLuminance         { FF_MXF_MasteringDisplay_PREFIX,0x03,0x00,0x00 }
93 #define FF_MXF_MasteringDisplayMinimumLuminance         { FF_MXF_MasteringDisplay_PREFIX,0x04,0x00,0x00 }
94
95 #define FF_MXF_MASTERING_CHROMA_DEN 50000
96 #define FF_MXF_MASTERING_LUMA_DEN   10000
97
98 typedef struct MXFCodecUL {
99     UID uid;
100     unsigned matching_len;
101     int id;
102     const char *desc;
103     unsigned wrapping_indicator_pos;
104     MXFWrappingIndicatorType wrapping_indicator_type;
105 } MXFCodecUL;
106
107 extern const MXFCodecUL ff_mxf_data_definition_uls[];
108 extern const MXFCodecUL ff_mxf_codec_uls[];
109 extern const MXFCodecUL ff_mxf_pixel_format_uls[];
110 extern const MXFCodecUL ff_mxf_codec_tag_uls[];
111 extern const MXFCodecUL ff_mxf_color_primaries_uls[];
112 extern const MXFCodecUL ff_mxf_color_trc_uls[];
113 extern const MXFCodecUL ff_mxf_color_space_uls[];
114
115 int ff_mxf_decode_pixel_layout(const char pixel_layout[16], enum AVPixelFormat *pix_fmt);
116 int ff_mxf_get_content_package_rate(AVRational time_base);
117
118
119 #define PRIxUID                             \
120     "%02x.%02x.%02x.%02x."                  \
121     "%02x.%02x.%02x.%02x."                  \
122     "%02x.%02x.%02x.%02x."                  \
123     "%02x.%02x.%02x.%02x"
124
125 #define UID_ARG(x) \
126     (x)[0],  (x)[1],  (x)[2],  (x)[3],      \
127     (x)[4],  (x)[5],  (x)[6],  (x)[7],      \
128     (x)[8],  (x)[9],  (x)[10], (x)[11],     \
129     (x)[12], (x)[13], (x)[14], (x)[15]      \
130
131 #ifdef DEBUG
132 #define PRINT_KEY(pc, s, x)                         \
133     av_log(pc, AV_LOG_VERBOSE,                      \
134            "%s "                                    \
135            "0x%02x,0x%02x,0x%02x,0x%02x,"           \
136            "0x%02x,0x%02x,0x%02x,0x%02x,"           \
137            "0x%02x,0x%02x,0x%02x,0x%02x,"           \
138            "0x%02x,0x%02x,0x%02x,0x%02x ",          \
139             s, UID_ARG(x));                         \
140     av_log(pc, AV_LOG_INFO,                         \
141            "%s "                                    \
142            "%02x.%02x.%02x.%02x."                   \
143            "%02x.%02x.%02x.%02x."                   \
144            "%02x.%02x.%02x.%02x."                   \
145            "%02x.%02x.%02x.%02x\n",                 \
146             s, UID_ARG(x))
147 #else
148 #define PRINT_KEY(pc, s, x) do { if(0)              \
149     av_log(pc, AV_LOG_VERBOSE,                      \
150            "%s "                                    \
151            "0x%02x,0x%02x,0x%02x,0x%02x,"           \
152            "0x%02x,0x%02x,0x%02x,0x%02x,"           \
153            "0x%02x,0x%02x,0x%02x,0x%02x,"           \
154            "0x%02x,0x%02x,0x%02x,0x%02x ",          \
155             s, UID_ARG(x));                         \
156     }while(0)
157 #endif
158
159 #endif /* AVFORMAT_MXF_H */