obsws-cli/obsws_cli/sceneitem.py

"""module containing commands for manipulating items in scenes."""

from typing import Annotated, Optional

import obsws_python as obsws
import typer
from rich.console import Console
from rich.table import Table

from . import validate
from .alias import AliasGroup

app = typer.Typer(cls=AliasGroup)
out_console = Console()
err_console = Console(stderr=True, style='bold red')


@app.callback()
def main():
    """Control items in OBS scenes."""


@app.command('list | ls')
def list_(
    ctx: typer.Context,
    scene_name: Annotated[
        Optional[str],
        typer.Argument(
            show_default='The current scene',
            help='Scene name to list items for',
        ),
    ] = None,
):
    """List all items in a scene."""
    if not scene_name:
        scene_name = ctx.obj.get_current_program_scene().scene_name

    if not validate.scene_in_scenes(ctx, scene_name):
        err_console.print(f'Scene [yellow]{scene_name}[/yellow] not found.')
        raise typer.Exit(1)

    resp = ctx.obj.get_scene_item_list(scene_name)
    items = sorted(
        (
            (
                item.get('sceneItemId'),
                item.get('sourceName'),
                item.get('isGroup'),
                item.get('sceneItemEnabled'),
            )
            for item in resp.scene_items
        ),
        key=lambda x: x[0],  # Sort by sceneItemId
    )

    if not items:
        out_console.print(f'No items found in scene [green]{scene_name}[/green].')
        raise typer.Exit()

    table = Table(title=f'Items in Scene: {scene_name}', padding=(0, 2))
    columns = [
        ('Item ID', 'center', 'cyan'),
        ('Item Name', 'left', 'cyan'),
        ('In Group', 'left', 'cyan'),
        ('Enabled', 'center', None),
    ]
    # Add columns to the table
    for column, justify, style in columns:
        table.add_column(column, justify=justify, style=style)

    for item_id, item_name, is_group, is_enabled in items:
        if is_group:
            resp = ctx.obj.get_group_scene_item_list(item_name)
            group_items = sorted(
                (
                    (
                        gi.get('sceneItemId'),
                        gi.get('sourceName'),
                        gi.get('sceneItemEnabled'),
                    )
                    for gi in resp.scene_items
                ),
                key=lambda x: x[0],  # Sort by sceneItemId
            )
            for group_item_id, group_item_name, group_item_enabled in group_items:
                table.add_row(
                    str(group_item_id),
                    group_item_name,
                    item_name,
                    ':white_heavy_check_mark:'
                    if is_enabled and group_item_enabled
                    else ':x:',
                )
        else:
            table.add_row(
                str(item_id),
                item_name,
                '',
                ':white_heavy_check_mark:' if is_enabled else ':x:',
            )

    out_console.print(table)


def _validate_sources(
    ctx: typer.Context,
    scene_name: str,
    item_name: str,
    group: Optional[str] = None,
) -> bool:
    """Validate the scene name and item name."""
    if not validate.scene_in_scenes(ctx, scene_name):
        err_console.print(f'Scene [yellow]{scene_name}[/yellow] not found.')
        return False

    if group:
        if not validate.item_in_scene_item_list(ctx, scene_name, group):
            err_console.print(
                f'Group [yellow]{group}[/yellow] not found in scene [yellow]{scene_name}[/yellow].'
            )
            return False
    else:
        if not validate.item_in_scene_item_list(ctx, scene_name, item_name):
            err_console.print(
                f'Item [yellow]{item_name}[/yellow] not found in scene [yellow]{scene_name}[/yellow].'
            )
            return False

    return True


def _get_scene_name_and_item_id(
    ctx: typer.Context, scene_name: str, item_name: str, group: Optional[str] = None
):
    """Get the scene name and item ID for the given scene and item name."""
    if group:
        resp = ctx.obj.get_group_scene_item_list(group)
        for item in resp.scene_items:
            if item.get('sourceName') == item_name:
                scene_name = group
                scene_item_id = item.get('sceneItemId')
                break
        else:
            err_console.print(
                f'Item [yellow]{item_name}[/yellow] not found in group [yellow]{group}[/yellow].'
            )
            raise typer.Exit(1)
    else:
        try:
            resp = ctx.obj.get_scene_item_id(scene_name, item_name)
        except obsws.error.OBSSDKRequestError as e:
            if e.code == 600:
                err_console.print(
                    f'Item [yellow]{item_name}[/yellow] not found in scene [yellow]{scene_name}[/yellow]. Is the item in a group? '
                    'If so use the --group option to specify the parent group. '
                    'Use `obsws-cli sceneitem list` for a list of items in the scene.'
                )
                raise typer.Exit(1)
            else:
                raise
        scene_item_id = resp.scene_item_id

    return scene_name, scene_item_id


@app.command('show | sh')
def show(
    ctx: typer.Context,
    scene_name: Annotated[
        str, typer.Argument(..., show_default=False, help='Scene name the item is in')
    ],
    item_name: Annotated[
        str,
        typer.Argument(..., show_default=False, help='Item name to show in the scene'),
    ],
    group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
):
    """Show an item in a scene."""
    if not _validate_sources(ctx, scene_name, item_name, group):
        raise typer.Exit(1)

    old_scene_name = scene_name
    scene_name, scene_item_id = _get_scene_name_and_item_id(
        ctx, scene_name, item_name, group
    )

    ctx.obj.set_scene_item_enabled(
        scene_name=scene_name,
        item_id=int(scene_item_id),
        enabled=True,
    )

    if group:
        out_console.print(
            f'Item [green]{item_name}[/green] in group [green]{group}[/green] in scene [green]{old_scene_name}[/green] has been shown.'
        )
    else:
        # If not in a parent group, just show the scene name
        # This is to avoid confusion with the parent group name
        # which is not the same as the scene name
        # and is not needed in this case
        out_console.print(
            f'Item [green]{item_name}[/green] in scene [green]{scene_name}[/green] has been shown.'
        )


@app.command('hide | h')
def hide(
    ctx: typer.Context,
    scene_name: Annotated[
        str, typer.Argument(..., show_default=False, help='Scene name the item is in')
    ],
    item_name: Annotated[
        str,
        typer.Argument(..., show_default=False, help='Item name to hide in the scene'),
    ],
    group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
):
    """Hide an item in a scene."""
    if not _validate_sources(ctx, scene_name, item_name, group):
        raise typer.Exit(1)

    old_scene_name = scene_name
    scene_name, scene_item_id = _get_scene_name_and_item_id(
        ctx, scene_name, item_name, group
    )

    ctx.obj.set_scene_item_enabled(
        scene_name=scene_name,
        item_id=int(scene_item_id),
        enabled=False,
    )

    if group:
        out_console.print(
            f'Item [green]{item_name}[/green] in group [green]{group}[/green] in scene [green]{old_scene_name}[/green] has been hidden.'
        )
    else:
        # If not in a parent group, just show the scene name
        # This is to avoid confusion with the parent group name
        # which is not the same as the scene name
        # and is not needed in this case
        out_console.print(
            f'Item [green]{item_name}[/green] in scene [green]{scene_name}[/green] has been hidden.'
        )


@app.command('toggle | tg')
def toggle(
    ctx: typer.Context,
    scene_name: Annotated[
        str, typer.Argument(..., show_default=False, help='Scene name the item is in')
    ],
    item_name: Annotated[
        str,
        typer.Argument(
            ..., show_default=False, help='Item name to toggle in the scene'
        ),
    ],
    group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
):
    """Toggle an item in a scene."""
    if not _validate_sources(ctx, scene_name, item_name, group):
        raise typer.Exit(1)

    old_scene_name = scene_name
    scene_name, scene_item_id = _get_scene_name_and_item_id(
        ctx, scene_name, item_name, group
    )

    enabled = ctx.obj.get_scene_item_enabled(
        scene_name=scene_name,
        item_id=int(scene_item_id),
    )
    new_state = not enabled.scene_item_enabled

    ctx.obj.set_scene_item_enabled(
        scene_name=scene_name,
        item_id=int(scene_item_id),
        enabled=new_state,
    )

    if group:
        if new_state:
            out_console.print(
                f'Item [green]{item_name}[/green] in group [green]{group}[/green] in scene [green]{old_scene_name}[/green] has been shown.'
            )
        else:
            out_console.print(
                f'Item [green]{item_name}[/green] in group [green]{group}[/green] in scene [green]{old_scene_name}[/green] has been hidden.'
            )
    else:
        # If not in a parent group, just show the scene name
        # This is to avoid confusion with the parent group name
        # which is not the same as the scene name
        # and is not needed in this case
        if new_state:
            out_console.print(
                f'Item [green]{item_name}[/green] in scene [green]{scene_name}[/green] has been shown.'
            )
        else:
            out_console.print(
                f'Item [green]{item_name}[/green] in scene [green]{scene_name}[/green] has been hidden.'
            )


@app.command('visible | v')
def visible(
    ctx: typer.Context,
    scene_name: Annotated[
        str, typer.Argument(..., show_default=False, help='Scene name the item is in')
    ],
    item_name: Annotated[
        str,
        typer.Argument(
            ..., show_default=False, help='Item name to check visibility in the scene'
        ),
    ],
    group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
):
    """Check if an item in a scene is visible."""
    if not _validate_sources(ctx, scene_name, item_name, group):
        raise typer.Exit(1)

    old_scene_name = scene_name
    scene_name, scene_item_id = _get_scene_name_and_item_id(
        ctx, scene_name, item_name, group
    )

    enabled = ctx.obj.get_scene_item_enabled(
        scene_name=scene_name,
        item_id=int(scene_item_id),
    )

    if group:
        out_console.print(
            f'Item [green]{item_name}[/green] in group [green]{group}[/green] in scene [green]{old_scene_name}[/green] is currently {"visible" if enabled.scene_item_enabled else "hidden"}.'
        )
    else:
        # If not in a parent group, just show the scene name
        # This is to avoid confusion with the parent group name
        # which is not the same as the scene name
        # and is not needed in this case
        out_console.print(
            f'Item [green]{item_name}[/green] in scene [green]{scene_name}[/green] is currently {"visible" if enabled.scene_item_enabled else "hidden"}.'
        )


@app.command('transform | t')
def transform(
    ctx: typer.Context,
    scene_name: Annotated[
        str, typer.Argument(..., show_default=False, help='Scene name the item is in')
    ],
    item_name: Annotated[
        str,
        typer.Argument(
            ..., show_default=False, help='Item name to transform in the scene'
        ),
    ],
    group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
    alignment: Annotated[
        Optional[int], typer.Option(help='Alignment of the item in the scene')
    ] = None,
    bounds_alignment: Annotated[
        Optional[int], typer.Option(help='Bounds alignment of the item in the scene')
    ] = None,
    bounds_height: Annotated[
        Optional[float], typer.Option(help='Height of the item in the scene')
    ] = None,
    bounds_type: Annotated[
        Optional[str], typer.Option(help='Type of bounds for the item in the scene')
    ] = None,
    bounds_width: Annotated[
        Optional[float], typer.Option(help='Width of the item in the scene')
    ] = None,
    crop_to_bounds: Annotated[
        Optional[bool], typer.Option(help='Crop the item to the bounds')
    ] = None,
    crop_bottom: Annotated[
        Optional[float], typer.Option(help='Bottom crop of the item in the scene')
    ] = None,
    crop_left: Annotated[
        Optional[float], typer.Option(help='Left crop of the item in the scene')
    ] = None,
    crop_right: Annotated[
        Optional[float], typer.Option(help='Right crop of the item in the scene')
    ] = None,
    crop_top: Annotated[
        Optional[float], typer.Option(help='Top crop of the item in the scene')
    ] = None,
    position_x: Annotated[
        Optional[float], typer.Option(help='X position of the item in the scene')
    ] = None,
    position_y: Annotated[
        Optional[float], typer.Option(help='Y position of the item in the scene')
    ] = None,
    rotation: Annotated[
        Optional[float], typer.Option(help='Rotation of the item in the scene')
    ] = None,
    scale_x: Annotated[
        Optional[float], typer.Option(help='X scale of the item in the scene')
    ] = None,
    scale_y: Annotated[
        Optional[float], typer.Option(help='Y scale of the item in the scene')
    ] = None,
):
    """Set the transform of an item in a scene."""
    if not _validate_sources(ctx, scene_name, item_name, group):
        raise typer.Exit(1)

    old_scene_name = scene_name
    scene_name, scene_item_id = _get_scene_name_and_item_id(
        ctx, scene_name, item_name, group
    )

    transform = {}
    if alignment is not None:
        transform['alignment'] = alignment
    if bounds_alignment is not None:
        transform['boundsAlignment'] = bounds_alignment
    if bounds_height is not None:
        transform['boundsHeight'] = bounds_height
    if bounds_type is not None:
        transform['boundsType'] = bounds_type
    if bounds_width is not None:
        transform['boundsWidth'] = bounds_width
    if crop_to_bounds is not None:
        transform['cropToBounds'] = crop_to_bounds
    if crop_bottom is not None:
        transform['cropBottom'] = crop_bottom
    if crop_left is not None:
        transform['cropLeft'] = crop_left
    if crop_right is not None:
        transform['cropRight'] = crop_right
    if crop_top is not None:
        transform['cropTop'] = crop_top
    if position_x is not None:
        transform['positionX'] = position_x
    if position_y is not None:
        transform['positionY'] = position_y
    if rotation is not None:
        transform['rotation'] = rotation
    if scale_x is not None:
        transform['scaleX'] = scale_x
    if scale_y is not None:
        transform['scaleY'] = scale_y

    if not transform:
        err_console.print('No transform options provided.')
        raise typer.Exit(1)

    transform = ctx.obj.set_scene_item_transform(
        scene_name=scene_name,
        item_id=int(scene_item_id),
        transform=transform,
    )

    if group:
        out_console.print(
            f'Item [green]{item_name}[/green] in group [green]{group}[/green] in scene [green]{old_scene_name}[/green] has been transformed.'
        )
    else:
        # If not in a parent group, just show the scene name
        # This is to avoid confusion with the parent group name
        # which is not the same as the scene name
        # and is not needed in this case
        out_console.print(
            f'Item [green]{item_name}[/green] in scene [green]{scene_name}[/green] has been transformed.'
        )