[FFmpeg-soc] [soc]: r5217 - concat/libavformat/avplaylist.h
gkovacs
subversion at mplayerhq.hu
Sun Aug 23 23:55:47 CEST 2009
Author: gkovacs
Date: Sun Aug 23 23:55:47 2009
New Revision: 5217
Log:
remove redundant function declaration doxy comments
Modified:
concat/libavformat/avplaylist.h
Modified: concat/libavformat/avplaylist.h
==============================================================================
--- concat/libavformat/avplaylist.h Sun Aug 23 23:49:05 2009 (r5216)
+++ concat/libavformat/avplaylist.h Sun Aug 23 23:55:47 2009 (r5217)
@@ -48,43 +48,37 @@ typedef struct AVPlaylistContext {
int *nb_streams_list; /**< List of the number of streams in each playlist item*/
} AVPlaylistContext;
-/** @fn AVFormatContext *av_playlist_alloc_formatcontext(char *filename)
- * @brief Allocates and opens file, codecs, and streams associated with filename.
+/** @brief Allocates and opens file, codecs, and streams associated with filename.
* @param filename Null-terminated string of file to open.
* @return Returns an allocated AVFormatContext.
*/
AVFormatContext *av_playlist_alloc_formatcontext(char *filename);
-/** @fn void av_playlist_populate_context(AVPlaylistContext *ctx, int pe_curidx)
- * @brief Opens the playlist element with the specified index from the AVPlaylistContext.
+/** @brief Opens the playlist element with the specified index from the AVPlaylistContext.
* @param ctx AVPlaylistContext containing the desired playlist element.
* @param pe_curidx Index of the playlist element to be opened.
*/
void av_playlist_populate_context(AVPlaylistContext *ctx, int pe_curidx);
-/** @fn void av_playlist_set_streams(AVFormatContext *s)
- * @brief Sets the master concat-type demuxer's streams to those of its currently opened playlist element.
+/** @brief Sets the master concat-type demuxer's streams to those of its currently opened playlist element.
* @param s AVFormatContext of the concat-type demuxer, which contains the AVPlaylistContext and substreams.
*/
void av_playlist_set_streams(AVFormatContext *s);
-/** @fn av_playlist_formatcontext_from_filelist(const char **flist, int len)
- * @brief Allocates and populates a new AVFormatContext for a concat-type demuxer.
+/** @brief Allocates and populates a new AVFormatContext for a concat-type demuxer.
* @param flist List of filenames from which to construct the playlist.
* @param len Length of filename list.
* @return Returns NULL if failed, or AVFormatContext if succeeded.
*/
AVFormatContext *av_playlist_formatcontext_from_filelist(const char **flist, int len);
-/** @fn AVPlaylistContext* av_playlist_get_context(AVFormatContext *ic)
- * @brief Returns AVPlaylistContext continaed within a concat-type demuxer.
+/** @brief Returns AVPlaylistContext continaed within a concat-type demuxer.
* @param ic AVFormatContext of the concat-type demuxer, which contains the AVPlaylistContext.
* @return Returns NULL if failed (not concat-type demuxer or Playlist not yet allocated), or AVPlaylistContext if succeeded.
*/
AVPlaylistContext* av_playlist_get_context(AVFormatContext *ic);
-/** @fn void av_playlist_relative_paths(char **flist, int len, const char *workingdir)
- * @brief Converts a list of mixed relative or absolute paths into all absolute paths.
+/** @brief Converts a list of mixed relative or absolute paths into all absolute paths.
* @param flist List of null-terminated strings of relative or absolute paths.
* @param len Number of paths in flist.
* @param workingdir Path that strings in flist are relative to.
@@ -93,8 +87,7 @@ void av_playlist_relative_paths(char **f
int len,
const char *workingdir);
-/** @fn void av_playlist_split_encodedstring(char *s, char sep, char ***flist_ptr, int *len_ptr)
- * @brief Splits a character-delimited string into a list of strings.
+/** @brief Splits a character-delimited string into a list of strings.
* @param s The input character-delimited string ("one,two,three").
* @param sep The delimiter character (',').
* @param flist_ptr Pointer to string list which will be allocated by function.
@@ -105,39 +98,34 @@ void av_playlist_split_encodedstring(con
char ***flist_ptr,
int *len_ptr);
-/** @fn AVPlaylistContext *av_playlist_from_filelist(const char **flist, int len)
- * @brief Allocates and returns a AVPlaylistContext with playlist elements specified by a file list.
+/** @brief Allocates and returns a AVPlaylistContext with playlist elements specified by a file list.
* @param flist List of filenames from which to construct the playlist.
* @param len Length of filename list.
* @return Returns the allocated AVPlaylistContext.
*/
AVPlaylistContext *av_playlist_from_filelist(const char **flist, int len);
-/** @fn AVPlaylistContext *av_playlist_from_encodedstring(char *s, char sep)
- * @brief Allocates and returns a AVPlaylistContext with playlist elements specified by a character-delimited string.
+/** @brief Allocates and returns a AVPlaylistContext with playlist elements specified by a character-delimited string.
* @param s The input character-delimited string ("one,two,three").
* @param sep The delimiter character (',').
* @return Returns the allocated AVPlaylistContext.
*/
AVPlaylistContext *av_playlist_from_encodedstring(const char *s, const char sep);
-/** @fn void av_playlist_add_path(AVPlaylistContext *ctx, char *itempath)
- * @brief Adds PlayElem for item located at specified path to a AVPlaylistContext.
+/** @brief Adds PlayElem for item located at specified path to a AVPlaylistContext.
* @param ctx Pre-allocated AVPlaylistContext to add elements to.
* @param itempath Absolute path to item for which to add a playlist element.
*/
void av_playlist_add_path(AVPlaylistContext *ctx, const char *itempath);
-/** @fn int64_t av_playlist_time_offset(int64_t *durations, int pe_curidx)
- * @brief Calculates the total time offset of an element in a AVPlaylistContext in AV_TIME_BASE units.
+/** @brief Calculates the total time offset of an element in a AVPlaylistContext in AV_TIME_BASE units.
* @param durations Durations of playlist items in AV_TIME_BASE units, array must be of size greater than or equal to pe_curidx.
* @param pe_curidx Index of the playlist element for which to calculate the time offset.
* @return Returns the time offset in AV_TIME_BASE units.
*/
int64_t av_playlist_time_offset(const int64_t *durations, int pe_curidx);
-/** @fn int av_playlist_stream_index_from_time(AVPlaylistContext *ctx, int64_t pts, int64_t *localpts)
- * @brief Calculates the index of the playlist item which would contain the timestamp specified in AV_TIME_BASE units.
+/** @brief Calculates the index of the playlist item which would contain the timestamp specified in AV_TIME_BASE units.
* @param ctx AVPlaylistContext within which the list of playlist elements and durations are stored.
* @param pts Timestamp in AV_TIME_BASE.
* @param localpts Time in the local demuxer's timeframe in AV_TIME_BASE units; if null, not calculated.
@@ -147,24 +135,21 @@ int av_playlist_stream_index_from_time(A
int64_t pts,
int64_t *localpts);
-/** @fn int av_playlist_playidx_from_streamidx(AVPlaylistContext *ctx, int stream_index)
- * @brief Calculates the index of the playlist item which contains the specified stream index.
+/** @brief Calculates the index of the playlist item which contains the specified stream index.
* @param ctx AVPlaylistContext within which the list of playlist elements and durations are stored.
* @param stream_index Global stream index, the index of the stream within the playlist demuxer.
* @return Returns the index of the playlist item which contains the specified stream index.
*/
int av_playlist_playidx_from_streamidx(AVPlaylistContext *ctx, int stream_index);
-/** @fn int av_playlist_localstidx_from_streamidx(AVPlaylistContext *ctx, int stream_index)
- * @brief Calculates the local stream index which corresponds to a global stream index.
+/** @brief Calculates the local stream index which corresponds to a global stream index.
* @param ctx AVPlaylistContext within which the list of playlist elements and durations are stored.
* @param stream_index Global stream index, the index of the stream within the playlist demuxer.
* @return Returns the local stream index, the index of the stream within the child demuxer.
*/
int av_playlist_localstidx_from_streamidx(AVPlaylistContext *ctx, int stream_index);
-/** @fn int av_playlist_streams_offset_from_playidx(AVPlaylistContext *ctx, int playidx)
- * @brief Calculates the stream offset which corresponds to the given playlist item index.
+/** @brief Calculates the stream offset which corresponds to the given playlist item index.
* @param ctx AVPlaylistContext within which the list of playlist elements and durations are stored.
* @param playidx Playlist item index, the index of the child demuxer within ctx->icl.
* @return Returns the stream offset, which is global stream index - local stream index.
More information about the FFmpeg-soc
mailing list