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