接入必读

请先查看接入必读了解具体接入方式，再参考此文档完成接入。

功能介绍

MIDI 为用户提供音乐转谱提取能力，将输入的音频进行分析提取、导出MIDI格式音乐，包含音乐的音符、力度、时长等信息。

• 输入：一段音乐音频
• 输出：MIDI格式音乐

接口说明

• 当前支持通过 HTTP 协议在线调用。
• 请求包括：
  • payload字段为将请求参数序列化后的json文本
  • data字段为将音频二进制文件按照base64格式编码（标准base64，RFC 4648）的文本
• 使用备注：

公共参数

参考详细说明功能调用-通用协议

配置参数

payload配置参数为json字符串格式

响应格式

HTTP响应Content-Type: application/json

• 响应结果格式由入参extra.midi决定：

  • 当extra.midi=true，MIDI检测结果在data字段，为MIDI格式的二进制数据，标准base64编码
  • 当extra.midi=false，MIDI检测结果在payload字段中，payload为json字符串格式，json内容格式如下：

  按照时间先后顺序列出了所有的人声MIDI时间段，其中pitch为对应时间段的人声音高，velocity为人声的力度（音量）

  字段	描述	类型
  midiList	包含人声MIDI数据的数组	array
  midiList.start	开始时间戳，单位秒	number
  midiList.end	结束时间戳，单位秒	number
  midiList.pitch	音高	number
  midiList.velocity	力度（音量）	number
  track	扩展参数，"vocal"代表人声	string
  confidence	扩展参数，代表置信度	float

  示例：

  {
    "midiList": [
      {
        "start": 1.4164172,
        "end": 1.7531066,
        "pitch": 54.787903,
        "velocity": 100
      },
      {
        "start": 1.9156463,
        "end": 2.078186,
        "pitch": 53.074356,
        "velocity": 100
      },
      ...
      {
        "start": 16.323627,
        "end": 16.759003,
        "pitch": 55.029453,
        "velocity": 100
      }
    ],
    "track": "vocal",
    "confidence": 0.8626614
  }
  
  

参考示例

调用方式为：POST /api/v1/invoke

Golang

// Code sample:
// use http client to invoke SAMI HTTP Service
package main

import (
	"bytes"
	"encoding/base64"
	"encoding/json"
	"fmt"
	"io/ioutil"
	"log"
	"net/http"
	"time"
)

type InvokeResponse struct {
	StatusCode int32   `form:"status_code,required" json:"status_code,required" query:"status_code,required"`
	StatusText string  `form:"status_text,required" json:"status_text,required" query:"status_text,required"`
	TaskId     string  `form:"task_id,required" json:"task_id,required" query:"task_id,required"`
	Namespace  string  `form:"namespace,required" json:"namespace,required" query:"namespace,required"`
	Payload    *string `form:"payload,omitempty" json:"payload,omitempty" query:"payload,omitempty"`
	Data       []byte  `form:"data,omitempty" json:"data,omitempty" query:"data,omitempty"`
	State      *string `form:"state,omitempty" json:"state,omitempty" query:"state,omitempty"`
}

const (
	domain = "https://sami.bytedance.com"

	// auth token
	appkey    = "your_appkey"

	// SAMI method
	version   = "v4"
	namespace = "MIDI"

	// dump output
	dataOutputFile    = "output.wav"
	payloadOutputFile = "output.json"
	isDump            = true
)

func main() {
	// Get token
	token := "your_token"

	// Construct HTTP request
	//   1. Read local audio file
	//   2. Set HTTP json body
	//   3. Do HTTP POST request
	audioPath := "/path/to/audio"
	content, err := ioutil.ReadFile(audioPath)
	if err != nil {
		log.Fatalf("failed to read file: %v", err)
	}
	data := base64.StdEncoding.EncodeToString(content)
	body := fmt.Sprintf(`{"data": "%v","payload":"{\"extra\":{\"midi\":false}}"}`, data)
	urlPath := fmt.Sprintf(
		"%v/api/v1/invoke?version=%v&token=%v&appkey=%v&namespace=%v",
		domain, version, token, appkey, namespace,
	)
	log.Printf("invoke request: %v", urlPath)

	// HTTP POST request
	start := time.Now()
	resp, err := http.Post(urlPath, "application/json", bytes.NewBuffer([]byte(body)))
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	// Parse HTTP response
	ret, err := ioutil.ReadAll(resp.Body)
	if err != nil || resp.StatusCode != http.StatusOK {
		panic(string(ret))
	}
	log.Printf("http invoke: cost=%vms, response: %v", time.Since(start).Milliseconds(), string(ret))

	// parse SAMI response
	samiResp := InvokeResponse{}
	payloadStr := ""
	if err = json.Unmarshal(ret, &samiResp); err != nil {
		log.Println("parse response failed", string(ret), err)
		panic(err)
	}
	if samiResp.Payload != nil {
		payloadStr = *samiResp.Payload
	}
	log.Printf("response task_id=%v, payload=%v, data=[%d]byte", samiResp.TaskId, payloadStr, len(samiResp.Data))
	if isDump && samiResp.Payload != nil {
		_ = ioutil.WriteFile(payloadOutputFile, []byte(*samiResp.Payload), 0644)
	}
	if isDump && len(samiResp.Data) > 0 {
		_ = ioutil.WriteFile(dataOutputFile, samiResp.Data, 0644)
	}
}

常见问题

• 通用FAQ

• 通用状态码

• 特定状态码