OLD | NEW |
1 // Copyright 2015 The Chromium Authors. All rights reserved. | 1 // Copyright 2015 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef MEDIA_AUDIO_AUDIO_FILE_WRITER_H_ | 5 #ifndef MEDIA_AUDIO_AUDIO_FILE_WRITER_H_ |
6 #define MEDIA_AUDIO_AUDIO_FILE_WRITER_H_ | 6 #define MEDIA_AUDIO_AUDIO_FILE_WRITER_H_ |
7 | 7 |
8 #include <memory> | 8 #include <memory> |
9 | 9 |
10 namespace base { | 10 #include "base/callback_forward.h" |
11 class FilePath; | 11 #include "base/files/file_path.h" |
12 } | |
13 | 12 |
14 namespace media { | 13 namespace media { |
15 | 14 |
16 class AudioBus; | 15 class AudioBus; |
| 16 class AudioParameters; |
17 | 17 |
18 // A writer interface used for writing audio data to file for debugging | 18 // A writer interface used for writing audio data to file for debugging |
19 // purposes. | 19 // purposes. |
20 class AudioFileWriter { | 20 class AudioFileWriter { |
21 public: | 21 public: |
| 22 // Used for creating an AudioFileWriter. |
| 23 using CreateCallback = |
| 24 base::RepeatingCallback<std::unique_ptr<AudioFileWriter>( |
| 25 const AudioParameters&)>; |
| 26 |
22 virtual ~AudioFileWriter() {} | 27 virtual ~AudioFileWriter() {} |
23 | 28 |
24 // Must be called before calling Write() for the first time after creation or | 29 // Must be called before calling Write() for the first time after creation or |
25 // Stop() call. Can be called on any sequence; Write() and Stop() must be | 30 // Stop() call. Can be called on any sequence; Write() and Stop() must be |
26 // called on the same sequence as Start(). | 31 // called on the same sequence as Start(). |
27 virtual void Start(const base::FilePath& file) = 0; | 32 virtual void Start(const base::FilePath& file) = 0; |
28 | 33 |
29 // Must be called to finish recording. Each call to Start() requires a call to | 34 // Must be called to finish recording. Each call to Start() requires a call to |
30 // Stop(). Will be automatically called on destruction. | 35 // Stop(). Will be automatically called on destruction. |
31 virtual void Stop() = 0; | 36 virtual void Stop() = 0; |
32 | 37 |
33 // Write |data| to file. | 38 // Write |data| to file. |
34 virtual void Write(std::unique_ptr<AudioBus> data) = 0; | 39 virtual void Write(std::unique_ptr<AudioBus> data) = 0; |
35 | 40 |
36 // Returns true if Write() call scheduled at this point will most likely write | 41 // Returns true if Write() call scheduled at this point will most likely write |
37 // data to the file, and false if it most likely will be a no-op. The result | 42 // data to the file, and false if it most likely will be a no-op. The result |
38 // may be ambigulous if Start() or Stop() is executed at the moment. Can be | 43 // may be ambigulous if Start() or Stop() is executed at the moment. Can be |
39 // called from any sequence. | 44 // called from any sequence. |
40 virtual bool WillWrite() = 0; | 45 virtual bool WillWrite() = 0; |
| 46 |
| 47 // Gets the extension for the file type the as a string, for example "wav". |
| 48 // Can be called before calling Start() to add the appropriate extension to |
| 49 // the filename. |
| 50 virtual const base::FilePath::CharType* GetFileNameExtension() = 0; |
41 }; | 51 }; |
42 | 52 |
43 } // namespace media | 53 } // namspace media |
44 | 54 |
45 #endif // MEDIA_AUDIO_AUDIO_FILE_WRITER_H_ | 55 #endif // MEDIA_AUDIO_AUDIO_FILE_WRITER_H_ |
OLD | NEW |