Summer Coding 2010 proposal - Fedora Musicians' Guide

About my Project

 * Name: Fedora Musicians' Guide
 * Idea Page: Summer Coding 2010 ideas - Fedora Musicians' Guide
 * Proposed Language: English

Description
The goal of this project is to create a user guide for music and audio programs on Fedora Linux. The guide will illustrate both basic and advanced uses of leading open-source audio software, in an attempt to address problems and questions faced by musicians who use computers as a creative platform. This gives the guide a specific target audience: well-trained musicians with little or no knowledge of Linux, who are capable of similar tasks with commercial software applications on Windows or Mac OS X. These users traditionally pay large sums of money for closed-source software, so this guide will show that the specialized software applications required by these users are available and operable on Linux.

The target audience requires a specific mode of writing, where the technological implications of their actions will be fully explained, and the musical implications will be mostly absent. I do not believe that this renders the guide inaccessible to laypeople: it is always the user's responsibility to decide what to do; this guide will show them how to do it. Furthermore, a concerted effort will be made to ensure that every task has an obvious outcome, so that any sufficiently interested user will be able to benefit from using this guide.

The document will be written on the Fedora Wiki, with a probable transition to DocBook XML and Publican.

Note that my 'convincing paragraph' is here.

Impact on the Fedora Community

 * Me: The creation of this Guide will allow the Fedora Project to target a new user base, which would otherwise be unlikely to switch. Certain sections of the Guide may help to illustrate the shortcomings of audio and music software on Fedora or Linux, giving other contributors a set of areas to focus attention.  Conversely, certain sections may highlight some of Fedora's (or Linux's) hidden strengths - areas that Fedora can advertise its advanced capabilities.  I expect this to be the case with most of the programs, because few musicians know about them - or how to use them - but many are of very high quality.
 * Mentor: This guide will present Fedora as a useful tool for creators and performers of music. I believe that this will expand the Fedora community into a specific class of users for whom we have offered little formal support up to now. As Christopher points out, it also assists the existing Fedora community by identifying specific shortcomings and unresolved problems. Rlandmann 23:34, 18 May 2010 (UTC)
 * Community Member: "As a graduate student in music and through my lengthy experience with closed-source music software, I can see several positive ways in which the completion of this guide could benefit the Fedora and music communities. Firstly, the guide would make open-source programs like LilyPond more accessible and easier to understand. As a result, I believe that more musicians would be willing to convert to these programs rather than to pay big sums of money for closed-sourced programs that do the same thing. As well, I think that this guide would allow amateur and professional musicians to explore other aspects of music-making by discovering programs through this guide that would let them do so." (Vivian L., email: vivluong from Google's free webmail service)

How I Will Keep the Community Informed of my Progress
In addition to blogging twice a week, I intend to publish a weekly summary of my activities to select newsgroups (at least summer-coding-discuss, and perhaps also music@fedora, docs@fedora, or Planet CCRMA). Furthermore, all of my development will take place publicly on the Fedora Wiki. This will inevitably lead to some confusion, and temporarily poorly-organized wiki pages, but it has the benefits that I can carry out development from any computer, that it is an established platform for community interaction, and that anybody has the ability to monitor and contribute to the project's progress. Also, it allows the widest possible target-audience testing. A regularly-updated, detailed schedule on the wiki will help observers to track my progress.

How I Will Solve Problems if my Mentor(s) Is/Are not Available
This is obviously a difficult situation, and it is one of the reasons that I chose the development method above. Because of this, some people may already be watching; if they aren't, then it will be easy for me to show them where I'm having trouble. Another key strategy, which will hopefully help avoid becoming stuck in the first place, is to read other, similar documents, for this and other operating systems. By reading existing documentation, I hope to avoid pitfalls that may limit the usefulness of this existing documentation. Of course, IRC channels, mailing lists, and internet search engines are an obvious possibility.

I Believe in Myself!
As a student of music history and theory, much of my livelihood involves managing large research projects. As a keen user of Linux for most of this time (and of Mac OS X for the rest of it), I have grown accustomed to using open-source tools to wholly or partly complete these projects. Furthermore, a scholarly paper and a user guide are both large documents, written with a specific purpose in mind. They both require a great deal of thought, planning, and organization on the part of the author(s). They both also require great attention to detail, and it is here where my musical training will help the most. Attention to detail is part of what makes or breaks the career of a Western classical musician. Many years of musical training - followed by four years of study at a university - have taught me quite a lot about rehearsing every possibility multiple times, just in case it fails once or twice. This unique perspective, primarily as a musician rather than a computer programmer, is the reason that I believe my abilities are well-suited to this task.

Definitions
I use the following terms in the following ways.
 * Tutorial: One topic or process covered in the guide, such as "Installation of Ardour."
 * Tutorial algorithm: The steps to be followed in each tutorial, such as:
 * Open Terminal.
 * Type
 * When it stops, type
 * Wait for updating.
 * Target-audience testing: Testing to ensure that members of the document's target audience group will be able to use the document as intended.

Schedule, by Project Week Number

 * 1) (28 - 30 May):
 * 2) * Write message and find subjects for tutorial-algorithm testing, and target-audience testing.
 * 3) * Create development/testing environments (list is for personal reference):
 * 4) ** Fedora 13 x64 (KDE only) on fwt
 * 5) ** Fedora 13 i686 (KDE only) on hp
 * 6) ** Fedora 13 x64 (KDE) in vbox
 * 7) ** Fedora 13 x64 (GNOME) in vbox
 * 8) ** Fedora 13 x64 (XFCE) in vbox
 * 9) ** Fedora 13 i686 (KDE) in vbox
 * 10) ** Fedora 13 i686 (GNOME) in vbox
 * 11) ** Fedora 13 i686 (XFCE) in vbox
 * 12) (31 May - 6 June):
 * 13) * Finalize tutorial topics, revising schedule as needed.
 * 14) * Compile list of users/platforms willing to help with testing.
 * 15) * Begin Writing Tutorial Algorithms (these will require less research):
 * 16) ** Sound Servers: JACK
 * 17) ** Sound Servers: PulseAudio
 * 18) ** Planet CCRMA: Repository Configuration
 * 19) ** Recording: Audacity
 * 20) ** Synthesizers: SuperCollider
 * 21) ** Typesetting: LilyPond
 * 22) ** Typesetting: Frescobaldi
 * 23) (7 - 13 June):
 * 24) * Test previous week's tutorial algorithms.
 * 25) * Finish writing tutorial algorithms (these will require more research):
 * 26) ** Recording: Ardour
 * 27) ** Synthesizers: FluidSynth/QSynth
 * 28) ** Synthesizers: Rosegarden
 * 29) ** Synthesizers: Qtractor
 * 30) ** Training: GNU Solfege
 * 31) (14 - 20 June):
 * 32) * Test previous week's tutorial algorithms.
 * 33) * Review algorithms, seeking possible mistakes or pitfalls, and forewarn about them.
 * 34) * Buffer week.
 * 35) (21 - 27 June):
 * 36) * Ensure contact is made with the Docs SIG about the evolution to an "official" document.
 * 37) * Begin writing documents on the Fedora Wiki (algorithms will already be on the Wiki):
 * 38) ** Sound Cards
 * 39) ** Sound Servers: ALSA, Phonon, and Informational Background
 * 40) ** Sound Servers: JACK
 * 41) ** Sound Servers: PulseAudio
 * 42) ** Planet CCRMA: Informational Background
 * 43) ** Planet CCRMA: Repository Configuration
 * 44) ** Recording: Audacity vs. Ardour
 * 45) ** Recording: Audacity
 * 46) ** Synthesizers: SuperCollider
 * 47) ** Typesetting: LilyPond
 * 48) ** Typesetting: Frescobaldi
 * 49) (28 June - 4 July): Week of Canada Day
 * 50) * Finish writing documents on the Fedora Wiki:
 * 51) ** Recording: Ardour
 * 52) ** Synthesizers: FluidSynth/QSynth
 * 53) ** Synthesizers: Rosegarden
 * 54) ** Synthesizers: Qtractor
 * 55) ** Training: GNU Solfege
 * 56) * Begin target-audience testing with previous week's material.
 * 57) (5 - 11 July): Midterm
 * 58) * Continue target-audience testing.
 * 59) * Revise documents to incorporate target-audience comments.
 * 60) * Must have found editor, if the Guide is to be turned into an "official" document.
 * 61) * Write midterm report, due on 12 July.
 * 62) (12 - 18 July):
 * 63) * Finish target-audience testing.
 * 64) * Finish revising documents to incorporate comments of target-audience tests.
 * 65) (19 - 25 July):
 * 66) * Convert document to DocBook XML?
 * 67) * Write and Test Optional Sections (Algorithms):
 * 68) ** Kernel Optimization
 * 69) ** Webcasting: Icecast
 * 70) (26 July - 1 August):
 * 71) * Finish converting to DocBook XML?
 * 72) * Write and Test Optional Sections (Prose):
 * 73) ** Kernel Optimization
 * 74) ** Webcasting: Icecast
 * 75) (2 - 8 August): Week of Another Long Weekend:
 * 76) * This is a buffer week, which shall receive no assigned task (except optional tasks).
 * 77) * Convert Optional Sections to DocBook XML
 * 78) (9 August): Project Completion.
 * 79) * Write final report, due 16 August.
 * 80) * Create "snapshot" of all documents, due 16 August.
 * 81) * Write evaluation, due 16 August.
 * 82) Return to real life.

Proposed Tutorial Topics
(1.) Topics marked as "optional" will be completed as time permits, during project weeks 9, 10, and 11. See the proposed schedule for details.

(2.) Where possible, I will avoid replication of material by referring to existing Fedora Project documentation.

System Tasks

 * Understanding Sound Cards
 * What Is a "Sound Card?"
 * How Do I Find Information about my audio interface? (optional)
 * How Do I Find Information about my MIDI interface? (optional)
 * How Do I Know Which Input/Output Port to Use?
 * Understanding Sound Servers
 * What a Sound Server Is
 * Advanced Linux Sound Architecture (ALSA)
 * What ALSA Is, and Why It Exists
 * PulseAudio
 * What PulseAudio Is, and Why It Exists
 * Knowing When to Use PulseAudio
 * How to Disable PulseAudio
 * How to Remove PulseAudio
 * JACK Advanced Connection Kit
 * What JACK Is, and Why It Exists
 * Knowing When to Use JACK
 * How to Setup Your System for JACK (will refer to kernel section, later)
 * Controlling JACK with QjackCtl
 * Phonon
 * What Phonon Is, and Why It Exists
 * Knowing When to Use Phonon
 * Planet CCRMA at Home
 * What Planet CCRMA Is, and Why It Exists
 * Knowing Whether You Should Use Planet CCRMA (including risks & benefits of third-party repositories)
 * Adding the Planet CCRMA Repositories
 * Downloading and Installing Software from Planet CCRMA
 * Optimizing the Linux Kernel for Audio Applications (optional, but highly desired - at least CCRMA)
 * What Is a Realtime Kernel? (including "What is processor scheduling?")
 * Using a Pre-built Realtime Kernel from Planet CCRMA (including "Planet CCRMA's kernels may be older than Fedora's")
 * Building Your Own Audio-Optimized Kernel (of course, with appropriate disclaimers)
 * Other Possible Optimizations (this will primarily be the removal of unused device drivers)

Audio Tasks

 * Recording
 * Knowing Whether to Use Audacity or Ardour
 * Audacity
 * Requirements and Installation
 * Configuration
 * Recording a Session
 * Saving and Exporting
 * Using Simple Effects
 * Ardour
 * Requirements and Installation
 * Configuration
 * Recording a Session
 * Saving and Exporting
 * Something Complex
 * Something else Complex
 * Synthesizers and Sequencers
 * SuperCollider
 * What Is SuperCollider?
 * The Different Parts of SC
 * Requirements and Installation
 * Using GEdit to write and run code/programs/music
 * Composing with SuperCollider (Method 1)
 * Composing with SuperCollider (Method 2) (N.B. these 'methods' are intended to help users learn compositional strategies... the software is not particularly inviting)
 * Exporting Sound Files
 * FluidSynth
 * What Is FluidSynth?
 * About SoundFonts?
 * Requirements and Installation
 * Configuration
 * QSynth: Introduction and Installation
 * Using JACK with FluidSynth
 * Redirecting Output for Recording
 * Qtractor & Rosegarden: These will be in separate sections, but I'll need to learn the programs better before deciding what to do.
 * Typesetting
 * LilyPond
 * What LilyPond Is
 * How LilyPond Works (and "LP is best used with other programs to help it")
 * Installation (and Configuration, if Required)
 * A Brief Introduction to LilyPond Syntax
 * Working on a Counterpoint Exercise (this is a simple score)
 * Working on a Piano Score (these can get quite complex; we'll focus on issues unique to piano music)
 * Working on an Large Ensemble Score (probably a work for orchestra; we'll focus on issues unique to large ensemble music)
 * Frescobaldi (N.B. this is a modified text editor for use specifically with LilyPond files)
 * What Frescobaldi Is, and How It Can Help
 * Installation and Configuration
 * The Basic Features of Frescobaldi
 * The Advanced Features of Frescobaldi
 * Aural Skills Training
 * GNU Solfege
 * I haven't used this in years, and it has changed quite a lot. I'll have to re-learn the software, then decide what to do.
 * Webcasting (highly optional - would make a great addition)
 * Darkice or Darksnow
 * Icecast Server
 * If I end up covering these applications, tutorial topics can be decided later.

Miscellaneous
-Can you set up an appropriate development environment?

Yes; this is not especially difficult.

-Have you met your proposed mentor and members of the associated community?

Yes, they are Rudi Landmann (docs) and Anthony Green (music). I have also been in contact with several mailing lists and IRC channels, and received a few interested responses.

-What is your t-shirt size?

Probably "M".

-Describe a great learning experience you had as a child

Although it is not a single experience, the time that I spent with computers as a child (at about 10-15 years old) has certainly helped to shape my character. I began by simply moving components between machines and changing settings, with no particular goal in mind. This gave me the confidence to begin programming, and eventually move to Linux. Once I did that, the open-source music programs available on Mandrake (yeah - Mandrake) helped me to learn about musical composition. The question, "What can I do to make a particular sound?" is one that still drives me today.

Comments
Add comment

Please see the discussion page for comments.