examples.mk 14.9 KB
Newer Older
John Koleszar's avatar
John Koleszar committed
1
##
2
## Copyright (c) 2016, Alliance for Open Media. All rights reserved
John Koleszar's avatar
John Koleszar committed
3
##
4 5 6 7 8 9
## This source code is subject to the terms of the BSD 2 Clause License and
## the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License
## was not distributed with this source code in the LICENSE file, you can
## obtain it at www.aomedia.org/license/software. If the Alliance for Open
## Media Patent License 1.0 was not distributed with this source code in the
## PATENTS file, you can obtain it at www.aomedia.org/license/patent.
John Koleszar's avatar
John Koleszar committed
10 11
##

12

13
LIBYUV_SRCS +=  third_party/libyuv/include/libyuv/basic_types.h  \
James Zern's avatar
James Zern committed
14 15 16
                third_party/libyuv/include/libyuv/convert.h \
                third_party/libyuv/include/libyuv/convert_argb.h \
                third_party/libyuv/include/libyuv/convert_from.h \
17
                third_party/libyuv/include/libyuv/cpu_id.h  \
Deb Mukherjee's avatar
Deb Mukherjee committed
18
                third_party/libyuv/include/libyuv/planar_functions.h  \
James Zern's avatar
James Zern committed
19
                third_party/libyuv/include/libyuv/rotate.h  \
Deb Mukherjee's avatar
Deb Mukherjee committed
20
                third_party/libyuv/include/libyuv/row.h  \
21
                third_party/libyuv/include/libyuv/scale.h  \
Deb Mukherjee's avatar
Deb Mukherjee committed
22 23 24 25 26
                third_party/libyuv/include/libyuv/scale_row.h  \
                third_party/libyuv/source/cpu_id.cc \
                third_party/libyuv/source/planar_functions.cc \
                third_party/libyuv/source/row_any.cc \
                third_party/libyuv/source/row_common.cc \
James Zern's avatar
James Zern committed
27
                third_party/libyuv/source/row_gcc.cc \
Deb Mukherjee's avatar
Deb Mukherjee committed
28 29
                third_party/libyuv/source/row_mips.cc \
                third_party/libyuv/source/row_neon.cc \
James Zern's avatar
James Zern committed
30
                third_party/libyuv/source/row_neon64.cc \
Deb Mukherjee's avatar
Deb Mukherjee committed
31
                third_party/libyuv/source/row_win.cc \
James Zern's avatar
James Zern committed
32
                third_party/libyuv/source/scale.cc \
James Zern's avatar
James Zern committed
33
                third_party/libyuv/source/scale_any.cc \
Deb Mukherjee's avatar
Deb Mukherjee committed
34
                third_party/libyuv/source/scale_common.cc \
James Zern's avatar
James Zern committed
35
                third_party/libyuv/source/scale_gcc.cc \
Deb Mukherjee's avatar
Deb Mukherjee committed
36 37
                third_party/libyuv/source/scale_mips.cc \
                third_party/libyuv/source/scale_neon.cc \
James Zern's avatar
James Zern committed
38
                third_party/libyuv/source/scale_neon64.cc \
James Zern's avatar
James Zern committed
39
                third_party/libyuv/source/scale_win.cc \
John Koleszar's avatar
John Koleszar committed
40

41 42
LIBWEBM_COMMON_SRCS += third_party/libwebm/webmids.hpp

43 44 45 46 47 48 49
LIBWEBM_MUXER_SRCS += third_party/libwebm/mkvmuxer.cpp \
                      third_party/libwebm/mkvmuxerutil.cpp \
                      third_party/libwebm/mkvwriter.cpp \
                      third_party/libwebm/mkvmuxer.hpp \
                      third_party/libwebm/mkvmuxertypes.hpp \
                      third_party/libwebm/mkvmuxerutil.hpp \
                      third_party/libwebm/mkvparser.hpp \
50
                      third_party/libwebm/mkvwriter.hpp
51

52 53 54 55 56
LIBWEBM_PARSER_SRCS = third_party/libwebm/mkvparser.cpp \
                      third_party/libwebm/mkvreader.cpp \
                      third_party/libwebm/mkvparser.hpp \
                      third_party/libwebm/mkvreader.hpp

57 58
# List of examples to build. UTILS are tools meant for distribution
# while EXAMPLES demonstrate specific portions of the API.
Adrian Grange's avatar
Adrian Grange committed
59 60 61 62 63 64 65 66 67 68 69
UTILS-$(CONFIG_DECODERS)    += aomdec.c
aomdec.SRCS                 += md5_utils.c md5_utils.h
aomdec.SRCS                 += aom_ports/mem_ops.h
aomdec.SRCS                 += aom_ports/mem_ops_aligned.h
aomdec.SRCS                 += aom_ports/msvc.h
aomdec.SRCS                 += aom_ports/aom_timer.h
aomdec.SRCS                 += aom/aom_integer.h
aomdec.SRCS                 += args.c args.h
aomdec.SRCS                 += ivfdec.c ivfdec.h
aomdec.SRCS                 += tools_common.c tools_common.h
aomdec.SRCS                 += y4menc.c y4menc.h
Deb Mukherjee's avatar
Deb Mukherjee committed
70
ifeq ($(CONFIG_LIBYUV),yes)
Adrian Grange's avatar
Adrian Grange committed
71
  aomdec.SRCS                 += $(LIBYUV_SRCS)
Deb Mukherjee's avatar
Deb Mukherjee committed
72
endif
73
ifeq ($(CONFIG_WEBM_IO),yes)
Adrian Grange's avatar
Adrian Grange committed
74 75 76
  aomdec.SRCS                 += $(LIBWEBM_COMMON_SRCS)
  aomdec.SRCS                 += $(LIBWEBM_PARSER_SRCS)
  aomdec.SRCS                 += webmdec.cc webmdec.h
77
endif
Adrian Grange's avatar
Adrian Grange committed
78 79 80 81 82 83 84 85 86 87 88 89 90 91
aomdec.GUID                  = BA5FE66F-38DD-E034-F542-B1578C5FB950
aomdec.DESCRIPTION           = Full featured decoder
UTILS-$(CONFIG_ENCODERS)    += aomenc.c
aomenc.SRCS                 += args.c args.h y4minput.c y4minput.h aomenc.h
aomenc.SRCS                 += ivfdec.c ivfdec.h
aomenc.SRCS                 += ivfenc.c ivfenc.h
aomenc.SRCS                 += rate_hist.c rate_hist.h
aomenc.SRCS                 += tools_common.c tools_common.h
aomenc.SRCS                 += warnings.c warnings.h
aomenc.SRCS                 += aom_ports/mem_ops.h
aomenc.SRCS                 += aom_ports/mem_ops_aligned.h
aomenc.SRCS                 += aom_ports/msvc.h
aomenc.SRCS                 += aom_ports/aom_timer.h
aomenc.SRCS                 += aomstats.c aomstats.h
Deb Mukherjee's avatar
Deb Mukherjee committed
92
ifeq ($(CONFIG_LIBYUV),yes)
Adrian Grange's avatar
Adrian Grange committed
93
  aomenc.SRCS                 += $(LIBYUV_SRCS)
Deb Mukherjee's avatar
Deb Mukherjee committed
94
endif
95
ifeq ($(CONFIG_WEBM_IO),yes)
Adrian Grange's avatar
Adrian Grange committed
96 97 98
  aomenc.SRCS                 += $(LIBWEBM_COMMON_SRCS)
  aomenc.SRCS                 += $(LIBWEBM_MUXER_SRCS)
  aomenc.SRCS                 += webmenc.cc webmenc.h
99
endif
Adrian Grange's avatar
Adrian Grange committed
100 101
aomenc.GUID                  = 548DEC74-7A15-4B2B-AFC3-AA102E7C25C1
aomenc.DESCRIPTION           = Full featured encoder
102

103
EXAMPLES-$(CONFIG_DECODERS)        += simple_decoder.c
104
simple_decoder.GUID                 = D3BBF1E9-2427-450D-BBFF-B2843C1D44CC
105 106
simple_decoder.SRCS                += ivfdec.h ivfdec.c
simple_decoder.SRCS                += tools_common.h tools_common.c
107 108
simple_decoder.SRCS                += video_common.h
simple_decoder.SRCS                += video_reader.h video_reader.c
Yaowu Xu's avatar
Yaowu Xu committed
109 110 111
simple_decoder.SRCS                += aom_ports/mem_ops.h
simple_decoder.SRCS                += aom_ports/mem_ops_aligned.h
simple_decoder.SRCS                += aom_ports/msvc.h
112
simple_decoder.DESCRIPTION          = Simplified decoder loop
113
EXAMPLES-$(CONFIG_DECODERS)        += decode_to_md5.c
114 115 116
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
117 118
decode_to_md5.SRCS                 += video_common.h
decode_to_md5.SRCS                 += video_reader.h video_reader.c
Yaowu Xu's avatar
Yaowu Xu committed
119 120 121
decode_to_md5.SRCS                 += aom_ports/mem_ops.h
decode_to_md5.SRCS                 += aom_ports/mem_ops_aligned.h
decode_to_md5.SRCS                 += aom_ports/msvc.h
122 123
decode_to_md5.GUID                  = 59120B9B-2735-4BFE-B022-146CA340FE42
decode_to_md5.DESCRIPTION           = Frame by frame MD5 checksum
124
EXAMPLES-$(CONFIG_ENCODERS)     += simple_encoder.c
125 126 127 128
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
Yaowu Xu's avatar
Yaowu Xu committed
129
simple_encoder.SRCS             += aom_ports/msvc.h
John Koleszar's avatar
John Koleszar committed
130 131
simple_encoder.GUID              = 4607D299-8A71-4D2C-9B1D-071899B6FBFD
simple_encoder.DESCRIPTION       = Simplified encoder loop
132
EXAMPLES-$(CONFIG_ENCODERS)     += twopass_encoder.c
133 134 135 136
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
Yaowu Xu's avatar
Yaowu Xu committed
137
twopass_encoder.SRCS            += aom_ports/msvc.h
John Koleszar's avatar
John Koleszar committed
138 139
twopass_encoder.GUID             = 73494FA6-4AF9-4763-8FBB-265C92402FD8
twopass_encoder.DESCRIPTION      = Two-pass encoder loop
140
EXAMPLES-$(CONFIG_DECODERS)     += decode_with_drops.c
141 142
decode_with_drops.SRCS          += ivfdec.h ivfdec.c
decode_with_drops.SRCS          += tools_common.h tools_common.c
143 144
decode_with_drops.SRCS          += video_common.h
decode_with_drops.SRCS          += video_reader.h video_reader.c
Yaowu Xu's avatar
Yaowu Xu committed
145 146 147
decode_with_drops.SRCS          += aom_ports/mem_ops.h
decode_with_drops.SRCS          += aom_ports/mem_ops_aligned.h
decode_with_drops.SRCS          += aom_ports/msvc.h
John Koleszar's avatar
John Koleszar committed
148 149
decode_with_drops.GUID           = CE5C53C4-8DDA-438A-86ED-0DDD3CDB8D26
decode_with_drops.DESCRIPTION    = Drops frames while decoding
150 151 152 153 154
EXAMPLES-$(CONFIG_ENCODERS)        += set_maps.c
set_maps.SRCS                      += ivfenc.h ivfenc.c
set_maps.SRCS                      += tools_common.h tools_common.c
set_maps.SRCS                      += video_common.h
set_maps.SRCS                      += video_writer.h video_writer.c
Yaowu Xu's avatar
Yaowu Xu committed
155
set_maps.SRCS                      += aom_ports/msvc.h
156 157
set_maps.GUID                       = ECB2D24D-98B8-4015-A465-A4AF3DCC145F
set_maps.DESCRIPTION                = Set active and ROI maps
158 159 160 161 162 163 164 165 166
ifeq ($(CONFIG_ENCODERS),yes)
ifeq ($(CONFIG_DECODERS),yes)
EXAMPLES-$(CONFIG_ENCODERS)        += aom_cx_set_ref.c
aom_cx_set_ref.SRCS                += ivfenc.h ivfenc.c
aom_cx_set_ref.SRCS                += tools_common.h tools_common.c
aom_cx_set_ref.SRCS                += video_common.h
aom_cx_set_ref.SRCS                += video_writer.h video_writer.c
aom_cx_set_ref.SRCS                += aom_ports/msvc.h
aom_cx_set_ref.GUID                 = C5E31F7F-96F6-48BD-BD3E-10EBF6E8057A
167
aom_cx_set_ref.DESCRIPTION          = AV1 set encoder reference frame
168 169
endif
endif
John Koleszar's avatar
John Koleszar committed
170 171 172

# Handle extra library flags depending on codec configuration

173 174 175
# We should not link to math library (libm) on RVCT
# when building for bare-metal targets
ifeq ($(CONFIG_OS_SUPPORT), yes)
176
CODEC_EXTRA_LIBS-$(CONFIG_AV1)            += m
177 178
else
    ifeq ($(CONFIG_GCC), yes)
179
    CODEC_EXTRA_LIBS-$(CONFIG_AV1)        += m
180 181
    endif
endif
John Koleszar's avatar
John Koleszar committed
182 183 184 185 186 187 188 189 190 191
#
# 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)
James Zern's avatar
James Zern committed
192 193
    LIB_PATH-yes := $(SRC_PATH_BARE)/../lib
    INC_PATH-yes := $(SRC_PATH_BARE)/../include
John Koleszar's avatar
John Koleszar committed
194 195
else
    LIB_PATH-yes                     += $(if $(BUILD_PFX),$(BUILD_PFX),.)
196 197
    INC_PATH-$(CONFIG_AV1_DECODER)   += $(SRC_PATH_BARE)/av1
    INC_PATH-$(CONFIG_AV1_ENCODER)   += $(SRC_PATH_BARE)/av1
John Koleszar's avatar
John Koleszar committed
198
endif
James Zern's avatar
James Zern committed
199 200 201
INC_PATH-$(CONFIG_LIBYUV) += $(SRC_PATH_BARE)/third_party/libyuv/include
LIB_PATH := $(call enabled,LIB_PATH)
INC_PATH := $(call enabled,INC_PATH)
202 203
INTERNAL_CFLAGS = $(addprefix -I,$(INC_PATH))
INTERNAL_LDFLAGS += $(addprefix -L,$(LIB_PATH))
John Koleszar's avatar
John Koleszar committed
204 205 206 207


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


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


# 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
224 225
DIST-BINS-$(NOT_MSVS)      += $(addprefix bin/,$(ALL_EXAMPLES:.c=$(EXE_SFX)))
INSTALL-BINS-$(NOT_MSVS)   += $(addprefix bin/,$(UTILS:.c=$(EXE_SFX)))
226 227
DIST-SRCS-yes              += $(ALL_SRCS)
INSTALL-SRCS-yes           += $(UTIL_SRCS)
228
OBJS-$(NOT_MSVS)           += $(call objs,$(ALL_SRCS))
KO Myung-Hun's avatar
KO Myung-Hun committed
229
BINS-$(NOT_MSVS)           += $(addprefix $(BUILD_PFX),$(ALL_EXAMPLES:.c=$(EXE_SFX)))
John Koleszar's avatar
John Koleszar committed
230 231 232


# Instantiate linker template for all examples.
Yaowu Xu's avatar
Yaowu Xu committed
233
CODEC_LIB=$(if $(CONFIG_DEBUG_LIBS),aom_g,aom)
234 235 236 237 238 239 240 241 242
ifneq ($(filter darwin%,$(TGT_OS)),)
SHARED_LIB_SUF=.dylib
else
ifneq ($(filter os2%,$(TGT_OS)),)
SHARED_LIB_SUF=_dll.a
else
SHARED_LIB_SUF=.so
endif
endif
jimbankoski's avatar
jimbankoski committed
243
CODEC_LIB_SUF=$(if $(CONFIG_SHARED),$(SHARED_LIB_SUF),.a)
John Koleszar's avatar
John Koleszar committed
244
$(foreach bin,$(BINS-yes),\
245 246
    $(eval $(bin):$(LIB_PATH)/lib$(CODEC_LIB)$(CODEC_LIB_SUF))\
    $(eval $(call linker_template,$(bin),\
KO Myung-Hun's avatar
KO Myung-Hun committed
247
        $(call objs,$($(notdir $(bin:$(EXE_SFX)=)).SRCS)) \
John Koleszar's avatar
John Koleszar committed
248
        -l$(CODEC_LIB) $(addprefix -l,$(CODEC_EXTRA_LIBS))\
249
        )))
John Koleszar's avatar
John Koleszar committed
250 251 252 253 254 255 256 257 258 259 260

# 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)
Yaowu Xu's avatar
Yaowu Xu committed
261
CODEC_LIB=$(if $(CONFIG_SHARED),aom,$(if $(CONFIG_STATIC_MSVCRT),aommt,aommd))
John Koleszar's avatar
John Koleszar committed
262 263 264 265 266 267 268 269 270 271 272 273 274 275
# 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
Adrian Grange's avatar
Adrian Grange committed
276
$(1): $($(1:.$(VCPROJ_SFX)=).SRCS) aom.$(VCPROJ_SFX)
277 278
	$(if $(quiet),@echo "    [vcproj] $$@")
	$(qexec)$$(GEN_VCPROJ)\
John Koleszar's avatar
John Koleszar committed
279 280
            --exe\
            --target=$$(TOOLCHAIN)\
281
            --name=$$(@:.$(VCPROJ_SFX)=)\
John Koleszar's avatar
John Koleszar committed
282
            --ver=$$(CONFIG_VS_VERSION)\
283
            --proj-guid=$$($$(@:.$(VCPROJ_SFX)=).GUID)\
284
            --src-path-bare="$(SRC_PATH_BARE)" \
John Koleszar's avatar
John Koleszar committed
285
            $$(if $$(CONFIG_STATIC_MSVCRT),--static-crt) \
286
            --out=$$@ $$(INTERNAL_CFLAGS) $$(CFLAGS) \
Martin Storsjo's avatar
Martin Storsjo committed
287
            $$(INTERNAL_LDFLAGS) $$(LDFLAGS) -l$$(CODEC_LIB) $$^
John Koleszar's avatar
John Koleszar committed
288
endef
289 290
ALL_EXAMPLES_BASENAME := $(notdir $(ALL_EXAMPLES))
PROJECTS-$(CONFIG_MSVS) += $(ALL_EXAMPLES_BASENAME:.c=.$(VCPROJ_SFX))
John Koleszar's avatar
John Koleszar committed
291
INSTALL-BINS-$(CONFIG_MSVS) += $(foreach p,$(VS_PLATFORMS),\
292
                               $(addprefix bin/$(p)/,$(ALL_EXAMPLES_BASENAME:.c=.exe)))
John Koleszar's avatar
John Koleszar committed
293 294
$(foreach proj,$(call enabled,PROJECTS),\
    $(eval $(call vcproj_template,$(proj))))
295 296 297 298 299 300

#
# Documentation Rules
#
%.dox: %.c
	@echo "    [DOXY] $@"
301
	@mkdir -p $(dir $@)
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
	@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 += $^" > $@