Set default format in gr.Audio to be None to avoid unnecessary preprocessing

.changeset/nasty-zebras-cheat.md

@@ -0,0 +1,5 @@
+---
+"gradio": minor
+---
+
+feat:Set default `format` in `gr.Audio` to be `None` to avoid unnecessary preprocessing

gradio/components/audio.py

@@ -100,7 +100,7 @@ def __init__(
         elem_classes: list[str] | str | None = None,
         render: bool = True,
         key: int | str | None = None,
-        format: Literal["wav", "mp3"] = "wav",
+        format: Literal["wav", "mp3"] | None = None,
         autoplay: bool = False,
         show_download_button: bool | None = None,
         show_share_button: bool | None = None,
@@ -127,9 +127,9 @@ def __init__(
             streaming: If set to True when used in a `live` interface as an input, will automatically stream webcam feed. When used set as an output, takes audio chunks yield from the backend and combines them into one streaming audio output.
             elem_id: An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.
             elem_classes: An optional list of strings that are assigned as the classes of this component in the HTML DOM. Can be used for targeting CSS styles.
-            render: If False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later.
+            render: if False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later.
             key: if assigned, will be used to assume identity across a re-render. Components that have the same key across a re-render will have their value preserved.
-            format: The file format to save audio files. Either 'wav' or 'mp3'. wav files are lossless but will tend to be larger files. mp3 files tend to be smaller. Default is wav. Applies both when this component is used as an input (when `type` is "format") and when this component is used as an output.
+            format: the file extension with which to save audio files. Either 'wav' or 'mp3'. wav files are lossless but will tend to be larger files. mp3 files tend to be smaller. This parameter applies both when this component is used as an input (and `type` is "filepath") to determine which file format to convert user-provided audio to, and when this component is used as an output to determine the format of audio returned to the user. If None, no file format conversion is done and the audio is kept as is. In the case where output audio is returned from the prediction function as numpy array and no `format` is provided, it will be returned as a "wav" file.
             autoplay: Whether to automatically play the audio when the component is used as an output. Note: browsers will not autoplay audio files if the user has not interacted with the page yet.
             show_download_button: If True, will show a download button in the corner of the component for saving audio. If False, icon does not appear. By default, it will be True for output components and False for input components.
             show_share_button: If True, will show a share icon in the corner of the component that allows user to share outputs to Hugging Face Spaces Discussions. If False, icon does not appear. If set to None (default behavior), then the icon appears if this Gradio app is launched on Spaces, but not otherwise.
@@ -158,15 +158,20 @@ def __init__(
         valid_types = ["numpy", "filepath"]
         if type not in valid_types:
             raise ValueError(
-                f"Invalid value for parameter `type`: {type}. Please choose from one of: {valid_types}"
+                f"Invalid value for parameter `type`: {type}. Please choose from one of: {' '.join(valid_types)}"
             )
         self.type = type
         self.streaming = streaming
         if self.streaming and "microphone" not in self.sources:
             raise ValueError(
                 "Audio streaming only available if sources includes 'microphone'."
             )
-        self.format = format
+        valid_formats = ["wav", "mp3"]
+        if format is not None and format.lower() not in valid_formats:
+            raise ValueError(
+                f"Invalid value for parameter `format`: {format}. Please choose from one of: {' '.join(valid_formats)}"
+            )
+        self.format = format and format.lower()
         self.autoplay = autoplay
         self.loop = loop
         self.show_download_button = show_download_button
@@ -224,16 +229,23 @@ def preprocess(
         if not payload.path:
             raise ValueError("payload path missing")
 
-        # Need a unique name for the file to avoid re-using the same audio file if
-        # a user submits the same audio file twice
-        temp_file_path = Path(payload.path)
-        output_file_name = str(
-            temp_file_path.with_name(f"{temp_file_path.stem}{temp_file_path.suffix}")
-        )
+        needs_conversion = False
+        original_suffix = Path(payload.path).suffix.lower()
+        if self.format is not None and original_suffix != f".{self.format}":
+            needs_conversion = True
 
-        sample_rate, data = processing_utils.audio_from_file(temp_file_path)
+        # To avoid possibly-unbound errors
+        duration, sample_rate, data = 0, 0, np.array([])
+        # Only extract audio data if necessary
+        if (
+            self.min_length is not None
+            or self.max_length is not None
+            or self.type == "numpy"
+            or needs_conversion
+        ):
+            sample_rate, data = processing_utils.audio_from_file(payload.path)
+            duration = len(data) / sample_rate
 
-        duration = len(data) / sample_rate
         if self.min_length is not None and duration < self.min_length:
             raise Error(
                 f"Audio is too short, and must be at least {self.min_length} seconds"
@@ -246,7 +258,10 @@ def preprocess(
         if self.type == "numpy":
             return sample_rate, data
         elif self.type == "filepath":
-            output_file = str(Path(output_file_name).with_suffix(f".{self.format}"))
+            if not needs_conversion:
+                return payload.path
+            output_file = str(Path(payload.path).with_suffix(f".{self.format}"))
+            assert self.format is not None  # noqa: S101
             processing_utils.audio_to_file(
                 sample_rate, data, output_file, format=self.format
             )
@@ -270,6 +285,7 @@ def postprocess(
         orig_name = None
         if value is None:
             return None
+
         if isinstance(value, bytes):
             if self.streaming:
                 return value
@@ -280,14 +296,24 @@ def postprocess(
         elif isinstance(value, tuple):
             sample_rate, data = value
             file_path = processing_utils.save_audio_to_cache(
-                data, sample_rate, format=self.format, cache_dir=self.GRADIO_CACHE
+                data,
+                sample_rate,
+                format=self.format or "wav",
+                cache_dir=self.GRADIO_CACHE,
             )
             orig_name = Path(file_path).name
-        else:
-            if not isinstance(value, (str, Path)):
-                raise ValueError(f"Cannot process {value} as Audio")
-            file_path = str(value)
+        elif isinstance(value, (str, Path)):
+            original_suffix = Path(value).suffix.lower()
+            if self.format is not None and original_suffix != f".{self.format}":
+                sample_rate, data = processing_utils.audio_from_file(str(value))
+                file_path = processing_utils.save_audio_to_cache(
+                    data, sample_rate, format=self.format, cache_dir=self.GRADIO_CACHE
+                )
+            else:
+                file_path = str(value)
             orig_name = Path(file_path).name if Path(file_path).exists() else None
+        else:
+            raise ValueError(f"Cannot process {value} as Audio")
         return FileData(path=file_path, orig_name=orig_name)
 
     @staticmethod

gradio/components/video.py

@@ -99,41 +99,41 @@ def __init__(
     ):
         """
         Parameters:
-            value: A path or URL for the default value that Video component is going to take. Can also be a tuple consisting of (video filepath, subtitle filepath). If a subtitle file is provided, it should be of type .srt or .vtt. Or can be callable, in which case the function will be called whenever the app loads to set the initial value of the component.
-            format: Format of video format to be returned by component, such as 'avi' or 'mp4'. Use 'mp4' to ensure browser playability. If set to None, video will keep uploaded format.
-            sources: A list of sources permitted for video. "upload" creates a box where user can drop a video file, "webcam" allows user to record a video from their webcam. If None, defaults to ["upload, "webcam"].
-            height: The height of the displayed video, specified in pixels if a number is passed, or in CSS units if a string is passed.
-            width: The width of the displayed video, specified in pixels if a number is passed, or in CSS units if a string is passed.
-            label: The label for this component. Appears above the component and is also used as the header if there are a table of examples for this component. If None and used in a `gr.Interface`, the label will be the name of the parameter this component is assigned to.
-            every: Continously calls `value` to recalculate it if `value` is a function (has no effect otherwise). Can provide a Timer whose tick resets `value`, or a float that provides the regular interval for the reset Timer.
-            inputs: Components that are used as inputs to calculate `value` if `value` is a function (has no effect otherwise). `value` is recalculated any time the inputs change.
+            value: path or URL for the default value that Video component is going to take. Can also be a tuple consisting of (video filepath, subtitle filepath). If a subtitle file is provided, it should be of type .srt or .vtt. Or can be callable, in which case the function will be called whenever the app loads to set the initial value of the component.
+            format: the file extension with which to save video, such as 'avi' or 'mp4'. This parameter applies both when this component is used as an input to determine which file format to convert user-provided video to, and when this component is used as an output to determine the format of video returned to the user. If None, no file format conversion is done and the video is kept as is. Use 'mp4' to ensure browser playability.
+            sources: list of sources permitted for video. "upload" creates a box where user can drop a video file, "webcam" allows user to record a video from their webcam. If None, defaults to both ["upload, "webcam"].
+            height: height of the displayed video, specified in pixels if a number is passed, or in CSS units if a string is passed.
+            width: width of the displayed video, specified in pixels if a number is passed, or in CSS units if a string is passed.
+            label: the label for this component. Appears above the component and is also used as the header if there are a table of examples for this component. If None and used in a `gr.Interface`, the label will be the name of the parameter this component is assigned to.
+            every: continously calls `value` to recalculate it if `value` is a function (has no effect otherwise). Can provide a Timer whose tick resets `value`, or a float that provides the regular interval for the reset Timer.
+            inputs: components that are used as inputs to calculate `value` if `value` is a function (has no effect otherwise). `value` is recalculated any time the inputs change.
             show_label: if True, will display label.
-            container: If True, will place the component in a container - providing some extra padding around the border.
+            container: if True, will place the component in a container - providing some extra padding around the border.
             scale: relative size compared to adjacent Components. For example if Components A and B are in a Row, and A has scale=2, and B has scale=1, A will be twice as wide as B. Should be an integer. scale applies in Rows, and to top-level Components in Blocks where fill_height=True.
             min_width: minimum pixel width, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in this Component being narrower than min_width, the min_width parameter will be respected first.
             interactive: if True, will allow users to upload a video; if False, can only be used to display videos. If not provided, this is inferred based on whether the component is used as an input or output.
-            visible: If False, component will be hidden.
-            elem_id: An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.
-            elem_classes: An optional list of strings that are assigned as the classes of this component in the HTML DOM. Can be used for targeting CSS styles.
-            render: If False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later.
+            visible: if False, component will be hidden.
+            elem_id: an optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.
+            elem_classes: an optional list of strings that are assigned as the classes of this component in the HTML DOM. Can be used for targeting CSS styles.
+            render: if False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later.
             key: if assigned, will be used to assume identity across a re-render. Components that have the same key across a re-render will have their value preserved.
-            mirror_webcam: If True webcam will be mirrored. Default is True.
-            include_audio: Whether the component should record/retain the audio track for a video. By default, audio is excluded for webcam videos and included for uploaded videos.
-            autoplay: Whether to automatically play the video when the component is used as an output. Note: browsers will not autoplay video files if the user has not interacted with the page yet.
-            show_share_button: If True, will show a share icon in the corner of the component that allows user to share outputs to Hugging Face Spaces Discussions. If False, icon does not appear. If set to None (default behavior), then the icon appears if this Gradio app is launched on Spaces, but not otherwise.
-            show_download_button: If True, will show a download icon in the corner of the component that allows user to download the output. If False, icon does not appear. By default, it will be True for output components and False for input components.
-            min_length: The minimum length of video (in seconds) that the user can pass into the prediction function. If None, there is no minimum length.
-            max_length: The maximum length of video (in seconds) that the user can pass into the prediction function. If None, there is no maximum length.
-            loop: If True, the video will loop when it reaches the end and continue playing from the beginning.
-            streaming: When used set as an output, takes video chunks yielded from the backend and combines them into one streaming video output. Each chunk should be a video file with a .ts extension using an h.264 encoding. Mp4 files are also accepted but they will be converted to h.264 encoding.
-            watermark: An image file to be included as a watermark on the video. The image is not scaled and is displayed on the bottom right of the video. Valid formats for the image are: jpeg, png.
+            mirror_webcam: if True webcam will be mirrored. Default is True.
+            include_audio: whether the component should record/retain the audio track for a video. By default, audio is excluded for webcam videos and included for uploaded videos.
+            autoplay: whether to automatically play the video when the component is used as an output. Note: browsers will not autoplay video files if the user has not interacted with the page yet.
+            show_share_button: if True, will show a share icon in the corner of the component that allows user to share outputs to Hugging Face Spaces Discussions. If False, icon does not appear. If set to None (default behavior), then the icon appears if this Gradio app is launched on Spaces, but not otherwise.
+            show_download_button: if True, will show a download icon in the corner of the component that allows user to download the output. If False, icon does not appear. By default, it will be True for output components and False for input components.
+            min_length: the minimum length of video (in seconds) that the user can pass into the prediction function. If None, there is no minimum length.
+            max_length: the maximum length of video (in seconds) that the user can pass into the prediction function. If None, there is no maximum length.
+            loop: if True, the video will loop when it reaches the end and continue playing from the beginning.
+            streaming: when used set as an output, takes video chunks yielded from the backend and combines them into one streaming video output. Each chunk should be a video file with a .ts extension using an h.264 encoding. Mp4 files are also accepted but they will be converted to h.264 encoding.
+            watermark: an image file to be included as a watermark on the video. The image is not scaled and is displayed on the bottom right of the video. Valid formats for the image are: jpeg, png.
         """
         valid_sources: list[Literal["upload", "webcam"]] = ["upload", "webcam"]
         if sources is None:
             self.sources = valid_sources
         elif isinstance(sources, str) and sources in valid_sources:
             self.sources = [sources]
-        elif isinstance(sources, list):
+        elif isinstance(sources, list) and all(s in valid_sources for s in sources):
             self.sources = sources
         else:
             raise ValueError(

gradio/processing_utils.py

@@ -577,7 +577,7 @@ def resize_and_crop(img, size, crop_type="center"):
 ##################
 
 
-def audio_from_file(filename, crop_min=0, crop_max=100):
+def audio_from_file(filename: str, crop_min: float = 0, crop_max: float = 100):
     try:
         audio = AudioSegment.from_file(filename)
     except FileNotFoundError as e: