File: speech_recognition_engine.h

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (79 lines) | stat: -rw-r--r-- 2,768 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CONTENT_BROWSER_SPEECH_SPEECH_RECOGNITION_ENGINE_H_
#define CONTENT_BROWSER_SPEECH_SPEECH_RECOGNITION_ENGINE_H_

#include <vector>

#include "components/speech/audio_buffer.h"
#include "content/common/content_export.h"
#include "media/base/audio_parameters.h"
#include "media/mojo/mojom/speech_recognition_error.mojom.h"
#include "media/mojo/mojom/speech_recognition_recognition_context.h"
#include "media/mojo/mojom/speech_recognition_result.mojom.h"

namespace blink {
namespace mojom {
class SpeechRecognitionError;
}  // namespace mojom
}  // namespace blink

namespace content {

// This is the interface for any speech recognition engine, local or network.
//
// The expected call sequence is:
// StartRecognition      Mandatory at beginning of SR.
//   TakeAudioChunk      For every audio chunk pushed.
//   AudioChunksEnded    Finalize the audio stream (omitted in case of errors).
// EndRecognition        Mandatory at end of SR (even on errors).
//
// UpdateRecognitionContext can be called anywhere after StartRecognition and
// before EndRecognition.
//
// No delegate callbacks are performed before StartRecognition or after
// EndRecognition. If a recognition was started, the caller can free the
// SpeechRecognitionEngine only after calling EndRecognition.

class CONTENT_EXPORT SpeechRecognitionEngine {
 public:
  class Delegate {
   public:
    // Called whenever a result is retrieved.
    virtual void OnSpeechRecognitionEngineResults(
        const std::vector<media::mojom::WebSpeechRecognitionResultPtr>&
            results) = 0;
    virtual void OnSpeechRecognitionEngineEndOfUtterance() = 0;
    virtual void OnSpeechRecognitionEngineError(
        const media::mojom::SpeechRecognitionError& error) = 0;

   protected:
    virtual ~Delegate() = default;
  };

  SpeechRecognitionEngine() = default;
  virtual ~SpeechRecognitionEngine() = default;
  virtual void StartRecognition() = 0;
  virtual void UpdateRecognitionContext(
      const media::SpeechRecognitionRecognitionContext&
          recognition_context) = 0;
  virtual void EndRecognition() = 0;
  virtual void TakeAudioChunk(const AudioChunk& data) = 0;
  virtual void AudioChunksEnded() = 0;
  virtual int GetDesiredAudioChunkDurationMs() const = 0;

  void SetAudioParameters(media::AudioParameters audio_parameters);

  // set_delegate detached from constructor for lazy dependency injection.
  void set_delegate(Delegate* delegate);

 protected:
  raw_ptr<Delegate> delegate_ = nullptr;
  media::AudioParameters audio_parameters_;
};

}  // namespace content

#endif  // CONTENT_BROWSER_SPEECH_SPEECH_RECOGNITION_ENGINE_H_