# Copyright 2026 The HuggingFace Team. All rights reserved. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. import torch from transformers import T5EncoderModel, T5TokenizerFast from ...configuration_utils import FrozenDict from ...guiders import ClassifierFreeGuidance from ...models import AutoencoderKLLTXVideo from ...utils import logging from ...video_processor import VideoProcessor from ..modular_pipeline import ModularPipelineBlocks, PipelineState from ..modular_pipeline_utils import ComponentSpec, InputParam, OutputParam from .modular_pipeline import LTXModularPipeline logger = logging.get_logger(__name__) def _get_t5_prompt_embeds( components, prompt: str | list[str], max_sequence_length: int, device: torch.device, dtype: torch.dtype, ): prompt = [prompt] if isinstance(prompt, str) else prompt text_inputs = components.tokenizer( prompt, padding="max_length", max_length=max_sequence_length, truncation=True, add_special_tokens=True, return_tensors="pt", ) text_input_ids = text_inputs.input_ids prompt_attention_mask = text_inputs.attention_mask prompt_attention_mask = prompt_attention_mask.bool().to(device) prompt_embeds = components.text_encoder(text_input_ids.to(device))[0] prompt_embeds = prompt_embeds.to(dtype=dtype, device=device) return prompt_embeds, prompt_attention_mask class LTXTextEncoderStep(ModularPipelineBlocks): model_name = "ltx" @property def description(self) -> str: return "Text Encoder step that generates text embeddings to guide the video generation" @property def expected_components(self) -> list[ComponentSpec]: return [ ComponentSpec("text_encoder", T5EncoderModel), ComponentSpec("tokenizer", T5TokenizerFast), ComponentSpec( "guider", ClassifierFreeGuidance, config=FrozenDict({"guidance_scale": 3.0}), default_creation_method="from_config", ), ] @property def inputs(self) -> list[InputParam]: return [ InputParam.template("prompt"), InputParam.template("negative_prompt"), InputParam.template("max_sequence_length", default=128), ] @property def intermediate_outputs(self) -> list[OutputParam]: return [ OutputParam.template("prompt_embeds"), OutputParam.template("prompt_embeds_mask", name="prompt_attention_mask"), OutputParam.template("negative_prompt_embeds"), OutputParam.template("negative_prompt_embeds_mask", name="negative_prompt_attention_mask"), ] @staticmethod def check_inputs(block_state): if block_state.prompt is not None and ( not isinstance(block_state.prompt, str) and not isinstance(block_state.prompt, list) ): raise ValueError(f"`prompt` has to be of type `str` or `list` but is {type(block_state.prompt)}") @staticmethod def encode_prompt( components, prompt: str, device: torch.device | None = None, prepare_unconditional_embeds: bool = True, negative_prompt: str | None = None, max_sequence_length: int = 128, ): device = device or components._execution_device dtype = components.text_encoder.dtype if not isinstance(prompt, list): prompt = [prompt] batch_size = len(prompt) prompt_embeds, prompt_attention_mask = _get_t5_prompt_embeds( components=components, prompt=prompt, max_sequence_length=max_sequence_length, device=device, dtype=dtype, ) negative_prompt_embeds = None negative_prompt_attention_mask = None if prepare_unconditional_embeds: negative_prompt = negative_prompt or "" negative_prompt = batch_size * [negative_prompt] if isinstance(negative_prompt, str) else negative_prompt if batch_size != len(negative_prompt): raise ValueError( f"`negative_prompt`: {negative_prompt} has batch size {len(negative_prompt)}, but `prompt`:" f" {prompt} has batch size {batch_size}. Please make sure that passed `negative_prompt` matches" " the batch size of `prompt`." ) negative_prompt_embeds, negative_prompt_attention_mask = _get_t5_prompt_embeds( components=components, prompt=negative_prompt, max_sequence_length=max_sequence_length, device=device, dtype=dtype, ) return prompt_embeds, prompt_attention_mask, negative_prompt_embeds, negative_prompt_attention_mask @torch.no_grad() def __call__(self, components: LTXModularPipeline, state: PipelineState) -> PipelineState: block_state = self.get_block_state(state) self.check_inputs(block_state) block_state.device = components._execution_device ( block_state.prompt_embeds, block_state.prompt_attention_mask, block_state.negative_prompt_embeds, block_state.negative_prompt_attention_mask, ) = self.encode_prompt( components=components, prompt=block_state.prompt, device=block_state.device, prepare_unconditional_embeds=components.requires_unconditional_embeds, negative_prompt=block_state.negative_prompt, max_sequence_length=block_state.max_sequence_length, ) self.set_block_state(state, block_state) return components, state # Copied from diffusers.pipelines.stable_diffusion.pipeline_stable_diffusion_img2img.retrieve_latents def retrieve_latents( encoder_output: torch.Tensor, generator: torch.Generator | None = None, sample_mode: str = "sample" ): if hasattr(encoder_output, "latent_dist") and sample_mode == "sample": return encoder_output.latent_dist.sample(generator) elif hasattr(encoder_output, "latent_dist") and sample_mode == "argmax": return encoder_output.latent_dist.mode() elif hasattr(encoder_output, "latents"): return encoder_output.latents else: raise AttributeError("Could not access latents of provided encoder_output") def _normalize_latents( latents: torch.Tensor, latents_mean: torch.Tensor, latents_std: torch.Tensor, scaling_factor: float = 1.0 ) -> torch.Tensor: # Normalize latents across the channel dimension [B, C, F, H, W] latents_mean = latents_mean.view(1, -1, 1, 1, 1).to(latents.device, latents.dtype) latents_std = latents_std.view(1, -1, 1, 1, 1).to(latents.device, latents.dtype) latents = (latents - latents_mean) * scaling_factor / latents_std return latents class LTXVaeEncoderStep(ModularPipelineBlocks): model_name = "ltx" @property def description(self) -> str: return "VAE Encoder step that encodes an input image into latent space for image-to-video generation" @property def expected_components(self) -> list[ComponentSpec]: return [ ComponentSpec("vae", AutoencoderKLLTXVideo), ComponentSpec( "video_processor", VideoProcessor, config=FrozenDict({"vae_scale_factor": 32}), default_creation_method="from_config", ), ] @property def inputs(self) -> list[InputParam]: return [ InputParam.template("image", required=True), InputParam.template("height", default=512), InputParam.template("width", default=704), InputParam.template("generator"), ] @property def intermediate_outputs(self) -> list[OutputParam]: return [ OutputParam( "image_latents", type_hint=torch.Tensor, description="Encoded image latents from the VAE encoder", ), ] @torch.no_grad() def __call__(self, components: LTXModularPipeline, state: PipelineState) -> PipelineState: block_state = self.get_block_state(state) device = components._execution_device image = block_state.image if not isinstance(image, torch.Tensor): image = components.video_processor.preprocess(image, height=block_state.height, width=block_state.width) image = image.to(device=device, dtype=torch.float32) vae_dtype = components.vae.dtype num_images = image.shape[0] if isinstance(block_state.generator, list): init_latents = [ retrieve_latents( components.vae.encode(image[i].unsqueeze(0).unsqueeze(2).to(vae_dtype)), block_state.generator[i], ) for i in range(num_images) ] else: init_latents = [ retrieve_latents( components.vae.encode(img.unsqueeze(0).unsqueeze(2).to(vae_dtype)), block_state.generator, ) for img in image ] init_latents = torch.cat(init_latents, dim=0).to(torch.float32) block_state.image_latents = _normalize_latents( init_latents, components.vae.latents_mean, components.vae.latents_std ) self.set_block_state(state, block_state) return components, state