--- libgig/trunk/man/wav2gig.1.in 2021/08/28 13:46:54 3989 +++ libgig/trunk/man/wav2gig.1.in 2021/08/30 20:14:15 3990 @@ -1,4 +1,4 @@ -.TH "wav2gig" "1" "03 Aug 2021" "libgig @VERSION@" "libgig tools" +.TH "wav2gig" "1" "30 Aug 2021" "libgig @VERSION@" "libgig tools" .SH NAME wav2gig \- Create GigaStudio (.gig) file from a set of WAV files. .SH SYNOPSIS @@ -10,8 +10,10 @@ samples. The created GigaStudio (.gig) file will contain the given input samples. The -samples' meta information like loop points are automatically extracted from the -input wave files and applied accordingly. +samples' meta information (as far as available) like root note +(a.k.a 'unity note'), fine tune, loop points, loop type and loop play count +are automatically extracted from the input wave (.wav) files and applied +accordingly. Additionally this tool creates exactly one instrument inside the newly created GigaStudio (.gig) file and tries to automatically map the samples in a @@ -21,8 +23,9 @@ for mapping the samples accordingly. See .BR SAMPLE .BR NAMES -below for details on the currently supported and assumed naming scheme for the -input sample files. +below for details on the assumed naming scheme for input sample files and how +to override that default naming scheme by providing custom regular expression +patterns. .SH OPTIONS .TP @@ -43,13 +46,52 @@ .TP .B \ -v Print version and exit. +.TP +.B \ --regex-name1 PATTERN +Regular expression for overriding the +.BR NAME1 +part of the input sample file name scheme. + +Defaults to '^([^-]+) - [^-]+ - [^-]+ - [^-]+ - [^.]+'. + +.TP +.B \ --regex-name2 PATTERN +Regular expression for overriding the +.BR NAME2 +part of the input sample file name scheme. + +Defaults to '^[^-]+ - ([^-]+) - [^-]+ - [^-]+ - [^.]+'. + +.TP +.B \ --regex-velocity-nr PATTERN +Regular expression for overriding the +.BR VELOCITY_NR +part of the input sample file name scheme. + +Defaults to '^[^-]+ - [^-]+ - ([^-]+) - [^-]+ - [^.]+'. + +.TP +.B \ --regex-note-nr PATTERN +Regular expression for overriding the +.BR NOTE_NR +part of the input sample file name scheme. + +Defaults to '^[^-]+ - [^-]+ - [^-]+ - ([^-]+) - [^.]+'. + +.TP +.B \ --regex-note-name PATTERN +Regular expression for overriding the +.BR NOTE_NAME +part of the input sample file name scheme. + +Defaults to '^[^-]+ - [^-]+ - [^-]+ - [^-]+ - ([^.]+)'. .SH SAMPLE NAMES -Right now this tool assumes the following sample naming scheme for being able to -automatically map samples to regions on the keyboard, as well as mapping them to -velocity splits adequately: +By default this tool assumes the following input sample file naming scheme for +automatically mapping samples to regions on the keyboard, as well as mapping +them to velocity splits adequately: -.B NAME1 - NAME2 - VELOCITY_NR - NOTE_NR - NOTE_NAME +.B 'NAME1 - NAME2 - VELOCITY_NR - NOTE_NR - NOTE_NAME.wav' Which are interpreted in the following way: @@ -60,18 +102,30 @@ This is not interpreted for sample mapping, but it will be used to assemble the final sample name inside the GigaStudio (.gig) file. +You may use +.BR --regex-name1 +to override this part of the naming scheme. + .TP .B \ NAME2 Secondary name of the sample (e.g. "Cresc"). This is currently ignored, but might be used in future. +You may use +.BR --regex-name2 +to override this part of the naming scheme. + .TP .B \ VELOCITY_NR MIDI Velocity number of the sample (e.g. "18"). This informtion will be used to automatically create velocity splits. +You may use +.BR --regex-velocity-nr +to override this part of the naming scheme. + .TP .B \ NOTE_NR MIDI Note number of the sample (e.g. "021" for note a-1). @@ -79,6 +133,10 @@ This informtion will be used to automatically map the sample to a region on the keyboard. +You may use +.BR --regex-note-nr +to override this part of the naming scheme. + .TP .B \ NOTE_NAME Note name of the sample (e.g. "a-1"). @@ -86,6 +144,10 @@ This is not interpreted for sample mapping, but it will be used to assemble the final sample name inside the GigaStudio (.gig) file. +You may use +.BR --regex-note-name +to override this part of the naming scheme. + .SH "SEE ALSO" .BR gig2mono(1), .BR gigextract(1),