arguments.h File Reference

Go to the source code of this file.

Functions
bool	GetDimension (const char *string, DIMENSION *dimension_out)
	Convert a command-line argument to an image dimension.
bool	GetPixelFormat (const char *string, PIXEL_FORMAT *format_out)
	Convert a command-line argument to a pixel format.
bool	GetImageFormat (const char *string, IMAGE_FORMAT *format_out)
	Convert a command-line argument to an image format.
bool	GetPrecision (const char *string, PRECISION *precision_out)
	Convert a command-line argument to precision in bits.
bool	GetQuantization (const char *string, QUANT *quant)
	Set the values in the quantization table. More...
bool	GetChannelOrder (const char *string, CHANNEL *channel_order_table, int *channel_order_count, int channel_order_table_length)
	Set the order in which channels are encoded into the bitstream. More...
bool	GetEnabledParts (const char *string, uint32_t *enabled_parts_out)
	Set the flags that indicate which parts of VC-5 are enabled. More...
bool	GetBandfileInfo (const char *string, BANDFILE_INFO *bandfile)
	Parse the bandfile information. More...
bool	GetLayerCount (const char *string, COUNT *layer_count_out)
	Convert a command-line argument to the number of layers.
bool	GetEnabledSections (const char *string, uint32_t *enabled_sections_out)
	Set the flags that indicate which sections in VC-5 Part 6 are enabled. More...

Detailed Description

Definitions of the routines for parsing the values of command-line arguments.

(c) 2013 Society of Motion Picture & Television Engineers LLC and Woodman Labs, Inc. All rights reserved–use subject to compliance with end user license agreement.

Function Documentation

GetBandfileInfo()

bool GetBandfileInfo	(	const char *	string,
		BANDFILE_INFO *	bandfile
	)

Parse the bandfile information.

The bandfile information is a string of fields delimited by commas. The first field is the pathname of the bandfile, the second and third fields are the channel mask and subband mask as hexadecimal numbers. The masks specify which channels and subbands to write to the bandfile.

Todo:

Add a lowpass mask as an optional fourth argument in the band file information string to specify which lowpass bands in the intermediate wavelets are included in the bandfile or use extra bits in the subband mask.

Here is the caller graph for this function:

GetChannelOrder()

bool GetChannelOrder	(	const char *	string,
		CHANNEL *	channel_order_table,
		int *	channel_order_count,
		int	channel_order_table_length
	)

Set the order in which channels are encoded into the bitstream.

The string contains the channel numbers in the order in which the channnels are encoded into the bitstream. First channel by number is channel zero.

Note that this facility allows the user to specify that only a subset of the component arrays are encoded as channels in the bitstream.

Here is the caller graph for this function:

GetEnabledParts()

bool GetEnabledParts	(	const char *	string,
		uint32_t *	enabled_parts_out
	)

Set the flags that indicate which parts of VC-5 are enabled.

The argument is a list of comma-separated integers for the part numbers in the VC-5 standard that are enabled for this invocation of the encoder.

Part 1 is always enabled.  Part 2 is never enabled (and is ignored).

Note: Enabling a part at runtime has no effect unless support for that part is compiled into the program by enabling the corresponding compile-time switch.

Here is the caller graph for this function:

GetEnabledSections()

bool GetEnabledSections	(	const char *	string,
		uint32_t *	enabled_sections_out
	)

Set the flags that indicate which sections in VC-5 Part 6 are enabled.

The argument is a list of comma-separated integers for the section numbers in the VC-5 Part 2 conformance specification that are enabled for this invocation of the encoder.

Note: Enabling sections at runtime has no effect unless support for sections is compiled into the program by enabling the corresponding compile-time switch for VC-5 part 6 (sections).

GetQuantization()

bool GetQuantization	(	const char *	string,
		QUANT *	quant
	)

Set the values in the quantization table.

The string contains the quantization values separated by commas.

Here is the caller graph for this function: