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 "libavutil/avstring.h"
23 #include "libavutil/hash.h"
24 #include "libavutil/intreadwrite.h"
25 #include "libavutil/opt.h"
26 #include "avformat.h"
27 #include "internal.h"
28 
29 struct HashContext {
30  const AVClass *avclass;
32  char *hash_name;
35 };
36 
37 #define OFFSET(x) offsetof(struct HashContext, x)
38 #define ENC AV_OPT_FLAG_ENCODING_PARAM
39 #define HASH_OPT(defaulttype) \
40  { "hash", "set hash to use", OFFSET(hash_name), AV_OPT_TYPE_STRING, {.str = defaulttype}, 0, 0, ENC }
41 #define FORMAT_VERSION_OPT \
42  { "format_version", "file format version", OFFSET(format_version), AV_OPT_TYPE_INT, {.i64 = 2}, 1, 2, ENC }
43 
44 #if CONFIG_HASH_MUXER || CONFIG_STREAMHASH_MUXER
45 static const AVOption hash_streamhash_options[] = {
46  HASH_OPT("sha256"),
47  { NULL },
48 };
49 
50 static const AVClass hash_streamhashenc_class = {
51  .class_name = "(stream) hash muxer",
52  .item_name = av_default_item_name,
53  .option = hash_streamhash_options,
54  .version = LIBAVUTIL_VERSION_INT,
55 };
56 #endif
57 
58 #if CONFIG_FRAMEHASH_MUXER
59 static const AVOption framehash_options[] = {
60  HASH_OPT("sha256"),
62  { NULL },
63 };
64 #endif
65 
66 #if CONFIG_MD5_MUXER
67 static const AVOption md5_options[] = {
68  HASH_OPT("md5"),
69  { NULL },
70 };
71 #endif
72 
73 #if CONFIG_FRAMEMD5_MUXER
74 static const AVOption framemd5_options[] = {
75  HASH_OPT("md5"),
77  { NULL },
78 };
79 #endif
80 
81 #if CONFIG_HASH_MUXER || CONFIG_MD5_MUXER
82 static int hash_init(struct AVFormatContext *s)
83 {
84  int res;
85  struct HashContext *c = s->priv_data;
86  c->per_stream = 0;
87  c->hashes = av_mallocz(sizeof(*c->hashes));
88  if (!c->hashes)
89  return AVERROR(ENOMEM);
90  res = av_hash_alloc(&c->hashes[0], c->hash_name);
91  if (res < 0)
92  return res;
93  av_hash_init(c->hashes[0]);
94  return 0;
95 }
96 #endif
97 
98 #if CONFIG_STREAMHASH_MUXER
99 static int streamhash_init(struct AVFormatContext *s)
100 {
101  int res, i;
102  struct HashContext *c = s->priv_data;
103  c->per_stream = 1;
104  c->hashes = av_calloc(s->nb_streams, sizeof(*c->hashes));
105  if (!c->hashes)
106  return AVERROR(ENOMEM);
107  for (i = 0; i < s->nb_streams; i++) {
108  res = av_hash_alloc(&c->hashes[i], c->hash_name);
109  if (res < 0) {
110  return res;
111  }
112  av_hash_init(c->hashes[i]);
113  }
114  return 0;
115 }
116 #endif
117 
118 #if CONFIG_HASH_MUXER || CONFIG_MD5_MUXER || CONFIG_STREAMHASH_MUXER
119 static char get_media_type_char(enum AVMediaType type)
120 {
121  switch (type) {
122  case AVMEDIA_TYPE_VIDEO: return 'v';
123  case AVMEDIA_TYPE_AUDIO: return 'a';
124  case AVMEDIA_TYPE_DATA: return 'd';
125  case AVMEDIA_TYPE_SUBTITLE: return 's';
126  case AVMEDIA_TYPE_ATTACHMENT: return 't';
127  default: return '?';
128  }
129 }
130 
131 static int hash_write_packet(struct AVFormatContext *s, AVPacket *pkt)
132 {
133  struct HashContext *c = s->priv_data;
134  av_hash_update(c->hashes[c->per_stream ? pkt->stream_index : 0], pkt->data, pkt->size);
135  return 0;
136 }
137 
138 static int hash_write_trailer(struct AVFormatContext *s)
139 {
140  struct HashContext *c = s->priv_data;
141  int num_hashes = c->per_stream ? s->nb_streams : 1;
142  for (int i = 0; i < num_hashes; i++) {
143  char buf[AV_HASH_MAX_SIZE*2+128];
144  if (c->per_stream) {
145  AVStream *st = s->streams[i];
146  snprintf(buf, sizeof(buf) - 200, "%d,%c,%s=", i, get_media_type_char(st->codecpar->codec_type),
147  av_hash_get_name(c->hashes[i]));
148  } else {
149  snprintf(buf, sizeof(buf) - 200, "%s=", av_hash_get_name(c->hashes[i]));
150  }
151  av_hash_final_hex(c->hashes[i], buf + strlen(buf), sizeof(buf) - strlen(buf));
152  av_strlcatf(buf, sizeof(buf), "\n");
153  avio_write(s->pb, buf, strlen(buf));
154  }
155 
156  return 0;
157 }
158 #endif
159 
160 static void hash_free(struct AVFormatContext *s)
161 {
162  struct HashContext *c = s->priv_data;
163  if (c->hashes) {
164  int num_hashes = c->per_stream ? s->nb_streams : 1;
165  for (int i = 0; i < num_hashes; i++) {
166  av_hash_freep(&c->hashes[i]);
167  }
168  }
169  av_freep(&c->hashes);
170 }
171 
172 #if CONFIG_HASH_MUXER
174  .name = "hash",
175  .long_name = NULL_IF_CONFIG_SMALL("Hash testing"),
176  .priv_data_size = sizeof(struct HashContext),
177  .audio_codec = AV_CODEC_ID_PCM_S16LE,
178  .video_codec = AV_CODEC_ID_RAWVIDEO,
179  .init = hash_init,
180  .write_packet = hash_write_packet,
181  .write_trailer = hash_write_trailer,
182  .deinit = hash_free,
185  .priv_class = &hash_streamhashenc_class,
186 };
187 #endif
188 
189 #if CONFIG_MD5_MUXER
190 static const AVClass md5enc_class = {
191  .class_name = "MD5 muxer",
192  .item_name = av_default_item_name,
193  .option = md5_options,
194  .version = LIBAVUTIL_VERSION_INT,
195 };
196 
198  .name = "md5",
199  .long_name = NULL_IF_CONFIG_SMALL("MD5 testing"),
200  .priv_data_size = sizeof(struct HashContext),
201  .audio_codec = AV_CODEC_ID_PCM_S16LE,
202  .video_codec = AV_CODEC_ID_RAWVIDEO,
203  .init = hash_init,
204  .write_packet = hash_write_packet,
205  .write_trailer = hash_write_trailer,
206  .deinit = hash_free,
209  .priv_class = &md5enc_class,
210 };
211 #endif
212 
213 #if CONFIG_STREAMHASH_MUXER
215  .name = "streamhash",
216  .long_name = NULL_IF_CONFIG_SMALL("Per-stream hash testing"),
217  .priv_data_size = sizeof(struct HashContext),
218  .audio_codec = AV_CODEC_ID_PCM_S16LE,
219  .video_codec = AV_CODEC_ID_RAWVIDEO,
220  .init = streamhash_init,
221  .write_packet = hash_write_packet,
222  .write_trailer = hash_write_trailer,
223  .deinit = hash_free,
226  .priv_class = &hash_streamhashenc_class,
227 };
228 #endif
229 
230 #if CONFIG_FRAMEHASH_MUXER || CONFIG_FRAMEMD5_MUXER
231 static void framehash_print_extradata(struct AVFormatContext *s)
232 {
233  int i;
234 
235  for (i = 0; i < s->nb_streams; i++) {
236  AVStream *st = s->streams[i];
237  AVCodecParameters *par = st->codecpar;
238  if (par->extradata) {
239  struct HashContext *c = s->priv_data;
240  char buf[AV_HASH_MAX_SIZE*2+1];
241 
242  avio_printf(s->pb, "#extradata %d, %31d, ", i, par->extradata_size);
243  av_hash_init(c->hashes[0]);
244  av_hash_update(c->hashes[0], par->extradata, par->extradata_size);
245  av_hash_final_hex(c->hashes[0], buf, sizeof(buf));
246  avio_write(s->pb, buf, strlen(buf));
247  avio_printf(s->pb, "\n");
248  }
249  }
250 }
251 
252 static int framehash_init(struct AVFormatContext *s)
253 {
254  int res;
255  struct HashContext *c = s->priv_data;
256  c->per_stream = 0;
257  c->hashes = av_mallocz(sizeof(*c->hashes));
258  if (!c->hashes)
259  return AVERROR(ENOMEM);
260  res = av_hash_alloc(&c->hashes[0], c->hash_name);
261  if (res < 0)
262  return res;
263  return 0;
264 }
265 
266 static int framehash_write_header(struct AVFormatContext *s)
267 {
268  struct HashContext *c = s->priv_data;
269  avio_printf(s->pb, "#format: frame checksums\n");
270  avio_printf(s->pb, "#version: %d\n", c->format_version);
271  avio_printf(s->pb, "#hash: %s\n", av_hash_get_name(c->hashes[0]));
272  framehash_print_extradata(s);
274  avio_printf(s->pb, "#stream#, dts, pts, duration, size, hash\n");
275  return 0;
276 }
277 
278 static int framehash_write_packet(struct AVFormatContext *s, AVPacket *pkt)
279 {
280  struct HashContext *c = s->priv_data;
281  char buf[AV_HASH_MAX_SIZE*2+128];
282  int len;
283  av_hash_init(c->hashes[0]);
284  av_hash_update(c->hashes[0], pkt->data, pkt->size);
285 
286  snprintf(buf, sizeof(buf) - (AV_HASH_MAX_SIZE * 2 + 1), "%d, %10"PRId64", %10"PRId64", %8"PRId64", %8d, ",
288  len = strlen(buf);
289  av_hash_final_hex(c->hashes[0], buf + len, sizeof(buf) - len);
290  avio_write(s->pb, buf, strlen(buf));
291 
292  if (c->format_version > 1 && pkt->side_data_elems) {
293  int i;
294  avio_printf(s->pb, ", S=%d", pkt->side_data_elems);
295  for (i = 0; i < pkt->side_data_elems; i++) {
296  av_hash_init(c->hashes[0]);
297  if (HAVE_BIGENDIAN && pkt->side_data[i].type == AV_PKT_DATA_PALETTE) {
298  for (size_t j = 0; j < pkt->side_data[i].size; j += sizeof(uint32_t)) {
299  uint32_t data = AV_RL32(pkt->side_data[i].data + j);
300  av_hash_update(c->hashes[0], (uint8_t *)&data, sizeof(uint32_t));
301  }
302  } else
303  av_hash_update(c->hashes[0], pkt->side_data[i].data, pkt->side_data[i].size);
304  snprintf(buf, sizeof(buf) - (AV_HASH_MAX_SIZE * 2 + 1),
305  ", %8"SIZE_SPECIFIER", ", pkt->side_data[i].size);
306  len = strlen(buf);
307  av_hash_final_hex(c->hashes[0], buf + len, sizeof(buf) - len);
308  avio_write(s->pb, buf, strlen(buf));
309  }
310  }
311 
312  avio_printf(s->pb, "\n");
313  return 0;
314 }
315 #endif
316 
317 #if CONFIG_FRAMEHASH_MUXER
318 static const AVClass framehash_class = {
319  .class_name = "frame hash muxer",
320  .item_name = av_default_item_name,
321  .option = framehash_options,
322  .version = LIBAVUTIL_VERSION_INT,
323 };
324 
326  .name = "framehash",
327  .long_name = NULL_IF_CONFIG_SMALL("Per-frame hash testing"),
328  .priv_data_size = sizeof(struct HashContext),
329  .audio_codec = AV_CODEC_ID_PCM_S16LE,
330  .video_codec = AV_CODEC_ID_RAWVIDEO,
331  .init = framehash_init,
332  .write_header = framehash_write_header,
333  .write_packet = framehash_write_packet,
334  .deinit = hash_free,
337  .priv_class = &framehash_class,
338 };
339 #endif
340 
341 #if CONFIG_FRAMEMD5_MUXER
342 static const AVClass framemd5_class = {
343  .class_name = "frame MD5 muxer",
344  .item_name = av_default_item_name,
345  .option = framemd5_options,
346  .version = LIBAVUTIL_VERSION_INT,
347 };
348 
350  .name = "framemd5",
351  .long_name = NULL_IF_CONFIG_SMALL("Per-frame MD5 testing"),
352  .priv_data_size = sizeof(struct HashContext),
353  .audio_codec = AV_CODEC_ID_PCM_S16LE,
354  .video_codec = AV_CODEC_ID_RAWVIDEO,
355  .init = framehash_init,
356  .write_header = framehash_write_header,
357  .write_packet = framehash_write_packet,
358  .deinit = hash_free,
361  .priv_class = &framemd5_class,
362 };
363 #endif
AV_CODEC_ID_PCM_S16LE
@ AV_CODEC_ID_PCM_S16LE
Definition: codec_id.h:313
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:74
AVOutputFormat::name
const char * name
Definition: avformat.h:496
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:56
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:52
AVFMT_VARIABLE_FPS
#define AVFMT_VARIABLE_FPS
Format allows variable fps.
Definition: avformat.h:470
get_media_type_char
static char get_media_type_char(enum AVMediaType type)
Definition: cmdutils.c:1483
AV_CODEC_ID_RAWVIDEO
@ AV_CODEC_ID_RAWVIDEO
Definition: codec_id.h:63
AVPacket::data
uint8_t * data
Definition: packet.h:373
AVOption
AVOption.
Definition: opt.h:247
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:46
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:391
av_strlcatf
size_t av_strlcatf(char *dst, size_t size, const char *fmt,...)
Definition: avstring.c:101
AVPacketSideData::size
size_t size
Definition: packet.h:316
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:41
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:160
intreadwrite.h
s
#define s(width, name)
Definition: cbs_vp9.c:257
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:315
AVMEDIA_TYPE_DATA
@ AVMEDIA_TYPE_DATA
Opaque data information usually continuous.
Definition: avutil.h:203
AVFormatContext
Format I/O context.
Definition: avformat.h:1097
internal.h
HashContext
Definition: hashenc.c:29
AVStream::codecpar
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:992
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:317
av_default_item_name
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:235
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:78
HashContext::hash_name
char * hash_name
Definition: hashenc.c:32
AVMediaType
AVMediaType
Definition: avutil.h:199
AVPacket::size
int size
Definition: packet.h:374
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:117
AVPacket::dts
int64_t dts
Decompression timestamp in AVStream->time_base units; the time at which the packet is decompressed.
Definition: packet.h:372
avio_write
void avio_write(AVIOContext *s, const unsigned char *buf, int size)
Definition: aviobuf.c:218
AVHashContext
Definition: hash.c:58
ff_md5_muxer
const AVOutputFormat ff_md5_muxer
HashContext::hashes
struct AVHashContext ** hashes
Definition: hashenc.c:31
i
int i
Definition: input.c:406
AVOutputFormat
Definition: avformat.h:495
AVPacket::pts
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: packet.h:366
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:263
len
int len
Definition: vorbis_enc_data.h:426
av_calloc
void * av_calloc(size_t nmemb, size_t size)
Definition: mem.c:271
AVFMT_TS_NEGATIVE
#define AVFMT_TS_NEGATIVE
Format allows muxing negative timestamps.
Definition: avformat.h:480
AVFMT_TS_NONSTRICT
#define AVFMT_TS_NONSTRICT
Format does not require strictly increasing timestamps, but they must still be monotonic.
Definition: avformat.h:477
AVStream
Stream structure.
Definition: avformat.h:845
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:384
AV_RL32
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_RL32
Definition: bytestream.h:92
SIZE_SPECIFIER
#define SIZE_SPECIFIER
Definition: internal.h:193
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:34
hash.h
HashContext::per_stream
int per_stream
Definition: hashenc.c:33
AVPacket::stream_index
int stream_index
Definition: packet.h:375
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:39
AVPacket
This structure stores compressed data.
Definition: packet.h:350
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:35
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:24
HashContext::avclass
const AVClass * avclass
Definition: hashenc.c:30
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:385