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 \ --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	.TH "wav2gig" "1" "30 Aug 2021" "libgig @VERSION@" "libgig tools"
2	.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	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
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	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
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	.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
90	By default this tool assumes the following input sample file naming scheme for
91	automatically mapping samples to regions on the keyboard, as well as mapping
92	them to velocity splits adequately:
93
94	.B 'NAME1 - NAME2 - VELOCITY_NR - NOTE_NR - NOTE_NAME.wav'
95
96	Which are interpreted in the following way:
97
98	.TP
99	.B \ NAME1
100	Primary name of the sample (e.g. "Violin").
101
102	This is not interpreted for sample mapping, but it will be used to assemble the
103	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
110	.B \ NAME2
111	Secondary name of the sample (e.g. "Cresc").
112
113	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
120	.B \ VELOCITY_NR
121	MIDI Velocity number of the sample (e.g. "18").
122
123	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
130	.B \ NOTE_NR
131	MIDI Note number of the sample (e.g. "021" for note a-1).
132
133	This informtion will be used to automatically map the sample to a region on the
134	keyboard.
135
136	You may use
137	.BR --regex-note-nr
138	to override this part of the naming scheme.
139
140	.TP
141	.B \ NOTE_NAME
142	Note name of the sample (e.g. "a-1").
143
144	This is not interpreted for sample mapping, but it will be used to assemble the
145	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"
152	.BR gig2mono(1),
153	.BR gigextract(1),
154	.BR gigdump(1),
155	.BR gigmerge(1)
156	.BR korg2gig(1)
157
158	.SH "BUGS"
159	Check and report bugs at http://bugs.linuxsampler.org
160	.SH "Author"
161	Application and manual page written by Christian Schoenebeck <cuse@users.sf.net>