zzmkrandom.c

#include <string.h>
#include <errno.h>
#include <unistd.h>
#include <sys/time.h>

#include "zz_priv.h"
#include "byteorder.h"
#include "zzwrite.h"

// Magic values
#define MAGIC1 0xfffee00d
#define MAGIC2 BSWAP_32(0xfffee00d)
#define MAGIC3 0xfffee0dd
#define MAGIC4 BSWAP_32(0xfffee0dd)
#define MAGIC5 ((0x0010 << 24) | (0x0001 << 16) | ('S' << 8) | ('S'))

enum
{
	OPT_STDOUT,
	OPT_BROKEN,
	OPT_SEED,
	OPT_COUNT
};

static struct zzopts opts[] =
	{ { "--stdout", "Output result to stdout", false, false, 0, 0 },	// OPT_STDOUT
	  { "--broken", "Generate broken DICOM that should still be parseable", false, false, 0, 0 },	// OPT_BROKEN
	  { "--seed", "Make pseudo-random result with given random seed", false, false, 1, 0 },	// OPT_SEED
	  { NULL, NULL, false, false, 0, 0 } };		// OPT_COUNT

static long zseed = 0; // stored in instance number
static bool broken = false; // generate broken DICOM
	
static inline bool is_explicit(struct zzfile *zz) { return zz->ladder[zz->ladderidx].txsyn == ZZ_EXPLICIT; }

static void write_implicit(struct zzio *zi, uint16_t group, uint16_t element, uint32_t length)
{
	ziwrite(zi, &group, 2);
	ziwrite(zi, &element, 2);
	ziwrite(zi, &length, 4);
}

static bool randomly(struct zzfile *zz, zzKey key, enum VR vr)
{
	int chance = rand() % 5;
	if (chance == 0)
	{
		zzwEmpty(zz, key, vr);
		return false;
	}
	else if (chance == 1)
	{
		zzwMax(zz, key, vr);
		return false;
	}
	return true;
}

static const char *randomDA()
{
	return "19790408";
}

static struct timeval randomTM()
{
	struct timeval tv;
	gettimeofday(&tv, NULL);
	return tv;
}

static const char *randomPN(bool utf8)
{
	const char *name = NULL;
	switch (rand() % 3)
	{
	case 0: if (utf8) name = u8"必要"; else name = "^SOME_ISO^"; break;
	case 1: if (utf8) name = u8"Приве́т नमस्ते שָׁלוֹם"; else name = "random^zzmk"; break;
	case 2: name = "^DICOMTEST^^^"; break;
	}
	return name;
}

static void genericfile(struct zzfile *zz, const char *sopclass)
{
	bool utf8 = (rand() % 1 == 0);
	if (randomly(zz, DCM_SpecificCharacterSet, CS)) zzwCS(zz, DCM_SpecificCharacterSet, utf8 ? "ISO_IR 192" : "ISO_IR 100");
	if (randomly(zz, DCM_SOPClassUID, UI)) zzwUI(zz, DCM_SOPClassUID, sopclass);
	if (randomly(zz, DCM_SOPInstanceUID, UI)) zzwUI(zz, DCM_SOPInstanceUID, "1.2.3.4.5.6.7");
	if (randomly(zz, DCM_StudyDate, DA)) zzwDAs(zz, DCM_StudyDate, randomDA());
	if (randomly(zz, DCM_StudyTime, TM)) zzwTM(zz, DCM_StudyTime, randomTM());
	if (randomly(zz, DCM_AccessionNumber, SH)) zzwSH(zz, DCM_AccessionNumber, "1234567890123456");
	if (randomly(zz, DCM_ReferringPhysiciansName, PN)) zzwPN(zz, DCM_ReferringPhysiciansName, randomPN(utf8));
	if (randomly(zz, DCM_PatientsName, PN)) zzwPN(zz, DCM_PatientsName, randomPN(utf8));
	zzwLO(zz, DCM_PatientID, "zzmkrandom"); // marker used for testing
	if (randomly(zz, DCM_PatientsBirthDate, DA)) zzwDAs(zz, DCM_PatientsBirthDate, randomDA());
	if (randomly(zz, DCM_PatientsSex, CS)) zzwCS(zz, DCM_PatientsSex, "M");
	if (randomly(zz, DCM_PatientsWeight, DS)) zzwDSs(zz, DCM_PatientsWeight, "120");
	zzwUI(zz, DCM_StudyInstanceUID, "1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16.17.18.19.20.21.22.23.24.25.26");
	zzwUI(zz, DCM_SeriesInstanceUID, "1.2.3.4.2");
	if (randomly(zz, DCM_StudyID, SH)) zzwSH(zz, DCM_StudyID, "StudyID");
	if (randomly(zz, DCM_SeriesNumber, IS)) zzwIS(zz, DCM_SeriesNumber, rand());
	zzwIS(zz, DCM_InstanceNumber, zseed);
	double patpos[] = { drand48(), drand48(), drand48() };
	if (randomly(zz, DCM_ImagePositionPatient, DS)) zzwDSdv(zz, DCM_ImagePositionPatient, 3, patpos);
	if (broken && randomly(zz, DCM_PixelSpacing, DS)) zzwDSs(zz, DCM_PixelSpacing, "1.199166666667\\1.199166666667"); // out of order
	if (randomly(zz, DCM_Laterality, CS)) zzwCS(zz, DCM_Laterality, "R");
	if (randomly(zz, DCM_SliceLocation, DS)) zzwDSd(zz, DCM_SliceLocation, drand48());
	// stop at above - group 0x0020, element 0x1041
}

static void garbfill(struct zzfile *zz)
{
	switch (rand() % 5)
	{
	case 0: zzwUL(zz, DCM_DataPointRows, MAGIC1); zzwUL(zz, DCM_DataPointColumns, MAGIC2); break;
	case 1: zzwUL(zz, DCM_DataPointRows, MAGIC3); zzwUL(zz, DCM_DataPointColumns, MAGIC4); break;
	case 2: zzwUL(zz, DCM_DataPointRows, MAGIC2); zzwUL(zz, DCM_DataPointColumns, MAGIC5); break;
	case 3: zzwUL(zz, DCM_DataPointRows, MAGIC5); zzwUL(zz, DCM_DataPointColumns, MAGIC3); break;
	default:
	case 4: zzwUL(zz, DCM_DataPointRows, MAGIC4); zzwUL(zz, DCM_DataPointColumns, MAGIC1); break;
	}
}

static void zzwOBnoise(struct zzfile *zz, zzKey key, size_t size)
{
	char *buf;

	buf = malloc(size);
	memset(buf, rand(), size);
	if (!is_explicit(zz) && key == DCM_PixelData)
	{
		zzwOW(zz, key, size / 2, (uint16_t *)buf);
	}
	else
	{
		zzwOB(zz, key, size, buf);
	}
	free(buf);
}

void addSQ(struct zzfile *zz)
{
	long i, loops, val, *pos = (rand() % 2) == 0 ? NULL : &val;
	zzwSQ_begin(zz, ZZ_KEY(0x0020, 0x1115), pos);
	loops = rand() % 8;
	for (i = 0; i < loops; i++)
	{
		long val2, *pos2 = (rand() % 2) == 0 ? NULL : &val2;
		zzwItem_begin(zz, pos2);
			if (rand() % 5 > 2) garbfill(zz);
		zzwItem_end(zz, pos2);
		if (broken && pos2 != NULL && rand() % 10 > 8)
		{
			write_implicit(zz->zi, 0xfffe, 0xe00d, 0); // this crashed dicom3tools; not really legal dicom
		}
	}
	if (rand() % 3 == 0)
	{
		long val2, *pos2 = (rand() % 2) == 0 ? NULL : &val2;
		zzwItem_begin(zz, pos2);
		if (rand() % 3 > 0) addSQ(zz);
		zzwItem_end(zz, pos2);
	}
	zzwSQ_end(zz, pos);
}

int main(int argc, char **argv)
{
	const char *outputfile = "random.dcm";
	struct zzfile szz, *zz = &szz;
	int firstparam;

	firstparam = zzutil(argc, argv, 0, "[<output file>]", "Generate random or pseudo-random DICOM file for unit testing", opts);
	if (opts[OPT_SEED].found)
	{
		zseed = atoi(argv[opts[OPT_SEED].argstart + 1]);
	}
	else
	{
		zseed = time(NULL) + getpid();
	}
	if (argc - firstparam > 0)
	{
		outputfile = argv[firstparam];
	}
	srand(zseed);

	memset(zz, 0, sizeof(*zz));
	if (opts[OPT_BROKEN].found)
	{
		broken = true;
	}
	if (!opts[OPT_STDOUT].found)
	{
		zz->zi = ziopenfile(outputfile, "w");
	}
	else
	{
		zz->zi = ziopenstdout();
	}
	if (!zz->zi)
	{
		fprintf(stderr, "Failed to open output file \"%s\": %s\n", outputfile, strerror(errno));
	}

	switch (rand() % 15)
	{
	case 0: 
		zz->ladder[0].txsyn = ZZ_IMPLICIT;	// no header, implicit
		break;
	case 1:
		if (broken)
		{
			zz->ladder[0].txsyn = ZZ_IMPLICIT;	// implicit header, buggy like CTN
			zzwHeader(zz, UID_SecondaryCaptureImageStorage, "1.2.3.4.0", UID_LittleEndianImplicitTransferSyntax);
			break;
		}
		// fallthrough
	case 2:
		zz->ladder[0].txsyn = ZZ_EXPLICIT;	// no header, explicit
		break;
	case 3:
		zz->ladder[0].txsyn = ZZ_IMPLICIT;	// implicit with explicit header
		zz->ladderidx = 1;
		zz->ladder[1].txsyn = ZZ_EXPLICIT;
		zzwHeader(zz, UID_SecondaryCaptureImageStorage, "1.2.3.4.0", UID_LittleEndianImplicitTransferSyntax);
		zz->ladderidx = 0;
		break;
	default:
		zz->ladder[0].txsyn = ZZ_EXPLICIT;	// explicit with explicit header
		zzwHeader(zz, UID_SecondaryCaptureImageStorage, "1.2.3.4.0", UID_LittleEndianExplicitTransferSyntax);
		break;
	}

	genericfile(zz, UID_SecondaryCaptureImageStorage);

	if (is_explicit(zz) && rand() % 10 > 2)	// add SQ block
	{
		addSQ(zz);
	}

	if (rand() % 10 > 5) garbfill(zz);

	// TODO, fix private tags namespace

	// try to confuse parsers that rely on arbitrary characters in the data stream - pretend to be an explicit VR
	if (!is_explicit(zz) && rand() % 10 > 8) zzwOBnoise(zz, ZZ_KEY(0x0029, 0x0009), 'S' + ('S' << 8));

	if (rand() % 10 > 2)	// add UN block
	{
		long val, *pos = (rand() % 2) == 0 ? NULL : &val;
		zzwUN_begin(zz, ZZ_KEY(0x0029, 0x1010), pos);
		if (rand() % 10 > 2)
		{
			long val2, *pos2 = (rand() % 2) == 0 ? NULL : &val2;
			zzwItem_begin(zz, pos2);
				if (rand() % 5 > 2) garbfill(zz);
			zzwItem_end(zz, pos2);
			if (rand() % 10 > 2)
			{
				long val3, *pos3 = (rand() % 2) == 0 ? NULL : &val3;
				zzwItem_begin(zz, pos3);
					if (rand() % 5 > 2) garbfill(zz);
				zzwItem_end(zz, pos3);
			}
		}
		zzwUN_end(zz, NULL);
	}

	// Invent a new VR to check that the toolkit reads it correctly
	if (broken && is_explicit(zz) && rand() % 5 == 0)
	{
		const uint16_t group = 0x0029;
		const uint16_t element = 0x1090;
		const uint16_t zero = 0;
		const uint32_t length = 0;

		ziwrite(zz->zi, &group, 2);
		ziwrite(zz->zi, &element, 2);
		ziwrite(zz->zi, "QQ", 2);
		ziwrite(zz->zi, &zero, 2);
		ziwrite(zz->zi, &length, 4);
	}

	if (rand() % 10 > 3) zzwOBnoise(zz, DCM_PixelData, rand() % 9999);
	if (rand() % 10 > 7) zzwOBnoise(zz, DCM_DataSetTrailingPadding, rand() % 9999);

	ziclose(zz->zi);

	return 0;
}