-
Notifications
You must be signed in to change notification settings - Fork 22
/
bongo.texi
1558 lines (1273 loc) · 62.9 KB
/
bongo.texi
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
\input texinfo @c -*- texinfo -*-
@c %**start of header
@setfilename bongo.info
@settitle Bongo Manual
@c %**end of header
@copying
@noindent
Copyright @copyright{} 2007 Daniel Brockman@*
Copyright @copyright{} 2007 Daniel Jensen
@quotation
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2 or
any later version published by the Free Software Foundation; with no
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled ``GNU FDL''.
@end quotation
@end copying
@titlepage
@title Bongo Manual
@page
@vskip 0pt plus 1filll
@insertcopying
@end titlepage
@contents
@dircategory Emacs
@direntry
* Bongo: (bongo). Play music with Emacs.
@end direntry
@ifnottex
@node Top
@top The Bongo Media Player
Bongo is a flexible and usable media player for GNU Emacs. This manual
describes how to use Bongo and some of how to customize and extend it.
@insertcopying
@end ifnottex
@menu
* Introduction:: An overview of basic Bongo concepts.
Using Bongo
* Inserting Tracks:: Populating your buffers with media.
* Playing Tracks:: Listening to audio and watching video.
* Enqueuing Tracks:: Picking tracks from libraries into playlists.
* Marking Tracks:: Choosing sets of tracks to operate on.
* Saving and Loading:: Storing Bongo buffers in files.
Advanced Topics
* The P/R/M Convention:: Convention used by many Bongo commands.
* Action Tracks:: Special tracks that perform actions.
Hacking Bongo
* Internals:: How Bongo works and how to hack it.
* Writing Backends:: Telling Bongo how to use other players.
Copying Bongo
* GNU GPL:: Conditions for copying and changing Bongo.
* GNU FDL:: The license for this documentation.
@detailmenu
Here are some other nodes which are really inferiors of the ones
already listed, mentioned here so you can get to them in one step:
Basics
* Tracks:: Media files, URIs, audio CDs, DVDs, etc.
* Backends:: External applications used to play tracks.
* Players:: External processes actually playing tracks.
* Playlists:: Buffers holding tracks to be played.
* Libraries:: Buffers holding entire media collections.
Playback
* Pausing:: Temporarily stopping playback.
* Stopping:: Permanently stopping playback.
* Seeking:: Rewinding or fast-forwarding tracks.
* Volume:: Changing the volume of your sound card.
* Switching Tracks:: Playing the next or previous track.
* Playback Modes:: Choosing the order in which tracks are played.
* Sprinkle Mode:: Keeping playlists populated with random tracks.
@end detailmenu
@end menu
@node Introduction
@chapter Introduction
You are reading about Bongo, a flexible and usable media player for GNU
Emacs. Bongo is flexible because it does not assume that you want to do
things in a certain way.
On the other hand, its default settings and key bindings are good and
carefully thought-out. So Bongo is usable because it does not force you
to come up with your own way of doing things.
To open a Bongo buffer, use @kbd{M-x bongo @key{RET}}. To switch
between playlist and library, use the @kbd{h}
(@code{bongo-switch-buffers}) command. There are a few different ways
to go from here.
@itemize @bullet
@item
One way to use Bongo is to go to a playlist, insert some tracks, and
just play those tracks in some order (@pxref{Playing Tracks}).
@item
Another way is to insert a lot of tracks into a library, and pick out
some of them into a playlist (@pxref{Enqueuing Tracks}).
@item
Yet another way is to let Bongo continuously pick out fresh random
tracks from the library into the playlist (@pxref{Sprinkle Mode}).
@end itemize
Five ideas central to Bongo are @dfn{tracks}, which represent media
resources; @dfn{backends}, which are applications used to play media;
@dfn{players}, which are instances of backends; and @dfn{playlists} and
@dfn{libraries}, which are buffers used to organize tracks.
The following sections explain these basic ideas in turn.
@menu
* Tracks:: Media files, URIs, audio CDs, DVDs, etc.
* Backends:: External applications used to play tracks.
* Players:: External processes actually playing tracks.
* Playlists:: Buffers holding tracks to be played.
* Libraries:: Buffers holding entire media collections.
@end menu
@node Tracks
@section Tracks
Bongo is a media player; its job is to play things. The things that it
plays are called @dfn{tracks}. Bongo tracks can represent local audio
and video files, remote media streams (such as internet radio stations),
audio CD tracks and DVD chapters.
There are even tracks that perform arbitrary actions when played
(@pxref{Action Tracks}). Such tracks may be used, for example, to force
playback to stop at certain points in a playlist.
To insert a local file track into a playlist or library, use @kbd{i}.
Other kinds can be inserted using @kbd{I} (@pxref{Inserting Tracks}).
@node Backends
@section Backends
Instead of actually attempting to decode media files to produce sound
and display video, Bongo relies on external applications to do this.
The applications it uses for this purpose are called @dfn{backends}.
The term ``backend'' is used loosely to refer to either an external
application, or to the glue code in Bongo specific to that application,
or even to both the application and the glue code seen as a whole.
(This usage is quite natural and normally does not cause any confusion.)
Bongo currently ships with backends for VLC, @samp{mpg123},
@samp{ogg123}, @samp{speexdec}, TiMidity and MikMod. Unfortunately,
only VLC and @samp{mpg123} support fast-forwarding and rewinding
(@pxref{Seeking}).
@node Players
@section Players
Instances of backends (@pxref{Backends}) are called @dfn{players} (or
@dfn{backend players}). Every time a track starts playing, a new
backend player is created. Multiple players may exist simultaneously.
For example, while there is only one VLC @emph{backend}, there may be
multiple VLC @emph{players} at any given time --- each probably playing
a different track.
Every player has an associated process (which does the actual work of
playing) and an associated buffer (from which it may be controlled).
Bongo buffers designed to hold players are called @dfn{playlist
buffers}.
@node Playlists
@section Playlists
Playlist buffers, or simply @dfn{playlists}, are buffers specifically
designed to hold and control backend players (@pxref{Players}).
Playlists have a number of commands used to control playback: play the
track at point (@key{RET}), pause/resume playback (@key{SPC}), go to the
next track (@kbd{C-c C-n}), go to the previous track (@kbd{C-c C-p}),
stop playback (@kbd{C-c C-s}), and so on (@pxref{Playing Tracks}).
Some backends support fast-forwarding and rewinding (@pxref{Seeking}).
@node Libraries
@section Libraries
@cindex nearest playlist buffer
Library buffers, or simply @dfn{libraries}, are buffers specifically
designed to hold tracks for convenient insertion into playlist buffers.
After inserting tracks into a library (using @kbd{i} and @kbd{I}), you
may enqueue into the nearest playlist using the @kbd{e} command (which
appends to the end of the playlist) and the @kbd{E} command (which
inserts into the playlist directly after the currently playing track).
All the commands for controlling playback (@pxref{Playlists}) are also
available in library buffers, where they simply control playback in the
most recently used, or @dfn{nearest}, playlist buffer. Similarily, if
you attempt to play a track in a library (using @key{RET}), the track
will be enqueued into the nearest playlist and played there instead.
You may prefer to use Bongo without library buffers, simply inserting
tracks directly into playlists. There is no problem with that:
libraries are provided only as a convenience.
@node Inserting Tracks
@chapter Inserting Tracks
@table @kbd
@item i
Insert a file or directory (@code{bongo-insert-file}).
@item I
Insert one or more non-file tracks (@code{bongo-insert-special}).
@end table
If you try to insert a directory with subdirectories, Bongo will ask
whether you want to recursively insert them too. To get rid of this
question, customize the variable
@code{bongo-insert-whole-directory-trees}.
The @kbd{I} command prompts for the type of thing to insert --- an
action track, a CD, a URI, or the contents of a PLS or an M3U playlist.
These special insert commands are described individually below.
@table @kbd
@item I action @key{RET}
Insert an action track (@code{bongo-insert-action}).
This command prompts for an Emacs Lisp form to be evaluated when the
action track is played. @ref{Top, Emacs Lisp Reference,, elisp, GNU
Emacs Lisp Reference Manual}
@item I cd @key{RET}
Insert one track for each audio track on the CD in the tray
(@code{bongo-insert-cd}). If the track information is unavailable,
insert a single track representing the entire disc.
The customization group @code{bongo-audio-cd} covers this feature.
@ref{Easy Customization,,, emacs, GNU Emacs Manual}
@item I uri @key{RET}
Insert a URI track (@code{bongo-insert-uri}).
This commands prompts for the URI (or URL) and for an optional title.
If specified, the title will be displayed instead of the URI. For most
internet radio streams, leaving out the title enables the radio station
to specify a title on its own.
@item I playlist @key{RET}
Insert the contents of a PLS or an M3U playlist file
(@code{bongo-insert-playlist-contents}).
The type of the playlist is determined by its file extension:
@itemize @bullet
@item
@samp{pls} for PLS playlists;
@item
@samp{m3u} or @samp{m3u8} (forces UTF-8) for M3U playlists.
@end itemize
While PLS files are rather complex, M3U files are simple lists of file
names (one per line, except that lines starting with @samp{#} are
comments).
@end table
@node Playing Tracks
@chapter Playing Tracks
To play some particular track, move point to it and hit @key{RET} (or
click on it). Doing that on a section header will just collapse the
section; to play a section, use @kbd{g} (@code{bongo-play}).
@table @asis
@item @key{RET}
Play the track at point. If point is on a section header, collapse or
expand the section.
@item @kbd{g}
Play the track or section at point, unless there is an active region
or marking (@pxref{Marking Tracks}).
In choosing which tracks and sections to play, this command follows
the prefix/region/marking (@pxref{The P/R/M Convention}), so it may
not actually always play the track or section at point.
@item @kbd{1 g}
Play the track or section at point, even if there is an active region
or marking.
@end table
Since libraries are not meant to play tracks, the @key{RET} and @kbd{g}
commands enqueue into the nearest playlist and play there instead when
used in a library buffer.
@menu
* Pausing:: Temporarily stopping playback.
* Stopping:: Permanently stopping playback.
* Seeking:: Rewinding or fast-forwarding tracks.
* Volume:: Changing the volume of your sound card.
* Switching Tracks:: Playing the next or previous track.
* Playback Modes:: Choosing the order in which tracks are played.
* Sprinkle Mode:: Keeping playlists populated with random tracks.
@end menu
@node Pausing
@section Pausing Playback
@cindex @key{SPC}
@findex bongo-pause/resume
It is often useful to temporarily pause playback without killing the
backend process. The @key{SPC} command toggles the paused state of the
currently playing track.
@table @asis
@item @key{SPC}
Pause or resume playback (@code{bongo-pause/resume}).
@end table
@cindex signals
Some backends (e.g., VLC and @samp{mpg123}) support pausing by talking
to the backend process through a pipe. For backends where this is not
possible (due to lack of any such remote control facility), pausing is
implemented using @samp{SIGTSTP} (or @samp{SIGSTOP}) and @samp{SIGCONT},
which forces the entire process to stop (just as @samp{C-z} would in a
job control shell).
@node Stopping
@section Stopping Playback
The @kbd{C-c C-s} command stops playback and kills the backend process.
However, if nothing is being played, then @kbd{C-c C-s} instead
@emph{starts} playing the first track.
@table @asis
@item @kbd{C-c C-s}
Start or stop playback (@code{bongo-start/stop}).
@item @kbd{C-u C-c C-s}
Switch to start/stop playback mode, in which playback stops whenever any
track finishes playing (@pxref{Playback Modes}).
@item @kbd{1 C-c C-s}
Insert a stopping action track (@pxref{Action Tracks}) immediately after
the current track. (``Stop after playing this track.'')
@item @kbd{5 C-c C-s}
Insert a stopping action track five tracks below the current track.
(``Stop after playing these five tracks.'')
@item @kbd{C-u C-u C-c C-s}
Insert a stopping action track at point.
@end table
@node Seeking
@section Fast-forwarding and Rewinding
@cindex fast-forwarding
@cindex rewinding
Some backends support fast-forwarding and rewinding --- often referred
to as @dfn{seeking} forward or backward. This allows you to skip over
some part of a track or go back and play some part of it again.
@table @asis
@item @kbd{f}, @kbd{b}
Fast-forward or rewind the current track 1 second (or @var{n} seconds,
given a prefix argument @var{n}).
@item @kbd{F}, @kbd{B}, @kbd{S-@key{right}}, @kbd{S-@key{left}}
Fast-forward or rewind 3 seconds (or 3 @var{n} seconds).
@item @kbd{M-F}, @kbd{M-B}, @kbd{M-S-@key{right}}, @kbd{M-S-@key{left}}
Fast-forward or rewind 10 seconds (or 10 @var{n} seconds).
@item @kbd{C-M-F}, @kbd{C-M-B}, @kbd{C-M-S-@key{right}}, @kbd{C-M-S-@key{left}}
Fast-forward or rewind 60 seconds (or @var{n} minutes).
While @kbd{C-M-B} and @kbd{C-M-F} cannot be typed in all terminals, you may
use the following commands as substitutes:
@table @asis
@item @kbd{60 b}, @kbd{60 f}
Seek 60 seconds.
@item @kbd{C-u C-u C-u b}, @kbd{C-u C-u C-u f}
Seek 64 seconds.
@end table
@end table
To seek a specific number of seconds, give a numeric prefix argument to
@kbd{f} or @kbd{b}. (For example, @kbd{27 f} would seek 27
seconds forward.)
To seek to a specific position, use the @kbd{s} (@code{bongo-seek})
command with a numeric prefix argument. (For example, @kbd{80 s} would
jump directly to 1 minute and 20 seconds from the beginning of the
track.) Giving just @kbd{C-u} as the prefix argument to @kbd{s} will
prompt for the position to seek to and allows you to say things like
``1:20''.
Unfortunately, not all backends support seeking. Among the ones in the
Bongo distribution, VLC and @samp{mpg123} do support it, whereas
@samp{ogg123}, @samp{speexdec}, TiMidity and MikMod do not.
@subsection Seek Mode
Typing @kbd{s} (@code{bongo-seek}) without any prefix argument takes you
into a special mode dedicated to seeking. In this mode, all the seeking
commands work as usual, but you can drop most of the @kbd{S-} modifiers.
For example, @kbd{S-@key{left}} still works, but @key{left} does the
same thing.
@table @asis
@item @kbd{s}
Enter seek mode. Use @key{RET} or @kbd{C-g} to exit.
@end table
In seek mode, playback status is shown continuously in the echo area,
and the following extra key bindings are available:
@table @asis
@item @kbd{a}, @kbd{e}, @key{home}, @key{end}
These are shortcuts for @kbd{C-c C-a} (@code{bongo-replay-current}) and
@kbd{C-c C-e} (@code{bongo-skip-current}).
@item @kbd{p}, @kbd{n}, @kbd{r}
These are shortcuts for @kbd{C-c C-p} (@code{bongo-play-previous}),
@kbd{C-c C-n} (@code{bongo-play-next}), and @kbd{C-c C-r}
(@code{bongo-play-random}).
@end table
Seek mode uses its own command loop, so you cannot do anything other
than seeking (and a handful of other things) until you quit seek mode.
If you don't like this, set @code{bongo-seek-electric-mode} to
@code{nil}.
@node Volume
@section Volume
The volume control facility is provided by the @samp{volume} library
@footnote{http://www.brockman.se/software/volume-el/}.
The @kbd{v} (@code{volume}) command
@node Switching Tracks
@section Switching Tracks
The @kbd{C-c C-n}, @kbd{C-c C-p} and @kbd{C-c C-r} commands are used to
start playing another track (stopping any currently playing track first).
@table @asis
@item @kbd{C-c C-n}
Play the next track (@code{bongo-play-next}).
@item @kbd{C-c C-p}
Play the previous track (@code{bongo-play-previous}).
@item @kbd{C-c C-r}
Play a random track (@code{bongo-play-random}).
@item @kbd{5 C-c C-n}
Skip four tracks downwards and play the one after that.
@item @kbd{5 C-c C-p}
Skip four tracks upwards and play the one before that.
@end table
Though @kbd{0 C-c C-n} may be used to play the current track again, it
is easier to use the @kbd{C-c C-a} command.
@table @asis
@item @kbd{C-c C-a}
Play the current track again (@code{bongo-replay-current}).
@end table
Just as the regular @kbd{C-a} command in Emacs has a counterpart
@kbd{C-e}, so @kbd{C-c C-a} has a counterpart @kbd{C-c C-e}.
@table @asis
@item @kbd{C-c C-e}
Skip the current track (@code{bongo-skip-current}). Proceed according
to the current playback mode (@pxref{Playback Modes}).
@end table
@node Playback Modes
@section Playback Modes
Whenever a track finishes playing (or is skipped using @kbd{C-c C-e}),
normally, the next track in the playlist will be played. This is the
default behavior, but it can be changed. The way Bongo chooses which
track to play next is called the @dfn{playback mode}.
There are five built-in playback modes. Switching to one of them is
easily done by giving a @kbd{C-u} prefix argument to the corresponding
playback command:
@table @kbd
@item C-u C-c C-n
In @dfn{progressive playback}, the default playback mode, tracks are
played in the usual top-to-bottom order.
@item C-u C-c C-p
In @dfn{regressive playback}, tracks are played in reverse order,
bottom-to-top.
@item C-u C-c C-a
In @dfn{repeating playback}, the same track is played over and over.
@item C-u C-c C-s
In @dfn{start/stop playback}, playback is stopped after each track.
For example, this is often nice when your playlist contains videos that
would otherwise keep popping up, covering your Emacs frame.
@item C-u C-c C-r
In @dfn{random playback}, tracks are played in random order. For an
alternative to random playback mode, @ref{Sprinkle Mode}.
@end table
When a non-progressive playback mode is in effect, this is indicated in
the mode line:
@itemize @bullet
@item
@samp{Playlist[reverse]} for regressive playback;
@item
@samp{Playlist[repeat]} for repeating playback;
@item
@samp{Playlist[stop]} for start/stop playback;
@item
@samp{Playlist[random]} for random playback;
@item
@samp{Playlist[custom]} for custom playback modes (to change this for
some specific custom playback mode, put the string to be used as the
indicator on the @code{bongo-playback-mode-indicator} property of the
symbol naming the function used for @code{bongo-next-action}).
@end itemize
@node Sprinkle Mode
@section Sprinkle Mode
@node Enqueuing Tracks
@chapter Enqueuing Tracks
The following commands are used to enqueue tracks into the playlist:
@table @kbd
@item e
Append a track to the end of the playlist.
@item E
Insert a track into the playlist directly after the currently playing
track (in order to have it played next).
@end table
@node Marking Tracks
@chapter Marking Tracks
@node Saving and Loading
@chapter Saving and Loading
@node The P/R/M Convention
@chapter The Prefix/Region/Marking Convention
Many Bongo commands follow a certain convention, called the P/R/M
convention, which makes it possible to predict which objects a command
will operate on.
Normally, a command operates on the track or section under point.
However, if any tracks are marked (@pxref{Marking Tracks}), the
command operates on those instead---unless there is an active region,
in which case the command operates on the tracks and sections in the
region. All of this may be overridden by giving a numeric prefix
argument, which tells the command how many tracks or sections to
operate on, counting from point. Most commands allow negative prefix
arguments for operating on tracks before point.
Note that giving a prefix argument of `1' tells a command to operate
on the track or section under point regardless of any marking or
region that may be in effect.
@table @kbd
@item &
Force the next command to use the P/R/M convention
(@code{bongo-universal-prefix/region/marking-object-command}).
@item M-&
Force the next command to use the P/R/M convention, but to operate
only on tracks---never on sections
(@code{bongo-universal-prefix/region/marking-track-command}).
@end table
@node Action Tracks
@chapter Action Tracks
@node Internals
@chapter Internals
@node Writing Backends
@chapter Writing Backends
The predefined backends support commonly used media files and players.
To use other programs with Bongo, you can define your own custom
backends. This involves some Emacs Lisp, but simple non-interactive
backends are easy to define. @xref{Top, Emacs Lisp Reference,, elisp,
GNU Emacs Lisp Reference Manual}, for help with writing Lisp.
As an example, here is a minimal backend for displaying PostScript and
PDF files with Evince, a GNOME document viewer. We don't need
interactive controls for Evince; we only want to launch it.
@lisp
(eval-after-load 'bongo
'(define-bongo-backend evince
:matcher '(local-file "ps" "pdf")))
@end lisp
@code{define-bongo-backend} is used to define backends. The definition
is wrapped inside an @code{eval-after-load} form so that it will
execute after Bongo has loaded. You don't need this if you load Bongo
at startup, but it will work in both cases.
The first argument names the backend. As a side effect, it also
defines the executable file @file{evince} to be used with the backend.
In most cases, this default behavior is fine. If you want to
customize the invocation of Evince, use @kbd{M-x customize-group
@key{RET} bongo-evince @key{RET}}. The @code{define-bongo-backend}
macro automatically defines customizable options for this.
The second argument, the keyword @code{:matcher}, and the third
argument define a matcher for the backend. Files with suffixes
@file{ps} and @file{pdf} can now be inserted in Bongo buffers, and
Bongo will select the new backend to display them. The Evince backend
is now ready for use.
For information on how to write more advanced backend definitions,
refer to the description of @code{define-bongo-backend} below.
Examples can be found in @file{bongo.el}.
@defmac define-bongo-backend name [keyword value]@dots{}
Defines a new backend named @var{name}. More specifically, defines
variables used by the backend, a constructor function that will be
invoked to play tracks with the backend and optionally matchers and
translators for the backend. The default definitions can be
overridden with keyword arguments. The @var{name} argument is not
evaluated.
@code{define-bongo-backend} accepts the following optional keywords:
@table @code
@item :pretty-name @var{string}
The name used to described the backend to the user. The default is to
use @var{name}.
@item :matcher @var{matcher}
A backend matcher expression. This keyword can be supplied multiple
times, specifying multiple matchers. There is no default matcher.
@item :file-name-transformer @var{expression}
A file name transformer for the backend, to be used by
@code{bongo-transform-file-name} to manipulate file names. This
keyword can be supplied multiple times, specifying multiple
transformers. There is no default file name transformer.
@item :program-name @var{string}
The file name of the executable program for the backend. The default
is the symbol-name of @var{name}.
@item :program-name-variable @var{variable}
The variable specifying the backend executable. The default defines a
variable @code{bongo-@var{name}-program-name}, bound to the value of
@var{program-name}.
@item :program-arguments @var{list}
A list of program arguments, to be processed by
@code{bongo-evaluate-program-arguments}. The default is
@code{(@var{extra-program-arguments-variable} bongo-extra-arguments
bongo-file-name)}.
@item :extra-program-arguments-variable @var{variable-name}
The name of the variable specifying extra command line arguments to
pass to the program. This variable will be defined with
@code{defcustom}, if its name is mentioned in @var{program-arguments}.
The default defines a variable
@code{bongo-@var{name}-extra-arguments}.
@item :extra-program-arguments @var{list}
The initial value for the @var{extra-program-arguments-variable}
variable. The default is @code{nil}.
@item :constructor @var{function}
The function that will create and invoke the backend player. It must
be a function of two arguments, a file name and a list of extra
arguments. It shall return a player, represented by a cons
@code{(name . properties)} where @code{properties} is an alist.
The default defines a function @code{bongo-start-@var{name}-player}
which calls @code{bongo-start-simple-player}.
@item :pause-signal @var{sigcode}
The signal used with @code{signal-process} to pause the player
process. The default is @code{SIGSTOP}.
@end table
@end defmac
@node GNU GPL
@appendix GNU General Public License
@center Version 2, June 1991
@display
Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
@end display
@unnumberedsec Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software---to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Lesser General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
@iftex
@unnumberedsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
@end iftex
@ifnottex
@center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
@end ifnottex
@enumerate 0
@item
This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The ``Program,'' below,
refers to any such program or work, and a ``work based on the Program''
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term ``modification.'') Each licensee is addressed as ``you.''
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
@item
You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
@item
You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
@enumerate a
@item
You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
@item
You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
@item
If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
@end enumerate
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
@item
You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
@enumerate a
@item
Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
@item
Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
@item
Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
@end enumerate
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
@item
You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
@item
You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
@item
Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
@item
If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
@item
If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
@item
The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and ``any
later version,'' you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
@item
If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes