Commit f42d52e6 authored by James Zern's avatar James Zern

documentation: minor cosmetics

- correct spelling
- remove explicit file name w/\file (unnecessary when contained in the
  same file and prone to desync)

Change-Id: I68a3960ac5ab84d0f2e5c9b2e29799f26dfccf23
parent 0030303b
......@@ -31,7 +31,7 @@
The WebM project is an open source project supported by its community. For
questions about this SDK, please mail the apps-devel@webmproject.org list.
To contribute, see http://www.webmproject.org/code/contribute and mail
vpx-devel@webmproject.org.
codec-devel@webmproject.org.
*/
/*!\page changelog CHANGELOG
......
......@@ -25,7 +25,7 @@
codec may write into to store details about a single instance of that codec.
Most of the context is implementation specific, and thus opaque to the
application. The context structure as seen by the application is of fixed
size, and thus can be allocated eith with automatic storage or dynamically
size, and thus can be allocated with automatic storage or dynamically
on the heap.
Most operations require an initialized codec context. Codec context
......@@ -74,7 +74,7 @@
the ABI is versioned. The ABI version number must be passed at
initialization time to ensure the application is using a header file that
matches the library. The current ABI version number is stored in the
prepropcessor macros #VPX_CODEC_ABI_VERSION, #VPX_ENCODER_ABI_VERSION, and
preprocessor macros #VPX_CODEC_ABI_VERSION, #VPX_ENCODER_ABI_VERSION, and
#VPX_DECODER_ABI_VERSION. For convenience, each initialization function has
a wrapper macro that inserts the correct version number. These macros are
named like the initialization methods, but without the _ver suffix.
......@@ -125,7 +125,7 @@
The special value <code>0</code> is reserved to represent an infinite
deadline. In this case, the codec will perform as much processing as
possible to yeild the highest quality frame.
possible to yield the highest quality frame.
By convention, the value <code>1</code> is used to mean "return as fast as
possible."
......@@ -135,7 +135,7 @@
/*! \page usage_xma External Memory Allocation
Applications that wish to have fine grained control over how and where
decoders allocate memory \ref MAY make use of the e_xternal Memory Allocation
decoders allocate memory \ref MAY make use of the eXternal Memory Allocation
(XMA) interface. Not all codecs support the XMA \ref usage_features.
To use a decoder in XMA mode, the decoder \ref MUST be initialized with the
......@@ -143,7 +143,7 @@
allocate is heavily dependent on the size of the encoded video frames. The
size of the video must be known before requesting the decoder's memory map.
This stream information can be obtained with the vpx_codec_peek_stream_info()
function, which does not require a contructed decoder context. If the exact
function, which does not require a constructed decoder context. If the exact
stream is not known, a stream info structure can be created that reflects
the maximum size that the decoder instance is required to support.
......@@ -175,7 +175,7 @@
\section usage_xma_seg_szalign Segment Size and Alignment
The sz (size) and align (alignment) parameters describe the required size
and alignment of the requested segment. Alignment will always be a power of
two. Applications \ref MUST honor the aligment requested. Failure to do so
two. Applications \ref MUST honor the alignment requested. Failure to do so
could result in program crashes or may incur a speed penalty.
\section usage_xma_seg_flags Segment Flags
......
......@@ -9,7 +9,7 @@
*/
/*!\file decoder_impl.h
/*!\file
* \brief Describes the decoder algorithm interface for algorithm
* implementations.
*
......@@ -214,7 +214,7 @@ typedef vpx_image_t*(*vpx_codec_get_frame_fn_t)(vpx_codec_alg_priv_t *ctx,
vpx_codec_iter_t *iter);
/*\brief e_xternal Memory Allocation memory map get iterator
/*\brief eXternal Memory Allocation memory map get iterator
*
* Iterates over a list of the memory maps requested by the decoder. The
* iterator storage should be initialized to NULL to start the iteration.
......@@ -230,7 +230,7 @@ typedef vpx_codec_err_t (*vpx_codec_get_mmap_fn_t)(const vpx_codec_ctx_t *c
vpx_codec_iter_t *iter);
/*\brief e_xternal Memory Allocation memory map set iterator
/*\brief eXternal Memory Allocation memory map set iterator
*
* Sets a memory descriptor inside the decoder instance.
*
......@@ -405,7 +405,7 @@ vpx_codec_iface_t id##_algo
/* Internal Utility Functions
*
* The following functions are indended to be used inside algorithms as
* The following functions are intended to be used inside algorithms as
* utilities for manipulating vpx_codec_* data structures.
*/
struct vpx_codec_pkt_list
......
......@@ -9,7 +9,7 @@
*/
/*!\file vpx_decoder.c
/*!\file
* \brief Provides the high level interface to wrap decoder algorithms.
*
*/
......
......@@ -9,7 +9,7 @@
*/
/*!\file vpx_decoder.c
/*!\file
* \brief Provides the high level interface to wrap decoder algorithms.
*
*/
......
......@@ -9,7 +9,7 @@
*/
/*!\file vpx_decoder.c
/*!\file
* \brief Provides the high level interface to wrap decoder algorithms.
*
*/
......
......@@ -9,7 +9,7 @@
*/
/*!\file vpx_encoder.c
/*!\file
* \brief Provides the high level interface to wrap encoder algorithms.
*
*/
......
......@@ -14,7 +14,7 @@
* VP8 is vpx's newest video compression algorithm that uses motion
* compensated prediction, Discrete Cosine Transform (DCT) coding of the
* prediction error signal and context dependent entropy coding techniques
* based on arithmatic principles. It features:
* based on arithmetic principles. It features:
* - YUV 4:2:0 image format
* - Macro-block based coding (16x16 luma plus two 8x8 chroma)
* - 1/4 (1/8) pixel accuracy motion compensated prediction
......@@ -25,7 +25,7 @@
*
* @{
*/
/*!\file vp8.h
/*!\file
* \brief Provides controls common to both the VP8 encoder and decoder.
*/
#ifndef VP8_H
......@@ -67,7 +67,7 @@ enum vp8_postproc_level
/*!\brief post process flags
*
* This define a structure that describe the post processing settings. For
* the best objective measure (using thet PSNR metric) set post_proc_flag
* the best objective measure (using the PSNR metric) set post_proc_flag
* to VP8_DEBLOCK and deblocking_level to 1.
*/
......@@ -101,7 +101,7 @@ typedef struct vpx_ref_frame
} vpx_ref_frame_t;
/*!\brief vp8 decoder control funciton parameter type
/*!\brief vp8 decoder control function parameter type
*
* defines the data type for each of VP8 decoder control function requires
*/
......
......@@ -16,7 +16,7 @@
*/
#include "vp8.h"
/*!\file vp8cx.h
/*!\file
* \brief Provides definitions for using the VP8 encoder algorithm within the
* vpx Codec Interface.
*/
......
......@@ -16,7 +16,7 @@
*
* @{
*/
/*!\file vp8dx.h
/*!\file
* \brief Provides definitions for using the VP8 algorithm within the vpx Decoder
* interface.
*/
......
......@@ -16,7 +16,7 @@
* @{
*/
/*!\file vpx_codec.h
/*!\file
* \brief Describes the codec algorithm interface to applications.
*
* This file describes the interface between an application and a
......@@ -145,7 +145,7 @@ extern "C" {
typedef long vpx_codec_caps_t;
#define VPX_CODEC_CAP_DECODER 0x1 /**< Is a decoder */
#define VPX_CODEC_CAP_ENCODER 0x2 /**< Is an encoder */
#define VPX_CODEC_CAP_XMA 0x4 /**< Supports e_xternal Memory Allocation */
#define VPX_CODEC_CAP_XMA 0x4 /**< Supports eXternal Memory Allocation */
/*! \brief Initialization-time Feature Enabling
......@@ -156,7 +156,7 @@ extern "C" {
* The available flags are specified by VPX_CODEC_USE_* defines.
*/
typedef long vpx_codec_flags_t;
#define VPX_CODEC_USE_XMA 0x00000001 /**< Use e_xternal Memory Allocation mode */
#define VPX_CODEC_USE_XMA 0x00000001 /**< Use eXternal Memory Allocation mode */
/*!\brief Codec interface structure.
......@@ -232,7 +232,7 @@ extern "C" {
/*!\brief Return the version major number */
#define vpx_codec_version_major() ((vpx_codec_version()>>16)&0xff)
/*!\brief Return the version minr number */
/*!\brief Return the version minor number */
#define vpx_codec_version_minor() ((vpx_codec_version()>>8)&0xff)
/*!\brief Return the version patch number */
......@@ -338,9 +338,9 @@ extern "C" {
/*!\brief Get the capabilities of an algorithm.
*
* Retrieves the capabliities bitfield from the algorithm's interface.
* Retrieves the capabilities bitfield from the algorithm's interface.
*
* \param[in] iface Pointer to the alogrithm interface
* \param[in] iface Pointer to the algorithm interface
*
*/
vpx_codec_caps_t vpx_codec_get_caps(vpx_codec_iface_t *iface);
......@@ -354,7 +354,7 @@ extern "C" {
*
* This wrapper function dispatches the request to the helper function
* associated with the given ctrl_id. It tries to call this function
* transparantly, but will return #VPX_CODEC_ERROR if the request could not
* transparently, but will return #VPX_CODEC_ERROR if the request could not
* be dispatched.
*
* Note that this function should not be used directly. Call the
......@@ -525,7 +525,7 @@ extern "C" {
* passed in the order they are read from vpx_codec_get_mem_map(), but may be
* passed in groups of any size. Segments \ref MUST be set only once. The
* allocation function \ref MUST ensure that the vpx_codec_mmap_t::base member
* is non-NULL. If the segment requires cleanup handling (eg, calling free()
* is non-NULL. If the segment requires cleanup handling (e.g., calling free()
* or close()) then the vpx_codec_mmap_t::dtor member \ref MUST be populated.
*
* \param[in] ctx Pointer to this instance's context.
......
......@@ -17,7 +17,7 @@
* @{
*/
/*!\file vpx_decoder.h
/*!\file
* \brief Describes the decoder algorithm interface to applications.
*
* This file describes the interface between an application and a
......@@ -48,7 +48,7 @@ extern "C" {
* ::vpx_codec_iface_t interface structure. Capabilities are extra interfaces
* or functionality, and are not required to be supported by a decoder.
*
* The available flags are specifiedby VPX_CODEC_CAP_* defines.
* The available flags are specified by VPX_CODEC_CAP_* defines.
*/
#define VPX_CODEC_CAP_PUT_SLICE 0x10000 /**< Will issue put_slice callbacks */
#define VPX_CODEC_CAP_PUT_FRAME 0x20000 /**< Will issue put_frame callbacks */
......@@ -109,7 +109,7 @@ extern "C" {
* kept readable and stable until all memory maps have been set.
*
* \param[in] ctx Pointer to this instance's context.
* \param[in] iface Pointer to the alogrithm interface to use.
* \param[in] iface Pointer to the algorithm interface to use.
* \param[in] cfg Configuration to use, if known. May be NULL.
* \param[in] flags Bitfield of VPX_CODEC_USE_* flags
* \param[in] ver ABI version number. Must be set to
......@@ -139,7 +139,7 @@ extern "C" {
* context is not necessary. Can be used to determine if the bitstream is
* of the proper format, and to extract information from the stream.
*
* \param[in] iface Pointer to the alogrithm interface
* \param[in] iface Pointer to the algorithm interface
* \param[in] data Pointer to a block of data to parse
* \param[in] data_sz Size of the data buffer
* \param[in,out] si Pointer to stream info to update. The size member
......
......@@ -16,7 +16,7 @@
* @{
*/
/*!\file vpx_decoder_compat.h
/*!\file
* \brief Provides a compatibility layer between version 1 and 2 of this API.
*
* This interface has been deprecated. Only existing code should make use
......@@ -89,12 +89,12 @@ extern "C" {
* ::vpx_dec_iface_t interface structure. Capabilities are extra interfaces
* or functionality, and are not required to be supported by a decoder.
*
* The available flags are specifiedby VPX_DEC_CAP_* defines.
* The available flags are specified by VPX_DEC_CAP_* defines.
*/
typedef int vpx_dec_caps_t;
#define VPX_DEC_CAP_PUT_SLICE 0x0001 /**< Will issue put_slice callbacks */
#define VPX_DEC_CAP_PUT_FRAME 0x0002 /**< Will issue put_frame callbacks */
#define VPX_DEC_CAP_XMA 0x0004 /**< Supports e_xternal Memory Allocation */
#define VPX_DEC_CAP_XMA 0x0004 /**< Supports eXternal Memory Allocation */
/*!\brief Stream properties
*
......@@ -222,7 +222,7 @@ extern "C" {
* is properly initialized.
*
* \param[in] ctx Pointer to this instance's context.
* \param[in] iface Pointer to the alogrithm interface to use.
* \param[in] iface Pointer to the algorithm interface to use.
* \param[in] ver ABI version number. Must be set to
* VPX_DECODER_ABI_VERSION
* \retval #VPX_DEC_OK
......@@ -253,9 +253,9 @@ extern "C" {
/*!\brief Get the capabilities of an algorithm.
*
* Retrieves the capabliities bitfield from the algorithm's interface.
* Retrieves the capabilities bitfield from the algorithm's interface.
*
* \param[in] iface Pointer to the alogrithm interface
* \param[in] iface Pointer to the algorithm interface
*
*/
vpx_dec_caps_t vpx_dec_get_caps(vpx_dec_iface_t *iface) DEPRECATED;
......@@ -267,7 +267,7 @@ extern "C" {
* context is not necessary. Can be used to determine if the bitstream is
* of the proper format, and to extract information from the stream.
*
* \param[in] iface Pointer to the alogrithm interface
* \param[in] iface Pointer to the algorithm interface
* \param[in] data Pointer to a block of data to parse
* \param[in] data_sz Size of the data buffer
* \param[in,out] si Pointer to stream info to update. The size member
......@@ -309,7 +309,7 @@ extern "C" {
*
* This wrapper function dispatches the request to the helper function
* associated with the given ctrl_id. It tries to call this function
* transparantly, but will return #VPX_DEC_ERROR if the request could not
* transparently, but will return #VPX_DEC_ERROR if the request could not
* be dispatched.
*
* \param[in] ctx Pointer to this instance's context
......@@ -507,7 +507,7 @@ extern "C" {
* is properly initialized.
*
* \param[in] ctx Pointer to this instance's context.
* \param[in] iface Pointer to the alogrithm interface to use.
* \param[in] iface Pointer to the algorithm interface to use.
* \param[in] ver ABI version number. Must be set to
* VPX_DECODER_ABI_VERSION
* \retval #VPX_DEC_OK
......@@ -558,7 +558,7 @@ extern "C" {
* passed in the order they are read from vpx_dec_get_mem_map(), but may be
* passed in groups of any size. Segments \ref MUST be set only once. The
* allocation function \ref MUST ensure that the vpx_dec_mmap_t::base member
* is non-NULL. If the segment requires cleanup handling (eg, calling free()
* is non-NULL. If the segment requires cleanup handling (e.g., calling free()
* or close()) then the vpx_dec_mmap_t::dtor member \ref MUST be populated.
*
* \param[in] ctx Pointer to this instance's context.
......
......@@ -17,7 +17,7 @@
* @{
*/
/*!\file vpx_encoder.h
/*!\file
* \brief Describes the encoder algorithm interface to applications.
*
* This file describes the interface between an application and a
......@@ -51,7 +51,7 @@ extern "C" {
* interfaces or functionality, and are not required to be supported
* by an encoder.
*
* The available flags are specifiedby VPX_CODEC_CAP_* defines.
* The available flags are specified by VPX_CODEC_CAP_* defines.
*/
#define VPX_CODEC_CAP_PSNR 0x10000 /**< Can issue PSNR packets */
......@@ -147,7 +147,7 @@ extern "C" {
/* This packet size is fixed to allow codecs to extend this
* interface without having to manage storage for raw packets,
* ie if it's smaller than 128 bytes, you can store in the
* i.e., if it's smaller than 128 bytes, you can store in the
* packet list directly.
*/
char pad[128 - sizeof(enum vpx_codec_cx_pkt_kind)]; /**< fixed sz */
......
......@@ -9,7 +9,7 @@
*/
/*!\file vpx_image.h
/*!\file
* \brief Describes the vpx image descriptor and associated operations
*
*/
......@@ -33,7 +33,7 @@ extern "C" {
#define VPX_IMG_FMT_PLANAR 0x100 /**< Image is a planar format */
#define VPX_IMG_FMT_UV_FLIP 0x200 /**< V plane precedes U plane in memory */
#define VPX_IMG_FMT_HAS_ALPHA 0x400 /**< Image has an alpha channel componnent */
#define VPX_IMG_FMT_HAS_ALPHA 0x400 /**< Image has an alpha channel component */
/*!\brief List of supported image formats */
......@@ -115,7 +115,7 @@ extern "C" {
#define VPX_PLANE_Y 0 /**< Y (Luminance) plane */
#define VPX_PLANE_U 1 /**< U (Chroma) plane */
#define VPX_PLANE_V 2 /**< V (Chroma) plane */
#define VPX_PLANE_ALPHA 3 /**< A (Transparancy) plane */
#define VPX_PLANE_ALPHA 3 /**< A (Transparency) plane */
#if !defined(VPX_CODEC_DISABLE_COMPAT) || !VPX_CODEC_DISABLE_COMPAT
#define PLANE_PACKED VPX_PLANE_PACKED
#define PLANE_Y VPX_PLANE_Y
......
......@@ -9,10 +9,10 @@
*/
/* \file mem_ops.h
* \brief Provides portable memory access primatives
/* \file
* \brief Provides portable memory access primitives
*
* This function provides portable primatives for getting and setting of
* This function provides portable primitives for getting and setting of
* signed and unsigned integers in 16, 24, and 32 bit sizes. The operations
* can be performed on unaligned data regardless of hardware support for
* unaligned accesses.
......
......@@ -9,12 +9,12 @@
*/
/* \file mem_ops_aligned.h
* \brief Provides portable memory access primatives for operating on aligned
/* \file
* \brief Provides portable memory access primitives for operating on aligned
* data
*
* This file is split from mem_ops.h for easier maintainence. See mem_ops.h
* for a more detailed description of these primatives.
* This file is split from mem_ops.h for easier maintenance. See mem_ops.h
* for a more detailed description of these primitives.
*/
#ifndef INCLUDED_BY_MEM_OPS_H
#error Include mem_ops.h, not mem_ops_aligned.h directly.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment