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