# HG changeset patch # User diego # Date 1198237818 0 # Node ID 979a885a7686623f3916e790583b1cf435f5b6b3 # Parent 082a99e447951d522dc80ade06ab3cc26455523f comment typo fixes diff -r 082a99e44795 -r 979a885a7686 avformat.h --- a/avformat.h Fri Dec 21 00:22:40 2007 +0000 +++ b/avformat.h Fri Dec 21 11:50:18 2007 +0000 @@ -272,21 +272,21 @@ /** * Stream structure. * New fields can be added to the end with minor version bumps. - * Removal, reordering and changes to existing fields require a Major + * Removal, reordering and changes to existing fields require a major * version bump. - * sizeof(AVStream) must not be used outside libav* + * sizeof(AVStream) must not be used outside libav*. */ typedef struct AVStream { int index; /**< stream index in AVFormatContext */ int id; /**< format specific stream id */ AVCodecContext *codec; /**< codec context */ /** - * real base frame rate of the stream. - * this is the lowest framerate with which all timestamps can be + * Real base frame rate of the stream. + * This is the lowest frame rate with which all timestamps can be * represented accurately (it is the least common multiple of all - * framerates in the stream), Note, this value is just a guess! - * for example if the timebase is 1/90000 and all frames have either - * approximately 3600 or 1800 timer ticks then r_frame_rate will be 50/1 + * frame rates in the stream), Note, this value is just a guess! + * For example if the timebase is 1/90000 and all frames have either + * approximately 3600 or 1800 timer ticks then r_frame_rate will be 50/1. */ AVRational r_frame_rate; void *priv_data; @@ -297,9 +297,9 @@ struct AVFrac pts; /** - * this is the fundamental unit of time (in seconds) in terms - * of which frame timestamps are represented. for fixed-fps content, - * timebase should be 1/framerate and timestamp increments should be + * This is the fundamental unit of time (in seconds) in terms + * of which frame timestamps are represented. For fixed-fps content, + * timebase should be 1/frame rate and timestamp increments should be * identically 1. */ AVRational time_base; @@ -312,16 +312,16 @@ * MN: dunno if that is the right place for it */ float quality; /** - * decoding: pts of the first frame of the stream, in stream time base. - * only set this if you are absolutely 100% sure that the value you set - * it to really is the pts of the first frame + * Decoding: pts of the first frame of the stream, in stream time base. + * Only set this if you are absolutely 100% sure that the value you set + * it to really is the pts of the first frame. * This may be undefined (AV_NOPTS_VALUE). - * @note the ASF header does NOT contain a correct start_time the ASF - * demuxer must NOT set this + * @note The ASF header does NOT contain a correct start_time the ASF + * demuxer must NOT set this. */ int64_t start_time; /** - * decoding: duration of the stream, in stream time base. + * Decoding: duration of the stream, in stream time base. * If a source file does not specify a duration, but does specify * a bitrate, this value will be estimates from bit rate and file size. */ @@ -351,11 +351,10 @@ #define AV_PROGRAM_RUNNING 1 /** - * * New fields can be added to the end with minor version bumps. - * Removal, reordering and changes to existing fields require a Major + * Removal, reordering and changes to existing fields require a major * version bump. - * sizeof(AVProgram) must not be used outside libav* + * sizeof(AVProgram) must not be used outside libav*. */ typedef struct AVProgram { int id; @@ -375,9 +374,9 @@ /** * format I/O context. * New fields can be added to the end with minor version bumps. - * Removal, reordering and changes to existing fields require a Major + * Removal, reordering and changes to existing fields require a major * version bump. - * sizeof(AVFormatContext) must not be used outside libav* + * sizeof(AVFormatContext) must not be used outside libav*. */ typedef struct AVFormatContext { const AVClass *av_class; /**< set by av_alloc_format_context */ diff -r 082a99e44795 -r 979a885a7686 avio.h --- a/avio.h Fri Dec 21 00:22:40 2007 +0000 +++ b/avio.h Fri Dec 21 11:50:18 2007 +0000 @@ -32,9 +32,9 @@ /** * URL Context. * New fields can be added to the end with minor version bumps. - * Removal, reordering and changes to existing fields require a Major + * Removal, reordering and changes to existing fields require a major * version bump. - * sizeof(URLContext) must not be used outside libav* + * sizeof(URLContext) must not be used outside libav*. */ struct URLContext { struct URLProtocol *prot; @@ -69,7 +69,7 @@ /** * Return the maximum packet size associated to packetized file - * handle. If the file is not packetized (stream like http or file on + * handle. If the file is not packetized (stream like HTTP or file on * disk), then 0 is returned. * * @param h file handle @@ -79,10 +79,10 @@ void url_get_filename(URLContext *h, char *buf, int buf_size); /** - * the callback is called in blocking functions to test regulary if + * The callback is called in blocking functions to test regulary if * asynchronous interruption is needed. AVERROR(EINTR) is returned * in this case by the interrupted function. 'NULL' means no interrupt - * callback is given. i + * callback is given. */ void url_set_interrupt_cb(URLInterruptCB *interrupt_cb); @@ -95,9 +95,10 @@ * @param pause 1 for pause, 0 for resume */ int av_url_read_pause(URLContext *h, int pause); + /** * Seek to a given timestamp relative to some component stream. - * Only meaningful if using a network streaming protocol (e.g. MMS.) + * Only meaningful if using a network streaming protocol (e.g. MMS.). * @param stream_index The stream index that the timestamp is relative to. * If stream_index is (-1) the timestamp should be in AV_TIME_BASE * units from the beginning of the presentation. @@ -145,9 +146,9 @@ /** * Bytestream IO Context. * New fields can be added to the end with minor version bumps. - * Removal, reordering and changes to existing fields require a Major + * Removal, reordering and changes to existing fields require a major * version bump. - * sizeof(ByteIOContext) must not be used outside libav* + * sizeof(ByteIOContext) must not be used outside libav*. */ typedef struct { unsigned char *buffer;