aboutsummaryrefslogtreecommitdiff
path: root/ext/js/media/media-util.js
blob: e02cc391abfd9622911b224bde5cd6b1d14e4d0e (plain)
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
/*
 * Copyright (C) 2023       Yomitan Authors
 * Copyright (C) 2020-2022  Yomichan Authors
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

/**
 * MediaUtil is a class containing helper methods related to media processing.
 */
class MediaUtil {
    /**
     * Gets the file extension of a file path. URL search queries and hash
     * fragments are not handled.
     * @param {string} path The path to the file.
     * @returns {string} The file extension, including the '.', or an empty string
     *   if there is no file extension.
     */
    static getFileNameExtension(path) {
        const match = /\.[^./\\]*$/.exec(path);
        return match !== null ? match[0] : '';
    }

    /**
     * Gets an image file's media type using a file path.
     * @param {string} path The path to the file.
     * @returns {?string} The media type string if it can be determined from the file path,
     *   otherwise `null`.
     */
    static getImageMediaTypeFromFileName(path) {
        switch (this.getFileNameExtension(path).toLowerCase()) {
            case '.apng':
                return 'image/apng';
            case '.bmp':
                return 'image/bmp';
            case '.gif':
                return 'image/gif';
            case '.ico':
            case '.cur':
                return 'image/x-icon';
            case '.jpg':
            case '.jpeg':
            case '.jfif':
            case '.pjpeg':
            case '.pjp':
                return 'image/jpeg';
            case '.png':
                return 'image/png';
            case '.svg':
                return 'image/svg+xml';
            case '.tif':
            case '.tiff':
                return 'image/tiff';
            case '.webp':
                return 'image/webp';
            default:
                return null;
        }
    }

    /**
     * Gets the file extension for a corresponding media type.
     * @param {string} mediaType The media type to use.
     * @returns {?string} A file extension including the dot for the media type,
     *   otherwise `null`.
     */
    static getFileExtensionFromImageMediaType(mediaType) {
        switch (mediaType) {
            case 'image/apng':
                return '.apng';
            case 'image/bmp':
                return '.bmp';
            case 'image/gif':
                return '.gif';
            case 'image/x-icon':
                return '.ico';
            case 'image/jpeg':
                return '.jpeg';
            case 'image/png':
                return '.png';
            case 'image/svg+xml':
                return '.svg';
            case 'image/tiff':
                return '.tiff';
            case 'image/webp':
                return '.webp';
            default:
                return null;
        }
    }

    /**
     * Gets the file extension for a corresponding media type.
     * @param {string} mediaType The media type to use.
     * @returns {string} A file extension including the dot for the media type,
     *   otherwise `null`.
     */
    static getFileExtensionFromAudioMediaType(mediaType) {
        switch (mediaType) {
            case 'audio/mpeg':
            case 'audio/mp3':
                return '.mp3';
            case 'audio/mp4':
                return '.mp4';
            case 'audio/ogg':
            case 'audio/vorbis':
                return '.ogg';
            case 'audio/vnd.wav':
            case 'audio/wave':
            case 'audio/wav':
            case 'audio/x-wav':
            case 'audio/x-pn-wav':
                return '.wav';
            case 'audio/flac':
                return '.flac';
            case 'audio/webm':
                return '.webm';
            default:
                return null;
        }
    }
}