diff options
Diffstat (limited to 'libavformat')
| -rw-r--r-- | libavformat/avformat.h | 122 | ||||
| -rw-r--r-- | libavformat/avio.h | 34 | ||||
| -rw-r--r-- | libavformat/avlanguage.h | 4 | ||||
| -rw-r--r-- | libavformat/http.h | 4 | ||||
| -rw-r--r-- | libavformat/id3v2.h | 4 | ||||
| -rw-r--r-- | libavformat/internal.h | 8 | ||||
| -rw-r--r-- | libavformat/librtmp.c | 2 | ||||
| -rw-r--r-- | libavformat/matroskaenc.c | 2 | ||||
| -rw-r--r-- | libavformat/mpeg.c | 2 | ||||
| -rw-r--r-- | libavformat/mpegts.c | 2 | ||||
| -rw-r--r-- | libavformat/nutenc.c | 4 | ||||
| -rw-r--r-- | libavformat/rtmppkt.h | 28 | ||||
| -rw-r--r-- | libavformat/rtmpproto.c | 34 | ||||
| -rw-r--r-- | libavformat/utils.c | 4 | ||||
| -rw-r--r-- | libavformat/vorbiscomment.h | 2 |
15 files changed, 128 insertions, 128 deletions
diff --git a/libavformat/avformat.h b/libavformat/avformat.h index 283b5b943a..a7204fcc28 100644 --- a/libavformat/avformat.h +++ b/libavformat/avformat.h @@ -42,12 +42,12 @@ unsigned avformat_version(void); /** - * Returns the libavformat build-time configuration. + * Return the libavformat build-time configuration. */ const char *avformat_configuration(void); /** - * Returns the libavformat license. + * Return the libavformat license. */ const char *avformat_license(void); @@ -130,7 +130,7 @@ typedef struct AVMetadata AVMetadata; typedef struct AVMetadataConv AVMetadataConv; /** - * Gets a metadata element with matching key. + * Get a metadata element with matching key. * @param prev Set to the previous matching element to find the next. * If set to NULL the first matching element is returned. * @param flags Allows case as well as suffix-insensitive comparisons. @@ -141,7 +141,7 @@ av_metadata_get(AVMetadata *m, const char *key, const AVMetadataTag *prev, int f #if LIBAVFORMAT_VERSION_MAJOR == 52 /** - * Sets the given tag in m, overwriting an existing tag. + * Set the given tag in m, overwriting an existing tag. * @param key tag key to add to m (will be av_strduped) * @param value tag value to add to m (will be av_strduped) * @return >= 0 on success otherwise an error code <0 @@ -151,7 +151,7 @@ attribute_deprecated int av_metadata_set(AVMetadata **pm, const char *key, const #endif /** - * Sets the given tag in m, overwriting an existing tag. + * Set the given tag in m, overwriting an existing tag. * @param key tag key to add to m (will be av_strduped depending on flags) * @param value tag value to add to m (will be av_strduped depending on flags). * Passing a NULL value will cause an existing tag to be deleted. @@ -160,7 +160,7 @@ attribute_deprecated int av_metadata_set(AVMetadata **pm, const char *key, const int av_metadata_set2(AVMetadata **pm, const char *key, const char *value, int flags); /** - * Converts all the metadata sets from ctx according to the source and + * Convert all the metadata sets from ctx according to the source and * destination conversion tables. If one of the tables is NULL, then * tags are converted to/from ffmpeg generic tag names. * @param d_conv destination tags format conversion table @@ -170,7 +170,7 @@ void av_metadata_conv(struct AVFormatContext *ctx,const AVMetadataConv *d_conv, const AVMetadataConv *s_conv); /** - * Frees all the memory allocated for an AVMetadata struct. + * Free all the memory allocated for an AVMetadata struct. */ void av_metadata_free(AVMetadata **m); @@ -179,7 +179,7 @@ void av_metadata_free(AVMetadata **m); /** - * Allocates and reads the payload of a packet and initializes its + * Allocate and read the payload of a packet and initialize its * fields with default values. * * @param pkt packet @@ -349,18 +349,18 @@ typedef struct AVInputFormat { /** General purpose read-only value that the format can use. */ int value; - /** Starts/resumes playing - only meaningful if using a network-based format + /** Start/resume playing - only meaningful if using a network-based format (RTSP). */ int (*read_play)(struct AVFormatContext *); - /** Pauses playing - only meaningful if using a network-based format + /** Pause playing - only meaningful if using a network-based format (RTSP). */ int (*read_pause)(struct AVFormatContext *); const struct AVCodecTag * const *codec_tag; /** - * Seeks to timestamp ts. + * Seek to timestamp ts. * Seeking will be done so that the point from which all active streams * can be presented successfully will be closest to ts and within min/max_ts. * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL. @@ -790,8 +790,8 @@ attribute_deprecated AVOutputFormat *guess_format(const char *short_name, #endif /** - * Returns the output format in the list of registered output formats - * which best matches the provided parameters, or returns NULL if + * Return the output format in the list of registered output formats + * which best matches the provided parameters, or return NULL if * there is no match. * * @param short_name if non-NULL checks if short_name matches with the @@ -806,14 +806,14 @@ AVOutputFormat *av_guess_format(const char *short_name, const char *mime_type); /** - * Guesses the codec ID based upon muxer and filename. + * Guess the codec ID based upon muxer and filename. */ enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name, const char *filename, const char *mime_type, enum AVMediaType type); /** - * Sends a nice hexadecimal dump of a buffer to the specified file stream. + * Send a nice hexadecimal dump of a buffer to the specified file stream. * * @param f The file stream pointer where the dump should be sent to. * @param buf buffer @@ -824,7 +824,7 @@ enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name, void av_hex_dump(FILE *f, uint8_t *buf, int size); /** - * Sends a nice hexadecimal dump of a buffer to the log. + * Send a nice hexadecimal dump of a buffer to the log. * * @param avcl A pointer to an arbitrary struct of which the first field is a * pointer to an AVClass struct. @@ -838,7 +838,7 @@ void av_hex_dump(FILE *f, uint8_t *buf, int size); void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size); /** - * Sends a nice dump of a packet to the specified file stream. + * Send a nice dump of a packet to the specified file stream. * * @param f The file stream pointer where the dump should be sent to. * @param pkt packet to dump @@ -847,7 +847,7 @@ void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size); void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload); /** - * Sends a nice dump of a packet to the log. + * Send a nice dump of a packet to the log. * * @param avcl A pointer to an arbitrary struct of which the first field is a * pointer to an AVClass struct. @@ -859,7 +859,7 @@ void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload); void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload); /** - * Initializes libavformat and registers all the muxers, demuxers and + * Initialize libavformat and register all the muxers, demuxers and * protocols. If you do not call this function, then you can select * exactly which formats you want to support. * @@ -870,7 +870,7 @@ void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload); void av_register_all(void); /** - * Gets the CodecID for the given codec tag tag. + * Get the CodecID for the given codec tag tag. * If no codec id is found returns CODEC_ID_NONE. * * @param tags list of supported codec_id-codec_tag pairs, as stored @@ -879,7 +879,7 @@ void av_register_all(void); enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag); /** - * Gets the codec tag for the given codec id id. + * Get the codec tag for the given codec id id. * If no codec tag is found returns 0. * * @param tags list of supported codec_id-codec_tag pairs, as stored @@ -890,12 +890,12 @@ unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecI /* media file input */ /** - * Finds AVInputFormat based on the short name of the input format. + * Find AVInputFormat based on the short name of the input format. */ AVInputFormat *av_find_input_format(const char *short_name); /** - * Guesses the file format. + * Guess the file format. * * @param is_opened Whether the file is already opened; determines whether * demuxers with or without AVFMT_NOFILE are probed. @@ -903,7 +903,7 @@ AVInputFormat *av_find_input_format(const char *short_name); AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened); /** - * Guesses the file format. + * Guess the file format. * * @param is_opened Whether the file is already opened; determines whether * demuxers with or without AVFMT_NOFILE are probed. @@ -916,7 +916,7 @@ AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened); AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max); /** - * Allocates all the structures needed to read an input stream. + * Allocate all the structures needed to read an input stream. * This does not open the needed codecs for decoding the stream[s]. */ int av_open_input_stream(AVFormatContext **ic_ptr, @@ -924,7 +924,7 @@ int av_open_input_stream(AVFormatContext **ic_ptr, AVInputFormat *fmt, AVFormatParameters *ap); /** - * Opens a media file as input. The codecs are not opened. Only the file + * Open a media file as input. The codecs are not opened. Only the file * header (if present) is read. * * @param ic_ptr The opened media file handle is put here. @@ -948,14 +948,14 @@ attribute_deprecated AVFormatContext *av_alloc_format_context(void); #endif /** - * Allocates an AVFormatContext. + * Allocate an AVFormatContext. * Can be freed with av_free() but do not forget to free everything you * explicitly allocated as well! */ AVFormatContext *avformat_alloc_context(void); /** - * Reads packets of a media file to get stream information. This + * Read packets of a media file to get stream information. This * is useful for file formats with no headers such as MPEG. This * function also computes the real framerate in case of MPEG-2 repeat * frame mode. @@ -970,7 +970,7 @@ AVFormatContext *avformat_alloc_context(void); int av_find_stream_info(AVFormatContext *ic); /** - * Reads a transport packet from a media file. + * Read a transport packet from a media file. * * This function is obsolete and should never be used. * Use av_read_frame() instead. @@ -982,7 +982,7 @@ int av_find_stream_info(AVFormatContext *ic); int av_read_packet(AVFormatContext *s, AVPacket *pkt); /** - * Returns the next frame of a stream. + * Return the next frame of a stream. * * The returned packet is valid * until the next av_read_frame() or until av_close_input_file() and @@ -1003,7 +1003,7 @@ int av_read_packet(AVFormatContext *s, AVPacket *pkt); int av_read_frame(AVFormatContext *s, AVPacket *pkt); /** - * Seeks to the keyframe at timestamp. + * Seek to the keyframe at timestamp. * 'timestamp' in 'stream_index'. * @param stream_index If stream_index is (-1), a default * stream is selected, and timestamp is automatically converted @@ -1017,7 +1017,7 @@ int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, int flags); /** - * Seeks to timestamp ts. + * Seek to timestamp ts. * Seeking will be done so that the point from which all active streams * can be presented successfully will be closest to ts and within min/max_ts. * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL. @@ -1045,33 +1045,33 @@ int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags); /** - * Starts playing a network-based stream (e.g. RTSP stream) at the + * Start playing a network-based stream (e.g. RTSP stream) at the * current position. */ int av_read_play(AVFormatContext *s); /** - * Pauses a network-based stream (e.g. RTSP stream). + * Pause a network-based stream (e.g. RTSP stream). * * Use av_read_play() to resume it. */ int av_read_pause(AVFormatContext *s); /** - * Frees a AVFormatContext allocated by av_open_input_stream. + * Free a AVFormatContext allocated by av_open_input_stream. * @param s context to free */ void av_close_input_stream(AVFormatContext *s); /** - * Closes a media file (but not its codecs). + * Close a media file (but not its codecs). * * @param s media file handle */ void av_close_input_file(AVFormatContext *s); /** - * Adds a new stream to a media file. + * Add a new stream to a media file. * * Can only be called in the read_header() function. If the flag * AVFMTCTX_NOHEADER is in the format context, then new streams @@ -1084,7 +1084,7 @@ AVStream *av_new_stream(AVFormatContext *s, int id); AVProgram *av_new_program(AVFormatContext *s, int id); /** - * Adds a new chapter. + * Add a new chapter. * This function is NOT part of the public API * and should ONLY be used by demuxers. * @@ -1100,7 +1100,7 @@ AVChapter *ff_new_chapter(AVFormatContext *s, int id, AVRational time_base, int64_t start, int64_t end, const char *title); /** - * Sets the pts for a given stream. + * Set the pts for a given stream. * * @param s stream * @param pts_wrap_bits number of bits effectively used by the pts @@ -1119,7 +1119,7 @@ void av_set_pts_info(AVStream *s, int pts_wrap_bits, int av_find_default_stream_index(AVFormatContext *s); /** - * Gets the index for a specific timestamp. + * Get the index for a specific timestamp. * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond * to the timestamp which is <= the requested one, if backward * is 0, then it will be >= @@ -1129,7 +1129,7 @@ int av_find_default_stream_index(AVFormatContext *s); int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags); /** - * Ensures the index uses less memory than the maximum specified in + * Ensure the index uses less memory than the maximum specified in * AVFormatContext.max_index_size by discarding entries if it grows * too large. * This function is not part of the public API and should only be called @@ -1138,7 +1138,7 @@ int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags); void ff_reduce_index(AVFormatContext *s, int stream_index); /** - * Adds an index entry into a sorted list. Updates the entry if the list + * Add an index entry into a sorted list. Update the entry if the list * already contains it. * * @param timestamp timestamp in the time base of the given stream @@ -1147,7 +1147,7 @@ int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp, int size, int distance, int flags); /** - * Does a binary search using av_index_search_timestamp() and + * Perform a binary search using av_index_search_timestamp() and * AVCodec.read_timestamp(). * This is not supposed to be called directly by a user application, * but by demuxers. @@ -1158,7 +1158,7 @@ int av_seek_frame_binary(AVFormatContext *s, int stream_index, int64_t target_ts, int flags); /** - * Updates cur_dts of all streams based on the given timestamp and AVStream. + * Update cur_dts of all streams based on the given timestamp and AVStream. * * Stream ref_st unchanged, others set cur_dts in their native time base. * Only needed for timestamp wrapping or if (dts not set and pts!=dts). @@ -1168,7 +1168,7 @@ int av_seek_frame_binary(AVFormatContext *s, int stream_index, void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp); /** - * Does a binary search using read_timestamp(). + * Perform a binary search using read_timestamp(). * This is not supposed to be called directly by a user application, * but by demuxers. * @param target_ts target timestamp in the time base of the given stream @@ -1211,7 +1211,7 @@ void av_url_split(char *proto, int proto_size, const char *url); /** - * Allocates the stream private data and writes the stream header to an + * Allocate the stream private data and write the stream header to an * output media file. * * @param s media file handle @@ -1220,7 +1220,7 @@ void av_url_split(char *proto, int proto_size, int av_write_header(AVFormatContext *s); /** - * Writes a packet to an output media file. + * Write a packet to an output media file. * * The packet shall contain one audio or video frame. * The packet must be correctly interleaved according to the container @@ -1234,7 +1234,7 @@ int av_write_header(AVFormatContext *s); int av_write_frame(AVFormatContext *s, AVPacket *pkt); /** - * Writes a packet to an output media file ensuring correct interleaving. + * Write a packet to an output media file ensuring correct interleaving. * * The packet must contain one audio or video frame. * If the packets are already correctly interleaved, the application should @@ -1251,7 +1251,7 @@ int av_write_frame(AVFormatContext *s, AVPacket *pkt); int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt); /** - * Interleaves a packet per dts in an output media file. + * Interleave a packet per dts in an output media file. * * Packets with pkt->destruct == av_destruct_packet will be freed inside this * function, so they cannot be used after it. Note that calling av_free_packet() @@ -1269,7 +1269,7 @@ int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out, AVPacket *pkt, int flush); /** - * Writes the stream trailer to an output media file and frees the + * Write the stream trailer to an output media file and free the * file private data. * * May only be called after a successful call to av_write_header. @@ -1286,14 +1286,14 @@ void dump_format(AVFormatContext *ic, #if LIBAVFORMAT_VERSION_MAJOR < 53 /** - * Parses width and height out of string str. + * Parse width and height out of string str. * @deprecated Use av_parse_video_frame_size instead. */ attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr, const char *str); /** - * Converts framerate from a string to a fraction. + * Convert framerate from a string to a fraction. * @deprecated Use av_parse_video_frame_rate instead. */ attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base, @@ -1301,7 +1301,7 @@ attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base, #endif /** - * Parses datestr and returns a corresponding number of microseconds. + * Parse datestr and return a corresponding number of microseconds. * @param datestr String representing a date or a duration. * - If a date the syntax is: * @code @@ -1312,7 +1312,7 @@ attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base, * interpreted as UTC. * If the year-month-day part is not specified it takes the current * year-month-day. - * Returns the number of microseconds since 1st of January, 1970 up to + * @return the number of microseconds since 1st of January, 1970 up to * the time of the parsed date or INT64_MIN if datestr cannot be * successfully parsed. * - If a duration the syntax is: @@ -1320,7 +1320,7 @@ attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base, * [-]HH[:MM[:SS[.m...]]] * [-]S+[.m...] * @endcode - * Returns the number of microseconds contained in a time interval + * @return the number of microseconds contained in a time interval * with the specified duration or INT64_MIN if datestr cannot be * successfully parsed. * @param duration Flag which tells how to interpret datestr, if @@ -1329,7 +1329,7 @@ attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base, */ int64_t parse_date(const char *datestr, int duration); -/** Gets the current time in microseconds. */ +/** Get the current time in microseconds. */ int64_t av_gettime(void); /* ffm-specific for ffserver */ @@ -1339,7 +1339,7 @@ int ffm_write_write_index(int fd, int64_t pos); void ffm_set_write_index(AVFormatContext *s, int64_t pos, int64_t file_size); /** - * Attempts to find a specific tag in a URL. + * Attempt to find a specific tag in a URL. * * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done. * Return 1 if found. @@ -1347,7 +1347,7 @@ void ffm_set_write_index(AVFormatContext *s, int64_t pos, int64_t file_size); int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info); /** - * Returns in 'buf' the path with '%d' replaced by a number. + * Return in 'buf' the path with '%d' replaced by a number. * * Also handles the '%0nd' format where 'n' is the total number * of digits and '%%'. @@ -1362,7 +1362,7 @@ int av_get_frame_filename(char *buf, int buf_size, const char *path, int number); /** - * Checks whether filename actually is a numbered sequence generator. + * Check whether filename actually is a numbered sequence generator. * * @param filename possible numbered sequence string * @return 1 if a valid numbered sequence string, 0 otherwise @@ -1370,7 +1370,7 @@ int av_get_frame_filename(char *buf, int buf_size, int av_filename_number_test(const char *filename); /** - * Generates an SDP for an RTP session. + * Generate an SDP for an RTP session. * * @param ac array of AVFormatContexts describing the RTP streams. If the * array is composed by only one context, such context can contain @@ -1386,7 +1386,7 @@ int av_filename_number_test(const char *filename); int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size); /** - * Returns a positive value if the given filename has one of the given + * Return a positive value if the given filename has one of the given * extensions, 0 otherwise. * * @param extensions a comma-separated list of filename extensions diff --git a/libavformat/avio.h b/libavformat/avio.h index f699a6eb98..dc8fdd6f7d 100644 --- a/libavformat/avio.h +++ b/libavformat/avio.h @@ -68,8 +68,8 @@ typedef struct URLPollEntry { typedef int URLInterruptCB(void); /** - * Creates an URLContext for accessing to the resource indicated by - * url, and opens it using the URLProtocol up. + * Create a URLContext for accessing to the resource indicated by + * url, and open it using the URLProtocol up. * * @param puc pointer to the location where, in case of success, the * function puts the pointer to the created URLContext @@ -82,8 +82,8 @@ int url_open_protocol (URLContext **puc, struct URLProtocol *up, const char *url, int flags); /** - * Creates an URLContext for accessing to the resource indicated by - * url, but doesn't initiate the connection yet. + * Create a URLContext for accessing to the resource indicated by + * url, but do not initiate the connection yet. * * @param puc pointer to the location where, in case of success, the * function puts the pointer to the created URLContext @@ -100,8 +100,8 @@ int url_alloc(URLContext **h, const char *url, int flags); int url_connect(URLContext *h); /** - * Creates an URLContext for accessing to the resource indicated by - * url, and opens it. + * Create an URLContext for accessing to the resource indicated by + * url, and open it. * * @param puc pointer to the location where, in case of success, the * function puts the pointer to the created URLContext @@ -113,7 +113,7 @@ int url_connect(URLContext *h); int url_open(URLContext **h, const char *url, int flags); /** - * Reads up to size bytes from the resource accessed by h, and stores + * Read up to size bytes from the resource accessed by h, and store * the read bytes in buf. * * @return The number of bytes actually read, or a negative value @@ -135,7 +135,7 @@ int url_read_complete(URLContext *h, unsigned char *buf, int size); int url_write(URLContext *h, const unsigned char *buf, int size); /** - * Changes the position that will be used by the next read/write + * Change the position that will be used by the next read/write * operation on the resource accessed by h. * * @param pos specifies the new position to set @@ -151,7 +151,7 @@ int url_write(URLContext *h, const unsigned char *buf, int size); int64_t url_seek(URLContext *h, int64_t pos, int whence); /** - * Closes the resource accessed by the URLContext h, and frees the + * Close the resource accessed by the URLContext h, and free the * memory used by it. * * @return a negative value if an error condition occurred, 0 @@ -160,7 +160,7 @@ int64_t url_seek(URLContext *h, int64_t pos, int whence); int url_close(URLContext *h); /** - * Returns a non-zero value if the resource indicated by url + * Return a non-zero value if the resource indicated by url * exists, 0 otherwise. */ int url_exist(const char *url); @@ -282,7 +282,7 @@ attribute_deprecated int av_register_protocol(URLProtocol *protocol); #endif /** - * Registers the URLProtocol protocol. + * Register the URLProtocol protocol. * * @param size the size of the URLProtocol struct referenced */ @@ -368,7 +368,7 @@ void url_fskip(ByteIOContext *s, int64_t offset); int64_t url_ftell(ByteIOContext *s); /** - * Gets the filesize. + * Get the filesize. * @return filesize or AVERROR */ int64_t url_fsize(ByteIOContext *s); @@ -404,13 +404,13 @@ void put_flush_packet(ByteIOContext *s); /** - * Reads size bytes from ByteIOContext into buf. + * Read size bytes from ByteIOContext into buf. * @return number of bytes read or AVERROR */ int get_buffer(ByteIOContext *s, unsigned char *buf, int size); /** - * Reads size bytes from ByteIOContext into buf. + * Read size bytes from ByteIOContext into buf. * This reads at most 1 packet. If that is not enough fewer bytes will be * returned. * @return number of bytes read or AVERROR @@ -439,7 +439,7 @@ static inline int url_is_streamed(ByteIOContext *s) } /** - * Creates and initializes a ByteIOContext for accessing the + * Create and initialize a ByteIOContext for accessing the * resource referenced by the URLContext h. * @note When the URLContext h has been opened in read+write mode, the * ByteIOContext can be used only for writing. @@ -462,7 +462,7 @@ int url_resetbuf(ByteIOContext *s, int flags); #endif /** - * Rewinds the ByteIOContext using the specified buffer containing the first buf_size bytes of the file. + * Rewind the ByteIOContext using the specified buffer containing the first buf_size bytes of the file. * Used after probing to avoid seeking. * Joins buf and s->buffer, taking any overlap into consideration. * @note s->buffer must overlap with buf or they can't be joined and the function fails @@ -477,7 +477,7 @@ int url_resetbuf(ByteIOContext *s, int flags); int ff_rewind_with_probe_data(ByteIOContext *s, unsigned char *buf, int buf_size); /** - * Creates and initializes a ByteIOContext for accessing the + * Create and initialize a ByteIOContext for accessing the * resource indicated by url. * @note When the resource indicated by url has been opened in * read+write mode, the ByteIOContext can be used only for writing. diff --git a/libavformat/avlanguage.h b/libavformat/avlanguage.h index eac0031455..7fb8968810 100644 --- a/libavformat/avlanguage.h +++ b/libavformat/avlanguage.h @@ -31,8 +31,8 @@ enum AVLangCodespace { }; /** - * Converts a language code to a target codespace. The source codespace is guessed. - * Returns NULL if the provided lang is null or invalid. + * Convert a language code to a target codespace. The source codespace is guessed. + * @return NULL if the provided lang is null or invalid. */ const char *av_convert_lang_to(const char *lang, enum AVLangCodespace target_codespace); diff --git a/libavformat/http.h b/libavformat/http.h index a0ae943b84..cd003bba8e 100644 --- a/libavformat/http.h +++ b/libavformat/http.h @@ -25,7 +25,7 @@ #include "avio.h" /** - * Sets custom HTTP headers. + * Set custom HTTP headers. * A trailing CRLF ("\r\n") is required for custom headers. * Passing in an empty header string ("\0") will reset to defaults. * @@ -43,7 +43,7 @@ void ff_http_set_headers(URLContext *h, const char *headers); /** - * Enables or disables chunked transfer encoding. (default is enabled) + * Enable or disable chunked transfer encoding. (default is enabled) * * @param h URL context for this HTTP connection * @param is_chunked 0 to disable chunking, nonzero otherwise. diff --git a/libavformat/id3v2.h b/libavformat/id3v2.h index 1f1530467e..ed6e450318 100644 --- a/libavformat/id3v2.h +++ b/libavformat/id3v2.h @@ -34,7 +34,7 @@ #define ID3v2_DEFAULT_MAGIC "ID3" /** - * Detects ID3v2 Header. + * Detect ID3v2 Header. * @buf must be ID3v2_HEADER_SIZE byte long * @magic magic bytes to identify the header, machine byte order. * If in doubt, use ID3v2_DEFAULT_MAGIC. @@ -42,7 +42,7 @@ int ff_id3v2_match(const uint8_t *buf, const char *magic); /** - * Gets the length of an ID3v2 tag. + * Get the length of an ID3v2 tag. * @buf must be ID3v2_HEADER_SIZE bytes long and point to the start of an * already detected ID3v2 tag */ diff --git a/libavformat/internal.h b/libavformat/internal.h index 2edc3306a7..6ff28d3fad 100644 --- a/libavformat/internal.h +++ b/libavformat/internal.h @@ -67,11 +67,11 @@ void ff_read_frame_flush(AVFormatContext *s); #define NTP_OFFSET 2208988800ULL #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL) -/** Gets the current time since NTP epoch in microseconds. */ +/** Get the current time since NTP epoch in microseconds. */ uint64_t ff_ntp_time(void); /** - * Probes a bytestream to determine the input format. Each time a probe returns + * Probe a bytestream to determine the input format. Each time a probe returns * with a score that is too low, the probe buffer size is increased and another * attempt is made. When the maximum probe size is reached, the input format * with the highest score is returned. @@ -102,7 +102,7 @@ void ff_url_split(char *proto, int proto_size, #endif /** - * Assembles a URL string from components. This is the reverse operation + * Assemble a URL string from components. This is the reverse operation * of av_url_split. * * Note, this requires networking to be initialized, so the caller must @@ -127,7 +127,7 @@ int ff_url_join(char *str, int size, const char *proto, int port, const char *fmt, ...); /** - * Appends the media-specific SDP fragment for the media stream c + * Append the media-specific SDP fragment for the media stream c * to the buffer buff. * * Note, the buffer needs to be initialized, since it is appended to diff --git a/libavformat/librtmp.c b/libavformat/librtmp.c index dd7640aaeb..be890ed210 100644 --- a/libavformat/librtmp.c +++ b/libavformat/librtmp.c @@ -55,7 +55,7 @@ static int rtmp_close(URLContext *s) } /** - * Opens RTMP connection and verifies that the stream can be played. + * Open RTMP connection and verify that the stream can be played. * * URL syntax: rtmp://server[:port][/app][/playpath][ keyword=value]... * where 'app' is first one or two directories in the path diff --git a/libavformat/matroskaenc.c b/libavformat/matroskaenc.c index 2238c13ffc..d906662b95 100644 --- a/libavformat/matroskaenc.c +++ b/libavformat/matroskaenc.c @@ -193,7 +193,7 @@ static void put_ebml_string(ByteIOContext *pb, unsigned int elementid, const cha } /** - * Writes a void element of a given size. Useful for reserving space in + * Write a void element of a given size. Useful for reserving space in * the file to be written to later. * * @param size The number of bytes to reserve, which must be at least 2. diff --git a/libavformat/mpeg.c b/libavformat/mpeg.c index 4d1db258d7..6fd0125f5d 100644 --- a/libavformat/mpeg.c +++ b/libavformat/mpeg.c @@ -196,7 +196,7 @@ static int find_prev_start_code(ByteIOContext *pb, int *size_ptr) #endif /** - * Extracts stream types from a program stream map + * Extract stream types from a program stream map * According to ISO/IEC 13818-1 ('MPEG-2 Systems') table 2-35 * * @return number of bytes occupied by PSM in the bitstream diff --git a/libavformat/mpegts.c b/libavformat/mpegts.c index 59603384d2..d9ee987e1d 100644 --- a/libavformat/mpegts.c +++ b/libavformat/mpegts.c @@ -239,7 +239,7 @@ static int discard_pid(MpegTSContext *ts, unsigned int pid) } /** - * Assembles PES packets out of TS packets, and then calls the "section_cb" + * Assemble PES packets out of TS packets, and then call the "section_cb" * function when they are complete. */ static void write_section_data(AVFormatContext *s, MpegTSFilter *tss1, diff --git a/libavformat/nutenc.c b/libavformat/nutenc.c index 061cd870d6..a11be96c0c 100644 --- a/libavformat/nutenc.c +++ b/libavformat/nutenc.c @@ -242,7 +242,7 @@ static void build_frame_code(AVFormatContext *s){ } /** - * Gets the length in bytes which is needed to store val as v. + * Get the length in bytes which is needed to store val as v. */ static int get_length(uint64_t val){ int i=1; @@ -269,7 +269,7 @@ static void put_tt(NUTContext *nut, StreamContext *nus, ByteIOContext *bc, uint6 } /** - * Stores a string as vb. + * Store a string as vb. */ static void put_str(ByteIOContext *bc, const char *string){ int len= strlen(string); diff --git a/libavformat/rtmppkt.h b/libavformat/rtmppkt.h index 23d4ebcd04..37e989101d 100644 --- a/libavformat/rtmppkt.h +++ b/libavformat/rtmppkt.h @@ -83,7 +83,7 @@ typedef struct RTMPPacket { } RTMPPacket; /** - * Creates new RTMP packet with given attributes. + * Create new RTMP packet with given attributes. * * @param pkt packet * @param channel_id packet channel ID @@ -96,14 +96,14 @@ int ff_rtmp_packet_create(RTMPPacket *pkt, int channel_id, RTMPPacketType type, int timestamp, int size); /** - * Frees RTMP packet. + * Free RTMP packet. * * @param pkt packet */ void ff_rtmp_packet_destroy(RTMPPacket *pkt); /** - * Reads RTMP packet sent by the server. + * Read RTMP packet sent by the server. * * @param h reader context * @param p packet @@ -116,7 +116,7 @@ int ff_rtmp_packet_read(URLContext *h, RTMPPacket *p, int chunk_size, RTMPPacket *prev_pkt); /** - * Sends RTMP packet to the server. + * Send RTMP packet to the server. * * @param h reader context * @param p packet to send @@ -129,7 +129,7 @@ int ff_rtmp_packet_write(URLContext *h, RTMPPacket *p, int chunk_size, RTMPPacket *prev_pkt); /** - * Prints information and contents of RTMP packet. + * Print information and contents of RTMP packet. * * @param h output context * @param p packet to dump @@ -143,7 +143,7 @@ void ff_rtmp_packet_dump(void *ctx, RTMPPacket *p); */ /** - * Calculates number of bytes taken by first AMF entry in data. + * Calculate number of bytes taken by first AMF entry in data. * * @param data input data * @param data_end input buffer end @@ -152,7 +152,7 @@ void ff_rtmp_packet_dump(void *ctx, RTMPPacket *p); int ff_amf_tag_size(const uint8_t *data, const uint8_t *data_end); /** - * Retrieves value of given AMF object field in string form. + * Retrieve value of given AMF object field in string form. * * @param data AMF object data * @param data_end input buffer end @@ -165,7 +165,7 @@ int ff_amf_get_field_value(const uint8_t *data, const uint8_t *data_end, const uint8_t *name, uint8_t *dst, int dst_size); /** - * Writes boolean value in AMF format to buffer. + * Write boolean value in AMF format to buffer. * * @param dst pointer to the input buffer (will be modified) * @param val value to write @@ -173,7 +173,7 @@ int ff_amf_get_field_value(const uint8_t *data, const uint8_t *data_end, void ff_amf_write_bool(uint8_t **dst, int val); /** - * Writes number in AMF format to buffer. + * Write number in AMF format to buffer. * * @param dst pointer to the input buffer (will be modified) * @param num value to write @@ -181,7 +181,7 @@ void ff_amf_write_bool(uint8_t **dst, int val); void ff_amf_write_number(uint8_t **dst, double num); /** - * Writes string in AMF format to buffer. + * Write string in AMF format to buffer. * * @param dst pointer to the input buffer (will be modified) * @param str string to write @@ -189,21 +189,21 @@ void ff_amf_write_number(uint8_t **dst, double num); void ff_amf_write_string(uint8_t **dst, const char *str); /** - * Writes AMF NULL value to buffer. + * Write AMF NULL value to buffer. * * @param dst pointer to the input buffer (will be modified) */ void ff_amf_write_null(uint8_t **dst); /** - * Writes marker for AMF object to buffer. + * Write marker for AMF object to buffer. * * @param dst pointer to the input buffer (will be modified) */ void ff_amf_write_object_start(uint8_t **dst); /** - * Writes string used as field name in AMF object to buffer. + * Write string used as field name in AMF object to buffer. * * @param dst pointer to the input buffer (will be modified) * @param str string to write @@ -211,7 +211,7 @@ void ff_amf_write_object_start(uint8_t **dst); void ff_amf_write_field_name(uint8_t **dst, const char *str); /** - * Writes marker for end of AMF object to buffer. + * Write marker for end of AMF object to buffer. * * @param dst pointer to the input buffer (will be modified) */ diff --git a/libavformat/rtmpproto.c b/libavformat/rtmpproto.c index a02bad5cf8..aca1fd3272 100644 --- a/libavformat/rtmpproto.c +++ b/libavformat/rtmpproto.c @@ -102,7 +102,7 @@ static const uint8_t rtmp_server_key[] = { }; /** - * Generates 'connect' call and sends it to the server. + * Generate 'connect' call and send it to the server. */ static void gen_connect(URLContext *s, RTMPContext *rt, const char *proto, const char *host, int port) @@ -154,7 +154,7 @@ static void gen_connect(URLContext *s, RTMPContext *rt, const char *proto, } /** - * Generates 'releaseStream' call and sends it to the server. It should make + * Generate 'releaseStream' call and send it to the server. It should make * the server release some channel for media streams. */ static void gen_release_stream(URLContext *s, RTMPContext *rt) @@ -177,7 +177,7 @@ static void gen_release_stream(URLContext *s, RTMPContext *rt) } /** - * Generates 'FCPublish' call and sends it to the server. It should make + * Generate 'FCPublish' call and send it to the server. It should make * the server preapare for receiving media streams. */ static void gen_fcpublish_stream(URLContext *s, RTMPContext *rt) @@ -200,7 +200,7 @@ static void gen_fcpublish_stream(URLContext *s, RTMPContext *rt) } /** - * Generates 'FCUnpublish' call and sends it to the server. It should make + * Generate 'FCUnpublish' call and send it to the server. It should make * the server destroy stream. */ static void gen_fcunpublish_stream(URLContext *s, RTMPContext *rt) @@ -223,7 +223,7 @@ static void gen_fcunpublish_stream(URLContext *s, RTMPContext *rt) } /** - * Generates 'createStream' call and sends it to the server. It should make + * Generate 'createStream' call and send it to the server. It should make * the server allocate some channel for media streams. */ static void gen_create_stream(URLContext *s, RTMPContext *rt) @@ -245,7 +245,7 @@ static void gen_create_stream(URLContext *s, RTMPContext *rt) /** - * Generates 'deleteStream' call and sends it to the server. It should make + * Generate 'deleteStream' call and send it to the server. It should make * the server remove some channel for media streams. */ static void gen_delete_stream(URLContext *s, RTMPContext *rt) @@ -267,7 +267,7 @@ static void gen_delete_stream(URLContext *s, RTMPContext *rt) } /** - * Generates 'play' call and sends it to the server, then pings the server + * Generate 'play' call and send it to the server, then ping the server * to start actual playing. */ static void gen_play(URLContext *s, RTMPContext *rt) @@ -302,7 +302,7 @@ static void gen_play(URLContext *s, RTMPContext *rt) } /** - * Generates 'publish' call and sends it to the server. + * Generate 'publish' call and send it to the server. */ static void gen_publish(URLContext *s, RTMPContext *rt) { @@ -326,7 +326,7 @@ static void gen_publish(URLContext *s, RTMPContext *rt) } /** - * Generates ping reply and sends it to the server. + * Generate ping reply and send it to the server. */ static void gen_pong(URLContext *s, RTMPContext *rt, RTMPPacket *ppkt) { @@ -342,7 +342,7 @@ static void gen_pong(URLContext *s, RTMPContext *rt, RTMPPacket *ppkt) } /** - * Generates report on bytes read so far and sends it to the server. + * Generate report on bytes read so far and send it to the server. */ static void gen_bytes_read(URLContext *s, RTMPContext *rt, uint32_t ts) { @@ -361,7 +361,7 @@ static void gen_bytes_read(URLContext *s, RTMPContext *rt, uint32_t ts) #define HMAC_OPAD_VAL 0x5C /** - * Calculates HMAC-SHA2 digest for RTMP handshake packets. + * Calculate HMAC-SHA2 digest for RTMP handshake packets. * * @param src input buffer * @param len input buffer length (should be 1536) @@ -410,7 +410,7 @@ static void rtmp_calc_digest(const uint8_t *src, int len, int gap, } /** - * Puts HMAC-SHA2 digest of packet data (except for the bytes where this digest + * Put HMAC-SHA2 digest of packet data (except for the bytes where this digest * will be stored) into that packet. * * @param buf handshake data (1536 bytes) @@ -431,7 +431,7 @@ static int rtmp_handshake_imprint_with_digest(uint8_t *buf) } /** - * Verifies that the received server response has the expected digest value. + * Verify that the received server response has the expected digest value. * * @param buf handshake data received from the server (1536 bytes) * @param off position to search digest offset from @@ -455,7 +455,7 @@ static int rtmp_validate_digest(uint8_t *buf, int off) } /** - * Performs handshake with the server by means of exchanging pseudorandom data + * Perform handshake with the server by means of exchanging pseudorandom data * signed with HMAC-SHA2 digest. * * @return 0 if handshake succeeds, negative value otherwise @@ -540,7 +540,7 @@ static int rtmp_handshake(URLContext *s, RTMPContext *rt) } /** - * Parses received packet and may perform some action depending on + * Parse received packet and possibly perform some action depending on * the packet contents. * @return 0 for no errors, negative values for serious errors which prevent * further communications, positive values for uncritical errors @@ -666,7 +666,7 @@ static int rtmp_parse_result(URLContext *s, RTMPContext *rt, RTMPPacket *pkt) } /** - * Interacts with the server by receiving and sending RTMP packets until + * Interact with the server by receiving and sending RTMP packets until * there is some significant data (media data or expected status notification). * * @param s reading context @@ -791,7 +791,7 @@ static int rtmp_close(URLContext *h) } /** - * Opens RTMP connection and verifies that the stream can be played. + * Open RTMP connection and verify that the stream can be played. * * URL syntax: rtmp://server[:port][/app][/playpath] * where 'app' is first one or two directories in the path diff --git a/libavformat/utils.c b/libavformat/utils.c index 4ab18bba1a..303e091c61 100644 --- a/libavformat/utils.c +++ b/libavformat/utils.c @@ -1745,7 +1745,7 @@ int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int /*******************************************************/ /** - * Returns TRUE if the stream has accurate duration in any stream. + * Return TRUE if the stream has accurate duration in any stream. * * @return TRUE if the stream has accurate duration for at least one component. */ @@ -2924,7 +2924,7 @@ int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out, AVPacket *pk } /** - * Interleaves an AVPacket correctly so it can be muxed. + * Interleave an AVPacket correctly so it can be muxed. * @param out the interleaved packet will be output here * @param in the input packet * @param flush 1 if no further packets are available as input and all diff --git a/libavformat/vorbiscomment.h b/libavformat/vorbiscomment.h index 714f1f2b96..fe989a0439 100644 --- a/libavformat/vorbiscomment.h +++ b/libavformat/vorbiscomment.h @@ -26,7 +26,7 @@ #include "metadata.h" /** - * Calculates the length in bytes of a VorbisComment. This is the minimum + * Calculate the length in bytes of a VorbisComment. This is the minimum * size required by ff_vorbiscomment_write(). * * @param m The metadata structure to be parsed. For no metadata, set to NULL. |