mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-02-20 04:56:24 +00:00
Code Issues 1 Projects Releases Wiki Activity

move last template doc snippets to source code and delete them

Browse source 
Original commit message from CVS:
* docs/libs/tmpl/gstaudio.sgml:
* docs/libs/tmpl/gstcolorbalance.sgml:
* docs/libs/tmpl/gstmixer.sgml:
* docs/libs/tmpl/gstringbuffer.sgml:
* docs/libs/tmpl/gsttuner.sgml:
* docs/libs/tmpl/gstxoverlay.sgml:
* gst-libs/gst/audio/audio.c:
* gst-libs/gst/audio/gstringbuffer.c:
* gst-libs/gst/interfaces/colorbalance.c:
* gst-libs/gst/interfaces/mixer.c:
* gst-libs/gst/interfaces/tuner.c:
* gst-libs/gst/interfaces/xoverlay.c:
move last template doc snippets to source code and delete them
This commit is contained in:
Thomas Vander Stichele 2006-06-07 11:03:03 +00:00
parent 3a19c68a34
commit 51ca8fe3e1
13 changed files with 43 additions and 791 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
ChangeLog
View file

@ -1,3 +1,19 @@
2006-06-07 Thomas Vander Stichele <thomas at apestaart dot org>
* docs/libs/tmpl/gstaudio.sgml:
* docs/libs/tmpl/gstcolorbalance.sgml:
* docs/libs/tmpl/gstmixer.sgml:
* docs/libs/tmpl/gstringbuffer.sgml:
* docs/libs/tmpl/gsttuner.sgml:
* docs/libs/tmpl/gstxoverlay.sgml:
* gst-libs/gst/audio/audio.c:
* gst-libs/gst/audio/gstringbuffer.c:
* gst-libs/gst/interfaces/colorbalance.c:
* gst-libs/gst/interfaces/mixer.c:
* gst-libs/gst/interfaces/tuner.c:
* gst-libs/gst/interfaces/xoverlay.c:
move last template doc snippets to source code and delete them
2006-06-06 Michael Smith <msmith@fluendo.com> 2006-06-06 Michael Smith <msmith@fluendo.com>
* ext/theora/theoraparse.c: (theora_parse_drain_queue_prematurely), * ext/theora/theoraparse.c: (theora_parse_drain_queue_prematurely),

79
docs/libs/tmpl/gstaudio.sgml
View file

@ -1,79 +0,0 @@
<!-- ##### SECTION Title ##### -->
gstaudio
<!-- ##### SECTION Short_Description ##### -->
a support library for audio elements
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### ENUM GstAudioFieldFlag ##### -->
<para>
</para>
@GST_AUDIO_FIELD_RATE:
@GST_AUDIO_FIELD_CHANNELS:
@GST_AUDIO_FIELD_ENDIANNESS:
@GST_AUDIO_FIELD_WIDTH:
@GST_AUDIO_FIELD_DEPTH:
@GST_AUDIO_FIELD_SIGNED:
<!-- ##### FUNCTION gst_audio_frame_byte_size ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### FUNCTION gst_audio_frame_length ##### -->
<para>
</para>
@pad:
@buf:
@Returns:
<!-- ##### FUNCTION gst_audio_duration_from_pad_buffer ##### -->
<para>
</para>
@pad:
@buf:
@Returns:
<!-- ##### FUNCTION gst_audio_is_buffer_framed ##### -->
<para>
</para>
@pad:
@buf:
@Returns:
<!-- ##### FUNCTION gst_audio_structure_set_int ##### -->
<para>
</para>
@structure:
@flag:

86
docs/libs/tmpl/gstcolorbalance.sgml
View file

@ -1,86 +0,0 @@
<!-- ##### SECTION Title ##### -->
gstcolorbalance
<!-- ##### SECTION Short_Description ##### -->
interface for adjusting color balance settings
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GstColorBalance ##### -->
<para>
</para>
<!-- ##### SIGNAL GstColorBalance::value-changed ##### -->
<para>
</para>
@gstcolorbalance: the object which received the signal.
@arg1:
@arg2:
<!-- ##### STRUCT GstColorBalanceClass ##### -->
<para>
</para>
@klass:
@balance_type:
@list_channels:
@set_value:
@get_value:
@value_changed:
@_gst_reserved:
<!-- ##### FUNCTION gst_color_balance_list_channels ##### -->
<para>
</para>
@balance:
@Returns:
<!-- ##### FUNCTION gst_color_balance_get_value ##### -->
<para>
</para>
@balance:
@channel:
@Returns:
<!-- ##### FUNCTION gst_color_balance_set_value ##### -->
<para>
</para>
@balance:
@channel:
@value:
<!-- ##### FUNCTION gst_color_balance_value_changed ##### -->
<para>
</para>
@balance:
@channel:
@value:

164
docs/libs/tmpl/gstmixer.sgml
View file

@ -1,164 +0,0 @@
<!-- ##### SECTION Title ##### -->
gstmixer
<!-- ##### SECTION Short_Description ##### -->
interface for elements that provide mixer operations
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GstMixer ##### -->
<para>
</para>
<!-- ##### STRUCT GstMixerClass ##### -->
<para>
</para>
@klass:
@mixer_type:
@list_tracks:
@set_volume:
@get_volume:
@set_mute:
@set_record:
@mute_toggled:
@record_toggled:
@volume_changed:
@set_option:
@get_option:
@option_changed:
<!-- ##### STRUCT GstMixerOptions ##### -->
<para>
</para>
<!-- ##### STRUCT GstMixerTrack ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_mixer_list_tracks ##### -->
<para>
</para>
@mixer:
@Returns:
<!-- ##### FUNCTION gst_mixer_get_volume ##### -->
<para>
</para>
@mixer:
@track:
@volumes:
<!-- ##### FUNCTION gst_mixer_set_volume ##### -->
<para>
</para>
@mixer:
@track:
@volumes:
<!-- ##### FUNCTION gst_mixer_set_mute ##### -->
<para>
</para>
@mixer:
@track:
@mute:
<!-- ##### FUNCTION gst_mixer_set_record ##### -->
<para>
</para>
@mixer:
@track:
@record:
<!-- ##### FUNCTION gst_mixer_set_option ##### -->
<para>
</para>
@mixer:
@opts:
@value:
<!-- ##### FUNCTION gst_mixer_mute_toggled ##### -->
<para>
</para>
@mixer:
@track:
@mute:
<!-- ##### FUNCTION gst_mixer_record_toggled ##### -->
<para>
</para>
@mixer:
@track:
@record:
<!-- ##### FUNCTION gst_mixer_volume_changed ##### -->
<para>
</para>
@mixer:
@track:
@volumes:
<!-- ##### FUNCTION gst_mixer_option_changed ##### -->
<para>
</para>
@mixer:
@opts:
@value:
<!-- ##### FUNCTION gst_mixer_options_get_values ##### -->
<para>
</para>
@mixer_options:
@Returns:

208
docs/libs/tmpl/gstringbuffer.sgml
View file

@ -1,208 +0,0 @@
<!-- ##### SECTION Title ##### -->
gstringbuffer
<!-- ##### SECTION Short_Description ##### -->
an implementation of an audio ringbuffer
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GstRingBuffer ##### -->
<para>
</para>
@cond:
@open:
@acquired:
@data:
@spec:
@segstate:
@samples_per_seg:
@empty_seg:
@state:
@segdone:
@segbase:
@waiting:
<!-- ##### STRUCT GstRingBufferSpec ##### -->
<para>
</para>
@caps:
@type:
@format:
@sign:
@bigend:
@width:
@depth:
@rate:
@channels:
@latency_time:
@buffer_time:
@segsize:
@segtotal:
@bytes_per_sample:
@silence_sample:
<!-- ##### STRUCT GstRingBufferClass ##### -->
<para>
</para>
@parent_class:
@open_device:
@acquire:
@release:
@close_device:
@start:
@pause:
@resume:
@stop:
@delay:
<!-- ##### FUNCTION gst_ring_buffer_set_callback ##### -->
<para>
</para>
@buf:
@cb:
@user_data:
<!-- ##### FUNCTION gst_ring_buffer_acquire ##### -->
<para>
</para>
@buf:
@spec:
@Returns:
<!-- ##### FUNCTION gst_ring_buffer_release ##### -->
<para>
</para>
@buf:
@Returns:
<!-- ##### FUNCTION gst_ring_buffer_is_acquired ##### -->
<para>
</para>
@buf:
@Returns:
<!-- ##### FUNCTION gst_ring_buffer_start ##### -->
<para>
</para>
@buf:
@Returns:
<!-- ##### FUNCTION gst_ring_buffer_pause ##### -->
<para>
</para>
@buf:
@Returns:
<!-- ##### FUNCTION gst_ring_buffer_stop ##### -->
<para>
</para>
@buf:
@Returns:
<!-- ##### FUNCTION gst_ring_buffer_delay ##### -->
<para>
</para>
@buf:
@Returns:
<!-- ##### FUNCTION gst_ring_buffer_samples_done ##### -->
<para>
</para>
@buf:
@Returns:
<!-- ##### FUNCTION gst_ring_buffer_set_sample ##### -->
<para>
</para>
@buf:
@sample:
<!-- ##### FUNCTION gst_ring_buffer_commit ##### -->
<para>
</para>
@buf:
@sample:
@data:
@len:
@Returns:
<!-- ##### FUNCTION gst_ring_buffer_prepare_read ##### -->
<para>
</para>
@buf:
@segment:
@readptr:
@len:
@Returns:
<!-- ##### FUNCTION gst_ring_buffer_clear ##### -->
<para>
</para>
@buf:
@segment:
<!-- ##### FUNCTION gst_ring_buffer_advance ##### -->
<para>
</para>
@buf:
@advance:

178
docs/libs/tmpl/gsttuner.sgml
View file

@ -1,178 +0,0 @@
<!-- ##### SECTION Title ##### -->
gsttuner
<!-- ##### SECTION Short_Description ##### -->
interface for elements that provide tuner operations
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GstTuner ##### -->
<para>
</para>
<!-- ##### STRUCT GstTunerClass ##### -->
<para>
</para>
@klass:
@list_channels:
@set_channel:
@get_channel:
@list_norms:
@set_norm:
@get_norm:
@set_frequency:
@get_frequency:
@signal_strength:
@channel_changed:
@norm_changed:
@frequency_changed:
@signal_changed:
@_gst_reserved:
<!-- ##### FUNCTION gst_tuner_list_channels ##### -->
<para>
</para>
@tuner:
@Returns:
<!-- ##### FUNCTION gst_tuner_get_channel ##### -->
<para>
</para>
@tuner:
@Returns:
<!-- ##### FUNCTION gst_tuner_set_channel ##### -->
<para>
</para>
@tuner:
@channel:
<!-- ##### FUNCTION gst_tuner_list_norms ##### -->
<para>
</para>
@tuner:
@Returns:
<!-- ##### FUNCTION gst_tuner_get_norm ##### -->
<para>
</para>
@tuner:
@Returns:
<!-- ##### FUNCTION gst_tuner_set_norm ##### -->
<para>
</para>
@tuner:
@norm:
<!-- ##### FUNCTION gst_tuner_set_frequency ##### -->
<para>
</para>
@tuner:
@channel:
@frequency:
<!-- ##### FUNCTION gst_tuner_signal_strength ##### -->
<para>
</para>
@tuner:
@channel:
@Returns:
<!-- ##### FUNCTION gst_tuner_find_norm_by_name ##### -->
<para>
</para>
@tuner:
@norm:
@Returns:
<!-- ##### FUNCTION gst_tuner_find_channel_by_name ##### -->
<para>
</para>
@tuner:
@channel:
@Returns:
<!-- ##### FUNCTION gst_tuner_channel_changed ##### -->
<para>
</para>
@tuner:
@channel:
<!-- ##### FUNCTION gst_tuner_norm_changed ##### -->
<para>
</para>
@tuner:
@norm:
<!-- ##### FUNCTION gst_tuner_frequency_changed ##### -->
<para>
</para>
@tuner:
@channel:
@frequency:
<!-- ##### FUNCTION gst_tuner_signal_changed ##### -->
<para>
</para>
@tuner:
@channel:
@signal:

68
docs/libs/tmpl/gstxoverlay.sgml
View file

@ -1,68 +0,0 @@
<!-- ##### SECTION Title ##### -->
gstxoverlay
<!-- ##### SECTION Short_Description ##### -->
interface for setting/getting a Window on elements supporting it.
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GstXOverlay ##### -->
<para>
</para>
<!-- ##### STRUCT GstXOverlayClass ##### -->
<para>
</para>
@klass:
@set_xwindow_id:
@expose:
<!-- ##### FUNCTION gst_x_overlay_set_xwindow_id ##### -->
<para>
</para>
@overlay:
@xwindow_id:
<!-- ##### FUNCTION gst_x_overlay_got_xwindow_id ##### -->
<para>
</para>
@overlay:
@xwindow_id:
<!-- ##### FUNCTION gst_x_overlay_prepare_xwindow_id ##### -->
<para>
</para>
@overlay:
<!-- ##### FUNCTION gst_x_overlay_expose ##### -->
<para>
</para>
@overlay:

5
gst-libs/gst/audio/audio.c
View file

@ -26,6 +26,11 @@
#include <gst/gststructure.h> #include <gst/gststructure.h>
/**
* SECTION:gstaudio
* @short_description: Support library for audio elements
*/
int int
gst_audio_frame_byte_size (GstPad * pad) gst_audio_frame_byte_size (GstPad * pad)
{ {

7
gst-libs/gst/audio/gstringbuffer.c
View file

@ -1,8 +1,6 @@
/* GStreamer /* GStreamer
* Copyright (C) 2005 Wim Taymans <wim@fluendo.com> * Copyright (C) 2005 Wim Taymans <wim@fluendo.com>
* *
* gstringbuffer.c:
*
* This library is free software; you can redistribute it and/or * This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public * modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either * License as published by the Free Software Foundation; either
@ -18,6 +16,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gstringbuffer * SECTION:gstringbuffer
* @short_description: Base class for audio ringbuffer implementations * @short_description: Base class for audio ringbuffer implementations
@ -30,9 +29,9 @@
* </para> * </para>
* <para> * <para>
* The ringbuffer abstracts a circular buffer of data. One reader and * The ringbuffer abstracts a circular buffer of data. One reader and
* one writer can operate on the data from different threads in a lockfree * one writer can operate on the data from different threads in a lockfree
* manner. The base class is sufficiently flexible to be used as an * manner. The base class is sufficiently flexible to be used as an
* abstraction for DMA based ringbuffers as well as a pure software * abstraction for DMA based ringbuffers as well as a pure software
* implementations. * implementations.
* </para> * </para>
* </refsect2> * </refsect2>

5
gst-libs/gst/interfaces/colorbalance.c
View file

@ -27,6 +27,11 @@
#include "colorbalance.h" #include "colorbalance.h"
#include "interfaces-marshal.h" #include "interfaces-marshal.h"
/**
* SECTION:gstcolorbalance
* @short_description: Interface for adjusting color balance settings
*/
enum enum
{ {
VALUE_CHANGED, VALUE_CHANGED,

5
gst-libs/gst/interfaces/mixer.c
View file

@ -26,6 +26,11 @@
#include "mixer.h" #include "mixer.h"
#include "interfaces-marshal.h" #include "interfaces-marshal.h"
/**
* SECTION:gstmixer
* @short_description: Interface for elements that provide mixer operations
*/
enum enum
{ {
SIGNAL_MUTE_TOGGLED, SIGNAL_MUTE_TOGGLED,

5
gst-libs/gst/interfaces/tuner.c
View file

@ -28,6 +28,11 @@
#include <string.h> #include <string.h>
/**
* SECTION:gsttuner
* @short_description: Interface for elements providing tuner operations
*/
enum enum
{ {
NORM_CHANGED, NORM_CHANGED,

8
gst-libs/gst/interfaces/xoverlay.c
View file

@ -38,10 +38,10 @@
* </listitem> * </listitem>
* <listitem> * <listitem>
* <para> * <para>
* To force a redrawing of the latest video frame the video sink element * To force a redrawing of the latest video frame the video sink element
* displayed on the Window. Indeed if the #GstPipeline is in #GST_STATE_PAUSED * displayed on the Window. Indeed if the #GstPipeline is in #GST_STATE_PAUSED
* state, moving the Window around will damage its content. Application * state, moving the Window around will damage its content. Application
* developers will want to handle the Expose events themselves and force the * developers will want to handle the Expose events themselves and force the
* video sink element to refresh the Window's content. * video sink element to refresh the Window's content.
* </para> * </para>
* </listitem> * </listitem>
@ -49,7 +49,7 @@
* </para> * </para>
* <para> * <para>
* Using the Window created by the video sink is probably the simplest scenario, * Using the Window created by the video sink is probably the simplest scenario,
* in some cases, though, it might not be flexible enough for application * in some cases, though, it might not be flexible enough for application
* developers if they need to catch events such as mouse moves and button * developers if they need to catch events such as mouse moves and button
* clicks. * clicks.
* </para> * </para>
@ -58,7 +58,7 @@
* flexible solution but it has some issues. Indeed the application needs to set * flexible solution but it has some issues. Indeed the application needs to set
* its Window identifier at the right time to avoid internal Window creation * its Window identifier at the right time to avoid internal Window creation
* from the video sink element. To solve this issue a #GstMessage is posted on * from the video sink element. To solve this issue a #GstMessage is posted on
* the bus to inform the application that it should set the Window identifier * the bus to inform the application that it should set the Window identifier
* immediately. Here is an example on how to do that correctly: * immediately. Here is an example on how to do that correctly:
* <programlisting> * <programlisting>
* static GstBusSyncReply * static GstBusSyncReply