Tangerine 3DS: Difference between revisions

Revision as of 05:43, 4 July 2021

tangerine is a work-in-progress music player for the Nintendo 3DS and Nintendo Switch.

Note from developer:

The 3DS build is currently in heavy development as the shift is made from pp2d to citro2d. Please use the previous build instead of building yourself.

Features

Support for multiple formats (wav, flac, and mp3 currently).
Ability to play playlists.
Anything else the 3DS's sound application does.
Touchscreen controls.

Building

You can just run make or make all to get both 3ds and switch builds, but for just one of them follow this:

3DS

Make sure you have the latest releases of ctrulib, citro3d, citro2d, and 3ds-mpg123 installed via the devkitPro pacman.
Then type make 3ds to get a .3dsx, .smdh, and .cia.

Switch

Make sure you have the latest releases of libnx and switch-mpg123 installed via the devkitPro pacman.
Then type make switch to get a .nro.

User guide

Put all music in /music/ folder on your SD card as traditional file browsing is not currently supported yet.

Controls

L/R - Skip forward/back a song

A - Pause/play

B - Return to file selection

Progress bar (touch screen) - Scrub through the audio (slow)

Known issues

Some flac files have issues with playback speed on hardware but work fine in Citra.

Scrubbing within flac/mp3 files may take several seconds on Old 3DS depending on the size of the file

Credits

Thanks to:

@smealum for ctrulib.
@fincs for citro3d.
@Steveice10 for buildtools.
@BernardoGiordano for pp2d and help with Makefile/rsf files.
VLC for android for the rough UI design concept.
@Sergey#5402 for help testing.
@Fenrir#3268, @ahoischen#9453, and @TurtleP#2954 (and anyone else!) in #dev in the Nintendo Homebrew discord for help with some beginner C mistakes.
mackron for their doctor libs (dr_flac and dr_wav specifically).
devkitPro for the example Makefiles, portlibs, and citro2d.
switchbrew/3dsbrew for documentation and examples.
The big N for the Nintendo 3DS Sound application.
Erokia for Heartbleed Synth.
and @deltabeard for their orginal libmpg123 portlib fork and ctrmus (big inspiration and for understanding the DSP a lot better).

@@ Line 11: / Line 11: @@
 }}
-= tangerine =
+tangerine is a work-in-progress music player for the Nintendo 3DS and Nintendo Switch.
-=== A work-in-progress music player for the Nintendo 3DS and Nintendo Switch ===
+'''Note from developer:'''
-== Overview: ==
+The 3DS build is currently in heavy development as the shift is made from pp2d to citro2d. Please use the previous build instead of building yourself.
-* The 3DS build is currently in heavy development as the shift is made from pp2d to citro2d. Please use the previous build instead of building yourself.
+==Features==
-* Put all music in &quot;&quot;/music&quot;&quot; folder on your SD card as traditional file browsing is not currently supported yet
+* Support for multiple formats (wav, flac, and mp3 currently).
-* Support for multiple formats (wav, flac, and mp3 currently)
+* Ability to play playlists.
-* Skip forward and back a song using the L and R buttons
+* Anything else the 3DS's sound application does.
-* Use the progress bar on the touch screen to scrub through the audio (SLOW)
+* Touchscreen controls.
-* Pause/Play with A, and return to file selection with B
-* ''Touchscreen'' controls (yay?)
-== Planned Features: ==
-* ☐ Update internal documentation
-* ☐ Move to citro2d
-* ☐ Switch version
-* ☐ Actual file browsing
-* ☐ Support for more formats
-* ☐ Ability to create playlists
-* ☒ Ability to play playlists
-* ☐ Record and save bits of audio using the microphone like the built in app
-* ☐ UI overhaul (currently it's not super terrible, but it's definitely not where I want it to be)
-* ☐ Themes maybe?
-* anything else the 3DS's sound application does
-== Building ==
+==Building==
 You can just run <code>make</code> or <code>make all</code> to get both 3ds and switch builds, but for just one of them follow this:
-=== 3DS ===
+===3DS===
+* Make sure you have the latest releases of ctrulib, citro3d, citro2d, and 3ds-mpg123 installed via the devkitPro pacman.
+* Then type <code>make 3ds</code> to get a .3dsx, .smdh, and .cia.
-Make sure you have the latest releases of ctrulib, citro3d, citro2d, and 3ds-mpg123 installed via the devkitPro pacman. Then type
+===Switch===
+* Make sure you have the latest releases of libnx and switch-mpg123 installed via the devkitPro pacman.
+* Then type <code>make switch</code> to get a .nro.
-<pre>make 3ds
+==User guide==
-</pre>
+Put all music in /music/ folder on your SD card as traditional file browsing is not currently supported yet.
-to get a .3dsx, .smdh, and .cia
-=== Switch ===
+==Controls==
+L/R - Skip forward/back a song
-Make sure you have the latest releases of libnx and switch-mpg123 installed via the devkitPro pacman. Then type
+A - Pause/play
-<pre>make switch
+B - Return to file selection
-</pre>
-to get an .nro
-== Known Issues: ==
+Progress bar (touch screen) - Scrub through the audio (slow)
-* Some flac files have issues with playback speed on hardware but work fine in Citra
+==Known issues==
-* Scrubbing within flac/mp3 files may take several seconds on Old 3DS depending on the size of the file WARNING: This was my first time ever writing C. There are going to be bugs and 90% percent of this is probably terrible code, so don't hesitate to report anything because I probably wouldn't have found it otherwise.
+Some flac files have issues with playback speed on hardware but work fine in Citra.
-== Credits: ==
+Scrubbing within flac/mp3 files may take several seconds on Old 3DS depending on the size of the file
-Thanks to
+==Credits==
+Thanks to:
+* @smealum for [https://github.com/smealum/ctrulib ctrulib].
+* @fincs for [https://github.com/fincs/citro3d citro3d].
+* @Steveice10 for [https://github.com/Steveice10/buildtools buildtools].
+* @BernardoGiordano for [https://github.com/BernardoGiordano/Checkpoint/tree/master/source/pp2d pp2d] and help with Makefile/rsf files.
+* [https://www.videolan.org/vlc/download-android.html VLC for android] for the rough UI design concept.
+* @Sergey#5402 for help testing.
+* @Fenrir#3268, @ahoischen#9453, and @TurtleP#2954 (and anyone else!) in #dev in the Nintendo Homebrew discord for help with some beginner C mistakes.
+* [https://mackron.github.io/ mackron] for their [https://github.com/mackron/dr_libs doctor libs] (dr_flac and dr_wav specifically).
+* devkitPro for the example Makefiles, portlibs, and [https://github.com/devkitPro/citro2d citro2d].
+* switchbrew/3dsbrew for documentation and examples.
+* The big N for the Nintendo 3DS Sound application.
+* [https://freesound.org/people/Erokia Erokia] for [https://freesound.org/people/Erokia/sounds/414770/ Heartbleed Synth].
+* and @deltabeard for their orginal libmpg123 portlib fork and [https://github.com/deltabeard/ctrmus ctrmus] (big inspiration and for understanding the DSP a lot better).
-* @smealum for [https://github.com/smealum/ctrulib ctrulib]
+[[Category:3DS homebrew application]]
-* @fincs for [https://github.com/fincs/citro3d citro3d]
+[[Category:Homebrew media players on 3DS]]
-* @Steveice10 for [https://github.com/Steveice10/buildtools buildtools]
-* @BernardoGiordano for [https://github.com/BernardoGiordano/Checkpoint/tree/master/source/pp2d pp2d] and help with Makefile/rsf files
-* [https://www.videolan.org/vlc/download-android.html VLC for android] for the rough UI design concept
-* @Sergey#5402 for help testing
-* @Fenrir#3268, @ahoischen#9453, and @TurtleP#2954 (and anyone else!) in #dev in the Nintendo Homebrew discord for help with my beginner C mistakes
-* [https://mackron.github.io/ mackron] for their [https://github.com/mackron/dr_libs doctor libs] (dr_flac and dr_wav specifically)
-* devkitPro for the example Makefiles, portlibs, and [https://github.com/devkitPro/citro2d citro2d]
-* switchbrew/3dsbrew for documentation and examples
-* The big N for the Nintendo 3DS Sound application
-* [https://freesound.org/people/Erokia Erokia] for [https://freesound.org/people/Erokia/sounds/414770/ &quot;&quot;Heartbleed Synth&quot;&quot;]
-* and @deltabeard for their orginal libmpg123 portlib fork and [https://github.com/deltabeard/ctrmus ctrmus] (big inspiration, helped me to understand the DSP a lot better)