[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 "avformat.h"
#include "avdevice.h"
#include "cmdutils.h"
#include "avstring.h"
#include "version.h"
#include "config.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);
}

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