The "GR-PEACH_Audio_Playback_7InchLCD_Sample" is a sample code that can provides high-resolution audio playback of FLAC format files. It also allows the user to audio-playback control functions such as play, pause, and stop by manipulating key switches.

Dependencies:   GR-PEACH_video R_BSP TLV320_RBSP USBHost_custom

Fork of GR-PEACH_Audio_Playback_Sample by Renesas

Note

For a sample program of without LCD Board, please refer to GR-PEACH_Audio_Playback_Sample.

Introduction

The "GR-PEACH_Audio_Playback_7InchLCD_Sample" is a sample code that can provides high-resolution audio playback of FLAC format files. It also allows the user to audio-playback control functions such as play, pause, and stop by manipulating key switches.

1. Overview of the Sample Code

1.1 Software Block Diagram

Figure 1.1 shows the software block diagram.

/media/uploads/1050186/lcd_figure1_1.png

1.2 Pin Definitions

Table 1.1 shows the pins used in this sample code.

/media/uploads/1050186/lcd_table1_1.png

2. Sample Code Operating Environment

In order to operate this sample code, GR-PEACH, Audio Camera Shield and 7.1 inch LCD Shield must be needed. For details on Audio Camera Shield and 7.1 inch LCD Shield, please refer to the following links, respectively:

In this section, it is described that how board is configured and to control audio playback via command line and touch screen.

2.1 Operating Environment

Figure 2.1 shows the overview of the operating environment for this sample code.

/media/uploads/1050186/lcd_figure2_1.png

Figure 2.2 and 2.3 show how to configure GR-PEACH, Audio Camera Shield and 7.1 inch LCD shield when using USB0 and USB1, respectively.

/media/uploads/1050186/lcd_figure2_2.png /media/uploads/1050186/lcd_figure2_3.png

Table 2.1 lists the overview of Graphical User Interface (GUI) of this sample code.

/media/uploads/1050186/lcd_table2_1.png

2.2 List of User Operations

Table 2.2 shows the relationship among Audio Playback, Command Line and Onboard Switch.

/media/uploads/1050186/lcd_table2_2.png

3. Function Outline

Table 3.1, 3.2 and 3.3 shows the overview of functions implemented in this sample code.

/media/uploads/1050186/lcd_table3_1.png /media/uploads/1050186/lcd_table3_2.png /media/uploads/1050186/lcd_table3_3.png /media/uploads/1050186/lcd_figure3_1.png

3.1 Playback Control

This sample program supports the operation "play", "pause", "stop", "play next song" and "play previous song".

3.2 Trick Play Control

In order to enable/disable Repeat Mode, user need to type "repeat" on command line or click the corresponding icon shown in Table 2.2. By derault, Repeat Mode is enabled. When Repeat Mode is enabled, the first song is played back after the playback of the last song is finished. Otherwise, the playback is shopped when finishing to play back the last song.

3.3 How to see Song Information

The information of the song being played back can be seen by typing playinfo on command line. Table 3.4 lists the items user can see on the terminal.

/media/uploads/dkato/audioplayback_table3_4.png

3.4 How to analyze the folder structure in USB stick

In this sample code, the folder structure in USB stick is analyzed in the breadth-first order. Table 3.5 shows how the files in USB stick are numbered.

/media/uploads/dkato/audioplayback_table3_5.png

4.Others

4.1 Serial Communication Setting

With respect to the default serial communication related setting on mbed, please refer to the follwing link:
https://developer.mbed.org/teams/Renesas/wiki/GR-PEACH-Getting-Started#install-the-usb-serial-communication
Please set up the terminal software you would like to use on your PC in consideration of the above. For example, 9600 should be specified for the baud rate on the terminal in order to control this sample via command line.

4.2 Necessary modification when using GCC ARM Embedded

If you would like to use GCC ARM Embedded, you must revise the following linker script incorporated in mbed OS 5 package as follows:

  • Linker Script to be modified
    $(PROJECT_ROOT)/mbed-os/targets/TARGET_RENESAS/TARGET_RZ_A1H/device/TOOLCHAIN_GCC_ARM/RZA1H.ld

    Please note that $(PROJECT_ROOT) in the above denotes the root directory of this sample code

  • Before Modification

RZA1H.ld

/* Linker script for mbed RZ_A1H */

/* Linker script to configure memory regions. */
MEMORY
{
  ROM   (rx)  : ORIGIN = 0x00000000, LENGTH = 0x02000000
  BOOT_LOADER (rx) : ORIGIN = 0x18000000, LENGTH = 0x00004000 
  SFLASH (rx) : ORIGIN = 0x18004000, LENGTH = 0x07FFC000 
  L_TTB (rw)  : ORIGIN = 0x20000000, LENGTH = 0x00004000 
  RAM (rwx) : ORIGIN = 0x20020000, LENGTH = 0x00700000
  RAM_NC (rwx) : ORIGIN = 0x20900000, LENGTH = 0x00100000
}
(snip)
  • After Modification

RZA1H.ld

/* Linker script for mbed RZ_A1H */

/* Linker script to configure memory regions. */
MEMORY
{
  ROM   (rx)  : ORIGIN = 0x00000000, LENGTH = 0x02000000
  BOOT_LOADER (rx) : ORIGIN = 0x18000000, LENGTH = 0x00004000 
  SFLASH (rx) : ORIGIN = 0x18004000, LENGTH = 0x07FFC000 
  L_TTB (rw)  : ORIGIN = 0x20000000, LENGTH = 0x00004000 
  RAM (rwx) : ORIGIN = 0x20020000, LENGTH = 0x00180000
  RAM_NC (rwx) : ORIGIN = 0x20200000, LENGTH = 0x00680000
}
(snip)
Committer:
Osamu Nakamura
Date:
Tue Apr 11 12:42:10 2017 +0900
Revision:
6:a957aaa284f0
Parent:
0:ee40da884cfc
Update R-BSP from rev. cbb9d60c8748 to fb9eda52224e so that this program can be compiled with IAR toolchain.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dkato 0:ee40da884cfc 1 GNU Free Documentation License
dkato 0:ee40da884cfc 2 Version 1.2, November 2002
dkato 0:ee40da884cfc 3
dkato 0:ee40da884cfc 4
dkato 0:ee40da884cfc 5 Copyright (C) 2000,2001,2002 Free Software Foundation, Inc.
dkato 0:ee40da884cfc 6 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
dkato 0:ee40da884cfc 7 Everyone is permitted to copy and distribute verbatim copies
dkato 0:ee40da884cfc 8 of this license document, but changing it is not allowed.
dkato 0:ee40da884cfc 9
dkato 0:ee40da884cfc 10
dkato 0:ee40da884cfc 11 0. PREAMBLE
dkato 0:ee40da884cfc 12
dkato 0:ee40da884cfc 13 The purpose of this License is to make a manual, textbook, or other
dkato 0:ee40da884cfc 14 functional and useful document "free" in the sense of freedom: to
dkato 0:ee40da884cfc 15 assure everyone the effective freedom to copy and redistribute it,
dkato 0:ee40da884cfc 16 with or without modifying it, either commercially or noncommercially.
dkato 0:ee40da884cfc 17 Secondarily, this License preserves for the author and publisher a way
dkato 0:ee40da884cfc 18 to get credit for their work, while not being considered responsible
dkato 0:ee40da884cfc 19 for modifications made by others.
dkato 0:ee40da884cfc 20
dkato 0:ee40da884cfc 21 This License is a kind of "copyleft", which means that derivative
dkato 0:ee40da884cfc 22 works of the document must themselves be free in the same sense. It
dkato 0:ee40da884cfc 23 complements the GNU General Public License, which is a copyleft
dkato 0:ee40da884cfc 24 license designed for free software.
dkato 0:ee40da884cfc 25
dkato 0:ee40da884cfc 26 We have designed this License in order to use it for manuals for free
dkato 0:ee40da884cfc 27 software, because free software needs free documentation: a free
dkato 0:ee40da884cfc 28 program should come with manuals providing the same freedoms that the
dkato 0:ee40da884cfc 29 software does. But this License is not limited to software manuals;
dkato 0:ee40da884cfc 30 it can be used for any textual work, regardless of subject matter or
dkato 0:ee40da884cfc 31 whether it is published as a printed book. We recommend this License
dkato 0:ee40da884cfc 32 principally for works whose purpose is instruction or reference.
dkato 0:ee40da884cfc 33
dkato 0:ee40da884cfc 34
dkato 0:ee40da884cfc 35 1. APPLICABILITY AND DEFINITIONS
dkato 0:ee40da884cfc 36
dkato 0:ee40da884cfc 37 This License applies to any manual or other work, in any medium, that
dkato 0:ee40da884cfc 38 contains a notice placed by the copyright holder saying it can be
dkato 0:ee40da884cfc 39 distributed under the terms of this License. Such a notice grants a
dkato 0:ee40da884cfc 40 world-wide, royalty-free license, unlimited in duration, to use that
dkato 0:ee40da884cfc 41 work under the conditions stated herein. The "Document", below,
dkato 0:ee40da884cfc 42 refers to any such manual or work. Any member of the public is a
dkato 0:ee40da884cfc 43 licensee, and is addressed as "you". You accept the license if you
dkato 0:ee40da884cfc 44 copy, modify or distribute the work in a way requiring permission
dkato 0:ee40da884cfc 45 under copyright law.
dkato 0:ee40da884cfc 46
dkato 0:ee40da884cfc 47 A "Modified Version" of the Document means any work containing the
dkato 0:ee40da884cfc 48 Document or a portion of it, either copied verbatim, or with
dkato 0:ee40da884cfc 49 modifications and/or translated into another language.
dkato 0:ee40da884cfc 50
dkato 0:ee40da884cfc 51 A "Secondary Section" is a named appendix or a front-matter section of
dkato 0:ee40da884cfc 52 the Document that deals exclusively with the relationship of the
dkato 0:ee40da884cfc 53 publishers or authors of the Document to the Document's overall subject
dkato 0:ee40da884cfc 54 (or to related matters) and contains nothing that could fall directly
dkato 0:ee40da884cfc 55 within that overall subject. (Thus, if the Document is in part a
dkato 0:ee40da884cfc 56 textbook of mathematics, a Secondary Section may not explain any
dkato 0:ee40da884cfc 57 mathematics.) The relationship could be a matter of historical
dkato 0:ee40da884cfc 58 connection with the subject or with related matters, or of legal,
dkato 0:ee40da884cfc 59 commercial, philosophical, ethical or political position regarding
dkato 0:ee40da884cfc 60 them.
dkato 0:ee40da884cfc 61
dkato 0:ee40da884cfc 62 The "Invariant Sections" are certain Secondary Sections whose titles
dkato 0:ee40da884cfc 63 are designated, as being those of Invariant Sections, in the notice
dkato 0:ee40da884cfc 64 that says that the Document is released under this License. If a
dkato 0:ee40da884cfc 65 section does not fit the above definition of Secondary then it is not
dkato 0:ee40da884cfc 66 allowed to be designated as Invariant. The Document may contain zero
dkato 0:ee40da884cfc 67 Invariant Sections. If the Document does not identify any Invariant
dkato 0:ee40da884cfc 68 Sections then there are none.
dkato 0:ee40da884cfc 69
dkato 0:ee40da884cfc 70 The "Cover Texts" are certain short passages of text that are listed,
dkato 0:ee40da884cfc 71 as Front-Cover Texts or Back-Cover Texts, in the notice that says that
dkato 0:ee40da884cfc 72 the Document is released under this License. A Front-Cover Text may
dkato 0:ee40da884cfc 73 be at most 5 words, and a Back-Cover Text may be at most 25 words.
dkato 0:ee40da884cfc 74
dkato 0:ee40da884cfc 75 A "Transparent" copy of the Document means a machine-readable copy,
dkato 0:ee40da884cfc 76 represented in a format whose specification is available to the
dkato 0:ee40da884cfc 77 general public, that is suitable for revising the document
dkato 0:ee40da884cfc 78 straightforwardly with generic text editors or (for images composed of
dkato 0:ee40da884cfc 79 pixels) generic paint programs or (for drawings) some widely available
dkato 0:ee40da884cfc 80 drawing editor, and that is suitable for input to text formatters or
dkato 0:ee40da884cfc 81 for automatic translation to a variety of formats suitable for input
dkato 0:ee40da884cfc 82 to text formatters. A copy made in an otherwise Transparent file
dkato 0:ee40da884cfc 83 format whose markup, or absence of markup, has been arranged to thwart
dkato 0:ee40da884cfc 84 or discourage subsequent modification by readers is not Transparent.
dkato 0:ee40da884cfc 85 An image format is not Transparent if used for any substantial amount
dkato 0:ee40da884cfc 86 of text. A copy that is not "Transparent" is called "Opaque".
dkato 0:ee40da884cfc 87
dkato 0:ee40da884cfc 88 Examples of suitable formats for Transparent copies include plain
dkato 0:ee40da884cfc 89 ASCII without markup, Texinfo input format, LaTeX input format, SGML
dkato 0:ee40da884cfc 90 or XML using a publicly available DTD, and standard-conforming simple
dkato 0:ee40da884cfc 91 HTML, PostScript or PDF designed for human modification. Examples of
dkato 0:ee40da884cfc 92 transparent image formats include PNG, XCF and JPG. Opaque formats
dkato 0:ee40da884cfc 93 include proprietary formats that can be read and edited only by
dkato 0:ee40da884cfc 94 proprietary word processors, SGML or XML for which the DTD and/or
dkato 0:ee40da884cfc 95 processing tools are not generally available, and the
dkato 0:ee40da884cfc 96 machine-generated HTML, PostScript or PDF produced by some word
dkato 0:ee40da884cfc 97 processors for output purposes only.
dkato 0:ee40da884cfc 98
dkato 0:ee40da884cfc 99 The "Title Page" means, for a printed book, the title page itself,
dkato 0:ee40da884cfc 100 plus such following pages as are needed to hold, legibly, the material
dkato 0:ee40da884cfc 101 this License requires to appear in the title page. For works in
dkato 0:ee40da884cfc 102 formats which do not have any title page as such, "Title Page" means
dkato 0:ee40da884cfc 103 the text near the most prominent appearance of the work's title,
dkato 0:ee40da884cfc 104 preceding the beginning of the body of the text.
dkato 0:ee40da884cfc 105
dkato 0:ee40da884cfc 106 A section "Entitled XYZ" means a named subunit of the Document whose
dkato 0:ee40da884cfc 107 title either is precisely XYZ or contains XYZ in parentheses following
dkato 0:ee40da884cfc 108 text that translates XYZ in another language. (Here XYZ stands for a
dkato 0:ee40da884cfc 109 specific section name mentioned below, such as "Acknowledgements",
dkato 0:ee40da884cfc 110 "Dedications", "Endorsements", or "History".) To "Preserve the Title"
dkato 0:ee40da884cfc 111 of such a section when you modify the Document means that it remains a
dkato 0:ee40da884cfc 112 section "Entitled XYZ" according to this definition.
dkato 0:ee40da884cfc 113
dkato 0:ee40da884cfc 114 The Document may include Warranty Disclaimers next to the notice which
dkato 0:ee40da884cfc 115 states that this License applies to the Document. These Warranty
dkato 0:ee40da884cfc 116 Disclaimers are considered to be included by reference in this
dkato 0:ee40da884cfc 117 License, but only as regards disclaiming warranties: any other
dkato 0:ee40da884cfc 118 implication that these Warranty Disclaimers may have is void and has
dkato 0:ee40da884cfc 119 no effect on the meaning of this License.
dkato 0:ee40da884cfc 120
dkato 0:ee40da884cfc 121
dkato 0:ee40da884cfc 122 2. VERBATIM COPYING
dkato 0:ee40da884cfc 123
dkato 0:ee40da884cfc 124 You may copy and distribute the Document in any medium, either
dkato 0:ee40da884cfc 125 commercially or noncommercially, provided that this License, the
dkato 0:ee40da884cfc 126 copyright notices, and the license notice saying this License applies
dkato 0:ee40da884cfc 127 to the Document are reproduced in all copies, and that you add no other
dkato 0:ee40da884cfc 128 conditions whatsoever to those of this License. You may not use
dkato 0:ee40da884cfc 129 technical measures to obstruct or control the reading or further
dkato 0:ee40da884cfc 130 copying of the copies you make or distribute. However, you may accept
dkato 0:ee40da884cfc 131 compensation in exchange for copies. If you distribute a large enough
dkato 0:ee40da884cfc 132 number of copies you must also follow the conditions in section 3.
dkato 0:ee40da884cfc 133
dkato 0:ee40da884cfc 134 You may also lend copies, under the same conditions stated above, and
dkato 0:ee40da884cfc 135 you may publicly display copies.
dkato 0:ee40da884cfc 136
dkato 0:ee40da884cfc 137
dkato 0:ee40da884cfc 138 3. COPYING IN QUANTITY
dkato 0:ee40da884cfc 139
dkato 0:ee40da884cfc 140 If you publish printed copies (or copies in media that commonly have
dkato 0:ee40da884cfc 141 printed covers) of the Document, numbering more than 100, and the
dkato 0:ee40da884cfc 142 Document's license notice requires Cover Texts, you must enclose the
dkato 0:ee40da884cfc 143 copies in covers that carry, clearly and legibly, all these Cover
dkato 0:ee40da884cfc 144 Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
dkato 0:ee40da884cfc 145 the back cover. Both covers must also clearly and legibly identify
dkato 0:ee40da884cfc 146 you as the publisher of these copies. The front cover must present
dkato 0:ee40da884cfc 147 the full title with all words of the title equally prominent and
dkato 0:ee40da884cfc 148 visible. You may add other material on the covers in addition.
dkato 0:ee40da884cfc 149 Copying with changes limited to the covers, as long as they preserve
dkato 0:ee40da884cfc 150 the title of the Document and satisfy these conditions, can be treated
dkato 0:ee40da884cfc 151 as verbatim copying in other respects.
dkato 0:ee40da884cfc 152
dkato 0:ee40da884cfc 153 If the required texts for either cover are too voluminous to fit
dkato 0:ee40da884cfc 154 legibly, you should put the first ones listed (as many as fit
dkato 0:ee40da884cfc 155 reasonably) on the actual cover, and continue the rest onto adjacent
dkato 0:ee40da884cfc 156 pages.
dkato 0:ee40da884cfc 157
dkato 0:ee40da884cfc 158 If you publish or distribute Opaque copies of the Document numbering
dkato 0:ee40da884cfc 159 more than 100, you must either include a machine-readable Transparent
dkato 0:ee40da884cfc 160 copy along with each Opaque copy, or state in or with each Opaque copy
dkato 0:ee40da884cfc 161 a computer-network location from which the general network-using
dkato 0:ee40da884cfc 162 public has access to download using public-standard network protocols
dkato 0:ee40da884cfc 163 a complete Transparent copy of the Document, free of added material.
dkato 0:ee40da884cfc 164 If you use the latter option, you must take reasonably prudent steps,
dkato 0:ee40da884cfc 165 when you begin distribution of Opaque copies in quantity, to ensure
dkato 0:ee40da884cfc 166 that this Transparent copy will remain thus accessible at the stated
dkato 0:ee40da884cfc 167 location until at least one year after the last time you distribute an
dkato 0:ee40da884cfc 168 Opaque copy (directly or through your agents or retailers) of that
dkato 0:ee40da884cfc 169 edition to the public.
dkato 0:ee40da884cfc 170
dkato 0:ee40da884cfc 171 It is requested, but not required, that you contact the authors of the
dkato 0:ee40da884cfc 172 Document well before redistributing any large number of copies, to give
dkato 0:ee40da884cfc 173 them a chance to provide you with an updated version of the Document.
dkato 0:ee40da884cfc 174
dkato 0:ee40da884cfc 175
dkato 0:ee40da884cfc 176 4. MODIFICATIONS
dkato 0:ee40da884cfc 177
dkato 0:ee40da884cfc 178 You may copy and distribute a Modified Version of the Document under
dkato 0:ee40da884cfc 179 the conditions of sections 2 and 3 above, provided that you release
dkato 0:ee40da884cfc 180 the Modified Version under precisely this License, with the Modified
dkato 0:ee40da884cfc 181 Version filling the role of the Document, thus licensing distribution
dkato 0:ee40da884cfc 182 and modification of the Modified Version to whoever possesses a copy
dkato 0:ee40da884cfc 183 of it. In addition, you must do these things in the Modified Version:
dkato 0:ee40da884cfc 184
dkato 0:ee40da884cfc 185 A. Use in the Title Page (and on the covers, if any) a title distinct
dkato 0:ee40da884cfc 186 from that of the Document, and from those of previous versions
dkato 0:ee40da884cfc 187 (which should, if there were any, be listed in the History section
dkato 0:ee40da884cfc 188 of the Document). You may use the same title as a previous version
dkato 0:ee40da884cfc 189 if the original publisher of that version gives permission.
dkato 0:ee40da884cfc 190 B. List on the Title Page, as authors, one or more persons or entities
dkato 0:ee40da884cfc 191 responsible for authorship of the modifications in the Modified
dkato 0:ee40da884cfc 192 Version, together with at least five of the principal authors of the
dkato 0:ee40da884cfc 193 Document (all of its principal authors, if it has fewer than five),
dkato 0:ee40da884cfc 194 unless they release you from this requirement.
dkato 0:ee40da884cfc 195 C. State on the Title page the name of the publisher of the
dkato 0:ee40da884cfc 196 Modified Version, as the publisher.
dkato 0:ee40da884cfc 197 D. Preserve all the copyright notices of the Document.
dkato 0:ee40da884cfc 198 E. Add an appropriate copyright notice for your modifications
dkato 0:ee40da884cfc 199 adjacent to the other copyright notices.
dkato 0:ee40da884cfc 200 F. Include, immediately after the copyright notices, a license notice
dkato 0:ee40da884cfc 201 giving the public permission to use the Modified Version under the
dkato 0:ee40da884cfc 202 terms of this License, in the form shown in the Addendum below.
dkato 0:ee40da884cfc 203 G. Preserve in that license notice the full lists of Invariant Sections
dkato 0:ee40da884cfc 204 and required Cover Texts given in the Document's license notice.
dkato 0:ee40da884cfc 205 H. Include an unaltered copy of this License.
dkato 0:ee40da884cfc 206 I. Preserve the section Entitled "History", Preserve its Title, and add
dkato 0:ee40da884cfc 207 to it an item stating at least the title, year, new authors, and
dkato 0:ee40da884cfc 208 publisher of the Modified Version as given on the Title Page. If
dkato 0:ee40da884cfc 209 there is no section Entitled "History" in the Document, create one
dkato 0:ee40da884cfc 210 stating the title, year, authors, and publisher of the Document as
dkato 0:ee40da884cfc 211 given on its Title Page, then add an item describing the Modified
dkato 0:ee40da884cfc 212 Version as stated in the previous sentence.
dkato 0:ee40da884cfc 213 J. Preserve the network location, if any, given in the Document for
dkato 0:ee40da884cfc 214 public access to a Transparent copy of the Document, and likewise
dkato 0:ee40da884cfc 215 the network locations given in the Document for previous versions
dkato 0:ee40da884cfc 216 it was based on. These may be placed in the "History" section.
dkato 0:ee40da884cfc 217 You may omit a network location for a work that was published at
dkato 0:ee40da884cfc 218 least four years before the Document itself, or if the original
dkato 0:ee40da884cfc 219 publisher of the version it refers to gives permission.
dkato 0:ee40da884cfc 220 K. For any section Entitled "Acknowledgements" or "Dedications",
dkato 0:ee40da884cfc 221 Preserve the Title of the section, and preserve in the section all
dkato 0:ee40da884cfc 222 the substance and tone of each of the contributor acknowledgements
dkato 0:ee40da884cfc 223 and/or dedications given therein.
dkato 0:ee40da884cfc 224 L. Preserve all the Invariant Sections of the Document,
dkato 0:ee40da884cfc 225 unaltered in their text and in their titles. Section numbers
dkato 0:ee40da884cfc 226 or the equivalent are not considered part of the section titles.
dkato 0:ee40da884cfc 227 M. Delete any section Entitled "Endorsements". Such a section
dkato 0:ee40da884cfc 228 may not be included in the Modified Version.
dkato 0:ee40da884cfc 229 N. Do not retitle any existing section to be Entitled "Endorsements"
dkato 0:ee40da884cfc 230 or to conflict in title with any Invariant Section.
dkato 0:ee40da884cfc 231 O. Preserve any Warranty Disclaimers.
dkato 0:ee40da884cfc 232
dkato 0:ee40da884cfc 233 If the Modified Version includes new front-matter sections or
dkato 0:ee40da884cfc 234 appendices that qualify as Secondary Sections and contain no material
dkato 0:ee40da884cfc 235 copied from the Document, you may at your option designate some or all
dkato 0:ee40da884cfc 236 of these sections as invariant. To do this, add their titles to the
dkato 0:ee40da884cfc 237 list of Invariant Sections in the Modified Version's license notice.
dkato 0:ee40da884cfc 238 These titles must be distinct from any other section titles.
dkato 0:ee40da884cfc 239
dkato 0:ee40da884cfc 240 You may add a section Entitled "Endorsements", provided it contains
dkato 0:ee40da884cfc 241 nothing but endorsements of your Modified Version by various
dkato 0:ee40da884cfc 242 parties--for example, statements of peer review or that the text has
dkato 0:ee40da884cfc 243 been approved by an organization as the authoritative definition of a
dkato 0:ee40da884cfc 244 standard.
dkato 0:ee40da884cfc 245
dkato 0:ee40da884cfc 246 You may add a passage of up to five words as a Front-Cover Text, and a
dkato 0:ee40da884cfc 247 passage of up to 25 words as a Back-Cover Text, to the end of the list
dkato 0:ee40da884cfc 248 of Cover Texts in the Modified Version. Only one passage of
dkato 0:ee40da884cfc 249 Front-Cover Text and one of Back-Cover Text may be added by (or
dkato 0:ee40da884cfc 250 through arrangements made by) any one entity. If the Document already
dkato 0:ee40da884cfc 251 includes a cover text for the same cover, previously added by you or
dkato 0:ee40da884cfc 252 by arrangement made by the same entity you are acting on behalf of,
dkato 0:ee40da884cfc 253 you may not add another; but you may replace the old one, on explicit
dkato 0:ee40da884cfc 254 permission from the previous publisher that added the old one.
dkato 0:ee40da884cfc 255
dkato 0:ee40da884cfc 256 The author(s) and publisher(s) of the Document do not by this License
dkato 0:ee40da884cfc 257 give permission to use their names for publicity for or to assert or
dkato 0:ee40da884cfc 258 imply endorsement of any Modified Version.
dkato 0:ee40da884cfc 259
dkato 0:ee40da884cfc 260
dkato 0:ee40da884cfc 261 5. COMBINING DOCUMENTS
dkato 0:ee40da884cfc 262
dkato 0:ee40da884cfc 263 You may combine the Document with other documents released under this
dkato 0:ee40da884cfc 264 License, under the terms defined in section 4 above for modified
dkato 0:ee40da884cfc 265 versions, provided that you include in the combination all of the
dkato 0:ee40da884cfc 266 Invariant Sections of all of the original documents, unmodified, and
dkato 0:ee40da884cfc 267 list them all as Invariant Sections of your combined work in its
dkato 0:ee40da884cfc 268 license notice, and that you preserve all their Warranty Disclaimers.
dkato 0:ee40da884cfc 269
dkato 0:ee40da884cfc 270 The combined work need only contain one copy of this License, and
dkato 0:ee40da884cfc 271 multiple identical Invariant Sections may be replaced with a single
dkato 0:ee40da884cfc 272 copy. If there are multiple Invariant Sections with the same name but
dkato 0:ee40da884cfc 273 different contents, make the title of each such section unique by
dkato 0:ee40da884cfc 274 adding at the end of it, in parentheses, the name of the original
dkato 0:ee40da884cfc 275 author or publisher of that section if known, or else a unique number.
dkato 0:ee40da884cfc 276 Make the same adjustment to the section titles in the list of
dkato 0:ee40da884cfc 277 Invariant Sections in the license notice of the combined work.
dkato 0:ee40da884cfc 278
dkato 0:ee40da884cfc 279 In the combination, you must combine any sections Entitled "History"
dkato 0:ee40da884cfc 280 in the various original documents, forming one section Entitled
dkato 0:ee40da884cfc 281 "History"; likewise combine any sections Entitled "Acknowledgements",
dkato 0:ee40da884cfc 282 and any sections Entitled "Dedications". You must delete all sections
dkato 0:ee40da884cfc 283 Entitled "Endorsements".
dkato 0:ee40da884cfc 284
dkato 0:ee40da884cfc 285
dkato 0:ee40da884cfc 286 6. COLLECTIONS OF DOCUMENTS
dkato 0:ee40da884cfc 287
dkato 0:ee40da884cfc 288 You may make a collection consisting of the Document and other documents
dkato 0:ee40da884cfc 289 released under this License, and replace the individual copies of this
dkato 0:ee40da884cfc 290 License in the various documents with a single copy that is included in
dkato 0:ee40da884cfc 291 the collection, provided that you follow the rules of this License for
dkato 0:ee40da884cfc 292 verbatim copying of each of the documents in all other respects.
dkato 0:ee40da884cfc 293
dkato 0:ee40da884cfc 294 You may extract a single document from such a collection, and distribute
dkato 0:ee40da884cfc 295 it individually under this License, provided you insert a copy of this
dkato 0:ee40da884cfc 296 License into the extracted document, and follow this License in all
dkato 0:ee40da884cfc 297 other respects regarding verbatim copying of that document.
dkato 0:ee40da884cfc 298
dkato 0:ee40da884cfc 299
dkato 0:ee40da884cfc 300 7. AGGREGATION WITH INDEPENDENT WORKS
dkato 0:ee40da884cfc 301
dkato 0:ee40da884cfc 302 A compilation of the Document or its derivatives with other separate
dkato 0:ee40da884cfc 303 and independent documents or works, in or on a volume of a storage or
dkato 0:ee40da884cfc 304 distribution medium, is called an "aggregate" if the copyright
dkato 0:ee40da884cfc 305 resulting from the compilation is not used to limit the legal rights
dkato 0:ee40da884cfc 306 of the compilation's users beyond what the individual works permit.
dkato 0:ee40da884cfc 307 When the Document is included in an aggregate, this License does not
dkato 0:ee40da884cfc 308 apply to the other works in the aggregate which are not themselves
dkato 0:ee40da884cfc 309 derivative works of the Document.
dkato 0:ee40da884cfc 310
dkato 0:ee40da884cfc 311 If the Cover Text requirement of section 3 is applicable to these
dkato 0:ee40da884cfc 312 copies of the Document, then if the Document is less than one half of
dkato 0:ee40da884cfc 313 the entire aggregate, the Document's Cover Texts may be placed on
dkato 0:ee40da884cfc 314 covers that bracket the Document within the aggregate, or the
dkato 0:ee40da884cfc 315 electronic equivalent of covers if the Document is in electronic form.
dkato 0:ee40da884cfc 316 Otherwise they must appear on printed covers that bracket the whole
dkato 0:ee40da884cfc 317 aggregate.
dkato 0:ee40da884cfc 318
dkato 0:ee40da884cfc 319
dkato 0:ee40da884cfc 320 8. TRANSLATION
dkato 0:ee40da884cfc 321
dkato 0:ee40da884cfc 322 Translation is considered a kind of modification, so you may
dkato 0:ee40da884cfc 323 distribute translations of the Document under the terms of section 4.
dkato 0:ee40da884cfc 324 Replacing Invariant Sections with translations requires special
dkato 0:ee40da884cfc 325 permission from their copyright holders, but you may include
dkato 0:ee40da884cfc 326 translations of some or all Invariant Sections in addition to the
dkato 0:ee40da884cfc 327 original versions of these Invariant Sections. You may include a
dkato 0:ee40da884cfc 328 translation of this License, and all the license notices in the
dkato 0:ee40da884cfc 329 Document, and any Warranty Disclaimers, provided that you also include
dkato 0:ee40da884cfc 330 the original English version of this License and the original versions
dkato 0:ee40da884cfc 331 of those notices and disclaimers. In case of a disagreement between
dkato 0:ee40da884cfc 332 the translation and the original version of this License or a notice
dkato 0:ee40da884cfc 333 or disclaimer, the original version will prevail.
dkato 0:ee40da884cfc 334
dkato 0:ee40da884cfc 335 If a section in the Document is Entitled "Acknowledgements",
dkato 0:ee40da884cfc 336 "Dedications", or "History", the requirement (section 4) to Preserve
dkato 0:ee40da884cfc 337 its Title (section 1) will typically require changing the actual
dkato 0:ee40da884cfc 338 title.
dkato 0:ee40da884cfc 339
dkato 0:ee40da884cfc 340
dkato 0:ee40da884cfc 341 9. TERMINATION
dkato 0:ee40da884cfc 342
dkato 0:ee40da884cfc 343 You may not copy, modify, sublicense, or distribute the Document except
dkato 0:ee40da884cfc 344 as expressly provided for under this License. Any other attempt to
dkato 0:ee40da884cfc 345 copy, modify, sublicense or distribute the Document is void, and will
dkato 0:ee40da884cfc 346 automatically terminate your rights under this License. However,
dkato 0:ee40da884cfc 347 parties who have received copies, or rights, from you under this
dkato 0:ee40da884cfc 348 License will not have their licenses terminated so long as such
dkato 0:ee40da884cfc 349 parties remain in full compliance.
dkato 0:ee40da884cfc 350
dkato 0:ee40da884cfc 351
dkato 0:ee40da884cfc 352 10. FUTURE REVISIONS OF THIS LICENSE
dkato 0:ee40da884cfc 353
dkato 0:ee40da884cfc 354 The Free Software Foundation may publish new, revised versions
dkato 0:ee40da884cfc 355 of the GNU Free Documentation License from time to time. Such new
dkato 0:ee40da884cfc 356 versions will be similar in spirit to the present version, but may
dkato 0:ee40da884cfc 357 differ in detail to address new problems or concerns. See
dkato 0:ee40da884cfc 358 http://www.gnu.org/copyleft/.
dkato 0:ee40da884cfc 359
dkato 0:ee40da884cfc 360 Each version of the License is given a distinguishing version number.
dkato 0:ee40da884cfc 361 If the Document specifies that a particular numbered version of this
dkato 0:ee40da884cfc 362 License "or any later version" applies to it, you have the option of
dkato 0:ee40da884cfc 363 following the terms and conditions either of that specified version or
dkato 0:ee40da884cfc 364 of any later version that has been published (not as a draft) by the
dkato 0:ee40da884cfc 365 Free Software Foundation. If the Document does not specify a version
dkato 0:ee40da884cfc 366 number of this License, you may choose any version ever published (not
dkato 0:ee40da884cfc 367 as a draft) by the Free Software Foundation.
dkato 0:ee40da884cfc 368
dkato 0:ee40da884cfc 369
dkato 0:ee40da884cfc 370 ADDENDUM: How to use this License for your documents
dkato 0:ee40da884cfc 371
dkato 0:ee40da884cfc 372 To use this License in a document you have written, include a copy of
dkato 0:ee40da884cfc 373 the License in the document and put the following copyright and
dkato 0:ee40da884cfc 374 license notices just after the title page:
dkato 0:ee40da884cfc 375
dkato 0:ee40da884cfc 376 Copyright (c) YEAR YOUR NAME.
dkato 0:ee40da884cfc 377 Permission is granted to copy, distribute and/or modify this document
dkato 0:ee40da884cfc 378 under the terms of the GNU Free Documentation License, Version 1.2
dkato 0:ee40da884cfc 379 or any later version published by the Free Software Foundation;
dkato 0:ee40da884cfc 380 with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
dkato 0:ee40da884cfc 381 A copy of the license is included in the section entitled "GNU
dkato 0:ee40da884cfc 382 Free Documentation License".
dkato 0:ee40da884cfc 383
dkato 0:ee40da884cfc 384 If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
dkato 0:ee40da884cfc 385 replace the "with...Texts." line with this:
dkato 0:ee40da884cfc 386
dkato 0:ee40da884cfc 387 with the Invariant Sections being LIST THEIR TITLES, with the
dkato 0:ee40da884cfc 388 Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
dkato 0:ee40da884cfc 389
dkato 0:ee40da884cfc 390 If you have Invariant Sections without Cover Texts, or some other
dkato 0:ee40da884cfc 391 combination of the three, merge those two alternatives to suit the
dkato 0:ee40da884cfc 392 situation.
dkato 0:ee40da884cfc 393
dkato 0:ee40da884cfc 394 If your document contains nontrivial examples of program code, we
dkato 0:ee40da884cfc 395 recommend releasing these examples in parallel under your choice of
dkato 0:ee40da884cfc 396 free software license, such as the GNU General Public License,
dkato 0:ee40da884cfc 397 to permit their use in free software.