Crate rsynko_yt

Expand description

§rsynko-yt

This crate specifies how Youtube is a special case of media download. A Youtube watch URL denotes a video identity; retrieving its watch page reveals a player key; a fully described player request denotes the media catalog; each catalog entry states where its representation lives and what guards it; a granted entry denotes a fully described media request; and that request is consumed by the generic atomic download program.

The specification owns Youtube URL recognition, request descriptions, player-response interpretation, challenge meaning, format ranking, and the composition with ordinary selection, naming, progress, atomic publication, and terminal reporting. It chooses no HTTP client, no JSON decoder, no URL library, and no player-program evaluator. An interpreter executes a YoutubeRequest, decodes response bytes, performs the query mechanics, and resolves challenges; it never infers Youtube behavior from a host name or media URL.

URL recognition is a pure observation and belongs to the specification:

use rsynko_yt::youtube_id;

assert_eq!(
    youtube_id("https://www.youtube.com/watch?v=abc123"),
    Some("abc123".to_owned()),
);
assert_eq!(youtube_id("https://example.com/watch?v=abc123"), None);

YoutubeSorts carries the request and solution sorts every Youtube class shares, so a class never re-declares one. YoutubeRequestAlg defines the watch, player, player-program, and media requests in that carrier; YoutubeRequestBytesAlg executes one without changing what it means; YoutubeProgramAlg observes what a player program states about itself; and YoutubeResponseAlg decodes the bytes into YoutubeWatchPage and YoutubePlayer observations.

Youtube grants a catalog matching what a client claims about itself, so the program is retrieved before the catalog and the player request states the session the page issued and the signature timestamp of the program the client runs. A request claiming nothing is answered with the formats such a client may retrieve, or refused outright.

Each client is granted a different catalog, and neither is the whole truth: one states a single muxed representation carrying both streams, another states every adaptive representation on its own. YoutubeClientAlg names the clients an interpreter can present itself as, and extraction asks under each claim and takes the union in claim order. A client refused states nothing about the others.

A reference interpreter tying those sorts to an inspectable YoutubeRequest lives in rsynko-memory.

§Challenges

A described format is not the same as a retrievable one. Youtube states a format’s location in one of two ways, denoted by YoutubeFormatSource: directly, or behind a signature that only the player program resolves. Independently, a location may carry a throttling parameter governing the rate at which the representation is served. YoutubeChallenge denotes both as one kind of thing — an obfuscated value whose solution is a value.

The two guard different things. A signature guards access: unanswered, the representation cannot be retrieved at all. A throttling parameter governs the rate at which a granted representation is served: unanswered, the representation is still retrievable, only slowly.

Granting a format means answering every challenge its source poses. YoutubeGrant denotes the outcome for exactly one format: granted at a fully answered URL, throttled at a URL still posing its throttling parameter, or withheld together with the signature that withheld it. Withholding is an observation, never a silent omission.

use rsynko_yt::{DEFAULT_SIGNATURE_PARAMETER, YoutubeChallenge, YoutubeFormatSource};

let source = YoutubeFormatSource::Signed {
    url: "https://media.example/video.mp4".to_owned(),
    signature: "obfuscated".to_owned(),
    parameter: DEFAULT_SIGNATURE_PARAMETER.to_owned(),
};
assert_eq!(source.url(), "https://media.example/video.mp4");
assert_eq!(
    source.signature_challenge(),
    Some(YoutubeChallenge::Signature("obfuscated".to_owned())),
);

Three primitive capabilities carry the parts a specification cannot state. YoutubeUrlAlg observes and answers the query surface. YoutubeChallengeAlg resolves the posed challenges in one application under the player program that poses them, so that resolution cost follows the number of distinct challenges rather than the number of formats, and a solution is never mistaken for one another program would give. YoutubeSolutionAlg observes one individual solution. YoutubeChallengeExt derives challenge collection, per-format granting, and whole-catalog granting over them.

An interpreter that resolves nothing is a complete interpreter. It withholds every signed format with its unresolved signature and serves the rest at whatever rate their unanswered throttling parameters govern, which keeps the catalog honest while a player-program evaluator is absent.

§Laws

request construction is deterministic for a video identity and player key;
only audio and/or video formats are admitted;
a source posing no challenge is granted its stated URL unchanged;
granting yields exactly one outcome per described format, in declaration order;
one distinct challenge is posed to resolution once however many formats pose it;
an unresolved signature withholds exactly the formats it guards and no others;
an unresolved throttling parameter governs the rate of a still retrievable URL;
a solution is stated relative to the player program that poses the challenge;
attaching a solved signature leaves the throttling challenge of a URL unchanged;
formats are ordered by height and bitrate before ordinary best/worst selection;
the player catalog depends on the video identity, the API key, and what the client claims;
the catalog is the union of what every client is granted, in claim order;
extraction states how many formats were described, unreadable, withheld, and throttled;
the selected media request is passed unchanged to generic download;
generic download publication, progress, and exactly-one-terminal-event laws remain intact.

Macros§

ambassador_impl_YoutubeChallengeAlg: A macro to be used by ambassador::Delegate to delegate YoutubeChallengeAlg A macro to be used by ambassador::Delegate to delegate YoutubeChallengeAlg A macro to be used by ambassador::Delegate to delegate YoutubeChallengeAlg
ambassador_impl_YoutubeClientAlg: A macro to be used by ambassador::Delegate to delegate YoutubeClientAlg A macro to be used by ambassador::Delegate to delegate YoutubeClientAlg A macro to be used by ambassador::Delegate to delegate YoutubeClientAlg
ambassador_impl_YoutubeProgramAlg: A macro to be used by ambassador::Delegate to delegate YoutubeProgramAlg A macro to be used by ambassador::Delegate to delegate YoutubeProgramAlg A macro to be used by ambassador::Delegate to delegate YoutubeProgramAlg
ambassador_impl_YoutubeRequestAlg: A macro to be used by ambassador::Delegate to delegate YoutubeRequestAlg A macro to be used by ambassador::Delegate to delegate YoutubeRequestAlg A macro to be used by ambassador::Delegate to delegate YoutubeRequestAlg
ambassador_impl_YoutubeRequestBytesAlg: A macro to be used by ambassador::Delegate to delegate YoutubeRequestBytesAlg A macro to be used by ambassador::Delegate to delegate YoutubeRequestBytesAlg A macro to be used by ambassador::Delegate to delegate YoutubeRequestBytesAlg
ambassador_impl_YoutubeResponseAlg: A macro to be used by ambassador::Delegate to delegate YoutubeResponseAlg
ambassador_impl_YoutubeSolutionAlg: A macro to be used by ambassador::Delegate to delegate YoutubeSolutionAlg A macro to be used by ambassador::Delegate to delegate YoutubeSolutionAlg A macro to be used by ambassador::Delegate to delegate YoutubeSolutionAlg
ambassador_impl_YoutubeUrlAlg: A macro to be used by ambassador::Delegate to delegate YoutubeUrlAlg A macro to be used by ambassador::Delegate to delegate YoutubeUrlAlg A macro to be used by ambassador::Delegate to delegate YoutubeUrlAlg

Structs§

PlayerClaim: Denotes what one client claims about itself when it asks for a catalog.
YoutubeFormat: Denotes one format described by the Youtube player response.
YoutubePlayer: Denotes the Youtube observations recovered from a player response.
YoutubeWatchPage: Denotes the Youtube observations recovered from a watch page.

Enums§

WithheldReason: Names the kind of unresolved challenge withholding an entire format catalog.
YoutubeApplicationError: Denotes failure of one Youtube-specialized media download.
YoutubeChallenge: Denotes one obfuscated value that only the Youtube player program resolves.
YoutubeError: Denotes failure to interpret one Youtube watch URL.
YoutubeFormatSource: Denotes how one format states the location of its representation.
YoutubeGrant: Denotes the outcome of granting one format its retrievable representation.

Constants§

DEFAULT_SIGNATURE_PARAMETER: Names the query parameter carrying a solved signature when a format states no other.
YOUTUBE_DESCRIBED: Names the observation counting the formats the player response described.
YOUTUBE_THROTTLED: Names the observation counting the formats an unresolved throttling parameter governs.
YOUTUBE_UNREADABLE: Names the observation counting the described formats the interpreter could not read.
YOUTUBE_WITHHELD: Names the observation counting the formats an unresolved signature withheld.

Traits§

YoutubeApplicationExt: Derives Youtube extraction and specialized media retrieval as generic download.
YoutubeApplicationLaws: Checks that Youtube specialization hands its media request to generic download unchanged.
YoutubeChallengeAlg: Specifies resolution of every challenge one catalog poses in a single application.
YoutubeChallengeExt: Derives bulk challenge resolution and per-format granting from primitive capabilities.
YoutubeChallengeLawFixture: Supplies the resolved challenges and the application trace a granting scenario cannot author.
YoutubeChallengeLaws: Checks the granting laws against any interpreter that resolves Youtube challenges.
YoutubeClientAlg: Specifies which clients one interpreter can present itself as.
YoutubeExtractionExt: Derives Youtube extraction from request, response, and domain-data algebras.
YoutubeExtractionLaws: Checks that Youtube extraction denotes exactly the video its URL identifies.
YoutubeLawFixture: Supplies the transport bytes and request trace a Youtube scenario cannot author for itself.
YoutubeNotesExt: Derives what a reader is told about extraction and about the requests that follow it.
YoutubeProgramAlg: Specifies observation of what a player program states about itself.
YoutubeRequestAlg: Provides the carrier and constructors for Youtube requests.
YoutubeRequestBytesAlg: Specifies retrieval of bytes denoted by a Youtube request carrier.
YoutubeRequestLaws: Checks that the request vocabulary distinguishes the retrievals it names.
YoutubeResponseAlg: Specifies decoding transport bytes into Youtube response observations.
YoutubeResponseLaws: Checks that decoding recovers the observations the transport bytes describe.
YoutubeSolutionAlg: Specifies observation of one individually resolved challenge.
YoutubeSolutionLaws: Checks the granting laws that only a seeded, tracing interpreter can exercise.
YoutubeSorts: The sorts of Youtube meaning — the type families the Youtube algebra classes share.
YoutubeUrlAlg: Specifies the query surface through which Youtube poses and answers URL challenges.
YoutubeUrlLaws: Checks the query-surface laws against any interpreter of Youtube URL mechanics.

Functions§

media_failure: States what a reader is told about one failed media request.
withheld_challenge: Names the challenge a grant withheld, when it withheld one.
youtube_id: Observes the video identity denoted by a supported Youtube URL.

Crate rsynko_yt

Crate rsynko_yt Copy item path

§rsynko-yt

§Challenges

§Laws

Macros§

Structs§

Enums§

Constants§

Traits§

Functions§

Crate rsynko_yt