nsaito92 commented 4 years ago

概要

ローカルの音楽ファイルを元に、色々な曲をアラームに選択できる様にする。

期待値

対応内容

参考情報

備考

*

nsaito92 commented 4 years ago

対応開始。

技術調査
必要と思われる機能追加の検討

nsaito92 commented 4 years ago

ざっくり必要と思う機能

権限処理(外部ストレージの音楽ファイル参照)
アラームに使用する音楽ファイルをユーザーに選ばせる機能
- これは、画面を一から作らずに、ファイル選択ができる外部アプリ暗黙的Intentを投げることで実現したい。
選択されたファイル情報を永続化する機能
アラーム実行時、永続化しておいたファイル情報を元に、アラーム時に再生する機能

対応する順番

アラームに使用する音楽ファイルをユーザーに選ばせる機能

まずは、上記でどこまで外部アプリに任せられるか調べる。それ次第で実装する量が変わるため。こちらの対応の様に自前の画面で、一覧を表示することもできるが、出来れば、他アプリに任せたい。

nsaito92 commented 4 years ago

アラーム実行時、永続化しておいたファイル情報を元に、アラーム時に再生する機能

現状の仕様だと、MediaPlayer#setDataSourceで、AssetFileDescriptorで取得したFileDescriptor(resディレクトリのmp3ファイル)を、リソースデータとして渡している。
端末ストレージにあるファイルを、FileDescriptorオブジェクトとして渡せる様になることが、単純に考えるとまず必要そう。
- 外部ストレージのファイルを読み出して、FileDescriptorを生成する。
対応案を検討
- FileOutputStream#getFDでFileDescriptorを渡すことが出来る。
- MediaStore API でもいけそう
- FileProvider

外部ストレージのファイルを読み出して、FileDescriptorを生成する方法

使用する処理
- openFileInput関数で、読み出すファイルを取得。
- FileInputStreamクラスに、openFileInputの戻り値を指定して、インスタンス作成。
- InputStreamReaderインスタンスに、FileInputStreamインスタンスと、****パラメータとして、インスタンス作成。
- BufferedReaderインスタンスを、InputStreamReaderを元に作成。

試したこと

1 (NG)

    /**
     * ContentResolverを使用して、URIから正確なファイルパスを取得する。
     * @param uri
     * @return
     */
    public String getFilePathFromUri(Uri uri) {
        Log.d(TAG, "getFilePathFromUri");
        Log.d(TAG, "uri = " + uri);

        Cursor cursor = null;
        String filepath = null;
        String[] columns = {MediaStore.Audio.Media.DATA};   // ★この変数は不要とする。

        Log.d(TAG, "columns[0] = " + columns[0]);

        try {
            cursor = contentResolver.query(uri, null, null, null, null);

            if (cursor != null && cursor.moveToFirst()) {

                // ここには入ってくる
                Log.d(TAG, "cursor OK");

                // カウントは1とれるので、データが一つ取れている。
                Log.d(TAG, "cursor.getCount() = " + cursor.getCount());

                // ★データを取得すると、null。 → queryのprojectionにcolumnsを指定するのをやめたところ、取得出来た。
                // URLが分かって入ればprojectionを指定する理由がないと思われるので、こちらはnullで検討を進める。
                Log.d(TAG, "cursor.getString(0) = " + cursor.getString(0));
                filepath = cursor.getString(0);
            }
        } finally {
            cursor.close();
        }

        Log.d(TAG, "filepath = " + filepath);
        return filepath;
    }

結果ディレクトリが参照できていない。

08-23 18:36:57.998 2094-2094/org.bitbucket.snaoto22.frock D/ContentResolverController: getFilePathFromUri
08-23 18:36:57.998 2094-2094/org.bitbucket.snaoto22.frock D/ContentResolverController: uri = content://com.android.externalstorage.documents/document/primary%3AAndroid%2Fmedia%2Fcom.Slack%2FNotifications%2FSlack%20-%20Boing.mp3
08-23 18:36:57.998 2094-2094/org.bitbucket.snaoto22.frock D/ContentResolverController: columns[0] = _data
08-23 18:36:58.016 2094-2094/org.bitbucket.snaoto22.frock D/ContentResolverController: cursor OK
08-23 18:36:58.016 2094-2094/org.bitbucket.snaoto22.frock D/ContentResolverController: cursor.getCount() = 1
08-23 18:36:58.017 2094-2094/org.bitbucket.snaoto22.frock D/ContentResolverController: cursor.getString(0) = primary:Android/media/com.Slack/Notifications/Slack - Boing.mp3
08-23 18:36:58.018 2094-2094/org.bitbucket.snaoto22.frock D/ContentResolverController: filepath = primary:Android/media/com.Slack/Notifications/Slack - Boing.mp3
08-23 18:36:58.019 2094-2094/org.bitbucket.snaoto22.frock W/System.err: java.io.FileNotFoundException: primary:Android/media/com.Slack/Notifications/Slack - Boing.mp3 (No such file or directory)

2(NG)

こちらの記事を参考にした。


    public String getFilePathFromUri(Uri uri) {
        Log.d(TAG, "getFilePathFromUri");
        Log.d(TAG, "uri = " + uri);

        String filepath = null;

        // URIにより、取得方法が異なるため処理を分ける。
        if (ClockUtil.PackageNames.COM_ANDROID_EXTERNALSTORAGE_DOCUMENTS.
                equals(uri.getAuthority())) {
            Log.d(TAG, "uri.getAuthority() = " + uri.getAuthority());

            //
            String docID = DocumentsContract.getDocumentId(uri);
            String split[] = docID.split(":");
            String type =  split[0];

            Log.d(TAG, "type = " + type);
            Log.d(TAG, "split[1] = " + split[1]);

            //
            if ("primary".equalsIgnoreCase(type)) {
                Log.d(TAG, "test : 1");
                filepath = Environment.getExternalStorageDirectory() + "/" + split[1];
            } else {
                Log.d(TAG, "test : 2");
                //
                filepath =  "/stroage/" + type + "/" + split[1];
            }
        } else {
            Log.d(TAG, "test : 3");
            Cursor cursor = null;
            String[] columns = {MediaStore.Audio.Media.DATA};   // ★この変数は不要とする。

            Log.d(TAG, "columns[0] = " + columns[0]);

            try {
                cursor = contentResolver.query(MediaStore.Images.Media.EXTERNAL_CONTENT_URI, null, null, null, null);

                if (cursor != null && cursor.moveToFirst()) {

                    // ここには入ってくる
                    Log.d(TAG, "cursor OK");

                    // カウントは1とれるので、データが一つ取れている。
                    Log.d(TAG, "cursor.getCount() = " + cursor.getCount());

                    // ★データを取得すると、null。 → queryのprojectionにcolumnsを指定するのをやめたところ、取得出来た。
                    // URLが分かって入ればprojectionを指定する理由がないと思われるので、こちらはnullで検討を進める。
                    Log.d(TAG, "cursor.getString(0) = " + cursor.getString(0));
                    filepath = cursor.getString(0);
                }
            } finally {
                if (cursor != null) {
                    cursor.close();
                }
            }
        }
        Log.d(TAG, "filepath = " + filepath);
        return filepath;
    }

結果権限がないと言われている。

08-24 01:17:56.377 10043-10043/org.bitbucket.snaoto22.frock D/ContentResolverController: getFilePathFromUri
08-24 01:17:56.377 10043-10043/org.bitbucket.snaoto22.frock D/ContentResolverController: uri = content://com.android.externalstorage.documents/document/primary%3AAndroid%2Fmedia%2Fcom.Slack%2FNotifications%2FSlack%20-%20Boing.mp3
08-24 01:17:56.377 10043-10043/org.bitbucket.snaoto22.frock D/ContentResolverController: uri.getAuthority() = com.android.externalstorage.documents
08-24 01:17:56.379 10043-10043/org.bitbucket.snaoto22.frock D/ContentResolverController: type = primary
08-24 01:17:56.379 10043-10043/org.bitbucket.snaoto22.frock D/ContentResolverController: split[1] = Android/media/com.Slack/Notifications/Slack - Boing.mp3
08-24 01:17:56.379 10043-10043/org.bitbucket.snaoto22.frock D/ContentResolverController: test : 1
08-24 01:17:56.383 10043-10043/org.bitbucket.snaoto22.frock D/ContentResolverController: filepath = /storage/emulated/0/Android/media/com.Slack/Notifications/Slack - Boing.mp3
08-24 01:17:56.386 10043-10043/org.bitbucket.snaoto22.frock W/System.err: java.io.FileNotFoundException: /storage/emulated/0/Android/media/com.Slack/Notifications/Slack - Boing.mp3 (Permission denied)

3

権限追加して、端末上で酒毒で権限追加。

    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />

結果 FileDescriptorオブジェクトの生成に成功出来た。

08-24 01:42:44.194 14783-14783/org.bitbucket.snaoto22.frock D/ContentResolverController: getFilePathFromUri
08-24 01:42:44.194 14783-14783/org.bitbucket.snaoto22.frock D/ContentResolverController: uri = content://com.android.externalstorage.documents/document/primary%3AAndroid%2Fmedia%2Fcom.Slack%2FNotifications%2FSlack%20-%20Boing.mp3
08-24 01:42:44.194 14783-14783/org.bitbucket.snaoto22.frock D/ContentResolverController: uri.getAuthority() = com.android.externalstorage.documents
08-24 01:42:44.196 14783-14783/org.bitbucket.snaoto22.frock D/ContentResolverController: type = primary
08-24 01:42:44.196 14783-14783/org.bitbucket.snaoto22.frock D/ContentResolverController: split[1] = Android/media/com.Slack/Notifications/Slack - Boing.mp3
08-24 01:42:44.196 14783-14783/org.bitbucket.snaoto22.frock D/ContentResolverController: test : 1
08-24 01:42:44.198 14783-14783/org.bitbucket.snaoto22.frock D/ContentResolverController: filepath = /storage/emulated/0/Android/media/com.Slack/Notifications/Slack - Boing.mp3
08-24 01:42:44.199 14783-14783/org.bitbucket.snaoto22.frock D/AlarmPreferenceActivity: inputStream.getFD() = java.io.FileDescriptor@9c62f40

nsaito92 commented 4 years ago

間が空いてしまったので現状整理

MediaPlayer#setDataSource に渡すFileDescriptor を他アプリから取得する方法の仮実装が出来た。
実際にMediaPlayerに渡す処理を実装する。
- URIの情報を永続化して、アラーム実行時に読み込む処理
そのあとは、ランタイム権限処理を対応して、本issueは完了。

nsaito92 commented 4 years ago

ファイル選択機能

クラス修正

DB操作周り

【済】FrockSettingsOpenHelper
- テーブルにカラム追加
  - URIを文字列として永続化するカラム
【済】AlarmSettingEntity
- URIを管理するメンバ変数を追加。
- 追加したメンバ変数のset/get処理を追加。
FrockSettingsHelperController
- URI永続化処理
  - 【済】新規追加
  - 【済】編集
  - 【済】削除
  - 音楽の列だけ削除
AlarmService
- アラーム起動時にDBを読み込む
  - FileDescriptorインスタンスが生成出来た : アラーム鳴動に利用する。
  - FileDescriptorの生成に失敗(ファイルがなかった) : assetのファイルを使用し、DBのURI情報を削除する
  - nullだった(ファイル指定特になし) : assetのファイルを使用し、アラーム鳴動に利用する。(既存の動き)
ClockUtil
- 音楽ファイルURIから、ファイル名のみ抽出する処理を追加。

ユーザー操作周り

AlarmPreferenceActivity
- ファイラーから渡されたURLを渡されたら、URI永続化処理を行う。
- 画面を開いた、設定更新された時に、音楽選択の項目の画面表示を更新する様にする。
  - 永続化したURL情報がある場合は、そこからファイル名を表示する。
  - 設定がない場合は、「設定なし」を表示してDBのURI情報を削除する。
- 長押しした時に、初期設定に戻せる項目を追加(再度assetの音楽ファイルを利用する)
  - URI削除処理を実行する。

エビデンス

新規作成したカラムにデータ追加、修正、削除が行えることを確認。

sqlite> select * from alarmsettingsdb;
1|1|1|12|1,4,5|content://com.android.externalstorage.documents/document/primary%3AAndroid%2Fmedia%2Fcom.Slack%2FNotifications%2FSlack%20-%20Boing.mp3
2|0|1|21|1,5|content://com.android.externalstorage.documents/document/primary%3AAndroid%2Fmedia%2Fcom.Slack%2FNotifications%2FSlack%20-%20Plink.mp3
sqlite>

引っかかった点

カラムの追加をしたので、テーブルの再作成を行いたかったが、アプリをアンインストールしても、DBが消えなかった件。マニフェストのAndroid:allowBackupの設定の問題だった。

android:allowBackup
アプリがバックアップ / 復元用インフラストラクチャに参加できるようにするかどうかを指定します。この属性を false に設定した場合、すべてのアプリデータを保存するフルシステム バックアップを adb 経由で実行したとしても、このアプリのバックアップや復元は行われません。この属性のデフォルト値は true です。

nsaito92 commented 4 years ago

現状整理

ファイルURI情報のDBの永続化まで対応。


sqlite> .tables
alarmsettingsdb   android_metadata
sqlite> select * FROM alarmsettingsdb;
1|1|1|12|1,4,5|content://com.android.externalstorage.documents/document/primary%3AAndroid%2Fmedia%2Fcom.Slack%2FNotifications%2FSlack%20-%20Boing.mp3
2|0|1|21|1,5|content://com.android.externalstorage.documents/document/primary%3AAndroid%2Fmedia%2Fcom.Slack%2FNotifications%2FSlack%20-%20Plink.mp3
sqlite>


* 次に永続化した情報を元に、アラームサービスにセットする処理を作り込む。(ド正常系)
* それが出来たら、非正常系、異常系処理を対応。

nsaito92 commented 4 years ago

考えてなかった点

AlarmService からDBのURIを参照する処理を追加するが、どの行のデータを参照すれば分からない状態だった。
追加対応として、 AlarmService インスタンス生成時に元になる行情報を、Intentで渡す様にすることを検討する。

nsaito92 commented 4 years ago

進捗

暫定でAlarmServiceにintent#getIntExtraで 1 を渡して、DBクエリで音楽ファイルを使用して再生する処理を実装。
アラーム鳴動時に、ファイルを使用して再生するところまで出来た。

nsaito92 commented 4 years ago

進捗

スヌーズの場合の考慮が必要なことに気づいたので、追加検討中・・

nsaito92 commented 4 years ago

■対応したこと

【済】calender生成処理を確認
【済】alarmmanagerに投げる設定のentityクラスを生成
【済】画面の表示

■見えている課題

【済】ファイラーアプリで何も選択されなかった場合のハンドリング
【済】ファイル選択機能の残件整理
- ファイル削除された場合とか大丈夫?
【済】設定の保存順によってはアプリが落ちる

■別チケット

時々アラームが起動できていない。リソースのエラー?
通知出なくなってる?
ランタイム権限要求
トーストなどのユーザー通知周り
各コンポーネントの公開状態の見直し?

nsaito92 commented 4 years ago

97a8192919235d18765f1a012fbc3eb97da5ec30 の単体試験。

ファイル選択を行なったが、読み取れないURIだった。まだ「保存」ボタンは押していないため、前のデータが保存されたままの状態。

sqlite> select * FROM alarmsettingsdb;
1|1|7|15|1,2,3,4,5|content://com.android.externalstorage.documents/document/primary%3AAndroid%2Fmedia%2Fcom.Slack%2FNotifications%2FSlack%20-%20Incoming%20call.mp3
2|1|16|50|1,2,3,4,5|content://com.android.externalstorage.documents/document/primary%3AAndroid%2Fmedia%2Fcom.Slack%2FNotifications%2FSlack%20-%20Plink.mp3
3|1|18|19|4|content://com.android.externalstorage.documents/document/primary%3AAndroid%2Fmedia%2Fcom.Slack%2FNotifications%2FSlack%20-%20Wow.mp3

保存ボタンタップ後。無効なデータである情報を保存した。

sqlite> select * FROM alarmsettingsdb;
1|1|7|15|1,2,3,4,5|content://com.android.externalstorage.documents/document/primary%3AAndroid%2Fmedia%2Fcom.Slack%2FNotifications%2FSlack%20-%20Incoming%20call.mp3
2|1|16|50|1,2,3,4,5|content://com.android.externalstorage.documents/document/primary%3AAndroid%2Fmedia%2Fcom.Slack%2FNotifications%2FSlack%20-%20Plink.mp3
3|1|18|19|4|invaliduri

nsaito92 commented 4 years ago

残件のチケットを作成したのでcloseします。

nsaito92 / Frock

ローカルの音楽ファイルを元に、色々な曲をアラームに選択できる様にする。 #9

概要

期待値

対応内容

参考情報

備考

アラーム実行時、永続化しておいたファイル情報を元に、アラーム時に再生する機能

外部ストレージのファイルを読み出して、FileDescriptorを生成する方法

関連情報

URI取得パターンの例

adbで行う場合

試したこと

1 (NG)

2(NG)

3

ファイル選択機能

クラス修正

DB操作周り

ユーザー操作周り

エビデンス

引っかかった点

現状整理