2 * Hash/MD5 encoder (for codec/format testing)
3 * Copyright (c) 2009 Reimar Döffinger, based on crcenc (c) 2002 Fabrice Bellard
5 * This file is part of FFmpeg.
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.
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.
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
22 #include "libavutil/avassert.h"
23 #include "libavutil/avstring.h"
24 #include "libavutil/hash.h"
25 #include "libavutil/intreadwrite.h"
26 #include "libavutil/opt.h"
31 const AVClass *avclass;
32 struct AVHashContext **hashes;
38 #define OFFSET(x) offsetof(struct HashContext, x)
39 #define ENC AV_OPT_FLAG_ENCODING_PARAM
40 #define HASH_OPT(defaulttype) \
41 { "hash", "set hash to use", OFFSET(hash_name), AV_OPT_TYPE_STRING, {.str = defaulttype}, 0, 0, ENC }
42 #define FORMAT_VERSION_OPT \
43 { "format_version", "file format version", OFFSET(format_version), AV_OPT_TYPE_INT, {.i64 = 2}, 1, 2, ENC }
45 #if CONFIG_HASH_MUXER || CONFIG_STREAMHASH_MUXER
46 static const AVOption hash_streamhash_options[] = {
52 #if CONFIG_FRAMEHASH_MUXER
53 static const AVOption framehash_options[] = {
61 static const AVOption md5_options[] = {
67 #if CONFIG_FRAMEMD5_MUXER
68 static const AVOption framemd5_options[] = {
75 #if CONFIG_HASH_MUXER || CONFIG_MD5_MUXER
76 static int hash_init(struct AVFormatContext *s)
79 struct HashContext *c = s->priv_data;
81 c->hashes = av_mallocz_array(1, sizeof(*c->hashes));
83 return AVERROR(ENOMEM);
84 res = av_hash_alloc(&c->hashes[0], c->hash_name);
87 av_hash_init(c->hashes[0]);
92 #if CONFIG_STREAMHASH_MUXER
93 static int streamhash_init(struct AVFormatContext *s)
96 struct HashContext *c = s->priv_data;
98 c->hashes = av_mallocz_array(s->nb_streams, sizeof(*c->hashes));
100 return AVERROR(ENOMEM);
101 for (i = 0; i < s->nb_streams; i++) {
102 res = av_hash_alloc(&c->hashes[i], c->hash_name);
106 av_hash_init(c->hashes[i]);
112 #if CONFIG_HASH_MUXER || CONFIG_MD5_MUXER || CONFIG_STREAMHASH_MUXER
113 static char get_media_type_char(enum AVMediaType type)
116 case AVMEDIA_TYPE_VIDEO: return 'v';
117 case AVMEDIA_TYPE_AUDIO: return 'a';
118 case AVMEDIA_TYPE_DATA: return 'd';
119 case AVMEDIA_TYPE_SUBTITLE: return 's';
120 case AVMEDIA_TYPE_ATTACHMENT: return 't';
125 static int hash_write_packet(struct AVFormatContext *s, AVPacket *pkt)
127 struct HashContext *c = s->priv_data;
128 av_hash_update(c->hashes[c->per_stream ? pkt->stream_index : 0], pkt->data, pkt->size);
132 static int hash_write_trailer(struct AVFormatContext *s)
134 struct HashContext *c = s->priv_data;
135 int num_hashes = c->per_stream ? s->nb_streams : 1;
136 for (int i = 0; i < num_hashes; i++) {
137 char buf[AV_HASH_MAX_SIZE*2+128];
139 AVStream *st = s->streams[i];
140 snprintf(buf, sizeof(buf) - 200, "%d,%c,%s=", i, get_media_type_char(st->codecpar->codec_type),
141 av_hash_get_name(c->hashes[i]));
143 snprintf(buf, sizeof(buf) - 200, "%s=", av_hash_get_name(c->hashes[i]));
145 av_hash_final_hex(c->hashes[i], buf + strlen(buf), sizeof(buf) - strlen(buf));
146 av_strlcatf(buf, sizeof(buf), "\n");
147 avio_write(s->pb, buf, strlen(buf));
154 static void hash_free(struct AVFormatContext *s)
156 struct HashContext *c = s->priv_data;
158 int num_hashes = c->per_stream ? s->nb_streams : 1;
159 for (int i = 0; i < num_hashes; i++) {
160 av_hash_freep(&c->hashes[i]);
163 av_freep(&c->hashes);
166 #if CONFIG_HASH_MUXER
167 static const AVClass hashenc_class = {
168 .class_name = "hash muxer",
169 .item_name = av_default_item_name,
170 .option = hash_streamhash_options,
171 .version = LIBAVUTIL_VERSION_INT,
174 const AVOutputFormat ff_hash_muxer = {
176 .long_name = NULL_IF_CONFIG_SMALL("Hash testing"),
177 .priv_data_size = sizeof(struct HashContext),
178 .audio_codec = AV_CODEC_ID_PCM_S16LE,
179 .video_codec = AV_CODEC_ID_RAWVIDEO,
181 .write_packet = hash_write_packet,
182 .write_trailer = hash_write_trailer,
184 .flags = AVFMT_VARIABLE_FPS | AVFMT_TS_NONSTRICT |
186 .priv_class = &hashenc_class,
191 static const AVClass md5enc_class = {
192 .class_name = "MD5 muxer",
193 .item_name = av_default_item_name,
194 .option = md5_options,
195 .version = LIBAVUTIL_VERSION_INT,
198 const AVOutputFormat ff_md5_muxer = {
200 .long_name = NULL_IF_CONFIG_SMALL("MD5 testing"),
201 .priv_data_size = sizeof(struct HashContext),
202 .audio_codec = AV_CODEC_ID_PCM_S16LE,
203 .video_codec = AV_CODEC_ID_RAWVIDEO,
205 .write_packet = hash_write_packet,
206 .write_trailer = hash_write_trailer,
208 .flags = AVFMT_VARIABLE_FPS | AVFMT_TS_NONSTRICT |
210 .priv_class = &md5enc_class,
214 #if CONFIG_STREAMHASH_MUXER
215 static const AVClass streamhashenc_class = {
216 .class_name = "stream hash muxer",
217 .item_name = av_default_item_name,
218 .option = hash_streamhash_options,
219 .version = LIBAVUTIL_VERSION_INT,
222 const AVOutputFormat ff_streamhash_muxer = {
223 .name = "streamhash",
224 .long_name = NULL_IF_CONFIG_SMALL("Per-stream hash testing"),
225 .priv_data_size = sizeof(struct HashContext),
226 .audio_codec = AV_CODEC_ID_PCM_S16LE,
227 .video_codec = AV_CODEC_ID_RAWVIDEO,
228 .init = streamhash_init,
229 .write_packet = hash_write_packet,
230 .write_trailer = hash_write_trailer,
232 .flags = AVFMT_VARIABLE_FPS | AVFMT_TS_NONSTRICT |
234 .priv_class = &streamhashenc_class,
238 #if CONFIG_FRAMEHASH_MUXER || CONFIG_FRAMEMD5_MUXER
239 static void framehash_print_extradata(struct AVFormatContext *s)
243 for (i = 0; i < s->nb_streams; i++) {
244 AVStream *st = s->streams[i];
245 AVCodecParameters *par = st->codecpar;
246 if (par->extradata) {
247 struct HashContext *c = s->priv_data;
248 char buf[AV_HASH_MAX_SIZE*2+1];
250 avio_printf(s->pb, "#extradata %d, %31d, ", i, par->extradata_size);
251 av_hash_init(c->hashes[0]);
252 av_hash_update(c->hashes[0], par->extradata, par->extradata_size);
253 av_hash_final_hex(c->hashes[0], buf, sizeof(buf));
254 avio_write(s->pb, buf, strlen(buf));
255 avio_printf(s->pb, "\n");
260 static int framehash_init(struct AVFormatContext *s)
263 struct HashContext *c = s->priv_data;
265 c->hashes = av_mallocz_array(1, sizeof(*c->hashes));
267 return AVERROR(ENOMEM);
268 res = av_hash_alloc(&c->hashes[0], c->hash_name);
274 static int framehash_write_header(struct AVFormatContext *s)
276 struct HashContext *c = s->priv_data;
277 avio_printf(s->pb, "#format: frame checksums\n");
278 avio_printf(s->pb, "#version: %d\n", c->format_version);
279 avio_printf(s->pb, "#hash: %s\n", av_hash_get_name(c->hashes[0]));
280 framehash_print_extradata(s);
281 ff_framehash_write_header(s);
282 avio_printf(s->pb, "#stream#, dts, pts, duration, size, hash\n");
286 static int framehash_write_packet(struct AVFormatContext *s, AVPacket *pkt)
288 struct HashContext *c = s->priv_data;
289 char buf[AV_HASH_MAX_SIZE*2+128];
291 av_hash_init(c->hashes[0]);
292 av_hash_update(c->hashes[0], pkt->data, pkt->size);
294 snprintf(buf, sizeof(buf) - (AV_HASH_MAX_SIZE * 2 + 1), "%d, %10"PRId64", %10"PRId64", %8"PRId64", %8d, ",
295 pkt->stream_index, pkt->dts, pkt->pts, pkt->duration, pkt->size);
297 av_hash_final_hex(c->hashes[0], buf + len, sizeof(buf) - len);
298 avio_write(s->pb, buf, strlen(buf));
300 if (c->format_version > 1 && pkt->side_data_elems) {
302 avio_printf(s->pb, ", S=%d", pkt->side_data_elems);
303 for (i = 0; i < pkt->side_data_elems; i++) {
304 av_hash_init(c->hashes[0]);
305 if (HAVE_BIGENDIAN && pkt->side_data[i].type == AV_PKT_DATA_PALETTE) {
306 for (size_t j = 0; j < pkt->side_data[i].size; j += sizeof(uint32_t)) {
307 uint32_t data = AV_RL32(pkt->side_data[i].data + j);
308 av_hash_update(c->hashes[0], (uint8_t *)&data, sizeof(uint32_t));
311 av_hash_update(c->hashes[0], pkt->side_data[i].data, pkt->side_data[i].size);
312 snprintf(buf, sizeof(buf) - (AV_HASH_MAX_SIZE * 2 + 1),
313 ", %8"SIZE_SPECIFIER", ", pkt->side_data[i].size);
315 av_hash_final_hex(c->hashes[0], buf + len, sizeof(buf) - len);
316 avio_write(s->pb, buf, strlen(buf));
320 avio_printf(s->pb, "\n");
325 #if CONFIG_FRAMEHASH_MUXER
326 static const AVClass framehash_class = {
327 .class_name = "frame hash muxer",
328 .item_name = av_default_item_name,
329 .option = framehash_options,
330 .version = LIBAVUTIL_VERSION_INT,
333 const AVOutputFormat ff_framehash_muxer = {
335 .long_name = NULL_IF_CONFIG_SMALL("Per-frame hash testing"),
336 .priv_data_size = sizeof(struct HashContext),
337 .audio_codec = AV_CODEC_ID_PCM_S16LE,
338 .video_codec = AV_CODEC_ID_RAWVIDEO,
339 .init = framehash_init,
340 .write_header = framehash_write_header,
341 .write_packet = framehash_write_packet,
343 .flags = AVFMT_VARIABLE_FPS | AVFMT_TS_NONSTRICT |
345 .priv_class = &framehash_class,
349 #if CONFIG_FRAMEMD5_MUXER
350 static const AVClass framemd5_class = {
351 .class_name = "frame MD5 muxer",
352 .item_name = av_default_item_name,
353 .option = framemd5_options,
354 .version = LIBAVUTIL_VERSION_INT,
357 const AVOutputFormat ff_framemd5_muxer = {
359 .long_name = NULL_IF_CONFIG_SMALL("Per-frame MD5 testing"),
360 .priv_data_size = sizeof(struct HashContext),
361 .audio_codec = AV_CODEC_ID_PCM_S16LE,
362 .video_codec = AV_CODEC_ID_RAWVIDEO,
363 .init = framehash_init,
364 .write_header = framehash_write_header,
365 .write_packet = framehash_write_packet,
367 .flags = AVFMT_VARIABLE_FPS | AVFMT_TS_NONSTRICT |
369 .priv_class = &framemd5_class,