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