/[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 3989 by schoenebeck, Tue Aug 3 14:37:25 2021 UTC revision 3990 by schoenebeck, Mon Aug 30 20:14:15 2021 UTC
# Line 1  Line 1 
1  .TH "wav2gig" "1" "03 Aug 2021" "libgig @VERSION@" "libgig tools"  .TH "wav2gig" "1" "30 Aug 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
# Line 21  tool tries to guess the required informa Line 23  tool tries to guess the required informa
23  for mapping the samples accordingly. See  for mapping 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 \ --regex-name1 PATTERN
51    Regular expression for overriding the
52    .BR NAME1
53    part of the input sample file name scheme.
54    
55    Defaults to '^([^-]+) - [^-]+ - [^-]+ - [^-]+ - [^.]+'.
56    
57    .TP
58    .B \ --regex-name2 PATTERN
59    Regular expression for overriding the
60    .BR NAME2
61    part of the input sample file name scheme.
62    
63    Defaults to '^[^-]+ - ([^-]+) - [^-]+ - [^-]+ - [^.]+'.
64    
65    .TP
66    .B \ --regex-velocity-nr PATTERN
67    Regular expression for overriding the
68    .BR VELOCITY_NR
69    part of the input sample file name scheme.
70    
71    Defaults to '^[^-]+ - [^-]+ - ([^-]+) - [^-]+ - [^.]+'.
72    
73    .TP
74    .B \ --regex-note-nr PATTERN
75    Regular expression for overriding the
76    .BR NOTE_NR
77    part of the input sample file name scheme.
78    
79    Defaults to '^[^-]+ - [^-]+ - [^-]+ - ([^-]+) - [^.]+'.
80    
81    .TP
82    .B \ --regex-note-name PATTERN
83    Regular expression for overriding the
84    .BR NOTE_NAME
85    part of the input sample file name scheme.
86    
87    Defaults to '^[^-]+ - [^-]+ - [^-]+ - [^-]+ - ([^.]+)'.
88    
89  .SH SAMPLE NAMES  .SH SAMPLE NAMES
90  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
91  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
92  velocity splits adequately:  them to velocity splits adequately:
93    
94  .B NAME1 - NAME2 - VELOCITY_NR - NOTE_NR - NOTE_NAME  .B 'NAME1 - NAME2 - VELOCITY_NR - NOTE_NR - NOTE_NAME.wav'
95    
96  Which are interpreted in the following way:  Which are interpreted in the following way:
97    
# Line 60  Primary name of the sample (e.g. "Violin Line 102  Primary name of the sample (e.g. "Violin
102  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
103  final sample name inside the GigaStudio (.gig) file.  final sample name inside the GigaStudio (.gig) file.
104    
105    You may use
106    .BR --regex-name1
107    to override this part of the naming scheme.
108    
109  .TP  .TP
110  .B \ NAME2  .B \ NAME2
111  Secondary name of the sample (e.g. "Cresc").  Secondary name of the sample (e.g. "Cresc").
112    
113  This is currently ignored, but might be used in future.  This is currently ignored, but might be used in future.
114    
115    You may use
116    .BR --regex-name2
117    to override this part of the naming scheme.
118    
119  .TP  .TP
120  .B \ VELOCITY_NR  .B \ VELOCITY_NR
121  MIDI Velocity number of the sample (e.g. "18").  MIDI Velocity number of the sample (e.g. "18").
122    
123  This informtion will be used to automatically create velocity splits.  This informtion will be used to automatically create velocity splits.
124    
125    You may use
126    .BR --regex-velocity-nr
127    to override this part of the naming scheme.
128    
129  .TP  .TP
130  .B \ NOTE_NR  .B \ NOTE_NR
131  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).
# Line 79  MIDI Note number of the sample (e.g. "02 Line 133  MIDI Note number of the sample (e.g. "02
133  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
134  keyboard.  keyboard.
135    
136    You may use
137    .BR --regex-note-nr
138    to override this part of the naming scheme.
139    
140  .TP  .TP
141  .B \ NOTE_NAME  .B \ NOTE_NAME
142  Note name of the sample (e.g. "a-1").  Note name of the sample (e.g. "a-1").
# Line 86  Note name of the sample (e.g. "a-1"). Line 144  Note name of the sample (e.g. "a-1").
144  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
145  final sample name inside the GigaStudio (.gig) file.  final sample name inside the GigaStudio (.gig) file.
146    
147    You may use
148    .BR --regex-note-name
149    to override this part of the naming scheme.
150    
151  .SH "SEE ALSO"  .SH "SEE ALSO"
152  .BR gig2mono(1),  .BR gig2mono(1),
153  .BR gigextract(1),  .BR gigextract(1),
Legend:
Removed from v.3989  
changed lines
  Added in v.3990
  ViewVC Help
Powered by ViewVC