ref: f6a42c50c040196f3f830d3e51d405d5ae2b8982
dir: /src/sox.c/
/* * Sox - The Swiss Army Knife of Audio Manipulation. * * This is the main function for the command line sox program. * * July 5, 1991 * Copyright 1991 Lance Norskog And Sundry Contributors * This source code is freely redistributable and may be used for * any purpose. This copyright notice must be maintained. * Lance Norskog And Sundry Contributors are not responsible for * the consequences of using this software. * * Change History: * * June 1, 1998 - Chris Bagwell (cbagwell@sprynet.com) * Added patch to get volume working again. Based on patch sent from * Matija Nalis <mnalis@public.srce.hr>. * Added command line switches to force format to ADPCM or GSM. * * September 12, 1998 - Chris Bagwell (cbagwell@sprynet.com) * Reworked code that handled effects. Wasn't correctly draining * stereo effects and a few other problems. * Made command usage (-h) show supported effects and file formats. * (this is partially from a patch by Leigh Smith * leigh@psychokiller.dialix.oz.au). * */ #include "st.h" #include "version.h" #include "patchlvl.h" #include <stdio.h> #include <string.h> #include <stdlib.h> /* for malloc() */ #include <errno.h> #include <sys/types.h> /* for fstat() */ #include <sys/stat.h> /* for fstat() */ #ifdef unix #include <unistd.h> /* for unlink() */ #endif #ifdef HAVE_GETOPT_H #include <getopt.h> #else int getopt(P3(int,char **,char *)); #endif #ifdef VMS #include <perror.h> #define LASTCHAR ']' #else #define LASTCHAR '/' #endif /* * SOX main program. * * Rewrite for new nicer option syntax. July 13, 1991. * Rewrite for separate effects library. Sep. 15, 1991. * Incorporate Jimen Ching's fixes for real library operation: Aug 3, 1994. * Rewrite for multiple effects: Aug 24, 1994. */ #ifdef AMIGA /* This is the Amiga version string */ char amiversion[AmiVerSize]=AmiVerChars; #endif /* AMIGA */ int clipped = 0; /* Volume change clipping errors */ static LONG ibufl[BUFSIZ/2]; /* Left/right interleave buffers */ static LONG ibufr[BUFSIZ/2]; static LONG obufl[BUFSIZ/2]; static LONG obufr[BUFSIZ/2]; void init(); void doopts(P2(int, char **)); void usage(P1(char *)); int filetype(P1(int)); void process(); void statistics(); LONG volumechange(); void checkeffect(P1(eff_t)); int flow_effect(P1(int)); int drain_effect(P1(int)); struct soundstream informat, outformat; ft_t ft; #define MAXEFF 4 struct effect eff; struct effect efftab[MAXEFF]; /* table of left/mono channel effects */ struct effect efftabR[MAXEFF]; /* table of right channel effects */ /* efftab[0] is the input stream */ int neffects; /* # of effects */ char *ifile, *ofile, *itype, *otype; IMPORT char *optarg; IMPORT int optind; int main(argc, argv) int argc; char **argv; { myname = argv[0]; init(); ifile = ofile = NULL; /* Get input format options */ ft = &informat; doopts(argc, argv); /* Get input file */ if (optind >= argc) usage("No input file?"); ifile = argv[optind]; if (! strcmp(ifile, "-")) ft->fp = stdin; else if ((ft->fp = fopen(ifile, READBINARY)) == NULL) fail("Can't open input file '%s': %s", ifile, strerror(errno)); ft->filename = ifile; optind++; /* If more arguments are left then look for -e to see if */ /* no output file is used, then just do an effect */ if (optind < argc && strcmp(argv[optind], "-e")) writing = 1; else if (optind < argc) { writing = 0; optind++; /* Move passed -e */ } else writing = 1; /* No arguments left but let next check fail */ /* Get output format options */ ft = &outformat; doopts(argc, argv); if (writing) { /* Get output file */ if (optind >= argc) usage("No output file?"); ofile = argv[optind]; ft->filename = ofile; /* * There are two choices here: * 1) stomp the old file - normal shell "> file" behavior * 2) fail if the old file already exists - csh mode */ if (! strcmp(ofile, "-")) { ft->fp = stdout; /* stdout tends to be line-buffered. Override this */ /* to be Full Buffering. */ if (setvbuf (ft->fp,NULL,_IOFBF,sizeof(char)*BUFSIZ)) fail("Can't set write buffer"); } else { ft->fp = fopen(ofile, WRITEBINARY); if (ft->fp == NULL) fail("Can't open output file '%s': %s", ofile, strerror(errno)); /* stdout tends to be line-buffered. Override this */ /* to be Full Buffering. */ if (setvbuf (ft->fp,NULL,_IOFBF,sizeof(char)*BUFSIZ)) fail("Can't set write buffer"); } /* end of else != stdout */ /* Move passed filename */ optind++; } /* end if writing */ /* Get effect name */ if (optind < argc) { eff.name = argv[optind]; optind++; geteffect(&eff); (* eff.h->getopts)(&eff, argc - optind, &argv[optind]); } else { eff.name = "null"; geteffect(&eff); } /* Check global arguments */ if (volume <= 0.0) fail("Volume must be greater than 0.0"); #if defined(DUMB_FILESYSETM) informat.seekable = 0; outformat.seekable = 0; #else informat.seekable = (filetype(fileno(informat.fp)) == S_IFREG); outformat.seekable = (filetype(fileno(outformat.fp)) == S_IFREG); #endif /* If file types have not been set with -t, set from file names. */ if (! informat.filetype) { if ((informat.filetype = strrchr(ifile, LASTCHAR)) != NULL) informat.filetype++; else informat.filetype = ifile; if ((informat.filetype = strrchr(informat.filetype, '.')) != NULL) informat.filetype++; else /* Default to "auto" */ informat.filetype = "auto"; } if (writing && ! outformat.filetype) { if ((outformat.filetype = strrchr(ofile, LASTCHAR)) != NULL) outformat.filetype++; else outformat.filetype = ofile; if ((outformat.filetype = strrchr(outformat.filetype, '.')) != NULL) outformat.filetype++; } /* Default the input comment to the filename. * The output comment will be assigned when the informat * structure is copied to the outformat. */ informat.comment = informat.filename; process(); statistics(); return(0); } #ifdef HAVE_GETOPT_H char *getoptstr = "+r:v:t:c:phsuUAagbwlfdDxV"; #else char *getoptstr = "r:v:t:c:phsuUAagbwlfdDxV"; #endif void doopts(argc, argv) int argc; char **argv; { int c; char *str; while ((c = getopt(argc, argv, getoptstr)) != -1) { switch(c) { case 'p': soxpreview++; break; case 'h': usage((char *)0); /* no return from above */ case 't': if (! ft) usage("-t"); ft->filetype = optarg; if (ft->filetype[0] == '.') ft->filetype++; break; case 'r': if (! ft) usage("-r"); str = optarg; #ifdef __alpha__ if ((! sscanf(str, "%u", &ft->info.rate)) || (ft->info.rate <= 0)) #else if ((! sscanf(str, "%lu", &ft->info.rate)) || (ft->info.rate <= 0)) #endif fail("-r must be given a positive integer"); break; case 'v': if (! ft) usage("-v"); str = optarg; if ((! sscanf(str, "%e", &volume)) || (volume <= 0)) fail("Volume value '%s' is not a number", optarg); dovolume = 1; break; case 'c': if (! ft) usage("-c"); str = optarg; if (! sscanf(str, "%d", &ft->info.channels)) fail("-c must be given a number"); break; case 'b': if (! ft) usage("-b"); ft->info.size = BYTE; break; case 'w': if (! ft) usage("-w"); ft->info.size = WORD; break; case 'l': if (! ft) usage("-l"); ft->info.size = DWORD; break; case 'f': if (! ft) usage("-f"); ft->info.size = FLOAT; break; case 'd': if (! ft) usage("-d"); ft->info.size = DOUBLE; break; case 'D': if (! ft) usage("-D"); ft->info.size = IEEE; break; case 's': if (! ft) usage("-s"); ft->info.style = SIGN2; break; case 'u': if (! ft) usage("-u"); ft->info.style = UNSIGNED; break; case 'U': if (! ft) usage("-U"); ft->info.style = ULAW; break; case 'A': if (! ft) usage("-A"); ft->info.style = ALAW; break; case 'a': if (! ft) usage("-a"); ft->info.style = ADPCM; break; case 'g': if (! ft) usage("-g"); ft->info.style = GSM; break; case 'x': if (! ft) usage("-x"); ft->swap = 1; break; case 'V': verbose = 1; break; } } } void init() { /* init files */ informat.info.rate = outformat.info.rate = 0; informat.info.size = outformat.info.size = -1; informat.info.style = outformat.info.style = -1; informat.info.channels = outformat.info.channels = -1; informat.comment = outformat.comment = NULL; informat.swap = 0; informat.filetype = outformat.filetype = (char *) 0; informat.fp = stdin; outformat.fp = stdout; informat.filename = "input"; outformat.filename = "output"; } /* * Process input file -> effect table -> output file * one buffer at a time */ void process() { LONG i; int e, f, havedata; gettype(&informat); if (writing) gettype(&outformat); /* Read and write starters can change their formats. */ (* informat.h->startread)(&informat); checkformat(&informat); if (dovolume) report("Volume factor: %f\n", volume); report("Input file: using sample rate %lu\n\tsize %s, style %s, %d %s", informat.info.rate, sizes[informat.info.size], styles[informat.info.style], informat.info.channels, (informat.info.channels > 1) ? "channels" : "channel"); if (informat.comment) report("Input file: comment \"%s\"\n", informat.comment); /* need to check EFF_REPORT */ if (writing) { copyformat(&informat, &outformat); (* outformat.h->startwrite)(&outformat); checkformat(&outformat); cmpformats(&informat, &outformat); report("Output file: using sample rate %lu\n\tsize %s, style %s, %d %s", outformat.info.rate, sizes[outformat.info.size], styles[outformat.info.style], outformat.info.channels, (outformat.info.channels > 1) ? "channels" : "channel"); if (outformat.comment) report("Output file: comment \"%s\"\n", outformat.comment); } /* Very Important: * Effect fabrication and start is called AFTER files open. * Effect may write out data beforehand, and * some formats don't know their sample rate until now. */ /* inform effect about signal information */ eff.ininfo = informat.info; eff.outinfo = outformat.info; for(i = 0; i < 8; i++) { memcpy(&eff.loops[i], &informat.loops[i], sizeof(struct loopinfo)); } eff.instr = informat.instr; /* build efftab */ checkeffect(&eff); /* Start all effects */ for(e = 1; e < neffects; e++) { (* efftab[e].h->start)(&efftab[e]); if (efftabR[e].name) (* efftabR[e].h->start)(&efftabR[e]); } /* Reserve an output buffer for all effects */ for(e = 0; e < neffects; e++) { efftab[e].obuf = (LONG *) malloc(BUFSIZ * sizeof(LONG)); if (efftabR[e].name) efftabR[e].obuf = (LONG *) malloc(BUFSIZ * sizeof(LONG)); } /* Read initial chunk of input data. */ efftab[0].olen = (*informat.h->read)(&informat, efftab[0].obuf, (LONG) BUFSIZ); efftab[0].odone = 0; /* Change the volume of this initial input data if needed. */ if (dovolume) for (i = 0; i < efftab[0].olen; i++) efftab[0].obuf[i] = volumechange(efftab[0].obuf[i]); /* Run input data through effects and get more until olen == 0 */ while (efftab[0].olen > 0) { /* mark chain as empty */ for(e = 1; e < neffects; e++) efftab[e].odone = efftab[e].olen = 0; do { /* run entire chain BACKWARDS: pull, don't push.*/ /* this is because buffering system isn't a nice queueing system */ for(e = neffects - 1; e > 0; e--) if (flow_effect(e)) break; /* If outputing and output data was generated then write it */ if (writing&&(efftab[neffects-1].olen>efftab[neffects-1].odone)) { (* outformat.h->write)(&outformat, efftab[neffects-1].obuf, (LONG) efftab[neffects-1].olen); efftab[neffects-1].odone = efftab[neffects-1].olen; } /* if stuff still in pipeline, set up to flow effects again */ havedata = 0; for(e = 0; e < neffects - 1; e++) if (efftab[e].odone < efftab[e].olen) { havedata = 1; break; } } while (havedata); /* Read another chunk of input data. */ efftab[0].olen = (*informat.h->read)(&informat, efftab[0].obuf, (LONG) BUFSIZ); efftab[0].odone = 0; /* Change volume of these samples if needed. */ if (dovolume) for (i = 0; i < efftab[0].olen; i++) efftab[0].obuf[i] = volumechange(efftab[0].obuf[i]); } /* Drain the effects out first to last, * pushing residue through subsequent effects */ /* oh, what a tangled web we weave */ for(f = 1; f < neffects; f++) { while (1) { if (drain_effect(f) == 0) break; /* out of while (1) */ if (writing&&efftab[neffects-1].olen > 0) (* outformat.h->write)(&outformat, efftab[neffects-1].obuf, (LONG) efftab[neffects-1].olen); if (efftab[f].olen != BUFSIZ) break; } } /* Very Important: * Effect stop is called BEFORE files close. * Effect may write out more data after. */ for (e = 1; e < neffects; e++) { (* efftab[e].h->stop)(&efftab[e]); if (efftabR[e].name) (* efftabR[e].h->stop)(&efftabR[e]); } (* informat.h->stopread)(&informat); fclose(informat.fp); if (writing) (* outformat.h->stopwrite)(&outformat); if (writing) fclose(outformat.fp); } int flow_effect(e) int e; { LONG i, idone, odone, idonel, odonel, idoner, odoner; LONG *ibuf, *obuf; /* I have no input data ? */ if (efftab[e-1].odone == efftab[e-1].olen) return 0; if (! efftabR[e].name) { /* No stereo data, or effect can handle stereo data so * run effect over entire buffer. */ idone = efftab[e-1].olen - efftab[e-1].odone; odone = BUFSIZ; (* efftab[e].h->flow)(&efftab[e], &efftab[e-1].obuf[efftab[e-1].odone], efftab[e].obuf, &idone, &odone); efftab[e-1].odone += idone; efftab[e].odone = 0; efftab[e].olen = odone; } else { /* Put stereo data in two seperate buffers and run effect * on each of them. */ idone = efftab[e-1].olen - efftab[e-1].odone; odone = BUFSIZ; ibuf = &efftab[e-1].obuf[efftab[e-1].odone]; for(i = 0; i < idone; i += 2) { ibufl[i/2] = *ibuf++; ibufr[i/2] = *ibuf++; } /* left */ idonel = (idone + 1)/2; /* odd-length logic */ odonel = odone/2; (* efftab[e].h->flow)(&efftab[e], ibufl, obufl, &idonel, &odonel); /* right */ idoner = idone/2; /* odd-length logic */ odoner = odone/2; (* efftabR[e].h->flow)(&efftabR[e], ibufr, obufr, &idoner, &odoner); obuf = efftab[e].obuf; /* This loop implies left and right effect will always output * the same amount of data. */ for(i = 0; i < odoner; i++) { *obuf++ = obufl[i]; *obuf++ = obufr[i]; } efftab[e-1].odone += idonel + idoner; efftab[e].odone = 0; efftab[e].olen = odonel + odoner; } if (idone == 0) fail("Effect took no samples!"); return 1; } int drain_effect(e) int e; { LONG i, olen, olenl, olenr; LONG *obuf; if (! efftabR[e].name) { efftab[e].olen = BUFSIZ; (* efftab[e].h->drain)(&efftab[e],efftab[e].obuf, &efftab[e].olen); } else { olen = BUFSIZ; /* left */ olenl = olen/2; (* efftab[e].h->drain)(&efftab[e], obufl, &olenl); /* right */ olenr = olen/2; (* efftab[e].h->drain)(&efftabR[e], obufr, &olenr); obuf = efftab[e].obuf; /* This loop implies left and right effect will always output * the same amount of data. */ for(i = 0; i < olenr; i++) { *obuf++ = obufl[i]; *obuf++ = obufr[i]; } efftab[e].olen = olenl + olenr; } return(efftab[e].olen); } #define setin(eff, effname) \ {eff.name = effname; \ eff.ininfo.rate = informat.info.rate; \ eff.ininfo.channels = informat.info.channels; \ eff.outinfo.rate = informat.info.rate; \ eff.outinfo.channels = informat.info.channels;} #define setout(eff, effname) \ {eff.name = effname; \ eff.ininfo.rate = outformat.info.rate; \ eff.ininfo.channels = outformat.info.channels; \ eff.outinfo.rate = outformat.info.rate; \ eff.outinfo.channels = outformat.info.channels;} /* * If no effect given, decide what it should be. * Smart ruleset for multiple effects in sequence. * Puts user-specified effect in right place. */ void checkeffect(effp) eff_t effp; { int i, j; int needchan = 0, needrate = 0; /* if given effect does these, we don't need to add them */ needrate = (informat.info.rate != outformat.info.rate) && ! (effp->h->flags & EFF_RATE); needchan = (informat.info.channels != outformat.info.channels) && ! (effp->h->flags & EFF_MCHAN); neffects = 1; /* effect #0 is the input stream */ /* inform all effects about all relevant changes */ for(i = 0; i < MAXEFF; i++) { efftab[i].name = efftabR[i].name = (char *) 0; /* inform effect about signal information */ efftab[i].ininfo = informat.info; efftabR[i].ininfo = informat.info; efftab[i].outinfo = outformat.info; efftabR[i].outinfo = outformat.info; for(j = 0; j < 8; j++) { memcpy(&efftab[i].loops[j], &informat.loops[j], sizeof(struct loopinfo)); memcpy(&efftabR[i].loops[j], &informat.loops[j], sizeof(struct loopinfo)); } efftab[i].instr = informat.instr; efftabR[i].instr = informat.instr; } /* If not writing output, then just add the user specified effect. * This is to avoid channel and rate averaging since you don't have * a real output format. */ if (! writing) { neffects = 2; efftab[1].name = effp->name; if ((informat.info.channels == 2) && (! (effp->h->flags & EFF_MCHAN))) efftabR[1].name = effp->name; } else if (soxpreview) { /* to go faster, i suppose rate could come first if downsampling */ if (needchan && (informat.info.channels > outformat.info.channels)) { if (needrate) { neffects = 4; efftab[1].name = "avg"; efftab[2].name = "rate"; setout(efftab[3], effp->name); } else { neffects = 3; efftab[1].name = "avg"; setout(efftab[2], effp->name); } } else if (needchan && (informat.info.channels < outformat.info.channels)) { if (needrate) { neffects = 4; efftab[1].name = effp->name; efftab[1].outinfo.rate = informat.info.rate; efftab[1].outinfo.channels = informat.info.channels; efftab[2].name = "rate"; efftab[3].name = "avg"; } else { neffects = 3; efftab[1].name = effp->name; efftab[1].outinfo.channels = informat.info.channels; efftab[2].name = "avg"; } } else { if (needrate) { neffects = 3; efftab[1].name = effp->name; efftab[1].outinfo.rate = informat.info.rate; efftab[2].name = "rate"; if (informat.info.channels == 2) efftabR[2].name = "rate"; } else { neffects = 2; efftab[1].name = effp->name; } if ((informat.info.channels == 2) && (! (effp->h->flags & EFF_MCHAN))) efftabR[1].name = effp->name; } } else { /* not preview mode */ /* [ sum to mono,] [ then rate,] then effect */ /* not the purest, but much faster */ if (needchan && (informat.info.channels > outformat.info.channels)) { if (needrate && (informat.info.rate != outformat.info.rate)) { neffects = 4; efftab[1].name = "avg"; efftab[2].name = effp->name; efftab[2].outinfo.rate = informat.info.rate; efftab[2].outinfo.channels = informat.info.channels; efftab[3].name = "rate"; } else { neffects = 3; efftab[1].name = "avg"; efftab[2].name = effp->name; efftab[2].outinfo.rate = informat.info.rate; efftab[2].outinfo.channels = informat.info.channels; } } else if (needchan && (informat.info.channels < outformat.info.channels)) { if (needrate) { neffects = 4; efftab[1].name = effp->name; if (! (effp->h->flags & EFF_MCHAN)) efftabR[1].name = effp->name; efftab[1].outinfo.rate = informat.info.rate; efftab[1].outinfo.channels = informat.info.channels; efftab[2].name = "rate"; efftab[3].name = "avg"; } else { neffects = 3; efftab[1].name = effp->name; if (! (effp->h->flags & EFF_MCHAN)) efftabR[1].name = effp->name; efftab[1].outinfo.channels = informat.info.channels; efftab[2].name = "avg"; } } else { if (needrate) { neffects = 3; efftab[1].name = effp->name; efftab[1].outinfo.rate = informat.info.rate; efftab[2].name = "rate"; if (informat.info.channels == 2) efftabR[2].name = "rate"; } else { neffects = 2; efftab[1].name = effp->name; } if ((informat.info.channels == 2) && (! (effp->h->flags & EFF_MCHAN))) efftabR[1].name = effp->name; } } for(i = 1; i < neffects; i++) { /* pointer comparison OK here */ /* shallow copy of initialized effect data */ /* XXX this assumes that effect_getopt() doesn't malloc() */ if (efftab[i].name == effp->name) { memcpy(&efftab[i], &eff, sizeof(struct effect)); if (efftabR[i].name) memcpy(&efftabR[i], &eff, sizeof(struct effect)); } else { /* set up & give default opts for added effects */ geteffect(&efftab[i]); (* efftab[i].h->getopts)(&efftab[i],0,(char *)0); if (efftabR[i].name) memcpy(&efftabR[i], &efftab[i], sizeof(struct effect)); } } /* If a user doesn't specify an effect then a null entry could * have been placed in the middle of the list above. Remove * those entries here. */ for(i = 1; i < neffects; i++) if (! strcmp(efftab[i].name, "null")) { for(; i < neffects; i++) { efftab[i] = efftab[i+1]; efftabR[i] = efftabR[i+1]; } neffects--; } } /* Guido Van Rossum fix */ void statistics() { if (dovolume && clipped > 0) report("Volume change clipped %d samples", clipped); } LONG volumechange(y) LONG y; { double y1; y1 = y * volume; if (y1 < -2147483647.0) { y1 = -2147483647.0; clipped++; } else if (y1 > 2147483647.0) { y1 = 2147483647.0; clipped++; } return y1; } int filetype(fd) int fd; { struct stat st; fstat(fd, &st); return st.st_mode & S_IFMT; } char *usagestr = "[ gopts ] [ fopts ] ifile [ fopts ] ofile [ effect [ effopts ] ]"; void usage(opt) char *opt; { int i; fprintf(stderr, "%s: ", myname); if (verbose || !opt) fprintf(stderr, "%s\n\n", version()); fprintf(stderr, "Usage: %s\n\n", usagestr); if (opt) fprintf(stderr, "Failed at: %s\n", opt); else { fprintf(stderr,"gopts: -e -h -p -v volume -V\n\n"); fprintf(stderr,"fopts: -r rate -c channels -s/-u/-U/-A/-a/-g -b/-w/-l/-f/-d/-D -x\n\n"); fprintf(stderr, "effect: "); for (i = 1; effects[i].name != NULL; i++) { fprintf(stderr, "%s ", effects[i].name); } fprintf(stderr, "\n\neffopts: depends on effect\n\n"); fprintf(stderr, "Supported file formats: "); for (i = 0; formats[i].names != NULL; i++) { /* only print the first name */ fprintf(stderr, "%s ", formats[i].names[0]); } fputc('\n', stderr); } exit(1); } /* called from util.c:fail */ void cleanup() { /* Close the input file and outputfile before exiting*/ if (informat.fp) fclose(informat.fp); if (outformat.fp) { fclose(outformat.fp); /* remove the output file because we failed, if it's ours. */ /* Don't if its not a regular file. */ if (filetype(fileno(outformat.fp)) == S_IFREG) REMOVE(outformat.filename); } }