lavfi/overlay: add yuv422 format mode
[ffmpeg.git] / doc / Makefile
1 LIBRARIES-$(CONFIG_AVUTIL)     += libavutil
2 LIBRARIES-$(CONFIG_SWSCALE)    += libswscale
3 LIBRARIES-$(CONFIG_SWRESAMPLE) += libswresample
4 LIBRARIES-$(CONFIG_AVCODEC)    += libavcodec
5 LIBRARIES-$(CONFIG_AVFORMAT)   += libavformat
6 LIBRARIES-$(CONFIG_AVDEVICE)   += libavdevice
7 LIBRARIES-$(CONFIG_AVFILTER)   += libavfilter
8
9 COMPONENTS-$(CONFIG_AVUTIL)     += ffmpeg-utils
10 COMPONENTS-$(CONFIG_SWSCALE)    += ffmpeg-scaler
11 COMPONENTS-$(CONFIG_SWRESAMPLE) += ffmpeg-resampler
12 COMPONENTS-$(CONFIG_AVCODEC)    += ffmpeg-codecs ffmpeg-bitstream-filters
13 COMPONENTS-$(CONFIG_AVFORMAT)   += ffmpeg-formats ffmpeg-protocols
14 COMPONENTS-$(CONFIG_AVDEVICE)   += ffmpeg-devices
15 COMPONENTS-$(CONFIG_AVFILTER)   += ffmpeg-filters
16
17 MANPAGES1   = $(AVPROGS-yes:%=doc/%.1)    $(AVPROGS-yes:%=doc/%-all.1)    $(COMPONENTS-yes:%=doc/%.1)
18 MANPAGES3   = $(LIBRARIES-yes:%=doc/%.3)
19 MANPAGES    = $(MANPAGES1) $(MANPAGES3)
20 PODPAGES    = $(AVPROGS-yes:%=doc/%.pod)  $(AVPROGS-yes:%=doc/%-all.pod)  $(COMPONENTS-yes:%=doc/%.pod)  $(LIBRARIES-yes:%=doc/%.pod)
21 HTMLPAGES   = $(AVPROGS-yes:%=doc/%.html) $(AVPROGS-yes:%=doc/%-all.html) $(COMPONENTS-yes:%=doc/%.html) $(LIBRARIES-yes:%=doc/%.html) \
22               doc/developer.html                                        \
23               doc/faq.html                                              \
24               doc/fate.html                                             \
25               doc/general.html                                          \
26               doc/git-howto.html                                        \
27               doc/nut.html                                              \
28               doc/platform.html                                         \
29
30 TXTPAGES    = doc/fate.txt                                              \
31
32
33 DOCS-$(CONFIG_HTMLPAGES) += $(HTMLPAGES)
34 DOCS-$(CONFIG_PODPAGES)  += $(PODPAGES)
35 DOCS-$(CONFIG_MANPAGES)  += $(MANPAGES)
36 DOCS-$(CONFIG_TXTPAGES)  += $(TXTPAGES)
37 DOCS = $(DOCS-yes)
38
39 DOC_EXAMPLES-$(CONFIG_DECODING_ENCODING_EXAMPLE) += decoding_encoding
40 DOC_EXAMPLES-$(CONFIG_DEMUXING_DECODING_EXAMPLE) += demuxing_decoding
41 DOC_EXAMPLES-$(CONFIG_FILTERING_AUDIO_EXAMPLE)   += filtering_audio
42 DOC_EXAMPLES-$(CONFIG_FILTERING_VIDEO_EXAMPLE)   += filtering_video
43 DOC_EXAMPLES-$(CONFIG_METADATA_EXAMPLE)          += metadata
44 DOC_EXAMPLES-$(CONFIG_MUXING_EXAMPLE)            += muxing
45 DOC_EXAMPLES-$(CONFIG_REMUXING_EXAMPLE)          += remuxing
46 DOC_EXAMPLES-$(CONFIG_RESAMPLING_AUDIO_EXAMPLE)  += resampling_audio
47 DOC_EXAMPLES-$(CONFIG_SCALING_VIDEO_EXAMPLE)     += scaling_video
48 DOC_EXAMPLES-$(CONFIG_TRANSCODE_AAC_EXAMPLE)     += transcode_aac
49 ALL_DOC_EXAMPLES_LIST = $(DOC_EXAMPLES-) $(DOC_EXAMPLES-yes)
50
51 DOC_EXAMPLES       := $(DOC_EXAMPLES-yes:%=doc/examples/%$(PROGSSUF)$(EXESUF))
52 ALL_DOC_EXAMPLES   := $(ALL_DOC_EXAMPLES_LIST:%=doc/examples/%$(PROGSSUF)$(EXESUF))
53 ALL_DOC_EXAMPLES_G := $(ALL_DOC_EXAMPLES_LIST:%=doc/examples/%$(PROGSSUF)_g$(EXESUF))
54 PROGS              += $(DOC_EXAMPLES)
55
56 all-$(CONFIG_DOC): doc
57
58 doc: documentation
59
60 apidoc: doc/doxy/html
61 documentation: $(DOCS)
62
63 examples: $(DOC_EXAMPLES)
64
65 TEXIDEP = perl $(SRC_PATH)/doc/texidep.pl $(SRC_PATH) $< $@ >$(@:%=%.d)
66
67 doc/%.txt: TAG = TXT
68 doc/%.txt: doc/%.texi
69         $(Q)$(TEXIDEP)
70         $(M)makeinfo --force --no-headers -o $@ $< 2>/dev/null
71
72 GENTEXI  = format codec
73 GENTEXI := $(GENTEXI:%=doc/avoptions_%.texi)
74
75 $(GENTEXI): TAG = GENTEXI
76 $(GENTEXI): doc/avoptions_%.texi: doc/print_options$(HOSTEXESUF)
77         $(M)doc/print_options $* > $@
78
79 doc/%.html: TAG = HTML
80 doc/%.html: doc/%.texi $(SRC_PATH)/doc/t2h.init $(GENTEXI)
81         $(Q)$(TEXIDEP)
82         $(M)texi2html -I doc -monolithic --D=config-not-all --init-file $(SRC_PATH)/doc/t2h.init --output $@ $<
83
84 doc/%-all.html: TAG = HTML
85 doc/%-all.html: doc/%.texi $(SRC_PATH)/doc/t2h.init $(GENTEXI)
86         $(Q)$(TEXIDEP)
87         $(M)texi2html -I doc -monolithic --D=config-all --init-file $(SRC_PATH)/doc/t2h.init --output $@ $<
88
89 doc/%.pod: TAG = POD
90 doc/%.pod: doc/%.texi $(SRC_PATH)/doc/texi2pod.pl $(GENTEXI)
91         $(Q)$(TEXIDEP)
92         $(M)perl $(SRC_PATH)/doc/texi2pod.pl -Dconfig-not-all=yes -Idoc $< $@
93
94 doc/%-all.pod: TAG = POD
95 doc/%-all.pod: doc/%.texi $(SRC_PATH)/doc/texi2pod.pl $(GENTEXI)
96         $(Q)$(TEXIDEP)
97         $(M)perl $(SRC_PATH)/doc/texi2pod.pl -Dconfig-all=yes -Idoc $< $@
98
99 doc/%.1 doc/%.3: TAG = MAN
100 doc/%.1: doc/%.pod $(GENTEXI)
101         $(M)pod2man --section=1 --center=" " --release=" " $< > $@
102 doc/%.3: doc/%.pod $(GENTEXI)
103         $(M)pod2man --section=3 --center=" " --release=" " $< > $@
104
105 $(DOCS) doc/doxy/html: | doc/
106 $(DOC_EXAMPLES:%=%.o): | doc/examples
107 OBJDIRS += doc/examples
108
109 doc/doxy/html: $(SRC_PATH)/doc/Doxyfile $(INSTHEADERS)
110         $(M)$(SRC_PATH)/doc/doxy-wrapper.sh $(SRC_PATH) $^
111
112 install-doc: install-html install-man
113
114 install-html:
115
116 install-man:
117
118 ifdef CONFIG_HTMLPAGES
119 install-progs-$(CONFIG_DOC): install-html
120
121 install-html: $(HTMLPAGES)
122         $(Q)mkdir -p "$(DOCDIR)"
123         $(INSTALL) -m 644 $(HTMLPAGES) "$(DOCDIR)"
124 endif
125
126 ifdef CONFIG_MANPAGES
127 install-progs-$(CONFIG_DOC): install-man
128
129 install-man: $(MANPAGES)
130         $(Q)mkdir -p "$(MANDIR)/man1"
131         $(INSTALL) -m 644 $(MANPAGES1) "$(MANDIR)/man1"
132         $(Q)mkdir -p "$(MANDIR)/man3"
133         $(INSTALL) -m 644 $(MANPAGES3) "$(MANDIR)/man3"
134 endif
135
136 uninstall: uninstall-doc
137
138 uninstall-doc: uninstall-html uninstall-man
139
140 uninstall-html:
141         $(RM) -r "$(DOCDIR)"
142
143 uninstall-man:
144         $(RM) $(addprefix "$(MANDIR)/man1/",$(AVPROGS-yes:%=%.1) $(AVPROGS-yes:%=%-all.1) $(COMPONENTS-yes:%=%.1))
145         $(RM) $(addprefix "$(MANDIR)/man3/",$(LIBRARIES-yes:%=%.3))
146
147 clean:: docclean
148
149 distclean:: docclean
150         $(RM) doc/config.texi
151
152 examplesclean:
153         $(RM) $(ALL_DOC_EXAMPLES) $(ALL_DOC_EXAMPLES_G)
154         $(RM) $(CLEANSUFFIXES:%=doc/examples/%)
155
156 docclean: examplesclean
157         $(RM) $(CLEANSUFFIXES:%=doc/%)
158         $(RM) $(TXTPAGES) doc/*.html doc/*.pod doc/*.1 doc/*.3 doc/avoptions_*.texi
159         $(RM) -r doc/doxy/html
160
161 -include $(wildcard $(DOCS:%=%.d))
162
163 .PHONY: apidoc doc documentation