15 Directory Structure

In support of re-use and maintainability, a VYA module's code files and accompanying documents are to be stored in a standard directory tree named after the module (e.g. mymodule), as indicated in Table 6.

Table 6: VYA directory tree (in alphabetical order)

mymodule/	subdirectory contents	remarks
doc/	module documentation, referenced docs (optional)
example/	myvyamoduleexample.cc, myvyamoduleexample.h, myvyamoduleexample.main.cc, makefile, video test sequences and responses (opt.), initialization files (opt.)	- video sequences may be referenced through links - frontend and backends referenced in makefile - makefile makes myvyamoduleexample
include/	myvyaprocess1.h, myvyaprocess2.h, ... myvyamodule.h	myvyamodule is the module's process network (opt.)
lib/	libmyvyamodule.a	subdirectory per O.S.
Makefile		makes lib/ and obj/
obj/	myvyaprocess1.o, myvyaprocess2.o, ... myvyamodule.o	subdirectory per O.S.
readme.txt		file-header-like module info plus installation instructions
src/	myprocess1.cc, myprocess2.cc, ... myvyamodule.cc	hierarchical for nested process networks

The (partial) directory tree of a VYA library with version control could for instance look like follows (with "$(HOME)" the directory in which the modules are installed):

$(HOME)/Modules/vya-0.2/
$(HOME)/Modules/vya-0.3/
$(HOME)/Modules/vya-0.3/cvbs_decoding/
$(HOME)/Modules/vya-0.3/front_backends/
$(HOME)/Modules/vya-0.3/front_backends/sgi_divo/
$(HOME)/Modules/vya-0.3/front_backends/sgi_divo/v1/(as in Table 6)
$(HOME)/Modules/vya-0.3/front_backends/vya_pfspd/
$(HOME)/Modules/vya-0.3/front_backends/vya_pfspd/v1/(as in Table 6)
$(HOME)/Modules/vya-0.3/mpeg_decoding/
$(HOME)/Modules/vya-0.3/noise_reduction/
$(HOME)/Modules/vya-0.3/picture_control/
$(HOME)/Modules/vya-0.3/scanrate_conversion/
$(HOME)/Modules/vya-0.3/sharpness_enhancement/
$(HOME)/Modules/vya-0.3/spatial_scaling/