examples.mk 15.5 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 43
LIBWEBM_COMMON_SRCS += third_party/libwebm/common/hdr_util.cc \
                       third_party/libwebm/common/hdr_util.h \
                       third_party/libwebm/common/webmids.h
44

45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
LIBWEBM_MUXER_SRCS += third_party/libwebm/mkvmuxer/mkvmuxer.cc \
                      third_party/libwebm/mkvmuxer/mkvmuxerutil.cc \
                      third_party/libwebm/mkvmuxer/mkvwriter.cc \
                      third_party/libwebm/mkvmuxer/mkvmuxer.h \
                      third_party/libwebm/mkvmuxer/mkvmuxertypes.h \
                      third_party/libwebm/mkvmuxer/mkvmuxerutil.h \
                      third_party/libwebm/mkvparser/mkvparser.h \
                      third_party/libwebm/mkvmuxer/mkvwriter.h

LIBWEBM_PARSER_SRCS = third_party/libwebm/mkvparser/mkvparser.cc \
                      third_party/libwebm/mkvparser/mkvreader.cc \
                      third_party/libwebm/mkvparser/mkvparser.h \
                      third_party/libwebm/mkvparser/mkvreader.h

# Add compile flags and include path for libwebm sources.
ifeq ($(CONFIG_WEBM_IO),yes)
  CXXFLAGS     += -D__STDC_CONSTANT_MACROS -D__STDC_LIMIT_MACROS
  INC_PATH-yes += $(SRC_PATH_BARE)/third_party/libwebm
endif
64

65

66 67
# 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
68 69 70 71 72 73 74 75 76 77 78
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
79
ifeq ($(CONFIG_LIBYUV),yes)
Adrian Grange's avatar
Adrian Grange committed
80
  aomdec.SRCS                 += $(LIBYUV_SRCS)
Deb Mukherjee's avatar
Deb Mukherjee committed
81
endif
82
ifeq ($(CONFIG_WEBM_IO),yes)
Adrian Grange's avatar
Adrian Grange committed
83
  aomdec.SRCS                 += $(LIBWEBM_COMMON_SRCS)
84
  aomdec.SRCS                 += $(LIBWEBM_MUXER_SRCS)
Adrian Grange's avatar
Adrian Grange committed
85 86
  aomdec.SRCS                 += $(LIBWEBM_PARSER_SRCS)
  aomdec.SRCS                 += webmdec.cc webmdec.h
87
endif
Adrian Grange's avatar
Adrian Grange committed
88 89 90 91 92 93 94 95 96 97 98 99 100 101
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
102
ifeq ($(CONFIG_LIBYUV),yes)
Adrian Grange's avatar
Adrian Grange committed
103
  aomenc.SRCS                 += $(LIBYUV_SRCS)
Deb Mukherjee's avatar
Deb Mukherjee committed
104
endif
105
ifeq ($(CONFIG_WEBM_IO),yes)
Adrian Grange's avatar
Adrian Grange committed
106 107
  aomenc.SRCS                 += $(LIBWEBM_COMMON_SRCS)
  aomenc.SRCS                 += $(LIBWEBM_MUXER_SRCS)
108
  aomenc.SRCS                 += $(LIBWEBM_PARSER_SRCS)
Adrian Grange's avatar
Adrian Grange committed
109
  aomenc.SRCS                 += webmenc.cc webmenc.h
110
endif
Adrian Grange's avatar
Adrian Grange committed
111 112
aomenc.GUID                  = 548DEC74-7A15-4B2B-AFC3-AA102E7C25C1
aomenc.DESCRIPTION           = Full featured encoder
113

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

# Handle extra library flags depending on codec configuration

184 185 186
# We should not link to math library (libm) on RVCT
# when building for bare-metal targets
ifeq ($(CONFIG_OS_SUPPORT), yes)
187
CODEC_EXTRA_LIBS-$(CONFIG_AV1)            += m
188 189
else
    ifeq ($(CONFIG_GCC), yes)
190
    CODEC_EXTRA_LIBS-$(CONFIG_AV1)        += m
191 192
    endif
endif
John Koleszar's avatar
John Koleszar committed
193 194 195 196 197 198 199 200 201 202
#
# 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
203 204
    LIB_PATH-yes := $(SRC_PATH_BARE)/../lib
    INC_PATH-yes := $(SRC_PATH_BARE)/../include
John Koleszar's avatar
John Koleszar committed
205 206
else
    LIB_PATH-yes                     += $(if $(BUILD_PFX),$(BUILD_PFX),.)
207 208
    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
209
endif
James Zern's avatar
James Zern committed
210 211 212
INC_PATH-$(CONFIG_LIBYUV) += $(SRC_PATH_BARE)/third_party/libyuv/include
LIB_PATH := $(call enabled,LIB_PATH)
INC_PATH := $(call enabled,INC_PATH)
213 214
INTERNAL_CFLAGS = $(addprefix -I,$(INC_PATH))
INTERNAL_LDFLAGS += $(addprefix -L,$(LIB_PATH))
John Koleszar's avatar
John Koleszar committed
215 216 217 218


# Expand list of selected examples to build (as specified above)
UTILS           = $(call enabled,UTILS)
219 220
EXAMPLES        = $(addprefix examples/,$(call enabled,EXAMPLES))
ALL_EXAMPLES    = $(UTILS) $(EXAMPLES)
221
UTIL_SRCS       = $(foreach ex,$(UTILS),$($(ex:.c=).SRCS))
222
ALL_SRCS        = $(foreach ex,$(ALL_EXAMPLES),$($(notdir $(ex:.c=)).SRCS))
John Koleszar's avatar
John Koleszar committed
223 224 225 226
CODEC_EXTRA_LIBS=$(sort $(call enabled,CODEC_EXTRA_LIBS))


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


# 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
235 236
DIST-BINS-$(NOT_MSVS)      += $(addprefix bin/,$(ALL_EXAMPLES:.c=$(EXE_SFX)))
INSTALL-BINS-$(NOT_MSVS)   += $(addprefix bin/,$(UTILS:.c=$(EXE_SFX)))
237 238
DIST-SRCS-yes              += $(ALL_SRCS)
INSTALL-SRCS-yes           += $(UTIL_SRCS)
239
OBJS-$(NOT_MSVS)           += $(call objs,$(ALL_SRCS))
KO Myung-Hun's avatar
KO Myung-Hun committed
240
BINS-$(NOT_MSVS)           += $(addprefix $(BUILD_PFX),$(ALL_EXAMPLES:.c=$(EXE_SFX)))
John Koleszar's avatar
John Koleszar committed
241 242 243


# Instantiate linker template for all examples.
Yaowu Xu's avatar
Yaowu Xu committed
244
CODEC_LIB=$(if $(CONFIG_DEBUG_LIBS),aom_g,aom)
245 246 247 248 249 250 251 252 253
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
254
CODEC_LIB_SUF=$(if $(CONFIG_SHARED),$(SHARED_LIB_SUF),.a)
John Koleszar's avatar
John Koleszar committed
255
$(foreach bin,$(BINS-yes),\
256 257
    $(eval $(bin):$(LIB_PATH)/lib$(CODEC_LIB)$(CODEC_LIB_SUF))\
    $(eval $(call linker_template,$(bin),\
KO Myung-Hun's avatar
KO Myung-Hun committed
258
        $(call objs,$($(notdir $(bin:$(EXE_SFX)=)).SRCS)) \
John Koleszar's avatar
John Koleszar committed
259
        -l$(CODEC_LIB) $(addprefix -l,$(CODEC_EXTRA_LIBS))\
260
        )))
John Koleszar's avatar
John Koleszar committed
261 262 263 264 265 266 267 268 269 270 271

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

#
# Documentation Rules
#
%.dox: %.c
	@echo "    [DOXY] $@"
312
	@mkdir -p $(dir $@)
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339
	@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 += $^" > $@