trunk/man/wav2gig.1.in

.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
.B wav2gig
[ OPTIONS ] GIG_FILE WAV_FILE_OR_DIR_1 [ WAV_FILE_OR_DIR_2 ... ]
.SH DESCRIPTION
Takes a list of wave (.wav) files and / or directories containing wave files as
argument(s) and creates one new GigaStudio / GigaSampler (.gig) file for those
samples.

The created GigaStudio (.gig) file will contain the given input samples. The
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
meaningful way to that instrument. As the wave (.wav) format currently does not
support many of the meta information required for this particular task, this
tool tries to guess the required information from the individual sample's name
for mapping the samples accordingly. See
.BR SAMPLE
.BR NAMES
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
.B \ GIG_FILE
GigaStudio / GigaSampler (.gig) filename to be created
.TP
.B \ WAV_FILE_OR_DIR_1
Filename or directory containing wave (.wav) file(s)
.TP
.B \ WAV_FILE_OR_DIR_2
Filename or directory containing wave (.wav) file(s)
.TP
.B \ -r
Recurse through all subdirectories of provided input WAV directories.
.TP
.B \ -f
Overwrite output GigaStudio (.gig) file in case it already exists.
.TP
.B \ -v
Print version and exit.
.TP
.B \ --dry-run
Scan input sample (.wav) files, but exit before creating any .gig file.
.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
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.wav'

Which are interpreted in the following way:

.TP
.B \ NAME1
Primary name of the sample (e.g. "Violin").

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).

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").

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),
.BR gigdump(1),
.BR gigmerge(1)
.BR korg2gig(1)

.SH "BUGS"
Check and report bugs at http://bugs.linuxsampler.org
.SH "Author"
Application and manual page written by Christian Schoenebeck <cuse@users.sf.net>
1	schoenebeck	3990	.TH "wav2gig" "1" "30 Aug 2021" "libgig @VERSION@" "libgig tools"
2	schoenebeck	3980	.SH NAME
3			wav2gig \- Create GigaStudio (.gig) file from a set of WAV files.
4			.SH SYNOPSIS
5			.B wav2gig
6			[ OPTIONS ] GIG_FILE WAV_FILE_OR_DIR_1 [ WAV_FILE_OR_DIR_2 ... ]
7			.SH DESCRIPTION
8			Takes a list of wave (.wav) files and / or directories containing wave files as
9			argument(s) and creates one new GigaStudio / GigaSampler (.gig) file for those
10			samples.
11
12			The created GigaStudio (.gig) file will contain the given input samples. The
13	schoenebeck	3990	samples' meta information (as far as available) like root note
14			(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	schoenebeck	3980
18			Additionally this tool creates exactly one instrument inside the newly created
19			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
21			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
23			for mapping the samples accordingly. See
24			.BR SAMPLE
25			.BR NAMES
26	schoenebeck	3990	below for details on the assumed naming scheme for input sample files and how
27			to override that default naming scheme by providing custom regular expression
28			patterns.
29	schoenebeck	3980
30			.SH OPTIONS
31			.TP
32			.B \ GIG_FILE
33			GigaStudio / GigaSampler (.gig) filename to be created
34			.TP
35			.B \ WAV_FILE_OR_DIR_1
36			Filename or directory containing wave (.wav) file(s)
37			.TP
38			.B \ WAV_FILE_OR_DIR_2
39			Filename or directory containing wave (.wav) file(s)
40			.TP
41			.B \ -r
42			Recurse through all subdirectories of provided input WAV directories.
43			.TP
44			.B \ -f
45			Overwrite output GigaStudio (.gig) file in case it already exists.
46			.TP
47			.B \ -v
48			Print version and exit.
49	schoenebeck	3990	.TP
50	schoenebeck	3991	.B \ --dry-run
51			Scan input sample (.wav) files, but exit before creating any .gig file.
52			.TP
53	schoenebeck	3990	.B \ --regex-name1 PATTERN
54			Regular expression for overriding the
55			.BR NAME1
56			part of the input sample file name scheme.
57	schoenebeck	3980
58	schoenebeck	3990	Defaults to '^([^-]+) - [^-]+ - [^-]+ - [^-]+ - [^.]+'.
59
60			.TP
61			.B \ --regex-name2 PATTERN
62			Regular expression for overriding the
63			.BR NAME2
64			part of the input sample file name scheme.
65
66			Defaults to '^[^-]+ - ([^-]+) - [^-]+ - [^-]+ - [^.]+'.
67
68			.TP
69			.B \ --regex-velocity-nr PATTERN
70			Regular expression for overriding the
71			.BR VELOCITY_NR
72			part of the input sample file name scheme.
73
74			Defaults to '^[^-]+ - [^-]+ - ([^-]+) - [^-]+ - [^.]+'.
75
76			.TP
77			.B \ --regex-note-nr PATTERN
78			Regular expression for overriding the
79			.BR NOTE_NR
80			part of the input sample file name scheme.
81
82			Defaults to '^[^-]+ - [^-]+ - [^-]+ - ([^-]+) - [^.]+'.
83
84			.TP
85			.B \ --regex-note-name PATTERN
86			Regular expression for overriding the
87			.BR NOTE_NAME
88			part of the input sample file name scheme.
89
90			Defaults to '^[^-]+ - [^-]+ - [^-]+ - [^-]+ - ([^.]+)'.
91
92	schoenebeck	3980	.SH SAMPLE NAMES
93	schoenebeck	3990	By default this tool assumes the following input sample file naming scheme for
94			automatically mapping samples to regions on the keyboard, as well as mapping
95			them to velocity splits adequately:
96	schoenebeck	3980
97	schoenebeck	3990	.B 'NAME1 - NAME2 - VELOCITY_NR - NOTE_NR - NOTE_NAME.wav'
98	schoenebeck	3980
99			Which are interpreted in the following way:
100
101			.TP
102			.B \ NAME1
103			Primary name of the sample (e.g. "Violin").
104
105			This is not interpreted for sample mapping, but it will be used to assemble the
106			final sample name inside the GigaStudio (.gig) file.
107
108	schoenebeck	3990	You may use
109			.BR --regex-name1
110			to override this part of the naming scheme.
111
112	schoenebeck	3980	.TP
113			.B \ NAME2
114			Secondary name of the sample (e.g. "Cresc").
115
116			This is currently ignored, but might be used in future.
117
118	schoenebeck	3990	You may use
119			.BR --regex-name2
120			to override this part of the naming scheme.
121
122	schoenebeck	3980	.TP
123			.B \ VELOCITY_NR
124			MIDI Velocity number of the sample (e.g. "18").
125
126			This informtion will be used to automatically create velocity splits.
127
128	schoenebeck	3990	You may use
129			.BR --regex-velocity-nr
130			to override this part of the naming scheme.
131
132	schoenebeck	3980	.TP
133			.B \ NOTE_NR
134			MIDI Note number of the sample (e.g. "021" for note a-1).
135
136			This informtion will be used to automatically map the sample to a region on the
137			keyboard.
138
139	schoenebeck	3990	You may use
140			.BR --regex-note-nr
141			to override this part of the naming scheme.
142
143	schoenebeck	3980	.TP
144			.B \ NOTE_NAME
145			Note name of the sample (e.g. "a-1").
146
147			This is not interpreted for sample mapping, but it will be used to assemble the
148			final sample name inside the GigaStudio (.gig) file.
149
150	schoenebeck	3990	You may use
151			.BR --regex-note-name
152			to override this part of the naming scheme.
153
154	schoenebeck	3980	.SH "SEE ALSO"
155			.BR gig2mono(1),
156			.BR gigextract(1),
157			.BR gigdump(1),
158			.BR gigmerge(1)
159			.BR korg2gig(1)
160
161			.SH "BUGS"
162			Check and report bugs at http://bugs.linuxsampler.org
163			.SH "Author"
164			Application and manual page written by Christian Schoenebeck <cuse@users.sf.net>