Потоковая загрузка звука

Хотя по умолчанию звуковые данные загружаются целиком, в некоторых случаях может быть полезно загружать их частями перед использованием. Это обычно называют “потоковой загрузкой” (streaming).

Одно из преимуществ потоковой загрузки звука состоит в том, что во время выполнения требуется меньше памяти. Другое преимущество в том, что если вы загружаете контент, например, по HTTP URL, то можете обновлять его в любое время, а также избежать первоначальной полной загрузки.

Пример

Есть пример проекта, демонстрирующий такую настройку: https://github.com/defold/example-sound-streaming

Как включить потоковую загрузку звука

Простой способ

Самый простой способ использовать потоковую загрузку звука - включить параметр sound.stream_enabled в game.project. Когда эта опция включена, движок начнет загружать звуки потоково.

Примечание: если у вас одновременно загружено много звуковых файлов, возможно, потребуется увеличить значение sound.stream_cache_size (см. ниже).

Ресурсы времени выполнения

Также можно создать новый ресурс звуковых данных и назначить его звуковому компоненту.

Для этого нужно:

• Загрузить начальную часть данных звукового файла
  • Примечание: это исходный звуковой файл, включая заголовок ogg/wav
• Создать новый ресурс звуковых данных, вызвав resource.create_sound_data().
• Назначить новый ресурс звуковых данных звуковому компоненту с помощью go.set()

Ниже приведен фрагмент из примерного проекта, использующий http.request() для получения начального звукового файла.

local function play_sound(self, hash)
    go.set(self.component, "sound", hash) -- override the resource data on the component
    sound.play(self.component)            -- start playing the sound
end

local function parse_range(s)
    local _, _, rstart, rend, size = string.find(s, "(%d+)-(%d+)/(%d+)") -- "bytes 0-16383/103277"
    return rstart, rend, size
end

-- Callback for the http response.
local function http_result(self, _id, response, extra)
    if response.status == 200 or response.status == 206 then
        -- Successful request
        local relative_path = self.filename
        local range = response.headers['content-range'] -- content-range = "bytes 0-16383/103277"
        local rstart, rend, filesize = parse_range(range)
        -- Create the Defold resource
        --   "partial" will enable the streaming mode
        print("Creating resource", relative_path)
        local hash = resource.create_sound_data(relative_path, { data = response.response, filesize = filesize, partial = true })
        -- send "play_sound" to the component
        play_sound(self, hash)
    end
end

local function load_web_sound(base_url, relative_path)
    local url = base_url .. "/" .. relative_path
    local headers = {}
    headers['Range'] = string.format("bytes=%d-%d", 0, 16384-1)

    http.request(url, "GET", http_result, headers, nil, { ignore_cache = true })
end

Провайдеры ресурсов

Можно использовать и другие способы загрузки начального фрагмента звукового файла. Важно помнить, что остальные фрагменты загружаются через систему ресурсов и ее провайдеров ресурсов. В этом примере мы добавляем нового (HTTP) файлового провайдера, добавляя mount live update с помощью вызова liveupdate.add_mount().

Рабочий пример можно найти здесь: https://github.com/defold/example-sound-streaming.

-- See http_result() from above example

local function load_web_sound(base_url, relative_path)
    local url = base_url .. "/" .. relative_path
    local headers = {}
    -- Request the initial part of the file
    headers['Range'] = string.format("bytes=%d-%d", 0, 16384-1)

    http.request(url, "GET", http_result, headers, nil, { ignore_cache = true })
end

function init(self)
    self.base_url = "http://my.server.com"
    self.filename = "/path/to/sound.ogg"

    liveupdate.add_mount("webmount", self.base_url, 100, function ()
                    -- once the mount is ready, we can start our request for downloading the first chunk
                    load_web_sound(self.base_url, self.filename)
                end)
end

function final(self)
    liveupdate.remove_mount("webmount")
end

Кэш звуковых фрагментов

Объем памяти, потребляемой звуками во время выполнения, управляется параметром sound.stream_cache_size в game.project. При заданном лимите объем загруженных звуковых данных никогда не превысит это значение.

Начальный фрагмент каждого звукового файла не может быть вытеснен из кэша и будет занимать место в кэше до тех пор, пока ресурс загружен. Размер начального фрагмента задается параметром sound.stream_preload_size в game.project.

Также можно управлять размером каждого звукового фрагмента, изменяя параметр sound.stream_chunk_size в game.project. Это может помочь еще сильнее уменьшить размер кэша звука, если у вас одновременно загружено много звуковых файлов. Звуковые файлы, размер которых меньше размера звукового фрагмента, не загружаются потоково, а если новый фрагмент не помещается в кэш, вытесняется самый старый фрагмент.