examples.mk

   1 ##
   2 ##  Copyright (c) 2010 The WebM project authors. All Rights Reserved.
   3 ##
   4 ##  Use of this source code is governed by a BSD-style license
   5 ##  that can be found in the LICENSE file in the root of the source
   6 ##  tree. An additional intellectual property rights grant can be found
   7 ##  in the file PATENTS.  All contributing project authors may
   8 ##  be found in the AUTHORS file in the root of the source tree.
   9 ##
  10
  11
  12 # List of examples to build. UTILS are files that are taken from the source
  13 # tree directly, and GEN_EXAMPLES are files that are created from the
  14 # examples folder.
  15 UTILS-$(CONFIG_DECODERS)    += vpxdec.c
  16 vpxdec.SRCS                 += md5_utils.c md5_utils.h
  17 vpxdec.SRCS                 += vpx_ports/vpx_timer.h
  18 vpxdec.SRCS                 += vpx/vpx_integer.h
  19 vpxdec.SRCS                 += args.c args.h vpx_ports/config.h
  20 vpxdec.SRCS                 += tools_common.c tools_common.h
  21 vpxdec.SRCS                 += nestegg/halloc/halloc.h
  22 vpxdec.SRCS                 += nestegg/halloc/src/align.h
  23 vpxdec.SRCS                 += nestegg/halloc/src/halloc.c
  24 vpxdec.SRCS                 += nestegg/halloc/src/hlist.h
  25 vpxdec.SRCS                 += nestegg/halloc/src/macros.h
  26 vpxdec.SRCS                 += nestegg/include/nestegg/nestegg.h
  27 vpxdec.SRCS                 += nestegg/src/nestegg.c
  28 vpxdec.GUID                  = BA5FE66F-38DD-E034-F542-B1578C5FB950
  29 vpxdec.DESCRIPTION           = Full featured decoder
  30 UTILS-$(CONFIG_ENCODERS)    += vpxenc.c
  31 vpxenc.SRCS                 += args.c args.h y4minput.c y4minput.h
  32 vpxenc.SRCS                 += tools_common.c tools_common.h
  33 vpxenc.SRCS                 += vpx_ports/config.h vpx_ports/mem_ops.h
  34 vpxenc.SRCS                 += vpx_ports/mem_ops_aligned.h
  35 vpxenc.SRCS                 += libmkv/EbmlIDs.h
  36 vpxenc.SRCS                 += libmkv/EbmlWriter.c
  37 vpxenc.SRCS                 += libmkv/EbmlWriter.h
  38 vpxenc.GUID                  = 548DEC74-7A15-4B2B-AFC3-AA102E7C25C1
  39 vpxenc.DESCRIPTION           = Full featured encoder
  40
  41 # Clean up old ivfenc, ivfdec binaries.
  42 ifeq ($(CONFIG_MSVS),yes)
  43 CLEAN-OBJS += $(foreach p,$(VS_PLATFORMS),$(p)/Release/ivfenc.exe)
  44 CLEAN-OBJS += $(foreach p,$(VS_PLATFORMS),$(p)/Release/ivfdec.exe)
  45 else
  46 CLEAN-OBJS += ivfenc{.c.o,.c.d,.dox,.exe,}
  47 CLEAN-OBJS += ivfdec{.c.o,.c.d,.dox,.exe,}
  48 endif
  49
  50 # XMA example disabled for now, not used in VP8
  51 #UTILS-$(CONFIG_DECODERS)    += example_xma.c
  52 #example_xma.GUID             = A955FC4A-73F1-44F7-135E-30D84D32F022
  53 #example_xma.DESCRIPTION      = External Memory Allocation mode usage
  54
  55 GEN_EXAMPLES-$(CONFIG_DECODERS) += simple_decoder.c
  56 simple_decoder.GUID              = D3BBF1E9-2427-450D-BBFF-B2843C1D44CC
  57 simple_decoder.DESCRIPTION       = Simplified decoder loop
  58 GEN_EXAMPLES-$(CONFIG_DECODERS) += postproc.c
  59 postproc.GUID                    = 65E33355-F35E-4088-884D-3FD4905881D7
  60 postproc.DESCRIPTION             = Decoder postprocessor control
  61 GEN_EXAMPLES-$(CONFIG_DECODERS) += decode_to_md5.c
  62 decode_to_md5.SRCS              += md5_utils.h md5_utils.c
  63 decode_to_md5.GUID               = 59120B9B-2735-4BFE-B022-146CA340FE42
  64 decode_to_md5.DESCRIPTION        = Frame by frame MD5 checksum
  65
  66 GEN_EXAMPLES-$(CONFIG_ENCODERS) += simple_encoder.c
  67 simple_encoder.GUID              = 4607D299-8A71-4D2C-9B1D-071899B6FBFD
  68 simple_encoder.DESCRIPTION       = Simplified encoder loop
  69 GEN_EXAMPLES-$(CONFIG_ENCODERS) += twopass_encoder.c
  70 twopass_encoder.GUID             = 73494FA6-4AF9-4763-8FBB-265C92402FD8
  71 twopass_encoder.DESCRIPTION      = Two-pass encoder loop
  72 GEN_EXAMPLES-$(CONFIG_ENCODERS) += force_keyframe.c
  73 force_keyframe.GUID              = 3C67CADF-029F-4C86-81F5-D6D4F51177F0
  74 force_keyframe.DESCRIPTION       = Force generation of keyframes
  75 ifeq ($(CONFIG_DECODERS),yes)
  76 GEN_EXAMPLES-$(CONFIG_ENCODERS) += decode_with_drops.c
  77 endif
  78 decode_with_drops.GUID           = CE5C53C4-8DDA-438A-86ED-0DDD3CDB8D26
  79 decode_with_drops.DESCRIPTION    = Drops frames while decoding
  80 GEN_EXAMPLES-$(CONFIG_ENCODERS) += error_resilient.c
  81 error_resilient.GUID             = DF5837B9-4145-4F92-A031-44E4F832E00C
  82 error_resilient.DESCRIPTION      = Error Resiliency Feature
  83
  84 GEN_EXAMPLES-$(CONFIG_VP8_ENCODER) += vp8_scalable_patterns.c
  85 vp8_scalable_patterns.GUID          = 0D6A210B-F482-4D6F-8570-4A9C01ACC88C
  86 vp8_scalable_patterns.DESCRIPTION   = VP8 Scalable Bitstream Patterns
  87 GEN_EXAMPLES-$(CONFIG_VP8_ENCODER) += vp8_set_maps.c
  88 vp8_set_maps.GUID                   = ECB2D24D-98B8-4015-A465-A4AF3DCC145F
  89 vp8_set_maps.DESCRIPTION            = VP8 set active and ROI maps
  90 GEN_EXAMPLES-$(CONFIG_VP8_ENCODER) += vp8cx_set_ref.c
  91 vp8cx_set_ref.GUID                  = C5E31F7F-96F6-48BD-BD3E-10EBF6E8057A
  92 vp8cx_set_ref.DESCRIPTION           = VP8 set encoder reference frame
  93
  94
  95 # Handle extra library flags depending on codec configuration
  96 CODEC_EXTRA_LIBS-$(CONFIG_VP8)         += m
  97
  98 #
  99 # End of specified files. The rest of the build rules should happen
 100 # automagically from here.
 101 #
 102
 103
 104 # Examples need different flags based on whether we're building
 105 # from an installed tree or a version controlled tree. Determine
 106 # the proper paths.
 107 ifeq ($(HAVE_ALT_TREE_LAYOUT),yes)
 108     LIB_PATH := $(SRC_PATH_BARE)/../lib
 109     INC_PATH := $(SRC_PATH_BARE)/../include
 110 else
 111     LIB_PATH-yes                     += $(if $(BUILD_PFX),$(BUILD_PFX),.)
 112     INC_PATH-$(CONFIG_VP8_DECODER)   += $(SRC_PATH_BARE)/vp8
 113     INC_PATH-$(CONFIG_VP8_ENCODER)   += $(SRC_PATH_BARE)/vp8
 114     LIB_PATH := $(call enabled,LIB_PATH)
 115     INC_PATH := $(call enabled,INC_PATH)
 116 endif
 117 CFLAGS += $(addprefix -I,$(INC_PATH))
 118 LDFLAGS += $(addprefix -L,$(LIB_PATH))
 119
 120
 121 # Expand list of selected examples to build (as specified above)
 122 UTILS           = $(call enabled,UTILS)
 123 GEN_EXAMPLES    = $(call enabled,GEN_EXAMPLES)
 124 ALL_EXAMPLES    = $(UTILS) $(GEN_EXAMPLES)
 125 UTIL_SRCS       = $(foreach ex,$(UTILS),$($(ex:.c=).SRCS))
 126 ALL_SRCS        = $(foreach ex,$(ALL_EXAMPLES),$($(ex:.c=).SRCS))
 127 CODEC_EXTRA_LIBS=$(sort $(call enabled,CODEC_EXTRA_LIBS))
 128
 129
 130 # Expand all example sources into a variable containing all sources
 131 # for that example (not just them main one specified in UTILS/GEN_EXAMPLES)
 132 # and add this file to the list (for MSVS workspace generation)
 133 $(foreach ex,$(ALL_EXAMPLES),$(eval $(ex:.c=).SRCS += $(ex) examples.mk))
 134
 135
 136 # If this is a universal (fat) binary, then all the subarchitectures have
 137 # already been built and our job is to stitch them together. The
 138 # BUILD_OBJS variable indicates whether we should be building
 139 # (compiling, linking) the library. The LIPO_OBJS variable indicates
 140 # that we're stitching.
 141 $(eval $(if $(filter universal%,$(TOOLCHAIN)),LIPO_OBJS,BUILD_OBJS):=yes)
 142
 143
 144 # Create build/install dependencies for all examples. The common case
 145 # is handled here. The MSVS case is handled below.
 146 NOT_MSVS = $(if $(CONFIG_MSVS),,yes)
 147 DIST-BINS-$(NOT_MSVS)      += $(addprefix bin/,$(ALL_EXAMPLES:.c=))
 148 INSTALL-BINS-$(NOT_MSVS)   += $(addprefix bin/,$(UTILS:.c=))
 149 DIST-SRCS-yes              += $(ALL_SRCS)
 150 INSTALL-SRCS-yes           += $(UTIL_SRCS)
 151 OBJS-$(NOT_MSVS)           += $(if $(BUILD_OBJS),$(call objs,$(ALL_SRCS)))
 152 BINS-$(NOT_MSVS)           += $(addprefix $(BUILD_PFX),$(ALL_EXAMPLES:.c=))
 153
 154
 155 # Instantiate linker template for all examples.
 156 CODEC_LIB=$(if $(CONFIG_DEBUG_LIBS),vpx_g,vpx)
 157 $(foreach bin,$(BINS-yes),\
 158     $(if $(BUILD_OBJS),$(eval $(bin): $(LIB_PATH)/lib$(CODEC_LIB).a))\
 159     $(if $(BUILD_OBJS),$(eval $(call linker_template,$(bin),\
 160         $(call objs,$($(notdir $(bin)).SRCS)) \
 161         -l$(CODEC_LIB) $(addprefix -l,$(CODEC_EXTRA_LIBS))\
 162         )))\
 163     $(if $(LIPO_OBJS),$(eval $(call lipo_bin_template,$(bin))))\
 164     )
 165
 166
 167 # Rules to generate the GEN_EXAMPLES sources
 168 .PRECIOUS: %.c
 169 CLEAN-OBJS += $(GEN_EXAMPLES)
 170 %.c: examples/%.txt
 171         @echo "    [EXAMPLE] $@"
 172         @$(SRC_PATH_BARE)/examples/gen_example_code.sh $< > $@
 173
 174
 175 # The following pairs define a mapping of locations in the distribution
 176 # tree to locations in the source/build trees.
 177 INSTALL_MAPS += src/%.c   %.c
 178 INSTALL_MAPS += src/%     $(SRC_PATH_BARE)/%
 179 INSTALL_MAPS += bin/%     %
 180 INSTALL_MAPS += %         %
 181
 182
 183 # Set up additional MSVS environment
 184 ifeq ($(CONFIG_MSVS),yes)
 185 CODEC_LIB=$(if $(CONFIG_STATIC_MSVCRT),vpxmt,vpxmd)
 186 # This variable uses deferred expansion intentionally, since the results of
 187 # $(wildcard) may change during the course of the Make.
 188 VS_PLATFORMS = $(foreach d,$(wildcard */Release/$(CODEC_LIB).lib),$(word 1,$(subst /, ,$(d))))
 189 INSTALL_MAPS += $(foreach p,$(VS_PLATFORMS),bin/$(p)/%  $(p)/Release/%)
 190 endif
 191
 192 # Build Visual Studio Projects. We use a template here to instantiate
 193 # explicit rules rather than using an implicit rule because we want to
 194 # leverage make's VPATH searching rather than specifying the paths on
 195 # each file in ALL_EXAMPLES. This has the unfortunate side effect that
 196 # touching the source files trigger a rebuild of the project files
 197 # even though there is no real dependency there (the dependency is on
 198 # the makefiles). We may want to revisit this.
 199 define vcproj_template
 200 $(1): $($(1:.vcproj=).SRCS)
 201         @echo "    [vcproj] $$@"
 202         $$(SRC_PATH_BARE)/build/make/gen_msvs_proj.sh\
 203             --exe\
 204             --target=$$(TOOLCHAIN)\
 205             --name=$$(@:.vcproj=)\
 206             --ver=$$(CONFIG_VS_VERSION)\
 207             --proj-guid=$$($$(@:.vcproj=).GUID)\
 208             $$(if $$(CONFIG_STATIC_MSVCRT),--static-crt) \
 209             --out=$$@ $$(CFLAGS) $$(LDFLAGS) -l$$(CODEC_LIB) -lwinmm $$^
 210 endef
 211 PROJECTS-$(CONFIG_MSVS) += $(ALL_EXAMPLES:.c=.vcproj)
 212 INSTALL-BINS-$(CONFIG_MSVS) += $(foreach p,$(VS_PLATFORMS),\
 213                                $(addprefix bin/$(p)/,$(ALL_EXAMPLES:.c=.exe)))
 214 $(foreach proj,$(call enabled,PROJECTS),\
 215     $(eval $(call vcproj_template,$(proj))))
 216
 217
 218
 219 #
 220 # Documentation Rules
 221 #
 222 %.dox: examples/%.txt
 223         @echo "    [DOXY] $@"
 224         @$(SRC_PATH_BARE)/examples/gen_example_text.sh $< | \
 225          $(SRC_PATH_BARE)/examples/gen_example_doxy.php \
 226              example_$(@:.dox=)  $(@:.dox=.c) > $@
 227
 228 %.dox: %.c
 229         @echo "    [DOXY] $@"
 230         @echo "/*!\page example_$(@:.dox=) $(@:.dox=)" > $@
 231         @echo "   \includelineno $(notdir $<)" >> $@
 232         @echo "*/" >> $@
 233
 234 samples.dox: examples.mk
 235         @echo "    [DOXY] $@"
 236         @echo "/*!\page samples Sample Code" > $@
 237         @echo "    This SDK includes a number of sample applications."\
 238               "each sample documents a feature of the SDK in both prose"\
 239               "and the associated C code. In general, later samples"\
 240               "build upon prior samples, so it is best to work through the"\
 241               "list in order. The following samples are included: ">>$@
 242         @$(foreach ex,$(GEN_EXAMPLES:.c=),\
 243            echo "     - \subpage example_$(ex) $($(ex).DESCRIPTION)" >> $@;)
 244         @echo >> $@
 245         @echo "    In addition, the SDK contains a number of utilities."\
 246               "Since these utilities are built upon the concepts described"\
 247               "in the sample code listed above, they are not documented in"\
 248               "pieces like the samples are. Thir sourcre is included here"\
 249               "for reference. The following utilities are included:" >> $@
 250         @$(foreach ex,$(UTILS:.c=),\
 251            echo "     - \subpage example_$(ex) $($(ex).DESCRIPTION)" >> $@;)
 252         @echo "*/" >> $@
 253
 254 CLEAN-OBJS += examples.doxy samples.dox $(ALL_EXAMPLES:.c=.dox)
 255 DOCS-yes += examples.doxy samples.dox $(ALL_EXAMPLES:.c=.dox)
 256 examples.doxy: samples.dox $(ALL_EXAMPLES:.c=.dox)
 257         @echo "INPUT += $^" > $@