len0rd/rockbox
1
0
Fork 1
mirror of https://github.com/Rockbox/rockbox.git synced 2026-04-11 16:37:45 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Manual: remove most HWCODEC artifacts

Browse source 
This causes 3 changes in layout. 2 I can't track down and 1 is better this way.

Change-Id: If4ad5e1d7431b4c2cbaaf9767d78139ef4e2dc44
This commit is contained in:
Moshe Piekarski 2020-11-16 18:14:31 -05:00
parent 7c87467ba4
commit 0aa702836b
24 changed files with 451 additions and 613 deletions
Download patch file Download diff file Expand all files Collapse all files

32
manual/plugins/lrcplayer.tex
View file

@ -37,8 +37,8 @@ Any other tags and lines without time tags are ignored.
\subsubsection{Location of lyrics files}
The plugin checks the following directories for lyrics files.
\opt{swcodec}{If no lyrics file is found and the audio file is a \fname{.mp3},
it also checks for SYLT and USLT tags in the id3v2 tags.}
If no lyrics file is found and the audio file is a \fname{.mp3},
it also checks for SYLT and USLT tags in the id3v2 tags.
\begin{enumerate}
\item The directory containing the audio file and its parent directories.
@ -116,10 +116,8 @@ same order as in that list.
\begin{description}
\item[Theme settings.] Change theme related settings.
\begin{description}
\opt{lcd_bitmap}{%
\item[Show Statusbar.] Show / hide the statusbar.
\item[Display Title.] Show / hide the track title.
}%
\item[Show Statusbar.] Show / hide the statusbar.
\item[Display Title.] Show / hide the track title.
\item[Display Time.] Show / hide the current time.
\opt{lcd_color}{%
\item[Inactive Colour.] Set the colour of the inactive part of the lyrics.
@ -127,22 +125,18 @@ same order as in that list.
\item[Backlight Force On.] Do not turn off the backlight while displaying
the lyrics.
\end{description}
\opt{lcd_bitmap}{%
\item[Display Settings.] Change how the lyrics are displayed.
\begin{description}
\item[Wrap.] Breaks lines at white space.
\item[Wipe.] Wipes the text.
\item[Alignment.] Align text to the left, centre, or right.
\item[Activate Only Current Line.]
Activate only the current line, or the current and previous lines.
\end{description}
}%
\item[Display Settings.] Change how the lyrics are displayed.
\begin{description}
\item[Wrap.] Breaks lines at white space.
\item[Wipe.] Wipes the text.
\item[Alignment.] Align text to the left, centre, or right.
\item[Activate Only Current Line.]
Activate only the current line, or the current and previous lines.
\end{description}
\item[Lyrics Settings.] Change how the lyrics files are loaded.
\begin{description}
\item[Encoding.] Sets the codepage used in the plugin.
\opt{swcodec}{%
\item[Read ID3 tag.] Read lyrics from id3 tags in mp3 files.
}%
\item[Read ID3 tag.] Read lyrics from id3 tags in mp3 files.
\item[Lrc Directory.] Set the directory where lyrics files are stored,
must be a maximum of 63 bytes.
\end{description}

130
manual/plugins/main.tex
View file

@ -14,30 +14,28 @@ them can be started from \setting{Browse Plugins} in the \setting{Main Menu}.\\
Viewer plugins get started automatically by opening an associated file (i.e.
text files%
\opt{lcd_bitmap}{, chip8 games}%
), or from the \setting{Open with} option on the \setting{Context Menu}.
, chip8 games), or from the \setting{Open with} option on the \setting{Context Menu}.
\section{Games}
\opt{lcd_bitmap}
{See also the Chip{}-8 emulator in \reference{ref:Chip8emulator},
Frotz in \reference{ref:Frotz},
\opt{iriverh100,iaudiom5,lcd_color}
{Rockboy in \reference{ref:Rockboy}}
and ZXBox in \reference{ref:ZXBox}.}
See also the Chip{}-8 emulator in \reference{ref:Chip8emulator},
Frotz in \reference{ref:Frotz},
\opt{iriverh100,iaudiom5,lcd_color}
{Rockboy in \reference{ref:Rockboy}}
and ZXBox in \reference{ref:ZXBox}.
\opt{lcd_bitmap}{\input{plugins/2048.tex}}
\input{plugins/2048.tex}
\opt{lcd_bitmap}{\input{plugins/blackjack.tex}}
\input{plugins/blackjack.tex}
\opt{large_plugin_buffer}{\input{plugins/boomshine.tex}}
\opt{lcd_bitmap}{\input{plugins/brickmania.tex}}
\input{plugins/brickmania.tex}
\opt{lcd_bitmap}{\input{plugins/bubbles.tex}}
\input{plugins/bubbles.tex}
\opt{lcd_bitmap}{\input{plugins/chessbox.tex}}
\input{plugins/chessbox.tex}
\opt{lcd_bitmap}{\input{plugins/chopper.tex}}
\input{plugins/chopper.tex}
\opt{lcd_color}{\input{plugins/clix.tex}}
@ -51,103 +49,103 @@ text files%
{\input{plugins/flipit.tex}}
\opt{lcd_bitmap}{\input{plugins/goban.tex}}
\input{plugins/goban.tex}
\opt{lcd_non-mono}{\nopt{iriverh10_5gb,ipodmini1g,c200,c200v2,mpiohd200,clipzip,samsungyh820}{
\input{plugins/invadrox.tex}}}
{\input{plugins/jackpot.tex}}
\opt{lcd_bitmap}{\input{plugins/jewels.tex}}
\input{plugins/jewels.tex}
\opt{lcd_bitmap}{\input{plugins/maze.tex}}
\input{plugins/maze.tex}
\opt{lcd_bitmap}{\input{plugins/mazezam.tex}}
\input{plugins/mazezam.tex}
\opt{lcd_bitmap}{\input{plugins/minesweeper.tex}}
\input{plugins/minesweeper.tex}
\opt{iriverh100,iaudiom5,lcd_color}{\nopt{c200,c200v2}{\input{plugins/pacbox.tex}}}
\opt{lcd_bitmap}{\input{plugins/pegbox.tex}}
\input{plugins/pegbox.tex}
\opt{lcd_color}{\opt{large_plugin_buffer}{\input{plugins/pixelpainter.tex}}}
\opt{lcd_bitmap}{\input{plugins/pong.tex}}
\input{plugins/pong.tex}
\opt{lcd_color}{\nopt{lowmem,iaudiox5,iriverh300}{\input{plugins/quake.tex}}}
\opt{lcd_bitmap}{\input{plugins/reversi.tex}}
\input{plugins/reversi.tex}
\opt{lcd_bitmap}{\input{plugins/robotfindskitten.tex}}
\input{plugins/robotfindskitten.tex}
{\input{plugins/rockblox.tex}}
\opt{lcd_bitmap}{\input{plugins/rockblox1d.tex}}
\input{plugins/rockblox1d.tex}
\opt{lcd_bitmap}{\input{plugins/sgt-puzzles.tex}}
\input{plugins/sgt-puzzles.tex}
\opt{lcd_bitmap}{\input{plugins/sliding.tex}}
\input{plugins/sliding.tex}
\opt{lcd_bitmap}{\input{plugins/snake.tex}}
\input{plugins/snake.tex}
\opt{lcd_bitmap}{\input{plugins/snake2.tex}}
\input{plugins/snake2.tex}
\opt{lcd_bitmap}{\input{plugins/sokoban.tex}}
\input{plugins/sokoban.tex}
\opt{lcd_bitmap}{\input{plugins/solitaire.tex}}
\input{plugins/solitaire.tex}
\opt{lcd_bitmap}{\input{plugins/spacerocks.tex}}
\input{plugins/spacerocks.tex}
\opt{lcd_bitmap}{\input{plugins/star.tex}}
\input{plugins/star.tex}
\opt{lcd_bitmap}{\input{plugins/sudoku.tex}}
\input{plugins/sudoku.tex}
\opt{lcd_non-mono}{\nopt{iriverh10_5gb,ipodmini1g,c200,c200v2,mpiohd200,clipzip,samsungyh820}{
\input{plugins/superdom.tex}}}
\opt{lcd_color}{\nopt{lowmem,iaudiox5,iriverh300}{\input{plugins/wolf3d.tex}}}
\opt{lcd_bitmap}{\input{plugins/wormlet.tex}}
\input{plugins/wormlet.tex}
\opt{lcd_bitmap}{\input{plugins/xobox.tex}}
\input{plugins/xobox.tex}
\opt{lcd_color}{\input{plugins/xworld.tex}}
\section{Demos}
\opt{lcd_bitmap}{\input{plugins/bounce.tex}}
\input{plugins/bounce.tex}
{\input{plugins/credits.tex}}
{\input{plugins/cube.tex}}
\opt{lcd_bitmap}{\input{plugins/demystify.tex}}
\input{plugins/demystify.tex}
\opt{swcodec}{\input{plugins/fft.tex}}
\input{plugins/fft.tex}
\opt{lcd_bitmap}{\input{plugins/fire.tex}}
\input{plugins/fire.tex}
\opt{lcd_bitmap}{\input{plugins/fractals.tex}}
\input{plugins/fractals.tex}
{\input{plugins/logo.tex}}
\opt{lcd_bitmap}{\nopt{xduoox3,clip,clipplus}{\input{plugins/matrix.tex}}}
\nopt{xduoox3,clip,clipplus}{\input{plugins/matrix.tex}}
{\input{plugins/mosaic.tex}}
\opt{lcd_bitmap}{\input{plugins/oscilloscope.tex}}
\input{plugins/oscilloscope.tex}
\opt{tagcache}{\opt{lcd_bitmap}{\input{plugins/pictureflow.tex}}}
\opt{tagcache}{\input{plugins/pictureflow.tex}}
\opt{lcd_bitmap}{\input{plugins/plasma.tex}}
\input{plugins/plasma.tex}
\opt{lcd_bitmap}{\input{plugins/rocklife.tex}}
\input{plugins/rocklife.tex}
{\input{plugins/snow.tex}}
\opt{lcd_bitmap}{\input{plugins/starfield.tex}}
\input{plugins/starfield.tex}
\opt{lcd_bitmap}{\input{plugins/vumeter.tex}}
\input{plugins/vumeter.tex}
\section{\label{ref:Viewersplugins}Viewers}
@ -168,7 +166,7 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
Frotz & \fname{.z1} to \fname{.z8} & \\
Image Viewer & \fname{.bmp, .jpg, .jpeg, .png\opt{lcd_color}{, .ppm}} & \\
Lua scripting language& \fname{.lua} & \\
\opt{swcodec}{\nopt{lowmem}{
\nopt{lowmem}{
Midiplay & \fname{.mid, .midi} & \\
Mikmod & \fname{.669, .amf, .asy, .dsm,} & \\
& \fname{.far, .gdm, imf, .it,} & \\
@ -176,13 +174,9 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
& \fname{.s3m, .stm, .stx, .ult,} & \\
& \fname{.uni, .umx, .xm} & \\
MPEG Player & \fname{.mpg, .mpeg, .mpv, .m2v} & \\
}}
\opt{swcodec}{
}
MP3 Encoder & \fname{.wav} & x \\
}
\opt{lcd_bitmap}{
Rockboy & \fname{.gb, .gbc} & \\
}
Search & \fname{.m3u, .m3u8} & x \\
Shopping list & \fname{.shopper} & \\
Sort & \fname{.*} & x \\
@ -196,31 +190,31 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
{\input{plugins/winshortcuts.tex}}
\opt{lcd_bitmap}{\input{plugins/chip8emulator.tex}}
\input{plugins/chip8emulator.tex}
\opt{lcd_bitmap}{\input{plugins/frotz.tex}}
\input{plugins/frotz.tex}
\opt{lcd_bitmap}{\input{plugins/imageviewer.tex}}
\input{plugins/imageviewer.tex}
\opt{large_plugin_buffer}{\input{plugins/lua.tex}}
\opt{swcodec}{\nopt{lowmem}{\input{plugins/midiplay.tex}}}
\opt{swcodec}{\nopt{lowmem}{\input{plugins/mikmod.tex}}}
\nopt{lowmem}{\input{plugins/midiplay.tex}}
\nopt{lowmem}{\input{plugins/mikmod.tex}}
\opt{lcd_bitmap}{\opt{swcodec}{\nopt{lowmem}{\input{plugins/mpegplayer.tex}}}}
\nopt{lowmem}{\input{plugins/mpegplayer.tex}}
\opt{swcodec}{\input{plugins/mp3_encoder.tex}}
\input{plugins/mp3_encoder.tex}
\opt{iriverh300,iriverh100,SANSA_FUZE_PAD,SANSA_E200_PAD,IPOD_4G_PAD,IPOD_3G_PAD%
,IPOD_1G2G_PAD,SAMSUNG_YPR0_PAD}{
\input{plugins/pdbox.tex}}
\opt{lcd_bitmap}{\nopt{%
\nopt{%
ipod1g2g,ipod3g,ipod4g,ipodmini% horizontal pixelformat not implemented
,iaudiom3,mpiohd200, % vertical interleaved pixelformat not implemented
,mrobe100% lcd size/depth not implemented
}{
\input{plugins/rockboy.tex}}}
\input{plugins/rockboy.tex}}
{\input{plugins/search.tex}}
@ -236,7 +230,7 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
{\input{plugins/vbrfix.tex}}
\opt{lcd_bitmap}{\input{plugins/zxbox.tex}}
\input{plugins/zxbox.tex}
\section{Applications}
@ -244,7 +238,7 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
{\input{plugins/batterybenchmark.tex}}
\opt{lcd_bitmap}{\input{plugins/calculator.tex}}
\input{plugins/calculator.tex}
\opt{rtc}{\input{plugins/calendar.tex}}
@ -260,7 +254,7 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
\opt{HAVE_BACKLIGHT}{\input{plugins/lamp.tex}}
\opt{lcd_bitmap}{\input{plugins/lrcplayer.tex}}
\input{plugins/lrcplayer.tex}
{\input{plugins/main_menu_config.tex}}
@ -270,9 +264,9 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
{\input{plugins/otp.tex}}
\opt{lcd_bitmap}{\input{plugins/periodic_table.tex}}
\input{plugins/periodic_table.tex}
\opt{swcodec}{\opt{recording_mic}{\input{plugins/pitch_detector.tex}}}
\opt{recording_mic}{\input{plugins/pitch_detector.tex}}
{\input{plugins/random_folder_advance_config.tex}}
@ -284,4 +278,4 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
{\input{plugins/stopwatch.tex}}
\opt{lcd_bitmap}{\input{plugins/text_editor.tex}}
\input{plugins/text_editor.tex}

6
manual/plugins/oscilloscope.tex
View file

@ -4,10 +4,8 @@
This demo shows the shape of the sound samples that make up the music
being played.
\opt{swcodec}{
At faster speed rates, the \dap\ is less responsive
to user input and music may start to skip.
}
At faster speed rates, the \dap\ is less responsive
to user input and music may start to skip.
\subsubsection{Keys}

8
manual/plugins/pictureflow.tex
View file

@ -1,9 +1,9 @@
\subsection{PictureFlow}
\screenshot{plugins/images/ss-pictureflow}{PictureFlow}{img:pictureflow}
PictureFlow provides a visualisation of your albums with their associated cover
art. \opt{swcodec}{It is possible to start playback of the selected
album from PictureFlow. Playback will start from the selected track. The
PictureFlow plugin will continue to run while your tracks are played.}
art. It is possible to start playback of the selected album from PictureFlow.
Playback will start from the selected track. The PictureFlow plugin will
continue to run while your tracks are played.
\subsubsection{Requirements}
PictureFlow uses both the album art (see \reference{ref:album_art}) and
@ -139,7 +139,7 @@ aware:
\subsubsection{Main Menu}
\begin{description}
\item[Go to WPS.] Leave PictureFlow and enter the while playing screen.
\opt{swcodec}{\item[Playback Control.] Control music playback from within the plugin.}
\item[Playback Control.] Control music playback from within the plugin.
\item[Settings.] Enter the settings menu.
\item[Return.] Exit menu.
\item[Quit.] Exit PictureFlow plugin.

28
manual/plugins/text_viewer.tex
View file

@ -197,25 +197,19 @@ by using \emph{Open with} from the \emph{Context Menu}
\begin{description}
\item[Encoding] Set the codepage in the text viewer.
Available settings:
\setting{ISO-8859-1} (Latin 1).
\setting{ISO-8859-1} (Latin 1),
\setting{ISO-8859-7} (Greek),
\opt{lcd_bitmap}{
\setting{ISO-8859-8} (Hebrew),
}
\setting{ISO-8859-8} (Hebrew),
\setting{CP1251} (Cyrillic),
\opt{lcd_bitmap}{
\setting{ISO-8859-11} (Thai),
\setting{CP1256} (Arabic),
}
\setting{ISO-8859-11} (Thai),
\setting{CP1256} (Arabic),
\setting{ISO-8859-9} (Turkish),
\setting{ISO-8859-2} (Latin Extended),
\setting{CP1250} (Central European),
\opt{lcd_bitmap}{
\setting{SJIS} (Japanese),
\setting{GB-2312} (Simple Chinese),
\setting{KSX-1001} (Korean),
\setting{BIG5} (Traditional Chinese),
}
\setting{SJIS} (Japanese),
\setting{GB-2312} (Simple Chinese),
\setting{KSX-1001} (Korean),
\setting{BIG5} (Traditional Chinese),
\setting{UTF-8} (Unicode),
This setting only applies to the plugin and is independent from the
\setting{Default Codepage} setting (see \reference{ref:Defaultcodepage}).
@ -230,9 +224,7 @@ by using \emph{Open with} from the \emph{Context Menu}
\item[Join] Join lines together.
\item[Expand] Add a blank line at newlines. Useful for making paragraphs
clearer in some book style text files.
\opt{lcd_bitmap}{
\item[Reflow Lines] Justify the text.
}
\end{description}
\item[Screens Per Page] Set the number of screens per page. Available
options are \setting{1} to \setting{5} screens per page.
@ -242,7 +234,6 @@ by using \emph{Open with} from the \emph{Context Menu}
(Useful for displaying right-to-left languages, such as Arabic or Hebrew)
\item[Left] Set the text alignment to the left.
\end{description}
\opt{lcd_bitmap}{
\item[Show Header] Select whether to show the header. The header displays the file path.
\begin{description}
\item[No] Do not display the header.
@ -263,7 +254,6 @@ by using \emph{Open with} from the \emph{Context Menu}
\item[No] Do not display the status bar.
\item[Yes] Display the status bar.
\end{description}
}
\item[Scroll Settings] The scrolling settings submenu.
\begin{description}
\item[Horizontal] Submenu for horizontal scrolling settings.
@ -299,14 +289,12 @@ by using \emph{Open with} from the \emph{Context Menu}
\item[Scroll by Page] Scroll up or down one full screen.
\item[Scroll by Line] Scroll up or down one line.
\end{description}
\opt{lcd_bitmap}{
\item[Overlap Pages] Set whether the last line from the
previous screen is retained when scrolling pages.
\begin{description}
\item[No] Do not retain previous line.
\item[Yes] Retain previous line.
\end{description}
}
\item[Auto-scroll Speed] Control the speed of auto-scrolling
in number of lines per second. Available options are
\setting{1} to \setting{10} lines per second. As an example,

8
manual/plugins/theme_remove.tex
View file

@ -3,7 +3,7 @@
This plugin offers a way to remove a theme. Open the \setting{Context Menu} (see \reference{ref:Contextmenu})
upon a theme\fname{.cfg} file and select \setting{Open With... $\rightarrow$ theme\_remove}.
Some files are not removed regardless of the \setting{Remove Options} such as
\fname{rockbox\_default.wps}\opt{lcd_bitmap}{ and the font file currently in use}.
\fname{rockbox\_default.wps} and the font file currently in use.
\subsubsection{Theme Remove menu}
\begin{description}
@ -34,18 +34,14 @@ Some files are not removed regardless of the \setting{Remove Options} such as
\end{description}
\begin{description}
\opt{lcd_bitmap}{
\item[Font.]
Specifies how the \fname{.fnt} file belonging to a theme \fname{.cfg} file is handled.
If this option is set to \setting{Remove if not Used}, the fonts came from rockbox-fonts.zip
will not be removed as themes may depend on those fonts.
}%
\item[WPS.]
Specifies how the \fname{.wps} file belonging to a theme \fname{.cfg} file is handled.
\opt{lcd_bitmap}{
\item[Statusbar Skin.]
Specifies how the \fname{.sbs} file belonging to a theme \fname{.cfg} file is handled.
}%
\opt{HAVE_REMOTE_LCD}{
\item[Remote WPS.]
Specifies how the \fname{.rwps} file belonging to a theme \fname{.cfg} file is handled.
@ -56,12 +52,10 @@ Some files are not removed regardless of the \setting{Remove Options} such as
\item[Backdrop.]
Specifies how the backdrop \fname{.bmp} file belonging to a theme \fname{.cfg} file is handled.
}%
\opt{lcd_bitmap}{
\item[Iconset.]
Specifies how the iconset \fname{.bmp} file belonging to a theme \fname{.cfg} file is handled.
\item[Viewers Iconset.]
Specifies how the viewers iconset \fname{.bmp} file belonging to a theme \fname{.cfg} file is handled.
}%
\opt{HAVE_REMOTE_LCD}{
\item[Remote Iconset.]
Specifies how the remote iconset \fname{.bmp} file belonging to