summaryrefslogtreecommitdiff
path: root/src/components/include/media_manager/media_manager.h
blob: 60c93843d1ab2b099397808e1ba0579e559b4a44 (plain)
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 (c) 2014, Ford Motor Company
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following
 * disclaimer in the documentation and/or other materials provided with the
 * distribution.
 *
 * Neither the name of the Ford Motor Company nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef SRC_COMPONENTS_INCLUDE_MEDIA_MANAGER_MEDIA_MANAGER_H_
#define SRC_COMPONENTS_INCLUDE_MEDIA_MANAGER_MEDIA_MANAGER_H_

#include <string>
#include "interfaces/MOBILE_API.h"  // see discussion in sdl_core PR #2184
#include "media_manager/media_manager_settings.h"
#include "protocol/service_type.h"
#include "utils/macro.h"  // for "DEPRECATED"
namespace media_manager {

class MediaManager {
 public:
  virtual void StartMicrophoneRecording(
      int32_t application_key,
      const std::string& outputFileName,
      int32_t duration,
      mobile_apis::SamplingRate::eType sampling_rate,
      mobile_apis::BitsPerSample::eType bits_per_sample,
      mobile_apis::AudioType::eType audio_type) = 0;
  virtual void StopMicrophoneRecording(int32_t application_key) = 0;

  virtual void StartStreaming(int32_t application_key,
                              protocol_handler::ServiceType service_type) = 0;
  virtual void StopStreaming(int32_t application_key,
                             protocol_handler::ServiceType service_type) = 0;
  virtual void FramesProcessed(int32_t application_key,
                               int32_t frame_number) = 0;
  /**
   * \brief Media manager settings getter
   * \return pointer to media manager settings class
   */
  virtual const MediaManagerSettings& settings() const = 0;

  /**
   * \brief Convert an amount of audio bytes to an estimated time in ms
   * \param data_size number of bytes to be played
   * \return milliseconds required to play <data_size> many bytes with
   *          the current pcm stream capabilities
   */
  virtual uint32_t DataSizeToMilliseconds(uint64_t data_size) const = 0;

  virtual ~MediaManager() {}
};

}  // namespace media_manager

#endif  // SRC_COMPONENTS_INCLUDE_MEDIA_MANAGER_MEDIA_MANAGER_H_