← Back to branch summary

~ubuntu-branches/ubuntu/lucid/ecasound2.2/lucid

« back to all changes in this revision

Viewing changes to Documentation/users_guide/users_guide.latex

  • Committer: Bazaar Package Importer
  • Author(s): Junichi Uekawa
  • Date: 2008-09-26 09:58:52 UTC
  • mfrom: (1.1.6 upstream)
  • Revision ID: james.westby@ubuntu.com-20080926095852-k3v9ewhmxpaltusw
Tags: 2.5.2-3
yodl 2.13.1 removed --unique-output option. Remove --unique-output
accordingly.

Show diffs side-by-side

added added

removed removed

Lines of Context:
Documentation/users_guide/users_guide.latex
5
5
 
6
6
\title{Ecasound User's Guide}
7
7
\author{Kai Vehmanen}
8
 
\date{06122006}
 
8
\date{05082008}
9
9
\begin{document}
10
10
 
11
11
\maketitle
30
30
% ----------------------------------------------------------------------
31
31
\chapter{Document history}
32
32
\begin{itemize}
 
33
\item 05.08.2008 - Fixed a bug in example of loop device usage.
 
34
\item 09.03.2008 - Updated the EWF file section. Replace uses of ``/dev/dsp''
 
35
                   with ``alsa'' in many examples.
33
36
\item 06.12.2006 - Added notes concerning quoting EOS arguments containing
34
37
                   commas.
35
38
\item 04.06.2006 - Some minor improvements to the text. Updated the descriptions of
358
361
ecasound -a:1 -i:monofile1.wav -erc:1,2 -epp:0 \
359
362
         -a:2 -i:monofile2.wav -erc:1,2 -epp:50 \
360
363
         -a:3 -i:monofile3.wav -erc:1,2 -epp:100 \
361
 
         -a:all -f:16,2,44100 -o:/dev/dsp
 
364
         -a:all -f:16,2,44100 -o:alsa
362
365
\end{verbatim}
363
366
 
364
367
The actual signal chain is something like:
367
370
monofile1.wav |--'1'---- erc ----| epp |---\
368
371
                           \-----|     |---\\
369
372
                                            \\
370
 
monofile2.wav |--'2'---- erc ----| epp |------- | /dev/dsp
371
 
                           \-----|     |------- |�
 
373
monofile2.wav |--'2'---- erc ----| epp |------- | alsa
 
374
                           \-----|     |------- |
372
375
                                            //
373
376
monofile3.wav |--'3'---- erc ----| epp |---//
374
377
                           \-----|     |---/
477
480
 
478
481
\begin{verbatim}
479
482
# increased refresh rate 20Hz
480
 
ecasignalview -r:50 /dev/dsp null
 
483
ecasignalview -r:50 alsa null
481
484
 
482
485
# larger buffersize (1024 samples)
483
 
ecasignalview -b:1024 /dev/dsp null
 
486
ecasignalview -b:1024 alsa null
484
487
 
485
488
# recording in mode 32bit/10channels/96000Hz with
486
489
# interleaved channels 
487
 
ecasignalview -f:s32,10,96000,i /dev/dsp null
 
490
ecasignalview -f:s32,10,96000,i alsa null
488
491
\end{verbatim}
489
492
 
490
493
\subsection{Monitoring Non-realtime Sources}
520
523
\subsection{Example of use}
521
524
 
522
525
An example use-case where we route audio from chains ``1'' and ``2''
523
 
to chain ``3'' which is connected to a soundcard output.
 
526
to chain ``3'' which is amplified and send to a soundcard output (``alsa'').
524
527
 
525
528
\begin{verbatim} 
526
529
--cut--
527
530
# note, the second loop parameter is the loop id-number;
528
531
# it is used to associate loop inputs with correct loop outputs
529
 
ecasound -a:1 -i:some.mp3 -o:loop,1
530
 
         -a:2 -i:another.mp3 -o:loop,1
531
 
         -a:3 -i:loop,1 -o /dev/dsp -ea:200
 
532
ecasound -a:1 -i:some.mp3 
 
533
         -a:2 -i:another.mp3 
 
534
         -a:1,2 -o:loop,1
 
535
         -a:3 -ea:200 -i:loop,1 -o alsa
532
536
--cut--
533
537
 
534
538
\end{verbatim}
538
542
adds latency (-b:x -> latency of x frames). 
539
543
 
540
544
% ----------------------------------------------------------------------
541
 
\section{Ecasound wave files - the .ewf format}
 
545
\section{Ecasound Wave Files - the EWF (.ewf) format}
542
546
 
543
547
\subsection{General}
544
548
 
545
 
Ecasound wave file (.ewf) is a simple wrapper format for controlling 
 
549
Ecasound Wave File (.ewf) is a simple wrapper format for controlling 
546
550
other audio objects. Ewf files are useful for offsetting or time-shifting
547
551
audio files (for instance play a short audio clip in the middle of 
548
552
a long multitrack mix), for minimizing diskspace usage during
549
553
multitrack recording (output offsetting ) and looping.
550
554
 
 
555
Starting from Ecasound version 2.5.0, similar functionality is
 
556
provided by special purpose audio object types 'audioloop', 'audioselect'
 
557
and others. You may choose between EWF and these audio object types
 
558
based on your specific needs.
 
559
 
 
560
Writing to EWF file is nowadays considered to be a deprecated
 
561
feature and it may be removed in a future release.
 
562
 
551
563
\subsection{File format}
552
564
 
553
565
Ewf-files are stored in ascii format. The syntax is based on ``key=value''
556
568
recognized ewf keywords are:
557
569
 
558
570
\begin{itemize}
559
 
\item  source - audio object name {[}read,write{]}
560
 
\item  offset - insert audio object at offset (seconds) {[}read,write{]} 
561
 
\item  start-position - start offset inside audio object (seconds) {[}read{]}
562
 
\item  length - how much of audio object data is used (seconds) {[}read{]}
 
571
\item  source - audio object name (string) {[}read,write{]}
 
572
\item  offset - insert audio object at offset (time) {[}read,write{]} 
 
573
\item  start-position - start offset inside audio object (time) {[}read{]}
 
574
\item  length - how much of audio object data is used (time) {[}read{]}
563
575
\item  looping - whether to loop sample data (true or false) {[}read{]}
564
576
\end{itemize}
565
577
 
 
578
All time values are interpreted as seconds (need not be an integer
 
579
but can be given as a decimal number, e.g. ``1.05''). However if 
 
580
the value is an integer number and has a postfix of ``sa'' (e.g. 
 
581
``44100sa''), it is interpreted as time expressed as samples (in
 
582
case of a multichannel stream, time in sample frames).
 
583
 
566
584
\subsection{Example of ewf use}
567
585
 
568
586
Let's look at a simple example .ewf file:
577
595
--cut--
578
596
\end{verbatim} 
579
597
 
580
 
Now what happens when you issue "ecasound -i test.ewf -o /dev/dsp"? 
 
598
Now what happens when you issue "ecasound -i test.ewf -o alsa"? 
581
599
Because of the ``offset'' definition, the first 5 seconds will be 
582
600
silent. After that ecasound will start to read data from ``test.wav''.
583
601
But as ``start-position'' is not zero, ecasound will skip the 
628
646
--cut--
629
647
ecasound -a:1 -i:some.mp3 -pf:bassbooster.ecp
630
648
         -a:2 -i:another.mp3 -pf:bassbooster.ecp
631
 
         -a:1,2 -o:/dev/dsp
 
649
         -a:1,2 -o:alsa
632
650
--cut--
633
651
 \end{verbatim} 
634
652
 
647
665
--cut--
648
666
ecasound -a:1 -i:some.mp3 -pn:bassbooster
649
667
         -a:2 -i:another.mp3 -pn:bassbooster
650
 
         -a:1,2 -o:/dev/dsp
 
668
         -a:1,2 -o:alsa
651
669
--cut--
652
670
\end{verbatim} 
653
671
 
669
687
 
670
688
\begin{verbatim}
671
689
--cut--
672
 
ecasound -i:foo.mp3 -o:/dev/dsp -pn:f_res_lowpass,800
673
 
ecasound -i:foo.mp3 -o:/dev/dsp -ef3:800,1.5,0.7
 
690
ecasound -i:foo.mp3 -o:alsa -pn:f_res_lowpass,800
 
691
ecasound -i:foo.mp3 -o:alsa -ef3:800,1.5,0.7
674
692
--cut--
675
693
\end{verbatim}
676
694