Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
documentation:file_formats [2019/02/03 09:42] devadocumentation:file_formats [2019/03/17 17:27] (current) deva
Line 2: Line 2:
 This page describes the file formats used by the DrumGizmo engine. For ease of use we have implemented everything using xml. The main files are the drum kit files, the instrument files and the midi map files. These are described in detail below. This page describes the file formats used by the DrumGizmo engine. For ease of use we have implemented everything using xml. The main files are the drum kit files, the instrument files and the midi map files. These are described in detail below.
  
-=====New file format (currently unreleased, check <=0.9.8 for current format)=====+=====New file format (version 0.9.17 and up)=====
 ====Drumkit xml format==== ====Drumkit xml format====
 <code xml> <code xml>
Line 10: Line 10:
     <version>1.2.3</version>     <version>1.2.3</version>
     <title>Test Kit</title>     <title>Test Kit</title>
-    <logo src="IconFile"/>+    <logo src="LogoFile.png"/>
     <description>This is the description of the drumkit</description>     <description>This is the description of the drumkit</description>
     <license>Creative Commons</license>     <license>Creative Commons</license>
Line 25: Line 25:
    <channel name="AmbL">    <channel name="AmbL">
      <title>Ambience left</title>      <title>Ambience left</title>
-     <source>T-bone rb500</source> 
    </channel>    </channel>
    <channel name="AmbR">    <channel name="AmbR">
      <title>Ambience right</title>      <title>Ambience right</title>
-     <source>T-bone rb500</source> 
-   </channel> 
-   <channel name="Hihat"> 
-     <title>Hihat</title> 
-     <source>T-bone rb500</source> 
    </channel>    </channel>
 +   <channel name="Hihat"/>
    <channel name="KdrumL">    <channel name="KdrumL">
      <title>KickDrum left</title>      <title>KickDrum left</title>
-     <source>T-bone rb500</source> 
    </channel>    </channel>
    <channel name="KdrumR">    <channel name="KdrumR">
      <title>KickDrum right</title>      <title>KickDrum right</title>
-     <source>T-bone rb500</source> 
    </channel>    </channel>
    <channel name="OHL">    <channel name="OHL">
      <title>Overhead left</title>      <title>Overhead left</title>
-     <source>T-bone rb500</source> 
    </channel>    </channel>
    <channel name="OHR">    <channel name="OHR">
      <title>Overhead right</title>      <title>Overhead right</title>
-     <source>T-bone rb500</source> 
    </channel>    </channel>
    <channel name="RideL">    <channel name="RideL">
      <title>Ride left</title>      <title>Ride left</title>
-     <source>T-bone rb500</source> 
    </channel>    </channel>
    <channel name="RideR">    <channel name="RideR">
      <title>Ride right</title>      <title>Ride right</title>
-     <source>T-bone rb500</source> 
    </channel>    </channel>
    <channel name="Snare_bottom">    <channel name="Snare_bottom">
      <title>Snare bottom</title>      <title>Snare bottom</title>
-     <source>T-bone rb500</source> 
    </channel>    </channel>
    <channel name="Snare_top">    <channel name="Snare_top">
      <title>Snare top</title>      <title>Snare top</title>
-     <source>T-bone rb500</source> 
-   </channel> 
-   <channel name="Tom1"> 
-     <title>Rack tom 1</title> 
-     <source>T-bone rb500</source> 
-   </channel> 
-   <channel name="Tom2"> 
-     <title>Rack tom 2</title> 
-     <source>T-bone rb500</source> 
-   </channel> 
-   <channel name="Tom3"> 
-     <title>Rack tom 3</title> 
-     <source>T-bone rb500</source> 
    </channel>    </channel>
 +   <channel name="Tom1"/>
 +   <channel name="Tom2"/>
 +   <channel name="Tom3"/>
    <channel name="Tom4">    <channel name="Tom4">
-     <title>Floor tom 1</title+     <title>Floor tom</title>
-     <source>T-bone rb500</source>+
    </channel>    </channel>
    <channel name="Trigger">    <channel name="Trigger">
      <title>Kickdrum trigger</title>      <title>Kickdrum trigger</title>
-     <source>DDrum kickdrum trigger</source> 
    </channel>    </channel>
   </channels>   </channels>
   <instruments>   <instruments>
     <instrument name="China" file="China/China.xml">     <instrument name="China" file="China/China.xml">
-      <channelmap in="AmbL" out="AmbL" bleed="1.0" main="true"/> +      <channelmap in="AmbL" out="AmbL" main="true"/> 
-      <channelmap in="AmbR" out="AmbR" bleed="1.0" main="true"/> +      <channelmap in="AmbR" out="AmbR" main="true"/> 
-      <channelmap in="Hihat" out="Hihat" bleed="1.0"/> +      <channelmap in="Hihat" out="Hihat"/> 
-      <channelmap in="KdrumL" out="KdrumL" bleed="1.0"/> +      <channelmap in="KdrumL" out="KdrumL"/> 
-      <channelmap in="KdrumR" out="KdrumR" bleed="1.0"/> +      <channelmap in="KdrumR" out="KdrumR"/> 
-      <channelmap in="OHL" out="OHL" bleed="1.0" main="true"/> +      <channelmap in="OHL" out="OHL" main="true"/> 
-      <channelmap in="OHR" out="OHR" bleed="1.0" main="true"/> +      <channelmap in="OHR" out="OHR" main="true"/> 
-      <channelmap in="RideL" out="RideL" bleed="1.0"/> +      <channelmap in="RideL" out="RideL"/> 
-      <channelmap in="RideR" out="RideR" bleed="1.0"/> +      <channelmap in="RideR" out="RideR"/> 
-      <channelmap in="Snare_bottom" out="Snare_bottom" bleed="1.0"/> +      <channelmap in="Snare_bottom" out="Snare_bottom"/> 
-      <channelmap in="Snare_top" out="Snare_top" bleed="1.0"/> +      <channelmap in="Snare_top" out="Snare_top"/> 
-      <channelmap in="Tom1" out="Tom1" bleed="1.0"/> +      <channelmap in="Tom1" out="Tom1"/> 
-      <channelmap in="Tom2" out="Tom2" bleed="1.0"/> +      <channelmap in="Tom2" out="Tom2"/> 
-      <channelmap in="Tom3" out="Tom3" bleed="1.0"/> +      <channelmap in="Tom3" out="Tom3"/> 
-      <channelmap in="Tom4" out="Tom4" bleed="1.0"/> +      <channelmap in="Tom4" out="Tom4"/> 
-      <channelmap in="Trigger" out="Trigger" bleed="1.0"/>+      <channelmap in="Trigger" out="Trigger"/>
     </instrument>     </instrument>
     <instrument name="HihatClosed" group="hihat" file="HihatClosed/HihatClosed.xml">     <instrument name="HihatClosed" group="hihat" file="HihatClosed/HihatClosed.xml">
-      <channelmap in="AmbL" out="AmbL" bleed="1.0" main="true"/> +      <chokes> 
-      <channelmap in="AmbR" out="AmbR" bleed="1.0" main="true"/> +        <choke instrument="HihatFullyOpen" choketime="100"/> 
-      <channelmap in="Hihat" out="Hihat" bleed="1.0" main="true"/> +        <choke instrument="HihatHalfOpen"/> 
-      <channelmap in="KdrumL" out="KdrumL" bleed="1.0"/> +      </chokes> 
-      <channelmap in="KdrumR" out="KdrumR" bleed="1.0"/> +      <channelmap in="AmbL" out="AmbL" main="true"/> 
-      <channelmap in="OHL" out="OHL" bleed="1.0" main="true"/> +      <channelmap in="AmbR" out="AmbR" main="true"/> 
-      <channelmap in="OHR" out="OHR" bleed="1.0" main="true"/> +      <channelmap in="Hihat" out="Hihat" main="true"/> 
-      <channelmap in="RideL" out="RideL" bleed="1.0"/> +      <channelmap in="KdrumL" out="KdrumL"/> 
-      <channelmap in="RideR" out="RideR" bleed="1.0"/> +      <channelmap in="KdrumR" out="KdrumR"/> 
-      <channelmap in="Snare_bottom" out="Snare_bottom" bleed="1.0"/> +      <channelmap in="OHL" out="OHL" main="true"/> 
-      <channelmap in="Snare_top" out="Snare_top" bleed="1.0"/> +      <channelmap in="OHR" out="OHR" main="true"/> 
-      <channelmap in="Tom1" out="Tom1" bleed="1.0"/> +      <channelmap in="RideL" out="RideL"/> 
-      <channelmap in="Tom2" out="Tom2" bleed="1.0"/> +      <channelmap in="RideR" out="RideR"/> 
-      <channelmap in="Tom3" out="Tom3" bleed="1.0"/> +      <channelmap in="Snare_bottom" out="Snare_bottom"/> 
-      <channelmap in="Tom4" out="Tom4" bleed="1.0"/> +      <channelmap in="Snare_top" out="Snare_top"/> 
-      <channelmap in="Trigger" out="Trigger" bleed="1.0"/>+      <channelmap in="Tom1" out="Tom1"/> 
 +      <channelmap in="Tom2" out="Tom2"/> 
 +      <channelmap in="Tom3" out="Tom3"/> 
 +      <channelmap in="Tom4" out="Tom4"/> 
 +      <channelmap in="Trigger" out="Trigger"/>
     </instrument>     </instrument>
   </instruments>   </instruments>
Line 233: Line 213:
 ===audiofile node=== ===audiofile node===
 "channel" is the name used in the drumkit xml file to connect the instrument channel to the DG output channel. "file" tells what wav file to use. "filechannel" tells what channel inside that wav to use. "channel" is the name used in the drumkit xml file to connect the instrument channel to the DG output channel. "file" tells what wav file to use. "filechannel" tells what channel inside that wav to use.
-=====0.9.8 and older===== + 
-====Drumkit xml format====+=====Drumkit xml format (versions before 0.9.17)=====
 <code xml> <code xml>
 <?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
Line 281: Line 261:
 The name and description attributes are not currently in use, but are useful for people editing the files. The name and description attributes are not currently in use, but are useful for people editing the files.
 The "group" attribute in the instrument node is used to bind several instruments into a group. For instance you can have "open hihat" and "closed hihat" being part of the group "hihat". The only effect this has is that whenever a closed hihat hit is played just after an open hihat hit, it will quickly fade the open hihat hit while play the closed hihat hit. The "group" attribute in the instrument node is used to bind several instruments into a group. For instance you can have "open hihat" and "closed hihat" being part of the group "hihat". The only effect this has is that whenever a closed hihat hit is played just after an open hihat hit, it will quickly fade the open hihat hit while play the closed hihat hit.
 +
 ====Instrument xml format==== ====Instrument xml format====
 <code xml> <code xml>
documentation/file_formats.1549183355.txt.gz · Last modified: 2019/02/03 09:42 by deva
Trace:
GNU Free Documentation License 1.3
Valid CSS Driven by DokuWiki Recent changes RSS feed Valid XHTML 1.0