/[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 3980 by schoenebeck, Tue Aug 3 14:37:25 2021 UTC revision 3995 by schoenebeck, Fri Sep 3 15:06:10 2021 UTC
# Line 1  Line 1 
1  .TH "wav2gig" "1" "03 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 10  argument(s) and creates one new GigaStud Line 10  argument(s) and creates one new GigaStud
10  samples.  samples.
11    
12  The created GigaStudio (.gig) file will contain the given input samples. The  The created GigaStudio (.gig) file will contain the given input samples. The
13  samples' meta information like loop points are automatically extracted from the  samples' meta information (as far as available) like root note
14  input wave files and applied accordingly.  (a.k.a 'unity note'), fine tune, loop points, loop type and loop play count
15    are automatically extracted from the input wave (.wav) files and applied
16    accordingly.
17    
18  Additionally this tool creates exactly one instrument inside the newly created  Additionally this tool creates exactly one instrument inside the newly created
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 currently supported and assumed naming scheme for the  below for details on the assumed naming scheme for input sample files and how
27  input sample files.  to override that default naming scheme by providing custom regular expression
28    patterns.
29    
30  .SH OPTIONS  .SH OPTIONS
31  .TP  .TP
# Line 43  Overwrite output GigaStudio (.gig) file Line 46  Overwrite output GigaStudio (.gig) file
46  .TP  .TP
47  .B \ -v  .B \ -v
48  Print version and exit.  Print version and exit.
49    .TP
50    .B \ --dry-run
51    Scan input sample (.wav) files, but exit before creating any .gig file.
52    .TP
53    .B \ --verbose
54    Increase amount of info being shown.
55    .TP
56    .B \ --regex-name1 PATTERN
57    Regular expression for overriding the
58    .BR NAME1
59    part of the input sample file name scheme.
60    
61    Defaults to '([^-\/\\]+) - [^-]+ - [^-]+ - [^-]+ - [^.]+'.
62    
63    .TP
64    .B \ --regex-name2 PATTERN
65    Regular expression for overriding the
66    .BR NAME2
67    part of the input sample file name scheme.
68    
69    Defaults to '[^-\/\\]+ - ([^-]+) - [^-]+ - [^-]+ - [^.]+'.
70    
71    .TP
72    .B \ --regex-velocity-nr PATTERN
73    Regular expression for overriding the
74    .BR VELOCITY_NR
75    part of the input sample file name scheme.
76    
77    Defaults to '[^-\/\\]+ - [^-]+ - ([^-]+) - [^-]+ - [^.]+'.
78    
79    .TP
80    .B \ --regex-note-nr PATTERN
81    Regular expression for overriding the
82    .BR NOTE_NR
83    part of the input sample file name scheme.
84    
85    Defaults to '[^-\/\\]+ - [^-]+ - [^-]+ - ([^-]+) - [^.]+'.
86    
87    .TP
88    .B \ --regex-note-name PATTERN
89    Regular expression for overriding the
90    .BR NOTE_NAME
91    part of the input sample file name scheme.
92    
93    Defaults to '[^-\/\\]+ - [^-]+ - [^-]+ - [^-]+ - ([^.]+)'.
94    
95  .SH SAMPLE NAMES  .SH SAMPLE NAMES
96  Right now this tool assumes the following sample naming scheme for being able to  By default this tool assumes the following input sample file naming scheme for
97  automatically map samples to regions on the keyboard, as well as mapping them to  automatically mapping samples to regions on the keyboard, as well as mapping
98  velocity splits adequately:  them to velocity splits adequately:
99    
100  .B NAME1 - NAME2 - VELOCITY_NR - NOTE_NR - NOTE_NAME  .B 'NAME1 - NAME2 - VELOCITY_NR - NOTE_NR - NOTE_NAME.wav'
101    
102  Which are interpreted in the following way:  Which are interpreted in the following way:
103    
# Line 60  Primary name of the sample (e.g. "Violin Line 108  Primary name of the sample (e.g. "Violin
108  This is not interpreted for sample mapping, but it will be used to assemble the  This is not interpreted for sample mapping, but it will be used to assemble the
109  final sample name inside the GigaStudio (.gig) file.  final sample name inside the GigaStudio (.gig) file.
110    
111    You may use
112    .BR --regex-name1
113    to override this part of the naming scheme.
114    
115  .TP  .TP
116  .B \ NAME2  .B \ NAME2
117  Secondary name of the sample (e.g. "Cresc").  Secondary name of the sample (e.g. "Cresc").
118    
119  This is currently ignored, but might be used in future.  This is currently ignored, but might be used in future.
120    
121    You may use
122    .BR --regex-name2
123    to override this part of the naming scheme.
124    
125  .TP  .TP
126  .B \ VELOCITY_NR  .B \ VELOCITY_NR
127  MIDI Velocity number of the sample (e.g. "18").  MIDI Velocity number of the sample (e.g. "18").
128    
129  This informtion will be used to automatically create velocity splits.  This informtion will be used to automatically create velocity splits.
130    
131    You may use
132    .BR --regex-velocity-nr
133    to override this part of the naming scheme.
134    
135  .TP  .TP
136  .B \ NOTE_NR  .B \ NOTE_NR
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
147    .BR --regex-note-nr
148    to override this part of the naming scheme.
149    
150  .TP  .TP
151  .B \ NOTE_NAME  .B \ NOTE_NAME
# Line 86  Note name of the sample (e.g. "a-1"). Line 154  Note name of the sample (e.g. "a-1").
154  This is not interpreted for sample mapping, but it will be used to assemble the  This is not interpreted for sample mapping, but it will be used to assemble the
155  final sample name inside the GigaStudio (.gig) file.  final sample name inside the GigaStudio (.gig) file.
156    
157    You may use
158    .BR --regex-note-name
159    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.3980  
changed lines
  Added in v.3995
  ViewVC Help
Powered by ViewVC