examples.mk 15.7 KB
Newer Older
John Koleszar's avatar
John Koleszar committed
1
##
2
##  Copyright (c) 2010 The WebM project authors. All Rights Reserved.
John Koleszar's avatar
John Koleszar committed
3
##
4
##  Use of this source code is governed by a BSD-style license
5
6
##  that can be found in the LICENSE file in the root of the source
##  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.
John Koleszar's avatar
John Koleszar committed
9
10
##

11
12
13
14
15
16
LIBYUV_SRCS +=  third_party/libyuv/include/libyuv/basic_types.h  \
                third_party/libyuv/include/libyuv/cpu_id.h  \
                third_party/libyuv/include/libyuv/scale.h  \
                third_party/libyuv/source/row.h \
                third_party/libyuv/source/scale.c  \
                third_party/libyuv/source/cpu_id.c
John Koleszar's avatar
John Koleszar committed
17

18
19
# List of examples to build. UTILS are tools meant for distribution
# while EXAMPLES demonstrate specific portions of the API.
20
21
UTILS-$(CONFIG_DECODERS)    += vpxdec.c
vpxdec.SRCS                 += md5_utils.c md5_utils.h
22
23
vpxdec.SRCS                 += vpx_ports/mem_ops.h
vpxdec.SRCS                 += vpx_ports/mem_ops_aligned.h
24
25
vpxdec.SRCS                 += vpx_ports/vpx_timer.h
vpxdec.SRCS                 += vpx/vpx_integer.h
26
vpxdec.SRCS                 += args.c args.h
27
vpxdec.SRCS                 += ivfdec.c ivfdec.h
John Koleszar's avatar
John Koleszar committed
28
vpxdec.SRCS                 += tools_common.c tools_common.h
29
vpxdec.SRCS                 += webmdec.c webmdec.h
30
vpxdec.SRCS                 += y4menc.c y4menc.h
James Zern's avatar
James Zern committed
31
32
33
34
35
36
37
vpxdec.SRCS                 += third_party/nestegg/halloc/halloc.h
vpxdec.SRCS                 += third_party/nestegg/halloc/src/align.h
vpxdec.SRCS                 += third_party/nestegg/halloc/src/halloc.c
vpxdec.SRCS                 += third_party/nestegg/halloc/src/hlist.h
vpxdec.SRCS                 += third_party/nestegg/halloc/src/macros.h
vpxdec.SRCS                 += third_party/nestegg/include/nestegg/nestegg.h
vpxdec.SRCS                 += third_party/nestegg/src/nestegg.c
John Koleszar's avatar
John Koleszar committed
38
vpxdec.SRCS                 += $(LIBYUV_SRCS)
39
40
41
vpxdec.GUID                  = BA5FE66F-38DD-E034-F542-B1578C5FB950
vpxdec.DESCRIPTION           = Full featured decoder
UTILS-$(CONFIG_ENCODERS)    += vpxenc.c
42
vpxenc.SRCS                 += args.c args.h y4minput.c y4minput.h vpxenc.h
43
44
vpxenc.SRCS                 += ivfdec.c ivfdec.h
vpxenc.SRCS                 += ivfenc.c ivfenc.h
45
vpxenc.SRCS                 += rate_hist.c rate_hist.h
John Koleszar's avatar
John Koleszar committed
46
vpxenc.SRCS                 += tools_common.c tools_common.h
47
vpxenc.SRCS                 += warnings.c warnings.h
48
vpxenc.SRCS                 += webmenc.c webmenc.h
49
vpxenc.SRCS                 += vpx_ports/mem_ops.h
50
vpxenc.SRCS                 += vpx_ports/mem_ops_aligned.h
Johann's avatar
Johann committed
51
vpxenc.SRCS                 += vpx_ports/vpx_timer.h
52
vpxenc.SRCS                 += vpxstats.c vpxstats.h
53
54
55
vpxenc.SRCS                 += third_party/libmkv/EbmlIDs.h
vpxenc.SRCS                 += third_party/libmkv/EbmlWriter.c
vpxenc.SRCS                 += third_party/libmkv/EbmlWriter.h
56
vpxenc.SRCS                 += $(LIBYUV_SRCS)
57
58
vpxenc.GUID                  = 548DEC74-7A15-4B2B-AFC3-AA102E7C25C1
vpxenc.DESCRIPTION           = Full featured encoder
59
EXAMPLES-$(CONFIG_VP9_ENCODER)    += vp9_spatial_scalable_encoder.c
60
vp9_spatial_scalable_encoder.SRCS += args.c args.h
61
62
vp9_spatial_scalable_encoder.SRCS += ivfenc.c ivfenc.h
vp9_spatial_scalable_encoder.SRCS += tools_common.c tools_common.h
63
64
vp9_spatial_scalable_encoder.SRCS += video_common.h
vp9_spatial_scalable_encoder.SRCS += video_writer.h video_writer.c
65
vp9_spatial_scalable_encoder.SRCS += vpxstats.c vpxstats.h
James Zern's avatar
James Zern committed
66
67
vp9_spatial_scalable_encoder.GUID   = 4A38598D-627D-4505-9C7B-D4020C84100D
vp9_spatial_scalable_encoder.DESCRIPTION = Spatial Scalable Encoder
68

69
70
71
72
ifeq ($(CONFIG_SHARED),no)
UTILS-$(CONFIG_VP9_ENCODER)    += resize_util.c
endif

73
74
75
76
# XMA example disabled for now, not used in VP8
#UTILS-$(CONFIG_DECODERS)    += example_xma.c
#example_xma.GUID             = A955FC4A-73F1-44F7-135E-30D84D32F022
#example_xma.DESCRIPTION      = External Memory Allocation mode usage
John Koleszar's avatar
John Koleszar committed
77

78
79
80
EXAMPLES-$(CONFIG_ENCODERS)         += vpx_temporal_scalable_patterns.c
vpx_temporal_scalable_patterns.SRCS += ivfenc.c ivfenc.h
vpx_temporal_scalable_patterns.SRCS += tools_common.c tools_common.h
81
82
vpx_temporal_scalable_patterns.SRCS += video_common.h
vpx_temporal_scalable_patterns.SRCS += video_writer.h video_writer.c
83
84
vpx_temporal_scalable_patterns.GUID  = B18C08F2-A439-4502-A78E-849BE3D60947
vpx_temporal_scalable_patterns.DESCRIPTION = Temporal Scalability Encoder
85
86
EXAMPLES-$(CONFIG_VP8_DECODER)     += simple_decoder.c
simple_decoder.GUID                 = D3BBF1E9-2427-450D-BBFF-B2843C1D44CC
87
88
simple_decoder.SRCS                += ivfdec.h ivfdec.c
simple_decoder.SRCS                += tools_common.h tools_common.c
89
90
simple_decoder.SRCS                += video_common.h
simple_decoder.SRCS                += video_reader.h video_reader.c
91
92
simple_decoder.SRCS                += vpx_ports/mem_ops.h
simple_decoder.SRCS                += vpx_ports/mem_ops_aligned.h
93
94
simple_decoder.DESCRIPTION          = Simplified decoder loop
EXAMPLES-$(CONFIG_VP8_DECODER)     += postproc.c
95
96
postproc.SRCS                      += ivfdec.h ivfdec.c
postproc.SRCS                      += tools_common.h tools_common.c
97
98
postproc.SRCS                      += video_common.h
postproc.SRCS                      += video_reader.h video_reader.c
99
100
postproc.SRCS                      += vpx_ports/mem_ops.h
postproc.SRCS                      += vpx_ports/mem_ops_aligned.h
101
102
103
postproc.GUID                       = 65E33355-F35E-4088-884D-3FD4905881D7
postproc.DESCRIPTION                = Decoder postprocessor control
EXAMPLES-$(CONFIG_VP8_DECODER)     += decode_to_md5.c
104
105
106
decode_to_md5.SRCS                 += md5_utils.h md5_utils.c
decode_to_md5.SRCS                 += ivfdec.h ivfdec.c
decode_to_md5.SRCS                 += tools_common.h tools_common.c
107
108
decode_to_md5.SRCS                 += video_common.h
decode_to_md5.SRCS                 += video_reader.h video_reader.c
109
110
decode_to_md5.SRCS                 += vpx_ports/mem_ops.h
decode_to_md5.SRCS                 += vpx_ports/mem_ops_aligned.h
111
112
113
decode_to_md5.GUID                  = 59120B9B-2735-4BFE-B022-146CA340FE42
decode_to_md5.DESCRIPTION           = Frame by frame MD5 checksum
EXAMPLES-$(CONFIG_VP8_ENCODER)  += simple_encoder.c
114
115
116
117
simple_encoder.SRCS             += ivfenc.h ivfenc.c
simple_encoder.SRCS             += tools_common.h tools_common.c
simple_encoder.SRCS             += video_common.h
simple_encoder.SRCS             += video_writer.h video_writer.c
John Koleszar's avatar
John Koleszar committed
118
119
simple_encoder.GUID              = 4607D299-8A71-4D2C-9B1D-071899B6FBFD
simple_encoder.DESCRIPTION       = Simplified encoder loop
120
EXAMPLES-$(CONFIG_VP8_ENCODER)  += twopass_encoder.c
121
122
123
124
twopass_encoder.SRCS            += ivfenc.h ivfenc.c
twopass_encoder.SRCS            += tools_common.h tools_common.c
twopass_encoder.SRCS            += video_common.h
twopass_encoder.SRCS            += video_writer.h video_writer.c
John Koleszar's avatar
John Koleszar committed
125
126
twopass_encoder.GUID             = 73494FA6-4AF9-4763-8FBB-265C92402FD8
twopass_encoder.DESCRIPTION      = Two-pass encoder loop
127
EXAMPLES-$(CONFIG_VP8_ENCODER)  += force_keyframe.c
John Koleszar's avatar
John Koleszar committed
128
129
130
force_keyframe.GUID              = 3C67CADF-029F-4C86-81F5-D6D4F51177F0
force_keyframe.DESCRIPTION       = Force generation of keyframes
ifeq ($(CONFIG_DECODERS),yes)
131
132
133
EXAMPLES-$(CONFIG_VP8_ENCODER)  += decode_with_drops.c
decode_with_drops.SRCS          += ivfdec.h ivfdec.c
decode_with_drops.SRCS          += tools_common.h tools_common.c
134
135
decode_with_drops.SRCS          += video_common.h
decode_with_drops.SRCS          += video_reader.h video_reader.c
136
137
decode_with_drops.SRCS          += vpx_ports/mem_ops.h
decode_with_drops.SRCS          += vpx_ports/mem_ops_aligned.h
John Koleszar's avatar
John Koleszar committed
138
139
140
endif
decode_with_drops.GUID           = CE5C53C4-8DDA-438A-86ED-0DDD3CDB8D26
decode_with_drops.DESCRIPTION    = Drops frames while decoding
141
ifeq ($(CONFIG_VP8_DECODER),yes)
142
EXAMPLES-$(CONFIG_ERROR_CONCEALMENT)    += decode_with_partial_drops.c
143
144
145
endif
decode_with_partial_drops.GUID           = 61C2D026-5754-46AC-916F-1343ECC5537E
decode_with_partial_drops.DESCRIPTION    = Drops parts of frames while decoding
146
EXAMPLES-$(CONFIG_VP8_ENCODER)  += error_resilient.c
John Koleszar's avatar
John Koleszar committed
147
148
149
error_resilient.GUID             = DF5837B9-4145-4F92-A031-44E4F832E00C
error_resilient.DESCRIPTION      = Error Resiliency Feature

150
EXAMPLES-$(CONFIG_VP8_ENCODER)     += vp8_set_maps.c
151
152
153
154
vp8_set_maps.SRCS                  += ivfenc.h ivfenc.c
vp8_set_maps.SRCS                  += tools_common.h tools_common.c
vp8_set_maps.SRCS                  += video_common.h
vp8_set_maps.SRCS                  += video_writer.h video_writer.c
John Koleszar's avatar
John Koleszar committed
155
156
vp8_set_maps.GUID                   = ECB2D24D-98B8-4015-A465-A4AF3DCC145F
vp8_set_maps.DESCRIPTION            = VP8 set active and ROI maps
157
EXAMPLES-$(CONFIG_VP8_ENCODER)     += vp8cx_set_ref.c
John Koleszar's avatar
John Koleszar committed
158
159
160
vp8cx_set_ref.GUID                  = C5E31F7F-96F6-48BD-BD3E-10EBF6E8057A
vp8cx_set_ref.DESCRIPTION           = VP8 set encoder reference frame

161
162

ifeq ($(CONFIG_MULTI_RES_ENCODING),yes)
163
EXAMPLES-$(CONFIG_VP8_DECODER)          += vp8_multi_resolution_encoder.c
164
165
166
167
vp8_multi_resolution_encoder.SRCS       += $(LIBYUV_SRCS)
vp8_multi_resolution_encoder.GUID        = 04f8738e-63c8-423b-90fa-7c2703a374de
vp8_multi_resolution_encoder.DESCRIPTION = VP8 Multiple-resolution Encoding
endif
John Koleszar's avatar
John Koleszar committed
168
169
170

# Handle extra library flags depending on codec configuration

171
172
173
174
# We should not link to math library (libm) on RVCT
# when building for bare-metal targets
ifeq ($(CONFIG_OS_SUPPORT), yes)
CODEC_EXTRA_LIBS-$(CONFIG_VP8)         += m
175
CODEC_EXTRA_LIBS-$(CONFIG_VP9)         += m
176
177
178
else
    ifeq ($(CONFIG_GCC), yes)
    CODEC_EXTRA_LIBS-$(CONFIG_VP8)         += m
179
    CODEC_EXTRA_LIBS-$(CONFIG_VP9)         += m
180
181
    endif
endif
John Koleszar's avatar
John Koleszar committed
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
#
# End of specified files. The rest of the build rules should happen
# automagically from here.
#


# Examples need different flags based on whether we're building
# from an installed tree or a version controlled tree. Determine
# the proper paths.
ifeq ($(HAVE_ALT_TREE_LAYOUT),yes)
    LIB_PATH := $(SRC_PATH_BARE)/../lib
    INC_PATH := $(SRC_PATH_BARE)/../include
else
    LIB_PATH-yes                     += $(if $(BUILD_PFX),$(BUILD_PFX),.)
    INC_PATH-$(CONFIG_VP8_DECODER)   += $(SRC_PATH_BARE)/vp8
    INC_PATH-$(CONFIG_VP8_ENCODER)   += $(SRC_PATH_BARE)/vp8
198
199
    INC_PATH-$(CONFIG_VP9_DECODER)   += $(SRC_PATH_BARE)/vp9
    INC_PATH-$(CONFIG_VP9_ENCODER)   += $(SRC_PATH_BARE)/vp9
John Koleszar's avatar
John Koleszar committed
200
201
202
    LIB_PATH := $(call enabled,LIB_PATH)
    INC_PATH := $(call enabled,INC_PATH)
endif
203
204
INTERNAL_CFLAGS = $(addprefix -I,$(INC_PATH))
INTERNAL_LDFLAGS += $(addprefix -L,$(LIB_PATH))
John Koleszar's avatar
John Koleszar committed
205
206
207
208


# Expand list of selected examples to build (as specified above)
UTILS           = $(call enabled,UTILS)
209
210
EXAMPLES        = $(addprefix examples/,$(call enabled,EXAMPLES))
ALL_EXAMPLES    = $(UTILS) $(EXAMPLES)
211
UTIL_SRCS       = $(foreach ex,$(UTILS),$($(ex:.c=).SRCS))
212
ALL_SRCS        = $(foreach ex,$(ALL_EXAMPLES),$($(notdir $(ex:.c=)).SRCS))
John Koleszar's avatar
John Koleszar committed
213
214
215
216
CODEC_EXTRA_LIBS=$(sort $(call enabled,CODEC_EXTRA_LIBS))


# Expand all example sources into a variable containing all sources
217
# for that example (not just them main one specified in UTILS/EXAMPLES)
John Koleszar's avatar
John Koleszar committed
218
# and add this file to the list (for MSVS workspace generation)
219
$(foreach ex,$(ALL_EXAMPLES),$(eval $(notdir $(ex:.c=)).SRCS += $(ex) examples.mk))
John Koleszar's avatar
John Koleszar committed
220
221
222
223
224
225
226
227
228
229
230
231
232


# If this is a universal (fat) binary, then all the subarchitectures have
# already been built and our job is to stitch them together. The
# BUILD_OBJS variable indicates whether we should be building
# (compiling, linking) the library. The LIPO_OBJS variable indicates
# that we're stitching.
$(eval $(if $(filter universal%,$(TOOLCHAIN)),LIPO_OBJS,BUILD_OBJS):=yes)


# Create build/install dependencies for all examples. The common case
# is handled here. The MSVS case is handled below.
NOT_MSVS = $(if $(CONFIG_MSVS),,yes)
KO Myung-Hun's avatar
KO Myung-Hun committed
233
234
DIST-BINS-$(NOT_MSVS)      += $(addprefix bin/,$(ALL_EXAMPLES:.c=$(EXE_SFX)))
INSTALL-BINS-$(NOT_MSVS)   += $(addprefix bin/,$(UTILS:.c=$(EXE_SFX)))
235
236
DIST-SRCS-yes              += $(ALL_SRCS)
INSTALL-SRCS-yes           += $(UTIL_SRCS)
John Koleszar's avatar
John Koleszar committed
237
OBJS-$(NOT_MSVS)           += $(if $(BUILD_OBJS),$(call objs,$(ALL_SRCS)))
KO Myung-Hun's avatar
KO Myung-Hun committed
238
BINS-$(NOT_MSVS)           += $(addprefix $(BUILD_PFX),$(ALL_EXAMPLES:.c=$(EXE_SFX)))
John Koleszar's avatar
John Koleszar committed
239
240
241
242


# Instantiate linker template for all examples.
CODEC_LIB=$(if $(CONFIG_DEBUG_LIBS),vpx_g,vpx)
jimbankoski's avatar
jimbankoski committed
243
244
SHARED_LIB_SUF=$(if $(filter darwin%,$(TGT_OS)),.dylib,.so)
CODEC_LIB_SUF=$(if $(CONFIG_SHARED),$(SHARED_LIB_SUF),.a)
John Koleszar's avatar
John Koleszar committed
245
$(foreach bin,$(BINS-yes),\
246
247
    $(if $(BUILD_OBJS),$(eval $(bin):\
        $(LIB_PATH)/lib$(CODEC_LIB)$(CODEC_LIB_SUF)))\
John Koleszar's avatar
John Koleszar committed
248
    $(if $(BUILD_OBJS),$(eval $(call linker_template,$(bin),\
KO Myung-Hun's avatar
KO Myung-Hun committed
249
        $(call objs,$($(notdir $(bin:$(EXE_SFX)=)).SRCS)) \
John Koleszar's avatar
John Koleszar committed
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
        -l$(CODEC_LIB) $(addprefix -l,$(CODEC_EXTRA_LIBS))\
        )))\
    $(if $(LIPO_OBJS),$(eval $(call lipo_bin_template,$(bin))))\
    )


# The following pairs define a mapping of locations in the distribution
# tree to locations in the source/build trees.
INSTALL_MAPS += src/%.c   %.c
INSTALL_MAPS += src/%     $(SRC_PATH_BARE)/%
INSTALL_MAPS += bin/%     %
INSTALL_MAPS += %         %


# Set up additional MSVS environment
ifeq ($(CONFIG_MSVS),yes)
Jim Bankoski's avatar
Jim Bankoski committed
266
CODEC_LIB=$(if $(CONFIG_SHARED),vpx,$(if $(CONFIG_STATIC_MSVCRT),vpxmt,vpxmd))
John Koleszar's avatar
John Koleszar committed
267
268
269
270
271
272
273
274
275
276
277
278
279
280
# This variable uses deferred expansion intentionally, since the results of
# $(wildcard) may change during the course of the Make.
VS_PLATFORMS = $(foreach d,$(wildcard */Release/$(CODEC_LIB).lib),$(word 1,$(subst /, ,$(d))))
INSTALL_MAPS += $(foreach p,$(VS_PLATFORMS),bin/$(p)/%  $(p)/Release/%)
endif

# Build Visual Studio Projects. We use a template here to instantiate
# explicit rules rather than using an implicit rule because we want to
# leverage make's VPATH searching rather than specifying the paths on
# each file in ALL_EXAMPLES. This has the unfortunate side effect that
# touching the source files trigger a rebuild of the project files
# even though there is no real dependency there (the dependency is on
# the makefiles). We may want to revisit this.
define vcproj_template
281
$(1): $($(1:.$(VCPROJ_SFX)=).SRCS) vpx.$(VCPROJ_SFX)
John Koleszar's avatar
John Koleszar committed
282
	@echo "    [vcproj] $$@"
283
	$$(GEN_VCPROJ)\
John Koleszar's avatar
John Koleszar committed
284
285
            --exe\
            --target=$$(TOOLCHAIN)\
286
            --name=$$(@:.$(VCPROJ_SFX)=)\
John Koleszar's avatar
John Koleszar committed
287
            --ver=$$(CONFIG_VS_VERSION)\
288
            --proj-guid=$$($$(@:.$(VCPROJ_SFX)=).GUID)\
John Koleszar's avatar
John Koleszar committed
289
            $$(if $$(CONFIG_STATIC_MSVCRT),--static-crt) \
290
            --out=$$@ $$(INTERNAL_CFLAGS) $$(CFLAGS) \
291
            $$(INTERNAL_LDFLAGS) $$(LDFLAGS) -l$$(CODEC_LIB) $$^
John Koleszar's avatar
John Koleszar committed
292
endef
293
294
ALL_EXAMPLES_BASENAME := $(notdir $(ALL_EXAMPLES))
PROJECTS-$(CONFIG_MSVS) += $(ALL_EXAMPLES_BASENAME:.c=.$(VCPROJ_SFX))
John Koleszar's avatar
John Koleszar committed
295
INSTALL-BINS-$(CONFIG_MSVS) += $(foreach p,$(VS_PLATFORMS),\
296
                               $(addprefix bin/$(p)/,$(ALL_EXAMPLES_BASENAME:.c=.exe)))
John Koleszar's avatar
John Koleszar committed
297
298
$(foreach proj,$(call enabled,PROJECTS),\
    $(eval $(call vcproj_template,$(proj))))
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331

#
# Documentation Rules
#
%.dox: %.c
	@echo "    [DOXY] $@"
	@echo "/*!\page example_$(@F:.dox=) $(@F:.dox=)" > $@
	@echo "   \includelineno $(<F)" >> $@
	@echo "*/" >> $@

samples.dox: examples.mk
	@echo "    [DOXY] $@"
	@echo "/*!\page samples Sample Code" > $@
	@echo "    This SDK includes a number of sample applications."\
	      "Each sample documents a feature of the SDK in both prose"\
	      "and the associated C code."\
	      "The following samples are included: ">>$@
	@$(foreach ex,$(sort $(notdir $(EXAMPLES:.c=))),\
	   echo "     - \subpage example_$(ex) $($(ex).DESCRIPTION)" >> $@;)
	@echo >> $@
	@echo "    In addition, the SDK contains a number of utilities."\
              "Since these utilities are built upon the concepts described"\
              "in the sample code listed above, they are not documented in"\
              "pieces like the samples are. Their source is included here"\
              "for reference. The following utilities are included:" >> $@
	@$(foreach ex,$(sort $(UTILS:.c=)),\
	   echo "     - \subpage example_$(ex) $($(ex).DESCRIPTION)" >> $@;)
	@echo "*/" >> $@

CLEAN-OBJS += examples.doxy samples.dox $(ALL_EXAMPLES:.c=.dox)
DOCS-yes += examples.doxy samples.dox
examples.doxy: samples.dox $(ALL_EXAMPLES:.c=.dox)
	@echo "INPUT += $^" > $@