Fix gtk-doc warnings. Also don't misuse api-doc comments for normal comments.

Original commit message from CVS:
* docs/plugins/gst-plugins-bad-plugins-sections.txt:
* examples/app/appsrc-ra.c:
* examples/app/appsrc-seekable.c:
* examples/app/appsrc-stream.c:
* examples/app/appsrc-stream2.c:
* ext/directfb/dfbvideosink.h:
* ext/metadata/gstbasemetadata.c:
* ext/metadata/gstbasemetadata.h:
* ext/metadata/metadata.c:
* ext/metadata/metadataexif.c:
* ext/theora/theoradec.h:
* gst/deinterlace2/gstdeinterlace2.h:
* gst/deinterlace2/tvtime/speedy.c:
* gst/deinterlace2/tvtime/speedy.h:
* gst/deinterlace2/tvtime/vfir.c:
Fix gtk-doc warnings. Also don't misuse api-doc comments for normal
comments.
This commit is contained in:
Stefan Kost 2008-06-18 06:31:13 +00:00
parent fc19ab1ded
commit 5a0287dc76
16 changed files with 131 additions and 119 deletions

View File

@ -1,3 +1,23 @@
2008-06-18 Stefan Kost <ensonic@users.sf.net>
* docs/plugins/gst-plugins-bad-plugins-sections.txt:
* examples/app/appsrc-ra.c:
* examples/app/appsrc-seekable.c:
* examples/app/appsrc-stream.c:
* examples/app/appsrc-stream2.c:
* ext/directfb/dfbvideosink.h:
* ext/metadata/gstbasemetadata.c:
* ext/metadata/gstbasemetadata.h:
* ext/metadata/metadata.c:
* ext/metadata/metadataexif.c:
* ext/theora/theoradec.h:
* gst/deinterlace2/gstdeinterlace2.h:
* gst/deinterlace2/tvtime/speedy.c:
* gst/deinterlace2/tvtime/speedy.h:
* gst/deinterlace2/tvtime/vfir.c:
Fix gtk-doc warnings. Also don't misuse api-doc comments for normal
comments.
2008-06-17 Jan Schmidt <jan.schmidt@sun.com> 2008-06-17 Jan Schmidt <jan.schmidt@sun.com>
* ext/resindvd/resindvdbin.c: * ext/resindvd/resindvdbin.c:

View File

@ -141,8 +141,10 @@ GST_TYPE_DVD_SPU
gst_dvd_spu_get_type gst_dvd_spu_get_type
SpuColour SpuColour
SpuLineCtrlI SpuLineCtrlI
SpuPacket
SpuPixCtrlI SpuPixCtrlI
SpuRect SpuRect
SpuState
DVD_SPU_LOCK DVD_SPU_LOCK
DVD_SPU_UNLOCK DVD_SPU_UNLOCK
SPU_STATE_FLAGS_MASK SPU_STATE_FLAGS_MASK
@ -210,7 +212,6 @@ GST_INTERLEAVE_GET_CLASS
GST_IS_INTERLEAVE GST_IS_INTERLEAVE
GST_IS_INTERLEAVE_CLASS GST_IS_INTERLEAVE_CLASS
GST_TYPE_INTERLEAVE GST_TYPE_INTERLEAVE
GstInterleave
GstInterleaveClass GstInterleaveClass
GstInterleaveFunc GstInterleaveFunc
gst_interleave_get_type gst_interleave_get_type
@ -227,7 +228,6 @@ GST_DEINTERLEAVE_GET_CLASS
GST_IS_DEINTERLEAVE GST_IS_DEINTERLEAVE
GST_IS_DEINTERLEAVE_CLASS GST_IS_DEINTERLEAVE_CLASS
GST_TYPE_DEINTERLEAVE GST_TYPE_DEINTERLEAVE
GstDeinterleave
GstDeinterleaveClass GstDeinterleaveClass
GstDeinterleaveFunc GstDeinterleaveFunc
gst_deinterleave_get_type gst_deinterleave_get_type
@ -251,7 +251,7 @@ gst_jack_audio_sink_get_type
<SECTION> <SECTION>
<FILE>gstbasemetadata</FILE> <FILE>gstbasemetadata</FILE>
<TITLE>GstBaseMetadata/TITLE> <TITLE>GstBaseMetadata</TITLE>
GstBaseMetadata GstBaseMetadata
GST_BASE_METADATA_SINK_PAD GST_BASE_METADATA_SINK_PAD
GST_BASE_METADATA_SRC_PAD GST_BASE_METADATA_SRC_PAD
@ -261,6 +261,7 @@ gst_base_metadata_unset_option_flag
gst_base_metadata_update_inject_segment_with_new_data gst_base_metadata_update_inject_segment_with_new_data
<SUBSECTION Standard> <SUBSECTION Standard>
GstBaseMetadataClass GstBaseMetadataClass
MetadataState
GST_BASE_METADATA GST_BASE_METADATA
GST_BASE_METADATA_CLASS GST_BASE_METADATA_CLASS
GST_IS_BASE_METADATA GST_IS_BASE_METADATA
@ -328,6 +329,10 @@ GST_MPEG2ENC_CLASS
GST_IS_MPEG2ENC GST_IS_MPEG2ENC
GST_IS_MPEG2ENC_CLASS GST_IS_MPEG2ENC_CLASS
GST_TYPE_MPEG2ENC GST_TYPE_MPEG2ENC
GST_MPEG2ENC_MUTEX_LOCK
GST_MPEG2ENC_MUTEX_UNLOCK
GST_MPEG2ENC_SIGNAL
GST_MPEG2ENC_WAIT
gst_mpeg2enc_get_type gst_mpeg2enc_get_type
</SECTION> </SECTION>

View File

@ -33,7 +33,7 @@
GST_DEBUG_CATEGORY (appsrc_playbin_debug); GST_DEBUG_CATEGORY (appsrc_playbin_debug);
#define GST_CAT_DEFAULT appsrc_playbin_debug #define GST_CAT_DEFAULT appsrc_playbin_debug
/** /*
* an example application of using appsrc in random-access mode. When the * an example application of using appsrc in random-access mode. When the
* appsrc requests data with the need-data signal, we retrieve a buffer of the * appsrc requests data with the need-data signal, we retrieve a buffer of the
* requested size and push it to appsrc. * requested size and push it to appsrc.

View File

@ -33,7 +33,7 @@
GST_DEBUG_CATEGORY (appsrc_playbin_debug); GST_DEBUG_CATEGORY (appsrc_playbin_debug);
#define GST_CAT_DEFAULT appsrc_playbin_debug #define GST_CAT_DEFAULT appsrc_playbin_debug
/** /*
* an example application of using appsrc in seekable mode. When the * an example application of using appsrc in seekable mode. When the
* appsrc requests data with the need-data signal, we retrieve a buffer and * appsrc requests data with the need-data signal, we retrieve a buffer and
* push it to appsrc. We can also use the method as demonstrated in * push it to appsrc. We can also use the method as demonstrated in

View File

@ -33,7 +33,7 @@
GST_DEBUG_CATEGORY (appsrc_playbin_debug); GST_DEBUG_CATEGORY (appsrc_playbin_debug);
#define GST_CAT_DEFAULT appsrc_playbin_debug #define GST_CAT_DEFAULT appsrc_playbin_debug
/** /*
* an example application of using appsrc in streaming push mode. We simply push * an example application of using appsrc in streaming push mode. We simply push
* buffers into appsrc. The size of the buffers we push can be any size we * buffers into appsrc. The size of the buffers we push can be any size we
* choose. * choose.

View File

@ -33,7 +33,7 @@
GST_DEBUG_CATEGORY (appsrc_playbin_debug); GST_DEBUG_CATEGORY (appsrc_playbin_debug);
#define GST_CAT_DEFAULT appsrc_playbin_debug #define GST_CAT_DEFAULT appsrc_playbin_debug
/** /*
* an example application of using appsrc in streaming pull mode. When the * an example application of using appsrc in streaming pull mode. When the
* appsrc request data with the need-data signal, we retrieve a buffer of an * appsrc request data with the need-data signal, we retrieve a buffer of an
* arbitrary size and push it to appsrc. * arbitrary size and push it to appsrc.

View File

@ -71,9 +71,9 @@ struct _GstDfbVMode {
* The opaque #GstDfbVideoSink structure. * The opaque #GstDfbVideoSink structure.
*/ */
struct _GstDfbVideoSink { struct _GstDfbVideoSink {
/* Our element stuff */
GstVideoSink videosink; GstVideoSink videosink;
/* < private > */
GMutex *pool_lock; GMutex *pool_lock;
GSList *buffer_pool; GSList *buffer_pool;

View File

@ -1914,11 +1914,7 @@ done:
* EXIF, IPTC, XMP or not. * EXIF, IPTC, XMP or not.
* @see_also: #gst_base_metadata_unset_option_flag * @see_also: #gst_base_metadata_unset_option_flag
* #gst_base_metadata_get_option_flag * #gst_base_metadata_get_option_flag
*
* Returns: nothing
*
*/ */
void void
gst_base_metadata_set_option_flag (GstBaseMetadata * base, MetaOptions options) gst_base_metadata_set_option_flag (GstBaseMetadata * base, MetaOptions options)
{ {
@ -1934,11 +1930,7 @@ gst_base_metadata_set_option_flag (GstBaseMetadata * base, MetaOptions options)
* EXIF, IPTC, XMP or not. * EXIF, IPTC, XMP or not.
* @see_also: #gst_base_metadata_set_option_flag * @see_also: #gst_base_metadata_set_option_flag
* #gst_base_metadata_get_option_flag * #gst_base_metadata_get_option_flag
*
* Returns: nothing
*
*/ */
void void
gst_base_metadata_unset_option_flag (GstBaseMetadata * base, gst_base_metadata_unset_option_flag (GstBaseMetadata * base,
MetaOptions options) MetaOptions options)
@ -1956,9 +1948,7 @@ gst_base_metadata_unset_option_flag (GstBaseMetadata * base,
* #gst_base_metadata_unset_option_flag * #gst_base_metadata_unset_option_flag
* *
* Returns: The current mode of operation * Returns: The current mode of operation
*
*/ */
MetaOptions MetaOptions
gst_base_metadata_get_option_flag (const GstBaseMetadata * base) gst_base_metadata_get_option_flag (const GstBaseMetadata * base)
{ {
@ -1979,11 +1969,7 @@ gst_base_metadata_get_option_flag (const GstBaseMetadata * base)
* the @data ownership will be taken and @data and @size willl be set to 0; * the @data ownership will be taken and @data and @size willl be set to 0;
* Hanlding EXIF, IPTC, XMP or not. * Hanlding EXIF, IPTC, XMP or not.
* @see_also: #gst_base_metadata_calculate_offsets * @see_also: #gst_base_metadata_calculate_offsets
*
* Returns: Nothing
*
*/ */
void gst_base_metadata_update_inject_segment_with_new_data void gst_base_metadata_update_inject_segment_with_new_data
(GstBaseMetadata * base, (GstBaseMetadata * base,
guint8 ** data, guint32 * size, MetadataChunkType type) guint8 ** data, guint32 * size, MetadataChunkType type)

View File

@ -67,10 +67,10 @@ G_BEGIN_DECLS
typedef struct _GstBaseMetadata GstBaseMetadata; typedef struct _GstBaseMetadata GstBaseMetadata;
typedef struct _GstBaseMetadataClass GstBaseMetadataClass; typedef struct _GstBaseMetadataClass GstBaseMetadataClass;
typedef enum _tag_BaseMetadataType { enum {
BASE_METADATA_DEMUXING, BASE_METADATA_DEMUXING,
BASE_METADATA_MUXING BASE_METADATA_MUXING
} BaseMetadataType; };
/* /*
@ -126,7 +126,7 @@ typedef enum _tag_BaseMetadataType {
(GST_BASE_METADATA_CAST (obj)->img_type) (GST_BASE_METADATA_CAST (obj)->img_type)
typedef enum _tag_MetadataState typedef enum _MetadataState
{ {
MT_STATE_NULL, /* still need to check media type */ MT_STATE_NULL, /* still need to check media type */
MT_STATE_PARSED MT_STATE_PARSED

View File

@ -41,7 +41,7 @@
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/* /**
* SECTION: metadata * SECTION: metadata
* @short_description: This module provides high-level functions to parse files * @short_description: This module provides high-level functions to parse files
* *

View File

@ -41,7 +41,7 @@
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/* /**
* SECTION: metadataexif * SECTION: metadataexif
* @short_description: This module provides functions to extract tags from * @short_description: This module provides functions to extract tags from
* EXIF metadata chunks and create EXIF chunks from metadata tags. * EXIF metadata chunks and create EXIF chunks from metadata tags.

View File

@ -54,6 +54,7 @@ struct _GstTheoraExpDec
{ {
GstElement element; GstElement element;
/* <private> */
/* Pads */ /* Pads */
GstPad *sinkpad; GstPad *sinkpad;
GstPad *srcpad; GstPad *srcpad;

View File

@ -50,7 +50,7 @@ typedef struct deinterlace_method_s deinterlace_method_t;
typedef struct deinterlace_scanline_data_s deinterlace_scanline_data_t; typedef struct deinterlace_scanline_data_s deinterlace_scanline_data_t;
typedef struct deinterlace_frame_data_s deinterlace_frame_data_t; typedef struct deinterlace_frame_data_s deinterlace_frame_data_t;
/** /*
* There are two scanline functions that every deinterlacer plugin * There are two scanline functions that every deinterlacer plugin
* must implement to do its work: one for a 'copy' and one for * must implement to do its work: one for a 'copy' and one for
* an 'interpolate' for the currently active field. This so so that * an 'interpolate' for the currently active field. This so so that
@ -70,7 +70,7 @@ struct deinterlace_scanline_data_s
int bottom_field; int bottom_field;
}; };
/** /*
* | t-3 t-2 t-1 t * | t-3 t-2 t-1 t
* | Field 3 | Field 2 | Field 1 | Field 0 | * | Field 3 | Field 2 | Field 1 | Field 0 |
* | TT3 | | TT1 | | * | TT3 | | TT1 | |
@ -87,7 +87,7 @@ struct deinterlace_scanline_data_s
*/ */
typedef void (*deinterlace_interp_scanline_t) (GstDeinterlace2 * object, typedef void (*deinterlace_interp_scanline_t) (GstDeinterlace2 * object,
deinterlace_scanline_data_t * data, guint8 * output); deinterlace_scanline_data_t * data, guint8 * output);
/** /*
* For the copy scanline, the API is basically the same, except that * For the copy scanline, the API is basically the same, except that
* we're given a scanline to 'copy'. * we're given a scanline to 'copy'.
* *
@ -102,7 +102,7 @@ typedef void (*deinterlace_interp_scanline_t) (GstDeinterlace2 * object,
typedef void (*deinterlace_copy_scanline_t) (GstDeinterlace2 * object, typedef void (*deinterlace_copy_scanline_t) (GstDeinterlace2 * object,
deinterlace_scanline_data_t * data, guint8 * output); deinterlace_scanline_data_t * data, guint8 * output);
/** /*
* The frame function is for deinterlacing plugins that can only act * The frame function is for deinterlacing plugins that can only act
* on whole frames, rather than on a scanline at a time. * on whole frames, rather than on a scanline at a time.
*/ */
@ -117,7 +117,7 @@ struct deinterlace_frame_data_s
typedef void (*deinterlace_frame_t) (GstDeinterlace2 * object); typedef void (*deinterlace_frame_t) (GstDeinterlace2 * object);
/** /*
* This structure defines the deinterlacer plugin. * This structure defines the deinterlacer plugin.
*/ */
struct deinterlace_method_s struct deinterlace_method_s

View File

@ -1,4 +1,4 @@
/** /*
* Copyright (c) 2002, 2003 Billy Biggs <vektor@dumbterm.net>. * Copyright (c) 2002, 2003 Billy Biggs <vektor@dumbterm.net>.
* Copyright (C) 2001 Matthew J. Marjanovic <maddog@mir.com> * Copyright (C) 2001 Matthew J. Marjanovic <maddog@mir.com>
* *
@ -17,7 +17,7 @@
* Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/ */
/** /*
* Includes 420to422, 422to444 scaling filters from the MPEG2 reference * Includes 420to422, 422to444 scaling filters from the MPEG2 reference
* implementation. The v12 source code indicates that they were written * implementation. The v12 source code indicates that they were written
* by Cheung Auyeung <auyeung@mot.com>. The file they were in was: * by Cheung Auyeung <auyeung@mot.com>. The file they were in was:
@ -49,7 +49,7 @@
* *
*/ */
/** /*
* Code for the UYVY to YUYV routine comes from rivatv: * Code for the UYVY to YUYV routine comes from rivatv:
* *
* rivatv-convert.c video image conversion routines * rivatv-convert.c video image conversion routines
@ -157,7 +157,7 @@ void (*convert_uyvy_to_yuyv_scanline) (uint8_t * uyvy_buf, uint8_t * yuyv_buf,
void (*composite_colour4444_alpha_to_packed422_scanline) (uint8_t * output, void (*composite_colour4444_alpha_to_packed422_scanline) (uint8_t * output,
uint8_t * input, int af, int y, int cb, int cr, int width, int alpha); uint8_t * input, int af, int y, int cb, int cr, int width, int alpha);
/** /*
* result = (1 - alpha)B + alpha*F * result = (1 - alpha)B + alpha*F
* = B - alpha*B + alpha*F * = B - alpha*B + alpha*F
* = B + alpha*(F - B) * = B + alpha*(F - B)
@ -574,7 +574,7 @@ packed422_to_packed444_scanline_c (uint8_t * output, uint8_t * input, int width)
} }
} }
/** /*
* For the middle pixels, the filter kernel is: * For the middle pixels, the filter kernel is:
* *
* [-1 3 -6 12 -24 80 80 -24 12 -6 3 -1] * [-1 3 -6 12 -24 80 80 -24 12 -6 3 -1]
@ -1290,7 +1290,7 @@ blit_colour_packed4444_scanline_mmxext (uint8_t * output, int width,
#endif #endif
/** /*
* Some memcpy code inspired by the xine code which originally came * Some memcpy code inspired by the xine code which originally came
* from mplayer. * from mplayer.
*/ */
@ -1450,7 +1450,7 @@ composite_colour4444_alpha_to_packed422_scanline_c (uint8_t * output,
int i; int i;
for (i = 0; i < width; i++) { for (i = 0; i < width; i++) {
/** /*
* (1 - alpha)*B + alpha*F * (1 - alpha)*B + alpha*F
* (1 - af*a)*B + af*a*F * (1 - af*a)*B + af*a*F
* B - af*a*B + af*a*F * B - af*a*B + af*a*F
@ -1463,7 +1463,7 @@ composite_colour4444_alpha_to_packed422_scanline_c (uint8_t * output,
if ((i & 1) == 0) { if ((i & 1) == 0) {
/** /*
* At first I thought I was doing this incorrectly, but * At first I thought I was doing this incorrectly, but
* the following math has convinced me otherwise. * the following math has convinced me otherwise.
* *
@ -1604,7 +1604,7 @@ composite_packed4444_alpha_to_packed422_scanline_c (uint8_t * output,
output[3] = foreground[3]; output[3] = foreground[3];
} }
} else if (a) { } else if (a) {
/** /*
* (1 - alpha)*B + alpha*F * (1 - alpha)*B + alpha*F
* (1 - af*a)*B + af*a*F * (1 - af*a)*B + af*a*F
* B - af*a*B + af*a*F * B - af*a*B + af*a*F
@ -1617,7 +1617,7 @@ composite_packed4444_alpha_to_packed422_scanline_c (uint8_t * output,
if ((i & 1) == 0) { if ((i & 1) == 0) {
/** /*
* At first I thought I was doing this incorrectly, but * At first I thought I was doing this incorrectly, but
* the following math has convinced me otherwise. * the following math has convinced me otherwise.
* *
@ -1762,7 +1762,7 @@ composite_packed4444_to_packed422_scanline_c (uint8_t * output, uint8_t * input,
output[3] = foreground[3]; output[3] = foreground[3];
} }
} else if (a) { } else if (a) {
/** /*
* (1 - alpha)*B + alpha*F * (1 - alpha)*B + alpha*F
* B + af*F - af*B * B + af*F - af*B
*/ */
@ -1772,7 +1772,7 @@ composite_packed4444_to_packed422_scanline_c (uint8_t * output, uint8_t * input,
if ((i & 1) == 0) { if ((i & 1) == 0) {
/** /*
* C_r = (1 - af)*B + af*F * C_r = (1 - af)*B + af*F
* C_r = B - af*B + af*F * C_r = B - af*B + af*F
*/ */
@ -1887,7 +1887,7 @@ composite_packed4444_to_packed422_scanline_mmxext (uint8_t * output,
} }
#endif #endif
/** /*
* um... just need some scrap paper... * um... just need some scrap paper...
* D = (1 - alpha)*B + alpha*F * D = (1 - alpha)*B + alpha*F
* D = (1 - a)*B + a*textluma * D = (1 - a)*B + a*textluma
@ -2287,7 +2287,7 @@ a8_subpix_blit_scanline_c (uint8_t * output, uint8_t * input,
} }
} }
/** /*
* These are from lavtools in mjpegtools: * These are from lavtools in mjpegtools:
* *
* colorspace.c: Routines to perform colorspace conversions. * colorspace.c: Routines to perform colorspace conversions.
@ -2552,7 +2552,7 @@ packed444_to_rgb24_rec601_scanline_c (uint8_t * output, uint8_t * input,
} }
} }
/** /*
* 601 numbers: * 601 numbers:
* *
* Y' = 0.299*R' + 0.587*G' + 0.114*B' (in 0.0 to 1.0) * Y' = 0.299*R' + 0.587*G' + 0.114*B' (in 0.0 to 1.0)

View File

@ -37,7 +37,7 @@
extern "C" { extern "C" {
#endif #endif
/** /*
* Speedy is a collection of optimized functions plus their C fallbacks. * Speedy is a collection of optimized functions plus their C fallbacks.
* This includes a simple system to select which functions to use * This includes a simple system to select which functions to use
* at runtime. * at runtime.
@ -50,7 +50,7 @@ extern "C" {
* implementation of each function. * implementation of each function.
*/ */
/** /*
* Struct for pulldown detection metrics. * Struct for pulldown detection metrics.
*/ */
typedef struct pulldown_metrics_s { typedef struct pulldown_metrics_s {
@ -60,19 +60,19 @@ typedef struct pulldown_metrics_s {
int t, s, p; int t, s, p;
} pulldown_metrics_t; } pulldown_metrics_t;
/** /*
* Interpolates a packed 4:2:2 scanline using linear interpolation. * Interpolates a packed 4:2:2 scanline using linear interpolation.
*/ */
extern void (*interpolate_packed422_scanline)( uint8_t *output, uint8_t *top, extern void (*interpolate_packed422_scanline)( uint8_t *output, uint8_t *top,
uint8_t *bot, int width ); uint8_t *bot, int width );
/** /*
* Blits a colour to a packed 4:2:2 scanline. * Blits a colour to a packed 4:2:2 scanline.
*/ */
extern void (*blit_colour_packed422_scanline)( uint8_t *output, extern void (*blit_colour_packed422_scanline)( uint8_t *output,
int width, int y, int cb, int cr ); int width, int y, int cb, int cr );
/** /*
* Blits a colour to a packed 4:4:4:4 scanline. I use luma/cb/cr instead of * Blits a colour to a packed 4:4:4:4 scanline. I use luma/cb/cr instead of
* RGB but this will of course work for either. * RGB but this will of course work for either.
*/ */
@ -80,19 +80,19 @@ extern void (*blit_colour_packed4444_scanline)( uint8_t *output,
int width, int alpha, int luma, int width, int alpha, int luma,
int cb, int cr ); int cb, int cr );
/** /*
* Blit from and to packed 4:2:2 scanline. * Blit from and to packed 4:2:2 scanline.
*/ */
extern void (*blit_packed422_scanline)( uint8_t *dest, const uint8_t *src, int width ); extern void (*blit_packed422_scanline)( uint8_t *dest, const uint8_t *src, int width );
/** /*
* Composites a premultiplied 4:4:4:4 pixel onto a packed 4:2:2 scanline. * Composites a premultiplied 4:4:4:4 pixel onto a packed 4:2:2 scanline.
*/ */
extern void (*composite_colour4444_alpha_to_packed422_scanline)( uint8_t *output, uint8_t *input, extern void (*composite_colour4444_alpha_to_packed422_scanline)( uint8_t *output, uint8_t *input,
int af, int y, int cb, int cr, int af, int y, int cb, int cr,
int width, int alpha ); int width, int alpha );
/** /*
* Composites a packed 4:4:4:4 scanline onto a packed 4:2:2 scanline. * Composites a packed 4:4:4:4 scanline onto a packed 4:2:2 scanline.
* Chroma is downsampled by dropping samples (nearest neighbour). * Chroma is downsampled by dropping samples (nearest neighbour).
*/ */
@ -101,7 +101,7 @@ extern void (*composite_packed4444_to_packed422_scanline)( uint8_t *output,
uint8_t *foreground, uint8_t *foreground,
int width ); int width );
/** /*
* Composites a packed 4:4:4:4 scanline onto a packed 4:2:2 scanline. * Composites a packed 4:4:4:4 scanline onto a packed 4:2:2 scanline.
* Chroma is downsampled by dropping samples (nearest neighbour). The * Chroma is downsampled by dropping samples (nearest neighbour). The
* alpha value provided is in the range 0-256 and is first applied to * alpha value provided is in the range 0-256 and is first applied to
@ -112,7 +112,7 @@ extern void (*composite_packed4444_alpha_to_packed422_scanline)( uint8_t *output
uint8_t *foreground, uint8_t *foreground,
int width, int alpha ); int width, int alpha );
/** /*
* Takes an alphamask and the given colour (in Y'CbCr) and composites it * Takes an alphamask and the given colour (in Y'CbCr) and composites it
* onto a packed 4:4:4:4 scanline. * onto a packed 4:4:4:4 scanline.
*/ */
@ -122,7 +122,7 @@ extern void (*composite_alphamask_to_packed4444_scanline)( uint8_t *output,
int textluma, int textcb, int textluma, int textcb,
int textcr ); int textcr );
/** /*
* Takes an alphamask and the given colour (in Y'CbCr) and composites it * Takes an alphamask and the given colour (in Y'CbCr) and composites it
* onto a packed 4:4:4:4 scanline. The alpha value provided is in the * onto a packed 4:4:4:4 scanline. The alpha value provided is in the
* range 0-256 and is first applied to the input (for fadeouts). * range 0-256 and is first applied to the input (for fadeouts).
@ -133,13 +133,13 @@ extern void (*composite_alphamask_alpha_to_packed4444_scanline)( uint8_t *output
int textluma, int textcb, int textluma, int textcb,
int textcr, int alpha ); int textcr, int alpha );
/** /*
* Premultiplies the colour by the alpha channel in a packed 4:4:4:4 * Premultiplies the colour by the alpha channel in a packed 4:4:4:4
* scanline. * scanline.
*/ */
extern void (*premultiply_packed4444_scanline)( uint8_t *output, uint8_t *input, int width ); extern void (*premultiply_packed4444_scanline)( uint8_t *output, uint8_t *input, int width );
/** /*
* Blend between two packed 4:2:2 scanline. Pos is the fade value in * Blend between two packed 4:2:2 scanline. Pos is the fade value in
* the range 0-256. A value of 0 gives 100% src1, and a value of 256 * the range 0-256. A value of 0 gives 100% src1, and a value of 256
* gives 100% src2. Anything in between gives the appropriate faded * gives 100% src2. Anything in between gives the appropriate faded
@ -148,14 +148,14 @@ extern void (*premultiply_packed4444_scanline)( uint8_t *output, uint8_t *input,
extern void (*blend_packed422_scanline)( uint8_t *output, uint8_t *src1, extern void (*blend_packed422_scanline)( uint8_t *output, uint8_t *src1,
uint8_t *src2, int width, int pos ); uint8_t *src2, int width, int pos );
/** /*
* Calculates the 'difference factor' for two scanlines. This is a * Calculates the 'difference factor' for two scanlines. This is a
* metric where higher values indicate that the two scanlines are more * metric where higher values indicate that the two scanlines are more
* different. * different.
*/ */
extern unsigned int (*diff_factor_packed422_scanline)( uint8_t *cur, uint8_t *old, int width ); extern unsigned int (*diff_factor_packed422_scanline)( uint8_t *cur, uint8_t *old, int width );
/** /*
* Calculates the 'comb factor' for a set of three scanlines. This is a * Calculates the 'comb factor' for a set of three scanlines. This is a
* metric where higher values indicate a more likely chance that the two * metric where higher values indicate a more likely chance that the two
* fields are at separate points in time. * fields are at separate points in time.
@ -163,68 +163,68 @@ extern unsigned int (*diff_factor_packed422_scanline)( uint8_t *cur, uint8_t *ol
extern unsigned int (*comb_factor_packed422_scanline)( uint8_t *top, uint8_t *mid, extern unsigned int (*comb_factor_packed422_scanline)( uint8_t *top, uint8_t *mid,
uint8_t *bot, int width ); uint8_t *bot, int width );
/** /*
* Vertical [1 2 1] chroma filter. * Vertical [1 2 1] chroma filter.
*/ */
extern void (*vfilter_chroma_121_packed422_scanline)( uint8_t *output, int width, extern void (*vfilter_chroma_121_packed422_scanline)( uint8_t *output, int width,
uint8_t *m, uint8_t *t, uint8_t *b ); uint8_t *m, uint8_t *t, uint8_t *b );
/** /*
* Vertical [3 3 2] chroma filter. * Vertical [3 3 2] chroma filter.
*/ */
extern void (*vfilter_chroma_332_packed422_scanline)( uint8_t *output, int width, extern void (*vfilter_chroma_332_packed422_scanline)( uint8_t *output, int width,
uint8_t *m, uint8_t *t, uint8_t *b ); uint8_t *m, uint8_t *t, uint8_t *b );
/** /*
* Sets the chroma of the scanline to neutral (128) in-place. * Sets the chroma of the scanline to neutral (128) in-place.
*/ */
extern void (*kill_chroma_packed422_inplace_scanline)( uint8_t *data, int width ); extern void (*kill_chroma_packed422_inplace_scanline)( uint8_t *data, int width );
/** /*
* Mirrors the scanline in-place. * Mirrors the scanline in-place.
*/ */
extern void (*mirror_packed422_inplace_scanline)( uint8_t *data, int width ); extern void (*mirror_packed422_inplace_scanline)( uint8_t *data, int width );
/** /*
* Inverts the colours on a scanline in-place. * Inverts the colours on a scanline in-place.
*/ */
extern void (*invert_colour_packed422_inplace_scanline)( uint8_t *data, int width ); extern void (*invert_colour_packed422_inplace_scanline)( uint8_t *data, int width );
/** /*
* Fast memcpy function, used by all of the blit functions. Won't blit * Fast memcpy function, used by all of the blit functions. Won't blit
* anything if dest == src. * anything if dest == src.
*/ */
extern void (*speedy_memcpy)( void *output, const void *input, size_t size ); extern void (*speedy_memcpy)( void *output, const void *input, size_t size );
/** /*
* Calculates the block difference metrics for dalias' pulldown * Calculates the block difference metrics for dalias' pulldown
* detection algorithm. * detection algorithm.
*/ */
extern void (*diff_packed422_block8x8)( pulldown_metrics_t *m, uint8_t *old, extern void (*diff_packed422_block8x8)( pulldown_metrics_t *m, uint8_t *old,
uint8_t *new, int os, int ns ); uint8_t *new, int os, int ns );
/** /*
* Takes an alpha mask and subpixelly blits it using linear * Takes an alpha mask and subpixelly blits it using linear
* interpolation. * interpolation.
*/ */
extern void (*a8_subpix_blit_scanline)( uint8_t *output, uint8_t *input, extern void (*a8_subpix_blit_scanline)( uint8_t *output, uint8_t *input,
int lasta, int startpos, int width ); int lasta, int startpos, int width );
/** /*
* 1/4 vertical subpixel blit for packed 4:2:2 scanlines using linear * 1/4 vertical subpixel blit for packed 4:2:2 scanlines using linear
* interpolation. * interpolation.
*/ */
extern void (*quarter_blit_vertical_packed422_scanline)( uint8_t *output, uint8_t *one, extern void (*quarter_blit_vertical_packed422_scanline)( uint8_t *output, uint8_t *one,
uint8_t *three, int width ); uint8_t *three, int width );
/** /*
* Vertical subpixel blit for packed 4:2:2 scanlines using linear * Vertical subpixel blit for packed 4:2:2 scanlines using linear
* interpolation. * interpolation.
*/ */
extern void (*subpix_blit_vertical_packed422_scanline)( uint8_t *output, uint8_t *top, extern void (*subpix_blit_vertical_packed422_scanline)( uint8_t *output, uint8_t *top,
uint8_t *bot, int subpixpos, int width ); uint8_t *bot, int subpixpos, int width );
/** /*
* Simple function to convert a 4:4:4 scanline to a 4:4:4:4 scanline by * Simple function to convert a 4:4:4 scanline to a 4:4:4:4 scanline by
* adding an alpha channel. Result is non-premultiplied. * adding an alpha channel. Result is non-premultiplied.
*/ */
@ -232,7 +232,7 @@ extern void (*packed444_to_nonpremultiplied_packed4444_scanline)( uint8_t *outpu
uint8_t *input, uint8_t *input,
int width, int alpha ); int width, int alpha );
/** /*
* I think this function needs to be rethought and renamed, but here * I think this function needs to be rethought and renamed, but here
* it is for now. This function horizontally resamples a scanline * it is for now. This function horizontally resamples a scanline
* using linear interpolation to compensate for a change in pixel * using linear interpolation to compensate for a change in pixel
@ -243,7 +243,7 @@ extern void (*aspect_adjust_packed4444_scanline)( uint8_t *output,
int width, int width,
double pixel_aspect ); double pixel_aspect );
/** /*
* Convert a packed 4:4:4 surface to a packed 4:2:2 surface using * Convert a packed 4:4:4 surface to a packed 4:2:2 surface using
* nearest neighbour chroma downsampling. * nearest neighbour chroma downsampling.
*/ */
@ -251,7 +251,7 @@ extern void (*packed444_to_packed422_scanline)( uint8_t *output,
uint8_t *input, uint8_t *input,
int width ); int width );
/** /*
* Converts packed 4:2:2 to packed 4:4:4 scanlines using nearest * Converts packed 4:2:2 to packed 4:4:4 scanlines using nearest
* neighbour chroma upsampling. * neighbour chroma upsampling.
*/ */
@ -259,7 +259,7 @@ extern void (*packed422_to_packed444_scanline)( uint8_t *output,
uint8_t *input, uint8_t *input,
int width ); int width );
/** /*
* This filter actually does not meet the spec so calling it rec601 * This filter actually does not meet the spec so calling it rec601
* is a bit of a lie. I got the filter from Poynton's site. This * is a bit of a lie. I got the filter from Poynton's site. This
* converts a scanline from packed 4:2:2 to packed 4:4:4. But this * converts a scanline from packed 4:2:2 to packed 4:4:4. But this
@ -269,7 +269,7 @@ extern void (*packed422_to_packed444_rec601_scanline)( uint8_t *dest,
uint8_t *src, uint8_t *src,
int width ); int width );
/** /*
* Conversions between Y'CbCr and R'G'B'. We use Rec.601 numbers * Conversions between Y'CbCr and R'G'B'. We use Rec.601 numbers
* since our source is broadcast video, but I think there is an * since our source is broadcast video, but I think there is an
* argument to be made for switching to Rec.709. * argument to be made for switching to Rec.709.
@ -284,19 +284,19 @@ extern void (*rgba32_to_packed4444_rec601_scanline)( uint8_t *output,
uint8_t *input, uint8_t *input,
int width ); int width );
/** /*
* Convert from 4:2:2 with UYVY ordering to 4:2:2 with YUYV ordering. * Convert from 4:2:2 with UYVY ordering to 4:2:2 with YUYV ordering.
*/ */
extern void (*convert_uyvy_to_yuyv_scanline)( uint8_t *uyvy_buf, extern void (*convert_uyvy_to_yuyv_scanline)( uint8_t *uyvy_buf,
uint8_t *yuyv_buf, int width ); uint8_t *yuyv_buf, int width );
/** /*
* Sets up the function pointers to point at the fastest function * Sets up the function pointers to point at the fastest function
* available. Requires accelleration settings (see mm_accel.h). * available. Requires accelleration settings (see mm_accel.h).
*/ */
void setup_speedy_calls( uint32_t accel, int verbose ); void setup_speedy_calls( uint32_t accel, int verbose );
/** /*
* Returns a bitfield of what accellerations were used when speedy was * Returns a bitfield of what accellerations were used when speedy was
* initialized. See mm_accel.h. * initialized. See mm_accel.h.
*/ */

View File

@ -43,7 +43,7 @@
#include "speedy.h" #include "speedy.h"
#include "gstdeinterlace2.h" #include "gstdeinterlace2.h"
/** /*
* The MPEG2 spec uses a slightly harsher filter, they specify * The MPEG2 spec uses a slightly harsher filter, they specify
* [-1 8 2 8 -1]. ffmpeg uses a similar filter but with more of * [-1 8 2 8 -1]. ffmpeg uses a similar filter but with more of
* a tendancy to blur than to use the local information. The * a tendancy to blur than to use the local information. The
@ -118,7 +118,7 @@ deinterlace_line (uint8_t * dst, uint8_t * lum_m4,
} }
/** /*
* The commented-out method below that uses the bottom_field member is more * The commented-out method below that uses the bottom_field member is more
* like the filter as specified in the MPEG2 spec, but it doesn't seem to * like the filter as specified in the MPEG2 spec, but it doesn't seem to
* have the desired effect. * have the desired effect.