65 lines
2.2 KiB
Python
65 lines
2.2 KiB
Python
# Copyright (C) 2025 AIDC-AI
|
|
#
|
|
# 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.
|
|
|
|
"""
|
|
Progress event models for video generation
|
|
|
|
Provides structured progress events for UI layer to consume and translate.
|
|
"""
|
|
|
|
from dataclasses import dataclass
|
|
from typing import Optional
|
|
|
|
|
|
@dataclass
|
|
class ProgressEvent:
|
|
"""
|
|
Structured progress event for video generation
|
|
|
|
Attributes:
|
|
event_type: Type of event (e.g., "generating_narrations", "frame_step", "concatenating")
|
|
progress: Progress value from 0.0 to 1.0
|
|
frame_current: Current frame number (1-based, optional)
|
|
frame_total: Total number of frames (optional)
|
|
step: Current step within frame (1-4, optional)
|
|
action: Action being performed (e.g., "audio", "image", "compose", "video", optional)
|
|
|
|
Examples:
|
|
# Simple progress event
|
|
ProgressEvent(event_type="generating_narrations", progress=0.05)
|
|
|
|
# Frame step event
|
|
ProgressEvent(
|
|
event_type="frame_step",
|
|
progress=0.23,
|
|
frame_current=1,
|
|
frame_total=5,
|
|
step=1,
|
|
action="audio"
|
|
)
|
|
"""
|
|
event_type: str
|
|
progress: float
|
|
|
|
# Optional frame-related fields
|
|
frame_current: Optional[int] = None
|
|
frame_total: Optional[int] = None
|
|
step: Optional[int] = None # 1-4 for frame processing steps
|
|
action: Optional[str] = None # "audio", "image", "compose", "video"
|
|
extra_info: Optional[str] = None # Additional information (e.g., batch progress)
|
|
|
|
def __post_init__(self):
|
|
"""Validate progress value"""
|
|
if not 0.0 <= self.progress <= 1.0:
|
|
raise ValueError(f"Progress must be between 0.0 and 1.0, got {self.progress}")
|
|
|