Coverage Report

Created: 2026-04-29 07:00

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/ffmpeg/libavcodec/exif.c
Line
Count
Source
1
/*
2
 * EXIF metadata parser
3
 * Copyright (c) 2013 Thilo Borgmann <thilo.borgmann _at_ mail.de>
4
 * Copyright (c) 2024-2025 Leo Izen <leo.izen@gmail.com>
5
 *
6
 * This file is part of FFmpeg.
7
 *
8
 * FFmpeg is free software; you can redistribute it and/or
9
 * modify it under the terms of the GNU Lesser General Public
10
 * License as published by the Free Software Foundation; either
11
 * version 2.1 of the License, or (at your option) any later version.
12
 *
13
 * FFmpeg is distributed in the hope that it will be useful,
14
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16
 * Lesser General Public License for more details.
17
 *
18
 * You should have received a copy of the GNU Lesser General Public
19
 * License along with FFmpeg; if not, write to the Free Software
20
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21
 */
22
23
/**
24
 * @file
25
 * EXIF metadata parser
26
 * @author Thilo Borgmann <thilo.borgmann _at_ mail.de>
27
 * @author Leo Izen <leo.izen@gmail.com>
28
 */
29
30
#include <inttypes.h>
31
32
#include "libavutil/attributes.h"
33
#include "libavutil/avconfig.h"
34
#include "libavutil/bprint.h"
35
#include "libavutil/display.h"
36
#include "libavutil/intreadwrite.h"
37
#include "libavutil/mem.h"
38
39
#include "bytestream.h"
40
#include "exif_internal.h"
41
#include "tiff_common.h"
42
43
0
#define EXIF_II_LONG           0x49492a00
44
0
#define EXIF_MM_LONG           0x4d4d002a
45
46
0
#define BASE_TAG_SIZE          12
47
0
#define IFD_EXTRA_SIZE         6
48
49
#define EXIF_TAG_NAME_LENGTH   32
50
0
#define MAKERNOTE_TAG          0x927c
51
0
#define ORIENTATION_TAG        0x112
52
0
#define EXIFIFD_TAG            0x8769
53
0
#define IMAGE_WIDTH_TAG        0x100
54
0
#define IMAGE_LENGTH_TAG       0x101
55
0
#define PIXEL_X_TAG            0xa002
56
0
#define PIXEL_Y_TAG            0xa003
57
58
struct exif_tag {
59
    const char name[EXIF_TAG_NAME_LENGTH];
60
    uint16_t id;
61
};
62
63
static const struct exif_tag tag_list[] = { // JEITA CP-3451 EXIF specification:
64
    {"GPSVersionID",               0x00}, // <- Table 12 GPS Attribute Information
65
    {"GPSLatitudeRef",             0x01},
66
    {"GPSLatitude",                0x02},
67
    {"GPSLongitudeRef",            0x03},
68
    {"GPSLongitude",               0x04},
69
    {"GPSAltitudeRef",             0x05},
70
    {"GPSAltitude",                0x06},
71
    {"GPSTimeStamp",               0x07},
72
    {"GPSSatellites",              0x08},
73
    {"GPSStatus",                  0x09},
74
    {"GPSMeasureMode",             0x0A},
75
    {"GPSDOP",                     0x0B},
76
    {"GPSSpeedRef",                0x0C},
77
    {"GPSSpeed",                   0x0D},
78
    {"GPSTrackRef",                0x0E},
79
    {"GPSTrack",                   0x0F},
80
    {"GPSImgDirectionRef",         0x10},
81
    {"GPSImgDirection",            0x11},
82
    {"GPSMapDatum",                0x12},
83
    {"GPSDestLatitudeRef",         0x13},
84
    {"GPSDestLatitude",            0x14},
85
    {"GPSDestLongitudeRef",        0x15},
86
    {"GPSDestLongitude",           0x16},
87
    {"GPSDestBearingRef",          0x17},
88
    {"GPSDestBearing",             0x18},
89
    {"GPSDestDistanceRef",         0x19},
90
    {"GPSDestDistance",            0x1A},
91
    {"GPSProcessingMethod",        0x1B},
92
    {"GPSAreaInformation",         0x1C},
93
    {"GPSDateStamp",               0x1D},
94
    {"GPSDifferential",            0x1E},
95
    {"ImageWidth",                 0x100}, // <- Table 3 TIFF Rev. 6.0 Attribute Information Used in Exif
96
    {"ImageLength",                0x101},
97
    {"BitsPerSample",              0x102},
98
    {"Compression",                0x103},
99
    {"PhotometricInterpretation",  0x106},
100
    {"Orientation",                0x112},
101
    {"SamplesPerPixel",            0x115},
102
    {"PlanarConfiguration",        0x11C},
103
    {"YCbCrSubSampling",           0x212},
104
    {"YCbCrPositioning",           0x213},
105
    {"XResolution",                0x11A},
106
    {"YResolution",                0x11B},
107
    {"ResolutionUnit",             0x128},
108
    {"StripOffsets",               0x111},
109
    {"RowsPerStrip",               0x116},
110
    {"StripByteCounts",            0x117},
111
    {"JPEGInterchangeFormat",      0x201},
112
    {"JPEGInterchangeFormatLength",0x202},
113
    {"TransferFunction",           0x12D},
114
    {"WhitePoint",                 0x13E},
115
    {"PrimaryChromaticities",      0x13F},
116
    {"YCbCrCoefficients",          0x211},
117
    {"ReferenceBlackWhite",        0x214},
118
    {"DateTime",                   0x132},
119
    {"ImageDescription",           0x10E},
120
    {"Make",                       0x10F},
121
    {"Model",                      0x110},
122
    {"Software",                   0x131},
123
    {"Artist",                     0x13B},
124
    {"Copyright",                  0x8298},
125
    {"ExifVersion",                0x9000}, // <- Table 4 Exif IFD Attribute Information (1)
126
    {"FlashpixVersion",            0xA000},
127
    {"ColorSpace",                 0xA001},
128
    {"ComponentsConfiguration",    0x9101},
129
    {"CompressedBitsPerPixel",     0x9102},
130
    {"PixelXDimension",            0xA002},
131
    {"PixelYDimension",            0xA003},
132
    {"MakerNote",                  0x927C},
133
    {"UserComment",                0x9286},
134
    {"RelatedSoundFile",           0xA004},
135
    {"DateTimeOriginal",           0x9003},
136
    {"DateTimeDigitized",          0x9004},
137
    {"SubSecTime",                 0x9290},
138
    {"SubSecTimeOriginal",         0x9291},
139
    {"SubSecTimeDigitized",        0x9292},
140
    {"ImageUniqueID",              0xA420},
141
    {"ExposureTime",               0x829A}, // <- Table 5 Exif IFD Attribute Information (2)
142
    {"FNumber",                    0x829D},
143
    {"ExposureProgram",            0x8822},
144
    {"SpectralSensitivity",        0x8824},
145
    {"ISOSpeedRatings",            0x8827},
146
    {"OECF",                       0x8828},
147
    {"ShutterSpeedValue",          0x9201},
148
    {"ApertureValue",              0x9202},
149
    {"BrightnessValue",            0x9203},
150
    {"ExposureBiasValue",          0x9204},
151
    {"MaxApertureValue",           0x9205},
152
    {"SubjectDistance",            0x9206},
153
    {"MeteringMode",               0x9207},
154
    {"LightSource",                0x9208},
155
    {"Flash",                      0x9209},
156
    {"FocalLength",                0x920A},
157
    {"SubjectArea",                0x9214},
158
    {"FlashEnergy",                0xA20B},
159
    {"SpatialFrequencyResponse",   0xA20C},
160
    {"FocalPlaneXResolution",      0xA20E},
161
    {"FocalPlaneYResolution",      0xA20F},
162
    {"FocalPlaneResolutionUnit",   0xA210},
163
    {"SubjectLocation",            0xA214},
164
    {"ExposureIndex",              0xA215},
165
    {"SensingMethod",              0xA217},
166
    {"FileSource",                 0xA300},
167
    {"SceneType",                  0xA301},
168
    {"CFAPattern",                 0xA302},
169
    {"CustomRendered",             0xA401},
170
    {"ExposureMode",               0xA402},
171
    {"WhiteBalance",               0xA403},
172
    {"DigitalZoomRatio",           0xA404},
173
    {"FocalLengthIn35mmFilm",      0xA405},
174
    {"SceneCaptureType",           0xA406},
175
    {"GainControl",                0xA407},
176
    {"Contrast",                   0xA408},
177
    {"Saturation",                 0xA409},
178
    {"Sharpness",                  0xA40A},
179
    {"DeviceSettingDescription",   0xA40B},
180
    {"SubjectDistanceRange",       0xA40C},
181
182
    /* InteropIFD tags */
183
    {"RelatedImageFileFormat",     0x1000},
184
    {"RelatedImageWidth",          0x1001},
185
    {"RelatedImageLength",         0x1002},
186
187
    /* private EXIF tags */
188
    {"PrintImageMatching",         0xC4A5}, // <- undocumented meaning
189
190
    /* IFD tags */
191
    {"ExifIFD",                    0x8769}, // <- An IFD pointing to standard Exif metadata
192
    {"GPSInfo",                    0x8825}, // <- An IFD pointing to GPS Exif Metadata
193
    {"InteropIFD",                 0xA005}, // <- Table 13 Interoperability IFD Attribute Information
194
    {"GlobalParametersIFD",        0x0190},
195
    {"ProfileIFD",                 0xc6f5},
196
197
    /* Extra FFmpeg tags */
198
    { "IFD1",                      0xFFFC},
199
    { "IFD2",                      0xFFFB},
200
    { "IFD3",                      0xFFFA},
201
    { "IFD4",                      0xFFF9},
202
    { "IFD5",                      0xFFF8},
203
    { "IFD6",                      0xFFF7},
204
    { "IFD7",                      0xFFF6},
205
    { "IFD8",                      0xFFF5},
206
    { "IFD9",                      0xFFF4},
207
    { "IFD10",                     0xFFF3},
208
    { "IFD11",                     0xFFF2},
209
    { "IFD12",                     0xFFF1},
210
    { "IFD13",                     0xFFF0},
211
    { "IFD14",                     0xFFEF},
212
    { "IFD15",                     0xFFEE},
213
    { "IFD16",                     0xFFED},
214
};
215
216
/* same as type_sizes but with string == 1 */
217
static const size_t exif_sizes[] = {
218
    [0] = 0,
219
    [AV_TIFF_BYTE] = 1,
220
    [AV_TIFF_STRING] = 1,
221
    [AV_TIFF_SHORT] = 2,
222
    [AV_TIFF_LONG] = 4,
223
    [AV_TIFF_RATIONAL] = 8,
224
    [AV_TIFF_SBYTE] = 1,
225
    [AV_TIFF_UNDEFINED] = 1,
226
    [AV_TIFF_SSHORT] = 2,
227
    [AV_TIFF_SLONG] = 4,
228
    [AV_TIFF_SRATIONAL] = 8,
229
    [AV_TIFF_FLOAT] = 4,
230
    [AV_TIFF_DOUBLE] = 8,
231
    [AV_TIFF_IFD] = 4,
232
};
233
234
const char *av_exif_get_tag_name(uint16_t id)
235
0
{
236
0
    for (size_t i = 0; i < FF_ARRAY_ELEMS(tag_list); i++) {
237
0
        if (tag_list[i].id == id)
238
0
            return tag_list[i].name;
239
0
    }
240
241
0
    return NULL;
242
0
}
243
244
int32_t av_exif_get_tag_id(const char *name)
245
0
{
246
0
    if (!name)
247
0
        return -1;
248
249
0
    for (size_t i = 0; i < FF_ARRAY_ELEMS(tag_list); i++) {
250
0
        if (!strcmp(tag_list[i].name, name))
251
0
            return tag_list[i].id;
252
0
    }
253
254
0
    return -1;
255
0
}
256
257
static inline void tput16(PutByteContext *pb, const int le, const uint16_t value)
258
0
{
259
0
    le ? bytestream2_put_le16(pb, value) : bytestream2_put_be16(pb, value);
260
0
}
261
262
static inline void tput32(PutByteContext *pb, const int le, const uint32_t value)
263
0
{
264
0
    le ? bytestream2_put_le32(pb, value) : bytestream2_put_be32(pb, value);
265
0
}
266
267
static inline void tput64(PutByteContext *pb, const int le, const uint64_t value)
268
0
{
269
0
    le ? bytestream2_put_le64(pb, value) : bytestream2_put_be64(pb, value);
270
0
}
271
272
static int exif_read_values(void *logctx, GetByteContext *gb, int le, AVExifEntry *entry)
273
0
{
274
0
    if (exif_sizes[entry->type] * entry->count > bytestream2_get_bytes_left(gb))
275
0
        return AVERROR_INVALIDDATA;
276
277
0
    switch (entry->type) {
278
0
        case AV_TIFF_SHORT:
279
0
        case AV_TIFF_LONG:
280
0
            entry->value.uint = av_calloc(entry->count, sizeof(*entry->value.uint));
281
0
            break;
282
0
        case AV_TIFF_SSHORT:
283
0
        case AV_TIFF_SLONG:
284
0
            entry->value.sint = av_calloc(entry->count, sizeof(*entry->value.sint));
285
0
            break;
286
0
        case AV_TIFF_DOUBLE:
287
0
        case AV_TIFF_FLOAT:
288
0
            entry->value.dbl = av_calloc(entry->count, sizeof(*entry->value.dbl));
289
0
            break;
290
0
        case AV_TIFF_RATIONAL:
291
0
        case AV_TIFF_SRATIONAL:
292
0
            entry->value.rat = av_calloc(entry->count, sizeof(*entry->value.rat));
293
0
            break;
294
0
        case AV_TIFF_UNDEFINED:
295
0
        case AV_TIFF_BYTE:
296
0
            entry->value.ubytes = av_mallocz(entry->count);
297
0
            break;
298
0
        case AV_TIFF_SBYTE:
299
0
            entry->value.sbytes = av_mallocz(entry->count);
300
0
            break;
301
0
        case AV_TIFF_STRING:
302
0
            entry->value.str = av_mallocz(entry->count + 1);
303
0
            break;
304
0
        case AV_TIFF_IFD:
305
0
            av_log(logctx, AV_LOG_WARNING, "Bad IFD type for non-IFD tag\n");
306
0
            return AVERROR_INVALIDDATA;
307
0
    }
308
0
    if (!entry->value.ptr)
309
0
        return AVERROR(ENOMEM);
310
0
    switch (entry->type) {
311
0
        case AV_TIFF_SHORT:
312
0
            for (size_t i = 0; i < entry->count; i++)
313
0
                entry->value.uint[i] = ff_tget_short(gb, le);
314
0
            break;
315
0
        case AV_TIFF_LONG:
316
0
            for (size_t i = 0; i < entry->count; i++)
317
0
                entry->value.uint[i] = ff_tget_long(gb, le);
318
0
            break;
319
0
        case AV_TIFF_SSHORT:
320
0
            for (size_t i = 0; i < entry->count; i++)
321
0
                entry->value.sint[i] = (int16_t) ff_tget_short(gb, le);
322
0
            break;
323
0
        case AV_TIFF_SLONG:
324
0
            for (size_t i = 0; i < entry->count; i++)
325
0
                entry->value.sint[i] = (int32_t) ff_tget_long(gb, le);
326
0
            break;
327
0
        case AV_TIFF_DOUBLE:
328
0
            for (size_t i = 0; i < entry->count; i++)
329
0
                entry->value.dbl[i] = ff_tget_double(gb, le);
330
0
            break;
331
0
        case AV_TIFF_FLOAT:
332
0
            for (size_t i = 0; i < entry->count; i++) {
333
0
                av_alias32 alias = { .u32 = ff_tget_long(gb, le) };
334
0
                entry->value.dbl[i] = alias.f32;
335
0
            }
336
0
            break;
337
0
        case AV_TIFF_RATIONAL:
338
0
        case AV_TIFF_SRATIONAL:
339
0
            for (size_t i = 0; i < entry->count; i++) {
340
0
                int32_t num = ff_tget_long(gb, le);
341
0
                int32_t den = ff_tget_long(gb, le);
342
0
                entry->value.rat[i] = av_make_q(num, den);
343
0
            }
344
0
            break;
345
0
        case AV_TIFF_UNDEFINED:
346
0
        case AV_TIFF_BYTE:
347
            /* these three fields are aliased to entry->value.ptr via a union */
348
            /* and entry->value.ptr will always be nonzero here */
349
0
            av_assert0(entry->value.ubytes);
350
0
            bytestream2_get_buffer(gb, entry->value.ubytes, entry->count);
351
0
            break;
352
0
        case AV_TIFF_SBYTE:
353
0
            av_assert0(entry->value.sbytes);
354
0
            bytestream2_get_buffer(gb, entry->value.sbytes, entry->count);
355
0
            break;
356
0
        case AV_TIFF_STRING:
357
0
            av_assert0(entry->value.str);
358
0
            bytestream2_get_buffer(gb, entry->value.str, entry->count);
359
0
            break;
360
0
    }
361
362
0
    return 0;
363
0
}
364
365
static void exif_write_values(PutByteContext *pb, int le, const AVExifEntry *entry)
366
0
{
367
0
    switch (entry->type) {
368
0
        case AV_TIFF_SHORT:
369
0
            for (size_t i = 0; i < entry->count; i++)
370
0
                tput16(pb, le, entry->value.uint[i]);
371
0
            break;
372
0
        case AV_TIFF_LONG:
373
0
            for (size_t i = 0; i < entry->count; i++)
374
0
                tput32(pb, le, entry->value.uint[i]);
375
0
            break;
376
0
        case AV_TIFF_SSHORT:
377
0
            for (size_t i = 0; i < entry->count; i++)
378
0
                tput16(pb, le, entry->value.sint[i]);
379
0
            break;
380
0
        case AV_TIFF_SLONG:
381
0
            for (size_t i = 0; i < entry->count; i++)
382
0
                tput32(pb, le, entry->value.sint[i]);
383
0
            break;
384
0
        case AV_TIFF_DOUBLE:
385
0
            for (size_t i = 0; i < entry->count; i++) {
386
0
                const av_alias64 a = { .f64 = entry->value.dbl[i] };
387
0
                tput64(pb, le, a.u64);
388
0
            }
389
0
            break;
390
0
        case AV_TIFF_FLOAT:
391
0
            for (size_t i = 0; i < entry->count; i++) {
392
0
                const av_alias32 a = { .f32 = entry->value.dbl[i] };
393
0
                tput32(pb, le, a.u32);
394
0
            }
395
0
            break;
396
0
        case AV_TIFF_RATIONAL:
397
0
        case AV_TIFF_SRATIONAL:
398
0
            for (size_t i = 0; i < entry->count; i++) {
399
0
                tput32(pb, le, entry->value.rat[i].num);
400
0
                tput32(pb, le, entry->value.rat[i].den);
401
0
            }
402
0
            break;
403
0
        case AV_TIFF_UNDEFINED:
404
0
        case AV_TIFF_BYTE:
405
0
            bytestream2_put_buffer(pb, entry->value.ubytes, entry->count);
406
0
            break;
407
0
        case AV_TIFF_SBYTE:
408
0
            bytestream2_put_buffer(pb, entry->value.sbytes, entry->count);
409
0
            break;
410
0
        case AV_TIFF_STRING:
411
0
            bytestream2_put_buffer(pb, entry->value.str, entry->count);
412
0
            break;
413
0
    }
414
0
}
415
416
static const uint8_t aoc_header[] = { 'A', 'O', 'C', 0, };
417
static const uint8_t casio_header[] = { 'Q', 'V', 'C', 0, 0, 0, };
418
static const uint8_t foveon_header[] = { 'F', 'O', 'V', 'E', 'O', 'N', 0, 0, };
419
static const uint8_t fuji_header[] = { 'F', 'U', 'J', 'I', };
420
static const uint8_t nikon_header[] = { 'N', 'i', 'k', 'o', 'n', 0, };
421
static const uint8_t olympus1_header[] = { 'O', 'L', 'Y', 'M', 'P', 0, };
422
static const uint8_t olympus2_header[] = { 'O', 'L', 'Y', 'M', 'P', 'U', 'S', 0, 'I', 'I', };
423
static const uint8_t panasonic_header[] = { 'P', 'a', 'n', 'a', 's', 'o', 'n', 'i', 'c', 0, 0, 0, };
424
static const uint8_t sigma_header[] = { 'S', 'I', 'G', 'M', 'A', 0, 0, 0, };
425
static const uint8_t sony_header[] = { 'S', 'O', 'N', 'Y', ' ', 'D', 'S', 'C', ' ', 0, 0, 0, };
426
427
struct exif_makernote_data {
428
    const uint8_t *header;
429
    size_t header_size;
430
    int result;
431
};
432
433
#define MAKERNOTE_STRUCT(h, r) { \
434
    .header = (h),               \
435
    .header_size = sizeof((h)),  \
436
    .result = (r),               \
437
}
438
439
static const struct exif_makernote_data makernote_data[] = {
440
    MAKERNOTE_STRUCT(aoc_header, 6),
441
    MAKERNOTE_STRUCT(casio_header, -1),
442
    MAKERNOTE_STRUCT(foveon_header, 10),
443
    MAKERNOTE_STRUCT(fuji_header, -1),
444
    MAKERNOTE_STRUCT(olympus1_header, 8),
445
    MAKERNOTE_STRUCT(olympus2_header, -1),
446
    MAKERNOTE_STRUCT(panasonic_header, 12),
447
    MAKERNOTE_STRUCT(sigma_header, 10),
448
    MAKERNOTE_STRUCT(sony_header, 12),
449
};
450
451
/*
452
 * derived from Exiv2 MakerNote's article
453
 * https://exiv2.org/makernote.html or archived at
454
 * https://web.archive.org/web/20250311155857/https://exiv2.org/makernote.html
455
 */
456
static int exif_get_makernote_offset(GetByteContext *gb)
457
0
{
458
0
    if (bytestream2_get_bytes_left(gb) < BASE_TAG_SIZE)
459
0
        return -1;
460
461
0
    for (int i = 0; i < FF_ARRAY_ELEMS(makernote_data); i++) {
462
0
        if (!memcmp(gb->buffer, makernote_data[i].header, makernote_data[i].header_size))
463
0
            return makernote_data[i].result;
464
0
    }
465
466
0
    if (!memcmp(gb->buffer, nikon_header, sizeof(nikon_header))) {
467
0
        if (bytestream2_get_bytes_left(gb) < 14)
468
0
            return -1;
469
0
        else if (AV_RB32(gb->buffer + 10) == EXIF_MM_LONG || AV_RB32(gb->buffer + 10) == EXIF_II_LONG)
470
0
            return -1;
471
0
        return 8;
472
0
    }
473
474
0
    return 0;
475
0
}
476
477
static int exif_parse_ifd_list(void *logctx, GetByteContext *gb, int le,
478
                               int depth, AVExifMetadata *ifd, int guess);
479
480
static int exif_decode_tag(void *logctx, GetByteContext *gb, int le,
481
                           int depth, AVExifEntry *entry)
482
0
{
483
0
    int ret = 0, makernote_offset = -1, tell, is_ifd, count;
484
0
    enum AVTiffDataType type;
485
0
    uint32_t payload;
486
487
    /* safety check to prevent infinite recursion on malicious IFDs */
488
0
    if (depth > 3)
489
0
        return AVERROR_INVALIDDATA;
490
491
0
    tell = bytestream2_tell(gb);
492
493
0
    entry->id = ff_tget_short(gb, le);
494
0
    type = ff_tget_short(gb, le);
495
0
    count = ff_tget_long(gb, le);
496
0
    payload = ff_tget_long(gb, le);
497
498
0
    av_log(logctx, AV_LOG_DEBUG, "TIFF Tag: id: 0x%04x, type: %d, count: %u, offset: %d, "
499
0
                                 "payload: %" PRIu32 "\n", entry->id, type, count, tell, payload);
500
501
0
    if (!type) {
502
0
        av_log(logctx, AV_LOG_DEBUG, "Skipping invalid TIFF tag 0\n");
503
0
        goto end;
504
0
    }
505
506
    /* AV_TIFF_IFD is the largest, numerically */
507
0
    if (type > AV_TIFF_IFD || count >= INT_MAX/8U)
508
0
        return AVERROR_INVALIDDATA;
509
510
0
    is_ifd = type == AV_TIFF_IFD || ff_tis_ifd(entry->id) || entry->id == MAKERNOTE_TAG;
511
512
0
    if (is_ifd) {
513
0
        if (!payload)
514
0
            goto end;
515
0
        bytestream2_seek(gb, payload, SEEK_SET);
516
0
    }
517
518
0
    if (entry->id == MAKERNOTE_TAG) {
519
0
        makernote_offset = exif_get_makernote_offset(gb);
520
0
        if (makernote_offset < 0)
521
0
            is_ifd = 0;
522
0
    }
523
524
0
    if (is_ifd) {
525
0
        entry->type = AV_TIFF_IFD;
526
0
        entry->count = 1;
527
0
        entry->ifd_offset = makernote_offset > 0 ? makernote_offset : 0;
528
0
        if (entry->ifd_offset) {
529
0
            entry->ifd_lead = av_malloc(entry->ifd_offset);
530
0
            if (!entry->ifd_lead)
531
0
                return AVERROR(ENOMEM);
532
0
            bytestream2_get_buffer(gb, entry->ifd_lead, entry->ifd_offset);
533
0
        }
534
0
        ret = exif_parse_ifd_list(logctx, gb, le, depth + 1, &entry->value.ifd, entry->id == MAKERNOTE_TAG);
535
0
        if (ret < 0 && entry->id == MAKERNOTE_TAG) {
536
            /*
537
             * we guessed that MakerNote was an IFD
538
             * but we were probably incorrect at this
539
             * point so we try again as a binary blob
540
             */
541
0
            av_log(logctx, AV_LOG_DEBUG, "unrecognized MakerNote IFD, retrying as blob\n");
542
0
            is_ifd = 0;
543
0
        }
544
0
    }
545
546
    /* inverted condition instead of else so we can fall through from above */
547
0
    if (!is_ifd) {
548
0
        entry->type = type == AV_TIFF_IFD ? AV_TIFF_UNDEFINED : type;
549
0
        entry->count = count;
550
0
        bytestream2_seek(gb, count * exif_sizes[type] > 4 ? payload : tell + 8, SEEK_SET);
551
0
        ret = exif_read_values(logctx, gb, le, entry);
552
0
    }
553
554
0
end:
555
0
    bytestream2_seek(gb, tell + BASE_TAG_SIZE, SEEK_SET);
556
557
0
    return ret;
558
0
}
559
560
static int exif_parse_ifd_list(void *logctx, GetByteContext *gb, int le,
561
                               int depth, AVExifMetadata *ifd, int guess)
562
0
{
563
0
    uint32_t entries;
564
0
    size_t required_size;
565
0
    void *temp;
566
0
    int ret = 0;
567
568
0
    av_log(logctx, AV_LOG_DEBUG, "parsing IFD list at offset: %d\n", bytestream2_tell(gb));
569
570
0
    if (bytestream2_get_bytes_left(gb) < 2) {
571
0
        av_log(logctx, guess ? AV_LOG_DEBUG : AV_LOG_ERROR,
572
0
               "not enough bytes remaining in EXIF buffer: 2 required\n");
573
0
        ret = AVERROR_INVALIDDATA;
574
0
        goto end;
575
0
    }
576
577
0
    entries = ff_tget_short(gb, le);
578
0
    if (bytestream2_get_bytes_left(gb) < entries * BASE_TAG_SIZE) {
579
0
        av_log(logctx, guess ? AV_LOG_DEBUG : AV_LOG_ERROR,
580
0
               "not enough bytes remaining in EXIF buffer. entries: %" PRIu32 "\n", entries);
581
0
        ret = AVERROR_INVALIDDATA;
582
0
        goto end;
583
0
    }
584
0
    if (entries > 4096) {
585
        /* that is a lot of entries, probably an error */
586
0
        av_log(logctx, guess ? AV_LOG_DEBUG : AV_LOG_ERROR,
587
0
               "too many entries: %" PRIu32 "\n", entries);
588
0
        ret = AVERROR_INVALIDDATA;
589
0
        goto end;
590
0
    }
591
592
0
    ifd->count = entries;
593
0
    av_log(logctx, AV_LOG_DEBUG, "entry count for IFD: %u\n", ifd->count);
594
595
    /* empty IFD is technically legal but equivalent to no metadata present */
596
0
    if (!ifd->count) {
597
0
        ret = 0;
598
0
        goto end;
599
0
    }
600
601
0
    if (av_size_mult(ifd->count, sizeof(*ifd->entries), &required_size) < 0) {
602
0
        ret = AVERROR(ENOMEM);
603
0
        goto end;
604
0
    }
605
0
    temp = av_fast_realloc(ifd->entries, &ifd->size, required_size);
606
0
    if (!temp) {
607
0
        av_freep(&ifd->entries);
608
0
        ret = AVERROR(ENOMEM);
609
0
        goto end;
610
0
    }
611
0
    ifd->entries = temp;
612
613
    /* entries have pointers in them which can cause issues if */
614
    /* they are freed or realloc'd when garbage */
615
0
    memset(ifd->entries, 0, required_size);
616
617
0
    for (uint32_t i = 0; i < entries; i++) {
618
0
        ret = exif_decode_tag(logctx, gb, le, depth, &ifd->entries[i]);
619
0
        if (ret < 0)
620
0
            goto end;
621
0
    }
622
623
0
end:
624
0
    if (ret < 0) {
625
0
        av_exif_free(ifd);
626
0
        return ret;
627
0
    }
628
    /*
629
     * at the end of an IFD is an pointer to the next IFD
630
     * or zero if there are no more IFDs, which is usually the case
631
     */
632
0
    ret = ff_tget_long(gb, le);
633
634
    /* overflow */
635
0
    if (ret < 0) {
636
0
        ret = AVERROR_INVALIDDATA;
637
0
        av_exif_free(ifd);
638
0
    }
639
640
0
    return ret;
641
0
}
642
643
/*
644
 * note that this function does not free the entry pointer itself
645
 * because it's probably part of a larger array that should be freed
646
 * all at once
647
 */
648
static void exif_free_entry(AVExifEntry *entry)
649
0
{
650
0
    if (!entry)
651
0
        return;
652
0
    if (entry->type == AV_TIFF_IFD)
653
0
        av_exif_free(&entry->value.ifd);
654
0
    else
655
0
        av_freep(&entry->value.ptr);
656
0
    av_freep(&entry->ifd_lead);
657
0
}
658
659
void av_exif_free(AVExifMetadata *ifd)
660
0
{
661
0
    if (!ifd)
662
0
        return;
663
0
    if (!ifd->entries) {
664
0
        ifd->count = 0;
665
0
        ifd->size = 0;
666
0
        return;
667
0
    }
668
0
    for (size_t i = 0; i < ifd->count; i++) {
669
0
        AVExifEntry *entry = &ifd->entries[i];
670
0
        exif_free_entry(entry);
671
0
    }
672
0
    av_freep(&ifd->entries);
673
0
    ifd->count = 0;
674
0
    ifd->size = 0;
675
0
}
676
677
static size_t exif_get_ifd_size(const AVExifMetadata *ifd)
678
0
{
679
    /* 6 == 4 + 2; 2-byte entry-count at the beginning */
680
    /* plus 4-byte next-IFD pointer at the end */
681
0
    size_t total_size = IFD_EXTRA_SIZE;
682
0
    for (size_t i = 0; i < ifd->count; i++) {
683
0
        const AVExifEntry *entry = &ifd->entries[i];
684
0
        if (entry->type == AV_TIFF_IFD) {
685
0
            total_size += BASE_TAG_SIZE + exif_get_ifd_size(&entry->value.ifd) + entry->ifd_offset;
686
0
        } else {
687
0
            size_t payload_size = entry->count * exif_sizes[entry->type];
688
0
            total_size += BASE_TAG_SIZE + (payload_size > 4 ? payload_size : 0);
689
0
        }
690
0
    }
691
0
    return total_size;
692
0
}
693
694
static int exif_write_ifd(void *logctx, PutByteContext *pb, int le, int depth, const AVExifMetadata *ifd)
695
0
{
696
0
    int offset, ret, tell, tell2;
697
0
    tell = bytestream2_tell_p(pb);
698
0
    tput16(pb, le, ifd->count);
699
0
    offset = tell + IFD_EXTRA_SIZE + BASE_TAG_SIZE * (uint32_t) ifd->count;
700
0
    av_log(logctx, AV_LOG_DEBUG, "writing IFD with %u entries and initial offset %d\n", ifd->count, offset);
701
0
    for (size_t i = 0; i < ifd->count; i++) {
702
0
        const AVExifEntry *entry = &ifd->entries[i];
703
0
        av_log(logctx, AV_LOG_DEBUG, "writing TIFF entry: id: 0x%04" PRIx16 ", type: %d, count: %"
704
0
                                      PRIu32 ", offset: %d, offset value: %d\n",
705
0
                                      entry->id, entry->type, entry->count,
706
0
                                      bytestream2_tell_p(pb), offset);
707
0
        tput16(pb, le, entry->id);
708
0
        if (entry->id == MAKERNOTE_TAG && entry->type == AV_TIFF_IFD) {
709
0
            size_t ifd_size = exif_get_ifd_size(&entry->value.ifd);
710
0
            tput16(pb, le, AV_TIFF_UNDEFINED);
711
0
            tput32(pb, le, ifd_size);
712
0
        } else {
713
0
            tput16(pb, le, entry->type);
714
0
            tput32(pb, le, entry->count);
715
0
        }
716
0
        if (entry->type == AV_TIFF_IFD) {
717
0
            tput32(pb, le, offset);
718
0
            tell2 = bytestream2_tell_p(pb);
719
0
            bytestream2_seek_p(pb, offset, SEEK_SET);
720
0
            if (entry->ifd_offset)
721
0
                bytestream2_put_buffer(pb, entry->ifd_lead, entry->ifd_offset);
722
0
            ret = exif_write_ifd(logctx, pb, le, depth + 1, &entry->value.ifd);
723
0
            if (ret < 0)
724
0
                return ret;
725
0
            offset += ret + entry->ifd_offset;
726
0
            bytestream2_seek_p(pb, tell2, SEEK_SET);
727
0
        } else {
728
0
            size_t payload_size = entry->count * exif_sizes[entry->type];
729
0
            if (payload_size > 4) {
730
0
                tput32(pb, le, offset);
731
0
                tell2 = bytestream2_tell_p(pb);
732
0
                bytestream2_seek_p(pb, offset, SEEK_SET);
733
0
                exif_write_values(pb, le, entry);
734
0
                offset += payload_size;
735
0
                bytestream2_seek_p(pb, tell2, SEEK_SET);
736
0
            } else {
737
                /* zero uninitialized excess payload values */
738
0
                AV_WN32(pb->buffer, 0);
739
0
                exif_write_values(pb, le, entry);
740
0
                bytestream2_seek_p(pb, 4 - payload_size, SEEK_CUR);
741
0
            }
742
0
        }
743
0
    }
744
745
    /*
746
     * we write 0 if this is the top-level exif IFD
747
     * indicating that there are no more IFD pointers
748
     */
749
0
    tput32(pb, le, depth ? offset : 0);
750
0
    return offset - tell;
751
0
}
752
753
int av_exif_write(void *logctx, const AVExifMetadata *ifd, AVBufferRef **buffer, enum AVExifHeaderMode header_mode)
754
0
{
755
0
    AVBufferRef *buf = NULL;
756
0
    size_t size, headsize = 8;
757
0
    PutByteContext pb;
758
0
    int ret = 0, off = 0, next;
759
0
    AVExifMetadata *ifd_new = NULL;
760
0
    AVExifMetadata extra_ifds[16] = { 0 };
761
762
0
    int le = 1;
763
764
0
    if (*buffer) {
765
0
        ret = AVERROR(EINVAL);
766
0
        goto end;
767
0
    }
768
769
0
    size = exif_get_ifd_size(ifd);
770
0
    switch (header_mode) {
771
0
        case AV_EXIF_EXIF00:
772
0
            off = 6;
773
0
            break;
774
0
        case AV_EXIF_T_OFF:
775
0
            off = 4;
776
0
            break;
777
0
        case AV_EXIF_ASSUME_BE:
778
0
            le = 0;
779
0
            headsize = 0;
780
0
            break;
781
0
        case AV_EXIF_ASSUME_LE:
782
0
            le = 1;
783
0
            headsize = 0;
784
0
            break;
785
0
    }
786
787
0
    ret = av_buffer_realloc(&buf, size + off + headsize);
788
0
    if (ret < 0)
789
0
        goto end;
790
791
0
    if (header_mode == AV_EXIF_EXIF00) {
792
0
        AV_WL32(buf->data, MKTAG('E','x','i','f'));
793
0
        AV_WN16(buf->data + 4, 0);
794
0
    } else if (header_mode == AV_EXIF_T_OFF) {
795
0
        AV_WN32(buf->data, 0);
796
0
    }
797
798
0
    bytestream2_init_writer(&pb, buf->data + off, buf->size - off);
799
800
0
    if (header_mode != AV_EXIF_ASSUME_BE && header_mode != AV_EXIF_ASSUME_LE) {
801
        /* these constants are be32 in both cases */
802
        /* le == 1 always in this case */
803
0
        bytestream2_put_be32(&pb, EXIF_II_LONG);
804
0
        tput32(&pb, le, 8);
805
0
    }
806
807
0
    int extras = 0;
808
0
    for (int i = 0; i < FF_ARRAY_ELEMS(extra_ifds); i++) {
809
0
        AVExifEntry *extra_entry = NULL;
810
0
        uint16_t extra_tag = 0xFFFCu - i;
811
0
        ret = av_exif_get_entry(logctx, (AVExifMetadata *) ifd, extra_tag, 0, &extra_entry);
812
0
        if (ret < 0)
813
0
            break;
814
0
        if (!ret)
815
0
            continue;
816
0
        av_log(logctx, AV_LOG_DEBUG, "found extra IFD tag: %04x\n", extra_tag);
817
0
        if (!ifd_new) {
818
0
            ifd_new = av_exif_clone_ifd(ifd);
819
0
            if (!ifd_new)
820
0
                break;
821
0
            ifd = ifd_new;
822
0
        }
823
        /* calling remove_entry will call av_exif_free on the original */
824
0
        AVExifMetadata *cloned = av_exif_clone_ifd(&extra_entry->value.ifd);
825
0
        if (!cloned)
826
0
            break;
827
0
        extra_ifds[extras++] = *cloned;
828
        /* don't use av_exif_free here, we want to preserve internals */
829
0
        av_free(cloned);
830
0
        ret = av_exif_remove_entry(logctx, ifd_new, extra_tag, 0);
831
0
        if (ret < 0)
832
0
            break;
833
0
    }
834
835
0
    if (ret < 0) {
836
0
        av_log(logctx, AV_LOG_ERROR, "error popping additional IFD: %s\n", av_err2str(ret));
837
0
        goto end;
838
0
    }
839
840
0
    next = bytestream2_tell_p(&pb);
841
0
    ret = exif_write_ifd(logctx, &pb, le, 0, ifd);
842
0
    if (ret < 0) {
843
0
        av_log(logctx, AV_LOG_ERROR, "error writing EXIF data: %s\n", av_err2str(ret));
844
0
        goto end;
845
0
    }
846
0
    next += ret;
847
848
0
    for (int i = 0; i < extras; i++) {
849
0
        av_log(logctx, AV_LOG_DEBUG, "writing additional ifd at: %d\n", next);
850
        /* exif_write_ifd always writes 0 i.e. last ifd so we overwrite that here */
851
0
        bytestream2_seek_p(&pb, -4, SEEK_CUR);
852
0
        tput32(&pb, le, next);
853
0
        bytestream2_seek_p(&pb, next, SEEK_SET);
854
0
        ret = exif_write_ifd(logctx, &pb, le, 0, &extra_ifds[i]);
855
0
        if (ret < 0) {
856
0
            av_log(logctx, AV_LOG_ERROR, "error writing additional IFD: %s\n", av_err2str(ret));
857
0
            goto end;
858
0
        }
859
0
        next += ret;
860
0
    }
861
862
    /* shrink the buffer to the amount of data we actually used */
863
    /* extras don't contribute the initial BASE_TAG_SIZE each */
864
0
    ret = av_buffer_realloc(&buf, buf->size - BASE_TAG_SIZE * extras);
865
0
    if (ret < 0)
866
0
        goto end;
867
868
0
    *buffer = buf;
869
0
    ret = 0;
870
871
0
end:
872
0
    av_exif_free(ifd_new);
873
0
    av_freep(&ifd_new);
874
0
    for (int i = 0; i < FF_ARRAY_ELEMS(extra_ifds); i++)
875
0
        av_exif_free(&extra_ifds[i]);
876
0
    if (ret < 0)
877
0
        av_buffer_unref(&buf);
878
879
0
    return ret;
880
0
}
881
882
int av_exif_parse_buffer(void *logctx, const uint8_t *buf, size_t size,
883
                         AVExifMetadata *ifd, enum AVExifHeaderMode header_mode)
884
0
{
885
0
    int ret, le;
886
0
    GetByteContext gbytes;
887
0
    if (size > INT_MAX)
888
0
        return AVERROR(EINVAL);
889
0
    size_t off = 0;
890
0
    switch (header_mode) {
891
0
        case AV_EXIF_EXIF00:
892
0
            if (size < 6)
893
0
                return AVERROR_INVALIDDATA;
894
0
            off = 6;
895
0
            av_fallthrough;
896
0
        case AV_EXIF_T_OFF:
897
0
            if (size < 4)
898
0
                return AVERROR_INVALIDDATA;
899
0
            if (!off)
900
0
                off = AV_RB32(buf) + 4;
901
0
            av_fallthrough;
902
0
        case AV_EXIF_TIFF_HEADER: {
903
0
            int ifd_offset;
904
0
            if (size <= off)
905
0
                return AVERROR_INVALIDDATA;
906
0
            bytestream2_init(&gbytes, buf + off, size - off);
907
            // read TIFF header
908
0
            ret = ff_tdecode_header(&gbytes, &le, &ifd_offset);
909
0
            if (ret < 0) {
910
0
                av_log(logctx, AV_LOG_ERROR, "invalid TIFF header in EXIF data: %s\n", av_err2str(ret));
911
0
                return ret;
912
0
            }
913
0
            bytestream2_seek(&gbytes, ifd_offset, SEEK_SET);
914
0
            break;
915
0
        }
916
0
        case AV_EXIF_ASSUME_LE:
917
0
            le = 1;
918
0
            bytestream2_init(&gbytes, buf, size);
919
0
            break;
920
0
        case AV_EXIF_ASSUME_BE:
921
0
            le = 0;
922
0
            bytestream2_init(&gbytes, buf, size);
923
0
            break;
924
0
        default:
925
0
            return AVERROR(EINVAL);
926
0
    }
927
928
    /*
929
     * parse IFD0 here. If the return value is positive that tells us
930
     * there is subimage metadata, but we don't parse that IFD here
931
     */
932
0
    ret = exif_parse_ifd_list(logctx, &gbytes, le, 0, ifd, 0);
933
0
    if (ret < 0) {
934
0
        av_log(logctx, AV_LOG_ERROR, "error decoding EXIF data: %s\n", av_err2str(ret));
935
0
        return ret;
936
0
    }
937
0
    if (!ret)
938
0
        goto finish;
939
0
    int next = ret;
940
0
    bytestream2_seek(&gbytes, next, SEEK_SET);
941
942
    /* cap at 16 extra IFDs for sanity/parse security */
943
0
    for (int extra_tag = 0xFFFCu; extra_tag > 0xFFECu; extra_tag--) {
944
0
        AVExifMetadata extra_ifd = { 0 };
945
0
        ret = exif_parse_ifd_list(logctx, &gbytes, le, 0, &extra_ifd, 1);
946
0
        if (ret < 0) {
947
0
            av_exif_free(&extra_ifd);
948
0
            break;
949
0
        }
950
0
        next = ret;
951
0
        av_log(logctx, AV_LOG_DEBUG, "found extra IFD: %04x with next=%d\n", extra_tag, ret);
952
0
        bytestream2_seek(&gbytes, next, SEEK_SET);
953
0
        ret = av_exif_set_entry(logctx, ifd, extra_tag, AV_TIFF_IFD, 1, NULL, 0, &extra_ifd);
954
0
        av_exif_free(&extra_ifd);
955
0
        if (ret < 0 || !next || bytestream2_get_bytes_left(&gbytes) <= 0)
956
0
            break;
957
0
    }
958
959
0
finish:
960
0
    return bytestream2_tell(&gbytes) + off;
961
0
}
962
963
0
#define COLUMN_SEP(i, c) ((i) ? ((i) % (c) ? ", " : "\n") : "")
964
965
static int exif_ifd_to_dict(void *logctx, const char *prefix, const AVExifMetadata *ifd, AVDictionary **metadata)
966
0
{
967
0
    AVBPrint bp;
968
0
    int ret = 0;
969
0
    char *key = NULL;
970
0
    char *value = NULL;
971
972
0
    if (!prefix)
973
0
        prefix = "";
974
975
0
    for (uint16_t i = 0; i < ifd->count; i++) {
976
0
        const AVExifEntry *entry = &ifd->entries[i];
977
0
        const char *name = av_exif_get_tag_name(entry->id);
978
0
        av_bprint_init(&bp, entry->count * 10, AV_BPRINT_SIZE_UNLIMITED);
979
0
        if (*prefix)
980
0
            av_bprintf(&bp, "%s/", prefix);
981
0
        if (name)
982
0
            av_bprintf(&bp, "%s", name);
983
0
        else
984
0
            av_bprintf(&bp, "0x%04X", entry->id);
985
0
        ret = av_bprint_finalize(&bp, &key);
986
0
        if (ret < 0)
987
0
            goto end;
988
0
        av_bprint_init(&bp, entry->count * 10, AV_BPRINT_SIZE_UNLIMITED);
989
0
        switch (entry->type) {
990
0
            case AV_TIFF_IFD:
991
0
                ret = exif_ifd_to_dict(logctx, key, &entry->value.ifd, metadata);
992
0
                if (ret < 0)
993
0
                    goto end;
994
0
                break;
995
0
            case AV_TIFF_SHORT:
996
0
            case AV_TIFF_LONG:
997
0
                for (uint32_t j = 0; j < entry->count; j++)
998
0
                    av_bprintf(&bp, "%s%7" PRIu32, COLUMN_SEP(j, 8), (uint32_t)entry->value.uint[j]);
999
0
                break;
1000
0
            case AV_TIFF_SSHORT:
1001
0
            case AV_TIFF_SLONG:
1002
0
                for (uint32_t j = 0; j < entry->count; j++)
1003
0
                    av_bprintf(&bp, "%s%7" PRId32, COLUMN_SEP(j, 8), (int32_t)entry->value.sint[j]);
1004
0
                break;
1005
0
            case AV_TIFF_RATIONAL:
1006
0
            case AV_TIFF_SRATIONAL:
1007
0
                for (uint32_t j = 0; j < entry->count; j++)
1008
0
                    av_bprintf(&bp, "%s%7i:%-7i", COLUMN_SEP(j, 4), entry->value.rat[j].num, entry->value.rat[j].den);
1009
0
                break;
1010
0
            case AV_TIFF_DOUBLE:
1011
0
            case AV_TIFF_FLOAT:
1012
0
                for (uint32_t j = 0; j < entry->count; j++)
1013
0
                    av_bprintf(&bp, "%s%.15g", COLUMN_SEP(j, 4), entry->value.dbl[j]);
1014
0
                break;
1015
0
            case AV_TIFF_STRING:
1016
0
                av_bprintf(&bp, "%s", entry->value.str);
1017
0
                break;
1018
0
            case AV_TIFF_UNDEFINED:
1019
0
            case AV_TIFF_BYTE:
1020
0
                for (uint32_t j = 0; j < entry->count; j++)
1021
0
                    av_bprintf(&bp, "%s%3i", COLUMN_SEP(j, 16), entry->value.ubytes[j]);
1022
0
                break;
1023
0
            case AV_TIFF_SBYTE:
1024
0
                for (uint32_t j = 0; j < entry->count; j++)
1025
0
                    av_bprintf(&bp, "%s%3i", COLUMN_SEP(j, 16), entry->value.sbytes[j]);
1026
0
                break;
1027
0
        }
1028
0
        if (entry->type != AV_TIFF_IFD) {
1029
0
            if (!av_bprint_is_complete(&bp)) {
1030
0
                av_bprint_finalize(&bp, NULL);
1031
0
                ret = AVERROR(ENOMEM);
1032
0
                goto end;
1033
0
            }
1034
0
            ret = av_bprint_finalize(&bp, &value);
1035
0
            if (ret < 0)
1036
0
                goto end;
1037
0
            ret = av_dict_set(metadata, key, value, AV_DICT_DONT_STRDUP_KEY | AV_DICT_DONT_STRDUP_VAL);
1038
0
            key = NULL;
1039
0
            value = NULL;
1040
0
            if (ret < 0)
1041
0
                goto end;
1042
0
        } else {
1043
0
            av_freep(&key);
1044
0
        }
1045
0
    }
1046
1047
0
end:
1048
0
    av_freep(&key);
1049
0
    av_freep(&value);
1050
0
    return ret;
1051
0
}
1052
1053
int av_exif_ifd_to_dict(void *logctx, const AVExifMetadata *ifd, AVDictionary **metadata)
1054
0
{
1055
0
    return exif_ifd_to_dict(logctx, "", ifd, metadata);
1056
0
}
1057
1058
#if LIBAVCODEC_VERSION_MAJOR < 63
1059
int avpriv_exif_decode_ifd(void *logctx, const uint8_t *buf, int size,
1060
                           int le, int depth, AVDictionary **metadata)
1061
0
{
1062
0
    AVExifMetadata ifd = { 0 };
1063
0
    GetByteContext gb;
1064
0
    int ret;
1065
0
    bytestream2_init(&gb, buf, size);
1066
0
    ret = exif_parse_ifd_list(logctx, &gb, le, depth, &ifd, 0);
1067
0
    if (ret < 0)
1068
0
        return ret;
1069
0
    ret = av_exif_ifd_to_dict(logctx, &ifd, metadata);
1070
0
    av_exif_free(&ifd);
1071
0
    return ret;
1072
0
}
1073
#endif
1074
1075
0
#define EXIF_COPY(fname, srcname) do { \
1076
0
    size_t sz; \
1077
0
    if (av_size_mult(src->count, sizeof(*(fname)), &sz) < 0) { \
1078
0
        ret = AVERROR(ENOMEM); \
1079
0
        goto end; \
1080
0
    } \
1081
0
    (fname) = av_memdup((srcname), sz); \
1082
0
    if (!(fname)) { \
1083
0
        ret = AVERROR(ENOMEM); \
1084
0
        goto end; \
1085
0
    } \
1086
0
} while (0)
1087
1088
static int exif_clone_entry(AVExifEntry *dst, const AVExifEntry *src)
1089
0
{
1090
0
    int ret = 0;
1091
1092
0
    memset(dst, 0, sizeof(*dst));
1093
1094
0
    dst->count = src->count;
1095
0
    dst->id = src->id;
1096
0
    dst->type = src->type;
1097
1098
0
    dst->ifd_offset = src->ifd_offset;
1099
0
    if (src->ifd_lead) {
1100
0
        dst->ifd_lead = av_memdup(src->ifd_lead, src->ifd_offset);
1101
0
        if (!dst->ifd_lead) {
1102
0
            ret = AVERROR(ENOMEM);
1103
0
            goto end;
1104
0
        }
1105
0
    } else {
1106
0
        dst->ifd_lead = NULL;
1107
0
    }
1108
1109
0
    switch(src->type) {
1110
0
        case AV_TIFF_IFD: {
1111
0
            AVExifMetadata *cloned = av_exif_clone_ifd(&src->value.ifd);
1112
0
            if (!cloned) {
1113
0
                ret = AVERROR(ENOMEM);
1114
0
                goto end;
1115
0
            }
1116
0
            dst->value.ifd = *cloned;
1117
0
            av_freep(&cloned);
1118
0
            break;
1119
0
        }
1120
0
        case AV_TIFF_SHORT:
1121
0
        case AV_TIFF_LONG:
1122
0
            EXIF_COPY(dst->value.uint, src->value.uint);
1123
0
            break;
1124
0
        case AV_TIFF_SLONG:
1125
0
        case AV_TIFF_SSHORT:
1126
0
            EXIF_COPY(dst->value.sint, src->value.sint);
1127
0
            break;
1128
0
        case AV_TIFF_RATIONAL:
1129
0
        case AV_TIFF_SRATIONAL:
1130
0
            EXIF_COPY(dst->value.rat, src->value.rat);
1131
0
            break;
1132
0
        case AV_TIFF_DOUBLE:
1133
0
        case AV_TIFF_FLOAT:
1134
0
            EXIF_COPY(dst->value.dbl, src->value.dbl);
1135
0
            break;
1136
0
        case AV_TIFF_BYTE:
1137
0
        case AV_TIFF_UNDEFINED:
1138
0
            EXIF_COPY(dst->value.ubytes, src->value.ubytes);
1139
0
            break;
1140
0
        case AV_TIFF_SBYTE:
1141
0
            EXIF_COPY(dst->value.sbytes, src->value.sbytes);
1142
0
            break;
1143
0
        case AV_TIFF_STRING:
1144
0
            dst->value.str = av_memdup(src->value.str, src->count+1);
1145
0
            if (!dst->value.str) {
1146
0
                ret = AVERROR(ENOMEM);
1147
0
                goto end;
1148
0
            }
1149
0
            break;
1150
0
    }
1151
1152
0
    return 0;
1153
1154
0
end:
1155
0
    av_freep(&dst->ifd_lead);
1156
0
    if (src->type == AV_TIFF_IFD)
1157
0
        av_exif_free(&dst->value.ifd);
1158
0
    else
1159
0
        av_freep(&dst->value.ptr);
1160
0
    memset(dst, 0, sizeof(*dst));
1161
1162
0
    return ret;
1163
0
}
1164
1165
static int exif_get_entry(void *logctx, AVExifMetadata *ifd, uint16_t id, int depth, AVExifEntry **value)
1166
0
{
1167
0
    int offset = 1;
1168
1169
0
    if (!ifd || ifd->count && !ifd->entries || !value)
1170
0
        return AVERROR(EINVAL);
1171
1172
0
    for (size_t i = 0; i < ifd->count; i++) {
1173
0
        if (ifd->entries[i].id == id) {
1174
0
            *value = &ifd->entries[i];
1175
0
            return i + offset;
1176
0
        }
1177
0
        if (ifd->entries[i].type == AV_TIFF_IFD) {
1178
0
            if (depth < 3) {
1179
0
                int ret = exif_get_entry(logctx, &ifd->entries[i].value.ifd, id, depth + 1, value);
1180
0
                if (ret)
1181
0
                    return ret < 0 ? ret : ret + offset;
1182
0
            }
1183
0
            offset += ifd->entries[i].value.ifd.count;
1184
0
        }
1185
0
    }
1186
1187
0
    return 0;
1188
0
}
1189
1190
int av_exif_get_entry(void *logctx, AVExifMetadata *ifd, uint16_t id, int flags, AVExifEntry **value)
1191
0
{
1192
0
    return exif_get_entry(logctx, ifd, id, (flags & AV_EXIF_FLAG_RECURSIVE) ? 0 : INT_MAX, value);
1193
0
}
1194
1195
int av_exif_set_entry(void *logctx, AVExifMetadata *ifd, uint16_t id, enum AVTiffDataType type,
1196
    uint32_t count, const uint8_t *ifd_lead, uint32_t ifd_offset, const void *value)
1197
0
{
1198
0
    void *temp;
1199
0
    int ret = 0;
1200
0
    AVExifEntry *entry = NULL;
1201
0
    AVExifEntry src = { 0 };
1202
1203
0
    if (!ifd || ifd->count && !ifd->entries
1204
0
             || ifd_lead && !ifd_offset || !ifd_lead && ifd_offset
1205
0
             || !value || ifd->count == 0xFFFFu)
1206
0
        return AVERROR(EINVAL);
1207
1208
0
    ret = av_exif_get_entry(logctx, ifd, id, 0, &entry);
1209
0
    if (ret < 0)
1210
0
        return ret;
1211
1212
0
    if (entry) {
1213
0
        exif_free_entry(entry);
1214
0
    } else {
1215
0
        size_t required_size;
1216
0
        ret = av_size_mult(ifd->count + 1, sizeof(*ifd->entries), &required_size);
1217
0
        if (ret < 0)
1218
0
            return AVERROR(ENOMEM);
1219
0
        temp = av_fast_realloc(ifd->entries, &ifd->size, required_size);
1220
0
        if (!temp)
1221
0
            return AVERROR(ENOMEM);
1222
0
        ifd->entries = temp;
1223
0
        entry = &ifd->entries[ifd->count++];
1224
0
    }
1225
1226
0
    src.count = count;
1227
0
    src.id = id;
1228
0
    src.type = type;
1229
0
    src.ifd_lead = (uint8_t *) ifd_lead;
1230
0
    src.ifd_offset = ifd_offset;
1231
0
    if (type == AV_TIFF_IFD)
1232
0
        src.value.ifd = * (const AVExifMetadata *) value;
1233
0
    else
1234
0
        src.value.ptr = (void *) value;
1235
1236
0
    ret = exif_clone_entry(entry, &src);
1237
1238
0
    if (ret < 0)
1239
0
        ifd->count--;
1240
1241
0
    return ret;
1242
0
}
1243
1244
static int exif_remove_entry(void *logctx, AVExifMetadata *ifd, uint16_t id, int depth)
1245
0
{
1246
0
    int32_t index = -1;
1247
0
    int ret = 0;
1248
1249
0
    if (!ifd || ifd->count && !ifd->entries)
1250
0
        return AVERROR(EINVAL);
1251
1252
0
    for (size_t i = 0; i < ifd->count; i++) {
1253
0
        if (ifd->entries[i].id == id) {
1254
0
            index = i;
1255
0
            break;
1256
0
        }
1257
0
        if (ifd->entries[i].type == AV_TIFF_IFD && depth < 3) {
1258
0
            ret = exif_remove_entry(logctx, &ifd->entries[i].value.ifd, id, depth + 1);
1259
0
            if (ret)
1260
0
                return ret;
1261
0
        }
1262
0
    }
1263
1264
0
    if (index < 0)
1265
0
        return 0;
1266
0
    exif_free_entry(&ifd->entries[index]);
1267
1268
0
    if (index == --ifd->count) {
1269
0
        if (!index)
1270
0
            av_freep(&ifd->entries);
1271
0
        return 1;
1272
0
    }
1273
1274
0
    memmove(&ifd->entries[index], &ifd->entries[index + 1], (ifd->count - index) * sizeof(*ifd->entries));
1275
1276
0
    return 1 + (ifd->count - index);
1277
0
}
1278
1279
int av_exif_remove_entry(void *logctx, AVExifMetadata *ifd, uint16_t id, int flags)
1280
0
{
1281
0
    return exif_remove_entry(logctx, ifd, id, (flags & AV_EXIF_FLAG_RECURSIVE) ? 0 : INT_MAX);
1282
0
}
1283
1284
AVExifMetadata *av_exif_clone_ifd(const AVExifMetadata *ifd)
1285
0
{
1286
0
    AVExifMetadata *ret = av_mallocz(sizeof(*ret));
1287
0
    if (!ret)
1288
0
        return NULL;
1289
1290
0
    ret->count = ifd->count;
1291
0
    if (ret->count) {
1292
0
        size_t required_size;
1293
0
        if (av_size_mult(ret->count, sizeof(*ret->entries), &required_size) < 0)
1294
0
            goto fail;
1295
0
        av_fast_mallocz(&ret->entries, &ret->size, required_size);
1296
0
        if (!ret->entries)
1297
0
            goto fail;
1298
0
    }
1299
1300
0
    for (size_t i = 0; i < ret->count; i++) {
1301
0
        const AVExifEntry *entry = &ifd->entries[i];
1302
0
        AVExifEntry *ret_entry = &ret->entries[i];
1303
0
        int status = exif_clone_entry(ret_entry, entry);
1304
0
        if (status < 0)
1305
0
            goto fail;
1306
0
    }
1307
1308
0
    return ret;
1309
1310
0
fail:
1311
0
    av_exif_free(ret);
1312
0
    av_free(ret);
1313
0
    return NULL;
1314
0
}
1315
1316
static const int rotation_lut[2][4] = {
1317
    {1, 8, 3, 6}, {4, 7, 2, 5},
1318
};
1319
1320
int av_exif_matrix_to_orientation(const int32_t *matrix)
1321
0
{
1322
0
    double rotation = av_display_rotation_get(matrix);
1323
    // determinant
1324
0
    int vflip = ((int64_t)matrix[0] * (int64_t)matrix[4]
1325
0
               - (int64_t)matrix[1] * (int64_t)matrix[3]) < 0;
1326
0
    if (!isfinite(rotation))
1327
0
        return 0;
1328
0
    int rot = (int)(rotation + 0.5);
1329
0
    rot = (((rot % 360) + 360) % 360) / 90;
1330
0
    return rotation_lut[vflip][rot];
1331
0
}
1332
1333
int av_exif_orientation_to_matrix(int32_t *matrix, int orientation)
1334
0
{
1335
0
    switch (orientation) {
1336
0
        case 1:
1337
0
            av_display_rotation_set(matrix, 0.0);
1338
0
            break;
1339
0
        case 2:
1340
0
            av_display_rotation_set(matrix, 0.0);
1341
0
            av_display_matrix_flip(matrix, 1, 0);
1342
0
            break;
1343
0
        case 3:
1344
0
            av_display_rotation_set(matrix, 180.0);
1345
0
            break;
1346
0
        case 4:
1347
0
            av_display_rotation_set(matrix, 180.0);
1348
0
            av_display_matrix_flip(matrix, 1, 0);
1349
0
            break;
1350
0
        case 5:
1351
0
            av_display_rotation_set(matrix, 90.0);
1352
0
            av_display_matrix_flip(matrix, 1, 0);
1353
0
            break;
1354
0
        case 6:
1355
0
            av_display_rotation_set(matrix, 90.0);
1356
0
            break;
1357
0
        case 7:
1358
0
            av_display_rotation_set(matrix, -90.0);
1359
0
            av_display_matrix_flip(matrix, 1, 0);
1360
0
            break;
1361
0
        case 8:
1362
0
            av_display_rotation_set(matrix, -90.0);
1363
0
            break;
1364
0
        default:
1365
0
            return AVERROR(EINVAL);
1366
0
    }
1367
1368
0
    return 0;
1369
0
}
1370
1371
int ff_exif_sanitize_ifd(void *logctx, const AVFrame *frame, AVExifMetadata *ifd)
1372
0
{
1373
0
    int ret = 0;
1374
0
    AVFrameSideData *sd_orient = NULL;
1375
0
    AVExifEntry *or = NULL;
1376
0
    AVExifEntry *iw = NULL;
1377
0
    AVExifEntry *ih = NULL;
1378
0
    AVExifEntry *pw = NULL;
1379
0
    AVExifEntry *ph = NULL;
1380
0
    uint64_t orientation = 1;
1381
0
    uint64_t w = frame->width;
1382
0
    uint64_t h = frame->height;
1383
0
    int rewrite = 0;
1384
1385
0
    sd_orient = av_frame_get_side_data(frame, AV_FRAME_DATA_DISPLAYMATRIX);
1386
1387
0
    if (sd_orient)
1388
0
        orientation = av_exif_matrix_to_orientation((int32_t *) sd_orient->data);
1389
0
    if (orientation != 1)
1390
0
        av_log(logctx, AV_LOG_DEBUG, "matrix contains nontrivial EXIF orientation: %" PRIu64 "\n", orientation);
1391
1392
0
    for (size_t i = 0; i < ifd->count; i++) {
1393
0
        AVExifEntry *entry = &ifd->entries[i];
1394
0
        if (entry->id == ORIENTATION_TAG && entry->count > 0 && entry->type == AV_TIFF_SHORT) {
1395
0
            or = entry;
1396
0
            continue;
1397
0
        }
1398
0
        if (entry->id == IMAGE_WIDTH_TAG && entry->count > 0 && entry->type == AV_TIFF_LONG) {
1399
0
            iw = entry;
1400
0
            continue;
1401
0
        }
1402
0
        if (entry->id == IMAGE_LENGTH_TAG && entry->count > 0 && entry->type == AV_TIFF_LONG) {
1403
0
            ih = entry;
1404
0
            continue;
1405
0
        }
1406
0
        if (entry->id == EXIFIFD_TAG && entry->type == AV_TIFF_IFD) {
1407
0
            AVExifMetadata *exif = &entry->value.ifd;
1408
0
            for (size_t j = 0; j < exif->count; j++) {
1409
0
                AVExifEntry *exifentry = &exif->entries[j];
1410
0
                if (exifentry->id == PIXEL_X_TAG && exifentry->count > 0 && exifentry->type == AV_TIFF_SHORT) {
1411
0
                    pw = exifentry;
1412
0
                    continue;
1413
0
                }
1414
0
                if (exifentry->id == PIXEL_Y_TAG && exifentry->count > 0 && exifentry->type == AV_TIFF_SHORT) {
1415
0
                    ph = exifentry;
1416
0
                    continue;
1417
0
                }
1418
0
            }
1419
0
        }
1420
0
    }
1421
1422
0
    if (or && or->value.uint[0] != orientation) {
1423
0
        rewrite = 1;
1424
0
        or->value.uint[0] = orientation;
1425
0
    }
1426
0
    if (iw && iw->value.uint[0] != w) {
1427
0
        rewrite = 1;
1428
0
        iw->value.uint[0] = w;
1429
0
    }
1430
0
    if (ih && ih->value.uint[0] != h) {
1431
0
        rewrite = 1;
1432
0
        ih->value.uint[0] = h;
1433
0
    }
1434
0
    if (pw && pw->value.uint[0] != w) {
1435
0
        rewrite = 1;
1436
0
        pw->value.uint[0] = w;
1437
0
    }
1438
0
    if (ph && ph->value.uint[0] != h) {
1439
0
        rewrite = 1;
1440
0
        ph->value.uint[0] = h;
1441
0
    }
1442
0
    if (!or && orientation != 1) {
1443
0
        rewrite = 1;
1444
0
        ret = av_exif_set_entry(logctx, ifd, ORIENTATION_TAG, AV_TIFF_SHORT, 1, NULL, 0, &orientation);
1445
0
        if (ret < 0)
1446
0
            goto end;
1447
0
    }
1448
0
    if (!iw && w) {
1449
0
        rewrite = 1;
1450
0
        ret = av_exif_set_entry(logctx, ifd, IMAGE_WIDTH_TAG, AV_TIFF_LONG, 1, NULL, 0, &w);
1451
0
        if (ret < 0)
1452
0
            goto end;
1453
0
    }
1454
0
    if (!ih && h) {
1455
0
        rewrite = 1;
1456
0
        ret = av_exif_set_entry(logctx, ifd, IMAGE_LENGTH_TAG, AV_TIFF_LONG, 1, NULL, 0, &h);
1457
0
        if (ret < 0)
1458
0
            goto end;
1459
0
    }
1460
0
    if (!pw && w && w < 0xFFFFu || !ph && h && h < 0xFFFFu) {
1461
0
        AVExifMetadata *exif;
1462
0
        AVExifEntry *exif_entry;
1463
0
        int exif_found = av_exif_get_entry(logctx, ifd, EXIFIFD_TAG, 0, &exif_entry);
1464
0
        rewrite = 1;
1465
0
        if (exif_found < 0)
1466
0
            goto end;
1467
0
        if (exif_found > 0) {
1468
0
            exif = &exif_entry->value.ifd;
1469
0
        } else {
1470
0
            AVExifMetadata exif_new = { 0 };
1471
0
            ret = av_exif_set_entry(logctx, ifd, EXIFIFD_TAG, AV_TIFF_IFD, 1, NULL, 0, &exif_new);
1472
0
            if (ret < 0) {
1473
0
                av_exif_free(&exif_new);
1474
0
                goto end;
1475
0
            }
1476
0
            exif = &ifd->entries[ifd->count - 1].value.ifd;
1477
0
        }
1478
0
        if (!pw && w && w < 0xFFFFu) {
1479
0
            ret = av_exif_set_entry(logctx, exif, PIXEL_X_TAG, AV_TIFF_SHORT, 1, NULL, 0, &w);
1480
0
            if (ret < 0)
1481
0
                goto end;
1482
0
        }
1483
0
        if (!ph && h && h < 0xFFFFu) {
1484
0
            ret = av_exif_set_entry(logctx, exif, PIXEL_Y_TAG, AV_TIFF_SHORT, 1, NULL, 0, &h);
1485
0
            if (ret < 0)
1486
0
                goto end;
1487
0
        }
1488
0
    }
1489
1490
0
    return rewrite;
1491
1492
0
end:
1493
0
    return ret;
1494
0
}
1495
1496
int ff_exif_get_buffer(void *logctx, const AVFrame *frame, AVBufferRef **buffer_ptr, enum AVExifHeaderMode header_mode)
1497
0
{
1498
0
    AVFrameSideData *sd_exif = NULL;
1499
0
    AVBufferRef *buffer = NULL;
1500
0
    AVExifMetadata ifd = { 0 };
1501
0
    int ret = 0;
1502
0
    int rewrite = 0;
1503
1504
0
    if (!buffer_ptr || *buffer_ptr)
1505
0
        return AVERROR(EINVAL);
1506
1507
0
    sd_exif = av_frame_get_side_data(frame, AV_FRAME_DATA_EXIF);
1508
0
    if (!sd_exif)
1509
0
        return 0;
1510
1511
0
    ret = av_exif_parse_buffer(logctx, sd_exif->data, sd_exif->size, &ifd, AV_EXIF_TIFF_HEADER);
1512
0
    if (ret < 0)
1513
0
        goto end;
1514
1515
0
    rewrite = ff_exif_sanitize_ifd(logctx, frame, &ifd);
1516
0
    if (rewrite < 0) {
1517
0
        ret = rewrite;
1518
0
        goto end;
1519
0
    }
1520
1521
0
    if (rewrite) {
1522
0
        ret = av_exif_write(logctx, &ifd, &buffer, header_mode);
1523
0
        if (ret < 0)
1524
0
            goto end;
1525
1526
0
        *buffer_ptr = buffer;
1527
0
    } else {
1528
0
        *buffer_ptr = av_buffer_ref(sd_exif->buf);
1529
0
        if (!*buffer_ptr) {
1530
0
            ret = AVERROR(ENOMEM);
1531
0
            goto end;
1532
0
        }
1533
0
    }
1534
1535
0
    av_exif_free(&ifd);
1536
0
    return rewrite;
1537
1538
0
end:
1539
0
    av_exif_free(&ifd);
1540
0
    return ret;
1541
0
}