Commit 2dd668a7 authored by Tim-Philipp Müller's avatar Tim-Philipp Müller 🐠

docs: move GstPhotography interface docs into the library docs

Now that we have docs for the libs.
parent 8a7079dd
......@@ -97,6 +97,11 @@
<xi:include href="xml/gstglwindowwin32.xml"/>
<xi:include href="xml/gstglwindowx11.xml"/>
</chapter>
<chapter>
<title>Interfaces</title>
<xi:include href="xml/gstphotography.xml" />
</chapter>
</part>
<part id="gstreamer-libs-hierarchy">
......
......@@ -529,6 +529,20 @@ gst_mpegts_tot_get_type
<SECTION>
<FILE>gstphotography</FILE>
<TITLE>GstPhotography</TITLE>
GstPhotography
GstPhotographyNoiseReduction
GstPhotographyWhiteBalanceMode
GstPhotographyColorToneMode
GstPhotographySceneMode
GstPhotographyFlashMode
GstPhotographyFlickerReductionMode
GstPhotographyFocusMode
GstPhotographyFocusStatus
GstPhotographyCaps
GstPhotographyShakeRisk
GstPhotographySettings
GstPhotographyCapturePrepared
GST_PHOTOGRAPHY_AUTOFOCUS_DONE
GST_PHOTOGRAPHY_SHAKE_RISK
GST_PHOTOGRAPHY_PROP_WB_MODE
......@@ -548,76 +562,35 @@ GST_PHOTOGRAPHY_PROP_IMAGE_PREVIEW_SUPPORTED_CAPS
GST_PHOTOGRAPHY_PROP_FLICKER_MODE
GST_PHOTOGRAPHY_PROP_FOCUS_MODE
GST_PHOTOGRAPHY_PROP_ZOOM
GstPhotographyNoiseReduction
GstWhiteBalanceMode
GstColourToneMode
GstSceneMode
GstFlashMode
GstFocusStatus
GstPhotoCaps
GstPhotoShakeRisk
GstFlickerReductionMode
GstFocusMode
GstPhotoCapturePrepared
get_ev_compensation
get_iso_speed
get_aperture
get_exposure
get_white_balance_mode
get_colour_tone_mode
get_scene_mode
get_flash_mode
get_zoom
get_flicker_mode
get_focus_mode
set_ev_compensation
set_iso_speed
set_aperture
set_exposure
set_white_balance_mode
set_colour_tone_mode
set_scene_mode
set_flash_mode
set_zoom
set_flicker_mode
set_focus_mode
get_capabilities
prepare_for_capture
set_autofocus
set_config
get_config
get_noise_reduction
set_noise_reduction
gst_photography_get_ev_compensation
gst_photography_get_iso_speed
gst_photography_get_aperture
gst_photography_get_exposure
gst_photography_get_white_balance_mode
gst_photography_get_colour_tone_mode
gst_photography_get_color_tone_mode
gst_photography_get_scene_mode
gst_photography_get_flash_mode
gst_photography_get_noise_reduction
gst_photography_get_zoom
gst_photography_get_flicker_mode
gst_photography_get_focus_mode
gst_photography_get_noise_reduction
gst_photography_get_zoom
gst_photography_set_ev_compensation
gst_photography_set_iso_speed
gst_photography_set_aperture
gst_photography_set_exposure
gst_photography_set_white_balance_mode
gst_photography_set_colour_tone_mode
gst_photography_set_color_tone_mode
gst_photography_set_scene_mode
gst_photography_set_flash_mode
gst_photography_set_noise_reduction
gst_photography_set_zoom
gst_photography_set_flicker_mode
gst_photography_set_focus_mode
gst_photography_set_noise_reduction
gst_photography_set_zoom
gst_photography_get_capabilities
gst_photography_prepare_for_capture
gst_photography_set_autofocus
gst_photography_set_config
gst_photography_get_config
GstPhotography
<SUBSECTION Standard>
GST_PHOTOGRAPHY
GST_IS_PHOTOGRAPHY
......
......@@ -166,8 +166,7 @@ EXTRA_HFILES = \
$(top_srcdir)/sys/directdraw/gstdirectdrawsink.h \
$(top_srcdir)/sys/dvb/gstdvbsrc.h \
$(top_srcdir)/sys/shm/gstshmsink.h \
$(top_srcdir)/sys/shm/gstshmsrc.h \
$(top_srcdir)/gst-libs/gst/interfaces/photography.h
$(top_srcdir)/sys/shm/gstshmsrc.h
# Images to copy into HTML directory.
HTML_IMAGES = camerabin.png
......@@ -182,7 +181,6 @@ extra_files =
# contains GtkObjects/GObjects and you want to document signals and properties.
GTKDOC_CFLAGS = -DGST_USE_UNSTABLE_API $(GST_PLUGINS_BAD_CFLAGS) $(GST_BASE_CFLAGS) -I$(top_builddir)
GTKDOC_LIBS = \
$(top_builddir)/gst-libs/gst/interfaces/libgstphotography-@GST_API_VERSION@.la \
$(GST_BASE_LIBS)
GTKDOC_CC=$(LIBTOOL) --tag=CC --mode=compile $(CC)
......
......@@ -141,9 +141,4 @@
<xi:include href="xml/plugin-voamrwbenc.xml" />
<xi:include href="xml/plugin-zbar.xml" />
</chapter>
<chapter>
<title>gst-plugins-bad Interfaces</title>
<xi:include href="xml/gstphotography.xml" />
</chapter>
</book>
......@@ -1629,56 +1629,3 @@ GST_IS_COMPOSITOR_PAD
GST_IS_COMPOSITOR_PAD_CLASS
GST_TYPE_COMPOSITOR_PAD
</SECTION>
# gst-libs
<SECTION>
<FILE>gstphotography</FILE>
<TITLE>GstPhotography</TITLE>
GstPhotography
GST_PHOTOGRAPHY_AUTOFOCUS_DONE
GST_PHOTOGRAPHY_SHAKE_RISK
GstPhotographyNoiseReduction
GstPhotographyWhiteBalanceMode
GstPhotographyColorToneMode
GstPhotographySceneMode
GstPhotographyFlashMode
GstPhotographyFlickerReductionMode
GstPhotographyFocusMode
GstPhotographyFocusStatus
GstPhotographyCaps
GstPhotographyShakeRisk
GstPhotographySettings
GstPhotographyCapturePrepared
gst_photography_get_ev_compensation
gst_photography_get_iso_speed
gst_photography_get_aperture
gst_photography_get_exposure
gst_photography_get_white_balance_mode
gst_photography_get_color_tone_mode
gst_photography_get_scene_mode
gst_photography_get_flash_mode
gst_photography_get_noise_reduction
gst_photography_get_zoom
gst_photography_set_ev_compensation
gst_photography_set_iso_speed
gst_photography_set_aperture
gst_photography_set_exposure
gst_photography_set_white_balance_mode
gst_photography_set_color_tone_mode
gst_photography_set_scene_mode
gst_photography_set_flash_mode
gst_photography_set_noise_reduction
gst_photography_set_zoom
gst_photography_get_capabilities
gst_photography_prepare_for_capture
gst_photography_set_autofocus
gst_photography_set_config
gst_photography_get_config
<SUBSECTION Standard>
GST_PHOTOGRAPHY
GST_IS_PHOTOGRAPHY
GST_PHOTOGRAPHY_GET_INTERFACE
gst_photography_get_type
</SECTION>
......@@ -46273,846 +46273,6 @@
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstFlacParse::check-frame-checksums</NAME>
<TYPE>gboolean</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Check Frame Checksums</NICK>
<BLURB>Check the overall checksums of every frame.</BLURB>
<DEFAULT>FALSE</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Dec::deblocking-level</NAME>
<TYPE>guint</TYPE>
<RANGE><= 16</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Deblocking Level</NICK>
<BLURB>Deblocking level.</BLURB>
<DEFAULT>4</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Dec::noise-level</NAME>
<TYPE>guint</TYPE>
<RANGE><= 16</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Noise Level</NICK>
<BLURB>Noise level.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Dec::post-processing</NAME>
<TYPE>gboolean</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Post Processing</NICK>
<BLURB>Enable post processing.</BLURB>
<DEFAULT>FALSE</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Dec::post-processing-flags</NAME>
<TYPE>GstVP8DecPostProcessingFlags</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Post Processing Flags</NICK>
<BLURB>Flags to control post processing.</BLURB>
<DEFAULT>Deblock|Demacroblock|Multi-frame quality enhancement</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Dec::threads</NAME>
<TYPE>guint</TYPE>
<RANGE>[1,16]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Max Threads</NICK>
<BLURB>Maximum number of decoding threads.</BLURB>
<DEFAULT>1</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::bitrate</NAME>
<TYPE>gint</TYPE>
<RANGE>[0,1000000000]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Bit rate</NICK>
<BLURB>Bit rate (in bits/sec).</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::error-resilient</NAME>
<TYPE>GstVP8EncErFlags</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Error resilient</NICK>
<BLURB>Error resilience flags.</BLURB>
<DEFAULT></DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::max-keyframe-distance</NAME>
<TYPE>gint</TYPE>
<RANGE>[0,9999]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Maximum Key frame distance</NICK>
<BLURB>Maximum distance between key frames.</BLURB>
<DEFAULT>60</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::max-latency</NAME>
<TYPE>gint</TYPE>
<RANGE>[0,25]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Max latency</NICK>
<BLURB>Number of frames in encoder queue.</BLURB>
<DEFAULT>10</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::mode</NAME>
<TYPE>GstVP8EncMode</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Mode</NICK>
<BLURB>Mode.</BLURB>
<DEFAULT>Variable Bit Rate (VBR) mode</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::quality</NAME>
<TYPE>gdouble</TYPE>
<RANGE>[0,10]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Quality</NICK>
<BLURB>Quality. This parameter sets a constant quantizer.</BLURB>
<DEFAULT>5</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::speed</NAME>
<TYPE>gint</TYPE>
<RANGE>[0,7]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Speed</NICK>
<BLURB>Speed.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::threads</NAME>
<TYPE>gint</TYPE>
<RANGE>[0,64]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Threads</NICK>
<BLURB>Number of threads to use.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::multipass-cache-file</NAME>
<TYPE>gchar*</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Multipass Cache File</NICK>
<BLURB>Multipass cache file.</BLURB>
<DEFAULT>"multipass.cache"</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::multipass-mode</NAME>
<TYPE>GstVP8EncMultipassMode</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Multipass Mode</NICK>
<BLURB>Multipass encode mode.</BLURB>
<DEFAULT>One pass encoding (default)</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::auto-alt-ref-frames</NAME>
<TYPE>gboolean</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Auto Alt Ref Frames</NICK>
<BLURB>Automatically create alternative reference frames.</BLURB>
<DEFAULT>FALSE</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::max-quantizer</NAME>
<TYPE>gint</TYPE>
<RANGE>[0,63]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Maximum Quantizer</NICK>
<BLURB>Maximum Quantizer (worst).</BLURB>
<DEFAULT>63</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::min-quantizer</NAME>
<TYPE>gint</TYPE>
<RANGE>[0,63]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Minimum Quantizer</NICK>
<BLURB>Minimum Quantizer (best).</BLURB>
<DEFAULT>4</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::drop-frame</NAME>
<TYPE>gint</TYPE>
<RANGE>[0,100]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Drop Frame</NICK>
<BLURB>Drop Frame.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::lag-in-frames</NAME>
<TYPE>gint</TYPE>
<RANGE>[0,25]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Lag in frames</NICK>
<BLURB>Maximum number of frames to lag.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::maxsection-pct</NAME>
<TYPE>guint</TYPE>
<RANGE>[200,800]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>maximum percentage allocation per section</NICK>
<BLURB>The numbers represent a percentage of the average allocation per section (frame).</BLURB>
<DEFAULT>800</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::minsection-pct</NAME>
<TYPE>guint</TYPE>
<RANGE><= 20</RANGE>
<FLAGS>rw</FLAGS>
<NICK>minimum percentage allocation per section</NICK>
<BLURB>The numbers represent a percentage of the average allocation per section (frame).</BLURB>
<DEFAULT>5</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::noise-sensitivity</NAME>
<TYPE>gint</TYPE>
<RANGE>[0,6]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Noise sensitivity</NICK>
<BLURB>Noise sensisivity (frames to blur).</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::resize-allowed</NAME>
<TYPE>gboolean</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Resize Allowed</NICK>
<BLURB>Allow spatial resampling.</BLURB>
<DEFAULT>FALSE</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::sharpness</NAME>
<TYPE>gint</TYPE>
<RANGE>[0,7]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Sharpness</NICK>
<BLURB>Filter sharpness.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::static-threshold</NAME>
<TYPE>gint</TYPE>
<RANGE>>= 0</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Static Threshold</NICK>
<BLURB>Motion detection threshold.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::token-parts</NAME>
<TYPE>gint</TYPE>
<RANGE>[0,3]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Token Parts</NICK>
<BLURB>Token Parts.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::tune</NAME>
<TYPE>GstVP8EncTune</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Tune</NICK>
<BLURB>Tune.</BLURB>
<DEFAULT>Tune for PSNR</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::arnr-maxframes</NAME>
<TYPE>gint</TYPE>
<RANGE>[0,15]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>AltRef max frames</NICK>
<BLURB>AltRef maximum number of frames.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::arnr-strength</NAME>
<TYPE>gint</TYPE>
<RANGE>[0,6]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>AltRef strength</NICK>
<BLURB>AltRef strength.</BLURB>
<DEFAULT>3</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::arnr-type</NAME>
<TYPE>gint</TYPE>
<RANGE>[1,3]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>AltRef type</NICK>
<BLURB>AltRef type.</BLURB>
<DEFAULT>3</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::auto-alt-ref</NAME>
<TYPE>gboolean</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Auto alt reference frames</NICK>
<BLURB>Automatically generate alt reference frames.</BLURB>
<DEFAULT>FALSE</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::buffer-initial-size</NAME>
<TYPE>gint</TYPE>
<RANGE>>= 0</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Buffer initial size</NICK>
<BLURB>Initial client buffer size (ms).</BLURB>
<DEFAULT>4000</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::buffer-optimal-size</NAME>
<TYPE>gint</TYPE>
<RANGE>>= 0</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Buffer optimal size</NICK>
<BLURB>Optimal client buffer size (ms).</BLURB>
<DEFAULT>5000</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::buffer-size</NAME>
<TYPE>gint</TYPE>
<RANGE>>= 0</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Buffer size</NICK>
<BLURB>Client buffer size (ms).</BLURB>
<DEFAULT>6000</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::cpu-used</NAME>
<TYPE>gint</TYPE>
<RANGE>[-16,16]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>CPU used</NICK>
<BLURB>CPU used.</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::cq-level</NAME>
<TYPE>gint</TYPE>
<RANGE>[0,63]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Constrained quality level</NICK>
<BLURB>Constrained quality level.</BLURB>
<DEFAULT>10</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::deadline</NAME>
<TYPE>gint64</TYPE>
<RANGE>>= 0</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Deadline</NICK>
<BLURB>Deadline per frame (usec, 0=disabled).</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::dropframe-threshold</NAME>
<TYPE>gint</TYPE>
<RANGE>[0,100]</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Drop Frame Threshold</NICK>
<BLURB>Temporal resampling threshold (buf %).</BLURB>
<DEFAULT>0</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::end-usage</NAME>
<TYPE>GstVP8EncEndUsage</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Rate control mode</NICK>
<BLURB>Rate control mode.</BLURB>
<DEFAULT>Variable Bit Rate (VBR) mode</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::h-scaling-mode</NAME>
<TYPE>GstVP8EncScalingMode</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Horizontal scaling mode</NICK>
<BLURB>Horizontal scaling mode.</BLURB>
<DEFAULT>Normal</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::kf-max-dist</NAME>
<TYPE>gint</TYPE>
<RANGE>>= 0</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Keyframe max distance</NICK>
<BLURB>Maximum distance between keyframes (number of frames).</BLURB>
<DEFAULT>128</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::kf-mode</NAME>
<TYPE>GstVP8EncKfMode</TYPE>
<RANGE></RANGE>
<FLAGS>rw</FLAGS>
<NICK>Keyframe Mode</NICK>
<BLURB>Keyframe placement.</BLURB>
<DEFAULT>Determine optimal placement automatically</DEFAULT>
</ARG>
<ARG>
<NAME>GstVP8Enc::max-intra-bitrate-pct</NAME>
<TYPE>gint</TYPE>
<RANGE>>= 0</RANGE>
<FLAGS>rw</FLAGS>
<NICK>Max Intra bitrate</NICK>
<BLURB>Maximum Intra frame bitrate.</BLURB>