Download video(s) (first iteration) (#5)

* Updated package.json (and made an excuse to make a branch) * Video filepath parser (#6) * Restructured files; Added parser placeholder * More restructuring * Added basic parser for hydrating template strings * Improved docs * More docs * Initial implementation of media profiles (#7) * [WIP] Added basic video download method * [WIP] Very-WIP first steps at parsing options and downloading * Made my options safe by default and removed special safe versions * Ran html generator for mediaprofile model - leaving as-is for now * Addressed a bunch of TODO comments * Add "channel" type Media Source (#8) * [WIP] Working on fetching channel metadata in yt-dlp backend * Finished first draft of methods to do with querying channels * Renamed CommandRunnerMock to have a more descriptive name * Ran the phx generator for the channel model * Renamed Downloader namespace to MediaClient * [WIP] saving before attempting LiveView * LiveView did not work out but here's a working controller how about * Index a channel (#9) * Ran a MediaItem generator; Reformatted to my liking * [WIP] added basic index function * setup oban * Added basic Oban job for indexing * Added in workers for indexing; hooked them into record creation flow * Added a task model with a phx generator * Tied together tasks with jobs and channels * Download indexed videos (#10) * Clarified documentation * more comments * [WIP] hooked up basic video downloading; starting work on metadata * Added metadata model and parsing Adding the metadata model made me realize that, in many cases, yt-dlp returns undesired input in stdout, breaking parsing. In order to get the metadata model working, I had to change the way in which the app interacts with yt-dlp. Now, output is written as a file to disk which is immediately re-read and returned. * Added tests for video download worker * Hooked up video downloading to the channel indexing pipeline * Adds tasks for media items * Updated video metadata parser to extract the title * Ran linting
2024-01-30 20:15:59 -08:00
1 parent fee39151a8
commit a5e7c48f70
@@ -0,0 +1,27 @@
+defmodule Pinchflat.Profiles.MediaProfile do
+  @moduledoc """
+  A media profile is a set of settings that can be applied to many media sources
+  """
+
+  use Ecto.Schema
+  import Ecto.Changeset
+
+  alias Pinchflat.MediaSource.Channel
+
+  schema "media_profiles" do
+    field :name, :string
+    field :output_path_template, :string
+
+    has_many :channels, Channel
+
+    timestamps(type: :utc_datetime)
+  end
+
+  @doc false
+  def changeset(media_profile, attrs) do
+    media_profile
+    |> cast(attrs, [:name, :output_path_template])
+    |> validate_required([:name, :output_path_template])
+    |> unique_constraint(:name)
+  end
+end
@@ -0,0 +1,39 @@
+defmodule Pinchflat.Profiles.Options.YtDlp.OptionBuilder do
+  @moduledoc """
+  Builds the options for yt-dlp based on the given media profile.
+
+  IDEA: consider making this a behaviour so I can add other backends later
+  """
+
+  alias Pinchflat.Profiles.MediaProfile
+  alias Pinchflat.Profiles.Options.YtDlp.OutputPathBuilder
+
+  @doc """
+  Builds the options for yt-dlp based on the given media profile.
+
+  IDEA: consider adding the ability to pass in a second argument to override
+        these options
+  """
+  def build(%MediaProfile{} = media_profile) do
+    {:ok, output_path} = OutputPathBuilder.build(media_profile.output_path_template)
+
+    # NOTE: I'll be hardcoding most things for now (esp. options to help me test) -
+    # add more configuration later as I build out the models. Walk before you can run!
+
+    # NOTE: Looks like you can put different media types in different directories.
+    # see: https://github.com/yt-dlp/yt-dlp#output-template
+    {:ok,
+     [
+       :embed_metadata,
+       :embed_thumbnail,
+       :embed_subs,
+       :no_progress,
+       sub_langs: "en.*",
+       output: Path.join(base_directory(), output_path)
+     ]}
+  end
+
+  defp base_directory do
+    Application.get_env(:pinchflat, :media_directory)
+  end
+end
@@ -0,0 +1,64 @@
+defmodule Pinchflat.Profiles.Options.YtDlp.OutputPathBuilder do
+  @moduledoc """
+  Builds yt-dlp-friendly output paths for downloaded media
+
+  IDEA: consider making this a behaviour so I can add other backends later
+  """
+
+  alias Pinchflat.RenderedString.Parser, as: TemplateParser
+
+  @doc """
+  Builds the actual final filepath from a given template.
+
+  Translates liquid-style templates into yt-dlp-style templates,
+  leaving yt-dlp syntax intact.
+  """
+  def build(template_string) do
+    TemplateParser.parse(template_string, full_yt_dlp_options_map())
+  end
+
+  defp full_yt_dlp_options_map do
+    Map.merge(
+      standard_yt_dlp_option_map(),
+      custom_yt_dlp_option_map()
+    )
+  end
+
+  defp standard_yt_dlp_option_map do
+    %{
+      # Uppercase "S" means "safe" - ie: filepath-safe
+      "id" => "%(id)S",
+      "ext" => "%(ext)S",
+      "title" => "%(title)S",
+      "fulltitle" => "%(fulltitle)S",
+      "uploader" => "%(uploader)S",
+      "creator" => "%(creator)S",
+      "upload_date" => "%(upload_date)S",
+      "release_date" => "%(release_date)S",
+      "duration" => "%(duration)S",
+      # For videos classified as an episode of a series:
+      "series" => "%(series)S",
+      "season" => "%(season)S",
+      "season_number" => "%(season_number)S",
+      "episode" => "%(episode)S",
+      "episode_number" => "%(episode_number)S",
+      "episode_id" => "%(episode_id)S",
+      # For videos classified as music:
+      "track" => "%(track)S",
+      "track_number" => "%(track_number)S",
+      "artist" => "%(artist)S",
+      "album" => "%(album)S",
+      "album_type" => "%(album_type)S",
+      "genre" => "%(genre)S"
+    }
+  end
+
+  defp custom_yt_dlp_option_map do
+    %{
+      # Individual parts of the upload date
+      "upload_year" => "%(upload_date>%Y)S",
+      "upload_month" => "%(upload_date>%m)S",
+      "upload_day" => "%(upload_date>%d)S"
+    }
+  end
+end