Update comment to version, negotiated with Diego, and

[ffmpeg] / cmdutils.h

diff --git a/cmdutils.h b/cmdutils.h
index bbc77e24207f05de04d8e0eb2af2f8fb56cdbe50..27d295fe81d15108eb8fc5d8ba78a217aff23159 100644 (file)
--- a/cmdutils.h
+++ b/cmdutils.h
@@ -19,8 +19,41 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
-#ifndef _CMD_UTILS_H
-#define _CMD_UTILS_H
+#ifndef FFMPEG_CMDUTILS_H
+#define FFMPEG_CMDUTILS_H
+
+#include <inttypes.h>
+
+/**
+ * Parses a string and returns its corresponding value as a double.
+ * Exits from the application if the string cannot be correctly
+ * parsed or the corresponding value is invalid.
+ *
+ * @param context the context of the value to be set (e.g. the
+ * corresponding commandline option name)
+ * @param numstr the string to be parsed
+ * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
+ * string should be parsed
+ * @param min the minimum valid accepted value
+ * @param max the maximum valid accepted value
+ */
+double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max);
+
+/**
+ * Parses a string specifying a time and returns its corresponding
+ * value as a number of microseconds. Exits from the application if
+ * the string cannot be correctly parsed.
+ *
+ * @param context the context of the value to be set (e.g. the
+ * corresponding commandline option name)
+ * @param timestr the string to be parsed
+ * @param is_duration a flag which tells how to interpret \p timestr, if
+ * not zero \p timestr is interpreted as a duration, otherwise as a
+ * date
+ *
+ * @see parse_date()
+ */
+int64_t parse_time_or_die(const char *context, const char *timestr, int is_duration);
 
 typedef struct {
     const char *name;
@@ -65,9 +98,26 @@ void parse_options(int argc, char **argv, const OptionDef *options,
 void print_error(const char *filename, int err);
 
 /**
- * Prints on stdout the license of the program, which depends on the license of
- * the compiled libav* libraries.
+ * Prints the program banner to stderr. The banner contents depend on the
+ * current version of the repository and of the libav* libraries used by
+ * the program.
+ * @param program_name name of the program
+ * @param program_birth_year year of birth of the program
+ */
+void show_banner(const char *program_name, int program_birth_year);
+
+/**
+ * Prints the version of the program to stdout. The version message
+ * depends on the current versions of the repository and of the libav*
+ * libraries.
+ * @param program_name name of the program
+ */
+void show_version(const char *program_name);
+
+/**
+ * Prints the license of the program to stdout. The license depends on
+ * the license of the libraries compiled into the program.
  */
 void show_license(void);
 
-#endif /* _CMD_UTILS_H */
+#endif /* FFMPEG_CMDUTILS_H */