libavcodec/zmbvenc: block scoring improvements/bug fixes
[ffmpeg.git] / libavcodec / codec2utils.h
1 /*
2  * codec2 utility functions
3  * Copyright (c) 2017 Tomas Härdin
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
22 #ifndef AVCODEC_CODEC2UTILS_H
23 #define AVCODEC_CODEC2UTILS_H
24
25 #include <stdint.h>
26
27 //Highest mode we're willing to use.
28 //Don't want to let users accidentally produce files that can't be decoded in the future.
29 //CODEC2_MODE_WB (9) is experimental/unstable as of 2017-11-23.
30 #define AVPRIV_CODEC2_MODE_MAX 8 //CODEC2_MODE_700C
31
32 //Used by both codec2raw demuxer and libcodec2 encoder.
33 //The integers match the values in codec2.h, so "3200" -> CODEC2_MODE_3000 = 0 and so on.
34 //It is possible that we're linked to a version of libcodec2 that lacks some of these modes.
35 //For example Debian stretch ships with libcodec2.so.0.4 which lacks CODEC2_MODE_700C.
36 #define AVPRIV_CODEC2_AVOPTIONS(desc, classname, min_val, default_val, option_flags) \
37     { "mode", desc, offsetof(classname, mode), AV_OPT_TYPE_INT, {.i64 = default_val}, min_val, AVPRIV_CODEC2_MODE_MAX, .flags=option_flags, .unit="codec2_mode"},\
38     { "3200", "3200", 0, AV_OPT_TYPE_CONST, {.i64 = 0}, .flags=option_flags, .unit="codec2_mode"},\
39     { "2400", "2400", 0, AV_OPT_TYPE_CONST, {.i64 = 1}, .flags=option_flags, .unit="codec2_mode"},\
40     { "1600", "1600", 0, AV_OPT_TYPE_CONST, {.i64 = 2}, .flags=option_flags, .unit="codec2_mode"},\
41     { "1400", "1400", 0, AV_OPT_TYPE_CONST, {.i64 = 3}, .flags=option_flags, .unit="codec2_mode"},\
42     { "1300", "1300", 0, AV_OPT_TYPE_CONST, {.i64 = 4}, .flags=option_flags, .unit="codec2_mode"},\
43     { "1200", "1200", 0, AV_OPT_TYPE_CONST, {.i64 = 5}, .flags=option_flags, .unit="codec2_mode"},\
44     { "700",  "700",  0, AV_OPT_TYPE_CONST, {.i64 = 6}, .flags=option_flags, .unit="codec2_mode"},\
45     { "700B", "700B", 0, AV_OPT_TYPE_CONST, {.i64 = 7}, .flags=option_flags, .unit="codec2_mode"},\
46     { "700C", "700C", 0, AV_OPT_TYPE_CONST, {.i64 = 8}, .flags=option_flags, .unit="codec2_mode"}
47
48 //The three following functions are here to avoid needing libavformat/codec2.c to depend on libcodec2
49
50 //Computes bitrate from mode, with frames rounded up to the nearest octet.
51 //So 700 bit/s (28 bits/frame) becomes 800 bits/s (32 bits/frame).
52 //logctx is used for av_log()
53 //Returns <0 if mode is invalid
54 int avpriv_codec2_mode_bit_rate(void *logctx, int mode);
55
56 //Mimics codec2_samples_per_frame()
57 int avpriv_codec2_mode_frame_size(void *logctx, int mode);
58
59 //Mimics (codec2_bits_per_frame()+7)/8
60 int avpriv_codec2_mode_block_align(void *logctx, int mode);
61
62 #define AVPRIV_CODEC2_EXTRADATA_SIZE 4
63
64 //Used in codec2raw demuxer and libcodec2 encoder
65 static inline void avpriv_codec2_make_extradata(uint8_t *ptr, int mode) {
66     //version 0.8 as of 2017-12-23 (r3386)
67     ptr[0] = 0;     //major
68     ptr[1] = 8;     //minor
69     ptr[2] = mode;  //mode
70     ptr[3] = 0;     //flags
71 }
72
73 //Returns version as a 16-bit value. 0.8 -> 0x0008
74 static inline uint16_t avpriv_codec2_version_from_extradata(uint8_t *ptr) {
75     return (ptr[0] << 8) + ptr[1];
76 }
77
78 static inline uint8_t avpriv_codec2_mode_from_extradata(uint8_t *ptr) {
79     return ptr[2];
80 }
81
82 #endif /* AVCODEC_CODEC2UTILS_H */