FFmpeg
hashenc.c
Go to the documentation of this file.
1 /*
2  * Hash/MD5 encoder (for codec/format testing)
3  * Copyright (c) 2009 Reimar Döffinger, based on crcenc (c) 2002 Fabrice Bellard
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 #include "config_components.h"
23 
24 #include "libavutil/avstring.h"
25 #include "libavutil/hash.h"
26 #include "libavutil/intreadwrite.h"
27 #include "libavutil/opt.h"
28 #include "avformat.h"
29 #include "internal.h"
30 
31 struct HashContext {
32  const AVClass *avclass;
34  char *hash_name;
37 };
38 
39 #define OFFSET(x) offsetof(struct HashContext, x)
40 #define ENC AV_OPT_FLAG_ENCODING_PARAM
41 #define HASH_OPT(defaulttype) \
42  { "hash", "set hash to use", OFFSET(hash_name), AV_OPT_TYPE_STRING, {.str = defaulttype}, 0, 0, ENC }
43 #define FORMAT_VERSION_OPT \
44  { "format_version", "file format version", OFFSET(format_version), AV_OPT_TYPE_INT, {.i64 = 2}, 1, 2, ENC }
45 
46 #if CONFIG_HASH_MUXER || CONFIG_STREAMHASH_MUXER
47 static const AVOption hash_streamhash_options[] = {
48  HASH_OPT("sha256"),
49  { NULL },
50 };
51 
52 static const AVClass hash_streamhashenc_class = {
53  .class_name = "(stream) hash muxer",
54  .item_name = av_default_item_name,
55  .option = hash_streamhash_options,
56  .version = LIBAVUTIL_VERSION_INT,
57 };
58 #endif
59 
60 #if CONFIG_FRAMEHASH_MUXER
61 static const AVOption framehash_options[] = {
62  HASH_OPT("sha256"),
64  { NULL },
65 };
66 #endif
67 
68 #if CONFIG_MD5_MUXER
69 static const AVOption md5_options[] = {
70  HASH_OPT("md5"),
71  { NULL },
72 };
73 #endif
74 
75 #if CONFIG_FRAMEMD5_MUXER
76 static const AVOption framemd5_options[] = {
77  HASH_OPT("md5"),
79  { NULL },
80 };
81 #endif
82 
83 #if CONFIG_HASH_MUXER || CONFIG_MD5_MUXER
84 static int hash_init(struct AVFormatContext *s)
85 {
86  int res;
87  struct HashContext *c = s->priv_data;
88  c->per_stream = 0;
89  c->hashes = av_mallocz(sizeof(*c->hashes));
90  if (!c->hashes)
91  return AVERROR(ENOMEM);
92  res = av_hash_alloc(&c->hashes[0], c->hash_name);
93  if (res < 0)
94  return res;
95  av_hash_init(c->hashes[0]);
96  return 0;
97 }
98 #endif
99 
100 #if CONFIG_STREAMHASH_MUXER
101 static int streamhash_init(struct AVFormatContext *s)
102 {
103  int res, i;
104  struct HashContext *c = s->priv_data;
105  c->per_stream = 1;
106  c->hashes = av_calloc(s->nb_streams, sizeof(*c->hashes));
107  if (!c->hashes)
108  return AVERROR(ENOMEM);
109  for (i = 0; i < s->nb_streams; i++) {
110  res = av_hash_alloc(&c->hashes[i], c->hash_name);
111  if (res < 0) {
112  return res;
113  }
114  av_hash_init(c->hashes[i]);
115  }
116  return 0;
117 }
118 #endif
119 
120 #if CONFIG_HASH_MUXER || CONFIG_MD5_MUXER || CONFIG_STREAMHASH_MUXER
121 static char get_media_type_char(enum AVMediaType type)
122 {
123  switch (type) {
124  case AVMEDIA_TYPE_VIDEO: return 'v';
125  case AVMEDIA_TYPE_AUDIO: return 'a';
126  case AVMEDIA_TYPE_DATA: return 'd';
127  case AVMEDIA_TYPE_SUBTITLE: return 's';
128  case AVMEDIA_TYPE_ATTACHMENT: return 't';
129  default: return '?';
130  }
131 }
132 
133 static int hash_write_packet(struct AVFormatContext *s, AVPacket *pkt)
134 {
135  struct HashContext *c = s->priv_data;
136  av_hash_update(c->hashes[c->per_stream ? pkt->stream_index : 0], pkt->data, pkt->size);
137  return 0;
138 }
139 
140 static int hash_write_trailer(struct AVFormatContext *s)
141 {
142  struct HashContext *c = s->priv_data;
143  int num_hashes = c->per_stream ? s->nb_streams : 1;
144  for (int i = 0; i < num_hashes; i++) {
145  char buf[AV_HASH_MAX_SIZE*2+128];
146  if (c->per_stream) {
147  AVStream *st = s->streams[i];
148  snprintf(buf, sizeof(buf) - 200, "%d,%c,%s=", i, get_media_type_char(st->codecpar->codec_type),
149  av_hash_get_name(c->hashes[i]));
150  } else {
151  snprintf(buf, sizeof(buf) - 200, "%s=", av_hash_get_name(c->hashes[i]));
152  }
153  av_hash_final_hex(c->hashes[i], buf + strlen(buf), sizeof(buf) - strlen(buf));
154  av_strlcatf(buf, sizeof(buf), "\n");
155  avio_write(s->pb, buf, strlen(buf));
156  }
157 
158  return 0;
159 }
160 #endif
161 
162 static void hash_free(struct AVFormatContext *s)
163 {
164  struct HashContext *c = s->priv_data;
165  if (c->hashes) {
166  int num_hashes = c->per_stream ? s->nb_streams : 1;
167  for (int i = 0; i < num_hashes; i++) {
168  av_hash_freep(&c->hashes[i]);
169  }
170  }
171  av_freep(&c->hashes);
172 }
173 
174 #if CONFIG_HASH_MUXER
176  .name = "hash",
177  .long_name = NULL_IF_CONFIG_SMALL("Hash testing"),
178  .priv_data_size = sizeof(struct HashContext),
179  .audio_codec = AV_CODEC_ID_PCM_S16LE,
180  .video_codec = AV_CODEC_ID_RAWVIDEO,
181  .init = hash_init,
182  .write_packet = hash_write_packet,
183  .write_trailer = hash_write_trailer,
184  .deinit = hash_free,
187  .priv_class = &hash_streamhashenc_class,
188 };
189 #endif
190 
191 #if CONFIG_MD5_MUXER
192 static const AVClass md5enc_class = {
193  .class_name = "MD5 muxer",
194  .item_name = av_default_item_name,
195  .option = md5_options,
196  .version = LIBAVUTIL_VERSION_INT,
197 };
198 
200  .name = "md5",
201  .long_name = NULL_IF_CONFIG_SMALL("MD5 testing"),
202  .priv_data_size = sizeof(struct HashContext),
203  .audio_codec = AV_CODEC_ID_PCM_S16LE,
204  .video_codec = AV_CODEC_ID_RAWVIDEO,
205  .init = hash_init,
206  .write_packet = hash_write_packet,
207  .write_trailer = hash_write_trailer,
208  .deinit = hash_free,
211  .priv_class = &md5enc_class,
212 };
213 #endif
214 
215 #if CONFIG_STREAMHASH_MUXER
217  .name = "streamhash",
218  .long_name = NULL_IF_CONFIG_SMALL("Per-stream hash testing"),
219  .priv_data_size = sizeof(struct HashContext),
220  .audio_codec = AV_CODEC_ID_PCM_S16LE,
221  .video_codec = AV_CODEC_ID_RAWVIDEO,
222  .init = streamhash_init,
223  .write_packet = hash_write_packet,
224  .write_trailer = hash_write_trailer,
225  .deinit = hash_free,
228  .priv_class = &hash_streamhashenc_class,
229 };
230 #endif
231 
232 #if CONFIG_FRAMEHASH_MUXER || CONFIG_FRAMEMD5_MUXER
233 static void framehash_print_extradata(struct AVFormatContext *s)
234 {
235  int i;
236 
237  for (i = 0; i < s->nb_streams; i++) {
238  AVStream *st = s->streams[i];
239  AVCodecParameters *par = st->codecpar;
240  if (par->extradata) {
241  struct HashContext *c = s->priv_data;
242  char buf[AV_HASH_MAX_SIZE*2+1];
243 
244  avio_printf(s->pb, "#extradata %d, %31d, ", i, par->extradata_size);
245  av_hash_init(c->hashes[0]);
246  av_hash_update(c->hashes[0], par->extradata, par->extradata_size);
247  av_hash_final_hex(c->hashes[0], buf, sizeof(buf));
248  avio_write(s->pb, buf, strlen(buf));
249  avio_printf(s->pb, "\n");
250  }
251  }
252 }
253 
254 static int framehash_init(struct AVFormatContext *s)
255 {
256  int res;
257  struct HashContext *c = s->priv_data;
258  c->per_stream = 0;
259  c->hashes = av_mallocz(sizeof(*c->hashes));
260  if (!c->hashes)
261  return AVERROR(ENOMEM);
262  res = av_hash_alloc(&c->hashes[0], c->hash_name);
263  if (res < 0)
264  return res;
265  return 0;
266 }
267 
268 static int framehash_write_header(struct AVFormatContext *s)
269 {
270  struct HashContext *c = s->priv_data;
271  avio_printf(s->pb, "#format: frame checksums\n");
272  avio_printf(s->pb, "#version: %d\n", c->format_version);
273  avio_printf(s->pb, "#hash: %s\n", av_hash_get_name(c->hashes[0]));
274  framehash_print_extradata(s);
276  avio_printf(s->pb, "#stream#, dts, pts, duration, size, hash\n");
277  return 0;
278 }
279 
280 static int framehash_write_packet(struct AVFormatContext *s, AVPacket *pkt)
281 {
282  struct HashContext *c = s->priv_data;
283  char buf[AV_HASH_MAX_SIZE*2+128];
284  int len;
285  av_hash_init(c->hashes[0]);
286  av_hash_update(c->hashes[0], pkt->data, pkt->size);
287 
288  snprintf(buf, sizeof(buf) - (AV_HASH_MAX_SIZE * 2 + 1), "%d, %10"PRId64", %10"PRId64", %8"PRId64", %8d, ",
290  len = strlen(buf);
291  av_hash_final_hex(c->hashes[0], buf + len, sizeof(buf) - len);
292  avio_write(s->pb, buf, strlen(buf));
293 
294  if (c->format_version > 1 && pkt->side_data_elems) {
295  int i;
296  avio_printf(s->pb, ", S=%d", pkt->side_data_elems);
297  for (i = 0; i < pkt->side_data_elems; i++) {
298  av_hash_init(c->hashes[0]);
299  if (HAVE_BIGENDIAN && pkt->side_data[i].type == AV_PKT_DATA_PALETTE) {
300  for (size_t j = 0; j < pkt->side_data[i].size; j += sizeof(uint32_t)) {
301  uint32_t data = AV_RL32(pkt->side_data[i].data + j);
302  av_hash_update(c->hashes[0], (uint8_t *)&data, sizeof(uint32_t));
303  }
304  } else
305  av_hash_update(c->hashes[0], pkt->side_data[i].data, pkt->side_data[i].size);
306  snprintf(buf, sizeof(buf) - (AV_HASH_MAX_SIZE * 2 + 1),
307  ", %8"SIZE_SPECIFIER", ", pkt->side_data[i].size);
308  len = strlen(buf);
309  av_hash_final_hex(c->hashes[0], buf + len, sizeof(buf) - len);
310  avio_write(s->pb, buf, strlen(buf));
311  }
312  }
313 
314  avio_printf(s->pb, "\n");
315  return 0;
316 }
317 #endif
318 
319 #if CONFIG_FRAMEHASH_MUXER
320 static const AVClass framehash_class = {
321  .class_name = "frame hash muxer",
322  .item_name = av_default_item_name,
323  .option = framehash_options,
324  .version = LIBAVUTIL_VERSION_INT,
325 };
326 
328  .name = "framehash",
329  .long_name = NULL_IF_CONFIG_SMALL("Per-frame hash testing"),
330  .priv_data_size = sizeof(struct HashContext),
331  .audio_codec = AV_CODEC_ID_PCM_S16LE,
332  .video_codec = AV_CODEC_ID_RAWVIDEO,
333  .init = framehash_init,
334  .write_header = framehash_write_header,
335  .write_packet = framehash_write_packet,
336  .deinit = hash_free,
339  .priv_class = &framehash_class,
340 };
341 #endif
342 
343 #if CONFIG_FRAMEMD5_MUXER
344 static const AVClass framemd5_class = {
345  .class_name = "frame MD5 muxer",
346  .item_name = av_default_item_name,
347  .option = framemd5_options,
348  .version = LIBAVUTIL_VERSION_INT,
349 };
350 
352  .name = "framemd5",
353  .long_name = NULL_IF_CONFIG_SMALL("Per-frame MD5 testing"),
354  .priv_data_size = sizeof(struct HashContext),
355  .audio_codec = AV_CODEC_ID_PCM_S16LE,
356  .video_codec = AV_CODEC_ID_RAWVIDEO,
357  .init = framehash_init,
358  .write_header = framehash_write_header,
359  .write_packet = framehash_write_packet,
360  .deinit = hash_free,
363  .priv_class = &framemd5_class,
364 };
365 #endif
AV_CODEC_ID_PCM_S16LE
@ AV_CODEC_ID_PCM_S16LE
Definition: codec_id.h:316
AVMEDIA_TYPE_SUBTITLE
@ AVMEDIA_TYPE_SUBTITLE
Definition: avutil.h:204
AVCodecParameters::extradata
uint8_t * extradata
Extra binary data needed for initializing the decoder, codec-dependent.
Definition: codec_par.h:75
AVOutputFormat::name
const char * name
Definition: avformat.h:510
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
opt.h
AVCodecParameters::codec_type
enum AVMediaType codec_type
General type of the encoded data.
Definition: codec_par.h:57
AV_HASH_MAX_SIZE
#define AV_HASH_MAX_SIZE
Maximum value that av_hash_get_size() will currently return.
Definition: hash.h:156
AVCodecParameters
This struct describes the properties of an encoded stream.
Definition: codec_par.h:53
AVFMT_VARIABLE_FPS
#define AVFMT_VARIABLE_FPS
Format allows variable fps.
Definition: avformat.h:484
AV_CODEC_ID_RAWVIDEO
@ AV_CODEC_ID_RAWVIDEO
Definition: codec_id.h:63
AVPacket::data
uint8_t * data
Definition: packet.h:374
AVOption
AVOption.
Definition: opt.h:251
AV_PKT_DATA_PALETTE
@ AV_PKT_DATA_PALETTE
An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE bytes worth of palette.
Definition: packet.h:47
data
const char data[16]
Definition: mxf.c:143
AVPacket::duration
int64_t duration
Duration of this packet in AVStream->time_base units, 0 if unknown.
Definition: packet.h:392
get_media_type_char
static char get_media_type_char(enum AVMediaType type)
Definition: opt_common.c:655
av_strlcatf
size_t av_strlcatf(char *dst, size_t size, const char *fmt,...)
Definition: avstring.c:104
AVPacketSideData::size
size_t size
Definition: packet.h:317
av_hash_get_name
const char * av_hash_get_name(const AVHashContext *ctx)
Definition: hash.c:92
FORMAT_VERSION_OPT
#define FORMAT_VERSION_OPT
Definition: hashenc.c:43
type
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it vf type
Definition: writing_filters.txt:86
pkt
AVPacket * pkt
Definition: movenc.c:59
ff_streamhash_muxer
const AVOutputFormat ff_streamhash_muxer
hash_free
static void hash_free(struct AVFormatContext *s)
Definition: hashenc.c:162
intreadwrite.h
s
#define s(width, name)
Definition: cbs_vp9.c:256
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
av_hash_alloc
int av_hash_alloc(AVHashContext **ctx, const char *name)
Allocate a hash context for the algorithm specified by name.
Definition: hash.c:102
AVPacketSideData::data
uint8_t * data
Definition: packet.h:316
AVMEDIA_TYPE_DATA
@ AVMEDIA_TYPE_DATA
Opaque data information usually continuous.
Definition: avutil.h:203
AVFormatContext
Format I/O context.
Definition: avformat.h:1213
internal.h
HashContext
Definition: hashenc.c:31
AVStream::codecpar
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1108
LIBAVUTIL_VERSION_INT
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
NULL
#define NULL
Definition: coverity.c:32
av_hash_init
void av_hash_init(AVHashContext *ctx)
Initialize or reset a hash context.
Definition: hash.c:139
AVPacketSideData::type
enum AVPacketSideDataType type
Definition: packet.h:318
av_default_item_name
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:237
av_hash_update
void av_hash_update(AVHashContext *ctx, const uint8_t *src, size_t len)
Update a hash context with additional data.
Definition: hash.c:160
ff_framemd5_muxer
const AVOutputFormat ff_framemd5_muxer
c
Undefined Behavior In the C some operations are like signed integer dereferencing freed accessing outside allocated Undefined Behavior must not occur in a C it is not safe even if the output of undefined operations is unused The unsafety may seem nit picking but Optimizing compilers have in fact optimized code on the assumption that no undefined Behavior occurs Optimizing code based on wrong assumptions can and has in some cases lead to effects beyond the output of computations The signed integer overflow problem in speed critical code Code which is highly optimized and works with signed integers sometimes has the problem that often the output of the computation does not c
Definition: undefined.txt:32
av_hash_freep
void av_hash_freep(AVHashContext **ctx)
Free hash context and set hash context pointer to NULL.
Definition: hash.c:236
AVCodecParameters::extradata_size
int extradata_size
Size of the extradata content in bytes.
Definition: codec_par.h:79
HashContext::hash_name
char * hash_name
Definition: hashenc.c:34
AVMediaType
AVMediaType
Definition: avutil.h:199
AVPacket::size
int size
Definition: packet.h:375
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:116
AVPacket::dts
int64_t dts
Decompression timestamp in AVStream->time_base units; the time at which the packet is decompressed.
Definition: packet.h:373
avio_write
void avio_write(AVIOContext *s, const unsigned char *buf, int size)
Definition: aviobuf.c:232
AVHashContext
Definition: hash.c:58
ff_md5_muxer
const AVOutputFormat ff_md5_muxer
HashContext::hashes
struct AVHashContext ** hashes
Definition: hashenc.c:33
AVOutputFormat
Definition: avformat.h:509
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:271
AVPacket::pts
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: packet.h:367
AVMEDIA_TYPE_ATTACHMENT
@ AVMEDIA_TYPE_ATTACHMENT
Opaque data information usually sparse.
Definition: avutil.h:205
ff_framehash_muxer
const AVOutputFormat ff_framehash_muxer
av_mallocz
void * av_mallocz(size_t size)
Allocate a memory block with alignment suitable for all memory accesses (including vectors if availab...
Definition: mem.c:264
len
int len
Definition: vorbis_enc_data.h:426
av_calloc
void * av_calloc(size_t nmemb, size_t size)
Definition: mem.c:272
AVFMT_TS_NEGATIVE
#define AVFMT_TS_NEGATIVE
Format allows muxing negative timestamps.
Definition: avformat.h:494
AVFMT_TS_NONSTRICT
#define AVFMT_TS_NONSTRICT
Format does not require strictly increasing timestamps, but they must still be monotonic.
Definition: avformat.h:491
AVStream
Stream structure.
Definition: avformat.h:948
AVClass::class_name
const char * class_name
The name of the class; usually it is the same name as the context structure type to which the AVClass...
Definition: log.h:71
avformat.h
AVPacket::side_data
AVPacketSideData * side_data
Additional packet data that can be provided by the container.
Definition: packet.h:385
AV_RL32
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_RL32
Definition: bytestream.h:92
SIZE_SPECIFIER
#define SIZE_SPECIFIER
Definition: internal.h:192
avio_printf
int avio_printf(AVIOContext *s, const char *fmt,...) av_printf_format(2
Writes a formatted string to the context.
HashContext::format_version
int format_version
Definition: hashenc.c:36
hash.h
HashContext::per_stream
int per_stream
Definition: hashenc.c:35
AVPacket::stream_index
int stream_index
Definition: packet.h:376
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
av_hash_final_hex
void av_hash_final_hex(struct AVHashContext *ctx, uint8_t *dst, int size)
Finalize a hash context and store the hexadecimal representation of the actual hash value as a string...
Definition: hash.c:213
HASH_OPT
#define HASH_OPT(defaulttype)
Definition: hashenc.c:41
AVPacket
This structure stores compressed data.
Definition: packet.h:351
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:34
ff_framehash_write_header
int ff_framehash_write_header(AVFormatContext *s)
Set the timebase for each stream from the corresponding codec timebase and print it.
Definition: framehash.c:25
HashContext::avclass
const AVClass * avclass
Definition: hashenc.c:32
avstring.h
snprintf
#define snprintf
Definition: snprintf.h:34
ff_hash_muxer
const AVOutputFormat ff_hash_muxer
AVPacket::side_data_elems
int side_data_elems
Definition: packet.h:386