videos: move 'Caption' and associated global/functions to a separate file

2022-05-23 22:37:58 +02:00 · 2022-05-23 22:37:58 +02:00 · cd03fa06ae
commit cd03fa06ae
--- a/spec/spec_helper.cr
+++ b/spec/spec_helper.cr
@ -5,6 +5,7 @@ require "protodec/utils"
 require "yaml"
 require "../src/invidious/helpers/*"
 require "../src/invidious/channels/*"
+require "../src/invidious/videos/caption"
 require "../src/invidious/videos"
 require "../src/invidious/comments"
 require "../src/invidious/playlists"
--- a/src/invidious/frontend/watch_page.cr
+++ b/src/invidious/frontend/watch_page.cr
@ -7,7 +7,7 @@ module Invidious::Frontend::WatchPage
    getter full_videos : Array(Hash(String, JSON::Any))
    getter video_streams : Array(Hash(String, JSON::Any))
    getter audio_streams : Array(Hash(String, JSON::Any))
-    getter captions : Array(Caption)
+    getter captions : Array(Invidious::Videos::Caption)

    def initialize(
      @full_videos,
--- a/src/invidious/videos.cr
+++ b/src/invidious/videos.cr
@ -1,136 +1,3 @@
-CAPTION_LANGUAGES = {
-  "",
-  "English",
-  "English (auto-generated)",
-  "English (United Kingdom)",
-  "English (United States)",
-  "Afrikaans",
-  "Albanian",
-  "Amharic",
-  "Arabic",
-  "Armenian",
-  "Azerbaijani",
-  "Bangla",
-  "Basque",
-  "Belarusian",
-  "Bosnian",
-  "Bulgarian",
-  "Burmese",
-  "Cantonese (Hong Kong)",
-  "Catalan",
-  "Cebuano",
-  "Chinese",
-  "Chinese (China)",
-  "Chinese (Hong Kong)",
-  "Chinese (Simplified)",
-  "Chinese (Taiwan)",
-  "Chinese (Traditional)",
-  "Corsican",
-  "Croatian",
-  "Czech",
-  "Danish",
-  "Dutch",
-  "Dutch (auto-generated)",
-  "Esperanto",
-  "Estonian",
-  "Filipino",
-  "Finnish",
-  "French",
-  "French (auto-generated)",
-  "Galician",
-  "Georgian",
-  "German",
-  "German (auto-generated)",
-  "Greek",
-  "Gujarati",
-  "Haitian Creole",
-  "Hausa",
-  "Hawaiian",
-  "Hebrew",
-  "Hindi",
-  "Hmong",
-  "Hungarian",
-  "Icelandic",
-  "Igbo",
-  "Indonesian",
-  "Indonesian (auto-generated)",
-  "Interlingue",
-  "Irish",
-  "Italian",
-  "Italian (auto-generated)",
-  "Japanese",
-  "Japanese (auto-generated)",
-  "Javanese",
-  "Kannada",
-  "Kazakh",
-  "Khmer",
-  "Korean",
-  "Korean (auto-generated)",
-  "Kurdish",
-  "Kyrgyz",
-  "Lao",
-  "Latin",
-  "Latvian",
-  "Lithuanian",
-  "Luxembourgish",
-  "Macedonian",
-  "Malagasy",
-  "Malay",
-  "Malayalam",
-  "Maltese",
-  "Maori",
-  "Marathi",
-  "Mongolian",
-  "Nepali",
-  "Norwegian Bokmål",
-  "Nyanja",
-  "Pashto",
-  "Persian",
-  "Polish",
-  "Portuguese",
-  "Portuguese (auto-generated)",
-  "Portuguese (Brazil)",
-  "Punjabi",
-  "Romanian",
-  "Russian",
-  "Russian (auto-generated)",
-  "Samoan",
-  "Scottish Gaelic",
-  "Serbian",
-  "Shona",
-  "Sindhi",
-  "Sinhala",
-  "Slovak",
-  "Slovenian",
-  "Somali",
-  "Southern Sotho",
-  "Spanish",
-  "Spanish (auto-generated)",
-  "Spanish (Latin America)",
-  "Spanish (Mexico)",
-  "Spanish (Spain)",
-  "Sundanese",
-  "Swahili",
-  "Swedish",
-  "Tajik",
-  "Tamil",
-  "Telugu",
-  "Thai",
-  "Turkish",
-  "Turkish (auto-generated)",
-  "Ukrainian",
-  "Urdu",
-  "Uzbek",
-  "Vietnamese",
-  "Vietnamese (auto-generated)",
-  "Welsh",
-  "Western Frisian",
-  "Xhosa",
-  "Yiddish",
-  "Yoruba",
-  "Zulu",
-}
-
 struct Video
  include DB::Serializable

@ -141,7 +8,7 @@ struct Video
  property updated : Time

  @[DB::Field(ignore: true)]
-  property captions : Array(Caption)?
+  @captions = [] of Invidious::Videos::Caption

  @[DB::Field(ignore: true)]
  property adaptive_fmts : Array(Hash(String, JSON::Any))?
@ -595,20 +462,12 @@ struct Video
    keywords.includes? "YouTube Red"
  end

-  def captions : Array(Caption)
-    return @captions.as(Array(Caption)) if @captions
-    captions = info["captions"]?.try &.["playerCaptionsTracklistRenderer"]?.try &.["captionTracks"]?.try &.as_a.map do |caption|
-      name = caption["name"]["simpleText"]? || caption["name"]["runs"][0]["text"]
-      language_code = caption["languageCode"].to_s
-      base_url = caption["baseUrl"].to_s
-
-      caption = Caption.new(name.to_s, language_code, base_url)
-      caption.name = caption.name.split(" - ")[0]
-      caption
+  def captions : Array(Invidious::Videos::Caption)
+    if @captions.empty? && @info.has_key?("captions")
+      @captions = Invidious::Videos::Caption.from_yt_json(info["captions"])
    end
-    captions ||= [] of Caption
-    @captions = captions
-    return @captions.as(Array(Caption))
+
+    return @captions
  end

  def description
@ -672,21 +531,6 @@ struct Video
  end
 end

-struct Caption
-  property name
-  property language_code
-  property base_url
-
-  getter name : String
-  getter language_code : String
-  getter base_url : String
-
-  setter name
-
-  def initialize(@name, @language_code, @base_url)
-  end
-end
-
 class VideoRedirect < Exception
  property video_id : String

--- a/src/invidious/videos/caption.cr
+++ b/src/invidious/videos/caption.cr
@ -0,0 +1,168 @@
+require "json"
+
+module Invidious::Videos
+  struct Caption
+    property name : String
+    property language_code : String
+    property base_url : String
+
+    def initialize(@name, @language_code, @base_url)
+    end
+
+    # Parse the JSON structure from Youtube
+    def self.from_yt_json(container : JSON::Any) : Array(Caption)
+      caption_tracks = container
+        .dig?("playerCaptionsTracklistRenderer", "captionTracks")
+        .try &.as_a
+
+      captions_list = [] of Caption
+      return captions_list if caption_tracks.nil?
+
+      caption_tracks.each do |caption|
+        name = caption["name"]["simpleText"]? || caption["name"]["runs"][0]["text"]
+        name = name.to_s.split(" - ")[0]
+
+        language_code = caption["languageCode"].to_s
+        base_url = caption["baseUrl"].to_s
+
+        captions_list << Caption.new(name, language_code, base_url)
+      end
+
+      return captions_list
+    end
+
+    # List of all caption languages available on Youtube.
+    LANGUAGES = {
+      "",
+      "English",
+      "English (auto-generated)",
+      "English (United Kingdom)",
+      "English (United States)",
+      "Afrikaans",
+      "Albanian",
+      "Amharic",
+      "Arabic",
+      "Armenian",
+      "Azerbaijani",
+      "Bangla",
+      "Basque",
+      "Belarusian",
+      "Bosnian",
+      "Bulgarian",
+      "Burmese",
+      "Cantonese (Hong Kong)",
+      "Catalan",
+      "Cebuano",
+      "Chinese",
+      "Chinese (China)",
+      "Chinese (Hong Kong)",
+      "Chinese (Simplified)",
+      "Chinese (Taiwan)",
+      "Chinese (Traditional)",
+      "Corsican",
+      "Croatian",
+      "Czech",
+      "Danish",
+      "Dutch",
+      "Dutch (auto-generated)",
+      "Esperanto",
+      "Estonian",
+      "Filipino",
+      "Finnish",
+      "French",
+      "French (auto-generated)",
+      "Galician",
+      "Georgian",
+      "German",
+      "German (auto-generated)",
+      "Greek",
+      "Gujarati",
+      "Haitian Creole",
+      "Hausa",
+      "Hawaiian",
+      "Hebrew",
+      "Hindi",
+      "Hmong",
+      "Hungarian",
+      "Icelandic",
+      "Igbo",
+      "Indonesian",
+      "Indonesian (auto-generated)",
+      "Interlingue",
+      "Irish",
+      "Italian",
+      "Italian (auto-generated)",
+      "Japanese",
+      "Japanese (auto-generated)",
+      "Javanese",
+      "Kannada",
+      "Kazakh",
+      "Khmer",
+      "Korean",
+      "Korean (auto-generated)",
+      "Kurdish",
+      "Kyrgyz",
+      "Lao",
+      "Latin",
+      "Latvian",
+      "Lithuanian",
+      "Luxembourgish",
+      "Macedonian",
+      "Malagasy",
+      "Malay",
+      "Malayalam",
+      "Maltese",
+      "Maori",
+      "Marathi",
+      "Mongolian",
+      "Nepali",
+      "Norwegian Bokmål",
+      "Nyanja",
+      "Pashto",
+      "Persian",
+      "Polish",
+      "Portuguese",
+      "Portuguese (auto-generated)",
+      "Portuguese (Brazil)",
+      "Punjabi",
+      "Romanian",
+      "Russian",
+      "Russian (auto-generated)",
+      "Samoan",
+      "Scottish Gaelic",
+      "Serbian",
+      "Shona",
+      "Sindhi",
+      "Sinhala",
+      "Slovak",
+      "Slovenian",
+      "Somali",
+      "Southern Sotho",
+      "Spanish",
+      "Spanish (auto-generated)",
+      "Spanish (Latin America)",
+      "Spanish (Mexico)",
+      "Spanish (Spain)",
+      "Sundanese",
+      "Swahili",
+      "Swedish",
+      "Tajik",
+      "Tamil",
+      "Telugu",
+      "Thai",
+      "Turkish",
+      "Turkish (auto-generated)",
+      "Ukrainian",
+      "Urdu",
+      "Uzbek",
+      "Vietnamese",
+      "Vietnamese (auto-generated)",
+      "Welsh",
+      "Western Frisian",
+      "Xhosa",
+      "Yiddish",
+      "Yoruba",
+      "Zulu",
+    }
+  end
+end
--- a/src/invidious/views/user/preferences.ecr
+++ b/src/invidious/views/user/preferences.ecr
@ -89,7 +89,7 @@
                <label for="captions[0]"><%= translate(locale, "preferences_captions_label") %></label>
                <% preferences.captions.each_with_index do |caption, index| %>
                    <select class="pure-u-1-6" name="captions[<%= index %>]" id="captions[<%= index %>]">
-                        <% CAPTION_LANGUAGES.each do |option| %>
+                        <% Invidious::Videos::Caption::LANGUAGES.each do |option| %>
                            <option value="<%= option %>" <% if preferences.captions[index] == option %> selected <% end %>><%= translate(locale, option.blank? ? "none" : option) %></option>
                        <% end %>
                    </select>