From 2dd668a7176006c7ed1abe508dcbbadca70475b3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim-Philipp=20M=C3=BCller?= Date: Mon, 25 Aug 2014 14:43:49 +0100 Subject: [PATCH] docs: move GstPhotography interface docs into the library docs Now that we have docs for the libs. --- docs/libs/gst-plugins-bad-libs-docs.sgml | 5 + docs/libs/gst-plugins-bad-libs-sections.txt | 67 +- docs/plugins/Makefile.am | 4 +- .../plugins/gst-plugins-bad-plugins-docs.sgml | 5 - .../gst-plugins-bad-plugins-sections.txt | 53 -- docs/plugins/gst-plugins-bad-plugins.args | 840 ------------------ .../plugins/gst-plugins-bad-plugins.hierarchy | 1 - docs/plugins/gst-plugins-bad-plugins.types | 6 - 8 files changed, 26 insertions(+), 955 deletions(-) diff --git a/docs/libs/gst-plugins-bad-libs-docs.sgml b/docs/libs/gst-plugins-bad-libs-docs.sgml index 8c1102635f..461477089c 100644 --- a/docs/libs/gst-plugins-bad-libs-docs.sgml +++ b/docs/libs/gst-plugins-bad-libs-docs.sgml @@ -97,6 +97,11 @@ + + + Interfaces + + diff --git a/docs/libs/gst-plugins-bad-libs-sections.txt b/docs/libs/gst-plugins-bad-libs-sections.txt index d07f6d6d67..55e2a3348a 100644 --- a/docs/libs/gst-plugins-bad-libs-sections.txt +++ b/docs/libs/gst-plugins-bad-libs-sections.txt @@ -529,6 +529,20 @@ gst_mpegts_tot_get_type
gstphotography +GstPhotography +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 GST_PHOTOGRAPHY GST_IS_PHOTOGRAPHY diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am index b093bcfe56..58d1ef76bd 100644 --- a/docs/plugins/Makefile.am +++ b/docs/plugins/Makefile.am @@ -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) diff --git a/docs/plugins/gst-plugins-bad-plugins-docs.sgml b/docs/plugins/gst-plugins-bad-plugins-docs.sgml index cf1a942084..f9c015eb69 100644 --- a/docs/plugins/gst-plugins-bad-plugins-docs.sgml +++ b/docs/plugins/gst-plugins-bad-plugins-docs.sgml @@ -141,9 +141,4 @@ - - - gst-plugins-bad Interfaces - - diff --git a/docs/plugins/gst-plugins-bad-plugins-sections.txt b/docs/plugins/gst-plugins-bad-plugins-sections.txt index 49a85dec7f..78121d824e 100644 --- a/docs/plugins/gst-plugins-bad-plugins-sections.txt +++ b/docs/plugins/gst-plugins-bad-plugins-sections.txt @@ -1629,56 +1629,3 @@ GST_IS_COMPOSITOR_PAD GST_IS_COMPOSITOR_PAD_CLASS GST_TYPE_COMPOSITOR_PAD
- -# gst-libs - -
-gstphotography -GstPhotography -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 - -GST_PHOTOGRAPHY -GST_IS_PHOTOGRAPHY -GST_PHOTOGRAPHY_GET_INTERFACE -gst_photography_get_type -
- diff --git a/docs/plugins/gst-plugins-bad-plugins.args b/docs/plugins/gst-plugins-bad-plugins.args index 22cae74a0d..55fa9d1f1e 100644 --- a/docs/plugins/gst-plugins-bad-plugins.args +++ b/docs/plugins/gst-plugins-bad-plugins.args @@ -46273,846 +46273,6 @@ 0 - -GstFlacParse::check-frame-checksums -gboolean - -rw -Check Frame Checksums -Check the overall checksums of every frame. -FALSE - - - -GstVP8Dec::deblocking-level -guint -<= 16 -rw -Deblocking Level -Deblocking level. -4 - - - -GstVP8Dec::noise-level -guint -<= 16 -rw -Noise Level -Noise level. -0 - - - -GstVP8Dec::post-processing -gboolean - -rw -Post Processing -Enable post processing. -FALSE - - - -GstVP8Dec::post-processing-flags -GstVP8DecPostProcessingFlags - -rw -Post Processing Flags -Flags to control post processing. -Deblock|Demacroblock|Multi-frame quality enhancement - - - -GstVP8Dec::threads -guint -[1,16] -rw -Max Threads -Maximum number of decoding threads. -1 - - - -GstVP8Enc::bitrate -gint -[0,1000000000] -rw -Bit rate -Bit rate (in bits/sec). -0 - - - -GstVP8Enc::error-resilient -GstVP8EncErFlags - -rw -Error resilient -Error resilience flags. - - - - -GstVP8Enc::max-keyframe-distance -gint -[0,9999] -rw -Maximum Key frame distance -Maximum distance between key frames. -60 - - - -GstVP8Enc::max-latency -gint -[0,25] -rw -Max latency -Number of frames in encoder queue. -10 - - - -GstVP8Enc::mode -GstVP8EncMode - -rw -Mode -Mode. -Variable Bit Rate (VBR) mode - - - -GstVP8Enc::quality -gdouble -[0,10] -rw -Quality -Quality. This parameter sets a constant quantizer. -5 - - - -GstVP8Enc::speed -gint -[0,7] -rw -Speed -Speed. -0 - - - -GstVP8Enc::threads -gint -[0,64] -rw -Threads -Number of threads to use. -0 - - - -GstVP8Enc::multipass-cache-file -gchar* - -rw -Multipass Cache File -Multipass cache file. -"multipass.cache" - - - -GstVP8Enc::multipass-mode -GstVP8EncMultipassMode - -rw -Multipass Mode -Multipass encode mode. -One pass encoding (default) - - - -GstVP8Enc::auto-alt-ref-frames -gboolean - -rw -Auto Alt Ref Frames -Automatically create alternative reference frames. -FALSE - - - -GstVP8Enc::max-quantizer -gint -[0,63] -rw -Maximum Quantizer -Maximum Quantizer (worst). -63 - - - -GstVP8Enc::min-quantizer -gint -[0,63] -rw -Minimum Quantizer -Minimum Quantizer (best). -4 - - - -GstVP8Enc::drop-frame -gint -[0,100] -rw -Drop Frame -Drop Frame. -0 - - - -GstVP8Enc::lag-in-frames -gint -[0,25] -rw -Lag in frames -Maximum number of frames to lag. -0 - - - -GstVP8Enc::maxsection-pct -guint -[200,800] -rw -maximum percentage allocation per section -The numbers represent a percentage of the average allocation per section (frame). -800 - - - -GstVP8Enc::minsection-pct -guint -<= 20 -rw -minimum percentage allocation per section -The numbers represent a percentage of the average allocation per section (frame). -5 - - - -GstVP8Enc::noise-sensitivity -gint -[0,6] -rw -Noise sensitivity -Noise sensisivity (frames to blur). -0 - - - -GstVP8Enc::resize-allowed -gboolean - -rw -Resize Allowed -Allow spatial resampling. -FALSE - - - -GstVP8Enc::sharpness -gint -[0,7] -rw -Sharpness -Filter sharpness. -0 - - - -GstVP8Enc::static-threshold -gint ->= 0 -rw -Static Threshold -Motion detection threshold. -0 - - - -GstVP8Enc::token-parts -gint -[0,3] -rw -Token Parts -Token Parts. -0 - - - -GstVP8Enc::tune -GstVP8EncTune - -rw -Tune -Tune. -Tune for PSNR - - - -GstVP8Enc::arnr-maxframes -gint -[0,15] -rw -AltRef max frames -AltRef maximum number of frames. -0 - - - -GstVP8Enc::arnr-strength -gint -[0,6] -rw -AltRef strength -AltRef strength. -3 - - - -GstVP8Enc::arnr-type -gint -[1,3] -rw -AltRef type -AltRef type. -3 - - - -GstVP8Enc::auto-alt-ref -gboolean - -rw -Auto alt reference frames -Automatically generate alt reference frames. -FALSE - - - -GstVP8Enc::buffer-initial-size -gint ->= 0 -rw -Buffer initial size -Initial client buffer size (ms). -4000 - - - -GstVP8Enc::buffer-optimal-size -gint ->= 0 -rw -Buffer optimal size -Optimal client buffer size (ms). -5000 - - - -GstVP8Enc::buffer-size -gint ->= 0 -rw -Buffer size -Client buffer size (ms). -6000 - - - -GstVP8Enc::cpu-used -gint -[-16,16] -rw -CPU used -CPU used. -0 - - - -GstVP8Enc::cq-level -gint -[0,63] -rw -Constrained quality level -Constrained quality level. -10 - - - -GstVP8Enc::deadline -gint64 ->= 0 -rw -Deadline -Deadline per frame (usec, 0=disabled). -0 - - - -GstVP8Enc::dropframe-threshold -gint -[0,100] -rw -Drop Frame Threshold -Temporal resampling threshold (buf %). -0 - - - -GstVP8Enc::end-usage -GstVP8EncEndUsage - -rw -Rate control mode -Rate control mode. -Variable Bit Rate (VBR) mode - - - -GstVP8Enc::h-scaling-mode -GstVP8EncScalingMode - -rw -Horizontal scaling mode -Horizontal scaling mode. -Normal - - - -GstVP8Enc::kf-max-dist -gint ->= 0 -rw -Keyframe max distance -Maximum distance between keyframes (number of frames). -128 - - - -GstVP8Enc::kf-mode -GstVP8EncKfMode - -rw -Keyframe Mode -Keyframe placement. -Determine optimal placement automatically - - - -GstVP8Enc::max-intra-bitrate-pct -gint ->= 0 -rw -Max Intra bitrate -Maximum Intra frame bitrate. -0 - - - -GstVP8Enc::overshoot-pct -gint -[0,1000] -rw -Overshoot PCT -Datarate overshoot (max) target (%). -100 - - - -GstVP8Enc::resize-down-threshold -gint -[0,100] -rw -Resize Down Threshold -Downscale threshold (buf %). -60 - - - -GstVP8Enc::resize-up-threshold -gint -[0,100] -rw -Resize Up Threshold -Upscale threshold (buf %). -30 - - - -GstVP8Enc::target-bitrate -gint ->= 0 -rw -Target bitrate -Target bitrate (in bits/sec). -256000 - - - -GstVP8Enc::token-partitions -GstVP8EncTokenPartitions - -rw -Token partitions -Number of token partitions. -One token partition - - - -GstVP8Enc::ts-layer-id -GValueArray* - -rw -Coding layer identification -Sequence defining coding layer membership. - - - - -GstVP8Enc::ts-number-layers -gint -[1,5] -rw -Number of coding layers -Number of coding layers to use. -1 - - - -GstVP8Enc::ts-periodicity -gint -[0,16] -rw -Layer periodicity -Length of sequence that defines layer membership periodicity. -0 - - - -GstVP8Enc::ts-rate-decimator -GValueArray* - -rw -Coding layer rate decimator -Rate decimation factors for each layer. - - - - -GstVP8Enc::ts-target-bitrate -GValueArray* - -rw -Coding layer target bitrates -Target bitrates for coding layers (one per layer, decreasing). - - - - -GstVP8Enc::tuning -GstVP8EncTuning - -rw -Tuning -Tuning. -Tune for PSNR - - - -GstVP8Enc::twopass-vbr-bias-pct -gint -[0,100] -rw -2-pass VBR bias -CBR/VBR bias (0=CBR, 100=VBR). -50 - - - -GstVP8Enc::twopass-vbr-maxsection-pct -gint ->= 0 -rw -2-pass GOP max bitrate -GOP maximum bitrate (% target). -0 - - - -GstVP8Enc::twopass-vbr-minsection-pct -gint ->= 0 -rw -2-pass GOP min bitrate -GOP minimum bitrate (% target). -0 - - - -GstVP8Enc::undershoot-pct -gint -[0,1000] -rw -Undershoot PCT -Datarate undershoot (min) target (%). -100 - - - -GstVP8Enc::v-scaling-mode -GstVP8EncScalingMode - -rw -Vertical scaling mode -Vertical scaling mode. -Normal - - - -GstPhotography::aperture -guint -<= 255 -rw -Aperture property -Aperture defines the size of lens opening (0 = auto). -0 - - - -GstPhotography::capabilities -gulong - -r -Photo capabilities bitmask -Tells the photo capabilities of the device. - - - - -GstPhotography::colour-tone-mode -GstColourToneMode - -rw -Colour tone mode property -Colour tone setting changes colour shading in the photo. -GST_PHOTOGRAPHY_COLOUR_TONE_MODE_NORMAL - - - -GstPhotography::ev-compensation -gfloat -[-2.5,2.5] -rw -EV compensation property -EV compensation affects the brightness of the image. -0 - - - -GstPhotography::exposure -guint - -rw -Exposure time in milliseconds -Exposure time defines how long the shutter will stay open (0 = auto). -0 - - - -GstPhotography::flash-mode -GstPhotographyFlashMode - -rw -Flash mode property -Flash mode defines how the flash light should be used. -GST_PHOTOGRAPHY_FLASH_MODE_AUTO - - - -GstPhotography::flicker-mode -GstPhotographyFlickerReductionMode - -rw -Flicker reduction mode property -Flicker reduction mode defines a line frequency for flickering prevention. -GST_PHOTOGRAPHY_FLICKER_REDUCTION_OFF - - - -GstPhotography::focus-mode -GstPhotographyFocusMode - -rw -Focus mode property -Focus mode defines the range of focal lengths to use in autofocus search. -GST_PHOTOGRAPHY_FOCUS_MODE_AUTO - - - -GstPhotography::image-capture-supported-caps -GstCaps* - -r -Image capture supported caps -Caps describing supported image capture formats. - - - - -GstPhotography::iso-speed -guint -<= 6400 -rw -ISO speed property -ISO speed defines the light sensitivity (0 = auto). -0 - - - -GstPhotography::scene-mode -GstPhotographySceneMode - -rw -Scene mode property -Scene mode works as a preset for different photo shooting mode settings. -GST_PHOTOGRAPHY_SCENE_MODE_AUTO - - - -GstPhotography::white-balance-mode -GstPhotographyWhiteBalanceMode - -rw -White balance mode property -White balance affects the color temperature of the photo. -GST_PHOTOGRAPHY_WB_MODE_AUTO - - - -GstPhotography::image-preview-supported-caps -GstCaps* - -r -Image preview supported caps -Caps describing supported image preview formats. - - - - -GstPhotography::noise-reduction -GstPhotographyNoiseReduction - -rw -Noise Reduction settings -Which noise reduction modes are enabled (0 = disabled). - - - - -GstPhotography::zoom -gfloat -[1,10] -rw -Zoom property -How much the resulted image will be zoomed. -1 - - - -GstPhotography::analog-gain -gfloat ->= 1 -rw -Analog gain applied to the sensor -Analog gain applied to the sensor. -1 - - - -GstPhotography::color-temperature -guint - -rw -Color temperature in Kelvin units -Color temperature in Kelvin units for manual white balance. -0 - - - -GstPhotography::color-tone-mode -GstPhotographyColorToneMode - -rw -Color tone mode property -Color tone setting changes color shading in the photo. -GST_PHOTOGRAPHY_COLOR_TONE_MODE_NORMAL - - - -GstPhotography::exposure-time -guint - -rw -Exposure time in milliseconds -Exposure time defines how long the shutter will stay open (0 = auto). -0 - - - -GstPhotography::lens-focus -gfloat ->= 0 -rw -Manual lens focus -Focus point in diopter units. -0 - - - -GstPhotography::max-exposure-time -guint - -rw -Maximum exposure time -Maximum exposure time for automatic exposure mode. -0 - - - -GstPhotography::min-exposure-time -guint - -rw -Minimum exposure time -Minimum exposure time for automatic exposure mode. -0 - - - -GstPhotography::white-point -GValueArray* - -rw -White point -Describe color white as raw values. - - - GstWaterRipple::amplitude gdouble diff --git a/docs/plugins/gst-plugins-bad-plugins.hierarchy b/docs/plugins/gst-plugins-bad-plugins.hierarchy index a60fefded7..cd1f3f43ab 100644 --- a/docs/plugins/gst-plugins-bad-plugins.hierarchy +++ b/docs/plugins/gst-plugins-bad-plugins.hierarchy @@ -391,7 +391,6 @@ GInterface GstChildProxy GstColorBalance GstNavigation - GstPhotography GstPreset GstTagSetter GstTagXmpWriter diff --git a/docs/plugins/gst-plugins-bad-plugins.types b/docs/plugins/gst-plugins-bad-plugins.types index 3117ba5d71..e69de29bb2 100644 --- a/docs/plugins/gst-plugins-bad-plugins.types +++ b/docs/plugins/gst-plugins-bad-plugins.types @@ -1,6 +0,0 @@ -#include - -#include - -gst_photography_get_type -