From 5b1a5a9bf87f39f15c1621d76a1b31a5e1be6317 Mon Sep 17 00:00:00 2001 From: Lleu Yang Date: Mon, 19 Aug 2024 19:40:34 +0800 Subject: [PATCH] Geometry Nodes: new Sound category This commit adds a new "Sound" category under "Geometry Nodes" section. It also contains three new entries: Sample Sound Node, Sound Info Node and Sound Node. --- ...ng_geometry-nodes_sample_sound-example.png | 3 + .../node-types_GeometryNodeInputSound.webp | 3 + .../node-types_GeometryNodeSampleSound.webp | 3 + .../node-types_GeometryNodeSoundInfo.webp | 3 + manual/modeling/geometry_nodes/index.rst | 8 +++ .../geometry_nodes/input/constant/index.rst | 1 + .../geometry_nodes/input/constant/sound.rst | 38 +++++++++++++ .../modeling/geometry_nodes/sound/index.rst | 10 ++++ .../geometry_nodes/sound/sample_sound.rst | 57 +++++++++++++++++++ .../geometry_nodes/sound/sound_info.rst | 36 ++++++++++++ 10 files changed, 162 insertions(+) create mode 100644 manual/images/modeling_geometry-nodes_sample_sound-example.png create mode 100644 manual/images/node-types_GeometryNodeInputSound.webp create mode 100644 manual/images/node-types_GeometryNodeSampleSound.webp create mode 100644 manual/images/node-types_GeometryNodeSoundInfo.webp create mode 100644 manual/modeling/geometry_nodes/input/constant/sound.rst create mode 100644 manual/modeling/geometry_nodes/sound/index.rst create mode 100644 manual/modeling/geometry_nodes/sound/sample_sound.rst create mode 100644 manual/modeling/geometry_nodes/sound/sound_info.rst diff --git a/manual/images/modeling_geometry-nodes_sample_sound-example.png b/manual/images/modeling_geometry-nodes_sample_sound-example.png new file mode 100644 index 000000000..09efddec2 --- /dev/null +++ b/manual/images/modeling_geometry-nodes_sample_sound-example.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3b165807e7aac9d575c2ea6361f7e8acd366c7e60465dc059e8d1c2991b62e08 +size 97576 diff --git a/manual/images/node-types_GeometryNodeInputSound.webp b/manual/images/node-types_GeometryNodeInputSound.webp new file mode 100644 index 000000000..feba259a5 --- /dev/null +++ b/manual/images/node-types_GeometryNodeInputSound.webp @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:13cd52331f438062df9fc7eb6dce2db060a543183aad0fb2b256ede4007ad624 +size 8166 diff --git a/manual/images/node-types_GeometryNodeSampleSound.webp b/manual/images/node-types_GeometryNodeSampleSound.webp new file mode 100644 index 000000000..feba259a5 --- /dev/null +++ b/manual/images/node-types_GeometryNodeSampleSound.webp @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:13cd52331f438062df9fc7eb6dce2db060a543183aad0fb2b256ede4007ad624 +size 8166 diff --git a/manual/images/node-types_GeometryNodeSoundInfo.webp b/manual/images/node-types_GeometryNodeSoundInfo.webp new file mode 100644 index 000000000..87088b90a --- /dev/null +++ b/manual/images/node-types_GeometryNodeSoundInfo.webp @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ba7237f3b7e6dc13978126021544424a4b0696a3447741a0c7e60da9999c5b35 +size 4610 diff --git a/manual/modeling/geometry_nodes/index.rst b/manual/modeling/geometry_nodes/index.rst index fb3c9a4f8..ed23e4f2d 100644 --- a/manual/modeling/geometry_nodes/index.rst +++ b/manual/modeling/geometry_nodes/index.rst @@ -60,6 +60,14 @@ Node Types ----- +.. toctree:: + :maxdepth: 3 + :titlesonly: + + sound/index.rst + +----- + .. toctree:: :maxdepth: 3 :titlesonly: diff --git a/manual/modeling/geometry_nodes/input/constant/index.rst b/manual/modeling/geometry_nodes/input/constant/index.rst index 11ee4dae9..17316c855 100644 --- a/manual/modeling/geometry_nodes/input/constant/index.rst +++ b/manual/modeling/geometry_nodes/input/constant/index.rst @@ -14,6 +14,7 @@ Nodes used mainly as input to other nodes. integer.rst material.rst rotation.rst + sound.rst string.rst value.rst vector.rst diff --git a/manual/modeling/geometry_nodes/input/constant/sound.rst b/manual/modeling/geometry_nodes/input/constant/sound.rst new file mode 100644 index 000000000..6c75c10d5 --- /dev/null +++ b/manual/modeling/geometry_nodes/input/constant/sound.rst @@ -0,0 +1,38 @@ +.. index:: Geometry Nodes; Sound +.. _bpy.types.GeometryNodeInputSound: + +********** +Sound Node +********** + +.. figure:: /images/node-types_GeometryNodeInputSound.webp + :align: right + :width: 300px + + Sound node. + +The *Sound* node provides access to a sound file. + +.. seealso:: + + :doc:`/modeling/geometry_nodes/sound/sound_info` + + +Inputs +====== + +This node has no inputs. + + +Properties +========== + +Sound Data-Block + The :ref:`data-block selector ` to select an existing sound or open a sound from the file browser. + + +Outputs +======= + +Sound + The sound file chosen from the data-block selector. diff --git a/manual/modeling/geometry_nodes/sound/index.rst b/manual/modeling/geometry_nodes/sound/index.rst new file mode 100644 index 000000000..3e93c59e9 --- /dev/null +++ b/manual/modeling/geometry_nodes/sound/index.rst @@ -0,0 +1,10 @@ + +############### + Sound Nodes +############### + +.. toctree:: + :maxdepth: 1 + + sample_sound.rst + sound_info.rst diff --git a/manual/modeling/geometry_nodes/sound/sample_sound.rst b/manual/modeling/geometry_nodes/sound/sample_sound.rst new file mode 100644 index 000000000..c26de4ea9 --- /dev/null +++ b/manual/modeling/geometry_nodes/sound/sample_sound.rst @@ -0,0 +1,57 @@ +.. index:: Geometry Nodes; Sample Sound +.. _bpy.types.GeometryNodeSampleSound: + +***************** +Sample Sound Node +***************** + +.. figure:: /images/node-types_GeometryNodeSampleSound.webp + :align: center + :alt: Sample Sound node. + +The *Sample Sound* node retrieves amplitude from a sound at a specific time. + +Inputs +====== + +Sound + The sound to retrieve the amplitude from. + +Time + Sample time of the sound. + +Downmix to Mono + Downmix multiple audio channels into a single one (overrides the value of the Channel input). + +Channel + Which channel to be sampled from the input *Sound*. + +Low + The lower bound of frequency to be sampled. + +High + The upper bound of frequency to be sampled. + +Properties +========== + +Window + Type of window function to apply. + +FFT Size + FFT size to use when sampling sound. Larger value means more frequency details and less + temporal details, while smaller value does the opposite. + +Outputs +======= + +Amplitude + The amplitude computed from the source *Sound* input. + +Examples +======== + +.. figure:: /images/modeling_geometry-nodes_sample_sound-example.png + :align: center + + Here the node is used to visualize part of the spectrum of a sound. diff --git a/manual/modeling/geometry_nodes/sound/sound_info.rst b/manual/modeling/geometry_nodes/sound/sound_info.rst new file mode 100644 index 000000000..fe009a58d --- /dev/null +++ b/manual/modeling/geometry_nodes/sound/sound_info.rst @@ -0,0 +1,36 @@ +.. index:: Geometry Nodes; Sound Info +.. _bpy.types.GeometryNodeSoundInfo: + +*************** +Sound Info Node +*************** + +.. figure:: /images/node-types_GeometryNodeSoundInfo.webp + :align: right + :alt: Sound Info node. + :width: 300px + + +The *Sound Info* node gets information from sound. +This can be useful to generate parameters in the geometry node for arbitrary sounds. + +Inputs +====== + +Sound + Source sound to get parameters from. + +Properties +========== + +This node has no properties. + + +Outputs +======= + +Audio Channels + Total channel amount of the sound. + +Sample Rate + Sample rate (in Hz) of the sound. -- 2.30.2