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