[libav.git] / cmdutils.c

/*
 * Various utilities for command line tools
 * Copyright (c) 2000-2003 Fabrice Bellard
 *
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * FFmpeg is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with FFmpeg; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

#include <string.h>
#include <stdlib.h>
#include <errno.h>
#include <math.h>

#include "config.h"
#include "avformat.h"
#include "avfilter.h"
#include "avdevice.h"
#include "cmdutils.h"
#include "avstring.h"
#include "version.h"

#undef exit


double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max)
{
    char *tail;
    const char *error;
    double d = strtod(numstr, &tail);
    if (*tail)
        error= "Expected number for %s but found: %s\n";
    else if (d < min || d > max)
        error= "The value for %s was %s which is not within %f - %f\n";
    else if(type == OPT_INT64 && (int64_t)d != d)
        error= "Expected int64 for %s but found %s\n";
    else
        return d;
    fprintf(stderr, error, context, numstr, min, max);
    exit(1);
}

int64_t parse_time_or_die(const char *context, const char *timestr, int is_duration)
{
    int64_t us = parse_date(timestr, is_duration);
    if (us == INT64_MIN) {
        fprintf(stderr, "Invalid %s specification for %s: %s\n",
                is_duration ? "duration" : "date", context, timestr);
        exit(1);
    }
    return us;
}

void show_help_options(const OptionDef *options, const char *msg, int mask, int value)
{
    const OptionDef *po;
    int first;

    first = 1;
    for(po = options; po->name != NULL; po++) {
        char buf[64];
        if ((po->flags & mask) == value) {
            if (first) {
                printf("%s", msg);
                first = 0;
            }
            av_strlcpy(buf, po->name, sizeof(buf));
            if (po->flags & HAS_ARG) {
                av_strlcat(buf, " ", sizeof(buf));
                av_strlcat(buf, po->argname, sizeof(buf));
            }
            printf("-%-17s  %s\n", buf, po->help);
        }
    }
}

static const OptionDef* find_option(const OptionDef *po, const char *name){
    while (po->name != NULL) {
        if (!strcmp(name, po->name))
            break;
        po++;
    }
    return po;
}

void parse_options(int argc, char **argv, const OptionDef *options,
                   void (* parse_arg_function)(const char*))
{
    const char *opt, *arg;
    int optindex, handleoptions=1;
    const OptionDef *po;

    /* parse options */
    optindex = 1;
    while (optindex < argc) {
        opt = argv[optindex++];

        if (handleoptions && opt[0] == '-' && opt[1] != '\0') {
          if (opt[1] == '-' && opt[2] == '\0') {
            handleoptions = 0;
            continue;
          }
            po= find_option(options, opt + 1);
            if (!po->name)
                po= find_option(options, "default");
            if (!po->name) {
unknown_opt:
                fprintf(stderr, "%s: unrecognized option '%s'\n", argv[0], opt);
                exit(1);
            }
            arg = NULL;
            if (po->flags & HAS_ARG) {
                arg = argv[optindex++];
                if (!arg) {
                    fprintf(stderr, "%s: missing argument for option '%s'\n", argv[0], opt);
                    exit(1);
                }
            }
            if (po->flags & OPT_STRING) {
                char *str;
                str = av_strdup(arg);
                *po->u.str_arg = str;
            } else if (po->flags & OPT_BOOL) {
                *po->u.int_arg = 1;
            } else if (po->flags & OPT_INT) {
                *po->u.int_arg = parse_number_or_die(opt+1, arg, OPT_INT64, INT_MIN, INT_MAX);
            } else if (po->flags & OPT_INT64) {
                *po->u.int64_arg = parse_number_or_die(opt+1, arg, OPT_INT64, INT64_MIN, INT64_MAX);
            } else if (po->flags & OPT_FLOAT) {
                *po->u.float_arg = parse_number_or_die(opt+1, arg, OPT_FLOAT, -1.0/0.0, 1.0/0.0);
            } else if (po->flags & OPT_FUNC2) {
                if(po->u.func2_arg(opt+1, arg)<0)
                    goto unknown_opt;
            } else {
                po->u.func_arg(arg);
            }
        } else {
            if (parse_arg_function)
                parse_arg_function(opt);
        }
    }
}

void print_error(const char *filename, int err)
{
    switch(err) {
    case AVERROR_NUMEXPECTED:
        fprintf(stderr, "%s: Incorrect image filename syntax.\n"
                "Use '%%d' to specify the image number:\n"
                "  for img1.jpg, img2.jpg, ..., use 'img%%d.jpg';\n"
                "  for img001.jpg, img002.jpg, ..., use 'img%%03d.jpg'.\n",
                filename);
        break;
    case AVERROR_INVALIDDATA:
        fprintf(stderr, "%s: Error while parsing header\n", filename);
        break;
    case AVERROR_NOFMT:
        fprintf(stderr, "%s: Unknown format\n", filename);
        break;
    case AVERROR(EIO):
        fprintf(stderr, "%s: I/O error occurred\n"
                "Usually that means that input file is truncated and/or corrupted.\n",
                filename);
        break;
    case AVERROR(ENOMEM):
        fprintf(stderr, "%s: memory allocation error occurred\n", filename);
        break;
    case AVERROR(ENOENT):
        fprintf(stderr, "%s: no such file or directory\n", filename);
        break;
    default:
        fprintf(stderr, "%s: Error while opening file\n", filename);
        break;
    }
}

void show_banner(const char *program_name, int program_birth_year)
{
    fprintf(stderr, "%s version " FFMPEG_VERSION ", Copyright (c) %d-2008 Fabrice Bellard, et al.\n",
            program_name, program_birth_year);
    fprintf(stderr, "  configuration: " FFMPEG_CONFIGURATION "\n");
    fprintf(stderr, "  libavutil version: " AV_STRINGIFY(LIBAVUTIL_VERSION) "\n");
    fprintf(stderr, "  libavcodec version: " AV_STRINGIFY(LIBAVCODEC_VERSION) "\n");
    fprintf(stderr, "  libavformat version: " AV_STRINGIFY(LIBAVFORMAT_VERSION) "\n");
    fprintf(stderr, "  libavdevice version: " AV_STRINGIFY(LIBAVDEVICE_VERSION) "\n");
#if ENABLE_AVFILTER
    fprintf(stderr, "  libavfilter version: " AV_STRINGIFY(LIBAVFILTER_VERSION) "\n");
#endif
    fprintf(stderr, "  built on " __DATE__ " " __TIME__);
#ifdef __GNUC__
    fprintf(stderr, ", gcc: " __VERSION__ "\n");
#else
    fprintf(stderr, ", using a non-gcc compiler\n");
#endif
}

void show_version(const char *program_name) {
     /* TODO: add function interface to avutil and avformat avdevice*/
    printf("%s " FFMPEG_VERSION "\n", program_name);
    printf("libavutil   %d\n"
           "libavcodec  %d\n"
           "libavformat %d\n"
           "libavdevice %d\n",
           LIBAVUTIL_BUILD, avcodec_build(), LIBAVFORMAT_BUILD, LIBAVDEVICE_BUILD);
}

void show_license(void)
{
#ifdef CONFIG_NONFREE
    printf(
    "This version of FFmpeg has nonfree parts compiled in.\n"
    "Therefore it is not legally redistributable.\n"
    );
#elif CONFIG_GPL
    printf(
    "FFmpeg is free software; you can redistribute it and/or modify\n"
    "it under the terms of the GNU General Public License as published by\n"
    "the Free Software Foundation; either version 2 of the License, or\n"
    "(at your option) any later version.\n"
    "\n"
    "FFmpeg is distributed in the hope that it will be useful,\n"
    "but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
    "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n"
    "GNU General Public License for more details.\n"
    "\n"
    "You should have received a copy of the GNU General Public License\n"
    "along with FFmpeg; if not, write to the Free Software\n"
    "Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n"
    );
#else
    printf(
    "FFmpeg is free software; you can redistribute it and/or\n"
    "modify it under the terms of the GNU Lesser General Public\n"
    "License as published by the Free Software Foundation; either\n"
    "version 2.1 of the License, or (at your option) any later version.\n"
    "\n"
    "FFmpeg is distributed in the hope that it will be useful,\n"
    "but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
    "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU\n"
    "Lesser General Public License for more details.\n"
    "\n"
    "You should have received a copy of the GNU Lesser General Public\n"
    "License along with FFmpeg; if not, write to the Free Software\n"
    "Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n"
    );
#endif
}
Commit	Line	Data
01310af2 FB	1	/*
	2	* Various utilities for command line tools
	3	* Copyright (c) 2000-2003 Fabrice Bellard
	4	*
b78e7197 DB	5	* This file is part of FFmpeg.
	6	*
	7	* FFmpeg is free software; you can redistribute it and/or
01310af2 FB	8	* modify it under the terms of the GNU Lesser General Public
01310af2 FB	9	* License as published by the Free Software Foundation; either
b78e7197	10	* version 2.1 of the License, or (at your option) any later version.
01310af2	11	*
b78e7197	12	* FFmpeg is distributed in the hope that it will be useful,
01310af2 FB	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	15	* Lesser General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU Lesser General Public
b78e7197	18	* License along with FFmpeg; if not, write to the Free Software
5509bffa	19	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
01310af2	20	*/
364a9607	21
0f4e8165 RB	22	#include <string.h>
	23	#include <stdlib.h>
	24	#include <errno.h>
7c84b8bc	25	#include <math.h>
0f4e8165	26
63d026b1	27	#include "config.h"
01310af2	28	#include "avformat.h"
ab4b28f0	29	#include "avfilter.h"
2208741a	30	#include "avdevice.h"
01310af2	31	#include "cmdutils.h"
f7d78f36	32	#include "avstring.h"
86074ed1	33	#include "version.h"
01310af2	34
c367d067 MN	35	#undef exit
c367d067 MN	36
086ab001 MN	37
	38	double parse_number_or_die(const char context, const char numstr, int type, double min, double max)
	39	{
	40	char *tail;
	41	const char *error;
	42	double d = strtod(numstr, &tail);
	43	if (*tail)
	44	error= "Expected number for %s but found: %s\n";
	45	else if (d < min \|\| d > max)
	46	error= "The value for %s was %s which is not within %f - %f\n";
	47	else if(type == OPT_INT64 && (int64_t)d != d)
	48	error= "Expected int64 for %s but found %s\n";
	49	else
	50	return d;
	51	fprintf(stderr, error, context, numstr, min, max);
	52	exit(1);
	53	}
	54
7542157d SS	55	int64_t parse_time_or_die(const char context, const char timestr, int is_duration)
	56	{
	57	int64_t us = parse_date(timestr, is_duration);
	58	if (us == INT64_MIN) {
	59	fprintf(stderr, "Invalid %s specification for %s: %s\n",
	60	is_duration ? "duration" : "date", context, timestr);
	61	exit(1);
	62	}
	63	return us;
	64	}
	65
02d504a7	66	void show_help_options(const OptionDef options, const char msg, int mask, int value)
01310af2 FB	67	{
01310af2 FB	68	const OptionDef *po;
02d504a7	69	int first;
01310af2	70
02d504a7 FB	71	first = 1;
	72	for(po = options; po->name != NULL; po++) {
	73	char buf[64];
	74	if ((po->flags & mask) == value) {
	75	if (first) {
	76	printf("%s", msg);
	77	first = 0;
	78	}
f7d78f36	79	av_strlcpy(buf, po->name, sizeof(buf));
02d504a7	80	if (po->flags & HAS_ARG) {
f7d78f36 MR	81	av_strlcat(buf, " ", sizeof(buf));
f7d78f36 MR	82	av_strlcat(buf, po->argname, sizeof(buf));
01310af2	83	}
02d504a7	84	printf("-%-17s %s\n", buf, po->help);
01310af2 FB	85	}
	86	}
	87	}
	88
fccfc475	89	static const OptionDef* find_option(const OptionDef po, const char name){
8bbf6db9 MN	90	while (po->name != NULL) {
	91	if (!strcmp(name, po->name))
	92	break;
	93	po++;
	94	}
	95	return po;
	96	}
	97
60a9966e SS	98	void parse_options(int argc, char *argv, const OptionDef options,
60a9966e SS	99	void (* parse_arg_function)(const char*))
01310af2 FB	100	{
01310af2 FB	101	const char opt, arg;
b0d7bc1e	102	int optindex, handleoptions=1;
01310af2 FB	103	const OptionDef *po;
	104
	105	/* parse options */
	106	optindex = 1;
	107	while (optindex < argc) {
	108	opt = argv[optindex++];
115329f1	109
84bf226b TL	110	if (handleoptions && opt[0] == '-' && opt[1] != '\0') {
	111	if (opt[1] == '-' && opt[2] == '\0') {
	112	handleoptions = 0;
	113	continue;
	114	}
8bbf6db9 MN	115	po= find_option(options, opt + 1);
	116	if (!po->name)
	117	po= find_option(options, "default");
01310af2	118	if (!po->name) {
8bbf6db9	119	unknown_opt:
01310af2 FB	120	fprintf(stderr, "%s: unrecognized option '%s'\n", argv[0], opt);
	121	exit(1);
	122	}
	123	arg = NULL;
	124	if (po->flags & HAS_ARG) {
	125	arg = argv[optindex++];
	126	if (!arg) {
	127	fprintf(stderr, "%s: missing argument for option '%s'\n", argv[0], opt);
	128	exit(1);
	129	}
	130	}
	131	if (po->flags & OPT_STRING) {
	132	char *str;
02d504a7	133	str = av_strdup(arg);
01310af2 FB	134	*po->u.str_arg = str;
	135	} else if (po->flags & OPT_BOOL) {
	136	*po->u.int_arg = 1;
26d4f26b	137	} else if (po->flags & OPT_INT) {
7c84b8bc	138	*po->u.int_arg = parse_number_or_die(opt+1, arg, OPT_INT64, INT_MIN, INT_MAX);
ffdf9a1f	139	} else if (po->flags & OPT_INT64) {
7c84b8bc	140	*po->u.int64_arg = parse_number_or_die(opt+1, arg, OPT_INT64, INT64_MIN, INT64_MAX);
1f631450	141	} else if (po->flags & OPT_FLOAT) {
1f3d74d3	142	*po->u.float_arg = parse_number_or_die(opt+1, arg, OPT_FLOAT, -1.0/0.0, 1.0/0.0);
8bbf6db9 MN	143	} else if (po->flags & OPT_FUNC2) {
	144	if(po->u.func2_arg(opt+1, arg)<0)
	145	goto unknown_opt;
01310af2	146	} else {
bb270c08	147	po->u.func_arg(arg);
01310af2 FB	148	}
01310af2 FB	149	} else {
60a9966e SS	150	if (parse_arg_function)
60a9966e SS	151	parse_arg_function(opt);
01310af2 FB	152	}
	153	}
	154	}
	155
	156	void print_error(const char *filename, int err)
	157	{
	158	switch(err) {
	159	case AVERROR_NUMEXPECTED:
	160	fprintf(stderr, "%s: Incorrect image filename syntax.\n"
	161	"Use '%%d' to specify the image number:\n"
	162	" for img1.jpg, img2.jpg, ..., use 'img%%d.jpg';\n"
115329f1	163	" for img001.jpg, img002.jpg, ..., use 'img%%03d.jpg'.\n",
01310af2 FB	164	filename);
	165	break;
	166	case AVERROR_INVALIDDATA:
	167	fprintf(stderr, "%s: Error while parsing header\n", filename);
	168	break;
	169	case AVERROR_NOFMT:
	170	fprintf(stderr, "%s: Unknown format\n", filename);
	171	break;
6f3e0b21	172	case AVERROR(EIO):
d9526386	173	fprintf(stderr, "%s: I/O error occurred\n"
bb270c08 DB	174	"Usually that means that input file is truncated and/or corrupted.\n",
bb270c08 DB	175	filename);
45ce5ddb	176	break;
769e10f0	177	case AVERROR(ENOMEM):
d9526386	178	fprintf(stderr, "%s: memory allocation error occurred\n", filename);
45ce5ddb	179	break;
24fddf48	180	case AVERROR(ENOENT):
0ba0c8de BF	181	fprintf(stderr, "%s: no such file or directory\n", filename);
0ba0c8de BF	182	break;
01310af2 FB	183	default:
	184	fprintf(stderr, "%s: Error while opening file\n", filename);
	185	break;
	186	}
	187	}
f35917b2	188
86074ed1 SS	189	void show_banner(const char *program_name, int program_birth_year)
86074ed1 SS	190	{
69c12fbb	191	fprintf(stderr, "%s version " FFMPEG_VERSION ", Copyright (c) %d-2008 Fabrice Bellard, et al.\n",
86074ed1 SS	192	program_name, program_birth_year);
	193	fprintf(stderr, " configuration: " FFMPEG_CONFIGURATION "\n");
	194	fprintf(stderr, " libavutil version: " AV_STRINGIFY(LIBAVUTIL_VERSION) "\n");
	195	fprintf(stderr, " libavcodec version: " AV_STRINGIFY(LIBAVCODEC_VERSION) "\n");
	196	fprintf(stderr, " libavformat version: " AV_STRINGIFY(LIBAVFORMAT_VERSION) "\n");
2208741a	197	fprintf(stderr, " libavdevice version: " AV_STRINGIFY(LIBAVDEVICE_VERSION) "\n");
ab4b28f0 VS	198	#if ENABLE_AVFILTER
	199	fprintf(stderr, " libavfilter version: " AV_STRINGIFY(LIBAVFILTER_VERSION) "\n");
	200	#endif
86074ed1 SS	201	fprintf(stderr, " built on " __DATE__ " " __TIME__);
	202	#ifdef __GNUC__
	203	fprintf(stderr, ", gcc: " __VERSION__ "\n");
	204	#else
	205	fprintf(stderr, ", using a non-gcc compiler\n");
	206	#endif
	207	}
	208
	209	void show_version(const char *program_name) {
2208741a	210	/* TODO: add function interface to avutil and avformat avdevice*/
86074ed1 SS	211	printf("%s " FFMPEG_VERSION "\n", program_name);
	212	printf("libavutil %d\n"
	213	"libavcodec %d\n"
2208741a MN	214	"libavformat %d\n"
	215	"libavdevice %d\n",
	216	LIBAVUTIL_BUILD, avcodec_build(), LIBAVFORMAT_BUILD, LIBAVDEVICE_BUILD);
86074ed1 SS	217	}
86074ed1 SS	218
f35917b2 SS	219	void show_license(void)
f35917b2 SS	220	{
7ead693b DB	221	#ifdef CONFIG_NONFREE
	222	printf(
	223	"This version of FFmpeg has nonfree parts compiled in.\n"
	224	"Therefore it is not legally redistributable.\n"
	225	);
	226	#elif CONFIG_GPL
f35917b2 SS	227	printf(
	228	"FFmpeg is free software; you can redistribute it and/or modify\n"
	229	"it under the terms of the GNU General Public License as published by\n"
	230	"the Free Software Foundation; either version 2 of the License, or\n"
	231	"(at your option) any later version.\n"
	232	"\n"
	233	"FFmpeg is distributed in the hope that it will be useful,\n"
	234	"but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
	235	"MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n"
	236	"GNU General Public License for more details.\n"
	237	"\n"
	238	"You should have received a copy of the GNU General Public License\n"
	239	"along with FFmpeg; if not, write to the Free Software\n"
	240	"Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n"
	241	);
	242	#else
	243	printf(
	244	"FFmpeg is free software; you can redistribute it and/or\n"
	245	"modify it under the terms of the GNU Lesser General Public\n"
	246	"License as published by the Free Software Foundation; either\n"
	247	"version 2.1 of the License, or (at your option) any later version.\n"
	248	"\n"
	249	"FFmpeg is distributed in the hope that it will be useful,\n"
	250	"but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
	251	"MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n"
	252	"Lesser General Public License for more details.\n"
	253	"\n"
	254	"You should have received a copy of the GNU Lesser General Public\n"
	255	"License along with FFmpeg; if not, write to the Free Software\n"
	256	"Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n"
	257	);
	258	#endif
	259	}