[FFmpeg-devel] [PATCH] Do not leave positive values undefined when negative are defined as error
Michael Niedermayer
michaelni at gmx.at
Sun Sep 15 15:26:59 CEST 2013
Define positive return values as non errors and leave further meaning undefined
This allows future extensions to use these values
Signed-off-by: Michael Niedermayer <michaelni at gmx.at>
---
cmdutils.h | 2 +-
libavcodec/iff.c | 2 +-
libavcodec/wmaprodec.c | 2 +-
libavfilter/avcodec.h | 6 +++---
libavfilter/avfilter.h | 2 +-
libavfilter/avfiltergraph.c | 4 ++--
libavfilter/graphparser.c | 4 ++--
libavfilter/internal.h | 10 +++++-----
libavfilter/lavfutils.h | 2 +-
libavformat/avio.h | 4 ++--
libavformat/avio_internal.h | 4 ++--
libavformat/url.h | 4 ++--
libavutil/eval.h | 4 ++--
libavutil/parseutils.h | 2 +-
14 files changed, 26 insertions(+), 26 deletions(-)
diff --git a/cmdutils.h b/cmdutils.h
index 3af4476..a0707bd 100644
--- a/cmdutils.h
+++ b/cmdutils.h
@@ -498,7 +498,7 @@ int read_yesno(void);
* @param filename file to read from
* @param bufptr location where pointer to buffer is returned
* @param size location where size of buffer is returned
- * @return 0 in case of success, a negative value corresponding to an
+ * @return >=0 in case of success, a negative value corresponding to an
* AVERROR error code in case of failure.
*/
int cmdutils_read_file(const char *filename, char **bufptr, size_t *size);
diff --git a/libavcodec/iff.c b/libavcodec/iff.c
index ab2f172..9c894ef 100644
--- a/libavcodec/iff.c
+++ b/libavcodec/iff.c
@@ -184,7 +184,7 @@ static int cmap_read_palette(AVCodecContext *avctx, uint32_t *pal)
*
* @param avctx the AVCodecContext where to extract extra context to
* @param avpkt the AVPacket to extract extra context from or NULL to use avctx
- * @return 0 in case of success, a negative error code otherwise
+ * @return >=0 in case of success, a negative error code otherwise
*/
static int extract_header(AVCodecContext *const avctx,
const AVPacket *const avpkt) {
diff --git a/libavcodec/wmaprodec.c b/libavcodec/wmaprodec.c
index 4bd2d36..6014fe1 100644
--- a/libavcodec/wmaprodec.c
+++ b/libavcodec/wmaprodec.c
@@ -678,7 +678,7 @@ static void decode_decorrelation_matrix(WMAProDecodeCtx *s,
/**
*@brief Decode channel transformation parameters
*@param s codec context
- *@return 0 in case of success, < 0 in case of bitstream errors
+ *@return >=0 in case of success, < 0 in case of bitstream errors
*/
static int decode_channel_transform(WMAProDecodeCtx* s)
{
diff --git a/libavfilter/avcodec.h b/libavfilter/avcodec.h
index ae55df7..529821c 100644
--- a/libavfilter/avcodec.h
+++ b/libavfilter/avcodec.h
@@ -72,7 +72,7 @@ AVFilterBufferRef *avfilter_get_buffer_ref_from_frame(enum AVMediaType type,
*
* @param frame an already allocated AVFrame
* @param samplesref an audio buffer reference
- * @return 0 in case of success, a negative AVERROR code in case of
+ * @return >=0 in case of success, a negative AVERROR code in case of
* failure
* @deprecated Use avfilter_copy_buf_props() instead.
*/
@@ -85,7 +85,7 @@ int avfilter_fill_frame_from_audio_buffer_ref(AVFrame *frame,
*
* @param frame an already allocated AVFrame
* @param picref a video buffer reference
- * @return 0 in case of success, a negative AVERROR code in case of
+ * @return >=0 in case of success, a negative AVERROR code in case of
* failure
* @deprecated Use avfilter_copy_buf_props() instead.
*/
@@ -98,7 +98,7 @@ int avfilter_fill_frame_from_video_buffer_ref(AVFrame *frame,
*
* @param frame an already allocated AVFrame
* @param ref a video or audio buffer reference
- * @return 0 in case of success, a negative AVERROR code in case of
+ * @return >=0 in case of success, a negative AVERROR code in case of
* failure
* @deprecated Use avfilter_copy_buf_props() instead.
*/
diff --git a/libavfilter/avfilter.h b/libavfilter/avfilter.h
index b8d7cc3..c2c3010 100644
--- a/libavfilter/avfilter.h
+++ b/libavfilter/avfilter.h
@@ -1266,7 +1266,7 @@ enum {
*
* @param graphctx the filter graph
* @param log_ctx context used for logging
- * @return 0 in case of success, a negative AVERROR code otherwise
+ * @return >=0 in case of success, a negative AVERROR code otherwise
*/
int avfilter_graph_config(AVFilterGraph *graphctx, void *log_ctx);
diff --git a/libavfilter/avfiltergraph.c b/libavfilter/avfiltergraph.c
index fb78a87..06741c5 100644
--- a/libavfilter/avfiltergraph.c
+++ b/libavfilter/avfiltergraph.c
@@ -220,7 +220,7 @@ FF_ENABLE_DEPRECATION_WARNINGS
* A graph is considered valid if all its input and output pads are
* connected.
*
- * @return 0 in case of success, a negative value otherwise
+ * @return >=0 in case of success, a negative value otherwise
*/
static int graph_check_validity(AVFilterGraph *graph, AVClass *log_ctx)
{
@@ -258,7 +258,7 @@ static int graph_check_validity(AVFilterGraph *graph, AVClass *log_ctx)
/**
* Configure all the links of graphctx.
*
- * @return 0 in case of success, a negative value otherwise
+ * @return >=0 in case of success, a negative value otherwise
*/
static int graph_config_links(AVFilterGraph *graph, AVClass *log_ctx)
{
diff --git a/libavfilter/graphparser.c b/libavfilter/graphparser.c
index b1368d9..b61a682 100644
--- a/libavfilter/graphparser.c
+++ b/libavfilter/graphparser.c
@@ -89,7 +89,7 @@ static char *parse_link_name(const char **buf, void *log_ctx)
* @param filt_name the name of the filter to create
* @param args the arguments provided to the filter during its initialization
* @param log_ctx the log context to use
- * @return 0 in case of success, a negative AVERROR code otherwise
+ * @return >=0 in case of success, a negative AVERROR code otherwise
*/
static int create_filter(AVFilterContext **filt_ctx, AVFilterGraph *ctx, int index,
const char *filt_name, const char *args, void *log_ctx)
@@ -152,7 +152,7 @@ static int create_filter(AVFilterContext **filt_ctx, AVFilterGraph *ctx, int ind
* @param index an index which is assigned to the created filter
* instance, and which is supposed to be unique for each filter
* instance added to the filtergraph
- * @return 0 in case of success, a negative AVERROR code otherwise
+ * @return >=0 in case of success, a negative AVERROR code otherwise
*/
static int parse_filter(AVFilterContext **filt_ctx, const char **buf, AVFilterGraph *graph,
int index, void *log_ctx)
diff --git a/libavfilter/internal.h b/libavfilter/internal.h
index 1e8cd58..2fba406 100644
--- a/libavfilter/internal.h
+++ b/libavfilter/internal.h
@@ -171,7 +171,7 @@ int ff_fmt_is_in(int fmt, const int *fmts);
* @param ret pixel format pointer to where the value should be written
* @param arg string to parse
* @param log_ctx log context
- * @return 0 in case of success, a negative AVERROR code on error
+ * @return >=0 in case of success, a negative AVERROR code on error
*/
int ff_parse_pixel_format(enum AVPixelFormat *ret, const char *arg, void *log_ctx);
@@ -181,7 +181,7 @@ int ff_parse_pixel_format(enum AVPixelFormat *ret, const char *arg, void *log_ct
* @param ret unsigned integer pointer to where the value should be written
* @param arg string to parse
* @param log_ctx log context
- * @return 0 in case of success, a negative AVERROR code on error
+ * @return >=0 in case of success, a negative AVERROR code on error
*/
int ff_parse_sample_rate(int *ret, const char *arg, void *log_ctx);
@@ -191,7 +191,7 @@ int ff_parse_sample_rate(int *ret, const char *arg, void *log_ctx);
* @param ret unsigned AVRational pointer to where the value should be written
* @param arg string to parse
* @param log_ctx log context
- * @return 0 in case of success, a negative AVERROR code on error
+ * @return >=0 in case of success, a negative AVERROR code on error
*/
int ff_parse_time_base(AVRational *ret, const char *arg, void *log_ctx);
@@ -201,7 +201,7 @@ int ff_parse_time_base(AVRational *ret, const char *arg, void *log_ctx);
* @param ret integer pointer to where the value should be written
* @param arg string to parse
* @param log_ctx log context
- * @return 0 in case of success, a negative AVERROR code on error
+ * @return >=0 in case of success, a negative AVERROR code on error
*/
int ff_parse_sample_format(int *ret, const char *arg, void *log_ctx);
@@ -211,7 +211,7 @@ int ff_parse_sample_format(int *ret, const char *arg, void *log_ctx);
* @param ret 64bit integer pointer to where the value should be written.
* @param arg string to parse
* @param log_ctx log context
- * @return 0 in case of success, a negative AVERROR code on error
+ * @return >=0 in case of success, a negative AVERROR code on error
*/
int ff_parse_channel_layout(int64_t *ret, const char *arg, void *log_ctx);
diff --git a/libavfilter/lavfutils.h b/libavfilter/lavfutils.h
index a310e83..07a2f4c 100644
--- a/libavfilter/lavfutils.h
+++ b/libavfilter/lavfutils.h
@@ -34,7 +34,7 @@
* @param pix_fmt pointer to the pixel format of the loaded image
* @param filename the name of the image file to load
* @param log_ctx log context
- * @return 0 in case of success, a negative error code otherwise.
+ * @return >=0 in case of success, a negative error code otherwise.
*/
int ff_load_image(uint8_t *data[4], int linesize[4],
int *w, int *h, enum AVPixelFormat *pix_fmt,
diff --git a/libavformat/avio.h b/libavformat/avio.h
index 5bdbc62..0b1ecf7 100644
--- a/libavformat/avio.h
+++ b/libavformat/avio.h
@@ -368,7 +368,7 @@ int avio_get_str16be(AVIOContext *pb, int maxlen, char *buf, int buflen);
* In case of failure the pointed to value is set to NULL.
* @param flags flags which control how the resource indicated by url
* is to be opened
- * @return 0 in case of success, a negative value corresponding to an
+ * @return >=0 in case of success, a negative value corresponding to an
* AVERROR code in case of failure
*/
int avio_open(AVIOContext **s, const char *url, int flags);
@@ -387,7 +387,7 @@ int avio_open(AVIOContext **s, const char *url, int flags);
* @param options A dictionary filled with protocol-private options. On return
* this parameter will be destroyed and replaced with a dict containing options
* that were not found. May be NULL.
- * @return 0 in case of success, a negative value corresponding to an
+ * @return >=0 in case of success, a negative value corresponding to an
* AVERROR code in case of failure
*/
int avio_open2(AVIOContext **s, const char *url, int flags,
diff --git a/libavformat/avio_internal.h b/libavformat/avio_internal.h
index e67ba73..c73ebb0 100644
--- a/libavformat/avio_internal.h
+++ b/libavformat/avio_internal.h
@@ -78,7 +78,7 @@ static av_always_inline void ffio_wfourcc(AVIOContext *pb, const uint8_t *s)
* @param s The read-only AVIOContext to rewind
* @param buf The probe buffer containing the first buf_size bytes of the file
* @param buf_size The size of buf
- * @return 0 in case of success, a negative value corresponding to an
+ * @return >=0 in case of success, a negative value corresponding to an
* AVERROR code in case of failure
*/
int ffio_rewind_with_probe_data(AVIOContext *s, unsigned char **buf, int buf_size);
@@ -125,7 +125,7 @@ int ffio_open_dyn_packet_buf(AVIOContext **s, int max_packet_size);
*
* @param s Used to return the pointer to the created AVIOContext.
* In case of failure the pointed to value is set to NULL.
- * @return 0 in case of success, a negative value corresponding to an
+ * @return >=0 in case of success, a negative value corresponding to an
* AVERROR code in case of failure
*/
int ffio_fdopen(AVIOContext **s, URLContext *h);
diff --git a/libavformat/url.h b/libavformat/url.h
index 06dfda1..f590e39 100644
--- a/libavformat/url.h
+++ b/libavformat/url.h
@@ -101,7 +101,7 @@ typedef struct URLProtocol {
* is to be opened
* @param int_cb interrupt callback to use for the URLContext, may be
* NULL
- * @return 0 in case of success, a negative value corresponding to an
+ * @return >=0 in case of success, a negative value corresponding to an
* AVERROR code in case of failure
*/
int ffurl_alloc(URLContext **puc, const char *filename, int flags,
@@ -130,7 +130,7 @@ int ffurl_connect(URLContext *uc, AVDictionary **options);
* @param options A dictionary filled with protocol-private options. On return
* this parameter will be destroyed and replaced with a dict containing options
* that were not found. May be NULL.
- * @return 0 in case of success, a negative value corresponding to an
+ * @return >=0 in case of success, a negative value corresponding to an
* AVERROR code in case of failure
*/
int ffurl_open(URLContext **puc, const char *filename, int flags,
diff --git a/libavutil/eval.h b/libavutil/eval.h
index a1d1fe3..2210b42 100644
--- a/libavutil/eval.h
+++ b/libavutil/eval.h
@@ -45,7 +45,7 @@ typedef struct AVExpr AVExpr;
* @param funcs2 NULL terminated array of function pointers for functions which take 2 arguments
* @param opaque a pointer which will be passed to all functions from funcs1 and funcs2
* @param log_ctx parent logging context
- * @return 0 in case of success, a negative value corresponding to an
+ * @return >=0 in case of success, a negative value corresponding to an
* AVERROR code otherwise
*/
int av_expr_parse_and_eval(double *res, const char *s,
@@ -68,7 +68,7 @@ int av_expr_parse_and_eval(double *res, const char *s,
* @param func2_names NULL terminated array of zero terminated strings of funcs2 identifiers
* @param funcs2 NULL terminated array of function pointers for functions which take 2 arguments
* @param log_ctx parent logging context
- * @return 0 in case of success, a negative value corresponding to an
+ * @return >=0 in case of success, a negative value corresponding to an
* AVERROR code otherwise
*/
int av_expr_parse(AVExpr **expr, const char *s,
diff --git a/libavutil/parseutils.h b/libavutil/parseutils.h
index 3eb35fc..b5f8d81 100644
--- a/libavutil/parseutils.h
+++ b/libavutil/parseutils.h
@@ -127,7 +127,7 @@ int av_parse_color(uint8_t *rgba_color, const char *color_string, int slen,
* @endcode
* @param duration flag which tells how to interpret timestr, if not
* zero timestr is interpreted as a duration, otherwise as a date
- * @return 0 in case of success, a negative value corresponding to an
+ * @return >=0 in case of success, a negative value corresponding to an
* AVERROR code otherwise
*/
int av_parse_time(int64_t *timeval, const char *timestr, int duration);
--
1.7.9.5
More information about the ffmpeg-devel
mailing list