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