Audacity  2.2.0
ImportLOF.h
Go to the documentation of this file.
1 /**********************************************************************
2 
3  Audacity: A Digital Audio Editor
4 
5  ImportLOF.h
6 
7  David I. Murray
8 
9  Supports the opening of ".lof" files which are text files that contain
10  a list of individual files to open in audacity in specific formats.
11 
12  (In BNF) The syntax for an LOF file, denoted by <lof>:
13 
14  <lof> ::= [<window> | <file> | <#>]*
15  <window> ::= window [<window-parameter>]* <newline>
16  <window-parameter> ::= offset <time> | duration <time>
17  <time> ::= [<digit>]+ [ . [<digit>]* ]
18  <file> ::= file [<file-parameter>]* <newline>
19  <file-parameter> ::= offset <time>
20  <#> ::= <comment> <newline>
21 
22  EXAMPLE LOF file:
23 
24  # everything following the hash character is ignored
25  window # an initial window command is implicit and optional
26  file "C:\folder1\sample1.wav" # sample1.wav is displayed
27  file "C:\sample2.wav" offset 5 # sample2 is displayed with a 5s offset
28  File "C:\sample3.wav" # sample3 is displayed with no offset
29  window offset 5 duration 10 # open a NEW window, zoom to display
30  # 10 seconds total starting at 5 (ending at 15) seconds
31  file "C:\sample3.wav" offset 2.5
32 
33  SEMANTICS:
34 
35  There are two commands: "window" creates a NEW window, and "file"
36  appends a track to the current window and displays the file there. The
37  first file is always placed in a NEW window, whether or not an initial
38  "window" command is given.
39 
40  Commands have optional keyword parameters that may be listed in any
41  order. A parameter should only occur once per command. The "offset"
42  parameter specifies a time offset. For windows, this is the leftmost
43  time displayed in the window. For files, the offset is an amount by
44  which the file is shifted in time before display (only enabled for audio;
45  not midi). The offset is specified as an integer or decimal number of
46  seconds, and the default value is zero.
47 
48  Windows may also have a "duration" parameter, which specifies how much
49  time should be displayed in the window. The default duration is equal
50  to the duration of the longest track currently displayed.
51 
52 **********************************************************************/
53 
54 #ifndef __AUDACITY_IMPORT_LOF__
55 #define __AUDACITY_IMPORT_LOF__
56 
57 #include "ImportForwards.h"
58 
59 void GetLOFImportPlugin(ImportPluginList &importPluginList,
60  UnusableImportPluginList &unusableImportPluginList);
61 
62 #endif
void GetLOFImportPlugin(ImportPluginList &importPluginList, UnusableImportPluginList &unusableImportPluginList)
An UnusableImportPlugin list.
An ImportPlugin list.