/[svn]/libgig/trunk/man/wav2gig.1.in
ViewVC logotype

Diff of /libgig/trunk/man/wav2gig.1.in

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 3991 by schoenebeck, Tue Aug 31 15:58:57 2021 UTC revision 3995 by schoenebeck, Fri Sep 3 15:06:10 2021 UTC
# Line 1  Line 1 
1  .TH "wav2gig" "1" "30 Aug 2021" "libgig @VERSION@" "libgig tools"  .TH "wav2gig" "1" "03 Sep 2021" "libgig @VERSION@" "libgig tools"
2  .SH NAME  .SH NAME
3  wav2gig \- Create GigaStudio (.gig) file from a set of WAV files.  wav2gig \- Create GigaStudio (.gig) file from a set of WAV files.
4  .SH SYNOPSIS  .SH SYNOPSIS
# Line 19  Additionally this tool creates exactly o Line 19  Additionally this tool creates exactly o
19  GigaStudio (.gig) file and tries to automatically map the samples in a  GigaStudio (.gig) file and tries to automatically map the samples in a
20  meaningful way to that instrument. As the wave (.wav) format currently does not  meaningful way to that instrument. As the wave (.wav) format currently does not
21  support many of the meta information required for this particular task, this  support many of the meta information required for this particular task, this
22  tool tries to guess the required information from the individual sample's name  tool tries to extract the required (missing) information from the individual
23  for mapping the samples accordingly. See  sample's file name for being able to map the samples accordingly. See
24  .BR SAMPLE  .BR SAMPLE
25  .BR NAMES  .BR NAMES
26  below for details on the assumed naming scheme for input sample files and how  below for details on the assumed naming scheme for input sample files and how
# Line 50  Print version and exit. Line 50  Print version and exit.
50  .B \ --dry-run  .B \ --dry-run
51  Scan input sample (.wav) files, but exit before creating any .gig file.  Scan input sample (.wav) files, but exit before creating any .gig file.
52  .TP  .TP
53    .B \ --verbose
54    Increase amount of info being shown.
55    .TP
56  .B \ --regex-name1 PATTERN  .B \ --regex-name1 PATTERN
57  Regular expression for overriding the  Regular expression for overriding the
58  .BR NAME1  .BR NAME1
59  part of the input sample file name scheme.  part of the input sample file name scheme.
60    
61  Defaults to '^([^-]+) - [^-]+ - [^-]+ - [^-]+ - [^.]+'.  Defaults to '([^-\/\\]+) - [^-]+ - [^-]+ - [^-]+ - [^.]+'.
62    
63  .TP  .TP
64  .B \ --regex-name2 PATTERN  .B \ --regex-name2 PATTERN
# Line 63  Regular expression for overriding the Line 66  Regular expression for overriding the
66  .BR NAME2  .BR NAME2
67  part of the input sample file name scheme.  part of the input sample file name scheme.
68    
69  Defaults to '^[^-]+ - ([^-]+) - [^-]+ - [^-]+ - [^.]+'.  Defaults to '[^-\/\\]+ - ([^-]+) - [^-]+ - [^-]+ - [^.]+'.
70    
71  .TP  .TP
72  .B \ --regex-velocity-nr PATTERN  .B \ --regex-velocity-nr PATTERN
# Line 71  Regular expression for overriding the Line 74  Regular expression for overriding the
74  .BR VELOCITY_NR  .BR VELOCITY_NR
75  part of the input sample file name scheme.  part of the input sample file name scheme.
76    
77  Defaults to '^[^-]+ - [^-]+ - ([^-]+) - [^-]+ - [^.]+'.  Defaults to '[^-\/\\]+ - [^-]+ - ([^-]+) - [^-]+ - [^.]+'.
78    
79  .TP  .TP
80  .B \ --regex-note-nr PATTERN  .B \ --regex-note-nr PATTERN
# Line 79  Regular expression for overriding the Line 82  Regular expression for overriding the
82  .BR NOTE_NR  .BR NOTE_NR
83  part of the input sample file name scheme.  part of the input sample file name scheme.
84    
85  Defaults to '^[^-]+ - [^-]+ - [^-]+ - ([^-]+) - [^.]+'.  Defaults to '[^-\/\\]+ - [^-]+ - [^-]+ - ([^-]+) - [^.]+'.
86    
87  .TP  .TP
88  .B \ --regex-note-name PATTERN  .B \ --regex-note-name PATTERN
# Line 87  Regular expression for overriding the Line 90  Regular expression for overriding the
90  .BR NOTE_NAME  .BR NOTE_NAME
91  part of the input sample file name scheme.  part of the input sample file name scheme.
92    
93  Defaults to '^[^-]+ - [^-]+ - [^-]+ - [^-]+ - ([^.]+)'.  Defaults to '[^-\/\\]+ - [^-]+ - [^-]+ - [^-]+ - ([^.]+)'.
94    
95  .SH SAMPLE NAMES  .SH SAMPLE NAMES
96  By default this tool assumes the following input sample file naming scheme for  By default this tool assumes the following input sample file naming scheme for
# Line 134  to override this part of the naming sche Line 137  to override this part of the naming sche
137  MIDI Note number of the sample (e.g. "021" for note a-1).  MIDI Note number of the sample (e.g. "021" for note a-1).
138    
139  This informtion will be used to automatically map the sample to a region on the  This informtion will be used to automatically map the sample to a region on the
140  keyboard.  keyboard. The sample's root note (a.k.a. "unity note") is taken directly from
141    the .wav file content, however if the .wav file content does not contain a root
142    note information then
143    .B \ NOTE_NR
144    is used as root note as well.
145    
146  You may use  You may use
147  .BR --regex-note-nr  .BR --regex-note-nr
# Line 151  You may use Line 158  You may use
158  .BR --regex-note-name  .BR --regex-note-name
159  to override this part of the naming scheme.  to override this part of the naming scheme.
160    
161    .PP
162    This tool utilizes the
163    .I regular expressions
164    library provided by C++ (introduced with the C++11 standard revision).
165    Each custom regular expression (abbreviated as 'RegEx' from now on below)
166    passed to one of the
167    .BR --regex-*
168    options must contain
169    .B
170    exactly one
171    active RegEx 'capture group' which is denoted in regular expressions by a pair
172    of round brackets like:
173    
174    .B (PATTERN)
175    
176    So the 'capture group' marks the portion in the overall filename string that is
177    going to be exctracted for the respective component of the filename schema.
178    If additional RegEx group(s) are needed to build the overall RegEx pattern, then
179    those other group(s) must be defined as 'passive groups' denoted in RegEx
180    patterns by an additional question mark and colon like this:
181    
182    .B (?:PATTERN)
183    
184    Keep in mind that RegEx scanners behave 'greedy' by default, which means by
185    default they try to match the longest string possible according to your defined
186    RegEx pattern. If that's not desired then you may either override the required
187    parts of your RegEx pattern to behave 'non-greedy' such that those parts would
188    match for the shortest string possible instead, or alternatively consider using
189    the RegEx 'alternation'
190    operator, which is denoted in regular expressions by a vertical bar character
191    like:
192    
193    .B PATTERN1|PATTERN2|PATTERN3
194    
195    The RegEx 'alternation' operator is sometimes more intuitive, because it tries
196    to match the provided patterns strictly in order from left to right. So it
197    would first try to match the first pattern, and only if no match with the first
198    pattern was possible (independent of string length) it would then try to match
199    the second pattern, and so on.
200    
201  .SH "SEE ALSO"  .SH "SEE ALSO"
202  .BR gig2mono(1),  .BR gig2mono(1),
203  .BR gigextract(1),  .BR gigextract(1),
Legend:
Removed from v.3991  
changed lines
  Added in v.3995
  ViewVC Help
Powered by ViewVC