lrorpilla / jidoujisho

A full-featured immersion language learning suite for mobile.

jidoujisho

A full-featured immersion language learning suite for mobile.

---

‍🧪 Preview Release: 2.9.0-preview2

✨ Latest Release: 2.8.9

📚 Resources:
🏠 Wiki · ❓ FAQ · 🩺 Troubleshooting · 🚀 Getting Started · 🃏 Flashcard Creation · 🗃️ Workflow Setup · 🎥 Viewing Media · 💡 Tips and Tricks · 🧑‍💻 Development · 👥 Contribution · 📑 API Documentation

🗒️ Release Notes:
(Legacy) 0.3 · 0.4 · 0.5 · 0.6 · 0.7 · 0.8 · 0.9 · 0.10 · 0.11 · 0.12 · 0.13 · 0.14 · 0.15 · 0.16 · 0.17 · 0.18 · 0.19 · 0.20 · 0.21 · 0.22 · 0.23 · 0.24 · 0.25 · 0.26
(Chisa) 1.0 · 1.1
(Yuuna) 2.0 · 2.1 · 2.2 · 2.3 · 2.4 · 2.5 · 2.6 · 2.7 · 2.8

📱 Language learning in the palm of your hand

jidoujisho is a video player, reading aid, dictionary and card creation toolkit with features specifically helpful for language learners.

• 📖 Tap and drag selection of subtitles and paragraphs allows for instant dictionary lookups
• 🃏 Export flashcards to AnkiDroid, complete with image and audio of the current context
• 📺 Watch videos or listen to audio with subtitles from local device storage, YouTube or stream from a Jellyfin library or a direct URL
• 📚 Read books anywhere and offline, via an embedded, self-hosted ッツ Ebook Reader
• 🖼️ Read and mine manga pre-processed with Mokuro, and export or crop the current image
• 🕸️ WebSocket support allows convenient use alongside texthookers for visual novels, games and more
• 🎶 Get lyrics and easily make dictionary lookups for the current playing song in your music app
• 🤖 Interact with ChatGPT in your target language to get grammar information, example sentences and more
• 📘 Use Yomichan dictionaries with pitch and frequency information, and selectively collapse and expand dictionaries by default
• ⛏ Frictionless sentence mining and flashcard creation workflow with support for modular enhancements and automations

🎞️ A glimpse of jidoujisho in action

⚕️ Current state of the project

jidoujisho is eagerly looking for contributors. If you are interested in maintaining a dictionary format, media source, an enhancement or quick action or even a new language for the application, user and developer documentation is coming soon.

Originally built for the Japanese language learning community, jidoujisho is free and open source software, and is available to download here on GitHub.

Please note that the development of the app switches between changes being implemented and being left alone for daily use. Update frequency may depend on the gravity of any issues that arise. Hiatuses provide practical insight on usage and where development should go next.

📖 Using the application

🚨 Supported Formats

• jidoujisho will take video and audio formats as supported by VLC. SDR video is recommended over HDR. Subtitles may be embedded within the video being played and selected during playback.
• If you have trouble with storage space on your device, you may use the app as an external player for Jellyfin and stream from your PC media library, complete with progress tracking and external subtitles support.
• If you wish to use external subtitles, they may be in SRT, ASS or SSA format and you may import them during playback through the menu. You may switch between different audio and subtitle tracks. Image-based subtitles such as PGS are not currently supported.
• Closed captions and auto-generated captions are available when watching YouTube videos. Here is a fair sample of YouTube videos with such subtitles showcasing some very practical application use cases. Users are strongly advised not to use automatic captions if they cannot reliably discern their correctness.
• ッツ Ebook Reader allows reading of books in EPUB or HTMLZ format.
• Mokuro volumes must be in HTML format, and have images in the relative directory.
• Make sure your Android WebView is updated before use. This will resolve common issues that may occur with ッツ Ebook Reader or Mokuro.
• Users may import Yomichan dictionaries for Japanese, some can be found here. Note that Yomichan dictionaries using structured-content are currently unsupported.
• Other supported formats include Migaku and DSL dictionaries.

🚀 Getting Started

A primer on the basics of the application is as follows.

• 📲 Download and install the latest release onto your Android device
• ⏯️ Watch a video with the Player selecting from your local media library or picking a YouTube video
• 📚 Start a novel with the Reader to launch ッツ Ebook Reader to read an EPUB or HTMLZ file
• 🖼️ Read pre-processed manga in HTML with the Mokuro media source
• 📋 Tap a word for instant dictionary lookups, and open the Card Creator or use Instant Export
• ❎ You can dismiss dictionary popups by swiping horizontally, using a volume button or tapping on the current selection
• ↕️ You may swipe vertically in the player to open the transcript in the player, and pick a time or read subtitles
• ↔️ Swipe horizontally in the player to repeat the current subtitle audio

📲 Exporting to AnkiDroid

• 📤 You may also export the current context to an AnkiDroid card, including the current image and audio
• ⚠️ If AnkiDroid is not running in the background, you will be prompted to install or launch it
• 🗃 The AnkiDroid deck you last export to will be remembered for your next export
• 📝 You may edit the card fields before exporting to AnkiDroid
• ⚛️ Customisation of the Anki export is possible by creating your own export profile

🙌 User Tips

• 🇯🇵 Can't find Japanese subtitles for your media? Try finding what you need at kitsunekko or Nekomoekisatten
• 🔮 Customise your workflow by trying out different enhancements and quick actions
• 🈲 Monolingually transitioning? Collapse your bilingual dictionaries by default, and split your export fields between expanded and collapsed meanings.
• 📡 You can use Jellyfin to stream media from your PC, complete with progress tracking and external subtitle support
• 🖐️ Double tap on a character when reading a meaning to quickly select it as a word and recursively search
• 📑 External subtitles with the same name as the selected video file will be loaded by default
• 📰 You can get example sentences from Massif, Tatoeba or ImmersionKit if a sentence you find is too hard
• ⏲️ If your subtitles are off, you can set the delay or pad the exported audio time with an allowance
• ✊ Export a range of multiple subtitles by holding onto a subtitle aside from the current one in the transcript
• 📹 The quality closest to the last selected quality will be selected by default for YouTube videos
• 💬 If your video has burned-in subtitles, you may use the blur widget under player options to hide them
• ✂️ Reading manga? You can crop an image before exporting a card
• 🎧 Listening to an audiobook? You can read with subtitles during playback by opening the transcript and clicking on the upper-right icon
• 🔔 You can listen in the background by turning on background play with live subtitle previews in media notifications with controls
• 🪡 Limit export to a single dictionary by selecting the button on the rightmost tag of a dictionary entry
• 📜 Tap on a field's icon in the Card Creator to lock the field, which can be useful if exporting the same sentence multiple times
• 🤖 Users may chat in various languages supported by ChatGPT. Users are advised not to heavily rely on an AI language model if they cannot accurately distinguish its correctness and accuracy.

👥 Contribution and attribution

lrorpilla

m-edlund

Aegyo

Aquafina-water-bottle

Natsume-197

MarvNC

jidoujisho is written in Dart and powered by Flutter, and is made available under the GNU General Public License 3.0.

Database enabled by Isar and Hive. Reader via a self-hosted ッツ Ebook Reader. Mokuro for manga reading. Video streaming via YouTube. Chat service via ChatGPT.

Image search via Bing. Audio search via Forvo and JapanesePod101. Example sentences from Massif, Tatoeba and ImmersionKit. Lyrics from Google and Uta-Net.

Natural language processing tools include Ve and MeCab for Japanese. Special thanks to the Yomichan project.

If you like what I've done so far, you can help me out by testing the application on various devices so that I can gauge the compatibility of the application with different versions of Android, making a donation or collaborating with me on further improvements.

The logo of the application is both by suzy and Aaron Marbella, support their awesome work if you can!

jidoujisho's Issues

Bug when I rotate the phone while video is loading.

When the video is loading and I rotate the phone without having the auto-rotation option activated, for some reason the video player detects it and this bug happens. The audio is good, but the image stills the same for the rest of the video.

[Feature Request] External Video Player For Plex

I like streaming video from my pc to my phone via plex, and the app gives the option to watch the video with an external app. I would love to use jidoujisho for that so I can do lookups on subs while I watch, but the app doesn't appear on the list of external apps.

I believe that the external players are just all of the apps that android recognizes as video players. For example, if I go to change android's default video player, jidoujisho is not on the list.

Filters option

May be good to have a filters option while searching content.
Some examples are:
-Close captioning available videos
-Videos
-Channels
-Songs
-Newer/Older
And others like those

Thanks for your work!

Fr: pause playback when looking up a definition

Typically when I look up a new word, I need some time to read the definition and understand the word in the context.

I think it would be a good idea to pause automatically when a lookup is done because of this.

Please consider this, and thanks for all your work!

Idea for Rudimentary Support of Chinese?

Greetings,

I know that currently, there isn't a parser setup for Chinese.
Is there any way to create a rudimentary way to do Chinese parsing with tap, since we already have some Chinese Dictionaries for Yomichan that work?
Currently, I don't have huge issues using Yomichan to read in Chinese, but with the tapping on the app, it tries to lookup the entire sentence when I tap over certain words.

Is there a way you could create a crude temporary solution in the options, where it just does a lookup starting at the first character you tap, and looks up the word in the dictionaries?

Here is an example sentence from this show Hilda:
我们就要辨识并采集到十种本地植物的样本
If I do a search for ANY of the words starting halfway through the sentence with the hanzi 十, the dictionary will try and do a lookup of the entire phrase. I can't lookup things like "植物" even though this is in the Japanese-English and Chinese-English dictionaries I have.

I'm not sure if this is doable to make it work as least as well as Yomichan does.

Video of Yomichan on the sentence:
https://user-images.githubusercontent.com/9376306/129407452-2a174b5f-ca78-4b84-ab96-e20995fc8be6.mp4

Thanks~

2 Bugs/Improvements - Subtitle won't refresh when changing tracks / Load External Subtitle By Default?

Hello,

One issue I'm having is on a show with multiple subtitle tracks, it won't actually change to the selected subtitle track. It loads the first subtitle in alphabetical order that's embedded on a .mkv, so Arabic in my example. I try to change it to Chinese Simplified, and after I select the new subtitle, it won't reload the subtitles for the video, so it's stuck just displaying Arabic.

My second thing is a suggestion: Use a fuzzysearch to open related subtitle files and add them into the subtitle list - this would help dealing with lots of shows with external subtitles.
example:
Are You OK Episode 01 iQiyi 1920x1080.mp4
Are You OK Episode 01 iQiyi 1920x1080.en.srt
Are You OK Episode 01 iQiyi 1920x1080.zh-CN.srt

This is the common naming convention, where all subtitles include the full filename, and append a language code after a period (.)
I think this is related to the File Picker, but I'm not sure how to override that on Android...

I hope to see these fixes or a clarification with this app, if no one else is experiencing the issue.

Vlad

Optimization for older devices

I tested the app in 3 devices, one with Android 7, and two with Android 9. In the Android 9 devices, it runs perfectly, but in the older Android 7 device it has some performance issues while loading or/and playing videos. Also, when I search a definition on the fly while watching, it takes much more time to auto-pause the video, and usually it shows the following subtitles before it pauses (in some cases, 2 or 3 subtitles are shown before).

Thanks!

Is this a problem of mine or...?

Does the app support .mkv videos?
'cuz I've downloaded an anime and tried to open it with the app but doesn't load it.

[Feature Request] Custom dictionary support

Current method for monolingual dictionary seem make http calls for each look up.

Which is:

• Extremely slow
• Limits to one dictionary (missing quite a lot of entries)
• Very dependent on the way this website index the words

Recursive lookups for monolingual definitions

Some definitions in monolingual dictionaries point to other definitions and aren't that useful in their own. Here is an example.

もご-もご [1] （副）スル
（１）「もぐもぐ」に同じ。「―（と）かむ」
（２）うごめくさま。もぞもぞ。「着ぶくれて―する」

Would be great if I could click on もぐもぐ and see that definition.

How about Netflix?

Hello. It is a really very interesting app. I think it has a lot of potential. By the way, can it be applied to Netflix?

[Feature Request] White Mode

I really would love to use the reader and viewer aspects of this app with my ink reader but since it's only available in black, it's currently impossible to use. Would it be possible to have some sort of theme or light mode in the future by any chance?

Either way the app is amazing!

Error at the export to Anki screen

I don't know how to describe it, I hope these two videos help:
https://streamable.com/rohbew
https://streamable.com/qah0ts
As you can see, the video gets unpaused and paused when I edit something.

Option to autopause after a subtitle

I personally enjoy reading the subtitles. When I watch content in MPV, I use a script to autopause after every subtitle, to listen the sentence and then repeat what it said, after that, un-pause the video and do it again and again.
It would be great to have that feature in jidoujisho too.

Thanks!

[Feature Request] Portrait orientation in Player mode

As the title says, currently the app switches to landscape orientation when playing a video and it's not possible to change orientation. It would be useful to use it in portrait so that when exporting cards to Anki there is enough vertical space to se all the fields.

Exported cards' images and audio not synced in Ankidroid

Here is an issue l just ran into.

How to reproduce:

• jidoujisho 0.13.0-beta
• latest ankidroid (2.14.6)
• desktop anki Version 2.1.22 (0ecc189a)

Steps:

• in jidoujisho, open a video and "export the current context to anki" to create a card
• in ankidroid, verify that the created card can display its image and play its audio
• in ankidroid, sync changes
• in desktop anki, likewise sync so the new card becomes available
• in desktop anki, Browse to see the card
• press Ctrl+L to verify that the card is missing its image, and can't play its audio

A workaround is to run "Check Media" in ankidroid before syncing. After this, the image and audio are synced just fine.

Reading only online?

Do i need to have internet connection to read a local book? Are there third party readers that can be used along side jidoujisho?
The mining process is pretty neat in the app and I would like to use it for reading as well.

JMdict V2 not being imported in version 0.24.5-beta

I tried to import JMdict V2 (available for download here) using 0.24.4-beta and 0.24.5-beta but it wasn't imported, as you can see in this video. That's strange. It had been imported in version 0.24.2-bata. Other dictionaries are being imported but JMdict V2 isn't anymore.

Add "share to/open with jidoujisho"

In YouTube, the search is actually pretty good, so I like to use it for most videos. But occasionally something comes up with subs and I'd like to watch that in jidoujisho just because it's convenient.

It would be nice to have an option to open the current youtube video in jidoujisho for this reason.

Can't select Japanese audio in dual-audio files

Just as the title says, I have a local dual-audio file that plays in English only although it has Japanese. I can't select the option for Japanese although it's already there.
This how it looks

Be able to select the screenshot when exporting multiple subtitles in a same card.

When I export multiple subtitles in a same card, the screenshot is taken from the first subtitle. May be convenient to be able to select the screenshot based on one of the subtitles that I selected to be export on the same card just touching the subtitle, or just be able to take a screenshot freely and put it into the card.

Thanks!

Dictionary term search should be smarter

Currently if one searches for 原色擬似概念 on a local dictionary, it report that it has no results, even tho 原色 exists in the dictionary.

My suggestion is to make the search more lenient so that it supports words shorter than the highlighted ones.

Doesn't load external .srt by default and can't locate any to load manually 0.3.2/0.4.2(non android 11 version)

Samsung Galaxy S7 running Android 8

When selecting a video through Play Local Media you can see both the video and .srt files, but when clicking Load External Subtitles no files can be located, there's no dropdown arrow to change location away from recent, and the "open from" menu doesn't show the phone's local storage.

Play Local Media

Load External Subtitles

0.3.1 loads .srt files by default but doesn't have the Load External Subtitles option so couldn't test that.

Sharing from YouTube does not work when a video was left unclosed

How to reproduce:

• open a YouTube video in jidoujisho
• minimize it and open YouTube instead
• in the YouTube app, share a video to jidoujisho

Startup issue on pixel 4a

Using Android version 11 currently.
Does not start at all.

Support for kanji dictionary.

As of now if I import kanji dictionary the app treats it as word dictionary and cant read it. Is there a way to make kanji dictionary work? Speaking of Kanji dictionary frequency lists are also treated as dictionaries.

.null files

Files generated by Jidoujisho were supposed to be .null files or is it a bug?

[Feature Request] An easy way to favorite sentences on the fly

It would be awesome if we could mark/favorite/save dialogues to look up words after we've finished watching.

A continuation to dual adio problem.

This is a problem that arised after the recent update that was intended to fix a problem where selecting Japanese audio was not possible.
A new problem arised. If I open the a video file that has dual audio the app crashes and exit. If I try to open the video from the file manger it works fine.
This is a link for a video that has the problem.
https://ouo.press/Tz0aKr
Note: other files that are mono-audio work just fine anywhere.
Take your time to fix it. It's a bit of a pain but I can still watch.
Thi

Couple of feature idea.

I think the following features will help advanced learners.

Show subtitle on pause.
Keeps the subtitle hidden and only shows it when the video is paused.

Show subtitle on repeat.
Keeps the subtitle hidden and shows it when the part of the video is repeated.

Thanks a lot for such a great app 😀.

[Feature Request] Forvo audio and NHK Pitch Accent audios

First of all, I'd like to tell you that I've done a factory reset on my phone and that I'm able to open local videos ever since. Thanks, again, for all the time you invested on my own personal issue.

I've been thinking about this request for a long time — you too might've thought about it, I suppose. My feature request is: automatically download and export Forvo audios to Anki and support for NHK Pitch Accent audios that Migaku Japanese uses. I believe that such feature would improve everybody's learning journey with Anki, plus it's a feature to make your project better.

(I've loving the manga feature. I was about to start reading mangas, and you made a tool for it)

Mouse support

When I use a mouse on my tablet I can highlight text and everything but I am unable to scan the text to get dictionary results. Is there a way to set a hotkey or something I yomichan so I can use the middle mouse button to scan? Thank you for your hard work on this amazing project.

Subtitle remains visible until the next one is displayed

In some cases, a subtitle line lasts for a couple of seconds, say, and then it should end according to the transcript, followed by a break of some time before the next subtitle line.

So

• sub1 should be shown for 5s
• there should be no subtitle visible for 5s
• a new subtitle line should be shown

In my case the second step is skipped, meaning the first line is not hidden.

Local videos don't load anymore (only on my phone?)

I've recently flashed LineageOS on phone — a Xiaomi Redmi Note 5. Local videos stopped working since version 0.25.8 — 0.25.7 is working well. I've tried scopedstorage versions, it didn't work as well. Since no one has reported this problem, it might have something to do with LineageOS?

[Feature Request] A way of dealing with furigana in subtitles.

I've found a problem with subs that have furigana, mainly those you find on Netflix subs.




The word can't be parsed at all because there's furigana on almost every kanji. My request is:

• Skip furigana when parsing;
• Option to turn furigana on and off (because it might be helpful for some users);
• Automatically remove furigana when a cards is created.

You can find the subtitle in the screenshots here. But it's pretty common to have furigana in subs — I personally find them annoying.
I'm not aware of other patterns to indicate furigana, so far I've only encountered the one present in the screenshots. There might be more patterns.

Sub not displaying properly

I was watching 史上最強の弟子ケンイチ and noticed that some lines were cut due to the way the sub file is formatted.
Here's an example of the error: https://streamable.com/l8epm5
Here's the lines:
Dialogue: 0,0:02:07.12,0:02:09.37,a,,0,0,0,,（田中(たなか)）\N前から\N気になってたんだけど Dialogue: 0,0:02:09.58,0:02:10.38,a,,0,0,0,,（島山(しまやま)）\Nん？

Dialogue: 0,0:02:25.60,0:02:29.52,a,,0,0,0,,（田中）\Nでも 風林寺ってさ\Nどっか近寄りがたいよな Dialogue: 0,0:02:29.64,0:02:32.19,a,,0,0,0,,住んでる世界が違うっていうか…

Feature request: Showing local file name in the player

Great app that's close to perfection. I mainly use the app for playing local videos and since file names are sometimes too long I can't see the full title of the episode from the file picker. This results in me opening an episode to realize it's the wrong one.
It would be great if I could see the file name inside the player or maybe change the view to list in the file picker (don't no if you can control it).

Subtitle navigation for autogenerated subs broken

Hi, just found out that if I enable autogenerated subs and navigate to one of the last subtitle lines, the video seems to start over in a weird manner instead of going to the end.

Tried it with this video on 0.12.1 beta
https://youtu.be/-i8Nl4zPq20

2 Ideas - A Reading Mode, and Double-Tap to Pause/Unpause

Not sure if these are possible, but I feel like a reading mode would be pretty handy for people who want to learn to read.
Have it pause at the beginning of the line.

The pause button that appears when paused and works when the middle of the screen is tapped is ok, but I feel like setting a Double-Tap to pause would be much more useful, especially on tablets.
Not sure if it's doable with the current media player that is incorporated.

Anki cards are not being created in ankidroid.

I did edit the note type slightly so migaku support would appear but I don't think that it would stop the exportation of cards, other than that all the setting were done correctly. I made sure the cards were being sent to the correct deck multiple times and even rebooted my phone but the cards were not present in ankidroid. The app also crashed a few times today for no reason.

Crash when selecting a subtitle file

I have an anime episode and subtitles for that episode as an .ass file. When I select "Load External Subtitles" from the player menu and select that .ass file, the player crashes every time.

I seem to be able to work around this crash if I first select "no subtitles" and then select the .ass file.

I suspect this may have something to do with the fact that the video file has an embedded English subtitle that is selected by default.

I'm using the latest version, 0.13.1 beta.

I realize this is not a lot to go by, so let me know what I could provide to help investigating this.

Can't export audio to anki

This doesn't happen to all video files, but in certain ones, audio can't be exported. The field doesn't even appear at the export pop up, but it does when I open it in anki.
https://ddl.animeout.com/index.php?url=slaine.animeout.com/series/Completed/Akatsuki%20no%20Yona/[AnimeOut]%20Akatsuki%20no%20Yona%20-%2001%20(720p-100MB)[FFF][Henz].mkv
This an example of a video the illicit this bug.

Exporting to Ankidroid issue

When I try to export to ankidroid, it exports the current snapshot but no audio. It only happens with one anime in specific. It works with the other ones. How can I fix this issue?

Pause video when bluetooth headphone pause button is pressed

My bluetooth headphones have a pause+resume button and two volume controls. The volume controls work right now, but the pause button does nothing.

If I use the same headphones with Netflix or YouTube (vanced), the video is paused and resumed like one would expect.

Configure subtitle font size

I'm using a Galaxy Tab S6 Lite (2000 x 1200px) and I find the size of the subtitles too small to read comfortably.

It seems to be hardcoded to 16px atm, would it be possible to make it configurable?

Better subscriptions import

Would be convenient to be able to import the subscriptions directly from youtube, newpipe, and other similar youtube-based apps.

Thanks!

Don't confirm ending playback when video has ended

I figured I'd open some issues that seem like low hanging fruit.

When the video has ended and I navigate back to leave it, I'm still asked if I want to leave.

Kind of makes sense but idk if it would be nice to just leave without asking in this case.

Default YouTube quality to something that's seek friendly

For me the best experience is when I have good support for rewinding subtitles. Because of this, I'd like to have them well supported when a new video starts playing.

Do you think this could be an option in the app?

Error when installing

When I try to install the app I get this error: (INSTALL_PARSE_FAILED_NO_CERTIFICATES)

[Feature Request] Resize/movable dictionary overlay for reader

First off, thank you for such an amazing app! I was looking for alternatives to Typhon and stumbled upon this gem :')

So far, the dictionary has been relatively easy to use, but I find that it does get in the way when looking up the definition/pronunciation of any kanji near the top of the screen. Being able to drag it around or resize the overlay would make it feel less intrusive and easier to use. Also, while less important, highlighting the current word/phrase being looked up would also be great (similar to Typhon).